NVCC 和 NVRTC 在编译到 PTX 上的区别

Posted

技术标签:

【中文标题】NVCC 和 NVRTC 在编译到 PTX 上的区别【英文标题】:Differences between NVCC and NVRTC on compilation to PTX 【发布时间】:2020-07-12 18:08:34 【问题描述】:

总结

我正在将一个基于 Scratchapixel version 的简单光线追踪应用程序移植到一堆 GPU 库中。我使用运行时 API 和驱动程序 API 成功地将它移植到 CUDA,但是当我尝试使用运行时编译的 PTX 和 NVRTC 时,它会抛出 Segmentation fault (core dumped)。 如果我取消注释内核文件开头的#include <math.h> 指令(见下文),它仍然使用 NVCC 工作(生成的 PTX 完全相同)但使用 NVRTC 编译失败。

我想知道如何使 NVRTC 的行为与 NVCC 一样(甚至有可能吗?),或者至少了解此问题背后的原因。

详细说明

文件kernel.cu(内核源):

//#include <math.h>

#define MAX_RAY_DEPTH 5

template<typename T>
class Vec3

public:
    T x, y, z;
    __device__ Vec3() : x(T(0)), y(T(0)), z(T(0)) 
    __device__ Vec3(T xx) : x(xx), y(xx), z(xx) 
    __device__ Vec3(T xx, T yy, T zz) : x(xx), y(yy), z(zz) 
    __device__ Vec3& normalize()
    
        T nor2 = length2();
        if (nor2 > 0) 
            T invNor = 1 / sqrt(nor2);
            x *= invNor, y *= invNor, z *= invNor;
        
        return *this;
    
    __device__ Vec3<T> operator * (const T &f) const  return Vec3<T>(x * f, y * f, z * f); 
    __device__ Vec3<T> operator * (const Vec3<T> &v) const  return Vec3<T>(x * v.x, y * v.y, z * v.z); 
    __device__ T dot(const Vec3<T> &v) const  return x * v.x + y * v.y + z * v.z; 
    __device__ Vec3<T> operator - (const Vec3<T> &v) const  return Vec3<T>(x - v.x, y - v.y, z - v.z); 
    __device__ Vec3<T> operator + (const Vec3<T> &v) const  return Vec3<T>(x + v.x, y + v.y, z + v.z); 
    __device__ Vec3<T>& operator += (const Vec3<T> &v)  x += v.x, y += v.y, z += v.z; return *this; 
    __device__ Vec3<T>& operator *= (const Vec3<T> &v)  x *= v.x, y *= v.y, z *= v.z; return *this; 
    __device__ Vec3<T> operator - () const  return Vec3<T>(-x, -y, -z); 
    __device__ T length2() const  return x * x + y * y + z * z; 
    __device__ T length() const  return sqrt(length2()); 
;

typedef Vec3<float> Vec3f;
typedef Vec3<bool> Vec3b;

class Sphere

public:
    const char* id;
    Vec3f center;                           /// position of the sphere
    float radius, radius2;                  /// sphere radius and radius^2
    Vec3f surfaceColor, emissionColor;      /// surface color and emission (light)
    float transparency, reflection;         /// surface transparency and reflectivity
    int animation_frame;
    Vec3b animation_position_rand;
    Vec3f animation_position;
    Sphere(
        const char* id,
        const Vec3f &c,
        const float &r,
        const Vec3f &sc,
        const float &refl = 0,
        const float &transp = 0,
        const Vec3f &ec = 0) :
        id(id), center(c), radius(r), radius2(r * r), surfaceColor(sc),
        emissionColor(ec), transparency(transp), reflection(refl)
    
        animation_frame = 0;
    
    //[comment]
    // Compute a ray-sphere intersection using the geometric solution
    //[/comment]
    __device__ bool intersect(const Vec3f &rayorig, const Vec3f &raydir, float &t0, float &t1) const
    
        Vec3f l = center - rayorig;
        float tca = l.dot(raydir);
        if (tca < 0) return false;
        float d2 = l.dot(l) - tca * tca;
        if (d2 > radius2) return false;
        float thc = sqrt(radius2 - d2);
        t0 = tca - thc;
        t1 = tca + thc;

        return true;
    
;

__device__ float mix(const float &a, const float &b, const float &mixval)

    return b * mixval + a * (1 - mixval);


