misc: minimize dependencies on udp.h
[vpp.git] / src / vnet / udp / udp.h
index bd163e2..8f4b2f1 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017 Cisco and/or its affiliates.
+ * Copyright (c) 2017-2020 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at:
 #define __included_udp_h__
 
 #include <vnet/vnet.h>
+#include <vnet/udp/udp_inlines.h>
+#include <vnet/udp/udp_local.h>
 #include <vnet/udp/udp_packet.h>
 #include <vnet/ip/ip.h>
 #include <vnet/ip/ip4.h>
 #include <vnet/ip/ip4_packet.h>
-#include <vnet/pg/pg.h>
 #include <vnet/ip/format.h>
 
 #include <vnet/ip/ip.h>
 #include <vnet/session/transport.h>
 
-typedef struct
-{
-  transport_connection_t connection;         /** must be first */
-
-  /** ersatz MTU to limit fifo pushes to test data size */
-  u32 mtu;
-} udp_connection_t;
-
-typedef struct _udp_uri_main
-{
-  /* Per-worker thread udp connection pools */
-  udp_connection_t **udp_sessions;
-  udp_connection_t *udp_listeners;
-
-  /* convenience */
-  vlib_main_t *vlib_main;
-  vnet_main_t *vnet_main;
-  ip4_main_t *ip4_main;
-  ip6_main_t *ip6_main;
-} udp_uri_main_t;
-
-extern udp_uri_main_t udp_uri_main;
-extern vlib_node_registration_t udp4_uri_input_node;
-
-always_inline udp_uri_main_t *
-vnet_get_udp_main ()
-{
-  return &udp_uri_main;
-}
-
-always_inline udp_connection_t *
-udp_connection_get (u32 conn_index, u32 thread_index)
-{
-  return pool_elt_at_index (udp_uri_main.udp_sessions[thread_index],
-                           conn_index);
-}
-
-always_inline udp_connection_t *
-udp_listener_get (u32 conn_index)
-{
-  return pool_elt_at_index (udp_uri_main.udp_listeners, conn_index);
-}
-
 typedef enum
 {
 #define udp_error(n,s) UDP_ERROR_##n,
@@ -77,51 +35,44 @@ typedef enum
   UDP_N_ERROR,
 } udp_error_t;
 
-#define foreach_udp4_dst_port                  \
-_ (67, dhcp_to_server)                          \
-_ (68, dhcp_to_client)                          \
-_ (500, ikev2)                                  \
-_ (3784, bfd4)                                  \
-_ (3785, bfd_echo4)                             \
-_ (4341, lisp_gpe)                              \
-_ (4342, lisp_cp)                              \
-_ (4739, ipfix)                                 \
-_ (4789, vxlan)                                        \
-_ (4789, vxlan6)                               \
-_ (4790, vxlan_gpe)                            \
-_ (6633, vpath_3)
-
-
-#define foreach_udp6_dst_port                   \
-_ (547, dhcpv6_to_server)                       \
-_ (546, dhcpv6_to_client)                      \
-_ (3784, bfd6)                                  \
-_ (3785, bfd_echo6)                             \
-_ (4341, lisp_gpe6)                             \
-_ (4342, lisp_cp6)                             \
-_ (4790, vxlan6_gpe)      \
-_ (6633, vpath6_3)
+#define foreach_udp_connection_flag                                    \
+  _(CONNECTED, "CONNECTED")    /**< connected mode */                  \
+  _(OWNS_PORT, "OWNS_PORT")    /**< port belong to conn (UDPC) */      \
+  _(CLOSING, "CLOSING")                /**< conn closed with data */           \
+  _(LISTEN, "LISTEN")          /**< conn is listening */               \
+  _(MIGRATED, "MIGRATED")      /**< cloned to another thread */        \
 
-typedef enum
+enum udp_conn_flags_bits
 {
-#define _(n,f) UDP_DST_PORT_##f = n,
-  foreach_udp4_dst_port foreach_udp6_dst_port
+#define _(sym, str) UDP_CONN_F_BIT_##sym,
+  foreach_udp_connection_flag
 #undef _
-} udp_dst_port_t;
+  UDP_CONN_N_FLAGS
+};
 
