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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef __included_udp_h__
16 #define __included_udp_h__
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>
26 #include <vnet/ip/ip.h>
27 #include <vnet/session/transport.h>
31 #define udp_error(n,s) UDP_ERROR_##n,
32 #include <vnet/udp/udp_error.def>
37 #define foreach_udp_connection_flag \
38 _(CONNECTED, "CONNECTED") /**< connected mode */ \
39 _(OWNS_PORT, "OWNS_PORT") /**< port belong to conn (UDPC) */ \
40 _(CLOSING, "CLOSING") /**< conn closed with data */ \
41 _(LISTEN, "LISTEN") /**< conn is listening */ \
42 _(MIGRATED, "MIGRATED") /**< cloned to another thread */ \
44 enum udp_conn_flags_bits
46 #define _(sym, str) UDP_CONN_F_BIT_##sym,
47 foreach_udp_connection_flag
52 typedef enum udp_conn_flags_
54 #define _(sym, str) UDP_CONN_F_##sym = 1 << UDP_CONN_F_BIT_##sym,
55 foreach_udp_connection_flag
61 /** Required for pool_get_aligned */
62 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
63 transport_connection_t connection; /**< must be first */
64 clib_spinlock_t rx_lock; /**< rx fifo lock */
65 u8 flags; /**< connection flags */
66 u16 mss; /**< connection mss */
69 #define foreach_udp4_dst_port \
71 _ (67, dhcp_to_server) \
72 _ (68, dhcp_to_client) \
83 _ (48879, vxlan_gbp) \
90 #define foreach_udp6_dst_port \
92 _ (547, dhcpv6_to_server) \
93 _ (546, dhcpv6_to_client) \
99 _ (48879, vxlan6_gbp) \
100 _ (4790, VXLAN6_GPE) \
104 _ (53053, dns_reply6)
108 #define _(n,f) UDP_DST_PORT_##f = n,
109 foreach_udp4_dst_port foreach_udp6_dst_port
115 #define _(n,f) UDP6_DST_PORT_##f = n,
116 foreach_udp6_dst_port
122 /* Name (a c string). */
125 /* Port number in host byte order. */
126 udp_dst_port_t dst_port;
128 /* Node which handles this type. */
131 /* Next index for this type. */
134 /* UDP sessions refcount (not tunnels) */
137 /* Parser for packet generator edits for this protocol */
138 unformat_function_t *unformat_pg_edit;
139 } udp_dst_port_info_t;
144 UDP_IP4, /* the code is full of is_ip4... */
150 udp_dst_port_info_t *dst_port_infos[N_UDP_AF];
152 /* Hash tables mapping name/protocol to protocol info index. */
153 uword *dst_port_info_by_name[N_UDP_AF];
154 uword *dst_port_info_by_dst_port[N_UDP_AF];
156 /* Sparse vector mapping udp dst_port in network byte order
158 u16 *next_by_dst_port4;
159 u16 *next_by_dst_port6;
163 /* Udp local to input arc index */
164 u32 local_to_input_edge[N_UDP_AF];
167 * Per-worker thread udp connection pools used with session layer
169 udp_connection_t **connections;
170 u32 *connection_peekers;
171 clib_spinlock_t *peekers_readers_locks;
172 clib_spinlock_t *peekers_write_locks;
173 udp_connection_t *listener_pool;
178 extern udp_main_t udp_main;
179 extern vlib_node_registration_t udp4_input_node;
180 extern vlib_node_registration_t udp6_input_node;
181 extern vlib_node_registration_t udp4_local_node;
182 extern vlib_node_registration_t udp6_local_node;
184 always_inline udp_connection_t *
185 udp_connection_get (u32 conn_index, u32 thread_index)
187 if (pool_is_free_index (udp_main.connections[thread_index], conn_index))
189 return pool_elt_at_index (udp_main.connections[thread_index], conn_index);
192 always_inline udp_connection_t *
193 udp_listener_get (u32 conn_index)
195 return pool_elt_at_index (udp_main.listener_pool, conn_index);
198 always_inline udp_main_t *
204 always_inline udp_connection_t *
205 udp_connection_from_transport (transport_connection_t * tc)
207 return ((udp_connection_t *) tc);
211 udp_connection_index (udp_connection_t * uc)
213 return (uc - udp_main.connections[uc->c_thread_index]);
216 void udp_connection_free (udp_connection_t * uc);
217 udp_connection_t *udp_connection_alloc (u32 thread_index);
220 * Acquires a lock that blocks a connection pool from expanding.
223 udp_pool_add_peeker (u32 thread_index)
225 if (thread_index != vlib_get_thread_index ())
227 clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
228 udp_main.connection_peekers[thread_index] += 1;
229 if (udp_main.connection_peekers[thread_index] == 1)
230 clib_spinlock_lock_if_init (&udp_main.peekers_write_locks[thread_index]);
231 clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
236 udp_pool_remove_peeker (u32 thread_index)
238 if (thread_index != vlib_get_thread_index ())
240 ASSERT (udp_main.connection_peekers[thread_index] > 0);
241 clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
242 udp_main.connection_peekers[thread_index] -= 1;
243 if (udp_main.connection_peekers[thread_index] == 0)
244 clib_spinlock_unlock_if_init (&udp_main.peekers_write_locks
246 clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
250 always_inline udp_connection_t *
251 udp_connection_clone_safe (u32 connection_index, u32 thread_index)
253 udp_connection_t *old_c, *new_c;
254 u32 current_thread_index = vlib_get_thread_index ();
255 new_c = udp_connection_alloc (current_thread_index);
257 /* If during the memcpy pool is reallocated AND the memory allocator
258 * decides to give the old chunk of memory to somebody in a hurry to
259 * scribble something on it, we have a problem. So add this thread as
260 * a session pool peeker.
262 udp_pool_add_peeker (thread_index);
263 old_c = udp_main.connections[thread_index] + connection_index;
264 clib_memcpy_fast (new_c, old_c, sizeof (*new_c));
265 old_c->flags |= UDP_CONN_F_MIGRATED;
266 udp_pool_remove_peeker (thread_index);
267 new_c->c_thread_index = current_thread_index;
268 new_c->c_c_index = udp_connection_index (new_c);
269 new_c->c_fib_index = old_c->c_fib_index;
273 always_inline udp_dst_port_info_t *
274 udp_get_dst_port_info (udp_main_t * um, udp_dst_port_t dst_port, u8 is_ip4)
276 uword *p = hash_get (um->dst_port_info_by_dst_port[is_ip4], dst_port);
277 return p ? vec_elt_at_index (um->dst_port_infos[is_ip4], p[0]) : 0;
280 format_function_t format_udp_header;
281 format_function_t format_udp_rx_trace;
282 format_function_t format_udp_connection;
283 unformat_function_t unformat_udp_header;
285 void udp_add_dst_port (udp_main_t * um, udp_dst_port_t dst_port,
286 char *dst_port_name, u8 is_ip4);
287 void udp_register_dst_port (vlib_main_t * vm,
288 udp_dst_port_t dst_port,
289 u32 node_index, u8 is_ip4);
290 void udp_unregister_dst_port (vlib_main_t * vm,
291 udp_dst_port_t dst_port, u8 is_ip4);
292 bool udp_is_valid_dst_port (udp_dst_port_t dst_port, u8 is_ip4);
293 void udp_connection_share_port (u16 lcl_port, u8 is_ip4);
295 void udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
298 vlib_buffer_push_udp (vlib_buffer_t * b, u16 sp, u16 dp, u8 offload_csum)
301 u16 udp_len = sizeof (udp_header_t) + b->current_length;
302 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID))
303 udp_len += b->total_length_not_including_first_buffer;
305 uh = vlib_buffer_push_uninit (b, sizeof (udp_header_t));
309 uh->length = clib_host_to_net_u16 (udp_len);
311 b->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
312 vnet_buffer (b)->l4_hdr_offset = (u8 *) uh - b->data;
313 b->flags |= VNET_BUFFER_F_L4_HDR_OFFSET_VALID;
318 ip_udp_fixup_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 is_ip4)
329 ip0 = vlib_buffer_get_current (b0);
331 /* fix the <bleep>ing outer-IP checksum */
332 sum0 = ip0->checksum;
333 /* old_l0 always 0, see the rewrite setup */
334 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
336 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
337 length /* changed member */ );
338 ip0->checksum = ip_csum_fold (sum0);
339 ip0->length = new_l0;
342 udp0 = (udp_header_t *) (ip0 + 1);
343 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
345 udp0->length = new_l0;
352 ip0 = vlib_buffer_get_current (b0);
354 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
356 ip0->payload_length = new_l0;
359 udp0 = (udp_header_t *) (ip0 + 1);
360 udp0->length = new_l0;
363 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
364 ASSERT (bogus0 == 0);
366 if (udp0->checksum == 0)
367 udp0->checksum = 0xffff;
372 ip_udp_encap_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 * ec0, word ec_len,
375 vlib_buffer_advance (b0, -ec_len);
381 ip0 = vlib_buffer_get_current (b0);
383 /* Apply the encap string. */
384 clib_memcpy_fast (ip0, ec0, ec_len);
385 ip_udp_fixup_one (vm, b0, 1);
391 ip0 = vlib_buffer_get_current (b0);
393 /* Apply the encap string. */
394 clib_memcpy_fast (ip0, ec0, ec_len);
395 ip_udp_fixup_one (vm, b0, 0);
400 ip_udp_encap_two (vlib_main_t * vm, vlib_buffer_t * b0, vlib_buffer_t * b1,
401 u8 * ec0, u8 * ec1, word ec_len, u8 is_v4)
404 udp_header_t *udp0, *udp1;
406 ASSERT (_vec_len (ec0) == _vec_len (ec1));
408 vlib_buffer_advance (b0, -ec_len);
409 vlib_buffer_advance (b1, -ec_len);
413 ip4_header_t *ip0, *ip1;
414 ip_csum_t sum0, sum1;
415 u16 old_l0 = 0, old_l1 = 0;
417 ip0 = vlib_buffer_get_current (b0);
418 ip1 = vlib_buffer_get_current (b1);
420 /* Apply the encap string */
421 clib_memcpy_fast (ip0, ec0, ec_len);
422 clib_memcpy_fast (ip1, ec1, ec_len);
424 /* fix the <bleep>ing outer-IP checksum */
425 sum0 = ip0->checksum;
426 sum1 = ip1->checksum;
428 /* old_l0 always 0, see the rewrite setup */
429 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
430 new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1));
432 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
433 length /* changed member */ );
434 sum1 = ip_csum_update (sum1, old_l1, new_l1, ip4_header_t,
435 length /* changed member */ );
437 ip0->checksum = ip_csum_fold (sum0);
438 ip1->checksum = ip_csum_fold (sum1);
440 ip0->length = new_l0;
441 ip1->length = new_l1;
444 udp0 = (udp_header_t *) (ip0 + 1);
445 udp1 = (udp_header_t *) (ip1 + 1);
448 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
451 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1) -
453 udp0->length = new_l0;
454 udp1->length = new_l1;
458 ip6_header_t *ip0, *ip1;
461 ip0 = vlib_buffer_get_current (b0);
462 ip1 = vlib_buffer_get_current (b1);
464 /* Apply the encap string. */
465 clib_memcpy_fast (ip0, ec0, ec_len);
466 clib_memcpy_fast (ip1, ec1, ec_len);
468 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
470 new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1)
472 ip0->payload_length = new_l0;
473 ip1->payload_length = new_l1;
476 udp0 = (udp_header_t *) (ip0 + 1);
477 udp1 = (udp_header_t *) (ip1 + 1);
479 udp0->length = new_l0;
480 udp1->length = new_l1;
483 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
485 ip6_tcp_udp_icmp_compute_checksum (vm, b1, ip1, &bogus1);
486 ASSERT (bogus0 == 0);
487 ASSERT (bogus1 == 0);
489 if (udp0->checksum == 0)
490 udp0->checksum = 0xffff;
491 if (udp1->checksum == 0)
492 udp1->checksum = 0xffff;
497 * fd.io coding-style-patch-verification: ON
500 * eval: (c-set-style "gnu")
504 #endif /* __included_udp_h__ */