README.md revision e1b749ab
1# vcl-ldpreload a LD_PRELOAD library that uses VCL library for data transport
2
3libvcl_ldpreload.so library is to be used as a LD_PRELOAD library.
4User can LD_PRELOAD any application that uses POSIX socket API.
5This library internally uses libvppcom.so library from VPP project.
6
7
8## HowTo
9
10The library can be compiled by running the following commands from the vppsb/vcl-ldpreload/src directory:
11If VPP is installed, then 
12```bash
13libtoolize
14aclocal
15autoconf
16automake 
17./configure
18make
19sudo make install
20```
21If VPP is not installed, but rather built in a separate directory, you can use the VPP_DIR 'configure' argument.
22```bash
23autoreconf -i -f
24./configure VPP_DIR=<absolute/path/to/vpp>
25make
26sudo make install
27```bash
28
29Useful test script can be found in VPP project:
30.../vpp/test/scripts/socket_test.sh
31
32Running socket_test.sh without parameters will give the help menu.
33 
34## Administrative
35
36### Current status
37
38This library is currently under active enhancement.
39
40### Objective
41
42This effort intends to be a building block for a better integration of POSIX socket applications with VPP.
43It will evolve depending on the needs of the VPP community while focusing on 
44LD_PRELOADing applications that use POSIX socket APIs.
45
46### Main contributors
47
48Shrinivasan Ganapathy - LF-ID:shganapa
49
50
51
52