feat: Due to the deep modifications related to names and packet format,

this task cover a large part of the codebase and involves several changes:

- the library provides a name data structure (hicn_name_t ), which is composed
  of a name prefix (hicn_name_prefix_t) and a name suffix (hicn_name_suffix_t),
  and it has been extended to provide all support functions required for name
  manipulation, including common prefix computation, as required for the Longest
  Prefix Match (LPM)in the forwarder, in addition to Exact Prefix Match (EPM).
- all code has been rewritten to use this data structure instead of having for
  instance the forwarder define its own name class (used to be Name and NameBitVector)
  the code has been refactored to minimize name allocations and copies, one remaining
  aspect is the difference of name storage between PIT and CS entries (respectively
  in the PIT entry, and in the message buffer), which causes the packet cache
  index to be updated when a PIT entry is converted into a CS entry. By storing
  the name in the PIT/CS entry everytime, we might save on this operation).
- hicn-light FIB has been rewritten : code has been refactored and should now be
  shorter and documented; unit tests have been drafted but more would be required
  to cover all cases and match the algorithms to add/remove nodes, as specified in the doc.
  all protocol details and hICN header formats are now abstracted by the library
  for the forwarder (and thus header.h and  protocols/*.h have been removed from
  public includes, and replaced by packet.h providing protocol agnostic packet
  level functions, completely replacing the compat.h header that used to provide
  similar functions.
- this works by exposing a opaque buffer to the application (a kind of socket buffer)
  which is used by the lib to cache the packet format and offsets of the different
  layers in the buffer and provider efficient operations (the packet format is
  either defined for packet construction, or guessed at ingress, and this structure
  is updated accordingly only once).

Co-authored-by: Jordan Augé <jordan.auge+fdio@cisco.com>
Signed-off-by: Luca Muscariello <muscariello@ieee.org>
Change-Id: I31e321897f85f0267fe8ba4720363c180564492f

1 files changed, 173 insertions, 0 deletions

diff --git a/ctrl/libhicnctrl/src/modules/hicn_light/route.c b/ctrl/libhicnctrl/src/modules/hicn_light/route.c
new file mode 100644
index 000000000..1adfe4f36
--- /dev/null
+++ b/ctrl/libhicnctrl/src/modules/hicn_light/route.c
@@ -0,0 +1,173 @@
+/*
+ * Copyright (c) 2021-2022 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.
+ */
+
+/**
+ * \file modules/hicn_light/route.c
+ * \brief Implementation of route object VFT for hicn_light.
+ */
+
+#include <assert.h>
+#include <hicn/ctrl/api.h>
+#include <hicn/util/log.h>
+#include "base.h"
+#include "route.h"
+#include <hicn/ctrl/hicn-light.h>
+
+#include "../../object_private.h"
+
+static int hicnlight_route_parse(const uint8_t *buffer, size_t size,
+                                 hc_route_t *route) {
+  if (size != sizeof(cmd_route_list_item_t)) return -1;
+  cmd_route_list_item_t *item = (cmd_route_list_item_t *)buffer;
+
+  if (!IS_VALID_NAME(item->face_name)) {
+    ERROR("[hc_connection_parse] Invalid face_name received");
+    return -1;
+  }
+
+  if (!IS_VALID_ID(item->face_id)) {
+    ERROR("[hc_connection_parse] Invalid face_id received");
+    return -1;
+  }
+
+  if (!IS_VALID_FAMILY(item->family)) {
+    ERROR("[hc_listener_parse] Invalid family received");
+    return -1;
+  }
+
+  if (!IS_VALID_ADDRESS(item->remote_addr)) {
+    ERROR("[hc_connection_parse] Invalid address received");
+    return -1;
+  }
+
+  // LEN
+  // COST
+
+  *route = (hc_route_t){
+      .face_name = "", /* This is not reported back */
+      .face_id = item->face_id,
+      .family = (int)(item->family),
+      .remote_addr = item->remote_addr,
+      .len = item->len,
+      .cost = item->cost,
+  };
+
+  if (hc_route_validate(route, false) < 0) return -1;
+  return 0;
+}
+
+int _hicnlight_route_parse(const uint8_t *buffer, size_t size,
+                           hc_object_t *object) {
+  return hicnlight_route_parse(buffer, size, &object->route);
+}
+
+/* ROUTE CREATE */
+
+int hicnlight_route_serialize_create(const hc_object_t *object,
+                                     uint8_t *packet) {
+  const hc_route_t *route = &object->route;
+  int rc;
+
+  msg_route_add_t *msg = (msg_route_add_t *)packet;
+  *msg = (msg_route_add_t){.header =
+                               {
+                                   .message_type = REQUEST_LIGHT,
+                                   .command_id = COMMAND_TYPE_ROUTE_ADD,
+                                   .length = 1,
+                                   .seq_num = 0,
+                               },
+                           .payload = {
+                               .address = route->remote_addr,
+                               .cost = route->cost,
+                               .family = route->family,
+                               .len = route->len,
+                           }};
+
+  /*
+   * The route commands expects the ID or name as part of the
+   * symbolic_or_connid attribute.
+   */
+  if (route->face_name[0] != '\0') {
+    rc = snprintf(msg->payload.symbolic_or_connid, SYMBOLIC_NAME_LEN, "%s",
+                  route->face_name);
+  } else {
+    rc = snprintf(msg->payload.symbolic_or_connid, SYMBOLIC_NAME_LEN, "%d",
+                  route->face_id);
+  }
+
+  if ((rc < 0) || (rc >= SYMBOLIC_NAME_LEN)) return -1;
+
+  return sizeof(msg_route_add_t);
+}
+
+/* ROUTE DELETE */
+
+int hicnlight_route_serialize_delete(const hc_object_t *object,
+                                     uint8_t *packet) {
+  const hc_route_t *route = &object->route;
+  int rc;
+
+  msg_route_remove_t *msg = (msg_route_remove_t *)packet;
+  memset(msg, 0, sizeof(msg_route_remove_t));
+  *msg = (msg_route_remove_t){.header =
+                                  {
+                                      .message_type = REQUEST_LIGHT,
+                                      .command_id = COMMAND_TYPE_ROUTE_REMOVE,
+                                      .length = 1,
+                                      .seq_num = 0,
+                                  },
+                              .payload = {
+                                  .family = (uint8_t)route->family,
+                                  .len = route->len,
+                              }};
+
+  /*
+   * Direct copy as part of the previous assignment does not work correctly...
+   * to be investigated
+   */
+  memcpy(&msg->payload.address, &route->remote_addr, sizeof(hicn_ip_address_t));
+
+  /*
+   * The route commands expects the ID or name as part of the
+   * symbolic_or_connid attribute.
+   */
+  if (route->face_name[0] != '\0') {
+    rc = snprintf(msg->payload.symbolic_or_connid, SYMBOLIC_NAME_LEN, "%s",
+                  route->face_name);
+  } else {
+    rc = snprintf(msg->payload.symbolic_or_connid, SYMBOLIC_NAME_LEN, "%d",
+                  route->face_id);
+  }
+
+  if ((rc < 0) || (rc >= SYMBOLIC_NAME_LEN)) return -1;
+
+  return sizeof(msg_route_remove_t);
+}
+
+/* ROUTE LIST */
+
+int hicnlight_route_serialize_list(const hc_object_t *object, uint8_t *packet) {
+  msg_route_list_t *msg = (msg_route_list_t *)packet;
+  *msg = (msg_route_list_t){.header = {
+                                .message_type = REQUEST_LIGHT,
+                                .command_id = COMMAND_TYPE_ROUTE_LIST,
+                                .length = 0,
+                                .seq_num = 0,
+                            }};
+
+  return sizeof(msg_header_t);  // Do not use msg_route_list_t
+}
+
+DECLARE_MODULE_OBJECT_OPS(hicnlight, route);