Fix packet trace for IP4/IP6 lookup/forwarding nodes

[vpp.git] / vnet / vnet / l2 / l2_bd.h

diff --git a/vnet/vnet/l2/l2_bd.h b/vnet/vnet/l2/l2_bd.h
index 9ff0a86..2d7853e 100644 (file)
--- a/vnet/vnet/l2/l2_bd.h
+++ b/vnet/vnet/l2/l2_bd.h
@@ -21,78 +21,76 @@
 #include <vlib/vlib.h>
 #include <vnet/vnet.h>
 
-typedef struct {
-  // hash bd_id -> bd_index
-  uword * bd_index_by_bd_id;
+typedef struct
+{
+  /* hash bd_id -> bd_index */
+  uword *bd_index_by_bd_id;
 
-  // Busy bd_index bitmap
-  uword * bd_index_bitmap;
+  /* Busy bd_index bitmap */
+  uword *bd_index_bitmap;
 
-  // convenience
-  vlib_main_t * vlib_main;
-  vnet_main_t * vnet_main;
+  /* convenience */
+  vlib_main_t *vlib_main;
+  vnet_main_t *vnet_main;
 } bd_main_t;
 
 bd_main_t bd_main;
 
-// Bridge domain member 
+/* Bridge domain member  */
 
 #define L2_FLOOD_MEMBER_NORMAL 0
 #define L2_FLOOD_MEMBER_BVI    1
 
-typedef struct {
-  u32  sw_if_index;  // the output L2 interface
-  u8   flags;        // 0=normal, 1=bvi
-  u8   shg;          // split horizon group number 
-  u16  spare;
+typedef struct
+{
+  u32 sw_if_index;             /* the output L2 interface */
+  u8 flags;                    /* 0=normal, 1=bvi */
+  u8 shg;                      /* split horizon group number  */
+  u16 spare;
 } l2_flood_member_t;
 
 
-// Per-bridge domain configuration
+/* Per-bridge domain configuration */
 
-typedef struct {
-  u32 feature_bitmap; 
-  // Contains bit enables for flooding, learning, and forwarding.
-  // All other feature bits should always be set.
-
-  // identity of the bridge-domain's BVI interface
-  // set to ~0 if there is no BVI
+typedef struct
+{
+  u32 feature_bitmap;
+  /*
+   * Contains bit enables for flooding, learning, and forwarding.
+   * All other feature bits should always be set.
+   *
+   * identity of the bridge-domain's BVI interface
+   * set to ~0 if there is no BVI
+   */
   u32 bvi_sw_if_index;
 
-  // output node index for bvi interface before it was changed to l2-input
-  u32 saved_bvi_output_node_index;
-
-  // bridge domain id, not to be confused with bd_index
+  /* bridge domain id, not to be confused with bd_index */
   u32 bd_id;
 
-  // Vector of members in the replication group
-  l2_flood_member_t * members;
+  /* Vector of members in the replication group */
+  l2_flood_member_t *members;
 
-  // hash ip4/ip6 -> mac for arp termination
+  /* hash ip4/ip6 -> mac for arp/nd termination */
   uword *mac_by_ip4;
   uword *mac_by_ip6;
 
 } l2_bridge_domain_t;
 
-// Return 1 if bridge domain has been initialized
+/* Return 1 if bridge domain has been initialized */
 always_inline u32
-bd_is_valid (l2_bridge_domain_t * bd_config) 
+bd_is_valid (l2_bridge_domain_t * bd_config)
 {
   return (bd_config->feature_bitmap != 0);
 }
 
-// Init bridge domain if not done already
-void
-bd_validate (l2_bridge_domain_t * bd_config);
+/* Init bridge domain if not done already */
+void bd_validate (l2_bridge_domain_t * bd_config);
 
 
 void
-bd_add_member (l2_bridge_domain_t * bd_config,
-               l2_flood_member_t * member);
+bd_add_member (l2_bridge_domain_t * bd_config, l2_flood_member_t * member);
 
-u32
-bd_remove_member (l2_bridge_domain_t * bd_config,
-                  u32 sw_if_index);
+u32 bd_remove_member (l2_bridge_domain_t * bd_config, u32 sw_if_index);
 
 
 #define L2_LEARN   (1<<0)
@@ -101,20 +99,39 @@ bd_remove_member (l2_bridge_domain_t * bd_config,
 #define L2_UU_FLOOD (1<<3)
 #define L2_ARP_TERM (1<<4)
 
-u32 
-bd_set_flags (vlib_main_t * vm,
-              u32 bd_index,
-              u32 flags,
-              u32 enable);
+u32 bd_set_flags (vlib_main_t * vm, u32 bd_index, u32 flags, u32 enable);
 
+/**
+ * \brief Get or create a bridge domain.
+ *
+ * Get or create a bridge domain with the given bridge domain ID.
+ *
+ * \param bdm bd_main pointer.
+ * \param bd_id The bridge domain ID or ~0 if an arbitrary unused bridge domain should be used.
+ * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
+ */
 u32 bd_find_or_add_bd_index (bd_main_t * bdm, u32 bd_id);
+
+/**
+ * \brief Delete a bridge domain.
+ *
+ * Delete an existing bridge domain with the given bridge domain ID.
+ *
+ * \param bdm bd_main pointer.
+ * \param bd_id The bridge domain ID.
+ * \return 0 on success and -1 if the bridge domain does not exist.
+ */
 int bd_delete_bd_index (bd_main_t * bdm, u32 bd_id);
 
-u32 bd_add_del_ip_mac(u32 bd_index,
-                     u8 *ip_addr,
-                     u8 *mac_addr,
-                     u8 is_ip6,
-                     u8 is_add);
+u32 bd_add_del_ip_mac (u32 bd_index,
+                      u8 * ip_addr, u8 * mac_addr, u8 is_ip6, u8 is_add);
 
 #endif
 
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */