numactl 项目技术文档

1. 安装指南

1.1 系统要求

• Linux 操作系统
• 支持 NUMA（Non-Uniform Memory Access）架构的硬件

1.2 安装步骤

1.2.1 从源码安装

1. 克隆项目仓库

   git clone https://github.com/numactl/numactl.git
   cd numactl
   

2. 编译和安装

   ./autogen.sh
   ./configure
   make
   sudo make install
   

1.2.2 使用包管理器安装

在某些 Linux 发行版中，可以使用包管理器直接安装 numactl。

• Debian/Ubuntu

  sudo apt-get install numactl
  

• Red Hat/CentOS

  sudo yum install numactl
  

2. 项目使用说明

2.1 基本使用

numactl 是一个用于在 NUMA 架构上运行程序的工具。它允许用户指定程序的内存分配策略和 CPU 亲和性。

示例：

numactl --membind=0 --cpunodebind=0 ./your_program

2.2 常用命令

• --membind=nodes：指定程序使用的内存节点。
• --cpunodebind=nodes：指定程序使用的 CPU 节点。
• --localalloc：在当前节点上分配内存。
• --preferred=node：优先在指定节点上分配内存。

2.3 工具程序

• numastat：显示 NUMA 分配统计信息。
• memhog：模拟内存压力测试。

3. 项目 API 使用文档

3.1 库文件

libnuma 是一个共享库，提供了 NUMA 相关的 API，允许开发者在应用程序中设置 NUMA 策略。

3.2 常用 API

• numa_available()：检查系统是否支持 NUMA。
• numa_alloc_onnode(size, node)：在指定节点上分配内存。
• numa_run_on_node(node)：将当前线程绑定到指定节点。

示例代码：

#include <numa.h>
#include <stdio.h>

int main() {
    if (numa_available() < 0) {
        printf("NUMA not available\n");
        return 1;
    }

    void *ptr = numa_alloc_onnode(1024, 0);
    if (ptr == NULL) {
        printf("Memory allocation failed\n");
        return 1;
    }

    numa_run_on_node(0);
    // 使用分配的内存

    numa_free(ptr, 1024);
    return 0;
}

4. 项目安装方式

4.1 源码安装

如前所述，通过克隆项目仓库并执行 make 和 make install 命令进行安装。

4.2 包管理器安装

在支持的 Linux 发行版中，可以使用包管理器直接安装 numactl。

---

通过以上文档，您应该能够顺利安装和使用 numactl 项目，并了解如何在应用程序中使用 NUMA API。