From nobody Sun Dec 22 08:02:02 2024 Received: from mail-pg1-f202.google.com (mail-pg1-f202.google.com [209.85.215.202]) (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 9864FB663 for ; Sat, 21 Dec 2024 00:51:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1734742298; cv=none; b=afbOLe+JHTvK1/BPQeJCOkmYnBoLc+2jDrHT1vJ9Qz41adLcqF4d9tbtIDBcyBdtYjQHVqd7iyFJ6NQxFhkp1hpTccxvn+zd06Ag8t88CDICwBHLAB6842u77pXiBhwCabuPdIwLoqD3PMfEEkqb554ZIoNOjh8C1jwssy5QfyM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1734742298; c=relaxed/simple; bh=Q4IYKRzUgikdQrLO/xeVDk1fFg7Nif3uP+CIswjEMhs=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=d22dlid1AK6xQowOak7gocQhcnDA6ltazn8Dbrf3tSlZ/0nhfiwxDluYt3kFWU4wdmjnSgFRiC1+XET6W9ktGVB/BxouWQsmA8iO4DJ+9QGPzhGq8x3+AI0Jgmb7uPapcpXbvxcqrP5f2Iw85vzLJRpiZvJPcBWKISLYMaiFZNQ= 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=TD6WIrMH; arc=none smtp.client-ip=209.85.215.202 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="TD6WIrMH" Received: by mail-pg1-f202.google.com with SMTP id 41be03b00d2f7-7ea8c2b257bso1716632a12.1 for ; Fri, 20 Dec 2024 16:51:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1734742296; x=1735347096; 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=1SuvBd87z8dQBsyZrB5o6nLF21oYWt912VciCuuXhAk=; b=TD6WIrMH/PSeZefcZH/xSj8V3zntcrPdAiHuasTxB3oG7xVCbZ7Rk7JxFi2D6wBXqo tvWgvXDv0t+k7ZI8mMCyaZ4TRgdPZOeFuwcfFcsYjNbjIZK3RVR5V+CWLcWH4K9j3DY/ dzJP5PPR8lXeEho8ax3i8hHFiooOjj1/C4q/hPGGbPSNwA8ucPVrk9d7V5nx4Bm/lTbR SfavQTmWd6WqNOb56BTbSjOP+7EO4bGlU2iN6q4cG9eeIhvfJ805vV5bJhIBONUDmeXM CLkLkmGvB1X3wqRv9y1yOG9YY3vIFh72li1rLgXm+pkrjKqSX3u9Q47MdwKFtXsVOc9Y eUgQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1734742296; x=1735347096; 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=1SuvBd87z8dQBsyZrB5o6nLF21oYWt912VciCuuXhAk=; b=JciV5p/Wp8VkXvs261DWyQbv4O2FL5BF49ZGI6JvdONCxsH0jfa5eDCnfzE5ug8QCB FNSBDnrFIHRE3pzfzUXIcjGNUmeFIal1JyuJBU5iqNG1L51f1DjFhq2Q2kNzn4KrMT8y DkvEnWWGqp49OIRRb6pf6X7E7INZppC2y07aqftAFediLx5JKrITVttpizMR/MC9O7tf UgQP8/gOSzHo0/3lnIEk0GdzVzUVymew+LEDhwBMvf/2t797djD1Tlu45u1zIAdb3z4/ auZtpxFbMy+m9FCYl8O4flEIJKK7ppf1DKfCIxTzJUUWvlgztUM6xGU/BBwDjmyIH+bq MkwQ== X-Forwarded-Encrypted: i=1; AJvYcCVK2tDIeGbdQUVQSJh58CEQcc54FYc3jiXeaNBgxcpN8O62W45xXdFnJRWk3BJgkoW9VaEsXOVhhItsHcE=@vger.kernel.org X-Gm-Message-State: AOJu0YzrGqDIsp165uIJqjSp3RQMLpUsHi2hPL9+zV1p4dYAVDmg7hra MeT7wGDlCtHE/5sDoeoiazVtYXXRaW6PW+zutJgztD3IG8f+RxbvcZmQaM9jRKJMI7ygsP/oTuJ V1HK58tOyDMmj6Ew+dUB2Pw== X-Google-Smtp-Source: AGHT+IHjSak1jAgwlXPNoXP7dkl7+gaTr1FCoaGK/MjoAkKJUhx1FnZaoq8kHAbuzx5bYAxn+DO+wEw8pti8Saz7mQ== X-Received: from plhc14.prod.google.com ([2002:a17:903:234e:b0:216:21cb:2dfe]) (user=almasrymina job=prod-delivery.src-stubby-dispatcher) by 2002:a17:902:ebc9:b0:212:fa3:f627 with SMTP id d9443c01a7336-219e6e9f9a2mr71116625ad.16.1734742295746; Fri, 20 Dec 2024 16:51:35 -0800 (PST) Date: Sat, 21 Dec 2024 00:42:32 +0000 In-Reply-To: <20241221004236.2629280-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: <20241221004236.2629280-1-almasrymina@google.com> X-Mailer: git-send-email 2.47.1.613.gc27f4b7a9f-goog Message-ID: <20241221004236.2629280-2-almasrymina@google.com> Subject: [PATCH RFC net-next v1 1/5] net: add devmem TCP TX documentation From: Mina Almasry To: netdev@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@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 , David Ahern , "Michael S. Tsirkin" , Jason Wang , Xuan Zhuo , "=?UTF-8?q?Eugenio=20P=C3=A9rez?=" , Stefan Hajnoczi , Stefano Garzarella , Shuah Khan , Kaiyuan Zhang , Pavel Begunkov , Willem de Bruijn , Samiullah Khawaja , Stanislav Fomichev , Joe Damato , dw@davidwei.uk 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 --- Documentation/networking/devmem.rst | 140 +++++++++++++++++++++++++++- 1 file changed, 136 insertions(+), 4 deletions(-) diff --git a/Documentation/networking/devmem.rst b/Documentation/networking= /devmem.rst index d95363645331..9be01cd96ee2 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,138 @@ 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. + + ret =3D setsockopt(socket_fd, SOL_SOCKET, SO_ZEROCOPY, &opt, sizeof(opt)); + +Sending data +-------------- + +Devmem data is sent using the SCM_DEVMEM_DMABUF cmsg. + +The user should create a msghdr with iov_base set to NULL and iov_len set = to the +number of bytes to be sent from the dmabuf. + +The user passes the dma-buf id via the dmabuf_tx_cmsg.dmabuf_id, and passe= s the +offset into the dmabuf from where to start sending using the +dmabuf_tx_cmsg.dmabuf_offset field:: + + char ctrl_data[CMSG_SPACE(sizeof(struct dmabuf_tx_cmsg))]; + struct dmabuf_tx_cmsg ddmabuf; + struct msghdr msg =3D {}; + struct cmsghdr *cmsg; + uint64_t off =3D 100; + struct iovec iov; + + iov.iov_base =3D NULL; + iov.iov_len =3D line_size; + + msg.msg_iov =3D &iov; + msg.msg_iovlen =3D 1; + + 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; + ddmabuf.dmabuf_offset =3D off; + + *((struct dmabuf_tx_cmsg *)CMSG_DATA(cmsg)) =3D ddmabuf; + + ret =3D 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.47.1.613.gc27f4b7a9f-goog