feat: boostrap hicn 22.02

The current patch provides several new features, improvements,
bug fixes and also complete rewrite of entire components.

- lib
The hicn packet parser has been improved with a new packet
format fully based on UDP. The TCP header is still temporarily
supported but the UDP header will replace completely the new hicn
packet format. Improvements have been made to make sure every
packet parsing operation is made via this library. The current
new header can be used as header between the payload and the
UDP header or as trailer in the UDP surplus area to be tested
when UDP options will start to be used.

- hicn-light
The portable packet forwarder has been completely rewritten from
scratch with the twofold objective to improve performance and
code size but  also to drop dependencies such as libparc which is
now removed by the current implementation.

- hicn control
the control library is the agent that is used to program the
packet forwarders via their binary API. This component has
benefited from significant improvements in terms of interaction
model which is now event driven and more robust to failures.

- VPP plugin has been updated to support VPP 22.02

- transport
Major improvement have been made to the RTC protocol, to the
support of IO modules and to the security sub system. Signed
manifests are the default data authenticity and integrity framework.
Confidentiality can be enabled by sharing the encryption key to the
prod/cons layer. The library has been tested with group key based
applications such as broadcast/multicast and real-time on-line
meetings with trusted server keys or MLS.

- testing
Unit testing has been introduced using GoogleTest. One third of
the code base is covered by unit testing with priority on
critical features. Functional testing has also been introduce
using Docker, linux bridging and Robot Framework to define
test with Less Code techniques to facilitate the extension
of the coverage.

Co-authored-by: Mauro Sardara <msardara@cisco.com>
Co-authored-by: Jordan Augé <jordan.auge+fdio@cisco.com>
Co-authored-by: Michele Papalini <micpapal@cisco.com>
Co-authored-by: Angelo Mantellini <manangel@cisco.com>
Co-authored-by: Jacques Samain <jsamain@cisco.com>
Co-authored-by: Olivier Roques <oroques+fdio@cisco.com>
Co-authored-by: Enrico Loparco <eloparco@cisco.com>
Co-authored-by: Giulio Grassi <gigrassi@cisco.com>

Change-Id: I75d0ef70f86d921e3ef503c99271216ff583c215
Signed-off-by: Luca Muscariello <muscariello@ieee.org>
Signed-off-by: Mauro Sardara <msardara@cisco.com>

1 files changed, 25 insertions, 81 deletions

diff --git a/libtransport/includes/hicn/transport/interfaces/portal.h b/libtransport/includes/hicn/transport/interfaces/portal.h
index 66fc84256..1a22b1f1d 100644
--- a/libtransport/includes/hicn/transport/interfaces/portal.h
+++ b/libtransport/includes/hicn/transport/interfaces/portal.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 Cisco and/or its affiliates.
+ * Copyright (c) 2021 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,8 @@
 #include <hicn/transport/core/content_object.h>
 #include <hicn/transport/core/interest.h>
 #include <hicn/transport/core/prefix.h>
+#include <hicn/transport/utils/event_thread.h>
+#include <hicn/transport/utils/noncopyable.h>
 
 #include <functional>
 
