docs: convert extras doc md->rst
[vpp.git] / extras / vcl-ldpreload / README.rst
1 .. _vcl_ldpreload_doc:
2
3 LD_PRELOAD the VCL
4 ==================
5
6 vcl-ldpreload is a LD_PRELOAD library that uses the VPP Communications Library (VCL).
7
8 User can LD_PRELOAD any application that uses POSIX socket API.
9
10 NOTE: The sources have been moved to ``vpp/src/vcl`` and ``libvcl_ldpreload.so`` is built with VPP and can be found in
11 ``vpp/build-root/install-vpp[_debug]-native/vpp/lib``
12
13 1. Running the demo
14 -------------------
15
16 Run test script without parameters to see help menu:
17
18 ::
19
20     export WS_ROOT= (e.g. /scratch/my_name/vpp)
21     $WS_ROOT/test/scripts/socket_test.sh
22
23
24 2. Docker iPerf examples
25 ------------------------
26
27 These launch xterms. To quit, close xterms and run following docker kill cmd (WARNING: This will kill all docker containers!) ‘docker kill $(docker ps -q)’
28
29 Docker iPerf using default Linux Bridge
30
31 ::
32
33     $WS_ROOT/test/scripts/socket_test.sh -bi docker-kernel
34
35
36 Docker iPerf using VPP
37
38 ::
39
40     $WS_ROOT/test/scripts/socket_test.sh -bi docker-preload