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 _ (PUNT4, "ip4-punt") \
28 _ (PUNT6, "ip6-punt") \
29 _ (DROP4, "ip4-drop") \
30 _ (DROP6, "ip6-drop") \
31 _ (ICMP4_ERROR, "ip4-icmp-error") \
32 _ (ICMP6_ERROR, "ip6-icmp-error")
36 #define _(s,n) UDP_LOCAL_NEXT_##s,
37 foreach_udp_local_next
42 #define udp_local_next_drop(is_ip4) ((is_ip4) ? UDP_LOCAL_NEXT_DROP4 : UDP_LOCAL_NEXT_DROP6)
43 #define udp_local_next_punt(is_ip4) ((is_ip4) ? UDP_LOCAL_NEXT_PUNT4 : UDP_LOCAL_NEXT_PUNT6)
50 } udp_local_rx_trace_t;
53 format_udp_rx_trace (u8 * s, va_list * args)
55 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
56 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
57 udp_local_rx_trace_t *t = va_arg (*args, udp_local_rx_trace_t *);
59 s = format (s, "UDP: src-port %d dst-port %d%s",
60 clib_net_to_host_u16 (t->src_port),
61 clib_net_to_host_u16 (t->dst_port),
62 t->bound ? "" : " (no listener)");
66 vlib_node_registration_t udp4_local_node;
67 vlib_node_registration_t udp6_local_node;
70 udp46_local_inline (vlib_main_t * vm,
71 vlib_node_runtime_t * node,
72 vlib_frame_t * from_frame, int is_ip4)
74 udp_main_t *um = &udp_main;
75 __attribute__ ((unused)) u32 n_left_from, next_index, *from, *to_next;
76 word n_no_listener = 0;
77 u8 punt_unknown = is_ip4 ? um->punt_unknown4 : um->punt_unknown6;
79 from = vlib_frame_vector_args (from_frame);
80 n_left_from = from_frame->n_vectors;
82 next_index = node->cached_next_index;
84 while (n_left_from > 0)
88 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
90 while (n_left_from >= 4 && n_left_to_next >= 2)
93 vlib_buffer_t *b0, *b1;
94 udp_header_t *h0 = 0, *h1 = 0;
95 u32 i0, i1, dst_port0, dst_port1;
96 u32 advance0, advance1;
97 u32 error0, next0, error1, next1;
99 /* Prefetch next iteration. */
101 vlib_buffer_t *p2, *p3;
103 p2 = vlib_get_buffer (vm, from[2]);
104 p3 = vlib_get_buffer (vm, from[3]);
106 vlib_prefetch_buffer_header (p2, LOAD);
107 vlib_prefetch_buffer_header (p3, LOAD);
109 CLIB_PREFETCH (p2->data, sizeof (h0[0]), LOAD);
110 CLIB_PREFETCH (p3->data, sizeof (h1[0]), LOAD);
122 b0 = vlib_get_buffer (vm, bi0);
123 b1 = vlib_get_buffer (vm, bi1);
125 /* ip4/6_local hands us the ip header, not the udp header */
128 advance0 = sizeof (ip4_header_t);
129 advance1 = sizeof (ip4_header_t);
133 advance0 = sizeof (ip6_header_t);
134 advance1 = sizeof (ip6_header_t);
137 if (PREDICT_FALSE (b0->current_length < advance0 + sizeof (*h0)))
139 error0 = UDP_ERROR_LENGTH_ERROR;
140 next0 = udp_local_next_drop (is_ip4);
144 vlib_buffer_advance (b0, advance0);
145 h0 = vlib_buffer_get_current (b0);
147 if (PREDICT_FALSE (clib_net_to_host_u16 (h0->length) >
148 vlib_buffer_length_in_chain (vm, b0)))
150 error0 = UDP_ERROR_LENGTH_ERROR;
151 next0 = udp_local_next_drop (is_ip4);
155 if (PREDICT_FALSE (b1->current_length < advance1 + sizeof (*h1)))
157 error1 = UDP_ERROR_LENGTH_ERROR;
158 next1 = udp_local_next_drop (is_ip4);
162 vlib_buffer_advance (b1, advance1);
163 h1 = vlib_buffer_get_current (b1);
165 if (PREDICT_FALSE (clib_net_to_host_u16 (h1->length) >
166 vlib_buffer_length_in_chain (vm, b1)))
168 error1 = UDP_ERROR_LENGTH_ERROR;
169 next1 = udp_local_next_drop (is_ip4);
173 /* Index sparse array with network byte order. */
174 dst_port0 = (error0 == 0) ? h0->dst_port : 0;
175 dst_port1 = (error1 == 0) ? h1->dst_port : 0;
176 sparse_vec_index2 (is_ip4 ? um->next_by_dst_port4 :
177 um->next_by_dst_port6,
178 dst_port0, dst_port1, &i0, &i1);
179 next0 = (error0 == 0) ?
180 vec_elt (is_ip4 ? um->next_by_dst_port4 : um->next_by_dst_port6,
182 next1 = (error1 == 0) ?
183 vec_elt (is_ip4 ? um->next_by_dst_port4 : um->next_by_dst_port6,
186 if (PREDICT_FALSE (i0 == SPARSE_VEC_INVALID_INDEX))
188 // move the pointer back so icmp-error can find the
190 vlib_buffer_advance (b0, -(word) advance0);
192 if (PREDICT_FALSE (punt_unknown))
194 b0->error = node->errors[UDP_ERROR_PUNT];
195 next0 = udp_local_next_punt (is_ip4);
199 icmp4_error_set_vnet_buffer (b0,
200 ICMP4_destination_unreachable,
201 ICMP4_destination_unreachable_port_unreachable,
203 next0 = UDP_LOCAL_NEXT_ICMP4_ERROR;
208 icmp6_error_set_vnet_buffer (b0,
209 ICMP6_destination_unreachable,
210 ICMP6_destination_unreachable_port_unreachable,
212 next0 = UDP_LOCAL_NEXT_ICMP6_ERROR;
218 b0->error = node->errors[UDP_ERROR_NONE];
219 // advance to the payload
220 vlib_buffer_advance (b0, sizeof (*h0));
223 if (PREDICT_FALSE (i1 == SPARSE_VEC_INVALID_INDEX))
225 // move the pointer back so icmp-error can find the
227 vlib_buffer_advance (b1, -(word) advance1);
229 if (PREDICT_FALSE (punt_unknown))
231 b1->error = node->errors[UDP_ERROR_PUNT];
232 next1 = udp_local_next_punt (is_ip4);
236 icmp4_error_set_vnet_buffer (b1,
237 ICMP4_destination_unreachable,
238 ICMP4_destination_unreachable_port_unreachable,
240 next1 = UDP_LOCAL_NEXT_ICMP4_ERROR;
245 icmp6_error_set_vnet_buffer (b1,
246 ICMP6_destination_unreachable,
247 ICMP6_destination_unreachable_port_unreachable,
249 next1 = UDP_LOCAL_NEXT_ICMP6_ERROR;
255 b1->error = node->errors[UDP_ERROR_NONE];
256 // advance to the payload
257 vlib_buffer_advance (b1, sizeof (*h1));
260 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
262 udp_local_rx_trace_t *tr = vlib_add_trace (vm, node,
264 if (b0->error != node->errors[UDP_ERROR_LENGTH_ERROR])
266 tr->src_port = h0 ? h0->src_port : 0;
267 tr->dst_port = h0 ? h0->dst_port : 0;
268 tr->bound = (next0 != UDP_LOCAL_NEXT_ICMP4_ERROR &&
269 next0 != UDP_LOCAL_NEXT_ICMP6_ERROR);
272 if (PREDICT_FALSE (b1->flags & VLIB_BUFFER_IS_TRACED))
274 udp_local_rx_trace_t *tr = vlib_add_trace (vm, node,
276 if (b1->error != node->errors[UDP_ERROR_LENGTH_ERROR])
278 tr->src_port = h1 ? h1->src_port : 0;
279 tr->dst_port = h1 ? h1->dst_port : 0;
280 tr->bound = (next1 != UDP_LOCAL_NEXT_ICMP4_ERROR &&
281 next1 != UDP_LOCAL_NEXT_ICMP6_ERROR);
285 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
286 to_next, n_left_to_next,
287 bi0, bi1, next0, next1);
290 while (n_left_from > 0 && n_left_to_next > 0)
294 udp_header_t *h0 = 0;
305 b0 = vlib_get_buffer (vm, bi0);
307 /* ip4/6_local hands us the ip header, not the udp header */
309 advance0 = sizeof (ip4_header_t);
311 advance0 = sizeof (ip6_header_t);
313 if (PREDICT_FALSE (b0->current_length < advance0 + sizeof (*h0)))
315 b0->error = node->errors[UDP_ERROR_LENGTH_ERROR];
316 next0 = udp_local_next_drop (is_ip4);
320 vlib_buffer_advance (b0, advance0);
322 h0 = vlib_buffer_get_current (b0);
324 if (PREDICT_TRUE (clib_net_to_host_u16 (h0->length) <=
325 vlib_buffer_length_in_chain (vm, b0)))
327 i0 = sparse_vec_index (is_ip4 ? um->next_by_dst_port4 :
328 um->next_by_dst_port6, h0->dst_port);
329 next0 = vec_elt (is_ip4 ? um->next_by_dst_port4 :
330 um->next_by_dst_port6, i0);
332 if (PREDICT_FALSE (i0 == SPARSE_VEC_INVALID_INDEX))
334 // move the pointer back so icmp-error can find the
336 vlib_buffer_advance (b0, -(word) advance0);
338 if (PREDICT_FALSE (punt_unknown))
340 b0->error = node->errors[UDP_ERROR_PUNT];
341 next0 = udp_local_next_punt (is_ip4);
345 icmp4_error_set_vnet_buffer (b0,
346 ICMP4_destination_unreachable,
347 ICMP4_destination_unreachable_port_unreachable,
349 next0 = UDP_LOCAL_NEXT_ICMP4_ERROR;
354 icmp6_error_set_vnet_buffer (b0,
355 ICMP6_destination_unreachable,
356 ICMP6_destination_unreachable_port_unreachable,
358 next0 = UDP_LOCAL_NEXT_ICMP6_ERROR;
364 b0->error = node->errors[UDP_ERROR_NONE];
365 // advance to the payload
366 vlib_buffer_advance (b0, sizeof (*h0));
371 b0->error = node->errors[UDP_ERROR_LENGTH_ERROR];
372 next0 = udp_local_next_drop (is_ip4);
376 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
378 udp_local_rx_trace_t *tr = vlib_add_trace (vm, node,
380 if (b0->error != node->errors[UDP_ERROR_LENGTH_ERROR])
382 tr->src_port = h0->src_port;
383 tr->dst_port = h0->dst_port;
384 tr->bound = (next0 != UDP_LOCAL_NEXT_ICMP4_ERROR &&
385 next0 != UDP_LOCAL_NEXT_ICMP6_ERROR);
389 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
390 to_next, n_left_to_next,
394 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
396 vlib_error_count (vm, node->node_index, UDP_ERROR_NO_LISTENER,
398 return from_frame->n_vectors;
401 static char *udp_error_strings[] = {
402 #define udp_error(n,s) s,
403 #include "udp_error.def"
408 udp4_local (vlib_main_t * vm,
409 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
411 return udp46_local_inline (vm, node, from_frame, 1 /* is_ip4 */ );
415 udp6_local (vlib_main_t * vm,
416 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
418 return udp46_local_inline (vm, node, from_frame, 0 /* is_ip4 */ );
422 VLIB_REGISTER_NODE (udp4_local_node) = {
423 .function = udp4_local,
424 .name = "ip4-udp-lookup",
425 /* Takes a vector of packets. */
426 .vector_size = sizeof (u32),
428 .n_errors = UDP_N_ERROR,
429 .error_strings = udp_error_strings,
431 .n_next_nodes = UDP_LOCAL_N_NEXT,
433 #define _(s,n) [UDP_LOCAL_NEXT_##s] = n,
434 foreach_udp_local_next
438 .format_buffer = format_udp_header,
439 .format_trace = format_udp_rx_trace,
440 .unformat_buffer = unformat_udp_header,
444 VLIB_NODE_FUNCTION_MULTIARCH (udp4_local_node, udp4_local);
447 VLIB_REGISTER_NODE (udp6_local_node) = {
448 .function = udp6_local,
449 .name = "ip6-udp-lookup",
450 /* Takes a vector of packets. */
451 .vector_size = sizeof (u32),
453 .n_errors = UDP_N_ERROR,
454 .error_strings = udp_error_strings,
456 .n_next_nodes = UDP_LOCAL_N_NEXT,
458 #define _(s,n) [UDP_LOCAL_NEXT_##s] = n,
459 foreach_udp_local_next
463 .format_buffer = format_udp_header,
464 .format_trace = format_udp_rx_trace,
465 .unformat_buffer = unformat_udp_header,
469 VLIB_NODE_FUNCTION_MULTIARCH (udp6_local_node, udp6_local);
472 add_dst_port (udp_main_t * um,
473 udp_dst_port_t dst_port, char *dst_port_name, u8 is_ip4)
475 udp_dst_port_info_t *pi;
478 vec_add2 (um->dst_port_infos[is_ip4], pi, 1);
479 i = pi - um->dst_port_infos[is_ip4];
481 pi->name = dst_port_name;
482 pi->dst_port = dst_port;
483 pi->next_index = pi->node_index = ~0;
485 hash_set (um->dst_port_info_by_dst_port[is_ip4], dst_port, i);
488 hash_set_mem (um->dst_port_info_by_name[is_ip4], pi->name, i);
492 udp_register_dst_port (vlib_main_t * vm,
493 udp_dst_port_t dst_port, u32 node_index, u8 is_ip4)
495 udp_main_t *um = &udp_main;
496 udp_dst_port_info_t *pi;
500 clib_error_t *error = vlib_call_init_function (vm, udp_local_init);
502 clib_error_report (error);
505 pi = udp_get_dst_port_info (um, dst_port, is_ip4);
508 add_dst_port (um, dst_port, 0, is_ip4);
509 pi = udp_get_dst_port_info (um, dst_port, is_ip4);
513 pi->node_index = node_index;
514 pi->next_index = vlib_node_add_next (vm,
515 is_ip4 ? udp4_local_node.index
516 : udp6_local_node.index, node_index);
518 /* Setup udp protocol -> next index sparse vector mapping. */
520 n = sparse_vec_validate (um->next_by_dst_port4,
521 clib_host_to_net_u16 (dst_port));
523 n = sparse_vec_validate (um->next_by_dst_port6,
524 clib_host_to_net_u16 (dst_port));
526 n[0] = pi->next_index;
530 udp_unregister_dst_port (vlib_main_t * vm, udp_dst_port_t dst_port, u8 is_ip4)
532 udp_main_t *um = &udp_main;
533 udp_dst_port_info_t *pi;
536 pi = udp_get_dst_port_info (um, dst_port, is_ip4);
537 /* Not registered? Fagedaboudit */
541 /* Kill the mapping. Don't bother killing the pi, it may be back. */
543 n = sparse_vec_validate (um->next_by_dst_port4,
544 clib_host_to_net_u16 (dst_port));
546 n = sparse_vec_validate (um->next_by_dst_port6,
547 clib_host_to_net_u16 (dst_port));
549 n[0] = SPARSE_VEC_INVALID_INDEX;
553 udp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add)
555 udp_main_t *um = &udp_main;
557 clib_error_t *error = vlib_call_init_function (vm, udp_local_init);
559 clib_error_report (error);
563 um->punt_unknown4 = is_add;
565 um->punt_unknown6 = is_add;
568 /* Parse a UDP header. */
570 unformat_udp_header (unformat_input_t * input, va_list * args)
572 u8 **result = va_arg (*args, u8 **);
574 __attribute__ ((unused)) int old_length;
575 u16 src_port, dst_port;
577 /* Allocate space for IP header. */
581 old_length = vec_len (*result);
582 vec_add2 (*result, p, sizeof (ip4_header_t));
586 memset (udp, 0, sizeof (udp[0]));
587 if (unformat (input, "src-port %d dst-port %d", &src_port, &dst_port))
589 udp->src_port = clib_host_to_net_u16 (src_port);
590 udp->dst_port = clib_host_to_net_u16 (dst_port);
597 udp_setup_node (vlib_main_t * vm, u32 node_index)
599 vlib_node_t *n = vlib_get_node (vm, node_index);
600 pg_node_t *pn = pg_get_node (node_index);
602 n->format_buffer = format_udp_header;
603 n->unformat_buffer = unformat_udp_header;
604 pn->unformat_edit = unformat_pg_udp_header;
608 udp_local_init (vlib_main_t * vm)
610 udp_main_t *um = &udp_main;
615 error = vlib_call_init_function (vm, udp_init);
617 clib_error_report (error);
621 for (i = 0; i < 2; i++)
623 um->dst_port_info_by_name[i] = hash_create_string (0, sizeof (uword));
624 um->dst_port_info_by_dst_port[i] = hash_create (0, sizeof (uword));
627 udp_setup_node (vm, udp4_local_node.index);
628 udp_setup_node (vm, udp6_local_node.index);
630 um->punt_unknown4 = 0;
631 um->punt_unknown6 = 0;
633 um->next_by_dst_port4 = sparse_vec_new
634 ( /* elt bytes */ sizeof (um->next_by_dst_port4[0]),
635 /* bits in index */ BITS (((udp_header_t *) 0)->dst_port));
637 um->next_by_dst_port6 = sparse_vec_new
638 ( /* elt bytes */ sizeof (um->next_by_dst_port6[0]),
639 /* bits in index */ BITS (((udp_header_t *) 0)->dst_port));
641 #define _(n,s) add_dst_port (um, UDP_DST_PORT_##s, #s, 1 /* is_ip4 */);
642 foreach_udp4_dst_port
644 #define _(n,s) add_dst_port (um, UDP_DST_PORT_##s, #s, 0 /* is_ip4 */);
645 foreach_udp6_dst_port
647 ip4_register_protocol (IP_PROTOCOL_UDP, udp4_local_node.index);
648 /* Note: ip6 differs from ip4, UDP is hotwired to ip6-udp-lookup */
652 VLIB_INIT_FUNCTION (udp_local_init);
655 * fd.io coding-style-patch-verification: ON
658 * eval: (c-set-style "gnu")