src/vnet/udp/udp.h

   1 /*
   2  * Copyright (c) 2017-2019 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 #ifndef __included_udp_h__
  16 #define __included_udp_h__
  17
  18 #include <vnet/vnet.h>
  19 #include <vnet/udp/udp_packet.h>
  20 #include <vnet/ip/ip.h>
  21 #include <vnet/ip/ip4.h>
  22 #include <vnet/ip/ip4_packet.h>
  23 #include <vnet/pg/pg.h>
  24 #include <vnet/ip/format.h>
  25
  26 #include <vnet/ip/ip.h>
  27 #include <vnet/session/transport.h>
  28
  29 typedef enum
  30 {
  31 #define udp_error(n,s) UDP_ERROR_##n,
  32 #include <vnet/udp/udp_error.def>
  33 #undef udp_error
  34   UDP_N_ERROR,
  35 } udp_error_t;
  36
  37 typedef struct
  38 {
  39   /** Required for pool_get_aligned */
  40   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  41   transport_connection_t connection;    /**< must be first */
  42   clib_spinlock_t rx_lock;              /**< rx fifo lock */
  43   u8 is_connected;                      /**< connected mode */
  44   u8 owns_port;                         /**< does port belong to conn (UDPC) */
  45 } udp_connection_t;
  46
  47 #define foreach_udp4_dst_port                   \
  48 _ (53, dns)                                     \
  49 _ (67, dhcp_to_server)                          \
  50 _ (68, dhcp_to_client)                          \
  51 _ (500, ikev2)                                  \
  52 _ (2152, GTPU)                                  \
  53 _ (3784, bfd4)                                  \
  54 _ (3785, bfd_echo4)                             \
  55 _ (4341, lisp_gpe)                              \
  56 _ (4342, lisp_cp)                               \
  57 _ (4500, ipsec)                                 \
  58 _ (4739, ipfix)                                 \
  59 _ (4789, vxlan)                                 \
  60 _ (4789, vxlan6)                                \
  61 _ (48879, vxlan_gbp)                            \
  62 _ (4790, VXLAN_GPE)                             \
  63 _ (6633, vpath_3)                               \
  64 _ (6081, geneve)                                \
  65 _ (53053, dns_reply)
  66
  67
  68 #define foreach_udp6_dst_port                   \
  69 _ (53, dns6)                                    \
  70 _ (547, dhcpv6_to_server)                       \
  71 _ (546, dhcpv6_to_client)                       \
  72 _ (2152, GTPU6)                                 \
  73 _ (3784, bfd6)                                  \
  74 _ (3785, bfd_echo6)                             \
  75 _ (4341, lisp_gpe6)                             \
  76 _ (4342, lisp_cp6)                              \
  77 _ (48879, vxlan6_gbp)                           \
  78 _ (4790, VXLAN6_GPE)                            \
  79 _ (6633, vpath6_3)                              \
  80 _ (6081, geneve6)                               \
  81 _ (8138, BIER)                                  \
  82 _ (53053, dns_reply6)
  83
  84 typedef enum
  85 {
  86 #define _(n,f) UDP_DST_PORT_##f = n,
  87   foreach_udp4_dst_port foreach_udp6_dst_port
  88 #undef _
  89 } udp_dst_port_t;
  90
  91 typedef enum
  92 {
  93 #define _(n,f) UDP6_DST_PORT_##f = n,
  94   foreach_udp6_dst_port
  95 #undef _
  96 } udp6_dst_port_t;
  97
  98 typedef struct
  99 {
 100   /* Name (a c string). */
 101   char *name;
 102
 103   /* GRE protocol type in host byte order. */
 104   udp_dst_port_t dst_port;
 105
 106   /* Node which handles this type. */
 107   u32 node_index;
 108
 109   /* Next index for this type. */
 110   u32 next_index;
 111
 112   /* Parser for packet generator edits for this protocol */
 113   unformat_function_t *unformat_pg_edit;
 114 } udp_dst_port_info_t;
 115
 116 typedef enum
 117 {
 118   UDP_IP6 = 0,
 119   UDP_IP4,                      /* the code is full of is_ip4... */
 120   N_UDP_AF,
 121 } udp_af_t;
 122
 123 typedef struct
 124 {
 125   udp_dst_port_info_t *dst_port_infos[N_UDP_AF];
 126
 127   /* Hash tables mapping name/protocol to protocol info index. */
 128   uword *dst_port_info_by_name[N_UDP_AF];
 129   uword *dst_port_info_by_dst_port[N_UDP_AF];
 130
 131   /* Sparse vector mapping udp dst_port in network byte order
 132      to next index. */
 133   u16 *next_by_dst_port4;
 134   u16 *next_by_dst_port6;
 135   u8 punt_unknown4;
 136   u8 punt_unknown6;
 137
 138   /*
 139    * Per-worker thread udp connection pools used with session layer
 140    */
 141   udp_connection_t **connections;
 142   u32 *connection_peekers;
 143   clib_spinlock_t *peekers_readers_locks;
 144   clib_spinlock_t *peekers_write_locks;
 145   udp_connection_t *listener_pool;
 146
 147 } udp_main_t;
 148
 149 extern udp_main_t udp_main;
 150 extern vlib_node_registration_t udp4_input_node;
 151 extern vlib_node_registration_t udp6_input_node;
 152 extern vlib_node_registration_t udp4_local_node;
 153 extern vlib_node_registration_t udp6_local_node;
 154
 155 always_inline udp_connection_t *
 156 udp_connection_get (u32 conn_index, u32 thread_index)
 157 {
 158   if (pool_is_free_index (udp_main.connections[thread_index], conn_index))
 159     return 0;
 160   return pool_elt_at_index (udp_main.connections[thread_index], conn_index);
 161 }
 162
 163 always_inline udp_connection_t *
 164 udp_listener_get (u32 conn_index)
 165 {
 166   return pool_elt_at_index (udp_main.listener_pool, conn_index);
 167 }
 168
 169 always_inline udp_main_t *
 170 vnet_get_udp_main ()
 171 {
 172   return &udp_main;
 173 }
 174
 175 always_inline udp_connection_t *
 176 udp_get_connection_from_transport (transport_connection_t * tc)
 177 {
 178   return ((udp_connection_t *) tc);
 179 }
 180
 181 always_inline u32
 182 udp_connection_index (udp_connection_t * uc)
 183 {
 184   return (uc - udp_main.connections[uc->c_thread_index]);
 185 }
 186
 187 udp_connection_t *udp_connection_alloc (u32 thread_index);
 188
 189 /**
 190  * Acquires a lock that blocks a connection pool from expanding.
 191  */
 192 always_inline void
 193 udp_pool_add_peeker (u32 thread_index)
 194 {
 195   if (thread_index != vlib_get_thread_index ())
 196     return;
 197   clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
 198   udp_main.connection_peekers[thread_index] += 1;
 199   if (udp_main.connection_peekers[thread_index] == 1)
 200     clib_spinlock_lock_if_init (&udp_main.peekers_write_locks[thread_index]);
 201   clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
 202                                 [thread_index]);
 203 }
 204
 205 always_inline void
 206 udp_pool_remove_peeker (u32 thread_index)
 207 {
 208   if (thread_index != vlib_get_thread_index ())
 209     return;
 210   ASSERT (udp_main.connection_peekers[thread_index] > 0);
 211   clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
 212   udp_main.connection_peekers[thread_index] -= 1;
 213   if (udp_main.connection_peekers[thread_index] == 0)
 214     clib_spinlock_unlock_if_init (&udp_main.peekers_write_locks
 215                                   [thread_index]);
 216   clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
 217                                 [thread_index]);
 218 }
 219
 220 always_inline udp_connection_t *
 221 udp_connection_clone_safe (u32 connection_index, u32 thread_index)
 222 {
 223   udp_connection_t *old_c, *new_c;
 224   u32 current_thread_index = vlib_get_thread_index ();
 225   new_c = udp_connection_alloc (current_thread_index);
 226
 227   /* If during the memcpy pool is reallocated AND the memory allocator
 228    * decides to give the old chunk of memory to somebody in a hurry to
 229    * scribble something on it, we have a problem. So add this thread as
 230    * a session pool peeker.
 231    */
 232   udp_pool_add_peeker (thread_index);
 233   old_c = udp_main.connections[thread_index] + connection_index;
 234   clib_memcpy_fast (new_c, old_c, sizeof (*new_c));
 235   udp_pool_remove_peeker (thread_index);
 236   new_c->c_thread_index = current_thread_index;
 237   new_c->c_c_index = udp_connection_index (new_c);
 238   new_c->is_connected = old_c->is_connected;
 239   new_c->c_fib_index = old_c->c_fib_index;
 240   return new_c;
 241 }
 242
 243
 244 always_inline udp_dst_port_info_t *
 245 udp_get_dst_port_info (udp_main_t * um, udp_dst_port_t dst_port, u8 is_ip4)
 246 {
 247   uword *p = hash_get (um->dst_port_info_by_dst_port[is_ip4], dst_port);
 248   return p ? vec_elt_at_index (um->dst_port_infos[is_ip4], p[0]) : 0;
 249 }
 250
 251 format_function_t format_udp_header;
 252 format_function_t format_udp_rx_trace;
 253 unformat_function_t unformat_udp_header;
 254
 255 void udp_register_dst_port (vlib_main_t * vm,
 256                             udp_dst_port_t dst_port,
 257                             u32 node_index, u8 is_ip4);
 258 void udp_unregister_dst_port (vlib_main_t * vm,
 259                               udp_dst_port_t dst_port, u8 is_ip4);
 260 bool udp_is_valid_dst_port (udp_dst_port_t dst_port, u8 is_ip4);
 261
 262 void udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
 263
 264 always_inline void *
 265 vlib_buffer_push_udp (vlib_buffer_t * b, u16 sp, u16 dp, u8 offload_csum)
 266 {
 267   udp_header_t *uh;
 268   u16 udp_len = sizeof (udp_header_t) + b->current_length;
 269   if (PREDICT_FALSE (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID))
 270     udp_len += b->total_length_not_including_first_buffer;
 271
 272   uh = vlib_buffer_push_uninit (b, sizeof (udp_header_t));
 273   uh->src_port = sp;
 274   uh->dst_port = dp;
 275   uh->checksum = 0;
 276   uh->length = clib_host_to_net_u16 (udp_len);
 277   if (offload_csum)
 278     {
 279       b->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
 280       vnet_buffer (b)->l4_hdr_offset = (u8 *) uh - b->data;
 281     }
 282   return uh;
 283 }
 284
 285 always_inline void
 286 ip_udp_fixup_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 is_ip4)
 287 {
 288   u16 new_l0;
 289   udp_header_t *udp0;
 290
 291   if (is_ip4)
 292     {
 293       ip4_header_t *ip0;
 294       ip_csum_t sum0;
 295       u16 old_l0 = 0;
 296
 297       ip0 = vlib_buffer_get_current (b0);
 298
 299       /* fix the <bleep>ing outer-IP checksum */
 300       sum0 = ip0->checksum;
 301       /* old_l0 always 0, see the rewrite setup */
 302       new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
 303
 304       sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
 305                              length /* changed member */ );
 306       ip0->checksum = ip_csum_fold (sum0);
 307       ip0->length = new_l0;
 308
 309       /* Fix UDP length */
 310       udp0 = (udp_header_t *) (ip0 + 1);
 311       new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
 312                                      - sizeof (*ip0));
 313       udp0->length = new_l0;
 314     }
 315   else
 316     {
 317       ip6_header_t *ip0;
 318       int bogus0;
 319
 320       ip0 = vlib_buffer_get_current (b0);
 321
 322       new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
 323                                      - sizeof (*ip0));
 324       ip0->payload_length = new_l0;
 325
 326       /* Fix UDP length */
 327       udp0 = (udp_header_t *) (ip0 + 1);
 328       udp0->length = new_l0;
 329
 330       udp0->checksum =
 331         ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
 332       ASSERT (bogus0 == 0);
 333
 334       if (udp0->checksum == 0)
 335         udp0->checksum = 0xffff;
 336     }
 337 }
 338
 339 always_inline void
 340 ip_udp_encap_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 * ec0, word ec_len,
 341                   u8 is_ip4)
 342 {
 343   vlib_buffer_advance (b0, -ec_len);
 344
 345   if (is_ip4)
 346     {
 347       ip4_header_t *ip0;
 348
 349       ip0 = vlib_buffer_get_current (b0);
 350
 351       /* Apply the encap string. */
 352       clib_memcpy_fast (ip0, ec0, ec_len);
 353       ip_udp_fixup_one (vm, b0, 1);
 354     }
 355   else
 356     {
 357       ip6_header_t *ip0;
 358
 359       ip0 = vlib_buffer_get_current (b0);
 360
 361       /* Apply the encap string. */
 362       clib_memcpy_fast (ip0, ec0, ec_len);
 363       ip_udp_fixup_one (vm, b0, 0);
 364     }
 365 }
 366
 367 always_inline void
 368 ip_udp_encap_two (vlib_main_t * vm, vlib_buffer_t * b0, vlib_buffer_t * b1,
 369                   u8 * ec0, u8 * ec1, word ec_len, u8 is_v4)
 370 {
 371   u16 new_l0, new_l1;
 372   udp_header_t *udp0, *udp1;
 373
 374   ASSERT (_vec_len (ec0) == _vec_len (ec1));
 375
 376   vlib_buffer_advance (b0, -ec_len);
 377   vlib_buffer_advance (b1, -ec_len);
 378
 379   if (is_v4)
 380     {
 381       ip4_header_t *ip0, *ip1;
 382       ip_csum_t sum0, sum1;
 383       u16 old_l0 = 0, old_l1 = 0;
 384
 385       ip0 = vlib_buffer_get_current (b0);
 386       ip1 = vlib_buffer_get_current (b1);
 387
 388       /* Apply the encap string */
 389       clib_memcpy_fast (ip0, ec0, ec_len);
 390       clib_memcpy_fast (ip1, ec1, ec_len);
 391
 392       /* fix the <bleep>ing outer-IP checksum */
 393       sum0 = ip0->checksum;
 394       sum1 = ip1->checksum;
 395
 396       /* old_l0 always 0, see the rewrite setup */
 397       new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
 398       new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1));
 399
 400       sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
 401                              length /* changed member */ );
 402       sum1 = ip_csum_update (sum1, old_l1, new_l1, ip4_header_t,
 403                              length /* changed member */ );
 404
 405       ip0->checksum = ip_csum_fold (sum0);
 406       ip1->checksum = ip_csum_fold (sum1);
 407
 408       ip0->length = new_l0;
 409       ip1->length = new_l1;
 410
 411       /* Fix UDP length */
 412       udp0 = (udp_header_t *) (ip0 + 1);
 413       udp1 = (udp_header_t *) (ip1 + 1);
 414
 415       new_l0 =
 416         clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
 417                               sizeof (*ip0));
 418       new_l1 =
 419         clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1) -
 420                               sizeof (*ip1));
 421       udp0->length = new_l0;
 422       udp1->length = new_l1;
 423     }
 424   else
 425     {
 426       ip6_header_t *ip0, *ip1;
 427       int bogus0, bogus1;
 428
 429       ip0 = vlib_buffer_get_current (b0);
 430       ip1 = vlib_buffer_get_current (b1);
 431
 432       /* Apply the encap string. */
 433       clib_memcpy_fast (ip0, ec0, ec_len);
 434       clib_memcpy_fast (ip1, ec1, ec_len);
 435
 436       new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
 437                                      - sizeof (*ip0));
 438       new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1)
 439                                      - sizeof (*ip1));
 440       ip0->payload_length = new_l0;
 441       ip1->payload_length = new_l1;
 442
 443       /* Fix UDP length */
 444       udp0 = (udp_header_t *) (ip0 + 1);
 445       udp1 = (udp_header_t *) (ip1 + 1);
 446
 447       udp0->length = new_l0;
 448       udp1->length = new_l1;
 449
 450       udp0->checksum =
 451         ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
 452       udp1->checksum =
 453         ip6_tcp_udp_icmp_compute_checksum (vm, b1, ip1, &bogus1);
 454       ASSERT (bogus0 == 0);
 455       ASSERT (bogus1 == 0);
 456
 457       if (udp0->checksum == 0)
 458         udp0->checksum = 0xffff;
 459       if (udp1->checksum == 0)
 460         udp1->checksum = 0xffff;
 461     }
 462 }
 463
 464 /*
 465  * fd.io coding-style-patch-verification: ON
 466  *
 467  * Local Variables:
 468  * eval: (c-set-style "gnu")
 469  * End:
 470  */
 471
 472 #endif /* __included_udp_h__ */