ip: extend the punt cli to accept reason filter for sockets registration
[vpp.git] / src / vnet / ip / punt.c
index a3c7eca..fb0cc22 100644 (file)
@@ -24,7 +24,6 @@
 
 #include <vnet/ip/ip.h>
 #include <vlib/vlib.h>
-#include <vnet/pg/pg.h>
 #include <vnet/udp/udp.h>
 #include <vnet/tcp/tcp.h>
 #include <vnet/ip/punt.h>
@@ -351,10 +350,10 @@ vnet_punt_socket_del (vlib_main_t * vm, const punt_reg_t * pr)
 }
 
 /**
- * @brief Request IP traffic punt to the local TCP/IP stack.
+ * @brief Request IP L4 traffic punt to the local TCP/IP stack.
  *
  * @em Note
- * - UDP and TCP are the only protocols supported in the current implementation
+ * - UDP is the only protocol supported in the current implementation
  *
  * @param vm       vlib_main_t corresponding to the current thread
  * @param af       IP address family.
@@ -406,6 +405,32 @@ punt_l4_add_del (vlib_main_t * vm,
     }
 }
 
+/**
+ * @brief Request exception traffic punt.
+ *
+ * @param reason   Punting reason
+ *
+ * @returns 0 on success, non-zero value otherwise
+ */
+static clib_error_t *
+punt_exception_add_del (vlib_punt_reason_t reason, bool is_add)
+{
+  punt_main_t *pm = &punt_main;
+  int rv = 0;
+  vnet_punt_reason_flag_t flag = vlib_punt_reason_get_flags (reason);
+  const char *node_name =
+    vnet_punt_reason_flag_is_IP6_PACKET (flag) ? "ip6-punt" : "ip4-punt";
+  if (is_add)
+    rv = vlib_punt_register (pm->hdl, reason, node_name);
+  else
+    rv = vlib_punt_unregister (pm->hdl, reason, node_name);
+  if (!rv)
+    return 0;
+  else
+    return clib_error_return (0, is_add ? "Existing punting registration..." :
+                                         "Punting registration not found...");
+}
+
 clib_error_t *
 vnet_punt_add_del (vlib_main_t * vm, const punt_reg_t * pr, bool is_add)
 {
@@ -415,6 +440,7 @@ vnet_punt_add_del (vlib_main_t * vm, const punt_reg_t * pr, bool is_add)
       return (punt_l4_add_del (vm, pr->punt.l4.af, pr->punt.l4.protocol,
                               pr->punt.l4.port, is_add));
     case PUNT_TYPE_EXCEPTION:
+      return punt_exception_add_del (pr->punt.exception.reason, is_add);
     case PUNT_TYPE_IP_PROTO:
       break;
     }
