Programmer's Guide Prog Master

User Manual:

Open the PDF directly: View PDF .
Page Count: 407 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Scroll down to view the document on your mobile browser.

Introduction
- Documentation Roadmap
- Related Publications
Overview
- Development Environment
- Environment Abstraction Layer
- Core Components
- Ethernet* Poll Mode Driver Architecture
- Packet Forwarding Algorithm Support
- librte_net
Environment Abstraction Layer
- EAL in a Linux-userland Execution Environment
- Memory Segments and Memory Zones (memzone)
- Multiple pthread
- Malloc
Service Cores
- Service Core Initialization
- Enabling Services on Cores
- Service Core Statistics
Ring Library
- References for Ring Implementation in FreeBSD*
- Lockless Ring Buffer in Linux*
- Additional Features
- Use Cases
- Anatomy of a Ring Buffer
- References
Mempool Library
- Cookies
- Stats
- Memory Alignment Constraints
- Local Cache
- Mempool Handlers
- Use Cases
Mbuf Library
- Design of Packet Buffers
- Buffers Stored in Memory Pools
- Constructors
- Allocating and Freeing mbufs
- Manipulating mbufs
- Meta Information
- Direct and Indirect Buffers
- Debug
- Use Cases
Poll Mode Driver
- Requirements and Assumptions
- Design Principles
- Logical Cores, Memory and NIC Queues Relationships
- Device Identification, Ownership and Configuration
- Poll Mode Driver API
Generic flow API (rte_flow)
- Overview
- Flow rule
- Rules management
- Isolated mode
- Verbose error reporting
- Helpers
- Caveats
- PMD interface
- Device compatibility
- Future evolutions
Switch Representation within DPDK Applications
- Introduction
- Port Representors
- Basic SR-IOV
- Controlled SR-IOV
- Flow API (rte_flow)
- Switching Examples
Traffic Metering and Policing API
- Overview
- Configuration steps
- Run-time processing
Traffic Management API
- Overview
- Capability API
- Scheduling Algorithms
- Traffic Shaping
- Congestion Management
- Packet Marking
- Steps to Setup the Hierarchy
Wireless Baseband Device Library
- Design Principles
- Device Management
- Device Operation Capabilities
- Operation Processing
- Sample code
Cryptography Device Library
- Design Principles
- Device Management
- Device Features and Capabilities
- Operation Processing
- Symmetric Cryptography Support
- Sample code
- Asymmetric Cryptography
- Asymmetric crypto Sample code
Compression Device Library
- Device Management
- Device Features and Capabilities
- Compression Operation
- Transforms
- Compression API Hash support
- Compression API Stateless operation
- Compression API Stateful operation
- Burst in compression API
- Sample code
Security Library
- Design Principles
- Device Features and Capabilities
Rawdevice Library
- Introduction
- Design
Link Bonding Poll Mode Driver Library
- Link Bonding Modes Overview
- Implementation Details
- Using Link Bonding Devices
Timer Library
- Implementation Details
- Use Cases
- References
Hash Library
- Hash API Overview
- Multi-process support
- Multi-thread support
- Extendable Bucket Functionality support
- Implementation Details (non Extendable Bucket Case)
- Implementation Details (with Extendable Bucket)
- Entry distribution in hash table
- Use Case: Flow Classification
- References
Elastic Flow Distributor Library
- Introduction
- Flow Based Distribution
- Example of EFD Library Usage
- Library API Overview
- Library Internals
- References
Membership Library
- Introduction
- Vector of Bloom Filters
- Hash-Table based Set-Summaries
- Library API Overview
- References
LPM Library
- LPM API Overview
- Implementation Details
LPM6 Library
- LPM6 API Overview
- Use Case: IPv6 Forwarding
Flow Classification Library
- Overview
Packet Distributor Library
- Distributor Core Operation
- Worker Operation
Reorder Library
- Operation
- Implementation Details
- Use Case: Packet Distributor
IP Fragmentation and Reassembly Library
- Packet fragmentation
- Packet reassembly
Generic Receive Offload Library
- Overview
- Two Sets of API
- Reassembly Algorithm
- TCP/IPv4 GRO
- VxLAN GRO
Generic Segmentation Offload Library
- Overview
- Limitations
- Packet Segmentation
- Supported GSO Packet Types
- How to Segment a Packet
The librte_pdump Library
- Operation
- Implementation Details
- Use Case: Packet Capturing
Multi-process Support
- Memory Sharing
- Deployment Models
- Multi-process Limitations
- Communication between multiple processes
Kernel NIC Interface
- The DPDK KNI Kernel Module
- KNI Creation and Deletion
- DPDK mbuf Flow
- Use Case: Ingress
- Use Case: Egress
- Ethtool
Thread Safety of DPDK Functions
- Fast-Path APIs
- Performance Insensitive API
- Library Initialization
- Interrupt Thread
Event Device Library
- Event struct
- API Walk-through
- Summary
Event Ethernet Rx Adapter Library
- API Walk-through
Event Ethernet Tx Adapter Library
- API Walk-through
Event Timer Adapter Library
- Event Timer struct
- API Overview
- Processing Timer Expiry Events
- Summary
Event Crypto Adapter Library
- Adapter Mode
- API Overview
Quality of Service (QoS) Framework
- Packet Pipeline with QoS Support
- Hierarchical Scheduler
- Dropper
- Traffic Metering
Power Management
- CPU Frequency Scaling
- Core-load Throttling through C-States
- Per-core Turbo Boost
- Use of Power Library in a Hyper-Threaded Environment
- API Overview of the Power Library
- User Cases
- Empty Poll API
- User Cases
- References
Packet Classification and Access Control
- Overview
- Application Programming Interface (API) Usage
Packet Framework
- Design Objectives
- Overview
- Port Library Design
- Table Library Design
- Pipeline Library Design
- Multicore Scaling
- Interfacing with Accelerators
Vhost Library
- Vhost API Overview
- Vhost-user Implementations
- Guest memory requirement
- Vhost supported vSwitch reference
- Vhost data path acceleration (vDPA)
Metrics Library
- Initialising the library
- Registering metrics
- Updating metric values
- Querying metrics
- Bit-rate statistics library
- Latency statistics library
Berkeley Packet Filter Library
- Not currently supported eBPF features
Source Organization
- Makefiles and Config
- Libraries
- Drivers
- Applications
Development Kit Build System
- Building the Development Kit Binary
- Building External Applications
- Makefile Description
Development Kit Root Makefile Help
- Configuration Targets
- Build Targets
- Install Targets
- Test Targets
- Documentation Targets
- Misc Targets
- Other Useful Command-line Variables
- Make in a Build Directory
- Compiling for Debug
Extending the DPDK
- Example: Adding a New Library libfoo
Building Your Own Application
- Compiling a Sample Application in the Development Kit Directory
- Build Your Own Application Outside the Development Kit
- Customizing Makefiles
External Application/Library Makefile help
- Prerequisites
- Build Targets
- Help Targets
- Other Useful Command-line Variables
- Make from Another Directory
Performance Optimization Guidelines
- Introduction
Writing Efficient Code
- Memory
- Communication Between lcores
- PMD Driver
- Locks and Atomic Operations
- Coding Considerations
- Setting the Target CPU Type
Profile Your Application
- Profiling on x86
- Profiling on ARM64
Glossary

Navigation menu