-typedef enum
+typedef enum udp_conn_flags_
 {
-#define _(n,f) UDP6_DST_PORT_##f = n,
-  foreach_udp6_dst_port
+#define _(sym, str) UDP_CONN_F_##sym = 1 << UDP_CONN_F_BIT_##sym,
+  foreach_udp_connection_flag
 #undef _
-} udp6_dst_port_t;
+} udp_conn_flags_t;
+
+typedef struct
+{
+  /** Required for pool_get_aligned */
+  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
+  transport_connection_t connection;   /**< must be first */
+  clib_spinlock_t rx_lock;             /**< rx fifo lock */
+  u8 flags;                            /**< connection flags */
+  u16 mss;                             /**< connection mss */
+} udp_connection_t;
 
 typedef struct
 {
   /* Name (a c string). */
   char *name;
 
-  /* GRE protocol type in host byte order. */
+  /* Port number in host byte order. */
   udp_dst_port_t dst_port;
 
   /* Node which handles this type. */
@@ -129,6 +80,12 @@ typedef struct
 
   /* Next index for this type. */
   u32 next_index;
+
+  /* UDP sessions refcount (not tunnels) */
+  u32 n_connections;
+
+  /* Parser for packet generator edits for this protocol */
+  unformat_function_t *unformat_pg_edit;
 } udp_dst_port_info_t;
 
 typedef enum
@@ -153,211 +110,136 @@ typedef struct
   u8 punt_unknown4;
   u8 punt_unknown6;
 
-  /* convenience */
-  vlib_main_t *vlib_main;
+  /* Udp local to input arc index */
+  u32 local_to_input_edge[N_UDP_AF];
+
+  /*
+   * Per-worker thread udp connection pools used with session layer
+   */
+  udp_connection_t **connections;
+  u32 *connection_peekers;
+  clib_spinlock_t *peekers_readers_locks;
+  clib_spinlock_t *peekers_write_locks;
+  udp_connection_t *listener_pool;
+
+  u16 default_mtu;
 } udp_main_t;
 
-always_inline udp_dst_port_info_t *
-udp_get_dst_port_info (udp_main_t * um, udp_dst_port_t dst_port, u8 is_ip4)
+extern udp_main_t udp_main;
+extern vlib_node_registration_t udp4_input_node;
+extern vlib_node_registration_t udp6_input_node;
+extern vlib_node_registration_t udp4_local_node;
+extern vlib_node_registration_t udp6_local_node;
+
+void udp_add_dst_port (udp_main_t * um, udp_dst_port_t dst_port,
+                      char *dst_port_name, u8 is_ip4);
+
+always_inline udp_connection_t *
+udp_connection_get (u32 conn_index, u32 thread_index)
 {
-  uword *p = hash_get (um->dst_port_info_by_dst_port[is_ip4], dst_port);
-  return p ? vec_elt_at_index (um->dst_port_infos[is_ip4], p[0]) : 0;
+  if (pool_is_free_index (udp_main.connections[thread_index], conn_index))
+    return 0;
+  return pool_elt_at_index (udp_main.connections[thread_index], conn_index);
 }
 
-format_function_t format_udp_header;
-format_function_t format_udp_rx_trace;
+always_inline udp_connection_t *
+udp_listener_get (u32 conn_index)
+{
+  return pool_elt_at_index (udp_main.listener_pool, conn_index);
+}
 
-unformat_function_t unformat_udp_header;
+always_inline udp_main_t *
+vnet_get_udp_main ()
+{
+  return &udp_main;
+}
 
-void udp_register_dst_port (vlib_main_t * vm,
-                           udp_dst_port_t dst_port,
-                           u32 node_index, u8 is_ip4);
+always_inline udp_connection_t *
+udp_connection_from_transport (transport_connection_t * tc)
+{
+  return ((udp_connection_t *) tc);
+}
 
-void
-udp_unregister_dst_port (vlib_main_t * vm,
-                        udp_dst_port_t dst_port, u8 is_ip4);
+always_inline u32
+udp_connection_index (udp_connection_t * uc)
+{
+  return (uc - udp_main.connections[uc->c_thread_index]);
+}
 
-void udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
+void udp_connection_free (udp_connection_t * uc);
+udp_connection_t *udp_connection_alloc (u32 thread_index);
 
