ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
vpp/extras/libmemif/docs/buildinstructions_doc.md
Chris Luke 64ebb5ff13 General documentation updates 
- We now have several developer-focused docs, so create an index page
  for them.
- Rework several docs to fit into the index structure.
- Experiment with code highlighting; tweak the CSS slightly to make
  it slightly nicer to look at.

Change-Id: I4185a18f84fa0764745ca7a3148276064a3155c6
Signed-off-by: Chris Luke <chrisy@flirble.org>
2017-09-28 01:04:56 +00:00

1.5 KiB
Raw Blame History

Build Instructions

Install dependencies

# sudo apt-get install -y git autoconf pkg_config libtool check

Clone repository to your local machine.

# git clone https://github.com/JakubGrajciar/libmemif.git

From root directory execute: For debug build:

# ./bootstrap
# ./configure
# make
# make install

For release build:

# ./bootstrap
# ./configure
# make release
# make install

Verify installation:

# ./.libs/icmpr-epoll

Make sure to run the binary file from ./.libs. File ./icmp_responder in libmemif root directory is script that links the library, so it only verifies successful build. Default install path is /usr/lib. Use help command to display build information and commands:

ICMP_Responder:add_epoll_fd:204: fd 0 added to epoll
MEMIF_DEBUG:src/main.c:memif_init:383: app name: ICMP_Responder
ICMP_Responder:add_epoll_fd:204: fd 4 added to epoll
LIBMEMIF EXAMPLE APP: ICMP_Responder (debug)
==============================
libmemif version: 1.0 (debug)
memif version: 256
commands:
	help - prints this help
	exit - exit app
	conn <index> - create memif (slave-mode)
	del  <index> - delete memif
	show - show connection details
	ip-set <index> <ip-addr> - set interface ip address
	rx-mode <index> <qid> <polling|interrupt> - set queue rx mode

Examples

Once the library is built/installed, refer to @ref libmemif_examples_doc and @ref libmemif_gettingstarted_doc for additional information on basic use cases and API usage.