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>
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) \
60 _ (48879, vxlan_gbp) \
67 #define foreach_udp6_dst_port \
69 _ (547, dhcpv6_to_server) \
70 _ (546, dhcpv6_to_client) \
76 _ (48879, vxlan6_gbp) \
77 _ (4790, VXLAN6_GPE) \
85 #define _(n,f) UDP_DST_PORT_##f = n,
86 foreach_udp4_dst_port foreach_udp6_dst_port
92 #define _(n,f) UDP6_DST_PORT_##f = n,
99 /* Name (a c string). */
102 /* GRE protocol type in host byte order. */
103 udp_dst_port_t dst_port;
105 /* Node which handles this type. */
108 /* Next index for this type. */
111 /* Parser for packet generator edits for this protocol */
112 unformat_function_t *unformat_pg_edit;
113 } udp_dst_port_info_t;
118 UDP_IP4, /* the code is full of is_ip4... */
124 udp_dst_port_info_t *dst_port_infos[N_UDP_AF];
126 /* Hash tables mapping name/protocol to protocol info index. */
127 uword *dst_port_info_by_name[N_UDP_AF];
128 uword *dst_port_info_by_dst_port[N_UDP_AF];
130 /* Sparse vector mapping udp dst_port in network byte order
132 u16 *next_by_dst_port4;
133 u16 *next_by_dst_port6;
138 * Per-worker thread udp connection pools used with session layer
140 udp_connection_t **connections;
141 u32 *connection_peekers;
142 clib_spinlock_t *peekers_readers_locks;
143 clib_spinlock_t *peekers_write_locks;
144 udp_connection_t *listener_pool;
148 extern udp_main_t udp_main;
149 extern vlib_node_registration_t udp4_input_node;
150 extern vlib_node_registration_t udp6_input_node;
151 extern vlib_node_registration_t udp4_local_node;
152 extern vlib_node_registration_t udp6_local_node;
154 always_inline udp_connection_t *
155 udp_connection_get (u32 conn_index, u32 thread_index)
157 if (pool_is_free_index (udp_main.connections[thread_index], conn_index))
159 return pool_elt_at_index (udp_main.connections[thread_index], conn_index);
162 always_inline udp_connection_t *
163 udp_listener_get (u32 conn_index)
165 return pool_elt_at_index (udp_main.listener_pool, conn_index);
168 always_inline udp_main_t *
174 always_inline udp_connection_t *
175 udp_get_connection_from_transport (transport_connection_t * tc)
177 return ((udp_connection_t *) tc);
181 udp_connection_index (udp_connection_t * uc)
183 return (uc - udp_main.connections[uc->c_thread_index]);
186 udp_connection_t *udp_connection_alloc (u32 thread_index);
189 * Acquires a lock that blocks a connection pool from expanding.
192 udp_pool_add_peeker (u32 thread_index)
194 if (thread_index != vlib_get_thread_index ())
196 clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
197 udp_main.connection_peekers[thread_index] += 1;
198 if (udp_main.connection_peekers[thread_index] == 1)
199 clib_spinlock_lock_if_init (&udp_main.peekers_write_locks[thread_index]);
200 clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
205 udp_pool_remove_peeker (u32 thread_index)
207 if (thread_index != vlib_get_thread_index ())
209 ASSERT (udp_main.connection_peekers[thread_index] > 0);
210 clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
211 udp_main.connection_peekers[thread_index] -= 1;
212 if (udp_main.connection_peekers[thread_index] == 0)
213 clib_spinlock_unlock_if_init (&udp_main.peekers_write_locks
215 clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
219 always_inline udp_connection_t *
220 udp_connection_clone_safe (u32 connection_index, u32 thread_index)
222 udp_connection_t *old_c, *new_c;
223 u32 current_thread_index = vlib_get_thread_index ();
224 new_c = udp_connection_alloc (current_thread_index);
226 /* If during the memcpy pool is reallocated AND the memory allocator
227 * decides to give the old chunk of memory to somebody in a hurry to
228 * scribble something on it, we have a problem. So add this thread as
229 * a session pool peeker.
231 udp_pool_add_peeker (thread_index);
232 old_c = udp_main.connections[thread_index] + connection_index;
233 clib_memcpy_fast (new_c, old_c, sizeof (*new_c));
234 udp_pool_remove_peeker (thread_index);
235 new_c->c_thread_index = current_thread_index;
236 new_c->c_c_index = udp_connection_index (new_c);
241 always_inline udp_dst_port_info_t *
242 udp_get_dst_port_info (udp_main_t * um, udp_dst_port_t dst_port, u8 is_ip4)
244 uword *p = hash_get (um->dst_port_info_by_dst_port[is_ip4], dst_port);
245 return p ? vec_elt_at_index (um->dst_port_infos[is_ip4], p[0]) : 0;
248 format_function_t format_udp_header;
249 format_function_t format_udp_rx_trace;
250 unformat_function_t unformat_udp_header;
252 void udp_register_dst_port (vlib_main_t * vm,
253 udp_dst_port_t dst_port,
254 u32 node_index, u8 is_ip4);
255 void udp_unregister_dst_port (vlib_main_t * vm,
256 udp_dst_port_t dst_port, u8 is_ip4);
257 bool udp_is_valid_dst_port (udp_dst_port_t dst_port, u8 is_ip4);
259 void udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
262 vlib_buffer_push_udp (vlib_buffer_t * b, u16 sp, u16 dp, u8 offload_csum)
265 u16 udp_len = sizeof (udp_header_t) + b->current_length;
266 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID))
267 udp_len += b->total_length_not_including_first_buffer;
269 uh = vlib_buffer_push_uninit (b, sizeof (udp_header_t));
273 uh->length = clib_host_to_net_u16 (udp_len);
276 b->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
277 vnet_buffer (b)->l4_hdr_offset = (u8 *) uh - b->data;
283 ip_udp_fixup_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 is_ip4)
294 ip0 = vlib_buffer_get_current (b0);
296 /* fix the <bleep>ing outer-IP checksum */
297 sum0 = ip0->checksum;
298 /* old_l0 always 0, see the rewrite setup */
299 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
301 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
302 length /* changed member */ );
303 ip0->checksum = ip_csum_fold (sum0);
304 ip0->length = new_l0;
307 udp0 = (udp_header_t *) (ip0 + 1);
308 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
310 udp0->length = new_l0;
317 ip0 = vlib_buffer_get_current (b0);
319 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
321 ip0->payload_length = new_l0;
324 udp0 = (udp_header_t *) (ip0 + 1);
325 udp0->length = new_l0;
328 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
329 ASSERT (bogus0 == 0);
331 if (udp0->checksum == 0)
332 udp0->checksum = 0xffff;
337 ip_udp_encap_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 * ec0, word ec_len,
340 vlib_buffer_advance (b0, -ec_len);
346 ip0 = vlib_buffer_get_current (b0);
348 /* Apply the encap string. */
349 clib_memcpy_fast (ip0, ec0, ec_len);
350 ip_udp_fixup_one (vm, b0, 1);
356 ip0 = vlib_buffer_get_current (b0);
358 /* Apply the encap string. */
359 clib_memcpy_fast (ip0, ec0, ec_len);
360 ip_udp_fixup_one (vm, b0, 0);
365 ip_udp_encap_two (vlib_main_t * vm, vlib_buffer_t * b0, vlib_buffer_t * b1,
366 u8 * ec0, u8 * ec1, word ec_len, u8 is_v4)
369 udp_header_t *udp0, *udp1;
371 ASSERT (_vec_len (ec0) == _vec_len (ec1));
373 vlib_buffer_advance (b0, -ec_len);
374 vlib_buffer_advance (b1, -ec_len);
378 ip4_header_t *ip0, *ip1;
379 ip_csum_t sum0, sum1;
380 u16 old_l0 = 0, old_l1 = 0;
382 ip0 = vlib_buffer_get_current (b0);
383 ip1 = vlib_buffer_get_current (b1);
385 /* Apply the encap string */
386 clib_memcpy_fast (ip0, ec0, ec_len);
387 clib_memcpy_fast (ip1, ec1, ec_len);
389 /* fix the <bleep>ing outer-IP checksum */
390 sum0 = ip0->checksum;
391 sum1 = ip1->checksum;
393 /* old_l0 always 0, see the rewrite setup */
394 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
395 new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1));
397 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
398 length /* changed member */ );
399 sum1 = ip_csum_update (sum1, old_l1, new_l1, ip4_header_t,
400 length /* changed member */ );
402 ip0->checksum = ip_csum_fold (sum0);
403 ip1->checksum = ip_csum_fold (sum1);
405 ip0->length = new_l0;
406 ip1->length = new_l1;
409 udp0 = (udp_header_t *) (ip0 + 1);
410 udp1 = (udp_header_t *) (ip1 + 1);
413 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
416 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1) -
418 udp0->length = new_l0;
419 udp1->length = new_l1;
423 ip6_header_t *ip0, *ip1;
426 ip0 = vlib_buffer_get_current (b0);
427 ip1 = vlib_buffer_get_current (b1);
429 /* Apply the encap string. */
430 clib_memcpy_fast (ip0, ec0, ec_len);
431 clib_memcpy_fast (ip1, ec1, ec_len);
433 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
435 new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1)
437 ip0->payload_length = new_l0;
438 ip1->payload_length = new_l1;
441 udp0 = (udp_header_t *) (ip0 + 1);
442 udp1 = (udp_header_t *) (ip1 + 1);
444 udp0->length = new_l0;
445 udp1->length = new_l1;
448 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
450 ip6_tcp_udp_icmp_compute_checksum (vm, b1, ip1, &bogus1);
451 ASSERT (bogus0 == 0);
452 ASSERT (bogus1 == 0);
454 if (udp0->checksum == 0)
455 udp0->checksum = 0xffff;
456 if (udp1->checksum == 0)
457 udp1->checksum = 0xffff;
462 * fd.io coding-style-patch-verification: ON
465 * eval: (c-set-style "gnu")
469 #endif /* __included_udp_h__ */