DPDK 中文編程指南

https://dpdk-docs.readthedocs.io/en/latest/linux_gsg/index.html

 

https://dpdk-docs.readthedocs.io/en/latest/prog_guide/index.html

 

編程指南

• 1. 簡介
  • 1.1. 文檔地圖
  • 1.2. 相關刊物
• 2. 概述
  • 2.1. 開發環境
  • 2.2. 環境適配層EAL
  • 2.3. 核心組件
    • 2.3.1. 環形緩衝區管理(librte_ring)
    • 2.3.2. 內存池管理(librte_mempool)
    • 2.3.3. 網絡報文緩衝區管理(librte_mbuf)
    • 2.3.4. 定時器管理(librte_timer)
  • 2.4. 以太網輪詢驅動架構
  • 2.5. 報文轉發算法支持
  • 2.6. 網絡協議庫(librte_net)
• 3. 環境適配層EAL
  • 3.1. Linux環境下的EAL
    • 3.1.1. 初始化和運行
    • 3.1.2. 多進程支持
    • 3.1.3. 內存映射和內存分配
    • 3.1.4. Xen Dom0非大頁運行支持
    • 3.1.5. PCI 訪問
    • 3.1.6. 邏輯核及共享變量
    • 3.1.7. 日誌
    • 3.1.8. CPU 特性識別
    • 3.1.9. 用戶空間中斷事件
    • 3.1.10. 黑名單
    • 3.1.11. Misc功能
  • 3.2. 內存段和內存區間
  • 3.3. 多線程
    • 3.3.1. EAL pthread and lcore Affinity
    • 3.3.2. 非EAL的線程支持
    • 3.3.3. 公共線程API
    • 3.3.4. 已知問題
    • 3.3.5. cgroup控制
  • 3.4. 內存申請
    • 3.4.1. Cookies
    • 3.4.2. 對齊和NUMA約束
    • 3.4.3. 用例
    • 3.4.4. 內部實現
• 4. Ring 庫
  • 4.1. FreeBSD* 中 Ring 的實現參考
  • 4.2. Linux* 中的無鎖環形緩衝區
  • 4.3. 附加功能
    • 4.3.1. Name
  • 4.4. 使用場景
  • 4.5. Ring Buffer解析
    • 4.5.1. 單生產者入隊
    • 4.5.2. 單消費者出隊
    • 4.5.3. 多生產者入隊
    • 4.5.4. 32-bit取模索引
  • 4.6. 參考文檔
• 5. Mempool 庫
  • 5.1. Cookies
  • 5.2. Stats
  • 5.3. 內存對齊約束
  • 5.4. 本地緩存
  • 5.5. Mempool 句柄
  • 5.6. 用例
• 6. Mbuf 庫
  • 6.1. Packet Buffer 設計
  • 6.2. 存儲在Mempool中的Buffer
  • 6.3. 構造函數
  • 6.4. 申請及釋放 mbufs
  • 6.5. 操作 mbufs
  • 6.6. 元數據信息
  • 6.7. 直接及間接 Buffers
  • 6.8. 調試
  • 6.9. 用例
• 7. 輪詢模式驅動
  • 7.1. 要求及假設條件
  • 7.2. 設計原則
  • 7.3. 邏輯核、內存及網卡隊列的聯繫
  • 7.4. 設備標識及配置
    • 7.4.1. 設備標識
    • 7.4.2. 設備配置
    • 7.4.3. 即時配置
    • 7.4.4. 傳輸隊列配置
    • 7.4.5. 釋放 Tx 緩存
    • 7.4.6. 硬件卸載
  • 7.5. PMD API
    • 7.5.1. 概要
    • 7.5.2. 通用報文表示
    • 7.5.3. 以太網設備 API
    • 7.5.4. 擴展的統計 API
