已合并
[docs] 更新UBSE相关链接 #101
whytao创建于 9月11日
[docs] 更新UBSE相关链接 #101
已合并
共 3 个文件变更+14-14
| @@ -76,16 +76,16 @@ sh run_dt.sh | |||
| 76 | ## 使用说明 | 76 | ## 使用说明 |
| 77 | 77 | ||
| 78 | - **安装部署** | 78 | - **安装部署** |
| 79 | - | 79 | + |
| 80 | 安装部署相关内容请参见 [安装部署](docs/zh/ubsm_installation_deployment.md)。 | 80 | 安装部署相关内容请参见 [安装部署](docs/zh/ubsm_installation_deployment.md)。 |
| 81 | 81 | ||
| 82 | - **API接口** | 82 | - **API接口** |
| 83 | - | 83 | + |
| 84 | API相关内容请参见 [接口说明](docs/zh/ubsm_api_description.md)。 | 84 | API相关内容请参见 [接口说明](docs/zh/ubsm_api_description.md)。 |
| 85 | 85 | ||
| 86 | ## License | 86 | ## License |
| 87 | 87 | ||
| 88 | -ubs-mem 采用 Mulan V2 License. | 88 | +ubs-mem 采用 Mulan V2 License。 |
| 89 | 89 | ||
| 90 | ## 贡献指南 | 90 | ## 贡献指南 |
| 91 | 91 | ||
| @@ -326,7 +326,7 @@ int ubsmem_shmem_allocate(const char *region_name, const char *name, size_t size | |||
| 326 | |--|--|--|--| | 326 | |--|--|--|--| |
| 327 | |region_name|const char *|入参|内存域名称（默认域为“default”，包含与当前节点全互联的节点）。| | 327 | |region_name|const char *|入参|内存域名称（默认域为“default”，包含与当前节点全互联的节点）。| |
| 328 | |name|const char *|入参|共享内存名称。全局唯一标识，最大有效长度为47字符（不包括“\0”），仅允许使用大小写字母、数字、“.”、“:”、“-”和“_”。| | 328 | |name|const char *|入参|共享内存名称。全局唯一标识，最大有效长度为47字符（不包括“\0”），仅允许使用大小写字母、数字、“.”、“:”、“-”和“_”。| |
| 329 | -|size|size_t|入参|共享内存size，最小4MB，需为4MB整数倍，单位为字节。<br>该参数的最小值与南向依赖UBSE中的配置项 [obmm.memory.block.size](https://atomgit.com/openeuler/ubs-engine/blob/master/docs/zh/ubse_configration_instructions.md) 有关。共享内存以FD的形式进行管理，每个FD管理 `obmm.memory.block.size` 大小的内存。共享内存在导出导入时会以该配置项向上取整对齐。<br>例如：该配置项为128MB，创建共享内存时传入size是4MB，实际上会创建出128MB的共享内存。| | 329 | +|size|size_t|入参|共享内存size，最小4MB，需为4MB整数倍，单位为字节。<br>该参数的最小值与南向依赖UBSE中的配置项 [obmm.memory.block.size](https://atomgit.com/openeuler/ubs-engine/blob/master/docs/zh/ubse_configuration_instructions.md) 有关。共享内存以FD的形式进行管理，每个FD管理 `obmm.memory.block.size` 大小的内存。共享内存在导出导入时会以该配置项向上取整对齐。<br>例如：该配置项为128MB，创建共享内存时传入size是4MB，实际上会创建出128MB的共享内存。| |
| 330 | |mode|mode_t|入参|访问权限，Unix文件权限位的 *rwx* 权限控制（ *x* 权限暂不支持，请忽略）。用于控制不同用户对该共享内存的访问权限，若无权限则映射失败。建议值： `S_IRUSR \| S_IWUSR` （即仅创建该共享内存的用户可以访问该共享内存）。| | 330 | |mode|mode_t|入参|访问权限，Unix文件权限位的 *rwx* 权限控制（ *x* 权限暂不支持，请忽略）。用于控制不同用户对该共享内存的访问权限，若无权限则映射失败。建议值： `S_IRUSR \| S_IWUSR` （即仅创建该共享内存的用户可以访问该共享内存）。| |
| 331 | |flags|uint64_t|入参|创建共享内存的标志信息。flag有效比特位含义请参见[表1 共享内存的flags](#table005)，各有效比特位组合关系参见[表2 共享内存的flags可组合关系](#table006)。| | 331 | |flags|uint64_t|入参|创建共享内存的标志信息。flag有效比特位含义请参见[表1 共享内存的flags](#table005)，各有效比特位组合关系参见[表2 共享内存的flags可组合关系](#table006)。| |
| 332 | 332 | ||
| @@ -377,7 +377,7 @@ int ubsmem_shmem_allocate_with_provider(const ubs_mem_provider_t *src_loc, const | |||
| 377 | |--|--|--|--| | 377 | |--|--|--|--| |
| 378 | |src_loc|const ubs_mem_provider_t *|入参|指定内存创建的节点信息，包括：<ul><li>host_name：节点名称，必填。</li><li>socket_id：指定内存导出的socket id，选填（UINT32_MAX）。</li><li>numa_id：指定内存导出的numa id，选填（UINT32_MAX）。</li><li>port_id：指定内存导出的port id，选填（UINT32_MAX）。</li></ul>| | 378 | |src_loc|const ubs_mem_provider_t *|入参|指定内存创建的节点信息，包括：<ul><li>host_name：节点名称，必填。</li><li>socket_id：指定内存导出的socket id，选填（UINT32_MAX）。</li><li>numa_id：指定内存导出的numa id，选填（UINT32_MAX）。</li><li>port_id：指定内存导出的port id，选填（UINT32_MAX）。</li></ul>| |
| 379 | |name|const char *|入参|共享内存名称。全局唯一标识，最大有效长度为47字符（不包括“\0”），仅允许使用大小写字母、数字、“.”、“:”、“-”和“_”。| | 379 | |name|const char *|入参|共享内存名称。全局唯一标识，最大有效长度为47字符（不包括“\0”），仅允许使用大小写字母、数字、“.”、“:”、“-”和“_”。| |
| 380 | -|size|size_t|入参|共享内存size，最小4MB，需为4MB整数倍，单位为字节。<br>该参数的最小值与南向依赖UBSE中的配置项 [obmm.memory.block.size](https://atomgit.com/openeuler/ubs-engine/blob/master/docs/zh/ubse_configration_instructions.md) 有关。共享内存以FD的形式进行管理，每个FD管理 `obmm.memory.block.size` 大小的内存。共享内存在导出导入时会以该配置项向上取整对齐。<br>例如：该配置项为128MB，创建共享内存时传入size是4MB，实际上会创建出128MB的共享内存。| | 380 | +|size|size_t|入参|共享内存size，最小4MB，需为4MB整数倍，单位为字节。<br>该参数的最小值与南向依赖UBSE中的配置项 [obmm.memory.block.size](https://atomgit.com/openeuler/ubs-engine/blob/master/docs/zh/ubse_configuration_instructions.md) 有关。共享内存以FD的形式进行管理，每个FD管理 `obmm.memory.block.size` 大小的内存。共享内存在导出导入时会以该配置项向上取整对齐。<br>例如：该配置项为128MB，创建共享内存时传入size是4MB，实际上会创建出128MB的共享内存。| |
| 381 | |mode|mode_t|入参|访问权限，Unix文件权限位的 *rwx* 权限控制（ *x* 权限暂不支持，忽略）。| | 381 | |mode|mode_t|入参|访问权限，Unix文件权限位的 *rwx* 权限控制（ *x* 权限暂不支持，忽略）。| |
| 382 | |flags|uint64_t|入参|创建共享内存的标志信息。flag有效比特位含义请参见[表1 共享内存的flags](#table005)，各有效比特位组合关系参见[表2 共享内存的flags可组合关系](#table006)。| | 382 | |flags|uint64_t|入参|创建共享内存的标志信息。flag有效比特位含义请参见[表1 共享内存的flags](#table005)，各有效比特位组合关系参见[表2 共享内存的flags可组合关系](#table006)。| |
| 383 | 383 | ||
| @@ -544,7 +544,7 @@ typedef struct { | |||
| 544 | 订阅共享内存故障事件，当共享内存发生故障时，会调用注册的事件通知函数。 | 544 | 订阅共享内存故障事件，当共享内存发生故障时，会调用注册的事件通知函数。 |
| 545 | 545 | ||
| 546 | >[!NOTE]说明 | 546 | >[!NOTE]说明 |
| 547 | ->用户在调用该接口前，需加入ubse属组，并具备ubse的mem.shm类接口权限，具体配置请参见[UBSE 配置说明](https://atomgit.com/openeuler/ubs-engine/blob/master/docs/zh/ubse_configration_instructions.md)文档。 | 547 | +>用户在调用该接口前，需加入ubse属组，并具备ubse的mem.shm类接口权限，具体配置请参见[UBSE 配置说明](https://atomgit.com/openeuler/ubs-engine/blob/master/docs/zh/ubse_configuration_instructions.md)文档。 |
| 548 | 548 | ||
| 549 | **接口格式** | 549 | **接口格式** |
| 550 | 550 | ||
| @@ -572,7 +572,7 @@ int ubsmem_shmem_faults_register(shmem_faults_func registerFunc); | |||
| 572 | 查询该节点在超节点域中的节点ID。 | 572 | 查询该节点在超节点域中的节点ID。 |
| 573 | 573 | ||
| 574 | >[!NOTE]说明 | 574 | >[!NOTE]说明 |
| 575 | ->用户在调用该接口前，需加入ubse属组，并具备ubse的topo类接口权限，具体配置请参见[UBSE 配置说明](https://atomgit.com/openeuler/ubs-engine/blob/master/docs/zh/ubse_configration_instructions.md)文档。 | 575 | +>用户在调用该接口前，需加入ubse属组，并具备ubse的topo类接口权限，具体配置请参见[UBSE 配置说明](https://atomgit.com/openeuler/ubs-engine/blob/master/docs/zh/ubse_configuration_instructions.md)文档。 |
| 576 | 576 | ||
| 577 | **接口格式** | 577 | **接口格式** |
| 578 | 578 | ||
| @@ -701,7 +701,7 @@ int ubsmem_lease_malloc(const char *region_name, size_t size, ubsmem_distance_t | |||
| 701 | |参数名|数据类型|参数类型|描述| | 701 | |参数名|数据类型|参数类型|描述| |
| 702 | |--|--|--|--| | 702 | |--|--|--|--| |
| 703 | |region_name|const char *|入参|内存域名称（默认域为“default”，包含与当前节点全互联的节点）。节点内唯一标识，最大有效长度为47字符（不包括“\0”），仅允许使用大小写字母、数字、“-”和“_”。| | 703 | |region_name|const char *|入参|内存域名称（默认域为“default”，包含与当前节点全互联的节点）。节点内唯一标识，最大有效长度为47字符（不包括“\0”），仅允许使用大小写字母、数字、“-”和“_”。| |
| 704 | -|size|size_t|入参|申请的内存size。最小4MB，需为4MB整数倍，单位为字节。<br>该参数的最小值与南向依赖UBSE中的配置项 [obmm.memory.block.size](https://atomgit.com/openeuler/ubs-engine/blob/master/docs/zh/ubse_configration_instructions.md) 有关。共享内存以FD的形式进行管理，每个FD管理 `obmm.memory.block.size` 大小的内存。共享内存在导出导入时会以该配置项向上取整对齐。<br>例如：该配置项为128MB，创建共享内存时传入size是4MB，实际上会创建出128MB的共享内存。| | 704 | +|size|size_t|入参|申请的内存size。最小4MB，需为4MB整数倍，单位为字节。<br>该参数的最小值与南向依赖UBSE中的配置项 [obmm.memory.block.size](https://atomgit.com/openeuler/ubs-engine/blob/master/docs/zh/ubse_configuration_instructions.md) 有关。共享内存以FD的形式进行管理，每个FD管理 `obmm.memory.block.size` 大小的内存。共享内存在导出导入时会以该配置项向上取整对齐。<br>例如：该配置项为128MB，创建共享内存时传入size是4MB，实际上会创建出128MB的共享内存。| |
| 705 | |mem_distance|ubsmem_distance_t|入参|节点连接模式，当前仅支持直连借用，即 `DISTANCE_DIRECT_NODE` 取值为0。| | 705 | |mem_distance|ubsmem_distance_t|入参|节点连接模式，当前仅支持直连借用，即 `DISTANCE_DIRECT_NODE` 取值为0。| |
| 706 | |flags|uint64_t|入参|借用的标志信息。如果为0，默认进行FD借用。当前支持以下flags：<ul><li>UBSM_FLAG_MMAP_HUGETLB_PMD：表示以2MB大页粒度进行映射。</li><li>UBSM_FLAG_MALLOC_WITH_NUMA：表示借用以远端NUMA呈现。与UBSM_FLAG_MMAP_HUGETLB_PMD不可同时指定，设置该flag借用最小值为128MB。</li></ul>| | 706 | |flags|uint64_t|入参|借用的标志信息。如果为0，默认进行FD借用。当前支持以下flags：<ul><li>UBSM_FLAG_MMAP_HUGETLB_PMD：表示以2MB大页粒度进行映射。</li><li>UBSM_FLAG_MALLOC_WITH_NUMA：表示借用以远端NUMA呈现。与UBSM_FLAG_MMAP_HUGETLB_PMD不可同时指定，设置该flag借用最小值为128MB。</li></ul>| |
| 707 | |local_ptr|void **|出参|申请后得到的本地地址。| | 707 | |local_ptr|void **|出参|申请后得到的本地地址。| |
| @@ -730,7 +730,7 @@ int ubsmem_lease_malloc_with_location(const ubs_mem_location_t *src_loc, size_t | |||
| 730 | |参数名|数据类型|参数类型|描述| | 730 | |参数名|数据类型|参数类型|描述| |
| 731 | |--|--|--|--| | 731 | |--|--|--|--| |
| 732 | |src_loc|const ubs_mem_location_t *|入参|指定借出内存节点的信息，包括slot_id、socket_id、numa_id和port_id。| | 732 | |src_loc|const ubs_mem_location_t *|入参|指定借出内存节点的信息，包括slot_id、socket_id、numa_id和port_id。| |
| 733 | -|size|size_t|入参|申请的内存size。最小4MB，需为4MB整数倍，单位为字节。<br>该参数的最小值与南向依赖UBSE中的配置项 [obmm.memory.block.size](https://atomgit.com/openeuler/ubs-engine/blob/master/docs/zh/ubse_configration_instructions.md) 有关。共享内存以FD的形式进行管理，每个FD管理 `obmm.memory.block.size` 大小的内存。共享内存在导出导入时会以该配置项向上取整对齐。<br>例如：该配置项为128MB，创建共享内存时传入size是4MB，实际上会创建出128MB的共享内存。| | 733 | +|size|size_t|入参|申请的内存size。最小4MB，需为4MB整数倍，单位为字节。<br>该参数的最小值与南向依赖UBSE中的配置项 [obmm.memory.block.size](https://atomgit.com/openeuler/ubs-engine/blob/master/docs/zh/ubse_configuration_instructions.md) 有关。共享内存以FD的形式进行管理，每个FD管理 `obmm.memory.block.size` 大小的内存。共享内存在导出导入时会以该配置项向上取整对齐。<br>例如：该配置项为128MB，创建共享内存时传入size是4MB，实际上会创建出128MB的共享内存。| |
| 734 | |flags|uint64_t|入参|借用的标志信息。如果为0，默认进行FD借用。当前支持以下flags：<ul><li>UBSM_FLAG_MMAP_HUGETLB_PMD：表示以2MB大页粒度进行映射。</li><li>UBSM_FLAG_MALLOC_WITH_NUMA：表示借用以远端NUMA呈现。与UBSM_FLAG_MMAP_HUGETLB_PMD不可同时指定，设置该flag借用最小值为128MB。</li></ul>| | 734 | |flags|uint64_t|入参|借用的标志信息。如果为0，默认进行FD借用。当前支持以下flags：<ul><li>UBSM_FLAG_MMAP_HUGETLB_PMD：表示以2MB大页粒度进行映射。</li><li>UBSM_FLAG_MALLOC_WITH_NUMA：表示借用以远端NUMA呈现。与UBSM_FLAG_MMAP_HUGETLB_PMD不可同时指定，设置该flag借用最小值为128MB。</li></ul>| |
| 735 | |local_ptr|void **|出参|申请后得到的本地地址。| | 735 | |local_ptr|void **|出参|申请后得到的本地地址。| |
| 736 | 736 | ||
| @@ -10,7 +10,7 @@ | |||
| 10 | 10 | ||
| 11 | | 类型 | 配置参考| | 11 | | 类型 | 配置参考| |
| 12 | |-----|-----| | 12 | |-----|-----| |
| 13 | -| 服务器 | <ul><li>TaiShan 500 2280</li> <li>其他配备支持UB的CPU的服务器</li></ul> | | 13 | +| 服务器 | <ul><li>TaiShan 500 2280</li> <li>Taishan 950 SuperPod</li> <li>其他配备支持UB的CPU的服务器</li></ul> | |
| 14 | 14 | ||
| 15 | ## 安装UBS Memory | 15 | ## 安装UBS Memory |
| 16 | 16 | ||
| @@ -31,7 +31,7 @@ | |||
| 31 | dnf install -y ubs-mem-shmem-x.x.x-x.x.*.rpm | 31 | dnf install -y ubs-mem-shmem-x.x.x-x.x.*.rpm |
| 32 | ``` | 32 | ``` |
| 33 | 33 | ||
| 34 | - >[!NOTE]说明 | 34 | + >[!NOTE] 说明 |
| 35 | >- 内存服务以ubsmd用户的身份运行，在使用RPM包安装时，若系统中不存在ubsmd用户，安装脚本将自动创建该用户。 | 35 | >- 内存服务以ubsmd用户的身份运行，在使用RPM包安装时，若系统中不存在ubsmd用户，安装脚本将自动创建该用户。 |
| 36 | >- 安装成功后，so会默认安装到“/usr/local/ubs\_mem/lib”目录，使用时需要export该路径。 | 36 | >- 安装成功后，so会默认安装到“/usr/local/ubs\_mem/lib”目录，使用时需要export该路径。 |
| 37 | >- 安装成功后，.h头文件会默认安装到“/usr/local/ubs\_mem/include”目录。 | 37 | >- 安装成功后，.h头文件会默认安装到“/usr/local/ubs\_mem/include”目录。 |
| @@ -104,7 +104,7 @@ | |||
| 104 | ubsm.performance.statistics.enable = off | 104 | ubsm.performance.statistics.enable = off |
| 105 | ``` | 105 | ``` |
| 106 | 106 | ||
| 107 | - >[!NOTE]说明 | 107 | + >[!NOTE] 说明 |
| 108 | > | 108 | > |
| 109 | >- 使用共享内存的分布式锁功能时，需要在配置文件中主动设置当前节点的IP地址和端口号以及集群中其他节点的节点信息，启动当前节点的ubsmd进程，会同步启动其他节点。 | 109 | >- 使用共享内存的分布式锁功能时，需要在配置文件中主动设置当前节点的IP地址和端口号以及集群中其他节点的节点信息，启动当前节点的ubsmd进程，会同步启动其他节点。 |
| 110 | >- 开启TLS（Transport Layer Security，安全传输层协议）认证功能操作详情可参见[开启TLS认证](ubsm_security_description.md#开启tls认证)，如果不使用该功能，将配置项 `ubsm.server.tls.enable` 设为 `off` 即可。 | 110 | >- 开启TLS（Transport Layer Security，安全传输层协议）认证功能操作详情可参见[开启TLS认证](ubsm_security_description.md#开启tls认证)，如果不使用该功能，将配置项 `ubsm.server.tls.enable` 设为 `off` 即可。 |
| @@ -117,7 +117,7 @@ | |||
| 117 | systemctl start ubsmd | 117 | systemctl start ubsmd |
| 118 | ``` | 118 | ``` |
| 119 | 119 | ||
| 120 | - >[!NOTE]说明 | 120 | + >[!NOTE] 说明 |
| 121 | >ubsmd进程启动依赖UBSE，该服务启动成功方可加载成功。 | 121 | >ubsmd进程启动依赖UBSE，该服务启动成功方可加载成功。 |
| 122 | 122 | ||
| 123 | 6. 查看ubsmd状态。 | 123 | 6. 查看ubsmd状态。 |
| @@ -150,7 +150,7 @@ | |||
| 150 | dnf remove ubs-mem-shmem | 150 | dnf remove ubs-mem-shmem |
| 151 | ``` | 151 | ``` |
| 152 | 152 | ||
| 153 | - >[!CAUTION]注意 | 153 | + >[!CAUTION] 注意 |
| 154 | > | 154 | > |
| 155 | >- 卸载会自动停止ubsmd并释放占用的远端内存，因此在卸载ubsmd时，应确保UBSE正常运行且无业务正在进行。 | 155 | >- 卸载会自动停止ubsmd并释放占用的远端内存，因此在卸载ubsmd时，应确保UBSE正常运行且无业务正在进行。 |
| 156 | >- 为了避免权限问题，卸载后用户和用户组ubsmd将会保留。 | 156 | >- 为了避免权限问题，卸载后用户和用户组ubsmd将会保留。 |