VPP-307: Documentation for vnet/vnet/vxlan-gpe
[vpp.git] / vnet / vnet / vxlan-gpe / vxlan_gpe.c
index 2baf182..a2b8978 100644 (file)
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ *  @file
+ *  @brief Common utility functions for IPv4 and IPv6 VXLAN GPE tunnels
+ *
+*/
 #include <vnet/vxlan-gpe/vxlan_gpe.h>
 #include <vnet/ip/format.h>
 
 vxlan_gpe_main_t vxlan_gpe_main;
 
+/**
+ * @brief Tracing function for VXLAN GPE tunnel packets
+ *
+ * @param *s formatting string
+ * @param *args
+ *
+ * @return *s formatted string
+ *
+ */
 u8 * format_vxlan_gpe_tunnel (u8 * s, va_list * args)
 {
   vxlan_gpe_tunnel_t * t = va_arg (*args, vxlan_gpe_tunnel_t *);
@@ -24,8 +38,8 @@ u8 * format_vxlan_gpe_tunnel (u8 * s, va_list * args)
 
   s = format (s, "[%d] local: %U remote: %U ",
               t - gm->tunnels,
-              format_ip46_address, &t->local,
-              format_ip46_address, &t->remote);
+              format_ip46_address, &t->local, IP46_TYPE_ANY,
+              format_ip46_address, &t->remote, IP46_TYPE_ANY);
 
   s = format (s, "  vxlan VNI %d ", t->vni);
 
@@ -54,13 +68,21 @@ u8 * format_vxlan_gpe_tunnel (u8 * s, va_list * args)
   return s;
 }
 
+/**
+ * @brief Naming for VXLAN GPE tunnel
+ *
+ * @param *s formatting string
+ * @param *args
+ *
+ * @return *s formatted string
+ *
+ */
 static u8 * format_vxlan_gpe_name (u8 * s, va_list * args)
 {
   u32 dev_instance = va_arg (*args, u32);
   return format (s, "vxlan_gpe_tunnel%d", dev_instance);
 }
 
-
 static uword dummy_interface_tx (vlib_main_t * vm,
                                  vlib_node_runtime_t * node,
                                  vlib_frame_t * frame)
@@ -68,11 +90,34 @@ static uword dummy_interface_tx (vlib_main_t * vm,
   clib_warning ("you shouldn't be here, leaking buffers...");
   return frame->n_vectors;
 }
