FDio/VPP项目插件开发指南：从零开始构建自定义插件

FDio/VPP项目插件开发指南：从零开始构建自定义插件

【免费下载链接】vpp 项目地址: https://gitcode.com/gh_mirrors/vp/vpp

引言

在FDio/VPP（Vector Packet Processing）项目中，插件机制是扩展系统功能的核心方式。本文将深入讲解如何在VPP框架中开发自定义插件，涵盖从创建到集成的完整流程，帮助开发者快速掌握VPP插件开发的核心技术。

插件开发策略选择

在开始开发前，需要根据插件的用途做出关键策略选择：

1. 默认启用策略：对于核心功能插件，通常默认启用
2. 默认禁用策略：适用于以下场景：
   • 实验性功能
   • 测试专用功能
   • 使用频率较低的功能

默认禁用配置示例：

/* *INDENT-OFF* */
VLIB_PLUGIN_REGISTER () = {
  .version = VPP_BUILD_VER,
  .description = "示例插件默认禁用",
  .default_disabled = 1,
};
/* *INDENT-ON* */

资源初始化最佳实践

VPP插件开发中，资源初始化需要特别注意：

错误做法：

static clib_error_t * sample_init (vlib_main_t * vm) {
  /* 错误示例：在初始化函数中直接创建资源 */
  BV(clib_bihash_init (h, ...))
}
VLIB_INIT_FUNCTION (sample_init);

推荐做法：

static void feature_init (my_main_t * mm) {
  if (mm->feature_initialized == 0) {
    BV(clib_bihash_init)(mm->hash_table, ...)
    /* 创建其他资源，如周期性进程 */
    mm->feature_initialized = 1;
  }
}

应在API消息处理程序或调试CLI中调用feature_init，确保资源按需创建。

插件创建完整流程

1. 生成插件骨架

使用VPP提供的插件生成工具创建基础代码结构：

cd ./src/plugins
../../extras/emacs/make-plugin.sh

生成过程中需要提供：

• 插件名称（影响文件名、类型名等）
• 调度类型（dual或qs）

2. 调度类型选择

类型	特点	适用场景
dual	传统双单循环对，支持推测性入队	负载密集型节点
qs	四单循环对，利用SIMD向量运算	高性能数据面处理

3. 生成的文件结构

生成的插件包含以下关键文件：

CMakeLists.txt    # 构建配置文件
myplugin.api      # API定义文件
myplugin.c        # 主插件文件
myplugin.h        # 头文件
myplugin_test.c   # 测试代码
node.c            # 数据面节点实现
setup.pg          # 插件设置

4. 构建与验证

完成插件创建后，执行完整重建：

make rebuild

验证插件是否成功加载：

make run

检查输出中是否包含插件加载信息。

核心文件详解

CMakeLists.txt

构建系统的核心配置文件，主要包含：

add_vpp_plugin (myplugin
  SOURCES
    myplugin.c node.c myplugin_periodic.c
  MULTIARCH_SOURCES
    node.c
  API_FILES
    myplugin.api
  API_TEST_SOURCES
    myplugin_test.c
)

myplugin.h

插件的主头文件，主要包含：

• 插件主数据结构定义
• 公共函数声明
• 类型定义

重要原则：避免使用全局变量，使用main_t结构体封装插件数据。

myplugin.c

插件的主实现文件，核心功能包括：

1. 插件注册

VLIB_PLUGIN_REGISTER () = {
  .version = VPP_BUILD_VER,
  .description = "插件描述",
};

2. 特性初始化

VNET_FEATURE_INIT (myplugin, static) = {
  .arc_name = "device-input",
  .node_name = "myplugin",
  .runs_before = VNET_FEATURES ("ethernet-input"),
};

3. API消息处理框架

node.c

数据面节点处理核心，包含：

• 数据包处理循环
• 节点调度逻辑
• 性能关键路径代码

开发时应保留生成的框架结构，替换具体处理逻辑。

myplugin.api

API定义文件示例：

autoreply define myplugin_enable_disable
{
  u32 client_index;
  u32 context;
  u8 enable_disable;
  u32 sw_if_index;
};

myplugin_test.c

提供API测试能力，可用于：

• 单元测试
• 集成测试
• 通过vpp_api_test进行验证

高级开发技巧

插件间协作

1. 调用其他插件的初始化函数：

vlib_call_plugin_init_function (vm, "otherplugin", init_func);

2. 获取其他插件的符号：

void *p = vlib_get_plugin_symbol ("plugin_name", "symbol");

多线程注意事项

VPP进程不是线程安全的，共享数据结构时：

• 使用锁机制保护
• 避免跨进程直接访问
• 使用消息队列进行通信

性能优化建议

1. 关键路径代码放在MULTIARCH_SOURCES中
2. 利用向量化指令优化数据处理
3. 避免在数据面进行内存分配
4. 使用预分配资源池

总结

VPP插件开发需要遵循框架规范，同时兼顾性能与可维护性。通过本文的指导，开发者可以快速构建符合VPP标准的插件，并充分利用VPP提供的高性能网络处理能力。实际开发中，建议参考VPP源码中的插件实现，不断优化和完善自己的插件功能。

【免费下载链接】vpp 项目地址: https://gitcode.com/gh_mirrors/vp/vpp