PMwCAS 项目教程

1. 项目目录结构及介绍

PMwCAS 项目的目录结构如下：

pmwcas/
├── src/
│   ├── benchmarks/
│   ├── double-linked-list/
│   ├── environment/
│   └── third-party/
├── .gitignore
├── .gitmodules
├── APIs.md
├── CHANGELOG.md
├── CMakeLists.txt
├── LICENSE
├── README.md
└── SECURITY.md

目录介绍

• src/: 包含项目的源代码，分为多个子目录：

  • benchmarks/: 包含性能测试和基准测试的代码。
  • double-linked-list/: 包含使用 PMwCAS 实现的锁自由双链表的代码。
  • environment/: 包含与环境相关的代码，如线程管理等。
  • third-party/: 包含第三方库的代码。

• .gitignore: Git 忽略文件配置。

• .gitmodules: Git 子模块配置。

• APIs.md: 项目 API 文档。

• CHANGELOG.md: 项目变更日志。

• CMakeLists.txt: CMake 构建配置文件。

• LICENSE: 项目许可证文件。

• README.md: 项目介绍和使用说明。

• SECURITY.md: 项目安全相关文档。

2. 项目启动文件介绍

PMwCAS 项目的启动文件主要集中在 src/benchmarks/ 目录下，其中包含了多个基准测试和示例程序。以下是一些关键的启动文件：

• mwcas_benchmark.cc: 这是一个基准测试程序，用于测试 PMwCAS 在固定大小的数组中对多个条目进行原子更改的性能。
• doubly_linked_list_benchmark.cc: 这是一个基准测试程序，用于测试使用 PMwCAS 实现的锁自由双链表的性能。
• mwcas_shm_server.cc: 这是一个共享内存服务程序，用于在没有真实 NVRAM 设备的情况下进行 NVRAM 仿真。

启动示例

以下是启动 mwcas_benchmark 的示例命令：

$ mwcas_shm_server -shm_segment "mwcas" # 启动共享内存服务
$ mwcas_benchmark -shm_segment "mwcas" -threads 2 -seconds 10 -array_size 100 -word_count 4

3. 项目的配置文件介绍

PMwCAS 项目的主要配置文件是 CMakeLists.txt，它定义了项目的构建配置。以下是一些关键的配置选项：

• PMEM_BACKEND: 指定持久化模式，可选值包括 PMDK、Volatile、Emu。
• CMAKE_BUILD_TYPE: 指定构建类型，可选值包括 Debug、Release、RelWithDebInfo。
• WITH_RTM: 是否启用 Intel TSX（硬件事务内存）支持，仅在 Volatile 模式下有效。
• DESC_CAP: 指定每个描述符可以容纳的最大字数。

配置示例

以下是构建 PMwCAS 项目的示例命令：

$ mkdir build
$ cd build
$ cmake -DPMEM_BACKEND=Volatile -DWITH_RTM=1 -DCMAKE_BUILD_TYPE=Release ..
$ make -j4

这个命令将构建一个使用 Intel TSX 支持的 Volatile 模式下的 PMwCAS 库。