For Developers

The Developers section covers the following areas:

• Describes how to build different types of VPP images

• Explains how to run VPP with and without GDB, with some GDB examples

• Describes the steps required to get a patch reviewed and merged

• Describes the VPP software architecture and identifies the associated four VPP layers

• Describes the different components that are associated with each VPP layer

• Explains how to Create, Add, Enable/Disable different ARC features

• Discusses different aspects of Bounded-index Extensible Hashing (bihash), and how it is used in database lookups

• Describes the different types of API support and how to integrate a plugin

• Building VPP
  • Set up Proxies
  • Get the VPP Sources
  • Build VPP Dependencies
  • Build VPP (Debug)
  • Build VPP (Release Version)
  • Building Necessary Packages
• Running VPP
  • Running Without GDB
  • Running With GDB
• Testing VPP
  • Examples
  • Detailed Documentation
• GDB Examples
  • Starting GDB
  • Backtrace
  • Get to the GDB prompt
  • Breakpoints
  • Step/Next/List
  • Examining Data and packets
• Adding a plugin
  • Strategic Choices
  • How to create a new plugin
  • Generated Files in Detail
• Add a plugin’s GO API
• Getting a Patch Reviewed
  • Setup
  • Clone with ssh
  • Git Review
• Software Architecture
  • VPP Layers - Implementation Taxonomy
• VPPINFRA (Infrastructure)
  • Vectors
  • Bitmaps
  • Pools
  • Hashes
  • Timekeeping
  • Timer Wheels
  • Format
  • Unformat
  • Vppinfra errors and warnings
  • Serialization
• VLIB (Vector Processing Library)
  • Init function discovery
  • Node Graph Initialization
  • Graph node dispatcher
  • Graph dispatcher internals
  • Vector Data Structure
  • Scheduling Vectors
  • Complications
  • Next frames, next frame ownership
  • dispatch_pending_node actions
  • Process / thread model
  • Process events
  • Buffers
  • Shared-memory message API
  • Debug CLI
  • Handing off buffers between threads
  • Handoff Demo Plugin
• Packet generator input script
• Start vpp with 2 worker threads
• Enable tracing, and start the packet generator
• Sample Run
• Plugins
• VNET (VPP Network Stack)
  • Effective graph dispatch function coding
  • Single/dual loops
  • Creating Packets from Scratch
  • Packet tracer
  • Graph Dispatcher Pcap Tracing
  • pcap rx, tx, and drop tracing
  • packet trace capture filtering
  • VPP Packet Generator
  • PG setup scripts
  • Debug CLI
• Feature Arcs
  • Adding a feature to an existing feature arc
  • Creating a feature arc
  • Enabling / Disabling features
  • Related “show” commands
  • Table of Feature Arcs
• Buffer Metadata
  • Vlib (Vector library) primary buffer metadata
  • Vnet (network stack) primary buffer metadata
  • Vnet (network stack) secondary buffer metadata
• Buffer Metadata Extensions
• Multi-architecture support
  • Multi-Architecture Graph Node Cookbook
  • Multi-Architecture Arbitrary Function Cookbook
• Bounded-index Extensible Hashing (bihash)
  • Discussion of the algorithm
  • Bihash Cookbook
• VPP API module
  • Overview
  • Common code
  • Generated code
  • Code generator
  • C Usage
  • C++ high level API
  • C++ Usage
• Binary API Support
  • Message Allocation
  • Message Tracing and Replay
  • API trace replay caveats
  • API trace interface issues
  • Client connection details
  • Client disconnection details
  • Sending binary API messages to VPP
  • Receiving binary API messages from VPP
• Build System
  • Introduction to the top-level Makefile
  • Introduction to cmake and ninja
  • Introduction to build-root/Makefile
• Event-logger
• G2 graphical event viewer
  • Building G2
  • Setting the Display Preferences
  • Screen Taxonomy
  • Mouse Gestures
  • Time Ruler
  • Event Selection
  • Snapshot Ring
  • Chasing Events
  • Burying Boring Tracks
  • Summary Mode
  • Hotkeys
• FIB 2.0 Hierarchical, Protocol, Independent
  • Prerequisites
  • The Data Model
  • Tunnels
  • MPLS FIB
  • IP Multicast FIB
  • Debugging
  • Fast Convergence
  • Scale
  • Barnacles
  • Get Hacking
  • Missing Functionality
• How to build a vpp dispatch trace aware Wireshark
  • Download wireshark source code
  • Install prerequisite packages
  • Compile Wireshark
  • Make a pcap dispatch trace
  • Display in Wireshark
• Punting Packets
  • Overview
  • The Punt Infrastructure
  • Punting to the Control Plane
• QUIC HostStack
  • Getting started
  • Internal Mechanics
• Cross compilation on MacOS
  • Installing clang-format 10.0.0
• Cloud NAT
  • Overview
  • Terminology & Usage
  • Extending the NAT
  • Known limitations
• IP Security
  • Route Base VPNs
  • Policy Based VPNs
• VPP API Language {#api_lang_doc}
  • Language definition
  • Types
  • Language generators