2 * node.c: udp packet processing
4 * Copyright (c) 2013 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>
26 #define foreach_udp_local_next \
27 _ (PUNT, "error-punt") \
28 _ (DROP, "error-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
45 } udp_local_rx_trace_t;
48 format_udp_rx_trace (u8 * s, va_list * args)
50 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
51 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
52 udp_local_rx_trace_t *t = va_arg (*args, udp_local_rx_trace_t *);
54 s = format (s, "UDP: src-port %d dst-port %d%s",
55 clib_net_to_host_u16 (t->src_port),
56 clib_net_to_host_u16 (t->dst_port),
57 t->bound ? "" : " (no listener)");
61 vlib_node_registration_t udp4_local_node;
62 vlib_node_registration_t udp6_local_node;
65 udp46_local_inline (vlib_main_t * vm,
66 vlib_node_runtime_t * node,
67 vlib_frame_t * from_frame, int is_ip4)
69 udp_main_t *um = &udp_main;
70 __attribute__ ((unused)) u32 n_left_from, next_index, *from, *to_next;
71 word n_no_listener = 0;
72 u8 punt_unknown = is_ip4 ? um->punt_unknown4 : um->punt_unknown6;
74 from = vlib_frame_vector_args (from_frame);
75 n_left_from = from_frame->n_vectors;
77 next_index = node->cached_next_index;
79 while (n_left_from > 0)
83 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
85 while (n_left_from >= 4 && n_left_to_next >= 2)
88 vlib_buffer_t *b0, *b1;
89 udp_header_t *h0 = 0, *h1 = 0;
90 u32 i0, i1, dst_port0, dst_port1;
91 u32 advance0, advance1;
92 u32 error0, next0, error1, next1;
94 /* Prefetch next iteration. */
96 vlib_buffer_t *p2, *p3;
98 p2 = vlib_get_buffer (vm, from[2]);
99 p3 = vlib_get_buffer (vm, from[3]);
101 vlib_prefetch_buffer_header (p2, LOAD);
102 vlib_prefetch_buffer_header (p3, LOAD);
104 CLIB_PREFETCH (p2->data, sizeof (h0[0]), LOAD);
105 CLIB_PREFETCH (p3->data, sizeof (h1[0]), LOAD);
117 b0 = vlib_get_buffer (vm, bi0);
118 b1 = vlib_get_buffer (vm, bi1);
120 /* ip4/6_local hands us the ip header, not the udp header */
123 advance0 = sizeof (ip4_header_t);
124 advance1 = sizeof (ip4_header_t);
128 advance0 = sizeof (ip6_header_t);
129 advance1 = sizeof (ip6_header_t);
132 if (PREDICT_FALSE (b0->current_length < advance0 + sizeof (*h0)))
134 error0 = UDP_ERROR_LENGTH_ERROR;
135 next0 = UDP_LOCAL_NEXT_DROP;
139 vlib_buffer_advance (b0, advance0);
140 h0 = vlib_buffer_get_current (b0);
142 if (PREDICT_FALSE (clib_net_to_host_u16 (h0->length) >
143 vlib_buffer_length_in_chain (vm, b0)))
145 error0 = UDP_ERROR_LENGTH_ERROR;
146 next0 = UDP_LOCAL_NEXT_DROP;
150 if (PREDICT_FALSE (b1->current_length < advance1 + sizeof (*h1)))
152 error1 = UDP_ERROR_LENGTH_ERROR;
153 next1 = UDP_LOCAL_NEXT_DROP;
157 vlib_buffer_advance (b1, advance1);
158 h1 = vlib_buffer_get_current (b1);
160 if (PREDICT_FALSE (clib_net_to_host_u16 (h1->length) >
161 vlib_buffer_length_in_chain (vm, b1)))
163 error1 = UDP_ERROR_LENGTH_ERROR;
164 next1 = UDP_LOCAL_NEXT_DROP;
168 /* Index sparse array with network byte order. */
169 dst_port0 = (error0 == 0) ? h0->dst_port : 0;
170 dst_port1 = (error1 == 0) ? h1->dst_port : 0;
171 sparse_vec_index2 (is_ip4 ? um->next_by_dst_port4 :
172 um->next_by_dst_port6,
173 dst_port0, dst_port1, &i0, &i1);
174 next0 = (error0 == 0) ?
175 vec_elt (is_ip4 ? um->next_by_dst_port4 : um->next_by_dst_port6,
177 next1 = (error1 == 0) ?
178 vec_elt (is_ip4 ? um->next_by_dst_port4 : um->next_by_dst_port6,
181 if (PREDICT_FALSE (i0 == SPARSE_VEC_INVALID_INDEX))
183 // move the pointer back so icmp-error can find the
185 vlib_buffer_advance (b0, -(word) advance0);
187 if (PREDICT_FALSE (punt_unknown))
189 b0->error = node->errors[UDP_ERROR_PUNT];
190 next0 = UDP_LOCAL_NEXT_PUNT;
194 icmp4_error_set_vnet_buffer (b0,
195 ICMP4_destination_unreachable,
196 ICMP4_destination_unreachable_port_unreachable,
198 next0 = UDP_LOCAL_NEXT_ICMP4_ERROR;
203 icmp6_error_set_vnet_buffer (b0,
204 ICMP6_destination_unreachable,
205 ICMP6_destination_unreachable_port_unreachable,
207 next0 = UDP_LOCAL_NEXT_ICMP6_ERROR;
213 b0->error = node->errors[UDP_ERROR_NONE];
214 // advance to the payload
215 vlib_buffer_advance (b0, sizeof (*h0));
218 if (PREDICT_FALSE (i1 == SPARSE_VEC_INVALID_INDEX))
220 // move the pointer back so icmp-error can find the
222 vlib_buffer_advance (b1, -(word) advance1);
224 if (PREDICT_FALSE (punt_unknown))
226 b1->error = node->errors[UDP_ERROR_PUNT];
227 next1 = UDP_LOCAL_NEXT_PUNT;
231 icmp4_error_set_vnet_buffer (b1,
232 ICMP4_destination_unreachable,
233 ICMP4_destination_unreachable_port_unreachable,
235 next1 = UDP_LOCAL_NEXT_ICMP4_ERROR;
240 icmp6_error_set_vnet_buffer (b1,
241 ICMP6_destination_unreachable,
242 ICMP6_destination_unreachable_port_unreachable,
244 next1 = UDP_LOCAL_NEXT_ICMP6_ERROR;
250 b1->error = node->errors[UDP_ERROR_NONE];
251 // advance to the payload
252 vlib_buffer_advance (b1, sizeof (*h1));
255 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
257 udp_local_rx_trace_t *tr = vlib_add_trace (vm, node,
259 if (b0->error != node->errors[UDP_ERROR_LENGTH_ERROR])
261 tr->src_port = h0 ? h0->src_port : 0;
262 tr->dst_port = h0 ? h0->dst_port : 0;
263 tr->bound = (next0 != UDP_LOCAL_NEXT_ICMP4_ERROR &&
264 next0 != UDP_LOCAL_NEXT_ICMP6_ERROR);
267 if (PREDICT_FALSE (b1->flags & VLIB_BUFFER_IS_TRACED))
269 udp_local_rx_trace_t *tr = vlib_add_trace (vm, node,
271 if (b1->error != node->errors[UDP_ERROR_LENGTH_ERROR])
273 tr->src_port = h1 ? h1->src_port : 0;
274 tr->dst_port = h1 ? h1->dst_port : 0;
275 tr->bound = (next1 != UDP_LOCAL_NEXT_ICMP4_ERROR &&
276 next1 != UDP_LOCAL_NEXT_ICMP6_ERROR);
280 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
281 to_next, n_left_to_next,
282 bi0, bi1, next0, next1);
285 while (n_left_from > 0 && n_left_to_next > 0)
289 udp_header_t *h0 = 0;
300 b0 = vlib_get_buffer (vm, bi0);
302 /* ip4/6_local hands us the ip header, not the udp header */
304 advance0 = sizeof (ip4_header_t);
306 advance0 = sizeof (ip6_header_t);
308 if (PREDICT_FALSE (b0->current_length < advance0 + sizeof (*h0)))
310 b0->error = node->errors[UDP_ERROR_LENGTH_ERROR];
311 next0 = UDP_LOCAL_NEXT_DROP;
315 vlib_buffer_advance (b0, advance0);
317 h0 = vlib_buffer_get_current (b0);
319 if (PREDICT_TRUE (clib_net_to_host_u16 (h0->length) <=
320 vlib_buffer_length_in_chain (vm, b0)))
322 i0 = sparse_vec_index (is_ip4 ? um->next_by_dst_port4 :
323 um->next_by_dst_port6, h0->dst_port);
324 next0 = vec_elt (is_ip4 ? um->next_by_dst_port4 :
325 um->next_by_dst_port6, i0);
327 if (PREDICT_FALSE (i0 == SPARSE_VEC_INVALID_INDEX))
329 // move the pointer back so icmp-error can find the
331 vlib_buffer_advance (b0, -(word) advance0);
333 if (PREDICT_FALSE (punt_unknown))
335 b0->error = node->errors[UDP_ERROR_PUNT];
336 next0 = UDP_LOCAL_NEXT_PUNT;
340 icmp4_error_set_vnet_buffer (b0,
341 ICMP4_destination_unreachable,
342 ICMP4_destination_unreachable_port_unreachable,
344 next0 = UDP_LOCAL_NEXT_ICMP4_ERROR;
349 icmp6_error_set_vnet_buffer (b0,
350 ICMP6_destination_unreachable,
351 ICMP6_destination_unreachable_port_unreachable,
353 next0 = UDP_LOCAL_NEXT_ICMP6_ERROR;
359 b0->error = node->errors[UDP_ERROR_NONE];
360 // advance to the payload
361 vlib_buffer_advance (b0, sizeof (*h0));
366 b0->error = node->errors[UDP_ERROR_LENGTH_ERROR];
367 next0 = UDP_LOCAL_NEXT_DROP;
371 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
373 udp_local_rx_trace_t *tr = vlib_add_trace (vm, node,
375 if (b0->error != node->errors[UDP_ERROR_LENGTH_ERROR])
377 tr->src_port = h0->src_port;
378 tr->dst_port = h0->dst_port;
379 tr->bound = (next0 != UDP_LOCAL_NEXT_ICMP4_ERROR &&
380 next0 != UDP_LOCAL_NEXT_ICMP6_ERROR);
384 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
385 to_next, n_left_to_next,
389 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
391 vlib_error_count (vm, node->node_index, UDP_ERROR_NO_LISTENER,
393 return from_frame->n_vectors;
396 static char *udp_error_strings[] = {
397 #define udp_error(n,s) s,
398 #include "udp_error.def"
403 udp4_local (vlib_main_t * vm,
404 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
406 return udp46_local_inline (vm, node, from_frame, 1 /* is_ip4 */ );
410 udp6_local (vlib_main_t * vm,
411 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
413 return udp46_local_inline (vm, node, from_frame, 0 /* is_ip4 */ );
417 VLIB_REGISTER_NODE (udp4_local_node) = {
418 .function = udp4_local,
419 .name = "ip4-udp-lookup",
420 /* Takes a vector of packets. */
421 .vector_size = sizeof (u32),
423 .n_errors = UDP_N_ERROR,
424 .error_strings = udp_error_strings,
426 .n_next_nodes = UDP_LOCAL_N_NEXT,
428 #define _(s,n) [UDP_LOCAL_NEXT_##s] = n,
429 foreach_udp_local_next
433 .format_buffer = format_udp_header,
434 .format_trace = format_udp_rx_trace,
435 .unformat_buffer = unformat_udp_header,
439 VLIB_NODE_FUNCTION_MULTIARCH (udp4_local_node, udp4_local);
442 VLIB_REGISTER_NODE (udp6_local_node) = {
443 .function = udp6_local,
444 .name = "ip6-udp-lookup",
445 /* Takes a vector of packets. */
446 .vector_size = sizeof (u32),
448 .n_errors = UDP_N_ERROR,
449 .error_strings = udp_error_strings,
451 .n_next_nodes = UDP_LOCAL_N_NEXT,
453 #define _(s,n) [UDP_LOCAL_NEXT_##s] = n,
454 foreach_udp_local_next
458 .format_buffer = format_udp_header,
459 .format_trace = format_udp_rx_trace,
460 .unformat_buffer = unformat_udp_header,
464 VLIB_NODE_FUNCTION_MULTIARCH (udp6_local_node, udp6_local);
467 add_dst_port (udp_main_t * um,
468 udp_dst_port_t dst_port, char *dst_port_name, u8 is_ip4)
470 udp_dst_port_info_t *pi;
473 vec_add2 (um->dst_port_infos[is_ip4], pi, 1);
474 i = pi - um->dst_port_infos[is_ip4];
476 pi->name = dst_port_name;
477 pi->dst_port = dst_port;
478 pi->next_index = pi->node_index = ~0;
480 hash_set (um->dst_port_info_by_dst_port[is_ip4], dst_port, i);
483 hash_set_mem (um->dst_port_info_by_name[is_ip4], pi->name, i);
487 udp_register_dst_port (vlib_main_t * vm,
488 udp_dst_port_t dst_port, u32 node_index, u8 is_ip4)
490 udp_main_t *um = &udp_main;
491 udp_dst_port_info_t *pi;
495 clib_error_t *error = vlib_call_init_function (vm, udp_local_init);
497 clib_error_report (error);
500 pi = udp_get_dst_port_info (um, dst_port, is_ip4);
503 add_dst_port (um, dst_port, 0, is_ip4);
504 pi = udp_get_dst_port_info (um, dst_port, is_ip4);
508 pi->node_index = node_index;
509 pi->next_index = vlib_node_add_next (vm,
510 is_ip4 ? udp4_local_node.index
511 : udp6_local_node.index, node_index);
513 /* Setup udp protocol -> next index sparse vector mapping. */
515 n = sparse_vec_validate (um->next_by_dst_port4,
516 clib_host_to_net_u16 (dst_port));
518 n = sparse_vec_validate (um->next_by_dst_port6,
519 clib_host_to_net_u16 (dst_port));
521 n[0] = pi->next_index;
525 udp_unregister_dst_port (vlib_main_t * vm, udp_dst_port_t dst_port, u8 is_ip4)
527 udp_main_t *um = &udp_main;
528 udp_dst_port_info_t *pi;
531 pi = udp_get_dst_port_info (um, dst_port, is_ip4);
532 /* Not registered? Fagedaboudit */
536 /* Kill the mapping. Don't bother killing the pi, it may be back. */
538 n = sparse_vec_validate (um->next_by_dst_port4,
539 clib_host_to_net_u16 (dst_port));
541 n = sparse_vec_validate (um->next_by_dst_port6,
542 clib_host_to_net_u16 (dst_port));
544 n[0] = SPARSE_VEC_INVALID_INDEX;
548 udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
550 udp_main_t *um = &udp_main;
552 clib_error_t *error = vlib_call_init_function (vm, udp_local_init);
554 clib_error_report (error);
558 um->punt_unknown4 = is_add;
560 um->punt_unknown6 = is_add;
563 /* Parse a UDP header. */
565 unformat_udp_header (unformat_input_t * input, va_list * args)
567 u8 **result = va_arg (*args, u8 **);
569 __attribute__ ((unused)) int old_length;
570 u16 src_port, dst_port;
572 /* Allocate space for IP header. */
576 old_length = vec_len (*result);
577 vec_add2 (*result, p, sizeof (ip4_header_t));
581 memset (udp, 0, sizeof (udp[0]));
582 if (unformat (input, "src-port %d dst-port %d", &src_port, &dst_port))
584 udp->src_port = clib_host_to_net_u16 (src_port);
585 udp->dst_port = clib_host_to_net_u16 (dst_port);
592 udp_setup_node (vlib_main_t * vm, u32 node_index)
594 vlib_node_t *n = vlib_get_node (vm, node_index);
595 pg_node_t *pn = pg_get_node (node_index);
597 n->format_buffer = format_udp_header;
598 n->unformat_buffer = unformat_udp_header;
599 pn->unformat_edit = unformat_pg_udp_header;
603 udp_local_init (vlib_main_t * vm)
605 udp_main_t *um = &udp_main;
610 error = vlib_call_init_function (vm, udp_init);
612 clib_error_report (error);
616 for (i = 0; i < 2; i++)
618 um->dst_port_info_by_name[i] = hash_create_string (0, sizeof (uword));
619 um->dst_port_info_by_dst_port[i] = hash_create (0, sizeof (uword));
622 udp_setup_node (vm, udp4_local_node.index);
623 udp_setup_node (vm, udp6_local_node.index);
625 um->punt_unknown4 = 0;
626 um->punt_unknown6 = 0;
628 um->next_by_dst_port4 = sparse_vec_new
629 ( /* elt bytes */ sizeof (um->next_by_dst_port4[0]),
630 /* bits in index */ BITS (((udp_header_t *) 0)->dst_port));
632 um->next_by_dst_port6 = sparse_vec_new
633 ( /* elt bytes */ sizeof (um->next_by_dst_port6[0]),
634 /* bits in index */ BITS (((udp_header_t *) 0)->dst_port));
636 #define _(n,s) add_dst_port (um, UDP_DST_PORT_##s, #s, 1 /* is_ip4 */);
637 foreach_udp4_dst_port
639 #define _(n,s) add_dst_port (um, UDP_DST_PORT_##s, #s, 0 /* is_ip4 */);
640 foreach_udp6_dst_port
642 ip4_register_protocol (IP_PROTOCOL_UDP, udp4_local_node.index);
643 /* Note: ip6 differs from ip4, UDP is hotwired to ip6-udp-lookup */
647 VLIB_INIT_FUNCTION (udp_local_init);
650 * fd.io coding-style-patch-verification: ON
653 * eval: (c-set-style "gnu")