[V4] doc: add GRO API limitations in prog_guide

  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 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(+)
  

Hi Jiayu Hu,

A request to information, why there is document update patch with code update patch shared?

As per DPDK 19.02-rc1 both code and document should be one patch. Can you share the code patch reference if it was applied before 19.02-rc1?

Thanks
Vipin Varghese

> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Jiayu Hu
> Sent: Wednesday, January 9, 2019 8:30 AM
> To: dev@dpdk.org
> Cc: stephen@networkplumber.org; Ananyev, Konstantin
> <konstantin.ananyev@intel.com>; mb@smartsharesystems.com; Hu, Jiayu
> <jiayu.hu@intel.com>; stable@dpdk.org
> Subject: [dpdk-dev] [PATCH V4] doc: add GRO API limitations in prog_guide
> 
> 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 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
  

Typo in previous email

why there is document update patch with no code update patch shared?

> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Varghese, Vipin
> Sent: Wednesday, January 9, 2019 9:55 AM
> To: Hu, Jiayu <jiayu.hu@intel.com>; dev@dpdk.org
> Cc: stephen@networkplumber.org; Ananyev, Konstantin
> <konstantin.ananyev@intel.com>; mb@smartsharesystems.com; Hu, Jiayu
> <jiayu.hu@intel.com>; stable@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH V4] doc: add GRO API limitations in prog_guide
> 
> Hi Jiayu Hu,
> 
> A request to information, why there is document update patch with code
> update patch shared?
> 
> As per DPDK 19.02-rc1 both code and document should be one patch. Can you
> share the code patch reference if it was applied before 19.02-rc1?
> 
> Thanks
> Vipin Varghese
> 
> > -----Original Message-----
> > From: dev <dev-bounces@dpdk.org> On Behalf Of Jiayu Hu
> > Sent: Wednesday, January 9, 2019 8:30 AM
> > To: dev@dpdk.org
> > Cc: stephen@networkplumber.org; Ananyev, Konstantin
> > <konstantin.ananyev@intel.com>; mb@smartsharesystems.com; Hu, Jiayu
> > <jiayu.hu@intel.com>; stable@dpdk.org
> > Subject: [dpdk-dev] [PATCH V4] doc: add GRO API limitations in
> > prog_guide
> >
> > 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 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
  

> -----Original Message-----
> From: Varghese, Vipin
> Sent: Wednesday, January 9, 2019 12:27 PM
> To: Varghese, Vipin <vipin.varghese@intel.com>; Hu, Jiayu
> <jiayu.hu@intel.com>; dev@dpdk.org
> Cc: stephen@networkplumber.org; Ananyev, Konstantin
> <konstantin.ananyev@intel.com>; mb@smartsharesystems.com; Hu, Jiayu
> <jiayu.hu@intel.com>; stable@dpdk.org
> Subject: RE: [dpdk-dev] [PATCH V4] doc: add GRO API limitations in
> prog_guide
> 
> Typo in previous email
> 
> why there is document update patch with no code update patch shared?

I think I need to remove the fix commit 9e0b9d2ec0f4 from this patch, since
the GRO programmer doc is introduced in 2c900d09055e.

Thanks,
Jiayu

> 
> > -----Original Message-----
> > From: dev <dev-bounces@dpdk.org> On Behalf Of Varghese, Vipin
> > Sent: Wednesday, January 9, 2019 9:55 AM
> > To: Hu, Jiayu <jiayu.hu@intel.com>; dev@dpdk.org
> > Cc: stephen@networkplumber.org; Ananyev, Konstantin
> > <konstantin.ananyev@intel.com>; mb@smartsharesystems.com; Hu,
> Jiayu
> > <jiayu.hu@intel.com>; stable@dpdk.org
> > Subject: Re: [dpdk-dev] [PATCH V4] doc: add GRO API limitations in
> prog_guide
> >
> > Hi Jiayu Hu,
> >
> > A request to information, why there is document update patch with code
> > update patch shared?
> >
> > As per DPDK 19.02-rc1 both code and document should be one patch. Can
> you
> > share the code patch reference if it was applied before 19.02-rc1?
> >
> > Thanks
> > Vipin Varghese
> >
> > > -----Original Message-----
> > > From: dev <dev-bounces@dpdk.org> On Behalf Of Jiayu Hu
> > > Sent: Wednesday, January 9, 2019 8:30 AM
> > > To: dev@dpdk.org
> > > Cc: stephen@networkplumber.org; Ananyev, Konstantin
> > > <konstantin.ananyev@intel.com>; mb@smartsharesystems.com; Hu,
> Jiayu
> > > <jiayu.hu@intel.com>; stable@dpdk.org
> > > Subject: [dpdk-dev] [PATCH V4] doc: add GRO API limitations in
> > > prog_guide
> > >
> > > 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 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