1//===----- CGCUDARuntime.h - Interface to CUDA Runtimes ---------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This provides an abstract class for CUDA code generation. Concrete
10// subclasses of this implement code generation for specific CUDA
11// runtime libraries.
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_CLANG_LIB_CODEGEN_CGCUDARUNTIME_H
16#define LLVM_CLANG_LIB_CODEGEN_CGCUDARUNTIME_H
17
18#include "clang/AST/GlobalDecl.h"
19#include "llvm/ADT/StringRef.h"
20#include "llvm/Frontend/Offloading/Utility.h"
21#include "llvm/IR/GlobalValue.h"
22
23namespace llvm {
24class Function;
25class GlobalVariable;
26}
27
28namespace clang {
29
30class CUDAKernelCallExpr;
31class NamedDecl;
32class VarDecl;
33
34namespace CodeGen {
35
36class CodeGenFunction;
37class CodeGenModule;
38class FunctionArgList;
39class ReturnValueSlot;
40class RValue;
41
42class CGCUDARuntime {
43protected:
44 CodeGenModule &CGM;
45
46public:
47 // Global variable properties that must be passed to CUDA runtime.
48 class DeviceVarFlags {
49 public:
50 enum DeviceVarKind {
51 Variable, // Variable
52 Surface, // Builtin surface
53 Texture, // Builtin texture
54 };
55
56 private:
57 LLVM_PREFERRED_TYPE(DeviceVarKind)
58 unsigned Kind : 2;
59 LLVM_PREFERRED_TYPE(bool)
60 unsigned Extern : 1;
61 LLVM_PREFERRED_TYPE(bool)
62 unsigned Constant : 1; // Constant variable.
63 LLVM_PREFERRED_TYPE(bool)
64 unsigned Managed : 1; // Managed variable.
65 LLVM_PREFERRED_TYPE(bool)
66 unsigned Normalized : 1; // Normalized texture.
67 int SurfTexType; // Type of surface/texutre.
68
69 public:
70 DeviceVarFlags(DeviceVarKind K, bool E, bool C, bool M, bool N, int T)
71 : Kind(K), Extern(E), Constant(C), Managed(M), Normalized(N),
72 SurfTexType(T) {}
73
74 DeviceVarKind getKind() const { return static_cast<DeviceVarKind>(Kind); }
75 bool isExtern() const { return Extern; }
76 bool isConstant() const { return Constant; }
77 bool isManaged() const { return Managed; }
78 bool isNormalized() const { return Normalized; }
79 int getSurfTexType() const { return SurfTexType; }
80 };
81
82 CGCUDARuntime(CodeGenModule &CGM) : CGM(CGM) {}
83 virtual ~CGCUDARuntime();
84
85 virtual RValue EmitCUDAKernelCallExpr(CodeGenFunction &CGF,
86 const CUDAKernelCallExpr *E,
87 ReturnValueSlot ReturnValue);
88
89 /// Emits a kernel launch stub.
90 virtual void emitDeviceStub(CodeGenFunction &CGF, FunctionArgList &Args) = 0;
91
92 /// Check whether a variable is a device variable and register it if true.
93 virtual void handleVarRegistration(const VarDecl *VD,
94 llvm::GlobalVariable &Var) = 0;
95
96 /// Finalize generated LLVM module. Returns a module constructor function
97 /// to be added or a null pointer.
98 virtual llvm::Function *finalizeModule() = 0;
99
100 /// Returns function or variable name on device side even if the current
101 /// compilation is for host.
102 virtual std::string getDeviceSideName(const NamedDecl *ND) = 0;
103
104 /// Get kernel handle by stub function.
105 virtual llvm::GlobalValue *getKernelHandle(llvm::Function *Stub,
106 GlobalDecl GD) = 0;
107
108 /// Get kernel stub by kernel handle.
109 virtual llvm::Function *getKernelStub(llvm::GlobalValue *Handle) = 0;
110
111 /// Adjust linkage of shadow variables in host compilation.
112 virtual void
113 internalizeDeviceSideVar(const VarDecl *D,
114 llvm::GlobalValue::LinkageTypes &Linkage) = 0;
115};
116
117/// Creates an instance of a CUDA runtime class.
118CGCUDARuntime *CreateNVCUDARuntime(CodeGenModule &CGM);
119
120}
121}
122
123#endif
124