diff options
| author |   Jakub Grajciar <grajciar.jakub@gmail.com> | 2017-08-30 10:13:25 +0200 |
|---|---|---|
| committer |   Damjan Marion <dmarion.lists@gmail.com> | 2017-09-13 20:12:54 +0000 |
| commit | 7c5c40db2a8d71a857ae63b6238cfac6e257da6d (patch) | |
| tree | f0c01c2087ffd67e770d6f7932849ba13f44f12f /extras/libmemif/docs/BuildInstructions.md | |
| parent | a4393be1a03f6a8f8da5d53c22b8dca52fed6f51 (diff) | |
Shared memory packet interface (memif) library
Change-Id: I5097462ae85acd705f19e92517c01094dba7565f
Signed-off-by: Jakub Grajciar <grajciar.jakub@gmail.com>
Diffstat (limited to 'extras/libmemif/docs/BuildInstructions.md')
| -rw-r--r-- | extras/libmemif/docs/BuildInstructions.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/extras/libmemif/docs/BuildInstructions.md b/extras/libmemif/docs/BuildInstructions.md new file mode 100644 index 00000000000..9bb59b94c11 --- /dev/null +++ b/extras/libmemif/docs/BuildInstructions.md @@ -0,0 +1,54 @@ +## 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 build/installed, refer to [Examples](../examples/README.md) and [Getting started](GettingStarted.md) for additional information on basic use cases and API usage. |