2 * Copyright (c) 2017 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>
39 /** Required for pool_get_aligned */
40 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
41 transport_connection_t connection; /**< must be first */
42 clib_spinlock_t rx_lock; /**< rx fifo lock */
43 u8 is_connected; /**< connected mode */
46 #define foreach_udp4_dst_port \
48 _ (67, dhcp_to_server) \
49 _ (68, dhcp_to_client) \
66 #define foreach_udp6_dst_port \
68 _ (547, dhcpv6_to_server) \
69 _ (546, dhcpv6_to_client) \
75 _ (4790, VXLAN6_GPE) \
83 #define _(n,f) UDP_DST_PORT_##f = n,
84 foreach_udp4_dst_port foreach_udp6_dst_port
90 #define _(n,f) UDP6_DST_PORT_##f = n,
97 /* Name (a c string). */
100 /* GRE protocol type in host byte order. */
101 udp_dst_port_t dst_port;
103 /* Node which handles this type. */
106 /* Next index for this type. */
108 } udp_dst_port_info_t;
113 UDP_IP4, /* the code is full of is_ip4... */
119 udp_dst_port_info_t *dst_port_infos[N_UDP_AF];
121 /* Hash tables mapping name/protocol to protocol info index. */
122 uword *dst_port_info_by_name[N_UDP_AF];
123 uword *dst_port_info_by_dst_port[N_UDP_AF];
125 /* Sparse vector mapping udp dst_port in network byte order
127 u16 *next_by_dst_port4;
128 u16 *next_by_dst_port6;
133 * Per-worker thread udp connection pools used with session layer
135 udp_connection_t **connections;
136 u32 *connection_peekers;
137 clib_spinlock_t *peekers_readers_locks;
138 clib_spinlock_t *peekers_write_locks;
139 udp_connection_t *listener_pool;
143 extern udp_main_t udp_main;
144 extern vlib_node_registration_t udp4_input_node;
145 extern vlib_node_registration_t udp6_input_node;
147 always_inline udp_connection_t *
148 udp_connection_get (u32 conn_index, u32 thread_index)
150 if (pool_is_free_index (udp_main.connections[thread_index], conn_index))
152 return pool_elt_at_index (udp_main.connections[thread_index], conn_index);
155 always_inline udp_connection_t *
156 udp_listener_get (u32 conn_index)
158 return pool_elt_at_index (udp_main.listener_pool, conn_index);
161 always_inline udp_main_t *
167 always_inline udp_connection_t *
168 udp_get_connection_from_transport (transport_connection_t * tc)
170 return ((udp_connection_t *) tc);
174 udp_connection_index (udp_connection_t * uc)
176 return (uc - udp_main.connections[uc->c_thread_index]);
179 udp_connection_t *udp_connection_alloc (u32 thread_index);
182 * Acquires a lock that blocks a connection pool from expanding.
185 udp_pool_add_peeker (u32 thread_index)
187 if (thread_index != vlib_get_thread_index ())
189 clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
190 udp_main.connection_peekers[thread_index] += 1;
191 if (udp_main.connection_peekers[thread_index] == 1)
192 clib_spinlock_lock_if_init (&udp_main.peekers_write_locks[thread_index]);
193 clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
198 udp_pool_remove_peeker (u32 thread_index)
200 if (thread_index != vlib_get_thread_index ())
202 ASSERT (udp_main.connection_peekers[thread_index] > 0);
203 clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
204 udp_main.connection_peekers[thread_index] -= 1;
205 if (udp_main.connection_peekers[thread_index] == 0)
206 clib_spinlock_unlock_if_init (&udp_main.peekers_write_locks
208 clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
212 always_inline udp_connection_t *
213 udp_connection_clone_safe (u32 connection_index, u32 thread_index)
215 udp_connection_t *old_c, *new_c;
216 u32 current_thread_index = vlib_get_thread_index ();
217 new_c = udp_connection_alloc (current_thread_index);
219 /* If during the memcpy pool is reallocated AND the memory allocator
220 * decides to give the old chunk of memory to somebody in a hurry to
221 * scribble something on it, we have a problem. So add this thread as
222 * a session pool peeker.
224 udp_pool_add_peeker (thread_index);
225 old_c = udp_main.connections[thread_index] + connection_index;
226 clib_memcpy (new_c, old_c, sizeof (*new_c));
227 udp_pool_remove_peeker (thread_index);
228 new_c->c_thread_index = current_thread_index;
229 new_c->c_c_index = udp_connection_index (new_c);
234 always_inline udp_dst_port_info_t *
235 udp_get_dst_port_info (udp_main_t * um, udp_dst_port_t dst_port, u8 is_ip4)
237 uword *p = hash_get (um->dst_port_info_by_dst_port[is_ip4], dst_port);
238 return p ? vec_elt_at_index (um->dst_port_infos[is_ip4], p[0]) : 0;
241 format_function_t format_udp_header;
242 format_function_t format_udp_rx_trace;
243 unformat_function_t unformat_udp_header;
245 void udp_register_dst_port (vlib_main_t * vm,
246 udp_dst_port_t dst_port,
247 u32 node_index, u8 is_ip4);
248 void udp_unregister_dst_port (vlib_main_t * vm,
249 udp_dst_port_t dst_port, u8 is_ip4);
251 void udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
254 vlib_buffer_push_udp (vlib_buffer_t * b, u16 sp, u16 dp, u8 offload_csum)
257 u16 udp_len = sizeof (udp_header_t) + b->current_length;
258 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID))
259 udp_len += b->total_length_not_including_first_buffer;
261 uh = vlib_buffer_push_uninit (b, sizeof (udp_header_t));
265 uh->length = clib_host_to_net_u16 (udp_len);
268 b->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
269 vnet_buffer (b)->l4_hdr_offset = (u8 *) uh - b->data;
275 ip_udp_fixup_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 is_ip4)
286 ip0 = vlib_buffer_get_current (b0);
288 /* fix the <bleep>ing outer-IP checksum */
289 sum0 = ip0->checksum;
290 /* old_l0 always 0, see the rewrite setup */
291 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
293 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
294 length /* changed member */ );
295 ip0->checksum = ip_csum_fold (sum0);
296 ip0->length = new_l0;
299 udp0 = (udp_header_t *) (ip0 + 1);
300 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
302 udp0->length = new_l0;
309 ip0 = vlib_buffer_get_current (b0);
311 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
313 ip0->payload_length = new_l0;
316 udp0 = (udp_header_t *) (ip0 + 1);
317 udp0->length = new_l0;
320 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
321 ASSERT (bogus0 == 0);
323 if (udp0->checksum == 0)
324 udp0->checksum = 0xffff;
329 ip_udp_encap_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 * ec0, word ec_len,
332 vlib_buffer_advance (b0, -ec_len);
338 ip0 = vlib_buffer_get_current (b0);
340 /* Apply the encap string. */
341 clib_memcpy (ip0, ec0, ec_len);
342 ip_udp_fixup_one (vm, b0, 1);
348 ip0 = vlib_buffer_get_current (b0);
350 /* Apply the encap string. */
351 clib_memcpy (ip0, ec0, ec_len);
352 ip_udp_fixup_one (vm, b0, 0);
357 ip_udp_encap_two (vlib_main_t * vm, vlib_buffer_t * b0, vlib_buffer_t * b1,
358 u8 * ec0, u8 * ec1, word ec_len, u8 is_v4)
361 udp_header_t *udp0, *udp1;
363 ASSERT (_vec_len (ec0) == _vec_len (ec1));
365 vlib_buffer_advance (b0, -ec_len);
366 vlib_buffer_advance (b1, -ec_len);
370 ip4_header_t *ip0, *ip1;
371 ip_csum_t sum0, sum1;
372 u16 old_l0 = 0, old_l1 = 0;
374 ip0 = vlib_buffer_get_current (b0);
375 ip1 = vlib_buffer_get_current (b1);
377 /* Apply the encap string */
378 clib_memcpy (ip0, ec0, ec_len);
379 clib_memcpy (ip1, ec1, ec_len);
381 /* fix the <bleep>ing outer-IP checksum */
382 sum0 = ip0->checksum;
383 sum1 = ip1->checksum;
385 /* old_l0 always 0, see the rewrite setup */
386 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
387 new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1));
389 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
390 length /* changed member */ );
391 sum1 = ip_csum_update (sum1, old_l1, new_l1, ip4_header_t,
392 length /* changed member */ );
394 ip0->checksum = ip_csum_fold (sum0);
395 ip1->checksum = ip_csum_fold (sum1);
397 ip0->length = new_l0;
398 ip1->length = new_l1;
401 udp0 = (udp_header_t *) (ip0 + 1);
402 udp1 = (udp_header_t *) (ip1 + 1);
405 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
408 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1) -
410 udp0->length = new_l0;
411 udp1->length = new_l1;
415 ip6_header_t *ip0, *ip1;
418 ip0 = vlib_buffer_get_current (b0);
419 ip1 = vlib_buffer_get_current (b1);
421 /* Apply the encap string. */
422 clib_memcpy (ip0, ec0, ec_len);
423 clib_memcpy (ip1, ec1, ec_len);
425 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 ip0->payload_length = new_l0;
430 ip1->payload_length = new_l1;
433 udp0 = (udp_header_t *) (ip0 + 1);
434 udp1 = (udp_header_t *) (ip1 + 1);
436 udp0->length = new_l0;
437 udp1->length = new_l1;
440 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
442 ip6_tcp_udp_icmp_compute_checksum (vm, b1, ip1, &bogus1);
443 ASSERT (bogus0 == 0);
444 ASSERT (bogus1 == 0);
446 if (udp0->checksum == 0)
447 udp0->checksum = 0xffff;
448 if (udp1->checksum == 0)
449 udp1->checksum = 0xffff;
454 * fd.io coding-style-patch-verification: ON
457 * eval: (c-set-style "gnu")
461 #endif /* __included_udp_h__ */