DPDK patches and discussions
 help / color / mirror / Atom feed
From: Jiayu Hu <jiayu.hu@intel.com>
To: dev@dpdk.org
Cc: Jiayu Hu <jiayu.hu@intel.com>
Subject: [dpdk-dev] [PATCH] doc: add GRO API requirement in prog_guide
Date: Tue, 18 Dec 2018 12:25:19 +0800	[thread overview]
Message-ID: <1545107119-85376-1-git-send-email-jiayu.hu@intel.com> (raw)

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 <jiayu.hu@intel.com>
---
 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

             reply	other threads:[~2018-12-18  4:25 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-12-18  4:25 Jiayu Hu [this message]
2018-12-26  4:04 ` [dpdk-dev] [PATCH v2] doc: add GRO API limitations " Jiayu Hu
2019-01-04  7:16   ` [dpdk-dev] [PATCH v3] " Jiayu Hu
2019-01-09  3:00     ` [dpdk-dev] [PATCH V4] " Jiayu Hu
2019-01-09  4:25       ` Varghese, Vipin
2019-01-09  4:27         ` Varghese, Vipin
2019-01-09  5:18           ` Hu, Jiayu
2019-01-09  8:19       ` [dpdk-dev] [PATCH v5] " Jiayu Hu
2019-01-09 18:20         ` Stephen Hemminger
2019-01-09 18:40           ` Ananyev, Konstantin
2019-01-09 21:31             ` Morten Brørup
2019-01-10  8:06               ` Hu, Jiayu
2019-01-10  8:28                 ` Morten Brørup
2019-01-16  2:13         ` [dpdk-dev] [PATCH v6] doc: add GRO " Jiayu Hu
2019-01-16  9:50           ` Ananyev, Konstantin
2019-01-17 22:08             ` Thomas Monjalon
2019-01-17 13:55           ` Kovacevic, Marko
2019-01-17 22:08             ` [dpdk-dev] [dpdk-stable] " Thomas Monjalon
2019-01-04 19:35 ` [dpdk-dev] [PATCH] doc: add GRO API requirement " Stephen Hemminger
2019-01-08  2:35   ` Hu, Jiayu

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1545107119-85376-1-git-send-email-jiayu.hu@intel.com \
    --to=jiayu.hu@intel.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).