FD.io VPP  v21.01.1
Vector Packet Processing
udp.h
Go to the documentation of this file.
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(n,s) UDP_ERROR_##n,
31 #include <vnet/udp/udp_error.def>
32 #undef udp_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 
44 {
45 #define _(sym, str) UDP_CONN_F_BIT_##sym,
47 #undef _
49 };
50 
51 typedef enum udp_conn_flags_
52 {
53 #define _(sym, str) UDP_CONN_F_##sym = 1 << UDP_CONN_F_BIT_##sym,
55 #undef _
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 */
67 
68 typedef struct
69 {
70  /* Name (a c string). */
71  char *name;
72 
73  /* Port number in host byte order. */
75 
76  /* Node which handles this type. */
77  u32 node_index;
78 
79  /* Next index for this type. */
80  u32 next_index;
81 
82  /* UDP sessions refcount (not tunnels) */
83  u32 n_connections;
84 
85  /* Parser for packet generator edits for this protocol */
88 
89 typedef enum
90 {
91  UDP_IP6 = 0,
92  UDP_IP4, /* the code is full of is_ip4... */
95 
96 typedef struct
97 {
98  udp_dst_port_info_t *dst_port_infos[N_UDP_AF];
99 
100  /* Hash tables mapping name/protocol to protocol info index. */
101  uword *dst_port_info_by_name[N_UDP_AF];
102  uword *dst_port_info_by_dst_port[N_UDP_AF];
104  /* Sparse vector mapping udp dst_port in network byte order
105  to next index. */
106  u16 *next_by_dst_port4;
107  u16 *next_by_dst_port6;
108  u8 punt_unknown4;
109  u8 punt_unknown6;
111  /* Udp local to input arc index */
112  u32 local_to_input_edge[N_UDP_AF];
114  /*
115  * Per-worker thread udp connection pools used with session layer
116  */
117  udp_connection_t **connections;
118  u32 *connection_peekers;
119  clib_spinlock_t *peekers_readers_locks;
120  clib_spinlock_t *peekers_write_locks;
121  udp_connection_t *listener_pool;
123  u16 default_mtu;
125 
126 extern udp_main_t udp_main;
131 
133  char *dst_port_name, u8 is_ip4);
134 
136 udp_connection_get (u32 conn_index, u32 thread_index)
137 {
138  if (pool_is_free_index (udp_main.connections[thread_index], conn_index))
139  return 0;
140  return pool_elt_at_index (udp_main.connections[thread_index], conn_index);
141 }
142 
144 udp_listener_get (u32 conn_index)
145 {
146  return pool_elt_at_index (udp_main.listener_pool, conn_index);
147 }
148 
151 {
152  return &udp_main;
153 }
154 
157 {
158  return ((udp_connection_t *) tc);
159 }
160 
163 {
164  return (uc - udp_main.connections[uc->c_thread_index]);
165 }
166 
169 
170 /**
171  * Acquires a lock that blocks a connection pool from expanding.
172  */
173 always_inline void
174 udp_pool_add_peeker (u32 thread_index)
175 {
176  if (thread_index != vlib_get_thread_index ())
177  return;
178  clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
179  udp_main.connection_peekers[thread_index] += 1;
180  if (udp_main.connection_peekers[thread_index] == 1)
181  clib_spinlock_lock_if_init (&udp_main.peekers_write_locks[thread_index]);
183  [thread_index]);
184 }
185 
186 always_inline void
187 udp_pool_remove_peeker (u32 thread_index)
188 {
189  if (thread_index != vlib_get_thread_index ())
190  return;
191  ASSERT (udp_main.connection_peekers[thread_index] > 0);
192  clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
193  udp_main.connection_peekers[thread_index] -= 1;
194  if (udp_main.connection_peekers[thread_index] == 0)
196  [thread_index]);
198  [thread_index]);
199 }
200 
202 udp_connection_clone_safe (u32 connection_index, u32 thread_index)
203 {
204  udp_connection_t *old_c, *new_c;
205  u32 current_thread_index = vlib_get_thread_index ();
206  new_c = udp_connection_alloc (current_thread_index);
207 
208  /* If during the memcpy pool is reallocated AND the memory allocator
209  * decides to give the old chunk of memory to somebody in a hurry to
210  * scribble something on it, we have a problem. So add this thread as
211  * a session pool peeker.
212  */
213  udp_pool_add_peeker (thread_index);
214  old_c = udp_main.connections[thread_index] + connection_index;
215  clib_memcpy_fast (new_c, old_c, sizeof (*new_c));
216  old_c->flags |= UDP_CONN_F_MIGRATED;
217  udp_pool_remove_peeker (thread_index);
218  new_c->c_thread_index = current_thread_index;
219  new_c->c_c_index = udp_connection_index (new_c);
220  new_c->c_fib_index = old_c->c_fib_index;
221  return new_c;
222 }
223 
226 {
227  uword *p = hash_get (um->dst_port_info_by_dst_port[is_ip4], dst_port);
228  return p ? vec_elt_at_index (um->dst_port_infos[is_ip4], p[0]) : 0;
229 }
230 
237 void udp_connection_share_port (u16 lcl_port, u8 is_ip4);
238 
239 void udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
240 
241 /*
242  * fd.io coding-style-patch-verification: ON
243  *
244  * Local Variables:
245  * eval: (c-set-style "gnu")
246  * End:
247  */
248 
249 #endif /* __included_udp_h__ */
static udp_connection_t * udp_connection_from_transport(transport_connection_t *tc)
Definition: udp.h:157
static udp_connection_t * udp_listener_get(u32 conn_index)
Definition: udp.h:145
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
unformat_function_t unformat_udp_header
Definition: udp.h:235
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:105
u32 * connection_peekers
Definition: udp.h:119
vl_api_ip_port_and_mask_t dst_port
Definition: flow_types.api:92
uword * dst_port_info_by_dst_port[N_UDP_AF]
Definition: udp.h:103
unformat_function_t unformat_udp_port
Definition: udp.h:236
#define clib_memcpy_fast(a, b, c)
Definition: string.h:81
static_always_inline void clib_spinlock_unlock_if_init(clib_spinlock_t *p)
Definition: lock.h:129
Definition: udp.h:97
uword unformat_pg_edit(unformat_input_t *input, va_list *args)
Definition: edit.c:106
static udp_dst_port_info_t * udp_get_dst_port_info(udp_main_t *um, udp_dst_port_t dst_port, u8 is_ip4)
Definition: udp.h:226
vlib_main_t * vm
Definition: in2out_ed.c:1580
vlib_node_registration_t udp4_local_node
(constructor) VLIB_REGISTER_NODE (udp4_local_node)
Definition: udp_local.c:403
udp_conn_flags_
Definition: udp.h:52
unsigned char u8
Definition: types.h:56
static udp_main_t * vnet_get_udp_main()
Definition: udp.h:151
u8 flags
connection flags
Definition: udp.h:65
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
udp_connection_t * udp_connection_alloc(u32 thread_index)
Definition: udp.c:93
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
void udp_add_dst_port(udp_main_t *um, udp_dst_port_t dst_port, char *dst_port_name, u8 is_ip4)
Definition: udp_local.c:448
void udp_connection_share_port(u16 lcl_port, u8 is_ip4)
Definition: udp.c:81
unsigned int u32
Definition: types.h:88
udp_dst_port_t
Definition: udp_local.h:58
static void udp_pool_remove_peeker(u32 thread_index)
Definition: udp.h:188
vlib_node_registration_t udp4_input_node
(constructor) VLIB_REGISTER_NODE (udp4_input_node)
Definition: udp_input.c:344
#define hash_get(h, key)
Definition: hash.h:249
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:546
udp_main_t udp_main
Definition: udp.c:23
static u32 udp_connection_index(udp_connection_t *uc)
Definition: udp.h:163
format_function_t format_udp_connection
Definition: udp.h:234
udp_dst_port_info_t * dst_port_infos[N_UDP_AF]
Definition: udp.h:99
unsigned short u16
Definition: types.h:57
clib_spinlock_t * peekers_readers_locks
Definition: udp.h:120
vlib_node_registration_t udp6_input_node
(constructor) VLIB_REGISTER_NODE (udp6_input_node)
Definition: udp_input.c:370
#define always_inline
Definition: ipsec.h:28
udp_connection_t * listener_pool
Definition: udp.h:122
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:232
Definition: udp.h:92
static void udp_pool_add_peeker(u32 thread_index)
Acquires a lock that blocks a connection pool from expanding.
Definition: udp.h:175
void udp_punt_unknown(vlib_main_t *vm, u8 is_ip4, u8 is_add)
Definition: udp_local.c:545
format_function_t format_udp_rx_trace
Definition: udp.h:233
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:219
static udp_connection_t * udp_connection_get(u32 conn_index, u32 thread_index)
Definition: udp.h:137
struct _transport_connection transport_connection_t
udp_error_t
Definition: udp.h:28
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:298
string name[64]
Definition: ip.api:44
#define ASSERT(truth)
udp_af_t
Definition: udp.h:90
clib_spinlock_t * peekers_write_locks
Definition: udp.h:121
#define foreach_udp_connection_flag
cloned to another thread
Definition: udp.h:36
enum udp_conn_flags_ udp_conn_flags_t
struct _vlib_node_registration vlib_node_registration_t
u64 uword
Definition: types.h:112
udp_conn_flags_bits
Definition: udp.h:44
vlib_node_registration_t udp6_local_node
(constructor) VLIB_REGISTER_NODE (udp6_local_node)
Definition: udp_local.c:425
void udp_connection_free(udp_connection_t *uc)
Definition: udp.c:124
static udp_connection_t * udp_connection_clone_safe(u32 connection_index, u32 thread_index)
Definition: udp.h:203
udp_connection_t ** connections
Definition: udp.h:118
static_always_inline void clib_spinlock_lock_if_init(clib_spinlock_t *p)
Definition: lock.h:106
Definition: udp.h:93
Definition: udp.h:94
format_function_t format_udp_header
Definition: udp.h:232