How fdio/hicn works
Project type and purpose
• hICN is an open-source, modular network stack and toolset implementing Cisco’s hybrid Information-Centric Networking.
• It includes:
• A core “lib” library for low-level ICN packet and data structures.
• A transport library (“libtransport”) implementing reliable/unreliable delivery, congestion control, ARQ/FEC.
• A lightweight forwarder (“hicn-light”) for standalone ICN forwarding in IPv6.
• A VPP plugin (“hicn-plugin”) to integrate ICN forwarding into the VPP data plane.
• Control plane tools and libraries (“ctrl” and “libhicnctrl”) to configure faces, routes, policies.
• Example applications (“apps”) that consume the transport API (ping, http-proxy, higet, etc.).
• Telemetry collectors for metrics (collectd plugins, Kafka writers).
• A comprehensive test suite and Docker/CMake build infrastructure.
File structure and infer architecture
• Top-level modules map directly to architectural components: lib, libtransport, hicn-light, hicn-plugin, ctrl, apps, telemetry, tests.
• Each module is built via CMake; the plugin and forwarder implement the “forwarding plane,” libtransport is the “transport plane,” and lib is the “core plane.”
• The control plane sits beside the forwarder layer, talking to either hicn-light (via its API) or to VPP (via binary API through libhicnctrl).
• Apps sit “above” libtransport, consuming its socket-style API to produce/consume ICN traffic.
a. Core Library (“lib”)
b. Transport Library (“libtransport”)
c. Forwarding Plane
– hicn-light (standalone forwarder process)
– hicn-plugin (VPP plugin module loaded into VPP dataplane)
d. Control Plane
– libhicnctrl (C library to talk to forwarder or VPP)
– ctrl/facemgr (daemon or CLI tools to manage faces, routes)
e. Applications (“apps” folder)
– ping client/server, hyperf, http-proxy, higet, etc.
f. Telemetry
– collectd plugins, Kafka/influx writers, custom vpp-hicn collectors
g. Infrastructure & Tests
– Docker containers, functional tests, CMake build logic, packaging scripts
Relationships and data flows
• At runtime Applications → libtransport API → libtransport core → Forwarding Plane
• If using hicn-light: libtransport links to hicn-light’s UNIX/UDP connector.
• If using VPP: libtransport → memif or binary API → VPP dataplane with hicn-plugin.
• Control Plane tools → libhicnctrl → Forwarding Plane (either hicn-light’s API or VPP binary API)
• Telemetry collectors subscribe or poll metrics from the forwarder (via shared memory or plugin hooks) and forward to external systems (Kafka, InfluxDB).
• Tests and CI wrap and orchestrate containers running the full stack end-to-end.
Architectural patterns & design principles
• Clear separation of concerns: core, transport, forwarding, control, applications.
• Plugin‐based extensibility for the data plane (hicn-plugin in VPP).
• Layered socket‐style API for transport, enabling pluggable I/O modules (memif, UDP, TCP).
• CMake modular builds with packaging support for Ubuntu, Docker, macOS, Windows.
• Functional test harness orchestrating multiple nodes/containers.