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, 131 insertions, 0 deletions

diff --git a/ctrl/libhicnctrl/src/module.h b/ctrl/libhicnctrl/src/module.h
new file mode 100644
index 000000000..44ba5ddbb
--- /dev/null
+++ b/ctrl/libhicnctrl/src/module.h
@@ -0,0 +1,131 @@
+#ifndef HICNCTRL_MODULE_H
+#define HICNCTRL_MODULE_H
+
+#include <stdint.h>
+
+#include <hicn/ctrl/data.h>
+#include <hicn/ctrl/object.h>
+#include <hicn/ctrl/socket.h>
+
+#include "request.h"
+
+/*
+ * execute is used for sync code (eg. in VPP), while serialize/parse for
+ * sync/async code (eg. in hicn-light).
+ */
+typedef int (*hc_execute_t)(hc_sock_t *, hc_object_t *, hc_data_t *);
+typedef int (*hc_serialize_t)(const hc_object_t *, uint8_t *);
+
+typedef struct {
+  int (*parse)(const uint8_t *buffer, size_t size, hc_object_t *object);
+  size_t serialized_size;
+  hc_serialize_t serialize[ACTION_N];
+  hc_execute_t execute[ACTION_N];
+} hc_module_object_ops_t;
+
+#define HC_MODULE_OBJECT_OPS_EMPTY       \
+  (hc_module_object_ops_t) {             \
+    .parse = NULL, .serialized_size = 0, \
+    .execute =                           \
+        {                                \
+            [ACTION_CREATE] = NULL,      \
+            [ACTION_DELETE] = NULL,      \
+            [ACTION_LIST] = NULL,        \
+        },                               \
+    .serialize = {                       \
+        [ACTION_CREATE] = NULL,          \
+        [ACTION_DELETE] = NULL,          \
+        [ACTION_LIST] = NULL,            \
+    },                                   \
+  }
+
+#define DECLARE_MODULE_OBJECT_OPS_H(PREFIX, NAME) \
+  extern const hc_module_object_ops_t PREFIX##_##NAME##_module_ops;
+
+/* Underscore'd functions take a hc_object_t as a parameter */
+
+#define HC_MODULE_OBJECT_OPS(PREFIX, NAME)                  \
+  (hc_module_object_ops_t) {                                \
+    .parse = _##PREFIX##_##NAME##_parse,                    \
+    .serialized_size = sizeof(cmd_##NAME##_list_item_t),    \
+    .execute =                                              \
+        {                                                   \
+            [ACTION_CREATE] = NULL,                         \
+            [ACTION_DELETE] = NULL,                         \
+            [ACTION_LIST] = NULL,                           \
+        },                                                  \
+    .serialize = {                                          \
+      [ACTION_CREATE] = PREFIX##_##NAME##_serialize_create, \
+      [ACTION_DELETE] = PREFIX##_##NAME##_serialize_delete, \
+      [ACTION_LIST] = PREFIX##_##NAME##_serialize_list,     \
+    }                                                       \
+  }
+
+#define DECLARE_MODULE_OBJECT_OPS(PREFIX, NAME)                 \
+  const hc_module_object_ops_t PREFIX##_##NAME##_module_ops = { \
+      .parse = _##PREFIX##_##NAME##_parse,                      \
+      .serialized_size = sizeof(cmd_##NAME##_list_item_t),      \
+      .execute =                                                \
+          {                                                     \
+              [ACTION_CREATE] = NULL,                           \
+              [ACTION_DELETE] = NULL,                           \
+              [ACTION_LIST] = NULL,                             \
+          },                                                    \
+      .serialize = {                                            \
+          [ACTION_CREATE] = PREFIX##_##NAME##_serialize_create, \
+          [ACTION_DELETE] = PREFIX##_##NAME##_serialize_delete, \
+          [ACTION_LIST] = PREFIX##_##NAME##_serialize_list,     \
+      }};
+
+#define DECLARE_VPP_MODULE_OBJECT_OPS(PREFIX, NAME)             \
+  const hc_module_object_ops_t PREFIX##_##NAME##_module_ops = { \
+      .execute =                                                \
+          {                                                     \
+              [ACTION_CREATE] = PREFIX##_##NAME##_create,       \
+              [ACTION_DELETE] = PREFIX##_##NAME##_delete,       \
+              [ACTION_LIST] = PREFIX##_##NAME##_list,           \
+          },                                                    \
+      .serialize =                                              \
+          {                                                     \
+              [ACTION_CREATE] = NULL,                           \
+              [ACTION_DELETE] = NULL,                           \
+              [ACTION_LIST] = NULL,                             \
+          },                                                    \
+  };
+
+typedef struct {
+  /** Create module-specific data storage */
+  void *(*create_data)(const char *);
+
+  /** Release module-specific data storage */
+  void (*free_data)(void *);
+
+  /** Retrieve underlying file descriptor */
+  int (*get_fd)(hc_sock_t *);
+
+  /** Retrieve underlying receive buffer */
+  int (*get_recv_buffer)(hc_sock_t *, uint8_t **buffer, size_t *size);
+
+  /** Connect control socket to the forwarder */
+  int (*connect)(hc_sock_t *);
+
+  /** Disconnect control socket from forwarder */
+  int (*disconnect)(hc_sock_t *);
+
+  /** Populate the TX buffer with the serialization of the next request to be
+   * sent */
+  ssize_t (*prepare)(hc_sock_t *, hc_request_t *, uint8_t **buffer);
+
+  /** Send the content of the TX buffer */
+  int (*send)(hc_sock_t *, uint8_t *buffer, size_t size);
+
+  /** Receive responses in the RX buffer */
+  int (*recv)(hc_sock_t *);
+
+  /** Process the content of the RX buffer to populate result data */
+  int (*process)(hc_sock_t *, size_t count);
+
+  hc_module_object_ops_t object_vft[OBJECT_TYPE_N];
+} hc_sock_ops_t;
+
+#endif /* HICNCTRL_MODULE_H */