+
+/**
+ * @brief CLI function for VXLAN GPE admin up/down
+ *
+ * @param *vnm
+ * @param hw_if_index
+ * @param flag
+ *
+ * @return *rc
+ *
+ */
+static clib_error_t *
+vxlan_gpe_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
+{
+  if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
+    vnet_hw_interface_set_flags (vnm, hw_if_index, VNET_HW_INTERFACE_FLAG_LINK_UP);
+  else
+    vnet_hw_interface_set_flags (vnm, hw_if_index, 0);
+
+  return 0;
+}
+
 VNET_DEVICE_CLASS (vxlan_gpe_device_class,static) = {
   .name = "VXLAN_GPE",
   .format_device_name = format_vxlan_gpe_name,
   .format_tx_trace = format_vxlan_gpe_encap_trace,
   .tx_function = dummy_interface_tx,
+  .admin_up_down_function = vxlan_gpe_interface_admin_up_down,
 };
 
 static uword dummy_set_rewrite (vnet_main_t * vnm,
@@ -86,6 +131,15 @@ static uword dummy_set_rewrite (vnet_main_t * vnm,
 }
 
 
+/**
+ * @brief Formatting function for tracing VXLAN GPE with length
+ *
+ * @param *s
+ * @param *args
+ *
+ * @return *s
+ *
+ */
 static u8 * format_vxlan_gpe_header_with_length (u8 * s, va_list * args)
 {
   u32 dev_instance = va_arg (*args, u32);
@@ -104,8 +158,7 @@ VNET_HW_INTERFACE_CLASS (vxlan_gpe_hw_class) = {
 _(vni)                                          \
 _(protocol)                                \
 _(encap_fib_index)                              \
-_(decap_fib_index)                              \
-_(decap_next_index)
+_(decap_fib_index)
 
 #define foreach_copy_ipv4 {                     \
   _(local.ip4.as_u32)                           \
@@ -120,6 +173,14 @@ _(decap_next_index)
 }
 
 
+/**
+ * @brief Calculate IPv4 VXLAN GPE rewrite header
+ *
+ * @param *t
+ *
+ * @return rc
+ *
+ */
 static int vxlan4_gpe_rewrite (vxlan_gpe_tunnel_t * t)
 {
   u8 *rw = 0;
@@ -151,13 +212,21 @@ static int vxlan4_gpe_rewrite (vxlan_gpe_tunnel_t * t)
   /* VXLAN header. Are we having fun yet? */
   h0->vxlan.flags = VXLAN_GPE_FLAGS_I | VXLAN_GPE_FLAGS_P;
   h0->vxlan.ver_res = VXLAN_GPE_VERSION;
-  h0->vxlan.protocol = VXLAN_GPE_PROTOCOL_IP4;
+  h0->vxlan.protocol = t->protocol;
   h0->vxlan.vni_res = clib_host_to_net_u32 (t->vni<<8);
 
   t->rewrite = rw;
   return (0);
 }
 
+/**
+ * @brief Calculate IPv6 VXLAN GPE rewrite header
+ *
+ * @param *t
+ *
+ * @return rc
+ *
+ */
 static int vxlan6_gpe_rewrite (vxlan_gpe_tunnel_t * t)
 {
   u8 *rw = 0;
@@ -189,14 +258,23 @@ static int vxlan6_gpe_rewrite (vxlan_gpe_tunnel_t * t)
   /* VXLAN header. Are we having fun yet? */
   h0->vxlan.flags = VXLAN_GPE_FLAGS_I | VXLAN_GPE_FLAGS_P;
   h0->vxlan.ver_res = VXLAN_GPE_VERSION;
-  h0->vxlan.protocol = VXLAN_GPE_PROTOCOL_IP4;
+  h0->vxlan.protocol = t->protocol;
   h0->vxlan.vni_res = clib_host_to_net_u32 (t->vni<<8);
 
   t->rewrite = rw;
   return (0);
 }
 
-int vnet_vxlan_gpe_add_del_tunnel 
+/**
+ * @brief Add or Del a VXLAN GPE tunnel
+ *
+ * @param *a
+ * @param *sw_if_index
+ *
+ * @return rc
+ *
+ */
+int vnet_vxlan_gpe_add_del_tunnel
 (vnet_vxlan_gpe_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
 {
   vxlan_gpe_main_t * gm = &vxlan_gpe_main;
@@ -210,7 +288,7 @@ int vnet_vxlan_gpe_add_del_tunnel
   vxlan4_gpe_tunnel_key_t key4, *key4_copy;
   vxlan6_gpe_tunnel_key_t key6, *key6_copy;
   hash_pair_t *hp;
-  
+
   if (!a->is_ip6)
   {
     key4.local = a->local.ip4.as_u32;
@@ -230,19 +308,16 @@ int vnet_vxlan_gpe_add_del_tunnel
 
     p = hash_get_mem(gm->vxlan6_gpe_tunnel_by_key, &key6);
   }
-  
+
   if (a->is_add)
     {
       /* adding a tunnel: tunnel must not already exist */
-      if (p) 
+      if (p)
         return VNET_API_ERROR_INVALID_VALUE;
-      
-      if (a->decap_next_index >= VXLAN_GPE_INPUT_N_NEXT)
-        return VNET_API_ERROR_INVALID_DECAP_NEXT;
-      
+
       pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
       memset (t, 0, sizeof (*t));
-      
+
       /* copy from arg structure */
 #define _(x) t->x = a->x;
       foreach_gpe_copy_field;
@@ -278,18 +353,18 @@ int vnet_vxlan_gpe_add_del_tunnel
           hash_set_mem (gm->vxlan6_gpe_tunnel_by_key, key6_copy,
                         t - gm->tunnels);
       }
-      
+
       if (vec_len (gm->free_vxlan_gpe_tunnel_hw_if_indices) > 0)
         {
           hw_if_index = gm->free_vxlan_gpe_tunnel_hw_if_indices
             [vec_len (gm->free_vxlan_gpe_tunnel_hw_if_indices)-1];
           _vec_len (gm->free_vxlan_gpe_tunnel_hw_if_indices) -= 1;
-          
+
           hi = vnet_get_hw_interface (vnm, hw_if_index);
           hi->dev_instance = t - gm->tunnels;
           hi->hw_instance = hi->dev_instance;
         }
-      else 
+      else
         {
           hw_if_index = vnet_register_interface
             (vnm, vxlan_gpe_device_class.index, t - gm->tunnels,
@@ -297,17 +372,19 @@ int vnet_vxlan_gpe_add_del_tunnel
           hi = vnet_get_hw_interface (vnm, hw_if_index);
           hi->output_node_index = vxlan_gpe_encap_node.index;
         }
-      
+
       t->hw_if_index = hw_if_index;
       t->sw_if_index = sw_if_index = hi->sw_if_index;
-      
-      vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 
+      vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
+      gm->tunnel_index_by_sw_if_index[sw_if_index] = t - gm->tunnels;
+
+      vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
                                    VNET_SW_INTERFACE_FLAG_ADMIN_UP);
     }
   else
     {
       /* deleting a tunnel: tunnel must exist */
-      if (!p) 
+      if (!p)
         return VNET_API_ERROR_NO_SUCH_ENTRY;
 
       t = pool_elt_at_index (gm->tunnels, p[0]);
@@ -315,6 +392,8 @@ int vnet_vxlan_gpe_add_del_tunnel
       vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */);
       vec_add1 (gm->free_vxlan_gpe_tunnel_hw_if_indices, t->hw_if_index);
 
+      gm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
+
       if (!a->is_ip6)
       {
         hp = hash_get_pair (gm->vxlan4_gpe_tunnel_by_key, &key4);
@@ -340,6 +419,14 @@ int vnet_vxlan_gpe_add_del_tunnel
   return 0;
 }
 
+/**
+ * @brief Find the IPv4 FIB index from the FIB ID
+ *
+ * @param fib_id
+ *
+ * @return fib_index
+ *
+ */
 static u32 fib4_index_from_fib_id (u32 fib_id)
 {
   ip4_main_t * im = &ip4_main;
@@ -352,6 +439,14 @@ static u32 fib4_index_from_fib_id (u32 fib_id)
   return p[0];
 }
 
+/**
+ * @brief Find the IPv4 FIB index from the FIB ID
+ *
+ * @param fib_id
+ *
+ * @return fib_index
+ *
+ */
 static u32 fib6_index_from_fib_id (u32 fib_id)
 {
   ip6_main_t * im = &ip6_main;
@@ -364,26 +459,16 @@ static u32 fib6_index_from_fib_id (u32 fib_id)
   return p[0];
 }
 
-static uword unformat_gpe_decap_next (unformat_input_t * input, va_list * args)
-{
-  u32 * result = va_arg (*args, u32 *);
-  u32 tmp;
-  
-  if (unformat (input, "drop"))
-    *result = VXLAN_GPE_INPUT_NEXT_DROP;
-  else if (unformat (input, "ip4"))
-    *result = VXLAN_GPE_INPUT_NEXT_IP4_INPUT;
-  else if (unformat (input, "ip6"))
-    *result = VXLAN_GPE_INPUT_NEXT_IP6_INPUT;
-  else if (unformat (input, "ethernet"))
-    *result = VXLAN_GPE_INPUT_NEXT_ETHERNET_INPUT;
-  else if (unformat (input, "%d", &tmp))
-    *result = tmp;
-  else
-    return 0;
-  return 1;
-}
-
+/**
+ * @brief CLI function for Add/Del of IPv4/IPv6 VXLAN GPE tunnel
+ *
+ * @param *vm
+ * @param *input
+ * @param *cmd
+ *
+ * @return error
+ *
+ */
 static clib_error_t *
 vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
                                    unformat_input_t * input,
@@ -399,14 +484,13 @@ vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
   u32 encap_fib_index = 0;
   u32 decap_fib_index = 0;
   u8 protocol = VXLAN_GPE_PROTOCOL_IP4;
-  u32 decap_next_index = VXLAN_GPE_INPUT_NEXT_IP4_INPUT; 
   u32 vni;
   u8 vni_set = 0;
   int rv;
   u32 tmp;
   vnet_vxlan_gpe_add_del_tunnel_args_t _a, * a = &_a;
   u32 sw_if_index;
-  
+
   /* Get a line of input. */
   if (! unformat_user (input, unformat_line_input, line_input))
     return 0;
@@ -414,7 +498,7 @@ vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
     if (unformat (line_input, "del"))
       is_add = 0;
-    else if (unformat (line_input, "local %U", 
+    else if (unformat (line_input, "local %U",
                        unformat_ip4_address, &local.ip4))
     {
       local_set = 1;
@@ -459,9 +543,6 @@ vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
         if (decap_fib_index == ~0)
           return clib_error_return (0, "nonexistent decap fib id %d", tmp);
       }
-    else if (unformat (line_input, "decap-next %U", unformat_gpe_decap_next, 
-                       &decap_next_index))
-      ;
     else if (unformat (line_input, "vni %d", &vni))
       vni_set = 1;
     else if (unformat(line_input, "next-ip4"))
@@ -472,8 +553,8 @@ vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
       protocol = VXLAN_GPE_PROTOCOL_ETHERNET;
     else if (unformat(line_input, "next-nsh"))
       protocol = VXLAN_GPE_PROTOCOL_NSH;
-    else 
-      return clib_error_return (0, "parse error: '%U'", 
+    else
+      return clib_error_return (0, "parse error: '%U'",
                                 format_unformat_error, line_input);
   }
 
@@ -523,7 +604,7 @@ vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
       return clib_error_return (0, "tunnel does not exist...");
 
     default:
-      return clib_error_return 
+      return clib_error_return
         (0, "vnet_vxlan_gpe_add_del_tunnel returned %d", rv);
     }
 
@@ -532,7 +613,7 @@ vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
 
 VLIB_CLI_COMMAND (create_vxlan_gpe_tunnel_command, static) = {
   .path = "create vxlan-gpe tunnel",
-  .short_help = 
+  .short_help =
   "create vxlan-gpe tunnel local <local-addr> remote <remote-addr>"
   " vni <nn> [next-ip4][next-ip6][next-ethernet][next-nsh]"
   " [encap-vrf-id <nn>] [decap-vrf-id <nn>]"
@@ -540,6 +621,16 @@ VLIB_CLI_COMMAND (create_vxlan_gpe_tunnel_command, static) = {
   .function = vxlan_gpe_add_del_tunnel_command_fn,
 };
 
+/**
+ * @brief CLI function for showing VXLAN GPE tunnels
+ *
+ * @param *vm
+ * @param *input
+ * @param *cmd
+ *
+ * @return error
+ *
+ */
 static clib_error_t *
 show_vxlan_gpe_tunnel_command_fn (vlib_main_t * vm,
                                 unformat_input_t * input,
@@ -547,7 +638,7 @@ show_vxlan_gpe_tunnel_command_fn (vlib_main_t * vm,
 {
   vxlan_gpe_main_t * gm = &vxlan_gpe_main;
   vxlan_gpe_tunnel_t * t;
-  
+
   if (pool_elts (gm->tunnels) == 0)
     vlib_cli_output (vm, "No vxlan-gpe tunnels configured.");
 
@@ -555,7 +646,7 @@ show_vxlan_gpe_tunnel_command_fn (vlib_main_t * vm,
   ({
     vlib_cli_output (vm, "%U", format_vxlan_gpe_tunnel, t);
   }));
-  
+
   return 0;
 }
 
@@ -564,10 +655,18 @@ VLIB_CLI_COMMAND (show_vxlan_gpe_tunnel_command, static) = {
     .function = show_vxlan_gpe_tunnel_command_fn,
 };
 
+/**
+ * @brief Feature init function for VXLAN GPE
+ *
+ * @param *vm
+ *
+ * @return error
+ *
+ */
 clib_error_t *vxlan_gpe_init (vlib_main_t *vm)
 {
   vxlan_gpe_main_t *gm = &vxlan_gpe_main;
-  
+
   gm->vnet_main = vnet_get_main();
   gm->vlib_main = vm;