HSAK高级编程技巧：如何基于ublock API构建自定义存储管理工具

HSAK高级编程技巧：如何基于ublock API构建自定义存储管理工具

【免费下载链接】hsakhsak stands for "Hybrid Storage Acceleration Kit", which is an IO software stack that provides high bandwidth and low latency for new storage media.项目地址: https://gitcode.com/openeuler/hsak

前往项目官网免费下载：https://ar.openeuler.org/ar/

HSAK（Hybrid Storage Acceleration Kit）是一款为新型存储介质提供高带宽、低延迟的IO软件栈。本文将详细介绍如何利用其核心ublock API开发自定义存储管理工具，帮助开发者快速实现存储设备监控、性能分析和错误处理等功能。

一、ublock API核心能力解析

ublock API作为HSAK的核心接口层，提供了完整的存储设备管理能力。通过包含头文件include/ublock.h即可使用这些接口，主要功能模块包括：

1.1 设备初始化与管理

• ublock_init()：启动ublock服务并初始化资源，支持RPC服务开关
• ublock_fini()：释放ublock管理的所有资源
• 设备枚举：通过ublock_get_bdevs()获取系统中所有NVMe设备列表

1.2 存储设备信息查询

• 基本信息：通过ublock_get_bdev()获取设备PCI地址、容量、厂商信息等
• SMART信息：使用ublock_get_SMART_info()获取设备健康状态、温度、寿命等关键指标
• 错误日志：通过ublock_get_error_log_info()查询设备错误记录

二、开发环境准备

2.1 源码获取

git clone https://gitcode.com/openeuler/hsak cd hsak

2.2 编译依赖

确保系统已安装以下依赖：

• CMake 3.10+
• DPDK开发库
• NVMe驱动开发包

2.3 编译示例工具

mkdir build && cd build cmake .. make -j4

编译完成后，可在cli目录下找到各类工具示例，如：

• cli/list/ublock_cli_list.c：设备列表工具
• cli/rw/ublock_cli_rw.c：IO读写测试工具
• cli/iostat_enable/ublock_iostat_enable.c：性能统计开关工具

三、构建自定义存储管理工具的关键步骤

3.1 初始化ublock环境

#include "ublock.h" int main() { // 初始化ublock并启用RPC服务 if (ublock_init("my_storage_tool") != 0) { fprintf(stderr, "Failed to initialize ublock\n"); return -1; } // 工具主体逻辑... // 释放资源 ublock_fini(); return 0; }

3.2 设备发现与信息收集

struct ublock_bdev_mgr bdev_list; TAILQ_INIT(&bdev_list.bdevs); // 获取所有NVMe设备 if (ublock_get_bdevs(&bdev_list) != 0) { fprintf(stderr, "Failed to get NVMe devices\n"); return -1; } // 遍历设备列表 struct ublock_bdev *bdev, *tmp; TAILQ_FOREACH_SAFE(bdev, &bdev_list.bdevs, link, tmp) { printf("Device PCI: %s\n", bdev->pci); printf("Model: %s\n", bdev->info.model_number); printf("Capacity: %lu bytes\n", bdev->info.cap_size); // 释放单个设备资源 ublock_free_bdev(bdev); } // 释放设备列表 ublock_free_bdevs(&bdev_list);

3.3 性能监控实现

通过ublock_ctrl_iostat_info结构体获取实时IO统计数据：

struct ublock_ctrl_iostat_info stats; if (ublock_get_ctrl_iostat(pci_addr, &stats) == 0) { printf("Read ops: %lu\n", stats.num_read_ops); printf("Write ops: %lu\n", stats.num_write_ops); printf("Read latency: %lu ms\n", stats.read_latency_ms); printf("Write latency: %lu ms\n", stats.write_latency_ms); }

3.4 错误处理与日志

struct ublock_nvme_error_info err_info[10]; int count = ublock_get_error_log_info(pci_addr, 10, err_info); if (count > 0) { printf("Found %d error entries:\n", count); for (int i = 0; i < count; i++) { printf("Error %d: LBA=0x%lx, Status=0x%x\n", i, err_info[i].lba, err_info[i].status); } }

四、高级功能扩展

4.1 自定义命令行工具开发

参考cli目录下的示例，通过ublock_cli_common.h提供的通用函数，可快速构建命令行界面：

• 命令参数解析
• 设备选择逻辑
• 格式化输出

4.2 错误注入测试

利用cli/error_inject/ublock_error_inject.c中的接口，实现存储设备错误注入，用于测试容错能力：

// 示例：注入介质错误 ublock_error_inject(pci_addr, ERROR_TYPE_MEDIA, lba_address);

4.3 集成RPC服务

通过初始化时启用RPC服务，可实现远程管理功能，参考src/ublock_rpc.c中的实现。

五、最佳实践与注意事项

1. 资源管理：使用ublock_get_bdev()获取的设备信息必须通过ublock_free_bdev()释放
2. 错误处理：部分API可能返回-EAGAIN，需要实现重试机制
3. 性能考虑：频繁查询SMART信息会影响性能，建议设置合理的查询间隔
4. 线程安全：ublock API不保证线程安全，多线程环境下需加锁保护

六、总结

基于HSAK的ublock API，开发者可以快速构建功能强大的存储管理工具。通过本文介绍的初始化、设备管理、性能监控和错误处理等核心步骤，结合cli目录下的示例代码，能够显著降低开发难度，提升存储系统的管理效率。无论是企业级存储监控解决方案，还是个人开发调试工具，ublock API都提供了灵活而高效的编程接口。

【免费下载链接】hsakhsak stands for "Hybrid Storage Acceleration Kit", which is an IO software stack that provides high bandwidth and low latency for new storage media.项目地址: https://gitcode.com/openeuler/hsak