From nobody Thu Dec 28 19:18:16 2023 X-Original-To: dev-commits-src-main@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 4T1JFN4SW1z54Qd3; Thu, 28 Dec 2023 19:18:16 +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 4T1JFN3pZVz4PLD; Thu, 28 Dec 2023 19:18:16 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1703791096; 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=35ywUkfjVPECGmAVtsaillJlESE6O9gpwooA9QWIzb4=; b=qlnZk447EiQphHfHozCV0rA1bLOXNFlCvHwUBuXdJYwvJpOCIp3VhfZAGpWS3RGEcOEDiT /1bydhzyuqDNtkukY9MvHBuLR/YxO5Q44dWzpiwK5npYrP4dtv9XdWmVb9hZi4xPZV0U2E lJqY68Nug64Z4kJtgyxYThSNc/DImtN5YCunbZ5I4FlOpM498y538ZZsa9Bq6QZQrbvhh1 xSGwOLgG8RrWATi+muuNbkltn/PuUhez00eNxaoTYQsSoN6uYOtYzJHy6j50cth3yoqNJY 2u4FAsysKw1HRApiuvh89Dk0TEv32GxRWpOYb3i0nyuPoH2hiGIPb5fz4Opayw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1703791096; a=rsa-sha256; cv=none; b=yP/LPowIoVTqcJ/bhTDERdGURhgvxWa0hcZC++JVH+1Riw8Iam5p+WWm0OYIht+zu08wVU STDXlXbfSZxOGJ8aebXViBSjW1OrsAWqUnCzHu8SfIkYzI7EeuPATbLq4qedNWmjH0HYfx eAw15+wsz4vheso/NkgICqVAn39CsyP/s/qvD64YyM68neGiOLbVsHvh7NxH1yKPXA9B06 7eodFp4xPP0hrqlwJ9dO8E/nE5yV1K+p3yobCV90VuzRMl07aROguODxubqeiKvIDm/NU7 RD2FtgXqhNTDHhMeSt2JxMsmMp0p5Wq3wzfDFsMlgR4eLenh5dqEF9NG0D7U+g== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1703791096; 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=35ywUkfjVPECGmAVtsaillJlESE6O9gpwooA9QWIzb4=; b=KKizz/KXHSflKGKNTQG1amUl2engT35hEGXevvhKvd1YJhaJUKO3KmUzeAiGvUQV6v8C83 Ue2iP66MeMcU3Jya3QlOuF+srHC/AM2CiMAZW88Tpy3vPNF/7x10v0NnBc84hTRIuCVoNs LjuZNNwWJOSJxWaSOZStLZjR22l8WLcdben8VxXZRy6jCA0XPzflBioZTu3CM0VuvDvqo7 jn+OW5Irx2XTyvwRQtJeL1KpC+Zrcvwq+/+wr3B8sC1qLQ3LG6R6KPpoRSDnfNVwZ/BFIQ O1aNjJEJuV39FSKKUKQpgG/gdbX2newQd2ydC9lFNxDAwsQy8nCivywepOylWQ== 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 4T1JFN2ryxzbKv; Thu, 28 Dec 2023 19:18:16 +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 3BSJIGW4075964; Thu, 28 Dec 2023 19:18:16 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 3BSJIGMS075961; Thu, 28 Dec 2023 19:18:16 GMT (envelope-from git) Date: Thu, 28 Dec 2023 19:18:16 GMT Message-Id: <202312281918.3BSJIGMS075961@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: John Baldwin Subject: git: 854e1fd69218 - main - mbuf.9: Document mtodo List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@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/main X-Git-Reftype: branch X-Git-Commit: 854e1fd692185749fea092b1431efd4a8e09c2eb Auto-Submitted: auto-generated The branch main has been updated by jhb: URL: https://cgit.FreeBSD.org/src/commit/?id=854e1fd692185749fea092b1431efd4a8e09c2eb commit 854e1fd692185749fea092b1431efd4a8e09c2eb Author: John Baldwin AuthorDate: 2023-12-28 19:17:22 +0000 Commit: John Baldwin CommitDate: 2023-12-28 19:17:45 +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 --- 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 81de035defb9..6bc814334f5d 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -1516,6 +1516,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 7c69ef86f63f..0b03d697b8bf 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 August 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 @@ -394,6 +397,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 @@ -773,7 +784,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 . @@ -787,12 +800,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