src/vnet/udp/udp.h

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