---
title: kupl_shm_win_alloc
description: "为指定kupl comm的每个进程分配一块等长共享内存空间，可通过kupl win访问。"
url: https://www.hikunpeng.com/document/detail/zh/kunpenghpcs/hpckit/devg/KunpengHPCKit_developer_090.html
sourcePath: /source/zh/kunpenghpcs/hpckit/devg/KunpengHPCKit_developer_090.html
indexId: 1a1d210bd8c4aa1b44f2935d1d5cbe444eec8ff690d34bc7dcbffd6df08cb20e67
---
# kupl_shm_win_alloc

为指定kupl comm的每个进程分配一块等长共享内存空间，可通过kupl win访问。

#### 接口定义

int kupl_shm_win_alloc(size_t size, kupl_shm_comm_h comm, void **baseptr, kupl_shm_win_h *win)


#### 环境变量

使用环境变量 KUPL_SHM_TYPE 控制共享内存底层实现方式。

可选值：

- posix（默认）
- sls

当共享内存底层实现为sls的情况下，可以使用环境变量KUPL_SHM_ENABLE_HUGEPAGE和KUPL_SHM_ON_PACKAGE来控制是否使能共享内存申请大页和是否使能共享内存申请高带宽内存。

KUPL_SHM_ENABLE_HUGEPAGE，默认值为n，代表不启用内存大页分配；y则代表在启用sls作为共享内存底层实现方式的情况下，启用共享内存大页分配。

KUPL_SHM_ON_PACKAGE，默认值为n，代表不启用高带宽内存分配；y则代表在启用sls作为共享内存底层实现方式的情况下，启用高带宽内存分配。


#### 参数


**表1 参数定义**

| 参数名 | 类型 | 描述 | 输入/输出 |
| --- | --- | --- | --- |
| size | size\_t | 共享内存空间字节大小 | 输入 |
| comm | kupl\_shm\_comm\_h | kupl通信域 | 输入 |
| baseptr | void \*\* | 进程共享内存块的首地址 | 输出 |
| win | kupl\_shm\_win\_h \* | 需要创建的window对象 | 输出 |


#### 返回值

- 成功：返回KUPL_OK
- 失败：返回KUPL_ERROR


#### 示例

```
#include <stdio.h>
#include <mpi.h>
#include <string.h>
#include <unistd.h>
#include "kupl.h"
 
// 创建 kupl 通信域需要的回调函数 1
static int oob_barrier_callback(void *group)
{
    return MPI_Barrier((MPI_Comm)group);
}
// 创建 kupl 通信域需要的回调函数 2
static int oob_allgather_callback(const void *sendbuf, void *recvbuf, int size, void *group,
                                  kupl_shm_datatype_t datatype)
{
    switch (datatype) {
        case KUPL_SHM_DATATYPE_CHAR:
            return MPI_Allgather(sendbuf, size, MPI_CHAR, recvbuf, size, MPI_CHAR, (MPI_Comm)group);
        default:
            fprintf(stderr, "not support datatype");
            return KUPL_ERROR;
    }
}
int main(int argc, char *argv[])
{
    // 初始化 MPI 环境
    MPI_Init(&argc, &argv);
    MPI_Comm comm = MPI_COMM_WORLD;
    // 获取 MPI 通信域大小
    int world_size;
    MPI_Comm_size(comm, &world_size);
    // 获取进程 rank 号
    int world_rank;
    MPI_Comm_rank(comm, &world_rank);
    // 获取进程 pid 号
    int pid = getpid();
    // 创建 kupl 通信域
    kupl_shm_oob_cb_t oob_cbs;
    kupl_shm_oob_cb_h oob_cbs_h = &oob_cbs;
    oob_cbs_h->oob_allgather = oob_allgather_callback;
    oob_cbs_h->oob_barrier = oob_barrier_callback;
    kupl_shm_comm_h kupl_comm;
    int ret = kupl_shm_comm_create(world_size, world_rank, pid, oob_cbs_h, (void *)comm, &kupl_comm);
    if (ret != KUPL_OK || kupl_comm == NULL) {
        fprintf(stderr, "kupl shm comm create failed: %d\n", ret);
        return -1;
    }
    // 申请共享内存
    kupl_shm_win_h win;
    void *local_buffer;
    int count = 4;
    size_t buf_size = count * sizeof(int);
    ret = kupl_shm_win_alloc(buf_size, kupl_comm, &local_buffer, &win);
    if (ret != KUPL_OK) {
        fprintf(stderr, "kupl shm win alloc failed: %d\n", ret);
        return -1;
    }
    // 进程 0 对本进程 buffer 赋值
    if (world_rank == 0) {
        for (int i = 0; i < count; i++) {
            ((int *)local_buffer)[i] = i;
        }
    }
    // 所有其他进程获取进程 0 的 buffer，进行 memcpy
    if (world_rank != 0) {
        void *remote_buffer;
        int remote_rank = 0;
        kupl_shm_win_query(win, remote_rank, &remote_buffer);
        memcpy(local_buffer, remote_buffer, buf_size);
        // 检查是否成功 memcpy
        bool check = true;
        for (int i = 0; i < count; i++) {
            if (((int *)local_buffer)[i] != i) {
                check = false;
                break;
            }
        }
        if (check) {
            printf("check success\n");
        } else {
            printf("check fail\n");
        }
    }
    // 销毁共享内存
    kupl_shm_win_free(win);
    // 销毁 kupl 通信域
    kupl_shm_comm_destroy(kupl_comm);
    MPI_Finalize();
    return 0;
}
```

运行结果如下。

```
check success
```

上述示例演示了创建、查询、清理一个kupl win的流程。kupl_shm_win_alloc函数创建一个kupl win。