path: root/doc/api
diff options
authorJiayu Hu <>2017-07-09 13:46:44 +0800
committerThomas Monjalon <>2017-07-09 18:14:46 +0200
commite996506a1c07f145aa15ea6756cb11f2c705d1d3 (patch)
treee129bea95d634633af742cef2045fab4ac24c195 /doc/api
parenta76f6b1b0929f38aa91af75e9860637b60cee882 (diff)
lib/gro: add Generic Receive Offload API framework
Generic Receive Offload (GRO) is a widely used SW-based offloading technique to reduce per-packet processing overhead. It gains performance by reassembling small packets into large ones. This patchset is to support GRO in DPDK. To support GRO, this patch implements a GRO API framework. To enable more flexibility to applications, DPDK GRO is implemented as a user library. Applications explicitly use the GRO library to merge small packets into large ones. DPDK GRO provides two reassembly modes. One is called lightweight mode, the other is called heavyweight mode. If applications want to merge packets in a simple way and the number of packets is relatively small, they can use the lightweight mode. If applications need more fine-grained controls, they can choose the heavyweight mode. rte_gro_reassemble_burst is the main reassembly API which is used in lightweight mode and processes N packets at a time. For applications, performing GRO in lightweight mode is simple. They just need to invoke rte_gro_reassemble_burst. Applications can get GROed packets as soon as rte_gro_reassemble_burst returns. rte_gro_reassemble is the main reassembly API which is used in heavyweight mode and tries to merge N inputted packets with the packets in GRO reassembly tables. For applications, performing GRO in heavyweight mode is relatively complicated. Before performing GRO, applications need to create a GRO context object, which keeps reassembly tables of desired GRO types, by rte_gro_ctx_create. Then applications can use rte_gro_reassemble to merge packets. The GROed packets are in the reassembly tables of the GRO context object. If applications want to get them, applications need to manually flush them by flush API. Signed-off-by: Jiayu Hu <> Reviewed-by: Jianfeng Tan <>
Diffstat (limited to 'doc/api')
2 files changed, 2 insertions, 0 deletions
diff --git a/doc/api/ b/doc/api/
index 3b83288..67594e1 100644
--- a/doc/api/
+++ b/doc/api/
@@ -95,6 +95,7 @@ There are many libraries, so their headers may be grouped by topics:
[SCTP] (@ref rte_sctp.h),
[TCP] (@ref rte_tcp.h),
[UDP] (@ref rte_udp.h),
+ [GRO] (@ref rte_gro.h),
[frag/reass] (@ref rte_ip_frag.h),
[LPM IPv4 route] (@ref rte_lpm.h),
[LPM IPv6 route] (@ref rte_lpm6.h),
diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf
index ca9194f..823554f 100644
--- a/doc/api/doxy-api.conf
+++ b/doc/api/doxy-api.conf
@@ -46,6 +46,7 @@ INPUT = doc/api/ \
lib/librte_efd \
lib/librte_ether \
lib/librte_eventdev \
+ lib/librte_gro \
lib/librte_hash \
lib/librte_ip_frag \
lib/librte_jobstats \