README revision 3688f046
1OVERVIEW
2========
3
4TLDK project scope is:
51) 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   suppose 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  Implementation of ARP, IP etc. layers and their related routing tables
20  are out of scope of these libraries. Similarly, the setup, management and
21  actual IO on underlying NIC devices are out of scope too.
22
23   The libraries only need to know about underlying devices plus what
24   HW offloads are supported, underlying device MTU and L3/L2 addresses to
25   fill into L3/L2 headers for the outgoing packets.
26
27   These libraries should be developed in such manner, they could be used
28   independently from implementations of 2) and 3).
29
302) Create VPP graph nodes, plugins etc using those libraries to implement
31   a host stack.
32
333) Create such mechanisms (netlink agents, packaging, etc) necessary to make
34   the resulting host stack easily usable by existing non-vpp aware software.
35
36INSTALLATION GUIDE
37=================
38
391. Obtain latest DPDK.
40   (refer to http://dpdk.org for information how to download and build it).
412. Make sure that RTE_SDK and RTE_TARGET DPDK related environment variables
42   are setup correctly.
433. Go to the TLDK root directory and type: 'make all'.
444. Run sample applications.
45
46As an example:
47export RTE_SDK=/opt/DPDK
48export RTE_TARGET=x86_64-native-linuxapp-gcc
49cd tldk
50make all
51./x86_64-native-linuxapp-gcc/app/udpfwd ...
52
53CONTENTS
54========
55
56$(TLDK_ROOT)
57|
58+----lib
59|      |
60|      +--libtle_dring - dring library
61|      |
62|      +--libtle_udp - implementation of the UDP datagram processing
63|
64+----examples
65|      |
66|      +--udpfwd - sample app to demonstrate and test libtle_udp usage
67|            (refer to examples/udpfwd/README for more information)
68+----test - unit-tests
69|      |
70|      +--dring - UT for libtle_dring
71