interface: callback to manage extra MAC addresses
[vpp.git] / src / vnet / interface_cli.c
index 95e1684..a66e157 100644 (file)
@@ -1164,6 +1164,158 @@ VLIB_CLI_COMMAND (set_interface_mtu_cmd, static) = {
 };
 /* *INDENT-ON* */
 
+static clib_error_t *
+show_interface_sec_mac_addr_fn (vlib_main_t * vm, unformat_input_t * input,
+                               vlib_cli_command_t * cmd)
+{
+  vnet_main_t *vnm = vnet_get_main ();
+  vnet_interface_main_t *im = &vnm->interface_main;
+  ethernet_main_t *em = &ethernet_main;
+  u32 sw_if_index = ~0;
+  vnet_sw_interface_t *si, *sorted_sis = 0;
+
+  if (unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
+    {
+      si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
+      vec_add1 (sorted_sis, si[0]);
+    }
+
+  /* if an interface name was not passed, get all interfaces */
+  if (vec_len (sorted_sis) == 0)
+    {
+      sorted_sis =
+       vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
+      _vec_len (sorted_sis) = 0;
+      /* *INDENT-OFF* */
+      pool_foreach (si, im->sw_interfaces,
+      ({
+        int visible = vnet_swif_is_api_visible (si);
+        if (visible)
+          vec_add1 (sorted_sis, si[0]);}
+        ));
+      /* *INDENT-ON* */
+      /* Sort by name. */
+      vec_sort_with_function (sorted_sis, sw_interface_name_compare);
+    }
+
+  vec_foreach (si, sorted_sis)
+  {
+    vnet_sw_interface_t *sup_si;
+    ethernet_interface_t *ei;
+
+    sup_si = vnet_get_sup_sw_interface (vnm, si->sw_if_index);
+    ei = ethernet_get_interface (em, sup_si->hw_if_index);
+
+    vlib_cli_output (vm, "%U (%s):",
+                    format_vnet_sw_if_index_name, vnm, si->sw_if_index,
+                    (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
+                    "up" : "dn");
+
+    if (ei && ei->secondary_addrs)
+      {
+       mac_address_t *sec_addr;
+
+       vec_foreach (sec_addr, ei->secondary_addrs)
+       {
+         vlib_cli_output (vm, "  %U", format_mac_address_t, sec_addr);
+       }
+      }
+  }
+
+  vec_free (sorted_sis);
+  return 0;
+}
+
+/*?
+ * This command is used to display interface secondary mac addresses.
+ *
+ * @cliexpar
+ * Example of how to display interface secondary mac addresses:
+ * @cliexstart{show interface secondary-mac-address}
+ * @cliexend
+?*/
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (show_interface_sec_mac_addr, static) = {
+  .path = "show interface secondary-mac-address",
+  .short_help = "show interface secondary-mac-address [<interface>]",
+  .function = show_interface_sec_mac_addr_fn,
+};
+/* *INDENT-ON* */
+
+static clib_error_t *
+interface_add_del_mac_address (vlib_main_t * vm, unformat_input_t * input,
+                              vlib_cli_command_t * cmd)
+{
+  vnet_main_t *vnm = vnet_get_main ();
+  vnet_sw_interface_t *si = NULL;
+  clib_error_t *error = 0;
+  u32 sw_if_index = ~0;
+  u8 mac[6] = { 0 };
+  u8 is_add, is_del;
+
+  is_add = is_del = 0;
+
+  if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
+    {
+      error = clib_error_return (0, "unknown interface `%U'",
+                                format_unformat_error, input);
+      goto done;
+    }
+  if (!unformat_user (input, unformat_ethernet_address, mac))
+    {
+      error = clib_error_return (0, "expected mac address `%U'",
+                                format_unformat_error, input);
+      goto done;
+    }
+
+  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
+    {
+      if (unformat (input, "add"))
+       is_add = 1;
+      else if (unformat (input, "del"))
+       is_del = 1;
+      else
+       break;
+    }
+
+  if (is_add == is_del)
+    {
+      error = clib_error_return (0, "must choose one of add or del");
+      goto done;
+    }
+
+  si = vnet_get_sw_interface (vnm, sw_if_index);
+  error =
+    vnet_hw_interface_add_del_mac_address (vnm, si->hw_if_index, mac, is_add);
+
+done:
+  return error;
+}
+
+/*?
+ * The '<em>set interface secondary-mac-address </em>' command allows adding
+ * or deleting extra MAC addresses on a given interface without changing the
+ * default MAC address. This could allow packets sent to these MAC addresses
+ * to be received without setting the interface to promiscuous mode.
+ * Not all interfaces support this operation. The ones that do are mostly
+ * hardware NICs, though virtio does also.
+ *
+ * @cliexpar
+ * @parblock
+ * Example of how to add a secondary MAC Address on an interface:
+ * @cliexcmd{set interface secondary-mac-address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01 add}
+ * Example of how to delete a secondary MAC address from an interface:
+ * @cliexcmd{set interface secondary-mac-address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01 del}
+ * @endparblock
+?*/
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (interface_add_del_mac_address_cmd, static) = {
+  .path = "set interface secondary-mac-address",
+  .short_help = "set interface secondary-mac-address <interface> <mac-address> [(add|del)]",
+  .function = interface_add_del_mac_address,
+};
+/* *INDENT-ON* */
+
 static clib_error_t *
 set_interface_mac_address (vlib_main_t * vm, unformat_input_t * input,
                           vlib_cli_command_t * cmd)
@@ -1695,47 +1847,97 @@ VLIB_CLI_COMMAND (cmd_set_if_rx_placement,static) = {
 };
 /* *INDENT-ON* */
 
+static u8 *
+format_vnet_pcap (u8 * s, va_list * args)
+{
+  vnet_pcap_t *pp = va_arg (*args, vnet_pcap_t *);
+  int type = va_arg (*args, int);
+  int printed = 0;
+
+  if (type == 0)
+    {
+      if (pp->pcap_rx_enable)
+       {
+         s = format (s, "rx");
+         printed = 1;
+       }
+      if (pp->pcap_tx_enable)
+       {
+         if (printed)
+           s = format (s, " and ");
+         s = format (s, "tx");
+         printed = 1;
+       }
+      if (pp->pcap_drop_enable)
+       {
+         if (printed)
+           s = format (s, " and ");
+         s = format (s, "drop");
+         printed = 1;
+       }
+      return s;
+    }
+  s = format (s, "unknown type %d!", type);
+  return s;
+}
+
+
 int
 vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t * a)
 {
   vlib_main_t *vm = vlib_get_main ();
-  vlib_rx_or_tx_t rxtx = a->rxtx;
-  vnet_pcap_t *pp = &vm->pcap[rxtx];
+  vnet_pcap_t *pp = &vm->pcap;
   pcap_main_t *pm = &pp->pcap_main;
+  vnet_classify_main_t *cm = &vnet_classify_main;
+  vnet_classify_filter_set_t *set = 0;
 
   if (a->status)
     {
-      if (pp->pcap_enable == 0)
+      if (pp->pcap_rx_enable || pp->pcap_tx_enable || pp->pcap_drop_enable)
        {
          vlib_cli_output
-           (vm, "pcap %s dispatch capture enabled: %d of %d pkts...",
-            (rxtx == VLIB_RX) ? "rx" : "tx",
+           (vm, "pcap %U dispatch capture enabled: %d of %d pkts...",
+            format_vnet_pcap, pp, 0 /* print type */ ,
             pm->n_packets_captured, pm->n_packets_to_capture);
          vlib_cli_output (vm, "capture to file %s", pm->file_name);
        }
       else
-       vlib_cli_output (vm, "pcap %s dispatch capture disabled",
-                        (rxtx == VLIB_RX) ? "rx" : "tx");
+       vlib_cli_output (vm, "pcap dispatch capture disabled");
+
       return 0;
     }
 
   /* Consistency checks */
 
   /* Enable w/ capture already enabled not allowed */
-  if (pp->pcap_enable && a->enable)
+  if ((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable)
+      && (a->rx_enable + a->tx_enable + a->drop_enable))
     return VNET_API_ERROR_INVALID_VALUE;
 
   /* Disable capture with capture already disabled, not interesting */
-  if (pp->pcap_enable == 0 && a->enable == 0)
+  if (((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable) == 0)
+      && ((a->rx_enable + a->tx_enable + a->drop_enable == 0)))
     return VNET_API_ERROR_VALUE_EXIST;
 
   /* Change number of packets to capture while capturing */
-  if (pp->pcap_enable && a->enable
+  if ((pp->pcap_rx_enable + pp->pcap_tx_enable + pp->pcap_drop_enable)
+      && (a->rx_enable + a->tx_enable + a->drop_enable)
       && (pm->n_packets_to_capture != a->packets_to_capture))
     return VNET_API_ERROR_INVALID_VALUE_2;
 
-  if (a->enable)
+  set = pool_elt_at_index (cm->filter_sets, cm->filter_set_by_sw_if_index[0]);
+
+  /* Classify filter specified, but no classify filter configured */
+  if ((a->rx_enable + a->tx_enable + a->drop_enable) && a->filter &&
+      (set->table_indices[0] == ~0))
+    return VNET_API_ERROR_NO_SUCH_LABEL;
+
+  if (a->rx_enable + a->tx_enable + a->drop_enable)
     {
+      /* Sanity check max bytes per pkt */
+      if (a->max_bytes_per_pkt < 32 || a->max_bytes_per_pkt > 9000)
+       return VNET_API_ERROR_INVALID_MEMORY_SIZE;
+
       /* Clean up from previous run, if any */
       vec_free (pm->file_name);
       vec_free (pm->pcap_data);
@@ -1746,19 +1948,39 @@ vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t * a)
        clib_spinlock_init (&(pm->lock));
 
       if (a->filename == 0)
-       a->filename = format (0, "/tmp/%s.pcap%c",
-                             (rxtx == VLIB_RX) ? "rx" : "tx", 0);
+       {
+         u8 *stem = 0;
+
+         if (a->rx_enable)
+           stem = format (stem, "rx");
+         if (a->tx_enable)
+           stem = format (stem, "tx");
+         if (a->drop_enable)
+           stem = format (stem, "drop");
+         a->filename = format (0, "/tmp/%s.pcap%c", stem, 0);
+         vec_free (stem);
+       }
 
       pm->file_name = (char *) a->filename;
       pm->n_packets_captured = 0;
       pm->packet_type = PCAP_PACKET_TYPE_ethernet;
       pm->n_packets_to_capture = a->packets_to_capture;
       pp->pcap_sw_if_index = a->sw_if_index;
-      pp->pcap_enable = 1;
+      if (a->filter)
+       pp->filter_classify_table_index = set->table_indices[0];
+      else
+       pp->filter_classify_table_index = ~0;
+      pp->pcap_rx_enable = a->rx_enable;
+      pp->pcap_tx_enable = a->tx_enable;
+      pp->pcap_drop_enable = a->drop_enable;
+      pp->max_bytes_per_pkt = a->max_bytes_per_pkt;
     }
   else
     {
-      pp->pcap_enable = 0;
+      pp->pcap_rx_enable = 0;
+      pp->pcap_tx_enable = 0;
+      pp->pcap_drop_enable = 0;
+      pp->filter_classify_table_index = ~0;
       if (pm->n_packets_captured)
        {
          clib_error_t *error;
@@ -1766,7 +1988,7 @@ vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t * a)
          vlib_cli_output (vm, "Write %d packets to %s, and stop capture...",
                           pm->n_packets_captured, pm->file_name);
          error = pcap_write (pm);
-         if (pm->file_descriptor >= 0)
+         if (pm->flags & PCAP_MAIN_INIT_DONE)
            pcap_close (pm);
          /* Report I/O errors... */
          if (error)
@@ -1784,19 +2006,22 @@ vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t * a)
 }
 
 static clib_error_t *
-pcap_trace_command_internal (vlib_main_t * vm,
-                            unformat_input_t * input,
-                            vlib_cli_command_t * cmd, vlib_rx_or_tx_t rxtx)
+pcap_trace_command_fn (vlib_main_t * vm,
+                      unformat_input_t * input, vlib_cli_command_t * cmd)
 {
   unformat_input_t _line_input, *line_input = &_line_input;
   vnet_pcap_dispatch_trace_args_t _a, *a = &_a;
   vnet_main_t *vnm = vnet_get_main ();
   u8 *filename = 0;
   u32 max = 1000;
+  u32 max_bytes_per_pkt = 512;
   int rv;
-  int enable = 0;
+  int rx_enable = 0;
+  int tx_enable = 0;
+  int drop_enable = 0;
   int status = 0;
-  u32 sw_if_index = 0;
+  int filter = 0;
+  u32 sw_if_index = ~0;
 
   /* Get a line of input. */
   if (!unformat_user (input, unformat_line_input, line_input))
@@ -1804,13 +2029,16 @@ pcap_trace_command_internal (vlib_main_t * vm,
 
   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
     {
-      if (unformat (line_input, "on %=", &enable, 1))
-       ;
-      else if (unformat (line_input, "enable %=", &enable, 1))
-       ;
-      else if (unformat (line_input, "off %=", &enable, 0))
-       ;
-      else if (unformat (line_input, "disable %=", &enable, 0))
+      if (unformat (line_input, "rx"))
+       rx_enable = 1;
+      else if (unformat (line_input, "tx"))
+       tx_enable = 1;
+      else if (unformat (line_input, "drop"))
+       drop_enable = 1;
+      else if (unformat (line_input, "off"))
+       rx_enable = tx_enable = drop_enable = 0;
+      else if (unformat (line_input, "max-bytes-per-pkt %u",
+                        &max_bytes_per_pkt))
        ;
       else if (unformat (line_input, "max %d", &max))
        ;
@@ -1826,6 +2054,8 @@ pcap_trace_command_internal (vlib_main_t * vm,
        ;
       else if (unformat (line_input, "intfc any"))
        sw_if_index = 0;
+      else if (unformat (line_input, "filter"))
+       filter = 1;
       else
        {
          return clib_error_return (0, "unknown input `%U'",
@@ -1837,11 +2067,14 @@ pcap_trace_command_internal (vlib_main_t * vm,
 
   /* no need for memset (a, 0, sizeof (*a)), set all fields here. */
   a->filename = filename;
-  a->enable = enable;
+  a->rx_enable = rx_enable;
+  a->tx_enable = tx_enable;
+  a->drop_enable = drop_enable;
   a->status = status;
   a->packets_to_capture = max;
-  a->rxtx = rxtx;
   a->sw_if_index = sw_if_index;
+  a->filter = filter;
+  a->max_bytes_per_pkt = max_bytes_per_pkt;
 
   rv = vnet_pcap_dispatch_trace_configure (a);
 
@@ -1866,6 +2099,14 @@ pcap_trace_command_internal (vlib_main_t * vm,
     case VNET_API_ERROR_NO_SUCH_ENTRY:
       return clib_error_return (0, "No packets captured...");
 
+    case VNET_API_ERROR_INVALID_MEMORY_SIZE:
+      return clib_error_return (0,
+                               "Max bytes per pkt must be > 32, < 9000...");
+
+    case VNET_API_ERROR_NO_SUCH_LABEL:
+      return clib_error_return
+       (0, "No classify filter configured, see 'classify filter...'");
+
     default:
       vlib_cli_output (vm, "WARNING: trace configure returned %d", rv);
       break;
@@ -1873,30 +2114,20 @@ pcap_trace_command_internal (vlib_main_t * vm,
   return 0;
 }
 
-static clib_error_t *
-pcap_rx_trace_command_fn (vlib_main_t * vm,
-                         unformat_input_t * input, vlib_cli_command_t * cmd)
-{
-  return pcap_trace_command_internal (vm, input, cmd, VLIB_RX);
-}
-
-static clib_error_t *
-pcap_tx_trace_command_fn (vlib_main_t * vm,
-                         unformat_input_t * input, vlib_cli_command_t * cmd)
-{
-  return pcap_trace_command_internal (vm, input, cmd, VLIB_TX);
-}
-
-
 /*?
  * This command is used to start or stop a packet capture, or show
- * the status of packet capture. Note that both "pcap rx trace" and
- * "pcap tx trace" are implemented. The command syntax is identical,
- * simply substitute rx for tx as needed.
+ * the status of packet capture.
  *
  * This command has the following optional parameters:
  *
- * - <b>on|off</b> - Used to start or stop a packet capture.
+ *
+ * - <b>rx</b> - Capture received packets
+ *
+ * - <b>tx</b> - Capture transmitted packets
+ *
+ * - <b>drop</b> - Capture dropped packets
+ *
+ * - <b>off</b> - Stop capturing packets, write results to the specified file
  *
  * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
  *   of packets have been received, buffer is flushed to file. Once another
@@ -1904,17 +2135,26 @@ pcap_tx_trace_command_fn (vlib_main_t * vm,
  *   to file, overwriting previous write. If not entered, value defaults
  *   to 100. Can only be updated if packet capture is off.
  *
- * - <b>intfc <interface>|any</b> - Used to specify a given interface,
+ * - <b>max-bytes-per-pkt <nnnn></b> - Maximum number of bytes to capture
+ *   for each packet. Must be >= 32, <= 9000.
+ *
+ * - <b>intfc <interface-name>|any</b> - Used to specify a given interface,
  *   or use '<em>any</em>' to run packet capture on all interfaces.
  *   '<em>any</em>' is the default if not provided. Settings from a previous
  *   packet capture are preserved, so '<em>any</em>' can be used to reset
  *   the interface setting.
  *
+ * - <b>filter</b> - Use the pcap rx / tx / drop trace filter, which
+ *   must be configured. Use <b>classify filter pcap...</b> to configure the
+ *   filter. The filter will only be executed if the per-interface or
+ *   any-interface tests fail.
+ *
  * - <b>file <name></b> - Used to specify the output filename. The file will
  *   be placed in the '<em>/tmp</em>' directory, so only the filename is
  *   supported. Directory should not be entered. If file already exists, file
- *   will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
- *   will be used. Can only be updated if packet capture is off.
+ *   will be overwritten. If no filename is provided, the file will be
+ *   named "/tmp/rx.pcap", "/tmp/tx.pcap", "/tmp/rxandtx.pcap", etc.
+ *   Can only be updated if packet capture is off.
  *
  * - <b>status</b> - Displays the current status and configured attributes
  *   associated with a packet capture. If packet capture is in progress,
@@ -1924,21 +2164,20 @@ pcap_tx_trace_command_fn (vlib_main_t * vm,
  *
  * @cliexpar
  * Example of how to display the status of a tx packet capture when off:
- * @cliexstart{pcap tx trace status}
+ * @cliexstart{pcap trace status}
  * max is 100, for any interface to file /tmp/vpe.pcap
  * pcap tx capture is off...
  * @cliexend
  * Example of how to start a tx packet capture:
- * @cliexstart{pcap tx trace on max 35 intfc GigabitEthernet0/8/0 file vppTest.pcap}
- * pcap tx capture on...
+ * @cliexstart{pcap trace tx max 35 intfc GigabitEthernet0/8/0 file vppTest.pcap}
  * @cliexend
  * Example of how to display the status of a tx packet capture in progress:
- * @cliexstart{pcap tx trace status}
+ * @cliexstart{pcap trace status}
  * max is 35, for interface GigabitEthernet0/8/0 to file /tmp/vppTest.pcap
  * pcap tx capture is on: 20 of 35 pkts...
  * @cliexend
  * Example of how to stop a tx packet capture:
- * @cliexstart{vppctl pcap tx trace off}
+ * @cliexstart{pcap trace off}
  * captured 21 pkts...
  * saved to /tmp/vppTest.pcap...
  * @cliexend
@@ -1946,20 +2185,13 @@ pcap_tx_trace_command_fn (vlib_main_t * vm,
 /* *INDENT-OFF* */
 
 VLIB_CLI_COMMAND (pcap_tx_trace_command, static) = {
-    .path = "pcap tx trace",
-    .short_help =
-    "pcap tx trace [on|off] [max <nn>] [intfc <interface>|any] [file <name>] [status]",
-    .function = pcap_tx_trace_command_fn,
-};
-VLIB_CLI_COMMAND (pcap_rx_trace_command, static) = {
-    .path = "pcap rx trace",
+    .path = "pcap trace",
     .short_help =
-    "pcap rx trace [on|off] [max <nn>] [intfc <interface>|any] [file <name>] [status]",
-    .function = pcap_rx_trace_command_fn,
+    "pcap trace rx tx drop off [max <nn>] [intfc <interface>|any] [file <name>] [status] [max-bytes-per-pkt <nnnn>][filter]",
+    .function = pcap_trace_command_fn,
 };
 /* *INDENT-ON* */
 
-
 /*
  * fd.io coding-style-patch-verification: ON
  *