DPDK官方文档列表
DPDK提供了不同的支持文档供读者使用。下文提到的文档均是目前官方网站 http://dpdk.org/doc 提到的最新版本文档(当前时间2018年4月,版本18.02)。以下按网页版的文档 http://dpdk.org/doc/guides/ 中目录的顺序,对应下载的pdf文档,简要说明其内容,方便我们按需查找相应的文档。
1. 快速开始指南(getting started guide)
用于描述在不同的操作系统(freebsd和linux)上安装、配置DPDK软件;帮助用户启动和快速运行软件。
见 linux_gsg-18.02.pdf和freebsd_gsg-18.02.pdf。
2.示例应用程序用户指南(sample applications user guides)
见sample_app_ug-18.02.pdf
3. 编程指南(programmer's guide)
包括DPDK软件架构以及在linux环境下的使用方法;编译系统、移植说明及优化方法。
见prog_guide-18.02.pdf
4. howto指南(howto guides)
见howto-18.02.pdf。先列一列(因为现在有些术语还没看。fix me):
- Live Migration of VM with SR-IOV VF
- Live Migration of VM with Virtio on host running vhost_user
- Flow Bifurcation How-to Guide
- 通用流量API - 例子
- PVP reference benchmark setup using testpmd
- VF daemon (VFd)
- Virtio_user for Container Networking
- Virtio_user as Exceptional Path
- DPDK pdump库和pdump工具
5. DPDK工具用户指南(DPDK tools user guides)
一些DPDK官方给的工具和test vector files的原理,见tools-18.02.pdf。
先列出来工具:
- dpdk-proinfo
- dpdk-pdump
- dpdk-pmdinfo
- dpdk-devbind
- dpdk-test-bbdev
- dpdk-test-crypto-perf
- dpdk-test-eventdev
6.testpmd示例应用程序用户指南(testpmd application user guides)
见testpmd_app_ug-18.02.pdf。(先知道 testpmd测试dpdk的一个玩意 fix me)
7. 网络接口控制器驱动程序(network interface controller drivers)
见nics-18.02.pdf。
8. 基带设备驱动程序(baseband device drivers)
见bbdevs-18.02.pdf。
9.加密设备驱动程序(crypto device drivers)
见cryptodevs-18.02.pdf。
10.事件设备驱动程序(event device drivers)
见eventdevs-18.02.pdf。
11. 内存池设备驱动程序(mempool device drivers)
见mempool-18.02.pdf。
12.特定平台的指南(platform specific guides)
目前只有octeontx board的支持包有关信息。见platform-18.02.pdf
13.投稿指南(contributor's guidelines)
主要面向dpdk投稿者(贡献者contributor)包括DPDK的C编码风格、特定开发环境在C代码中的设计、ABI更新升级、文档撰写、dpdk发布和稳定版有关的信息。见contributing-18.02.pdf。
14. 发布说明(release notes)
提供具体的发布信息,版本历史,包括支持特性、限制、问题改进、问题报告等。见rel_notes-18.02.pdf。
15. FAQ
常见问题解答。见faq-18.02.pdf。