From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id D289B1B675 for ; Tue, 18 Dec 2018 05:25:47 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 17 Dec 2018 20:25:46 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.56,367,1539673200"; d="scan'208";a="119290223" Received: from dpdk15.sh.intel.com ([10.67.111.146]) by FMSMGA003.fm.intel.com with ESMTP; 17 Dec 2018 20:25:45 -0800 From: Jiayu Hu To: dev@dpdk.org Cc: Jiayu Hu Date: Tue, 18 Dec 2018 12:25:19 +0800 Message-Id: <1545107119-85376-1-git-send-email-jiayu.hu@intel.com> X-Mailer: git-send-email 2.7.4 Subject: [dpdk-dev] [PATCH] doc: add GRO API requirement in prog_guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 18 Dec 2018 04:25:48 -0000 The GRO library requires that applications set correct values for MBUF->l2_len/l3_len/l4_len/outer_l2_len/outer_l3_len/pkt_len/data_len. This patch adds the requirement in prog_guide. Signed-off-by: Jiayu Hu --- doc/guides/prog_guide/generic_receive_offload_lib.rst | 6 ++++++ 1 file changed, 6 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..7e6944d 100644 --- a/doc/guides/prog_guide/generic_receive_offload_lib.rst +++ b/doc/guides/prog_guide/generic_receive_offload_lib.rst @@ -34,6 +34,12 @@ Currently, the GRO library provides GRO supports for TCP/IPv4 packets and VxLAN packets which contain an outer IPv4 header and an inner TCP/IPv4 packet. +.. note:: + To use the GRO library, applications must guarantee that + MBUF->l2_len/l3_len/l4_len/outer_l2_len/outer_l3_len and + MBUF->pkt_len/data_len of input packets are set to correct + values. + Two Sets of API --------------- -- 2.7.4