src/vnet/session/transport.h

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef VNET_VNET_URI_TRANSPORT_H_
  17 #define VNET_VNET_URI_TRANSPORT_H_
  18
  19 #include <vnet/vnet.h>
  20 #include <vnet/ip/ip.h>
  21 #include <vppinfra/bihash_16_8.h>
  22 #include <vppinfra/bihash_48_8.h>
  23 #include <vnet/tcp/tcp_debug.h>
  24 /*
  25  * Protocol independent transport properties associated to a session
  26  */
  27 typedef struct _transport_connection
  28 {
  29   ip46_address_t rmt_ip;        /**< Remote IP */
  30   ip46_address_t lcl_ip;        /**< Local IP */
  31   u16 lcl_port;                 /**< Local port */
  32   u16 rmt_port;                 /**< Remote port */
  33   u8 proto;                     /**< Transport protocol id (also session type) */
  34
  35   u32 s_index;                  /**< Parent session index */
  36   u32 c_index;                  /**< Connection index in transport pool */
  37   u8 is_ip4;                    /**< Flag if IP4 connection */
  38   u32 thread_index;             /**< Worker-thread index */
  39
  40 #if TRANSPORT_DEBUG
  41   elog_track_t elog_track;      /**< Event logging */
  42 #endif
  43
  44   /** Macros for 'derived classes' where base is named "connection" */
  45 #define c_lcl_ip connection.lcl_ip
  46 #define c_rmt_ip connection.rmt_ip
  47 #define c_lcl_ip4 connection.lcl_ip.ip4
  48 #define c_rmt_ip4 connection.rmt_ip.ip4
  49 #define c_lcl_ip6 connection.lcl_ip.ip6
  50 #define c_rmt_ip6 connection.rmt_ip.ip6
  51 #define c_lcl_port connection.lcl_port
  52 #define c_rmt_port connection.rmt_port
  53 #define c_proto connection.proto
  54 #define c_state connection.state
  55 #define c_s_index connection.s_index
  56 #define c_c_index connection.c_index
  57 #define c_is_ip4 connection.is_ip4
  58 #define c_thread_index connection.thread_index
  59 #define c_elog_track connection.elog_track
  60 } transport_connection_t;
  61
  62 /*
  63  * Transport protocol virtual function table
  64  */
  65 typedef struct _transport_proto_vft
  66 {
  67   /*
  68    * Setup
  69    */
  70   u32 (*bind) (u32, ip46_address_t *, u16);
  71   u32 (*unbind) (u32);
  72   int (*open) (ip46_address_t * addr, u16 port_host_byte_order);
  73   void (*close) (u32 conn_index, u32 thread_index);
  74   void (*cleanup) (u32 conn_index, u32 thread_index);
  75
  76   /*
  77    * Transmission
  78    */
  79     u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
  80     u16 (*send_mss) (transport_connection_t * tc);
  81     u32 (*send_space) (transport_connection_t * tc);
  82     u32 (*tx_fifo_offset) (transport_connection_t * tc);
  83
  84   /*
  85    * Connection retrieval
  86    */
  87   transport_connection_t *(*get_connection) (u32 conn_idx, u32 thread_idx);
  88   transport_connection_t *(*get_listener) (u32 conn_index);
  89   transport_connection_t *(*get_half_open) (u32 conn_index);
  90
  91   /*
  92    * Format
  93    */
  94   u8 *(*format_connection) (u8 * s, va_list * args);
  95   u8 *(*format_listener) (u8 * s, va_list * args);
  96   u8 *(*format_half_open) (u8 * s, va_list * args);
  97 } transport_proto_vft_t;
  98
  99 /* *INDENT-OFF* */
 100 /* 16 octets */
 101 typedef CLIB_PACKED (struct {
 102   union
 103     {
 104       struct
 105         {
 106           ip4_address_t src;
 107           ip4_address_t dst;
 108           u16 src_port;
 109           u16 dst_port;
 110           /* align by making this 4 octets even though its a 1-bit field
 111            * NOTE: avoid key overlap with other transports that use 5 tuples for
 112            * session identification.
 113            */
 114           u32 proto;
 115         };
 116       u64 as_u64[2];
 117     };
 118 }) v4_connection_key_t;
 119
 120 typedef CLIB_PACKED (struct {
 121   union
 122     {
 123       struct
 124         {
 125           /* 48 octets */
 126           ip6_address_t src;
 127           ip6_address_t dst;
 128           u16 src_port;
 129           u16 dst_port;
 130           u32 proto;
 131           u64 unused;
 132         };
 133       u64 as_u64[6];
 134     };
 135 }) v6_connection_key_t;
 136 /* *INDENT-ON* */
 137
 138 typedef clib_bihash_kv_16_8_t session_kv4_t;
 139 typedef clib_bihash_kv_48_8_t session_kv6_t;
 140
 141 always_inline void
 142 make_v4_ss_kv (session_kv4_t * kv, ip4_address_t * lcl, ip4_address_t * rmt,
 143                u16 lcl_port, u16 rmt_port, u8 proto)
 144 {
 145   v4_connection_key_t *key = (v4_connection_key_t *) kv->key;
 146
 147   key->src.as_u32 = lcl->as_u32;
 148   key->dst.as_u32 = rmt->as_u32;
 149   key->src_port = lcl_port;
 150   key->dst_port = rmt_port;
 151   key->proto = proto;
 152
 153   kv->value = ~0ULL;
 154 }
 155
 156 always_inline void
 157 make_v4_listener_kv (session_kv4_t * kv, ip4_address_t * lcl, u16 lcl_port,
 158                      u8 proto)
 159 {
 160   v4_connection_key_t *key = (v4_connection_key_t *) kv->key;
 161
 162   key->src.as_u32 = lcl->as_u32;
 163   key->dst.as_u32 = 0;
 164   key->src_port = lcl_port;
 165   key->dst_port = 0;
 166   key->proto = proto;
 167
 168   kv->value = ~0ULL;
 169 }
 170
 171 always_inline void
 172 make_v4_ss_kv_from_tc (session_kv4_t * kv, transport_connection_t * t)
 173 {
 174   return make_v4_ss_kv (kv, &t->lcl_ip.ip4, &t->rmt_ip.ip4, t->lcl_port,
 175                         t->rmt_port, t->proto);
 176 }
 177
 178 always_inline void
 179 make_v6_ss_kv (session_kv6_t * kv, ip6_address_t * lcl, ip6_address_t * rmt,
 180                u16 lcl_port, u16 rmt_port, u8 proto)
 181 {
 182   v6_connection_key_t *key = (v6_connection_key_t *) kv->key;
 183
 184   key->src.as_u64[0] = lcl->as_u64[0];
 185   key->src.as_u64[1] = lcl->as_u64[1];
 186   key->dst.as_u64[0] = rmt->as_u64[0];
 187   key->dst.as_u64[1] = rmt->as_u64[1];
 188   key->src_port = lcl_port;
 189   key->dst_port = rmt_port;
 190   key->proto = proto;
 191   key->unused = 0;
 192
 193   kv->value = ~0ULL;
 194 }
 195
 196 always_inline void
 197 make_v6_listener_kv (session_kv6_t * kv, ip6_address_t * lcl, u16 lcl_port,
 198                      u8 proto)
 199 {
 200   v6_connection_key_t *key = (v6_connection_key_t *) kv->key;
 201
 202   key->src.as_u64[0] = lcl->as_u64[0];
 203   key->src.as_u64[1] = lcl->as_u64[1];
 204   key->dst.as_u64[0] = 0;
 205   key->dst.as_u64[1] = 0;
 206   key->src_port = lcl_port;
 207   key->dst_port = 0;
 208   key->proto = proto;
 209   key->unused = 0;
 210
 211   kv->value = ~0ULL;
 212 }
 213
 214 always_inline void
 215 make_v6_ss_kv_from_tc (session_kv6_t * kv, transport_connection_t * t)
 216 {
 217   make_v6_ss_kv (kv, &t->lcl_ip.ip6, &t->rmt_ip.ip6, t->lcl_port,
 218                  t->rmt_port, t->proto);
 219 }
 220
 221 typedef struct _transport_endpoint
 222 {
 223   ip46_address_t ip;    /** ip address */
 224   u16 port;             /** port in host order */
 225   u8 is_ip4;            /** 1 if ip4 */
 226   u32 vrf;              /** fib table the endpoint is associated with */
 227 } transport_endpoint_t;
 228
 229 typedef clib_bihash_24_8_t transport_endpoint_table_t;
 230
 231 #define TRANSPORT_ENDPOINT_INVALID_INDEX ((u32)~0)
 232
 233 u32
 234 transport_endpoint_lookup (transport_endpoint_table_t * ht,
 235                            ip46_address_t * ip, u16 port);
 236 void transport_endpoint_table_add (transport_endpoint_table_t * ht,
 237                                    transport_endpoint_t * te, u32 value);
 238 void transport_endpoint_table_del (transport_endpoint_table_t * ht,
 239                                    transport_endpoint_t * te);
 240
 241 #endif /* VNET_VNET_URI_TRANSPORT_H_ */
 242
 243 /*
 244  * fd.io coding-style-patch-verification: ON
 245  *
 246  * Local Variables:
 247  * eval: (c-set-style "gnu")
 248  * End:
 249  */