CUDA Samples: approximate image reverse

以下CUDA sample是分别用C++和CUDA实现的对图像进行某种类似reverse的操作，并对其中使用到的CUDA函数进行了解说，各个文件内容如下：

common.hpp:

#ifndef FBC_CUDA_TEST_COMMON_HPP_
#define FBC_CUDA_TEST_COMMON_HPP_#include<random>
#include <opencv2/opencv.hpp>template< typename T >
static inline int check_Cuda(T result, const char * const func, const char * const file, const int line)
{if (result) {fprintf(stderr, "Error CUDA: at %s: %d, error code=%d, func: %s\n", file, line, static_cast<unsigned int>(result), func);cudaDeviceReset(); // Make sure we call CUDA Device Reset before exitingreturn -1;}
}template< typename T >
static inline int check(T result, const char * const func, const char * const file, const int line)
{if (result) {fprintf(stderr, "Error: at %s: %d, error code=%d, func: %s\n", file, line, static_cast<unsigned int>(result), func);return -1;}
}#define checkCudaErrors(val) check_Cuda((val), __FUNCTION__, __FILE__, __LINE__)
#define checkErrors(val) check((val), __FUNCTION__, __FILE__, __LINE__)#define CHECK(x) { \if (x) {} \else { fprintf(stderr, "Check Failed: %s, file: %s, line: %d\n", #x, __FILE__, __LINE__); return -1; } \
}#define PRINT_ERROR_INFO(info) { \fprintf(stderr, "Error: %s, file: %s, func: %s, line: %d\n", #info, __FILE__, __FUNCTION__, __LINE__); \return -1; }#define EPS_ 1.0e-4 // ε(Epsilon),非常小的数
#define PI 3.1415926535897932f
#define INF 2.e10fstatic inline void generator_random_number(float* data, int length, float a = 0.f, float b = 1.f)
{std::random_device rd; std::mt19937 generator(rd()); // 每次产生不固定的不同的值//std::default_random_engine generator; // 每次产生固定的不同的值std::uniform_real_distribution<float> distribution(a, b);for (int i = 0; i < length; ++i) {data[i] = distribution(generator);}
}template<typename T> // unsigned char, char, int , short
static inline void generator_random_number(T* data, int length, T a = (T)0, T b = (T)1)
{std::random_device rd; std::mt19937 generator(rd()); // 每次产生不固定的不同的值//std::default_random_engine generator; // 每次产生固定的不同的值std::uniform_int_distribution<int> distribution(a, b);for (int i = 0; i < length; ++i) {data[i] = static_cast<T>(distribution(generator));}
}static int save_image(const cv::Mat& mat1, const cv::Mat& mat2, int width, int height, const std::string& name)
{CHECK(mat1.type() == mat2.type());cv::Mat src1, src2, dst;cv::resize(mat1, src1, cv::Size(width / 2, height));cv::resize(mat2, src2, cv::Size(width / 2, height));dst = cv::Mat(height, width / 2 * 2, mat1.type());cv::Mat tmp = dst(cv::Rect(0, 0, width / 2, height));src1.copyTo(tmp);tmp = dst(cv::Rect(width / 2, 0, width / 2, height));src2.copyTo(tmp);cv::imwrite(name, dst);
}template<typename T>
static inline int compare_result(const T* src1, const T* src2, int length)
{CHECK(src1);CHECK(src2);int count{ 0 };for (int i = 0; i < length; ++i) {if (fabs(src1[i] - src2[i]) > EPS_) {if (typeid(float).name() == typeid(T).name() || typeid(double).name() == typeid(T).name())fprintf(stderr, "index: %d, val1: %f, val2: %f\n", i, src1[i], src2[i]);elsefprintf(stderr, "index: %d, val1: %d, val2: %d\n", i, src1[i], src2[i]);++count;}if (count > 100) return -1;}return 0;
}#endif // FBC_CUDA_TEST_COMMON_HPP_

funset.cpp:

