fib: fix some typos in fib/mtrie

Type: fix

Change-Id: I1af0e4a9bc23a3b6b6d3a74df093801ab6cae1f8
Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>

src/plugins/ila/ila.h

@@ -82,7 +82,7 @@ typedef struct {
   u32 next_hop_child_index;
 
   /**
-   * The next DPO in the grpah to follow
+   * The next DPO in the graph to follow
    */
   dpo_id_t ila_dpo;
 } ila_entry_t;

src/vnet/adj/adj.h

@@ -216,14 +216,14 @@ extern u8* format_adj_flags(u8 * s, va_list * args);
  * @brief IP unicast adjacency.
  *  @note cache aligned.
  *
- * An adjacency is a represenation of a peer on a particular link.
+ * An adjacency is a representation of a peer on a particular link.
  */
 typedef struct ip_adjacency_t_
 {
   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 
   /**
-   * Linkage into the FIB node grpah. First member since this type
+   * Linkage into the FIB node graph. First member since this type
    * has 8 byte alignment requirements.
    */
   fib_node_t ia_node;
@@ -243,7 +243,7 @@ typedef struct ip_adjacency_t_
 
   /**
    * The protocol of the neighbor/peer. i.e. the protocol with
-   * which to interpret the 'next-hop' attirbutes of the sub-types.
+   * which to interpret the 'next-hop' attributes of the sub-types.
    * 1-btyes
    */
   fib_protocol_t ia_nh_proto;
@@ -329,10 +329,10 @@ typedef struct ip_adjacency_t_
 } ip_adjacency_t;
 
 STATIC_ASSERT ((STRUCT_OFFSET_OF (ip_adjacency_t, cacheline0) == 0),
-	       "IP adjacency cachline 0 is not offset");
+	       "IP adjacency cacheline 0 is not offset");
 STATIC_ASSERT ((STRUCT_OFFSET_OF (ip_adjacency_t, cacheline1) ==
 		CLIB_CACHE_LINE_BYTES),
-	       "IP adjacency cachline 1 is more than one cachline size offset");
+	       "IP adjacency cacheline 1 is more than one cacheline size offset");
 
 /**
  * @brief
@@ -409,7 +409,7 @@ extern int adj_recursive_loop_detect (adj_index_t ai,
 
 /**
  * @brief
- * The global adjacnecy pool. Exposed for fast/inline data-plane access
+ * The global adjacency pool. Exposed for fast/inline data-plane access
  */
 extern ip_adjacency_t *adj_pool;
 

src/vnet/devices/pipe/pipe.h

