interface: callback to manage extra MAC addresses
[vpp.git] / src / vnet / interface_funcs.h
index 42b69bd..9241b34 100644 (file)
@@ -46,6 +46,14 @@ vnet_get_hw_interface (vnet_main_t * vnm, u32 hw_if_index)
   return pool_elt_at_index (vnm->interface_main.hw_interfaces, hw_if_index);
 }
 
+always_inline vnet_hw_interface_t *
+vnet_get_hw_interface_or_null (vnet_main_t * vnm, u32 hw_if_index)
+{
+  if (!pool_is_free_index (vnm->interface_main.hw_interfaces, hw_if_index))
+    return pool_elt_at_index (vnm->interface_main.hw_interfaces, hw_if_index);
+  return (NULL);
+}
+
 always_inline vnet_sw_interface_t *
 vnet_get_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
 {
@@ -53,7 +61,7 @@ vnet_get_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
 }
 
 always_inline vnet_sw_interface_t *
-vnet_get_sw_interface_safe (vnet_main_t * vnm, u32 sw_if_index)
+vnet_get_sw_interface_or_null (vnet_main_t * vnm, u32 sw_if_index)
 {
   if (!pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
     return pool_elt_at_index (vnm->interface_main.sw_interfaces, sw_if_index);
@@ -74,6 +82,7 @@ vnet_get_sup_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
 {
   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
   if (sw->type == VNET_SW_INTERFACE_TYPE_SUB ||
+      sw->type == VNET_SW_INTERFACE_TYPE_PIPE ||
       sw->type == VNET_SW_INTERFACE_TYPE_P2P)
     sw = vnet_get_sw_interface (vnm, sw->sup_sw_if_index);
   return sw;
@@ -83,17 +92,25 @@ always_inline vnet_hw_interface_t *
 vnet_get_sup_hw_interface (vnet_main_t * vnm, u32 sw_if_index)
 {
   vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
-  ASSERT (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
+  ASSERT ((sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE) ||
+         (sw->type == VNET_SW_INTERFACE_TYPE_PIPE));
   return vnet_get_hw_interface (vnm, sw->hw_if_index);
 }
 
 always_inline vnet_hw_interface_t *
-vnet_get_sw_hw_interface (vnet_main_t * vnm, u32 sw_if_index)
+vnet_get_sup_hw_interface_api_visible_or_null (vnet_main_t * vnm,
+                                              u32 sw_if_index)
 {
-  vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
-  if (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
-    return vnet_get_hw_interface (vnm, sw->hw_if_index);
-  return vnet_get_sup_hw_interface (vnm, sw_if_index);
+  vnet_sw_interface_t *si;
+  if (PREDICT_FALSE (pool_is_free_index (vnm->interface_main.sw_interfaces,
+                                        sw_if_index)))
+    return NULL;
+  si = vnet_get_sup_sw_interface (vnm, sw_if_index);
+  if (PREDICT_FALSE (si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN))
+    return NULL;
+  ASSERT ((si->type == VNET_SW_INTERFACE_TYPE_HARDWARE) ||
+         (si->type == VNET_SW_INTERFACE_TYPE_PIPE));
+  return vnet_get_hw_interface (vnm, si->hw_if_index);
 }
 
 always_inline vnet_hw_interface_class_t *
@@ -148,11 +165,20 @@ vnet_clear_sw_interface_tag (vnet_main_t * vnm, u32 sw_if_index)
     }
 }
 
+/**
+ * Walk return code
+ */
+typedef enum walk_rc_t_
+{
+  WALK_STOP,
+  WALK_CONTINUE,
+} walk_rc_t;
+
 /**
  * Call back walk type for walking SW indices on a HW interface
  */
-typedef void (*vnet_hw_sw_interface_walk_t) (vnet_main_t * vnm,
-                                            u32 sw_if_index, void *ctx);
+typedef walk_rc_t (*vnet_hw_sw_interface_walk_t) (vnet_main_t * vnm,
+                                                 u32 sw_if_index, void *ctx);
 
 /**
  * @brief
@@ -163,6 +189,34 @@ void vnet_hw_interface_walk_sw (vnet_main_t * vnm,
                                u32 hw_if_index,
                                vnet_hw_sw_interface_walk_t fn, void *ctx);
 
+/**
+ * Call back walk type for walking SW indices on a HW interface
+ */
+typedef walk_rc_t (*vnet_sw_interface_walk_t) (vnet_main_t * vnm,
+                                              vnet_sw_interface_t * si,
+                                              void *ctx);
+
+/**
+ * @brief
+ * Walk all the SW interfaces in the system.
+ */
+void vnet_sw_interface_walk (vnet_main_t * vnm,
+                            vnet_sw_interface_walk_t fn, void *ctx);
+
+
+/**
+ * Call back walk type for walking all HW indices
+ */
+typedef walk_rc_t (*vnet_hw_interface_walk_t) (vnet_main_t * vnm,
+                                              u32 hw_if_index, void *ctx);
+
+/**
+ * @brief
+ * Walk all the HW interface
+ */
+void vnet_hw_interface_walk (vnet_main_t * vnm,
+                            vnet_hw_interface_walk_t fn, void *ctx);
+
 /* Register a hardware interface instance. */
 u32 vnet_register_interface (vnet_main_t * vnm,
                             u32 dev_class_index,
@@ -186,13 +240,26 @@ void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index);
 int vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index);
 
-always_inline uword
+always_inline vnet_sw_interface_flags_t
 vnet_sw_interface_get_flags (vnet_main_t * vnm, u32 sw_if_index)
 {
   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
   return sw->flags;
 }
 
+always_inline uword
+vnet_sw_interface_is_valid (vnet_main_t * vnm, u32 sw_if_index)
+{
+  return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index);
+}
+
+always_inline uword
+vnet_hw_interface_is_valid (vnet_main_t * vnm, u32 hw_if_index)
+{
+  return !pool_is_free_index (vnm->interface_main.hw_interfaces, hw_if_index);
+}
+
+
 always_inline uword
 vnet_sw_interface_is_admin_up (vnet_main_t * vnm, u32 sw_if_index)
 {
@@ -220,6 +287,13 @@ vnet_sw_interface_is_api_valid (vnet_main_t * vnm, u32 sw_if_index)
     && vnet_sw_interface_is_api_visible (vnm, sw_if_index);
 }
 
+always_inline const u8 *
+vnet_sw_interface_get_hw_address (vnet_main_t * vnm, u32 sw_if_index)
+{
+  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
+  return hw->hw_address;
+}
+
 always_inline uword
 vnet_hw_interface_get_flags (vnet_main_t * vnm, u32 hw_if_index)
 {
@@ -227,19 +301,44 @@ vnet_hw_interface_get_flags (vnet_main_t * vnm, u32 hw_if_index)
   return hw->flags;
 }
 
-always_inline uword
-vnet_sw_interface_get_mtu (vnet_main_t * vnm, u32 sw_if_index,
-                          vlib_rx_or_tx_t dir)
+always_inline u32
+vnet_hw_interface_get_mtu (vnet_main_t * vnm, u32 hw_if_index)
+{
+  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
+  return hw->max_packet_bytes;
+}
+
+always_inline u32
+vnet_sw_interface_get_mtu (vnet_main_t * vnm, u32 sw_if_index, vnet_mtu_t af)
 {
   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
-  return (sw->max_l3_packet_bytes[dir]);
+  u32 mtu;
+  mtu = sw->mtu[af] > 0 ? sw->mtu[af] : sw->mtu[VNET_MTU_L3];
+  if (mtu == 0)
+    return 9000;               /* $$$ Deal with interface-types not setting MTU */
+  return mtu;
 }
 
 always_inline uword
 vnet_hw_interface_is_link_up (vnet_main_t * vnm, u32 hw_if_index)
 {
-  return (vnet_hw_interface_get_flags (vnm, hw_if_index) &
-         VNET_HW_INTERFACE_FLAG_LINK_UP) != 0;
+  return ((vnet_hw_interface_get_flags (vnm, hw_if_index) &
+          VNET_HW_INTERFACE_FLAG_LINK_UP) != 0);
+}
+
+always_inline uword
+vnet_sw_interface_is_link_up (vnet_main_t * vnm, u32 sw_if_index)
+{
+  vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
+
+  return (vnet_hw_interface_is_link_up (vnm, sw->hw_if_index));
+}
+
+always_inline uword
+vnet_sw_interface_is_up (vnet_main_t * vnm, u32 sw_if_index)
+{
+  return (vnet_sw_interface_is_admin_up (vnm, sw_if_index) &&
+         vnet_sw_interface_is_link_up (vnm, sw_if_index));
 }
 
 always_inline vlib_frame_t *
@@ -257,13 +356,24 @@ vnet_put_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index,
   return vlib_put_frame_to_node (vlib_get_main (), hw->output_node_index, f);
 }
 
