cuda driver-接口和错误检查

前言

CUDA Driver 是与 GPU 沟通的驱动级别底层 API，对 Driver API 的理解，有利于理解后续的 Runtime API。CUDA Driver 随显卡驱动发布，需要与 cudatoolkit 分开看，CUDA Driver 对应于 cuda.h 和 libcuda.so。Driver API 主要知识点是 Context 的管理机制 以及 CUDA 系列接口的开发习惯（错误检查方法），还有内存模型。

1.基本API

API	Description
cudaInit	用于初始化驱动API
cuDriverGetVersion	用于获取驱动版本
cuDeviceGetName	用于获取设备名称、型号

实例代码如下：

// CUDA驱动头文件cuda.h
#include <cuda.h>
#include <stdio.h>
#include <string.h>

int main()
{
    cuInit(0);

    // 获取 cuda 驱动版本 比如10.2
    int driver_version = 0;
    cuDriverGetVersion(&driver_version);
    printf("CUDA Driver version is <%d>\n", driver_version);

    // 获取当前设备信息
    char device_name[100];
    CUdevice device = 0;
    cuDeviceGetName(device_name, sizeof(device_name), device);
    printf("Device <%d> name is <%s>\n", device, device_name);

    return 0;
}

上述代码展示了使用 CUDA 驱动初始化函数 cuInit 并获取当前 CUDA 驱动版本和设备信息。
cuInit 函数的参数 flags 目前必须为 0，在使用 CUDA 的其它函数之前，必须先调用 cuInit 函数进行初始化，否则其它 CUDA API 函数会返回 CUDA_ERROR_NOT_INITIALIZED 错误。
代码通过调用 cuDriverGetVersion 函数获取当前 CUDA 驱动的版本，调用 cuDeviceGetName 函数获取当前设备的名称。
运行结果如下:

cuinit
CUDA Driver version is <11040>
Device <0> name is <NVIDIA GeForce RTX 3060 Laptop GPU>

2.错误检查

正确友好的检查 cuda 函数的返回值，有利于程序的组织结构，使得代码可读性更好，错误更容易发现。
实例代码如下：

// CUDA驱动头文件cuda.h
#include <cuda.h>
#include <stdio.h>
#include <string.h>

#define checkDriver(op) __check_cuda_driver((op), #op, __FILE__, __LINE__)

bool __check_cuda_driver(CUresult code, const char *op, const char *file, int line)
{

    if (code != CUresult::CUDA_SUCCESS)
    {
        const char *err_name = nullptr;
        const char *err_message = nullptr;
        cuGetErrorName(code, &err_name);// 直接获取错误代码的字符串
        cuGetErrorString(code, &err_message);// 获取错误代码的字符串描述
        printf("%s:%d  %s failed. \n  code = %s, message = %s\n", file, line, op, err_name, err_message);
        return false;
    }
    return true;
}

int main()
{
    if (!checkDriver(cuInit(0)))//cuInit 的意义是初始化驱动 API，如果不执行，则所有 API 都将返回错误，全局执行一次即可
    {
        return -1;
    }

    // 获取 cuda 驱动版本 比如10.2
    int driver_version = 0;
    if (!checkDriver(cuDriverGetVersion(&driver_version)))
    {
        return -1;
    }
    printf("CUDA Driver version is <%d>\n", driver_version);

    // 获取当前设备信息
    char device_name[100];
    CUdevice device = 0;
    if (!checkDriver(cuDeviceGetName(device_name, sizeof(device_name), device)))
    {
        return -1;
    }
    printf("Device <%d> name is <%s>\n", device, device_name);
    return 0;
}

这段代码在 cuInit 驱动初始化案例基础上增加了检查功能，通过宏定义 checkDriver 对 CUDA 驱动初始化和其它 CUDA API 调用进行检查。

宏定义 checkDriver 接受一个操作 op 作为参数。__check_cuda_driver使用变量 code 存储操作 op 的返回结果，如果返回结果不等于 CUDA_SUCCESS，即初始化或其它操作发生错误，就会打印出错误的文件名、行数、函数‘操作名称’错误代码和错误信息，并返回 -1 表示程序执行失败。
假如cudaInit(0)改为cudaInit(1),运行结果如下:

${file_name}.cpp:26 cuInit(1) failed.
code = CUDA_ERROR_INVALID_VALUE, message = invalid argument