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 transport_connection_t connection; /** must be first */
40 /** ersatz MTU to limit fifo pushes to test data size */
44 #define foreach_udp4_dst_port \
46 _ (67, dhcp_to_server) \
47 _ (68, dhcp_to_client) \
63 #define foreach_udp6_dst_port \
65 _ (547, dhcpv6_to_server) \
66 _ (546, dhcpv6_to_client) \
72 _ (4790, VXLAN6_GPE) \
80 #define _(n,f) UDP_DST_PORT_##f = n,
81 foreach_udp4_dst_port foreach_udp6_dst_port
87 #define _(n,f) UDP6_DST_PORT_##f = n,
94 /* Name (a c string). */
97 /* GRE protocol type in host byte order. */
98 udp_dst_port_t dst_port;
100 /* Node which handles this type. */
103 /* Next index for this type. */
105 } udp_dst_port_info_t;
110 UDP_IP4, /* the code is full of is_ip4... */
116 udp_dst_port_info_t *dst_port_infos[N_UDP_AF];
118 /* Hash tables mapping name/protocol to protocol info index. */
119 uword *dst_port_info_by_name[N_UDP_AF];
120 uword *dst_port_info_by_dst_port[N_UDP_AF];
122 /* Sparse vector mapping udp dst_port in network byte order
124 u16 *next_by_dst_port4;
125 u16 *next_by_dst_port6;
130 * Per-worker thread udp connection pools used with session layer
132 udp_connection_t **connections;
133 u32 *connection_peekers;
134 clib_spinlock_t *peekers_readers_locks;
135 clib_spinlock_t *peekers_write_locks;
136 udp_connection_t *listener_pool;
140 extern udp_main_t udp_main;
141 extern vlib_node_registration_t udp4_input_node;
142 extern vlib_node_registration_t udp6_input_node;
144 always_inline udp_connection_t *
145 udp_connection_get (u32 conn_index, u32 thread_index)
147 if (pool_is_free_index (udp_main.connections[thread_index], conn_index))
149 return pool_elt_at_index (udp_main.connections[thread_index], conn_index);
152 always_inline udp_connection_t *
153 udp_listener_get (u32 conn_index)
155 return pool_elt_at_index (udp_main.listener_pool, conn_index);
158 always_inline udp_main_t *
164 always_inline udp_connection_t *
165 udp_get_connection_from_transport (transport_connection_t * tc)
167 return ((udp_connection_t *) tc);
171 udp_connection_index (udp_connection_t * uc)
173 return (uc - udp_main.connections[uc->c_thread_index]);
176 udp_connection_t *udp_connection_alloc (u32 thread_index);
179 * Acquires a lock that blocks a connection pool from expanding.
182 udp_pool_add_peeker (u32 thread_index)
184 if (thread_index != vlib_get_thread_index ())
186 clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
187 udp_main.connection_peekers[thread_index] += 1;
188 if (udp_main.connection_peekers[thread_index] == 1)
189 clib_spinlock_lock_if_init (&udp_main.peekers_write_locks[thread_index]);
190 clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
195 udp_pool_remove_peeker (u32 thread_index)
197 if (thread_index != vlib_get_thread_index ())
199 ASSERT (udp_main.connection_peekers[thread_index] > 0);
200 clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
201 udp_main.connection_peekers[thread_index] -= 1;
202 if (udp_main.connection_peekers[thread_index] == 0)
203 clib_spinlock_unlock_if_init (&udp_main.peekers_write_locks
205 clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
209 always_inline udp_connection_t *
210 udp_conenction_clone_safe (u32 connection_index, u32 thread_index)
212 udp_connection_t *old_c, *new_c;
213 u32 current_thread_index = vlib_get_thread_index ();
214 new_c = udp_connection_alloc (current_thread_index);
216 /* If during the memcpy pool is reallocated AND the memory allocator
217 * decides to give the old chunk of memory to somebody in a hurry to
218 * scribble something on it, we have a problem. So add this thread as
219 * a session pool peeker.
221 udp_pool_add_peeker (thread_index);
222 old_c = udp_main.connections[thread_index] + connection_index;
223 clib_memcpy (new_c, old_c, sizeof (*new_c));
224 udp_pool_remove_peeker (thread_index);
225 new_c->c_thread_index = current_thread_index;
226 new_c->c_c_index = udp_connection_index (new_c);
231 always_inline udp_dst_port_info_t *
232 udp_get_dst_port_info (udp_main_t * um, udp_dst_port_t dst_port, u8 is_ip4)
234 uword *p = hash_get (um->dst_port_info_by_dst_port[is_ip4], dst_port);
235 return p ? vec_elt_at_index (um->dst_port_infos[is_ip4], p[0]) : 0;
238 format_function_t format_udp_header;
239 format_function_t format_udp_rx_trace;
240 unformat_function_t unformat_udp_header;
242 void udp_register_dst_port (vlib_main_t * vm,
243 udp_dst_port_t dst_port,
244 u32 node_index, u8 is_ip4);
245 void udp_unregister_dst_port (vlib_main_t * vm,
246 udp_dst_port_t dst_port, u8 is_ip4);
248 void udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
251 vlib_buffer_push_udp (vlib_buffer_t * b, u16 sp, u16 dp, u8 offload_csum)
255 uh = vlib_buffer_push_uninit (b, sizeof (udp_header_t));
259 uh->length = clib_host_to_net_u16 (b->current_length);
262 b->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
263 vnet_buffer (b)->l4_hdr_offset = (u8 *) uh - b->data;
269 ip_udp_fixup_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 is_ip4)
280 ip0 = vlib_buffer_get_current (b0);
282 /* fix the <bleep>ing outer-IP checksum */
283 sum0 = ip0->checksum;
284 /* old_l0 always 0, see the rewrite setup */
285 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
287 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
288 length /* changed member */ );
289 ip0->checksum = ip_csum_fold (sum0);
290 ip0->length = new_l0;
293 udp0 = (udp_header_t *) (ip0 + 1);
294 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
296 udp0->length = new_l0;
303 ip0 = vlib_buffer_get_current (b0);
305 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
307 ip0->payload_length = new_l0;
310 udp0 = (udp_header_t *) (ip0 + 1);
311 udp0->length = new_l0;
314 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
315 ASSERT (bogus0 == 0);
317 if (udp0->checksum == 0)
318 udp0->checksum = 0xffff;
323 ip_udp_encap_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 * ec0, word ec_len,
326 vlib_buffer_advance (b0, -ec_len);
332 ip0 = vlib_buffer_get_current (b0);
334 /* Apply the encap string. */
335 clib_memcpy (ip0, ec0, ec_len);
336 ip_udp_fixup_one (vm, b0, 1);
342 ip0 = vlib_buffer_get_current (b0);
344 /* Apply the encap string. */
345 clib_memcpy (ip0, ec0, ec_len);
346 ip_udp_fixup_one (vm, b0, 0);
351 ip_udp_encap_two (vlib_main_t * vm, vlib_buffer_t * b0, vlib_buffer_t * b1,
352 u8 * ec0, u8 * ec1, word ec_len, u8 is_v4)
355 udp_header_t *udp0, *udp1;
357 ASSERT (_vec_len (ec0) == _vec_len (ec1));
359 vlib_buffer_advance (b0, -ec_len);
360 vlib_buffer_advance (b1, -ec_len);
364 ip4_header_t *ip0, *ip1;
365 ip_csum_t sum0, sum1;
366 u16 old_l0 = 0, old_l1 = 0;
368 ip0 = vlib_buffer_get_current (b0);
369 ip1 = vlib_buffer_get_current (b1);
371 /* Apply the encap string */
372 clib_memcpy (ip0, ec0, ec_len);
373 clib_memcpy (ip1, ec1, ec_len);
375 /* fix the <bleep>ing outer-IP checksum */
376 sum0 = ip0->checksum;
377 sum1 = ip1->checksum;
379 /* old_l0 always 0, see the rewrite setup */
380 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
381 new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1));
383 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
384 length /* changed member */ );
385 sum1 = ip_csum_update (sum1, old_l1, new_l1, ip4_header_t,
386 length /* changed member */ );
388 ip0->checksum = ip_csum_fold (sum0);
389 ip1->checksum = ip_csum_fold (sum1);
391 ip0->length = new_l0;
392 ip1->length = new_l1;
395 udp0 = (udp_header_t *) (ip0 + 1);
396 udp1 = (udp_header_t *) (ip1 + 1);
399 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
402 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1) -
404 udp0->length = new_l0;
405 udp1->length = new_l1;
409 ip6_header_t *ip0, *ip1;
412 ip0 = vlib_buffer_get_current (b0);
413 ip1 = vlib_buffer_get_current (b1);
415 /* Apply the encap string. */
416 clib_memcpy (ip0, ec0, ec_len);
417 clib_memcpy (ip1, ec1, ec_len);
419 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
421 new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1)
423 ip0->payload_length = new_l0;
424 ip1->payload_length = new_l1;
427 udp0 = (udp_header_t *) (ip0 + 1);
428 udp1 = (udp_header_t *) (ip1 + 1);
430 udp0->length = new_l0;
431 udp1->length = new_l1;
434 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
436 ip6_tcp_udp_icmp_compute_checksum (vm, b1, ip1, &bogus1);
437 ASSERT (bogus0 == 0);
438 ASSERT (bogus1 == 0);
440 if (udp0->checksum == 0)
441 udp0->checksum = 0xffff;
442 if (udp1->checksum == 0)
443 udp1->checksum = 0xffff;
448 * fd.io coding-style-patch-verification: ON
451 * eval: (c-set-style "gnu")
455 #endif /* __included_udp_h__ */