fastPASTA

ALICE的快速协议分析扫描工具

有关通过“check”子命令执行的数据验证的完整列表，请参阅doc/checks_list.md。

发布和相关的变更日志可以在发布或CHANGELOG.md中找到。

在示例文档中查看更多示例，包括高级场景。

需要更多细节？请参阅开发者文档部分。

目的

用于验证或查看CERN ALICE探测器扫描的原始二进制数据的精选内容。

演示

目录

• fastPASTA
  • ALICE的快速协议分析扫描工具
  • 目的
  • 演示
• 目录
• 快速入门
  • 先决条件
  • 通过cargo安装（与Rust一起提供）
  • 添加shell补全
  • 查看帮助，包括使用示例
  • 使用示例
    • 从stdin读取 -> 过滤链接 -> 查看RDHs
    • 从文件读取 -> 按链接过滤 -> 验证
    • 从文件读取 -> 使用less查看ITS读取帧
  • 命令流
• 自定义检查
  • 使用自定义检查进行配置
  • 输出全面统计信息（并将它们输入以进行验证）
    • 输出统计信息
    • 示例
    • 使用统计信息进行数据验证
    • 示例
• 错误消息
  • 消息格式如下
  • 失败的RDH健全性检查示例
  • 错误代码
  • 详细级别
  • 运行测试
• 许可证
• 项目状态
• 基准和比较
  • 验证1.5 GB文件中所有RDH，数据来自1 GBT链接
  • 验证3 GB文件中所有RDH，数据来自2个不同的GBT链接
  • 验证260 MB文件中所有RDH和有效载荷，数据来自1 GBT链接
• 需要更多性能？
  • 背景
  • 要安装夜间工具链（并检查您的安装）
  • 编译优化的release-nightly实验构建配置文件
  • 二进制文件的路径：/target/release-nightly/fastpasta
  • 开发者文档

快速入门

先决条件

需要rust工具链来编译二进制文件。使用链接下载Windows安装程序。在macOS、Linux或其他类Unix操作系统上，只需运行

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

并遵循屏幕上的说明。

通过cargo安装（与Rust一起提供）

cargo install fastpasta

更新fastpasta只需重新运行cargo install fastpasta

添加shell补全

使用以下命令为bash/zsh/fish/powershell/elvish生成完成脚本

fastpasta --generate-completions <SHELL> > path/to/your/completion/scripts/_fastpasta

查看帮助，包括使用示例

fastpasta -h

使用示例

从stdin读取 -> 过滤链接 -> 查看RDHs

lz4 -d input.raw -c | fastpasta --filter-link 3 | fastpasta view rdh
#        ^^^^                      ^^^^                       ^^^^
#       INPUT       --->          FILTER          --->        VIEW
# Decompressing with `lz4`

管道通常不是必需的，避免使用它可以提高性能。例如，以下示例与上一个示例等效，但通过使用更少的管道，节省了大量的I/O开销。

lz4 -d input.raw -c | fastpasta --filter-link 3 view rdh

从文件读取 -> 按链接过滤 -> 验证

启用所有通用检查：sanity（无状态）和running（有状态）

fastpasta input.raw --filter-link 0 check all

启用所有sanity检查，并包含仅适用于ITS的检查

fastpasta input.raw check sanity its --filter-link 0

从文件读取 -> 使用less查看ITS读取帧

生成ITS读出帧视图

fastpasta input.raw view its-readout-frames | less

仅查看来自链接#3的读出帧

fastpasta input.raw view its-readout-frames -f 3 | less

命令流

flowchart TD;
  start["fastpasta"] --> top_sub_cmd{"Check or view?"};

  top_sub_cmd -- "view" --> view_type{"Type of view"};
  view_type -- "rdh" --> view_rdh{{$ fastpasta view rdh}};
  view_type -- "its-readout-frames" --> view_ro_frames{{$ fastpasta view its-readout-frames}};
  view_type -- "its-readout-frames-data" --> view_ro_frames_data{{$ fastpasta view its-readout-frames-data}};

  top_sub_cmd -- "check" --> check_type{"Type of check"};

  check_type -- "sanity" --> check_sanity{"$ fastpasta check sanity
  or
  target system"};
  check_sanity -- "its" --> check_sanity_its{{$ fastpasta check sanity its}};

  check_type -- "all" --> check_all{"$ fastpasta check all
  or
  target system"};
  check_all -- "its" --> check_all_its{{$ fastpasta check all its}};
  check_all -- "its-stave" --> check_all_its_stave{{$ fastpasta check all its-stave}};

自定义检查

使用自定义检查进行配置

要执行对原始数据的非常具体的检查，可以使用--checks-toml <PATH>选项提供一个TOML文件。

要开始，请使用--generate-checks-toml标志生成一个模板，该模板显示了哪些自定义检查可用，包括描述和示例。

生成的TOML文件将包含如下内容

# Number of Physics (PhT) Triggers expected in the data
# Example: 0, 10
#triggers_pht = None [ u32 ] # (Uncomment and set to enable this check)

要启用对原始数据中1个物理触发的检查，编辑文件如下

# Number of Physics (PhT) Triggers expected in the data
# Example: 0, 10
triggers_pht = 1 # This data should contain 1 PhT trigger.

最后像往常一样运行fastPASTA，例如

fastpasta check all its input-data.raw --checks-toml custom_checks.toml

输出全面统计信息（并将它们输入以进行验证）

输出统计信息

在数据分析过程中收集了大量的统计数据。这些统计数据可以写入文件/stdout的JSON/TOML格式，例如可以作为输入到验证这些统计数据的脚本的输入。

示例

对bin.raw中的数据进行stave级别的ITS相关检查，并将统计数据保存为stats.json

fastpasta check all its-stave --output-stats stats.json --stats-format json bin.raw

使用统计信息进行数据验证

输出统计数据也可以作为fastPASTA的输入，同时使用--input-stats-file <file>选项对一些原始数据进行检查。这将运行输入统计数据与分析过程中收集的统计数据之间的完整比较，并为每个不匹配的值输出错误信息。

fastpasta check all its-stave --input-stats-file stats.json bin.raw

MEMORY_OFFSET: [ERROR_CODE] ERROR_MESSAGE

0xE450FFD: [E10] RDH sanity check failed: data_format = 255

cargo test

rustup toolchain install nightly
rustup run nightly rustc --version

cargo +nightly build --profile release-nightly