Shmem Guidebook

Getting Started

  • 快速开始
    • 介绍
    • 软件架构
    • 目录结构说明
    • 软件硬件配套说明
    • 快速上手
    • 功能自测用例
    • python侧test用例
  • 相关脚本
    • build.sh
    • install.sh
      • 安装目录
    • run.sh
    • set_env.sh
    • uninstall.sh
    • release.sh

Using SHMEM

  • SHMEM API 样例
    • Init API
      • 初始化状态
      • 初始化所需的attributes
      • 初始化样例
      • 自定义日志打印
      • 注册私钥口令解密函数
      • Team API
      • host侧接口样例
      • device侧接口样例
    • Mem API
    • RMA API
    • Sync API

API

  • SHMEM DEF
    • Enumerations
      • shmem_error_code_t
        • SHMEM_SUCCESS
        • SHMEM_INVALID_PARAM
        • SHMEM_INVALID_VALUE
        • SHMEM_SMEM_ERROR
        • SHMEM_INNER_ERROR
        • SHMEM_NOT_INITED
      • shmem_init_status_t
        • SHMEM_STATUS_NOT_INITIALIZED
        • SHMEM_STATUS_SHM_CREATED
        • SHMEM_STATUS_IS_INITIALIZED
        • SHMEM_STATUS_INVALID
      • shmem_team_index_t
        • SHMEM_TEAM_INVALID
        • SHMEM_TEAM_WORLD
      • data_op_engine_type_t
        • SHMEM_DATA_OP_MTE
      • signal ops
        • SHMEM_SIGNAL_SET
        • SHMEM_SIGNAL_ADD
      • signal compare ops
        • SHMEM_CMP_EQ
        • SHMEM_CMP_NE
        • SHMEM_CMP_GT
        • SHMEM_CMP_GE
        • SHMEM_CMP_LT
        • SHMEM_CMP_LE
    • Typedefs
      • shmem_team_t
    • Macros
      • SHMEM_HOST_API
    • Structs
      • shmem_decrypt_handler
      • shmem_init_optional_attr_t
      • shmem_init_attr_t
      • non_contiguous_copy_param
  • HOST API
    • shmem_host_heap.h
    • shmem_host_init.h
    • shmem_host_rma.h
    • shmem_host_sync.h
    • shmem_host_team.h
  • DEVICE API
    • shmem_device_rma.h
      • SHMEM_TYPE_FUNC
      • SHMEM_GET_TYPENAME_MEM_UB
      • SHMEM_GET_TYPENAME_MEM_UB_TENSOR
      • SHMEM_GET_TYPENAME_MEM_UB_DETAILED
      • SHMEM_GET_TYPENAME_MEM_UB_TENSOR_DETAILED
      • SHMEM_PUT_TYPENAME_MEM_UB
      • SHMEM_PUT_TYPENAME_MEM_UB_TENSOR
      • SHMEM_PUT_TYPENAME_MEM_UB_DETAILED
      • SHMEM_PUT_TYPENAME_MEM_UB_TENSOR_DETAILED
      • ub_limit
    • shmem_device_sync.h
    • shmem_device_team.h

Python API

  • SHMEM对外接口
  • SHMEM类

Example

  • AllGather
    • 核函数实现

Architecture

  • 代码组织结构
    • SHMEM组织结构
    • include
    • src
    • examples
    • tests
    • docs
    • scripts

Troubleshooting And FAQs

  • SHMEM 使用限制
  • SHMEM 常见问题

Security hardening and public IP address

  • 安全加固
    • 通信矩阵
    • 加固须知
    • 运行用户建议
    • 内存地址随机化机制安全加固
  • 公网地址
Shmem Guidebook
  • Welcome to Shmem’s Documentation!
  • View page source

Welcome to Shmem’s Documentation!

Getting Started

  • 快速开始
    • 介绍
    • 软件架构
    • 目录结构说明
    • 软件硬件配套说明
    • 快速上手
    • python侧test用例
    • unique id 初始化方式
  • 相关脚本
    • build.sh
    • install.sh
    • run.sh
    • set_env.sh
    • uninstall.sh
    • release.sh

Using SHMEM

  • SHMEM API 样例
    • Init API
    • Mem API
    • RMA API
    • Sync API

API

  • SHMEM DEF
    • Enumerations
    • Typedefs
    • Macros
    • Structs
  • HOST API
    • shmem_host_heap.h
    • shmem_host_init.h
    • shmem_host_rma.h
    • shmem_host_sync.h
    • shmem_host_team.h
  • DEVICE API
    • shmem_device_rma.h
    • shmem_device_sync.h
    • shmem_device_team.h

Python API

  • SHMEM对外接口
  • SHMEM类

Example

  • AllGather
    • 核函数实现

Architecture

  • 代码组织结构
    • SHMEM组织结构
    • include
    • src
    • examples
    • tests
    • docs
    • scripts

Troubleshooting And FAQs

  • SHMEM 使用限制
  • SHMEM 常见问题

Security hardening and public IP address

  • 安全声明
    • 安全加固
      • 加固须知
      • 通信矩阵
    • 运行用户建议
    • 文件权限控制
    • 构建安全声明
    • 运行安全声明
    • 内存地址随机化机制安全加固
    • 公网地址声明
    • 漏洞机制说明
    • 附录

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2025.