• 8. 通用流 API (rte_flow)
  • 8.1. 概述
  • 8.2. 流規則
    • 8.2.1. 描述
    • 8.2.2. 屬性
    • 8.2.3. 模式條目
    • 8.2.4. 匹配模式
    • 8.2.5. Meta item types
    • 8.2.6. Data matching item types
    • 8.2.7. Actions
    • 8.2.8. Action types
    • 8.2.9. Negative types
    • 8.2.10. Planned types
  • 8.3. Rules management
    • 8.3.1. Validation
    • 8.3.2. Creation
    • 8.3.3. Destruction
    • 8.3.4. Flush
    • 8.3.5. Query
  • 8.4. Verbose error reporting
  • 8.5. Caveats
  • 8.6. PMD interface
  • 8.7. Device compatibility
    • 8.7.1. Global bit-masks
    • 8.7.2. Unsupported layer types
    • 8.7.3. ANY pattern item
    • 8.7.4. Unsupported actions
    • 8.7.5. Flow rules priority
  • 8.8. Future evolutions
  • 8.9. API migration
    • 8.9.1. MACVLAN to ETH → VF, PF
    • 8.9.2. ETHERTYPE to ETH → QUEUE, DROP
    • 8.9.3. FLEXIBLE to RAW → QUEUE
    • 8.9.4. SYN to TCP → QUEUE
    • 8.9.5. NTUPLE to IPV4, TCP, UDP → QUEUE
    • 8.9.6. TUNNEL to ETH, IPV4, IPV6, VXLAN (or other) → QUEUE
    • 8.9.7. FDIR to most item types → QUEUE, DROP, PASSTHRU
    • 8.9.8. HASH
    • 8.9.9. L2_TUNNEL to VOID → VXLAN (or others)
• 9. Cryptography Device Library
  • 9.1. Design Principles
  • 9.2. Device Management
    • 9.2.1. Device Creation
    • 9.2.2. Device Identification
    • 9.2.3. Device Configuration
    • 9.2.4. Configuration of Queue Pairs
    • 9.2.5. Logical Cores, Memory and Queues Pair Relationships
  • 9.3. Device Features and Capabilities
    • 9.3.1. Device Features
    • 9.3.2. Device Operation Capabilities
    • 9.3.3. Capabilities Discovery
  • 9.4. Operation Processing
    • 9.4.1. Enqueue / Dequeue Burst APIs
    • 9.4.2. Operation Representation
    • 9.4.3. Operation Management and Allocation
  • 9.5. Symmetric Cryptography Support
    • 9.5.1. Session and Session Management
    • 9.5.2. Transforms and Transform Chaining
    • 9.5.3. Symmetric Operations
  • 9.6. Asymmetric Cryptography
    • 9.6.1. Crypto Device API
• 10. 鏈路綁定PMD
  • 10.1. 鏈路綁定模式概述
  • 10.2. 實現細節
    • 10.2.1. 鏈路狀態改變中斷與輪詢
    • 10.2.2. 要求與限制
    • 10.2.3. 配置
  • 10.3. 使用鏈路綁定設備
    • 10.3.1. 程序中使用輪詢模式驅動
    • 10.3.2. 在EAL命令行中使用鏈路綁定設備
• 11. 定時器庫
  • 11.1. 實現細節
  • 11.2. 用例
  • 11.3. 參考
• 12. 哈希庫
  • 12.1. 哈希API概述
  • 12.2. 多進程支持
  • 12.3. 實現細節
  • 12.4. 哈希表中的條目分發
  • 12.5. 用例：流分類
  • 12.6. 參考
• 13. Elastic Flow Distributor Library
  • 13.1. Introduction
  • 13.2. Flow Based Distribution
    • 13.2.1. Computation Based Schemes
    • 13.2.2. Flow-Table Based Schemes
    • 13.2.3. EFD Based Scheme
  • 13.3. Example of EFD Library Usage
  • 13.4. Library API Overview
    • 13.4.1. EFD Table Create
    • 13.4.2. EFD Insert and Update
    • 13.4.3. EFD Lookup
    • 13.4.4. EFD Delete
  • 13.5. Library Internals
    • 13.5.1. Insert Function Internals
    • 13.5.2. Lookup Function Internals
    • 13.5.3. Group Rebalancing Function Internals
  • 13.6. References
