src/vnet/session/transport.c

   1 /*
   2  * Copyright (c) 2017 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 #include <vnet/session/transport_interface.h>
  17 #include <vnet/session/session.h>
  18 #include <vnet/fib/fib.h>
  19
  20 /**
  21  * Per-type vector of transport protocol virtual function tables
  22  */
  23 transport_proto_vft_t *tp_vfts;
  24
  25 /*
  26  * Port allocator seed
  27  */
  28 static u32 port_allocator_seed;
  29
  30 /*
  31  * Local endpoints table
  32  */
  33 static transport_endpoint_table_t local_endpoints_table;
  34
  35 /*
  36  * Pool of local endpoints
  37  */
  38 static transport_endpoint_t *local_endpoints;
  39
  40 /*
  41  * Local endpoints pool lock
  42  */
  43 static clib_spinlock_t local_endpoints_lock;
  44
  45 u8 *
  46 format_transport_proto (u8 * s, va_list * args)
  47 {
  48   u32 transport_proto = va_arg (*args, u32);
  49   switch (transport_proto)
  50     {
  51     case TRANSPORT_PROTO_TCP:
  52       s = format (s, "TCP");
  53       break;
  54     case TRANSPORT_PROTO_UDP:
  55       s = format (s, "UDP");
  56       break;
  57     case TRANSPORT_PROTO_SCTP:
  58       s = format (s, "SCTP");
  59       break;
  60     case TRANSPORT_PROTO_UDPC:
  61       s = format (s, "UDPC");
  62       break;
  63     }
  64   return s;
  65 }
  66
  67 u8 *
  68 format_transport_proto_short (u8 * s, va_list * args)
  69 {
  70   u32 transport_proto = va_arg (*args, u32);
  71   switch (transport_proto)
  72     {
  73     case TRANSPORT_PROTO_TCP:
  74       s = format (s, "T");
  75       break;
  76     case TRANSPORT_PROTO_UDP:
  77       s = format (s, "U");
  78       break;
  79     case TRANSPORT_PROTO_SCTP:
  80       s = format (s, "S");
  81       break;
  82     case TRANSPORT_PROTO_UDPC:
  83       s = format (s, "U");
  84       break;
  85     }
  86   return s;
  87 }
  88
  89 uword
  90 unformat_transport_proto (unformat_input_t * input, va_list * args)
  91 {
  92   u32 *proto = va_arg (*args, u32 *);
  93   if (unformat (input, "tcp"))
  94     *proto = TRANSPORT_PROTO_TCP;
  95   else if (unformat (input, "TCP"))
  96     *proto = TRANSPORT_PROTO_TCP;
  97   else if (unformat (input, "udp"))
  98     *proto = TRANSPORT_PROTO_UDP;
  99   else if (unformat (input, "UDP"))
 100     *proto = TRANSPORT_PROTO_UDP;
 101   else if (unformat (input, "sctp"))
 102     *proto = TRANSPORT_PROTO_SCTP;
 103   else if (unformat (input, "SCTP"))
 104     *proto = TRANSPORT_PROTO_SCTP;
 105   else if (unformat (input, "tls"))
 106     *proto = TRANSPORT_PROTO_TLS;
 107   else if (unformat (input, "TLS"))
 108     *proto = TRANSPORT_PROTO_TLS;
 109   else if (unformat (input, "udpc"))
 110     *proto = TRANSPORT_PROTO_UDPC;
 111   else if (unformat (input, "UDPC"))
 112     *proto = TRANSPORT_PROTO_UDPC;
 113   else
 114     return 0;
 115   return 1;
 116 }
 117
 118 u32
 119 transport_endpoint_lookup (transport_endpoint_table_t * ht, u8 proto,
 120                            ip46_address_t * ip, u16 port)
 121 {
 122   clib_bihash_kv_24_8_t kv;
 123   int rv;
 124
 125   kv.key[0] = ip->as_u64[0];
 126   kv.key[1] = ip->as_u64[1];
 127   kv.key[2] = (u64) port << 8 | (u64) proto;
 128
 129   rv = clib_bihash_search_inline_24_8 (ht, &kv);
 130   if (rv == 0)
 131     return kv.value;
 132
 133   return ENDPOINT_INVALID_INDEX;
 134 }
 135
 136 void
 137 transport_endpoint_table_add (transport_endpoint_table_t * ht, u8 proto,
 138                               transport_endpoint_t * te, u32 value)
 139 {
 140   clib_bihash_kv_24_8_t kv;
 141
 142   kv.key[0] = te->ip.as_u64[0];
 143   kv.key[1] = te->ip.as_u64[1];
 144   kv.key[2] = (u64) te->port << 8 | (u64) proto;
 145   kv.value = value;
 146
 147   clib_bihash_add_del_24_8 (ht, &kv, 1);
 148 }
 149
 150 void
 151 transport_endpoint_table_del (transport_endpoint_table_t * ht, u8 proto,
 152                               transport_endpoint_t * te)
 153 {
 154   clib_bihash_kv_24_8_t kv;
 155
 156   kv.key[0] = te->ip.as_u64[0];
 157   kv.key[1] = te->ip.as_u64[1];
 158   kv.key[2] = (u64) te->port << 8 | (u64) proto;
 159
 160   clib_bihash_add_del_24_8 (ht, &kv, 0);
 161 }
 162
 163 /**
 164  * Register transport virtual function table.
 165  *
 166  * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
 167  * @param vft - virtual function table for transport proto
 168  * @param fib_proto - network layer protocol
 169  * @param output_node - output node index that session layer will hand off
 170  *                      buffers to, for requested fib proto
 171  */
 172 void
 173 transport_register_protocol (transport_proto_t transport_proto,
 174                              const transport_proto_vft_t * vft,
 175                              fib_protocol_t fib_proto, u32 output_node)
 176 {
 177   u8 is_ip4 = fib_proto == FIB_PROTOCOL_IP4;
 178
 179   vec_validate (tp_vfts, transport_proto);
 180   tp_vfts[transport_proto] = *vft;
 181
 182   session_register_transport (transport_proto, vft, is_ip4, output_node);
 183 }
 184
 185 /**
 186  * Get transport virtual function table
 187  *
 188  * @param type - session type (not protocol type)
 189  */
 190 transport_proto_vft_t *
 191 transport_protocol_get_vft (transport_proto_t transport_proto)
 192 {
 193   if (transport_proto >= vec_len (tp_vfts))
 194     return 0;
 195   return &tp_vfts[transport_proto];
 196 }
 197
 198 transport_service_type_t
 199 transport_protocol_service_type (transport_proto_t tp)
 200 {
 201   return tp_vfts[tp].service_type;
 202 }
 203
 204 transport_tx_fn_type_t
 205 transport_protocol_tx_fn_type (transport_proto_t tp)
 206 {
 207   return tp_vfts[tp].tx_type;
 208 }
 209
 210 #define PORT_MASK ((1 << 16)- 1)
 211
 212 void
 213 transport_endpoint_del (u32 tepi)
 214 {
 215   clib_spinlock_lock_if_init (&local_endpoints_lock);
 216   pool_put_index (local_endpoints, tepi);
 217   clib_spinlock_unlock_if_init (&local_endpoints_lock);
 218 }
 219
 220 always_inline transport_endpoint_t *
 221 transport_endpoint_new (void)
 222 {
 223   transport_endpoint_t *tep;
 224   pool_get (local_endpoints, tep);
 225   return tep;
 226 }
 227
 228 void
 229 transport_endpoint_cleanup (u8 proto, ip46_address_t * lcl_ip, u16 port)
 230 {
 231   u32 tepi;
 232   transport_endpoint_t *tep;
 233
 234   /* Cleanup local endpoint if this was an active connect */
 235   tepi = transport_endpoint_lookup (&local_endpoints_table, proto, lcl_ip,
 236                                     clib_net_to_host_u16 (port));
 237   if (tepi != ENDPOINT_INVALID_INDEX)
 238     {
 239       tep = pool_elt_at_index (local_endpoints, tepi);
 240       transport_endpoint_table_del (&local_endpoints_table, proto, tep);
 241       transport_endpoint_del (tepi);
 242     }
 243 }
 244
 245 /**
 246  * Allocate local port and add if successful add entry to local endpoint
 247  * table to mark the pair as used.
 248  */
 249 int
 250 transport_alloc_local_port (u8 proto, ip46_address_t * ip)
 251 {
 252   transport_endpoint_t *tep;
 253   u32 tei;
 254   u16 min = 1024, max = 65535;  /* XXX configurable ? */
 255   int tries, limit;
 256
 257   limit = max - min;
 258
 259   /* Only support active opens from thread 0 */
 260   ASSERT (vlib_get_thread_index () == 0);
 261
 262   /* Search for first free slot */
 263   for (tries = 0; tries < limit; tries++)
 264     {
 265       u16 port = 0;
 266
 267       /* Find a port in the specified range */
 268       while (1)
 269         {
 270           port = random_u32 (&port_allocator_seed) & PORT_MASK;
 271           if (PREDICT_TRUE (port >= min && port < max))
 272             break;
 273         }
 274
 275       /* Look it up. If not found, we're done */
 276       tei = transport_endpoint_lookup (&local_endpoints_table, proto, ip,
 277                                        port);
 278       if (tei == ENDPOINT_INVALID_INDEX)
 279         {
 280           clib_spinlock_lock_if_init (&local_endpoints_lock);
 281           tep = transport_endpoint_new ();
 282           clib_memcpy (&tep->ip, ip, sizeof (*ip));
 283           tep->port = port;
 284           transport_endpoint_table_add (&local_endpoints_table, proto, tep,
 285                                         tep - local_endpoints);
 286           clib_spinlock_unlock_if_init (&local_endpoints_lock);
 287
 288           return tep->port;
 289         }
 290     }
 291   return -1;
 292 }
 293
 294 int
 295 transport_alloc_local_endpoint (u8 proto, transport_endpoint_t * rmt,
 296                                 ip46_address_t * lcl_addr, u16 * lcl_port)
 297 {
 298   fib_prefix_t prefix;
 299   fib_node_index_t fei;
 300   u32 sw_if_index;
 301   int port;
 302
 303   /*
 304    * Find the local address and allocate port
 305    */
 306
 307   /* Find a FIB path to the destination */
 308   clib_memcpy (&prefix.fp_addr, &rmt->ip, sizeof (rmt->ip));
 309   prefix.fp_proto = rmt->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 310   prefix.fp_len = rmt->is_ip4 ? 32 : 128;
 311
 312   ASSERT (rmt->fib_index != ENDPOINT_INVALID_INDEX);
 313   fei = fib_table_lookup (rmt->fib_index, &prefix);
 314
 315   /* Couldn't find route to destination. Bail out. */
 316   if (fei == FIB_NODE_INDEX_INVALID)
 317     {
 318       clib_warning ("no route to destination");
 319       return -1;
 320     }
 321
 322   sw_if_index = rmt->sw_if_index;
 323   if (sw_if_index == ENDPOINT_INVALID_INDEX)
 324     sw_if_index = fib_entry_get_resolving_interface (fei);
 325
 326   if (sw_if_index == ENDPOINT_INVALID_INDEX)
 327     {
 328       clib_warning ("no resolving interface for %U", format_ip46_address,
 329                     &rmt->ip, (rmt->is_ip4 == 0) + 1);
 330       return -1;
 331     }
 332
 333   memset (lcl_addr, 0, sizeof (*lcl_addr));
 334
 335   if (rmt->is_ip4)
 336     {
 337       ip4_address_t *ip4;
 338       ip4 = ip_interface_get_first_ip (sw_if_index, 1);
 339       if (!ip4)
 340         {
 341           clib_warning ("no routable ip4 address on %U",
 342                         format_vnet_sw_if_index_name, vnet_get_main (),
 343                         sw_if_index);
 344           return -1;
 345         }
 346       lcl_addr->ip4.as_u32 = ip4->as_u32;
 347     }
 348   else
 349     {
 350       ip6_address_t *ip6;
 351       ip6 = ip_interface_get_first_ip (sw_if_index, 0);
 352       if (ip6 == 0)
 353         {
 354           clib_warning ("no routable ip6 addresses on %U",
 355                         format_vnet_sw_if_index_name, vnet_get_main (),
 356                         sw_if_index);
 357           return -1;
 358         }
 359       clib_memcpy (&lcl_addr->ip6, ip6, sizeof (*ip6));
 360     }
 361
 362   /* Allocate source port */
 363   port = transport_alloc_local_port (proto, lcl_addr);
 364   if (port < 1)
 365     {
 366       clib_warning ("Failed to allocate src port");
 367       return -1;
 368     }
 369   *lcl_port = port;
 370   return 0;
 371 }
 372
 373 void
 374 transport_update_time (f64 time_now, u8 thread_index)
 375 {
 376   transport_proto_vft_t *vft;
 377   vec_foreach (vft, tp_vfts)
 378   {
 379     if (vft->update_time)
 380       (vft->update_time) (time_now, thread_index);
 381   }
 382 }
 383
 384 void
 385 transport_enable_disable (vlib_main_t * vm, u8 is_en)
 386 {
 387   transport_proto_vft_t *vft;
 388   vec_foreach (vft, tp_vfts)
 389   {
 390     if (vft->enable)
 391       (vft->enable) (vm, is_en);
 392   }
 393 }
 394
 395 void
 396 transport_init (void)
 397 {
 398   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 399   session_manager_main_t *smm = vnet_get_session_manager_main ();
 400   u32 num_threads;
 401
 402   if (smm->local_endpoints_table_buckets == 0)
 403     smm->local_endpoints_table_buckets = 250000;
 404   if (smm->local_endpoints_table_memory == 0)
 405     smm->local_endpoints_table_memory = 512 << 20;
 406
 407   /* Initialize [port-allocator] random number seed */
 408   port_allocator_seed = (u32) clib_cpu_time_now ();
 409
 410   clib_bihash_init_24_8 (&local_endpoints_table, "local endpoints table",
 411                          smm->local_endpoints_table_buckets,
 412                          smm->local_endpoints_table_memory);
 413   num_threads = 1 /* main thread */  + vtm->n_threads;
 414   if (num_threads > 1)
 415     clib_spinlock_init (&local_endpoints_lock);
 416 }
 417
 418 /*
 419  * fd.io coding-style-patch-verification: ON
 420  *
 421  * Local Variables:
 422  * eval: (c-set-style "gnu")
 423  * End:
 424  */