1//===----- CGOpenCLRuntime.h - Interface to OpenCL 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 OpenCL code generation.  Concrete
10// subclasses of this implement code generation for specific OpenCL
11// runtime libraries.
12//
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_CLANG_LIB_CODEGEN_CGOPENCLRUNTIME_H
16#define LLVM_CLANG_LIB_CODEGEN_CGOPENCLRUNTIME_H
17
18#include "clang/AST/Expr.h"
19#include "clang/AST/Type.h"
20#include "llvm/ADT/DenseMap.h"
21#include "llvm/IR/Type.h"
22#include "llvm/IR/Value.h"
23
24namespace clang {
25
26class BlockExpr;
27class Expr;
28class VarDecl;
29
30namespace CodeGen {
31
32class CodeGenFunction;
33class CodeGenModule;
34
35class CGOpenCLRuntime {
36protected:
37  CodeGenModule &CGM;
38  llvm::Type *PipeROTy;
39  llvm::Type *PipeWOTy;
40  llvm::PointerType *SamplerTy;
41
42  /// Structure for enqueued block information.
43  struct EnqueuedBlockInfo {
44    llvm::Function *InvokeFunc; /// Block invoke function.
45    llvm::Function *Kernel;     /// Enqueued block kernel.
46    llvm::Value *BlockArg;      /// The first argument to enqueued block kernel.
47  };
48  /// Maps block expression to block information.
49  llvm::DenseMap<const Expr *, EnqueuedBlockInfo> EnqueuedBlockMap;
50
51  virtual llvm::Type *getPipeType(const PipeType *T, StringRef Name,
52                                  llvm::Type *&PipeTy);
53
54public:
55  CGOpenCLRuntime(CodeGenModule &CGM) : CGM(CGM),
56    PipeROTy(nullptr), PipeWOTy(nullptr), SamplerTy(nullptr) {}
57  virtual ~CGOpenCLRuntime();
58
59  /// Emit the IR required for a work-group-local variable declaration, and add
60  /// an entry to CGF's LocalDeclMap for D.  The base class does this using
61  /// CodeGenFunction::EmitStaticVarDecl to emit an internal global for D.
62  virtual void EmitWorkGroupLocalVarDecl(CodeGenFunction &CGF,
63                                         const VarDecl &D);
64
65  virtual llvm::Type *convertOpenCLSpecificType(const Type *T);
66
67  virtual llvm::Type *getPipeType(const PipeType *T);
68
69  llvm::PointerType *getSamplerType(const Type *T);
70
71  // Returns a value which indicates the size in bytes of the pipe
72  // element.
73  virtual llvm::Value *getPipeElemSize(const Expr *PipeArg);
74
75  // Returns a value which indicates the alignment in bytes of the pipe
76  // element.
77  virtual llvm::Value *getPipeElemAlign(const Expr *PipeArg);
78
79  /// \return __generic void* type.
80  llvm::PointerType *getGenericVoidPointerType();
81
82  /// \return enqueued block information for enqueued block.
83  EnqueuedBlockInfo emitOpenCLEnqueuedBlock(CodeGenFunction &CGF,
84                                            const Expr *E);
85
86  /// Record invoke function and block literal emitted during normal
87  /// codegen for a block expression. The information is used by
88  /// emitOpenCLEnqueuedBlock to emit wrapper kernel.
89  ///
90  /// \param InvokeF invoke function emitted for the block expression.
91  /// \param Block block literal emitted for the block expression.
92  void recordBlockInfo(const BlockExpr *E, llvm::Function *InvokeF,
93                       llvm::Value *Block);
94
95  /// \return LLVM block invoke function emitted for an expression derived from
96  /// the block expression.
97  llvm::Function *getInvokeFunction(const Expr *E);
98};
99
100}
101}
102
103#endif
104