src/vnet/ip/punt.c

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 /**
  17  * @file
  18  * @brief Local TCP/IP stack punt infrastructure.
  19  *
  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
  23  */
  24
  25 #include <vnet/ip/ip.h>
  26 #include <vlib/vlib.h>
  27 #include <vnet/udp/udp.h>
  28 #include <vnet/tcp/tcp.h>
  29 #include <vnet/ip/punt.h>
  30 #include <vlib/unix/unix.h>
  31
  32 #include <stdio.h>
  33 #include <unistd.h>
  34 #include <sys/socket.h>
  35 #include <sys/uio.h>
  36 #include <stdlib.h>
  37
  38 punt_main_t punt_main;
  39
  40 char *
  41 vnet_punt_get_server_pathname (void)
  42 {
  43   punt_main_t *pm = &punt_main;
  44   return pm->sun_path;
  45 }
  46
  47 static void
  48 punt_client_l4_db_add (ip_address_family_t af, u16 port, u32 index)
  49 {
  50   punt_main_t *pm = &punt_main;
  51
  52   pm->db.clients_by_l4_port = hash_set (pm->db.clients_by_l4_port,
  53                                         punt_client_l4_mk_key (af, port),
  54                                         index);
  55 }
  56
  57 static u32
  58 punt_client_l4_db_remove (ip_address_family_t af, u16 port)
  59 {
  60   punt_main_t *pm = &punt_main;
  61   u32 key, index = ~0;
  62   uword *p;
  63
  64   key = punt_client_l4_mk_key (af, port);
  65   p = hash_get (pm->db.clients_by_l4_port, key);
  66
  67   if (p)
  68     index = p[0];
  69
  70   hash_unset (pm->db.clients_by_l4_port, key);
  71
  72   return (index);
  73 }
  74
  75 static void
  76 punt_client_ip_proto_db_add (ip_address_family_t af,
  77                              ip_protocol_t proto, u32 index)
  78 {
  79   punt_main_t *pm = &punt_main;
  80
  81   pm->db.clients_by_ip_proto = hash_set (pm->db.clients_by_ip_proto,
  82                                          punt_client_ip_proto_mk_key (af,
  83                                                                       proto),
  84                                          index);
  85 }
  86
  87 static u32
  88 punt_client_ip_proto_db_remove (ip_address_family_t af, ip_protocol_t proto)
  89 {
  90   punt_main_t *pm = &punt_main;
  91   u32 key, index = ~0;
  92   uword *p;
  93
  94   key = punt_client_ip_proto_mk_key (af, proto);
  95   p = hash_get (pm->db.clients_by_ip_proto, key);
  96
  97   if (p)
  98     index = p[0];
  99
 100   hash_unset (pm->db.clients_by_ip_proto, key);
 101
 102   return (index);
 103 }
 104
 105 static void
 106 punt_client_exception_db_add (vlib_punt_reason_t reason, u32 pci)
 107 {
 108   punt_main_t *pm = &punt_main;
 109
 110   vec_validate_init_empty (pm->db.clients_by_exception, reason, ~0);
 111
 112   pm->db.clients_by_exception[reason] = pci;
 113 }
 114
 115 static u32
 116 punt_client_exception_db_remove (vlib_punt_reason_t reason)
 117 {
 118   punt_main_t *pm = &punt_main;
 119   u32 pci = ~0;
 120
 121   if (punt_client_exception_get (reason))
 122     {
 123       pci = pm->db.clients_by_exception[reason];
 124       pm->db.clients_by_exception[reason] = ~0;
 125     }
 126
 127   return pci;
 128 }
 129
 130 static clib_error_t *
 131 punt_socket_read_ready (clib_file_t * uf)
 132 {
 133   vlib_main_t *vm = vlib_get_main ();
 134   punt_main_t *pm = &punt_main;
 135
 136   /** Schedule the rx node */
 137   vlib_node_set_interrupt_pending (vm, punt_socket_rx_node.index);
 138   vec_add1 (pm->ready_fds, uf->file_descriptor);
 139
 140   return 0;
 141 }
 142
 143 static clib_error_t *
 144 punt_socket_register_l4 (vlib_main_t * vm,
 145                          ip_address_family_t af,
 146                          u8 protocol, u16 port, char *client_pathname)
 147 {
 148   punt_main_t *pm = &punt_main;
 149   punt_client_t *c;
 150
 151   /* For now we only support UDP punt */
 152   if (protocol != IP_PROTOCOL_UDP)
 153     return clib_error_return (0,
 154                               "only UDP protocol (%d) is supported, got %d",
 155                               IP_PROTOCOL_UDP, protocol);
 156
 157   if (port == (u16) ~ 0)
 158     return clib_error_return (0, "UDP port number required");
 159
 160   c = punt_client_l4_get (af, port);
 161
 162   if (NULL == c)
 163     {
 164       pool_get_zero (pm->punt_client_pool, c);
 165       punt_client_l4_db_add (af, port, c - pm->punt_client_pool);
 166     }
 167
 168   memcpy (c->caddr.sun_path, client_pathname, sizeof (c->caddr.sun_path));
 169   c->caddr.sun_family = AF_UNIX;
 170   c->reg.type = PUNT_TYPE_L4;
 171   c->reg.punt.l4.port = port;
 172   c->reg.punt.l4.protocol = protocol;
 173   c->reg.punt.l4.af = af;
 174
 175   u32 node_index = (af == AF_IP4 ?
 176                     udp4_punt_socket_node.index :
 177                     udp6_punt_socket_node.index);
 178
 179   udp_register_dst_port (vm, port, node_index, af == AF_IP4);
 180
 181   return (NULL);
 182 }
 183
 184 static clib_error_t *
 185 punt_socket_register_ip_proto (vlib_main_t * vm,
 186                                ip_address_family_t af,
 187                                ip_protocol_t proto, char *client_pathname)
 188 {
 189   punt_main_t *pm = &punt_main;
 190   punt_client_t *c;
 191
 192   c = punt_client_ip_proto_get (af, proto);
 193
 194   if (NULL == c)
 195     {
 196       pool_get_zero (pm->punt_client_pool, c);
 197       punt_client_ip_proto_db_add (af, proto, c - pm->punt_client_pool);
 198     }
 199
 200   memcpy (c->caddr.sun_path, client_pathname, sizeof (c->caddr.sun_path));
 201   c->caddr.sun_family = AF_UNIX;
 202   c->reg.type = PUNT_TYPE_IP_PROTO;
 203   c->reg.punt.ip_proto.protocol = proto;
 204   c->reg.punt.ip_proto.af = af;
 205
 206   if (af == AF_IP4)
 207     ip4_register_protocol (proto, ip4_proto_punt_socket_node.index);
 208   else
 209     ip6_register_protocol (proto, ip6_proto_punt_socket_node.index);
 210
 211   return (NULL);
 212 }
 213
 214 static clib_error_t *
 215 punt_socket_register_exception (vlib_main_t * vm,
 216                                 vlib_punt_reason_t reason,
 217                                 char *client_pathname)
 218 {
 219   punt_main_t *pm = &punt_main;
 220   punt_client_t *pc;
 221
 222   pc = punt_client_exception_get (reason);
 223
 224   if (NULL == pc)
 225     {
 226       pool_get_zero (pm->punt_client_pool, pc);
 227       punt_client_exception_db_add (reason, pc - pm->punt_client_pool);
 228     }
 229
 230   memcpy (pc->caddr.sun_path, client_pathname, sizeof (pc->caddr.sun_path));
 231   pc->caddr.sun_family = AF_UNIX;
 232   pc->reg.type = PUNT_TYPE_EXCEPTION;
 233   pc->reg.punt.exception.reason = reason;
 234
 235   vlib_punt_register (pm->hdl,
 236                       pc->reg.punt.exception.reason, "exception-punt-socket");
 237
 238   return (NULL);
 239 }
 240
 241 static clib_error_t *
 242 punt_socket_unregister_l4 (ip_address_family_t af,
 243                            ip_protocol_t protocol, u16 port)
 244 {
 245   u32 pci;
 246
 247   udp_unregister_dst_port (vlib_get_main (), port, af == AF_IP4);
 248
 249   pci = punt_client_l4_db_remove (af, port);
 250
 251   if (~0 != pci)
 252     pool_put_index (punt_main.punt_client_pool, pci);
 253
 254   return (NULL);
 255 }
 256
 257 static clib_error_t *
 258 punt_socket_unregister_ip_proto (ip_address_family_t af, ip_protocol_t proto)
 259 {
 260   u32 pci;
 261
 262   if (af == AF_IP4)
 263     ip4_unregister_protocol (proto);
 264   else
 265     ip6_unregister_protocol (proto);
 266
 267   pci = punt_client_ip_proto_db_remove (af, proto);
 268
 269   if (~0 != pci)
 270     pool_put_index (punt_main.punt_client_pool, pci);
 271
 272   return (NULL);
 273 }
 274
 275 static clib_error_t *
 276 punt_socket_unregister_exception (vlib_punt_reason_t reason)
 277 {
 278   u32 pci;
 279
 280   pci = punt_client_exception_db_remove (reason);
 281
 282   if (~0 != pci)
 283     pool_put_index (punt_main.punt_client_pool, pci);
 284
 285   return (NULL);
 286 }
 287
 288 clib_error_t *
 289 vnet_punt_socket_add (vlib_main_t * vm, u32 header_version,
 290                       const punt_reg_t * pr, char *client_pathname)
 291 {
 292   punt_main_t *pm = &punt_main;
 293
 294   if (!pm->is_configured)
 295     return clib_error_return (0, "socket is not configured");
 296
 297   if (header_version != PUNT_PACKETDESC_VERSION)
 298     return clib_error_return (0, "Invalid packet descriptor version");
 299
 300   if (strncmp (client_pathname, vnet_punt_get_server_pathname (),
 301                UNIX_PATH_MAX) == 0)
 302     return clib_error_return (0,
 303                               "Punt socket: Invalid client path: %s",
 304                               client_pathname);
 305
 306   /* Register client */
 307   switch (pr->type)
 308     {
 309     case PUNT_TYPE_L4:
 310       return (punt_socket_register_l4 (vm,
 311                                        pr->punt.l4.af,
 312                                        pr->punt.l4.protocol,
 313                                        pr->punt.l4.port, client_pathname));
 314     case PUNT_TYPE_IP_PROTO:
 315       return (punt_socket_register_ip_proto (vm,
 316                                              pr->punt.ip_proto.af,
 317                                              pr->punt.ip_proto.protocol,
 318                                              client_pathname));
 319     case PUNT_TYPE_EXCEPTION:
 320       return (punt_socket_register_exception (vm,
 321                                               pr->punt.exception.reason,
 322                                               client_pathname));
 323     }
 324
 325   return 0;
 326 }
 327
 328 clib_error_t *
 329 vnet_punt_socket_del (vlib_main_t * vm, const punt_reg_t * pr)
 330 {
 331   punt_main_t *pm = &punt_main;
 332
 333   if (!pm->is_configured)
 334     return clib_error_return (0, "socket is not configured");
 335
 336   switch (pr->type)
 337     {
 338     case PUNT_TYPE_L4:
 339       return (punt_socket_unregister_l4 (pr->punt.l4.af,
 340                                          pr->punt.l4.protocol,
 341                                          pr->punt.l4.port));
 342     case PUNT_TYPE_IP_PROTO:
 343       return (punt_socket_unregister_ip_proto (pr->punt.ip_proto.af,
 344                                                pr->punt.ip_proto.protocol));
 345     case PUNT_TYPE_EXCEPTION:
 346       return (punt_socket_unregister_exception (pr->punt.exception.reason));
 347     }
 348
 349   return 0;
 350 }
 351
 352 /**
 353  * @brief Request IP L4 traffic punt to the local TCP/IP stack.
 354  *
 355  * @em Note
 356  * - UDP is the only protocol supported in the current implementation
 357  *
 358  * @param vm       vlib_main_t corresponding to the current thread
 359  * @param af       IP address family.
 360  * @param protocol 8-bits L4 protocol value
 361  *                 UDP is 17
 362  *                 TCP is 1
 363  * @param port     16-bits L4 (TCP/IP) port number when applicable (UDP only)
 364  *
 365  * @returns 0 on success, non-zero value otherwise
 366  */
 367 static clib_error_t *
 368 punt_l4_add_del (vlib_main_t * vm,
 369                  ip_address_family_t af,
 370                  ip_protocol_t protocol, u16 port, bool is_add)
 371 {
 372   /* For now we only support TCP and UDP punt */
 373   if (protocol != IP_PROTOCOL_UDP && protocol != IP_PROTOCOL_TCP)
 374     return clib_error_return (0,
 375                               "only UDP (%d) and TCP (%d) protocols are supported, got %d",
 376                               IP_PROTOCOL_UDP, IP_PROTOCOL_TCP, protocol);
 377
 378   if (port == (u16) ~ 0)
 379     {
 380       if (protocol == IP_PROTOCOL_UDP)
 381         udp_punt_unknown (vm, af == AF_IP4, is_add);
 382       else if (protocol == IP_PROTOCOL_TCP)
 383         tcp_punt_unknown (vm, af == AF_IP4, is_add);
 384
 385       return 0;
 386     }
 387
 388   else if (is_add)
 389     {
 390       if (protocol == IP_PROTOCOL_TCP)
 391         return clib_error_return (0, "punt TCP ports is not supported yet");
 392
 393       udp_register_dst_port (vm, port, udp4_punt_node.index, af == AF_IP4);
 394
 395       return 0;
 396     }
 397   else
 398     {
 399       if (protocol == IP_PROTOCOL_TCP)
 400         return clib_error_return (0, "punt TCP ports is not supported yet");
 401
 402       udp_unregister_dst_port (vm, port, af == AF_IP4);
 403
 404       return 0;
 405     }
 406 }
 407
 408 /**
 409  * @brief Request exception traffic punt.
 410  *
 411  * @param reason   Punting reason
 412  *
 413  * @returns 0 on success, non-zero value otherwise
 414  */
 415 static clib_error_t *
 416 punt_exception_add_del (vlib_punt_reason_t reason, bool is_add)
 417 {
 418   punt_main_t *pm = &punt_main;
 419   int rv = 0;
 420   vnet_punt_reason_flag_t flag = vlib_punt_reason_get_flags (reason);
 421   const char *node_name =
 422     vnet_punt_reason_flag_is_IP6_PACKET (flag) ? "ip6-punt" : "ip4-punt";
 423   if (is_add)
 424     rv = vlib_punt_register (pm->hdl, reason, node_name);
 425   else
 426     rv = vlib_punt_unregister (pm->hdl, reason, node_name);
 427   if (!rv)
 428     return 0;
 429   else
 430     return clib_error_return (0, is_add ? "Existing punting registration..." :
 431                                           "Punting registration not found...");
 432 }
 433
 434 clib_error_t *
 435 vnet_punt_add_del (vlib_main_t * vm, const punt_reg_t * pr, bool is_add)
 436 {
 437   switch (pr->type)
 438     {
 439     case PUNT_TYPE_L4:
 440       return (punt_l4_add_del (vm, pr->punt.l4.af, pr->punt.l4.protocol,
 441                                pr->punt.l4.port, is_add));
 442     case PUNT_TYPE_EXCEPTION:
 443       return punt_exception_add_del (pr->punt.exception.reason, is_add);
 444     case PUNT_TYPE_IP_PROTO:
 445       break;
 446     }
 447
 448   return (clib_error_return (0, "Unsupported punt type: %d", pr->type));
 449 }
 450
 451 static clib_error_t *
 452 punt_cli (vlib_main_t * vm,
 453           unformat_input_t * input__, vlib_cli_command_t * cmd)
 454 {
 455   unformat_input_t line_input, *input = &line_input;
 456   clib_error_t *error = NULL;
 457   bool is_add = true;
 458   /* *INDENT-OFF* */
 459   punt_reg_t pr = {
 460     .punt = {
 461       .l4 = {
 462         .af = AF_IP4,
 463         .port = ~0,
 464         .protocol = IP_PROTOCOL_UDP,
 465       },
 466     },
 467     .type = PUNT_TYPE_L4,
 468   };
 469   u32 port;
 470   /* *INDENT-ON* */
 471
 472   if (!unformat_user (input__, unformat_line_input, input))
 473     return 0;
 474
 475   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 476     {
 477       if (unformat (input, "del"))
 478         is_add = false;
 479       else if (unformat (input, "reason %U", unformat_punt_reason,
 480                          &pr.punt.exception.reason))
 481         pr.type = PUNT_TYPE_EXCEPTION;
 482       else if (unformat (input, "ipv4"))
 483         pr.punt.l4.af = AF_IP4;
 484       else if (unformat (input, "ipv6"))
 485         pr.punt.l4.af = AF_IP6;
 486       else if (unformat (input, "ip6"))
 487         pr.punt.l4.af = AF_IP6;
 488       else if (unformat (input, "%d", &port))
 489         pr.punt.l4.port = port;
 490       else if (unformat (input, "all"))
 491         pr.punt.l4.port = ~0;
 492       else if (unformat (input, "udp"))
 493         pr.punt.l4.protocol = IP_PROTOCOL_UDP;
 494       else if (unformat (input, "tcp"))
 495         pr.punt.l4.protocol = IP_PROTOCOL_TCP;
 496       else
 497         {
 498           error = clib_error_return (0, "parse error: '%U'",
 499                                      format_unformat_error, input);
 500           goto done;
 501         }
 502     }
 503
 504   /* punt both IPv6 and IPv4 when used in CLI */
 505   error = vnet_punt_add_del (vm, &pr, is_add);
 506   if (error)
 507     {
 508       clib_error_report (error);
 509     }
 510
 511 done:
 512   unformat_free (input);
 513   return error;
 514 }
 515
 516 /*?
 517  * The set of '<em>set punt</em>' commands allows specific IP traffic to
 518  * be punted to the host TCP/IP stack
 519  *
 520  * @em Note
 521  * - UDP is the only protocol supported in the current implementation
 522  * - All TCP traffic is currently punted to the host by default
 523  *
 524  * @cliexpar
 525  * @parblock
 526  * Example of how to request NTP traffic to be punted
 527  * @cliexcmd{set punt udp 125}
 528  *
 529  * Example of how to request all 'unknown' UDP traffic to be punted
 530  * @cliexcmd{set punt udp all}
 531  *
 532  * Example of how to stop all 'unknown' UDP traffic to be punted
 533  * @cliexcmd{set punt udp del all}
 534  * @endparblock
 535 ?*/
 536 /* *INDENT-OFF* */
 537 VLIB_CLI_COMMAND (punt_command, static) = {
 538   .path = "set punt",
 539   .short_help = "set punt [IPV4|ip6|ipv6] [UDP|tcp] [del] [ALL|<port-num>]",
 540   .function = punt_cli,
 541 };
 542 /* *INDENT-ON* */
 543
 544 static clib_error_t *
 545 punt_socket_register_cmd (vlib_main_t * vm,
 546                           unformat_input_t * input__,
 547                           vlib_cli_command_t * cmd)
 548 {
 549   unformat_input_t line_input, *input = &line_input;
 550   u8 *socket_name = 0;
 551   clib_error_t *error = NULL;
 552   /* *INDENT-OFF* */
 553   punt_reg_t pr = {
 554     .punt = {
 555       .l4 = {
 556         .af = AF_IP4,
 557         .port = ~0,
 558         .protocol = IP_PROTOCOL_UDP,
 559       },
 560     },
 561     .type = PUNT_TYPE_L4,
 562   };
 563   /* *INDENT-ON* */
 564
 565   if (!unformat_user (input__, unformat_line_input, input))
 566     return 0;
 567
 568   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 569     {
 570       if (unformat (input, "ipv4"))
 571         pr.punt.l4.af = AF_IP4;
 572       else if (unformat (input, "ipv6"))
 573         pr.punt.l4.af = AF_IP6;
 574       else if (unformat (input, "udp"))
 575         pr.punt.l4.protocol = IP_PROTOCOL_UDP;
 576       else if (unformat (input, "tcp"))
 577         pr.punt.l4.protocol = IP_PROTOCOL_TCP;
 578       else if (unformat (input, "%d", &pr.punt.l4.port))
 579         ;
 580       else if (unformat (input, "all"))
 581         pr.punt.l4.port = ~0;
 582       else if (unformat (input, "socket %s", &socket_name))
 583         ;
 584       else if (unformat (input, "reason %U", unformat_punt_reason,
 585                          &pr.punt.exception.reason))
 586         pr.type = PUNT_TYPE_EXCEPTION;
 587       else
 588         {
 589           error = clib_error_return (0, "parse error: '%U'",
 590                                      format_unformat_error, input);
 591           goto done;
 592         }
 593     }
 594
 595   if (!socket_name)
 596     error = clib_error_return (0, "socket name not specified");
 597   else
 598     error = vnet_punt_socket_add (vm, 1, &pr, (char *) socket_name);
 599
 600 done:
 601   unformat_free (input);
 602   return error;
 603 }
 604
 605 /*?
 606  *
 607  * @cliexpar
 608  * @cliexcmd{punt socket register socket punt_l4_foo.sock}
 609
 610  ?*/
 611 /* *INDENT-OFF* */
 612 VLIB_CLI_COMMAND (punt_socket_register_command, static) =
 613 {
 614   .path = "punt socket register",
 615   .function = punt_socket_register_cmd,
 616   .short_help = "punt socket register [IPV4|ipv6] [UDP|tcp] [ALL|<port-num>] socket <socket>",
 617   .is_mp_safe = 1,
 618 };
 619 /* *INDENT-ON* */
 620
 621 static clib_error_t *
 622 punt_socket_deregister_cmd (vlib_main_t * vm,
 623                             unformat_input_t * input__,
 624                             vlib_cli_command_t * cmd)
 625 {
 626   unformat_input_t line_input, *input = &line_input;
 627   clib_error_t *error = NULL;
 628   /* *INDENT-OFF* */
 629   punt_reg_t pr = {
 630     .punt = {
 631       .l4 = {
 632         .af = AF_IP4,
 633         .port = ~0,
 634         .protocol = IP_PROTOCOL_UDP,
 635       },
 636     },
 637     .type = PUNT_TYPE_L4,
 638   };
 639   /* *INDENT-ON* */
 640
 641   if (!unformat_user (input__, unformat_line_input, input))
 642     return 0;
 643
 644   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 645     {
 646       if (unformat (input, "ipv4"))
 647         pr.punt.l4.af = AF_IP4;
 648       else if (unformat (input, "ipv6"))
 649         pr.punt.l4.af = AF_IP6;
 650       else if (unformat (input, "udp"))
 651         pr.punt.l4.protocol = IP_PROTOCOL_UDP;
 652       else if (unformat (input, "tcp"))
 653         pr.punt.l4.protocol = IP_PROTOCOL_TCP;
 654       else if (unformat (input, "%d", &pr.punt.l4.port))
 655         ;
 656       else if (unformat (input, "all"))
 657         pr.punt.l4.port = ~0;
 658       else if (unformat (input, "reason %U", unformat_punt_reason,
 659                          &pr.punt.exception.reason))
 660         pr.type = PUNT_TYPE_EXCEPTION;
 661       else
 662         {
 663           error = clib_error_return (0, "parse error: '%U'",
 664                                      format_unformat_error, input);
 665           goto done;
 666         }
 667     }
 668
 669   error = vnet_punt_socket_del (vm, &pr);
 670 done:
 671   unformat_free (input);
 672   return error;
 673 }
 674
 675 /*?
 676  *
 677  * @cliexpar
 678  * @cliexcmd{punt socket register}
 679  ?*/
 680 /* *INDENT-OFF* */
 681 VLIB_CLI_COMMAND (punt_socket_deregister_command, static) =
 682 {
 683   .path = "punt socket deregister",
 684   .function = punt_socket_deregister_cmd,
 685   .short_help = "punt socket deregister [IPV4|ipv6] [UDP|tcp] [ALL|<port-num>]",
 686   .is_mp_safe = 1,
 687 };
 688 /* *INDENT-ON* */
 689
 690 void
 691 punt_client_walk (punt_type_t pt, punt_client_walk_cb_t cb, void *ctx)
 692 {
 693   punt_main_t *pm = &punt_main;
 694
 695   switch (pt)
 696     {
 697     case PUNT_TYPE_L4:
 698       {
 699         u32 pci, key;
 700
 701         /* *INDENT-OFF* */
 702         hash_foreach(key, pci, pm->db.clients_by_l4_port,
 703         ({
 704           cb (pool_elt_at_index(pm->punt_client_pool, pci), ctx);
 705         }));
 706         /* *INDENT-ON* */
 707         break;
 708       }
 709     case PUNT_TYPE_IP_PROTO:
 710       {
 711         u32 pci, key;
 712
 713         /* *INDENT-OFF* */
 714         hash_foreach(key, pci, pm->db.clients_by_ip_proto,
 715         ({
 716           cb (pool_elt_at_index(pm->punt_client_pool, pci), ctx);
 717         }));
 718         /* *INDENT-ON* */
 719         break;
 720       }
 721     case PUNT_TYPE_EXCEPTION:
 722       {
 723         u32 *pci;
 724
 725         vec_foreach (pci, pm->db.clients_by_exception)
 726         {
 727           if (~0 != *pci)
 728             cb (pool_elt_at_index (pm->punt_client_pool, *pci), ctx);
 729         }
 730
 731         break;
 732       }
 733     }
 734 }
 735
 736 static u8 *
 737 format_punt_client (u8 * s, va_list * args)
 738 {
 739   punt_client_t *pc = va_arg (*args, punt_client_t *);
 740
 741   s = format (s, " punt ");
 742
 743   switch (pc->reg.type)
 744     {
 745     case PUNT_TYPE_L4:
 746       s = format (s, "%U %U port %d",
 747                   format_ip_address_family, pc->reg.punt.l4.af,
 748                   format_ip_protocol, pc->reg.punt.l4.protocol,
 749                   pc->reg.punt.l4.port);
 750       break;
 751     case PUNT_TYPE_IP_PROTO:
 752       s = format (s, "%U %U",
 753                   format_ip_address_family, pc->reg.punt.ip_proto.af,
 754                   format_ip_protocol, pc->reg.punt.ip_proto.protocol);
 755       break;
 756     case PUNT_TYPE_EXCEPTION:
 757       s = format (s, " %U", format_vlib_punt_reason,
 758                   pc->reg.punt.exception.reason);
 759       break;
 760     }
 761
 762   s = format (s, " to socket %s \n", pc->caddr.sun_path);
 763
 764   return (s);
 765 }
 766
 767 static walk_rc_t
 768 punt_client_show_one (const punt_client_t * pc, void *ctx)
 769 {
 770   vlib_cli_output (ctx, "%U", format_punt_client, pc);
 771
 772   return (WALK_CONTINUE);
 773 }
 774
 775 static clib_error_t *
 776 punt_socket_show_cmd (vlib_main_t * vm,
 777                       unformat_input_t * input__, vlib_cli_command_t * cmd)
 778 {
 779   unformat_input_t line_input, *input = &line_input;
 780   clib_error_t *error = NULL;
 781   punt_type_t pt;
 782
 783   pt = PUNT_TYPE_L4;
 784
 785   if (!unformat_user (input__, unformat_line_input, input))
 786     return 0;
 787
 788   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 789     {
 790       if (unformat (input, "exception"))
 791         pt = PUNT_TYPE_EXCEPTION;
 792       else if (unformat (input, "l4"))
 793         pt = PUNT_TYPE_L4;
 794       else if (unformat (input, "ip"))
 795         pt = PUNT_TYPE_IP_PROTO;
 796       else
 797         {
 798           error = clib_error_return (0, "parse error: '%U'",
 799                                      format_unformat_error, input);
 800           goto done;
 801         }
 802     }
 803
 804   punt_client_walk (pt, punt_client_show_one, vm);
 805
 806 done:
 807   unformat_free (input);
 808   return (error);
 809 }
 810
 811 /*?
 812  *
 813  * @cliexpar
 814  * @cliexcmd{show punt socket ipv4}
 815  ?*/
 816 /* *INDENT-OFF* */
 817 VLIB_CLI_COMMAND (show_punt_socket_registration_command, static) =
 818 {
 819   .path = "show punt socket registrations",
 820   .function = punt_socket_show_cmd,
 821   .short_help = "show punt socket registrations [l4|exception]",
 822   .is_mp_safe = 1,
 823 };
 824 /* *INDENT-ON* */
 825
 826 clib_error_t *
 827 ip_punt_init (vlib_main_t * vm)
 828 {
 829   clib_error_t *error = NULL;
 830   punt_main_t *pm = &punt_main;
 831   vlib_thread_main_t *tm = vlib_get_thread_main ();
 832
 833   pm->is_configured = false;
 834   pm->interface_output_node =
 835     vlib_get_node_by_name (vm, (u8 *) "interface-output");
 836
 837   if ((error = vlib_call_init_function (vm, punt_init)))
 838     return error;
 839
 840   pm->hdl = vlib_punt_client_register ("ip-punt");
 841
 842   vec_validate_aligned (pm->thread_data, tm->n_vlib_mains,
 843                         CLIB_CACHE_LINE_BYTES);
 844
 845   return (error);
 846 }
 847
 848 u8 *
 849 format_vnet_punt_reason_flags (u8 *s, va_list *args)
 850 {
 851   vnet_punt_reason_flag_t flag = va_arg (*args, int);
 852 #define _(pos, len, value, name, str)                                         \
 853   if (vnet_punt_reason_flag_is_##name (flag))                                 \
 854     s = format (s, "%s ", str);
 855
 856   foreach_vnet_punt_reason_flag
 857 #undef _
 858     return (s);
 859 }
 860
 861 VLIB_INIT_FUNCTION (ip_punt_init);
 862
 863 static clib_error_t *
 864 punt_config (vlib_main_t * vm, unformat_input_t * input)
 865 {
 866   punt_main_t *pm = &punt_main;
 867   char *socket_path = 0;
 868
 869   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 870     {
 871       if (unformat (input, "socket %s", &socket_path))
 872         strncpy (pm->sun_path, socket_path, UNIX_PATH_MAX - 1);
 873       else
 874         return clib_error_return (0, "unknown input `%U'",
 875                                   format_unformat_error, input);
 876     }
 877
 878   if (socket_path == 0)
 879     return 0;
 880
 881   /* UNIX domain socket */
 882   struct sockaddr_un addr;
 883   if ((pm->socket_fd = socket (AF_UNIX, SOCK_DGRAM | SOCK_NONBLOCK, 0)) == -1)
 884     {
 885       return clib_error_return (0, "socket error");
 886     }
 887
 888   clib_memset (&addr, 0, sizeof (addr));
 889   addr.sun_family = AF_UNIX;
 890   if (*socket_path == '\0')
 891     {
 892       *addr.sun_path = '\0';
 893       strncpy (addr.sun_path + 1, socket_path + 1,
 894                sizeof (addr.sun_path) - 2);
 895     }
 896   else
 897     {
 898       strncpy (addr.sun_path, socket_path, sizeof (addr.sun_path) - 1);
 899       unlink (socket_path);
 900     }
 901
 902   if (bind (pm->socket_fd, (struct sockaddr *) &addr, sizeof (addr)) == -1)
 903     {
 904       return clib_error_return (0, "bind error");
 905     }
 906
 907   int n_bytes = 0x10000;
 908
 909   if (setsockopt
 910       (pm->socket_fd, SOL_SOCKET, SO_SNDBUF, &n_bytes,
 911        sizeof (n_bytes)) == -1)
 912     {
 913       return clib_error_return (0, "setsockopt error");
 914     }
 915
 916   /* Register socket */
 917   clib_file_main_t *fm = &file_main;
 918   clib_file_t template = { 0 };
 919   template.read_function = punt_socket_read_ready;
 920   template.file_descriptor = pm->socket_fd;
 921   template.description = format (0, "punt socket %s", socket_path);
 922   pm->clib_file_index = clib_file_add (fm, &template);
 923
 924   pm->is_configured = true;
 925
 926   return 0;
 927 }
 928
 929 VLIB_CONFIG_FUNCTION (punt_config, "punt");
 930
 931 /*
 932  * fd.io coding-style-patch-verification: ON
 933  *
 934  * Local Variables:
 935  * eval: (c-set-style "gnu")
 936  * End:
 937  */