cufile_sample_utils.h

/*
 * Copyright 2019 NVIDIA Corporation.  All rights reserved.
 *
 * Please refer to the NVIDIA end user license agreement (EULA) associated
 * with this source code for terms and conditions that govern your use of
 * this software. Any use, reproduction, disclosure, or distribution of
 * this software and related documentation outside the terms of the EULA
 * is strictly prohibited.
 *
 */

#ifndef __CUFILE_SAMPLE_UTILS_H_
#define __CUFILE_SAMPLE_UTILS_H_

#include <cassert>
#include <cstring>
#include <random>
#include <chrono>
#include <fstream>
#include <iostream>
#include <stdexcept>

#include <sys/stat.h>

#include <openssl/sha.h>
#include <openssl/evp.h>

#include <cuda.h>
#include <cuda_runtime.h>
#include <dlfcn.h>
#define MAX_CHUNK_READ (64 * 1024UL)

#define check_cudadrivercall(fn) \
	do { \
		CUresult res = fn; \
		if (res != CUDA_SUCCESS) { \
			const char *str = nullptr; \
			cuGetErrorName(res, &str); \
			std::cerr << "cuda driver api call failed " << #fn \
				<< " res : "<< res << ", " <<  __LINE__ << ":" << str << std::endl; \
			std::cerr << "EXITING program!!!" << std::endl; \
			exit(1); \
		} \
	} while(0)

#define check_cudaruntimecall(fn) \
	do { \
		cudaError_t res = fn; \
		if (res != cudaSuccess) { \
			const char *str = cudaGetErrorName(res); \
			std::cerr << "cuda runtime api call failed " << #fn \
				<<  __LINE__ << ":" << str << std::endl; \
			std::cerr << "EXITING program!!!" << std::endl; \
			exit(1); \
		} \
	} while(0)

struct Prng {
	long rmax_;
	std::mt19937 rand_;
	std::uniform_int_distribution<long> dist_;
	Prng(long rmax) :
		rmax_(rmax),
		rand_(std::chrono::high_resolution_clock::now().time_since_epoch().count()),
		dist_(std::uniform_int_distribution<long>(0, rmax_))
		{}
	long next_random_offset(void) {
		return dist_(rand_);
	}
};

//
// cuda driver error description
//
static inline const char *GetCuErrorString(CUresult curesult) {
	const char *descp;
	if (cuGetErrorName(curesult, &descp) != CUDA_SUCCESS)
		descp = "unknown cuda error";
	return descp;
}

//
// cuda runtime error description
//
static inline const char *GetCudaErrorString(cudaError_t cudaerr) {
	return cudaGetErrorName(cudaerr);
}


//
// cuFile APIs return both cuFile specific error codes as well as POSIX error codes
// for ease, the below template can be used for getting the error description depending
// on its type.

// POSIX
template<class T,
	typename std::enable_if<std::is_integral<T>::value, std::nullptr_t>::type = nullptr>
std::string cuFileGetErrorString(T status) {
	status = std::abs(status);
	return IS_CUFILE_ERR(status) ?
		std::string(CUFILE_ERRSTR(status)) : std::string(std::strerror(status));
}

// CUfileError_t
template<class T,
	typename std::enable_if<!std::is_integral<T>::value, std::nullptr_t>::type = nullptr>
std::string cuFileGetErrorString(T status) {
	std::string errStr = cuFileGetErrorString(static_cast<int>(status.err));
	if (IS_CUDA_ERR(status))
		errStr.append(".").append(GetCuErrorString(status.cu_err));
	return errStr;
}
#define GDSTOOLS_CRYPTO_LIB_A "libcrypto.so.1.1"
#define GDSTOOLS_CRYPTO_LIB_B "libcrypto.so.10"
#define GDSTOOLS_CRYPTO_LIB_C "libssl.so.3"
bool LoadMD5Symbols();
void UnLoSHA256Symbols();

bool ssl_lib_v3 = false;