__device__ Vec3f trace(
    const Vec3f &rayorig,
    const Vec3f &raydir,
    const Sphere *spheres,
    const unsigned int spheres_size,
    const int &depth)

    float tnear = INFINITY;
    const Sphere* sphere = NULL;
    // find intersection of this ray with the sphere in the scene
    for (unsigned i = 0; i < spheres_size; ++i) 
        float t0 = INFINITY, t1 = INFINITY;
        if (spheres[i].intersect(rayorig, raydir, t0, t1)) 
            if (t0 < 0) t0 = t1;
            if (t0 < tnear) 
                tnear = t0;
                sphere = &spheres[i];
            
        
    
    // if there's no intersection return black or background color
    if (!sphere) return Vec3f(2);
    Vec3f surfaceColor = 0; // color of the ray/surfaceof the object intersected by the ray
    Vec3f phit = rayorig + raydir * tnear; // point of intersection
    Vec3f nhit = phit - sphere->center; // normal at the intersection point
    nhit.normalize(); // normalize normal direction
    // If the normal and the view direction are not opposite to each other
    // reverse the normal direction. That also means we are inside the sphere so set
    // the inside bool to true. Finally reverse the sign of IdotN which we want
    // positive.
    float bias = 1e-4; // add some bias to the point from which we will be tracing
    bool inside = false;
    if (raydir.dot(nhit) > 0) nhit = -nhit, inside = true;
    if ((sphere->transparency > 0 || sphere->reflection > 0) && depth < MAX_RAY_DEPTH) 
        float facingratio = -raydir.dot(nhit);
        // change the mix value to tweak the effect
        float fresneleffect = mix(pow(1 - facingratio, 3), 1, 0.1);
        // compute reflection direction (not need to normalize because all vectors
        // are already normalized)
        Vec3f refldir = raydir - nhit * 2 * raydir.dot(nhit);
        refldir.normalize();
        Vec3f reflection = trace(phit + nhit * bias, refldir, spheres, spheres_size, depth + 1);
        Vec3f refraction = 0;
        // if the sphere is also transparent compute refraction ray (transmission)
        if (sphere->transparency) 
            float ior = 1.1, eta = (inside) ? ior : 1 / ior; // are we inside or outside the surface?
            float cosi = -nhit.dot(raydir);
            float k = 1 - eta * eta * (1 - cosi * cosi);
            Vec3f refrdir = raydir * eta + nhit * (eta *  cosi - sqrt(k));
            refrdir.normalize();
            refraction = trace(phit - nhit * bias, refrdir, spheres, spheres_size, depth + 1);
        
        // the result is a mix of reflection and refraction (if the sphere is transparent)
        surfaceColor = (
            reflection * fresneleffect +
            refraction * (1 - fresneleffect) * sphere->transparency) * sphere->surfaceColor;
    
    else 
        // it's a diffuse object, no need to raytrace any further
        for (unsigned i = 0; i < spheres_size; ++i) 
            if (spheres[i].emissionColor.x > 0) 
                // this is a light
                Vec3f transmission = 1;
                Vec3f lightDirection = spheres[i].center - phit;
                lightDirection.normalize();
                for (unsigned j = 0; j < spheres_size; ++j) 
                    if (i != j) 
                        float t0, t1;
                        if (spheres[j].intersect(phit + nhit * bias, lightDirection, t0, t1)) 
                            transmission = 0;
                            break;
                        
                    
                
                surfaceColor += sphere->surfaceColor * transmission *
                max(float(0), nhit.dot(lightDirection)) * spheres[i].emissionColor;
            
        
    

    return surfaceColor + sphere->emissionColor;


extern "C" __global__
void raytrace_kernel(unsigned int width, unsigned int height, Vec3f *image, Sphere *spheres, unsigned int spheres_size, float invWidth, float invHeight, float aspectratio, float angle) 
    int x = blockIdx.x * blockDim.x + threadIdx.x;
    int y = blockIdx.y * blockDim.y + threadIdx.y;

    if (y < height && x < width) 
        float xx = (2 * ((x + 0.5) * invWidth) - 1) * angle * aspectratio;
        float yy = (1 - 2 * ((y + 0.5) * invHeight)) * angle;
        Vec3f raydir(xx, yy, -1);
        raydir.normalize();
        image[y*width+x] = trace(Vec3f(0), raydir, spheres, spheres_size, 0);
    

我可以成功地编译它:nvcc --ptx kernel.cu -o kernel.ptx (full PTX here) 并在驱动程序 API 中使用该 PTX 和 cuModuleLoadDataEx,使用以下 sn-p。它按预期工作。