@@ -28,58 +30,18 @@ namespace transport {
 
 namespace interface {
 
-template <typename PrefixType>
-class BasicBindConfig {
-  static_assert(std::is_same<core::Prefix, PrefixType>::value,
-                "Prefix must be a Prefix type.");
-
-  const uint32_t standard_cs_reserved = 5000;
-
- public:
-  template <typename T>
-  BasicBindConfig(T &&prefix)
-      : prefix_(std::forward<T &&>(prefix)),
-        content_store_reserved_(standard_cs_reserved) {}
-
-  template <typename T>
-  BasicBindConfig(T &&prefix, uint32_t cs_reserved)
-      : prefix_(std::forward<T &&>(prefix)),
-        content_store_reserved_(cs_reserved) {}
-
-  TRANSPORT_ALWAYS_INLINE const PrefixType &prefix() const { return prefix_; }
-
-  TRANSPORT_ALWAYS_INLINE uint32_t csReserved() const {
-    return content_store_reserved_;
-  }
-
- private:
-  PrefixType prefix_;
-  uint32_t content_store_reserved_;
-};
-
-using BindConfig = BasicBindConfig<core::Prefix>;
-
-class Portal {
+class Portal : private utils::NonCopyable {
  public:
   /**
-   * Consumer callback is an abstract class containing two methods to be
-   * implemented by a consumer application.
+   * Transport callback is an abstract class containing two methods to be
+   * implemented by a consumer/producer application.
    */
-  class ConsumerCallback {
+  class TransportCallback {
    public:
+    virtual void onInterest(core::Interest &i) = 0;
     virtual void onContentObject(core::Interest &i, core::ContentObject &c) = 0;
     virtual void onTimeout(core::Interest::Ptr &i, const core::Name &n) = 0;
-    virtual void onError(std::error_code ec) = 0;
-  };
-
-  /**
-   * Producer callback is an abstract class containing two methods to be
-   * implemented by a producer application.
-   */
-  class ProducerCallback {
-   public:
-    virtual void onInterest(core::Interest &i) = 0;
-    virtual void onError(std::error_code ec) = 0;
+    virtual void onError(const std::error_code &ec) = 0;
   };
 
   using OnContentObjectCallback =
@@ -89,21 +51,14 @@ class Portal {
 
   Portal();
 
-  Portal(asio::io_service &io_service);
+  Portal(::utils::EventThread &worker);
 
   /**
-   * Set the consumer callback.
-   *
-   * @param consumer_callback - The pointer to the ConsumerCallback object.
-   */
-  void setConsumerCallback(ConsumerCallback *consumer_callback);
-
-  /**
-   * Set the producer callback.
+   * Set the transport protocl callback.
    *
    * @param producer_callback - The pointer to the ProducerCallback object.
    */
-  void setProducerCallback(ProducerCallback *producer_callback);
+  void registerTransportCallback(TransportCallback *transport_callback);
 
   /**
    * Connect the transport to the local hicn forwarder.
@@ -146,34 +101,12 @@ class Portal {
           UNSET_CALLBACK);
 
   /**
-   * Register a producer name to the local forwarder and optionally set the
-   * content store size in a per-face manner.
-   *
-   * @param config - The configuration for the local forwarder binding.
-   */
-  void bind(const BindConfig &config);
-
-  void runEventsLoop();
-
-  /**
-   * Run one event and return.
-   */
-  void runOneEvent();
-
-  /**
    * Send a data packet to the local forwarder. As opposite to sendInterest, the
    * ownership of the content object is not transferred to the portal.
    *
    * @param content_object - The data packet.
    */
   void sendContentObject(core::ContentObject &content_object);
-  /**
-   * Stop the event loop, canceling all the pending events in the event queue.
-   *
-   * Beware that stopping the event loop DOES NOT disconnect the transport from
-   * the local forwarder, the connector underneath will stay connected.
-   */
-  void stopEventsLoop();
 
   /**
    * Disconnect the transport from the local forwarder.
@@ -188,15 +121,26 @@ class Portal {
   /**
    * Get a reference to the io_service object.
    */
-  asio::io_service &getIoService();
+  utils::EventThread &getThread();
 
   /**
    * Register a route to the local forwarder.
    */
   void registerRoute(core::Prefix &prefix);
 
+  /**
+   * Send a MAP-Me command to traverse NATs.
+   */
+  void sendMapme();
+
+  /**
+   * Set forwarding strategy
+   */
+  void setForwardingStrategy(core::Prefix &prefix, std::string &strategy);
+
  private:
-  void *implementation_;
+  class Impl;
+  Impl *implementation_;
 };
 
 }  // namespace interface