numam-dpdk/doc/guides/rel_notes
Jiayu Hu 0d2cbe59b7 lib/gro: support TCP/IPv4
In this patch, we introduce five APIs to support TCP/IPv4 GRO.
- gro_tcp4_reassemble: reassemble an inputted TCP/IPv4 packet.
- gro_tcp4_tbl_create: create a TCP/IPv4 reassembly table, which is used
    to merge packets.
- gro_tcp4_tbl_destroy: free memory space of a TCP/IPv4 reassembly table.
- gro_tcp4_tbl_pkt_count: return the number of packets in a TCP/IPv4
    reassembly table.
- gro_tcp4_tbl_timeout_flush: flush timeout packets from a TCP/IPv4
    reassembly table.

TCP/IPv4 GRO API assumes all inputted packets are with correct IPv4
and TCP checksums. And TCP/IPv4 GRO API doesn't update IPv4 and TCP
checksums for merged packets. If inputted packets are IP fragmented,
TCP/IPv4 GRO API assumes they are complete packets (i.e. with L4
headers).

In TCP/IPv4 GRO, we use a table structure, called TCP/IPv4 reassembly
table, to reassemble packets. A TCP/IPv4 reassembly table includes a key
array and a item array, where the key array keeps the criteria to merge
packets and the item array keeps packet information.

One key in the key array points to an item group, which consists of
packets which have the same criteria value. If two packets are able to
merge, they must be in the same item group. Each key in the key array
includes two parts:
- criteria: the criteria of merging packets. If two packets can be
    merged, they must have the same criteria value.
- start_index: the index of the first incoming packet of the item group.

Each element in the item array keeps the information of one packet. It
mainly includes three parts:
- firstseg: the address of the first segment of the packet
- lastseg: the address of the last segment of the packet
- next_pkt_index: the index of the next packet in the same item group.
    All packets in the same item group are chained by next_pkt_index.
    With next_pkt_index, we can locate all packets in the same item
    group one by one.

To process an incoming packet needs three steps:
a. check if the packet should be processed. Packets with one of the
    following properties won't be processed:
	- FIN, SYN, RST, URG, PSH, ECE or CWR bit is set;
	- packet payload length is 0.
b. traverse the key array to find a key which has the same criteria
    value with the incoming packet. If find, goto step c. Otherwise,
    insert a new key and insert the packet into the item array.
c. locate the first packet in the item group via the start_index in the
    key. Then traverse all packets in the item group via next_pkt_index.
    If find one packet which can merge with the incoming one, merge them
    together. If can't find, insert the packet into this item group.

Signed-off-by: Jiayu Hu <jiayu.hu@intel.com>
Reviewed-by: Jianfeng Tan <jianfeng.tan@intel.com>
2017-07-09 18:14:54 +02:00
..
deprecation.rst devargs: introduce new parsing helper 2017-07-09 00:12:00 +02:00
index.rst doc: add template release notes for 17.08 2017-05-15 12:14:19 +02:00
known_issues.rst doc: add known issue about l3fwd-power 2017-05-07 22:31:29 +02:00
rel_description.rst doc: simplify release notes cover 2015-08-12 09:15:27 +02:00
release_1_8.rst doc: fix spellings 2015-12-15 13:50:42 +01:00
release_2_0.rst doc: add missing release notes for mlx4 availability in 2.0 2015-08-17 19:35:37 +02:00
release_2_1.rst doc: add mlx4 release notes for version 2.1 2015-08-17 19:35:37 +02:00
release_2_2.rst doc: add statistics fixes in release notes 2015-12-15 13:50:42 +01:00
release_16_04.rst doc: remove residual template from release notes 2016-04-11 23:56:34 +02:00
release_16_07.rst doc: add tested hardware and systems for 16.07 2016-07-28 18:11:56 +02:00
release_16_11.rst doc: fix release notes for 16.11 2016-11-13 15:25:12 +01:00
release_17_02.rst doc: update release notes for 17.02 2017-02-14 21:58:04 +01:00
release_17_05.rst doc: add tested platforms with Mellanox NICs 2017-05-10 23:04:10 +02:00
release_17_08.rst lib/gro: support TCP/IPv4 2017-07-09 18:14:54 +02:00
supported_os.rst doc: restructure release notes 2015-08-11 17:28:13 +02:00