1 //===----- CGOpenCLRuntime.cpp - Interface to OpenCL Runtimes -------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This provides an abstract class for OpenCL code generation. Concrete
11 // subclasses of this implement code generation for specific OpenCL
14 //===----------------------------------------------------------------------===//
16 #include "CGOpenCLRuntime.h"
17 #include "CodeGenFunction.h"
18 #include "TargetInfo.h"
19 #include "clang/CodeGen/ConstantInitBuilder.h"
20 #include "llvm/IR/DerivedTypes.h"
21 #include "llvm/IR/GlobalValue.h"
24 using namespace clang;
25 using namespace CodeGen;
27 CGOpenCLRuntime::~CGOpenCLRuntime() {}
29 void CGOpenCLRuntime::EmitWorkGroupLocalVarDecl(CodeGenFunction &CGF,
31 return CGF.EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
34 llvm::Type *CGOpenCLRuntime::convertOpenCLSpecificType(const Type *T) {
35 assert(T->isOpenCLSpecificType() &&
36 "Not an OpenCL specific type!");
38 llvm::LLVMContext& Ctx = CGM.getLLVMContext();
39 uint32_t AddrSpc = CGM.getContext().getTargetAddressSpace(
40 CGM.getContext().getOpenCLTypeAddrSpace(T));
41 switch (cast<BuiltinType>(T)->getKind()) {
43 llvm_unreachable("Unexpected opencl builtin type!");
45 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
46 case BuiltinType::Id: \
47 return llvm::PointerType::get( \
48 llvm::StructType::create(Ctx, "opencl." #ImgType "_" #Suffix "_t"), \
50 #include "clang/Basic/OpenCLImageTypes.def"
51 case BuiltinType::OCLSampler:
52 return getSamplerType(T);
53 case BuiltinType::OCLEvent:
54 return llvm::PointerType::get(
55 llvm::StructType::create(Ctx, "opencl.event_t"), AddrSpc);
56 case BuiltinType::OCLClkEvent:
57 return llvm::PointerType::get(
58 llvm::StructType::create(Ctx, "opencl.clk_event_t"), AddrSpc);
59 case BuiltinType::OCLQueue:
60 return llvm::PointerType::get(
61 llvm::StructType::create(Ctx, "opencl.queue_t"), AddrSpc);
62 case BuiltinType::OCLReserveID:
63 return llvm::PointerType::get(
64 llvm::StructType::create(Ctx, "opencl.reserve_id_t"), AddrSpc);
68 llvm::Type *CGOpenCLRuntime::getPipeType(const PipeType *T) {
70 return getPipeType(T, "opencl.pipe_ro_t", PipeROTy);
72 return getPipeType(T, "opencl.pipe_wo_t", PipeWOTy);
75 llvm::Type *CGOpenCLRuntime::getPipeType(const PipeType *T, StringRef Name,
76 llvm::Type *&PipeTy) {
78 PipeTy = llvm::PointerType::get(llvm::StructType::create(
79 CGM.getLLVMContext(), Name),
80 CGM.getContext().getTargetAddressSpace(
81 CGM.getContext().getOpenCLTypeAddrSpace(T)));
85 llvm::PointerType *CGOpenCLRuntime::getSamplerType(const Type *T) {
87 SamplerTy = llvm::PointerType::get(llvm::StructType::create(
88 CGM.getLLVMContext(), "opencl.sampler_t"),
89 CGM.getContext().getTargetAddressSpace(
90 CGM.getContext().getOpenCLTypeAddrSpace(T)));
94 llvm::Value *CGOpenCLRuntime::getPipeElemSize(const Expr *PipeArg) {
95 const PipeType *PipeTy = PipeArg->getType()->getAs<PipeType>();
96 // The type of the last (implicit) argument to be passed.
97 llvm::Type *Int32Ty = llvm::IntegerType::getInt32Ty(CGM.getLLVMContext());
98 unsigned TypeSize = CGM.getContext()
99 .getTypeSizeInChars(PipeTy->getElementType())
101 return llvm::ConstantInt::get(Int32Ty, TypeSize, false);
104 llvm::Value *CGOpenCLRuntime::getPipeElemAlign(const Expr *PipeArg) {
105 const PipeType *PipeTy = PipeArg->getType()->getAs<PipeType>();
106 // The type of the last (implicit) argument to be passed.
107 llvm::Type *Int32Ty = llvm::IntegerType::getInt32Ty(CGM.getLLVMContext());
108 unsigned TypeSize = CGM.getContext()
109 .getTypeAlignInChars(PipeTy->getElementType())
111 return llvm::ConstantInt::get(Int32Ty, TypeSize, false);
114 llvm::PointerType *CGOpenCLRuntime::getGenericVoidPointerType() {
115 assert(CGM.getLangOpts().OpenCL);
116 return llvm::IntegerType::getInt8PtrTy(
117 CGM.getLLVMContext(),
118 CGM.getContext().getTargetAddressSpace(LangAS::opencl_generic));
121 // Get the block literal from an expression derived from the block expression.
122 // OpenCL v2.0 s6.12.5:
123 // Block variable declarations are implicitly qualified with const. Therefore
124 // all block variables must be initialized at declaration time and may not be
126 static const BlockExpr *getBlockExpr(const Expr *E) {
127 if (auto Cast = dyn_cast<CastExpr>(E)) {
128 E = Cast->getSubExpr();
130 if (auto DR = dyn_cast<DeclRefExpr>(E)) {
131 E = cast<VarDecl>(DR->getDecl())->getInit();
133 E = E->IgnoreImplicit();
134 if (auto Cast = dyn_cast<CastExpr>(E)) {
135 E = Cast->getSubExpr();
137 return cast<BlockExpr>(E);
140 /// Record emitted llvm invoke function and llvm block literal for the
141 /// corresponding block expression.
142 void CGOpenCLRuntime::recordBlockInfo(const BlockExpr *E,
143 llvm::Function *InvokeF,
144 llvm::Value *Block) {
145 assert(EnqueuedBlockMap.find(E) == EnqueuedBlockMap.end() &&
146 "Block expression emitted twice");
147 assert(isa<llvm::Function>(InvokeF) && "Invalid invoke function");
148 assert(Block->getType()->isPointerTy() && "Invalid block literal type");
149 EnqueuedBlockMap[E].InvokeFunc = InvokeF;
150 EnqueuedBlockMap[E].BlockArg = Block;
151 EnqueuedBlockMap[E].Kernel = nullptr;
154 llvm::Function *CGOpenCLRuntime::getInvokeFunction(const Expr *E) {
155 return EnqueuedBlockMap[getBlockExpr(E)].InvokeFunc;
158 CGOpenCLRuntime::EnqueuedBlockInfo
159 CGOpenCLRuntime::emitOpenCLEnqueuedBlock(CodeGenFunction &CGF, const Expr *E) {
160 CGF.EmitScalarExpr(E);
162 const BlockExpr *Block = getBlockExpr(E);
163 assert(EnqueuedBlockMap.find(Block) != EnqueuedBlockMap.end() &&
164 "Block expression not emitted");
166 // Do not emit the block wrapper again if it has been emitted.
167 if (EnqueuedBlockMap[Block].Kernel) {
168 return EnqueuedBlockMap[Block];
171 auto *F = CGF.getTargetHooks().createEnqueuedBlockKernel(
172 CGF, EnqueuedBlockMap[Block].InvokeFunc,
173 EnqueuedBlockMap[Block].BlockArg->stripPointerCasts());
175 // The common part of the post-processing of the kernel goes here.
176 F->addFnAttr(llvm::Attribute::NoUnwind);
178 CGF.getTypes().ClangCallConvToLLVMCallConv(CallingConv::CC_OpenCLKernel));
179 EnqueuedBlockMap[Block].Kernel = F;
180 return EnqueuedBlockMap[Block];