• 14. LPM庫
  • 14.1. LPM API概述
  • 14.2. 實現細節
    • 14.2.1. 添加
    • 14.2.2. 查詢
    • 14.2.3. 規則數目的限制
    • 14.2.4. 用例：IPv4轉發
    • 14.2.5. References
• 15. LPM6庫
  • 15.1. LPM6 API概述
    • 15.1.1. 實現細節
    • 15.1.2. 添加
    • 15.1.3. 查詢
    • 15.1.4. 規則數目限制
  • 15.2. 用例：IPv6轉發
• 16. 報文分發庫
  • 16.1. 分發邏輯核操作
  • 16.2. Worker Operation
• 17. 排序器庫
  • 17.1. 操作
  • 17.2. 實現細節
  • 17.3. 用例：報文分發
• 18. IP分片及重組庫
  • 18.1. 報文分片
  • 18.2. 報文重組
    • 18.2.1. IP分片表
    • 18.2.2. 報文重組
    • 18.2.3. 調試日誌及統計收集
• 19. Librte_pdump庫
  • 19.1. 操作
  • 19.2. 實現細節
  • 19.3. 用例:抓包
• 20. 多進程支持
  • 20.1. 內存共享
  • 20.2. 部署模式
    • 20.2.1. 對稱/對等進程
    • 20.2.2. 非對稱/非對等進程
    • 20.2.3. 運行多個獨立的DPDK應用程序
    • 20.2.4. 運行多個獨立的DPDK應用程序組
  • 20.3. 多進程限制
• 21. 內核網絡接口卡接口
  • 21.1. DPDK KNI內核模塊
  • 21.2. KNI創建及刪除
  • 21.3. DPDK緩衝區流
  • 21.4. 用例: Ingress
  • 21.5. 用例: Egress
  • 21.6. 以太網工具
  • 21.7. 鏈路狀態及MTU改變
• 22. DPDK功能的線程安全
  • 22.1. 快速路徑API
  • 22.2. 非性能敏感API
  • 22.3. 庫初始化
  • 22.4. 中斷線程
• 23. QoS框架
  • 23.1. 支持QoS的數據包水線
  • 23.2. 分層調度
    • 23.2.1. 概述
    • 23.2.2. 調度層次
    • 23.2.3. 編程接口
    • 23.2.4. 實現
    • 23.2.5. Worst Case Scenarios for Performance
  • 23.3. Dropper
    • 23.3.1. Configuration
    • 23.3.2. Enqueue Operation
    • 23.3.3. Queue Empty Operation
    • 23.3.4. Source Files Location
    • 23.3.5. Integration with the DPDK QoS Scheduler
    • 23.3.6. Integration with the DPDK QoS Scheduler Sample Application
    • 23.3.7. Application Programming Interface (API)
  • 23.4. Traffic Metering
    • 23.4.1. Functional Overview
    • 23.4.2. Implementation Overview
• 24. 電源管理
  • 24.1. CPU頻率縮放
  • 24.2. 通過C-States調節Core負載
  • 24.3. 電源管理庫API概述
  • 24.4. 示例
  • 24.5. 參考
• 25. 報文分類及訪問控制
  • 25.1. 概述
    • 25.1.1. 規則定義
    • 25.1.2. RT 內存大小限制
    • 25.1.3. Classification 方法
  • 25.2. API用法
    • 25.2.1. 多類別報文分類
• 26. 報文框架
  • 26.1. 設計目標
  • 26.2. 概述
  • 26.3. 端口庫設計
    • 26.3.1. 端口類型
    • 26.3.2. 端口操作
  • 26.4. 表庫設計
    • 26.4.1. 表類型
    • 26.4.2. 表操作接口
    • 26.4.3. 哈希表設計
  • 26.5. 流水線庫設計
    • 26.5.1. 端口和表的連接
    • 26.5.2. 端口動作
    • 26.5.3. 表動作
  • 26.6. 多核處理
    • 26.6.1. 共享的數據結構
  • 26.7. 加速器
