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_inlines.h>
  20 #include <vnet/udp/udp_local.h>
  21 #include <vnet/udp/udp_packet.h>
  22 #include <vnet/ip/ip4_packet.h>
  23 #include <vnet/ip/format.h>
  24
  25 #include <vnet/ip/ip.h>
  26 #include <vnet/session/transport.h>
  27
  28 typedef enum
  29 {
  30 #define udp_error(f, n, s, d) UDP_ERROR_##f,
  31 #include <vnet/udp/udp_error.def>
  32 #undef udp_error
  33   UDP_N_ERROR,
  34 } udp_error_t;
  35
  36 #define foreach_udp_connection_flag                                     \
  37   _(CONNECTED, "CONNECTED")     /**< connected mode */                  \
  38   _(OWNS_PORT, "OWNS_PORT")     /**< port belong to conn (UDPC) */      \
  39   _(CLOSING, "CLOSING")         /**< conn closed with data */           \
  40   _(LISTEN, "LISTEN")           /**< conn is listening */               \
  41   _(MIGRATED, "MIGRATED")       /**< cloned to another thread */        \
  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   u16 mss;                              /**< connection mss */
  66   u32 sw_if_index;                      /**< connection sw_if_index */
  67   u32 next_node_index;  /**< Can be used to control next node in output */
  68   u32 next_node_opaque; /**< Opaque to pass to next node */
  69 } udp_connection_t;
  70
  71 typedef struct
  72 {
  73   /* Name (a c string). */
  74   char *name;
  75
  76   /* Port number in host byte order. */
  77   udp_dst_port_t dst_port;
  78
  79   /* Node which handles this type. */
  80   u32 node_index;
  81
  82   /* Next index for this type. */
  83   u32 next_index;
  84
  85   /* UDP sessions refcount (not tunnels) */
  86   u32 n_connections;
  87
  88   /* Parser for packet generator edits for this protocol */
  89   unformat_function_t *unformat_pg_edit;
  90 } udp_dst_port_info_t;
  91
  92 typedef enum
  93 {
  94   UDP_IP6 = 0,
  95   UDP_IP4,                      /* the code is full of is_ip4... */
  96   N_UDP_AF,
  97 } udp_af_t;
  98
  99 typedef struct
 100 {
 101   udp_dst_port_info_t *dst_port_infos[N_UDP_AF];
 102
 103   /* Hash tables mapping name/protocol to protocol info index. */
 104   uword *dst_port_info_by_name[N_UDP_AF];
 105   uword *dst_port_info_by_dst_port[N_UDP_AF];
 106
 107   /* Sparse vector mapping udp dst_port in network byte order
 108      to next index. */
 109   u16 *next_by_dst_port4;
 110   u16 *next_by_dst_port6;
 111   u8 punt_unknown4;
 112   u8 punt_unknown6;
 113
 114   /* Udp local to input arc index */
 115   u32 local_to_input_edge[N_UDP_AF];
 116
 117   /*
 118    * Per-worker thread udp connection pools used with session layer
 119    */
 120   udp_connection_t **connections;
 121   udp_connection_t *listener_pool;
 122
 123   u16 default_mtu;
 124   u16 msg_id_base;
 125
 126   u8 icmp_send_unreachable_disabled;
 127 } udp_main_t;
 128
 129 extern udp_main_t udp_main;
 130 extern vlib_node_registration_t udp4_input_node;
 131 extern vlib_node_registration_t udp6_input_node;
 132 extern vlib_node_registration_t udp4_local_node;
 133 extern vlib_node_registration_t udp6_local_node;
 134 extern vlib_node_registration_t udp4_output_node;
 135 extern vlib_node_registration_t udp6_output_node;
 136
 137 void udp_add_dst_port (udp_main_t * um, udp_dst_port_t dst_port,
 138                        char *dst_port_name, u8 is_ip4);
 139
 140 always_inline udp_connection_t *
 141 udp_connection_get (u32 conn_index, u32 thread_index)
 142 {
 143   if (pool_is_free_index (udp_main.connections[thread_index], conn_index))
 144     return 0;
 145   return pool_elt_at_index (udp_main.connections[thread_index], conn_index);
 146 }
 147
 148 always_inline udp_connection_t *
 149 udp_listener_get (u32 conn_index)
 150 {
 151   return pool_elt_at_index (udp_main.listener_pool, conn_index);
 152 }
 153
 154 always_inline udp_main_t *
 155 vnet_get_udp_main ()
 156 {
 157   return &udp_main;
 158 }
 159
 160 always_inline udp_connection_t *
 161 udp_connection_from_transport (transport_connection_t * tc)
 162 {
 163   return ((udp_connection_t *) tc);
 164 }
 165
 166 void udp_connection_free (udp_connection_t * uc);
 167 udp_connection_t *udp_connection_alloc (u32 thread_index);
 168
 169 always_inline udp_connection_t *
 170 udp_connection_clone_safe (u32 connection_index, u32 thread_index)
 171 {
 172   u32 current_thread_index = vlib_get_thread_index (), new_index;
 173   udp_connection_t *old_c, *new_c;
 174
 175   new_c = udp_connection_alloc (current_thread_index);
 176   new_index = new_c->c_c_index;
 177   /* Connection pool always realloced with barrier */
 178   old_c = udp_main.connections[thread_index] + connection_index;
 179   clib_memcpy_fast (new_c, old_c, sizeof (*new_c));
 180   old_c->flags |= UDP_CONN_F_MIGRATED;
 181   new_c->c_thread_index = current_thread_index;
 182   new_c->c_c_index = new_index;
 183   new_c->c_fib_index = old_c->c_fib_index;
 184   /* Assume cloned sessions don't need lock */
 185   new_c->rx_lock = 0;
 186   return new_c;
 187 }
 188
 189 always_inline udp_dst_port_info_t *
 190 udp_get_dst_port_info (udp_main_t * um, udp_dst_port_t dst_port, u8 is_ip4)
 191 {
 192   uword *p = hash_get (um->dst_port_info_by_dst_port[is_ip4], dst_port);
 193   return p ? vec_elt_at_index (um->dst_port_infos[is_ip4], p[0]) : 0;
 194 }
 195
 196 format_function_t format_udp_header;
 197 format_function_t format_udp_rx_trace;
 198 format_function_t format_udp_connection;
 199 unformat_function_t unformat_udp_header;
 200 unformat_function_t unformat_udp_port;
 201
 202 void udp_connection_share_port (u16 lcl_port, u8 is_ip4);
 203
 204 void udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
 205
 206 /*
 207  * fd.io coding-style-patch-verification: ON
 208  *
 209  * Local Variables:
 210  * eval: (c-set-style "gnu")
 211  * End:
 212  */
 213
 214 #endif /* __included_udp_h__ */