vpp/extras/libmemif/libmemif_doc.rst
Jakub Grajciar e74c04fc9f libmemif: refactor examples
- icmp_responder: responds to ICMPv4 and ARP requests
- loopback: connects two interfaces and sends a
  verification packet from master memif to slave memif
  where it is looped back
- loopback (reverse path): reverses direction of packet
  in loopback application (slave memif to master memif)

Type: refactor

Signed-off-by: Jakub Grajciar <jgrajcia@cisco.com>
Change-Id: Ie90aaa3367269408efb6c5d538ad5aa827432238
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2022-03-28 22:34:33 +00:00

67 lines
1.7 KiB
ReStructuredText

.. _libmemif_doc:
Shared Memory Packet Interface (memif) Library
==============================================
Features
--------
- ✅ Slave mode
- ✅ Connect to VPP over memif
- ✅ ICMP responder example app
- ✅ Transmit/receive packets
- ✅ Interrupt mode support
- ✅ File descriptor event polling in libmemif (optional)
- ✅ Simplify file descriptor event polling (one handler for control
and interrupt channel)
- ✅ Multiple connections
- ✅ Multiple queues
- ✅ Multi-thread support
- ✅ Master mode
- ✅ Multiple regions
- ✅ 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_examples_doc` which contains instructions on
how to set up connection between icmp_responder example app and VPP-memif.