diff options
| author |   Nathan Skrzypczak <nathan.skrzypczak@gmail.com> | 2021-10-12 14:00:25 +0200 |
|---|---|---|
| committer |   Dave Wallace <dwallacelf@gmail.com> | 2021-10-13 15:30:03 +0000 |
| commit | 8acc5ee9079d0b03229a72e72a5308e7de0a359a (patch) | |
| tree | ba3e5789abc2c3cd4edd9806fc44991c45d705f1 /extras/libmemif/libmemif_doc.md | |
| parent | 87e90830b8931b4c55526bf7cb5a148a10df061f (diff) | |
libmemif: docs md->rst
Type: improvement
Change-Id: Ibebd2d47a4268189f11601d004073e4858548f25
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Diffstat (limited to 'extras/libmemif/libmemif_doc.md')
| -rw-r--r-- | extras/libmemif/libmemif_doc.md | 58 |
1 files changed, 0 insertions, 58 deletions
diff --git a/extras/libmemif/libmemif_doc.md b/extras/libmemif/libmemif_doc.md deleted file mode 100644 index ac3d6dadcfb..00000000000 --- a/extras/libmemif/libmemif_doc.md +++ /dev/null @@ -1,58 +0,0 @@ -Shared Memory Packet Interface (memif) Library {#libmemif_doc} -============================================== - -## Introduction - -Shared memory packet interface (memif) provides high performance packet transmit and receive between user application and Vector Packet Processing (VPP) or multiple user applications. Using libmemif, user application can create shared memory interface in master or slave mode and connect to VPP or another application using libmemif. Once the connection is established, user application can receive or transmit packets using libmemif API. - - - -## Features - -- [x] Slave mode - - [x] Connect to VPP over memif - - [x] ICMP responder example app -- [x] Transmit/receive packets -- [x] Interrupt mode support -- [x] File descriptor event polling in libmemif (optional) - - [x] Simplify file descriptor event polling (one handler for control and interrupt channel) -- [x] Multiple connections -- [x] Multiple queues - - [x] Multi-thread support -- [x] Master mode - - [x] Multiple regions -- [x] Loopback - -## Quickstart - -This setup will run libmemif ICMP responder example app in container. Install [docker](https://docs.docker.com/engine/installation) engine. -Useful link: [Docker documentation](https://docs.docker.com/get-started). - -Build the docker image: -``` -# docker build . -t libmemif -``` - -Now you should be able to see libmemif image on your local machine: -``` -# docker images -REPOSITORY TAG IMAGE ID CREATED SIZE -libmemif latest 32ecc2f9d013 About a minute ago 468MB -... -``` - -Run container: -``` -# docker run -it --rm --name icmp-responder --hostname icmp-responder --privileged -v "/run/vpp/:/run/vpp/" libmemif -``` - -The interface will by default connect to a master interface listening on `/run/vpp/master.sock`. The example will handle ARP requests and respond to ICMPv4 requests to `192.168.1.1`. - -Continue with @ref libmemif_example_setup which contains instructions on how to set up connection between icmpr-epoll example app and VPP-memif. - -#### Next steps - -- @subpage libmemif_build_doc -- @subpage libmemif_examples_doc -- @subpage libmemif_example_setup_doc -- @subpage libmemif_gettingstarted_doc |