sys/netinet/tcp_lro.h

   1 /*-
   2  * Copyright (c) 2006, Myricom Inc.
   3  * Copyright (c) 2008, Intel Corporation.
   4  * Copyright (c) 2016 Mellanox Technologies.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _TCP_LRO_H_
  32 #define _TCP_LRO_H_
  33
  34 #include <sys/time.h>
  35
  36 #ifndef TCP_LRO_ENTRIES
  37 /* Define default number of LRO entries per RX queue */
  38 #define TCP_LRO_ENTRIES 8
  39 #endif
  40
  41 struct lro_entry {
  42         LIST_ENTRY(lro_entry)   next;
  43         LIST_ENTRY(lro_entry)   hash_next;
  44         struct mbuf             *m_head;
  45         struct mbuf             *m_tail;
  46         union {
  47                 struct ip       *ip4;
  48                 struct ip6_hdr  *ip6;
  49         } leip;
  50         union {
  51                 in_addr_t       s_ip4;
  52                 struct in6_addr s_ip6;
  53         } lesource;
  54         union {
  55                 in_addr_t       d_ip4;
  56                 struct in6_addr d_ip6;
  57         } ledest;
  58         uint16_t                source_port;
  59         uint16_t                dest_port;
  60         uint16_t                eh_type;        /* EthernetHeader type. */
  61         uint16_t                append_cnt;
  62         uint32_t                p_len;          /* IP header payload length. */
  63         uint32_t                ulp_csum;       /* TCP, etc. checksum. */
  64         uint32_t                next_seq;       /* tcp_seq */
  65         uint32_t                ack_seq;        /* tcp_seq */
  66         uint32_t                tsval;
  67         uint32_t                tsecr;
  68         uint16_t                window;
  69         uint16_t                timestamp;      /* flag, not a TCP hdr field. */
  70         struct timeval          mtime;
  71 };
  72 LIST_HEAD(lro_head, lro_entry);
  73
  74 #define le_ip4                  leip.ip4
  75 #define le_ip6                  leip.ip6
  76 #define source_ip4              lesource.s_ip4
  77 #define dest_ip4                ledest.d_ip4
  78 #define source_ip6              lesource.s_ip6
  79 #define dest_ip6                ledest.d_ip6
  80
  81 struct lro_mbuf_sort {
  82         uint64_t seq;
  83         struct mbuf *mb;
  84 };
  85
  86 /* NB: This is part of driver structs. */
  87 struct lro_ctrl {
  88         struct ifnet    *ifp;
  89         struct lro_mbuf_sort *lro_mbuf_data;
  90         uint64_t        lro_queued;
  91         uint64_t        lro_flushed;
  92         uint64_t        lro_bad_csum;
  93         unsigned        lro_cnt;
  94         unsigned        lro_mbuf_count;
  95         unsigned        lro_mbuf_max;
  96         unsigned short  lro_ackcnt_lim;         /* max # of aggregated ACKs */
  97         unsigned        lro_length_lim;         /* max len of aggregated data */
  98
  99         u_long          lro_hashsz;
 100         struct lro_head *lro_hash;
 101         struct lro_head lro_active;
 102         struct lro_head lro_free;
 103 };
 104
 105 #define TCP_LRO_LENGTH_MAX      65535
 106 #define TCP_LRO_ACKCNT_MAX      65535           /* unlimited */
 107
 108 int tcp_lro_init(struct lro_ctrl *);
 109 int tcp_lro_init_args(struct lro_ctrl *, struct ifnet *, unsigned, unsigned);
 110 void tcp_lro_free(struct lro_ctrl *);
 111 void tcp_lro_flush_inactive(struct lro_ctrl *, const struct timeval *);
 112 void tcp_lro_flush(struct lro_ctrl *, struct lro_entry *);
 113 void tcp_lro_flush_all(struct lro_ctrl *);
 114 int tcp_lro_rx(struct lro_ctrl *, struct mbuf *, uint32_t);
 115 void tcp_lro_queue_mbuf(struct lro_ctrl *, struct mbuf *);
 116
 117 #define TCP_LRO_NO_ENTRIES      -2
 118 #define TCP_LRO_CANNOT          -1
 119 #define TCP_LRO_NOT_SUPPORTED   1
 120
 121 #endif /* _TCP_LRO_H_ */