2 * Copyright (c) 2016 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.
18 * @brief Local TCP/IP stack punt infrastructure.
20 * Provides a set of VPP nodes together with the relevant APIs and CLI
21 * commands in order to adjust and dispatch packets from the VPP data plane
22 * to the local TCP/IP stack
25 #include <vnet/ip/ip.h>
26 #include <vnet/ethernet/ethernet.h>
27 #include <vlib/vlib.h>
28 #include <vnet/ip/punt.h>
29 #include <vlib/unix/unix.h>
33 #include <sys/socket.h>
39 #define punt_error(n,s) PUNT_ERROR_##n,
40 #include <vnet/ip/punt_error.def>
45 #define foreach_punt_next \
46 _ (PUNT4, "ip4-punt") \
51 #define _(s,n) PUNT_NEXT_##s,
57 enum punt_socket_rx_next_e
59 PUNT_SOCKET_RX_NEXT_INTERFACE_OUTPUT,
60 PUNT_SOCKET_RX_NEXT_IP4_LOOKUP,
61 PUNT_SOCKET_RX_NEXT_IP6_LOOKUP,
65 #define punt_next_punt(is_ip4) (is_ip4 ? PUNT_NEXT_PUNT4 : PUNT_NEXT_PUNT6)
67 /** @brief IPv4/IPv6 UDP punt node main loop.
69 This is the main loop inline function for IPv4/IPv6 UDP punt
72 @param vm vlib_main_t corresponding to the current thread
73 @param node vlib_node_runtime_t
74 @param frame vlib_frame_t whose contents should be dispatched
75 @param is_ipv4 indicates if called for IPv4 or IPv6 node
78 udp46_punt_inline (vlib_main_t * vm,
79 vlib_node_runtime_t * node,
80 vlib_frame_t * from_frame, int is_ip4)
82 u32 n_left_from, *from, *to_next;
85 from = vlib_frame_vector_args (from_frame);
86 n_left_from = from_frame->n_vectors;
88 /* udp[46]_lookup hands us the data payload, not the IP header */
90 advance = -(sizeof (ip4_header_t) + sizeof (udp_header_t));
92 advance = -(sizeof (ip6_header_t) + sizeof (udp_header_t));
94 while (n_left_from > 0)
98 vlib_get_next_frame (vm, node, punt_next_punt (is_ip4), to_next,
101 while (n_left_from > 0 && n_left_to_next > 0)
113 b0 = vlib_get_buffer (vm, bi0);
114 vlib_buffer_advance (b0, advance);
115 b0->error = node->errors[PUNT_ERROR_UDP_PORT];
118 vlib_put_next_frame (vm, node, punt_next_punt (is_ip4), n_left_to_next);
121 return from_frame->n_vectors;
124 static char *punt_error_strings[] = {
125 #define punt_error(n,s) s,
126 #include "punt_error.def"
130 /** @brief IPv4 UDP punt node.
133 This is the IPv4 UDP punt transition node. It is registered as a next
134 node for the "ip4-udp-lookup" handling UDP port(s) requested for punt.
135 The buffer's current data pointer is adjusted to the original packet
136 IPv4 header. All buffers are dispatched to "error-punt".
138 @param vm vlib_main_t corresponding to the current thread
139 @param node vlib_node_runtime_t
140 @param frame vlib_frame_t whose contents should be dispatched
142 @par Graph mechanics: next index usage
145 - <code>vnet_buffer(b)->current_data</code>
146 - <code>vnet_buffer(b)->current_len</code>
149 - Dispatches the packet to the "error-punt" node
151 VLIB_NODE_FN (udp4_punt_node) (vlib_main_t * vm,
152 vlib_node_runtime_t * node,
153 vlib_frame_t * from_frame)
155 return udp46_punt_inline (vm, node, from_frame, 1 /* is_ip4 */ );
158 /** @brief IPv6 UDP punt node.
161 This is the IPv6 UDP punt transition node. It is registered as a next
162 node for the "ip6-udp-lookup" handling UDP port(s) requested for punt.
163 The buffer's current data pointer is adjusted to the original packet
164 IPv6 header. All buffers are dispatched to "error-punt".
166 @param vm vlib_main_t corresponding to the current thread
167 @param node vlib_node_runtime_t
168 @param frame vlib_frame_t whose contents should be dispatched
170 @par Graph mechanics: next index usage
173 - <code>vnet_buffer(b)->current_data</code>
174 - <code>vnet_buffer(b)->current_len</code>
177 - Dispatches the packet to the "error-punt" node
179 VLIB_NODE_FN (udp6_punt_node) (vlib_main_t * vm,
180 vlib_node_runtime_t * node,
181 vlib_frame_t * from_frame)
183 return udp46_punt_inline (vm, node, from_frame, 0 /* is_ip4 */ );
187 VLIB_REGISTER_NODE (udp4_punt_node) = {
188 .name = "ip4-udp-punt",
189 /* Takes a vector of packets. */
190 .vector_size = sizeof (u32),
192 .n_errors = PUNT_N_ERROR,
193 .error_strings = punt_error_strings,
195 .n_next_nodes = PUNT_N_NEXT,
197 #define _(s,n) [PUNT_NEXT_##s] = n,
203 VLIB_REGISTER_NODE (udp6_punt_node) = {
204 .name = "ip6-udp-punt",
205 /* Takes a vector of packets. */
206 .vector_size = sizeof (u32),
208 .n_errors = PUNT_N_ERROR,
209 .error_strings = punt_error_strings,
211 .n_next_nodes = PUNT_N_NEXT,
213 #define _(s,n) [PUNT_NEXT_##s] = n,
222 punt_client_t client;
228 format_udp_punt_trace (u8 * s, va_list * args)
230 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
231 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
232 udp_punt_trace_t *t = va_arg (*args, udp_punt_trace_t *);
233 u32 indent = format_get_indent (s);
234 s = format (s, "to: %s", t->client.caddr.sun_path);
237 s = format (s, "\n%U(buffer is part of chain)", format_white_space,
240 s = format (s, "\n%U%U", format_white_space, indent,
241 format_hex_bytes, t->packet_data, sizeof (t->packet_data));
247 punt_socket_inline2 (vlib_main_t *vm, vlib_node_runtime_t *node,
248 vlib_frame_t *frame, punt_type_t pt,
249 ip_address_family_t af, ip_protocol_t protocol)
251 u32 *buffers = vlib_frame_vector_args (frame);
252 u32 thread_index = vm->thread_index;
253 uword n_packets = frame->n_vectors;
254 punt_main_t *pm = &punt_main;
257 punt_thread_data_t *ptd = &pm->thread_data[thread_index];
258 u32 node_index = (AF_IP4 == af ?
259 udp4_punt_socket_node.index :
260 udp6_punt_socket_node.index);
262 for (i = 0; i < n_packets; i++)
267 punt_packetdesc_t packetdesc;
270 b = vlib_get_buffer (vm, buffers[i]);
272 if (PUNT_TYPE_L4 == pt)
274 if (protocol == IP_PROTOCOL_UDP)
276 /* Reverse UDP Punt advance */
280 vlib_buffer_advance (
281 b, -(sizeof (ip4_header_t) + sizeof (udp_header_t)));
282 ip4_header_t *ip = vlib_buffer_get_current (b);
283 udp = (udp_header_t *) (ip + 1);
287 vlib_buffer_advance (
288 b, -(sizeof (ip6_header_t) + sizeof (udp_header_t)));
289 ip6_header_t *ip = vlib_buffer_get_current (b);
290 udp = (udp_header_t *) (ip + 1);
292 port = clib_net_to_host_u16 (udp->dst_port);
294 else if (protocol == IP_PROTOCOL_ICMP6)
296 ip6_header_t *ip = vlib_buffer_get_current (b);
297 icmp46_header_t *icmp = ip6_next_header (ip);
301 * Find registerered client
302 * If no registered client, drop packet and count
304 c = punt_client_l4_get (af, port);
306 else if (PUNT_TYPE_IP_PROTO == pt)
308 /* Reverse UDP Punt advance */
313 ip4_header_t *ip = vlib_buffer_get_current (b);
314 proto = ip->protocol;
318 ip6_header_t *ip = vlib_buffer_get_current (b);
319 proto = ip->protocol;
322 c = punt_client_ip_proto_get (af, proto);
324 else if (PUNT_TYPE_EXCEPTION == pt)
326 c = punt_client_exception_get (b->punt_reason);
331 if (PREDICT_FALSE (NULL == c))
333 vlib_node_increment_counter (vm, node_index,
334 PUNT_ERROR_SOCKET_TX_ERROR, 1);
338 struct sockaddr_un *caddr = &c->caddr;
341 vec_reset_length (ptd->iovecs);
343 /* Add packet descriptor */
344 packetdesc.sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
345 packetdesc.action = 0;
346 vec_add2 (ptd->iovecs, iov, 1);
347 iov->iov_base = &packetdesc;
348 iov->iov_len = sizeof (packetdesc);
350 /** VLIB buffer chain -> Unix iovec(s). */
351 vlib_buffer_advance (b, -ethernet_buffer_header_size (b));
352 vec_add2 (ptd->iovecs, iov, 1);
353 iov->iov_base = b->data + b->current_data;
354 iov->iov_len = l = b->current_length;
356 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
359 t = vlib_add_trace (vm, node, b, sizeof (t[0]));
360 clib_memcpy_fast (&t->client, c, sizeof (t->client));
361 clib_memcpy_fast (t->packet_data,
362 vlib_buffer_get_current (b),
363 sizeof (t->packet_data));
366 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
370 b = vlib_get_buffer (vm, b->next_buffer);
371 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
374 t = vlib_add_trace (vm, node, b, sizeof (t[0]));
375 clib_memcpy_fast (&t->client, c, sizeof (t->client));
379 vec_add2 (ptd->iovecs, iov, 1);
381 iov->iov_base = b->data + b->current_data;
382 iov->iov_len = b->current_length;
383 l += b->current_length;
385 while (b->flags & VLIB_BUFFER_NEXT_PRESENT);
388 struct msghdr msg = {
390 .msg_namelen = sizeof (*caddr),
391 .msg_iov = ptd->iovecs,
392 .msg_iovlen = vec_len (ptd->iovecs),
395 if (sendmsg (pm->socket_fd, &msg, 0) < (ssize_t) l)
396 vlib_node_increment_counter (vm, node_index,
397 PUNT_ERROR_SOCKET_TX_ERROR, 1);
399 vlib_node_increment_counter (vm, node_index, PUNT_ERROR_SOCKET_TX, 1);
403 vlib_buffer_free (vm, buffers, n_packets);
409 punt_socket_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
410 vlib_frame_t *frame, punt_type_t pt,
411 ip_address_family_t af)
413 return punt_socket_inline2 (vm, node, frame, pt, af, IP_PROTOCOL_UDP);
417 udp4_punt_socket (vlib_main_t * vm,
418 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
420 return punt_socket_inline (vm, node, from_frame, PUNT_TYPE_L4, AF_IP4);
424 udp6_punt_socket (vlib_main_t * vm,
425 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
427 return punt_socket_inline (vm, node, from_frame, PUNT_TYPE_L4, AF_IP6);
431 ip4_proto_punt_socket (vlib_main_t * vm,
432 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
434 return punt_socket_inline (vm, node, from_frame,
435 PUNT_TYPE_IP_PROTO, AF_IP4);
439 ip6_proto_punt_socket (vlib_main_t * vm,
440 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
442 return punt_socket_inline (vm, node, from_frame,
443 PUNT_TYPE_IP_PROTO, AF_IP6);
447 icmp6_punt_socket (vlib_main_t *vm, vlib_node_runtime_t *node,
448 vlib_frame_t *from_frame)
450 return punt_socket_inline2 (vm, node, from_frame, PUNT_TYPE_L4, AF_IP6,
455 exception_punt_socket (vlib_main_t * vm,
456 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
458 return punt_socket_inline (vm, node, from_frame,
459 PUNT_TYPE_EXCEPTION, AF_IP4);
464 VLIB_REGISTER_NODE (udp4_punt_socket_node) = {
465 .function = udp4_punt_socket,
466 .name = "ip4-udp-punt-socket",
467 .format_trace = format_udp_punt_trace,
468 .flags = VLIB_NODE_FLAG_IS_DROP,
469 /* Takes a vector of packets. */
470 .vector_size = sizeof (u32),
471 .n_errors = PUNT_N_ERROR,
472 .error_strings = punt_error_strings,
474 VLIB_REGISTER_NODE (udp6_punt_socket_node) = {
475 .function = udp6_punt_socket,
476 .name = "ip6-udp-punt-socket",
477 .format_trace = format_udp_punt_trace,
478 .flags = VLIB_NODE_FLAG_IS_DROP,
479 .vector_size = sizeof (u32),
480 .n_errors = PUNT_N_ERROR,
481 .error_strings = punt_error_strings,
483 VLIB_REGISTER_NODE (ip4_proto_punt_socket_node) = {
484 .function = ip4_proto_punt_socket,
485 .name = "ip4-proto-punt-socket",
486 .format_trace = format_udp_punt_trace,
487 .flags = VLIB_NODE_FLAG_IS_DROP,
488 /* Takes a vector of packets. */
489 .vector_size = sizeof (u32),
490 .n_errors = PUNT_N_ERROR,
491 .error_strings = punt_error_strings,
493 VLIB_REGISTER_NODE (ip6_proto_punt_socket_node) = {
494 .function = ip6_proto_punt_socket,
495 .name = "ip6-proto-punt-socket",
496 .format_trace = format_udp_punt_trace,
497 .flags = VLIB_NODE_FLAG_IS_DROP,
498 .vector_size = sizeof (u32),
499 .n_errors = PUNT_N_ERROR,
500 .error_strings = punt_error_strings,
502 VLIB_REGISTER_NODE (exception_punt_socket_node) = {
503 .function = exception_punt_socket,
504 .name = "exception-punt-socket",
505 .format_trace = format_udp_punt_trace,
506 .flags = VLIB_NODE_FLAG_IS_DROP,
507 .vector_size = sizeof (u32),
508 .n_errors = PUNT_N_ERROR,
509 .error_strings = punt_error_strings,
511 VLIB_REGISTER_NODE (icmp6_punt_socket_node) = {
512 .function = icmp6_punt_socket,
513 .name = "ip6-icmp-punt-socket",
514 .format_trace = format_udp_punt_trace,
515 .flags = VLIB_NODE_FLAG_IS_DROP,
516 .vector_size = sizeof (u32),
517 .n_errors = PUNT_N_ERROR,
518 .error_strings = punt_error_strings,
525 enum punt_action_e action;
530 format_punt_trace (u8 * s, va_list * va)
532 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
533 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
534 vnet_main_t *vnm = vnet_get_main ();
535 punt_trace_t *t = va_arg (*va, punt_trace_t *);
536 s = format (s, "%U Action: %d", format_vnet_sw_if_index_name,
537 vnm, t->sw_if_index, t->action);
542 punt_socket_rx_fd (vlib_main_t * vm, vlib_node_runtime_t * node, u32 fd)
544 const uword buffer_size = vlib_buffer_get_default_data_size (vm);
545 u32 n_trace = vlib_get_trace_count (vm, node);
546 u32 next = node->cached_next_index;
547 u32 n_left_to_next, next_index;
549 u32 error = PUNT_ERROR_NONE;
550 vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
552 /* $$$$ Only dealing with one buffer at the time for now */
556 punt_packetdesc_t packetdesc;
560 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
562 error = PUNT_ERROR_NOBUFFER;
566 b = vlib_get_buffer (vm, bi);
567 io[0].iov_base = &packetdesc;
568 io[0].iov_len = sizeof (packetdesc);
569 io[1].iov_base = b->data;
570 io[1].iov_len = buffer_size;
572 size = readv (fd, io, 2);
573 /* We need at least the packet descriptor plus a header */
574 if (size <= (int) (sizeof (packetdesc) + sizeof (ip4_header_t)))
576 vlib_buffer_free (vm, &bi, 1);
577 error = PUNT_ERROR_READV;
581 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
582 b->current_length = size - sizeof (packetdesc);
584 switch (packetdesc.action)
587 vnet_buffer (b)->sw_if_index[VLIB_TX] = packetdesc.sw_if_index;
588 next_index = PUNT_SOCKET_RX_NEXT_INTERFACE_OUTPUT;
591 case PUNT_IP4_ROUTED:
592 vnet_buffer (b)->sw_if_index[VLIB_RX] = packetdesc.sw_if_index;
593 vnet_buffer (b)->sw_if_index[VLIB_TX] = ~0;
594 next_index = PUNT_SOCKET_RX_NEXT_IP4_LOOKUP;
597 case PUNT_IP6_ROUTED:
598 vnet_buffer (b)->sw_if_index[VLIB_RX] = packetdesc.sw_if_index;
599 vnet_buffer (b)->sw_if_index[VLIB_TX] = ~0;
600 next_index = PUNT_SOCKET_RX_NEXT_IP6_LOOKUP;
604 error = PUNT_ERROR_ACTION;
605 vlib_buffer_free (vm, &bi, 1);
611 && vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ )))
614 vlib_set_trace_count (vm, node, --n_trace);
615 t = vlib_add_trace (vm, node, b, sizeof (*t));
616 t->sw_if_index = packetdesc.sw_if_index;
617 t->action = packetdesc.action;
624 vlib_validate_buffer_enqueue_x1 (vm, node, next, to_next, n_left_to_next,
626 vlib_put_next_frame (vm, node, next, n_left_to_next);
631 vlib_put_next_frame (vm, node, next, n_left_to_next);
632 vlib_node_increment_counter (vm, punt_socket_rx_node.index, error, 1);
637 punt_socket_rx (vlib_main_t * vm,
638 vlib_node_runtime_t * node, vlib_frame_t * frame)
640 punt_main_t *pm = &punt_main;
644 for (i = 0; i < vec_len (pm->ready_fds); i++)
646 total_count += punt_socket_rx_fd (vm, node, pm->ready_fds[i]);
647 vec_del1 (pm->ready_fds, i);
653 VLIB_REGISTER_NODE (punt_socket_rx_node) =
655 .function = punt_socket_rx,
656 .name = "punt-socket-rx",
657 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
658 .type = VLIB_NODE_TYPE_INPUT,
659 .state = VLIB_NODE_STATE_INTERRUPT,
661 .n_errors = PUNT_N_ERROR,
662 .error_strings = punt_error_strings,
663 .n_next_nodes = PUNT_SOCKET_RX_N_NEXT,
665 [PUNT_SOCKET_RX_NEXT_INTERFACE_OUTPUT] = "interface-output",
666 [PUNT_SOCKET_RX_NEXT_IP4_LOOKUP] = "ip4-lookup",
667 [PUNT_SOCKET_RX_NEXT_IP6_LOOKUP] = "ip6-lookup",
669 .format_trace = format_punt_trace,
674 * fd.io coding-style-patch-verification: ON
677 * eval: (c-set-style "gnu")