New upstream version 18.02
[deb_dpdk.git] / lib / librte_gro / gro_tcp4.c
index 61a0423..2c0f35c 100644 (file)
@@ -1,41 +1,11 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2017 Intel Corporation. All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2017 Intel Corporation
  */
 
 #include <rte_malloc.h>
 #include <rte_mbuf.h>
 #include <rte_cycles.h>
 #include <rte_ethdev.h>
-#include <rte_ip.h>
-#include <rte_tcp.h>
 
 #include "gro_tcp4.h"
 
@@ -72,20 +42,20 @@ gro_tcp4_tbl_create(uint16_t socket_id,
        }
        tbl->max_item_num = entries_num;
 
-       size = sizeof(struct gro_tcp4_key) * entries_num;
-       tbl->keys = rte_zmalloc_socket(__func__,
+       size = sizeof(struct gro_tcp4_flow) * entries_num;
+       tbl->flows = rte_zmalloc_socket(__func__,
                        size,
                        RTE_CACHE_LINE_SIZE,
                        socket_id);
-       if (tbl->keys == NULL) {
+       if (tbl->flows == NULL) {
                rte_free(tbl->items);
                rte_free(tbl);
                return NULL;
        }
-       /* INVALID_ARRAY_INDEX indicates empty key */
+       /* INVALID_ARRAY_INDEX indicates an empty flow */
        for (i = 0; i < entries_num; i++)
-               tbl->keys[i].start_index = INVALID_ARRAY_INDEX;
-       tbl->max_key_num = entries_num;
+               tbl->flows[i].start_index = INVALID_ARRAY_INDEX;
+       tbl->max_flow_num = entries_num;
 
        return tbl;
 }
@@ -97,111 +67,11 @@ gro_tcp4_tbl_destroy(void *tbl)
 
        if (tcp_tbl) {
                rte_free(tcp_tbl->items);
-               rte_free(tcp_tbl->keys);
+               rte_free(tcp_tbl->flows);
        }
        rte_free(tcp_tbl);
 }
 
-/*
- * merge two TCP/IPv4 packets without updating checksums.
- * If cmp is larger than 0, append the new packet to the
- * original packet. Otherwise, pre-pend the new packet to
- * the original packet.
- */
-static inline int
-merge_two_tcp4_packets(struct gro_tcp4_item *item_src,
-               struct rte_mbuf *pkt,
-               uint16_t ip_id,
-               uint32_t sent_seq,
-               int cmp)
-{
-       struct rte_mbuf *pkt_head, *pkt_tail, *lastseg;
-       uint16_t tcp_datalen;
-
-       if (cmp > 0) {
-               pkt_head = item_src->firstseg;
-               pkt_tail = pkt;
-       } else {
-               pkt_head = pkt;
-               pkt_tail = item_src->firstseg;
-       }
-
-       /* check if the packet length will be beyond the max value */
-       tcp_datalen = pkt_tail->pkt_len - pkt_tail->l2_len -
-               pkt_tail->l3_len - pkt_tail->l4_len;
-       if (pkt_head->pkt_len - pkt_head->l2_len + tcp_datalen >
-                       TCP4_MAX_L3_LENGTH)
-               return 0;
-
-       /* remove packet header for the tail packet */
-       rte_pktmbuf_adj(pkt_tail,
-                       pkt_tail->l2_len +
-                       pkt_tail->l3_len +
-                       pkt_tail->l4_len);
-
-       /* chain two packets together */
-       if (cmp > 0) {
-               item_src->lastseg->next = pkt;
-               item_src->lastseg = rte_pktmbuf_lastseg(pkt);
-               /* update IP ID to the larger value */
-               item_src->ip_id = ip_id;
-       } else {
-               lastseg = rte_pktmbuf_lastseg(pkt);
-               lastseg->next = item_src->firstseg;
-               item_src->firstseg = pkt;
-               /* update sent_seq to the smaller value */
-               item_src->sent_seq = sent_seq;
-       }
-       item_src->nb_merged++;
-
-       /* update mbuf metadata for the merged packet */
-       pkt_head->nb_segs += pkt_tail->nb_segs;
-       pkt_head->pkt_len += pkt_tail->pkt_len;
-
-       return 1;
-}
-
-static inline int
-check_seq_option(struct gro_tcp4_item *item,
-               struct tcp_hdr *tcp_hdr,
-               uint16_t tcp_hl,
-               uint16_t tcp_dl,
-               uint16_t ip_id,
-               uint32_t sent_seq)
-{
-       struct rte_mbuf *pkt0 = item->firstseg;
-       struct ipv4_hdr *ipv4_hdr0;
-       struct tcp_hdr *tcp_hdr0;
-       uint16_t tcp_hl0, tcp_dl0;
-       uint16_t len;
-
-       ipv4_hdr0 = (struct ipv4_hdr *)(rte_pktmbuf_mtod(pkt0, char *) +
-                       pkt0->l2_len);
-       tcp_hdr0 = (struct tcp_hdr *)((char *)ipv4_hdr0 + pkt0->l3_len);
-       tcp_hl0 = pkt0->l4_len;
-
-       /* check if TCP option fields equal. If not, return 0. */
-       len = RTE_MAX(tcp_hl, tcp_hl0) - sizeof(struct tcp_hdr);
-       if ((tcp_hl != tcp_hl0) ||
-                       ((len > 0) && (memcmp(tcp_hdr + 1,
-                                       tcp_hdr0 + 1,
-                                       len) != 0)))
-               return 0;
-
-       /* check if the two packets are neighbors */
-       tcp_dl0 = pkt0->pkt_len - pkt0->l2_len - pkt0->l3_len - tcp_hl0;
-       if ((sent_seq == (item->sent_seq + tcp_dl0)) &&
-                       (ip_id == (item->ip_id + 1)))
-               /* append the new packet */
-               return 1;
-       else if (((sent_seq + tcp_dl) == item->sent_seq) &&
-                       ((ip_id + item->nb_merged) == item->ip_id))
-               /* pre-pend the new packet */
-               return -1;
-       else
-               return 0;
-}
-
 static inline uint32_t
 find_an_empty_item(struct gro_tcp4_tbl *tbl)
 {
@@ -215,13 +85,13 @@ find_an_empty_item(struct gro_tcp4_tbl *tbl)
 }
 
 static inline uint32_t