+always_inline void
+vnet_hw_interface_set_link_speed (vnet_main_t * vnm, u32 hw_if_index,
+                                 u32 link_speed)
+{
+  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
+  hw->link_speed = link_speed;
+}
+
 /* Change interface flags (e.g. up, down, enable, disable). */
 clib_error_t *vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index,
-                                          u32 flags);
+                                          vnet_hw_interface_flags_t flags);
 
 /* Change interface flags (e.g. up, down, enable, disable). */
 clib_error_t *vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index,
-                                          u32 flags);
+                                          vnet_sw_interface_flags_t flags);
+
+void vnet_sw_interface_admin_up (vnet_main_t * vnm, u32 sw_if_index);
+void vnet_sw_interface_admin_down (vnet_main_t * vnm, u32 sw_if_index);
 
 /* Change interface class. */
 clib_error_t *vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index,
@@ -280,10 +390,16 @@ void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
 clib_error_t *vnet_rename_interface (vnet_main_t * vnm, u32 hw_if_index,
                                     char *new_name);
 
+/* Add/delete secondary interface mac address*/
+clib_error_t *vnet_hw_interface_add_del_mac_address (vnet_main_t * vnm,
+                                                    u32 hw_if_index,
+                                                    const u8 * mac_address,
+                                                    u8 is_add);
+
 /* Change interface mac address*/
 clib_error_t *vnet_hw_interface_change_mac_address (vnet_main_t * vnm,
                                                    u32 hw_if_index,
-                                                   u8 * mac_address);
+                                                   const u8 * mac_address);
 
 /* Change rx-mode */
 clib_error_t *set_hw_interface_change_rx_mode (vnet_main_t * vnm,
@@ -293,8 +409,17 @@ clib_error_t *set_hw_interface_change_rx_mode (vnet_main_t * vnm,
                                               vnet_hw_interface_rx_mode
                                               mode);
 
+/* Set rx-placement on the interface */
+clib_error_t *set_hw_interface_rx_placement (u32 hw_if_index, u32 queue_id,
+                                            u32 thread_index, u8 is_main);
+
+/* Set the MTU on the HW interface */
+void vnet_hw_interface_set_mtu (vnet_main_t * vnm, u32 hw_if_index, u32 mtu);
+
 /* Set the MTU on the SW interface */
-int vnet_sw_interface_set_mtu (vnet_main_t * vnm, u32 sw_if_index, u32 mtu);
+void vnet_sw_interface_set_mtu (vnet_main_t * vnm, u32 sw_if_index, u32 mtu);
+void vnet_sw_interface_set_protocol_mtu (vnet_main_t * vnm, u32 sw_if_index,
+                                        u32 mtu[]);
 
 /* update the unnumbered state of an interface */
 void vnet_sw_interface_update_unnumbered (u32 sw_if_index,
@@ -302,10 +427,13 @@ void vnet_sw_interface_update_unnumbered (u32 sw_if_index,
 
 int vnet_sw_interface_stats_collect_enable_disable (u32 sw_if_index,
                                                    u8 enable);
+void vnet_sw_interface_ip_directed_broadcast (vnet_main_t * vnm,
+                                             u32 sw_if_index, u8 enable);
 
 /* Formats sw/hw interface. */
 format_function_t format_vnet_hw_interface;
 format_function_t format_vnet_hw_interface_rx_mode;
+format_function_t format_vnet_hw_if_index_name;
 format_function_t format_vnet_sw_interface;
 format_function_t format_vnet_sw_interface_name;
 format_function_t format_vnet_sw_interface_name_override;
@@ -330,8 +458,6 @@ typedef struct
 } vnet_interface_output_runtime_t;
 
 /* Interface output function. */
-void *vnet_interface_output_node_multiarch_select (void);
-
 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
                                uword sw_if_index1);
 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
@@ -350,11 +476,14 @@ typedef enum
 } vnet_interface_tx_next_t;
 
 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
+#define VNET_SIMULATED_ETHERNET_TX_NEXT_L2_INPUT (VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT + 1)
 
 typedef enum
 {
   VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DOWN,
   VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DELETED,
+  VNET_INTERFACE_OUTPUT_ERROR_NO_BUFFERS_FOR_GSO,
+  VNET_INTERFACE_OUTPUT_ERROR_UNHANDLED_GSO_TYPE,
 } vnet_interface_output_error_t;
 
 /* Format for interface output traces. */