From patchwork Thu Dec 21 11:32:41 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Euan Bourke X-Patchwork-Id: 135428 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 70E5A43750; Thu, 21 Dec 2023 12:32:57 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E4AEC4027D; Thu, 21 Dec 2023 12:32:56 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.55.52.120]) by mails.dpdk.org (Postfix) with ESMTP id DD5CB400D6 for ; Thu, 21 Dec 2023 12:32:54 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1703158375; x=1734694375; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=91qy+C5Bf01mDHasraWQWBZMlGFScXEcCx9BdVAaL50=; b=Dx1Q6041mrmK/3o5GQWKencJD3ak9O2mYVxru5YC4bpTCxq7Kpb3rl5e VDggV//TJpNO2tFZDl3g2OvFQ/rGUk0kwMn2vZJIbWcWC4V37M8iP7n7C ErWngEG082xNPpVS9VpmCkdjDQDYhi4evgM4u56sej1ppbC7ROVzrRWv4 /Loy0sEu8GsglOhVp+4cFDuSZj09rdkJDtT8ZBmARn+o/HiT3nI4UX63O MjsKJzi0un3fZ3MJQ7VWCFZkmhERAdAssDMyKF0SkGoyzw5tTxqyYUzDm 5u0t8ayZGBdpgfP4Ck8yCY9ILYef5CUa77Mim5wm6TsqzHK0Se4uBwWxv g==; X-IronPort-AV: E=McAfee;i="6600,9927,10930"; a="394853938" X-IronPort-AV: E=Sophos;i="6.04,293,1695711600"; d="scan'208";a="394853938" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Dec 2023 03:32:53 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10930"; a="842605427" X-IronPort-AV: E=Sophos;i="6.04,293,1695711600"; d="scan'208";a="842605427" Received: from unknown (HELO silpixa00400630.ir.intel.com) ([10.237.213.151]) by fmsmga008.fm.intel.com with ESMTP; 21 Dec 2023 03:32:52 -0800 From: Euan Bourke To: dev@dpdk.org Cc: Euan Bourke , Thomas Monjalon , Bruce Richardson , Konstantin Ananyev Subject: [PATCH v2 1/2] doc: updated incorrect value for IP frag max fragments Date: Thu, 21 Dec 2023 11:32:41 +0000 Message-Id: <20231221113242.3351356-1-euan.bourke@intel.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: References: MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Docs for IP Fragment said RTE_LIBRTE_IP_FRAG_MAX_FRAGS was 4 by default, however this was changed to 8. Documentation has been updated to account for this, including a snippet of the code where RTE_LIBRTE_IP_FRAG_MAX_FRAGS is defined to ensure the documentation stays up to date. Signed-off-by: Euan Bourke --- .mailmap | 1 + config/rte_config.h | 4 +++- doc/guides/prog_guide/ip_fragment_reassembly_lib.rst | 7 ++++++- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.mailmap b/.mailmap index ab0742a382..528bc68a30 100644 --- a/.mailmap +++ b/.mailmap @@ -379,6 +379,7 @@ Eric Zhang Erik Gabriel Carrillo Erik Ziegenbalg Erlu Chen +Euan Bourke Eugenio Pérez Eugeny Parshutin Evan Swanson diff --git a/config/rte_config.h b/config/rte_config.h index da265d7dd2..a3f92354f8 100644 --- a/config/rte_config.h +++ b/config/rte_config.h @@ -84,8 +84,10 @@ /* rawdev defines */ #define RTE_RAWDEV_MAX_DEVS 64 -/* ip_fragmentation defines */ +/* ip_fragmentation defines 8< */ #define RTE_LIBRTE_IP_FRAG_MAX_FRAG 8 +/* >8 End of ip_fragmentation defines */ + // RTE_LIBRTE_IP_FRAG_TBL_STAT is not set /* rte_power defines */ diff --git a/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst b/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst index 314d4adbb8..5010472246 100644 --- a/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst +++ b/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst @@ -43,7 +43,12 @@ Note that all update/lookup operations on Fragment Table are not thread safe. So if different execution contexts (threads/processes) will access the same table simultaneously, then some external syncing mechanism have to be provided. -Each table entry can hold information about packets consisting of up to RTE_LIBRTE_IP_FRAG_MAX (by default: 4) fragments. +Each table entry can hold information about packets of up to ``RTE_LIBRTE_IP_FRAG_MAX_FRAGS`` fragments, +where ``RTE_LIBRTE_IP_FRAG_MAX_FRAGS`` defaults to: + +.. literalinclude:: ../../../config/rte_config.h + :start-after: ip_fragmentation defines 8< + :end-before: >8 End of ip_fragmentation defines Code example, that demonstrates creation of a new Fragment table: