xref: /vpp/
NameDateSize

..13-Mar-2018256

.clang-formatH A D13-Mar-20181.1 KiB

.git_commit_template.txtH A D29-May-20191.5 KiB

.gitignoreH A D04-Dec-20191.5 KiB

.gitreviewH A D13-Mar-201850

build/H20-Sep-201822

build-data/H20-Jan-201959

build-root/H26-Nov-2019175

docs/HToday4 KiB

doxygen/H16-Nov-20194 KiB

extras/H20-Nov-20194 KiB

gmod/H13-Mar-201857

INFO.yamlH A D31-Aug-20182.5 KiB

LICENSEH A D13-Mar-201811.1 KiB

MAINTAINERSH A D15-Jan-202012.7 KiB

MakefileH A D04-Jan-202022.1 KiB

README.mdH A D03-Aug-20184.4 KiB

RELEASE.mdH A D15-Jan-2020284.5 KiB

src/H27-Nov-2019243

test/H16-Jan-20208 KiB

README.md

1Vector Packet Processing
2========================
3
4## Introduction
5
6The VPP platform is an extensible framework that provides out-of-the-box
7production quality switch/router functionality. It is the open source version
8of Cisco's Vector Packet Processing (VPP) technology: a high performance,
9packet-processing stack that can run on commodity CPUs.
10
11The benefits of this implementation of VPP are its high performance, proven
12technology, its modularity and flexibility, and rich feature set.
13
14For more information on VPP and its features please visit the
15[FD.io website](http://fd.io/) and
16[What is VPP?](https://wiki.fd.io/view/VPP/What_is_VPP%3F) pages.
17
18
19## Changes
20
21Details of the changes leading up to this version of VPP can be found under
22@ref release_notes.
23
24
25## Directory layout
26
27| Directory name         | Description                                 |
28| ---------------------- | ------------------------------------------- |
29|      build-data        | Build metadata                              |
30|      build-root        | Build output directory                      |
31|      doxygen           | Documentation generator configuration       |
32|      dpdk              | DPDK patches and build infrastructure       |
33| @ref extras/libmemif   | Client library for memif                    |
34| @ref src/examples      | VPP example code                            |
35| @ref src/plugins       | VPP bundled plugins directory               |
36| @ref src/svm           | Shared virtual memory allocation library    |
37|      src/tests         | Standalone tests (not part of test harness) |
38|      src/vat           | VPP API test program                        |
39| @ref src/vlib          | VPP application library                     |
40| @ref src/vlibapi       | VPP API library                             |
41| @ref src/vlibmemory    | VPP Memory management                       |
42| @ref src/vnet          | VPP networking                              |
43| @ref src/vpp           | VPP application                             |
44| @ref src/vpp-api       | VPP application API bindings                |
45| @ref src/vppinfra      | VPP core library                            |
46| @ref src/vpp/api       | Not-yet-relocated API bindings              |
47|      test              | Unit tests and Python test harness          |
48
49## Getting started
50
51In general anyone interested in building, developing or running VPP should
52consult the [VPP wiki](https://wiki.fd.io/view/VPP) for more complete
53documentation.
54
55In particular, readers are recommended to take a look at [Pulling, Building,
56Running, Hacking, Pushing](https://wiki.fd.io/view/VPP/Pulling,_Building,_Run
57ning,_Hacking_and_Pushing_VPP_Code) which provides extensive step-by-step
58coverage of the topic.
59
60For the impatient, some salient information is distilled below.
61
62
63### Quick-start: On an existing Linux host
64
65To install system dependencies, build VPP and then install it, simply run the
66build script. This should be performed a non-privileged user with `sudo`
67access from the project base directory:
68
69    ./extras/vagrant/build.sh
70
71If you want a more fine-grained approach because you intend to do some
72development work, the `Makefile` in the root directory of the source tree
73provides several convenience shortcuts as `make` targets that may be of
74interest. To see the available targets run:
75
76    make
77
78
79### Quick-start: Vagrant
80
81The directory `extras/vagrant` contains a `VagrantFile` and supporting
82scripts to bootstrap a working VPP inside a Vagrant-managed Virtual Machine.
83This VM can then be used to test concepts with VPP or as a development
84platform to extend VPP. Some obvious caveats apply when using a VM for VPP
85since its performance will never match that of bare metal; if your work is
86timing or performance sensitive, consider using bare metal in addition or
87instead of the VM.
88
89For this to work you will need a working installation of Vagrant. Instructions
90for this can be found [on the Setting up Vagrant wiki page]
91(https://wiki.fd.io/view/DEV/Setting_Up_Vagrant).
92
93
94## More information
95
96Several modules provide documentation, see @subpage user_doc for more
97end-user-oriented information. Also see @subpage dev_doc for developer notes.
98
99Visit the [VPP wiki](https://wiki.fd.io/view/VPP) for details on more
100advanced building strategies and other development notes.
101
102
103## Test Framework
104
105There is PyDoc generated documentation available for the VPP test framework.
106See @ref test_framework_doc for details.
107