blob: d9ac5df36b73c1c80a15c154f7aeade47dcca275 [file] [log] [blame]
Alexey Bataev9959db52014-05-06 10:08:46 +00001//===----- CGOpenMPRuntime.h - Interface to OpenMP Runtimes -----*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This provides a class for OpenMP runtime code generation.
11//
12//===----------------------------------------------------------------------===//
13
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000014#ifndef LLVM_CLANG_LIB_CODEGEN_CGOPENMPRUNTIME_H
15#define LLVM_CLANG_LIB_CODEGEN_CGOPENMPRUNTIME_H
Alexey Bataev9959db52014-05-06 10:08:46 +000016
Alexey Bataev7292c292016-04-25 12:22:29 +000017#include "CGValue.h"
Alexey Bataev62b63b12015-03-10 07:28:44 +000018#include "clang/AST/Type.h"
Alexander Musmanc6388682014-12-15 07:07:06 +000019#include "clang/Basic/OpenMPKinds.h"
Chandler Carruth0d9593d2015-01-14 11:29:14 +000020#include "clang/Basic/SourceLocation.h"
Alexey Bataev9959db52014-05-06 10:08:46 +000021#include "llvm/ADT/DenseMap.h"
Alexey Bataev3a3bf0b2014-09-22 10:01:53 +000022#include "llvm/ADT/StringMap.h"
Alexey Bataev2a6f3f52018-11-07 19:11:14 +000023#include "llvm/ADT/StringSet.h"
Benjamin Kramer8fdba912016-02-02 14:24:21 +000024#include "llvm/IR/Function.h"
Alexey Bataev97720002014-11-11 04:05:39 +000025#include "llvm/IR/ValueHandle.h"
Alexey Bataev18095712014-10-10 12:19:54 +000026
27namespace llvm {
28class ArrayType;
29class Constant;
Alexey Bataev18095712014-10-10 12:19:54 +000030class FunctionType;
Alexey Bataev97720002014-11-11 04:05:39 +000031class GlobalVariable;
Alexey Bataev18095712014-10-10 12:19:54 +000032class StructType;
33class Type;
34class Value;
35} // namespace llvm
Alexey Bataev9959db52014-05-06 10:08:46 +000036
Alexey Bataev9959db52014-05-06 10:08:46 +000037namespace clang {
Alexey Bataevcc37cc12014-11-20 04:34:54 +000038class Expr;
Samuel Antaoee8fb302016-01-06 13:42:12 +000039class GlobalDecl;
Alexey Bataev8b427062016-05-25 12:36:08 +000040class OMPDependClause;
Alexey Bataev18095712014-10-10 12:19:54 +000041class OMPExecutableDirective;
Alexey Bataev7292c292016-04-25 12:22:29 +000042class OMPLoopDirective;
Alexey Bataev18095712014-10-10 12:19:54 +000043class VarDecl;
Alexey Bataevc5b1d322016-03-04 09:22:22 +000044class OMPDeclareReductionDecl;
45class IdentifierInfo;
Alexey Bataev18095712014-10-10 12:19:54 +000046
Alexey Bataev9959db52014-05-06 10:08:46 +000047namespace CodeGen {
John McCall7f416cc2015-09-08 08:05:57 +000048class Address;
Alexey Bataev18095712014-10-10 12:19:54 +000049class CodeGenFunction;
50class CodeGenModule;
Alexey Bataev9959db52014-05-06 10:08:46 +000051
Alexey Bataev14fa1c62016-03-29 05:34:15 +000052/// A basic class for pre|post-action for advanced codegen sequence for OpenMP
53/// region.
54class PrePostActionTy {
55public:
56 explicit PrePostActionTy() {}
57 virtual void Enter(CodeGenFunction &CGF) {}
58 virtual void Exit(CodeGenFunction &CGF) {}
59 virtual ~PrePostActionTy() {}
60};
61
62/// Class provides a way to call simple version of codegen for OpenMP region, or
63/// an advanced with possible pre|post-actions in codegen.
64class RegionCodeGenTy final {
65 intptr_t CodeGen;
66 typedef void (*CodeGenTy)(intptr_t, CodeGenFunction &, PrePostActionTy &);
67 CodeGenTy Callback;
68 mutable PrePostActionTy *PrePostAction;
69 RegionCodeGenTy() = delete;
70 RegionCodeGenTy &operator=(const RegionCodeGenTy &) = delete;
71 template <typename Callable>
72 static void CallbackFn(intptr_t CodeGen, CodeGenFunction &CGF,
73 PrePostActionTy &Action) {
74 return (*reinterpret_cast<Callable *>(CodeGen))(CGF, Action);
75 }
76
77public:
78 template <typename Callable>
79 RegionCodeGenTy(
80 Callable &&CodeGen,
81 typename std::enable_if<
82 !std::is_same<typename std::remove_reference<Callable>::type,
83 RegionCodeGenTy>::value>::type * = nullptr)
84 : CodeGen(reinterpret_cast<intptr_t>(&CodeGen)),
85 Callback(CallbackFn<typename std::remove_reference<Callable>::type>),
86 PrePostAction(nullptr) {}
87 void setAction(PrePostActionTy &Action) const { PrePostAction = &Action; }
88 void operator()(CodeGenFunction &CGF) const;
89};
Alexey Bataev6f1ffc02015-04-10 04:50:10 +000090
Alexey Bataev24b5bae2016-04-28 09:23:51 +000091struct OMPTaskDataTy final {
92 SmallVector<const Expr *, 4> PrivateVars;
93 SmallVector<const Expr *, 4> PrivateCopies;
94 SmallVector<const Expr *, 4> FirstprivateVars;
95 SmallVector<const Expr *, 4> FirstprivateCopies;
96 SmallVector<const Expr *, 4> FirstprivateInits;
Alexey Bataevf93095a2016-05-05 08:46:22 +000097 SmallVector<const Expr *, 4> LastprivateVars;
98 SmallVector<const Expr *, 4> LastprivateCopies;
Alexey Bataevbe5a8b42017-07-17 13:30:36 +000099 SmallVector<const Expr *, 4> ReductionVars;
100 SmallVector<const Expr *, 4> ReductionCopies;
101 SmallVector<const Expr *, 4> ReductionOps;
Alexey Bataev24b5bae2016-04-28 09:23:51 +0000102 SmallVector<std::pair<OpenMPDependClauseKind, const Expr *>, 4> Dependences;
103 llvm::PointerIntPair<llvm::Value *, 1, bool> Final;
104 llvm::PointerIntPair<llvm::Value *, 1, bool> Schedule;
Alexey Bataev1e1e2862016-05-10 12:21:02 +0000105 llvm::PointerIntPair<llvm::Value *, 1, bool> Priority;
Alexey Bataevbe5a8b42017-07-17 13:30:36 +0000106 llvm::Value *Reductions = nullptr;
Alexey Bataev24b5bae2016-04-28 09:23:51 +0000107 unsigned NumberOfParts = 0;
108 bool Tied = true;
109 bool Nogroup = false;
110};
111
Alexey Bataev5c40bec2017-07-13 13:36:14 +0000112/// Class intended to support codegen of all kind of the reduction clauses.
113class ReductionCodeGen {
114private:
Simon Pilgrim6c0eeff2017-07-13 17:34:44 +0000115 /// Data required for codegen of reduction clauses.
Alexey Bataev5c40bec2017-07-13 13:36:14 +0000116 struct ReductionData {
117 /// Reference to the original shared item.
118 const Expr *Ref = nullptr;
119 /// Helper expression for generation of private copy.
120 const Expr *Private = nullptr;
121 /// Helper expression for generation reduction operation.
122 const Expr *ReductionOp = nullptr;
123 ReductionData(const Expr *Ref, const Expr *Private, const Expr *ReductionOp)
124 : Ref(Ref), Private(Private), ReductionOp(ReductionOp) {}
125 };
126 /// List of reduction-based clauses.
127 SmallVector<ReductionData, 4> ClausesData;
128
129 /// List of addresses of original shared variables/expressions.
130 SmallVector<std::pair<LValue, LValue>, 4> SharedAddresses;
131 /// Sizes of the reduction items in chars.
Alexey Bataevbe5a8b42017-07-17 13:30:36 +0000132 SmallVector<std::pair<llvm::Value *, llvm::Value *>, 4> Sizes;
Alexey Bataev5c40bec2017-07-13 13:36:14 +0000133 /// Base declarations for the reduction items.
134 SmallVector<const VarDecl *, 4> BaseDecls;
Alexey Bataevbe5a8b42017-07-17 13:30:36 +0000135
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +0000136 /// Emits lvalue for shared expression.
Alexey Bataev5c40bec2017-07-13 13:36:14 +0000137 LValue emitSharedLValue(CodeGenFunction &CGF, const Expr *E);
138 /// Emits upper bound for shared expression (if array section).
139 LValue emitSharedLValueUB(CodeGenFunction &CGF, const Expr *E);
140 /// Performs aggregate initialization.
141 /// \param N Number of reduction item in the common list.
142 /// \param PrivateAddr Address of the corresponding private item.
Alexey Bataevbe5a8b42017-07-17 13:30:36 +0000143 /// \param SharedLVal Address of the original shared variable.
144 /// \param DRD Declare reduction construct used for reduction item.
Alexey Bataev5c40bec2017-07-13 13:36:14 +0000145 void emitAggregateInitialization(CodeGenFunction &CGF, unsigned N,
Alexey Bataevbe5a8b42017-07-17 13:30:36 +0000146 Address PrivateAddr, LValue SharedLVal,
147 const OMPDeclareReductionDecl *DRD);
Alexey Bataev5c40bec2017-07-13 13:36:14 +0000148
149public:
150 ReductionCodeGen(ArrayRef<const Expr *> Shareds,
151 ArrayRef<const Expr *> Privates,
152 ArrayRef<const Expr *> ReductionOps);
153 /// Emits lvalue for a reduction item.
154 /// \param N Number of the reduction item.
155 void emitSharedLValue(CodeGenFunction &CGF, unsigned N);
156 /// Emits the code for the variable-modified type, if required.
157 /// \param N Number of the reduction item.
158 void emitAggregateType(CodeGenFunction &CGF, unsigned N);
159 /// Emits the code for the variable-modified type, if required.
160 /// \param N Number of the reduction item.
161 /// \param Size Size of the type in chars.
162 void emitAggregateType(CodeGenFunction &CGF, unsigned N, llvm::Value *Size);
163 /// Performs initialization of the private copy for the reduction item.
164 /// \param N Number of the reduction item.
165 /// \param PrivateAddr Address of the corresponding private item.
166 /// \param DefaultInit Default initialization sequence that should be
167 /// performed if no reduction specific initialization is found.
Simon Pilgrim6c0eeff2017-07-13 17:34:44 +0000168 /// \param SharedLVal Address of the original shared variable.
Alexey Bataev5c40bec2017-07-13 13:36:14 +0000169 void
170 emitInitialization(CodeGenFunction &CGF, unsigned N, Address PrivateAddr,
171 LValue SharedLVal,
172 llvm::function_ref<bool(CodeGenFunction &)> DefaultInit);
Simon Pilgrim6c0eeff2017-07-13 17:34:44 +0000173 /// Returns true if the private copy requires cleanups.
Alexey Bataev5c40bec2017-07-13 13:36:14 +0000174 bool needCleanups(unsigned N);
Simon Pilgrim6c0eeff2017-07-13 17:34:44 +0000175 /// Emits cleanup code for the reduction item.
Alexey Bataev5c40bec2017-07-13 13:36:14 +0000176 /// \param N Number of the reduction item.
177 /// \param PrivateAddr Address of the corresponding private item.
178 void emitCleanups(CodeGenFunction &CGF, unsigned N, Address PrivateAddr);
Simon Pilgrim6c0eeff2017-07-13 17:34:44 +0000179 /// Adjusts \p PrivatedAddr for using instead of the original variable
Alexey Bataev5c40bec2017-07-13 13:36:14 +0000180 /// address in normal operations.
181 /// \param N Number of the reduction item.
182 /// \param PrivateAddr Address of the corresponding private item.
183 Address adjustPrivateAddress(CodeGenFunction &CGF, unsigned N,
184 Address PrivateAddr);
185 /// Returns LValue for the reduction item.
186 LValue getSharedLValue(unsigned N) const { return SharedAddresses[N].first; }
Alexey Bataevbe5a8b42017-07-17 13:30:36 +0000187 /// Returns the size of the reduction item (in chars and total number of
188 /// elements in the item), or nullptr, if the size is a constant.
189 std::pair<llvm::Value *, llvm::Value *> getSizes(unsigned N) const {
190 return Sizes[N];
191 }
Alexey Bataev5c40bec2017-07-13 13:36:14 +0000192 /// Returns the base declaration of the reduction item.
193 const VarDecl *getBaseDecl(unsigned N) const { return BaseDecls[N]; }
Alexey Bataev1c44e152018-03-06 18:59:43 +0000194 /// Returns the base declaration of the reduction item.
195 const Expr *getRefExpr(unsigned N) const { return ClausesData[N].Ref; }
Alexey Bataevbe5a8b42017-07-17 13:30:36 +0000196 /// Returns true if the initialization of the reduction item uses initializer
197 /// from declare reduction construct.
198 bool usesReductionInitializer(unsigned N) const;
Alexey Bataev5c40bec2017-07-13 13:36:14 +0000199};
200
Alexey Bataev9959db52014-05-06 10:08:46 +0000201class CGOpenMPRuntime {
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +0000202public:
203 /// Allows to disable automatic handling of functions used in target regions
204 /// as those marked as `omp declare target`.
205 class DisableAutoDeclareTargetRAII {
206 CodeGenModule &CGM;
207 bool SavedShouldMarkAsGlobal;
208
209 public:
210 DisableAutoDeclareTargetRAII(CodeGenModule &CGM);
211 ~DisableAutoDeclareTargetRAII();
212 };
213
Arpith Chacko Jacob5c309e42016-03-22 01:48:56 +0000214protected:
Alexey Bataev9959db52014-05-06 10:08:46 +0000215 CodeGenModule &CGM;
Alexey Bataev18fa2322018-05-02 14:20:50 +0000216 StringRef FirstSeparator, Separator;
217
218 /// Constructor allowing to redefine the name separator for the variables.
219 explicit CGOpenMPRuntime(CodeGenModule &CGM, StringRef FirstSeparator,
220 StringRef Separator);
Arpith Chacko Jacob5c309e42016-03-22 01:48:56 +0000221
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000222 /// Creates offloading entry for the provided entry ID \a ID,
Samuel Antaof83efdb2017-01-05 16:02:49 +0000223 /// address \a Addr, size \a Size, and flags \a Flags.
Arpith Chacko Jacob5c309e42016-03-22 01:48:56 +0000224 virtual void createOffloadEntry(llvm::Constant *ID, llvm::Constant *Addr,
Alexey Bataev03f270c2018-03-30 18:31:07 +0000225 uint64_t Size, int32_t Flags,
226 llvm::GlobalValue::LinkageTypes Linkage);
Arpith Chacko Jacob5c309e42016-03-22 01:48:56 +0000227
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000228 /// Helper to emit outlined function for 'target' directive.
Arpith Chacko Jacob5c309e42016-03-22 01:48:56 +0000229 /// \param D Directive to emit.
230 /// \param ParentName Name of the function that encloses the target region.
231 /// \param OutlinedFn Outlined function value to be defined by this call.
232 /// \param OutlinedFnID Outlined function ID value to be defined by this call.
233 /// \param IsOffloadEntry True if the outlined function is an offload entry.
234 /// \param CodeGen Lambda codegen specific to an accelerator device.
Simon Pilgrim6c0eeff2017-07-13 17:34:44 +0000235 /// An outlined function may not be an entry if, e.g. the if clause always
Arpith Chacko Jacob5c309e42016-03-22 01:48:56 +0000236 /// evaluates to false.
237 virtual void emitTargetOutlinedFunctionHelper(const OMPExecutableDirective &D,
238 StringRef ParentName,
239 llvm::Function *&OutlinedFn,
240 llvm::Constant *&OutlinedFnID,
241 bool IsOffloadEntry,
242 const RegionCodeGenTy &CodeGen);
243
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000244 /// Emits code for OpenMP 'if' clause using specified \a CodeGen
Arpith Chacko Jacobbb36fe82017-01-10 15:42:51 +0000245 /// function. Here is the logic:
246 /// if (Cond) {
247 /// ThenGen();
248 /// } else {
249 /// ElseGen();
250 /// }
251 void emitOMPIfClause(CodeGenFunction &CGF, const Expr *Cond,
252 const RegionCodeGenTy &ThenGen,
253 const RegionCodeGenTy &ElseGen);
254
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000255 /// Emits object of ident_t type with info for source location.
Arpith Chacko Jacobbb36fe82017-01-10 15:42:51 +0000256 /// \param Flags Flags for OpenMP location.
257 ///
258 llvm::Value *emitUpdateLocation(CodeGenFunction &CGF, SourceLocation Loc,
259 unsigned Flags = 0);
260
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000261 /// Returns pointer to ident_t type.
Arpith Chacko Jacobbb36fe82017-01-10 15:42:51 +0000262 llvm::Type *getIdentTyPointerTy();
263
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000264 /// Gets thread id value for the current thread.
Arpith Chacko Jacobbb36fe82017-01-10 15:42:51 +0000265 ///
266 llvm::Value *getThreadID(CodeGenFunction &CGF, SourceLocation Loc);
267
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000268 /// Get the function name of an outlined region.
Arpith Chacko Jacobbb36fe82017-01-10 15:42:51 +0000269 // The name can be customized depending on the target.
270 //
271 virtual StringRef getOutlinedHelperName() const { return ".omp_outlined."; }
272
Alexey Bataev3c595a62017-08-14 15:01:03 +0000273 /// Emits \p Callee function call with arguments \p Args with location \p Loc.
Alexey Bataev7ef47a62018-02-22 18:33:31 +0000274 void emitCall(CodeGenFunction &CGF, SourceLocation Loc, llvm::Value *Callee,
275 ArrayRef<llvm::Value *> Args = llvm::None) const;
Alexey Bataev3c595a62017-08-14 15:01:03 +0000276
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000277 /// Emits address of the word in a memory where current thread id is
Alexey Bataevb7f3cba2018-03-19 17:04:07 +0000278 /// stored.
279 virtual Address emitThreadIDAddress(CodeGenFunction &CGF, SourceLocation Loc);
280
Alexey Bataevfd006c42018-10-05 15:08:53 +0000281 void setLocThreadIdInsertPt(CodeGenFunction &CGF,
282 bool AtCurrentPoint = false);
283 void clearLocThreadIdInsertPt(CodeGenFunction &CGF);
284
Alexey Bataevceeaa482018-11-21 21:04:34 +0000285 /// Check if the default location must be constant.
286 /// Default is false to support OMPT/OMPD.
287 virtual bool isDefaultLocationConstant() const { return false; }
288
289 /// Returns additional flags that can be stored in reserved_2 field of the
290 /// default location.
291 virtual unsigned getDefaultLocationReserved2Flags() const { return 0; }
292
Alexey Bataevc3028ca2018-12-04 15:03:25 +0000293 /// Returns default flags for the barriers depending on the directive, for
294 /// which this barier is going to be emitted.
295 static unsigned getDefaultFlagsForBarriers(OpenMPDirectiveKind Kind);
296
Alexey Bataeva1166022018-11-27 21:24:54 +0000297 /// Get the LLVM type for the critical name.
298 llvm::ArrayType *getKmpCriticalNameTy() const {return KmpCriticalNameTy;}
299
300 /// Returns corresponding lock object for the specified critical region
301 /// name. If the lock object does not exist it is created, otherwise the
302 /// reference to the existing copy is returned.
303 /// \param CriticalName Name of the critical region.
304 ///
305 llvm::Value *getCriticalRegionLock(StringRef CriticalName);
306
Arpith Chacko Jacob5c309e42016-03-22 01:48:56 +0000307private:
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000308 /// Default const ident_t object used for initialization of all other
Alexey Bataev9959db52014-05-06 10:08:46 +0000309 /// ident_t objects.
Alexey Bataevc5b1d322016-03-04 09:22:22 +0000310 llvm::Constant *DefaultOpenMPPSource = nullptr;
Alexey Bataevceeaa482018-11-21 21:04:34 +0000311 using FlagsTy = std::pair<unsigned, unsigned>;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000312 /// Map of flags and corresponding default locations.
Alexey Bataevceeaa482018-11-21 21:04:34 +0000313 using OpenMPDefaultLocMapTy = llvm::DenseMap<FlagsTy, llvm::Value *>;
Alexey Bataev15007ba2014-05-07 06:18:01 +0000314 OpenMPDefaultLocMapTy OpenMPDefaultLocMap;
Alexey Bataev50b3c952016-02-19 10:38:26 +0000315 Address getOrCreateDefaultLocation(unsigned Flags);
John McCall7f416cc2015-09-08 08:05:57 +0000316
Alexey Bataeva4fa0b82018-04-16 17:59:34 +0000317 QualType IdentQTy;
Alexey Bataev14fa1c62016-03-29 05:34:15 +0000318 llvm::StructType *IdentTy = nullptr;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000319 /// Map for SourceLocation and OpenMP runtime library debug locations.
Alexey Bataevf002aca2014-05-30 05:48:40 +0000320 typedef llvm::DenseMap<unsigned, llvm::Value *> OpenMPDebugLocMapTy;
321 OpenMPDebugLocMapTy OpenMPDebugLocMap;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000322 /// The type for a microtask which gets passed to __kmpc_fork_call().
Alexey Bataev9959db52014-05-06 10:08:46 +0000323 /// Original representation is:
324 /// typedef void (kmpc_micro)(kmp_int32 global_tid, kmp_int32 bound_tid,...);
Alexey Bataev14fa1c62016-03-29 05:34:15 +0000325 llvm::FunctionType *Kmpc_MicroTy = nullptr;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000326 /// Stores debug location and ThreadID for the function.
Alexey Bataev18095712014-10-10 12:19:54 +0000327 struct DebugLocThreadIdTy {
328 llvm::Value *DebugLoc;
329 llvm::Value *ThreadID;
Alexey Bataevfd006c42018-10-05 15:08:53 +0000330 /// Insert point for the service instructions.
331 llvm::AssertingVH<llvm::Instruction> ServiceInsertPt = nullptr;
Alexey Bataev18095712014-10-10 12:19:54 +0000332 };
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000333 /// Map of local debug location, ThreadId and functions.
Alexey Bataev18095712014-10-10 12:19:54 +0000334 typedef llvm::DenseMap<llvm::Function *, DebugLocThreadIdTy>
335 OpenMPLocThreadIDMapTy;
336 OpenMPLocThreadIDMapTy OpenMPLocThreadIDMap;
Alexey Bataevc5b1d322016-03-04 09:22:22 +0000337 /// Map of UDRs and corresponding combiner/initializer.
338 typedef llvm::DenseMap<const OMPDeclareReductionDecl *,
339 std::pair<llvm::Function *, llvm::Function *>>
340 UDRMapTy;
341 UDRMapTy UDRMap;
342 /// Map of functions and locally defined UDRs.
343 typedef llvm::DenseMap<llvm::Function *,
344 SmallVector<const OMPDeclareReductionDecl *, 4>>
345 FunctionUDRMapTy;
346 FunctionUDRMapTy FunctionUDRMap;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000347 /// Type kmp_critical_name, originally defined as typedef kmp_int32
Alexey Bataev3a3bf0b2014-09-22 10:01:53 +0000348 /// kmp_critical_name[8];
349 llvm::ArrayType *KmpCriticalNameTy;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000350 /// An ordered map of auto-generated variables to their unique names.
Alexey Bataev97720002014-11-11 04:05:39 +0000351 /// It stores variables with the following names: 1) ".gomp_critical_user_" +
352 /// <critical_section_name> + ".var" for "omp critical" directives; 2)
353 /// <mangled_name_for_global_var> + ".cache." for cache for threadprivate
354 /// variables.
355 llvm::StringMap<llvm::AssertingVH<llvm::Constant>, llvm::BumpPtrAllocator>
356 InternalVars;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000357 /// Type typedef kmp_int32 (* kmp_routine_entry_t)(kmp_int32, void *);
Alexey Bataevc5b1d322016-03-04 09:22:22 +0000358 llvm::Type *KmpRoutineEntryPtrTy = nullptr;
Alexey Bataev62b63b12015-03-10 07:28:44 +0000359 QualType KmpRoutineEntryPtrQTy;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000360 /// Type typedef struct kmp_task {
Alexey Bataev8fc69dc2015-05-18 07:54:53 +0000361 /// void * shareds; /**< pointer to block of pointers to
362 /// shared vars */
363 /// kmp_routine_entry_t routine; /**< pointer to routine to call for
364 /// executing task */
365 /// kmp_int32 part_id; /**< part id for the task */
366 /// kmp_routine_entry_t destructors; /* pointer to function to invoke
367 /// deconstructors of firstprivate C++ objects */
368 /// } kmp_task_t;
369 QualType KmpTaskTQTy;
Alexey Bataeve213f3e2017-10-11 15:29:40 +0000370 /// Saved kmp_task_t for task directive.
371 QualType SavedKmpTaskTQTy;
372 /// Saved kmp_task_t for taskloop-based directive.
373 QualType SavedKmpTaskloopTQTy;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000374 /// Type typedef struct kmp_depend_info {
Alexey Bataev1d2353d2015-06-24 11:01:36 +0000375 /// kmp_intptr_t base_addr;
376 /// size_t len;
377 /// struct {
378 /// bool in:1;
379 /// bool out:1;
380 /// } flags;
381 /// } kmp_depend_info_t;
382 QualType KmpDependInfoTy;
Alexey Bataev8b427062016-05-25 12:36:08 +0000383 /// struct kmp_dim { // loop bounds info casted to kmp_int64
384 /// kmp_int64 lo; // lower
385 /// kmp_int64 up; // upper
386 /// kmp_int64 st; // stride
387 /// };
388 QualType KmpDimTy;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000389 /// Type struct __tgt_offload_entry{
Samuel Antaoee8fb302016-01-06 13:42:12 +0000390 /// void *addr; // Pointer to the offload entry info.
391 /// // (function or global)
392 /// char *name; // Name of the function or global.
393 /// size_t size; // Size of the entry info (0 if it a function).
394 /// };
395 QualType TgtOffloadEntryQTy;
396 /// struct __tgt_device_image{
397 /// void *ImageStart; // Pointer to the target code start.
398 /// void *ImageEnd; // Pointer to the target code end.
399 /// // We also add the host entries to the device image, as it may be useful
400 /// // for the target runtime to have access to that information.
401 /// __tgt_offload_entry *EntriesBegin; // Begin of the table with all
402 /// // the entries.
403 /// __tgt_offload_entry *EntriesEnd; // End of the table with all the
404 /// // entries (non inclusive).
405 /// };
406 QualType TgtDeviceImageQTy;
407 /// struct __tgt_bin_desc{
408 /// int32_t NumDevices; // Number of devices supported.
409 /// __tgt_device_image *DeviceImages; // Arrays of device images
410 /// // (one per device).
411 /// __tgt_offload_entry *EntriesBegin; // Begin of the table with all the
412 /// // entries.
413 /// __tgt_offload_entry *EntriesEnd; // End of the table with all the
414 /// // entries (non inclusive).
415 /// };
416 QualType TgtBinaryDescriptorQTy;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000417 /// Entity that registers the offloading constants that were emitted so
Samuel Antaoee8fb302016-01-06 13:42:12 +0000418 /// far.
419 class OffloadEntriesInfoManagerTy {
420 CodeGenModule &CGM;
Alexey Bataev1d2353d2015-06-24 11:01:36 +0000421
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000422 /// Number of entries registered so far.
Alexey Bataev03f270c2018-03-30 18:31:07 +0000423 unsigned OffloadingEntriesNum = 0;
Samuel Antaoee8fb302016-01-06 13:42:12 +0000424
425 public:
Samuel Antaof83efdb2017-01-05 16:02:49 +0000426 /// Base class of the entries info.
Samuel Antaoee8fb302016-01-06 13:42:12 +0000427 class OffloadEntryInfo {
428 public:
Alexey Bataev34f8a702018-03-28 14:28:54 +0000429 /// Kind of a given entry.
Reid Klecknerdc78f952016-01-11 20:55:16 +0000430 enum OffloadingEntryInfoKinds : unsigned {
Alexey Bataev34f8a702018-03-28 14:28:54 +0000431 /// Entry is a target region.
432 OffloadingEntryInfoTargetRegion = 0,
Alexey Bataev03f270c2018-03-30 18:31:07 +0000433 /// Entry is a declare target variable.
434 OffloadingEntryInfoDeviceGlobalVar = 1,
Alexey Bataev34f8a702018-03-28 14:28:54 +0000435 /// Invalid entry info.
436 OffloadingEntryInfoInvalid = ~0u
Samuel Antaoee8fb302016-01-06 13:42:12 +0000437 };
438
Alexey Bataev03f270c2018-03-30 18:31:07 +0000439 protected:
440 OffloadEntryInfo() = delete;
441 explicit OffloadEntryInfo(OffloadingEntryInfoKinds Kind) : Kind(Kind) {}
Samuel Antaof83efdb2017-01-05 16:02:49 +0000442 explicit OffloadEntryInfo(OffloadingEntryInfoKinds Kind, unsigned Order,
Alexey Bataev03f270c2018-03-30 18:31:07 +0000443 uint32_t Flags)
Samuel Antaof83efdb2017-01-05 16:02:49 +0000444 : Flags(Flags), Order(Order), Kind(Kind) {}
Alexey Bataev03f270c2018-03-30 18:31:07 +0000445 ~OffloadEntryInfo() = default;
Samuel Antaoee8fb302016-01-06 13:42:12 +0000446
Alexey Bataev03f270c2018-03-30 18:31:07 +0000447 public:
Samuel Antaoee8fb302016-01-06 13:42:12 +0000448 bool isValid() const { return Order != ~0u; }
449 unsigned getOrder() const { return Order; }
450 OffloadingEntryInfoKinds getKind() const { return Kind; }
Alexey Bataev03f270c2018-03-30 18:31:07 +0000451 uint32_t getFlags() const { return Flags; }
452 void setFlags(uint32_t NewFlags) { Flags = NewFlags; }
453 llvm::Constant *getAddress() const {
454 return cast_or_null<llvm::Constant>(Addr);
455 }
456 void setAddress(llvm::Constant *V) {
457 assert(!Addr.pointsToAliveValue() && "Address has been set before!");
458 Addr = V;
459 }
Samuel Antaoee8fb302016-01-06 13:42:12 +0000460 static bool classof(const OffloadEntryInfo *Info) { return true; }
461
Samuel Antaof83efdb2017-01-05 16:02:49 +0000462 private:
Alexey Bataev03f270c2018-03-30 18:31:07 +0000463 /// Address of the entity that has to be mapped for offloading.
464 llvm::WeakTrackingVH Addr;
465
Samuel Antaof83efdb2017-01-05 16:02:49 +0000466 /// Flags associated with the device global.
Alexey Bataev03f270c2018-03-30 18:31:07 +0000467 uint32_t Flags = 0u;
Samuel Antaof83efdb2017-01-05 16:02:49 +0000468
469 /// Order this entry was emitted.
Alexey Bataev03f270c2018-03-30 18:31:07 +0000470 unsigned Order = ~0u;
Samuel Antaoee8fb302016-01-06 13:42:12 +0000471
Alexey Bataev03f270c2018-03-30 18:31:07 +0000472 OffloadingEntryInfoKinds Kind = OffloadingEntryInfoInvalid;
Samuel Antaoee8fb302016-01-06 13:42:12 +0000473 };
474
Alexey Bataev03f270c2018-03-30 18:31:07 +0000475 /// Return true if a there are no entries defined.
Samuel Antaoee8fb302016-01-06 13:42:12 +0000476 bool empty() const;
Alexey Bataev03f270c2018-03-30 18:31:07 +0000477 /// Return number of entries defined so far.
Samuel Antaoee8fb302016-01-06 13:42:12 +0000478 unsigned size() const { return OffloadingEntriesNum; }
Alexey Bataev03f270c2018-03-30 18:31:07 +0000479 OffloadEntriesInfoManagerTy(CodeGenModule &CGM) : CGM(CGM) {}
Samuel Antaoee8fb302016-01-06 13:42:12 +0000480
Alexey Bataev03f270c2018-03-30 18:31:07 +0000481 //
482 // Target region entries related.
483 //
484
485 /// Kind of the target registry entry.
486 enum OMPTargetRegionEntryKind : uint32_t {
487 /// Mark the entry as target region.
488 OMPTargetRegionEntryTargetRegion = 0x0,
489 /// Mark the entry as a global constructor.
490 OMPTargetRegionEntryCtor = 0x02,
491 /// Mark the entry as a global destructor.
492 OMPTargetRegionEntryDtor = 0x04,
493 };
494
495 /// Target region entries info.
496 class OffloadEntryInfoTargetRegion final : public OffloadEntryInfo {
497 /// Address that can be used as the ID of the entry.
498 llvm::Constant *ID = nullptr;
Samuel Antaoee8fb302016-01-06 13:42:12 +0000499
500 public:
501 OffloadEntryInfoTargetRegion()
Alexey Bataev03f270c2018-03-30 18:31:07 +0000502 : OffloadEntryInfo(OffloadingEntryInfoTargetRegion) {}
Samuel Antaoee8fb302016-01-06 13:42:12 +0000503 explicit OffloadEntryInfoTargetRegion(unsigned Order,
504 llvm::Constant *Addr,
Alexey Bataev34f8a702018-03-28 14:28:54 +0000505 llvm::Constant *ID,
506 OMPTargetRegionEntryKind Flags)
507 : OffloadEntryInfo(OffloadingEntryInfoTargetRegion, Order, Flags),
Alexey Bataev03f270c2018-03-30 18:31:07 +0000508 ID(ID) {
509 setAddress(Addr);
Samuel Antaoee8fb302016-01-06 13:42:12 +0000510 }
Alexey Bataev03f270c2018-03-30 18:31:07 +0000511
512 llvm::Constant *getID() const { return ID; }
Samuel Antaoee8fb302016-01-06 13:42:12 +0000513 void setID(llvm::Constant *V) {
Alexey Bataev34f8a702018-03-28 14:28:54 +0000514 assert(!ID && "ID has been set before!");
Samuel Antaoee8fb302016-01-06 13:42:12 +0000515 ID = V;
516 }
517 static bool classof(const OffloadEntryInfo *Info) {
Alexey Bataev34f8a702018-03-28 14:28:54 +0000518 return Info->getKind() == OffloadingEntryInfoTargetRegion;
Samuel Antaoee8fb302016-01-06 13:42:12 +0000519 }
520 };
Alexey Bataev03f270c2018-03-30 18:31:07 +0000521
522 /// Initialize target region entry.
Samuel Antaoee8fb302016-01-06 13:42:12 +0000523 void initializeTargetRegionEntryInfo(unsigned DeviceID, unsigned FileID,
524 StringRef ParentName, unsigned LineNum,
Samuel Antao2de62b02016-02-13 23:35:10 +0000525 unsigned Order);
Alexey Bataev03f270c2018-03-30 18:31:07 +0000526 /// Register target region entry.
Samuel Antaoee8fb302016-01-06 13:42:12 +0000527 void registerTargetRegionEntryInfo(unsigned DeviceID, unsigned FileID,
528 StringRef ParentName, unsigned LineNum,
Samuel Antaof83efdb2017-01-05 16:02:49 +0000529 llvm::Constant *Addr, llvm::Constant *ID,
Alexey Bataev34f8a702018-03-28 14:28:54 +0000530 OMPTargetRegionEntryKind Flags);
Alexey Bataev03f270c2018-03-30 18:31:07 +0000531 /// Return true if a target region entry with the provided information
532 /// exists.
Samuel Antaoee8fb302016-01-06 13:42:12 +0000533 bool hasTargetRegionEntryInfo(unsigned DeviceID, unsigned FileID,
Samuel Antao2de62b02016-02-13 23:35:10 +0000534 StringRef ParentName, unsigned LineNum) const;
Samuel Antaoee8fb302016-01-06 13:42:12 +0000535 /// brief Applies action \a Action on all registered entries.
536 typedef llvm::function_ref<void(unsigned, unsigned, StringRef, unsigned,
Alexey Bataev03f270c2018-03-30 18:31:07 +0000537 const OffloadEntryInfoTargetRegion &)>
Samuel Antaoee8fb302016-01-06 13:42:12 +0000538 OffloadTargetRegionEntryInfoActTy;
539 void actOnTargetRegionEntriesInfo(
540 const OffloadTargetRegionEntryInfoActTy &Action);
541
Alexey Bataev03f270c2018-03-30 18:31:07 +0000542 //
543 // Device global variable entries related.
544 //
545
546 /// Kind of the global variable entry..
547 enum OMPTargetGlobalVarEntryKind : uint32_t {
548 /// Mark the entry as a to declare target.
549 OMPTargetGlobalVarEntryTo = 0x0,
Alexey Bataevc52f01d2018-07-16 20:05:25 +0000550 /// Mark the entry as a to declare target link.
551 OMPTargetGlobalVarEntryLink = 0x1,
Alexey Bataev03f270c2018-03-30 18:31:07 +0000552 };
553
554 /// Device global variable entries info.
555 class OffloadEntryInfoDeviceGlobalVar final : public OffloadEntryInfo {
556 /// Type of the global variable.
557 CharUnits VarSize;
558 llvm::GlobalValue::LinkageTypes Linkage;
559
560 public:
561 OffloadEntryInfoDeviceGlobalVar()
562 : OffloadEntryInfo(OffloadingEntryInfoDeviceGlobalVar) {}
563 explicit OffloadEntryInfoDeviceGlobalVar(unsigned Order,
564 OMPTargetGlobalVarEntryKind Flags)
565 : OffloadEntryInfo(OffloadingEntryInfoDeviceGlobalVar, Order, Flags) {}
566 explicit OffloadEntryInfoDeviceGlobalVar(
567 unsigned Order, llvm::Constant *Addr, CharUnits VarSize,
568 OMPTargetGlobalVarEntryKind Flags,
569 llvm::GlobalValue::LinkageTypes Linkage)
570 : OffloadEntryInfo(OffloadingEntryInfoDeviceGlobalVar, Order, Flags),
571 VarSize(VarSize), Linkage(Linkage) {
572 setAddress(Addr);
573 }
574
575 CharUnits getVarSize() const { return VarSize; }
576 void setVarSize(CharUnits Size) { VarSize = Size; }
577 llvm::GlobalValue::LinkageTypes getLinkage() const { return Linkage; }
578 void setLinkage(llvm::GlobalValue::LinkageTypes LT) { Linkage = LT; }
579 static bool classof(const OffloadEntryInfo *Info) {
580 return Info->getKind() == OffloadingEntryInfoDeviceGlobalVar;
581 }
582 };
583
584 /// Initialize device global variable entry.
585 void initializeDeviceGlobalVarEntryInfo(StringRef Name,
586 OMPTargetGlobalVarEntryKind Flags,
587 unsigned Order);
588
589 /// Register device global variable entry.
590 void
591 registerDeviceGlobalVarEntryInfo(StringRef VarName, llvm::Constant *Addr,
592 CharUnits VarSize,
593 OMPTargetGlobalVarEntryKind Flags,
594 llvm::GlobalValue::LinkageTypes Linkage);
595 /// Checks if the variable with the given name has been registered already.
596 bool hasDeviceGlobalVarEntryInfo(StringRef VarName) const {
597 return OffloadEntriesDeviceGlobalVar.count(VarName) > 0;
598 }
599 /// Applies action \a Action on all registered entries.
600 typedef llvm::function_ref<void(StringRef,
601 const OffloadEntryInfoDeviceGlobalVar &)>
602 OffloadDeviceGlobalVarEntryInfoActTy;
603 void actOnDeviceGlobalVarEntriesInfo(
604 const OffloadDeviceGlobalVarEntryInfoActTy &Action);
605
Samuel Antaoee8fb302016-01-06 13:42:12 +0000606 private:
607 // Storage for target region entries kind. The storage is to be indexed by
Samuel Antao2de62b02016-02-13 23:35:10 +0000608 // file ID, device ID, parent function name and line number.
Samuel Antaoee8fb302016-01-06 13:42:12 +0000609 typedef llvm::DenseMap<unsigned, OffloadEntryInfoTargetRegion>
Samuel Antaoee8fb302016-01-06 13:42:12 +0000610 OffloadEntriesTargetRegionPerLine;
611 typedef llvm::StringMap<OffloadEntriesTargetRegionPerLine>
612 OffloadEntriesTargetRegionPerParentName;
613 typedef llvm::DenseMap<unsigned, OffloadEntriesTargetRegionPerParentName>
614 OffloadEntriesTargetRegionPerFile;
615 typedef llvm::DenseMap<unsigned, OffloadEntriesTargetRegionPerFile>
616 OffloadEntriesTargetRegionPerDevice;
617 typedef OffloadEntriesTargetRegionPerDevice OffloadEntriesTargetRegionTy;
618 OffloadEntriesTargetRegionTy OffloadEntriesTargetRegion;
Alexey Bataev03f270c2018-03-30 18:31:07 +0000619 /// Storage for device global variable entries kind. The storage is to be
620 /// indexed by mangled name.
621 typedef llvm::StringMap<OffloadEntryInfoDeviceGlobalVar>
622 OffloadEntriesDeviceGlobalVarTy;
623 OffloadEntriesDeviceGlobalVarTy OffloadEntriesDeviceGlobalVar;
Samuel Antaoee8fb302016-01-06 13:42:12 +0000624 };
625 OffloadEntriesInfoManagerTy OffloadEntriesInfoManager;
626
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +0000627 bool ShouldMarkAsGlobal = true;
Alexey Bataev2a6f3f52018-11-07 19:11:14 +0000628 /// List of the emitted functions.
629 llvm::StringSet<> AlreadyEmittedTargetFunctions;
630 /// List of the global variables with their addresses that should not be
631 /// emitted for the target.
632 llvm::StringMap<llvm::WeakTrackingVH> EmittedNonTargetVariables;
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +0000633
Alexey Bataevbf8fe712018-08-07 16:14:36 +0000634 /// List of variables that can become declare target implicitly and, thus,
635 /// must be emitted.
636 llvm::SmallDenseSet<const VarDecl *> DeferredGlobalVariables;
637
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000638 /// Creates and registers offloading binary descriptor for the current
Samuel Antaoee8fb302016-01-06 13:42:12 +0000639 /// compilation unit. The function that does the registration is returned.
640 llvm::Function *createOffloadingBinaryDescriptorRegistration();
641
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000642 /// Creates all the offload entries in the current compilation unit
Samuel Antaoee8fb302016-01-06 13:42:12 +0000643 /// along with the associated metadata.
644 void createOffloadEntriesAndInfoMetadata();
645
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000646 /// Loads all the offload entries information from the host IR
Samuel Antaoee8fb302016-01-06 13:42:12 +0000647 /// metadata.
648 void loadOffloadInfoMetadata();
649
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000650 /// Returns __tgt_offload_entry type.
Samuel Antaoee8fb302016-01-06 13:42:12 +0000651 QualType getTgtOffloadEntryQTy();
652
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000653 /// Returns __tgt_device_image type.
Samuel Antaoee8fb302016-01-06 13:42:12 +0000654 QualType getTgtDeviceImageQTy();
655
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000656 /// Returns __tgt_bin_desc type.
Samuel Antaoee8fb302016-01-06 13:42:12 +0000657 QualType getTgtBinaryDescriptorQTy();
658
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000659 /// Start scanning from statement \a S and and emit all target regions
Samuel Antaoee8fb302016-01-06 13:42:12 +0000660 /// found along the way.
661 /// \param S Starting statement.
662 /// \param ParentName Name of the function declaration that is being scanned.
663 void scanForTargetRegionsFunctions(const Stmt *S, StringRef ParentName);
Alexey Bataev62b63b12015-03-10 07:28:44 +0000664
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000665 /// Build type kmp_routine_entry_t (if not built yet).
Alexey Bataev62b63b12015-03-10 07:28:44 +0000666 void emitKmpRoutineEntryT(QualType KmpInt32Ty);
Alexey Bataev9959db52014-05-06 10:08:46 +0000667
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000668 /// Returns pointer to kmpc_micro type.
Alexey Bataev9959db52014-05-06 10:08:46 +0000669 llvm::Type *getKmpc_MicroPointerTy();
670
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000671 /// Returns specified OpenMP runtime function.
Alexey Bataev9959db52014-05-06 10:08:46 +0000672 /// \param Function OpenMP runtime function.
673 /// \return Specified function.
Alexey Bataev50b3c952016-02-19 10:38:26 +0000674 llvm::Constant *createRuntimeFunction(unsigned Function);
Alexey Bataev3a3bf0b2014-09-22 10:01:53 +0000675
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000676 /// Returns __kmpc_for_static_init_* runtime function for the specified
Alexander Musman21212e42015-03-13 10:38:23 +0000677 /// size \a IVSize and sign \a IVSigned.
678 llvm::Constant *createForStaticInitFunction(unsigned IVSize, bool IVSigned);
679
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000680 /// Returns __kmpc_dispatch_init_* runtime function for the specified
Alexander Musman92bdaab2015-03-12 13:37:50 +0000681 /// size \a IVSize and sign \a IVSigned.
682 llvm::Constant *createDispatchInitFunction(unsigned IVSize, bool IVSigned);
683
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000684 /// Returns __kmpc_dispatch_next_* runtime function for the specified
Alexander Musman92bdaab2015-03-12 13:37:50 +0000685 /// size \a IVSize and sign \a IVSigned.
686 llvm::Constant *createDispatchNextFunction(unsigned IVSize, bool IVSigned);
687
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000688 /// Returns __kmpc_dispatch_fini_* runtime function for the specified
Alexey Bataev98eb6e32015-04-22 11:15:40 +0000689 /// size \a IVSize and sign \a IVSigned.
690 llvm::Constant *createDispatchFiniFunction(unsigned IVSize, bool IVSigned);
691
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000692 /// If the specified mangled name is not in the module, create and
Alexey Bataev97720002014-11-11 04:05:39 +0000693 /// return threadprivate cache object. This object is a pointer's worth of
694 /// storage that's reserved for use by the OpenMP runtime.
NAKAMURA Takumicdcbfba2014-11-11 07:58:06 +0000695 /// \param VD Threadprivate variable.
Alexey Bataev97720002014-11-11 04:05:39 +0000696 /// \return Cache variable for the specified threadprivate.
697 llvm::Constant *getOrCreateThreadPrivateCache(const VarDecl *VD);
698
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000699 /// Gets (if variable with the given name already exist) or creates
Alexey Bataev97720002014-11-11 04:05:39 +0000700 /// internal global variable with the specified Name. The created variable has
701 /// linkage CommonLinkage by default and is initialized by null value.
702 /// \param Ty Type of the global variable. If it is exist already the type
703 /// must be the same.
704 /// \param Name Name of the variable.
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000705 llvm::Constant *getOrCreateInternalVariable(llvm::Type *Ty,
Alexey Bataev97720002014-11-11 04:05:39 +0000706 const llvm::Twine &Name);
707
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000708 /// Set of threadprivate variables with the generated initializer.
Alexey Bataev2a6f3f52018-11-07 19:11:14 +0000709 llvm::StringSet<> ThreadPrivateWithDefinition;
Alexey Bataev97720002014-11-11 04:05:39 +0000710
Alexey Bataev34f8a702018-03-28 14:28:54 +0000711 /// Set of declare target variables with the generated initializer.
Alexey Bataev2a6f3f52018-11-07 19:11:14 +0000712 llvm::StringSet<> DeclareTargetWithDefinition;
Alexey Bataev34f8a702018-03-28 14:28:54 +0000713
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000714 /// Emits initialization code for the threadprivate variables.
Alexey Bataev97720002014-11-11 04:05:39 +0000715 /// \param VDAddr Address of the global variable \a VD.
716 /// \param Ctor Pointer to a global init function for \a VD.
717 /// \param CopyCtor Pointer to a global copy function for \a VD.
718 /// \param Dtor Pointer to a global destructor function for \a VD.
719 /// \param Loc Location of threadprivate declaration.
John McCall7f416cc2015-09-08 08:05:57 +0000720 void emitThreadPrivateVarInit(CodeGenFunction &CGF, Address VDAddr,
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000721 llvm::Value *Ctor, llvm::Value *CopyCtor,
722 llvm::Value *Dtor, SourceLocation Loc);
Alexey Bataev97720002014-11-11 04:05:39 +0000723
Alexey Bataev24b5bae2016-04-28 09:23:51 +0000724 struct TaskResultTy {
725 llvm::Value *NewTask = nullptr;
726 llvm::Value *TaskEntry = nullptr;
727 llvm::Value *NewTaskNewTaskTTy = nullptr;
Alexey Bataev7292c292016-04-25 12:22:29 +0000728 LValue TDBase;
Alexey Bataeva4fa0b82018-04-16 17:59:34 +0000729 const RecordDecl *KmpTaskTQTyRD = nullptr;
Alexey Bataevf93095a2016-05-05 08:46:22 +0000730 llvm::Value *TaskDupFn = nullptr;
Alexey Bataev7292c292016-04-25 12:22:29 +0000731 };
732 /// Emit task region for the task directive. The task region is emitted in
733 /// several steps:
734 /// 1. Emit a call to kmp_task_t *__kmpc_omp_task_alloc(ident_t *, kmp_int32
735 /// gtid, kmp_int32 flags, size_t sizeof_kmp_task_t, size_t sizeof_shareds,
736 /// kmp_routine_entry_t *task_entry). Here task_entry is a pointer to the
737 /// function:
738 /// kmp_int32 .omp_task_entry.(kmp_int32 gtid, kmp_task_t *tt) {
739 /// TaskFunction(gtid, tt->part_id, tt->shareds);
740 /// return 0;
741 /// }
742 /// 2. Copy a list of shared variables to field shareds of the resulting
743 /// structure kmp_task_t returned by the previous call (if any).
744 /// 3. Copy a pointer to destructions function to field destructions of the
745 /// resulting structure kmp_task_t.
746 /// \param D Current task directive.
Alexey Bataev7292c292016-04-25 12:22:29 +0000747 /// \param TaskFunction An LLVM function with type void (*)(i32 /*gtid*/, i32
748 /// /*part_id*/, captured_struct */*__context*/);
749 /// \param SharedsTy A type which contains references the shared variables.
750 /// \param Shareds Context with the list of shared variables from the \p
751 /// TaskFunction.
Alexey Bataev24b5bae2016-04-28 09:23:51 +0000752 /// \param Data Additional data for task generation like tiednsee, final
753 /// state, list of privates etc.
754 TaskResultTy emitTaskInit(CodeGenFunction &CGF, SourceLocation Loc,
755 const OMPExecutableDirective &D,
756 llvm::Value *TaskFunction, QualType SharedsTy,
757 Address Shareds, const OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +0000758
Alexey Bataev4a5bb772014-10-08 14:01:46 +0000759public:
Alexey Bataev18fa2322018-05-02 14:20:50 +0000760 explicit CGOpenMPRuntime(CodeGenModule &CGM)
761 : CGOpenMPRuntime(CGM, ".", ".") {}
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000762 virtual ~CGOpenMPRuntime() {}
Alexey Bataev91797552015-03-18 04:13:55 +0000763 virtual void clear();
Alexey Bataev4a5bb772014-10-08 14:01:46 +0000764
Alexey Bataev18fa2322018-05-02 14:20:50 +0000765 /// Get the platform-specific name separator.
766 std::string getName(ArrayRef<StringRef> Parts) const;
767
Alexey Bataevc5b1d322016-03-04 09:22:22 +0000768 /// Emit code for the specified user defined reduction construct.
769 virtual void emitUserDefinedReduction(CodeGenFunction *CGF,
770 const OMPDeclareReductionDecl *D);
Alexey Bataeva839ddd2016-03-17 10:19:46 +0000771 /// Get combiner/initializer for the specified user-defined reduction, if any.
772 virtual std::pair<llvm::Function *, llvm::Function *>
773 getUserDefinedReduction(const OMPDeclareReductionDecl *D);
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +0000774
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000775 /// Emits outlined function for the specified OpenMP parallel directive
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000776 /// \a D. This outlined function has type void(*)(kmp_int32 *ThreadID,
777 /// kmp_int32 BoundID, struct context_vars*).
Alexey Bataev18095712014-10-10 12:19:54 +0000778 /// \param D OpenMP directive.
779 /// \param ThreadIDVar Variable for thread id in the current OpenMP region.
Alexey Bataev81c7ea02015-07-03 09:56:58 +0000780 /// \param InnermostKind Kind of innermost directive (for simple directives it
781 /// is a directive itself, for combined - its innermost directive).
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000782 /// \param CodeGen Code generation sequence for the \a D directive.
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +0000783 virtual llvm::Value *emitParallelOutlinedFunction(
784 const OMPExecutableDirective &D, const VarDecl *ThreadIDVar,
785 OpenMPDirectiveKind InnermostKind, const RegionCodeGenTy &CodeGen);
786
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000787 /// Emits outlined function for the specified OpenMP teams directive
Arpith Chacko Jacob19b911c2017-01-18 18:18:53 +0000788 /// \a D. This outlined function has type void(*)(kmp_int32 *ThreadID,
789 /// kmp_int32 BoundID, struct context_vars*).
790 /// \param D OpenMP directive.
791 /// \param ThreadIDVar Variable for thread id in the current OpenMP region.
792 /// \param InnermostKind Kind of innermost directive (for simple directives it
793 /// is a directive itself, for combined - its innermost directive).
794 /// \param CodeGen Code generation sequence for the \a D directive.
795 virtual llvm::Value *emitTeamsOutlinedFunction(
Alexey Bataev81c7ea02015-07-03 09:56:58 +0000796 const OMPExecutableDirective &D, const VarDecl *ThreadIDVar,
797 OpenMPDirectiveKind InnermostKind, const RegionCodeGenTy &CodeGen);
Alexey Bataev18095712014-10-10 12:19:54 +0000798
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000799 /// Emits outlined function for the OpenMP task directive \a D. This
Alexey Bataev48591dd2016-04-20 04:01:36 +0000800 /// outlined function has type void(*)(kmp_int32 ThreadID, struct task_t*
801 /// TaskT).
Alexey Bataev62b63b12015-03-10 07:28:44 +0000802 /// \param D OpenMP directive.
803 /// \param ThreadIDVar Variable for thread id in the current OpenMP region.
Alexey Bataev48591dd2016-04-20 04:01:36 +0000804 /// \param PartIDVar Variable for partition id in the current OpenMP untied
805 /// task region.
806 /// \param TaskTVar Variable for task_t argument.
Alexey Bataev81c7ea02015-07-03 09:56:58 +0000807 /// \param InnermostKind Kind of innermost directive (for simple directives it
808 /// is a directive itself, for combined - its innermost directive).
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000809 /// \param CodeGen Code generation sequence for the \a D directive.
Alexey Bataev48591dd2016-04-20 04:01:36 +0000810 /// \param Tied true if task is generated for tied task, false otherwise.
811 /// \param NumberOfParts Number of parts in untied task. Ignored for tied
812 /// tasks.
Alexey Bataev62b63b12015-03-10 07:28:44 +0000813 ///
Alexey Bataev81c7ea02015-07-03 09:56:58 +0000814 virtual llvm::Value *emitTaskOutlinedFunction(
815 const OMPExecutableDirective &D, const VarDecl *ThreadIDVar,
Alexey Bataev48591dd2016-04-20 04:01:36 +0000816 const VarDecl *PartIDVar, const VarDecl *TaskTVar,
817 OpenMPDirectiveKind InnermostKind, const RegionCodeGenTy &CodeGen,
818 bool Tied, unsigned &NumberOfParts);
Alexey Bataev62b63b12015-03-10 07:28:44 +0000819
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000820 /// Cleans up references to the objects in finished function.
Alexey Bataev4a5bb772014-10-08 14:01:46 +0000821 ///
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +0000822 virtual void functionFinished(CodeGenFunction &CGF);
Alexey Bataev4a5bb772014-10-08 14:01:46 +0000823
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000824 /// Emits code for parallel or serial call of the \a OutlinedFn with
Alexey Bataev1d677132015-04-22 13:57:31 +0000825 /// variables captured in a record which address is stored in \a
826 /// CapturedStruct.
Alexey Bataev18095712014-10-10 12:19:54 +0000827 /// \param OutlinedFn Outlined function to be run in parallel threads. Type of
Alexey Bataev62b63b12015-03-10 07:28:44 +0000828 /// this function is void(*)(kmp_int32 *, kmp_int32, struct context_vars*).
NAKAMURA Takumi62f0eb52015-09-11 08:13:32 +0000829 /// \param CapturedVars A pointer to the record with the references to
Alexey Bataev4a5bb772014-10-08 14:01:46 +0000830 /// variables used in \a OutlinedFn function.
Alexey Bataev1d677132015-04-22 13:57:31 +0000831 /// \param IfCond Condition in the associated 'if' clause, if it was
832 /// specified, nullptr otherwise.
Alexey Bataev4a5bb772014-10-08 14:01:46 +0000833 ///
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000834 virtual void emitParallelCall(CodeGenFunction &CGF, SourceLocation Loc,
835 llvm::Value *OutlinedFn,
Alexey Bataev2377fe92015-09-10 08:12:02 +0000836 ArrayRef<llvm::Value *> CapturedVars,
837 const Expr *IfCond);
Alexey Bataevd74d0602014-10-13 06:02:40 +0000838
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000839 /// Emits a critical region.
Alexey Bataev18095712014-10-10 12:19:54 +0000840 /// \param CriticalName Name of the critical region.
Alexey Bataev75ddfab2014-12-01 11:32:38 +0000841 /// \param CriticalOpGen Generator for the statement associated with the given
842 /// critical region.
Alexey Bataevfc57d162015-12-15 10:55:09 +0000843 /// \param Hint Value of the 'hint' clause (optional).
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000844 virtual void emitCriticalRegion(CodeGenFunction &CGF, StringRef CriticalName,
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000845 const RegionCodeGenTy &CriticalOpGen,
Alexey Bataevfc57d162015-12-15 10:55:09 +0000846 SourceLocation Loc,
847 const Expr *Hint = nullptr);
Alexey Bataev4a5bb772014-10-08 14:01:46 +0000848
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000849 /// Emits a master region.
Alexey Bataev8d690652014-12-04 07:23:53 +0000850 /// \param MasterOpGen Generator for the statement associated with the given
851 /// master region.
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000852 virtual void emitMasterRegion(CodeGenFunction &CGF,
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000853 const RegionCodeGenTy &MasterOpGen,
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000854 SourceLocation Loc);
Alexey Bataev8d690652014-12-04 07:23:53 +0000855
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000856 /// Emits code for a taskyield directive.
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000857 virtual void emitTaskyieldCall(CodeGenFunction &CGF, SourceLocation Loc);
Alexey Bataev9f797f32015-02-05 05:57:51 +0000858
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000859 /// Emit a taskgroup region.
Alexey Bataevc30dd2d2015-06-18 12:14:09 +0000860 /// \param TaskgroupOpGen Generator for the statement associated with the
861 /// given taskgroup region.
862 virtual void emitTaskgroupRegion(CodeGenFunction &CGF,
863 const RegionCodeGenTy &TaskgroupOpGen,
864 SourceLocation Loc);
865
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000866 /// Emits a single region.
Alexey Bataev6956e2e2015-02-05 06:35:41 +0000867 /// \param SingleOpGen Generator for the statement associated with the given
868 /// single region.
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000869 virtual void emitSingleRegion(CodeGenFunction &CGF,
Alexey Bataev6f1ffc02015-04-10 04:50:10 +0000870 const RegionCodeGenTy &SingleOpGen,
Alexey Bataeva63048e2015-03-23 06:18:07 +0000871 SourceLocation Loc,
872 ArrayRef<const Expr *> CopyprivateVars,
Alexey Bataev420d45b2015-04-14 05:11:24 +0000873 ArrayRef<const Expr *> DestExprs,
Alexey Bataeva63048e2015-03-23 06:18:07 +0000874 ArrayRef<const Expr *> SrcExprs,
Alexey Bataeva63048e2015-03-23 06:18:07 +0000875 ArrayRef<const Expr *> AssignmentOps);
Alexey Bataev6956e2e2015-02-05 06:35:41 +0000876
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000877 /// Emit an ordered region.
Alexey Bataev98eb6e32015-04-22 11:15:40 +0000878 /// \param OrderedOpGen Generator for the statement associated with the given
Alexey Bataevc30dd2d2015-06-18 12:14:09 +0000879 /// ordered region.
Alexey Bataev98eb6e32015-04-22 11:15:40 +0000880 virtual void emitOrderedRegion(CodeGenFunction &CGF,
881 const RegionCodeGenTy &OrderedOpGen,
Alexey Bataev5f600d62015-09-29 03:48:57 +0000882 SourceLocation Loc, bool IsThreads);
Alexey Bataev98eb6e32015-04-22 11:15:40 +0000883
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000884 /// Emit an implicit/explicit barrier for OpenMP threads.
Alexey Bataevf2685682015-03-30 04:30:22 +0000885 /// \param Kind Directive for which this implicit barrier call must be
886 /// generated. Must be OMPD_barrier for explicit barrier generation.
Alexey Bataev25e5b442015-09-15 12:52:43 +0000887 /// \param EmitChecks true if need to emit checks for cancellation barriers.
888 /// \param ForceSimpleCall true simple barrier call must be emitted, false if
889 /// runtime class decides which one to emit (simple or with cancellation
890 /// checks).
Alexey Bataev4a5bb772014-10-08 14:01:46 +0000891 ///
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000892 virtual void emitBarrierCall(CodeGenFunction &CGF, SourceLocation Loc,
Alexey Bataev81c7ea02015-07-03 09:56:58 +0000893 OpenMPDirectiveKind Kind,
Alexey Bataev25e5b442015-09-15 12:52:43 +0000894 bool EmitChecks = true,
895 bool ForceSimpleCall = false);
Alexey Bataevb2059782014-10-13 08:23:51 +0000896
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000897 /// Check if the specified \a ScheduleKind is static non-chunked.
Alexander Musmanc6388682014-12-15 07:07:06 +0000898 /// This kind of worksharing directive is emitted without outer loop.
899 /// \param ScheduleKind Schedule kind specified in the 'schedule' clause.
900 /// \param Chunked True if chunk is specified in the clause.
901 ///
902 virtual bool isStaticNonchunked(OpenMPScheduleClauseKind ScheduleKind,
903 bool Chunked) const;
904
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000905 /// Check if the specified \a ScheduleKind is static non-chunked.
Carlo Bertollifc35ad22016-03-07 16:04:49 +0000906 /// This kind of distribute directive is emitted without outer loop.
907 /// \param ScheduleKind Schedule kind specified in the 'dist_schedule' clause.
908 /// \param Chunked True if chunk is specified in the clause.
909 ///
910 virtual bool isStaticNonchunked(OpenMPDistScheduleClauseKind ScheduleKind,
911 bool Chunked) const;
912
Gheorghe-Teodor Berceae9256762018-10-29 15:45:47 +0000913 /// Check if the specified \a ScheduleKind is static chunked.
914 /// \param ScheduleKind Schedule kind specified in the 'schedule' clause.
915 /// \param Chunked True if chunk is specified in the clause.
916 ///
917 virtual bool isStaticChunked(OpenMPScheduleClauseKind ScheduleKind,
918 bool Chunked) const;
919
920 /// Check if the specified \a ScheduleKind is static non-chunked.
921 /// \param ScheduleKind Schedule kind specified in the 'dist_schedule' clause.
922 /// \param Chunked True if chunk is specified in the clause.
923 ///
924 virtual bool isStaticChunked(OpenMPDistScheduleClauseKind ScheduleKind,
925 bool Chunked) const;
926
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000927 /// Check if the specified \a ScheduleKind is dynamic.
Alexander Musmandf7a8e22015-01-22 08:49:35 +0000928 /// This kind of worksharing directive is emitted without outer loop.
929 /// \param ScheduleKind Schedule Kind specified in the 'schedule' clause.
930 ///
931 virtual bool isDynamic(OpenMPScheduleClauseKind ScheduleKind) const;
932
Carlo Bertollib0ff0a62017-04-25 17:52:12 +0000933 /// struct with the values to be passed to the dispatch runtime function
934 struct DispatchRTInput {
935 /// Loop lower bound
936 llvm::Value *LB = nullptr;
937 /// Loop upper bound
938 llvm::Value *UB = nullptr;
939 /// Chunk size specified using 'schedule' clause (nullptr if chunk
940 /// was not specified)
941 llvm::Value *Chunk = nullptr;
942 DispatchRTInput() = default;
943 DispatchRTInput(llvm::Value *LB, llvm::Value *UB, llvm::Value *Chunk)
944 : LB(LB), UB(UB), Chunk(Chunk) {}
945 };
946
947 /// Call the appropriate runtime routine to initialize it before start
948 /// of loop.
949
950 /// This is used for non static scheduled types and when the ordered
951 /// clause is present on the loop construct.
952 /// Depending on the loop schedule, it is necessary to call some runtime
953 /// routine before start of the OpenMP loop to get the loop upper / lower
954 /// bounds \a LB and \a UB and stride \a ST.
955 ///
956 /// \param CGF Reference to current CodeGenFunction.
957 /// \param Loc Clang source location.
958 /// \param ScheduleKind Schedule kind, specified by the 'schedule' clause.
959 /// \param IVSize Size of the iteration variable in bits.
Simon Pilgrim6c0eeff2017-07-13 17:34:44 +0000960 /// \param IVSigned Sign of the iteration variable.
Carlo Bertollib0ff0a62017-04-25 17:52:12 +0000961 /// \param Ordered true if loop is ordered, false otherwise.
962 /// \param DispatchValues struct containing llvm values for lower bound, upper
963 /// bound, and chunk expression.
964 /// For the default (nullptr) value, the chunk 1 will be used.
965 ///
NAKAMURA Takumiff7a9252015-09-08 09:42:41 +0000966 virtual void emitForDispatchInit(CodeGenFunction &CGF, SourceLocation Loc,
Alexey Bataev9ebd7422016-05-10 09:57:36 +0000967 const OpenMPScheduleTy &ScheduleKind,
968 unsigned IVSize, bool IVSigned, bool Ordered,
Carlo Bertollib0ff0a62017-04-25 17:52:12 +0000969 const DispatchRTInput &DispatchValues);
NAKAMURA Takumiff7a9252015-09-08 09:42:41 +0000970
Alexey Bataev0f87dbe2017-08-14 17:56:13 +0000971 /// Struct with the values to be passed to the static runtime function
972 struct StaticRTInput {
973 /// Size of the iteration variable in bits.
974 unsigned IVSize = 0;
975 /// Sign of the iteration variable.
976 bool IVSigned = false;
977 /// true if loop is ordered, false otherwise.
978 bool Ordered = false;
979 /// Address of the output variable in which the flag of the last iteration
980 /// is returned.
981 Address IL = Address::invalid();
982 /// Address of the output variable in which the lower iteration number is
983 /// returned.
984 Address LB = Address::invalid();
985 /// Address of the output variable in which the upper iteration number is
986 /// returned.
987 Address UB = Address::invalid();
988 /// Address of the output variable in which the stride value is returned
989 /// necessary to generated the static_chunked scheduled loop.
990 Address ST = Address::invalid();
991 /// Value of the chunk for the static_chunked scheduled loop. For the
992 /// default (nullptr) value, the chunk 1 will be used.
993 llvm::Value *Chunk = nullptr;
994 StaticRTInput(unsigned IVSize, bool IVSigned, bool Ordered, Address IL,
995 Address LB, Address UB, Address ST,
996 llvm::Value *Chunk = nullptr)
997 : IVSize(IVSize), IVSigned(IVSigned), Ordered(Ordered), IL(IL), LB(LB),
998 UB(UB), ST(ST), Chunk(Chunk) {}
999 };
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001000 /// Call the appropriate runtime routine to initialize it before start
Alexander Musmanc6388682014-12-15 07:07:06 +00001001 /// of loop.
1002 ///
Carlo Bertollib0ff0a62017-04-25 17:52:12 +00001003 /// This is used only in case of static schedule, when the user did not
1004 /// specify a ordered clause on the loop construct.
1005 /// Depending on the loop schedule, it is necessary to call some runtime
Alexander Musmanc6388682014-12-15 07:07:06 +00001006 /// routine before start of the OpenMP loop to get the loop upper / lower
Alexey Bataev0f87dbe2017-08-14 17:56:13 +00001007 /// bounds LB and UB and stride ST.
Alexander Musmanc6388682014-12-15 07:07:06 +00001008 ///
1009 /// \param CGF Reference to current CodeGenFunction.
1010 /// \param Loc Clang source location.
Alexey Bataev0f87dbe2017-08-14 17:56:13 +00001011 /// \param DKind Kind of the directive.
Alexey Bataev9ebd7422016-05-10 09:57:36 +00001012 /// \param ScheduleKind Schedule kind, specified by the 'schedule' clause.
Alexey Bataev0f87dbe2017-08-14 17:56:13 +00001013 /// \param Values Input arguments for the construct.
Alexander Musmanc6388682014-12-15 07:07:06 +00001014 ///
John McCall7f416cc2015-09-08 08:05:57 +00001015 virtual void emitForStaticInit(CodeGenFunction &CGF, SourceLocation Loc,
Alexey Bataev0f87dbe2017-08-14 17:56:13 +00001016 OpenMPDirectiveKind DKind,
Alexey Bataev9ebd7422016-05-10 09:57:36 +00001017 const OpenMPScheduleTy &ScheduleKind,
Alexey Bataev0f87dbe2017-08-14 17:56:13 +00001018 const StaticRTInput &Values);
Alexander Musmanc6388682014-12-15 07:07:06 +00001019
Carlo Bertollifc35ad22016-03-07 16:04:49 +00001020 ///
1021 /// \param CGF Reference to current CodeGenFunction.
1022 /// \param Loc Clang source location.
1023 /// \param SchedKind Schedule kind, specified by the 'dist_schedule' clause.
Alexey Bataev0f87dbe2017-08-14 17:56:13 +00001024 /// \param Values Input arguments for the construct.
Carlo Bertollifc35ad22016-03-07 16:04:49 +00001025 ///
Alexey Bataev0f87dbe2017-08-14 17:56:13 +00001026 virtual void emitDistributeStaticInit(CodeGenFunction &CGF,
1027 SourceLocation Loc,
Carlo Bertollifc35ad22016-03-07 16:04:49 +00001028 OpenMPDistScheduleClauseKind SchedKind,
Alexey Bataev0f87dbe2017-08-14 17:56:13 +00001029 const StaticRTInput &Values);
Carlo Bertollifc35ad22016-03-07 16:04:49 +00001030
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001031 /// Call the appropriate runtime routine to notify that we finished
Alexey Bataev98eb6e32015-04-22 11:15:40 +00001032 /// iteration of the ordered loop with the dynamic scheduling.
1033 ///
1034 /// \param CGF Reference to current CodeGenFunction.
1035 /// \param Loc Clang source location.
1036 /// \param IVSize Size of the iteration variable in bits.
Simon Pilgrim6c0eeff2017-07-13 17:34:44 +00001037 /// \param IVSigned Sign of the iteration variable.
Alexey Bataev98eb6e32015-04-22 11:15:40 +00001038 ///
Alexey Bataevd7589ffe2015-05-20 13:12:48 +00001039 virtual void emitForOrderedIterationEnd(CodeGenFunction &CGF,
1040 SourceLocation Loc, unsigned IVSize,
1041 bool IVSigned);
Alexey Bataev98eb6e32015-04-22 11:15:40 +00001042
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001043 /// Call the appropriate runtime routine to notify that we finished
Alexander Musmanc6388682014-12-15 07:07:06 +00001044 /// all the work with current loop.
1045 ///
1046 /// \param CGF Reference to current CodeGenFunction.
1047 /// \param Loc Clang source location.
Alexey Bataevf43f7142017-09-06 16:17:35 +00001048 /// \param DKind Kind of the directive for which the static finish is emitted.
Alexander Musmanc6388682014-12-15 07:07:06 +00001049 ///
Alexey Bataevf43f7142017-09-06 16:17:35 +00001050 virtual void emitForStaticFinish(CodeGenFunction &CGF, SourceLocation Loc,
1051 OpenMPDirectiveKind DKind);
Alexander Musmanc6388682014-12-15 07:07:06 +00001052
Alexander Musman92bdaab2015-03-12 13:37:50 +00001053 /// Call __kmpc_dispatch_next(
1054 /// ident_t *loc, kmp_int32 tid, kmp_int32 *p_lastiter,
1055 /// kmp_int[32|64] *p_lower, kmp_int[32|64] *p_upper,
1056 /// kmp_int[32|64] *p_stride);
1057 /// \param IVSize Size of the iteration variable in bits.
Simon Pilgrim6c0eeff2017-07-13 17:34:44 +00001058 /// \param IVSigned Sign of the iteration variable.
Alexander Musman92bdaab2015-03-12 13:37:50 +00001059 /// \param IL Address of the output variable in which the flag of the
1060 /// last iteration is returned.
1061 /// \param LB Address of the output variable in which the lower iteration
1062 /// number is returned.
1063 /// \param UB Address of the output variable in which the upper iteration
1064 /// number is returned.
1065 /// \param ST Address of the output variable in which the stride value is
1066 /// returned.
1067 virtual llvm::Value *emitForNext(CodeGenFunction &CGF, SourceLocation Loc,
1068 unsigned IVSize, bool IVSigned,
John McCall7f416cc2015-09-08 08:05:57 +00001069 Address IL, Address LB,
1070 Address UB, Address ST);
Alexander Musman92bdaab2015-03-12 13:37:50 +00001071
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001072 /// Emits call to void __kmpc_push_num_threads(ident_t *loc, kmp_int32
Alexey Bataevb2059782014-10-13 08:23:51 +00001073 /// global_tid, kmp_int32 num_threads) to generate code for 'num_threads'
1074 /// clause.
1075 /// \param NumThreads An integer value of threads.
Alexey Bataev3eff5f42015-02-25 08:32:46 +00001076 virtual void emitNumThreadsClause(CodeGenFunction &CGF,
1077 llvm::Value *NumThreads,
1078 SourceLocation Loc);
Alexey Bataev97720002014-11-11 04:05:39 +00001079
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001080 /// Emit call to void __kmpc_push_proc_bind(ident_t *loc, kmp_int32
Alexey Bataev7f210c62015-06-18 13:40:03 +00001081 /// global_tid, int proc_bind) to generate code for 'proc_bind' clause.
1082 virtual void emitProcBindClause(CodeGenFunction &CGF,
1083 OpenMPProcBindClauseKind ProcBind,
1084 SourceLocation Loc);
1085
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001086 /// Returns address of the threadprivate variable for the current
Alexey Bataev97720002014-11-11 04:05:39 +00001087 /// thread.
NAKAMURA Takumicdcbfba2014-11-11 07:58:06 +00001088 /// \param VD Threadprivate variable.
Alexey Bataev97720002014-11-11 04:05:39 +00001089 /// \param VDAddr Address of the global variable \a VD.
1090 /// \param Loc Location of the reference to threadprivate var.
1091 /// \return Address of the threadprivate variable for the current thread.
John McCall7f416cc2015-09-08 08:05:57 +00001092 virtual Address getAddrOfThreadPrivate(CodeGenFunction &CGF,
1093 const VarDecl *VD,
1094 Address VDAddr,
1095 SourceLocation Loc);
Alexey Bataev97720002014-11-11 04:05:39 +00001096
Alexey Bataev92327c52018-03-26 16:40:55 +00001097 /// Returns the address of the variable marked as declare target with link
1098 /// clause.
Alexey Bataev03f270c2018-03-30 18:31:07 +00001099 virtual Address getAddrOfDeclareTargetLink(const VarDecl *VD);
Alexey Bataev92327c52018-03-26 16:40:55 +00001100
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001101 /// Emit a code for initialization of threadprivate variable. It emits
Alexey Bataev97720002014-11-11 04:05:39 +00001102 /// a call to runtime library which adds initial value to the newly created
1103 /// threadprivate variable (if it is not constant) and registers destructor
1104 /// for the variable (if any).
1105 /// \param VD Threadprivate variable.
1106 /// \param VDAddr Address of the global variable \a VD.
1107 /// \param Loc Location of threadprivate declaration.
1108 /// \param PerformInit true if initialization expression is not constant.
1109 virtual llvm::Function *
John McCall7f416cc2015-09-08 08:05:57 +00001110 emitThreadPrivateVarDefinition(const VarDecl *VD, Address VDAddr,
Alexey Bataev3eff5f42015-02-25 08:32:46 +00001111 SourceLocation Loc, bool PerformInit,
1112 CodeGenFunction *CGF = nullptr);
Alexey Bataevcc37cc12014-11-20 04:34:54 +00001113
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001114 /// Emit a code for initialization of declare target variable.
Alexey Bataev34f8a702018-03-28 14:28:54 +00001115 /// \param VD Declare target variable.
1116 /// \param Addr Address of the global variable \a VD.
1117 /// \param PerformInit true if initialization expression is not constant.
1118 virtual bool emitDeclareTargetVarDefinition(const VarDecl *VD,
1119 llvm::GlobalVariable *Addr,
1120 bool PerformInit);
1121
Alexey Bataevbe5a8b42017-07-17 13:30:36 +00001122 /// Creates artificial threadprivate variable with name \p Name and type \p
1123 /// VarType.
1124 /// \param VarType Type of the artificial threadprivate variable.
1125 /// \param Name Name of the artificial threadprivate variable.
1126 virtual Address getAddrOfArtificialThreadPrivate(CodeGenFunction &CGF,
1127 QualType VarType,
1128 StringRef Name);
1129
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001130 /// Emit flush of the variables specified in 'omp flush' directive.
Alexey Bataevcc37cc12014-11-20 04:34:54 +00001131 /// \param Vars List of variables to flush.
Alexey Bataev3eff5f42015-02-25 08:32:46 +00001132 virtual void emitFlush(CodeGenFunction &CGF, ArrayRef<const Expr *> Vars,
1133 SourceLocation Loc);
Alexey Bataev62b63b12015-03-10 07:28:44 +00001134
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001135 /// Emit task region for the task directive. The task region is
Nico Weber20b0ce32015-04-28 18:19:18 +00001136 /// emitted in several steps:
Alexey Bataev62b63b12015-03-10 07:28:44 +00001137 /// 1. Emit a call to kmp_task_t *__kmpc_omp_task_alloc(ident_t *, kmp_int32
1138 /// gtid, kmp_int32 flags, size_t sizeof_kmp_task_t, size_t sizeof_shareds,
1139 /// kmp_routine_entry_t *task_entry). Here task_entry is a pointer to the
1140 /// function:
1141 /// kmp_int32 .omp_task_entry.(kmp_int32 gtid, kmp_task_t *tt) {
1142 /// TaskFunction(gtid, tt->part_id, tt->shareds);
1143 /// return 0;
1144 /// }
1145 /// 2. Copy a list of shared variables to field shareds of the resulting
1146 /// structure kmp_task_t returned by the previous call (if any).
1147 /// 3. Copy a pointer to destructions function to field destructions of the
1148 /// resulting structure kmp_task_t.
1149 /// 4. Emit a call to kmp_int32 __kmpc_omp_task(ident_t *, kmp_int32 gtid,
1150 /// kmp_task_t *new_task), where new_task is a resulting structure from
1151 /// previous items.
Alexey Bataev36c1eb92015-04-30 06:51:57 +00001152 /// \param D Current task directive.
Alexey Bataev62b63b12015-03-10 07:28:44 +00001153 /// \param TaskFunction An LLVM function with type void (*)(i32 /*gtid*/, i32
1154 /// /*part_id*/, captured_struct */*__context*/);
1155 /// \param SharedsTy A type which contains references the shared variables.
Alexey Bataev1d2353d2015-06-24 11:01:36 +00001156 /// \param Shareds Context with the list of shared variables from the \p
Alexey Bataev62b63b12015-03-10 07:28:44 +00001157 /// TaskFunction.
Alexey Bataev1d677132015-04-22 13:57:31 +00001158 /// \param IfCond Not a nullptr if 'if' clause was specified, nullptr
1159 /// otherwise.
Alexey Bataev24b5bae2016-04-28 09:23:51 +00001160 /// \param Data Additional data for task generation like tiednsee, final
1161 /// state, list of privates etc.
1162 virtual void emitTaskCall(CodeGenFunction &CGF, SourceLocation Loc,
1163 const OMPExecutableDirective &D,
1164 llvm::Value *TaskFunction, QualType SharedsTy,
1165 Address Shareds, const Expr *IfCond,
1166 const OMPTaskDataTy &Data);
Alexey Bataev794ba0d2015-04-10 10:43:45 +00001167
Alexey Bataev7292c292016-04-25 12:22:29 +00001168 /// Emit task region for the taskloop directive. The taskloop region is
1169 /// emitted in several steps:
1170 /// 1. Emit a call to kmp_task_t *__kmpc_omp_task_alloc(ident_t *, kmp_int32
1171 /// gtid, kmp_int32 flags, size_t sizeof_kmp_task_t, size_t sizeof_shareds,
1172 /// kmp_routine_entry_t *task_entry). Here task_entry is a pointer to the
1173 /// function:
1174 /// kmp_int32 .omp_task_entry.(kmp_int32 gtid, kmp_task_t *tt) {
1175 /// TaskFunction(gtid, tt->part_id, tt->shareds);
1176 /// return 0;
1177 /// }
1178 /// 2. Copy a list of shared variables to field shareds of the resulting
1179 /// structure kmp_task_t returned by the previous call (if any).
1180 /// 3. Copy a pointer to destructions function to field destructions of the
1181 /// resulting structure kmp_task_t.
1182 /// 4. Emit a call to void __kmpc_taskloop(ident_t *loc, int gtid, kmp_task_t
1183 /// *task, int if_val, kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int
1184 /// nogroup, int sched, kmp_uint64 grainsize, void *task_dup ), where new_task
1185 /// is a resulting structure from
1186 /// previous items.
1187 /// \param D Current task directive.
Alexey Bataev7292c292016-04-25 12:22:29 +00001188 /// \param TaskFunction An LLVM function with type void (*)(i32 /*gtid*/, i32
1189 /// /*part_id*/, captured_struct */*__context*/);
1190 /// \param SharedsTy A type which contains references the shared variables.
1191 /// \param Shareds Context with the list of shared variables from the \p
1192 /// TaskFunction.
1193 /// \param IfCond Not a nullptr if 'if' clause was specified, nullptr
1194 /// otherwise.
Alexey Bataev24b5bae2016-04-28 09:23:51 +00001195 /// \param Data Additional data for task generation like tiednsee, final
1196 /// state, list of privates etc.
Alexey Bataev7292c292016-04-25 12:22:29 +00001197 virtual void emitTaskLoopCall(
1198 CodeGenFunction &CGF, SourceLocation Loc, const OMPLoopDirective &D,
Alexey Bataev24b5bae2016-04-28 09:23:51 +00001199 llvm::Value *TaskFunction, QualType SharedsTy, Address Shareds,
1200 const Expr *IfCond, const OMPTaskDataTy &Data);
Alexey Bataev7292c292016-04-25 12:22:29 +00001201
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001202 /// Emit code for the directive that does not require outlining.
Alexey Bataev6f1ffc02015-04-10 04:50:10 +00001203 ///
Alexey Bataev81c7ea02015-07-03 09:56:58 +00001204 /// \param InnermostKind Kind of innermost directive (for simple directives it
1205 /// is a directive itself, for combined - its innermost directive).
Alexey Bataev6f1ffc02015-04-10 04:50:10 +00001206 /// \param CodeGen Code generation sequence for the \a D directive.
Alexey Bataev25e5b442015-09-15 12:52:43 +00001207 /// \param HasCancel true if region has inner cancel directive, false
1208 /// otherwise.
Alexey Bataev6f1ffc02015-04-10 04:50:10 +00001209 virtual void emitInlinedDirective(CodeGenFunction &CGF,
Alexey Bataev81c7ea02015-07-03 09:56:58 +00001210 OpenMPDirectiveKind InnermostKind,
Alexey Bataev25e5b442015-09-15 12:52:43 +00001211 const RegionCodeGenTy &CodeGen,
1212 bool HasCancel = false);
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00001213
1214 /// Emits reduction function.
1215 /// \param ArgsType Array type containing pointers to reduction variables.
1216 /// \param Privates List of private copies for original reduction arguments.
1217 /// \param LHSExprs List of LHS in \a ReductionOps reduction operations.
1218 /// \param RHSExprs List of RHS in \a ReductionOps reduction operations.
1219 /// \param ReductionOps List of reduction operations in form 'LHS binop RHS'
1220 /// or 'operator binop(LHS, RHS)'.
Alexey Bataev7cae94e2018-01-04 19:45:16 +00001221 llvm::Value *emitReductionFunction(CodeGenModule &CGM, SourceLocation Loc,
1222 llvm::Type *ArgsType,
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00001223 ArrayRef<const Expr *> Privates,
1224 ArrayRef<const Expr *> LHSExprs,
1225 ArrayRef<const Expr *> RHSExprs,
1226 ArrayRef<const Expr *> ReductionOps);
1227
1228 /// Emits single reduction combiner
1229 void emitSingleReductionCombiner(CodeGenFunction &CGF,
1230 const Expr *ReductionOp,
1231 const Expr *PrivateRef,
1232 const DeclRefExpr *LHS,
1233 const DeclRefExpr *RHS);
1234
1235 struct ReductionOptionsTy {
1236 bool WithNowait;
1237 bool SimpleReduction;
1238 OpenMPDirectiveKind ReductionKind;
1239 };
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001240 /// Emit a code for reduction clause. Next code should be emitted for
Alexey Bataev794ba0d2015-04-10 10:43:45 +00001241 /// reduction:
1242 /// \code
1243 ///
1244 /// static kmp_critical_name lock = { 0 };
1245 ///
1246 /// void reduce_func(void *lhs[<n>], void *rhs[<n>]) {
1247 /// ...
1248 /// *(Type<i>*)lhs[i] = RedOp<i>(*(Type<i>*)lhs[i], *(Type<i>*)rhs[i]);
1249 /// ...
1250 /// }
1251 ///
1252 /// ...
1253 /// void *RedList[<n>] = {&<RHSExprs>[0], ..., &<RHSExprs>[<n>-1]};
1254 /// switch (__kmpc_reduce{_nowait}(<loc>, <gtid>, <n>, sizeof(RedList),
1255 /// RedList, reduce_func, &<lock>)) {
1256 /// case 1:
1257 /// ...
1258 /// <LHSExprs>[i] = RedOp<i>(*<LHSExprs>[i], *<RHSExprs>[i]);
1259 /// ...
1260 /// __kmpc_end_reduce{_nowait}(<loc>, <gtid>, &<lock>);
1261 /// break;
1262 /// case 2:
1263 /// ...
1264 /// Atomic(<LHSExprs>[i] = RedOp<i>(*<LHSExprs>[i], *<RHSExprs>[i]));
1265 /// ...
1266 /// break;
1267 /// default:;
1268 /// }
1269 /// \endcode
1270 ///
Alexey Bataevf24e7b12015-10-08 09:10:53 +00001271 /// \param Privates List of private copies for original reduction arguments.
Alexey Bataev794ba0d2015-04-10 10:43:45 +00001272 /// \param LHSExprs List of LHS in \a ReductionOps reduction operations.
1273 /// \param RHSExprs List of RHS in \a ReductionOps reduction operations.
1274 /// \param ReductionOps List of reduction operations in form 'LHS binop RHS'
1275 /// or 'operator binop(LHS, RHS)'.
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00001276 /// \param Options List of options for reduction codegen:
1277 /// WithNowait true if parent directive has also nowait clause, false
1278 /// otherwise.
1279 /// SimpleReduction Emit reduction operation only. Used for omp simd
1280 /// directive on the host.
1281 /// ReductionKind The kind of reduction to perform.
Alexey Bataev794ba0d2015-04-10 10:43:45 +00001282 virtual void emitReduction(CodeGenFunction &CGF, SourceLocation Loc,
Alexey Bataevf24e7b12015-10-08 09:10:53 +00001283 ArrayRef<const Expr *> Privates,
Alexey Bataev794ba0d2015-04-10 10:43:45 +00001284 ArrayRef<const Expr *> LHSExprs,
1285 ArrayRef<const Expr *> RHSExprs,
1286 ArrayRef<const Expr *> ReductionOps,
Arpith Chacko Jacob101e8fb2017-02-16 16:20:16 +00001287 ReductionOptionsTy Options);
Alexey Bataev8b8e2022015-04-27 05:22:09 +00001288
Alexey Bataevbe5a8b42017-07-17 13:30:36 +00001289 /// Emit a code for initialization of task reduction clause. Next code
1290 /// should be emitted for reduction:
1291 /// \code
1292 ///
1293 /// _task_red_item_t red_data[n];
1294 /// ...
1295 /// red_data[i].shar = &origs[i];
1296 /// red_data[i].size = sizeof(origs[i]);
1297 /// red_data[i].f_init = (void*)RedInit<i>;
1298 /// red_data[i].f_fini = (void*)RedDest<i>;
1299 /// red_data[i].f_comb = (void*)RedOp<i>;
1300 /// red_data[i].flags = <Flag_i>;
1301 /// ...
1302 /// void* tg1 = __kmpc_task_reduction_init(gtid, n, red_data);
1303 /// \endcode
1304 ///
1305 /// \param LHSExprs List of LHS in \a Data.ReductionOps reduction operations.
1306 /// \param RHSExprs List of RHS in \a Data.ReductionOps reduction operations.
1307 /// \param Data Additional data for task generation like tiedness, final
1308 /// state, list of privates, reductions etc.
1309 virtual llvm::Value *emitTaskReductionInit(CodeGenFunction &CGF,
1310 SourceLocation Loc,
1311 ArrayRef<const Expr *> LHSExprs,
1312 ArrayRef<const Expr *> RHSExprs,
1313 const OMPTaskDataTy &Data);
1314
1315 /// Required to resolve existing problems in the runtime. Emits threadprivate
1316 /// variables to store the size of the VLAs/array sections for
1317 /// initializer/combiner/finalizer functions + emits threadprivate variable to
1318 /// store the pointer to the original reduction item for the custom
1319 /// initializer defined by declare reduction construct.
1320 /// \param RCG Allows to reuse an existing data for the reductions.
1321 /// \param N Reduction item for which fixups must be emitted.
1322 virtual void emitTaskReductionFixups(CodeGenFunction &CGF, SourceLocation Loc,
1323 ReductionCodeGen &RCG, unsigned N);
1324
1325 /// Get the address of `void *` type of the privatue copy of the reduction
1326 /// item specified by the \p SharedLVal.
1327 /// \param ReductionsPtr Pointer to the reduction data returned by the
1328 /// emitTaskReductionInit function.
1329 /// \param SharedLVal Address of the original reduction item.
1330 virtual Address getTaskReductionItem(CodeGenFunction &CGF, SourceLocation Loc,
1331 llvm::Value *ReductionsPtr,
1332 LValue SharedLVal);
1333
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001334 /// Emit code for 'taskwait' directive.
Alexey Bataev8b8e2022015-04-27 05:22:09 +00001335 virtual void emitTaskwaitCall(CodeGenFunction &CGF, SourceLocation Loc);
Alexey Bataev0f34da12015-07-02 04:17:07 +00001336
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001337 /// Emit code for 'cancellation point' construct.
Alexey Bataev0f34da12015-07-02 04:17:07 +00001338 /// \param CancelRegion Region kind for which the cancellation point must be
1339 /// emitted.
1340 ///
1341 virtual void emitCancellationPointCall(CodeGenFunction &CGF,
1342 SourceLocation Loc,
1343 OpenMPDirectiveKind CancelRegion);
Alexey Bataev7d5d33e2015-07-06 05:50:32 +00001344
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001345 /// Emit code for 'cancel' construct.
Alexey Bataev87933c72015-09-18 08:07:34 +00001346 /// \param IfCond Condition in the associated 'if' clause, if it was
1347 /// specified, nullptr otherwise.
Alexey Bataev7d5d33e2015-07-06 05:50:32 +00001348 /// \param CancelRegion Region kind for which the cancel must be emitted.
1349 ///
1350 virtual void emitCancelCall(CodeGenFunction &CGF, SourceLocation Loc,
Alexey Bataev87933c72015-09-18 08:07:34 +00001351 const Expr *IfCond,
Alexey Bataev7d5d33e2015-07-06 05:50:32 +00001352 OpenMPDirectiveKind CancelRegion);
Samuel Antaobed3c462015-10-02 16:14:20 +00001353
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001354 /// Emit outilined function for 'target' directive.
Samuel Antaobed3c462015-10-02 16:14:20 +00001355 /// \param D Directive to emit.
Samuel Antaoee8fb302016-01-06 13:42:12 +00001356 /// \param ParentName Name of the function that encloses the target region.
1357 /// \param OutlinedFn Outlined function value to be defined by this call.
1358 /// \param OutlinedFnID Outlined function ID value to be defined by this call.
1359 /// \param IsOffloadEntry True if the outlined function is an offload entry.
Alexey Bataev14fa1c62016-03-29 05:34:15 +00001360 /// \param CodeGen Code generation sequence for the \a D directive.
Simon Pilgrim6c0eeff2017-07-13 17:34:44 +00001361 /// An outlined function may not be an entry if, e.g. the if clause always
Samuel Antaoee8fb302016-01-06 13:42:12 +00001362 /// evaluates to false.
1363 virtual void emitTargetOutlinedFunction(const OMPExecutableDirective &D,
1364 StringRef ParentName,
1365 llvm::Function *&OutlinedFn,
1366 llvm::Constant *&OutlinedFnID,
Alexey Bataev14fa1c62016-03-29 05:34:15 +00001367 bool IsOffloadEntry,
1368 const RegionCodeGenTy &CodeGen);
Samuel Antaobed3c462015-10-02 16:14:20 +00001369
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001370 /// Emit the target offloading code associated with \a D. The emitted
Samuel Antaobed3c462015-10-02 16:14:20 +00001371 /// code attempts offloading the execution to the device, an the event of
1372 /// a failure it executes the host version outlined in \a OutlinedFn.
1373 /// \param D Directive to emit.
1374 /// \param OutlinedFn Host version of the code to be offloaded.
Samuel Antaoee8fb302016-01-06 13:42:12 +00001375 /// \param OutlinedFnID ID of host version of the code to be offloaded.
Samuel Antaobed3c462015-10-02 16:14:20 +00001376 /// \param IfCond Expression evaluated in if clause associated with the target
1377 /// directive, or null if no if clause is used.
1378 /// \param Device Expression evaluated in device clause associated with the
1379 /// target directive, or null if no device clause is used.
Samuel Antaobed3c462015-10-02 16:14:20 +00001380 virtual void emitTargetCall(CodeGenFunction &CGF,
1381 const OMPExecutableDirective &D,
Samuel Antaoee8fb302016-01-06 13:42:12 +00001382 llvm::Value *OutlinedFn,
1383 llvm::Value *OutlinedFnID, const Expr *IfCond,
Alexey Bataev8451efa2018-01-15 19:06:12 +00001384 const Expr *Device);
Samuel Antaoee8fb302016-01-06 13:42:12 +00001385
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001386 /// Emit the target regions enclosed in \a GD function definition or
Samuel Antaoee8fb302016-01-06 13:42:12 +00001387 /// the function itself in case it is a valid device function. Returns true if
1388 /// \a GD was dealt with successfully.
Nico Webera2abe8c2016-01-06 19:13:49 +00001389 /// \param GD Function to scan.
Samuel Antaoee8fb302016-01-06 13:42:12 +00001390 virtual bool emitTargetFunctions(GlobalDecl GD);
1391
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001392 /// Emit the global variable if it is a valid device global variable.
Samuel Antaoee8fb302016-01-06 13:42:12 +00001393 /// Returns true if \a GD was dealt with successfully.
1394 /// \param GD Variable declaration to emit.
1395 virtual bool emitTargetGlobalVariable(GlobalDecl GD);
1396
Alexey Bataev03f270c2018-03-30 18:31:07 +00001397 /// Checks if the provided global decl \a GD is a declare target variable and
1398 /// registers it when emitting code for the host.
1399 virtual void registerTargetGlobalVariable(const VarDecl *VD,
1400 llvm::Constant *Addr);
1401
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001402 /// Emit the global \a GD if it is meaningful for the target. Returns
Simon Pilgrim2c518802017-03-30 14:13:19 +00001403 /// if it was emitted successfully.
Samuel Antaoee8fb302016-01-06 13:42:12 +00001404 /// \param GD Global to scan.
1405 virtual bool emitTargetGlobal(GlobalDecl GD);
1406
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001407 /// Creates the offloading descriptor in the event any target region
Samuel Antaoee8fb302016-01-06 13:42:12 +00001408 /// was emitted in the current module and return the function that registers
1409 /// it.
1410 virtual llvm::Function *emitRegistrationFunction();
Carlo Bertolli430d8ec2016-03-03 20:34:23 +00001411
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001412 /// Emits code for teams call of the \a OutlinedFn with
Carlo Bertolli430d8ec2016-03-03 20:34:23 +00001413 /// variables captured in a record which address is stored in \a
1414 /// CapturedStruct.
1415 /// \param OutlinedFn Outlined function to be run by team masters. Type of
1416 /// this function is void(*)(kmp_int32 *, kmp_int32, struct context_vars*).
1417 /// \param CapturedVars A pointer to the record with the references to
1418 /// variables used in \a OutlinedFn function.
1419 ///
1420 virtual void emitTeamsCall(CodeGenFunction &CGF,
1421 const OMPExecutableDirective &D,
1422 SourceLocation Loc, llvm::Value *OutlinedFn,
1423 ArrayRef<llvm::Value *> CapturedVars);
1424
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001425 /// Emits call to void __kmpc_push_num_teams(ident_t *loc, kmp_int32
Carlo Bertolli430d8ec2016-03-03 20:34:23 +00001426 /// global_tid, kmp_int32 num_teams, kmp_int32 thread_limit) to generate code
1427 /// for num_teams clause.
Carlo Bertollic6872252016-04-04 15:55:02 +00001428 /// \param NumTeams An integer expression of teams.
1429 /// \param ThreadLimit An integer expression of threads.
1430 virtual void emitNumTeamsClause(CodeGenFunction &CGF, const Expr *NumTeams,
1431 const Expr *ThreadLimit, SourceLocation Loc);
Samuel Antaodf158d52016-04-27 22:58:19 +00001432
Samuel Antaocc10b852016-07-28 14:23:26 +00001433 /// Struct that keeps all the relevant information that should be kept
1434 /// throughout a 'target data' region.
1435 class TargetDataInfo {
1436 /// Set to true if device pointer information have to be obtained.
1437 bool RequiresDevicePointerInfo = false;
1438
1439 public:
1440 /// The array of base pointer passed to the runtime library.
1441 llvm::Value *BasePointersArray = nullptr;
1442 /// The array of section pointers passed to the runtime library.
1443 llvm::Value *PointersArray = nullptr;
1444 /// The array of sizes passed to the runtime library.
1445 llvm::Value *SizesArray = nullptr;
1446 /// The array of map types passed to the runtime library.
1447 llvm::Value *MapTypesArray = nullptr;
1448 /// The total number of pointers passed to the runtime library.
1449 unsigned NumberOfPtrs = 0u;
1450 /// Map between the a declaration of a capture and the corresponding base
1451 /// pointer address where the runtime returns the device pointers.
1452 llvm::DenseMap<const ValueDecl *, Address> CaptureDeviceAddrMap;
1453
1454 explicit TargetDataInfo() {}
1455 explicit TargetDataInfo(bool RequiresDevicePointerInfo)
1456 : RequiresDevicePointerInfo(RequiresDevicePointerInfo) {}
1457 /// Clear information about the data arrays.
1458 void clearArrayInfo() {
1459 BasePointersArray = nullptr;
1460 PointersArray = nullptr;
1461 SizesArray = nullptr;
1462 MapTypesArray = nullptr;
1463 NumberOfPtrs = 0u;
1464 }
1465 /// Return true if the current target data information has valid arrays.
1466 bool isValid() {
1467 return BasePointersArray && PointersArray && SizesArray &&
1468 MapTypesArray && NumberOfPtrs;
1469 }
1470 bool requiresDevicePointerInfo() { return RequiresDevicePointerInfo; }
1471 };
1472
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001473 /// Emit the target data mapping code associated with \a D.
Samuel Antaodf158d52016-04-27 22:58:19 +00001474 /// \param D Directive to emit.
Samuel Antaocc10b852016-07-28 14:23:26 +00001475 /// \param IfCond Expression evaluated in if clause associated with the
1476 /// target directive, or null if no device clause is used.
Samuel Antaodf158d52016-04-27 22:58:19 +00001477 /// \param Device Expression evaluated in device clause associated with the
1478 /// target directive, or null if no device clause is used.
Samuel Antaocc10b852016-07-28 14:23:26 +00001479 /// \param Info A record used to store information that needs to be preserved
1480 /// until the region is closed.
Samuel Antaodf158d52016-04-27 22:58:19 +00001481 virtual void emitTargetDataCalls(CodeGenFunction &CGF,
1482 const OMPExecutableDirective &D,
1483 const Expr *IfCond, const Expr *Device,
Samuel Antaocc10b852016-07-28 14:23:26 +00001484 const RegionCodeGenTy &CodeGen,
1485 TargetDataInfo &Info);
Samuel Antaobd0ae2e2016-04-27 23:07:29 +00001486
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001487 /// Emit the data mapping/movement code associated with the directive
Samuel Antao8d2d7302016-05-26 18:30:22 +00001488 /// \a D that should be of the form 'target [{enter|exit} data | update]'.
Samuel Antaobd0ae2e2016-04-27 23:07:29 +00001489 /// \param D Directive to emit.
1490 /// \param IfCond Expression evaluated in if clause associated with the target
1491 /// directive, or null if no if clause is used.
1492 /// \param Device Expression evaluated in device clause associated with the
1493 /// target directive, or null if no device clause is used.
Samuel Antao8d2d7302016-05-26 18:30:22 +00001494 virtual void emitTargetDataStandAloneCall(CodeGenFunction &CGF,
1495 const OMPExecutableDirective &D,
1496 const Expr *IfCond,
1497 const Expr *Device);
Alexey Bataevc7a82b42016-05-06 09:40:08 +00001498
1499 /// Marks function \a Fn with properly mangled versions of vector functions.
1500 /// \param FD Function marked as 'declare simd'.
1501 /// \param Fn LLVM function that must be marked with 'declare simd'
1502 /// attributes.
1503 virtual void emitDeclareSimdFunction(const FunctionDecl *FD,
1504 llvm::Function *Fn);
Alexey Bataev8b427062016-05-25 12:36:08 +00001505
1506 /// Emit initialization for doacross loop nesting support.
1507 /// \param D Loop-based construct used in doacross nesting construct.
Alexey Bataevf138fda2018-08-13 19:04:24 +00001508 virtual void emitDoacrossInit(CodeGenFunction &CGF, const OMPLoopDirective &D,
1509 ArrayRef<Expr *> NumIterations);
Alexey Bataev8b427062016-05-25 12:36:08 +00001510
1511 /// Emit code for doacross ordered directive with 'depend' clause.
1512 /// \param C 'depend' clause with 'sink|source' dependency kind.
1513 virtual void emitDoacrossOrdered(CodeGenFunction &CGF,
1514 const OMPDependClause *C);
Alexey Bataev2c7eee52017-08-04 19:10:54 +00001515
Alexey Bataev3b8d5582017-08-08 18:04:06 +00001516 /// Translates the native parameter of outlined function if this is required
1517 /// for target.
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001518 /// \param FD Field decl from captured record for the parameter.
Alexey Bataev3b8d5582017-08-08 18:04:06 +00001519 /// \param NativeParam Parameter itself.
1520 virtual const VarDecl *translateParameter(const FieldDecl *FD,
1521 const VarDecl *NativeParam) const {
1522 return NativeParam;
1523 }
1524
1525 /// Gets the address of the native argument basing on the address of the
1526 /// target-specific parameter.
1527 /// \param NativeParam Parameter itself.
1528 /// \param TargetParam Corresponding target-specific parameter.
1529 virtual Address getParameterAddress(CodeGenFunction &CGF,
1530 const VarDecl *NativeParam,
1531 const VarDecl *TargetParam) const;
1532
Gheorghe-Teodor Bercea02650d42018-09-27 19:22:56 +00001533 /// Choose default schedule type and chunk value for the
1534 /// dist_schedule clause.
1535 virtual void getDefaultDistScheduleAndChunk(CodeGenFunction &CGF,
1536 const OMPLoopDirective &S, OpenMPDistScheduleClauseKind &ScheduleKind,
1537 llvm::Value *&Chunk) const {}
1538
Gheorghe-Teodor Bercea8233af92018-09-27 20:29:00 +00001539 /// Choose default schedule type and chunk value for the
1540 /// schedule clause.
1541 virtual void getDefaultScheduleAndChunk(CodeGenFunction &CGF,
1542 const OMPLoopDirective &S, OpenMPScheduleClauseKind &ScheduleKind,
Gheorghe-Teodor Berceae9256762018-10-29 15:45:47 +00001543 const Expr *&ChunkExpr) const {}
Gheorghe-Teodor Bercea8233af92018-09-27 20:29:00 +00001544
Alexey Bataev2c7eee52017-08-04 19:10:54 +00001545 /// Emits call of the outlined function with the provided arguments,
1546 /// translating these arguments to correct target-specific arguments.
1547 virtual void
Alexey Bataev3c595a62017-08-14 15:01:03 +00001548 emitOutlinedFunctionCall(CodeGenFunction &CGF, SourceLocation Loc,
1549 llvm::Value *OutlinedFn,
Alexey Bataev2c7eee52017-08-04 19:10:54 +00001550 ArrayRef<llvm::Value *> Args = llvm::None) const;
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00001551
1552 /// Emits OpenMP-specific function prolog.
1553 /// Required for device constructs.
1554 virtual void emitFunctionProlog(CodeGenFunction &CGF, const Decl *D) {}
1555
1556 /// Gets the OpenMP-specific address of the local variable.
1557 virtual Address getAddressOfLocalVariable(CodeGenFunction &CGF,
1558 const VarDecl *VD);
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +00001559
Raphael Isemannb23ccec2018-12-10 12:37:46 +00001560 /// Marks the declaration as already emitted for the device code and returns
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +00001561 /// true, if it was marked already, and false, otherwise.
Alexey Bataev6d944102018-05-02 15:45:28 +00001562 bool markAsGlobalTarget(GlobalDecl GD);
Alexey Bataev4f4bf7c2018-03-15 15:47:20 +00001563
Alexey Bataevbf8fe712018-08-07 16:14:36 +00001564 /// Emit deferred declare target variables marked for deferred emission.
1565 void emitDeferredTargetDecls() const;
Alexey Bataev60705422018-10-30 15:50:12 +00001566
1567 /// Adjust some parameters for the target-based directives, like addresses of
1568 /// the variables captured by reference in lambdas.
1569 virtual void
1570 adjustTargetSpecificDataForLambdas(CodeGenFunction &CGF,
1571 const OMPExecutableDirective &D) const;
Patrick Lyster8f7f5862018-11-19 15:09:33 +00001572
1573 /// Perform check on requires decl to ensure that target architecture
1574 /// supports unified addressing
1575 virtual void checkArchForUnifiedAddressing(CodeGenModule &CGM,
1576 const OMPRequiresDecl *D) const {}
Alexey Bataev9959db52014-05-06 10:08:46 +00001577};
Alexey Bataev8cbe0a62015-02-26 10:27:34 +00001578
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001579/// Class supports emissionof SIMD-only code.
1580class CGOpenMPSIMDRuntime final : public CGOpenMPRuntime {
1581public:
1582 explicit CGOpenMPSIMDRuntime(CodeGenModule &CGM) : CGOpenMPRuntime(CGM) {}
1583 ~CGOpenMPSIMDRuntime() override {}
1584
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001585 /// Emits outlined function for the specified OpenMP parallel directive
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001586 /// \a D. This outlined function has type void(*)(kmp_int32 *ThreadID,
1587 /// kmp_int32 BoundID, struct context_vars*).
1588 /// \param D OpenMP directive.
1589 /// \param ThreadIDVar Variable for thread id in the current OpenMP region.
1590 /// \param InnermostKind Kind of innermost directive (for simple directives it
1591 /// is a directive itself, for combined - its innermost directive).
1592 /// \param CodeGen Code generation sequence for the \a D directive.
1593 llvm::Value *
1594 emitParallelOutlinedFunction(const OMPExecutableDirective &D,
1595 const VarDecl *ThreadIDVar,
1596 OpenMPDirectiveKind InnermostKind,
1597 const RegionCodeGenTy &CodeGen) override;
1598
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001599 /// Emits outlined function for the specified OpenMP teams directive
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001600 /// \a D. This outlined function has type void(*)(kmp_int32 *ThreadID,
1601 /// kmp_int32 BoundID, struct context_vars*).
1602 /// \param D OpenMP directive.
1603 /// \param ThreadIDVar Variable for thread id in the current OpenMP region.
1604 /// \param InnermostKind Kind of innermost directive (for simple directives it
1605 /// is a directive itself, for combined - its innermost directive).
1606 /// \param CodeGen Code generation sequence for the \a D directive.
1607 llvm::Value *
1608 emitTeamsOutlinedFunction(const OMPExecutableDirective &D,
1609 const VarDecl *ThreadIDVar,
1610 OpenMPDirectiveKind InnermostKind,
1611 const RegionCodeGenTy &CodeGen) override;
1612
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001613 /// Emits outlined function for the OpenMP task directive \a D. This
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001614 /// outlined function has type void(*)(kmp_int32 ThreadID, struct task_t*
1615 /// TaskT).
1616 /// \param D OpenMP directive.
1617 /// \param ThreadIDVar Variable for thread id in the current OpenMP region.
1618 /// \param PartIDVar Variable for partition id in the current OpenMP untied
1619 /// task region.
1620 /// \param TaskTVar Variable for task_t argument.
1621 /// \param InnermostKind Kind of innermost directive (for simple directives it
1622 /// is a directive itself, for combined - its innermost directive).
1623 /// \param CodeGen Code generation sequence for the \a D directive.
1624 /// \param Tied true if task is generated for tied task, false otherwise.
1625 /// \param NumberOfParts Number of parts in untied task. Ignored for tied
1626 /// tasks.
1627 ///
1628 llvm::Value *emitTaskOutlinedFunction(
1629 const OMPExecutableDirective &D, const VarDecl *ThreadIDVar,
1630 const VarDecl *PartIDVar, const VarDecl *TaskTVar,
1631 OpenMPDirectiveKind InnermostKind, const RegionCodeGenTy &CodeGen,
1632 bool Tied, unsigned &NumberOfParts) override;
1633
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001634 /// Emits code for parallel or serial call of the \a OutlinedFn with
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001635 /// variables captured in a record which address is stored in \a
1636 /// CapturedStruct.
1637 /// \param OutlinedFn Outlined function to be run in parallel threads. Type of
1638 /// this function is void(*)(kmp_int32 *, kmp_int32, struct context_vars*).
1639 /// \param CapturedVars A pointer to the record with the references to
1640 /// variables used in \a OutlinedFn function.
1641 /// \param IfCond Condition in the associated 'if' clause, if it was
1642 /// specified, nullptr otherwise.
1643 ///
1644 void emitParallelCall(CodeGenFunction &CGF, SourceLocation Loc,
1645 llvm::Value *OutlinedFn,
1646 ArrayRef<llvm::Value *> CapturedVars,
1647 const Expr *IfCond) override;
1648
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001649 /// Emits a critical region.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001650 /// \param CriticalName Name of the critical region.
1651 /// \param CriticalOpGen Generator for the statement associated with the given
1652 /// critical region.
1653 /// \param Hint Value of the 'hint' clause (optional).
1654 void emitCriticalRegion(CodeGenFunction &CGF, StringRef CriticalName,
1655 const RegionCodeGenTy &CriticalOpGen,
1656 SourceLocation Loc,
1657 const Expr *Hint = nullptr) override;
1658
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001659 /// Emits a master region.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001660 /// \param MasterOpGen Generator for the statement associated with the given
1661 /// master region.
1662 void emitMasterRegion(CodeGenFunction &CGF,
1663 const RegionCodeGenTy &MasterOpGen,
1664 SourceLocation Loc) override;
1665
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001666 /// Emits code for a taskyield directive.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001667 void emitTaskyieldCall(CodeGenFunction &CGF, SourceLocation Loc) override;
1668
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001669 /// Emit a taskgroup region.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001670 /// \param TaskgroupOpGen Generator for the statement associated with the
1671 /// given taskgroup region.
1672 void emitTaskgroupRegion(CodeGenFunction &CGF,
1673 const RegionCodeGenTy &TaskgroupOpGen,
1674 SourceLocation Loc) override;
1675
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001676 /// Emits a single region.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001677 /// \param SingleOpGen Generator for the statement associated with the given
1678 /// single region.
1679 void emitSingleRegion(CodeGenFunction &CGF,
1680 const RegionCodeGenTy &SingleOpGen, SourceLocation Loc,
1681 ArrayRef<const Expr *> CopyprivateVars,
1682 ArrayRef<const Expr *> DestExprs,
1683 ArrayRef<const Expr *> SrcExprs,
1684 ArrayRef<const Expr *> AssignmentOps) override;
1685
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001686 /// Emit an ordered region.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001687 /// \param OrderedOpGen Generator for the statement associated with the given
1688 /// ordered region.
1689 void emitOrderedRegion(CodeGenFunction &CGF,
1690 const RegionCodeGenTy &OrderedOpGen,
1691 SourceLocation Loc, bool IsThreads) override;
1692
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001693 /// Emit an implicit/explicit barrier for OpenMP threads.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001694 /// \param Kind Directive for which this implicit barrier call must be
1695 /// generated. Must be OMPD_barrier for explicit barrier generation.
1696 /// \param EmitChecks true if need to emit checks for cancellation barriers.
1697 /// \param ForceSimpleCall true simple barrier call must be emitted, false if
1698 /// runtime class decides which one to emit (simple or with cancellation
1699 /// checks).
1700 ///
1701 void emitBarrierCall(CodeGenFunction &CGF, SourceLocation Loc,
1702 OpenMPDirectiveKind Kind, bool EmitChecks = true,
1703 bool ForceSimpleCall = false) override;
1704
1705 /// This is used for non static scheduled types and when the ordered
1706 /// clause is present on the loop construct.
1707 /// Depending on the loop schedule, it is necessary to call some runtime
1708 /// routine before start of the OpenMP loop to get the loop upper / lower
1709 /// bounds \a LB and \a UB and stride \a ST.
1710 ///
1711 /// \param CGF Reference to current CodeGenFunction.
1712 /// \param Loc Clang source location.
1713 /// \param ScheduleKind Schedule kind, specified by the 'schedule' clause.
1714 /// \param IVSize Size of the iteration variable in bits.
1715 /// \param IVSigned Sign of the iteration variable.
1716 /// \param Ordered true if loop is ordered, false otherwise.
1717 /// \param DispatchValues struct containing llvm values for lower bound, upper
1718 /// bound, and chunk expression.
1719 /// For the default (nullptr) value, the chunk 1 will be used.
1720 ///
1721 void emitForDispatchInit(CodeGenFunction &CGF, SourceLocation Loc,
1722 const OpenMPScheduleTy &ScheduleKind,
1723 unsigned IVSize, bool IVSigned, bool Ordered,
1724 const DispatchRTInput &DispatchValues) override;
1725
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001726 /// Call the appropriate runtime routine to initialize it before start
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001727 /// of loop.
1728 ///
1729 /// This is used only in case of static schedule, when the user did not
1730 /// specify a ordered clause on the loop construct.
1731 /// Depending on the loop schedule, it is necessary to call some runtime
1732 /// routine before start of the OpenMP loop to get the loop upper / lower
1733 /// bounds LB and UB and stride ST.
1734 ///
1735 /// \param CGF Reference to current CodeGenFunction.
1736 /// \param Loc Clang source location.
1737 /// \param DKind Kind of the directive.
1738 /// \param ScheduleKind Schedule kind, specified by the 'schedule' clause.
1739 /// \param Values Input arguments for the construct.
1740 ///
1741 void emitForStaticInit(CodeGenFunction &CGF, SourceLocation Loc,
1742 OpenMPDirectiveKind DKind,
1743 const OpenMPScheduleTy &ScheduleKind,
1744 const StaticRTInput &Values) override;
1745
1746 ///
1747 /// \param CGF Reference to current CodeGenFunction.
1748 /// \param Loc Clang source location.
1749 /// \param SchedKind Schedule kind, specified by the 'dist_schedule' clause.
1750 /// \param Values Input arguments for the construct.
1751 ///
1752 void emitDistributeStaticInit(CodeGenFunction &CGF, SourceLocation Loc,
1753 OpenMPDistScheduleClauseKind SchedKind,
1754 const StaticRTInput &Values) override;
1755
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001756 /// Call the appropriate runtime routine to notify that we finished
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001757 /// iteration of the ordered loop with the dynamic scheduling.
1758 ///
1759 /// \param CGF Reference to current CodeGenFunction.
1760 /// \param Loc Clang source location.
1761 /// \param IVSize Size of the iteration variable in bits.
1762 /// \param IVSigned Sign of the iteration variable.
1763 ///
1764 void emitForOrderedIterationEnd(CodeGenFunction &CGF, SourceLocation Loc,
1765 unsigned IVSize, bool IVSigned) override;
1766
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001767 /// Call the appropriate runtime routine to notify that we finished
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001768 /// all the work with current loop.
1769 ///
1770 /// \param CGF Reference to current CodeGenFunction.
1771 /// \param Loc Clang source location.
1772 /// \param DKind Kind of the directive for which the static finish is emitted.
1773 ///
1774 void emitForStaticFinish(CodeGenFunction &CGF, SourceLocation Loc,
1775 OpenMPDirectiveKind DKind) override;
1776
1777 /// Call __kmpc_dispatch_next(
1778 /// ident_t *loc, kmp_int32 tid, kmp_int32 *p_lastiter,
1779 /// kmp_int[32|64] *p_lower, kmp_int[32|64] *p_upper,
1780 /// kmp_int[32|64] *p_stride);
1781 /// \param IVSize Size of the iteration variable in bits.
1782 /// \param IVSigned Sign of the iteration variable.
1783 /// \param IL Address of the output variable in which the flag of the
1784 /// last iteration is returned.
1785 /// \param LB Address of the output variable in which the lower iteration
1786 /// number is returned.
1787 /// \param UB Address of the output variable in which the upper iteration
1788 /// number is returned.
1789 /// \param ST Address of the output variable in which the stride value is
1790 /// returned.
1791 llvm::Value *emitForNext(CodeGenFunction &CGF, SourceLocation Loc,
1792 unsigned IVSize, bool IVSigned, Address IL,
1793 Address LB, Address UB, Address ST) override;
1794
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001795 /// Emits call to void __kmpc_push_num_threads(ident_t *loc, kmp_int32
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001796 /// global_tid, kmp_int32 num_threads) to generate code for 'num_threads'
1797 /// clause.
1798 /// \param NumThreads An integer value of threads.
1799 void emitNumThreadsClause(CodeGenFunction &CGF, llvm::Value *NumThreads,
1800 SourceLocation Loc) override;
1801
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001802 /// Emit call to void __kmpc_push_proc_bind(ident_t *loc, kmp_int32
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001803 /// global_tid, int proc_bind) to generate code for 'proc_bind' clause.
1804 void emitProcBindClause(CodeGenFunction &CGF,
1805 OpenMPProcBindClauseKind ProcBind,
1806 SourceLocation Loc) override;
1807
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001808 /// Returns address of the threadprivate variable for the current
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001809 /// thread.
1810 /// \param VD Threadprivate variable.
1811 /// \param VDAddr Address of the global variable \a VD.
1812 /// \param Loc Location of the reference to threadprivate var.
1813 /// \return Address of the threadprivate variable for the current thread.
1814 Address getAddrOfThreadPrivate(CodeGenFunction &CGF, const VarDecl *VD,
1815 Address VDAddr, SourceLocation Loc) override;
1816
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001817 /// Emit a code for initialization of threadprivate variable. It emits
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001818 /// a call to runtime library which adds initial value to the newly created
1819 /// threadprivate variable (if it is not constant) and registers destructor
1820 /// for the variable (if any).
1821 /// \param VD Threadprivate variable.
1822 /// \param VDAddr Address of the global variable \a VD.
1823 /// \param Loc Location of threadprivate declaration.
1824 /// \param PerformInit true if initialization expression is not constant.
1825 llvm::Function *
1826 emitThreadPrivateVarDefinition(const VarDecl *VD, Address VDAddr,
1827 SourceLocation Loc, bool PerformInit,
1828 CodeGenFunction *CGF = nullptr) override;
1829
1830 /// Creates artificial threadprivate variable with name \p Name and type \p
1831 /// VarType.
1832 /// \param VarType Type of the artificial threadprivate variable.
1833 /// \param Name Name of the artificial threadprivate variable.
1834 Address getAddrOfArtificialThreadPrivate(CodeGenFunction &CGF,
1835 QualType VarType,
1836 StringRef Name) override;
1837
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001838 /// Emit flush of the variables specified in 'omp flush' directive.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001839 /// \param Vars List of variables to flush.
1840 void emitFlush(CodeGenFunction &CGF, ArrayRef<const Expr *> Vars,
1841 SourceLocation Loc) override;
1842
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001843 /// Emit task region for the task directive. The task region is
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001844 /// emitted in several steps:
1845 /// 1. Emit a call to kmp_task_t *__kmpc_omp_task_alloc(ident_t *, kmp_int32
1846 /// gtid, kmp_int32 flags, size_t sizeof_kmp_task_t, size_t sizeof_shareds,
1847 /// kmp_routine_entry_t *task_entry). Here task_entry is a pointer to the
1848 /// function:
1849 /// kmp_int32 .omp_task_entry.(kmp_int32 gtid, kmp_task_t *tt) {
1850 /// TaskFunction(gtid, tt->part_id, tt->shareds);
1851 /// return 0;
1852 /// }
1853 /// 2. Copy a list of shared variables to field shareds of the resulting
1854 /// structure kmp_task_t returned by the previous call (if any).
1855 /// 3. Copy a pointer to destructions function to field destructions of the
1856 /// resulting structure kmp_task_t.
1857 /// 4. Emit a call to kmp_int32 __kmpc_omp_task(ident_t *, kmp_int32 gtid,
1858 /// kmp_task_t *new_task), where new_task is a resulting structure from
1859 /// previous items.
1860 /// \param D Current task directive.
1861 /// \param TaskFunction An LLVM function with type void (*)(i32 /*gtid*/, i32
1862 /// /*part_id*/, captured_struct */*__context*/);
1863 /// \param SharedsTy A type which contains references the shared variables.
1864 /// \param Shareds Context with the list of shared variables from the \p
1865 /// TaskFunction.
1866 /// \param IfCond Not a nullptr if 'if' clause was specified, nullptr
1867 /// otherwise.
1868 /// \param Data Additional data for task generation like tiednsee, final
1869 /// state, list of privates etc.
1870 void emitTaskCall(CodeGenFunction &CGF, SourceLocation Loc,
1871 const OMPExecutableDirective &D, llvm::Value *TaskFunction,
1872 QualType SharedsTy, Address Shareds, const Expr *IfCond,
1873 const OMPTaskDataTy &Data) override;
1874
1875 /// Emit task region for the taskloop directive. The taskloop region is
1876 /// emitted in several steps:
1877 /// 1. Emit a call to kmp_task_t *__kmpc_omp_task_alloc(ident_t *, kmp_int32
1878 /// gtid, kmp_int32 flags, size_t sizeof_kmp_task_t, size_t sizeof_shareds,
1879 /// kmp_routine_entry_t *task_entry). Here task_entry is a pointer to the
1880 /// function:
1881 /// kmp_int32 .omp_task_entry.(kmp_int32 gtid, kmp_task_t *tt) {
1882 /// TaskFunction(gtid, tt->part_id, tt->shareds);
1883 /// return 0;
1884 /// }
1885 /// 2. Copy a list of shared variables to field shareds of the resulting
1886 /// structure kmp_task_t returned by the previous call (if any).
1887 /// 3. Copy a pointer to destructions function to field destructions of the
1888 /// resulting structure kmp_task_t.
1889 /// 4. Emit a call to void __kmpc_taskloop(ident_t *loc, int gtid, kmp_task_t
1890 /// *task, int if_val, kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int
1891 /// nogroup, int sched, kmp_uint64 grainsize, void *task_dup ), where new_task
1892 /// is a resulting structure from
1893 /// previous items.
1894 /// \param D Current task directive.
1895 /// \param TaskFunction An LLVM function with type void (*)(i32 /*gtid*/, i32
1896 /// /*part_id*/, captured_struct */*__context*/);
1897 /// \param SharedsTy A type which contains references the shared variables.
1898 /// \param Shareds Context with the list of shared variables from the \p
1899 /// TaskFunction.
1900 /// \param IfCond Not a nullptr if 'if' clause was specified, nullptr
1901 /// otherwise.
1902 /// \param Data Additional data for task generation like tiednsee, final
1903 /// state, list of privates etc.
1904 void emitTaskLoopCall(CodeGenFunction &CGF, SourceLocation Loc,
1905 const OMPLoopDirective &D, llvm::Value *TaskFunction,
1906 QualType SharedsTy, Address Shareds, const Expr *IfCond,
1907 const OMPTaskDataTy &Data) override;
1908
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001909 /// Emit a code for reduction clause. Next code should be emitted for
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00001910 /// reduction:
1911 /// \code
1912 ///
1913 /// static kmp_critical_name lock = { 0 };
1914 ///
1915 /// void reduce_func(void *lhs[<n>], void *rhs[<n>]) {
1916 /// ...
1917 /// *(Type<i>*)lhs[i] = RedOp<i>(*(Type<i>*)lhs[i], *(Type<i>*)rhs[i]);
1918 /// ...
1919 /// }
1920 ///
1921 /// ...
1922 /// void *RedList[<n>] = {&<RHSExprs>[0], ..., &<RHSExprs>[<n>-1]};
1923 /// switch (__kmpc_reduce{_nowait}(<loc>, <gtid>, <n>, sizeof(RedList),
1924 /// RedList, reduce_func, &<lock>)) {
1925 /// case 1:
1926 /// ...
1927 /// <LHSExprs>[i] = RedOp<i>(*<LHSExprs>[i], *<RHSExprs>[i]);
1928 /// ...
1929 /// __kmpc_end_reduce{_nowait}(<loc>, <gtid>, &<lock>);
1930 /// break;
1931 /// case 2:
1932 /// ...
1933 /// Atomic(<LHSExprs>[i] = RedOp<i>(*<LHSExprs>[i], *<RHSExprs>[i]));
1934 /// ...
1935 /// break;
1936 /// default:;
1937 /// }
1938 /// \endcode
1939 ///
1940 /// \param Privates List of private copies for original reduction arguments.
1941 /// \param LHSExprs List of LHS in \a ReductionOps reduction operations.
1942 /// \param RHSExprs List of RHS in \a ReductionOps reduction operations.
1943 /// \param ReductionOps List of reduction operations in form 'LHS binop RHS'
1944 /// or 'operator binop(LHS, RHS)'.
1945 /// \param Options List of options for reduction codegen:
1946 /// WithNowait true if parent directive has also nowait clause, false
1947 /// otherwise.
1948 /// SimpleReduction Emit reduction operation only. Used for omp simd
1949 /// directive on the host.
1950 /// ReductionKind The kind of reduction to perform.
1951 void emitReduction(CodeGenFunction &CGF, SourceLocation Loc,
1952 ArrayRef<const Expr *> Privates,
1953 ArrayRef<const Expr *> LHSExprs,
1954 ArrayRef<const Expr *> RHSExprs,
1955 ArrayRef<const Expr *> ReductionOps,
1956 ReductionOptionsTy Options) override;
1957
1958 /// Emit a code for initialization of task reduction clause. Next code
1959 /// should be emitted for reduction:
1960 /// \code
1961 ///
1962 /// _task_red_item_t red_data[n];
1963 /// ...
1964 /// red_data[i].shar = &origs[i];
1965 /// red_data[i].size = sizeof(origs[i]);
1966 /// red_data[i].f_init = (void*)RedInit<i>;
1967 /// red_data[i].f_fini = (void*)RedDest<i>;
1968 /// red_data[i].f_comb = (void*)RedOp<i>;
1969 /// red_data[i].flags = <Flag_i>;
1970 /// ...
1971 /// void* tg1 = __kmpc_task_reduction_init(gtid, n, red_data);
1972 /// \endcode
1973 ///
1974 /// \param LHSExprs List of LHS in \a Data.ReductionOps reduction operations.
1975 /// \param RHSExprs List of RHS in \a Data.ReductionOps reduction operations.
1976 /// \param Data Additional data for task generation like tiedness, final
1977 /// state, list of privates, reductions etc.
1978 llvm::Value *emitTaskReductionInit(CodeGenFunction &CGF, SourceLocation Loc,
1979 ArrayRef<const Expr *> LHSExprs,
1980 ArrayRef<const Expr *> RHSExprs,
1981 const OMPTaskDataTy &Data) override;
1982
1983 /// Required to resolve existing problems in the runtime. Emits threadprivate
1984 /// variables to store the size of the VLAs/array sections for
1985 /// initializer/combiner/finalizer functions + emits threadprivate variable to
1986 /// store the pointer to the original reduction item for the custom
1987 /// initializer defined by declare reduction construct.
1988 /// \param RCG Allows to reuse an existing data for the reductions.
1989 /// \param N Reduction item for which fixups must be emitted.
1990 void emitTaskReductionFixups(CodeGenFunction &CGF, SourceLocation Loc,
1991 ReductionCodeGen &RCG, unsigned N) override;
1992
1993 /// Get the address of `void *` type of the privatue copy of the reduction
1994 /// item specified by the \p SharedLVal.
1995 /// \param ReductionsPtr Pointer to the reduction data returned by the
1996 /// emitTaskReductionInit function.
1997 /// \param SharedLVal Address of the original reduction item.
1998 Address getTaskReductionItem(CodeGenFunction &CGF, SourceLocation Loc,
1999 llvm::Value *ReductionsPtr,
2000 LValue SharedLVal) override;
2001
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002002 /// Emit code for 'taskwait' directive.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002003 void emitTaskwaitCall(CodeGenFunction &CGF, SourceLocation Loc) override;
2004
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002005 /// Emit code for 'cancellation point' construct.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002006 /// \param CancelRegion Region kind for which the cancellation point must be
2007 /// emitted.
2008 ///
2009 void emitCancellationPointCall(CodeGenFunction &CGF, SourceLocation Loc,
2010 OpenMPDirectiveKind CancelRegion) override;
2011
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002012 /// Emit code for 'cancel' construct.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002013 /// \param IfCond Condition in the associated 'if' clause, if it was
2014 /// specified, nullptr otherwise.
2015 /// \param CancelRegion Region kind for which the cancel must be emitted.
2016 ///
2017 void emitCancelCall(CodeGenFunction &CGF, SourceLocation Loc,
2018 const Expr *IfCond,
2019 OpenMPDirectiveKind CancelRegion) override;
2020
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002021 /// Emit outilined function for 'target' directive.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002022 /// \param D Directive to emit.
2023 /// \param ParentName Name of the function that encloses the target region.
2024 /// \param OutlinedFn Outlined function value to be defined by this call.
2025 /// \param OutlinedFnID Outlined function ID value to be defined by this call.
2026 /// \param IsOffloadEntry True if the outlined function is an offload entry.
2027 /// \param CodeGen Code generation sequence for the \a D directive.
2028 /// An outlined function may not be an entry if, e.g. the if clause always
2029 /// evaluates to false.
2030 void emitTargetOutlinedFunction(const OMPExecutableDirective &D,
2031 StringRef ParentName,
2032 llvm::Function *&OutlinedFn,
2033 llvm::Constant *&OutlinedFnID,
2034 bool IsOffloadEntry,
2035 const RegionCodeGenTy &CodeGen) override;
2036
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002037 /// Emit the target offloading code associated with \a D. The emitted
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002038 /// code attempts offloading the execution to the device, an the event of
2039 /// a failure it executes the host version outlined in \a OutlinedFn.
2040 /// \param D Directive to emit.
2041 /// \param OutlinedFn Host version of the code to be offloaded.
2042 /// \param OutlinedFnID ID of host version of the code to be offloaded.
2043 /// \param IfCond Expression evaluated in if clause associated with the target
2044 /// directive, or null if no if clause is used.
2045 /// \param Device Expression evaluated in device clause associated with the
2046 /// target directive, or null if no device clause is used.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002047 void emitTargetCall(CodeGenFunction &CGF, const OMPExecutableDirective &D,
2048 llvm::Value *OutlinedFn, llvm::Value *OutlinedFnID,
Alexey Bataev8451efa2018-01-15 19:06:12 +00002049 const Expr *IfCond, const Expr *Device) override;
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002050
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002051 /// Emit the target regions enclosed in \a GD function definition or
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002052 /// the function itself in case it is a valid device function. Returns true if
2053 /// \a GD was dealt with successfully.
2054 /// \param GD Function to scan.
2055 bool emitTargetFunctions(GlobalDecl GD) override;
2056
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002057 /// Emit the global variable if it is a valid device global variable.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002058 /// Returns true if \a GD was dealt with successfully.
2059 /// \param GD Variable declaration to emit.
2060 bool emitTargetGlobalVariable(GlobalDecl GD) override;
2061
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002062 /// Emit the global \a GD if it is meaningful for the target. Returns
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002063 /// if it was emitted successfully.
2064 /// \param GD Global to scan.
2065 bool emitTargetGlobal(GlobalDecl GD) override;
2066
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002067 /// Creates the offloading descriptor in the event any target region
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002068 /// was emitted in the current module and return the function that registers
2069 /// it.
2070 llvm::Function *emitRegistrationFunction() override;
2071
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002072 /// Emits code for teams call of the \a OutlinedFn with
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002073 /// variables captured in a record which address is stored in \a
2074 /// CapturedStruct.
2075 /// \param OutlinedFn Outlined function to be run by team masters. Type of
2076 /// this function is void(*)(kmp_int32 *, kmp_int32, struct context_vars*).
2077 /// \param CapturedVars A pointer to the record with the references to
2078 /// variables used in \a OutlinedFn function.
2079 ///
2080 void emitTeamsCall(CodeGenFunction &CGF, const OMPExecutableDirective &D,
2081 SourceLocation Loc, llvm::Value *OutlinedFn,
2082 ArrayRef<llvm::Value *> CapturedVars) override;
2083
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002084 /// Emits call to void __kmpc_push_num_teams(ident_t *loc, kmp_int32
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002085 /// global_tid, kmp_int32 num_teams, kmp_int32 thread_limit) to generate code
2086 /// for num_teams clause.
2087 /// \param NumTeams An integer expression of teams.
2088 /// \param ThreadLimit An integer expression of threads.
2089 void emitNumTeamsClause(CodeGenFunction &CGF, const Expr *NumTeams,
2090 const Expr *ThreadLimit, SourceLocation Loc) override;
2091
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002092 /// Emit the target data mapping code associated with \a D.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002093 /// \param D Directive to emit.
2094 /// \param IfCond Expression evaluated in if clause associated with the
2095 /// target directive, or null if no device clause is used.
2096 /// \param Device Expression evaluated in device clause associated with the
2097 /// target directive, or null if no device clause is used.
2098 /// \param Info A record used to store information that needs to be preserved
2099 /// until the region is closed.
2100 void emitTargetDataCalls(CodeGenFunction &CGF,
2101 const OMPExecutableDirective &D, const Expr *IfCond,
2102 const Expr *Device, const RegionCodeGenTy &CodeGen,
2103 TargetDataInfo &Info) override;
2104
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002105 /// Emit the data mapping/movement code associated with the directive
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002106 /// \a D that should be of the form 'target [{enter|exit} data | update]'.
2107 /// \param D Directive to emit.
2108 /// \param IfCond Expression evaluated in if clause associated with the target
2109 /// directive, or null if no if clause is used.
2110 /// \param Device Expression evaluated in device clause associated with the
2111 /// target directive, or null if no device clause is used.
2112 void emitTargetDataStandAloneCall(CodeGenFunction &CGF,
2113 const OMPExecutableDirective &D,
2114 const Expr *IfCond,
2115 const Expr *Device) override;
2116
2117 /// Emit initialization for doacross loop nesting support.
2118 /// \param D Loop-based construct used in doacross nesting construct.
Alexey Bataevf138fda2018-08-13 19:04:24 +00002119 void emitDoacrossInit(CodeGenFunction &CGF, const OMPLoopDirective &D,
2120 ArrayRef<Expr *> NumIterations) override;
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002121
2122 /// Emit code for doacross ordered directive with 'depend' clause.
2123 /// \param C 'depend' clause with 'sink|source' dependency kind.
2124 void emitDoacrossOrdered(CodeGenFunction &CGF,
2125 const OMPDependClause *C) override;
2126
2127 /// Translates the native parameter of outlined function if this is required
2128 /// for target.
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00002129 /// \param FD Field decl from captured record for the parameter.
Alexey Bataeva8a9153a2017-12-29 18:07:07 +00002130 /// \param NativeParam Parameter itself.
2131 const VarDecl *translateParameter(const FieldDecl *FD,
2132 const VarDecl *NativeParam) const override;
2133
2134 /// Gets the address of the native argument basing on the address of the
2135 /// target-specific parameter.
2136 /// \param NativeParam Parameter itself.
2137 /// \param TargetParam Corresponding target-specific parameter.
2138 Address getParameterAddress(CodeGenFunction &CGF, const VarDecl *NativeParam,
2139 const VarDecl *TargetParam) const override;
2140};
2141
Alexey Bataev23b69422014-06-18 07:08:49 +00002142} // namespace CodeGen
2143} // namespace clang
Alexey Bataev9959db52014-05-06 10:08:46 +00002144
2145#endif