typedef int (*SHA256_Init_func_v1) (SHA256_CTX *c);
typedef int (*SHA256_Update_func_v1) (SHA256_CTX *c, const void *data, size_t len);
typedef int (*SHA256_Final_func_v1) (unsigned char *md, SHA256_CTX *c);
typedef int (*SHA256_Init_func_v3) (EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);
typedef int (*SHA256_Update_func_v3) (EVP_MD_CTX *ctx, const void *d, size_t cnt);
typedef int (*SHA256_Final_func_v3) (EVP_MD_CTX *ctx, unsigned char *md, unsigned int *s);
typedef EVP_MD_CTX *(*SHA256_Mdctx_create_func)();
typedef void (*SHA256_Mdctx_destroy_func)(EVP_MD_CTX *c);
typedef EVP_MD *(*SHA256_get_digestbyname_func)(const char *name);

static void *SHA256_lib_handle = NULL;
static SHA256_Init_func_v1 SHA256_Init_v1_p = NULL;
static SHA256_Update_func_v1 SHA256_Update_v1_p = NULL;
static SHA256_Final_func_v1 SHA256_Final_v1_p = NULL;
static SHA256_Init_func_v3 SHA256_Init_v3_p = NULL;
static SHA256_Update_func_v3 SHA256_Update_v3_p = NULL;
static SHA256_Final_func_v3 SHA256_Final_v3_p = NULL;

static SHA256_Mdctx_create_func SHA256_Mdctx_create_p = NULL;
static SHA256_Mdctx_destroy_func SHA256_Mdctx_destroy_p = NULL;
static SHA256_get_digestbyname_func SHA256_get_digestbyname_p = NULL;

bool LoadSHA256Symbols()
{
	SHA256_lib_handle = dlopen(GDSTOOLS_CRYPTO_LIB_C, RTLD_GLOBAL| RTLD_NOW);
	if(SHA256_lib_handle != NULL) {
		ssl_lib_v3 = true;
		goto load_sha256_symbols;
	}
	SHA256_lib_handle = dlopen(GDSTOOLS_CRYPTO_LIB_A, RTLD_GLOBAL| RTLD_NOW);
	if(SHA256_lib_handle != NULL) {
		goto load_sha256_symbols;
	}
	SHA256_lib_handle = dlopen(GDSTOOLS_CRYPTO_LIB_B, RTLD_GLOBAL| RTLD_NOW);
	if(SHA256_lib_handle != NULL) {
		goto load_sha256_symbols;
	}
	if(SHA256_lib_handle == NULL) {
		std::cout << "Please install" << GDSTOOLS_CRYPTO_LIB_A << " or " << GDSTOOLS_CRYPTO_LIB_B << " or " << GDSTOOLS_CRYPTO_LIB_A << "depending on your platform " << std::endl;
                return false;
	}

load_sha256_symbols:	
	if (!ssl_lib_v3) {
		SHA256_Init_v1_p = (SHA256_Init_func_v1) dlsym(SHA256_lib_handle, "SHA256_Init");
		if(SHA256_Init_v1_p == NULL) {
			goto error;
		}

		SHA256_Update_v1_p = (SHA256_Update_func_v1) dlsym(SHA256_lib_handle, "SHA256_Update");
		if(SHA256_Update_v1_p == NULL) {
			goto error;
		}

		SHA256_Final_v1_p = (SHA256_Final_func_v1) dlsym(SHA256_lib_handle, "SHA256_Final");
		if(SHA256_Final_v1_p == NULL) {
			goto error;
		}
	} else {
		SHA256_Init_v3_p = (SHA256_Init_func_v3) dlsym(SHA256_lib_handle, "EVP_DigestInit_ex");
		if(SHA256_Init_v3_p == NULL) {
			std::cout << "Unable to load EVP_DigestInit_ex symbols" << std::endl;
			goto error;
		}

		SHA256_Update_v3_p = (SHA256_Update_func_v3) dlsym(SHA256_lib_handle, "EVP_DigestUpdate");
		if(SHA256_Update_v3_p == NULL) {
			std::cout << "Unable to load EVP_DigestUpdate symbols" << std::endl;
			goto error;
		}

		SHA256_Final_v3_p = (SHA256_Final_func_v3) dlsym(SHA256_lib_handle, "EVP_DigestFinal_ex");
		if(SHA256_Final_v3_p == NULL) {
			std::cout << "Unable to load EVP_DigestFinal_ex symbols" << std::endl;
			goto error;
		}
		SHA256_Mdctx_create_p = (SHA256_Mdctx_create_func) dlsym(SHA256_lib_handle, "EVP_MD_CTX_new");
		if(SHA256_Mdctx_create_p == NULL) {
			std::cout << "Unable to load EVP_MD_CTX_new symbols" << std::endl;
			goto error;
		}
		SHA256_Mdctx_destroy_p = (SHA256_Mdctx_destroy_func) dlsym(SHA256_lib_handle, "EVP_MD_CTX_free");
		if(SHA256_Mdctx_destroy_p == NULL) {
			std::cout << "Unable to load EVP_MD_CTX_free symbols" << std::endl;
			goto error;
		}
		SHA256_get_digestbyname_p = (SHA256_get_digestbyname_func) dlsym(SHA256_lib_handle, "EVP_get_digestbyname");
		if(SHA256_get_digestbyname_p == NULL) {
			std::cout << "Unable to load EVP_get_digestbyname symbols" << std::endl;
			goto error;
		}
	}
        return true;
error:
	std::cout << "Unable to load SHA256 symbols" << std::endl;
        dlclose(SHA256_lib_handle);
        SHA256_lib_handle = NULL;
        SHA256_Init_v1_p = NULL;
        SHA256_Init_v3_p = NULL;
        SHA256_Update_v1_p = NULL;
        SHA256_Update_v3_p = NULL;
        SHA256_Final_v1_p = NULL;
        SHA256_Final_v3_p = NULL;
	SHA256_Mdctx_create_p = NULL;
	SHA256_Mdctx_destroy_p = NULL;
	SHA256_get_digestbyname_p = NULL;
	return false;
}