@@ -19,7 +19,7 @@
 #include <vnet/ethernet/ethernet.h>
 
 /**
- * represenation of a pipe interface
+ * representation of a pipe interface
  */
 typedef struct pipe_t_
 {

src/vnet/dhcp/dhcp_proxy.h

@@ -96,7 +96,7 @@ typedef struct dhcp_server_t_
 } dhcp_server_t;
 
 /**
- * @brief A DHCP proxy represenation fpr per-client VRF config
+ * @brief A DHCP proxy representation fpr per-client VRF config
  */
 typedef struct dhcp_proxy_t_
 {

src/vnet/dpo/dpo.h

@@ -334,7 +334,7 @@ extern void dpo_stack(dpo_type_t child_type,
  *  VLIB graph arcs are created, from the child_node passed.
  *
  * @param child_node
- *  The VLIB grpah node index to create an arc from to the parent
+ *  The VLIB graph node index to create an arc from to the parent
  *
  * @param dpo
  *  This is the DPO to stack and set.

src/vnet/dpo/load_balance.c

@@ -449,7 +449,7 @@ ip_multipath_normalize_next_hops (const load_balance_path_t * raw_next_hops,
                 /*
                  * when the weight skew is high (norm is small) and n == nf.
                  * without this correction the path with a low weight would have
-                 * no represenation in the load-balanace - don't want that.
+                 * no representation in the load-balanace - don't want that.
                  * If the weight skew is high so the load-balance has many buckets
                  * to allow it. pays ya money takes ya choice.
                  */

src/vnet/dpo/load_balance.h

@@ -175,7 +175,7 @@ typedef struct load_balance_t_ {
 } load_balance_t;
 
 STATIC_ASSERT(sizeof(load_balance_t) <= CLIB_CACHE_LINE_BYTES,
-	      "A load_balance object size exceeds one cachline");
+	      "A load_balance object size exceeds one cacheline");
 
 /**
  * Flags controlling load-balance formatting/display

src/vnet/dpo/replicate_dpo.h

@@ -107,7 +107,7 @@ typedef struct replicate_t_ {
 } replicate_t;
 
 STATIC_ASSERT(sizeof(replicate_t) <= CLIB_CACHE_LINE_BYTES,
-	      "A replicate object size exceeds one cachline");
+	      "A replicate object size exceeds one cacheline");
 
 /**
  * Flags controlling load-balance formatting/display

src/vnet/fib/fib_entry.h

@@ -23,7 +23,7 @@
 
 /**
  * The different sources that can create a route.
- * The sources are defined here the thier relative priority order.
+ * The sources are defined here with their relative priority order.
  * The lower the value the higher the priority
  */
 typedef enum fib_source_t_ {
@@ -193,7 +193,7 @@ STATIC_ASSERT (sizeof(fib_source_t) == 1,
 
 /**
  * The different sources that can create a route.
- * The sources are defined here the thier relative priority order.
+ * The sources are defined here with their relative priority order.
  * The lower the value the higher the priority
  */
 typedef enum fib_entry_attribute_t_ {

src/vnet/fib/fib_node.h

@@ -175,7 +175,7 @@ typedef enum fib_node_bw_flags_t_
 } fib_node_bw_flags_t;
 
 /**
- * Forward eclarations
+ * Forward declarations
  */
 struct fib_node_t_;
 

src/vnet/fib/fib_path.c

@@ -676,7 +676,7 @@ static void
 fib_path_attached_next_hop_set (fib_path_t *path)
 {
     /*
-     * resolve directly via the adjacnecy discribed by the
+     * resolve directly via the adjacency discribed by the
      * interface and next-hop
      */
     dpo_set(&path->fp_dpo,

src/vnet/fib/fib_path_list.c

@@ -29,7 +29,7 @@
 
 /**
  * The magic number of child entries that make a path-list popular.
- * There's a trade-off here between convergnece and forwarding speed.
+ * There's a trade-off here between convergence and forwarding speed.
  * Popular path-lists generate load-balance maps for the entries that
  * use them. If the map is present there is a switch path cost to indirect
  * through the map - this indirection provides the fast convergence - so
@@ -512,7 +512,7 @@ fib_path_list_back_walk_notify (fib_node_t *node,
 {
     /*
      * the path-list is not a direct child of any other node type
-     * paths, which do not change thier to-list-mapping, save the
+     * paths, which do not change their to-list-mapping, save the
      * list they are a member of, and invoke the BW function directly.
      */
     ASSERT(0);

src/vnet/fib/fib_types.h

@@ -198,7 +198,7 @@ extern fib_forward_chain_type_t fib_forw_chain_type_from_fib_proto(fib_protocol_
 extern dpo_proto_t fib_forw_chain_type_to_dpo_proto(fib_forward_chain_type_t fct);
 
 /**
- * Aggregrate type for a prefix
+ * Aggregate type for a prefix
  */
 typedef struct fib_prefix_t_ {
     /**

src/vnet/fib/fib_walk.c

@@ -127,7 +127,7 @@ static const char * const fib_walk_queue_stats_names[] = FIB_WALK_QUEUE_STATS;
 static const char * const fib_node_bw_reason_names[] = FIB_NODE_BW_REASONS;
 
 /**
- * A represenation of one queue of walk
+ * A representation of one queue of walk
  */
 typedef struct fib_walk_queue_t_
 {
@@ -738,7 +738,7 @@ fib_walk_async (fib_node_type_t parent_type,
  * @brief Back walk all the children of a FIB node.
  *
  * note this is a synchronous depth first walk. Children visited may propagate
- * the walk to thier children. Other children node types may not propagate,
+ * the walk to their children. Other children node types may not propagate,
  * synchronously but instead queue the walk for later async completion.
  */
 void

src/vnet/fib/ip4_fib.c

@@ -18,7 +18,7 @@
 #include <vnet/fib/ip4_fib.h>
 
 /*
- * A table of pefixes to be added to tables and the sources for them
+ * A table of prefixes to be added to tables and the sources for them
  */
 typedef struct ip4_fib_table_special_prefix_t_ {
     fib_prefix_t ift_prefix;
@@ -435,7 +435,7 @@ ip4_fib_table_sub_tree_walk (ip4_fib_t *fib,
     int i;
 
     /*
-     * There is no efficent way to walk this array of hash tables.
+     * There is no efficient way to walk this array of hash tables.
      * so we walk each table with a mask length greater than and equal to
      * the required root and check it is covered by the root.
      */

src/vnet/ip/ip4_mtrie.c

@@ -198,7 +198,7 @@ get_next_ply_for_leaf (ip4_fib_mtrie_t * m, ip4_fib_mtrie_leaf_t l)
 void
 ip4_mtrie_free (ip4_fib_mtrie_t * m)
 {
-  /* the root ply is embedded so the is nothing to do,
+  /* the root ply is embedded so there is nothing to do,
    * the assumption being that the IP4 FIB table has emptied the trie
    * before deletion.
    */

src/vnet/ip/ip4_mtrie.h

@@ -108,7 +108,7 @@ typedef struct ip4_fib_mtrie_8_ply_t_
   i32 n_non_empty_leafs;
 
   /**
-   * The length of the ply's coviering prefix. Also a measure of its depth
+   * The length of the ply's covering prefix. Also a measure of its depth
    * If a leaf in a slot has a mask length longer than this then it is
    * 'non-empty'. Otherwise it is the value of the cover.
    */
@@ -131,7 +131,7 @@ typedef struct
   /**
    * Embed the PLY with the mtrie struct. This means that the Data-plane
    * 'get me the mtrie' returns the first ply, and not an indirect 'pointer'
-   * to it. therefore no cachline misses in the data-path.
+   * to it. therefore no cacheline misses in the data-path.
    */
   ip4_fib_mtrie_16_ply_t root_ply;
 } ip4_fib_mtrie_t;
@@ -147,13 +147,13 @@ void ip4_mtrie_init (ip4_fib_mtrie_t * m);
 void ip4_mtrie_free (ip4_fib_mtrie_t * m);
 
 /**
- * @brief Add a route/rntry to the mtrie
+ * @brief Add a route/entry to the mtrie
  */
 void ip4_fib_mtrie_route_add (ip4_fib_mtrie_t * m,
 			      const ip4_address_t * dst_address,
 			      u32 dst_address_length, u32 adj_index);
 /**
- * @brief remove a route/rntry to the mtrie
+ * @brief remove a route/entry to the mtrie
  */
 void ip4_fib_mtrie_route_del (ip4_fib_mtrie_t * m,
 			      const ip4_address_t * dst_address,
@@ -177,7 +177,7 @@ format_function_t format_ip4_fib_mtrie;
 extern ip4_fib_mtrie_8_ply_t *ip4_ply_pool;
 
 /**
- * Is the leaf terminal (i.e. an LB index) or non-terminak (i.e. a PLY index)
+ * Is the leaf terminal (i.e. an LB index) or non-terminal (i.e. a PLY index)
  */
 always_inline u32
 ip4_fib_mtrie_leaf_is_terminal (ip4_fib_mtrie_leaf_t n)

src/vnet/ip/ip6.h

@@ -122,7 +122,7 @@ typedef enum ip6_fib_table_instance_type_t_
 {
     /**
      * This table stores the routes that are used to forward traffic.
-     * The key is the prefix, the result the adjacnecy to forward on.
+     * The key is the prefix, the result the adjacency to forward on.
      */
   IP6_FIB_TABLE_FWDING,
     /**
@@ -137,7 +137,7 @@ typedef enum ip6_fib_table_instance_type_t_
 #define IP6_FIB_NUM_TABLES (IP6_FIB_TABLE_NON_FWDING+1)
 
 /**
- * A represenation of a single IP6 table
+ * A representation of a single IP6 table
  */
 typedef struct ip6_fib_table_instance_t_
 {
@@ -151,7 +151,7 @@ typedef struct ip6_fib_table_instance_t_
 } ip6_fib_table_instance_t;
 
 /**
- * A represenation of a single IP6 mfib table
+ * A representation of a single IP6 mfib table
  */
 typedef struct ip6_mfib_table_instance_t_
 {

src/vnet/ip/ip6_ll_types.h

@@ -19,7 +19,7 @@
 #include <vnet/ip/ip6_packet.h>
 
 /**
- * Aggregrate type for a prefix in the IPv6 Link-local table
+ * Aggregate type for a prefix in the IPv6 Link-local table
  */
 typedef struct ip6_ll_prefix_t_
 {

src/vnet/mfib/mfib_types.h

@@ -19,7 +19,7 @@
 #include <vnet/fib/fib_types.h>
 
 /**
- * Aggregrate type for a prefix
+ * Aggregate type for a prefix
  */
 typedef struct mfib_prefix_t_ {
     /**