README.md

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