• 27. Vhost 庫
  • 27.1. Vhost API 概述
  • 27.2. Vhost-user 實現
  • 27.3. 支持Vhost的vSwitch
• 28. Metrics 庫
  • 28.1. 初始化庫
  • 28.2. 註冊metrics
  • 28.3. 更新 metric 值
  • 28.4. 查詢 metrics
  • 28.5. Bit-rate 統計庫
    • 28.5.1. 初始化
    • 28.5.2. 控制採樣速率
  • 28.6. 延遲統計庫
    • 28.6.1. 初始化
    • 28.6.2. 觸發統計值更新
    • 28.6.3. 關閉庫
• 29. 端口熱插拔框架
  • 29.1. 概述
  • 29.2. 端口熱插拔API概述
  • 29.3. 引用
  • 29.4. 限制
• 30. 源碼組織
  • 30.1. Makefiles 和 Config
  • 30.2. 庫
  • 30.3. 驅動
  • 30.4. 應用程序
• 31. 開發套件構建系統
  • 31.1. 編譯DPDK二進制文件
    • 31.1.1. 建立目錄概念
  • 31.2. 構建外部應用程序
  • 31.3. Makefile 描述
    • 31.3.1. DPDK Makefiles 的通用規則
    • 31.3.2. Makefile 類型
    • 31.3.3. 內部生成的構建工具
    • 31.3.4. 構建系統提供的有用變量
    • 31.3.5. 只能在Makefile中設置/覆蓋的變量
    • 31.3.6. 只能在命令行上由用戶設置/覆蓋的變量
    • 31.3.7. 可以在Makefile或命令行中由用戶設置/覆蓋的變量
• 32. DPDK 根目錄 Makefile 理解
  • 32.1. 配置 Targets
  • 32.2. 構建 Targets
  • 32.3. 安裝 Targets
  • 32.4. 測試 Targets
  • 32.5. 文檔 Targets
  • 32.6. 其他 Targets
  • 32.7. 其他有用的命令行變量
  • 32.8. 在需要構建的目錄中執行Make
  • 32.9. 編譯爲調試 Target
• 33. 擴展 DPDK
  • 33.1. 示例：添加新的庫 libfoo
    • 33.1.1. 示例：在測試用例中使用新庫 libfoo
• 34. 構建你自己的應用程序
  • 34.1. 在DPDK中編譯一個示例程序
  • 34.2. 在DPDK外構建自己的應用程序
  • 34.3. 定製 Makefiles
    • 34.3.1. 應用程序 Makefile
    • 34.3.2. 庫 Makefile
    • 34.3.3. 定製 Makefile 動作
• 35. 外部應用程序/庫的 Makefile
  • 35.1. 前提
  • 35.2. 構建 Targets
  • 35.3. Help Targets
  • 35.4. 其他有用的命令行變量
  • 35.5. 從其他目錄中編譯
• 36. 性能優化指南
  • 36.1. 介紹
• 37. 編寫高效代碼
  • 37.1. 內存
    • 37.1.1. 內存拷貝：不要在數據面程序中使用libc
    • 37.1.2. 內存申請
    • 37.1.3. 內存區域的併發訪問
    • 37.1.4. NUMA
    • 37.1.5. 跨存儲器通道分配
  • 37.2. lcore之間的通信
  • 37.3. PMD 驅動
    • 37.3.1. 低報文延遲
  • 37.4. 鎖和原子操作
  • 37.5. 編碼考慮
    • 37.5.1. 內聯函數
    • 37.5.2. 分支預測
  • 37.6. 設置目標CPU類型
• 38. 配置你的應用程序
  • 38.1. X86
  • 38.2. ARM64
    • 38.2.1. 使用 Linux perf
    • 38.2.2. 高分辨率的cycle計數器
• 39. 術語