opiproject/spdk

Storage Performance Development Kit (SPDK)

https://github.com/opiproject/spdk/actions/workflows/linters.yml/badge.svg](https://github.com/opiproject/spdk/actions/workflows/linters.yml) https://github.com/opiproject/spdk/actions/workflows/docker-publish.yml/badge.svg](https://github.com/opiproject/spdk/actions/workflows/docker-publish.yml)

概述

Storage Performance Development Kit (SPDK)提供一套用于编写高性能、可扩展用户态存储应用的工具和库。它通过将所有必要驱动移至用户空间并以轮询模式运行（而非依赖中断）来实现高性能，从而避免内核上下文切换并消除中断处理开销。本项目包含https://github.com/spdk/spdk的Dockerfile。

核心功能与特性

• 高性能存储开发工具：提供编写高性能存储应用的工具和库，支持用户态存储应用开发。
• 用户态驱动架构：将存储驱动移至用户空间，避免内核态与用户态切换开销。
• 轮询模式运行：采用轮询模式而非中断模式，消除中断处理开销，提升性能。
• 可扩展性：支持构建可扩展的存储应用，适用于高并发存储场景。

使用场景

适用于需要开发高性能、低延迟存储应用的场景，包括但不限于：

• 高性能存储服务开发（如NVMe存储应用）
• 存储性能基准测试工具开发
• 高并发用户态存储解决方案构建
• 存储性能优化研究

安装与使用

Docker方式

1. 拉取镜像
   指定版本（如v22.09）或使用latest获取最新版本：

   sh
   docker pull opiproject/spdk:<version>
   

2. 运行容器
   启动SPDK容器（--rm表示退出后自动删除容器）：

   sh
   docker run --rm opiproject/spdk:<version>
   

Docker Compose方式

使用docker-compose构建并启动服务（需确保存在docker-compose.yml文件）：

sh
docker-compose up --build --force-recreate

测试SPDK RPC代理

参考JSON RPC Proxy文档进行测试，示例命令：

sh
curl -k --user spdkuser:spdkpass -X POST -H "Content-Type: application/json" -d '{"id": 1, "method": "bdev_get_bdevs", "params": {"name": "Malloc0"}}' http://127.0.0.1:9009/

预期返回结果：

json
{"jsonrpc":"2.0","id":1,"result":[{"name":"Malloc0","aliases":["f1c5d95a-b235-40af-9e4d-2c0b3320de80"],"product_name":"Malloc disk","block_size":512,"num_blocks":131072,"uuid":"f1c5d95a-b235-40af-9e4d-2c0b3320de80","assigned_rate_limits":{"rw_ios_per_sec":0,"rw_mbytes_per_sec":0,"r_mbytes_per_sec":0,"w_mbytes_per_sec":0},"claimed":false,"zoned":false,"supported_io_types":{"read":true,"write":true,"unmap":true,"write_zeroes":true,"flush":true,"reset":true,"nvme_admin":false,"nvme_io":false},"driver_specific":{}}]}

贡献指南

本项目欢迎贡献和建议。我们鼓励社区通过提交Issues和Pull Requests（包含实质性内容或修复）参与。文档、测试框架等希望成为社区积极参与的过程。PR可由多人审核，最终由维护者接受。

详见https://github.com/opiproject/opi/blob/main/CONTRIBUTING.md%E5%92%8Chttps://github.com/opiproject/opi/blob/main/doc-github-rules.md%E3%80%82