[dpdk-dev] [PATCH v3 1/5] gso: add Generic Segmentation Offload API framework

[Ferruh Yigit]

On 9/12/2017 3:43 AM, Jiayu Hu wrote:
> Generic Segmentation Offload (GSO) is a SW technique to split large
> packets into small ones. Akin to TSO, GSO enables applications to
> operate on large packets, thus reducing per-packet processing overhead.
> 
> To enable more flexibility to applications, DPDK GSO is implemented
> as a standalone library. Applications explicitly use the GSO library
> to segment packets. This patch introduces the GSO API framework to DPDK.
> 
> The GSO library provides a segmentation API, rte_gso_segment(), for
> applications. It splits an input packet into small ones in each
> invocation. The GSO library refers to these small packets generated
> by rte_gso_segment() as GSO segments. Each of the newly-created GSO
> segments is organized as a two-segment MBUF, where the first segment is a
> standard MBUF, which stores a copy of packet header, and the second is an
> indirect MBUF which points to a section of data in the input packet.
> rte_gso_segment() reduces the refcnt of the input packet by 1. Therefore,
> when all GSO segments are freed, the input packet is freed automatically.
> Additionally, since each GSO segment has multiple MBUFs (i.e. 2 MBUFs),
> the driver of the interface which the GSO segments are sent to should
> support to transmit multi-segment packets.
> 
> Signed-off-by: Jiayu Hu <jiayu.hu at intel.com>
> Signed-off-by: Mark Kavanagh <mark.b.kavanagh at intel.com>
> ---
>  config/common_base                 |   5 ++
>  lib/Makefile                       |   2 +
>  lib/librte_gso/Makefile            |  49 ++++++++++++++
>  lib/librte_gso/rte_gso.c           |  50 ++++++++++++++
>  lib/librte_gso/rte_gso.h           | 133 +++++++++++++++++++++++++++++++++++++
>  lib/librte_gso/rte_gso_version.map |   7 ++
>  mk/rte.app.mk                      |   1 +

Can you please update documentation for new library:

- library documentation "doc/guides/prog_guide/xxx.rst"
- api documentation: doc/api/doxy-api.conf, doc/api/doxy-api-index.md
- release notes update to announce new library
- release notes, "Shared Library Versions" section with new library.

<...>