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