From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <jiayu.hu@intel.com>
Received: from mga01.intel.com (mga01.intel.com [192.55.52.88])
by dpdk.org (Postfix) with ESMTP id C3D415F2F;
Wed, 26 Dec 2018 05:05:06 +0100 (CET)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from fmsmga006.fm.intel.com ([10.253.24.20])
by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
25 Dec 2018 20:05:05 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.56,399,1539673200"; d="scan'208";a="305030962"
Received: from dpdk15.sh.intel.com ([10.67.111.146])
by fmsmga006.fm.intel.com with ESMTP; 25 Dec 2018 20:05:04 -0800
From: Jiayu Hu <jiayu.hu@intel.com>
To: dev@dpdk.org
Cc: thomas@monjalon.net,
Jiayu Hu <jiayu.hu@intel.com>,
stable@dpdk.org
Date: Wed, 26 Dec 2018 12:04:33 +0800
Message-Id: <1545797073-24844-1-git-send-email-jiayu.hu@intel.com>
X-Mailer: git-send-email 2.7.4
In-Reply-To: <1545107119-85376-1-git-send-email-jiayu.hu@intel.com>
References: <1545107119-85376-1-git-send-email-jiayu.hu@intel.com>
Subject: [dpdk-dev] [PATCH v2] doc: add GRO API limitations in prog_guide
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 26 Dec 2018 04:05:07 -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 <jiayu.hu@intel.com>
---
changes in v2:
- add fix versions
- add more limitations
doc/guides/prog_guide/generic_receive_offload_lib.rst | 11 +++++++++++
1 file changed, 11 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..3873610 100644
--- a/doc/guides/prog_guide/generic_receive_offload_lib.rst
+++ b/doc/guides/prog_guide/generic_receive_offload_lib.rst
@@ -191,3 +191,14 @@ 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 directly uses the values of MBUF->l2_len/l3_len/l4_len/
+ outer_l2_len/outer_l3_len to parse packet headers. In addition,
+ it relies on MBUF->pkt_len/data_len to process packets. Therefore,
+ to get correct reassembly results, applications must set correct
+ values to those MBUF metadata fields.
+
+- GRO library doesn't support to process packets with IPv4 option fields.
--
2.7.4