README revision 21121578
11. OVERVIEW
2
3   TLDK project scope is as follows:
4
5   1) To implement a set of libraries for L4 protocol processing (UDP, TCP etc.)
6   for both IPv4 and IPv6.
7
8   The goal is to provide lightweight, high performance and highly adaptable
9   implementation for L4(UDP, TCP etc.) protocol processing. The provided API
10   are not planned to be compatible with BSD socket API. These libraries are
11   supposed to be built on top of DPDK.
12
13   Note: these libraries are not supposed to be a 'complete' network stack.
14
15   Implementation of ARP, IP, ETHER, etc. layers and related routing tables,
16   code for setup, manage and perform actual IO over underlying devices are
17   all out of scope of these libraries.
18
19   The only information these libraries need to know about the 
20   underlying devices:
21   - supported HW offloads
22   - MTU and L3/L2 addresses
23   That allows the libraries to fill L2/L3 headers and mbuf metadata
24   for the outgoing packets.
25
26   These libraries should be developed in such manner, that they could be used
27   independently from implementations of 2) and 3).
28
29   2) To create VPP graph nodes, plugins etc using those libraries to implement
30   a host stack.
31
32   3) To create such mechanisms (netlink agents, packaging, etc) necessary
33   to make the resulting host stack easily usable by existing non-vpp aware
34   software.
35
36   The library uses siphash logic from the below source
37   https://github.com/veorq/SipHash
38
39
402. INSTALLATION GUIDE
41
42   1) Obtain latest supported DPDK version and build it.
43   (refer to http://dpdk.org for information how to download and build it).
44   Currently supported(tested) DPDK versions: 18.11 LTS.
45   2) Make sure that RTE_SDK and RTE_TARGET DPDK related environment variables
46   are setup correctly.
47   3) Go to the TLDK root directory and type: 'make all'.
48   4) Run sample applications.
49
50   For enabling unit tests application using GoogleTest please see:
51   ./test/gtest/README
52
53   As an example:
54   export RTE_SDK=/opt/DPDK
55   export RTE_TARGET=x86_64-native-linuxapp-gcc
56
57   cd tldk
58   make all
59   ./x86_64-native-linuxapp-gcc/app/l4fwd ...
60
613. CONTENTS
62
63   $(TLDK_ROOT)
64   |
65   +----app
66   |      |
67   |      +-- nginx - a clone of nginx integrated with TLDK
68   |          (refer to app/nginx/README.TLDK for more information)
69   |
70   +----lib
71   |      |
72   |      +--libtle_dring - dring library
73   |      |
74   |      +--libtle_l4p - implementation of the TCP/UDP packet processing
75   |      |
76   |      +--libtle_timer - implementation of the timer library
77   |
78   +----examples
79   |      |
80   |      +--l4fwd - sample app to demonstrate and test libtle_l4p TCP/UDP
81   |           | usage (refer to examples/l4fwd/README for more information)
82   |           |
83   |           +--test - function test scripts for l4lib using l4fwd
84   |
85   +----test - unit-tests
86   |      |
87   |      +--dring - UT for libtle_dring (standalone app)
88   |      |
89   |      +--gtest - UT for libtle_dring, libtle_l4p and libtle_timer
90   |      |     (googletest)
91   |      |
92   |      +--timer - UT for libtle_timer (standalone app)
93