即使我取消注释#include &lt;math.h&gt; 行,它也能正常工作(实际上,生成的 PTX 完全一样)。

CudaSafeCall( cuInit(0) );

CUdevice device;
CudaSafeCall( cuDeviceGet(&device, 0) );

CUcontext context;
CudaSafeCall( cuCtxCreate(&context, 0, device) );

unsigned int error_buffer_size = 1024;
std::vector<CUjit_option> options;
std::vector<void*> values;
char* error_log = new char[error_buffer_size];
options.push_back(CU_JIT_ERROR_LOG_BUFFER); //Pointer to a buffer in which to print any log messages that reflect errors
values.push_back(error_log);
options.push_back(CU_JIT_ERROR_LOG_BUFFER_SIZE_BYTES); //Log buffer size in bytes. Log messages will be capped at this size (including null terminator)
values.push_back(&error_buffer_size);
options.push_back(CU_JIT_TARGET_FROM_CUCONTEXT); //Determines the target based on the current attached context (default)
values.push_back(0); //No option value required for CU_JIT_TARGET_FROM_CUCONTEXT

CUmodule module;
CUresult status = cuModuleLoadDataEx(&module, ptxSource, options.size(), options.data(), values.data());
if (error_log && error_log[0])  //https://***.com/a/7970669/3136474
    std::cout << "Compiler error: " << error_log << std::endl;

CudaSafeCall( status );

但是,每当我尝试使用 NVRTC (full PTX here) 编译这个确切的内核时,它都会成功编译,但在调用 cuModuleLoadDataEx 时会给我一个 Segmentation fault (core dumped)(尝试使用生成的 PTX 时)。

如果我取消注释 #include &lt;math.h&gt; 行,它会在 nvrtcCompileProgram 调用中失败,输出如下:

nvrtcSafeBuild() failed at cuda_raytracer_nvrtc_api.cpp:221 : NVRTC_ERROR_COMPILATION
Build log:
/usr/include/bits/mathcalls.h(177): error: linkage specification is incompatible with previous "isinf"
__nv_nvrtc_builtin_header.h(126689): here

/usr/include/bits/mathcalls.h(211): error: linkage specification is incompatible with previous "isnan"
__nv_nvrtc_builtin_header.h(126686): here

2 errors detected in the compilation of "kernel.cu".

我使用 NVRTC 编译它的代码是:

nvrtcProgram prog;
NvrtcSafeCall( nvrtcCreateProgram(&prog, kernelSource, "kernel.cu", 0, NULL, NULL) );

// https://docs.nvidia.com/cuda/nvrtc/index.html#group__options
std::vector<const char*> compilationOpts;
compilationOpts.push_back("--device-as-default-execution-space");
// NvrtcSafeBuild is a macro which automatically prints nvrtcGetProgramLog if the compilation fails
NvrtcSafeBuild( nvrtcCompileProgram(prog, compilationOpts.size(), compilationOpts.data()), prog );

size_t ptxSize;
NvrtcSafeCall( nvrtcGetPTXSize(prog, &ptxSize) );
char* ptxSource = new char[ptxSize];
NvrtcSafeCall( nvrtcGetPTX(prog, ptxSource) );

NvrtcSafeCall( nvrtcDestroyProgram(&prog) );

然后我只需使用之前的 sn-p 加载 ptxSource(注意:该代码块与驱动程序 API 版本和 NVRTC 版本使用的代码块相同)。

到目前为止我注意到/尝试过的其他事情

    PTX generated by the NVCC 和 the one generated by NVRTC 完全不同,但我无法理解它们以识别可能的问题。 尝试向编译器指定具体的 GPU 架构(在我的例子中是 CC 6.1),没有区别。 试图禁用任何编译器优化(nvrtcCompileProgram 中的选项--ftz=false --prec-sqrt=true --prec-div=true --fmad=false)。 PTX 文件变大了,但仍然Segfaulting。 尝试将--std=c++11--std=c++14 添加到NVRTC 编译器选项。对于它们中的任何一个,NVRTC 都会生成一个几乎为空的(4 行)PTX,但在我尝试使用它之前不会发出警告或错误。

环境

SO:Ubuntu 18.04.4 LTS 64 位 nvcc --version:Cuda 编译工具,10.1 版,V10.1.168。建于 Wed_Apr_24_19:10:27_PDT_2019 gcc --version: gcc (Ubuntu 7.5.0-3ubuntu1~18.04) 7.5.0 硬件:英特尔 I7-7700HQ、GeForce GTX 1050 Ti

