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:
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 */ \
43 enum udp_conn_flags_bits
45 #define _(sym, str) UDP_CONN_F_BIT_##sym,
46 foreach_udp_connection_flag
51 typedef enum udp_conn_flags_
53 #define _(sym, str) UDP_CONN_F_##sym = 1 << UDP_CONN_F_BIT_##sym,
54 foreach_udp_connection_flag
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 */
67 #define foreach_udp4_dst_port \
69 _ (67, dhcp_to_server) \
70 _ (68, dhcp_to_client) \
81 _ (48879, vxlan_gbp) \
88 #define foreach_udp6_dst_port \
90 _ (547, dhcpv6_to_server) \
91 _ (546, dhcpv6_to_client) \
97 _ (48879, vxlan6_gbp) \
98 _ (4790, VXLAN6_GPE) \
102 _ (53053, dns_reply6)
106 #define _(n,f) UDP_DST_PORT_##f = n,
107 foreach_udp4_dst_port foreach_udp6_dst_port
113 #define _(n,f) UDP6_DST_PORT_##f = n,
114 foreach_udp6_dst_port
120 /* Name (a c string). */
123 /* Port number in host byte order. */
124 udp_dst_port_t dst_port;
126 /* Node which handles this type. */
129 /* Next index for this type. */
132 /* UDP sessions refcount (not tunnels) */
135 /* Parser for packet generator edits for this protocol */
136 unformat_function_t *unformat_pg_edit;
137 } udp_dst_port_info_t;
142 UDP_IP4, /* the code is full of is_ip4... */
148 udp_dst_port_info_t *dst_port_infos[N_UDP_AF];
150 /* Hash tables mapping name/protocol to protocol info index. */
151 uword *dst_port_info_by_name[N_UDP_AF];
152 uword *dst_port_info_by_dst_port[N_UDP_AF];
154 /* Sparse vector mapping udp dst_port in network byte order
156 u16 *next_by_dst_port4;
157 u16 *next_by_dst_port6;
161 /* Udp local to input arc index */
162 u32 local_to_input_edge[N_UDP_AF];
165 * Per-worker thread udp connection pools used with session layer
167 udp_connection_t **connections;
168 u32 *connection_peekers;
169 clib_spinlock_t *peekers_readers_locks;
170 clib_spinlock_t *peekers_write_locks;
171 udp_connection_t *listener_pool;
175 extern udp_main_t udp_main;
176 extern vlib_node_registration_t udp4_input_node;
177 extern vlib_node_registration_t udp6_input_node;
178 extern vlib_node_registration_t udp4_local_node;
179 extern vlib_node_registration_t udp6_local_node;
181 always_inline udp_connection_t *
182 udp_connection_get (u32 conn_index, u32 thread_index)
184 if (pool_is_free_index (udp_main.connections[thread_index], conn_index))
186 return pool_elt_at_index (udp_main.connections[thread_index], conn_index);
189 always_inline udp_connection_t *
190 udp_listener_get (u32 conn_index)
192 return pool_elt_at_index (udp_main.listener_pool, conn_index);
195 always_inline udp_main_t *
201 always_inline udp_connection_t *
202 udp_get_connection_from_transport (transport_connection_t * tc)
204 return ((udp_connection_t *) tc);
208 udp_connection_index (udp_connection_t * uc)
210 return (uc - udp_main.connections[uc->c_thread_index]);
213 udp_connection_t *udp_connection_alloc (u32 thread_index);
216 * Acquires a lock that blocks a connection pool from expanding.
219 udp_pool_add_peeker (u32 thread_index)
221 if (thread_index != vlib_get_thread_index ())
223 clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
224 udp_main.connection_peekers[thread_index] += 1;
225 if (udp_main.connection_peekers[thread_index] == 1)
226 clib_spinlock_lock_if_init (&udp_main.peekers_write_locks[thread_index]);
227 clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
232 udp_pool_remove_peeker (u32 thread_index)
234 if (thread_index != vlib_get_thread_index ())
236 ASSERT (udp_main.connection_peekers[thread_index] > 0);
237 clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
238 udp_main.connection_peekers[thread_index] -= 1;
239 if (udp_main.connection_peekers[thread_index] == 0)
240 clib_spinlock_unlock_if_init (&udp_main.peekers_write_locks
242 clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
246 always_inline udp_connection_t *
247 udp_connection_clone_safe (u32 connection_index, u32 thread_index)
249 udp_connection_t *old_c, *new_c;
250 u32 current_thread_index = vlib_get_thread_index ();
251 new_c = udp_connection_alloc (current_thread_index);
253 /* If during the memcpy pool is reallocated AND the memory allocator
254 * decides to give the old chunk of memory to somebody in a hurry to
255 * scribble something on it, we have a problem. So add this thread as
256 * a session pool peeker.
258 udp_pool_add_peeker (thread_index);
259 old_c = udp_main.connections[thread_index] + connection_index;
260 clib_memcpy_fast (new_c, old_c, sizeof (*new_c));
261 udp_pool_remove_peeker (thread_index);
262 new_c->c_thread_index = current_thread_index;
263 new_c->c_c_index = udp_connection_index (new_c);
264 new_c->c_fib_index = old_c->c_fib_index;
269 always_inline udp_dst_port_info_t *
270 udp_get_dst_port_info (udp_main_t * um, udp_dst_port_t dst_port, u8 is_ip4)
272 uword *p = hash_get (um->dst_port_info_by_dst_port[is_ip4], dst_port);
273 return p ? vec_elt_at_index (um->dst_port_infos[is_ip4], p[0]) : 0;
276 format_function_t format_udp_header;
277 format_function_t format_udp_rx_trace;
278 unformat_function_t unformat_udp_header;
280 void udp_add_dst_port (udp_main_t * um, udp_dst_port_t dst_port,
281 char *dst_port_name, u8 is_ip4);
282 void udp_register_dst_port (vlib_main_t * vm,
283 udp_dst_port_t dst_port,
284 u32 node_index, u8 is_ip4);
285 void udp_unregister_dst_port (vlib_main_t * vm,
286 udp_dst_port_t dst_port, u8 is_ip4);
287 bool udp_is_valid_dst_port (udp_dst_port_t dst_port, u8 is_ip4);
289 void udp_connection_share_port (u16 lcl_port, u8 is_ip4);
291 void udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
294 vlib_buffer_push_udp (vlib_buffer_t * b, u16 sp, u16 dp, u8 offload_csum)
297 u16 udp_len = sizeof (udp_header_t) + b->current_length;
298 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID))
299 udp_len += b->total_length_not_including_first_buffer;
301 uh = vlib_buffer_push_uninit (b, sizeof (udp_header_t));
305 uh->length = clib_host_to_net_u16 (udp_len);
308 b->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
309 vnet_buffer (b)->l4_hdr_offset = (u8 *) uh - b->data;
315 ip_udp_fixup_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 is_ip4)
326 ip0 = vlib_buffer_get_current (b0);
328 /* fix the <bleep>ing outer-IP checksum */
329 sum0 = ip0->checksum;
330 /* old_l0 always 0, see the rewrite setup */
331 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
333 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
334 length /* changed member */ );
335 ip0->checksum = ip_csum_fold (sum0);
336 ip0->length = new_l0;
339 udp0 = (udp_header_t *) (ip0 + 1);
340 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
342 udp0->length = new_l0;
349 ip0 = vlib_buffer_get_current (b0);
351 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
353 ip0->payload_length = new_l0;
356 udp0 = (udp_header_t *) (ip0 + 1);
357 udp0->length = new_l0;
360 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
361 ASSERT (bogus0 == 0);
363 if (udp0->checksum == 0)
364 udp0->checksum = 0xffff;
369 ip_udp_encap_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 * ec0, word ec_len,
372 vlib_buffer_advance (b0, -ec_len);
378 ip0 = vlib_buffer_get_current (b0);
380 /* Apply the encap string. */
381 clib_memcpy_fast (ip0, ec0, ec_len);
382 ip_udp_fixup_one (vm, b0, 1);
388 ip0 = vlib_buffer_get_current (b0);
390 /* Apply the encap string. */
391 clib_memcpy_fast (ip0, ec0, ec_len);
392 ip_udp_fixup_one (vm, b0, 0);
397 ip_udp_encap_two (vlib_main_t * vm, vlib_buffer_t * b0, vlib_buffer_t * b1,
398 u8 * ec0, u8 * ec1, word ec_len, u8 is_v4)
401 udp_header_t *udp0, *udp1;
403 ASSERT (_vec_len (ec0) == _vec_len (ec1));
405 vlib_buffer_advance (b0, -ec_len);
406 vlib_buffer_advance (b1, -ec_len);
410 ip4_header_t *ip0, *ip1;
411 ip_csum_t sum0, sum1;
412 u16 old_l0 = 0, old_l1 = 0;
414 ip0 = vlib_buffer_get_current (b0);
415 ip1 = vlib_buffer_get_current (b1);
417 /* Apply the encap string */
418 clib_memcpy_fast (ip0, ec0, ec_len);
419 clib_memcpy_fast (ip1, ec1, ec_len);
421 /* fix the <bleep>ing outer-IP checksum */
422 sum0 = ip0->checksum;
423 sum1 = ip1->checksum;
425 /* old_l0 always 0, see the rewrite setup */
426 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
427 new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1));
429 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
430 length /* changed member */ );
431 sum1 = ip_csum_update (sum1, old_l1, new_l1, ip4_header_t,
432 length /* changed member */ );
434 ip0->checksum = ip_csum_fold (sum0);
435 ip1->checksum = ip_csum_fold (sum1);
437 ip0->length = new_l0;
438 ip1->length = new_l1;
441 udp0 = (udp_header_t *) (ip0 + 1);
442 udp1 = (udp_header_t *) (ip1 + 1);
445 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
448 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1) -
450 udp0->length = new_l0;
451 udp1->length = new_l1;
455 ip6_header_t *ip0, *ip1;
458 ip0 = vlib_buffer_get_current (b0);
459 ip1 = vlib_buffer_get_current (b1);
461 /* Apply the encap string. */
462 clib_memcpy_fast (ip0, ec0, ec_len);
463 clib_memcpy_fast (ip1, ec1, ec_len);
465 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
467 new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1)
469 ip0->payload_length = new_l0;
470 ip1->payload_length = new_l1;
473 udp0 = (udp_header_t *) (ip0 + 1);
474 udp1 = (udp_header_t *) (ip1 + 1);
476 udp0->length = new_l0;
477 udp1->length = new_l1;
480 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
482 ip6_tcp_udp_icmp_compute_checksum (vm, b1, ip1, &bogus1);
483 ASSERT (bogus0 == 0);
484 ASSERT (bogus1 == 0);
486 if (udp0->checksum == 0)
487 udp0->checksum = 0xffff;
488 if (udp1->checksum == 0)
489 udp1->checksum = 0xffff;
494 * fd.io coding-style-patch-verification: ON
497 * eval: (c-set-style "gnu")
501 #endif /* __included_udp_h__ */