clang/lib/CodeGen/CGOpenCLRuntime.cpp

   1 //===----- CGOpenCLRuntime.cpp - Interface to OpenCL Runtimes -------------===//
   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 OpenCL code generation.  Concrete
  10 // subclasses of this implement code generation for specific OpenCL
  11 // runtime libraries.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "CGOpenCLRuntime.h"
  16 #include "CodeGenFunction.h"
  17 #include "TargetInfo.h"
  18 #include "clang/CodeGen/ConstantInitBuilder.h"
  19 #include "llvm/IR/DerivedTypes.h"
  20 #include "llvm/IR/GlobalValue.h"
  21 #include <assert.h>
  22
  23 using namespace clang;
  24 using namespace CodeGen;
  25
  26 CGOpenCLRuntime::~CGOpenCLRuntime() {}
  27
  28 void CGOpenCLRuntime::EmitWorkGroupLocalVarDecl(CodeGenFunction &CGF,
  29                                                 const VarDecl &D) {
  30   return CGF.EmitStaticVarDecl(D, llvm::GlobalValue::InternalLinkage);
  31 }
  32
  33 llvm::Type *CGOpenCLRuntime::convertOpenCLSpecificType(const Type *T) {
  34   assert(T->isOpenCLSpecificType() && "Not an OpenCL specific type!");
  35
  36   // Check if the target has a specific translation for this type first.
  37   if (llvm::Type *TransTy = CGM.getTargetCodeGenInfo().getOpenCLType(CGM, T))
  38     return TransTy;
  39
  40   switch (cast<BuiltinType>(T)->getKind()) {
  41   default:
  42     llvm_unreachable("Unexpected opencl builtin type!");
  43     return nullptr;
  44 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix)                   \
  45   case BuiltinType::Id:                                                        \
  46     return getPointerType(T, "opencl." #ImgType "_" #Suffix "_t");
  47 #include "clang/Basic/OpenCLImageTypes.def"
  48   case BuiltinType::OCLSampler:
  49     return getSamplerType(T);
  50   case BuiltinType::OCLEvent:
  51     return getPointerType(T, "opencl.event_t");
  52   case BuiltinType::OCLClkEvent:
  53     return getPointerType(T, "opencl.clk_event_t");
  54   case BuiltinType::OCLQueue:
  55     return getPointerType(T, "opencl.queue_t");
  56   case BuiltinType::OCLReserveID:
  57     return getPointerType(T, "opencl.reserve_id_t");
  58 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext)                                      \
  59   case BuiltinType::Id:                                                        \
  60     return getPointerType(T, "opencl." #ExtType);
  61 #include "clang/Basic/OpenCLExtensionTypes.def"
  62   }
  63 }
  64
  65 llvm::PointerType *CGOpenCLRuntime::getPointerType(const Type *T,
  66                                                    StringRef Name) {
  67   auto I = CachedTys.find(Name);
  68   if (I != CachedTys.end())
  69     return I->second;
  70
  71   llvm::LLVMContext &Ctx = CGM.getLLVMContext();
  72   uint32_t AddrSpc = CGM.getContext().getTargetAddressSpace(
  73       CGM.getContext().getOpenCLTypeAddrSpace(T));
  74   auto *PTy = llvm::PointerType::get(Ctx, AddrSpc);
  75   CachedTys[Name] = PTy;
  76   return PTy;
  77 }
  78
  79 llvm::Type *CGOpenCLRuntime::getPipeType(const PipeType *T) {
  80   if (llvm::Type *PipeTy = CGM.getTargetCodeGenInfo().getOpenCLType(CGM, T))
  81     return PipeTy;
  82
  83   if (T->isReadOnly())
  84     return getPipeType(T, "opencl.pipe_ro_t", PipeROTy);
  85   else
  86     return getPipeType(T, "opencl.pipe_wo_t", PipeWOTy);
  87 }
  88
  89 llvm::Type *CGOpenCLRuntime::getPipeType(const PipeType *T, StringRef Name,
  90                                          llvm::Type *&PipeTy) {
  91   if (!PipeTy)
  92     PipeTy = llvm::PointerType::get(
  93         CGM.getLLVMContext(), CGM.getContext().getTargetAddressSpace(
  94                                   CGM.getContext().getOpenCLTypeAddrSpace(T)));
  95   return PipeTy;
  96 }
  97
  98 llvm::Type *CGOpenCLRuntime::getSamplerType(const Type *T) {
  99   if (SamplerTy)
 100     return SamplerTy;
 101
 102   if (llvm::Type *TransTy = CGM.getTargetCodeGenInfo().getOpenCLType(
 103           CGM, CGM.getContext().OCLSamplerTy.getTypePtr()))
 104     SamplerTy = TransTy;
 105   else
 106     // struct opencl.sampler_t*
 107     SamplerTy = llvm::PointerType::get(
 108         CGM.getLLVMContext(), CGM.getContext().getTargetAddressSpace(
 109                                   CGM.getContext().getOpenCLTypeAddrSpace(T)));
 110   return SamplerTy;
 111 }
 112
 113 llvm::Value *CGOpenCLRuntime::getPipeElemSize(const Expr *PipeArg) {
 114   const PipeType *PipeTy = PipeArg->getType()->castAs<PipeType>();
 115   // The type of the last (implicit) argument to be passed.
 116   llvm::Type *Int32Ty = llvm::IntegerType::getInt32Ty(CGM.getLLVMContext());
 117   unsigned TypeSize = CGM.getContext()
 118                           .getTypeSizeInChars(PipeTy->getElementType())
 119                           .getQuantity();
 120   return llvm::ConstantInt::get(Int32Ty, TypeSize, false);
 121 }
 122
 123 llvm::Value *CGOpenCLRuntime::getPipeElemAlign(const Expr *PipeArg) {
 124   const PipeType *PipeTy = PipeArg->getType()->castAs<PipeType>();
 125   // The type of the last (implicit) argument to be passed.
 126   llvm::Type *Int32Ty = llvm::IntegerType::getInt32Ty(CGM.getLLVMContext());
 127   unsigned TypeSize = CGM.getContext()
 128                           .getTypeAlignInChars(PipeTy->getElementType())
 129                           .getQuantity();
 130   return llvm::ConstantInt::get(Int32Ty, TypeSize, false);
 131 }
 132
 133 llvm::PointerType *CGOpenCLRuntime::getGenericVoidPointerType() {
 134   assert(CGM.getLangOpts().OpenCL);
 135   return llvm::PointerType::get(
 136       CGM.getLLVMContext(),
 137       CGM.getContext().getTargetAddressSpace(LangAS::opencl_generic));
 138 }
 139
 140 // Get the block literal from an expression derived from the block expression.
 141 // OpenCL v2.0 s6.12.5:
 142 // Block variable declarations are implicitly qualified with const. Therefore
 143 // all block variables must be initialized at declaration time and may not be
 144 // reassigned.
 145 static const BlockExpr *getBlockExpr(const Expr *E) {
 146   const Expr *Prev = nullptr; // to make sure we do not stuck in infinite loop.
 147   while(!isa<BlockExpr>(E) && E != Prev) {
 148     Prev = E;
 149     E = E->IgnoreCasts();
 150     if (auto DR = dyn_cast<DeclRefExpr>(E)) {
 151       E = cast<VarDecl>(DR->getDecl())->getInit();
 152     }
 153   }
 154   return cast<BlockExpr>(E);
 155 }
 156
 157 /// Record emitted llvm invoke function and llvm block literal for the
 158 /// corresponding block expression.
 159 void CGOpenCLRuntime::recordBlockInfo(const BlockExpr *E,
 160                                       llvm::Function *InvokeF,
 161                                       llvm::Value *Block, llvm::Type *BlockTy) {
 162   assert(!EnqueuedBlockMap.contains(E) && "Block expression emitted twice");
 163   assert(isa<llvm::Function>(InvokeF) && "Invalid invoke function");
 164   assert(Block->getType()->isPointerTy() && "Invalid block literal type");
 165   EnqueuedBlockMap[E].InvokeFunc = InvokeF;
 166   EnqueuedBlockMap[E].BlockArg = Block;
 167   EnqueuedBlockMap[E].BlockTy = BlockTy;
 168   EnqueuedBlockMap[E].KernelHandle = nullptr;
 169 }
 170
 171 llvm::Function *CGOpenCLRuntime::getInvokeFunction(const Expr *E) {
 172   return EnqueuedBlockMap[getBlockExpr(E)].InvokeFunc;
 173 }
 174
 175 CGOpenCLRuntime::EnqueuedBlockInfo
 176 CGOpenCLRuntime::emitOpenCLEnqueuedBlock(CodeGenFunction &CGF, const Expr *E) {
 177   CGF.EmitScalarExpr(E);
 178
 179   // The block literal may be assigned to a const variable. Chasing down
 180   // to get the block literal.
 181   const BlockExpr *Block = getBlockExpr(E);
 182
 183   assert(EnqueuedBlockMap.contains(Block) && "Block expression not emitted");
 184
 185   // Do not emit the block wrapper again if it has been emitted.
 186   if (EnqueuedBlockMap[Block].KernelHandle) {
 187     return EnqueuedBlockMap[Block];
 188   }
 189
 190   auto *F = CGF.getTargetHooks().createEnqueuedBlockKernel(
 191       CGF, EnqueuedBlockMap[Block].InvokeFunc, EnqueuedBlockMap[Block].BlockTy);
 192
 193   // The common part of the post-processing of the kernel goes here.
 194   EnqueuedBlockMap[Block].KernelHandle = F;
 195   return EnqueuedBlockMap[Block];
 196 }