feat: libhicnctrl: new API to allow sending MAP-Me command on specific face

Change-Id: Iac39a1d145a5c1b4f19e1fa35d713ca720393760
Ticket: HICN-832
Signed-off-by: Jordan Augé <jordan.auge+fdio@cisco.com>

4 files changed, 96 insertions, 131 deletions

diff --git a/ctrl/libhicnctrl/src/modules/CMakeLists.txt b/ctrl/libhicnctrl/src/modules/CMakeLists.txt
index f7bd2f83a..f3e1a6342 100644
--- a/ctrl/libhicnctrl/src/modules/CMakeLists.txt
+++ b/ctrl/libhicnctrl/src/modules/CMakeLists.txt
@@ -1,4 +1,4 @@
-# Copyright (c) 2021-2022 Cisco and/or its affiliates.
+# Copyright (c) 2021-2023 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:
@@ -19,6 +19,7 @@ list(APPEND HICNLIGHT_MODULE_SOURCE_FILES
   ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/connection.c
   ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/face.c
   ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/listener.c
+  ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/mapme.c
   ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/route.c
   ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/stats.c
   ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/strategy.c
@@ -30,6 +31,7 @@ list(APPEND HICNLIGHT_MODULE_HEADER_FILES
   ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/connection.h
   ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/face.h
   ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/listener.h
+  ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/mapme.h
   ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/route.h
   ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/stats.h
   ${CMAKE_CURRENT_SOURCE_DIR}/hicn_light/strategy.h
diff --git a/ctrl/libhicnctrl/src/modules/hicn_light.c b/ctrl/libhicnctrl/src/modules/hicn_light.c
index a2577c31b..96cdda2d2 100644
--- a/ctrl/libhicnctrl/src/modules/hicn_light.c
+++ b/ctrl/libhicnctrl/src/modules/hicn_light.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021-2022 Cisco and/or its affiliates.
+ * Copyright (c) 2021-2023 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:
@@ -48,8 +48,9 @@
 
 #include "hicn_light/base.h"
 #include "hicn_light/connection.h"
-#include "hicn_light/listener.h"
 #include "hicn_light/face.h"
+#include "hicn_light/listener.h"
+#include "hicn_light/mapme.h"
 #include "hicn_light/route.h"
 #include "hicn_light/stats.h"
 #include "hicn_light/strategy.h"
@@ -200,8 +201,13 @@ static int hicnlight_process_header(hc_sock_t *sock) {
   }
   if (!request) {
     ERROR("[hc_sock_light_process] No request matching sequence number");
+    /*
+     * Currently: Ignore packet (alternatively: return 0 to discard in case of
+     * error; move s->got_header later in this case)
+     */
     return -1;
   }
+
   sock->current_request = request;
   hc_request_t *current_request = hc_request_get_current(request);
   hc_data_t *data = hc_request_get_data(current_request);
@@ -1412,7 +1418,7 @@ int hc_sock_initialize_module(hc_sock_t *s) {
   hc_sock_light.object_vft[OBJECT_TYPE_FACE] = HC_MODULE_OBJECT_OPS_EMPTY;
   hc_sock_light.object_vft[OBJECT_TYPE_PUNTING] = HC_MODULE_OBJECT_OPS_EMPTY;
   hc_sock_light.object_vft[OBJECT_TYPE_CACHE] = HC_MODULE_OBJECT_OPS_EMPTY;
-  hc_sock_light.object_vft[OBJECT_TYPE_MAPME] = HC_MODULE_OBJECT_OPS_EMPTY;
+  hc_sock_light.object_vft[OBJECT_TYPE_MAPME] = hicnlight_mapme_module_ops;
   hc_sock_light.object_vft[OBJECT_TYPE_WLDR] = HC_MODULE_OBJECT_OPS_EMPTY;
   hc_sock_light.object_vft[OBJECT_TYPE_POLICY] = HC_MODULE_OBJECT_OPS_EMPTY;
   hc_sock_light.object_vft[OBJECT_TYPE_ROUTE] = hicnlight_route_module_ops;
diff --git a/ctrl/libhicnctrl/src/modules/hicn_light/mapme.c b/ctrl/libhicnctrl/src/modules/hicn_light/mapme.c
index de75d82a8..04eb36e24 100644
--- a/ctrl/libhicnctrl/src/modules/hicn_light/mapme.c
+++ b/ctrl/libhicnctrl/src/modules/hicn_light/mapme.c
@@ -1,139 +1,68 @@
+/*
+ * Copyright (c) 2021-2023 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/mapme.c
+ * \brief Implementation of mapme object VFT for hicn_light.
+ */
+
+#include <hicn/ctrl/hicn-light.h>
 #include "mapme.h"
 
-static int _hcng_mapme_set(hc_sock_t *socket, int enabled) {
-#if 0
-  msg_mapme_enable_t msg = {.header =
-                                {
-                                    .message_type = REQUEST_LIGHT,
-                                    .command_id = COMMAND_TYPE_MAPME_ENABLE,
-                                    .length = 1,
-                                    .seq_num = 0,
-                                },
-                            .payload = {
-                                .activate = enabled,
-                            }};
-
-  hc_command_params_t params = {
-      .cmd = ACTION_SET,
-      .cmd_id = COMMAND_TYPE_MAPME_ENABLE,
-      .size_in = sizeof(cmd_mapme_enable_t),
-      .size_out = 0,
-      .parse = NULL,
-  };
-
-  return _hcng_execute_command(socket, (hc_msg_t *)&msg, sizeof(msg), &params,
-                               NULL, false);
-#endif
-  return 0;  // XXX added
+static int hicnlight_mapme_parse(const uint8_t *buffer, size_t size,
+                                 hc_mapme_t *mapme) {
+  return -1;
 }
 
-static int _hcng_mapme_set_discovery(hc_sock_t *socket, int enabled) {
-#if 0
-  msg_mapme_enable_t msg = {
-      .header =
-          {
-              .message_type = REQUEST_LIGHT,
-              .command_id = COMMAND_TYPE_MAPME_SET_DISCOVERY,
-              .length = 1,
-              .seq_num = 0,
-          },
-      .payload = {
-          .activate = enabled,
-      }};
-
-  hc_command_params_t params = {
-      .cmd = ACTION_SET,
-      .cmd_id = COMMAND_TYPE_MAPME_SET_DISCOVERY,
-      .size_in = sizeof(cmd_mapme_set_discovery_t),
-      .size_out = 0,
-      .parse = NULL,
-  };
-
-  return _hcng_execute_command(socket, (hc_msg_t *)&msg, sizeof(msg), &params,
-                               NULL, false);
-#endif
-  return 0;  // XXX added
+int _hicnlight_mapme_parse(const uint8_t *buffer, size_t size,
+                           hc_object_t *object) {
+  return hicnlight_mapme_parse(buffer, size, &object->mapme);
 }
 
-static int _hcng_mapme_set_timescale(hc_sock_t *socket, uint32_t timescale) {
-#if 0
-  msg_mapme_set_timescale_t msg = {
-      .header =
-          {
-              .message_type = REQUEST_LIGHT,
-              .command_id = COMMAND_TYPE_MAPME_SET_TIMESCALE,
-              .length = 1,
-              .seq_num = 0,
-          },
-      .payload = {
-          .timePeriod = timescale,
-      }};
-
-  hc_command_params_t params = {
-      .cmd = ACTION_SET,
-      .cmd_id = COMMAND_TYPE_MAPME_SET_TIMESCALE,
-      .size_in = sizeof(cmd_mapme_set_timescale_t),
-      .size_out = 0,
-      .parse = NULL,
-  };
-
-  return _hcng_execute_command(socket, (hc_msg_t *)&msg, sizeof(msg), &params,
-                               NULL, false);
-#endif
-  return 0;  // XXX added
+int hicnlight_mapme_serialize_create(const hc_object_t *object,
+                                     uint8_t *packet) {
+  const hc_mapme_t *mapme = &object->mapme;
+
+  msg_mapme_add_t *msg = (msg_mapme_add_t *)packet;
+  *msg = (msg_mapme_add_t){.header =
+                               {
+                                   .message_type = REQUEST_LIGHT,
+                                   .command_id = COMMAND_TYPE_MAPME_ADD,
+                                   .length = 1,
+                                   .seq_num = 0,
+                               },
+
+                           .payload = {.face_id = mapme->face_id,
+                                       .family = mapme->family,
+                                       .address = mapme->address,
+                                       .len = mapme->len}};
+
+  return sizeof(msg_mapme_add_t);
 }
 
-static int _hcng_mapme_set_retx(hc_sock_t *socket, uint32_t timescale) {
-#if 0
-  msg_mapme_set_retx_t msg = {.header =
-                                  {
-                                      .message_type = REQUEST_LIGHT,
-                                      .command_id = COMMAND_TYPE_MAPME_SET_RETX,
-                                      .length = 1,
-                                      .seq_num = 0,
-                                  },
-                              .payload = {
-                                  .timePeriod = timescale,
-                              }};
-
-  hc_command_params_t params = {
-      .cmd = ACTION_SET,
-      .cmd_id = COMMAND_TYPE_MAPME_SET_RETX,
-      .size_in = sizeof(msg_mapme_set_retx_t),
-      .size_out = 0,
-      .parse = NULL,
-  };
-
-  return _hcng_execute_command(socket, (hc_msg_t *)&msg, sizeof(msg), &params,
-                               NULL, false);
-#endif
-  return 0;  // XXX added
+int hicnlight_mapme_serialize_delete(const hc_object_t *object,
+                                     uint8_t *packet) {
+  return -1;
 }
 
-static int _hcng_mapme_send_update(hc_sock_t *socket, hc_mapme_t *mapme) {
-#if 0
-  if (!IS_VALID_FAMILY(mapme->family)) return -1;
-
-  msg_mapme_send_update_t msg = {
-      .header =
-          {
-              .message_type = REQUEST_LIGHT,
-              .command_id = COMMAND_TYPE_MAPME_SEND_UPDATE,
-              .length = 1,
-              .seq_num = 0,
-          },
-  };
-
-  hc_command_params_t params = {
-      .cmd = ACTION_UPDATE,
-      .cmd_id = COMMAND_TYPE_MAPME_SEND_UPDATE,
-      .size_in = sizeof(msg_mapme_send_update_t),
-      .size_out = 0,
-      .parse = NULL,
-  };
+int hicnlight_mapme_serialize_list(const hc_object_t *object, uint8_t *packet) {
+  return -1;
+}
 
-  return _hcng_execute_command(socket, (hc_msg_t *)&msg, sizeof(msg), &params,
-                               NULL, false);
-#endif
-  return 0;  // XXX added
+int hicnlight_mapme_serialize_set(const hc_object_t *object, uint8_t *packet) {
+  return -1;
 }
+
+DECLARE_MODULE_OBJECT_OPS(hicnlight, mapme);
diff --git a/ctrl/libhicnctrl/src/modules/hicn_light/mapme.h b/ctrl/libhicnctrl/src/modules/hicn_light/mapme.h
new file mode 100644
index 000000000..58a943b67
--- /dev/null
+++ b/ctrl/libhicnctrl/src/modules/hicn_light/mapme.h
@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2023 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/mapme.h
+ * \brief mapme object VFT for hicn_light.
+ */
+
+#ifndef HICNCTRL_MODULE_HICNLIGHT_MAPME_H
+#define HICNCTRL_MODULE_HICNLIGHT_MAPME_H
+
+#include "../../module.h"
+
+DECLARE_MODULE_OBJECT_OPS_H(hicnlight, mapme);
+
+#endif /* HICNCTRL_MODULE_HICNLIGHT_MAPME_H */