From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by dpdk.org (Postfix) with ESMTP id 9EEFE1B131; Wed, 9 Jan 2019 04:00:21 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by orsmga105.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 08 Jan 2019 19:00:20 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.56,455,1539673200"; d="scan'208";a="115280236" Received: from dpdk15.sh.intel.com ([10.67.111.146]) by fmsmga008.fm.intel.com with ESMTP; 08 Jan 2019 19:00:19 -0800 From: Jiayu Hu To: dev@dpdk.org Cc: stephen@networkplumber.org, konstantin.ananyev@intel.com, mb@smartsharesystems.com, Jiayu Hu , stable@dpdk.org Date: Wed, 9 Jan 2019 11:00:11 +0800 Message-Id: <1547002811-6989-1-git-send-email-jiayu.hu@intel.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1546586200-38148-1-git-send-email-jiayu.hu@intel.com> References: <1546586200-38148-1-git-send-email-jiayu.hu@intel.com> Subject: [dpdk-stable] [PATCH V4] doc: add GRO API limitations in prog_guide X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 09 Jan 2019 03:00:22 -0000 This patch adds GRO API limitations in the programmer guide. Fixes: 2c900d09055e ("doc: add GRO guide") Fixes: 9e0b9d2ec0f4 ("gro: support VxLAN GRO") Cc: stable@dpdk.org Signed-off-by: Jiayu Hu --- changes in v4: - update MBUF->l2_len/... requirement changes in v3: - add MBUF limitation changes in v2: - add fix versions - add more limitations doc/guides/prog_guide/generic_receive_offload_lib.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/guides/prog_guide/generic_receive_offload_lib.rst b/doc/guides/prog_guide/generic_receive_offload_lib.rst index 9c6a4d0..53c9d5c 100644 --- a/doc/guides/prog_guide/generic_receive_offload_lib.rst +++ b/doc/guides/prog_guide/generic_receive_offload_lib.rst @@ -191,3 +191,20 @@ Header fields deciding if packets are neighbors include: ignore IPv4 ID fields for the packets whose DF bit is 1. Additionally, packets which have different value of DF bit can't be merged. + +GRO Library Limitations +----------------------- + +- GRO library uses the values of MBUF->l2_len/l3_len/l4_len/ + outer_l2_len/outer_l3_len to get protocol headers for the + input packet, rather than parsing the packet header. Therefore, + before call GRO APIs to merge packets, user applications + must set MBUF->l2_len/l3_len/l4_len/outer_l2_len/outer_l3_len + to the same values as the protocol headers of the packet. + +- GRO library doesn't support to process packets with IPv4 Options. + +- GRO library just supports to process the packet organized + in a single MBUF. If the input packet consists of multiple + MBUFs (i.e. chained MBUFs), GRO reassembly behaviors are + unknown. -- 2.7.4