@@ -424,8 +450,9 @@ vnet_punt_add_del (vlib_main_t * vm, const punt_reg_t * pr, bool is_add)
 
 static clib_error_t *
 punt_cli (vlib_main_t * vm,
-         unformat_input_t * input, vlib_cli_command_t * cmd)
+         unformat_input_t * input__, vlib_cli_command_t * cmd)
 {
+  unformat_input_t line_input, *input = &line_input;
   clib_error_t *error = NULL;
   bool is_add = true;
   /* *INDENT-OFF* */
@@ -434,7 +461,7 @@ punt_cli (vlib_main_t * vm,
       .l4 = {
         .af = AF_IP4,
         .port = ~0,
-        .protocol = ~0,
+        .protocol = IP_PROTOCOL_UDP,
       },
     },
     .type = PUNT_TYPE_L4,
@@ -442,16 +469,26 @@ punt_cli (vlib_main_t * vm,
   u32 port;
   /* *INDENT-ON* */
 
+  if (!unformat_user (input__, unformat_line_input, input))
+    return 0;
+
   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
     {
       if (unformat (input, "del"))
        is_add = false;
+      else if (unformat (input, "reason %U", unformat_punt_reason,
+                        &pr.punt.exception.reason))
+       pr.type = PUNT_TYPE_EXCEPTION;
+      else if (unformat (input, "ipv4"))
+       pr.punt.l4.af = AF_IP4;
       else if (unformat (input, "ipv6"))
        pr.punt.l4.af = AF_IP6;
       else if (unformat (input, "ip6"))
        pr.punt.l4.af = AF_IP6;
       else if (unformat (input, "%d", &port))
        pr.punt.l4.port = port;
+      else if (unformat (input, "all"))
+       pr.punt.l4.port = ~0;
       else if (unformat (input, "udp"))
        pr.punt.l4.protocol = IP_PROTOCOL_UDP;
       else if (unformat (input, "tcp"))
@@ -472,6 +509,7 @@ punt_cli (vlib_main_t * vm,
     }
 
 done:
+  unformat_free (input);
   return error;
 }
 
@@ -498,15 +536,17 @@ done:
 /* *INDENT-OFF* */
 VLIB_CLI_COMMAND (punt_command, static) = {
   .path = "set punt",
-  .short_help = "set punt [udp|tcp] [del] <all | port-num1 [port-num2 ...]>",
+  .short_help = "set punt [IPV4|ip6|ipv6] [UDP|tcp] [del] [ALL|<port-num>]",
   .function = punt_cli,
 };
 /* *INDENT-ON* */
 
 static clib_error_t *
 punt_socket_register_cmd (vlib_main_t * vm,
-                         unformat_input_t * input, vlib_cli_command_t * cmd)
+                         unformat_input_t * input__,
+                         vlib_cli_command_t * cmd)
 {
+  unformat_input_t line_input, *input = &line_input;
   u8 *socket_name = 0;
   clib_error_t *error = NULL;
   /* *INDENT-OFF* */
@@ -515,17 +555,20 @@ punt_socket_register_cmd (vlib_main_t * vm,
       .l4 = {
         .af = AF_IP4,
         .port = ~0,
-        .protocol = ~0,
+        .protocol = IP_PROTOCOL_UDP,
       },
     },
     .type = PUNT_TYPE_L4,
   };
   /* *INDENT-ON* */
 
+  if (!unformat_user (input__, unformat_line_input, input))
+    return 0;
+
   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
     {
       if (unformat (input, "ipv4"))
-       ;
+       pr.punt.l4.af = AF_IP4;
       else if (unformat (input, "ipv6"))
        pr.punt.l4.af = AF_IP6;
       else if (unformat (input, "udp"))
@@ -534,8 +577,13 @@ punt_socket_register_cmd (vlib_main_t * vm,
        pr.punt.l4.protocol = IP_PROTOCOL_TCP;
       else if (unformat (input, "%d", &pr.punt.l4.port))
        ;
+      else if (unformat (input, "all"))
+       pr.punt.l4.port = ~0;
       else if (unformat (input, "socket %s", &socket_name))
        ;
+      else if (unformat (input, "reason %U", unformat_punt_reason,
+                        &pr.punt.exception.reason))
+       pr.type = PUNT_TYPE_EXCEPTION;
       else
        {
          error = clib_error_return (0, "parse error: '%U'",
@@ -550,29 +598,32 @@ punt_socket_register_cmd (vlib_main_t * vm,
     error = vnet_punt_socket_add (vm, 1, &pr, (char *) socket_name);
 
 done:
+  unformat_free (input);
   return error;
 }
 
 /*?
  *
  * @cliexpar
- * @cliexcmd{punt socket register}
+ * @cliexcmd{punt socket register socket punt_l4_foo.sock}
+
  ?*/
 /* *INDENT-OFF* */
 VLIB_CLI_COMMAND (punt_socket_register_command, static) =
 {
   .path = "punt socket register",
   .function = punt_socket_register_cmd,
-  .short_help = "punt socket register [ipv4|ipv6] [udp|tcp]> <all | port-num1 [port-num2 ...]> <socket>",
+  .short_help = "punt socket register [IPV4|ipv6] [UDP|tcp] [ALL|<port-num>] socket <socket>",
   .is_mp_safe = 1,
 };
 /* *INDENT-ON* */
 
 static clib_error_t *
 punt_socket_deregister_cmd (vlib_main_t * vm,
-                           unformat_input_t * input,
+                           unformat_input_t * input__,
                            vlib_cli_command_t * cmd)
 {
+  unformat_input_t line_input, *input = &line_input;
   clib_error_t *error = NULL;
   /* *INDENT-OFF* */
   punt_reg_t pr = {
@@ -580,17 +631,20 @@ punt_socket_deregister_cmd (vlib_main_t * vm,
       .l4 = {
         .af = AF_IP4,
         .port = ~0,
-        .protocol = ~0,
+        .protocol = IP_PROTOCOL_UDP,
       },
     },
     .type = PUNT_TYPE_L4,
   };
   /* *INDENT-ON* */
 
+  if (!unformat_user (input__, unformat_line_input, input))
+    return 0;
+
   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
     {
       if (unformat (input, "ipv4"))
-       ;
+       pr.punt.l4.af = AF_IP4;
       else if (unformat (input, "ipv6"))
        pr.punt.l4.af = AF_IP6;
       else if (unformat (input, "udp"))
@@ -599,6 +653,11 @@ punt_socket_deregister_cmd (vlib_main_t * vm,
        pr.punt.l4.protocol = IP_PROTOCOL_TCP;
       else if (unformat (input, "%d", &pr.punt.l4.port))
        ;
+      else if (unformat (input, "all"))
+       pr.punt.l4.port = ~0;
+      else if (unformat (input, "reason %U", unformat_punt_reason,
+                        &pr.punt.exception.reason))
+       pr.type = PUNT_TYPE_EXCEPTION;
       else
        {
          error = clib_error_return (0, "parse error: '%U'",
@@ -609,6 +668,7 @@ punt_socket_deregister_cmd (vlib_main_t * vm,
 
   error = vnet_punt_socket_del (vm, &pr);
 done:
+  unformat_free (input);
   return error;
 }
 
@@ -622,7 +682,7 @@ VLIB_CLI_COMMAND (punt_socket_deregister_command, static) =
 {
   .path = "punt socket deregister",
   .function = punt_socket_deregister_cmd,
-  .short_help = "punt socket deregister [ipv4|ipv6] [udp|tcp]> <all | port-num1 [port-num2 ...]>",
+  .short_help = "punt socket deregister [IPV4|ipv6] [UDP|tcp] [ALL|<port-num>]",
   .is_mp_safe = 1,
 };
 /* *INDENT-ON* */
@@ -714,13 +774,17 @@ punt_client_show_one (const punt_client_t * pc, void *ctx)
 
 static clib_error_t *
 punt_socket_show_cmd (vlib_main_t * vm,
-                     unformat_input_t * input, vlib_cli_command_t * cmd)
+                     unformat_input_t * input__, vlib_cli_command_t * cmd)
 {
+  unformat_input_t line_input, *input = &line_input;
   clib_error_t *error = NULL;
   punt_type_t pt;
 
   pt = PUNT_TYPE_L4;
 
+  if (!unformat_user (input__, unformat_line_input, input))
+    return 0;
+
   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
     {
       if (unformat (input, "exception"))
@@ -740,6 +804,7 @@ punt_socket_show_cmd (vlib_main_t * vm,
   punt_client_walk (pt, punt_client_show_one, vm);
 
 done:
+  unformat_free (input);
   return (error);
 }
 
@@ -780,6 +845,19 @@ ip_punt_init (vlib_main_t * vm)
   return (error);
 }
 
+u8 *
+format_vnet_punt_reason_flags (u8 *s, va_list *args)
+{
+  vnet_punt_reason_flag_t flag = va_arg (*args, int);
+#define _(pos, len, value, name, str)                                         \
+  if (vnet_punt_reason_flag_is_##name (flag))                                 \
+    s = format (s, "%s ", str);
+
+  foreach_vnet_punt_reason_flag
+#undef _
+    return (s);
+}
+
 VLIB_INIT_FUNCTION (ip_punt_init);
 
 static clib_error_t *
@@ -840,7 +918,7 @@ punt_config (vlib_main_t * vm, unformat_input_t * input)
   clib_file_t template = { 0 };
   template.read_function = punt_socket_read_ready;
   template.file_descriptor = pm->socket_fd;
-  template.description = format (0, "%s", socket_path);
+  template.description = format (0, "punt socket %s", socket_path);
   pm->clib_file_index = clib_file_add (fm, &template);
 
   pm->is_configured = true;