void UnLoadSHA256Symbols()
{
	if(SHA256_lib_handle) {
		dlclose (SHA256_lib_handle);
		SHA256_lib_handle = NULL;
        }
        return;
}

const EVP_MD *EVP_get_digestbyname_sample(const char *name)
{
	if(SHA256_get_digestbyname_p) {
		return SHA256_get_digestbyname_p(name);
	}
	return NULL;
}
EVP_MD_CTX *SHA256_Mdctx_create_sample()
{
	if(SHA256_Mdctx_create_p) {
		return SHA256_Mdctx_create_p();
	}
	return NULL;
}
void SHA256_Mdctx_destroy_sample(void *c)
{
	if(SHA256_Mdctx_destroy_p) {
		SHA256_Mdctx_destroy_p((EVP_MD_CTX *)c);
	}
	return;
}
int SHA256_Init_sample(void *c)
{
	if (!ssl_lib_v3) {
		if(SHA256_Init_v1_p) {
			return SHA256_Init_v1_p((SHA256_CTX *)c);
		}
		return 0;
	} else {
		if (SHA256_Init_v3_p) {
			return SHA256_Init_v3_p((EVP_MD_CTX *)c, EVP_get_digestbyname_sample("sha256"), NULL);
		} 
		return 0;
	}
	return 0;
}

int SHA256_Update_sample(void *c, const void *data, size_t len)
{
	if (!ssl_lib_v3) {
		if(SHA256_Update_v1_p) {
			return SHA256_Update_v1_p((SHA256_CTX *)c, data, len);
		}
		return 0;
	} else {
		if (SHA256_Update_v3_p) {
			return SHA256_Update_v3_p((EVP_MD_CTX *)c, data, len);
		}
		return 0;
	}
	return 0;
}

int SHA256_Final_sample(unsigned char *md, void *c)
{
	if (!ssl_lib_v3) {
		if(SHA256_Final_v1_p) {
			return SHA256_Final_v1_p(md, (SHA256_CTX *)c);
		}
		return 0;
	} else {
		if (SHA256_Final_v3_p) {
			unsigned int n;
			return SHA256_Final_v3_p((EVP_MD_CTX *)c, md, &n);
		}
		return 0;
	}
	return 0;
}

