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