2 * node.c: udp packet processing
4 * Copyright (c) 2013-2019 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vlib/vlib.h>
19 #include <vnet/pg/pg.h>
20 #include <vnet/udp/udp.h>
21 #include <vnet/udp/udp_packet.h>
22 #include <vppinfra/sparse_vec.h>
24 #define foreach_udp_local_next \
25 _ (PUNT4, "ip4-punt") \
26 _ (PUNT6, "ip6-punt") \
27 _ (DROP4, "ip4-drop") \
28 _ (DROP6, "ip6-drop") \
29 _ (ICMP4_ERROR, "ip4-icmp-error") \
30 _ (ICMP6_ERROR, "ip6-icmp-error")
34 #define _(s,n) UDP_LOCAL_NEXT_##s,
35 foreach_udp_local_next
40 #define udp_local_next_drop(is_ip4) ((is_ip4) ? UDP_LOCAL_NEXT_DROP4 : UDP_LOCAL_NEXT_DROP6)
41 #define udp_local_next_punt(is_ip4) ((is_ip4) ? UDP_LOCAL_NEXT_PUNT4 : UDP_LOCAL_NEXT_PUNT6)
48 } udp_local_rx_trace_t;
50 #ifndef CLIB_MARCH_VARIANT
52 format_udp_rx_trace (u8 * s, va_list * args)
54 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
55 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
56 udp_local_rx_trace_t *t = va_arg (*args, udp_local_rx_trace_t *);
58 s = format (s, "UDP: src-port %d dst-port %d%s",
59 clib_net_to_host_u16 (t->src_port),
60 clib_net_to_host_u16 (t->dst_port),
61 t->bound ? "" : " (no listener)");
64 #endif /* CLIB_MARCH_VARIANT */
67 udp46_local_inline (vlib_main_t * vm,
68 vlib_node_runtime_t * node,
69 vlib_frame_t * from_frame, int is_ip4)
71 udp_main_t *um = &udp_main;
72 __attribute__ ((unused)) u32 n_left_from, next_index, *from, *to_next;
73 word n_no_listener = 0;
74 u8 punt_unknown = is_ip4 ? um->punt_unknown4 : um->punt_unknown6;
76 from = vlib_frame_vector_args (from_frame);
77 n_left_from = from_frame->n_vectors;
79 next_index = node->cached_next_index;
81 while (n_left_from > 0)
85 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
87 while (n_left_from >= 4 && n_left_to_next >= 2)
90 vlib_buffer_t *b0, *b1;
91 udp_header_t *h0 = 0, *h1 = 0;
92 u32 i0, i1, dst_port0, dst_port1;
93 u32 advance0, advance1;
94 u32 error0, next0, error1, next1;
96 /* Prefetch next iteration. */
98 vlib_buffer_t *p2, *p3;
100 p2 = vlib_get_buffer (vm, from[2]);
101 p3 = vlib_get_buffer (vm, from[3]);
103 vlib_prefetch_buffer_header (p2, LOAD);
104 vlib_prefetch_buffer_header (p3, LOAD);
106 CLIB_PREFETCH (p2->data, sizeof (h0[0]), LOAD);
107 CLIB_PREFETCH (p3->data, sizeof (h1[0]), LOAD);
119 b0 = vlib_get_buffer (vm, bi0);
120 b1 = vlib_get_buffer (vm, bi1);
122 /* ip4/6_local hands us the ip header, not the udp header */
125 advance0 = sizeof (ip4_header_t);
126 advance1 = sizeof (ip4_header_t);
130 advance0 = sizeof (ip6_header_t);
131 advance1 = sizeof (ip6_header_t);
134 if (PREDICT_FALSE (b0->current_length < advance0 + sizeof (*h0)))
136 error0 = UDP_ERROR_LENGTH_ERROR;
137 next0 = udp_local_next_drop (is_ip4);
141 vlib_buffer_advance (b0, advance0);
142 h0 = vlib_buffer_get_current (b0);
144 if (PREDICT_FALSE (clib_net_to_host_u16 (h0->length) >
145 vlib_buffer_length_in_chain (vm, b0)))
147 error0 = UDP_ERROR_LENGTH_ERROR;
148 next0 = udp_local_next_drop (is_ip4);
152 if (PREDICT_FALSE (b1->current_length < advance1 + sizeof (*h1)))
154 error1 = UDP_ERROR_LENGTH_ERROR;
155 next1 = udp_local_next_drop (is_ip4);
159 vlib_buffer_advance (b1, advance1);
160 h1 = vlib_buffer_get_current (b1);
162 if (PREDICT_FALSE (clib_net_to_host_u16 (h1->length) >
163 vlib_buffer_length_in_chain (vm, b1)))
165 error1 = UDP_ERROR_LENGTH_ERROR;
166 next1 = udp_local_next_drop (is_ip4);
170 /* Index sparse array with network byte order. */
171 dst_port0 = (error0 == 0) ? h0->dst_port : 0;
172 dst_port1 = (error1 == 0) ? h1->dst_port : 0;
173 sparse_vec_index2 (is_ip4 ? um->next_by_dst_port4 :
174 um->next_by_dst_port6,
175 dst_port0, dst_port1, &i0, &i1);
176 next0 = (error0 == 0) ?
177 vec_elt (is_ip4 ? um->next_by_dst_port4 : um->next_by_dst_port6,
179 next1 = (error1 == 0) ?
180 vec_elt (is_ip4 ? um->next_by_dst_port4 : um->next_by_dst_port6,
183 if (PREDICT_FALSE (i0 == SPARSE_VEC_INVALID_INDEX))
185 // move the pointer back so icmp-error can find the
187 vlib_buffer_advance (b0, -(word) advance0);
189 if (PREDICT_FALSE (punt_unknown))
191 b0->error = node->errors[UDP_ERROR_PUNT];
192 next0 = udp_local_next_punt (is_ip4);
196 icmp4_error_set_vnet_buffer (b0,
197 ICMP4_destination_unreachable,
198 ICMP4_destination_unreachable_port_unreachable,
200 next0 = UDP_LOCAL_NEXT_ICMP4_ERROR;
205 icmp6_error_set_vnet_buffer (b0,
206 ICMP6_destination_unreachable,
207 ICMP6_destination_unreachable_port_unreachable,
209 next0 = UDP_LOCAL_NEXT_ICMP6_ERROR;
215 b0->error = node->errors[UDP_ERROR_NONE];
216 // advance to the payload
217 vlib_buffer_advance (b0, sizeof (*h0));
220 if (PREDICT_FALSE (i1 == SPARSE_VEC_INVALID_INDEX))
222 // move the pointer back so icmp-error can find the
224 vlib_buffer_advance (b1, -(word) advance1);
226 if (PREDICT_FALSE (punt_unknown))
228 b1->error = node->errors[UDP_ERROR_PUNT];
229 next1 = udp_local_next_punt (is_ip4);
233 icmp4_error_set_vnet_buffer (b1,
234 ICMP4_destination_unreachable,
235 ICMP4_destination_unreachable_port_unreachable,
237 next1 = UDP_LOCAL_NEXT_ICMP4_ERROR;
242 icmp6_error_set_vnet_buffer (b1,
243 ICMP6_destination_unreachable,
244 ICMP6_destination_unreachable_port_unreachable,
246 next1 = UDP_LOCAL_NEXT_ICMP6_ERROR;
252 b1->error = node->errors[UDP_ERROR_NONE];
253 // advance to the payload
254 vlib_buffer_advance (b1, sizeof (*h1));
257 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
259 udp_local_rx_trace_t *tr = vlib_add_trace (vm, node,
261 if (b0->error != node->errors[UDP_ERROR_LENGTH_ERROR])
263 tr->src_port = h0 ? h0->src_port : 0;
264 tr->dst_port = h0 ? h0->dst_port : 0;
265 tr->bound = (next0 != UDP_LOCAL_NEXT_ICMP4_ERROR &&
266 next0 != UDP_LOCAL_NEXT_ICMP6_ERROR);
269 if (PREDICT_FALSE (b1->flags & VLIB_BUFFER_IS_TRACED))
271 udp_local_rx_trace_t *tr = vlib_add_trace (vm, node,
273 if (b1->error != node->errors[UDP_ERROR_LENGTH_ERROR])
275 tr->src_port = h1 ? h1->src_port : 0;
276 tr->dst_port = h1 ? h1->dst_port : 0;
277 tr->bound = (next1 != UDP_LOCAL_NEXT_ICMP4_ERROR &&
278 next1 != UDP_LOCAL_NEXT_ICMP6_ERROR);
282 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
283 to_next, n_left_to_next,
284 bi0, bi1, next0, next1);
287 while (n_left_from > 0 && n_left_to_next > 0)
291 udp_header_t *h0 = 0;
302 b0 = vlib_get_buffer (vm, bi0);
304 /* ip4/6_local hands us the ip header, not the udp header */
306 advance0 = sizeof (ip4_header_t);
308 advance0 = sizeof (ip6_header_t);
310 if (PREDICT_FALSE (b0->current_length < advance0 + sizeof (*h0)))
312 b0->error = node->errors[UDP_ERROR_LENGTH_ERROR];
313 next0 = udp_local_next_drop (is_ip4);
317 vlib_buffer_advance (b0, advance0);
319 h0 = vlib_buffer_get_current (b0);
321 if (PREDICT_TRUE (clib_net_to_host_u16 (h0->length) <=
322 vlib_buffer_length_in_chain (vm, b0)))
324 i0 = sparse_vec_index (is_ip4 ? um->next_by_dst_port4 :
325 um->next_by_dst_port6, h0->dst_port);
326 next0 = vec_elt (is_ip4 ? um->next_by_dst_port4 :
327 um->next_by_dst_port6, i0);
329 if (PREDICT_FALSE (i0 == SPARSE_VEC_INVALID_INDEX))
331 // move the pointer back so icmp-error can find the
333 vlib_buffer_advance (b0, -(word) advance0);
335 if (PREDICT_FALSE (punt_unknown))
337 b0->error = node->errors[UDP_ERROR_PUNT];
338 next0 = udp_local_next_punt (is_ip4);
342 icmp4_error_set_vnet_buffer (b0,
343 ICMP4_destination_unreachable,
344 ICMP4_destination_unreachable_port_unreachable,
346 next0 = UDP_LOCAL_NEXT_ICMP4_ERROR;
351 icmp6_error_set_vnet_buffer (b0,
352 ICMP6_destination_unreachable,
353 ICMP6_destination_unreachable_port_unreachable,
355 next0 = UDP_LOCAL_NEXT_ICMP6_ERROR;
361 b0->error = node->errors[UDP_ERROR_NONE];
362 // advance to the payload
363 vlib_buffer_advance (b0, sizeof (*h0));
368 b0->error = node->errors[UDP_ERROR_LENGTH_ERROR];
369 next0 = udp_local_next_drop (is_ip4);
373 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
375 udp_local_rx_trace_t *tr = vlib_add_trace (vm, node,
377 if (b0->error != node->errors[UDP_ERROR_LENGTH_ERROR])
379 tr->src_port = h0->src_port;
380 tr->dst_port = h0->dst_port;
381 tr->bound = (next0 != UDP_LOCAL_NEXT_ICMP4_ERROR &&
382 next0 != UDP_LOCAL_NEXT_ICMP6_ERROR);
386 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
387 to_next, n_left_to_next,
391 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
393 vlib_error_count (vm, node->node_index, UDP_ERROR_NO_LISTENER,
395 return from_frame->n_vectors;
398 static char *udp_error_strings[] = {
399 #define udp_error(n,s) s,
400 #include "udp_error.def"
404 VLIB_NODE_FN (udp4_local_node) (vlib_main_t * vm,
405 vlib_node_runtime_t * node,
406 vlib_frame_t * from_frame)
408 return udp46_local_inline (vm, node, from_frame, 1 /* is_ip4 */ );
411 VLIB_NODE_FN (udp6_local_node) (vlib_main_t * vm,
412 vlib_node_runtime_t * node,
413 vlib_frame_t * from_frame)
415 return udp46_local_inline (vm, node, from_frame, 0 /* is_ip4 */ );
419 VLIB_REGISTER_NODE (udp4_local_node) = {
420 .name = "ip4-udp-lookup",
421 /* Takes a vector of packets. */
422 .vector_size = sizeof (u32),
424 .n_errors = UDP_N_ERROR,
425 .error_strings = udp_error_strings,
427 .n_next_nodes = UDP_LOCAL_N_NEXT,
429 #define _(s,n) [UDP_LOCAL_NEXT_##s] = n,
430 foreach_udp_local_next
434 .format_buffer = format_udp_header,
435 .format_trace = format_udp_rx_trace,
436 .unformat_buffer = unformat_udp_header,
441 VLIB_REGISTER_NODE (udp6_local_node) = {
442 .name = "ip6-udp-lookup",
443 /* Takes a vector of packets. */
444 .vector_size = sizeof (u32),
446 .n_errors = UDP_N_ERROR,
447 .error_strings = udp_error_strings,
449 .n_next_nodes = UDP_LOCAL_N_NEXT,
451 #define _(s,n) [UDP_LOCAL_NEXT_##s] = n,
452 foreach_udp_local_next
456 .format_buffer = format_udp_header,
457 .format_trace = format_udp_rx_trace,
458 .unformat_buffer = unformat_udp_header,
462 #ifndef CLIB_MARCH_VARIANT
464 add_dst_port (udp_main_t * um,
465 udp_dst_port_t dst_port, char *dst_port_name, u8 is_ip4)
467 udp_dst_port_info_t *pi;
470 vec_add2 (um->dst_port_infos[is_ip4], pi, 1);
471 i = pi - um->dst_port_infos[is_ip4];
473 pi->name = dst_port_name;
474 pi->dst_port = dst_port;
475 pi->next_index = pi->node_index = ~0;
477 hash_set (um->dst_port_info_by_dst_port[is_ip4], dst_port, i);
480 hash_set_mem (um->dst_port_info_by_name[is_ip4], pi->name, i);
484 udp_register_dst_port (vlib_main_t * vm,
485 udp_dst_port_t dst_port, u32 node_index, u8 is_ip4)
487 udp_main_t *um = &udp_main;
488 udp_dst_port_info_t *pi;
492 clib_error_t *error = vlib_call_init_function (vm, udp_local_init);
494 clib_error_report (error);
497 pi = udp_get_dst_port_info (um, dst_port, is_ip4);
500 add_dst_port (um, dst_port, 0, is_ip4);
501 pi = udp_get_dst_port_info (um, dst_port, is_ip4);
505 pi->node_index = node_index;
506 pi->next_index = vlib_node_add_next (vm,
507 is_ip4 ? udp4_local_node.index
508 : udp6_local_node.index, node_index);
510 /* Setup udp protocol -> next index sparse vector mapping. */
512 n = sparse_vec_validate (um->next_by_dst_port4,
513 clib_host_to_net_u16 (dst_port));
515 n = sparse_vec_validate (um->next_by_dst_port6,
516 clib_host_to_net_u16 (dst_port));
518 n[0] = pi->next_index;
522 udp_unregister_dst_port (vlib_main_t * vm, udp_dst_port_t dst_port, u8 is_ip4)
524 udp_main_t *um = &udp_main;
525 udp_dst_port_info_t *pi;
528 pi = udp_get_dst_port_info (um, dst_port, is_ip4);
529 /* Not registered? Fagedaboudit */
533 /* Kill the mapping. Don't bother killing the pi, it may be back. */
535 n = sparse_vec_validate (um->next_by_dst_port4,
536 clib_host_to_net_u16 (dst_port));
538 n = sparse_vec_validate (um->next_by_dst_port6,
539 clib_host_to_net_u16 (dst_port));
541 n[0] = SPARSE_VEC_INVALID_INDEX;
545 udp_is_valid_dst_port (udp_dst_port_t dst_port, u8 is_ip4)
547 udp_main_t *um = &udp_main;
551 n = sparse_vec_validate (um->next_by_dst_port4,
552 clib_host_to_net_u16 (dst_port));
554 n = sparse_vec_validate (um->next_by_dst_port6,
555 clib_host_to_net_u16 (dst_port));
557 return (n[0] != SPARSE_VEC_INVALID_INDEX);
561 udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
563 udp_main_t *um = &udp_main;
565 clib_error_t *error = vlib_call_init_function (vm, udp_local_init);
567 clib_error_report (error);
571 um->punt_unknown4 = is_add;
573 um->punt_unknown6 = is_add;
576 /* Parse a UDP header. */
578 unformat_udp_header (unformat_input_t * input, va_list * args)
580 u8 **result = va_arg (*args, u8 **);
582 __attribute__ ((unused)) int old_length;
583 u16 src_port, dst_port;
585 /* Allocate space for IP header. */
589 old_length = vec_len (*result);
590 vec_add2 (*result, p, sizeof (ip4_header_t));
594 clib_memset (udp, 0, sizeof (udp[0]));
595 if (unformat (input, "src-port %d dst-port %d", &src_port, &dst_port))
597 udp->src_port = clib_host_to_net_u16 (src_port);
598 udp->dst_port = clib_host_to_net_u16 (dst_port);
605 udp_setup_node (vlib_main_t * vm, u32 node_index)
607 vlib_node_t *n = vlib_get_node (vm, node_index);
608 pg_node_t *pn = pg_get_node (node_index);
610 n->format_buffer = format_udp_header;
611 n->unformat_buffer = unformat_udp_header;
612 pn->unformat_edit = unformat_pg_udp_header;
616 udp_local_init (vlib_main_t * vm)
618 udp_main_t *um = &udp_main;
623 error = vlib_call_init_function (vm, udp_init);
625 clib_error_report (error);
629 for (i = 0; i < 2; i++)
631 um->dst_port_info_by_name[i] = hash_create_string (0, sizeof (uword));
632 um->dst_port_info_by_dst_port[i] = hash_create (0, sizeof (uword));
635 udp_setup_node (vm, udp4_local_node.index);
636 udp_setup_node (vm, udp6_local_node.index);
638 um->punt_unknown4 = 0;
639 um->punt_unknown6 = 0;
641 um->next_by_dst_port4 = sparse_vec_new
642 ( /* elt bytes */ sizeof (um->next_by_dst_port4[0]),
643 /* bits in index */ BITS (((udp_header_t *) 0)->dst_port));
645 um->next_by_dst_port6 = sparse_vec_new
646 ( /* elt bytes */ sizeof (um->next_by_dst_port6[0]),
647 /* bits in index */ BITS (((udp_header_t *) 0)->dst_port));
649 #define _(n,s) add_dst_port (um, UDP_DST_PORT_##s, #s, 1 /* is_ip4 */);
650 foreach_udp4_dst_port
652 #define _(n,s) add_dst_port (um, UDP_DST_PORT_##s, #s, 0 /* is_ip4 */);
653 foreach_udp6_dst_port
655 ip4_register_protocol (IP_PROTOCOL_UDP, udp4_local_node.index);
656 /* Note: ip6 differs from ip4, UDP is hotwired to ip6-udp-lookup */
660 VLIB_INIT_FUNCTION (udp_local_init);
661 #endif /* CLIB_MARCH_VARIANT */
664 * fd.io coding-style-patch-verification: ON
667 * eval: (c-set-style "gnu")