-find_an_empty_key(struct gro_tcp4_tbl *tbl)
+find_an_empty_flow(struct gro_tcp4_tbl *tbl)
 {
        uint32_t i;
-       uint32_t max_key_num = tbl->max_key_num;
+       uint32_t max_flow_num = tbl->max_flow_num;
 
-       for (i = 0; i < max_key_num; i++)
-               if (tbl->keys[i].start_index == INVALID_ARRAY_INDEX)
+       for (i = 0; i < max_flow_num; i++)
+               if (tbl->flows[i].start_index == INVALID_ARRAY_INDEX)
                        return i;
        return INVALID_ARRAY_INDEX;
 }
@@ -229,10 +99,11 @@ find_an_empty_key(struct gro_tcp4_tbl *tbl)
 static inline uint32_t
 insert_new_item(struct gro_tcp4_tbl *tbl,
                struct rte_mbuf *pkt,
-               uint16_t ip_id,
-               uint32_t sent_seq,
+               uint64_t start_time,
                uint32_t prev_idx,
-               uint64_t start_time)
+               uint32_t sent_seq,
+               uint16_t ip_id,
+               uint8_t is_atomic)
 {
        uint32_t item_idx;
 
@@ -247,9 +118,10 @@ insert_new_item(struct gro_tcp4_tbl *tbl,
        tbl->items[item_idx].sent_seq = sent_seq;
        tbl->items[item_idx].ip_id = ip_id;
        tbl->items[item_idx].nb_merged = 1;
+       tbl->items[item_idx].is_atomic = is_atomic;
        tbl->item_num++;
 
-       /* if the previous packet exists, chain the new one with it */
+       /* if the previous packet exists, chain them together. */
        if (prev_idx != INVALID_ARRAY_INDEX) {
                tbl->items[item_idx].next_pkt_idx =
                        tbl->items[prev_idx].next_pkt_idx;
@@ -265,7 +137,7 @@ delete_item(struct gro_tcp4_tbl *tbl, uint32_t item_idx,
 {
        uint32_t next_idx = tbl->items[item_idx].next_pkt_idx;
 
-       /* set NULL to firstseg to indicate it's an empty item */
+       /* NULL indicates an empty item */
        tbl->items[item_idx].firstseg = NULL;
        tbl->item_num--;
        if (prev_item_idx != INVALID_ARRAY_INDEX)
@@ -275,52 +147,35 @@ delete_item(struct gro_tcp4_tbl *tbl, uint32_t item_idx,
 }
 
 static inline uint32_t
-insert_new_key(struct gro_tcp4_tbl *tbl,
-               struct tcp4_key *key_src,
+insert_new_flow(struct gro_tcp4_tbl *tbl,
+               struct tcp4_flow_key *src,
                uint32_t item_idx)
 {
-       struct tcp4_key *key_dst;
-       uint32_t key_idx;
+       struct tcp4_flow_key *dst;
+       uint32_t flow_idx;
 
-       key_idx = find_an_empty_key(tbl);
-       if (key_idx == INVALID_ARRAY_INDEX)
+       flow_idx = find_an_empty_flow(tbl);
+       if (unlikely(flow_idx == INVALID_ARRAY_INDEX))
                return INVALID_ARRAY_INDEX;
 
-       key_dst = &(tbl->keys[key_idx].key);
-
-       ether_addr_copy(&(key_src->eth_saddr), &(key_dst->eth_saddr));
-       ether_addr_copy(&(key_src->eth_daddr), &(key_dst->eth_daddr));
-       key_dst->ip_src_addr = key_src->ip_src_addr;
-       key_dst->ip_dst_addr = key_src->ip_dst_addr;
-       key_dst->recv_ack = key_src->recv_ack;
-       key_dst->src_port = key_src->src_port;
-       key_dst->dst_port = key_src->dst_port;
-
-       /* non-INVALID_ARRAY_INDEX value indicates this key is valid */
-       tbl->keys[key_idx].start_index = item_idx;
-       tbl->key_num++;
-
-       return key_idx;
-}
+       dst = &(tbl->flows[flow_idx].key);
 
-static inline int
-is_same_key(struct tcp4_key k1, struct tcp4_key k2)
-{
-       if (is_same_ether_addr(&k1.eth_saddr, &k2.eth_saddr) == 0)
-               return 0;
+       ether_addr_copy(&(src->eth_saddr), &(dst->eth_saddr));
+       ether_addr_copy(&(src->eth_daddr), &(dst->eth_daddr));
+       dst->ip_src_addr = src->ip_src_addr;
+       dst->ip_dst_addr = src->ip_dst_addr;
+       dst->recv_ack = src->recv_ack;
+       dst->src_port = src->src_port;
+       dst->dst_port = src->dst_port;
 
-       if (is_same_ether_addr(&k1.eth_daddr, &k2.eth_daddr) == 0)
-               return 0;
+       tbl->flows[flow_idx].start_index = item_idx;
+       tbl->flow_num++;
 
-       return ((k1.ip_src_addr == k2.ip_src_addr) &&
-                       (k1.ip_dst_addr == k2.ip_dst_addr) &&
-                       (k1.recv_ack == k2.recv_ack) &&
-                       (k1.src_port == k2.src_port) &&
-                       (k1.dst_port == k2.dst_port));
+       return flow_idx;
 }
 
 /*
- * update packet length for the flushed packet.
+ * update the packet length for the flushed packet.
  */
 static inline void
 update_header(struct gro_tcp4_item *item)
@@ -343,30 +198,41 @@ gro_tcp4_reassemble(struct rte_mbuf *pkt,
        struct ipv4_hdr *ipv4_hdr;
        struct tcp_hdr *tcp_hdr;
        uint32_t sent_seq;
-       uint16_t tcp_dl, ip_id;
+       uint16_t tcp_dl, ip_id, hdr_len, frag_off;
+       uint8_t is_atomic;
 
-       struct tcp4_key key;
+       struct tcp4_flow_key key;
        uint32_t cur_idx, prev_idx, item_idx;
-       uint32_t i, max_key_num;
+       uint32_t i, max_flow_num, remaining_flow_num;
        int cmp;
+       uint8_t find;
 
        eth_hdr = rte_pktmbuf_mtod(pkt, struct ether_hdr *);
        ipv4_hdr = (struct ipv4_hdr *)((char *)eth_hdr + pkt->l2_len);
        tcp_hdr = (struct tcp_hdr *)((char *)ipv4_hdr + pkt->l3_len);
+       hdr_len = pkt->l2_len + pkt->l3_len + pkt->l4_len;
 
        /*
-        * if FIN, SYN, RST, PSH, URG, ECE or
-        * CWR is set, return immediately.
+        * Don't process the packet which has FIN, SYN, RST, PSH, URG, ECE
+        * or CWR set.
         */
        if (tcp_hdr->tcp_flags != TCP_ACK_FLAG)
                return -1;
-       /* if payload length is 0, return immediately */
-       tcp_dl = rte_be_to_cpu_16(ipv4_hdr->total_length) - pkt->l3_len -
-               pkt->l4_len;
-       if (tcp_dl == 0)
+       /*
+        * Don't process the packet whose payload length is less than or
+        * equal to 0.
+        */
+       tcp_dl = pkt->pkt_len - hdr_len;
+       if (tcp_dl <= 0)
                return -1;
 
-       ip_id = rte_be_to_cpu_16(ipv4_hdr->packet_id);
+       /*
+        * Save IPv4 ID for the packet whose DF bit is 0. For the packet
+        * whose DF bit is 1, IPv4 ID is ignored.
+        */
+       frag_off = rte_be_to_cpu_16(ipv4_hdr->fragment_offset);
+       is_atomic = (frag_off & IPV4_HDR_DF_FLAG) == IPV4_HDR_DF_FLAG;
+       ip_id = is_atomic ? 0 : rte_be_to_cpu_16(ipv4_hdr->packet_id);
        sent_seq = rte_be_to_cpu_32(tcp_hdr->sent_seq);
 
        ether_addr_copy(&(eth_hdr->s_addr), &(key.eth_saddr));
@@ -377,25 +243,35 @@ gro_tcp4_reassemble(struct rte_mbuf *pkt,
        key.dst_port = tcp_hdr->dst_port;
        key.recv_ack = tcp_hdr->recv_ack;
 
-       /* search for a key */
-       max_key_num = tbl->max_key_num;
-       for (i = 0; i < max_key_num; i++) {
-               if ((tbl->keys[i].start_index != INVALID_ARRAY_INDEX) &&
-                               is_same_key(tbl->keys[i].key, key))
-                       break;
+       /* Search for a matched flow. */
+       max_flow_num = tbl->max_flow_num;
+       remaining_flow_num = tbl->flow_num;
+       find = 0;
+       for (i = 0; i < max_flow_num && remaining_flow_num; i++) {
+               if (tbl->flows[i].start_index != INVALID_ARRAY_INDEX) {
+                       if (is_same_tcp4_flow(tbl->flows[i].key, key)) {
+                               find = 1;
+                               break;
+                       }
+                       remaining_flow_num--;
+               }
        }
 
-       /* can't find a key, so insert a new key and a new item. */
-       if (i == tbl->max_key_num) {
-               item_idx = insert_new_item(tbl, pkt, ip_id, sent_seq,
-                               INVALID_ARRAY_INDEX, start_time);
+       /*
+        * Fail to find a matched flow. Insert a new flow and store the
+        * packet into the flow.
+        */
+       if (find == 0) {
+               item_idx = insert_new_item(tbl, pkt, start_time,
+                               INVALID_ARRAY_INDEX, sent_seq, ip_id,
+                               is_atomic);
                if (item_idx == INVALID_ARRAY_INDEX)
                        return -1;
-               if (insert_new_key(tbl, &key, item_idx) ==
+               if (insert_new_flow(tbl, &key, item_idx) ==
                                INVALID_ARRAY_INDEX) {
                        /*
-                        * fail to insert a new key, so
-                        * delete the inserted item
+                        * Fail to insert a new flow, so delete the
+                        * stored packet.
                         */
                        delete_item(tbl, item_idx, INVALID_ARRAY_INDEX);
                        return -1;
@@ -403,24 +279,27 @@ gro_tcp4_reassemble(struct rte_mbuf *pkt,
                return 0;
        }
 
-       /* traverse all packets in the item group to find one to merge */
-       cur_idx = tbl->keys[i].start_index;
+       /*
+        * Check all packets in the flow and try to find a neighbor for
+        * the input packet.
+        */
+       cur_idx = tbl->flows[i].start_index;
        prev_idx = cur_idx;
        do {
                cmp = check_seq_option(&(tbl->items[cur_idx]), tcp_hdr,
-                               pkt->l4_len, tcp_dl, ip_id, sent_seq);
+                               sent_seq, ip_id, pkt->l4_len, tcp_dl, 0,
+                               is_atomic);
                if (cmp) {
                        if (merge_two_tcp4_packets(&(tbl->items[cur_idx]),
-                                               pkt, ip_id,
-                                               sent_seq, cmp))
+                                               pkt, cmp, sent_seq, ip_id, 0))
                                return 1;
                        /*
-                        * fail to merge two packets since the packet
-                        * length will be greater than the max value.
-                        * So insert the packet into the item group.
+                        * Fail to merge the two packets, as the packet
+                        * length is greater than the max value. Store
+                        * the packet into the flow.
                         */
-                       if (insert_new_item(tbl, pkt, ip_id, sent_seq,
-                                               prev_idx, start_time) ==
+                       if (insert_new_item(tbl, pkt, start_time, prev_idx,
+                                               sent_seq, ip_id, is_atomic) ==
                                        INVALID_ARRAY_INDEX)
                                return -1;
                        return 0;
@@ -429,12 +308,9 @@ gro_tcp4_reassemble(struct rte_mbuf *pkt,
                cur_idx = tbl->items[cur_idx].next_pkt_idx;
        } while (cur_idx != INVALID_ARRAY_INDEX);
 
-       /*
-        * can't find a packet in the item group to merge,
-        * so insert the packet into the item group.
-        */
-       if (insert_new_item(tbl, pkt, ip_id, sent_seq, prev_idx,
-                               start_time) == INVALID_ARRAY_INDEX)
+       /* Fail to find a neighbor, so store the packet into the flow. */
+       if (insert_new_item(tbl, pkt, start_time, prev_idx, sent_seq,
+                               ip_id, is_atomic) == INVALID_ARRAY_INDEX)
                return -1;
 
        return 0;
@@ -448,44 +324,33 @@ gro_tcp4_tbl_timeout_flush(struct gro_tcp4_tbl *tbl,
 {
        uint16_t k = 0;
        uint32_t i, j;
-       uint32_t max_key_num = tbl->max_key_num;
+       uint32_t max_flow_num = tbl->max_flow_num;
 
-       for (i = 0; i < max_key_num; i++) {
-               /* all keys have been checked, return immediately */
-               if (tbl->key_num == 0)
+       for (i = 0; i < max_flow_num; i++) {
+               if (unlikely(tbl->flow_num == 0))
                        return k;
 
-               j = tbl->keys[i].start_index;
+               j = tbl->flows[i].start_index;
                while (j != INVALID_ARRAY_INDEX) {
                        if (tbl->items[j].start_time <= flush_timestamp) {
                                out[k++] = tbl->items[j].firstseg;
                                if (tbl->items[j].nb_merged > 1)
                                        update_header(&(tbl->items[j]));
                                /*
-                                * delete the item and get
-                                * the next packet index
+                                * Delete the packet and get the next
+                                * packet in the flow.
                                 */
-                               j = delete_item(tbl, j,
-                                               INVALID_ARRAY_INDEX);
+                               j = delete_item(tbl, j, INVALID_ARRAY_INDEX);
+                               tbl->flows[i].start_index = j;
+                               if (j == INVALID_ARRAY_INDEX)
+                                       tbl->flow_num--;
 
-                               /*
-                                * delete the key as all of
-                                * packets are flushed
-                                */
-                               if (j == INVALID_ARRAY_INDEX) {
-                                       tbl->keys[i].start_index =
-                                               INVALID_ARRAY_INDEX;
-                                       tbl->key_num--;
-                               } else
-                                       /* update start_index of the key */
-                                       tbl->keys[i].start_index = j;
-
-                               if (k == nb_out)
+                               if (unlikely(k == nb_out))
                                        return k;
                        } else
                                /*
-                                * left packets of this key won't be
-                                * timeout, so go to check other keys.
+                                * The left packets in this flow won't be
+                                * timeout. Go to check other flows.
                                 */
                                break;
                }