vpp-api/lua/README.md

   1 This is the experimental version of Lua API, aimed for the luajit use.
   2
   3 Please take a look and send the feedback to ayourtch@gmail.com.
   4
   5 To run the examples here:
   6
   7 1) install luajit - "sudo apt-get install luajit" on ubuntu
   8
   9 2) make build-vpp-api in the top directory
  10
  11 3) "make" in this directory to build libcough.so
  12
  13 4) "make run" in a separate terminal window
  14
  15 5) sudo luajit examples/example-cli.lua
  16
  17 This will result in something like this:
  18
  19 libcough detected
  20
  21 Version:        17.01-rc0~37-g8b3191e
  22 00000000  31 37 2E 30 31 2D 72 63  30 7E 33 37 2D 67 38 62  17.01-rc0~37-g8b
  23 00000010  33 31 39 31 65 00 00 00  00 00 00 00 00 00 00 00  3191e...........
  24
  25 { [1] = { ["luaapi_message_name"] = show_version_reply,["program"] = vpe,["version"] = 17.01-rc0~37-g8b3191e,["build_date"] = Fri Nov 11 15:30:21 UTC 2016,["retval"] = 0,["build_directory"] = /home/ubuntu/vpp,["_vl_msg_id"] = 166,["context"] = 0,} ,}
  26 ---
  27 { [1] = { ["luaapi_message_name"] = cli_inband_reply,["_vl_msg_id"] = 90,["length"] = 94,["reply"] = vpp v17.01-rc0~37-g8b3191e built by ubuntu on vpp-lapi-commit at Fri Nov 11 15:30:21 UTC 2016
  28 ,["retval"] = 0,["context"] = 0,} ,}
  29 ---
  30
  31 6) You can also run the performance test bench:
  32
  33 $ sudo luajit bench.lua
  34 libcough detected
  35
  36 10001 iterations, average speed 4108LL per second
  37 10001 iterations, average speed 4660LL per second
  38 10001 iterations, average speed 4095LL per second
  39 10001 iterations, average speed 4542LL per second
  40 10001 iterations, average speed 8048LL per second
  41 10001 iterations, average speed 6805LL per second
  42 10001 iterations, average speed 5170LL per second
  43 10001 iterations, average speed 6585LL per second
  44 10001 iterations, average speed 6714LL per second
  45 10001 iterations, average speed 6942LL per second
  46 Average tps across the tests: 5766LL
  47
  48 Note: the above is run in an lxd container running inside 2-core
  49 xhyve VM on a Macbook Pro, so I would not take the performance numbers for granted :)
  50
  51 The "examples" directory contains a few naive examples, as well as a couple of more
  52 advanced ones - a tab-completing CLI for VPP that can call both the APIs and CLI,
  53 and also a small test utility which I use for automating some small tests using
  54 VPP.
  55