diff options
author | Luca Muscariello <lumuscar@cisco.com> | 2022-03-30 22:29:28 +0200 |
---|---|---|
committer | Mauro Sardara <msardara@cisco.com> | 2022-03-31 19:51:47 +0200 |
commit | c46e5df56b67bb8ea7a068d39324c640084ead2b (patch) | |
tree | eddeb17785938e09bc42eec98ee09b8a28846de6 /README.md | |
parent | 18fa668f25d3cc5463417ce7df6637e31578e898 (diff) |
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>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 58 |
1 files changed, 27 insertions, 31 deletions
@@ -2,10 +2,13 @@ ## Introduction -hicn is an open source implementation of Cisco's hICN. It includes a network stack, that implements -ICN forwarding path in IPv6, and a transport stack that implements two main transport protocols and -a socket API. The transport protocols provide one reliable transport service implementation and a -real-time transport service for audio/video media. +This is an open source implementation of Cisco's hICN. It includes a network +stack, that implements ICN forwarding path in IPv6, and a transport stack that +implements reliable and unrelieable transport with congestion control and loss +management by ARQ or FEC. It supports applications such as reliable multicast +for ABR video, real-time video conferencing and on-line multiplayer games. +The client stack has been tested on iOS and Android over Wi-Fi, LTE and Ethernet +including multi-homing use cases. ## Directory layout @@ -15,29 +18,27 @@ real-time transport service for audio/video media. | hicn-plugin | VPP plugin | | hicn-light | Lightweight packet forwarder | | libtransport | Support library with transport layer and API | -| utils | Tools for testing | -| apps | Application examples using hicn stack | +| apps | Application examples using hicn stack and tools | | ctrl | Tools and libraries for network configuration and control | -hicn plugin is a VPP plugin that implement hicn packet processing as specified in -https://datatracker.ietf.org/doc/draft-muscariello-intarea-hicn/. The transport library is used to -implement the hicn host stack and makes use of libmemif as high performance connector between -transport and the network stack. The transport library makes use of VPP binary API to configure the -local namespace (local face management). +hicn plugin is a VPP plugin that implement hicn packet processing as specified +in https://datatracker.ietf.org/doc/draft-muscariello-intarea-hicn/. The +transport library is used to implement the hicn host stack and makes use of +libmemif as high performance connector between transport and the network stack. +The transport library makes use of VPP binary API to configure the local +namespace (local face management). ## Supported platforms -- Ubuntu 16.04 LTS (amd64) -- Ubuntu 18.04 LTS (amd64, arm64) -- CentOS 7 (x86_64) -- Android 10 -- iOS 13 -- macOS 10.15 -- Windows 10 +- Ubuntu 20.04 LTS (amd64, arm64) +- Android 10+ +- iOS 13+ +- macOS 10.15+ +- Windows 10+ ## Binaries -### Ubuntu 16/18 (amd64) and CentOS 7 (x86_64) +### Ubuntu (amd64, arm64) <https://packagecloud.io/fdio/release> @@ -45,17 +46,12 @@ local namespace (local face management). <https://hub.docker.com/u/icnteam> -### Vagrant - -<https://app.vagrantup.com/icnteam/> - ### Release note -The current master branch provides the latest release which is compatible with the latest VPP stable. -No other VPP releases are supported nor maintained. At every new VPP release distribution hicn -master branch is updated to work with the latest stable release. All previous stable releases -are discontinued and not maintained. The user who is interested in a specific release can always -checkout the right code tree by searching the latest commit under a given git tag carrying the -release version. - - +The current master branch provides the latest release which is compatible with +the latest VPP stable. No other VPP releases are supported nor maintained. At +every new VPP release distribution hicn master branch is updated to work with +the latest stable release. All previous stable releases are discontinued and not +maintained. The user who is interested in a specific release can always checkout +the right code tree by searching the latest commit under a given git tag +carrying the release version. |