sys/netinet/tcp_lro.h

   1 /*-
   2  * Copyright (c) 2006, Myricom Inc.
   3  * Copyright (c) 2008, Intel Corporation.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef _TCP_LRO_H_
  31 #define _TCP_LRO_H_
  32
  33 struct lro_entry
  34 {
  35         SLIST_ENTRY(lro_entry)  next;
  36         struct mbuf             *m_head;
  37         struct mbuf             *m_tail;
  38         union {
  39                 struct ip       *ip4;
  40                 struct ip6_hdr  *ip6;
  41         } leip;
  42         union {
  43                 in_addr_t       s_ip4;
  44                 struct in6_addr s_ip6;
  45         } lesource;
  46         union {
  47                 in_addr_t       d_ip4;
  48                 struct in6_addr d_ip6;
  49         } ledest;
  50         uint16_t                source_port;
  51         uint16_t                dest_port;
  52         uint16_t                eh_type;        /* EthernetHeader type. */
  53         uint16_t                append_cnt;
  54         uint32_t                p_len;          /* IP header payload length. */
  55         uint32_t                ulp_csum;       /* TCP, etc. checksum. */
  56         uint32_t                next_seq;       /* tcp_seq */
  57         uint32_t                ack_seq;        /* tcp_seq */
  58         uint32_t                tsval;
  59         uint32_t                tsecr;
  60         uint16_t                window;
  61         uint16_t                timestamp;      /* flag, not a TCP hdr field. */
  62 };
  63 SLIST_HEAD(lro_head, lro_entry);
  64
  65 #define le_ip4                  leip.ip4
  66 #define le_ip6                  leip.ip6
  67 #define source_ip4              lesource.s_ip4
  68 #define dest_ip4                ledest.d_ip4
  69 #define source_ip6              lesource.s_ip6
  70 #define dest_ip6                ledest.d_ip6
  71
  72 /* NB: This is part of driver structs. */
  73 struct lro_ctrl {
  74         struct ifnet    *ifp;
  75         int             lro_queued;
  76         int             lro_flushed;
  77         int             lro_bad_csum;
  78         int             lro_cnt;
  79
  80         struct lro_head lro_active;
  81         struct lro_head lro_free;
  82 };
  83
  84 int tcp_lro_init(struct lro_ctrl *);
  85 void tcp_lro_free(struct lro_ctrl *);
  86 void tcp_lro_flush(struct lro_ctrl *, struct lro_entry *);
  87 int tcp_lro_rx(struct lro_ctrl *, struct mbuf *, uint32_t);
  88
  89 #define TCP_LRO_CANNOT          -1
  90 #define TCP_LRO_NOT_SUPPORTED   1
  91
  92 #endif /* _TCP_LRO_H_ */