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 VPP directory
  10
  11 3) "make run" in a separate terminal window
  12    This ensures you have an instance of VPP running
  13
  14 4) sudo luajit examples/example-cli.lua
  15
  16 This will result in something like this:
  17
  18 Version:
  19 00000000  00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  ................
  20 00000010  00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  ................
  21
  22 { [1] = { ["luaapi_message_name"] = show_version_reply,["program"] = vpe,["version"] = ,["build_date"] = Fri Nov 25 10:58:48 UTC 2016,["retval"] = 0,["build_directory"] = /home/ubuntu/vpp,["_vl_msg_id"] = 170,["context"] = 0,} ,}
  23 ---
  24 { [1] = { ["luaapi_message_name"] = cli_inband_reply,["_vl_msg_id"] = 94,["length"] = 66,["reply"] = vpp v built by ubuntu on vpp-toys at Fri Nov 25 10:58:48 UTC 2016
  25 ,["retval"] = 0,["context"] = 0,} ,}
  26 ---
  27
  28 5) You can also run the performance test bench:
  29
  30 $ sudo luajit bench.lua
  31 10001 iterations, average speed 5624LL per second
  32 10001 iterations, average speed 6650LL per second
  33 10001 iterations, average speed 6053LL per second
  34 10001 iterations, average speed 7056LL per second
  35 10001 iterations, average speed 6388LL per second
  36 10001 iterations, average speed 5849LL per second
  37 10001 iterations, average speed 6321LL per second
  38 10001 iterations, average speed 6368LL per second
  39 10001 iterations, average speed 5958LL per second
  40 10001 iterations, average speed 6482LL per second
  41 Average tps across the tests: 6274LL
  42
  43 Note: the above is run in an lxd container running inside 2-core
  44 xhyve VM on a Macbook Pro, so I would not take the performance numbers for granted :)
  45
  46 The "examples" directory contains a few naive examples, as well as a couple of more
  47 advanced ones - a tab-completing CLI for VPP that can call both the APIs and CLI,
  48 and also a small test utility which I use for automating some small tests using
  49 VPP.
  50