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>
37 } udp_local_rx_trace_t;
39 static vlib_error_desc_t udp_error_counters[] = {
40 #define udp_error(f, n, s, d) { #n, d, VL_COUNTER_SEVERITY_##s },
41 #include "udp_error.def"
45 #define UDP_NO_NODE_SET ((u16) ~0)
47 #ifndef CLIB_MARCH_VARIANT
49 format_udp_rx_trace (u8 * s, va_list * args)
51 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
52 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
53 udp_local_rx_trace_t *t = va_arg (*args, udp_local_rx_trace_t *);
55 s = format (s, "UDP: src-port %d dst-port %d%s",
56 clib_net_to_host_u16 (t->src_port),
57 clib_net_to_host_u16 (t->dst_port),
58 t->bound ? "" : " (no listener)");
61 #endif /* CLIB_MARCH_VARIANT */
64 udp_dispatch_error (vlib_node_runtime_t *node, vlib_buffer_t *b, u32 advance,
67 udp_main_t *um = &udp_main;
68 u8 punt_unknown = is_ip4 ? um->punt_unknown4 : um->punt_unknown6;
70 if (PREDICT_FALSE (punt_unknown))
72 vlib_buffer_advance (b, -(word) advance);
73 b->error = node->errors[UDP_ERROR_PUNT];
74 *next = UDP_LOCAL_NEXT_PUNT;
76 else if (um->icmp_send_unreachable_disabled)
78 *next = UDP_LOCAL_NEXT_DROP;
79 b->error = node->errors[UDP_ERROR_NO_LISTENER];
83 /* move the pointer back so icmp-error can find the ip packet header */
84 vlib_buffer_advance (b, -(word) advance);
88 icmp4_error_set_vnet_buffer (
89 b, ICMP4_destination_unreachable,
90 ICMP4_destination_unreachable_port_unreachable, 0);
91 b->error = node->errors[UDP_ERROR_NO_LISTENER];
92 *next = UDP_LOCAL_NEXT_ICMP;
96 icmp6_error_set_vnet_buffer (
97 b, ICMP6_destination_unreachable,
98 ICMP6_destination_unreachable_port_unreachable, 0);
99 b->error = node->errors[UDP_ERROR_NO_LISTENER];
100 *next = UDP_LOCAL_NEXT_ICMP;
106 udp46_local_inline (vlib_main_t * vm,
107 vlib_node_runtime_t * node,
108 vlib_frame_t * from_frame, int is_ip4)
110 udp_main_t *um = &udp_main;
111 __attribute__ ((unused)) u32 n_left_from, next_index, *from, *to_next;
112 u16 *next_by_dst_port = (is_ip4 ?
113 um->next_by_dst_port4 : um->next_by_dst_port6);
114 from = vlib_frame_vector_args (from_frame);
115 n_left_from = from_frame->n_vectors;
117 next_index = node->cached_next_index;
119 while (n_left_from > 0)
123 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
125 while (n_left_from >= 4 && n_left_to_next >= 2)
128 vlib_buffer_t *b0, *b1;
129 udp_header_t *h0 = 0, *h1 = 0;
130 u32 i0, i1, dst_port0, dst_port1;
131 u32 advance0, advance1;
132 u32 error0, next0, error1, next1;
134 /* Prefetch next iteration. */
136 vlib_buffer_t *p2, *p3;
138 p2 = vlib_get_buffer (vm, from[2]);
139 p3 = vlib_get_buffer (vm, from[3]);
141 vlib_prefetch_buffer_header (p2, LOAD);
142 vlib_prefetch_buffer_header (p3, LOAD);
144 CLIB_PREFETCH (p2->data, sizeof (h0[0]), LOAD);
145 CLIB_PREFETCH (p3->data, sizeof (h1[0]), LOAD);
157 b0 = vlib_get_buffer (vm, bi0);
158 b1 = vlib_get_buffer (vm, bi1);
160 /* ip4/6_local hands us the ip header, not the udp header */
163 advance0 = ip4_header_bytes (vlib_buffer_get_current (b0));
164 advance1 = ip4_header_bytes (vlib_buffer_get_current (b1));
168 advance0 = sizeof (ip6_header_t);
169 advance1 = sizeof (ip6_header_t);
172 if (PREDICT_FALSE (b0->current_length < advance0 + sizeof (*h0)))
174 error0 = UDP_ERROR_LENGTH_ERROR;
175 next0 = UDP_LOCAL_NEXT_DROP;
179 vlib_buffer_advance (b0, advance0);
180 h0 = vlib_buffer_get_current (b0);
181 error0 = UDP_ERROR_NONE;
182 next0 = UDP_LOCAL_NEXT_PUNT;
183 if (PREDICT_FALSE (clib_net_to_host_u16 (h0->length) >
184 vlib_buffer_length_in_chain (vm, b0)))
186 error0 = UDP_ERROR_LENGTH_ERROR;
187 next0 = UDP_LOCAL_NEXT_DROP;
191 if (PREDICT_FALSE (b1->current_length < advance1 + sizeof (*h1)))
193 error1 = UDP_ERROR_LENGTH_ERROR;
194 next1 = UDP_LOCAL_NEXT_DROP;
198 vlib_buffer_advance (b1, advance1);
199 h1 = vlib_buffer_get_current (b1);
200 error1 = UDP_ERROR_NONE;
201 next1 = UDP_LOCAL_NEXT_PUNT;
202 if (PREDICT_FALSE (clib_net_to_host_u16 (h1->length) >
203 vlib_buffer_length_in_chain (vm, b1)))
205 error1 = UDP_ERROR_LENGTH_ERROR;
206 next1 = UDP_LOCAL_NEXT_DROP;
210 /* Index sparse array with network byte order. */
211 dst_port0 = (error0 == 0) ? h0->dst_port : 0;
212 dst_port1 = (error1 == 0) ? h1->dst_port : 0;
213 sparse_vec_index2 (next_by_dst_port, dst_port0, dst_port1, &i0,
215 next0 = (error0 == 0) ? vec_elt (next_by_dst_port, i0) : next0;
216 next1 = (error1 == 0) ? vec_elt (next_by_dst_port, i1) : next1;
218 if (PREDICT_FALSE (i0 == SPARSE_VEC_INVALID_INDEX ||
219 next0 == UDP_NO_NODE_SET))
221 udp_dispatch_error (node, b0, advance0, is_ip4, &next0);
225 b0->error = node->errors[UDP_ERROR_NONE];
226 // advance to the payload
227 vlib_buffer_advance (b0, sizeof (*h0));
230 if (PREDICT_FALSE (i1 == SPARSE_VEC_INVALID_INDEX ||
231 next1 == UDP_NO_NODE_SET))
233 udp_dispatch_error (node, b1, advance1, is_ip4, &next1);
237 b1->error = node->errors[UDP_ERROR_NONE];
238 // advance to the payload
239 vlib_buffer_advance (b1, sizeof (*h1));
242 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
244 udp_local_rx_trace_t *tr = vlib_add_trace (vm, node,
246 if (b0->error != node->errors[UDP_ERROR_LENGTH_ERROR])
248 tr->src_port = h0 ? h0->src_port : 0;
249 tr->dst_port = h0 ? h0->dst_port : 0;
250 tr->bound = (next0 != UDP_LOCAL_NEXT_ICMP);
253 if (PREDICT_FALSE (b1->flags & VLIB_BUFFER_IS_TRACED))
255 udp_local_rx_trace_t *tr = vlib_add_trace (vm, node,
257 if (b1->error != node->errors[UDP_ERROR_LENGTH_ERROR])
259 tr->src_port = h1 ? h1->src_port : 0;
260 tr->dst_port = h1 ? h1->dst_port : 0;
261 tr->bound = (next1 != UDP_LOCAL_NEXT_ICMP);
265 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
266 to_next, n_left_to_next,
267 bi0, bi1, next0, next1);
270 while (n_left_from > 0 && n_left_to_next > 0)
274 udp_header_t *h0 = 0;
285 b0 = vlib_get_buffer (vm, bi0);
287 /* ip4/6_local hands us the ip header, not the udp header */
289 advance0 = ip4_header_bytes (vlib_buffer_get_current (b0));
291 advance0 = sizeof (ip6_header_t);
293 if (PREDICT_FALSE (b0->current_length < advance0 + sizeof (*h0)))
295 b0->error = node->errors[UDP_ERROR_LENGTH_ERROR];
296 next0 = UDP_LOCAL_NEXT_DROP;
300 vlib_buffer_advance (b0, advance0);
302 h0 = vlib_buffer_get_current (b0);
304 if (PREDICT_TRUE (clib_net_to_host_u16 (h0->length) <=
305 vlib_buffer_length_in_chain (vm, b0)))
307 i0 = sparse_vec_index (next_by_dst_port, h0->dst_port);
308 next0 = vec_elt (next_by_dst_port, i0);
310 if (PREDICT_FALSE ((i0 == SPARSE_VEC_INVALID_INDEX) ||
311 next0 == UDP_NO_NODE_SET))
313 udp_dispatch_error (node, b0, advance0, is_ip4, &next0);
317 b0->error = node->errors[UDP_ERROR_NONE];
318 // advance to the payload
319 vlib_buffer_advance (b0, sizeof (*h0));
324 b0->error = node->errors[UDP_ERROR_LENGTH_ERROR];
325 next0 = UDP_LOCAL_NEXT_DROP;
329 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
331 udp_local_rx_trace_t *tr = vlib_add_trace (vm, node,
333 if (b0->error != node->errors[UDP_ERROR_LENGTH_ERROR])
335 tr->src_port = h0->src_port;
336 tr->dst_port = h0->dst_port;
337 tr->bound = (next0 != UDP_LOCAL_NEXT_ICMP);
341 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
342 to_next, n_left_to_next,
346 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
348 return from_frame->n_vectors;
351 VLIB_NODE_FN (udp4_local_node) (vlib_main_t * vm,
352 vlib_node_runtime_t * node,
353 vlib_frame_t * from_frame)
355 return udp46_local_inline (vm, node, from_frame, 1 /* is_ip4 */ );
358 VLIB_NODE_FN (udp6_local_node) (vlib_main_t * vm,
359 vlib_node_runtime_t * node,
360 vlib_frame_t * from_frame)
362 return udp46_local_inline (vm, node, from_frame, 0 /* is_ip4 */ );
366 VLIB_REGISTER_NODE (udp4_local_node) = {
367 .name = "ip4-udp-lookup",
368 /* Takes a vector of packets. */
369 .vector_size = sizeof (u32),
371 .n_errors = UDP_N_ERROR,
372 .error_counters = udp_error_counters,
374 .n_next_nodes = UDP_LOCAL_N_NEXT,
376 [UDP_LOCAL_NEXT_PUNT]= "ip4-punt",
377 [UDP_LOCAL_NEXT_DROP]= "ip4-drop",
378 [UDP_LOCAL_NEXT_ICMP]= "ip4-icmp-error",
381 .format_buffer = format_udp_header,
382 .format_trace = format_udp_rx_trace,
383 .unformat_buffer = unformat_udp_header,
388 VLIB_REGISTER_NODE (udp6_local_node) = {
389 .name = "ip6-udp-lookup",
390 /* Takes a vector of packets. */
391 .vector_size = sizeof (u32),
393 .n_errors = UDP_N_ERROR,
394 .error_counters = udp_error_counters,
396 .n_next_nodes = UDP_LOCAL_N_NEXT,
398 [UDP_LOCAL_NEXT_PUNT]= "ip6-punt",
399 [UDP_LOCAL_NEXT_DROP]= "ip6-drop",
400 [UDP_LOCAL_NEXT_ICMP]= "ip6-icmp-error",
403 .format_buffer = format_udp_header,
404 .format_trace = format_udp_rx_trace,
405 .unformat_buffer = unformat_udp_header,
409 #ifndef CLIB_MARCH_VARIANT
411 udp_add_dst_port (udp_main_t * um, udp_dst_port_t dst_port,
412 char *dst_port_name, u8 is_ip4)
414 udp_dst_port_info_t *pi;
417 vec_add2 (um->dst_port_infos[is_ip4], pi, 1);
418 i = pi - um->dst_port_infos[is_ip4];
420 pi->name = dst_port_name;
421 pi->dst_port = dst_port;
422 pi->next_index = pi->node_index = ~0;
424 hash_set (um->dst_port_info_by_dst_port[is_ip4], dst_port, i);
427 hash_set_mem (um->dst_port_info_by_name[is_ip4], pi->name, i);
431 udp_register_dst_port (vlib_main_t * vm,
432 udp_dst_port_t dst_port, u32 node_index, u8 is_ip4)
434 udp_main_t *um = &udp_main;
435 udp_dst_port_info_t *pi;
439 clib_error_t *error = vlib_call_init_function (vm, udp_local_init);
441 clib_error_report (error);
444 pi = udp_get_dst_port_info (um, dst_port, is_ip4);
447 udp_add_dst_port (um, dst_port, 0, is_ip4);
448 pi = udp_get_dst_port_info (um, dst_port, is_ip4);
452 pi->node_index = node_index;
453 pi->next_index = vlib_node_add_next (vm,
454 is_ip4 ? udp4_local_node.index
455 : udp6_local_node.index, node_index);
457 /* Setup udp protocol -> next index sparse vector mapping. */
459 n = sparse_vec_validate (um->next_by_dst_port4,
460 clib_host_to_net_u16 (dst_port));
462 n = sparse_vec_validate (um->next_by_dst_port6,
463 clib_host_to_net_u16 (dst_port));
465 n[0] = pi->next_index;
469 udp_unregister_dst_port (vlib_main_t * vm, udp_dst_port_t dst_port, u8 is_ip4)
471 udp_main_t *um = &udp_main;
472 udp_dst_port_info_t *pi;
475 pi = udp_get_dst_port_info (um, dst_port, is_ip4);
476 /* Not registered? Fagedaboudit */
480 /* Kill the mapping. Don't bother killing the pi, it may be back. */
482 n = sparse_vec_validate (um->next_by_dst_port4,
483 clib_host_to_net_u16 (dst_port));
485 n = sparse_vec_validate (um->next_by_dst_port6,
486 clib_host_to_net_u16 (dst_port));
488 n[0] = UDP_NO_NODE_SET;
492 udp_is_valid_dst_port (udp_dst_port_t dst_port, u8 is_ip4)
494 udp_main_t *um = &udp_main;
498 n = sparse_vec_validate (um->next_by_dst_port4,
499 clib_host_to_net_u16 (dst_port));
501 n = sparse_vec_validate (um->next_by_dst_port6,
502 clib_host_to_net_u16 (dst_port));
504 return (n[0] != SPARSE_VEC_INVALID_INDEX && n[0] != UDP_NO_NODE_SET);
508 udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
510 udp_main_t *um = &udp_main;
512 clib_error_t *error = vlib_call_init_function (vm, udp_local_init);
514 clib_error_report (error);
518 um->punt_unknown4 = is_add;
520 um->punt_unknown6 = is_add;
523 /* Parse a UDP header. */
525 unformat_udp_header (unformat_input_t * input, va_list * args)
527 u8 **result = va_arg (*args, u8 **);
529 __attribute__ ((unused)) int old_length;
530 u16 src_port, dst_port;
532 /* Allocate space for IP header. */
536 old_length = vec_len (*result);
537 vec_add2 (*result, p, sizeof (ip4_header_t));
541 clib_memset (udp, 0, sizeof (udp[0]));
542 if (unformat (input, "src-port %d dst-port %d", &src_port, &dst_port))
544 udp->src_port = clib_host_to_net_u16 (src_port);
545 udp->dst_port = clib_host_to_net_u16 (dst_port);
552 udp_setup_node (vlib_main_t * vm, u32 node_index)
554 vlib_node_t *n = vlib_get_node (vm, node_index);
555 pg_node_t *pn = pg_get_node (node_index);
557 n->format_buffer = format_udp_header;
558 n->unformat_buffer = unformat_udp_header;
559 pn->unformat_edit = unformat_pg_udp_header;
563 udp_local_init (vlib_main_t * vm)
565 udp_main_t *um = &udp_main;
570 error = vlib_call_init_function (vm, udp_init);
572 clib_error_report (error);
576 for (i = 0; i < 2; i++)
578 um->dst_port_info_by_name[i] = hash_create_string (0, sizeof (uword));
579 um->dst_port_info_by_dst_port[i] = hash_create (0, sizeof (uword));
582 udp_setup_node (vm, udp4_local_node.index);
583 udp_setup_node (vm, udp6_local_node.index);
585 um->punt_unknown4 = 0;
586 um->punt_unknown6 = 0;
588 um->next_by_dst_port4 = sparse_vec_new
589 ( /* elt bytes */ sizeof (um->next_by_dst_port4[0]),
590 /* bits in index */ BITS (((udp_header_t *) 0)->dst_port));
592 um->next_by_dst_port6 = sparse_vec_new
593 ( /* elt bytes */ sizeof (um->next_by_dst_port6[0]),
594 /* bits in index */ BITS (((udp_header_t *) 0)->dst_port));
596 #define _(n,s) udp_add_dst_port (um, UDP_DST_PORT_##s, #s, 1 /* is_ip4 */);
597 foreach_udp4_dst_port
599 #define _(n,s) udp_add_dst_port (um, UDP_DST_PORT_##s, #s, 0 /* is_ip4 */);
600 foreach_udp6_dst_port
602 ip4_register_protocol (IP_PROTOCOL_UDP, udp4_local_node.index);
603 /* Note: ip6 differs from ip4, UDP is hotwired to ip6-udp-lookup */
607 VLIB_INIT_FUNCTION (udp_local_init);
608 #endif /* CLIB_MARCH_VARIANT */
611 * fd.io coding-style-patch-verification: ON
614 * eval: (c-set-style "gnu")