summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2022-09-21refactor(logs): use glog instead of printsEnrico Loparco (eloparco)1-6/+0
Ref: HICN-788 Signed-off-by: Enrico Loparco (eloparco) <eloparco@cisco.com> Change-Id: Iedf75e1658a335985cc2dfd7b82ae61124f2371e
2022-08-11feat: drop sysrepo and netconf/yang supportLuca Muscariello1-317/+1
Signed-off-by: Luca Muscariello <muscariello@ieee.org> Change-Id: I215af1b77a3f9da878f3894708f687a7e7ea03a2
2022-06-30refactor(lib, hicn-light, vpp, hiperf): HICN-723Luca Muscariello2-10/+34
- move infra data structure into the shared lib - new packet cache using double hashing and lookup on prefix suffix - testing updates - authenticated requests using interest manifests 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: Olivier Roques <oroques+fdio@cisco.com> Co-authored-by: Enrico Loparco <eloparco@cisco.com> Change-Id: Iaddebfe6aa5279ea8553433b0f519578f6b9ccd9 Signed-off-by: Luca Muscariello <muscariello@ieee.org>
2022-03-31feat: boostrap hicn 22.02Luca Muscariello14-338/+620
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>
2021-04-15[HICN-690] Transport Library Major RefactoryLuca Muscariello1-1/+0
The current patch provides a major refactory of the transportlibrary. A summary of the different components that underwent major modifications is reported below. - Transport protocol updates The hierarchy of classes has been optimized to have common transport services across different transport protocols. This can allow to customize a transport protocol with new features. - A new real-time communication protocol The RTC protocol has been optimized in terms of algorithms to reduce consumer-producer synchronization latency. - A novel socket API The API has been reworked to be easier to consumer but also to have a more efficient integration in L4 proxies. - Several performance improvements A large number of performance improvements have been included in particular to make the entire stack zero-copy and optimize cache miss. - New memory buffer framework Memory management has been reworked entirely to provide a more efficient infra with a richer API. Buffers are now allocated in blocks and a single buffer holds the memory for (1) the shared_ptr control block, (2) the metadata of the packet (e.g. name, pointer to other buffers if buffer is chained and relevant offsets), and (3) the packet itself, as it is sent/received over the network. - A new slab allocator Dynamic memory allocation is now managed by a novel slab allocator that is optimised for packet processing and connection management. Memory is organized in pools of blocks all of the same size which are used during the processing of outgoing/incoming packets. When a memory block Is allocated is always taken from a global pool and when it is deallocated is returned to the pool, thus avoiding the cost of any heap allocation in the data path. - New transport connectors Consumer and producer end-points can communication either using an hicn packet forwarder or with direct connector based on shared memories or sockets. The usage of transport connectors typically for unit and funcitonal testing but may have additional usage. - Support for FEC/ECC for transport services FEC/ECC via reed solomon is supported by default and made available to transport services as a modular component. Reed solomon block codes is a default FEC model that can be replaced in a modular way by many other codes including RLNC not avaiable in this distribution. The current FEC framework support variable size padding and efficiently makes use of the infra memory buffers to avoid additiona copies. - Secure transport framework for signature computation and verification Crypto support is nativelty used in hICN for integrity and authenticity. Novel support that includes RTC has been implemented and made modular and reusable acrosso different transport protocols. - TLS - Transport layer security over hicn Point to point confidentiality is provided by integrating TLS on top of hICN reliable and non-reliable transport. The integration is common and makes a different use of the TLS record. - MLS - Messaging layer security over hicn MLS integration on top of hICN is made by using the MLSPP implemetation open sourced by Cisco. We have included instrumentation tools to deploy performance and functional tests of groups of end-points. - Android support The overall code has been heavily tested in Android environments and has received heavy lifting to better run natively in recent Android OS. Co-authored-by: Mauro Sardara <msardara@cisco.com> Co-authored-by: Michele Papalini <micpapal@cisco.com> Co-authored-by: Olivier Roques <oroques+fdio@cisco.com> Co-authored-by: Giulio Grassi <gigrassi@cisco.com> Change-Id: If477ba2fa686e6f47bdf96307ac60938766aef69 Signed-off-by: Luca Muscariello <muscariello@ieee.org>
2021-04-06[HICN-692] Fix deb package installation of packethicnMarco Trinelli2-10/+41
Signed-off-by: Marco Trinelli <marcotrinelli@gmail.com> Change-Id: I3c916807904d78c17a3444808f904b9c0cf0a4f5
2021-03-25[HICN-688] Include packethicn in hicn buildMarco Trinelli1-0/+97
Add license headers Add dependencies Fix build for Ubuntu 18.04 Move doc Signed-off-by: Marco Trinelli <marcotrinelli@gmail.com> Change-Id: Ie92268d2d3a47c47746107ac6f9c34b21949671c
2020-05-06[HICN-606] Added doxygen documentationAlberto Compagno2-0/+47
Signed-off-by: Alberto Compagno <acompagn+fdio@cisco.com> Change-Id: If2bf7f4f310adf6adbbb9ea29eafcb2a0ee40d54
2020-05-04[HICN-603] Cleanup code for managing routeAlberto Compagno2-117/+30
- Remove old code to add and remove hicn route. Routes are now added only through the ip route commands/apis - Adjusted the cli to set the strategy for a particular prefix - Adjusted libtransport consumer and producer app creation - Adjusted sysrepo plugin. Added hicn enable and disable and removed old api related to hicn routes and hicn faces - Adjusted libhicnctrl. Only routes api and listener are now available for hicn-plugin Signed-off-by: Alberto Compagno <acompagn+fdio@cisco.com> Change-Id: Ib4f7f45ba0b99253d60a9da2b295d6e783e5cd51
2020-03-23Merge "[HICN-572] Updated sysrepo documentation"Luca Muscariello1-6/+10
2020-03-23Merge "[HICN-551] Removed source code that uses acl"Luca Muscariello1-15/+92
2020-03-20[HICN-551] Removed source code that uses aclAlberto Compagno1-15/+92
- Removed punting from the sysrepo-plugin - Removed calls to the punting functions of binary api in the libhicnctrl - Added documentation in vpp-plugin.md and doxygen related to pg Change-Id: I8936156d51524797441ec49f0d5e801a1ad3643a Signed-off-by: Alberto Compagno <acompagn+fdio@cisco.com>
2020-03-20[HICN-572] Updated sysrepo documentationAlberto Compagno1-6/+10
- Removed reference to the old sysrepod - Added information for the authentication to netopee2-server Change-Id: I435458bebb8f95eb8e63a45fa7fa8a3e060a08e4 Signed-off-by: Alberto Compagno <acompagn+fdio@cisco.com>
2020-03-18[HICN-562] Add new options to VPP collectd pluginsOlivier Roques1-0/+15
Add two options to the vpp and vpp-hicn plugins: * Verbose, to enable additional statistics * Tag, to tag the data with a given string Change-Id: Ifee6c979654f87a13787095dddab0076b218e334 Signed-off-by: Olivier Roques <oroques+fdio@cisco.com>
2020-03-05[HICN-541] Add custom type database of collectd pluginsOlivier Roques1-3/+10
This patch adds the database containing the types that the two collectd plugins, vpp and vpp-hicn, defines. It is useful when using InfluxDB as it requires the type database for multi-value metrics (see https://docs.influxdata.com/influxdb/v1.7/supported_protocols/collectd/). Change-Id: Ia3e630b134e58e942be38cacb9b23379066c6e63 Signed-off-by: Olivier Roques <oroques+fdio@cisco.com>
2020-03-04[HICN-541] Change installation directory of collectd pluginsOlivier Roques1-3/+3
Signed-off-by: Olivier Roques <oroques+fdio@cisco.com> Change-Id: Ic298e57c11a0b86976d52096a2f691dd511adc3f
2020-02-28[HICN-537] Update telemetry documentationOlivier Roques2-5/+11
Change-Id: I3f6c656164b27481e029eb72a63030bb592a6f1b Signed-off-by: Olivier Roques <oroques+fdio@cisco.com>
2020-02-25[HICN-533] Update and format documentationOlivier Roques10-424/+508
This patch fixes misspells, improves readability and tries to make the different source files consistent between each other. It also updates hiperf usage and hicn + VPP installation (in utils.md) and fixes some mistakes related to collectd plugins (in telemetry.md). Change-Id: I100a1c7e40dbe9c485ae4548ffc653765f4421b9 Signed-off-by: Olivier Roques <oroques+fdio@cisco.com>
2020-02-21[HICN-531] update documentation with fixes and new contentLuca Muscariello6-102/+120
Change-Id: I4d75f559875fbaae3a63ed20835461b3d18691fb Signed-off-by: Luca Muscariello <muscariello@ieee.org>
2020-02-18[HICN-510] Adding collectd plugins to get telemetry from vpp and hicn-pluginAlberto Compagno2-1/+118
Change-Id: Idb322dc712b52301c66c5256ad8d1a6a65b503b9 Signed-off-by: Alberto Compagno <acompagn+fdio@cisco.com>
2020-02-15[HICN-521] Documentation updateLuca Muscariello9-101/+245
Change-Id: I3ef51af521b53512e589eaf5bb5c0852a638baf5 Signed-off-by: Luca Muscariello <muscariello@ieee.org>
2020-02-13[HICN-519] Documentation updateLuca Muscariello10-349/+269
Change-Id: Iba61bc07196643b8061f0cb0f7213c7e0b256020 Signed-off-by: Luca Muscariello <muscariello@ieee.org>
2020-02-12[HICN-512] documentation bundle using sphinxLuca Muscariello16-0/+2448
Change-Id: I1dcbca50f7406ef2714683547b6bb32463e1baf8 Signed-off-by: Luca Muscariello <muscariello@ieee.org>