[HICN-181] Added round robin strategy

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

1 files changed, 312 insertions, 0 deletions

diff --git a/hicn-plugin/src/strategies/dpo_rr.c b/hicn-plugin/src/strategies/dpo_rr.c
new file mode 100644
index 000000000..c9ec50445
--- /dev/null
+++ b/hicn-plugin/src/strategies/dpo_rr.c
@@ -0,0 +1,312 @@
+/*
+ * Copyright (c) 2017-2019 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:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "../strategy_dpo_ctx.h"
+#include "dpo_rr.h"
+#include "strategy_rr.h"
+#include "../strategy_dpo_manager.h"
+
+hicn_strategy_rr_ctx_t *hicn_strategy_rr_ctx_pool;
+
+const static char *const hicn_ip6_nodes[] = {
+  "hicn-rr-strategy",		// this is the name you give your node in VLIB_REGISTER_NODE
+  NULL,
+};
+
+const static char *const hicn_ip4_nodes[] = {
+  "hicn-rr-strategy",		// this is the name you give your node in VLIB_REGISTER_NODE
+  NULL,
+};
+
+const static char *const *const hicn_nodes_rr[DPO_PROTO_NUM] = {
+  [DPO_PROTO_IP6] = hicn_ip6_nodes,
+  [DPO_PROTO_IP4] = hicn_ip4_nodes,
+};
+
+/**
+ * @brief DPO type value for the rr_strategy
+ */
+static dpo_type_t hicn_dpo_type_rr;
+
+static const hicn_dpo_vft_t hicn_dpo_rr_vft = {
+  .hicn_dpo_get_ctx = &hicn_strategy_rr_ctx_get,
+  .hicn_dpo_is_type = &hicn_dpo_is_type_strategy_rr,
+  .hicn_dpo_get_type = &hicn_dpo_strategy_rr_get_type,
+  .hicn_dpo_module_init = &hicn_dpo_strategy_rr_module_init,
+  .hicn_dpo_create = &hicn_strategy_rr_ctx_create,
+  .hicn_dpo_add_update_nh = &hicn_strategy_rr_ctx_add_nh,
+  .hicn_dpo_del_nh = &hicn_strategy_rr_ctx_del_nh,
+  .hicn_dpo_lock_dpo_ctx = &hicn_strategy_rr_ctx_lock,
+  .hicn_dpo_unlock_dpo_ctx = hicn_strategy_rr_ctx_unlock,
+  .format_hicn_dpo = &format_hicn_dpo_strategy_rr
+};
+
+int
+hicn_dpo_is_type_strategy_rr (const dpo_id_t * dpo)
+{
+  return dpo->dpoi_type == hicn_dpo_type_rr;
+}
+
+void
+hicn_dpo_strategy_rr_module_init (void)
+{
+  pool_validate_index (hicn_strategy_rr_ctx_pool, 0);
+  /*
+   * Register our type of dpo
+   */
+  hicn_dpo_type_rr =
+    hicn_dpo_register_new_type (hicn_nodes_rr, &hicn_dpo_rr_vft,
+				hicn_rr_strategy_get_vft (),
+				&dpo_strategy_rr_ctx_vft);
+}
+
+u8 *
+format_hicn_dpo_strategy_rr (u8 * s, va_list * ap)
+{
+
+  u32 indent = va_arg (*ap, u32);
+  s =
+    format (s,
+	    "Round Robin: next hop is chosen ciclying between all the available next hops, one after the other.\n",
+	    indent);
+  return (s);
+}
+
+dpo_type_t
+hicn_dpo_strategy_rr_get_type (void)
+{
+  return hicn_dpo_type_rr;
+}
+
+//////////////////////////////////////////////////////////////////////////////////////////////////
+
+void
+hicn_strategy_rr_ctx_lock (dpo_id_t * dpo)
+{
+  if (dpo->dpoi_index != 0)
+    {
+      hicn_strategy_rr_ctx_t *hicn_strategy_rr_ctx =
+	(hicn_strategy_rr_ctx_t *) hicn_strategy_rr_ctx_get (dpo->dpoi_index);
+      hicn_strategy_rr_ctx->default_ctx.locks++;
+    }
+}
+
+void
+hicn_strategy_rr_ctx_unlock (dpo_id_t * dpo)
+{
+  if (dpo->dpoi_index != 0)
+    {
+      hicn_strategy_rr_ctx_t *hicn_strategy_rr_ctx =
+	(hicn_strategy_rr_ctx_t *) hicn_strategy_rr_ctx_get (dpo->dpoi_index);
+      hicn_strategy_rr_ctx->default_ctx.locks--;
+
+      if (0 == hicn_strategy_rr_ctx->default_ctx.locks)
+	{
+	  pool_put (hicn_strategy_rr_ctx_pool, hicn_strategy_rr_ctx);
+	}
+    }
+}
+
+u8 *
+format_hicn_strategy_rr_ctx (u8 * s, va_list * ap)
+{
+  int i = 0;
+  index_t index = va_arg (*ap, index_t);
+  hicn_strategy_rr_ctx_t *dpo = NULL;
+  dpo_id_t *next_hop = NULL;
+  hicn_face_vft_t *face_vft = NULL;
+  u32 indent = va_arg (*ap, u32);;
+
+  dpo = (hicn_strategy_rr_ctx_t *) hicn_strategy_rr_ctx_get (index);
+
+  s =
+    format (s, "hicn-rr, next hop Face %d",
+	    dpo->default_ctx.next_hops[dpo->current_nhop].dpoi_index);
+  for (i = 0; i < HICN_PARAM_FIB_ENTRY_NHOPS_MAX; i++)
+    {
+      next_hop = &dpo->default_ctx.next_hops[i];
+      face_vft = hicn_face_get_vft (next_hop->dpoi_type);
+      if (face_vft != NULL)
+	{
+	  s = format (s, "\n");
+	  s =
+	    format (s, "%U ", face_vft->format_face, next_hop->dpoi_index,
+		    indent);
+	}
+    }
+
+  return (s);
+}
+
+static index_t
+hicn_strategy_rr_ctx_get_index (hicn_strategy_rr_ctx_t * cd)
+{
+  return (cd - hicn_strategy_rr_ctx_pool);
+}
+
+int
+hicn_strategy_rr_ctx_create (dpo_proto_t proto, const dpo_id_t * next_hop,
+			     int nh_len, index_t * dpo_idx)
+{
+  hicn_strategy_rr_ctx_t *hicn_strategy_rr_ctx;
+  int ret = HICN_ERROR_NONE, i;
+  dpo_id_t invalid = NEXT_HOP_INVALID;
+
+  /* Allocate a hicn_dpo_ctx on the vpp pool and initialize it */
+  pool_get (hicn_strategy_rr_ctx_pool, hicn_strategy_rr_ctx);
+
+  *dpo_idx = hicn_strategy_rr_ctx_get_index (hicn_strategy_rr_ctx);
+  for (int i = 0; i < HICN_PARAM_FIB_ENTRY_NHOPS_MAX; i++)
+    {
+      hicn_strategy_rr_ctx->default_ctx.next_hops[i] = invalid;
+    }
+
+  hicn_strategy_rr_ctx->default_ctx.entry_count = 0;
+  hicn_strategy_rr_ctx->default_ctx.locks = 0;
+
+  for (i = 0; i < HICN_PARAM_FIB_ENTRY_NHOPS_MAX && i < nh_len; i++)
+    {
+      clib_memcpy (&hicn_strategy_rr_ctx->default_ctx.next_hops[i],
+		   &next_hop[i], sizeof (dpo_id_t));
+      hicn_strategy_rr_ctx->default_ctx.entry_count++;
+    }
+
+  hicn_strategy_rr_ctx->current_nhop = 0;
+
+  return ret;
+}
+
+hicn_dpo_ctx_t *
+hicn_strategy_rr_ctx_get (index_t index)
+{
+  hicn_strategy_rr_ctx_t *hicn_strategy_rr_ctx = NULL;
+  if (!pool_is_free_index (hicn_strategy_rr_ctx_pool, index))
+    {
+      hicn_strategy_rr_ctx =
+	(pool_elt_at_index (hicn_strategy_rr_ctx_pool, index));
+    }
+  return &hicn_strategy_rr_ctx->default_ctx;
+}
+
+int
+hicn_strategy_rr_ctx_add_nh (const dpo_id_t * nh, index_t dpo_idx)
+{
+  hicn_strategy_rr_ctx_t *hicn_strategy_rr_ctx =
+    (hicn_strategy_rr_ctx_t *) hicn_strategy_rr_ctx_get (dpo_idx);
+
+  if (hicn_strategy_rr_ctx != NULL)
+    {
+
+      int empty = hicn_strategy_rr_ctx->default_ctx.entry_count;
+
+      /* Iterate through the list of faces to add new faces */
+      for (int i = 0; i < hicn_strategy_rr_ctx->default_ctx.entry_count; i++)
+	{
+	  if (!memcmp
+	      (nh, &hicn_strategy_rr_ctx->default_ctx.next_hops[i],
+	       sizeof (dpo_id_t)))
+	    {
+	      /* If face is marked as deleted, ignore it */
+	      hicn_face_t *face =
+		hicn_dpoi_get_from_idx (hicn_strategy_rr_ctx->
+					default_ctx.next_hops[i].dpoi_index);
+	      if (face->shared.flags & HICN_FACE_FLAGS_DELETED)
+		{
+		  continue;
+		}
+	      return HICN_ERROR_DPO_CTX_NHOPS_EXISTS;
+	    }
+	}
+
+      /* Get an empty place */
+      if (empty > HICN_PARAM_FIB_ENTRY_NHOPS_MAX)
+	{
+	  return HICN_ERROR_DPO_CTX_NHOPS_NS;
+	}
+      if (PREDICT_FALSE (empty > HICN_PARAM_FIB_ENTRY_NHOPS_MAX))
+	{
+	  return HICN_ERROR_DPO_CTX_NHOPS_NS;
+	}
+      clib_memcpy (&hicn_strategy_rr_ctx->default_ctx.next_hops[empty], nh,
+		   sizeof (dpo_id_t));
+      hicn_strategy_rr_ctx->default_ctx.entry_count++;
+
+      return HICN_ERROR_NONE;
+    }
+  return HICN_ERROR_DPO_CTX_NOT_FOUND;
+}
+
+int
+hicn_strategy_rr_ctx_del_nh (hicn_face_id_t face_id, index_t dpo_idx,
+			     fib_prefix_t * fib_pfx)
+{
+  hicn_strategy_rr_ctx_t *hicn_strategy_rr_ctx =
+    (hicn_strategy_rr_ctx_t *) hicn_strategy_rr_ctx_get (dpo_idx);
+  int ret = HICN_ERROR_NONE;
+  int nh_id = ~0;
+  dpo_id_t invalid = NEXT_HOP_INVALID;
+
+  if (hicn_strategy_rr_ctx != NULL)
+    {
+      for (int i = 0; i < hicn_strategy_rr_ctx->default_ctx.entry_count; i++)
+	{
+	  if (hicn_strategy_rr_ctx->default_ctx.next_hops[i].dpoi_index ==
+	      face_id)
+	    {
+	      nh_id = i;
+	      hicn_face_unlock (&hicn_strategy_rr_ctx->default_ctx.
+				next_hops[i]);
+	      hicn_strategy_rr_ctx->default_ctx.next_hops[i] = invalid;
+	      hicn_strategy_rr_ctx->default_ctx.entry_count--;
+	    }
+	}
+
+      if (0 == hicn_strategy_rr_ctx->default_ctx.entry_count)
+	{
+	  fib_table_entry_special_remove (HICN_FIB_TABLE, fib_pfx,
+					  FIB_SOURCE_PLUGIN_HI);
+	}
+    }
+  else
+    {
+      ret = HICN_ERROR_DPO_CTX_NOT_FOUND;
+    }
+
+  /*
+   * Remove any possible hole in the arrays of dpos
+   */
+  if (hicn_strategy_rr_ctx->default_ctx.entry_count > 0 && nh_id != ~0
+      && nh_id < hicn_strategy_rr_ctx->default_ctx.entry_count - 1)
+    {
+      int i;
+      for (i = nh_id; i < hicn_strategy_rr_ctx->default_ctx.entry_count; i++)
+	{
+	  clib_memcpy (&hicn_strategy_rr_ctx->default_ctx.next_hops[i],
+		       &hicn_strategy_rr_ctx->default_ctx.next_hops[i + 1],
+		       sizeof (dpo_id_t));
+	}
+      /* Set as invalid the last dpo */
+      hicn_strategy_rr_ctx->default_ctx.next_hops[i] = invalid;
+    }
+  return ret;
+}
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */