文件最后提交记录最后更新时间
4 个月前
6 个月前
3 个月前
3 个月前
README

Accessor 访问器驱动测试

概述

本目录包含 Accessor(访问器)驱动的单元测试套件。Accessor 是一个用于访问芯片数据的访问器驱动,通过 Chip 接口(BlockIO 或 BitIO)读取和写入芯片寄存器数据,提供统一的访问接口和属性封装。测试覆盖了基本功能、Value 属性读写、BlockIO/BitIO 操作、异常处理、并发访问、ABI 接口等功能。

目录结构

accessor/
├── meson.build          # 构建配置文件
├── test_accessor.cpp    # 驱动单元测试
└── test_accessor_abi.cpp # 驱动ABI接口测试

测试文件说明

test_accessor.cpp

包含 Accessor 驱动的单元测试,共26个测试用例:

测试基类

  • AccessorTest: 测试基类,继承自 mc::test::TestWithEngine

    • 在 SetUp() 中创建模拟的 Chip 对象(mock_chip、exception_mock_chip)和 Accessor 对象
    • 提供 create_test_csr() 和 create_test_connector() 辅助函数
    • 提供 set_chip_reference() 辅助函数设置 Chip 对象引用
  • Mock对象:

    • mock_chip: 模拟 Chip 对象,实现 BlockIO 和 BitIO 方法
    • exception_mock_chip: 总是抛出异常的模拟 Chip 对象
    • null_result_mock_chip: 返回空数据的模拟 Chip 对象(用于 BitIO)
    • null_blockio_mock_chip: 返回空数据的模拟 Chip 对象(用于 BlockIO)

基本功能测试(2个用例)

  1. test_basic_init: 验证基本初始化(Type=1,BlockIO模式)

    • 验证属性正确设置(Offset、Size、Mask、Type)
  2. test_basic_init2: 验证基本初始化(Type=0,BitIO模式)

    • 验证属性正确设置

Value属性读写测试(2个用例)

  1. test_value_read: 验证 Value 属性的读取功能(BlockIO模式)

    • 设置 Chip 对象引用
    • 读取 Value,触发 BlockIORead 调用
    • 验证读取的值正确(小端序转换)
  2. test_value_write: 验证 Value 属性的写入功能(BlockIO模式)

    • 设置 Chip 对象引用
    • 写入 Value,触发 BlockIOWrite 调用
    • 验证写入的数据正确(小端序转换)

错误处理测试(4个用例)

  1. test_read_failure: 验证读取失败的情况

    • 使用特殊 offset(0xDEAD)触发读取失败
    • 验证不会抛出异常(异常被捕获)
  2. test_write_failure: 验证写入失败的情况

    • 使用特殊 offset(0xBEEF)触发写入失败
    • 验证不会抛出异常(异常被捕获)
  3. test_invalid_chip_ref: 验证无效 Chip 引用的情况

    • 设置不存在的 Chip 引用
    • 验证读取不会抛出异常(异常被捕获)
  4. test_chip_exception: 验证 Chip 对象抛出异常的情况

    • 使用异常 Chip 对象引用
    • 验证读取和写入不会抛出异常(异常被捕获)

边界条件测试(2个用例)

  1. test_size_zero: 验证 Size 为 0 的情况

    • Size 为 0 时,读取和写入都处理空数据
    • 验证写入时写入 0 字节
  2. test_large_data: 验证大数据量(Size=8字节)的情况

    • 测试 8 字节数据的读取和写入
    • 验证小端序转换正确

初始化错误处理测试(6个用例)

  1. test_init_missing_fields: 验证缺少必需字段(Chip)的初始化失败

  2. test_init_missing_offset: 验证缺少 Offset 字段的初始化失败

  3. test_init_missing_size: 验证缺少 Size 字段的初始化失败

  4. test_init_missing_mask: 验证缺少 Mask 字段的初始化失败

  5. test_init_missing_type: 验证缺少 Type 字段的初始化失败

  6. test_init_exception_handling: 验证初始化时的异常处理

    • 使用类型错误的 CSR 数据(Offset 为字符串)
    • 验证初始化失败

并发访问测试(1个用例)

  1. test_concurrent_access: 验证并发访问(多个线程同时读写 Value 属性)
    • 创建 5 个读取线程和 3 个写入线程
    • 验证至少有一些成功的读取操作
    • 验证线程安全性

BitIO 相关测试(9个用例)

  1. test_bitio_read: 验证 BitIORead 功能(Type=0)

    • 使用部分 mask(0x000000FF)读取最低字节
    • 验证读取的值正确
  2. test_bitio_read_full_mask: 验证 BitIORead 使用完整 mask(0xFFFFFFFF)

  3. test_bitio_read_partial_mask: 验证 BitIORead 使用部分 mask(0x0000FF00)

  4. test_bitio_write: 验证 BitIOWrite 功能(Type=0)

    • 验证写入的数据正确(小端序转换)
  5. DISABLED_test_bitio_read_null_result: 验证 BitIORead 返回 null 的情况(已禁用)

  6. test_bitio_read_empty_data: 验证 BitIORead 返回空数据的情况(Size=0)

  7. test_bitio_read_different_sizes: 验证 BitIORead 使用不同大小的数据(Size=1 和 Size=8)

  8. test_bitio_read_complex_mask: 验证 BitIORead 使用复杂 mask 模式(0xAA55AA55)

BlockIO 相关测试(2个用例)

  1. DISABLED_test_blockio_read_null_result: 验证 BlockIORead 返回 null 的情况(已禁用)

  2. test_blockio_read_empty_data: 验证 BlockIORead 数据转换失败的情况(Size=0)

属性读写异常处理测试(3个用例)

  1. test_property_write_invalid_chip_ref: 验证 property_write 在 ref_obj 为 nullptr 时不更新属性

    • 设置无效的 chip 引用
    • 验证写入不会更新属性
  2. test_property_write_exception: 验证 property_write 在异常时不更新属性

    • 使用异常 chip 引用
    • 验证写入失败时属性不更新
  3. test_property_read_invalid_chip_ref: 验证 property_read 在 ref_obj 为 nullptr 时的行为

    • 设置无效的 chip 引用
    • 验证读取不会抛出异常(异常被捕获)

test_accessor_abi.cpp

包含完整的驱动 ABI 接口测试,共17个测试用例:

测试基类

  • AccessorAbiTest: 基础测试类,负责:

    • 驱动库加载(通过 dlopen 加载 libAccessor.so)
    • 驱动注册和 ABI 接口获取
    • 测试服务初始化(accessor_test_service)
    • 根对象创建(root_object)
  • 辅助函数:

    • create_test_connector(): 创建测试用的连接器配置
    • create_test_csr_object(): 创建 Accessor CSR 配置对象

驱动注册功能测试

  1. register_device_driver_success: 验证驱动注册成功

    • 验证返回设备类型:Accessor
  2. device_driver_structure_validation: 验证设备驱动 ABI 接口完整性

    • 验证 ctor、init、start、stop 函数指针不为空

设备创建测试

  1. create_accessor_success: 验证 Accessor 设备创建成功

  2. create_accessor_null_service: 验证传入空服务指针的错误处理

  3. create_accessor_null_name: 验证传入空名称指针的错误处理

设备初始化测试

  1. init_accessor_success: 验证 Accessor 设备初始化成功(Type=1)

    • 验证属性正确设置(Offset、Size、Mask、Type)
  2. init_accessor_success1: 验证 Accessor 设备初始化成功(Type=0)

    • 验证属性正确设置
  3. init_accessor_null_params: 验证传入空参数的错误处理

  4. init_accessor_invalid_csr: 验证无效 CSR 对象的错误处理

    • 缺少必要字段的 CSR 对象

设备启动停止测试

  1. start_stop_accessor_success: 验证设备启动和停止功能

  2. start_accessor_null_device: 验证启动时传入空设备指针的错误处理

  3. stop_accessor_null_device: 验证停止时传入空设备指针的错误处理

属性验证测试

  1. accessor_properties_validation: 验证 Accessor 属性值正确设置
  • 验证 Chip、Offset、Size、Mask、Type 属性

边界值测试

  1. accessor_boundary_values: 验证边界值处理
  • 测试 Offset=0、Size=1、Mask=0、Type=0 的情况

完整生命周期测试

  1. accessor_full_lifecycle: 验证完整生命周期
  • 创建设备 -> 初始化 -> 启动 -> 验证状态 -> 停止

设备树转储测试

  1. dt_dump: 验证设备树转储功能
  • 验证返回非空字符串
  • 验证包含对象名称

测试统计

  • 总测试用例数: 43个
    • test_accessor.cpp: 26个
      • 基本功能测试: 2个
      • Value属性读写测试: 2个
      • 错误处理测试: 4个
      • 边界条件测试: 2个
      • 初始化错误处理测试: 6个
      • 并发访问测试: 1个
      • BitIO相关测试: 9个
      • BlockIO相关测试: 2个(其中1个已禁用)
      • 属性读写异常处理测试: 3个
    • test_accessor_abi.cpp: 17个
      • 驱动注册测试: 2个
      • 设备创建测试: 3个
      • 设备初始化测试: 4个
      • 设备启动停止测试: 3个
      • 属性验证测试: 1个
      • 边界值测试: 1个
      • 完整生命周期测试: 1个
      • 设备树转储测试: 1个

驱动功能说明

Accessor简介

Accessor 是一个访问器驱动,用于通过 Chip 接口访问芯片数据:

  • 功能: 提供统一的接口访问芯片寄存器数据,支持 BlockIO 和 BitIO 两种模式
  • 应用场景:
    • 封装芯片寄存器访问逻辑
    • 提供属性化的数据访问接口
    • 支持值变化检测和信号发射
    • 统一错误处理和统计
  • 访问模式:
    • Type=0: BitIO 模式,使用 BitIORead/BitIOWrite 方法
    • Type=1: BlockIO 模式,使用 BlockIORead/BlockIOWrite 方法

工作原理

  1. Chip引用: 通过 Chip 属性引用目标 Chip 对象(格式:#/对象名)
  2. 访问参数: 通过 Offset、Size、Mask、Type 参数配置访问方式
  3. 数据读取:
    • BlockIO模式: 调用 BlockIORead(offset, size),读取指定偏移量和长度的数据
    • BitIO模式: 调用 BitIORead(offset, size, mask),读取指定偏移量、长度和掩码的数据
  4. 数据写入:
    • BlockIO模式: 调用 BlockIOWrite(offset, buffer),写入指定偏移量的数据
    • BitIO模式: 调用 BitIOWrite(offset, size, mask, buffer),写入指定偏移量、长度和掩码的数据
  5. 数据转换: 将读取的字节数组转换为 uint64_t 值(小端序)
  6. 值变化检测: 检测 Value 属性的变化,并发射信号
  7. 统计信息: 记录成功和失败的访问次数

设备对象路径

设备对象路径格式:/bmc/dev/Accessor/${object_name}

接口

  • IAccessor: Accessor 专用接口,继承自 gen::Accessor
    • Chip: Chip 对象引用(格式:#/对象名)
    • Offset: 偏移量(uint32_t)
    • Size: 数据大小(uint8_t,1-8字节)
    • Mask: 位掩码(uint32_t,用于 BitIO 模式)
    • Type: 访问类型(uint8_t,0=BitIO,1=BlockIO)
    • Value: 数据值(uint64_t),自定义 getter/setter,触发实际的读写操作

配置参数说明

CSR配置(create_test_csr_object)

  • Chip: Chip 对象引用路径(必需,格式:#/对象名)
  • Offset: 偏移量(必需,uint32_t)
  • Size: 数据大小(必需,uint8_t,1-8字节)
  • Mask: 位掩码(必需,uint32_t,用于 BitIO 模式)
  • Type: 访问类型(必需,uint8_t,0=BitIO,1=BlockIO)

连接器配置(create_test_connector)

  • SystemId: 系统ID
  • Position: 位置
  • Slot: 槽位

测试特点

  1. 双层测试架构:

    • 单元测试使用 mock 对象,测试底层功能
    • ABI 接口测试使用动态库加载,测试完整流程
  2. Mock对象: 使用多种 mock Chip 对象模拟不同的场景:

    • 正常工作的 mock_chip
    • 总是抛出异常的 exception_mock_chip
    • 返回空数据的 null_result_mock_chip 和 null_blockio_mock_chip
  3. 双模式支持: 测试覆盖 BlockIO 和 BitIO 两种访问模式

  4. 并发测试: 测试多线程并发访问 Value 属性的线程安全性

  5. 错误处理验证: 详细测试各种异常场景的错误处理:

    • 读取失败、写入失败
    • 无效 Chip 引用
    • Chip 对象异常
    • 空数据、数据转换失败
  6. 边界值测试: 测试 Size=0、大数据量、复杂 mask 等边界条件

  7. 属性读写验证: 验证 Value 属性的自定义 getter/setter 逻辑

    • 读取时触发实际的 Chip 操作
    • 写入时触发实际的 Chip 操作
    • 异常时不更新属性值
  8. 小端序转换: 验证字节数组与 uint64_t 值之间的正确转换

依赖关系

  • 驱动库:
    • libAccessor.so(通过 dlopen 动态加载,仅 ABI 测试)
  • 测试框架: GoogleTest
  • 依赖库:
    • test_utilities: 测试工具库
    • test_utils: 测试工具库(包含 root_object)
    • libmcpp_deps: 核心库依赖
    • internal_dep: 内部依赖(设备管理器等)
    • accessor_static_lib: Accessor 驱动静态库

注意事项

  1. 动态库加载: ABI 测试使用动态库加载(dlopen)来加载驱动,需要确保驱动库在测试工作目录中可用
  2. Mock对象: 单元测试使用 mock Chip 对象模拟 Chip 接口,不需要真实的 Chip 硬件
  3. Chip引用格式: Chip 引用必须使用 #/对象名 格式,通过 from_variant 函数设置
  4. 必需字段: CSR 配置必须包含 Chip、Offset、Size、Mask、Type 字段,缺少任何字段会导致初始化失败
  5. 访问模式: Type=0 使用 BitIO 模式,Type=1 使用 BlockIO 模式
  6. 数据大小限制: Size 范围为 1-8 字节,超过此范围可能导致未定义行为
  7. 小端序转换: 数据在字节数组和 uint64_t 值之间转换时使用小端序
  8. 异常处理: 读取和写入操作中的异常会被捕获,不会导致程序崩溃
  9. 属性更新策略: Value 属性的 setter 只有在写入成功时才更新属性值,写入失败时属性值不变
  10. 并发安全: 多线程并发访问时,需要确保线程安全性
  11. 值变化检测: Accessor 会检测 Value 属性的变化,并发射信号
  12. 统计信息: Accessor 会记录成功和失败的访问次数,可以通过 dump 方法查看
  13. UNIT_TEST 宏: 测试中定义了 UNIT_TEST 宏,用于控制编译行为

相关组件

  • Chip接口: Accessor 通过 Chip 接口访问芯片数据,需要 Chip 对象实现 BlockIO 或 BitIO 方法
  • 设备管理器: 用于管理内部设备对象
  • IAccessor: Accessor 专用接口
  • ref_object: 用于引用其他对象的机制

应用场景

Accessor 驱动适用于:

  • 寄存器访问: 封装芯片寄存器的访问逻辑,提供属性化的访问接口
  • 数据监控: 监控芯片寄存器值的变化,并发射信号通知
  • 统一接口: 为不同的芯片提供统一的访问接口
  • 错误处理: 统一处理访问错误,记录统计信息
  • 系统集成: 在 BMC 系统中,用于访问各种芯片的寄存器数据