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/ip/punt.h>
31 #include <vlib/unix/unix.h>
35 #include <sys/socket.h>
39 punt_main_t punt_main;
42 vnet_punt_get_server_pathname (void)
44 punt_main_t *pm = &punt_main;
49 punt_client_l4_db_add (ip_address_family_t af, u16 port, u32 index)
51 punt_main_t *pm = &punt_main;
53 pm->db.clients_by_l4_port = hash_set (pm->db.clients_by_l4_port,
54 punt_client_l4_mk_key (af, port),
59 punt_client_l4_db_remove (ip_address_family_t af, u16 port)
61 punt_main_t *pm = &punt_main;
65 key = punt_client_l4_mk_key (af, port);
66 p = hash_get (pm->db.clients_by_l4_port, key);
71 hash_unset (pm->db.clients_by_l4_port, key);
77 punt_client_ip_proto_db_add (ip_address_family_t af,
78 ip_protocol_t proto, u32 index)
80 punt_main_t *pm = &punt_main;
82 pm->db.clients_by_ip_proto = hash_set (pm->db.clients_by_ip_proto,
83 punt_client_ip_proto_mk_key (af,
89 punt_client_ip_proto_db_remove (ip_address_family_t af, ip_protocol_t proto)
91 punt_main_t *pm = &punt_main;
95 key = punt_client_ip_proto_mk_key (af, proto);
96 p = hash_get (pm->db.clients_by_ip_proto, key);
101 hash_unset (pm->db.clients_by_ip_proto, key);
107 punt_client_exception_db_add (vlib_punt_reason_t reason, u32 pci)
109 punt_main_t *pm = &punt_main;
111 vec_validate_init_empty (pm->db.clients_by_exception, reason, ~0);
113 pm->db.clients_by_exception[reason] = pci;
117 punt_client_exception_db_remove (vlib_punt_reason_t reason)
119 punt_main_t *pm = &punt_main;
122 if (punt_client_exception_get (reason))
124 pci = pm->db.clients_by_exception[reason];
125 pm->db.clients_by_exception[reason] = ~0;
131 static clib_error_t *
132 punt_socket_read_ready (clib_file_t * uf)
134 vlib_main_t *vm = vlib_get_main ();
135 punt_main_t *pm = &punt_main;
137 /** Schedule the rx node */
138 vlib_node_set_interrupt_pending (vm, punt_socket_rx_node.index);
139 vec_add1 (pm->ready_fds, uf->file_descriptor);
144 static clib_error_t *
145 punt_socket_register_l4 (vlib_main_t * vm,
146 ip_address_family_t af,
147 u8 protocol, u16 port, char *client_pathname)
149 punt_main_t *pm = &punt_main;
152 /* For now we only support UDP punt */
153 if (protocol != IP_PROTOCOL_UDP)
154 return clib_error_return (0,
155 "only UDP protocol (%d) is supported, got %d",
156 IP_PROTOCOL_UDP, protocol);
158 if (port == (u16) ~ 0)
159 return clib_error_return (0, "UDP port number required");
161 c = punt_client_l4_get (af, port);
165 pool_get_zero (pm->punt_client_pool, c);
166 punt_client_l4_db_add (af, port, c - pm->punt_client_pool);
169 memcpy (c->caddr.sun_path, client_pathname, sizeof (c->caddr.sun_path));
170 c->caddr.sun_family = AF_UNIX;
171 c->reg.type = PUNT_TYPE_L4;
172 c->reg.punt.l4.port = port;
173 c->reg.punt.l4.protocol = protocol;
174 c->reg.punt.l4.af = af;
176 u32 node_index = (af == AF_IP4 ?
177 udp4_punt_socket_node.index :
178 udp6_punt_socket_node.index);
180 udp_register_dst_port (vm, port, node_index, af == AF_IP4);
185 static clib_error_t *
186 punt_socket_register_ip_proto (vlib_main_t * vm,
187 ip_address_family_t af,
188 ip_protocol_t proto, char *client_pathname)
190 punt_main_t *pm = &punt_main;
193 c = punt_client_ip_proto_get (af, proto);
197 pool_get_zero (pm->punt_client_pool, c);
198 punt_client_ip_proto_db_add (af, proto, c - pm->punt_client_pool);
201 memcpy (c->caddr.sun_path, client_pathname, sizeof (c->caddr.sun_path));
202 c->caddr.sun_family = AF_UNIX;
203 c->reg.type = PUNT_TYPE_IP_PROTO;
204 c->reg.punt.ip_proto.protocol = proto;
205 c->reg.punt.ip_proto.af = af;
208 ip4_register_protocol (proto, ip4_proto_punt_socket_node.index);
210 ip6_register_protocol (proto, ip6_proto_punt_socket_node.index);
215 static clib_error_t *
216 punt_socket_register_exception (vlib_main_t * vm,
217 vlib_punt_reason_t reason,
218 char *client_pathname)
220 punt_main_t *pm = &punt_main;
223 pc = punt_client_exception_get (reason);
227 pool_get_zero (pm->punt_client_pool, pc);
228 punt_client_exception_db_add (reason, pc - pm->punt_client_pool);
231 memcpy (pc->caddr.sun_path, client_pathname, sizeof (pc->caddr.sun_path));
232 pc->caddr.sun_family = AF_UNIX;
233 pc->reg.type = PUNT_TYPE_EXCEPTION;
234 pc->reg.punt.exception.reason = reason;
236 vlib_punt_register (pm->hdl,
237 pc->reg.punt.exception.reason, "exception-punt-socket");
242 static clib_error_t *
243 punt_socket_unregister_l4 (ip_address_family_t af,
244 ip_protocol_t protocol, u16 port)
248 udp_unregister_dst_port (vlib_get_main (), port, af == AF_IP4);
250 pci = punt_client_l4_db_remove (af, port);
253 pool_put_index (punt_main.punt_client_pool, pci);
258 static clib_error_t *
259 punt_socket_unregister_ip_proto (ip_address_family_t af, ip_protocol_t proto)
264 ip4_unregister_protocol (proto);
266 ip6_unregister_protocol (proto);
268 pci = punt_client_ip_proto_db_remove (af, proto);
271 pool_put_index (punt_main.punt_client_pool, pci);
276 static clib_error_t *
277 punt_socket_unregister_exception (vlib_punt_reason_t reason)
281 pci = punt_client_exception_db_remove (reason);
284 pool_put_index (punt_main.punt_client_pool, pci);
290 vnet_punt_socket_add (vlib_main_t * vm, u32 header_version,
291 const punt_reg_t * pr, char *client_pathname)
293 punt_main_t *pm = &punt_main;
295 if (!pm->is_configured)
296 return clib_error_return (0, "socket is not configured");
298 if (header_version != PUNT_PACKETDESC_VERSION)
299 return clib_error_return (0, "Invalid packet descriptor version");
301 if (strncmp (client_pathname, vnet_punt_get_server_pathname (),
303 return clib_error_return (0,
304 "Punt socket: Invalid client path: %s",
307 /* Register client */
311 return (punt_socket_register_l4 (vm,
313 pr->punt.l4.protocol,
314 pr->punt.l4.port, client_pathname));
315 case PUNT_TYPE_IP_PROTO:
316 return (punt_socket_register_ip_proto (vm,
317 pr->punt.ip_proto.af,
318 pr->punt.ip_proto.protocol,
320 case PUNT_TYPE_EXCEPTION:
321 return (punt_socket_register_exception (vm,
322 pr->punt.exception.reason,
330 vnet_punt_socket_del (vlib_main_t * vm, const punt_reg_t * pr)
332 punt_main_t *pm = &punt_main;
334 if (!pm->is_configured)
335 return clib_error_return (0, "socket is not configured");
340 return (punt_socket_unregister_l4 (pr->punt.l4.af,
341 pr->punt.l4.protocol,
343 case PUNT_TYPE_IP_PROTO:
344 return (punt_socket_unregister_ip_proto (pr->punt.ip_proto.af,
345 pr->punt.ip_proto.protocol));
346 case PUNT_TYPE_EXCEPTION:
347 return (punt_socket_unregister_exception (pr->punt.exception.reason));
354 * @brief Request IP traffic punt to the local TCP/IP stack.
357 * - UDP and TCP are the only protocols supported in the current implementation
359 * @param vm vlib_main_t corresponding to the current thread
360 * @param af IP address family.
361 * @param protocol 8-bits L4 protocol value
364 * @param port 16-bits L4 (TCP/IP) port number when applicable (UDP only)
366 * @returns 0 on success, non-zero value otherwise
368 static clib_error_t *
369 punt_l4_add_del (vlib_main_t * vm,
370 ip_address_family_t af,
371 ip_protocol_t protocol, u16 port, bool is_add)
373 /* For now we only support TCP and UDP punt */
374 if (protocol != IP_PROTOCOL_UDP && protocol != IP_PROTOCOL_TCP)
375 return clib_error_return (0,
376 "only UDP (%d) and TCP (%d) protocols are supported, got %d",
377 IP_PROTOCOL_UDP, IP_PROTOCOL_TCP, protocol);
379 if (port == (u16) ~ 0)
381 if (protocol == IP_PROTOCOL_UDP)
382 udp_punt_unknown (vm, af == AF_IP4, is_add);
383 else if (protocol == IP_PROTOCOL_TCP)
384 tcp_punt_unknown (vm, af == AF_IP4, is_add);
391 if (protocol == IP_PROTOCOL_TCP)
392 return clib_error_return (0, "punt TCP ports is not supported yet");
394 udp_register_dst_port (vm, port, udp4_punt_node.index, af == AF_IP4);
400 if (protocol == IP_PROTOCOL_TCP)
401 return clib_error_return (0, "punt TCP ports is not supported yet");
403 udp_unregister_dst_port (vm, port, af == AF_IP4);
410 vnet_punt_add_del (vlib_main_t * vm, const punt_reg_t * pr, bool is_add)
415 return (punt_l4_add_del (vm, pr->punt.l4.af, pr->punt.l4.protocol,
416 pr->punt.l4.port, is_add));
417 case PUNT_TYPE_EXCEPTION:
418 case PUNT_TYPE_IP_PROTO:
422 return (clib_error_return (0, "Unsupported punt type: %d", pr->type));
425 static clib_error_t *
426 punt_cli (vlib_main_t * vm,
427 unformat_input_t * input, vlib_cli_command_t * cmd)
429 clib_error_t *error = NULL;
440 .type = PUNT_TYPE_L4,
445 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
447 if (unformat (input, "del"))
449 else if (unformat (input, "ipv6"))
450 pr.punt.l4.af = AF_IP6;
451 else if (unformat (input, "ip6"))
452 pr.punt.l4.af = AF_IP6;
453 else if (unformat (input, "%d", &port))
454 pr.punt.l4.port = port;
455 else if (unformat (input, "udp"))
456 pr.punt.l4.protocol = IP_PROTOCOL_UDP;
457 else if (unformat (input, "tcp"))
458 pr.punt.l4.protocol = IP_PROTOCOL_TCP;
461 error = clib_error_return (0, "parse error: '%U'",
462 format_unformat_error, input);
467 /* punt both IPv6 and IPv4 when used in CLI */
468 error = vnet_punt_add_del (vm, &pr, is_add);
471 clib_error_report (error);
479 * The set of '<em>set punt</em>' commands allows specific IP traffic to
480 * be punted to the host TCP/IP stack
483 * - UDP is the only protocol supported in the current implementation
484 * - All TCP traffic is currently punted to the host by default
488 * Example of how to request NTP traffic to be punted
489 * @cliexcmd{set punt udp 125}
491 * Example of how to request all 'unknown' UDP traffic to be punted
492 * @cliexcmd{set punt udp all}
494 * Example of how to stop all 'unknown' UDP traffic to be punted
495 * @cliexcmd{set punt udp del all}
499 VLIB_CLI_COMMAND (punt_command, static) = {
501 .short_help = "set punt [udp|tcp] [del] <all | port-num1 [port-num2 ...]>",
502 .function = punt_cli,
506 static clib_error_t *
507 punt_socket_register_cmd (vlib_main_t * vm,
508 unformat_input_t * input, vlib_cli_command_t * cmd)
511 clib_error_t *error = NULL;
521 .type = PUNT_TYPE_L4,
525 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
527 if (unformat (input, "ipv4"))
529 else if (unformat (input, "ipv6"))
530 pr.punt.l4.af = AF_IP6;
531 else if (unformat (input, "udp"))
532 pr.punt.l4.protocol = IP_PROTOCOL_UDP;
533 else if (unformat (input, "tcp"))
534 pr.punt.l4.protocol = IP_PROTOCOL_TCP;
535 else if (unformat (input, "%d", &pr.punt.l4.port))
537 else if (unformat (input, "socket %s", &socket_name))
541 error = clib_error_return (0, "parse error: '%U'",
542 format_unformat_error, input);
548 error = clib_error_return (0, "socket name not specified");
550 error = vnet_punt_socket_add (vm, 1, &pr, (char *) socket_name);
559 * @cliexcmd{punt socket register}
562 VLIB_CLI_COMMAND (punt_socket_register_command, static) =
564 .path = "punt socket register",
565 .function = punt_socket_register_cmd,
566 .short_help = "punt socket register [ipv4|ipv6] [udp|tcp]> <all | port-num1 [port-num2 ...]> <socket>",
571 static clib_error_t *
572 punt_socket_deregister_cmd (vlib_main_t * vm,
573 unformat_input_t * input,
574 vlib_cli_command_t * cmd)
576 clib_error_t *error = NULL;
586 .type = PUNT_TYPE_L4,
590 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
592 if (unformat (input, "ipv4"))
594 else if (unformat (input, "ipv6"))
595 pr.punt.l4.af = AF_IP6;
596 else if (unformat (input, "udp"))
597 pr.punt.l4.protocol = IP_PROTOCOL_UDP;
598 else if (unformat (input, "tcp"))
599 pr.punt.l4.protocol = IP_PROTOCOL_TCP;
600 else if (unformat (input, "%d", &pr.punt.l4.port))
604 error = clib_error_return (0, "parse error: '%U'",
605 format_unformat_error, input);
610 error = vnet_punt_socket_del (vm, &pr);
618 * @cliexcmd{punt socket register}
621 VLIB_CLI_COMMAND (punt_socket_deregister_command, static) =
623 .path = "punt socket deregister",
624 .function = punt_socket_deregister_cmd,
625 .short_help = "punt socket deregister [ipv4|ipv6] [udp|tcp]> <all | port-num1 [port-num2 ...]>",
631 punt_client_walk (punt_type_t pt, punt_client_walk_cb_t cb, void *ctx)
633 punt_main_t *pm = &punt_main;
642 hash_foreach(key, pci, pm->db.clients_by_l4_port,
644 cb (pool_elt_at_index(pm->punt_client_pool, pci), ctx);
649 case PUNT_TYPE_IP_PROTO:
654 hash_foreach(key, pci, pm->db.clients_by_ip_proto,
656 cb (pool_elt_at_index(pm->punt_client_pool, pci), ctx);
661 case PUNT_TYPE_EXCEPTION:
665 vec_foreach (pci, pm->db.clients_by_exception)
668 cb (pool_elt_at_index (pm->punt_client_pool, *pci), ctx);
677 format_punt_client (u8 * s, va_list * args)
679 punt_client_t *pc = va_arg (*args, punt_client_t *);
681 s = format (s, " punt ");
683 switch (pc->reg.type)
686 s = format (s, "%U %U port %d",
687 format_ip_address_family, pc->reg.punt.l4.af,
688 format_ip_protocol, pc->reg.punt.l4.protocol,
689 pc->reg.punt.l4.port);
691 case PUNT_TYPE_IP_PROTO:
692 s = format (s, "%U %U",
693 format_ip_address_family, pc->reg.punt.ip_proto.af,
694 format_ip_protocol, pc->reg.punt.ip_proto.protocol);
696 case PUNT_TYPE_EXCEPTION:
697 s = format (s, " %U", format_vlib_punt_reason,
698 pc->reg.punt.exception.reason);
702 s = format (s, " to socket %s \n", pc->caddr.sun_path);
708 punt_client_show_one (const punt_client_t * pc, void *ctx)
710 vlib_cli_output (ctx, "%U", format_punt_client, pc);
712 return (WALK_CONTINUE);
715 static clib_error_t *
716 punt_socket_show_cmd (vlib_main_t * vm,
717 unformat_input_t * input, vlib_cli_command_t * cmd)
719 clib_error_t *error = NULL;
724 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
726 if (unformat (input, "exception"))
727 pt = PUNT_TYPE_EXCEPTION;
728 else if (unformat (input, "l4"))
730 else if (unformat (input, "ip"))
731 pt = PUNT_TYPE_IP_PROTO;
734 error = clib_error_return (0, "parse error: '%U'",
735 format_unformat_error, input);
740 punt_client_walk (pt, punt_client_show_one, vm);
749 * @cliexcmd{show punt socket ipv4}
752 VLIB_CLI_COMMAND (show_punt_socket_registration_command, static) =
754 .path = "show punt socket registrations",
755 .function = punt_socket_show_cmd,
756 .short_help = "show punt socket registrations [l4|exception]",
762 ip_punt_init (vlib_main_t * vm)
764 clib_error_t *error = NULL;
765 punt_main_t *pm = &punt_main;
766 vlib_thread_main_t *tm = vlib_get_thread_main ();
768 pm->is_configured = false;
769 pm->interface_output_node =
770 vlib_get_node_by_name (vm, (u8 *) "interface-output");
772 if ((error = vlib_call_init_function (vm, punt_init)))
775 pm->hdl = vlib_punt_client_register ("ip-punt");
777 vec_validate_aligned (pm->thread_data, tm->n_vlib_mains,
778 CLIB_CACHE_LINE_BYTES);
783 VLIB_INIT_FUNCTION (ip_punt_init);
785 static clib_error_t *
786 punt_config (vlib_main_t * vm, unformat_input_t * input)
788 punt_main_t *pm = &punt_main;
789 char *socket_path = 0;
791 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
793 if (unformat (input, "socket %s", &socket_path))
794 strncpy (pm->sun_path, socket_path, UNIX_PATH_MAX - 1);
796 return clib_error_return (0, "unknown input `%U'",
797 format_unformat_error, input);
800 if (socket_path == 0)
803 /* UNIX domain socket */
804 struct sockaddr_un addr;
805 if ((pm->socket_fd = socket (AF_UNIX, SOCK_DGRAM | SOCK_NONBLOCK, 0)) == -1)
807 return clib_error_return (0, "socket error");
810 clib_memset (&addr, 0, sizeof (addr));
811 addr.sun_family = AF_UNIX;
812 if (*socket_path == '\0')
814 *addr.sun_path = '\0';
815 strncpy (addr.sun_path + 1, socket_path + 1,
816 sizeof (addr.sun_path) - 2);
820 strncpy (addr.sun_path, socket_path, sizeof (addr.sun_path) - 1);
821 unlink (socket_path);
824 if (bind (pm->socket_fd, (struct sockaddr *) &addr, sizeof (addr)) == -1)
826 return clib_error_return (0, "bind error");
829 int n_bytes = 0x10000;
832 (pm->socket_fd, SOL_SOCKET, SO_SNDBUF, &n_bytes,
833 sizeof (n_bytes)) == -1)
835 return clib_error_return (0, "setsockopt error");
838 /* Register socket */
839 clib_file_main_t *fm = &file_main;
840 clib_file_t template = { 0 };
841 template.read_function = punt_socket_read_ready;
842 template.file_descriptor = pm->socket_fd;
843 template.description = format (0, "%s", socket_path);
844 pm->clib_file_index = clib_file_add (fm, &template);
846 pm->is_configured = true;
851 VLIB_CONFIG_FUNCTION (punt_config, "punt");
854 * fd.io coding-style-patch-verification: ON
857 * eval: (c-set-style "gnu")