VCL-LDPRELOAD LIBRARY

A LD_PRELOAD library built on top of VCL library

- initial creation.
- User can LD_PRELOAD any application that uses POSIX socket
  API and yet reap the benifits of VPP transport.

- addressed review comments
- fix bug in vcom_select
  rv was always zero.
- updated README.md with instructions to use socket_test.sh script

Signed-off-by: shrinivasan ganapathy <shrinivasanganapathy@gmail.com>

	new file:   vcl-ldpreload/LICENSE
	new file:   vcl-ldpreload/MAINTAINERS
	new file:   vcl-ldpreload/src/Makefile.am
	new file:   vcl-ldpreload/src/configure.ac
	new file:   vcl-ldpreload/src/libvcl-ldpreload.am
	new file:   vcl-ldpreload/src/libvcl-ldpreload/TODO
	new file:   vcl-ldpreload/src/libvcl-ldpreload/vcom.c
	new file:   vcl-ldpreload/src/libvcl-ldpreload/vcom.h
	new file:   vcl-ldpreload/src/libvcl-ldpreload/vcom_glibc_socket.h
	new file:   vcl-ldpreload/src/libvcl-ldpreload/vcom_socket.c
	new file:   vcl-ldpreload/src/libvcl-ldpreload/vcom_socket.h
	new file:   vcl-ldpreload/src/libvcl-ldpreload/vcom_socket_wrapper.c
	new file:   vcl-ldpreload/src/libvcl-ldpreload/vcom_socket_wrapper.h
	new file:   vcl-ldpreload/src/vcl-ldpreload.mk
	new file:   vcl-ldpreload/test/README.md

Change-Id: I0db70bc4c3b3bac35451afa432c20dc04cb9699c
Signed-off-by: shrinivasan ganapathy <shrinivasanganapathy@gmail.com>

1 files changed, 51 insertions, 1 deletions

diff --git a/vcl-ldpreload/README.md b/vcl-ldpreload/README.md
index 20dd49b..d1ec58a 100644
--- a/vcl-ldpreload/README.md
+++ b/vcl-ldpreload/README.md
@@ -1 +1,51 @@
-Stub
+# vcl-ldpreload a LD_PRELOAD library that uses VCL library for data transport
+
+libvcl_ldpreload.so library is to be used as a LD_PRELOAD library.
+User can LD_PRELOAD any application that uses POSIX socket API.
+This library internally uses libvppcom.so library from VPP project.
+
+
+## HowTo
+
+The library can be compiled by running the following commands from the vppsb/vcl-ldpreload/src directory:
+If VPP is installed, then 
+```bash
+libtoolize
+aclocal
+autoconf
+automake 
+./configure
+make
+sudo make install
+```
+If VPP is not installed, but rather built in a separate directory, you can use the VPP_DIR 'configure' argument.
+```bash
+autoreconf -i -f
+./configure VPP_DIR=<absolute/path/to/vpp>
+make
+sudo make install
+```bash
+
+Useful test script can be found in VPP project:
+.../vpp/test/scripts/socket_test.sh
+
+Running socket_test.sh without parameters will give the help menu.
+ 
+## Administrative
+
+### Current status
+
+This library is currently under active enhancement.
+
+### Objective
+
+This effort intends to be a building block for a better integration of POSIX socket applications with VPP.
+It will evolve depending on the needs of the VPP community while focusing on 
+LD_PRELOADing applications that use POSIX socket APIs.
+
+### Main contributors
+
+Shrinivasan Ganapathy - LF-ID:shganapa
+
+
+