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 <vlib/vlib.h>
27 #include <vnet/pg/pg.h>
28 #include <vnet/udp/udp.h>
29 #include <vnet/tcp/tcp.h>
30 #include <vnet/sctp/sctp.h>
31 #include <vnet/ip/punt.h>
32 #include <vppinfra/sparse_vec.h>
33 #include <vlib/unix/unix.h>
37 #include <sys/socket.h>
41 #define foreach_punt_next \
42 _ (PUNT4, "ip4-punt") \
47 #define _(s,n) PUNT_NEXT_##s,
53 enum punt_socket_rx_next_e
55 PUNT_SOCKET_RX_NEXT_INTERFACE_OUTPUT,
56 PUNT_SOCKET_RX_NEXT_IP4_LOOKUP,
57 PUNT_SOCKET_RX_NEXT_IP6_LOOKUP,
61 #define punt_next_punt(is_ip4) (is_ip4 ? PUNT_NEXT_PUNT4 : PUNT_NEXT_PUNT6)
63 extern vlib_node_registration_t udp4_punt_node;
64 extern vlib_node_registration_t udp6_punt_node;
65 extern vlib_node_registration_t udp4_punt_socket_node;
66 extern vlib_node_registration_t udp6_punt_socket_node;
67 static vlib_node_registration_t punt_socket_rx_node;
69 extern punt_main_t punt_main;
71 #ifndef CLIB_MARCH_VARIANT
72 punt_main_t punt_main;
75 vnet_punt_get_server_pathname (void)
77 punt_main_t *pm = &punt_main;
80 #endif /* CLIB_MARCH_VARIANT */
82 /** @brief IPv4/IPv6 UDP punt node main loop.
84 This is the main loop inline function for IPv4/IPv6 UDP punt
87 @param vm vlib_main_t corresponding to the current thread
88 @param node vlib_node_runtime_t
89 @param frame vlib_frame_t whose contents should be dispatched
90 @param is_ipv4 indicates if called for IPv4 or IPv6 node
93 udp46_punt_inline (vlib_main_t * vm,
94 vlib_node_runtime_t * node,
95 vlib_frame_t * from_frame, int is_ip4)
97 u32 n_left_from, *from, *to_next;
100 from = vlib_frame_vector_args (from_frame);
101 n_left_from = from_frame->n_vectors;
103 /* udp[46]_lookup hands us the data payload, not the IP header */
105 advance = -(sizeof (ip4_header_t) + sizeof (udp_header_t));
107 advance = -(sizeof (ip6_header_t) + sizeof (udp_header_t));
109 while (n_left_from > 0)
113 vlib_get_next_frame (vm, node, punt_next_punt (is_ip4), to_next,
116 while (n_left_from > 0 && n_left_to_next > 0)
128 b0 = vlib_get_buffer (vm, bi0);
129 vlib_buffer_advance (b0, advance);
130 b0->error = node->errors[PUNT_ERROR_UDP_PORT];
133 vlib_put_next_frame (vm, node, punt_next_punt (is_ip4), n_left_to_next);
136 return from_frame->n_vectors;
139 static char *punt_error_strings[] = {
140 #define punt_error(n,s) s,
141 #include "punt_error.def"
145 /** @brief IPv4 UDP punt node.
148 This is the IPv4 UDP punt transition node. It is registered as a next
149 node for the "ip4-udp-lookup" handling UDP port(s) requested for punt.
150 The buffer's current data pointer is adjusted to the original packet
151 IPv4 header. All buffers are dispatched to "error-punt".
153 @param vm vlib_main_t corresponding to the current thread
154 @param node vlib_node_runtime_t
155 @param frame vlib_frame_t whose contents should be dispatched
157 @par Graph mechanics: next index usage
160 - <code>vnet_buffer(b)->current_data</code>
161 - <code>vnet_buffer(b)->current_len</code>
164 - Dispatches the packet to the "error-punt" node
166 VLIB_NODE_FN (udp4_punt_node) (vlib_main_t * vm,
167 vlib_node_runtime_t * node,
168 vlib_frame_t * from_frame)
170 return udp46_punt_inline (vm, node, from_frame, 1 /* is_ip4 */ );
173 /** @brief IPv6 UDP punt node.
176 This is the IPv6 UDP punt transition node. It is registered as a next
177 node for the "ip6-udp-lookup" handling UDP port(s) requested for punt.
178 The buffer's current data pointer is adjusted to the original packet
179 IPv6 header. All buffers are dispatched to "error-punt".
181 @param vm vlib_main_t corresponding to the current thread
182 @param node vlib_node_runtime_t
183 @param frame vlib_frame_t whose contents should be dispatched
185 @par Graph mechanics: next index usage
188 - <code>vnet_buffer(b)->current_data</code>
189 - <code>vnet_buffer(b)->current_len</code>
192 - Dispatches the packet to the "error-punt" node
194 VLIB_NODE_FN (udp6_punt_node) (vlib_main_t * vm,
195 vlib_node_runtime_t * node,
196 vlib_frame_t * from_frame)
198 return udp46_punt_inline (vm, node, from_frame, 0 /* is_ip4 */ );
202 VLIB_REGISTER_NODE (udp4_punt_node) = {
203 .name = "ip4-udp-punt",
204 /* Takes a vector of packets. */
205 .vector_size = sizeof (u32),
207 .n_errors = PUNT_N_ERROR,
208 .error_strings = punt_error_strings,
210 .n_next_nodes = PUNT_N_NEXT,
212 #define _(s,n) [PUNT_NEXT_##s] = n,
218 VLIB_REGISTER_NODE (udp6_punt_node) = {
219 .name = "ip6-udp-punt",
220 /* Takes a vector of packets. */
221 .vector_size = sizeof (u32),
223 .n_errors = PUNT_N_ERROR,
224 .error_strings = punt_error_strings,
226 .n_next_nodes = PUNT_N_NEXT,
228 #define _(s,n) [PUNT_NEXT_##s] = n,
236 static punt_client_t *
237 punt_client_get (bool is_ip4, u16 port)
239 punt_main_t *pm = &punt_main;
241 is_ip4 ? pm->clients_by_dst_port4 : pm->clients_by_dst_port6;
243 u16 i = sparse_vec_index (v, port);
244 if (i == SPARSE_VEC_INVALID_INDEX)
247 return &vec_elt (v, i);
250 static struct sockaddr_un *
251 punt_socket_get (bool is_ip4, u16 port)
253 punt_client_t *v = punt_client_get (is_ip4, port);
260 #ifndef CLIB_MARCH_VARIANT
262 punt_socket_register (bool is_ip4, u8 protocol, u16 port,
263 char *client_pathname)
265 punt_main_t *pm = &punt_main;
267 punt_client_t *v = is_ip4 ? pm->clients_by_dst_port4 :
268 pm->clients_by_dst_port6;
270 if (strncmp (client_pathname, vnet_punt_get_server_pathname (),
274 clib_memset (&c, 0, sizeof (c));
275 memcpy (c.caddr.sun_path, client_pathname, sizeof (c.caddr.sun_path));
276 c.caddr.sun_family = AF_UNIX;
278 c.protocol = protocol;
279 n = sparse_vec_validate (v, port);
284 /* $$$$ Just leaves the mapping in place for now */
286 punt_socket_unregister (bool is_ip4, u8 protocol, u16 port)
290 #endif /* CLIB_MARCH_VARIANT */
294 punt_client_t client;
299 format_udp_punt_trace (u8 * s, va_list * args)
301 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
302 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
303 udp_punt_trace_t *t = va_arg (*args, udp_punt_trace_t *);
304 u32 indent = format_get_indent (s);
305 s = format (s, "to: %s", t->client.caddr.sun_path);
308 s = format (s, "\n%U(buffer is part of chain)", format_white_space,
315 udp46_punt_socket_inline (vlib_main_t * vm,
316 vlib_node_runtime_t * node,
317 vlib_frame_t * frame, bool is_ip4)
319 u32 *buffers = vlib_frame_vector_args (frame);
320 uword n_packets = frame->n_vectors;
321 struct iovec *iovecs = 0;
322 punt_main_t *pm = &punt_main;
325 u32 node_index = is_ip4 ? udp4_punt_socket_node.index :
326 udp6_punt_socket_node.index;
328 for (i = 0; i < n_packets; i++)
333 punt_packetdesc_t packetdesc;
335 b = vlib_get_buffer (vm, buffers[i]);
337 /* Reverse UDP Punt advance */
341 vlib_buffer_advance (b, -(sizeof (ip4_header_t) +
342 sizeof (udp_header_t)));
343 ip4_header_t *ip = vlib_buffer_get_current (b);
344 udp = (udp_header_t *) (ip + 1);
348 vlib_buffer_advance (b, -(sizeof (ip6_header_t) +
349 sizeof (udp_header_t)));
350 ip6_header_t *ip = vlib_buffer_get_current (b);
351 udp = (udp_header_t *) (ip + 1);
354 u16 port = clib_net_to_host_u16 (udp->dst_port);
357 * Find registerered client
358 * If no registered client, drop packet and count
360 struct sockaddr_un *caddr;
361 caddr = punt_socket_get (is_ip4, port);
364 vlib_node_increment_counter (vm, node_index,
365 PUNT_ERROR_SOCKET_TX_ERROR, 1);
369 punt_client_t *c = NULL;
370 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
372 c = punt_client_get (is_ip4, port);
374 t = vlib_add_trace (vm, node, b, sizeof (t[0]));
375 clib_memcpy_fast (&t->client, c, sizeof (t->client));
378 /* Re-set iovecs if present. */
380 _vec_len (iovecs) = 0;
382 /* Add packet descriptor */
383 packetdesc.sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
384 packetdesc.action = 0;
385 vec_add2 (iovecs, iov, 1);
386 iov->iov_base = &packetdesc;
387 iov->iov_len = sizeof (packetdesc);
389 /** VLIB buffer chain -> Unix iovec(s). */
390 vlib_buffer_advance (b, -(sizeof (ethernet_header_t)));
391 vec_add2 (iovecs, iov, 1);
392 iov->iov_base = b->data + b->current_data;
393 iov->iov_len = l = b->current_length;
395 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
399 b = vlib_get_buffer (vm, b->next_buffer);
400 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
402 if (PREDICT_FALSE (!c))
404 c = punt_client_get (is_ip4, port);
407 t = vlib_add_trace (vm, node, b, sizeof (t[0]));
408 clib_memcpy_fast (&t->client, c, sizeof (t->client));
412 vec_add2 (iovecs, iov, 1);
414 iov->iov_base = b->data + b->current_data;
415 iov->iov_len = b->current_length;
416 l += b->current_length;
418 while (b->flags & VLIB_BUFFER_NEXT_PRESENT);
421 struct msghdr msg = {
423 .msg_namelen = sizeof (*caddr),
425 .msg_iovlen = vec_len (iovecs),
428 if (sendmsg (pm->socket_fd, &msg, 0) < (ssize_t) l)
429 vlib_node_increment_counter (vm, node_index,
430 PUNT_ERROR_SOCKET_TX_ERROR, 1);
432 vlib_node_increment_counter (vm, node_index, PUNT_ERROR_SOCKET_TX, 1);
437 vlib_buffer_free (vm, buffers, n_packets);
443 udp4_punt_socket (vlib_main_t * vm,
444 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
446 return udp46_punt_socket_inline (vm, node, from_frame, true /* is_ip4 */ );
450 udp6_punt_socket (vlib_main_t * vm,
451 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
453 return udp46_punt_socket_inline (vm, node, from_frame, false /* is_ip4 */ );
458 VLIB_REGISTER_NODE (udp4_punt_socket_node) = {
459 .function = udp4_punt_socket,
460 .name = "ip4-udp-punt-socket",
461 .format_trace = format_udp_punt_trace,
462 .flags = VLIB_NODE_FLAG_IS_DROP,
463 /* Takes a vector of packets. */
464 .vector_size = sizeof (u32),
465 .n_errors = PUNT_N_ERROR,
466 .error_strings = punt_error_strings,
468 VLIB_REGISTER_NODE (udp6_punt_socket_node) = {
469 .function = udp6_punt_socket,
470 .name = "ip6-udp-punt-socket",
471 .format_trace = format_udp_punt_trace,
472 .flags = VLIB_NODE_FLAG_IS_DROP,
473 .vector_size = sizeof (u32),
474 .n_errors = PUNT_N_ERROR,
475 .error_strings = punt_error_strings,
481 enum punt_action_e action;
486 format_punt_trace (u8 * s, va_list * va)
488 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
489 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
490 vnet_main_t *vnm = vnet_get_main ();
491 punt_trace_t *t = va_arg (*va, punt_trace_t *);
492 s = format (s, "%U Action: %d", format_vnet_sw_if_index_name,
493 vnm, t->sw_if_index, t->action);
498 punt_socket_rx_fd (vlib_main_t * vm, vlib_node_runtime_t * node, u32 fd)
500 const uword buffer_size = vlib_buffer_get_default_data_size (vm);
501 u32 n_trace = vlib_get_trace_count (vm, node);
502 u32 next = node->cached_next_index;
503 u32 n_left_to_next, next_index;
505 u32 error = PUNT_ERROR_NONE;
506 vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
508 /* $$$$ Only dealing with one buffer at the time for now */
512 punt_packetdesc_t packetdesc;
516 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
518 error = PUNT_ERROR_NOBUFFER;
522 b = vlib_get_buffer (vm, bi);
523 io[0].iov_base = &packetdesc;
524 io[0].iov_len = sizeof (packetdesc);
525 io[1].iov_base = b->data;
526 io[1].iov_len = buffer_size;
528 size = readv (fd, io, 2);
529 /* We need at least the packet descriptor plus a header */
530 if (size <= (int) (sizeof (packetdesc) + sizeof (ip4_header_t)))
532 vlib_buffer_free (vm, &bi, 1);
533 error = PUNT_ERROR_READV;
537 b->flags = VNET_BUFFER_F_LOCALLY_ORIGINATED;
538 b->current_length = size - sizeof (packetdesc);
540 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
542 switch (packetdesc.action)
545 vnet_buffer (b)->sw_if_index[VLIB_TX] = packetdesc.sw_if_index;
546 next_index = PUNT_SOCKET_RX_NEXT_INTERFACE_OUTPUT;
549 case PUNT_IP4_ROUTED:
550 vnet_buffer (b)->sw_if_index[VLIB_RX] = packetdesc.sw_if_index;
551 vnet_buffer (b)->sw_if_index[VLIB_TX] = ~0;
552 next_index = PUNT_SOCKET_RX_NEXT_IP4_LOOKUP;
555 case PUNT_IP6_ROUTED:
556 vnet_buffer (b)->sw_if_index[VLIB_RX] = packetdesc.sw_if_index;
557 vnet_buffer (b)->sw_if_index[VLIB_TX] = ~0;
558 next_index = PUNT_SOCKET_RX_NEXT_IP6_LOOKUP;
562 error = PUNT_ERROR_ACTION;
563 vlib_buffer_free (vm, &bi, 1);
567 if (PREDICT_FALSE (n_trace > 0))
570 vlib_trace_buffer (vm, node, next_index, b, 1 /* follow_chain */ );
571 vlib_set_trace_count (vm, node, --n_trace);
572 t = vlib_add_trace (vm, node, b, sizeof (*t));
573 t->sw_if_index = packetdesc.sw_if_index;
574 t->action = packetdesc.action;
581 vlib_validate_buffer_enqueue_x1 (vm, node, next, to_next, n_left_to_next,
583 vlib_put_next_frame (vm, node, next, n_left_to_next);
587 vlib_node_increment_counter (vm, punt_socket_rx_node.index, error, 1);
592 punt_socket_rx (vlib_main_t * vm,
593 vlib_node_runtime_t * node, vlib_frame_t * frame)
595 punt_main_t *pm = &punt_main;
599 for (i = 0; i < vec_len (pm->ready_fds); i++)
601 total_count += punt_socket_rx_fd (vm, node, pm->ready_fds[i]);
602 vec_del1 (pm->ready_fds, i);
608 VLIB_REGISTER_NODE (punt_socket_rx_node, static) =
610 .function = punt_socket_rx,
611 .name = "punt-socket-rx",
612 .type = VLIB_NODE_TYPE_INPUT,
613 .state = VLIB_NODE_STATE_INTERRUPT,
615 .n_errors = PUNT_N_ERROR,
616 .error_strings = punt_error_strings,
617 .n_next_nodes = PUNT_SOCKET_RX_N_NEXT,
619 [PUNT_SOCKET_RX_NEXT_INTERFACE_OUTPUT] = "interface-output",
620 [PUNT_SOCKET_RX_NEXT_IP4_LOOKUP] = "ip4-lookup",
621 [PUNT_SOCKET_RX_NEXT_IP6_LOOKUP] = "ip6-lookup",
623 .format_trace = format_punt_trace,
627 static clib_error_t *
628 punt_socket_read_ready (clib_file_t * uf)
630 vlib_main_t *vm = vlib_get_main ();
631 punt_main_t *pm = &punt_main;
633 /** Schedule the rx node */
634 vlib_node_set_interrupt_pending (vm, punt_socket_rx_node.index);
635 vec_add1 (pm->ready_fds, uf->file_descriptor);
640 #ifndef CLIB_MARCH_VARIANT
642 vnet_punt_socket_add (vlib_main_t * vm, u32 header_version,
643 bool is_ip4, u8 protocol, u16 port,
644 char *client_pathname)
646 punt_main_t *pm = &punt_main;
648 if (!pm->is_configured)
649 return clib_error_return (0, "socket is not configured");
651 if (header_version != PUNT_PACKETDESC_VERSION)
652 return clib_error_return (0, "Invalid packet descriptor version");
654 /* For now we only support UDP punt */
655 if (protocol != IP_PROTOCOL_UDP)
656 return clib_error_return (0,
657 "only UDP protocol (%d) is supported, got %d",
658 IP_PROTOCOL_UDP, protocol);
660 if (port == (u16) ~ 0)
661 return clib_error_return (0, "UDP port number required");
663 /* Register client */
664 if (punt_socket_register (is_ip4, protocol, port, client_pathname) < 0)
665 return clib_error_return (0,
666 "Punt socket: Invalid client path: %s",
669 u32 node_index = is_ip4 ? udp4_punt_socket_node.index :
670 udp6_punt_socket_node.index;
672 udp_register_dst_port (vm, port, node_index, is_ip4);
678 vnet_punt_socket_del (vlib_main_t * vm, bool is_ip4, u8 l4_protocol, u16 port)
680 punt_main_t *pm = &punt_main;
682 if (!pm->is_configured)
683 return clib_error_return (0, "socket is not configured");
685 punt_socket_unregister (is_ip4, l4_protocol, port);
686 udp_unregister_dst_port (vm, port, is_ip4);
692 * @brief Request IP traffic punt to the local TCP/IP stack.
695 * - UDP and TCP are the only protocols supported in the current implementation
697 * @param vm vlib_main_t corresponding to the current thread
698 * @param ipv IP protcol version.
699 * 4 - IPv4, 6 - IPv6, ~0 for both IPv6 and IPv4
700 * @param protocol 8-bits L4 protocol value
703 * @param port 16-bits L4 (TCP/IP) port number when applicable (UDP only)
705 * @returns 0 on success, non-zero value otherwise
708 vnet_punt_add_del (vlib_main_t * vm, u8 ipv, u8 protocol, u16 port,
712 /* For now we only support TCP, UDP and SCTP punt */
713 if (protocol != IP_PROTOCOL_UDP &&
714 protocol != IP_PROTOCOL_TCP && protocol != IP_PROTOCOL_SCTP)
715 return clib_error_return (0,
716 "only UDP (%d), TCP (%d) and SCTP (%d) protocols are supported, got %d",
717 IP_PROTOCOL_UDP, IP_PROTOCOL_TCP,
718 IP_PROTOCOL_SCTP, protocol);
720 if (ipv != (u8) ~ 0 && ipv != 4 && ipv != 6)
721 return clib_error_return (0, "IP version must be 4 or 6, got %d", ipv);
723 if (port == (u16) ~ 0)
725 if ((ipv == 4) || (ipv == (u8) ~ 0))
727 if (protocol == IP_PROTOCOL_UDP)
728 udp_punt_unknown (vm, 1, is_add);
729 else if (protocol == IP_PROTOCOL_TCP)
730 tcp_punt_unknown (vm, 1, is_add);
731 else if (protocol == IP_PROTOCOL_SCTP)
732 sctp_punt_unknown (vm, 1, is_add);
735 if ((ipv == 6) || (ipv == (u8) ~ 0))
737 if (protocol == IP_PROTOCOL_UDP)
738 udp_punt_unknown (vm, 0, is_add);
739 else if (protocol == IP_PROTOCOL_TCP)
740 tcp_punt_unknown (vm, 0, is_add);
741 else if (protocol == IP_PROTOCOL_SCTP)
742 sctp_punt_unknown (vm, 0, is_add);
750 if (protocol == IP_PROTOCOL_TCP || protocol == IP_PROTOCOL_SCTP)
751 return clib_error_return (0,
752 "punt TCP/SCTP ports is not supported yet");
754 if (ipv == 4 || ipv == (u8) ~ 0)
755 udp_register_dst_port (vm, port, udp4_punt_node.index, 1);
757 if (ipv == 6 || ipv == (u8) ~ 0)
758 udp_register_dst_port (vm, port, udp6_punt_node.index, 0);
764 if (protocol == IP_PROTOCOL_TCP || protocol == IP_PROTOCOL_SCTP)
765 return clib_error_return (0,
766 "punt TCP/SCTP ports is not supported yet");
767 if (ipv == 4 || ipv == (u8) ~ 0)
768 udp_unregister_dst_port (vm, port, 1);
770 if (ipv == 6 || ipv == (u8) ~ 0)
771 udp_unregister_dst_port (vm, port, 0);
776 #endif /* CLIB_MARCH_VARIANT */
778 static clib_error_t *
779 punt_cli (vlib_main_t * vm,
780 unformat_input_t * input, vlib_cli_command_t * cmd)
785 clib_error_t *error = NULL;
787 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
789 if (unformat (input, "del"))
791 else if (unformat (input, "all"))
793 else if (unformat (input, "%d", &port))
795 else if (unformat (input, "udp"))
796 protocol = IP_PROTOCOL_UDP;
797 else if (unformat (input, "tcp"))
798 protocol = IP_PROTOCOL_TCP;
801 error = clib_error_return (0, "parse error: '%U'",
802 format_unformat_error, input);
807 /* punt both IPv6 and IPv4 when used in CLI */
808 error = vnet_punt_add_del (vm, ~0, protocol, port, is_add);
811 clib_error_report (error);
819 * The set of '<em>set punt</em>' commands allows specific IP traffic to
820 * be punted to the host TCP/IP stack
823 * - UDP is the only protocol supported in the current implementation
824 * - All TCP traffic is currently punted to the host by default
828 * Example of how to request NTP traffic to be punted
829 * @cliexcmd{set punt udp 125}
831 * Example of how to request all 'unknown' UDP traffic to be punted
832 * @cliexcmd{set punt udp all}
834 * Example of how to stop all 'unknown' UDP traffic to be punted
835 * @cliexcmd{set punt udp del all}
839 VLIB_CLI_COMMAND (punt_command, static) = {
841 .short_help = "set punt [udp|tcp] [del] <all | port-num1 [port-num2 ...]>",
842 .function = punt_cli,
846 #ifndef CLIB_MARCH_VARIANT
847 static clib_error_t *
848 punt_socket_register_cmd (vlib_main_t * vm,
849 unformat_input_t * input, vlib_cli_command_t * cmd)
855 clib_error_t *error = NULL;
857 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
859 if (unformat (input, "ipv4"))
861 else if (unformat (input, "ipv6"))
863 else if (unformat (input, "udp"))
864 protocol = IP_PROTOCOL_UDP;
865 else if (unformat (input, "tcp"))
866 protocol = IP_PROTOCOL_TCP;
867 else if (unformat (input, "%d", &port))
869 else if (unformat (input, "socket %s", &socket_name))
873 error = clib_error_return (0, "parse error: '%U'",
874 format_unformat_error, input);
880 vnet_punt_socket_add (vm, 1, is_ipv4, protocol, port,
881 (char *) socket_name);
889 * @cliexcmd{punt socket register}
892 VLIB_CLI_COMMAND (punt_socket_register_command, static) =
894 .path = "punt socket register",
895 .function = punt_socket_register_cmd,
896 .short_help = "punt socket register [ipv4|ipv6] [udp|tcp]> <all | port-num1 [port-num2 ...]> <socket>",
901 static clib_error_t *
902 punt_socket_deregister_cmd (vlib_main_t * vm,
903 unformat_input_t * input,
904 vlib_cli_command_t * cmd)
909 clib_error_t *error = NULL;
911 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
913 if (unformat (input, "ipv4"))
915 else if (unformat (input, "ipv6"))
917 else if (unformat (input, "udp"))
918 protocol = IP_PROTOCOL_UDP;
919 else if (unformat (input, "tcp"))
920 protocol = IP_PROTOCOL_TCP;
921 else if (unformat (input, "%d", &port))
925 error = clib_error_return (0, "parse error: '%U'",
926 format_unformat_error, input);
931 error = vnet_punt_socket_del (vm, is_ipv4, protocol, port);
939 * @cliexcmd{punt socket register}
942 VLIB_CLI_COMMAND (punt_socket_deregister_command, static) =
944 .path = "punt socket deregister",
945 .function = punt_socket_deregister_cmd,
946 .short_help = "punt socket deregister [ipv4|ipv6] [udp|tcp]> <all | port-num1 [port-num2 ...]>",
951 punt_socket_detail_t *
952 punt_socket_entries (u8 ipv)
954 punt_main_t *pm = &punt_main;
956 punt_socket_detail_t *ps = 0;
959 punt_client_t *v = !ipv ? pm->clients_by_dst_port4 :
960 pm->clients_by_dst_port6;
964 if (pc && pc->port != 0)
967 if (pc->protocol == IP_PROTOCOL_UDP)
969 is_valid = udp_is_valid_dst_port (pc->port, !ipv);
973 punt_socket_detail_t detail = {
975 .l4_protocol = pc->protocol,
978 memcpy (detail.pathname, pc->caddr.sun_path,
979 sizeof (pc->caddr.sun_path));
980 vec_add1 (ps, detail);
988 format_punt_socket (u8 * s, va_list * args)
990 punt_client_t *clients = va_arg (*args, punt_client_t *);
991 u8 *is_ipv6 = va_arg (*args, u8 *);
995 vec_foreach (pc, clients)
997 if (pc && pc->port != 0)
1000 if (pc->protocol == IP_PROTOCOL_UDP)
1002 is_valid = udp_is_valid_dst_port (pc->port, !(*is_ipv6));
1006 s = format (s, " punt %s port %d to socket %s \n",
1007 (pc->protocol == IP_PROTOCOL_UDP) ? "UDP" : "TCP",
1008 pc->port, pc->caddr.sun_path);
1016 static clib_error_t *
1017 punt_socket_show_cmd (vlib_main_t * vm,
1018 unformat_input_t * input, vlib_cli_command_t * cmd)
1021 punt_main_t *pm = &punt_main;
1022 clib_error_t *error = NULL;
1024 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1026 if (unformat (input, "ipv4"))
1028 else if (unformat (input, "ipv6"))
1032 error = clib_error_return (0, "parse error: '%U'",
1033 format_unformat_error, input);
1039 is_ipv6 ? pm->clients_by_dst_port6 : pm->clients_by_dst_port4;
1040 vlib_cli_output (vm, "%U", format_punt_socket, v, &is_ipv6);
1049 * @cliexcmd{show punt socket ipv4}
1052 VLIB_CLI_COMMAND (show_punt_socket_registration_command, static) =
1054 .path = "show punt socket registrations",
1055 .function = punt_socket_show_cmd,
1056 .short_help = "show punt socket registrations [ipv4|ipv6]",
1062 ip_punt_init (vlib_main_t * vm)
1064 punt_main_t *pm = &punt_main;
1066 pm->clients_by_dst_port6 = sparse_vec_new
1067 (sizeof (pm->clients_by_dst_port6[0]),
1068 BITS (((udp_header_t *) 0)->dst_port));
1069 pm->clients_by_dst_port4 = sparse_vec_new
1070 (sizeof (pm->clients_by_dst_port4[0]),
1071 BITS (((udp_header_t *) 0)->dst_port));
1073 pm->is_configured = false;
1074 pm->interface_output_node = vlib_get_node_by_name (vm,
1076 "interface-output");
1080 VLIB_INIT_FUNCTION (ip_punt_init);
1081 #endif /* CLIB_MARCH_VARIANT */
1083 static clib_error_t *
1084 punt_config (vlib_main_t * vm, unformat_input_t * input)
1086 punt_main_t *pm = &punt_main;
1087 char *socket_path = 0;
1089 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1091 if (unformat (input, "socket %s", &socket_path))
1092 strncpy (pm->sun_path, socket_path, UNIX_PATH_MAX - 1);
1094 return clib_error_return (0, "unknown input `%U'",
1095 format_unformat_error, input);
1098 if (socket_path == 0)
1101 /* UNIX domain socket */
1102 struct sockaddr_un addr;
1103 if ((pm->socket_fd = socket (AF_UNIX, SOCK_DGRAM | SOCK_NONBLOCK, 0)) == -1)
1105 return clib_error_return (0, "socket error");
1108 clib_memset (&addr, 0, sizeof (addr));
1109 addr.sun_family = AF_UNIX;
1110 if (*socket_path == '\0')
1112 *addr.sun_path = '\0';
1113 strncpy (addr.sun_path + 1, socket_path + 1,
1114 sizeof (addr.sun_path) - 2);
1118 strncpy (addr.sun_path, socket_path, sizeof (addr.sun_path) - 1);
1119 unlink (socket_path);
1122 if (bind (pm->socket_fd, (struct sockaddr *) &addr, sizeof (addr)) == -1)
1124 return clib_error_return (0, "bind error");
1127 /* Register socket */
1128 clib_file_main_t *fm = &file_main;
1129 clib_file_t template = { 0 };
1130 template.read_function = punt_socket_read_ready;
1131 template.file_descriptor = pm->socket_fd;
1132 template.description = format (0, "%s", socket_path);
1133 pm->clib_file_index = clib_file_add (fm, &template);
1135 pm->is_configured = true;
1140 VLIB_CONFIG_FUNCTION (punt_config, "punt");
1143 * fd.io coding-style-patch-verification: ON
1146 * eval: (c-set-style "gnu")