All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jiayu Hu <jiayu.hu@intel.com>
To: dev@dpdk.org
Cc: konstantin.ananyev@intel.com, mb@smartsharesystems.com,
	stephen@networkplumber.org, thomas@monjalon.net,
	vipin.varghese@intel.com, Jiayu Hu <jiayu.hu@intel.com>,
	stable@dpdk.org
Subject: [PATCH v5] doc: add GRO API limitations in prog_guide
Date: Wed,  9 Jan 2019 16:19:55 +0800	[thread overview]
Message-ID: <1547021995-14231-1-git-send-email-jiayu.hu@intel.com> (raw)
In-Reply-To: <1547002811-6989-1-git-send-email-jiayu.hu@intel.com>

This patch adds GRO API limitations in the programmer guide.

Fixes: 2c900d09055e ("doc: add GRO guide")
Cc: stable@dpdk.org

Signed-off-by: Jiayu Hu <jiayu.hu@intel.com>
---
changes in v5:
- remove fix commit 9e0b9d2ec0f4
changes in v4:
- update MBUF->l2_len/... requirement
changes in v3:
- add MBUF limitation
changes in v2:
- add fix commits
- 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

  parent reply	other threads:[~2019-01-09  8:19 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-12-18  4:25 [PATCH] doc: add GRO API requirement in prog_guide Jiayu Hu
2018-12-26  4:04 ` [PATCH v2] doc: add GRO API limitations " Jiayu Hu
2019-01-04  7:16   ` [PATCH v3] " Jiayu Hu
2019-01-09  3:00     ` [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       ` Jiayu Hu [this message]
2019-01-09 18:20         ` [PATCH v5] " 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         ` [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-stable] " Thomas Monjalon
2019-01-04 19:35 ` [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=1547021995-14231-1-git-send-email-jiayu.hu@intel.com \
    --to=jiayu.hu@intel.com \
    --cc=dev@dpdk.org \
    --cc=konstantin.ananyev@intel.com \
    --cc=mb@smartsharesystems.com \
    --cc=stable@dpdk.org \
    --cc=stephen@networkplumber.org \
    --cc=thomas@monjalon.net \
    --cc=vipin.varghese@intel.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.