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 vlib_node_registration_t udp4_punt_node;
64 vlib_node_registration_t udp6_punt_node;
65 vlib_node_registration_t udp4_punt_socket_node;
66 vlib_node_registration_t udp6_punt_socket_node;
67 static vlib_node_registration_t punt_socket_rx_node;
69 punt_main_t punt_main;
72 vnet_punt_get_server_pathname (void)
74 punt_main_t *pm = &punt_main;
78 /** @brief IPv4/IPv6 UDP punt node main loop.
80 This is the main loop inline function for IPv4/IPv6 UDP punt
83 @param vm vlib_main_t corresponding to the current thread
84 @param node vlib_node_runtime_t
85 @param frame vlib_frame_t whose contents should be dispatched
86 @param is_ipv4 indicates if called for IPv4 or IPv6 node
89 udp46_punt_inline (vlib_main_t * vm,
90 vlib_node_runtime_t * node,
91 vlib_frame_t * from_frame, int is_ip4)
93 u32 n_left_from, *from, *to_next;
96 from = vlib_frame_vector_args (from_frame);
97 n_left_from = from_frame->n_vectors;
99 /* udp[46]_lookup hands us the data payload, not the IP header */
101 advance = -(sizeof (ip4_header_t) + sizeof (udp_header_t));
103 advance = -(sizeof (ip6_header_t) + sizeof (udp_header_t));
105 while (n_left_from > 0)
109 vlib_get_next_frame (vm, node, punt_next_punt (is_ip4), to_next,
112 while (n_left_from > 0 && n_left_to_next > 0)
124 b0 = vlib_get_buffer (vm, bi0);
125 vlib_buffer_advance (b0, advance);
126 b0->error = node->errors[PUNT_ERROR_UDP_PORT];
129 vlib_put_next_frame (vm, node, punt_next_punt (is_ip4), n_left_to_next);
132 return from_frame->n_vectors;
135 static char *punt_error_strings[] = {
136 #define punt_error(n,s) s,
137 #include "punt_error.def"
141 /** @brief IPv4 UDP punt node.
144 This is the IPv4 UDP punt transition node. It is registered as a next
145 node for the "ip4-udp-lookup" handling UDP port(s) requested for punt.
146 The buffer's current data pointer is adjusted to the original packet
147 IPv4 header. All buffers are dispatched to "error-punt".
149 @param vm vlib_main_t corresponding to the current thread
150 @param node vlib_node_runtime_t
151 @param frame vlib_frame_t whose contents should be dispatched
153 @par Graph mechanics: next index usage
156 - <code>vnet_buffer(b)->current_data</code>
157 - <code>vnet_buffer(b)->current_len</code>
160 - Dispatches the packet to the "error-punt" node
163 udp4_punt (vlib_main_t * vm,
164 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
166 return udp46_punt_inline (vm, node, from_frame, 1 /* is_ip4 */ );
169 /** @brief IPv6 UDP punt node.
172 This is the IPv6 UDP punt transition node. It is registered as a next
173 node for the "ip6-udp-lookup" handling UDP port(s) requested for punt.
174 The buffer's current data pointer is adjusted to the original packet
175 IPv6 header. All buffers are dispatched to "error-punt".
177 @param vm vlib_main_t corresponding to the current thread
178 @param node vlib_node_runtime_t
179 @param frame vlib_frame_t whose contents should be dispatched
181 @par Graph mechanics: next index usage
184 - <code>vnet_buffer(b)->current_data</code>
185 - <code>vnet_buffer(b)->current_len</code>
188 - Dispatches the packet to the "error-punt" node
191 udp6_punt (vlib_main_t * vm,
192 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
194 return udp46_punt_inline (vm, node, from_frame, 0 /* is_ip4 */ );
198 VLIB_REGISTER_NODE (udp4_punt_node) = {
199 .function = udp4_punt,
200 .name = "ip4-udp-punt",
201 /* Takes a vector of packets. */
202 .vector_size = sizeof (u32),
204 .n_errors = PUNT_N_ERROR,
205 .error_strings = punt_error_strings,
207 .n_next_nodes = PUNT_N_NEXT,
209 #define _(s,n) [PUNT_NEXT_##s] = n,
215 VLIB_NODE_FUNCTION_MULTIARCH (udp4_punt_node, udp4_punt);
217 VLIB_REGISTER_NODE (udp6_punt_node) = {
218 .function = udp6_punt,
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,
234 VLIB_NODE_FUNCTION_MULTIARCH (udp6_punt_node, udp6_punt);;
238 static punt_client_t *
239 punt_client_get (bool is_ip4, u16 port)
241 punt_main_t *pm = &punt_main;
243 is_ip4 ? pm->clients_by_dst_port4 : pm->clients_by_dst_port6;
245 u16 i = sparse_vec_index (v, port);
246 if (i == SPARSE_VEC_INVALID_INDEX)
249 return &vec_elt (v, i);
252 static struct sockaddr_un *
253 punt_socket_get (bool is_ip4, u16 port)
255 punt_client_t *v = punt_client_get (is_ip4, port);
263 punt_socket_register (bool is_ip4, u8 protocol, u16 port,
264 char *client_pathname)
266 punt_main_t *pm = &punt_main;
268 punt_client_t *v = is_ip4 ? pm->clients_by_dst_port4 :
269 pm->clients_by_dst_port6;
271 if (strncmp (client_pathname, vnet_punt_get_server_pathname (),
275 clib_memset (&c, 0, sizeof (c));
276 memcpy (c.caddr.sun_path, client_pathname, sizeof (c.caddr.sun_path));
277 c.caddr.sun_family = AF_UNIX;
279 c.protocol = protocol;
280 n = sparse_vec_validate (v, port);
285 /* $$$$ Just leaves the mapping in place for now */
287 punt_socket_unregister (bool is_ip4, u8 protocol, u16 port)
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_DATA_SIZE;
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);
641 vnet_punt_socket_add (vlib_main_t * vm, u32 header_version,
642 bool is_ip4, u8 protocol, u16 port,
643 char *client_pathname)
645 punt_main_t *pm = &punt_main;
647 if (!pm->is_configured)
648 return clib_error_return (0, "socket is not configured");
650 if (header_version != PUNT_PACKETDESC_VERSION)
651 return clib_error_return (0, "Invalid packet descriptor version");
653 /* For now we only support UDP punt */
654 if (protocol != IP_PROTOCOL_UDP)
655 return clib_error_return (0,
656 "only UDP protocol (%d) is supported, got %d",
657 IP_PROTOCOL_UDP, protocol);
659 if (port == (u16) ~ 0)
660 return clib_error_return (0, "UDP port number required");
662 /* Register client */
663 if (punt_socket_register (is_ip4, protocol, port, client_pathname) < 0)
664 return clib_error_return (0,
665 "Punt socket: Invalid client path: %s",
668 u32 node_index = is_ip4 ? udp4_punt_socket_node.index :
669 udp6_punt_socket_node.index;
671 udp_register_dst_port (vm, port, node_index, is_ip4);
677 vnet_punt_socket_del (vlib_main_t * vm, bool is_ip4, u8 l4_protocol, u16 port)
679 punt_main_t *pm = &punt_main;
681 if (!pm->is_configured)
682 return clib_error_return (0, "socket is not configured");
684 punt_socket_unregister (is_ip4, l4_protocol, port);
685 udp_unregister_dst_port (vm, port, is_ip4);
691 * @brief Request IP traffic punt to the local TCP/IP stack.
694 * - UDP and TCP are the only protocols supported in the current implementation
696 * @param vm vlib_main_t corresponding to the current thread
697 * @param ipv IP protcol version.
698 * 4 - IPv4, 6 - IPv6, ~0 for both IPv6 and IPv4
699 * @param protocol 8-bits L4 protocol value
702 * @param port 16-bits L4 (TCP/IP) port number when applicable (UDP only)
704 * @returns 0 on success, non-zero value otherwise
707 vnet_punt_add_del (vlib_main_t * vm, u8 ipv, u8 protocol, u16 port,
711 /* For now we only support TCP, UDP and SCTP punt */
712 if (protocol != IP_PROTOCOL_UDP &&
713 protocol != IP_PROTOCOL_TCP && protocol != IP_PROTOCOL_SCTP)
714 return clib_error_return (0,
715 "only UDP (%d), TCP (%d) and SCTP (%d) protocols are supported, got %d",
716 IP_PROTOCOL_UDP, IP_PROTOCOL_TCP,
717 IP_PROTOCOL_SCTP, protocol);
719 if (ipv != (u8) ~ 0 && ipv != 4 && ipv != 6)
720 return clib_error_return (0, "IP version must be 4 or 6, got %d", ipv);
722 if (port == (u16) ~ 0)
724 if ((ipv == 4) || (ipv == (u8) ~ 0))
726 if (protocol == IP_PROTOCOL_UDP)
727 udp_punt_unknown (vm, 1, is_add);
728 else if (protocol == IP_PROTOCOL_TCP)
729 tcp_punt_unknown (vm, 1, is_add);
730 else if (protocol == IP_PROTOCOL_SCTP)
731 sctp_punt_unknown (vm, 1, is_add);
734 if ((ipv == 6) || (ipv == (u8) ~ 0))
736 if (protocol == IP_PROTOCOL_UDP)
737 udp_punt_unknown (vm, 0, is_add);
738 else if (protocol == IP_PROTOCOL_TCP)
739 tcp_punt_unknown (vm, 0, is_add);
740 else if (protocol == IP_PROTOCOL_SCTP)
741 sctp_punt_unknown (vm, 0, is_add);
749 if (protocol == IP_PROTOCOL_TCP || protocol == IP_PROTOCOL_SCTP)
750 return clib_error_return (0,
751 "punt TCP/SCTP ports is not supported yet");
753 if (ipv == 4 || ipv == (u8) ~ 0)
754 udp_register_dst_port (vm, port, udp4_punt_node.index, 1);
756 if (ipv == 6 || ipv == (u8) ~ 0)
757 udp_register_dst_port (vm, port, udp6_punt_node.index, 0);
762 return clib_error_return (0, "punt delete is not supported yet");
765 static clib_error_t *
766 punt_cli (vlib_main_t * vm,
767 unformat_input_t * input, vlib_cli_command_t * cmd)
772 clib_error_t *error = NULL;
774 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
776 if (unformat (input, "del"))
778 else if (unformat (input, "all"))
780 else if (unformat (input, "%d", &port))
782 else if (unformat (input, "udp"))
783 protocol = IP_PROTOCOL_UDP;
784 else if (unformat (input, "tcp"))
785 protocol = IP_PROTOCOL_TCP;
788 error = clib_error_return (0, "parse error: '%U'",
789 format_unformat_error, input);
794 /* punt both IPv6 and IPv4 when used in CLI */
795 error = vnet_punt_add_del (vm, ~0, protocol, port, is_add);
798 clib_error_report (error);
807 * The set of '<em>set punt</em>' commands allows specific IP traffic to
808 * be punted to the host TCP/IP stack
811 * - UDP is the only protocol supported in the current implementation
812 * - All TCP traffic is currently punted to the host by default
816 * Example of how to request NTP traffic to be punted
817 * @cliexcmd{set punt udp 125}
819 * Example of how to request all 'unknown' UDP traffic to be punted
820 * @cliexcmd{set punt udp all}
822 * Example of how to stop all 'unknown' UDP traffic to be punted
823 * @cliexcmd{set punt udp del all}
827 VLIB_CLI_COMMAND (punt_command, static) = {
829 .short_help = "set punt [udp|tcp] [del] <all | port-num1 [port-num2 ...]>",
830 .function = punt_cli,
834 static clib_error_t *
835 punt_socket_register_cmd (vlib_main_t * vm,
836 unformat_input_t * input, vlib_cli_command_t * cmd)
842 clib_error_t *error = NULL;
844 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
846 if (unformat (input, "ipv4"))
848 else if (unformat (input, "ipv6"))
850 else if (unformat (input, "udp"))
851 protocol = IP_PROTOCOL_UDP;
852 else if (unformat (input, "tcp"))
853 protocol = IP_PROTOCOL_TCP;
854 else if (unformat (input, "%d", &port))
856 else if (unformat (input, "socket %s", &socket_name))
860 error = clib_error_return (0, "parse error: '%U'",
861 format_unformat_error, input);
867 vnet_punt_socket_add (vm, 1, is_ipv4, protocol, port,
868 (char *) socket_name);
880 * @cliexcmd{punt socket register}
883 VLIB_CLI_COMMAND (punt_socket_register_command, static) =
885 .path = "punt socket register",
886 .function = punt_socket_register_cmd,
887 .short_help = "punt socket register [ipv4|ipv6] [udp|tcp]> <all | port-num1 [port-num2 ...]> <socket>",
892 static clib_error_t *
893 punt_socket_deregister_cmd (vlib_main_t * vm,
894 unformat_input_t * input,
895 vlib_cli_command_t * cmd)
900 clib_error_t *error = NULL;
902 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
904 if (unformat (input, "ipv4"))
906 else if (unformat (input, "ipv6"))
908 else if (unformat (input, "udp"))
909 protocol = IP_PROTOCOL_UDP;
910 else if (unformat (input, "tcp"))
911 protocol = IP_PROTOCOL_TCP;
912 else if (unformat (input, "%d", &port))
916 error = clib_error_return (0, "parse error: '%U'",
917 format_unformat_error, input);
922 error = vnet_punt_socket_del (vm, is_ipv4, protocol, port);
934 * @cliexcmd{punt socket register}
937 VLIB_CLI_COMMAND (punt_socket_deregister_command, static) =
939 .path = "punt socket deregister",
940 .function = punt_socket_deregister_cmd,
941 .short_help = "punt socket deregister [ipv4|ipv6] [udp|tcp]> <all | port-num1 [port-num2 ...]>",
946 punt_socket_detail_t *
947 punt_socket_entries (u8 ipv)
949 punt_main_t *pm = &punt_main;
951 punt_socket_detail_t *ps = 0;
954 punt_client_t *v = !ipv ? pm->clients_by_dst_port4 :
955 pm->clients_by_dst_port6;
959 if (pc && pc->port != 0)
962 if (pc->protocol == IP_PROTOCOL_UDP)
964 is_valid = udp_is_valid_dst_port (pc->port, !ipv);
968 punt_socket_detail_t detail = {
970 .l4_protocol = pc->protocol,
973 memcpy (detail.pathname, pc->caddr.sun_path,
974 sizeof (pc->caddr.sun_path));
975 vec_add1 (ps, detail);
983 format_punt_socket (u8 * s, va_list * args)
985 punt_client_t *clients = va_arg (*args, punt_client_t *);
986 u8 *is_ipv6 = va_arg (*args, u8 *);
990 vec_foreach (pc, clients)
992 if (pc && pc->port != 0)
995 if (pc->protocol == IP_PROTOCOL_UDP)
997 is_valid = udp_is_valid_dst_port (pc->port, !(*is_ipv6));
1001 s = format (s, " punt %s port %d to socket %s \n",
1002 (pc->protocol == IP_PROTOCOL_UDP) ? "UDP" : "TCP",
1003 pc->port, pc->caddr.sun_path);
1011 static clib_error_t *
1012 punt_socket_show_cmd (vlib_main_t * vm,
1013 unformat_input_t * input, vlib_cli_command_t * cmd)
1016 punt_main_t *pm = &punt_main;
1017 clib_error_t *error = NULL;
1019 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1021 if (unformat (input, "ipv4"))
1023 else if (unformat (input, "ipv6"))
1027 error = clib_error_return (0, "parse error: '%U'",
1028 format_unformat_error, input);
1034 is_ipv6 ? pm->clients_by_dst_port6 : pm->clients_by_dst_port4;
1035 vlib_cli_output (vm, "%U", format_punt_socket, v, &is_ipv6);
1044 * @cliexcmd{show punt socket ipv4}
1047 VLIB_CLI_COMMAND (show_punt_socket_registration_command, static) =
1049 .path = "show punt socket registrations",
1050 .function = punt_socket_show_cmd,
1051 .short_help = "show punt socket registrations [ipv4|ipv6]",
1057 punt_init (vlib_main_t * vm)
1059 punt_main_t *pm = &punt_main;
1061 pm->clients_by_dst_port6 = sparse_vec_new
1062 (sizeof (pm->clients_by_dst_port6[0]),
1063 BITS (((udp_header_t *) 0)->dst_port));
1064 pm->clients_by_dst_port4 = sparse_vec_new
1065 (sizeof (pm->clients_by_dst_port4[0]),
1066 BITS (((udp_header_t *) 0)->dst_port));
1068 pm->is_configured = false;
1069 pm->interface_output_node = vlib_get_node_by_name (vm,
1071 "interface-output");
1075 VLIB_INIT_FUNCTION (punt_init);
1077 static clib_error_t *
1078 punt_config (vlib_main_t * vm, unformat_input_t * input)
1080 punt_main_t *pm = &punt_main;
1081 char *socket_path = 0;
1083 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1085 if (unformat (input, "socket %s", &socket_path))
1086 strncpy (pm->sun_path, socket_path, UNIX_PATH_MAX - 1);
1088 return clib_error_return (0, "unknown input `%U'",
1089 format_unformat_error, input);
1092 if (socket_path == 0)
1095 /* UNIX domain socket */
1096 struct sockaddr_un addr;
1097 if ((pm->socket_fd = socket (AF_UNIX, SOCK_DGRAM | SOCK_NONBLOCK, 0)) == -1)
1099 return clib_error_return (0, "socket error");
1102 clib_memset (&addr, 0, sizeof (addr));
1103 addr.sun_family = AF_UNIX;
1104 if (*socket_path == '\0')
1106 *addr.sun_path = '\0';
1107 strncpy (addr.sun_path + 1, socket_path + 1,
1108 sizeof (addr.sun_path) - 2);
1112 strncpy (addr.sun_path, socket_path, sizeof (addr.sun_path) - 1);
1113 unlink (socket_path);
1116 if (bind (pm->socket_fd, (struct sockaddr *) &addr, sizeof (addr)) == -1)
1118 return clib_error_return (0, "bind error");
1121 /* Register socket */
1122 clib_file_main_t *fm = &file_main;
1123 clib_file_t template = { 0 };
1124 template.read_function = punt_socket_read_ready;
1125 template.file_descriptor = pm->socket_fd;
1126 template.description = format (0, "%s", socket_path);
1127 pm->clib_file_index = clib_file_add (fm, &template);
1129 pm->is_configured = true;
1134 VLIB_CONFIG_FUNCTION (punt_config, "punt");
1137 * fd.io coding-style-patch-verification: ON
1140 * eval: (c-set-style "gnu")