[HICN-606] Added doxygen documentation

Signed-off-by: Alberto Compagno <acompagn+fdio@cisco.com>
Change-Id: If2bf7f4f310adf6adbbb9ea29eafcb2a0ee40d54

1 files changed, 32 insertions, 19 deletions

diff --git a/hicn-plugin/src/state.h b/hicn-plugin/src/state.h
index 7e984e6c3..37003d0ae 100644
--- a/hicn-plugin/src/state.h
+++ b/hicn-plugin/src/state.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Cisco and/or its affiliates.
+ * Copyright (c) 2017-2020 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at:
@@ -26,26 +26,26 @@
 #include "strategy_dpo_ctx.h"
 #include "strategy_dpo_manager.h"
 
-always_inline void
-hicn_prefetch_pcs_entry (hicn_buffer_t * hicnb, hicn_pit_cs_t * pitcs)
-{
-  hicn_hash_node_t *node = pool_elt_at_index (pitcs->pcs_table->ht_nodes,
-					      hicnb->node_id);
-
-  hicn_hash_bucket_t *bucket;
-  if (hicnb->hash_bucket_flags & HICN_HASH_NODE_OVERFLOW_BUCKET)
-    bucket =
-      pool_elt_at_index (pitcs->pcs_table->ht_overflow_buckets,
-			 hicnb->bucket_id);
-  else
-    bucket =
-      (hicn_hash_bucket_t *) (pitcs->pcs_table->ht_buckets +
-			      hicnb->bucket_id);
+/**
+ * @file plugin_state
+ *
+ * Helper functions to hicn state (hash node, hash entry, strategy vft, dpo vft and dpo context id)
+ *
+ */
 
-  CLIB_PREFETCH (node, CLIB_CACHE_LINE_BYTES, STORE);
-  CLIB_PREFETCH (bucket, CLIB_CACHE_LINE_BYTES, STORE);
-}
+//TODO exploit this state to prefetch hash nodes and entries.
 
+/**
+ * @brief Retrieve the hicn state
+ *
+ * @param hicnb hicn buffer used to retrieve the hicn state
+ * @param pitcs pointer to PIT/CS
+ * @param node node in the hash table referring to the buffer
+ * @param strategy_vft return value pointing to the strategy vft corresponding to the buffer
+ * @param dpo_vft return value pointing to the dpo vft corresponding to the buffer
+ * @param dpo_ctx_id return value pointing to the dpo context id corresponding to the buffer
+ * @param hash_entry entry in the hash table referring to the buffer
+ */
 always_inline void
 hicn_get_internal_state (hicn_buffer_t * hicnb, hicn_pit_cs_t * pitcs,
 			 hicn_hash_node_t ** node,
@@ -77,6 +77,19 @@ hicn_get_internal_state (hicn_buffer_t * hicnb, hicn_pit_cs_t * pitcs,
  * nodes can prefetch the corresponding state (PIT entry, dpo_ctx and the
  * strategy vft
  */
+/**
+ * @brief Store the hicn state in the hicn buffer
+ *
+ * @param b vlib buffer holding the hICN packet
+ * @param name_hash hash of the hICN name
+ * @param node_id id of the node in the hash table referring to the buffer
+ * @param dpo_ctx_id id of the dpo context id corresponding to the buffer
+ * @param vft_id id of the strategy vft corresponding to the buffer
+ * @param hash_entry_id id of the entry in the hash table referring to the buffer
+ * @param bucket_id id of the hasth table bucket that holds the hash entry
+ * @param bucket_is_overflow 1 if the bucket is from the ht_overflow_buckets pool
+ *                           0 if the bucket is from the ht_buckets pool
+ */
 always_inline void
 hicn_store_internal_state (vlib_buffer_t * b, u64 name_hash, u32 node_id,
 			   u8 dpo_ctx_id, u8 vft_id, u8 hash_entry_id,