From nobody Sun Dec 14 19:24:39 2025 Received: from mail-pl1-f201.google.com (mail-pl1-f201.google.com [209.85.214.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 2B92A226883 for ; Thu, 17 Apr 2025 23:15:51 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1744931754; cv=none; b=ZFMH21tkkbdhQY7+kHS4z3qbrmfPKrtrhqAI4Q/oeXG9hGjq2v7zHAzHzajlfimRk5u8x9rz5nkPnZ7ttso9cHjpLdUHy4URNE1/y5FZvKGHV1nN3Jyys0Q+svMDbJSa6jV9m282eX3TiorhkRLQ5p2RKG/OFkWlsyyu1bP+yds= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1744931754; c=relaxed/simple; bh=NeEtl0JyBuBfw49B2XTpAH0+6fht1E94LTL5fw/u2mc=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=frQWOQuDcDJRxUD1wgc4yo2lR7tsD165iGkDz7Y/YXDxj19BQDSf9HR6b/7RuOoWUfYJkpEJqwk2FsHQ13jJQjocjAiFVEykNGHyYR6G+Qg5NASiPl/sBpoNwFiJYR9ErkA5EgbIoOkERcDErynFsrWGcggzx53GBglvp3pz0yM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--almasrymina.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=S/FqxTIl; arc=none smtp.client-ip=209.85.214.201 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--almasrymina.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="S/FqxTIl" Received: by mail-pl1-f201.google.com with SMTP id d9443c01a7336-22403329f9eso10577875ad.3 for ; Thu, 17 Apr 2025 16:15:51 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1744931751; x=1745536551; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=00AFS0dK/JcGiS86FrD0eZND+4+TxFoXvhHvSO3Mfac=; b=S/FqxTIl4gotr1yavLbLfridNFN/FT8XRUEU48kpJ5mhRKcyU8JhE+i1ddsKGLLQJX Yu9KGaMHFjuAOOXM5YovNEKh/E93Ayk8oWCdK51kirWC5VahcpPsgpSkLhn2z5X/Z3hc HPWK/URyyu3/2bRkeZAcagJxtwU7Qngs21/av+GjyF0fQCN6e5MJjL4eN85QzXBECiEc P40MZy7CWZPPb/FZSqx2zfbylc+jbW9gBa5Y3C3Bk/Fu9S4tjlBZ2qcUTOmNn8viPuGh bb7HFnEjXq6vJs//ocAsj725+Uds/BHM7llrQMCKKD2irJePqmAAOGnxkJh+T7nB/r62 NEhA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1744931751; x=1745536551; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=00AFS0dK/JcGiS86FrD0eZND+4+TxFoXvhHvSO3Mfac=; b=RixHUjX78mY8wuoPFzUk/gAn6p3DypETZzn22FKrEGdzpRNb7zCJFQ/DEmFB32YIW7 tO5Orc8BqWcJjvu3Pc3LyFS6aEyb9WVbLnkjgVTTFvqXAEI6RenOa9TEGhYad1cvmIob SX63JWAUpC3iP8pN8MN8VFHCQkStSPOPa28cSojhLSNA83HVFBZs+7dknNHkPjnhEXHu cT/ToWOU0MtxQtau4oC0702U4brd9sMVr4sa5KIJ0IxbDTptnn/nIV7cSAV1BAWnhHom NBER0KeiEdpvnzkUvWFZaAyuagoqlRdPcTRllB87+A+/bvBkzLmfztUHTSJBw7uEpoFe SELA== X-Forwarded-Encrypted: i=1; AJvYcCU5J7wEYFhMqFk/CgH0f5vIKSD/5Ntv86GN4W5jM1VJjFmQ9BENOEGH5KfvGDVfjq13kcmwrEiWKPsovQk=@vger.kernel.org X-Gm-Message-State: AOJu0YxyYT0oUQ+WkZ774JZ/BRXCGiGypI8Tms8G6h7xqoK4lv8eSnTM ojD5ulr/Mz+IgalINivl8fRRdqcHrzQcqcQ23d+C/d7yiTyS+PiPmchyUpPyh8UYlHCXlQwdDQ7 pW+S4veuGp1tKQT9WdUwyig== X-Google-Smtp-Source: AGHT+IHafWrM7cs+MI3iV0RuAM6mba99LEtrOyQd8pjffWGPtooqo/nTDaM0O2k7fwxrPoxXcPYwnXqfYFv0sCw7Zg== X-Received: from plbbh9.prod.google.com ([2002:a17:902:a989:b0:21f:b748:a1c8]) (user=almasrymina job=prod-delivery.src-stubby-dispatcher) by 2002:a17:902:d489:b0:224:e33:8896 with SMTP id d9443c01a7336-22c53285bbbmr8808575ad.11.1744931751514; Thu, 17 Apr 2025 16:15:51 -0700 (PDT) Date: Thu, 17 Apr 2025 23:15:36 +0000 In-Reply-To: <20250417231540.2780723-1-almasrymina@google.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20250417231540.2780723-1-almasrymina@google.com> X-Mailer: git-send-email 2.49.0.805.g082f7c87e0-goog Message-ID: <20250417231540.2780723-6-almasrymina@google.com> Subject: [PATCH net-next v9 5/9] net: add devmem TCP TX documentation From: Mina Almasry To: netdev@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, io-uring@vger.kernel.org, virtualization@lists.linux.dev, kvm@vger.kernel.org, linux-kselftest@vger.kernel.org Cc: Mina Almasry , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Simon Horman , Donald Hunter , Jonathan Corbet , Andrew Lunn , Jeroen de Borst , Harshitha Ramamurthy , Kuniyuki Iwashima , Willem de Bruijn , Jens Axboe , Pavel Begunkov , David Ahern , Neal Cardwell , "Michael S. Tsirkin" , Jason Wang , Xuan Zhuo , "=?UTF-8?q?Eugenio=20P=C3=A9rez?=" , Stefan Hajnoczi , Stefano Garzarella , Shuah Khan , sdf@fomichev.me, dw@davidwei.uk, Jamal Hadi Salim , Victor Nogueira , Pedro Tammela , Samiullah Khawaja Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add documentation outlining the usage and details of the devmem TCP TX API. Signed-off-by: Mina Almasry Acked-by: Stanislav Fomichev --- v5: - Address comments from Stan and Bagas v4: - Mention SO_BINDTODEVICE is recommended (me/Pavel). v2: - Update documentation for iov_base is the dmabuf offset (Stan) --- Documentation/networking/devmem.rst | 150 +++++++++++++++++++++++++++- 1 file changed, 146 insertions(+), 4 deletions(-) diff --git a/Documentation/networking/devmem.rst b/Documentation/networking= /devmem.rst index eb678ca45496..a6cd7236bfbd 100644 --- a/Documentation/networking/devmem.rst +++ b/Documentation/networking/devmem.rst @@ -62,15 +62,15 @@ More Info https://lore.kernel.org/netdev/20240831004313.3713467-1-almasrymina@go= ogle.com/ =20 =20 -Interface -=3D=3D=3D=3D=3D=3D=3D=3D=3D +RX Interface +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 =20 Example ------- =20 -tools/testing/selftests/net/ncdevmem.c:do_server shows an example of setti= ng up -the RX path of this API. +./tools/testing/selftests/drivers/net/hw/ncdevmem:do_server shows an examp= le of +setting up the RX path of this API. =20 =20 NIC Setup @@ -235,6 +235,148 @@ can be less than the tokens provided by the user in c= ase of: (a) an internal kernel leak bug. (b) the user passed more than 1024 frags. =20 +TX Interface +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + + +Example +------- + +./tools/testing/selftests/drivers/net/hw/ncdevmem:do_client shows an examp= le of +setting up the TX path of this API. + + +NIC Setup +--------- + +The user must bind a TX dmabuf to a given NIC using the netlink API:: + + struct netdev_bind_tx_req *req =3D NULL; + struct netdev_bind_tx_rsp *rsp =3D NULL; + struct ynl_error yerr; + + *ys =3D ynl_sock_create(&ynl_netdev_family, &yerr); + + req =3D netdev_bind_tx_req_alloc(); + netdev_bind_tx_req_set_ifindex(req, ifindex); + netdev_bind_tx_req_set_fd(req, dmabuf_fd); + + rsp =3D netdev_bind_tx(*ys, req); + + tx_dmabuf_id =3D rsp->id; + + +The netlink API returns a dmabuf_id: a unique ID that refers to this dmabuf +that has been bound. + +The user can unbind the dmabuf from the netdevice by closing the netlink s= ocket +that established the binding. We do this so that the binding is automatica= lly +unbound even if the userspace process crashes. + +Note that any reasonably well-behaved dmabuf from any exporter should work= with +devmem TCP, even if the dmabuf is not actually backed by devmem. An exampl= e of +this is udmabuf, which wraps user memory (non-devmem) in a dmabuf. + +Socket Setup +------------ + +The user application must use MSG_ZEROCOPY flag when sending devmem TCP. D= evmem +cannot be copied by the kernel, so the semantics of the devmem TX are simi= lar +to the semantics of MSG_ZEROCOPY:: + + setsockopt(socket_fd, SOL_SOCKET, SO_ZEROCOPY, &opt, sizeof(opt)); + +It is also recommended that the user binds the TX socket to the same inter= face +the dma-buf has been bound to via SO_BINDTODEVICE:: + + setsockopt(socket_fd, SOL_SOCKET, SO_BINDTODEVICE, ifname, strlen(ifname)= + 1); + + +Sending data +------------ + +Devmem data is sent using the SCM_DEVMEM_DMABUF cmsg. + +The user should create a msghdr where, + +* iov_base is set to the offset into the dmabuf to start sending from +* iov_len is set to the number of bytes to be sent from the dmabuf + +The user passes the dma-buf id to send from via the dmabuf_tx_cmsg.dmabuf_= id. + +The example below sends 1024 bytes from offset 100 into the dmabuf, and 20= 48 +from offset 2000 into the dmabuf. The dmabuf to send from is tx_dmabuf_id:: + + char ctrl_data[CMSG_SPACE(sizeof(struct dmabuf_tx_cmsg))]; + struct dmabuf_tx_cmsg ddmabuf; + struct msghdr msg =3D {}; + struct cmsghdr *cmsg; + struct iovec iov[2]; + + iov[0].iov_base =3D (void*)100; + iov[0].iov_len =3D 1024; + iov[1].iov_base =3D (void*)2000; + iov[1].iov_len =3D 2048; + + msg.msg_iov =3D iov; + msg.msg_iovlen =3D 2; + + msg.msg_control =3D ctrl_data; + msg.msg_controllen =3D sizeof(ctrl_data); + + cmsg =3D CMSG_FIRSTHDR(&msg); + cmsg->cmsg_level =3D SOL_SOCKET; + cmsg->cmsg_type =3D SCM_DEVMEM_DMABUF; + cmsg->cmsg_len =3D CMSG_LEN(sizeof(struct dmabuf_tx_cmsg)); + + ddmabuf.dmabuf_id =3D tx_dmabuf_id; + + *((struct dmabuf_tx_cmsg *)CMSG_DATA(cmsg)) =3D ddmabuf; + + sendmsg(socket_fd, &msg, MSG_ZEROCOPY); + + +Reusing TX dmabufs +------------------ + +Similar to MSG_ZEROCOPY with regular memory, the user should not modify the +contents of the dma-buf while a send operation is in progress. This is bec= ause +the kernel does not keep a copy of the dmabuf contents. Instead, the kernel +will pin and send data from the buffer available to the userspace. + +Just as in MSG_ZEROCOPY, the kernel notifies the userspace of send complet= ions +using MSG_ERRQUEUE:: + + int64_t tstop =3D gettimeofday_ms() + waittime_ms; + char control[CMSG_SPACE(100)] =3D {}; + struct sock_extended_err *serr; + struct msghdr msg =3D {}; + struct cmsghdr *cm; + int retries =3D 10; + __u32 hi, lo; + + msg.msg_control =3D control; + msg.msg_controllen =3D sizeof(control); + + while (gettimeofday_ms() < tstop) { + if (!do_poll(fd)) continue; + + ret =3D recvmsg(fd, &msg, MSG_ERRQUEUE); + + for (cm =3D CMSG_FIRSTHDR(&msg); cm; cm =3D CMSG_NXTHDR(&m= sg, cm)) { + serr =3D (void *)CMSG_DATA(cm); + + hi =3D serr->ee_data; + lo =3D serr->ee_info; + + fprintf(stdout, "tx complete [%d,%d]\n", lo, hi); + } + } + +After the associated sendmsg has been completed, the dmabuf can be reused = by +the userspace. + + Implementation & Caveats =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 --=20 2.49.0.805.g082f7c87e0-goog