src/vnet/udp/udp.h

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