// SHASUM routine : computes digest of nbytes of a file
static inline int SHASUM256(const char *fpath, unsigned char md[SHA256_DIGEST_LENGTH],
		size_t bytes = 0) {
	size_t size;
	SHA256_CTX ctx, *c;
	c = &ctx;
	EVP_MD_CTX *evp_c;

	char buf[MAX_CHUNK_READ];
	std::ifstream fp(fpath, std::ifstream::in | std::ifstream::binary);

	if (!fp.is_open()) {
		std::cerr << "file open failed" << std::endl;
		return -1;
	}

	fp.seekg(0, fp.end);
	size = fp.tellg();
	fp.seekg(0, fp.beg);

	if (!size) {
		fp.close();
		std::cerr << "file is empty" << std::endl;
		return -1;
	}

	if (bytes > size) {
		fp.close();
		std::cerr << bytes << ":" << size << std::endl;
		std::cerr << "bytes more than file size" << std::endl;
		return -1;
	}

	if (!bytes)
		bytes = size;
	
	if(LoadSHA256Symbols() == false) {
		std::cerr << "libcrypto not loaded" << std::endl;
                return -1;
	}

	if (ssl_lib_v3) {
		if ((evp_c = SHA256_Mdctx_create_sample()) == NULL) {
			std::cerr << "MD context creation failed" << std::endl;
			return -1;
		}
		SHA256_Init_sample((void *)evp_c);
	} else {
		SHA256_Init_sample((void *)c);
	}
	while (bytes && !fp.eof()) {
		size = std::min(bytes, MAX_CHUNK_READ);
		fp.read(buf, size);
		if (!ssl_lib_v3) {
			SHA256_Update_sample((void *)c, buf, fp.gcount());
		} else {
			SHA256_Update_sample((void *)evp_c, buf, fp.gcount());
		}
		bytes -= size;
	}

	fp.close();

	if (!ssl_lib_v3) {
		SHA256_Final_sample(md, (void *)c);
	} else {
		SHA256_Final_sample(md, (void *)evp_c);
	}
	if (ssl_lib_v3) {
		SHA256_Mdctx_destroy_sample((void *)evp_c);
	}
	UnLoadSHA256Symbols();
	return 0;
}

// SHASUM routine : computes digest of nbytes from a device memory region
static inline int SHASUM256_DEVICEMEM(char *devPtr,
                         size_t memSize,
                         unsigned char md[SHA256_DIGEST_LENGTH],
                         size_t devPtrOff,
                         size_t bytes = 0) {
	size_t size;
	SHA256_CTX ctx, *c;
	c = &ctx;
	EVP_MD_CTX *evp_c;

	char buf[MAX_CHUNK_READ];
	char *devbuf = devPtr + devPtrOff;

	size = memSize - devPtrOff;
	if (!size || size < 0) {
		std::cerr << "invalid parameters" << std::endl;
		return -1;
	}

	if (bytes > size) {
		std::cerr << bytes << ":" << size << std::endl;
		std::cerr << "bytes more than size" << std::endl;
		return -1;
	}

	if (!bytes)
		bytes = size;
	
	if(LoadSHA256Symbols() == false) {
		std::cerr << "libcrypto not loaded" << std::endl;
		return -1;
	}

	if (ssl_lib_v3) {
		if ((evp_c = SHA256_Mdctx_create_sample()) == NULL) {
			std::cerr << "MD context creation failed" << std::endl;
			return -1;
		}
		SHA256_Init_sample((void *)evp_c);
	} else {
		SHA256_Init_sample((void *)c);
	}

	while (bytes) {
		size = std::min(bytes, MAX_CHUNK_READ);
		cudaMemcpy(buf, devbuf, size, cudaMemcpyDeviceToHost);
		if (!ssl_lib_v3) {
			SHA256_Update_sample((void *)c, buf, size);
		} else {
			SHA256_Update_sample((void *)evp_c, buf, size);
		}
		bytes -= size;
		devbuf += size;
	}

	if (!ssl_lib_v3) {
		SHA256_Final_sample(md, (void *)c);
	} else {
		SHA256_Final_sample(md, (void *)evp_c);
		SHA256_Mdctx_destroy_sample((void *)evp_c);
	}
	UnLoadSHA256Symbols();
	return 0;
}

// SHASUM routine : print
static inline void DumpSHASUM(unsigned char md[SHA256_DIGEST_LENGTH]) {
	for (int i = 0; i < SHA256_DIGEST_LENGTH ; i++)
		std::cout << std::hex << static_cast<int>(md[i]);
	std::cout << std::dec << std::endl;
}

size_t GetFileSize(int fd) {
	int ret;
	struct stat st;

	ret = fstat(fd, &st);
	return (ret == 0) ? st.st_size : -1;
}
#endif