PMwCAS 项目使用教程

1. 项目介绍

PMwCAS（Persistent Multi-Word Compare-and-Swap）是一个用于在非易失性内存（NVRAM）上原子地更改多个8字节字的库。它允许开发者轻松构建无锁数据结构，并且不需要应用程序自定义恢复逻辑。PMwCAS的核心概念是描述符（descriptor），通过描述符可以实现对多个目标字的高效原子操作。

PMwCAS支持Windows和Linux操作系统，并提供了四种不同的持久化模式：

• 使用Intel PMDK进行持久化
• 通过DRAM模拟持久化
• 非持久化（无持久化支持）
• 使用Intel TSX进行非持久化（通过硬件事务内存安装描述符）

2. 项目快速启动

2.1 环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：Windows（CMake + Visual Studio）或 Linux（CMake + gcc/clang）
• 依赖库：Intel PMDK（如果使用持久化模式）

2.2 克隆项目

首先，克隆PMwCAS项目到本地：

git clone --recursive https://github.com/microsoft/pmwcas.git

2.3 编译项目

2.3.1 在Linux上编译

假设我们在源代码目录下创建一个名为build的目录进行编译：

mkdir build
cd build
cmake -DPMEM_BACKEND=[PMDK/Volatile/Emu] -DCMAKE_BUILD_TYPE=[Debug/Release/RelWithDebInfo] ..
make -jN

2.3.2 在Windows上编译

在Windows上编译时，使用以下命令：

md build
cd build
cmake -G [generator] ..

其中，[generator]应与已安装的Visual Studio版本匹配，例如Visual Studio 14 2015 Win64。然后，可以通过打开pmwcas.sln文件在Visual Studio中进行编译，或者使用以下命令：

msbuild pmwcas.sln /p:Configuration=[Release/Debug]

3. 应用案例和最佳实践

3.1 数组基准测试

PMwCAS提供了一个数组基准测试，用于原子地更改固定大小的数组中的随机数量的条目。以下是一个示例命令：

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

3.2 双链表

PMwCAS还提供了使用单字CAS和PMwCAS实现的无锁双链表。以下是一个示例命令：

mwcas_shm_server -shm_segment "mwcas" # 启动共享内存进程
doubly_linked_list_benchmark -shm_segment "mwcas" -threads 2 -seconds 10

4. 典型生态项目

PMwCAS可以与其他高性能计算和存储项目结合使用，例如：

• Intel PMDK：用于持久化内存编程的库，与PMwCAS结合使用可以实现高效的持久化数据结构。
• TBB（Threading Building Blocks）：Intel提供的并行编程库，可以与PMwCAS结合使用以提高多线程性能。
• SPDK（Storage Performance Development Kit）：用于构建高性能存储应用的库，可以与PMwCAS结合使用以实现高效的存储系统。

通过结合这些生态项目，PMwCAS可以进一步扩展其应用场景，提供更强大的功能和性能。