extras/libmemif/docs/buildinstructions_doc.md

   1 ## Build Instructions    {#libmemif_build_doc}
   2
   3 #### Install dependencies
   4 ```
   5 # sudo apt-get install -y git cmake autoconf pkg_config libtool check
   6 ```
   7
   8 Libmemif is now part of VPP repository. Follow fd.io wiki to pull source code from VPP repository.
   9 [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)
  10
  11 Libmemif is located under extras/libmemif. From extras/libmemif:
  12 ```
  13 # mkdir build
  14 # cd build
  15 # cmake ..
  16 # make install
  17 ```
  18
  19 #### Verify installation:
  20 ```
  21 build# ./examples/icmpr-epoll
  22 ```
  23 Use _help_ command to display build information and commands:
  24 ```
  25 LIBMEMIF EXAMPLE APP: ICMP_Responder
  26 ==============================
  27 libmemif version: 3.0
  28 memif version: 512
  29         use CTRL+C to exit
  30 MEMIF DETAILS
  31 ==============================
  32         interface name: memif_connection
  33         app name: ICMP_Responder
  34         remote interface name:
  35         remote app name:
  36         id: 0
  37         secret: (null)
  38         role: slave
  39         mode: ethernet
  40         socket filename: /run/vpp/memif.sock
  41         socket filename: /run/vpp/memif.sock
  42         rx queues:
  43         tx queues:
  44         link: down
  45 ```
  46
  47 #### Examples
  48
  49 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.