1 files changed, 191 insertions, 0 deletions
diff --git a/ctrl/libhicnctrl/includes/hicn/ctrl/command.h b/ctrl/libhicnctrl/includes/hicn/ctrl/command.h
new file mode 100644
index 000000000..1824d14c2
--- /dev/null
+++ b/ctrl/libhicnctrl/includes/hicn/ctrl/command.h
@@ -0,0 +1,191 @@
+#ifndef HICNLIGHT_CONFIG_COMMAND
+#define HICNLIGHT_CONFIG_COMMAND
+
+/**
+ * @file command.h
+ * @brief Commands.
+ */
+
+#include <stddef.h>  // offsetof
+#include <hicn/util/ip_address.h>
+
+#include <hicn/ctrl/api.h>
+
+/* Update sscanf accordingly in parse_cmd.c */
+#define MAX_PARAMETERS 10
+#define MAX_SCANF_PARAM_LEN 100
+
+typedef int (*parser_hook_t)(void *arg);
+
+typedef enum {
+  TYPENAME_UNDEFINED,
+  TYPENAME_INT,
+  TYPENAME_UINT,
+  TYPENAME_INT16,
+  TYPENAME_UINT16,
+  TYPENAME_STR,
+  TYPENAME_SYMBOLIC_OR_ID,
+  TYPENAME_INTERFACE_NAME,
+  TYPENAME_IP_ADDRESS,
+  TYPENAME_IP_PREFIX,
+  TYPENAME_ON_OFF,
+  TYPENAME_ENUM,
+  TYPENAME_POLICY_STATE,
+} parser_typename_t;
+
+typedef struct {
+  parser_typename_t name;
+  union {
+    struct {
+      size_t max_size;
+    } str;
+    struct {
+      int min;
+      int max;
+    } integer;
+    struct {
+      int (*from_str)(const char *str);
+    } enum_;
+    struct {
+      policy_tag_t tag;
+    } policy_state;
+  };
+} parser_type_t;
+
+typedef struct {
+  const char *name;
+  const char *help;
+  parser_type_t type;
+  size_t offset;
+  /*
+   * quick hack to let the functions update two or more parameters, like for
+   * IP_ADDRESS or IP_PREFIX types
+   */
+  size_t offset2;
+  size_t offset3;
+} command_parameter_t;
+
+typedef struct {
+  hc_action_t action;
+  hc_object_type_t object_type;
+  unsigned nparams;
+  command_parameter_t parameters[MAX_PARAMETERS];
+  parser_hook_t post_hook;
+} command_parser_t;
+
+/*
+ * NOTE: we now use strings everywhere to parse in the same way parameters
+ * coming from the commandline through getopt (strings), and those coming from
+ * sscanf (used to be variables, now all strings also.
+ */
+
+#define TYPE_STRN(N)      \
+  (parser_type_t) {       \
+    .name = TYPENAME_STR, \
+    .str = {              \
+        .max_size = N,    \
+    },                    \
+  }
+
+#define TYPE_INT(MIN, MAX) \
+  (parser_type_t) {        \
+    .name = TYPENAME_INT,  \
+    .integer = {           \
+        .min = (MIN),      \
+        .max = (MAX),      \
+    },                     \
+  }
+
+#define TYPE_UINT(MIN, MAX) \
+  (parser_type_t) {         \
+    .name = TYPENAME_UINT,  \
+    .integer = {            \
+        .min = (MIN),       \
+        .max = (MAX),       \
+    },                      \
+  }
+
+#define TYPE_INT16(MIN, MAX) \
+  (parser_type_t) {          \
+    .name = TYPENAME_INT16,  \
+    .integer = {             \
+        .min = (MIN),        \
+        .max = (MAX),        \
+    },                       \
+  }
+
+#define TYPE_UINT16(MIN, MAX) \
+  (parser_type_t) {           \
+    .name = TYPENAME_UINT16,  \
+    .integer = {              \
+        .min = (MIN),         \
+        .max = (MAX),         \
+    },                        \
+  }
+
+#define TYPE_SYMBOLIC_OR_ID TYPE_STRN(SYMBOLIC_NAME_LEN)
+
+#define TYPE_INTERFACE_NAME TYPE_STRN(INTERFACE_LEN)
+
+#define TYPE_IP_ADDRESS \
+  (parser_type_t) { .name = TYPENAME_IP_ADDRESS, }
+
+#define TYPE_IP_PREFIX \
+  (parser_type_t) { .name = TYPENAME_IP_PREFIX, }
+
+#define TYPE_ON_OFF \
+  (parser_type_t) { .name = TYPENAME_ON_OFF, }
+
+#define TYPE_ENUM(x)                                     \
+  (parser_type_t) {                                      \
+    .name = TYPENAME_ENUM,                               \
+    .enum_ = {                                           \
+        .from_str = (int (*)(const char *))x##_from_str, \
+    },                                                   \
+  }
+/* We need to allocate room for the intermediate string */
+
+#define TYPE_POLICY_STATE(TAG)     \
+  (parser_type_t) {                \
+    .name = TYPENAME_POLICY_STATE, \
+    .policy_state = {              \
+        .tag = TAG,                \
+    },                             \
+  }
+/* We need to allocate room for the intermediate string */
+
+/**
+ * \brief Register a protocol
+ * \param protocol Pointer to a protocol_t structure describing the protocol to
+ * register \return None
+ */
+
+void command_register(const command_parser_t *command);
+
+/**
+ * \brief Search a registered protocol in the library according to its name
+ * \param[in] action The action of the command.
+ * \param[in] object The object of the command.
+ * \param[in] nparams The number of parameters expected in the command.
+ * \return A pointer to the corresponding command if any, NULL othewise
+ */
+const command_parser_t *command_search(hc_action_t action,
+                                       hc_object_type_t object,
+                                       unsigned nparams);
+
+/**
+ * @brief List the commands associated with the specified object and/or action.
+ * Use OBJECT_UNDEFINED and ACTION_UNDEFINED to list all the available objects.
+ * Use ACTION_UNDEFINED to list all the actions associated to the specified
+ * object.
+ *
+ * @param object The action of the command
+ * @param action The object of the command
+ */
+void command_list(hc_object_type_t object, hc_action_t action);
+
+#define COMMAND_REGISTER(MOD)                                  \
+  static void __init_##MOD(void) __attribute__((constructor)); \
+  static void __init_##MOD(void) { command_register(&MOD); }
+
+#endif /* HICNLIGHT_CONFIG_COMMAND */