+/**
+ * Acquires a lock that blocks a connection pool from expanding.
+ */
 always_inline void
-ip_udp_fixup_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 is_ip4)
+udp_pool_add_peeker (u32 thread_index)
 {
-  u16 new_l0;
-  udp_header_t *udp0;
-
-  if (is_ip4)
-    {
-      ip4_header_t *ip0;
-      ip_csum_t sum0;
-      u16 old_l0 = 0;
-
-      ip0 = vlib_buffer_get_current (b0);
-
-      /* fix the <bleep>ing outer-IP checksum */
-      sum0 = ip0->checksum;
-      /* old_l0 always 0, see the rewrite setup */
-      new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
-
-      sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
-                            length /* changed member */ );
-      ip0->checksum = ip_csum_fold (sum0);
-      ip0->length = new_l0;
-
-      /* Fix UDP length */
-      udp0 = (udp_header_t *) (ip0 + 1);
-      new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
-                                    - sizeof (*ip0));
-      udp0->length = new_l0;
-    }
-  else
-    {
-      ip6_header_t *ip0;
-      int bogus0;
-
-      ip0 = vlib_buffer_get_current (b0);
-
-      new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
-                                    - sizeof (*ip0));
-      ip0->payload_length = new_l0;
-
-      /* Fix UDP length */
-      udp0 = (udp_header_t *) (ip0 + 1);
-      udp0->length = new_l0;
-
-      udp0->checksum =
-       ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
-      ASSERT (bogus0 == 0);
-
-      if (udp0->checksum == 0)
-       udp0->checksum = 0xffff;
-    }
+  if (thread_index != vlib_get_thread_index ())
+    return;
+  clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
+  udp_main.connection_peekers[thread_index] += 1;
+  if (udp_main.connection_peekers[thread_index] == 1)
+    clib_spinlock_lock_if_init (&udp_main.peekers_write_locks[thread_index]);
+  clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
+                               [thread_index]);
 }
 
 always_inline void
-ip_udp_encap_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 * ec0, word ec_len,
-                 u8 is_ip4)
+udp_pool_remove_peeker (u32 thread_index)
 {
-  vlib_buffer_advance (b0, -ec_len);
-
-  if (is_ip4)
-    {
-      ip4_header_t *ip0;
-
-      ip0 = vlib_buffer_get_current (b0);
-
-      /* Apply the encap string. */
-      clib_memcpy (ip0, ec0, ec_len);
-      ip_udp_fixup_one (vm, b0, 1);
-    }
-  else
-    {
-      ip6_header_t *ip0;
-
-      ip0 = vlib_buffer_get_current (b0);
+  if (thread_index != vlib_get_thread_index ())
+    return;
+  ASSERT (udp_main.connection_peekers[thread_index] > 0);
+  clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
+  udp_main.connection_peekers[thread_index] -= 1;
+  if (udp_main.connection_peekers[thread_index] == 0)
+    clib_spinlock_unlock_if_init (&udp_main.peekers_write_locks
+                                 [thread_index]);
+  clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
+                               [thread_index]);
+}
 
-      /* Apply the encap string. */
-      clib_memcpy (ip0, ec0, ec_len);
-      ip_udp_fixup_one (vm, b0, 0);
-    }
+always_inline udp_connection_t *
+udp_connection_clone_safe (u32 connection_index, u32 thread_index)
+{
+  udp_connection_t *old_c, *new_c;
+  u32 current_thread_index = vlib_get_thread_index ();
+  new_c = udp_connection_alloc (current_thread_index);
+
+  /* If during the memcpy pool is reallocated AND the memory allocator
+   * decides to give the old chunk of memory to somebody in a hurry to
+   * scribble something on it, we have a problem. So add this thread as
+   * a session pool peeker.
+   */
+  udp_pool_add_peeker (thread_index);
+  old_c = udp_main.connections[thread_index] + connection_index;
+  clib_memcpy_fast (new_c, old_c, sizeof (*new_c));
+  old_c->flags |= UDP_CONN_F_MIGRATED;
+  udp_pool_remove_peeker (thread_index);
+  new_c->c_thread_index = current_thread_index;
+  new_c->c_c_index = udp_connection_index (new_c);
+  new_c->c_fib_index = old_c->c_fib_index;
+  return new_c;
 }
 