#include "funset.hpp"
#include <random>
#include <iostream>
#include <vector>
#include <memory>
#include <string>
#include <algorithm>
#include "common.hpp"int test_image_reverse()
{std::string image_name{ "E:/GitCode/CUDA_Test/test_images/lena.png" };cv::Mat matSrc = cv::imread(image_name);CHECK(matSrc.data);cv::cvtColor(matSrc, matSrc, CV_BGR2GRAY);const int width{ 1511 }, height{ 1473 };const auto length = width * height;cv::resize(matSrc, matSrc, cv::Size(width, height));cv::Mat matTmp1;matSrc.convertTo(matTmp1, CV_32FC1);float elapsed_time1{ 0.f }, elapsed_time2{ 0.f }; // millisecondsconst std::vector<int> vec{ 5, 7};std::unique_ptr<float[]> dst1(new float[length]), dst2(new float[length]);std::for_each(dst1.get(), dst1.get() + length, [](float& n) {n = 0.f; });std::for_each(dst2.get(), dst2.get() + length, [](float& n) {n = 0.f; });int ret = image_reverse_cpu((float*)matTmp1.data, dst1.get(), length, vec, &elapsed_time1);if (ret != 0) PRINT_ERROR_INFO(image_reverse_cpu);ret = image_reverse_gpu((float*)matTmp1.data, dst2.get(), length, vec, &elapsed_time2);if (ret != 0) PRINT_ERROR_INFO(image_reverse_gpu);compare_result(dst1.get(), dst2.get(), length);cv::Mat matTmp2(height, width, CV_32FC1, dst2.get()), matDst;matTmp2.convertTo(matDst, CV_8UC1);save_image(matSrc, matDst, 400, 200, "E:/GitCode/CUDA_Test/test_images/image_reverse.png");fprintf(stderr, "test image reverse: cpu run time: %f ms, gpu run time: %f ms\n", elapsed_time1, elapsed_time2);return 0;
}

image_reverse.cpp:

#include "funset.hpp"
#include <chrono>
#include <algorithm>int image_reverse_cpu(const float* src, float* dst, int length, const std::vector<int>& vec, float* elapsed_time)
{auto start = std::chrono::steady_clock::now();for (int i = 0; i < length; ++i) {auto index1 = (i / vec[0]) % vec[1];auto index2 = vec[0] * (vec[1] - 2 * index1 - 1) + i;index2 = std::max(0, std::min(length - 1, index2));dst[index2] = src[i];}auto end = std::chrono::steady_clock::now();auto duration = std::chrono::duration_cast<std::chrono::nanoseconds>(end - start);*elapsed_time = duration.count() * 1.0e-6;return 0;
}

image_reverse.cu:

