From nobody Thu Jan 18 22:39:46 2024 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4TGHkB6ZS9z57B3k; Thu, 18 Jan 2024 22:39:46 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4TGHkB2cqvz4FpQ; Thu, 18 Jan 2024 22:39:46 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1705617586; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=oPaYLO6l+lgYr84XifghPW0t9vC8NOri0BMJhvrlXpc=; b=g9VFZGvylzIeH34TTaPRgxbFPWUqsNOb+bcVx8sINn1HASsSoVf7sosYQTbt1xr2SjkHJt QjgmtWlEyry7X90vIsRQYb5875p3YUcym88G5iLj4taLlQgtUH28XfazCdlKnIgrkqSHSY Y0QOkTATSDiSvf+7M5vsDHwaowO7f6FQlON8yH1ZAu3Lqug4S4/HfJQHwzQnvF9ZyjE7eM sKV9H+bRmjymZxqJ3wzATCmH1mkMimr5eiCzG1BHv4DwHjmNMU0+sUp4kJsJX/ZzpGhRHH mZNLQ4pJK4gsgTBXZOToQWLL9slhsKoJYxX0iv72WBrzvoNVhLygBa326hmUVw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1705617586; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=oPaYLO6l+lgYr84XifghPW0t9vC8NOri0BMJhvrlXpc=; b=uL1D6K0Sk4R/l4F5ufJQxqLJj11I73igi+BayUug71piq/fLv/Xe05ku0fmsEVPcV3JCkb Ow3h3pVnvExfv6YnKA0otGSQd1KXw6EW8vLxBrh2AEK4GoFxmamkbbHuTVeWvOucswVn6c hFeeTrhpb6ECXIja2mAaj/eHEXJPznKXSwW2UkyFFSogocOqPj+7kIcVXfTHTRpPtFFbcA M2kpnqwud3/oD3cN/jO/w0chaPIBdo/KREFF28cRiQr063dTtU5VFWZT80YofO2gnVKgBC DT26ot77MDyzn0p7EbgcHb3tKTixtkaGei9pEm5jEOiLrv57nJquwGSK3SSBvw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1705617586; a=rsa-sha256; cv=none; b=QPerCbGBgUs7k0tQgXDjLs1XjQE5L0Qj3lBACBCnYXJXJUB2EyGY5V2RkEDB9EHpVgYMMn 4Ty0OqXJmEnBqeVdPNTlJE4H/7gCR4KlgKZzY4NqlOvBeLg752dmgTvJMYTvo1V7+J3LH8 HQRGwvpBX3yTXYbqt3To2PcPvCD8H1CvBPvjxR8/krFS7fe4CbDmUS/eGnErTB/91k3F04 3hjASgsbY6jjHR5u/QeV8+L46ic9y4rXIE3IlMKD9u80oy86y3OEVhthVqq0l9MRPTDX1t tM1Ag+Fm6pK05+vc69rhjqmbvX2BnJv+qFZi0h1d2f0/oHsjRuDODjAbHHdPVg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4TGHkB1kHzzQvn; Thu, 18 Jan 2024 22:39:46 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 40IMdk4E009228; Thu, 18 Jan 2024 22:39:46 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 40IMdkLV009225; Thu, 18 Jan 2024 22:39:46 GMT (envelope-from git) Date: Thu, 18 Jan 2024 22:39:46 GMT Message-Id: <202401182239.40IMdkLV009225@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: John Baldwin Subject: git: e73b54810308 - stable/13 - mbuf.9: Document mtodo List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: jhb X-Git-Repository: src X-Git-Refname: refs/heads/stable/13 X-Git-Reftype: branch X-Git-Commit: e73b54810308327c26aeca1737c89b4b2da1fe61 Auto-Submitted: auto-generated The branch stable/13 has been updated by jhb: URL: https://cgit.FreeBSD.org/src/commit/?id=e73b54810308327c26aeca1737c89b4b2da1fe61 commit e73b54810308327c26aeca1737c89b4b2da1fe61 Author: John Baldwin AuthorDate: 2023-12-28 19:17:22 +0000 Commit: John Baldwin CommitDate: 2024-01-18 22:34:52 +0000 mbuf.9: Document mtodo mtodo() accepts an mbuf and offset and returns a void * pointer to the requested offset into the mbuf's associated data. Similar to mtod(), no bounds checking is performed. Reviewed by: imp, markj Sponsored by: Chelsio Communications Differential Revision: https://reviews.freebsd.org/D43215 (cherry picked from commit 854e1fd692185749fea092b1431efd4a8e09c2eb) --- share/man/man9/Makefile | 1 + share/man/man9/mbuf.9 | 24 +++++++++++++++++++----- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index d237f677311a..30712ab4f987 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -1503,6 +1503,7 @@ MLINKS+=\ mbuf.9 m_pullup.9 \ mbuf.9 m_split.9 \ mbuf.9 mtod.9 \ + mbuf.9 mtodo.9 \ mbuf.9 M_TRAILINGSPACE.9 \ mbuf.9 m_unshare.9 \ mbuf.9 M_WRITABLE.9 diff --git a/share/man/man9/mbuf.9 b/share/man/man9/mbuf.9 index 84fad793b970..2b488f59cfd6 100644 --- a/share/man/man9/mbuf.9 +++ b/share/man/man9/mbuf.9 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd April 8, 2021 +.Dd December 28, 2023 .Dt MBUF 9 .Os .\" @@ -52,7 +52,10 @@ .Fc .\" .Ss Mbuf utility macros +.Ft type .Fn mtod "struct mbuf *mbuf" "type" +.Ft void * +.Fn mtodo "struct mbuf *mbuf" "offset" .Fn M_ALIGN "struct mbuf *mbuf" "u_int len" .Fn MH_ALIGN "struct mbuf *mbuf" "u_int len" .Ft int @@ -392,6 +395,14 @@ It is advisable to ensure that there is enough contiguous data in See .Fn m_pullup for details. +.It Fn mtodo mbuf offset +Return a data pointer at an offset (in bytes) into the data attached to +.Fa mbuf . +Returns a +.Ft void * +pointer . +.Sy Note : +The caller must ensure that the offset is in bounds of the attached data. .It Fn MGET mbuf how type Allocate an .Vt mbuf @@ -764,7 +775,9 @@ in the are contiguous and lay in the data area of .Fa mbuf , so they are accessible with -.Fn mtod mbuf type . +.Fn mtod +or +.Fn mtodo . .Fa len must be smaller than, or equal to, the size of an .Vt mbuf cluster . @@ -778,12 +791,13 @@ to the data contained in the returned mbuf is stored in If .Fa offsetp is NULL, the region may be accessed using -.Fn mtod mbuf type . +.Fn mtod mbuf type +or +.Fn mtodo mbuf 0 . If .Fa offsetp is non-NULL, the region may be accessed using -.Fn mtod mbuf uint8_t -+ *offsetp. +.Fn mtodo mbuf *offsetp . The region of the mbuf chain between its beginning and .Fa offset is not modified, therefore it is safe to hold pointers to data within