X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=extras%2Flibmemif%2Fdocs%2Fbuildinstructions_doc.md;h=a226856b2b6eb8559b090b8a6f2da6e7dc103224;hb=ecfa2aaa631933f5c77858ae3e5e15a76619dd77;hp=838e835a9a575db1bad3662789723c8fcf106214;hpb=b4ff07a2f843207b6d024e1ed8a31fa37324fe07;p=vpp.git diff --git a/extras/libmemif/docs/buildinstructions_doc.md b/extras/libmemif/docs/buildinstructions_doc.md index 838e835a9a5..a226856b2b6 100644 --- a/extras/libmemif/docs/buildinstructions_doc.md +++ b/extras/libmemif/docs/buildinstructions_doc.md @@ -5,12 +5,10 @@ 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 -``` +Libmemif is now part of VPP repository. Follow fd.io wiki to pull source code from VPP repository. +[https://wiki.fd.io/view/VPP/Pulling,_Building,_Running,_Hacking_and_Pushing_VPP_Code#Pushing_Patches](https://wiki.fd.io/view/VPP/Pulling,_Building,_Running,_Hacking_and_Pushing_VPP_Code#Pushing_Patches) -From root directory execute: +Libmemif is located under extras/libmemif. For debug build: ``` # ./bootstrap @@ -33,21 +31,23 @@ Verify installation: > 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 +ICMP_Responder:add_epoll_fd:233: fd 0 added to epoll +ICMP_Responder:add_epoll_fd:233: fd 5 added to epoll LIBMEMIF EXAMPLE APP: ICMP_Responder (debug) ============================== -libmemif version: 1.0 (debug) -memif version: 256 +libmemif version: 2.0 (debug) +memif version: 512 commands: help - prints this help exit - exit app - conn - create memif (slave-mode) + conn [] - create memif. index is also used as interface id, mode 0 = slave 1 = master, interrupt-desc none = default 0 = if ring is full wait 1 = handle only ARP requests del - delete memif show - show connection details ip-set - set interface ip address rx-mode - set queue rx mode + sh-count - print counters + cl-count - clear counters + send - send icmp ``` #### Examples