---
title: kupl_memcpy2d_async
description: "二维异步内存拷贝，异步地将src位置的内存拷贝到dst位置。"
url: https://www.hikunpeng.com/document/detail/zh/kunpenghpcs/hpckit/devg/KunpengHPCKit_developer_077.html
sourcePath: /source/zh/kunpenghpcs/hpckit/devg/KunpengHPCKit_developer_077.html
indexId: c66d7ee260d0781c722923010c5686d0ccb99cc34fe0074dce67389ad4b3613e67
---
# kupl_memcpy2d_async

二维异步内存拷贝，异步地将src位置的内存拷贝到dst位置。

#### 接口定义

int kupl_memcpy2d_async(void *dst, size_t dpitch, const void *src, size_t spitch, size_t width, size_t height, kupl_queue_h queue, kupl_event_h event);

- 当前kupl memcpy2d_async支持的最大宽、高、搬运间隔均不超过UINT32_MAX，即width、spitch-width、dpitch-width、height上限为UINT32_MAX。。
- spitch*height 与dpitch*height 需要分别小于 src 和 dst 所指向内存的真实大小。


#### 环境变量

KUPL通过环境变量KUPL_MEMCPY_MT_THRESHOLD与KUPL_SDMA_MEMCPY_THRESHOLD来确认多线程memcpy能力的包大小阈值以及sdma memcpy能力的包大小阈值。多线程memcpy阈值默认为512KB，sdma memcpy阈值默认为2MB。

kupl二维异步memcpy共实现3种memcpy方法：单线程glibc memcpy方法、sdma memcpy方法及多线程memcpy方法；当环境中使能sdma时，默认选取sdma memcpy方法；当环境中没有sdma时，通过KUPL_MEMCPY_MT_THRESHOLD阈值选取memcpy方法，即拷贝的数据包长小于阈值时，进行glibc memcpy，否则进行多线程memcpy。

用户可以通过配置KUPL_MEMCPY_MT_THRESHOLD来设置多线程memcpy的阈值；kupl_memcpy_async接口也采用上述环境变量配置方式控制memcpy方法的选取。


#### 参数


**表1 参数定义**

| 参数名 | 类型 | 描述 | 输入/输出 |
| --- | --- | --- | --- |
| dst | void \* | 指向存储复制内容的目标内存位置的指针 | 输入/输出 |
| dpitch | size\_t | 目标内存的间距，即每存储width数据的偏移量 | 输入 |
| src | const void \* | 指向要复制的源内存位置的指针 | 输入 |
| spitch | size\_t | 源内存的间距，即每取出width数据的偏移量 | 输入 |
| width | size\_t | 需要拷贝的内存的宽 | 输入 |
| height | size\_t | 需要拷贝的内存的高 | 输入 |
| queue | kupl\_queue\_h | 需要将二维memcpy任务提交到的队列 | 输入 |
| event | kupl\_event\_h | 传递event任务的参数，用于后续同步 | 输入/输出 |


#### 返回值

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


#### 示例

```
#include <stdio.h> 
#include <stdlib.h>
#include <assert.h>
#include "kupl.h" 

int main() 
{ 
    int len = 65536; 
    double *src = (double *)kupl_malloc(KUPL_MEM_DEFAULT, len);
    double *dest = (double *)kupl_malloc(KUPL_MEM_DEFAULT, len);
    if (src == nullptr || dest == nullptr) {
        goto malloc_error;
    }
    for (int i = 0; i < len / sizeof(double); i++) {
        src[i] = i ;
        dest[i] = 0;
    }
    int height = 2, width = 200;
    int spitch = 300, dpitch = 400;
    kupl_queue_h queue = kupl_queue_create();
    kupl_event_h event = kupl_event_create();
    if (queue == nullptr || event == nullptr) {
        goto queue_event_error;
    }
    int ret = kupl_memcpy2d_async(dest, dpitch, src, spitch, width, height, queue, event);
    assert(ret == KUPL_OK);
    kupl_event_wait(event);
queue_event_error:
    kupl_event_destroy(event);
    kupl_queue_destroy(queue);
malloc_error:
    kupl_free(KUPL_MEM_DEFAULT, src);
    kupl_free(KUPL_MEM_DEFAULT, dest); 
    return 0; 
}
```


- 上述示例演示了异步二维内存拷贝的流程。
- 上述kupl_memcpy2d_async函数异步地将src数组中的内容复制到dest数组，其中src位置的数据每取出width数据的偏移量为300。
- dest位置的数据每存储width数据的偏移量为400。
- 拷贝数据的宽和高分别为200和2。
- 上述kupl_memcpy_async函数将src数组中的内容异步地复制到dest数组，其中复制的内存大小为len，其中event用于异步拷贝、后续的同步。
- 由于实际上只有sdma memcpy实现了真正的异步memcpy，因此在执行其余memcpy方法时，将打印warning信息。