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) \
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. */
110 } udp_dst_port_info_t;
115 UDP_IP4, /* the code is full of is_ip4... */
121 udp_dst_port_info_t *dst_port_infos[N_UDP_AF];
123 /* Hash tables mapping name/protocol to protocol info index. */
124 uword *dst_port_info_by_name[N_UDP_AF];
125 uword *dst_port_info_by_dst_port[N_UDP_AF];
127 /* Sparse vector mapping udp dst_port in network byte order
129 u16 *next_by_dst_port4;
130 u16 *next_by_dst_port6;
135 * Per-worker thread udp connection pools used with session layer
137 udp_connection_t **connections;
138 u32 *connection_peekers;
139 clib_spinlock_t *peekers_readers_locks;
140 clib_spinlock_t *peekers_write_locks;
141 udp_connection_t *listener_pool;
145 extern udp_main_t udp_main;
146 extern vlib_node_registration_t udp4_input_node;
147 extern vlib_node_registration_t udp6_input_node;
149 always_inline udp_connection_t *
150 udp_connection_get (u32 conn_index, u32 thread_index)
152 if (pool_is_free_index (udp_main.connections[thread_index], conn_index))
154 return pool_elt_at_index (udp_main.connections[thread_index], conn_index);
157 always_inline udp_connection_t *
158 udp_listener_get (u32 conn_index)
160 return pool_elt_at_index (udp_main.listener_pool, conn_index);
163 always_inline udp_main_t *
169 always_inline udp_connection_t *
170 udp_get_connection_from_transport (transport_connection_t * tc)
172 return ((udp_connection_t *) tc);
176 udp_connection_index (udp_connection_t * uc)
178 return (uc - udp_main.connections[uc->c_thread_index]);
181 udp_connection_t *udp_connection_alloc (u32 thread_index);
184 * Acquires a lock that blocks a connection pool from expanding.
187 udp_pool_add_peeker (u32 thread_index)
189 if (thread_index != vlib_get_thread_index ())
191 clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
192 udp_main.connection_peekers[thread_index] += 1;
193 if (udp_main.connection_peekers[thread_index] == 1)
194 clib_spinlock_lock_if_init (&udp_main.peekers_write_locks[thread_index]);
195 clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
200 udp_pool_remove_peeker (u32 thread_index)
202 if (thread_index != vlib_get_thread_index ())
204 ASSERT (udp_main.connection_peekers[thread_index] > 0);
205 clib_spinlock_lock_if_init (&udp_main.peekers_readers_locks[thread_index]);
206 udp_main.connection_peekers[thread_index] -= 1;
207 if (udp_main.connection_peekers[thread_index] == 0)
208 clib_spinlock_unlock_if_init (&udp_main.peekers_write_locks
210 clib_spinlock_unlock_if_init (&udp_main.peekers_readers_locks
214 always_inline udp_connection_t *
215 udp_connection_clone_safe (u32 connection_index, u32 thread_index)
217 udp_connection_t *old_c, *new_c;
218 u32 current_thread_index = vlib_get_thread_index ();
219 new_c = udp_connection_alloc (current_thread_index);
221 /* If during the memcpy pool is reallocated AND the memory allocator
222 * decides to give the old chunk of memory to somebody in a hurry to
223 * scribble something on it, we have a problem. So add this thread as
224 * a session pool peeker.
226 udp_pool_add_peeker (thread_index);
227 old_c = udp_main.connections[thread_index] + connection_index;
228 clib_memcpy (new_c, old_c, sizeof (*new_c));
229 udp_pool_remove_peeker (thread_index);
230 new_c->c_thread_index = current_thread_index;
231 new_c->c_c_index = udp_connection_index (new_c);
236 always_inline udp_dst_port_info_t *
237 udp_get_dst_port_info (udp_main_t * um, udp_dst_port_t dst_port, u8 is_ip4)
239 uword *p = hash_get (um->dst_port_info_by_dst_port[is_ip4], dst_port);
240 return p ? vec_elt_at_index (um->dst_port_infos[is_ip4], p[0]) : 0;
243 format_function_t format_udp_header;
244 format_function_t format_udp_rx_trace;
245 unformat_function_t unformat_udp_header;
247 void udp_register_dst_port (vlib_main_t * vm,
248 udp_dst_port_t dst_port,
249 u32 node_index, u8 is_ip4);
250 void udp_unregister_dst_port (vlib_main_t * vm,
251 udp_dst_port_t dst_port, u8 is_ip4);
253 void udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
256 vlib_buffer_push_udp (vlib_buffer_t * b, u16 sp, u16 dp, u8 offload_csum)
259 u16 udp_len = sizeof (udp_header_t) + b->current_length;
260 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID))
261 udp_len += b->total_length_not_including_first_buffer;
263 uh = vlib_buffer_push_uninit (b, sizeof (udp_header_t));
267 uh->length = clib_host_to_net_u16 (udp_len);
270 b->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
271 vnet_buffer (b)->l4_hdr_offset = (u8 *) uh - b->data;
277 ip_udp_fixup_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 is_ip4)
288 ip0 = vlib_buffer_get_current (b0);
290 /* fix the <bleep>ing outer-IP checksum */
291 sum0 = ip0->checksum;
292 /* old_l0 always 0, see the rewrite setup */
293 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
295 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
296 length /* changed member */ );
297 ip0->checksum = ip_csum_fold (sum0);
298 ip0->length = new_l0;
301 udp0 = (udp_header_t *) (ip0 + 1);
302 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
304 udp0->length = new_l0;
311 ip0 = vlib_buffer_get_current (b0);
313 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
315 ip0->payload_length = new_l0;
318 udp0 = (udp_header_t *) (ip0 + 1);
319 udp0->length = new_l0;
322 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
323 ASSERT (bogus0 == 0);
325 if (udp0->checksum == 0)
326 udp0->checksum = 0xffff;
331 ip_udp_encap_one (vlib_main_t * vm, vlib_buffer_t * b0, u8 * ec0, word ec_len,
334 vlib_buffer_advance (b0, -ec_len);
340 ip0 = vlib_buffer_get_current (b0);
342 /* Apply the encap string. */
343 clib_memcpy (ip0, ec0, ec_len);
344 ip_udp_fixup_one (vm, b0, 1);
350 ip0 = vlib_buffer_get_current (b0);
352 /* Apply the encap string. */
353 clib_memcpy (ip0, ec0, ec_len);
354 ip_udp_fixup_one (vm, b0, 0);
359 ip_udp_encap_two (vlib_main_t * vm, vlib_buffer_t * b0, vlib_buffer_t * b1,
360 u8 * ec0, u8 * ec1, word ec_len, u8 is_v4)
363 udp_header_t *udp0, *udp1;
365 ASSERT (_vec_len (ec0) == _vec_len (ec1));
367 vlib_buffer_advance (b0, -ec_len);
368 vlib_buffer_advance (b1, -ec_len);
372 ip4_header_t *ip0, *ip1;
373 ip_csum_t sum0, sum1;
374 u16 old_l0 = 0, old_l1 = 0;
376 ip0 = vlib_buffer_get_current (b0);
377 ip1 = vlib_buffer_get_current (b1);
379 /* Apply the encap string */
380 clib_memcpy (ip0, ec0, ec_len);
381 clib_memcpy (ip1, ec1, ec_len);
383 /* fix the <bleep>ing outer-IP checksum */
384 sum0 = ip0->checksum;
385 sum1 = ip1->checksum;
387 /* old_l0 always 0, see the rewrite setup */
388 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
389 new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1));
391 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
392 length /* changed member */ );
393 sum1 = ip_csum_update (sum1, old_l1, new_l1, ip4_header_t,
394 length /* changed member */ );
396 ip0->checksum = ip_csum_fold (sum0);
397 ip1->checksum = ip_csum_fold (sum1);
399 ip0->length = new_l0;
400 ip1->length = new_l1;
403 udp0 = (udp_header_t *) (ip0 + 1);
404 udp1 = (udp_header_t *) (ip1 + 1);
407 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
410 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1) -
412 udp0->length = new_l0;
413 udp1->length = new_l1;
417 ip6_header_t *ip0, *ip1;
420 ip0 = vlib_buffer_get_current (b0);
421 ip1 = vlib_buffer_get_current (b1);
423 /* Apply the encap string. */
424 clib_memcpy (ip0, ec0, ec_len);
425 clib_memcpy (ip1, ec1, ec_len);
427 new_l0 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
429 new_l1 = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1)
431 ip0->payload_length = new_l0;
432 ip1->payload_length = new_l1;
435 udp0 = (udp_header_t *) (ip0 + 1);
436 udp1 = (udp_header_t *) (ip1 + 1);
438 udp0->length = new_l0;
439 udp1->length = new_l1;
442 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip0, &bogus0);
444 ip6_tcp_udp_icmp_compute_checksum (vm, b1, ip1, &bogus1);
445 ASSERT (bogus0 == 0);
446 ASSERT (bogus1 == 0);
448 if (udp0->checksum == 0)
449 udp0->checksum = 0xffff;
450 if (udp1->checksum == 0)
451 udp1->checksum = 0xffff;
456 * fd.io coding-style-patch-verification: ON
459 * eval: (c-set-style "gnu")
463 #endif /* __included_udp_h__ */