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 #define TCP_LRO_SEQUENCE(mb) \
  42     (mb)->m_pkthdr.PH_loc.thirtytwo[0]
  43
  44 struct lro_entry
  45 {
  46         SLIST_ENTRY(lro_entry)  next;
  47         struct mbuf             *m_head;
  48         struct mbuf             *m_tail;
  49         union {
  50                 struct ip       *ip4;
  51                 struct ip6_hdr  *ip6;
  52         } leip;
  53         union {
  54                 in_addr_t       s_ip4;
  55                 struct in6_addr s_ip6;
  56         } lesource;
  57         union {
  58                 in_addr_t       d_ip4;
  59                 struct in6_addr d_ip6;
  60         } ledest;
  61         uint16_t                source_port;
  62         uint16_t                dest_port;
  63         uint16_t                eh_type;        /* EthernetHeader type. */
  64         uint16_t                append_cnt;
  65         uint32_t                p_len;          /* IP header payload length. */
  66         uint32_t                ulp_csum;       /* TCP, etc. checksum. */
  67         uint32_t                next_seq;       /* tcp_seq */
  68         uint32_t                ack_seq;        /* tcp_seq */
  69         uint32_t                tsval;
  70         uint32_t                tsecr;
  71         uint16_t                window;
  72         uint16_t                timestamp;      /* flag, not a TCP hdr field. */
  73         struct timeval          mtime;
  74 };
  75 SLIST_HEAD(lro_head, lro_entry);
  76
  77 #define le_ip4                  leip.ip4
  78 #define le_ip6                  leip.ip6
  79 #define source_ip4              lesource.s_ip4
  80 #define dest_ip4                ledest.d_ip4
  81 #define source_ip6              lesource.s_ip6
  82 #define dest_ip6                ledest.d_ip6
  83
  84 /* NB: This is part of driver structs. */
  85 struct lro_ctrl {
  86         struct ifnet    *ifp;
  87         struct mbuf     **lro_mbuf_data;
  88         uint64_t        lro_queued;
  89         uint64_t        lro_flushed;
  90         uint64_t        lro_bad_csum;
  91         unsigned        lro_cnt;
  92         unsigned        lro_mbuf_count;
  93         unsigned        lro_mbuf_max;
  94
  95         struct lro_head lro_active;
  96         struct lro_head lro_free;
  97 };
  98
  99 int tcp_lro_init(struct lro_ctrl *);
 100 int tcp_lro_init_args(struct lro_ctrl *, struct ifnet *, unsigned, unsigned);
 101 void tcp_lro_free(struct lro_ctrl *);
 102 void tcp_lro_flush_inactive(struct lro_ctrl *, const struct timeval *);
 103 void tcp_lro_flush(struct lro_ctrl *, struct lro_entry *);
 104 void tcp_lro_flush_all(struct lro_ctrl *);
 105 int tcp_lro_rx(struct lro_ctrl *, struct mbuf *, uint32_t);
 106 void tcp_lro_queue_mbuf(struct lro_ctrl *, struct mbuf *);
 107
 108 #define TCP_LRO_CANNOT          -1
 109 #define TCP_LRO_NOT_SUPPORTED   1
 110
 111 #endif /* _TCP_LRO_H_ */