Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2559CC433FE for ; Mon, 9 May 2022 16:05:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238802AbiEIQJG (ORCPT ); Mon, 9 May 2022 12:09:06 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39304 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238801AbiEIQJC (ORCPT ); Mon, 9 May 2022 12:09:02 -0400 Received: from ams.source.kernel.org (ams.source.kernel.org [IPv6:2604:1380:4601:e00::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 24F9A253AAF; Mon, 9 May 2022 09:05:08 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id CF1D2B81751; Mon, 9 May 2022 16:05:06 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 18F15C385B4; Mon, 9 May 2022 16:05:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1652112305; bh=DvQTtl6V3ZL0hPjfv6Ii9cYVyK56e4JNCIOEGxupVCU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=bPvVs+oF8P8Z2GCM84QPMjGXF35Swqu73i4neo7YJymcuts1AJhMmKmYAZ+zykVfo 9RmdBF8u36CMU8UtsG/5HDAETXnVX+kYGKExc0vDD3wZMrIkKsFOzE+2SmJ1qUkXIq L5qwV2XTLXFzggyn1QuVVQej7MYG0DhF2gOJuIdIMyklHtLvXkbt1yZBAiNlkjHKHY 4TD3sGVq6w9qdg6JyaVkckhYDdMEFzosmUKFYjNHB/btby5IlKG/sMhlgEwdD6Rm8v JIMUskb0S9oYL+17FkCjWlvWMWACTmfplWyz9af9Ts5ef/bXEnioK1nFdJ+EUvxEsB N66t6nc8heTSw== From: Jakub Kicinski To: davem@davemloft.net Cc: netdev@vger.kernel.org, edumazet@google.com, pabeni@redhat.com, linux-doc@vger.kernel.org, corbet@lwn.net, imagedong@tencent.com, dsahern@gmail.com, talalahmad@google.com, Jakub Kicinski Subject: [PATCH net-next 2/3] skbuff: rewrite the doc for data-only skbs Date: Mon, 9 May 2022 09:04:55 -0700 Message-Id: <20220509160456.1058940-3-kuba@kernel.org> X-Mailer: git-send-email 2.34.3 In-Reply-To: <20220509160456.1058940-1-kuba@kernel.org> References: <20220509160456.1058940-1-kuba@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org The comment about shinfo->dataref split is really unhelpful, at least to me. Rewrite it and render it to skb documentation. Signed-off-by: Jakub Kicinski --- Documentation/networking/index.rst | 1 + Documentation/networking/skbuff.rst | 6 +++++ include/linux/skbuff.h | 42 ++++++++++++++++++++--------- 3 files changed, 37 insertions(+), 12 deletions(-) diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst index 72cf33579b78..a1c271fe484e 100644 --- a/Documentation/networking/index.rst +++ b/Documentation/networking/index.rst @@ -97,6 +97,7 @@ Refer to :ref:`netdev-FAQ` for a guide on netdev development process specifics. sctp secid seg6-sysctl + skbuff smc-sysctl statistics strparser diff --git a/Documentation/networking/skbuff.rst b/Documentation/networking/skbuff.rst index b4a008feceb4..94681523e345 100644 --- a/Documentation/networking/skbuff.rst +++ b/Documentation/networking/skbuff.rst @@ -23,3 +23,9 @@ skb_clone() allows for fast duplication of skbs. None of the data buffers get copied, but caller gets a new metadata struct (struct sk_buff). &skb_shared_info.refcount indicates the number of skbs pointing at the same packet data (i.e. clones). + +dataref and headerless skbs +--------------------------- + +.. kernel-doc:: include/linux/skbuff.h + :doc: dataref and headerless skbs diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h index d30c0a33c547..60d4ec30ef66 100644 --- a/include/linux/skbuff.h +++ b/include/linux/skbuff.h @@ -714,16 +714,32 @@ struct skb_shared_info { skb_frag_t frags[MAX_SKB_FRAGS]; }; -/* We divide dataref into two halves. The higher 16 bits hold references - * to the payload part of skb->data. The lower 16 bits hold references to - * the entire skb->data. A clone of a headerless skb holds the length of - * the header in skb->hdr_len. - * - * All users must obey the rule that the skb->data reference count must be - * greater than or equal to the payload reference count. - * - * Holding a reference to the payload part means that the user does not - * care about modifications to the header part of skb->data. +/** + * DOC: dataref and headerless skbs + * + * Transport layers send out clones of payload skbs they hold for + * retransmissions. To allow lower layers of the stack to prepend their headers + * we split &skb_shared_info.dataref into two halves. + * The lower 16 bits count the overall number of references. + * The higher 16 bits indicate how many of the references are payload-only. + * skb_header_cloned() checks if skb is allowed to add / write the headers. + * + * The creator of the skb (e.g. TCP) marks its skb as &sk_buff.nohdr + * (via __skb_header_release()). Any clone created from marked skb will get + * &sk_buff.hdr_len populated with the available headroom. + * If there's the only clone in existence it's able to modify the headroom + * at will. The sequence of calls inside the transport layer is:: + * + * + * skb_reserve() + * __skb_header_release() + * skb_clone() + * // send the clone down the stack + * + * This is not a very generic construct and it depends on the transport layers + * doing the right thing. In practice there's usually only one payload-only skb. + * Having multiple payload-only skbs with different lengths of hdr_len is not + * possible. The payload-only skbs should never leave their owner. */ #define SKB_DATAREF_SHIFT 16 #define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1) @@ -2014,8 +2030,10 @@ static inline int skb_header_unclone(struct sk_buff *skb, gfp_t pri) } /** - * __skb_header_release - release reference to header - * @skb: buffer to operate on + * __skb_header_release() - allow clones to use the headroom + * @skb: buffer to operate on + * + * See "DOC: dataref and headerless skbs". */ static inline void __skb_header_release(struct sk_buff *skb) { -- 2.34.3