sys/netinet/tcp_fastopen.h

   1 /*-
   2  * Copyright (c) 2015-2017 Patrick Kelsey
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #ifndef _TCP_FASTOPEN_H_
  28 #define _TCP_FASTOPEN_H_
  29
  30 #ifdef _KERNEL
  31
  32 #include "opt_inet.h"
  33
  34 #define TCP_FASTOPEN_COOKIE_LEN         8       /* SipHash24 64-bit output */
  35
  36 #ifdef TCP_RFC7413
  37 VNET_DECLARE(unsigned int, tcp_fastopen_client_enable);
  38 #define V_tcp_fastopen_client_enable    VNET(tcp_fastopen_client_enable)
  39
  40 VNET_DECLARE(unsigned int, tcp_fastopen_server_enable);
  41 #define V_tcp_fastopen_server_enable    VNET(tcp_fastopen_server_enable)
  42 #else
  43 #define V_tcp_fastopen_client_enable    0
  44 #define V_tcp_fastopen_server_enable    0
  45 #endif  /* TCP_RFC7413 */
  46
  47 union tcp_fastopen_ip_addr {
  48         struct in_addr v4;
  49         struct in6_addr v6;
  50 };
  51
  52 struct tcp_fastopen_ccache_entry {
  53         TAILQ_ENTRY(tcp_fastopen_ccache_entry) cce_link;
  54         union tcp_fastopen_ip_addr cce_client_ip;       /* network byte order */
  55         union tcp_fastopen_ip_addr cce_server_ip;       /* network byte order */
  56         uint16_t server_port;                           /* network byte order */
  57         uint16_t server_mss;                            /* host byte order */
  58         uint8_t af;
  59         uint8_t cookie_len;
  60         uint8_t cookie[TCP_FASTOPEN_MAX_COOKIE_LEN];
  61         sbintime_t disable_time; /* non-zero value means path is disabled */
  62 };
  63
  64 struct tcp_fastopen_ccache;
  65
  66 struct tcp_fastopen_ccache_bucket {
  67         struct mtx      ccb_mtx;
  68         TAILQ_HEAD(bucket_entries, tcp_fastopen_ccache_entry) ccb_entries;
  69         int             ccb_num_entries;
  70         struct tcp_fastopen_ccache *ccb_ccache;
  71 };
  72
  73 struct tcp_fastopen_ccache {
  74         uma_zone_t      zone;
  75         struct tcp_fastopen_ccache_bucket *base;
  76         unsigned int    bucket_limit;
  77         unsigned int    buckets;
  78         unsigned int    mask;
  79         uint32_t        secret;
  80 };
  81
  82 struct tcpcb;
  83 #ifdef TCP_RFC7413
  84 void    tcp_fastopen_init(void);
  85 void    tcp_fastopen_destroy(void);
  86 unsigned int *tcp_fastopen_alloc_counter(void);
  87 void    tcp_fastopen_decrement_counter(unsigned int *);
  88 int     tcp_fastopen_check_cookie(struct in_conninfo *, uint8_t *, unsigned int,
  89             uint64_t *);
  90 void    tcp_fastopen_connect(struct tcpcb *);
  91 void    tcp_fastopen_disable_path(struct tcpcb *);
  92 void    tcp_fastopen_update_cache(struct tcpcb *, uint16_t, uint8_t,
  93             uint8_t *);
  94 #else
  95 static __inline void
  96 tcp_fastopen_init(void)
  97 {
  98 }
  99
 100 static __inline void
 101 tcp_fastopen_destroy(void)
 102 {
 103 }
 104
 105 static __inline unsigned int *
 106 tcp_fastopen_alloc_counter(void)
 107 {
 108         return (NULL);
 109 }
 110
 111 static __inline void
 112 tcp_fastopen_decrement_counter(unsigned int *_counter)
 113 {
 114 }
 115
 116 static __inline int
 117 tcp_fastopen_check_cookie(struct in_conninfo *_inc, uint8_t *_cookie,
 118     unsigned int _len, uint64_t *_latest_cookie)
 119 {
 120         return (-1);
 121 }
 122
 123 static __inline void
 124 tcp_fastopen_connect(struct tcpcb *_tp)
 125 {
 126 }
 127
 128 static __inline void
 129 tcp_fastopen_disable_path(struct tcpcb *_tp)
 130 {
 131 }
 132
 133 static __inline void
 134 tcp_fastopen_update_cache(struct tcpcb *_tp, uint16_t _mss, uint8_t _cookie_len,
 135     uint8_t *_cookie)
 136 {
 137 }
 138 #endif /* TCP_RFC7413 */
 139
 140 #endif /* _KERNEL */
 141
 142 #endif /* _TCP_FASTOPEN_H_ */