在 OP+1 日编辑

我忘了添加我的环境。请参阅上一节。

你也可以用 ptxas 编译 nvrtc 输出吗? – @talonmies 的评论

nvcc 生成的 PTX 编译时出现警告:

$ ptxas -o /tmp/temp_ptxas_output.o kernel.ptx
ptxas warning : Stack size for entry function 'raytrace_kernel' cannot be statically determined

这是由于递归内核函数 (more on that)。 可以放心地忽略它。

nvrtc 生成的 PTX 确实编译并发出错误:

$ ptxas -o /tmp/temp_ptxas_output.o nvrtc_kernel.ptx
ptxas fatal   : Unresolved extern function '_Z5powiffi'

基于this question,我将__device__ 添加到Sphere 类构造函数并删除了--device-as-default-execution-space 编译器选项。 它现在生成的 PTX 略有不同,但仍然显示相同的错误。

使用#include &lt;math.h&gt; 编译现在会生成很多“没有执行空间注释的函数被视为宿主函数,并且在 JIT 模式下不允许宿主函数。”除了以前的错误之外的警告。

如果我尝试使用accepted solution of the question,它会抛出一堆语法错误并且无法编译。 NVCC 仍然可以完美运行。

【问题讨论】:

段错误是主机端问题。您对 PTX 代码的关注可能放错了地方。您可能在驱动程序 API 或支持库中发现了错误。我会制作一个重现案例并将其报告为错误 你也可以用ptxas编译nvrtc输出吗? @talonmies 感谢您的提示,我不记得使用 ptxas 进行编译。我在问题末尾添加了您评论的答案。 【参考方案1】:

刚刚找到了古老的comment-and-test method 的罪魁祸首:如果我删除pow 调用用于计算trace 方法中的菲涅耳效应,错误就会消失。

目前,我刚刚将pow(var, 3) 替换为var*var*var

我创建了一个MVCE 并向 NVIDIA 提交了错误报告:https://developer.nvidia.com/nvidia_bug/2917596。

Liam Zhang 回答并指出了我的问题:

您的代码中的问题是传递给 cuModuleLoadDataEx 的选项值不正确。行:

options.push_back(CU_JIT_ERROR_LOG_BUFFER_SIZE_BYTES); //Log buffer size in bytes. Log messages will be capped at this size (including null terminator)
values.push_back(&error_buffer_size);

提供了缓冲区大小选项,但不是传递具有大小的值,而是传递指向该值的指针。由于该指针随后被读取为数字,因此驱动程序假定缓冲区大小比 1024 大得多。

在 NVRTC 编译期间,出现“未解析的外部函数”错误,因为 pow 函数签名,您可以在文档中找到:__device__​ double pow ( double x, double y ) 当驱动程序在将错误消息放入缓冲区时尝试将缓冲区归零时,发生了段错误。 没有调用 pow 就没有编译错误,所以没有使用错误缓冲区,也没有 segfault。

为确保设备代码正确,用于调用 pow 函数的值以及输出指针应为双精度数,或者可以使用浮点等效函数 powf

如果我将调用更改为values.push_back((void*)error_buffer_size);,它会报告与ptxas 生成的PTX 编译相同的错误:

Compiler error: ptxas fatal   : Unresolved extern function '_Z5powiffi'
cudaSafeCall() failed at file.cpp:74 : CUDA_ERROR_INVALID_PTX - a PTX JIT compilation failed

【讨论】:

在developer.nvidia.com/nvidia_bug/2917596报告的错误 错误的错误可能可以通过将 3 更改为 3.0 来修复 对于立方,从性能角度来看,无论如何建议使用乘法而不是调用pow() @talonmies,仅将 3 更改为 3.0 会在编译 more than one instance of overloaded function "pow" matches the argument list: [...] argument types are: (float, double) 时引发错误。但是,如果我将其键入为(float)3.0,它确实有效。

以上是关于NVCC 和 NVRTC 在编译到 PTX 上的区别的主要内容,如果未能解决你的问题,请参考以下文章

PTX 和 CUBIN w.r.t 有啥区别? NVCC 编译器?

NVRTC 编译何时应生成 CUBIN?

在 CUDA NVRTC 代码中包含 C 标准头文件

将 CUDA-gdb 与 NVRTC 一起使用

使用 CreateProcess 调用 nvcc.exe

CUDA compiler driver nvcc 散点 part 2