-always_inline void
-ip_udp_encap_two (vlib_main_t * vm, vlib_buffer_t * b0, vlib_buffer_t * b1,
-                 u8 * ec0, u8 * ec1, word ec_len, u8 is_v4)
+always_inline udp_dst_port_info_t *
+udp_get_dst_port_info (udp_main_t * um, udp_dst_port_t dst_port, u8 is_ip4)
 {
-  u16 new_l0, new_l1;
-  udp_header_t *udp0, *udp1;
-
-  ASSERT (_vec_len (ec0) == _vec_len (ec1));
-
-  vlib_buffer_advance (b0, -ec_len);
-  vlib_buffer_advance (b1, -ec_len);
-
-  if (is_v4)
-    {
-      ip4_header_t *ip0, *ip1;
-      ip_csum_t sum0, sum1;
-      u16 old_l0 = 0, old_l1 = 0;
-
-      ip0 = vlib_buffer_get_current (b0);
-      ip1 = vlib_buffer_get_current (b1);
-
-      /* Apply the encap string */
-      clib_memcpy (ip0, ec0, ec_len);
-      clib_memcpy (ip1, ec1, ec_len);
-
-      /* fix the <bleep>ing outer-IP checksum */
-      sum0 = ip0->checksum;
-      sum1 = ip1->checksum;
-
-      /* old_l0 always 0, see the rewrite setup */
-      new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
-      new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1));
-
-      sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
-                            length /* changed member */ );
-      sum1 = ip_csum_update (sum1, old_l1, new_l1, ip4_header_t,
-                            length /* changed member */ );
-
-      ip0->checksum = ip_csum_fold (sum0);
-      ip1->checksum = ip_csum_fold (sum1);
-
-      ip0->length = new_l0;
-      ip1->length = new_l1;
-
-      /* Fix UDP length */
-      udp0 = (udp_header_t *) (ip0 + 1);
-      udp1 = (udp_header_t *) (ip1 + 1);
-
-      new_l0 =
-       clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
-                             sizeof (*ip0));
-      new_l1 =
-       clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1) -
-                             sizeof (*ip1));
-      udp0->length = new_l0;
-      udp1->length = new_l1;
-    }
-  else
-    {
-      ip6_header_t *ip0, *ip1;
-      int bogus0, bogus1;
-
-      ip0 = vlib_buffer_get_current (b0);
-      ip1 = vlib_buffer_get_current (b1);
-
-      /* Apply the encap string. */
-      clib_memcpy (ip0, ec0, ec_len);
-      clib_memcpy (ip1, ec1, ec_len);
-
-      new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
-                                    - sizeof (*ip0));
-      new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1)
-                                    - sizeof (*ip1));
-      ip0->payload_length = new_l0;
-      ip1->payload_length = new_l1;
-
-      /* Fix UDP length */
-      udp0 = (udp_header_t *) (ip0 + 1);
-      udp1 = (udp_header_t *) (ip1 + 1);
-
-      udp0->length = new_l0;
-      udp1->length = new_l1;
-
-      udp0->checksum =
-       ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
-      udp1->checksum =
-       ip6_tcp_udp_icmp_compute_checksum (vm, b1, ip1, &bogus1);
-      ASSERT (bogus0 == 0);
-      ASSERT (bogus1 == 0);
-
-      if (udp0->checksum == 0)
-       udp0->checksum = 0xffff;
-      if (udp1->checksum == 0)
-       udp1->checksum = 0xffff;
-    }
+  uword *p = hash_get (um->dst_port_info_by_dst_port[is_ip4], dst_port);
+  return p ? vec_elt_at_index (um->dst_port_infos[is_ip4], p[0]) : 0;
 }
 
+format_function_t format_udp_header;
+format_function_t format_udp_rx_trace;
+format_function_t format_udp_connection;
+unformat_function_t unformat_udp_header;
+unformat_function_t unformat_udp_port;
+
+void udp_connection_share_port (u16 lcl_port, u8 is_ip4);
+
+void udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
+
 /*
  * fd.io coding-style-patch-verification: ON
  *