Klement Sekera da505f608e make test: improve documentation and PEP8 compliance
Change-Id: Ib4f0353aab6112fcc3c3d8f0bcbed5bc4b567b9b
Signed-off-by: Klement Sekera <ksekera@cisco.com>
2017-01-11 23:26:16 +00:00
2017-01-11 12:57:31 +00:00
2017-01-02 13:22:24 +00:00
2017-01-11 19:49:31 +00:00
2016-04-12 19:40:14 -05:00
2016-12-28 15:48:08 +00:00
2016-12-21 19:13:57 +01:00

Vector Packet Processing

Introduction

The VPP platform is an extensible framework that provides out-of-the-box production quality switch/router functionality. It is the open source version of Cisco's Vector Packet Processing (VPP) technology: a high performance, packet-processing stack that can run on commodity CPUs.

The benefits of this implementation of VPP are its high performance, proven technology, its modularity and flexibility, and rich feature set.

For more information on VPP and its features please visit the FD.io website and What is VPP? pages.

Changes

Details of the changes leading up to this version of VPP can be found under @ref release_notes.

Directory layout

Directory name Description
build-data Build metadata
build-root Build output directory
doxygen Documentation generator configuration
dpdk DPDK patches and build infrastructure
@ref plugins Not-yet-relocated VPP bundled plugins directory
@ref src VPP source code
@ref src/plugins VPP bundled plugins directory
@ref src/svm Shared virtual memory allocation library
src/tests Unit tests
src/vat VPP API test program
@ref src/vlib VPP application library
@ref src/vlibapi VPP API library
@ref src/vlibmemory VPP Memory management
@ref src/vlibsocket VPP Socket I/O
@ref src/vnet VPP networking
@ref src/vpp VPP application
@ref src/vpp-api VPP application API bindings
@ref src/vppinfra VPP core library
test Unit tests
@ref vpp-api Not-yet-relocated API bindings

Getting started

In general anyone interested in building, developing or running VPP should consult the VPP wiki for more complete documentation.

In particular, readers are recommended to take a look at [Pulling, Building, Running, Hacking, Pushing](https://wiki.fd.io/view/VPP/Pulling,_Building,_Run ning,_Hacking_and_Pushing_VPP_Code) which provides extensive step-by-step coverage of the topic.

For the impatient, some salient information is distilled below.

Quick-start: On an existing Linux host

To install system dependencies, build VPP and then install it, simply run the build script. This should be performed a non-privileged user with sudo access from the project base directory:

./build-root/vagrant/build.sh

If you want a more fine-grained approach because you intend to do some development work, the Makefile in the root directory of the source tree provides several convenience shortcuts as make targets that may be of interest. To see the available targets run:

make

Quick-start: Vagrant

The directory build-root/vagrant contains a VagrantFile and supporting scripts to bootstrap a working VPP inside a Vagrant-managed Virtual Machine. This VM can then be used to test concepts with VPP or as a development platform to extend VPP. Some obvious caveats apply when using a VM for VPP since its performance will never match that of bare metal; if your work is timing or performance sensitive, consider using bare metal in addition or instead of the VM.

For this to work you will need a working installation of Vagrant. Instructions for this can be found [on the Setting up Vagrant wiki page] (https://wiki.fd.io/view/DEV/Setting_Up_Vagrant).

More information

Several modules provide documentation, see @subpage user_doc for more information.

Visit the VPP wiki for details on more advanced building strategies and development notes.

Description
No description provided
Readme Apache-2.0
Languages
C 78.9%
Python 15%
C++ 3.3%
CMake 0.7%
Go 0.6%
Other 1.4%