#include "funset.hpp"
#include <iostream>
#include <cuda_runtime.h> // For the CUDA runtime routines (prefixed with "cuda_")
#include <device_launch_parameters.h>
#include "common.hpp"/* __device__: 函数类型限定符,表明被修饰的函数在设备上执行，只能从设备上调用，
但只能在其它__device__函数或者__global__函数中调用；__device__函数不支持递归；
__device__函数的函数体内不能声明静态变量；__device__函数的参数数目是不可变化的;
不能对__device__函数取指针 */
__device__ static int min_(int a, int b)
{return a > b ? b : a;
}__device__ static int max_(int a, int b)
{return a > b ? a : b;
}/* __global__: 函数类型限定符;在设备上运行;在主机端调用,计算能力3.2及以上可以在
设备端调用;声明的函数的返回值必须是void类型;对此类型函数的调用是异步的,即在
设备完全完成它的运行之前就返回了;对此类型函数的调用必须指定执行配置,即用于在
设备上执行函数时的grid和block的维度,以及相关的流(即插入<<<   >>>运算符);
a kernel,表示此函数为内核函数(运行在GPU上的CUDA并行计算函数称为kernel(内核函
数),内核函数必须通过__global__函数类型限定符定义);*/
__global__ static void image_reverse(const float* src, float* dst, int length, int vec0, int vec1)
{/* gridDim: 内置变量,用于描述线程网格的维度,对于所有线程块来说,这个变量是一个常数,用来保存线程格每一维的大小,即每个线程格中线程块的数量.一个grid最多只有二维,为dim3类型；blockDim: 内置变量,用于说明每个block的维度与尺寸.为dim3类型,包含了block在三个维度上的尺寸信息;对于所有线程块来说,这个变量是一个常数,保存的是线程块中每一维的线程数量;blockIdx: 内置变量,变量中包含的值就是当前执行设备代码的线程块的索引;用于说明当前thread所在的block在整个grid中的位置,blockIdx.x取值范围是[0,gridDim.x-1],blockIdx.y取值范围是[0, gridDim.y-1].为uint3类型,包含了一个block在grid中各个维度上的索引信息;threadIdx: 内置变量,变量中包含的值就是当前执行设备代码的线程索引;用于说明当前thread在block中的位置;如果线程是一维的可获取threadIdx.x,如果是二维的还可获取threadIdx.y,如果是三维的还可获取threadIdx.z;为uint3类型,包含了一个thread在block中各个维度的索引信息 */auto index = threadIdx.x + blockIdx.x * blockDim.x;while (index < length) {auto index1 = (index / vec0) % vec1;auto index2 = vec0 * (vec1 - 2 * index1 - 1) + index;index2 = max_(0, min_(length - 1, index2));dst[index2] = src[index];index += blockDim.x * gridDim.x;}
}int image_reverse_gpu(const float* src, float* dst, int length, const std::vector<int>& vec, float* elapsed_time)
{/* cudaEvent_t: CUDA event types,结构体类型, CUDA事件,用于测量GPU在某个任务上花费的时间,CUDA中的事件本质上是一个GPU时间戳,由于CUDA事件是在GPU上实现的,因此它们不适于对同时包含设备代码和主机代码的混合代码计时*/cudaEvent_t start, stop;// cudaEventCreate: 创建一个事件对象,异步启动cudaEventCreate(&start);cudaEventCreate(&stop);// cudaEventRecord: 记录一个事件,异步启动,start记录起始时间cudaEventRecord(start, 0);float *d_src{ nullptr }, *d_dst{ nullptr };// cudaMalloc: 在设备端分配内存cudaMalloc(&d_src, length * sizeof(float));cudaMalloc(&d_dst, length * sizeof(float));/* cudaMemcpy: 在主机端和设备端拷贝数据,此函数第四个参数仅能是下面之一:(1). cudaMemcpyHostToHost: 拷贝数据从主机端到主机端(2). cudaMemcpyHostToDevice: 拷贝数据从主机端到设备端(3). cudaMemcpyDeviceToHost: 拷贝数据从设备端到主机端(4). cudaMemcpyDeviceToDevice: 拷贝数据从设备端到设备端(5). cudaMemcpyDefault: 从指针值自动推断拷贝数据方向,需要支持统一虚拟寻址(CUDA6.0及以上版本)cudaMemcpy函数对于主机是同步的 */cudaMemcpy(d_src, src, length * sizeof(float), cudaMemcpyHostToDevice);cudaMemcpy(d_dst, dst, length * sizeof(float), cudaMemcpyHostToDevice);/* <<< >>>: 为CUDA引入的运算符,指定线程网格和线程块维度等,传递执行参数给CUDA编译器和运行时系统,用于说明内核函数中的线程数量,以及线程是如何组织的;尖括号中这些参数并不是传递给设备代码的参数,而是告诉运行时如何启动设备代码,传递给设备代码本身的参数是放在圆括号中传递的,就像标准的函数调用一样;不同计算能力的设备对线程的总数和组织方式有不同的约束;必须先为kernel中用到的数组或变量分配好足够的空间,再调用kernel函数,否则在GPU计算时会发生错误,例如越界等;使用运行时API时,需要在调用的内核函数名与参数列表直接以<<<Dg,Db,Ns,S>>>的形式设置执行配置,其中：Dg是一个dim3型变量,用于设置grid的维度和各个维度上的尺寸.设置好Dg后,grid中将有Dg.x*Dg.y个block,Dg.z必须为1;Db是一个dim3型变量,用于设置block的维度和各个维度上的尺寸.设置好Db后,每个block中将有Db.x*Db.y*Db.z个thread;Ns是一个size_t型变量,指定各块为此调用动态分配的共享存储器大小,这些动态分配的存储器可供声明为外部数组(extern __shared__)的其他任何变量使用;Ns是一个可选参数,默认值为0;S为cudaStream_t类型,用于设置与内核函数关联的流.S是一个可选参数,默认值0. */image_reverse << <512, 512 >> >(d_src, d_dst, length, vec[0], vec[1]);cudaMemcpy(dst, d_dst, length * sizeof(float), cudaMemcpyDeviceToHost);// cudaEventRecord: 记录一个事件,异步启动,stop记录结束时间cudaEventRecord(stop, 0);// cudaEventSynchronize: 事件同步,等待一个事件完成,异步启动cudaEventSynchronize(stop);// cudaEventElapseTime: 计算两个事件之间经历的时间,单位为毫秒,异步启动cudaEventElapsedTime(elapsed_time, start, stop);// cudaEventDestroy: 销毁事件对象,异步启动cudaEventDestroy(start);cudaEventDestroy(stop);return 0;
}

结果图如下：

执行结果如下：在CUDA核函数中，当index2会取到相同的值时，可能会导致c++与gpu对图像的某个像素值取值不同，对此种情况的处理，后面待进一步分析。