1 //===----- CGOpenMPRuntime.cpp - Interface to OpenMP Runtimes -------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This provides a class for OpenMP runtime code generation.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "CGOpenMPRuntime.h"
14 #include "CGCXXABI.h"
15 #include "CGCleanup.h"
16 #include "CGRecordLayout.h"
17 #include "CodeGenFunction.h"
18 #include "clang/AST/Attr.h"
19 #include "clang/AST/Decl.h"
20 #include "clang/AST/OpenMPClause.h"
21 #include "clang/AST/StmtOpenMP.h"
22 #include "clang/AST/StmtVisitor.h"
23 #include "clang/Basic/BitmaskEnum.h"
24 #include "clang/Basic/FileManager.h"
25 #include "clang/Basic/OpenMPKinds.h"
26 #include "clang/Basic/SourceManager.h"
27 #include "clang/CodeGen/ConstantInitBuilder.h"
28 #include "llvm/ADT/ArrayRef.h"
29 #include "llvm/ADT/SetOperations.h"
30 #include "llvm/ADT/StringExtras.h"
31 #include "llvm/Bitcode/BitcodeReader.h"
32 #include "llvm/IR/Constants.h"
33 #include "llvm/IR/DerivedTypes.h"
34 #include "llvm/IR/GlobalValue.h"
35 #include "llvm/IR/Value.h"
36 #include "llvm/Support/AtomicOrdering.h"
37 #include "llvm/Support/Format.h"
38 #include "llvm/Support/raw_ostream.h"
39 #include <cassert>
40 #include <numeric>
41 
42 using namespace clang;
43 using namespace CodeGen;
44 using namespace llvm::omp;
45 
46 namespace {
47 /// Base class for handling code generation inside OpenMP regions.
48 class CGOpenMPRegionInfo : public CodeGenFunction::CGCapturedStmtInfo {
49 public:
50   /// Kinds of OpenMP regions used in codegen.
51   enum CGOpenMPRegionKind {
52     /// Region with outlined function for standalone 'parallel'
53     /// directive.
54     ParallelOutlinedRegion,
55     /// Region with outlined function for standalone 'task' directive.
56     TaskOutlinedRegion,
57     /// Region for constructs that do not require function outlining,
58     /// like 'for', 'sections', 'atomic' etc. directives.
59     InlinedRegion,
60     /// Region with outlined function for standalone 'target' directive.
61     TargetRegion,
62   };
63 
64   CGOpenMPRegionInfo(const CapturedStmt &CS,
65                      const CGOpenMPRegionKind RegionKind,
66                      const RegionCodeGenTy &CodeGen, OpenMPDirectiveKind Kind,
67                      bool HasCancel)
68       : CGCapturedStmtInfo(CS, CR_OpenMP), RegionKind(RegionKind),
69         CodeGen(CodeGen), Kind(Kind), HasCancel(HasCancel) {}
70 
71   CGOpenMPRegionInfo(const CGOpenMPRegionKind RegionKind,
72                      const RegionCodeGenTy &CodeGen, OpenMPDirectiveKind Kind,
73                      bool HasCancel)
74       : CGCapturedStmtInfo(CR_OpenMP), RegionKind(RegionKind), CodeGen(CodeGen),
75         Kind(Kind), HasCancel(HasCancel) {}
76 
77   /// Get a variable or parameter for storing global thread id
78   /// inside OpenMP construct.
79   virtual const VarDecl *getThreadIDVariable() const = 0;
80 
81   /// Emit the captured statement body.
82   void EmitBody(CodeGenFunction &CGF, const Stmt *S) override;
83 
84   /// Get an LValue for the current ThreadID variable.
85   /// \return LValue for thread id variable. This LValue always has type int32*.
86   virtual LValue getThreadIDVariableLValue(CodeGenFunction &CGF);
87 
88   virtual void emitUntiedSwitch(CodeGenFunction & /*CGF*/) {}
89 
90   CGOpenMPRegionKind getRegionKind() const { return RegionKind; }
91 
92   OpenMPDirectiveKind getDirectiveKind() const { return Kind; }
93 
94   bool hasCancel() const { return HasCancel; }
95 
96   static bool classof(const CGCapturedStmtInfo *Info) {
97     return Info->getKind() == CR_OpenMP;
98   }
99 
100   ~CGOpenMPRegionInfo() override = default;
101 
102 protected:
103   CGOpenMPRegionKind RegionKind;
104   RegionCodeGenTy CodeGen;
105   OpenMPDirectiveKind Kind;
106   bool HasCancel;
107 };
108 
109 /// API for captured statement code generation in OpenMP constructs.
110 class CGOpenMPOutlinedRegionInfo final : public CGOpenMPRegionInfo {
111 public:
112   CGOpenMPOutlinedRegionInfo(const CapturedStmt &CS, const VarDecl *ThreadIDVar,
113                              const RegionCodeGenTy &CodeGen,
114                              OpenMPDirectiveKind Kind, bool HasCancel,
115                              StringRef HelperName)
116       : CGOpenMPRegionInfo(CS, ParallelOutlinedRegion, CodeGen, Kind,
117                            HasCancel),
118         ThreadIDVar(ThreadIDVar), HelperName(HelperName) {
119     assert(ThreadIDVar != nullptr && "No ThreadID in OpenMP region.");
120   }
121 
122   /// Get a variable or parameter for storing global thread id
123   /// inside OpenMP construct.
124   const VarDecl *getThreadIDVariable() const override { return ThreadIDVar; }
125 
126   /// Get the name of the capture helper.
127   StringRef getHelperName() const override { return HelperName; }
128 
129   static bool classof(const CGCapturedStmtInfo *Info) {
130     return CGOpenMPRegionInfo::classof(Info) &&
131            cast<CGOpenMPRegionInfo>(Info)->getRegionKind() ==
132                ParallelOutlinedRegion;
133   }
134 
135 private:
136   /// A variable or parameter storing global thread id for OpenMP
137   /// constructs.
138   const VarDecl *ThreadIDVar;
139   StringRef HelperName;
140 };
141 
142 /// API for captured statement code generation in OpenMP constructs.
143 class CGOpenMPTaskOutlinedRegionInfo final : public CGOpenMPRegionInfo {
144 public:
145   class UntiedTaskActionTy final : public PrePostActionTy {
146     bool Untied;
147     const VarDecl *PartIDVar;
148     const RegionCodeGenTy UntiedCodeGen;
149     llvm::SwitchInst *UntiedSwitch = nullptr;
150 
151   public:
152     UntiedTaskActionTy(bool Tied, const VarDecl *PartIDVar,
153                        const RegionCodeGenTy &UntiedCodeGen)
154         : Untied(!Tied), PartIDVar(PartIDVar), UntiedCodeGen(UntiedCodeGen) {}
155     void Enter(CodeGenFunction &CGF) override {
156       if (Untied) {
157         // Emit task switching point.
158         LValue PartIdLVal = CGF.EmitLoadOfPointerLValue(
159             CGF.GetAddrOfLocalVar(PartIDVar),
160             PartIDVar->getType()->castAs<PointerType>());
161         llvm::Value *Res =
162             CGF.EmitLoadOfScalar(PartIdLVal, PartIDVar->getLocation());
163         llvm::BasicBlock *DoneBB = CGF.createBasicBlock(".untied.done.");
164         UntiedSwitch = CGF.Builder.CreateSwitch(Res, DoneBB);
165         CGF.EmitBlock(DoneBB);
166         CGF.EmitBranchThroughCleanup(CGF.ReturnBlock);
167         CGF.EmitBlock(CGF.createBasicBlock(".untied.jmp."));
168         UntiedSwitch->addCase(CGF.Builder.getInt32(0),
169                               CGF.Builder.GetInsertBlock());
170         emitUntiedSwitch(CGF);
171       }
172     }
173     void emitUntiedSwitch(CodeGenFunction &CGF) const {
174       if (Untied) {
175         LValue PartIdLVal = CGF.EmitLoadOfPointerLValue(
176             CGF.GetAddrOfLocalVar(PartIDVar),
177             PartIDVar->getType()->castAs<PointerType>());
178         CGF.EmitStoreOfScalar(CGF.Builder.getInt32(UntiedSwitch->getNumCases()),
179                               PartIdLVal);
180         UntiedCodeGen(CGF);
181         CodeGenFunction::JumpDest CurPoint =
182             CGF.getJumpDestInCurrentScope(".untied.next.");
183         CGF.EmitBranch(CGF.ReturnBlock.getBlock());
184         CGF.EmitBlock(CGF.createBasicBlock(".untied.jmp."));
185         UntiedSwitch->addCase(CGF.Builder.getInt32(UntiedSwitch->getNumCases()),
186                               CGF.Builder.GetInsertBlock());
187         CGF.EmitBranchThroughCleanup(CurPoint);
188         CGF.EmitBlock(CurPoint.getBlock());
189       }
190     }
191     unsigned getNumberOfParts() const { return UntiedSwitch->getNumCases(); }
192   };
193   CGOpenMPTaskOutlinedRegionInfo(const CapturedStmt &CS,
194                                  const VarDecl *ThreadIDVar,
195                                  const RegionCodeGenTy &CodeGen,
196                                  OpenMPDirectiveKind Kind, bool HasCancel,
197                                  const UntiedTaskActionTy &Action)
198       : CGOpenMPRegionInfo(CS, TaskOutlinedRegion, CodeGen, Kind, HasCancel),
199         ThreadIDVar(ThreadIDVar), Action(Action) {
200     assert(ThreadIDVar != nullptr && "No ThreadID in OpenMP region.");
201   }
202 
203   /// Get a variable or parameter for storing global thread id
204   /// inside OpenMP construct.
205   const VarDecl *getThreadIDVariable() const override { return ThreadIDVar; }
206 
207   /// Get an LValue for the current ThreadID variable.
208   LValue getThreadIDVariableLValue(CodeGenFunction &CGF) override;
209 
210   /// Get the name of the capture helper.
211   StringRef getHelperName() const override { return ".omp_outlined."; }
212 
213   void emitUntiedSwitch(CodeGenFunction &CGF) override {
214     Action.emitUntiedSwitch(CGF);
215   }
216 
217   static bool classof(const CGCapturedStmtInfo *Info) {
218     return CGOpenMPRegionInfo::classof(Info) &&
219            cast<CGOpenMPRegionInfo>(Info)->getRegionKind() ==
220                TaskOutlinedRegion;
221   }
222 
223 private:
224   /// A variable or parameter storing global thread id for OpenMP
225   /// constructs.
226   const VarDecl *ThreadIDVar;
227   /// Action for emitting code for untied tasks.
228   const UntiedTaskActionTy &Action;
229 };
230 
231 /// API for inlined captured statement code generation in OpenMP
232 /// constructs.
233 class CGOpenMPInlinedRegionInfo : public CGOpenMPRegionInfo {
234 public:
235   CGOpenMPInlinedRegionInfo(CodeGenFunction::CGCapturedStmtInfo *OldCSI,
236                             const RegionCodeGenTy &CodeGen,
237                             OpenMPDirectiveKind Kind, bool HasCancel)
238       : CGOpenMPRegionInfo(InlinedRegion, CodeGen, Kind, HasCancel),
239         OldCSI(OldCSI),
240         OuterRegionInfo(dyn_cast_or_null<CGOpenMPRegionInfo>(OldCSI)) {}
241 
242   // Retrieve the value of the context parameter.
243   llvm::Value *getContextValue() const override {
244     if (OuterRegionInfo)
245       return OuterRegionInfo->getContextValue();
246     llvm_unreachable("No context value for inlined OpenMP region");
247   }
248 
249   void setContextValue(llvm::Value *V) override {
250     if (OuterRegionInfo) {
251       OuterRegionInfo->setContextValue(V);
252       return;
253     }
254     llvm_unreachable("No context value for inlined OpenMP region");
255   }
256 
257   /// Lookup the captured field decl for a variable.
258   const FieldDecl *lookup(const VarDecl *VD) const override {
259     if (OuterRegionInfo)
260       return OuterRegionInfo->lookup(VD);
261     // If there is no outer outlined region,no need to lookup in a list of
262     // captured variables, we can use the original one.
263     return nullptr;
264   }
265 
266   FieldDecl *getThisFieldDecl() const override {
267     if (OuterRegionInfo)
268       return OuterRegionInfo->getThisFieldDecl();
269     return nullptr;
270   }
271 
272   /// Get a variable or parameter for storing global thread id
273   /// inside OpenMP construct.
274   const VarDecl *getThreadIDVariable() const override {
275     if (OuterRegionInfo)
276       return OuterRegionInfo->getThreadIDVariable();
277     return nullptr;
278   }
279 
280   /// Get an LValue for the current ThreadID variable.
281   LValue getThreadIDVariableLValue(CodeGenFunction &CGF) override {
282     if (OuterRegionInfo)
283       return OuterRegionInfo->getThreadIDVariableLValue(CGF);
284     llvm_unreachable("No LValue for inlined OpenMP construct");
285   }
286 
287   /// Get the name of the capture helper.
288   StringRef getHelperName() const override {
289     if (auto *OuterRegionInfo = getOldCSI())
290       return OuterRegionInfo->getHelperName();
291     llvm_unreachable("No helper name for inlined OpenMP construct");
292   }
293 
294   void emitUntiedSwitch(CodeGenFunction &CGF) override {
295     if (OuterRegionInfo)
296       OuterRegionInfo->emitUntiedSwitch(CGF);
297   }
298 
299   CodeGenFunction::CGCapturedStmtInfo *getOldCSI() const { return OldCSI; }
300 
301   static bool classof(const CGCapturedStmtInfo *Info) {
302     return CGOpenMPRegionInfo::classof(Info) &&
303            cast<CGOpenMPRegionInfo>(Info)->getRegionKind() == InlinedRegion;
304   }
305 
306   ~CGOpenMPInlinedRegionInfo() override = default;
307 
308 private:
309   /// CodeGen info about outer OpenMP region.
310   CodeGenFunction::CGCapturedStmtInfo *OldCSI;
311   CGOpenMPRegionInfo *OuterRegionInfo;
312 };
313 
314 /// API for captured statement code generation in OpenMP target
315 /// constructs. For this captures, implicit parameters are used instead of the
316 /// captured fields. The name of the target region has to be unique in a given
317 /// application so it is provided by the client, because only the client has
318 /// the information to generate that.
319 class CGOpenMPTargetRegionInfo final : public CGOpenMPRegionInfo {
320 public:
321   CGOpenMPTargetRegionInfo(const CapturedStmt &CS,
322                            const RegionCodeGenTy &CodeGen, StringRef HelperName)
323       : CGOpenMPRegionInfo(CS, TargetRegion, CodeGen, OMPD_target,
324                            /*HasCancel=*/false),
325         HelperName(HelperName) {}
326 
327   /// This is unused for target regions because each starts executing
328   /// with a single thread.
329   const VarDecl *getThreadIDVariable() const override { return nullptr; }
330 
331   /// Get the name of the capture helper.
332   StringRef getHelperName() const override { return HelperName; }
333 
334   static bool classof(const CGCapturedStmtInfo *Info) {
335     return CGOpenMPRegionInfo::classof(Info) &&
336            cast<CGOpenMPRegionInfo>(Info)->getRegionKind() == TargetRegion;
337   }
338 
339 private:
340   StringRef HelperName;
341 };
342 
343 static void EmptyCodeGen(CodeGenFunction &, PrePostActionTy &) {
344   llvm_unreachable("No codegen for expressions");
345 }
346 /// API for generation of expressions captured in a innermost OpenMP
347 /// region.
348 class CGOpenMPInnerExprInfo final : public CGOpenMPInlinedRegionInfo {
349 public:
350   CGOpenMPInnerExprInfo(CodeGenFunction &CGF, const CapturedStmt &CS)
351       : CGOpenMPInlinedRegionInfo(CGF.CapturedStmtInfo, EmptyCodeGen,
352                                   OMPD_unknown,
353                                   /*HasCancel=*/false),
354         PrivScope(CGF) {
355     // Make sure the globals captured in the provided statement are local by
356     // using the privatization logic. We assume the same variable is not
357     // captured more than once.
358     for (const auto &C : CS.captures()) {
359       if (!C.capturesVariable() && !C.capturesVariableByCopy())
360         continue;
361 
362       const VarDecl *VD = C.getCapturedVar();
363       if (VD->isLocalVarDeclOrParm())
364         continue;
365 
366       DeclRefExpr DRE(CGF.getContext(), const_cast<VarDecl *>(VD),
367                       /*RefersToEnclosingVariableOrCapture=*/false,
368                       VD->getType().getNonReferenceType(), VK_LValue,
369                       C.getLocation());
370       PrivScope.addPrivate(
371           VD, [&CGF, &DRE]() { return CGF.EmitLValue(&DRE).getAddress(CGF); });
372     }
373     (void)PrivScope.Privatize();
374   }
375 
376   /// Lookup the captured field decl for a variable.
377   const FieldDecl *lookup(const VarDecl *VD) const override {
378     if (const FieldDecl *FD = CGOpenMPInlinedRegionInfo::lookup(VD))
379       return FD;
380     return nullptr;
381   }
382 
383   /// Emit the captured statement body.
384   void EmitBody(CodeGenFunction &CGF, const Stmt *S) override {
385     llvm_unreachable("No body for expressions");
386   }
387 
388   /// Get a variable or parameter for storing global thread id
389   /// inside OpenMP construct.
390   const VarDecl *getThreadIDVariable() const override {
391     llvm_unreachable("No thread id for expressions");
392   }
393 
394   /// Get the name of the capture helper.
395   StringRef getHelperName() const override {
396     llvm_unreachable("No helper name for expressions");
397   }
398 
399   static bool classof(const CGCapturedStmtInfo *Info) { return false; }
400 
401 private:
402   /// Private scope to capture global variables.
403   CodeGenFunction::OMPPrivateScope PrivScope;
404 };
405 
406 /// RAII for emitting code of OpenMP constructs.
407 class InlinedOpenMPRegionRAII {
408   CodeGenFunction &CGF;
409   llvm::DenseMap<const VarDecl *, FieldDecl *> LambdaCaptureFields;
410   FieldDecl *LambdaThisCaptureField = nullptr;
411   const CodeGen::CGBlockInfo *BlockInfo = nullptr;
412 
413 public:
414   /// Constructs region for combined constructs.
415   /// \param CodeGen Code generation sequence for combined directives. Includes
416   /// a list of functions used for code generation of implicitly inlined
417   /// regions.
418   InlinedOpenMPRegionRAII(CodeGenFunction &CGF, const RegionCodeGenTy &CodeGen,
419                           OpenMPDirectiveKind Kind, bool HasCancel)
420       : CGF(CGF) {
421     // Start emission for the construct.
422     CGF.CapturedStmtInfo = new CGOpenMPInlinedRegionInfo(
423         CGF.CapturedStmtInfo, CodeGen, Kind, HasCancel);
424     std::swap(CGF.LambdaCaptureFields, LambdaCaptureFields);
425     LambdaThisCaptureField = CGF.LambdaThisCaptureField;
426     CGF.LambdaThisCaptureField = nullptr;
427     BlockInfo = CGF.BlockInfo;
428     CGF.BlockInfo = nullptr;
429   }
430 
431   ~InlinedOpenMPRegionRAII() {
432     // Restore original CapturedStmtInfo only if we're done with code emission.
433     auto *OldCSI =
434         cast<CGOpenMPInlinedRegionInfo>(CGF.CapturedStmtInfo)->getOldCSI();
435     delete CGF.CapturedStmtInfo;
436     CGF.CapturedStmtInfo = OldCSI;
437     std::swap(CGF.LambdaCaptureFields, LambdaCaptureFields);
438     CGF.LambdaThisCaptureField = LambdaThisCaptureField;
439     CGF.BlockInfo = BlockInfo;
440   }
441 };
442 
443 /// Values for bit flags used in the ident_t to describe the fields.
444 /// All enumeric elements are named and described in accordance with the code
445 /// from https://github.com/llvm/llvm-project/blob/master/openmp/runtime/src/kmp.h
446 enum OpenMPLocationFlags : unsigned {
447   /// Use trampoline for internal microtask.
448   OMP_IDENT_IMD = 0x01,
449   /// Use c-style ident structure.
450   OMP_IDENT_KMPC = 0x02,
451   /// Atomic reduction option for kmpc_reduce.
452   OMP_ATOMIC_REDUCE = 0x10,
453   /// Explicit 'barrier' directive.
454   OMP_IDENT_BARRIER_EXPL = 0x20,
455   /// Implicit barrier in code.
456   OMP_IDENT_BARRIER_IMPL = 0x40,
457   /// Implicit barrier in 'for' directive.
458   OMP_IDENT_BARRIER_IMPL_FOR = 0x40,
459   /// Implicit barrier in 'sections' directive.
460   OMP_IDENT_BARRIER_IMPL_SECTIONS = 0xC0,
461   /// Implicit barrier in 'single' directive.
462   OMP_IDENT_BARRIER_IMPL_SINGLE = 0x140,
463   /// Call of __kmp_for_static_init for static loop.
464   OMP_IDENT_WORK_LOOP = 0x200,
465   /// Call of __kmp_for_static_init for sections.
466   OMP_IDENT_WORK_SECTIONS = 0x400,
467   /// Call of __kmp_for_static_init for distribute.
468   OMP_IDENT_WORK_DISTRIBUTE = 0x800,
469   LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/OMP_IDENT_WORK_DISTRIBUTE)
470 };
471 
472 namespace {
473 LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE();
474 /// Values for bit flags for marking which requires clauses have been used.
475 enum OpenMPOffloadingRequiresDirFlags : int64_t {
476   /// flag undefined.
477   OMP_REQ_UNDEFINED               = 0x000,
478   /// no requires clause present.
479   OMP_REQ_NONE                    = 0x001,
480   /// reverse_offload clause.
481   OMP_REQ_REVERSE_OFFLOAD         = 0x002,
482   /// unified_address clause.
483   OMP_REQ_UNIFIED_ADDRESS         = 0x004,
484   /// unified_shared_memory clause.
485   OMP_REQ_UNIFIED_SHARED_MEMORY   = 0x008,
486   /// dynamic_allocators clause.
487   OMP_REQ_DYNAMIC_ALLOCATORS      = 0x010,
488   LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/OMP_REQ_DYNAMIC_ALLOCATORS)
489 };
490 
491 enum OpenMPOffloadingReservedDeviceIDs {
492   /// Device ID if the device was not defined, runtime should get it
493   /// from environment variables in the spec.
494   OMP_DEVICEID_UNDEF = -1,
495 };
496 } // anonymous namespace
497 
498 /// Describes ident structure that describes a source location.
499 /// All descriptions are taken from
500 /// https://github.com/llvm/llvm-project/blob/master/openmp/runtime/src/kmp.h
501 /// Original structure:
502 /// typedef struct ident {
503 ///    kmp_int32 reserved_1;   /**<  might be used in Fortran;
504 ///                                  see above  */
505 ///    kmp_int32 flags;        /**<  also f.flags; KMP_IDENT_xxx flags;
506 ///                                  KMP_IDENT_KMPC identifies this union
507 ///                                  member  */
508 ///    kmp_int32 reserved_2;   /**<  not really used in Fortran any more;
509 ///                                  see above */
510 ///#if USE_ITT_BUILD
511 ///                            /*  but currently used for storing
512 ///                                region-specific ITT */
513 ///                            /*  contextual information. */
514 ///#endif /* USE_ITT_BUILD */
515 ///    kmp_int32 reserved_3;   /**< source[4] in Fortran, do not use for
516 ///                                 C++  */
517 ///    char const *psource;    /**< String describing the source location.
518 ///                            The string is composed of semi-colon separated
519 //                             fields which describe the source file,
520 ///                            the function and a pair of line numbers that
521 ///                            delimit the construct.
522 ///                             */
523 /// } ident_t;
524 enum IdentFieldIndex {
525   /// might be used in Fortran
526   IdentField_Reserved_1,
527   /// OMP_IDENT_xxx flags; OMP_IDENT_KMPC identifies this union member.
528   IdentField_Flags,
529   /// Not really used in Fortran any more
530   IdentField_Reserved_2,
531   /// Source[4] in Fortran, do not use for C++
532   IdentField_Reserved_3,
533   /// String describing the source location. The string is composed of
534   /// semi-colon separated fields which describe the source file, the function
535   /// and a pair of line numbers that delimit the construct.
536   IdentField_PSource
537 };
538 
539 /// Schedule types for 'omp for' loops (these enumerators are taken from
540 /// the enum sched_type in kmp.h).
541 enum OpenMPSchedType {
542   /// Lower bound for default (unordered) versions.
543   OMP_sch_lower = 32,
544   OMP_sch_static_chunked = 33,
545   OMP_sch_static = 34,
546   OMP_sch_dynamic_chunked = 35,
547   OMP_sch_guided_chunked = 36,
548   OMP_sch_runtime = 37,
549   OMP_sch_auto = 38,
550   /// static with chunk adjustment (e.g., simd)
551   OMP_sch_static_balanced_chunked = 45,
552   /// Lower bound for 'ordered' versions.
553   OMP_ord_lower = 64,
554   OMP_ord_static_chunked = 65,
555   OMP_ord_static = 66,
556   OMP_ord_dynamic_chunked = 67,
557   OMP_ord_guided_chunked = 68,
558   OMP_ord_runtime = 69,
559   OMP_ord_auto = 70,
560   OMP_sch_default = OMP_sch_static,
561   /// dist_schedule types
562   OMP_dist_sch_static_chunked = 91,
563   OMP_dist_sch_static = 92,
564   /// Support for OpenMP 4.5 monotonic and nonmonotonic schedule modifiers.
565   /// Set if the monotonic schedule modifier was present.
566   OMP_sch_modifier_monotonic = (1 << 29),
567   /// Set if the nonmonotonic schedule modifier was present.
568   OMP_sch_modifier_nonmonotonic = (1 << 30),
569 };
570 
571 /// A basic class for pre|post-action for advanced codegen sequence for OpenMP
572 /// region.
573 class CleanupTy final : public EHScopeStack::Cleanup {
574   PrePostActionTy *Action;
575 
576 public:
577   explicit CleanupTy(PrePostActionTy *Action) : Action(Action) {}
578   void Emit(CodeGenFunction &CGF, Flags /*flags*/) override {
579     if (!CGF.HaveInsertPoint())
580       return;
581     Action->Exit(CGF);
582   }
583 };
584 
585 } // anonymous namespace
586 
587 void RegionCodeGenTy::operator()(CodeGenFunction &CGF) const {
588   CodeGenFunction::RunCleanupsScope Scope(CGF);
589   if (PrePostAction) {
590     CGF.EHStack.pushCleanup<CleanupTy>(NormalAndEHCleanup, PrePostAction);
591     Callback(CodeGen, CGF, *PrePostAction);
592   } else {
593     PrePostActionTy Action;
594     Callback(CodeGen, CGF, Action);
595   }
596 }
597 
598 /// Check if the combiner is a call to UDR combiner and if it is so return the
599 /// UDR decl used for reduction.
600 static const OMPDeclareReductionDecl *
601 getReductionInit(const Expr *ReductionOp) {
602   if (const auto *CE = dyn_cast<CallExpr>(ReductionOp))
603     if (const auto *OVE = dyn_cast<OpaqueValueExpr>(CE->getCallee()))
604       if (const auto *DRE =
605               dyn_cast<DeclRefExpr>(OVE->getSourceExpr()->IgnoreImpCasts()))
606         if (const auto *DRD = dyn_cast<OMPDeclareReductionDecl>(DRE->getDecl()))
607           return DRD;
608   return nullptr;
609 }
610 
611 static void emitInitWithReductionInitializer(CodeGenFunction &CGF,
612                                              const OMPDeclareReductionDecl *DRD,
613                                              const Expr *InitOp,
614                                              Address Private, Address Original,
615                                              QualType Ty) {
616   if (DRD->getInitializer()) {
617     std::pair<llvm::Function *, llvm::Function *> Reduction =
618         CGF.CGM.getOpenMPRuntime().getUserDefinedReduction(DRD);
619     const auto *CE = cast<CallExpr>(InitOp);
620     const auto *OVE = cast<OpaqueValueExpr>(CE->getCallee());
621     const Expr *LHS = CE->getArg(/*Arg=*/0)->IgnoreParenImpCasts();
622     const Expr *RHS = CE->getArg(/*Arg=*/1)->IgnoreParenImpCasts();
623     const auto *LHSDRE =
624         cast<DeclRefExpr>(cast<UnaryOperator>(LHS)->getSubExpr());
625     const auto *RHSDRE =
626         cast<DeclRefExpr>(cast<UnaryOperator>(RHS)->getSubExpr());
627     CodeGenFunction::OMPPrivateScope PrivateScope(CGF);
628     PrivateScope.addPrivate(cast<VarDecl>(LHSDRE->getDecl()),
629                             [=]() { return Private; });
630     PrivateScope.addPrivate(cast<VarDecl>(RHSDRE->getDecl()),
631                             [=]() { return Original; });
632     (void)PrivateScope.Privatize();
633     RValue Func = RValue::get(Reduction.second);
634     CodeGenFunction::OpaqueValueMapping Map(CGF, OVE, Func);
635     CGF.EmitIgnoredExpr(InitOp);
636   } else {
637     llvm::Constant *Init = CGF.CGM.EmitNullConstant(Ty);
638     std::string Name = CGF.CGM.getOpenMPRuntime().getName({"init"});
639     auto *GV = new llvm::GlobalVariable(
640         CGF.CGM.getModule(), Init->getType(), /*isConstant=*/true,
641         llvm::GlobalValue::PrivateLinkage, Init, Name);
642     LValue LV = CGF.MakeNaturalAlignAddrLValue(GV, Ty);
643     RValue InitRVal;
644     switch (CGF.getEvaluationKind(Ty)) {
645     case TEK_Scalar:
646       InitRVal = CGF.EmitLoadOfLValue(LV, DRD->getLocation());
647       break;
648     case TEK_Complex:
649       InitRVal =
650           RValue::getComplex(CGF.EmitLoadOfComplex(LV, DRD->getLocation()));
651       break;
652     case TEK_Aggregate:
653       InitRVal = RValue::getAggregate(LV.getAddress(CGF));
654       break;
655     }
656     OpaqueValueExpr OVE(DRD->getLocation(), Ty, VK_RValue);
657     CodeGenFunction::OpaqueValueMapping OpaqueMap(CGF, &OVE, InitRVal);
658     CGF.EmitAnyExprToMem(&OVE, Private, Ty.getQualifiers(),
659                          /*IsInitializer=*/false);
660   }
661 }
662 
663 /// Emit initialization of arrays of complex types.
664 /// \param DestAddr Address of the array.
665 /// \param Type Type of array.
666 /// \param Init Initial expression of array.
667 /// \param SrcAddr Address of the original array.
668 static void EmitOMPAggregateInit(CodeGenFunction &CGF, Address DestAddr,
669                                  QualType Type, bool EmitDeclareReductionInit,
670                                  const Expr *Init,
671                                  const OMPDeclareReductionDecl *DRD,
672                                  Address SrcAddr = Address::invalid()) {
673   // Perform element-by-element initialization.
674   QualType ElementTy;
675 
676   // Drill down to the base element type on both arrays.
677   const ArrayType *ArrayTy = Type->getAsArrayTypeUnsafe();
678   llvm::Value *NumElements = CGF.emitArrayLength(ArrayTy, ElementTy, DestAddr);
679   DestAddr =
680       CGF.Builder.CreateElementBitCast(DestAddr, DestAddr.getElementType());
681   if (DRD)
682     SrcAddr =
683         CGF.Builder.CreateElementBitCast(SrcAddr, DestAddr.getElementType());
684 
685   llvm::Value *SrcBegin = nullptr;
686   if (DRD)
687     SrcBegin = SrcAddr.getPointer();
688   llvm::Value *DestBegin = DestAddr.getPointer();
689   // Cast from pointer to array type to pointer to single element.
690   llvm::Value *DestEnd = CGF.Builder.CreateGEP(DestBegin, NumElements);
691   // The basic structure here is a while-do loop.
692   llvm::BasicBlock *BodyBB = CGF.createBasicBlock("omp.arrayinit.body");
693   llvm::BasicBlock *DoneBB = CGF.createBasicBlock("omp.arrayinit.done");
694   llvm::Value *IsEmpty =
695       CGF.Builder.CreateICmpEQ(DestBegin, DestEnd, "omp.arrayinit.isempty");
696   CGF.Builder.CreateCondBr(IsEmpty, DoneBB, BodyBB);
697 
698   // Enter the loop body, making that address the current address.
699   llvm::BasicBlock *EntryBB = CGF.Builder.GetInsertBlock();
700   CGF.EmitBlock(BodyBB);
701 
702   CharUnits ElementSize = CGF.getContext().getTypeSizeInChars(ElementTy);
703 
704   llvm::PHINode *SrcElementPHI = nullptr;
705   Address SrcElementCurrent = Address::invalid();
706   if (DRD) {
707     SrcElementPHI = CGF.Builder.CreatePHI(SrcBegin->getType(), 2,
708                                           "omp.arraycpy.srcElementPast");
709     SrcElementPHI->addIncoming(SrcBegin, EntryBB);
710     SrcElementCurrent =
711         Address(SrcElementPHI,
712                 SrcAddr.getAlignment().alignmentOfArrayElement(ElementSize));
713   }
714   llvm::PHINode *DestElementPHI = CGF.Builder.CreatePHI(
715       DestBegin->getType(), 2, "omp.arraycpy.destElementPast");
716   DestElementPHI->addIncoming(DestBegin, EntryBB);
717   Address DestElementCurrent =
718       Address(DestElementPHI,
719               DestAddr.getAlignment().alignmentOfArrayElement(ElementSize));
720 
721   // Emit copy.
722   {
723     CodeGenFunction::RunCleanupsScope InitScope(CGF);
724     if (EmitDeclareReductionInit) {
725       emitInitWithReductionInitializer(CGF, DRD, Init, DestElementCurrent,
726                                        SrcElementCurrent, ElementTy);
727     } else
728       CGF.EmitAnyExprToMem(Init, DestElementCurrent, ElementTy.getQualifiers(),
729                            /*IsInitializer=*/false);
730   }
731 
732   if (DRD) {
733     // Shift the address forward by one element.
734     llvm::Value *SrcElementNext = CGF.Builder.CreateConstGEP1_32(
735         SrcElementPHI, /*Idx0=*/1, "omp.arraycpy.dest.element");
736     SrcElementPHI->addIncoming(SrcElementNext, CGF.Builder.GetInsertBlock());
737   }
738 
739   // Shift the address forward by one element.
740   llvm::Value *DestElementNext = CGF.Builder.CreateConstGEP1_32(
741       DestElementPHI, /*Idx0=*/1, "omp.arraycpy.dest.element");
742   // Check whether we've reached the end.
743   llvm::Value *Done =
744       CGF.Builder.CreateICmpEQ(DestElementNext, DestEnd, "omp.arraycpy.done");
745   CGF.Builder.CreateCondBr(Done, DoneBB, BodyBB);
746   DestElementPHI->addIncoming(DestElementNext, CGF.Builder.GetInsertBlock());
747 
748   // Done.
749   CGF.EmitBlock(DoneBB, /*IsFinished=*/true);
750 }
751 
752 LValue ReductionCodeGen::emitSharedLValue(CodeGenFunction &CGF, const Expr *E) {
753   return CGF.EmitOMPSharedLValue(E);
754 }
755 
756 LValue ReductionCodeGen::emitSharedLValueUB(CodeGenFunction &CGF,
757                                             const Expr *E) {
758   if (const auto *OASE = dyn_cast<OMPArraySectionExpr>(E))
759     return CGF.EmitOMPArraySectionExpr(OASE, /*IsLowerBound=*/false);
760   return LValue();
761 }
762 
763 void ReductionCodeGen::emitAggregateInitialization(
764     CodeGenFunction &CGF, unsigned N, Address PrivateAddr, LValue SharedLVal,
765     const OMPDeclareReductionDecl *DRD) {
766   // Emit VarDecl with copy init for arrays.
767   // Get the address of the original variable captured in current
768   // captured region.
769   const auto *PrivateVD =
770       cast<VarDecl>(cast<DeclRefExpr>(ClausesData[N].Private)->getDecl());
771   bool EmitDeclareReductionInit =
772       DRD && (DRD->getInitializer() || !PrivateVD->hasInit());
773   EmitOMPAggregateInit(CGF, PrivateAddr, PrivateVD->getType(),
774                        EmitDeclareReductionInit,
775                        EmitDeclareReductionInit ? ClausesData[N].ReductionOp
776                                                 : PrivateVD->getInit(),
777                        DRD, SharedLVal.getAddress(CGF));
778 }
779 
780 ReductionCodeGen::ReductionCodeGen(ArrayRef<const Expr *> Shareds,
781                                    ArrayRef<const Expr *> Origs,
782                                    ArrayRef<const Expr *> Privates,
783                                    ArrayRef<const Expr *> ReductionOps) {
784   ClausesData.reserve(Shareds.size());
785   SharedAddresses.reserve(Shareds.size());
786   Sizes.reserve(Shareds.size());
787   BaseDecls.reserve(Shareds.size());
788   const auto *IOrig = Origs.begin();
789   const auto *IPriv = Privates.begin();
790   const auto *IRed = ReductionOps.begin();
791   for (const Expr *Ref : Shareds) {
792     ClausesData.emplace_back(Ref, *IOrig, *IPriv, *IRed);
793     std::advance(IOrig, 1);
794     std::advance(IPriv, 1);
795     std::advance(IRed, 1);
796   }
797 }
798 
799 void ReductionCodeGen::emitSharedOrigLValue(CodeGenFunction &CGF, unsigned N) {
800   assert(SharedAddresses.size() == N && OrigAddresses.size() == N &&
801          "Number of generated lvalues must be exactly N.");
802   LValue First = emitSharedLValue(CGF, ClausesData[N].Shared);
803   LValue Second = emitSharedLValueUB(CGF, ClausesData[N].Shared);
804   SharedAddresses.emplace_back(First, Second);
805   if (ClausesData[N].Shared == ClausesData[N].Ref) {
806     OrigAddresses.emplace_back(First, Second);
807   } else {
808     LValue First = emitSharedLValue(CGF, ClausesData[N].Ref);
809     LValue Second = emitSharedLValueUB(CGF, ClausesData[N].Ref);
810     OrigAddresses.emplace_back(First, Second);
811   }
812 }
813 
814 void ReductionCodeGen::emitAggregateType(CodeGenFunction &CGF, unsigned N) {
815   const auto *PrivateVD =
816       cast<VarDecl>(cast<DeclRefExpr>(ClausesData[N].Private)->getDecl());
817   QualType PrivateType = PrivateVD->getType();
818   bool AsArraySection = isa<OMPArraySectionExpr>(ClausesData[N].Ref);
819   if (!PrivateType->isVariablyModifiedType()) {
820     Sizes.emplace_back(
821         CGF.getTypeSize(OrigAddresses[N].first.getType().getNonReferenceType()),
822         nullptr);
823     return;
824   }
825   llvm::Value *Size;
826   llvm::Value *SizeInChars;
827   auto *ElemType =
828       cast<llvm::PointerType>(OrigAddresses[N].first.getPointer(CGF)->getType())
829           ->getElementType();
830   auto *ElemSizeOf = llvm::ConstantExpr::getSizeOf(ElemType);
831   if (AsArraySection) {
832     Size = CGF.Builder.CreatePtrDiff(OrigAddresses[N].second.getPointer(CGF),
833                                      OrigAddresses[N].first.getPointer(CGF));
834     Size = CGF.Builder.CreateNUWAdd(
835         Size, llvm::ConstantInt::get(Size->getType(), /*V=*/1));
836     SizeInChars = CGF.Builder.CreateNUWMul(Size, ElemSizeOf);
837   } else {
838     SizeInChars =
839         CGF.getTypeSize(OrigAddresses[N].first.getType().getNonReferenceType());
840     Size = CGF.Builder.CreateExactUDiv(SizeInChars, ElemSizeOf);
841   }
842   Sizes.emplace_back(SizeInChars, Size);
843   CodeGenFunction::OpaqueValueMapping OpaqueMap(
844       CGF,
845       cast<OpaqueValueExpr>(
846           CGF.getContext().getAsVariableArrayType(PrivateType)->getSizeExpr()),
847       RValue::get(Size));
848   CGF.EmitVariablyModifiedType(PrivateType);
849 }
850 
851 void ReductionCodeGen::emitAggregateType(CodeGenFunction &CGF, unsigned N,
852                                          llvm::Value *Size) {
853   const auto *PrivateVD =
854       cast<VarDecl>(cast<DeclRefExpr>(ClausesData[N].Private)->getDecl());
855   QualType PrivateType = PrivateVD->getType();
856   if (!PrivateType->isVariablyModifiedType()) {
857     assert(!Size && !Sizes[N].second &&
858            "Size should be nullptr for non-variably modified reduction "
859            "items.");
860     return;
861   }
862   CodeGenFunction::OpaqueValueMapping OpaqueMap(
863       CGF,
864       cast<OpaqueValueExpr>(
865           CGF.getContext().getAsVariableArrayType(PrivateType)->getSizeExpr()),
866       RValue::get(Size));
867   CGF.EmitVariablyModifiedType(PrivateType);
868 }
869 
870 void ReductionCodeGen::emitInitialization(
871     CodeGenFunction &CGF, unsigned N, Address PrivateAddr, LValue SharedLVal,
872     llvm::function_ref<bool(CodeGenFunction &)> DefaultInit) {
873   assert(SharedAddresses.size() > N && "No variable was generated");
874   const auto *PrivateVD =
875       cast<VarDecl>(cast<DeclRefExpr>(ClausesData[N].Private)->getDecl());
876   const OMPDeclareReductionDecl *DRD =
877       getReductionInit(ClausesData[N].ReductionOp);
878   QualType PrivateType = PrivateVD->getType();
879   PrivateAddr = CGF.Builder.CreateElementBitCast(
880       PrivateAddr, CGF.ConvertTypeForMem(PrivateType));
881   QualType SharedType = SharedAddresses[N].first.getType();
882   SharedLVal = CGF.MakeAddrLValue(
883       CGF.Builder.CreateElementBitCast(SharedLVal.getAddress(CGF),
884                                        CGF.ConvertTypeForMem(SharedType)),
885       SharedType, SharedAddresses[N].first.getBaseInfo(),
886       CGF.CGM.getTBAAInfoForSubobject(SharedAddresses[N].first, SharedType));
887   if (CGF.getContext().getAsArrayType(PrivateVD->getType())) {
888     if (DRD && DRD->getInitializer())
889       (void)DefaultInit(CGF);
890     emitAggregateInitialization(CGF, N, PrivateAddr, SharedLVal, DRD);
891   } else if (DRD && (DRD->getInitializer() || !PrivateVD->hasInit())) {
892     (void)DefaultInit(CGF);
893     emitInitWithReductionInitializer(CGF, DRD, ClausesData[N].ReductionOp,
894                                      PrivateAddr, SharedLVal.getAddress(CGF),
895                                      SharedLVal.getType());
896   } else if (!DefaultInit(CGF) && PrivateVD->hasInit() &&
897              !CGF.isTrivialInitializer(PrivateVD->getInit())) {
898     CGF.EmitAnyExprToMem(PrivateVD->getInit(), PrivateAddr,
899                          PrivateVD->getType().getQualifiers(),
900                          /*IsInitializer=*/false);
901   }
902 }
903 
904 bool ReductionCodeGen::needCleanups(unsigned N) {
905   const auto *PrivateVD =
906       cast<VarDecl>(cast<DeclRefExpr>(ClausesData[N].Private)->getDecl());
907   QualType PrivateType = PrivateVD->getType();
908   QualType::DestructionKind DTorKind = PrivateType.isDestructedType();
909   return DTorKind != QualType::DK_none;
910 }
911 
912 void ReductionCodeGen::emitCleanups(CodeGenFunction &CGF, unsigned N,
913                                     Address PrivateAddr) {
914   const auto *PrivateVD =
915       cast<VarDecl>(cast<DeclRefExpr>(ClausesData[N].Private)->getDecl());
916   QualType PrivateType = PrivateVD->getType();
917   QualType::DestructionKind DTorKind = PrivateType.isDestructedType();
918   if (needCleanups(N)) {
919     PrivateAddr = CGF.Builder.CreateElementBitCast(
920         PrivateAddr, CGF.ConvertTypeForMem(PrivateType));
921     CGF.pushDestroy(DTorKind, PrivateAddr, PrivateType);
922   }
923 }
924 
925 static LValue loadToBegin(CodeGenFunction &CGF, QualType BaseTy, QualType ElTy,
926                           LValue BaseLV) {
927   BaseTy = BaseTy.getNonReferenceType();
928   while ((BaseTy->isPointerType() || BaseTy->isReferenceType()) &&
929          !CGF.getContext().hasSameType(BaseTy, ElTy)) {
930     if (const auto *PtrTy = BaseTy->getAs<PointerType>()) {
931       BaseLV = CGF.EmitLoadOfPointerLValue(BaseLV.getAddress(CGF), PtrTy);
932     } else {
933       LValue RefLVal = CGF.MakeAddrLValue(BaseLV.getAddress(CGF), BaseTy);
934       BaseLV = CGF.EmitLoadOfReferenceLValue(RefLVal);
935     }
936     BaseTy = BaseTy->getPointeeType();
937   }
938   return CGF.MakeAddrLValue(
939       CGF.Builder.CreateElementBitCast(BaseLV.getAddress(CGF),
940                                        CGF.ConvertTypeForMem(ElTy)),
941       BaseLV.getType(), BaseLV.getBaseInfo(),
942       CGF.CGM.getTBAAInfoForSubobject(BaseLV, BaseLV.getType()));
943 }
944 
945 static Address castToBase(CodeGenFunction &CGF, QualType BaseTy, QualType ElTy,
946                           llvm::Type *BaseLVType, CharUnits BaseLVAlignment,
947                           llvm::Value *Addr) {
948   Address Tmp = Address::invalid();
949   Address TopTmp = Address::invalid();
950   Address MostTopTmp = Address::invalid();
951   BaseTy = BaseTy.getNonReferenceType();
952   while ((BaseTy->isPointerType() || BaseTy->isReferenceType()) &&
953          !CGF.getContext().hasSameType(BaseTy, ElTy)) {
954     Tmp = CGF.CreateMemTemp(BaseTy);
955     if (TopTmp.isValid())
956       CGF.Builder.CreateStore(Tmp.getPointer(), TopTmp);
957     else
958       MostTopTmp = Tmp;
959     TopTmp = Tmp;
960     BaseTy = BaseTy->getPointeeType();
961   }
962   llvm::Type *Ty = BaseLVType;
963   if (Tmp.isValid())
964     Ty = Tmp.getElementType();
965   Addr = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(Addr, Ty);
966   if (Tmp.isValid()) {
967     CGF.Builder.CreateStore(Addr, Tmp);
968     return MostTopTmp;
969   }
970   return Address(Addr, BaseLVAlignment);
971 }
972 
973 static const VarDecl *getBaseDecl(const Expr *Ref, const DeclRefExpr *&DE) {
974   const VarDecl *OrigVD = nullptr;
975   if (const auto *OASE = dyn_cast<OMPArraySectionExpr>(Ref)) {
976     const Expr *Base = OASE->getBase()->IgnoreParenImpCasts();
977     while (const auto *TempOASE = dyn_cast<OMPArraySectionExpr>(Base))
978       Base = TempOASE->getBase()->IgnoreParenImpCasts();
979     while (const auto *TempASE = dyn_cast<ArraySubscriptExpr>(Base))
980       Base = TempASE->getBase()->IgnoreParenImpCasts();
981     DE = cast<DeclRefExpr>(Base);
982     OrigVD = cast<VarDecl>(DE->getDecl());
983   } else if (const auto *ASE = dyn_cast<ArraySubscriptExpr>(Ref)) {
984     const Expr *Base = ASE->getBase()->IgnoreParenImpCasts();
985     while (const auto *TempASE = dyn_cast<ArraySubscriptExpr>(Base))
986       Base = TempASE->getBase()->IgnoreParenImpCasts();
987     DE = cast<DeclRefExpr>(Base);
988     OrigVD = cast<VarDecl>(DE->getDecl());
989   }
990   return OrigVD;
991 }
992 
993 Address ReductionCodeGen::adjustPrivateAddress(CodeGenFunction &CGF, unsigned N,
994                                                Address PrivateAddr) {
995   const DeclRefExpr *DE;
996   if (const VarDecl *OrigVD = ::getBaseDecl(ClausesData[N].Ref, DE)) {
997     BaseDecls.emplace_back(OrigVD);
998     LValue OriginalBaseLValue = CGF.EmitLValue(DE);
999     LValue BaseLValue =
1000         loadToBegin(CGF, OrigVD->getType(), SharedAddresses[N].first.getType(),
1001                     OriginalBaseLValue);
1002     llvm::Value *Adjustment = CGF.Builder.CreatePtrDiff(
1003         BaseLValue.getPointer(CGF), SharedAddresses[N].first.getPointer(CGF));
1004     llvm::Value *PrivatePointer =
1005         CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
1006             PrivateAddr.getPointer(),
1007             SharedAddresses[N].first.getAddress(CGF).getType());
1008     llvm::Value *Ptr = CGF.Builder.CreateGEP(PrivatePointer, Adjustment);
1009     return castToBase(CGF, OrigVD->getType(),
1010                       SharedAddresses[N].first.getType(),
1011                       OriginalBaseLValue.getAddress(CGF).getType(),
1012                       OriginalBaseLValue.getAlignment(), Ptr);
1013   }
1014   BaseDecls.emplace_back(
1015       cast<VarDecl>(cast<DeclRefExpr>(ClausesData[N].Ref)->getDecl()));
1016   return PrivateAddr;
1017 }
1018 
1019 bool ReductionCodeGen::usesReductionInitializer(unsigned N) const {
1020   const OMPDeclareReductionDecl *DRD =
1021       getReductionInit(ClausesData[N].ReductionOp);
1022   return DRD && DRD->getInitializer();
1023 }
1024 
1025 LValue CGOpenMPRegionInfo::getThreadIDVariableLValue(CodeGenFunction &CGF) {
1026   return CGF.EmitLoadOfPointerLValue(
1027       CGF.GetAddrOfLocalVar(getThreadIDVariable()),
1028       getThreadIDVariable()->getType()->castAs<PointerType>());
1029 }
1030 
1031 void CGOpenMPRegionInfo::EmitBody(CodeGenFunction &CGF, const Stmt * /*S*/) {
1032   if (!CGF.HaveInsertPoint())
1033     return;
1034   // 1.2.2 OpenMP Language Terminology
1035   // Structured block - An executable statement with a single entry at the
1036   // top and a single exit at the bottom.
1037   // The point of exit cannot be a branch out of the structured block.
1038   // longjmp() and throw() must not violate the entry/exit criteria.
1039   CGF.EHStack.pushTerminate();
1040   CodeGen(CGF);
1041   CGF.EHStack.popTerminate();
1042 }
1043 
1044 LValue CGOpenMPTaskOutlinedRegionInfo::getThreadIDVariableLValue(
1045     CodeGenFunction &CGF) {
1046   return CGF.MakeAddrLValue(CGF.GetAddrOfLocalVar(getThreadIDVariable()),
1047                             getThreadIDVariable()->getType(),
1048                             AlignmentSource::Decl);
1049 }
1050 
1051 static FieldDecl *addFieldToRecordDecl(ASTContext &C, DeclContext *DC,
1052                                        QualType FieldTy) {
1053   auto *Field = FieldDecl::Create(
1054       C, DC, SourceLocation(), SourceLocation(), /*Id=*/nullptr, FieldTy,
1055       C.getTrivialTypeSourceInfo(FieldTy, SourceLocation()),
1056       /*BW=*/nullptr, /*Mutable=*/false, /*InitStyle=*/ICIS_NoInit);
1057   Field->setAccess(AS_public);
1058   DC->addDecl(Field);
1059   return Field;
1060 }
1061 
1062 CGOpenMPRuntime::CGOpenMPRuntime(CodeGenModule &CGM, StringRef FirstSeparator,
1063                                  StringRef Separator)
1064     : CGM(CGM), FirstSeparator(FirstSeparator), Separator(Separator),
1065       OMPBuilder(CGM.getModule()), OffloadEntriesInfoManager(CGM) {
1066   KmpCriticalNameTy = llvm::ArrayType::get(CGM.Int32Ty, /*NumElements*/ 8);
1067 
1068   // Initialize Types used in OpenMPIRBuilder from OMPKinds.def
1069   OMPBuilder.initialize();
1070   loadOffloadInfoMetadata();
1071 }
1072 
1073 void CGOpenMPRuntime::clear() {
1074   InternalVars.clear();
1075   // Clean non-target variable declarations possibly used only in debug info.
1076   for (const auto &Data : EmittedNonTargetVariables) {
1077     if (!Data.getValue().pointsToAliveValue())
1078       continue;
1079     auto *GV = dyn_cast<llvm::GlobalVariable>(Data.getValue());
1080     if (!GV)
1081       continue;
1082     if (!GV->isDeclaration() || GV->getNumUses() > 0)
1083       continue;
1084     GV->eraseFromParent();
1085   }
1086 }
1087 
1088 std::string CGOpenMPRuntime::getName(ArrayRef<StringRef> Parts) const {
1089   SmallString<128> Buffer;
1090   llvm::raw_svector_ostream OS(Buffer);
1091   StringRef Sep = FirstSeparator;
1092   for (StringRef Part : Parts) {
1093     OS << Sep << Part;
1094     Sep = Separator;
1095   }
1096   return std::string(OS.str());
1097 }
1098 
1099 static llvm::Function *
1100 emitCombinerOrInitializer(CodeGenModule &CGM, QualType Ty,
1101                           const Expr *CombinerInitializer, const VarDecl *In,
1102                           const VarDecl *Out, bool IsCombiner) {
1103   // void .omp_combiner.(Ty *in, Ty *out);
1104   ASTContext &C = CGM.getContext();
1105   QualType PtrTy = C.getPointerType(Ty).withRestrict();
1106   FunctionArgList Args;
1107   ImplicitParamDecl OmpOutParm(C, /*DC=*/nullptr, Out->getLocation(),
1108                                /*Id=*/nullptr, PtrTy, ImplicitParamDecl::Other);
1109   ImplicitParamDecl OmpInParm(C, /*DC=*/nullptr, In->getLocation(),
1110                               /*Id=*/nullptr, PtrTy, ImplicitParamDecl::Other);
1111   Args.push_back(&OmpOutParm);
1112   Args.push_back(&OmpInParm);
1113   const CGFunctionInfo &FnInfo =
1114       CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, Args);
1115   llvm::FunctionType *FnTy = CGM.getTypes().GetFunctionType(FnInfo);
1116   std::string Name = CGM.getOpenMPRuntime().getName(
1117       {IsCombiner ? "omp_combiner" : "omp_initializer", ""});
1118   auto *Fn = llvm::Function::Create(FnTy, llvm::GlobalValue::InternalLinkage,
1119                                     Name, &CGM.getModule());
1120   CGM.SetInternalFunctionAttributes(GlobalDecl(), Fn, FnInfo);
1121   if (CGM.getLangOpts().Optimize) {
1122     Fn->removeFnAttr(llvm::Attribute::NoInline);
1123     Fn->removeFnAttr(llvm::Attribute::OptimizeNone);
1124     Fn->addFnAttr(llvm::Attribute::AlwaysInline);
1125   }
1126   CodeGenFunction CGF(CGM);
1127   // Map "T omp_in;" variable to "*omp_in_parm" value in all expressions.
1128   // Map "T omp_out;" variable to "*omp_out_parm" value in all expressions.
1129   CGF.StartFunction(GlobalDecl(), C.VoidTy, Fn, FnInfo, Args, In->getLocation(),
1130                     Out->getLocation());
1131   CodeGenFunction::OMPPrivateScope Scope(CGF);
1132   Address AddrIn = CGF.GetAddrOfLocalVar(&OmpInParm);
1133   Scope.addPrivate(In, [&CGF, AddrIn, PtrTy]() {
1134     return CGF.EmitLoadOfPointerLValue(AddrIn, PtrTy->castAs<PointerType>())
1135         .getAddress(CGF);
1136   });
1137   Address AddrOut = CGF.GetAddrOfLocalVar(&OmpOutParm);
1138   Scope.addPrivate(Out, [&CGF, AddrOut, PtrTy]() {
1139     return CGF.EmitLoadOfPointerLValue(AddrOut, PtrTy->castAs<PointerType>())
1140         .getAddress(CGF);
1141   });
1142   (void)Scope.Privatize();
1143   if (!IsCombiner && Out->hasInit() &&
1144       !CGF.isTrivialInitializer(Out->getInit())) {
1145     CGF.EmitAnyExprToMem(Out->getInit(), CGF.GetAddrOfLocalVar(Out),
1146                          Out->getType().getQualifiers(),
1147                          /*IsInitializer=*/true);
1148   }
1149   if (CombinerInitializer)
1150     CGF.EmitIgnoredExpr(CombinerInitializer);
1151   Scope.ForceCleanup();
1152   CGF.FinishFunction();
1153   return Fn;
1154 }
1155 
1156 void CGOpenMPRuntime::emitUserDefinedReduction(
1157     CodeGenFunction *CGF, const OMPDeclareReductionDecl *D) {
1158   if (UDRMap.count(D) > 0)
1159     return;
1160   llvm::Function *Combiner = emitCombinerOrInitializer(
1161       CGM, D->getType(), D->getCombiner(),
1162       cast<VarDecl>(cast<DeclRefExpr>(D->getCombinerIn())->getDecl()),
1163       cast<VarDecl>(cast<DeclRefExpr>(D->getCombinerOut())->getDecl()),
1164       /*IsCombiner=*/true);
1165   llvm::Function *Initializer = nullptr;
1166   if (const Expr *Init = D->getInitializer()) {
1167     Initializer = emitCombinerOrInitializer(
1168         CGM, D->getType(),
1169         D->getInitializerKind() == OMPDeclareReductionDecl::CallInit ? Init
1170                                                                      : nullptr,
1171         cast<VarDecl>(cast<DeclRefExpr>(D->getInitOrig())->getDecl()),
1172         cast<VarDecl>(cast<DeclRefExpr>(D->getInitPriv())->getDecl()),
1173         /*IsCombiner=*/false);
1174   }
1175   UDRMap.try_emplace(D, Combiner, Initializer);
1176   if (CGF) {
1177     auto &Decls = FunctionUDRMap.FindAndConstruct(CGF->CurFn);
1178     Decls.second.push_back(D);
1179   }
1180 }
1181 
1182 std::pair<llvm::Function *, llvm::Function *>
1183 CGOpenMPRuntime::getUserDefinedReduction(const OMPDeclareReductionDecl *D) {
1184   auto I = UDRMap.find(D);
1185   if (I != UDRMap.end())
1186     return I->second;
1187   emitUserDefinedReduction(/*CGF=*/nullptr, D);
1188   return UDRMap.lookup(D);
1189 }
1190 
1191 namespace {
1192 // Temporary RAII solution to perform a push/pop stack event on the OpenMP IR
1193 // Builder if one is present.
1194 struct PushAndPopStackRAII {
1195   PushAndPopStackRAII(llvm::OpenMPIRBuilder *OMPBuilder, CodeGenFunction &CGF,
1196                       bool HasCancel)
1197       : OMPBuilder(OMPBuilder) {
1198     if (!OMPBuilder)
1199       return;
1200 
1201     // The following callback is the crucial part of clangs cleanup process.
1202     //
1203     // NOTE:
1204     // Once the OpenMPIRBuilder is used to create parallel regions (and
1205     // similar), the cancellation destination (Dest below) is determined via
1206     // IP. That means if we have variables to finalize we split the block at IP,
1207     // use the new block (=BB) as destination to build a JumpDest (via
1208     // getJumpDestInCurrentScope(BB)) which then is fed to
1209     // EmitBranchThroughCleanup. Furthermore, there will not be the need
1210     // to push & pop an FinalizationInfo object.
1211     // The FiniCB will still be needed but at the point where the
1212     // OpenMPIRBuilder is asked to construct a parallel (or similar) construct.
1213     auto FiniCB = [&CGF](llvm::OpenMPIRBuilder::InsertPointTy IP) {
1214       assert(IP.getBlock()->end() == IP.getPoint() &&
1215              "Clang CG should cause non-terminated block!");
1216       CGBuilderTy::InsertPointGuard IPG(CGF.Builder);
1217       CGF.Builder.restoreIP(IP);
1218       CodeGenFunction::JumpDest Dest =
1219           CGF.getOMPCancelDestination(OMPD_parallel);
1220       CGF.EmitBranchThroughCleanup(Dest);
1221     };
1222 
1223     // TODO: Remove this once we emit parallel regions through the
1224     //       OpenMPIRBuilder as it can do this setup internally.
1225     llvm::OpenMPIRBuilder::FinalizationInfo FI(
1226         {FiniCB, OMPD_parallel, HasCancel});
1227     OMPBuilder->pushFinalizationCB(std::move(FI));
1228   }
1229   ~PushAndPopStackRAII() {
1230     if (OMPBuilder)
1231       OMPBuilder->popFinalizationCB();
1232   }
1233   llvm::OpenMPIRBuilder *OMPBuilder;
1234 };
1235 } // namespace
1236 
1237 static llvm::Function *emitParallelOrTeamsOutlinedFunction(
1238     CodeGenModule &CGM, const OMPExecutableDirective &D, const CapturedStmt *CS,
1239     const VarDecl *ThreadIDVar, OpenMPDirectiveKind InnermostKind,
1240     const StringRef OutlinedHelperName, const RegionCodeGenTy &CodeGen) {
1241   assert(ThreadIDVar->getType()->isPointerType() &&
1242          "thread id variable must be of type kmp_int32 *");
1243   CodeGenFunction CGF(CGM, true);
1244   bool HasCancel = false;
1245   if (const auto *OPD = dyn_cast<OMPParallelDirective>(&D))
1246     HasCancel = OPD->hasCancel();
1247   else if (const auto *OPD = dyn_cast<OMPTargetParallelDirective>(&D))
1248     HasCancel = OPD->hasCancel();
1249   else if (const auto *OPSD = dyn_cast<OMPParallelSectionsDirective>(&D))
1250     HasCancel = OPSD->hasCancel();
1251   else if (const auto *OPFD = dyn_cast<OMPParallelForDirective>(&D))
1252     HasCancel = OPFD->hasCancel();
1253   else if (const auto *OPFD = dyn_cast<OMPTargetParallelForDirective>(&D))
1254     HasCancel = OPFD->hasCancel();
1255   else if (const auto *OPFD = dyn_cast<OMPDistributeParallelForDirective>(&D))
1256     HasCancel = OPFD->hasCancel();
1257   else if (const auto *OPFD =
1258                dyn_cast<OMPTeamsDistributeParallelForDirective>(&D))
1259     HasCancel = OPFD->hasCancel();
1260   else if (const auto *OPFD =
1261                dyn_cast<OMPTargetTeamsDistributeParallelForDirective>(&D))
1262     HasCancel = OPFD->hasCancel();
1263 
1264   // TODO: Temporarily inform the OpenMPIRBuilder, if any, about the new
1265   //       parallel region to make cancellation barriers work properly.
1266   llvm::OpenMPIRBuilder &OMPBuilder = CGM.getOpenMPRuntime().getOMPBuilder();
1267   PushAndPopStackRAII PSR(&OMPBuilder, CGF, HasCancel);
1268   CGOpenMPOutlinedRegionInfo CGInfo(*CS, ThreadIDVar, CodeGen, InnermostKind,
1269                                     HasCancel, OutlinedHelperName);
1270   CodeGenFunction::CGCapturedStmtRAII CapInfoRAII(CGF, &CGInfo);
1271   return CGF.GenerateOpenMPCapturedStmtFunction(*CS, D.getBeginLoc());
1272 }
1273 
1274 llvm::Function *CGOpenMPRuntime::emitParallelOutlinedFunction(
1275     const OMPExecutableDirective &D, const VarDecl *ThreadIDVar,
1276     OpenMPDirectiveKind InnermostKind, const RegionCodeGenTy &CodeGen) {
1277   const CapturedStmt *CS = D.getCapturedStmt(OMPD_parallel);
1278   return emitParallelOrTeamsOutlinedFunction(
1279       CGM, D, CS, ThreadIDVar, InnermostKind, getOutlinedHelperName(), CodeGen);
1280 }
1281 
1282 llvm::Function *CGOpenMPRuntime::emitTeamsOutlinedFunction(
1283     const OMPExecutableDirective &D, const VarDecl *ThreadIDVar,
1284     OpenMPDirectiveKind InnermostKind, const RegionCodeGenTy &CodeGen) {
1285   const CapturedStmt *CS = D.getCapturedStmt(OMPD_teams);
1286   return emitParallelOrTeamsOutlinedFunction(
1287       CGM, D, CS, ThreadIDVar, InnermostKind, getOutlinedHelperName(), CodeGen);
1288 }
1289 
1290 llvm::Function *CGOpenMPRuntime::emitTaskOutlinedFunction(
1291     const OMPExecutableDirective &D, const VarDecl *ThreadIDVar,
1292     const VarDecl *PartIDVar, const VarDecl *TaskTVar,
1293     OpenMPDirectiveKind InnermostKind, const RegionCodeGenTy &CodeGen,
1294     bool Tied, unsigned &NumberOfParts) {
1295   auto &&UntiedCodeGen = [this, &D, TaskTVar](CodeGenFunction &CGF,
1296                                               PrePostActionTy &) {
1297     llvm::Value *ThreadID = getThreadID(CGF, D.getBeginLoc());
1298     llvm::Value *UpLoc = emitUpdateLocation(CGF, D.getBeginLoc());
1299     llvm::Value *TaskArgs[] = {
1300         UpLoc, ThreadID,
1301         CGF.EmitLoadOfPointerLValue(CGF.GetAddrOfLocalVar(TaskTVar),
1302                                     TaskTVar->getType()->castAs<PointerType>())
1303             .getPointer(CGF)};
1304     CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
1305                             CGM.getModule(), OMPRTL___kmpc_omp_task),
1306                         TaskArgs);
1307   };
1308   CGOpenMPTaskOutlinedRegionInfo::UntiedTaskActionTy Action(Tied, PartIDVar,
1309                                                             UntiedCodeGen);
1310   CodeGen.setAction(Action);
1311   assert(!ThreadIDVar->getType()->isPointerType() &&
1312          "thread id variable must be of type kmp_int32 for tasks");
1313   const OpenMPDirectiveKind Region =
1314       isOpenMPTaskLoopDirective(D.getDirectiveKind()) ? OMPD_taskloop
1315                                                       : OMPD_task;
1316   const CapturedStmt *CS = D.getCapturedStmt(Region);
1317   bool HasCancel = false;
1318   if (const auto *TD = dyn_cast<OMPTaskDirective>(&D))
1319     HasCancel = TD->hasCancel();
1320   else if (const auto *TD = dyn_cast<OMPTaskLoopDirective>(&D))
1321     HasCancel = TD->hasCancel();
1322   else if (const auto *TD = dyn_cast<OMPMasterTaskLoopDirective>(&D))
1323     HasCancel = TD->hasCancel();
1324   else if (const auto *TD = dyn_cast<OMPParallelMasterTaskLoopDirective>(&D))
1325     HasCancel = TD->hasCancel();
1326 
1327   CodeGenFunction CGF(CGM, true);
1328   CGOpenMPTaskOutlinedRegionInfo CGInfo(*CS, ThreadIDVar, CodeGen,
1329                                         InnermostKind, HasCancel, Action);
1330   CodeGenFunction::CGCapturedStmtRAII CapInfoRAII(CGF, &CGInfo);
1331   llvm::Function *Res = CGF.GenerateCapturedStmtFunction(*CS);
1332   if (!Tied)
1333     NumberOfParts = Action.getNumberOfParts();
1334   return Res;
1335 }
1336 
1337 static void buildStructValue(ConstantStructBuilder &Fields, CodeGenModule &CGM,
1338                              const RecordDecl *RD, const CGRecordLayout &RL,
1339                              ArrayRef<llvm::Constant *> Data) {
1340   llvm::StructType *StructTy = RL.getLLVMType();
1341   unsigned PrevIdx = 0;
1342   ConstantInitBuilder CIBuilder(CGM);
1343   auto DI = Data.begin();
1344   for (const FieldDecl *FD : RD->fields()) {
1345     unsigned Idx = RL.getLLVMFieldNo(FD);
1346     // Fill the alignment.
1347     for (unsigned I = PrevIdx; I < Idx; ++I)
1348       Fields.add(llvm::Constant::getNullValue(StructTy->getElementType(I)));
1349     PrevIdx = Idx + 1;
1350     Fields.add(*DI);
1351     ++DI;
1352   }
1353 }
1354 
1355 template <class... As>
1356 static llvm::GlobalVariable *
1357 createGlobalStruct(CodeGenModule &CGM, QualType Ty, bool IsConstant,
1358                    ArrayRef<llvm::Constant *> Data, const Twine &Name,
1359                    As &&... Args) {
1360   const auto *RD = cast<RecordDecl>(Ty->getAsTagDecl());
1361   const CGRecordLayout &RL = CGM.getTypes().getCGRecordLayout(RD);
1362   ConstantInitBuilder CIBuilder(CGM);
1363   ConstantStructBuilder Fields = CIBuilder.beginStruct(RL.getLLVMType());
1364   buildStructValue(Fields, CGM, RD, RL, Data);
1365   return Fields.finishAndCreateGlobal(
1366       Name, CGM.getContext().getAlignOfGlobalVarInChars(Ty), IsConstant,
1367       std::forward<As>(Args)...);
1368 }
1369 
1370 template <typename T>
1371 static void
1372 createConstantGlobalStructAndAddToParent(CodeGenModule &CGM, QualType Ty,
1373                                          ArrayRef<llvm::Constant *> Data,
1374                                          T &Parent) {
1375   const auto *RD = cast<RecordDecl>(Ty->getAsTagDecl());
1376   const CGRecordLayout &RL = CGM.getTypes().getCGRecordLayout(RD);
1377   ConstantStructBuilder Fields = Parent.beginStruct(RL.getLLVMType());
1378   buildStructValue(Fields, CGM, RD, RL, Data);
1379   Fields.finishAndAddTo(Parent);
1380 }
1381 
1382 void CGOpenMPRuntime::setLocThreadIdInsertPt(CodeGenFunction &CGF,
1383                                              bool AtCurrentPoint) {
1384   auto &Elem = OpenMPLocThreadIDMap.FindAndConstruct(CGF.CurFn);
1385   assert(!Elem.second.ServiceInsertPt && "Insert point is set already.");
1386 
1387   llvm::Value *Undef = llvm::UndefValue::get(CGF.Int32Ty);
1388   if (AtCurrentPoint) {
1389     Elem.second.ServiceInsertPt = new llvm::BitCastInst(
1390         Undef, CGF.Int32Ty, "svcpt", CGF.Builder.GetInsertBlock());
1391   } else {
1392     Elem.second.ServiceInsertPt =
1393         new llvm::BitCastInst(Undef, CGF.Int32Ty, "svcpt");
1394     Elem.second.ServiceInsertPt->insertAfter(CGF.AllocaInsertPt);
1395   }
1396 }
1397 
1398 void CGOpenMPRuntime::clearLocThreadIdInsertPt(CodeGenFunction &CGF) {
1399   auto &Elem = OpenMPLocThreadIDMap.FindAndConstruct(CGF.CurFn);
1400   if (Elem.second.ServiceInsertPt) {
1401     llvm::Instruction *Ptr = Elem.second.ServiceInsertPt;
1402     Elem.second.ServiceInsertPt = nullptr;
1403     Ptr->eraseFromParent();
1404   }
1405 }
1406 
1407 static StringRef getIdentStringFromSourceLocation(CodeGenFunction &CGF,
1408                                                   SourceLocation Loc,
1409                                                   SmallString<128> &Buffer) {
1410   llvm::raw_svector_ostream OS(Buffer);
1411   // Build debug location
1412   PresumedLoc PLoc = CGF.getContext().getSourceManager().getPresumedLoc(Loc);
1413   OS << ";" << PLoc.getFilename() << ";";
1414   if (const auto *FD = dyn_cast_or_null<FunctionDecl>(CGF.CurFuncDecl))
1415     OS << FD->getQualifiedNameAsString();
1416   OS << ";" << PLoc.getLine() << ";" << PLoc.getColumn() << ";;";
1417   return OS.str();
1418 }
1419 
1420 llvm::Value *CGOpenMPRuntime::emitUpdateLocation(CodeGenFunction &CGF,
1421                                                  SourceLocation Loc,
1422                                                  unsigned Flags) {
1423   llvm::Constant *SrcLocStr;
1424   if (CGM.getCodeGenOpts().getDebugInfo() == codegenoptions::NoDebugInfo ||
1425       Loc.isInvalid()) {
1426     SrcLocStr = OMPBuilder.getOrCreateDefaultSrcLocStr();
1427   } else {
1428     std::string FunctionName = "";
1429     if (const auto *FD = dyn_cast_or_null<FunctionDecl>(CGF.CurFuncDecl))
1430       FunctionName = FD->getQualifiedNameAsString();
1431     PresumedLoc PLoc = CGF.getContext().getSourceManager().getPresumedLoc(Loc);
1432     const char *FileName = PLoc.getFilename();
1433     unsigned Line = PLoc.getLine();
1434     unsigned Column = PLoc.getColumn();
1435     SrcLocStr = OMPBuilder.getOrCreateSrcLocStr(FunctionName.c_str(), FileName,
1436                                                 Line, Column);
1437   }
1438   unsigned Reserved2Flags = getDefaultLocationReserved2Flags();
1439   return OMPBuilder.getOrCreateIdent(SrcLocStr, llvm::omp::IdentFlag(Flags),
1440                                      Reserved2Flags);
1441 }
1442 
1443 llvm::Value *CGOpenMPRuntime::getThreadID(CodeGenFunction &CGF,
1444                                           SourceLocation Loc) {
1445   assert(CGF.CurFn && "No function in current CodeGenFunction.");
1446   // If the OpenMPIRBuilder is used we need to use it for all thread id calls as
1447   // the clang invariants used below might be broken.
1448   if (CGM.getLangOpts().OpenMPIRBuilder) {
1449     SmallString<128> Buffer;
1450     OMPBuilder.updateToLocation(CGF.Builder.saveIP());
1451     auto *SrcLocStr = OMPBuilder.getOrCreateSrcLocStr(
1452         getIdentStringFromSourceLocation(CGF, Loc, Buffer));
1453     return OMPBuilder.getOrCreateThreadID(
1454         OMPBuilder.getOrCreateIdent(SrcLocStr));
1455   }
1456 
1457   llvm::Value *ThreadID = nullptr;
1458   // Check whether we've already cached a load of the thread id in this
1459   // function.
1460   auto I = OpenMPLocThreadIDMap.find(CGF.CurFn);
1461   if (I != OpenMPLocThreadIDMap.end()) {
1462     ThreadID = I->second.ThreadID;
1463     if (ThreadID != nullptr)
1464       return ThreadID;
1465   }
1466   // If exceptions are enabled, do not use parameter to avoid possible crash.
1467   if (auto *OMPRegionInfo =
1468           dyn_cast_or_null<CGOpenMPRegionInfo>(CGF.CapturedStmtInfo)) {
1469     if (OMPRegionInfo->getThreadIDVariable()) {
1470       // Check if this an outlined function with thread id passed as argument.
1471       LValue LVal = OMPRegionInfo->getThreadIDVariableLValue(CGF);
1472       llvm::BasicBlock *TopBlock = CGF.AllocaInsertPt->getParent();
1473       if (!CGF.EHStack.requiresLandingPad() || !CGF.getLangOpts().Exceptions ||
1474           !CGF.getLangOpts().CXXExceptions ||
1475           CGF.Builder.GetInsertBlock() == TopBlock ||
1476           !isa<llvm::Instruction>(LVal.getPointer(CGF)) ||
1477           cast<llvm::Instruction>(LVal.getPointer(CGF))->getParent() ==
1478               TopBlock ||
1479           cast<llvm::Instruction>(LVal.getPointer(CGF))->getParent() ==
1480               CGF.Builder.GetInsertBlock()) {
1481         ThreadID = CGF.EmitLoadOfScalar(LVal, Loc);
1482         // If value loaded in entry block, cache it and use it everywhere in
1483         // function.
1484         if (CGF.Builder.GetInsertBlock() == TopBlock) {
1485           auto &Elem = OpenMPLocThreadIDMap.FindAndConstruct(CGF.CurFn);
1486           Elem.second.ThreadID = ThreadID;
1487         }
1488         return ThreadID;
1489       }
1490     }
1491   }
1492 
1493   // This is not an outlined function region - need to call __kmpc_int32
1494   // kmpc_global_thread_num(ident_t *loc).
1495   // Generate thread id value and cache this value for use across the
1496   // function.
1497   auto &Elem = OpenMPLocThreadIDMap.FindAndConstruct(CGF.CurFn);
1498   if (!Elem.second.ServiceInsertPt)
1499     setLocThreadIdInsertPt(CGF);
1500   CGBuilderTy::InsertPointGuard IPG(CGF.Builder);
1501   CGF.Builder.SetInsertPoint(Elem.second.ServiceInsertPt);
1502   llvm::CallInst *Call = CGF.Builder.CreateCall(
1503       OMPBuilder.getOrCreateRuntimeFunction(CGM.getModule(),
1504                                             OMPRTL___kmpc_global_thread_num),
1505       emitUpdateLocation(CGF, Loc));
1506   Call->setCallingConv(CGF.getRuntimeCC());
1507   Elem.second.ThreadID = Call;
1508   return Call;
1509 }
1510 
1511 void CGOpenMPRuntime::functionFinished(CodeGenFunction &CGF) {
1512   assert(CGF.CurFn && "No function in current CodeGenFunction.");
1513   if (OpenMPLocThreadIDMap.count(CGF.CurFn)) {
1514     clearLocThreadIdInsertPt(CGF);
1515     OpenMPLocThreadIDMap.erase(CGF.CurFn);
1516   }
1517   if (FunctionUDRMap.count(CGF.CurFn) > 0) {
1518     for(const auto *D : FunctionUDRMap[CGF.CurFn])
1519       UDRMap.erase(D);
1520     FunctionUDRMap.erase(CGF.CurFn);
1521   }
1522   auto I = FunctionUDMMap.find(CGF.CurFn);
1523   if (I != FunctionUDMMap.end()) {
1524     for(const auto *D : I->second)
1525       UDMMap.erase(D);
1526     FunctionUDMMap.erase(I);
1527   }
1528   LastprivateConditionalToTypes.erase(CGF.CurFn);
1529   FunctionToUntiedTaskStackMap.erase(CGF.CurFn);
1530 }
1531 
1532 llvm::Type *CGOpenMPRuntime::getIdentTyPointerTy() {
1533   return OMPBuilder.IdentPtr;
1534 }
1535 
1536 llvm::Type *CGOpenMPRuntime::getKmpc_MicroPointerTy() {
1537   if (!Kmpc_MicroTy) {
1538     // Build void (*kmpc_micro)(kmp_int32 *global_tid, kmp_int32 *bound_tid,...)
1539     llvm::Type *MicroParams[] = {llvm::PointerType::getUnqual(CGM.Int32Ty),
1540                                  llvm::PointerType::getUnqual(CGM.Int32Ty)};
1541     Kmpc_MicroTy = llvm::FunctionType::get(CGM.VoidTy, MicroParams, true);
1542   }
1543   return llvm::PointerType::getUnqual(Kmpc_MicroTy);
1544 }
1545 
1546 llvm::FunctionCallee
1547 CGOpenMPRuntime::createForStaticInitFunction(unsigned IVSize, bool IVSigned) {
1548   assert((IVSize == 32 || IVSize == 64) &&
1549          "IV size is not compatible with the omp runtime");
1550   StringRef Name = IVSize == 32 ? (IVSigned ? "__kmpc_for_static_init_4"
1551                                             : "__kmpc_for_static_init_4u")
1552                                 : (IVSigned ? "__kmpc_for_static_init_8"
1553                                             : "__kmpc_for_static_init_8u");
1554   llvm::Type *ITy = IVSize == 32 ? CGM.Int32Ty : CGM.Int64Ty;
1555   auto *PtrTy = llvm::PointerType::getUnqual(ITy);
1556   llvm::Type *TypeParams[] = {
1557     getIdentTyPointerTy(),                     // loc
1558     CGM.Int32Ty,                               // tid
1559     CGM.Int32Ty,                               // schedtype
1560     llvm::PointerType::getUnqual(CGM.Int32Ty), // p_lastiter
1561     PtrTy,                                     // p_lower
1562     PtrTy,                                     // p_upper
1563     PtrTy,                                     // p_stride
1564     ITy,                                       // incr
1565     ITy                                        // chunk
1566   };
1567   auto *FnTy =
1568       llvm::FunctionType::get(CGM.VoidTy, TypeParams, /*isVarArg*/ false);
1569   return CGM.CreateRuntimeFunction(FnTy, Name);
1570 }
1571 
1572 llvm::FunctionCallee
1573 CGOpenMPRuntime::createDispatchInitFunction(unsigned IVSize, bool IVSigned) {
1574   assert((IVSize == 32 || IVSize == 64) &&
1575          "IV size is not compatible with the omp runtime");
1576   StringRef Name =
1577       IVSize == 32
1578           ? (IVSigned ? "__kmpc_dispatch_init_4" : "__kmpc_dispatch_init_4u")
1579           : (IVSigned ? "__kmpc_dispatch_init_8" : "__kmpc_dispatch_init_8u");
1580   llvm::Type *ITy = IVSize == 32 ? CGM.Int32Ty : CGM.Int64Ty;
1581   llvm::Type *TypeParams[] = { getIdentTyPointerTy(), // loc
1582                                CGM.Int32Ty,           // tid
1583                                CGM.Int32Ty,           // schedtype
1584                                ITy,                   // lower
1585                                ITy,                   // upper
1586                                ITy,                   // stride
1587                                ITy                    // chunk
1588   };
1589   auto *FnTy =
1590       llvm::FunctionType::get(CGM.VoidTy, TypeParams, /*isVarArg*/ false);
1591   return CGM.CreateRuntimeFunction(FnTy, Name);
1592 }
1593 
1594 llvm::FunctionCallee
1595 CGOpenMPRuntime::createDispatchFiniFunction(unsigned IVSize, bool IVSigned) {
1596   assert((IVSize == 32 || IVSize == 64) &&
1597          "IV size is not compatible with the omp runtime");
1598   StringRef Name =
1599       IVSize == 32
1600           ? (IVSigned ? "__kmpc_dispatch_fini_4" : "__kmpc_dispatch_fini_4u")
1601           : (IVSigned ? "__kmpc_dispatch_fini_8" : "__kmpc_dispatch_fini_8u");
1602   llvm::Type *TypeParams[] = {
1603       getIdentTyPointerTy(), // loc
1604       CGM.Int32Ty,           // tid
1605   };
1606   auto *FnTy =
1607       llvm::FunctionType::get(CGM.VoidTy, TypeParams, /*isVarArg=*/false);
1608   return CGM.CreateRuntimeFunction(FnTy, Name);
1609 }
1610 
1611 llvm::FunctionCallee
1612 CGOpenMPRuntime::createDispatchNextFunction(unsigned IVSize, bool IVSigned) {
1613   assert((IVSize == 32 || IVSize == 64) &&
1614          "IV size is not compatible with the omp runtime");
1615   StringRef Name =
1616       IVSize == 32
1617           ? (IVSigned ? "__kmpc_dispatch_next_4" : "__kmpc_dispatch_next_4u")
1618           : (IVSigned ? "__kmpc_dispatch_next_8" : "__kmpc_dispatch_next_8u");
1619   llvm::Type *ITy = IVSize == 32 ? CGM.Int32Ty : CGM.Int64Ty;
1620   auto *PtrTy = llvm::PointerType::getUnqual(ITy);
1621   llvm::Type *TypeParams[] = {
1622     getIdentTyPointerTy(),                     // loc
1623     CGM.Int32Ty,                               // tid
1624     llvm::PointerType::getUnqual(CGM.Int32Ty), // p_lastiter
1625     PtrTy,                                     // p_lower
1626     PtrTy,                                     // p_upper
1627     PtrTy                                      // p_stride
1628   };
1629   auto *FnTy =
1630       llvm::FunctionType::get(CGM.Int32Ty, TypeParams, /*isVarArg*/ false);
1631   return CGM.CreateRuntimeFunction(FnTy, Name);
1632 }
1633 
1634 /// Obtain information that uniquely identifies a target entry. This
1635 /// consists of the file and device IDs as well as line number associated with
1636 /// the relevant entry source location.
1637 static void getTargetEntryUniqueInfo(ASTContext &C, SourceLocation Loc,
1638                                      unsigned &DeviceID, unsigned &FileID,
1639                                      unsigned &LineNum) {
1640   SourceManager &SM = C.getSourceManager();
1641 
1642   // The loc should be always valid and have a file ID (the user cannot use
1643   // #pragma directives in macros)
1644 
1645   assert(Loc.isValid() && "Source location is expected to be always valid.");
1646 
1647   PresumedLoc PLoc = SM.getPresumedLoc(Loc);
1648   assert(PLoc.isValid() && "Source location is expected to be always valid.");
1649 
1650   llvm::sys::fs::UniqueID ID;
1651   if (auto EC = llvm::sys::fs::getUniqueID(PLoc.getFilename(), ID))
1652     SM.getDiagnostics().Report(diag::err_cannot_open_file)
1653         << PLoc.getFilename() << EC.message();
1654 
1655   DeviceID = ID.getDevice();
1656   FileID = ID.getFile();
1657   LineNum = PLoc.getLine();
1658 }
1659 
1660 Address CGOpenMPRuntime::getAddrOfDeclareTargetVar(const VarDecl *VD) {
1661   if (CGM.getLangOpts().OpenMPSimd)
1662     return Address::invalid();
1663   llvm::Optional<OMPDeclareTargetDeclAttr::MapTypeTy> Res =
1664       OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(VD);
1665   if (Res && (*Res == OMPDeclareTargetDeclAttr::MT_Link ||
1666               (*Res == OMPDeclareTargetDeclAttr::MT_To &&
1667                HasRequiresUnifiedSharedMemory))) {
1668     SmallString<64> PtrName;
1669     {
1670       llvm::raw_svector_ostream OS(PtrName);
1671       OS << CGM.getMangledName(GlobalDecl(VD));
1672       if (!VD->isExternallyVisible()) {
1673         unsigned DeviceID, FileID, Line;
1674         getTargetEntryUniqueInfo(CGM.getContext(),
1675                                  VD->getCanonicalDecl()->getBeginLoc(),
1676                                  DeviceID, FileID, Line);
1677         OS << llvm::format("_%x", FileID);
1678       }
1679       OS << "_decl_tgt_ref_ptr";
1680     }
1681     llvm::Value *Ptr = CGM.getModule().getNamedValue(PtrName);
1682     if (!Ptr) {
1683       QualType PtrTy = CGM.getContext().getPointerType(VD->getType());
1684       Ptr = getOrCreateInternalVariable(CGM.getTypes().ConvertTypeForMem(PtrTy),
1685                                         PtrName);
1686 
1687       auto *GV = cast<llvm::GlobalVariable>(Ptr);
1688       GV->setLinkage(llvm::GlobalValue::WeakAnyLinkage);
1689 
1690       if (!CGM.getLangOpts().OpenMPIsDevice)
1691         GV->setInitializer(CGM.GetAddrOfGlobal(VD));
1692       registerTargetGlobalVariable(VD, cast<llvm::Constant>(Ptr));
1693     }
1694     return Address(Ptr, CGM.getContext().getDeclAlign(VD));
1695   }
1696   return Address::invalid();
1697 }
1698 
1699 llvm::Constant *
1700 CGOpenMPRuntime::getOrCreateThreadPrivateCache(const VarDecl *VD) {
1701   assert(!CGM.getLangOpts().OpenMPUseTLS ||
1702          !CGM.getContext().getTargetInfo().isTLSSupported());
1703   // Lookup the entry, lazily creating it if necessary.
1704   std::string Suffix = getName({"cache", ""});
1705   return getOrCreateInternalVariable(
1706       CGM.Int8PtrPtrTy, Twine(CGM.getMangledName(VD)).concat(Suffix));
1707 }
1708 
1709 Address CGOpenMPRuntime::getAddrOfThreadPrivate(CodeGenFunction &CGF,
1710                                                 const VarDecl *VD,
1711                                                 Address VDAddr,
1712                                                 SourceLocation Loc) {
1713   if (CGM.getLangOpts().OpenMPUseTLS &&
1714       CGM.getContext().getTargetInfo().isTLSSupported())
1715     return VDAddr;
1716 
1717   llvm::Type *VarTy = VDAddr.getElementType();
1718   llvm::Value *Args[] = {emitUpdateLocation(CGF, Loc), getThreadID(CGF, Loc),
1719                          CGF.Builder.CreatePointerCast(VDAddr.getPointer(),
1720                                                        CGM.Int8PtrTy),
1721                          CGM.getSize(CGM.GetTargetTypeStoreSize(VarTy)),
1722                          getOrCreateThreadPrivateCache(VD)};
1723   return Address(CGF.EmitRuntimeCall(
1724                      OMPBuilder.getOrCreateRuntimeFunction(
1725                          CGM.getModule(), OMPRTL___kmpc_threadprivate_cached),
1726                      Args),
1727                  VDAddr.getAlignment());
1728 }
1729 
1730 void CGOpenMPRuntime::emitThreadPrivateVarInit(
1731     CodeGenFunction &CGF, Address VDAddr, llvm::Value *Ctor,
1732     llvm::Value *CopyCtor, llvm::Value *Dtor, SourceLocation Loc) {
1733   // Call kmp_int32 __kmpc_global_thread_num(&loc) to init OpenMP runtime
1734   // library.
1735   llvm::Value *OMPLoc = emitUpdateLocation(CGF, Loc);
1736   CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
1737                           CGM.getModule(), OMPRTL___kmpc_global_thread_num),
1738                       OMPLoc);
1739   // Call __kmpc_threadprivate_register(&loc, &var, ctor, cctor/*NULL*/, dtor)
1740   // to register constructor/destructor for variable.
1741   llvm::Value *Args[] = {
1742       OMPLoc, CGF.Builder.CreatePointerCast(VDAddr.getPointer(), CGM.VoidPtrTy),
1743       Ctor, CopyCtor, Dtor};
1744   CGF.EmitRuntimeCall(
1745       OMPBuilder.getOrCreateRuntimeFunction(
1746           CGM.getModule(), OMPRTL___kmpc_threadprivate_register),
1747       Args);
1748 }
1749 
1750 llvm::Function *CGOpenMPRuntime::emitThreadPrivateVarDefinition(
1751     const VarDecl *VD, Address VDAddr, SourceLocation Loc,
1752     bool PerformInit, CodeGenFunction *CGF) {
1753   if (CGM.getLangOpts().OpenMPUseTLS &&
1754       CGM.getContext().getTargetInfo().isTLSSupported())
1755     return nullptr;
1756 
1757   VD = VD->getDefinition(CGM.getContext());
1758   if (VD && ThreadPrivateWithDefinition.insert(CGM.getMangledName(VD)).second) {
1759     QualType ASTTy = VD->getType();
1760 
1761     llvm::Value *Ctor = nullptr, *CopyCtor = nullptr, *Dtor = nullptr;
1762     const Expr *Init = VD->getAnyInitializer();
1763     if (CGM.getLangOpts().CPlusPlus && PerformInit) {
1764       // Generate function that re-emits the declaration's initializer into the
1765       // threadprivate copy of the variable VD
1766       CodeGenFunction CtorCGF(CGM);
1767       FunctionArgList Args;
1768       ImplicitParamDecl Dst(CGM.getContext(), /*DC=*/nullptr, Loc,
1769                             /*Id=*/nullptr, CGM.getContext().VoidPtrTy,
1770                             ImplicitParamDecl::Other);
1771       Args.push_back(&Dst);
1772 
1773       const auto &FI = CGM.getTypes().arrangeBuiltinFunctionDeclaration(
1774           CGM.getContext().VoidPtrTy, Args);
1775       llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(FI);
1776       std::string Name = getName({"__kmpc_global_ctor_", ""});
1777       llvm::Function *Fn =
1778           CGM.CreateGlobalInitOrCleanUpFunction(FTy, Name, FI, Loc);
1779       CtorCGF.StartFunction(GlobalDecl(), CGM.getContext().VoidPtrTy, Fn, FI,
1780                             Args, Loc, Loc);
1781       llvm::Value *ArgVal = CtorCGF.EmitLoadOfScalar(
1782           CtorCGF.GetAddrOfLocalVar(&Dst), /*Volatile=*/false,
1783           CGM.getContext().VoidPtrTy, Dst.getLocation());
1784       Address Arg = Address(ArgVal, VDAddr.getAlignment());
1785       Arg = CtorCGF.Builder.CreateElementBitCast(
1786           Arg, CtorCGF.ConvertTypeForMem(ASTTy));
1787       CtorCGF.EmitAnyExprToMem(Init, Arg, Init->getType().getQualifiers(),
1788                                /*IsInitializer=*/true);
1789       ArgVal = CtorCGF.EmitLoadOfScalar(
1790           CtorCGF.GetAddrOfLocalVar(&Dst), /*Volatile=*/false,
1791           CGM.getContext().VoidPtrTy, Dst.getLocation());
1792       CtorCGF.Builder.CreateStore(ArgVal, CtorCGF.ReturnValue);
1793       CtorCGF.FinishFunction();
1794       Ctor = Fn;
1795     }
1796     if (VD->getType().isDestructedType() != QualType::DK_none) {
1797       // Generate function that emits destructor call for the threadprivate copy
1798       // of the variable VD
1799       CodeGenFunction DtorCGF(CGM);
1800       FunctionArgList Args;
1801       ImplicitParamDecl Dst(CGM.getContext(), /*DC=*/nullptr, Loc,
1802                             /*Id=*/nullptr, CGM.getContext().VoidPtrTy,
1803                             ImplicitParamDecl::Other);
1804       Args.push_back(&Dst);
1805 
1806       const auto &FI = CGM.getTypes().arrangeBuiltinFunctionDeclaration(
1807           CGM.getContext().VoidTy, Args);
1808       llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(FI);
1809       std::string Name = getName({"__kmpc_global_dtor_", ""});
1810       llvm::Function *Fn =
1811           CGM.CreateGlobalInitOrCleanUpFunction(FTy, Name, FI, Loc);
1812       auto NL = ApplyDebugLocation::CreateEmpty(DtorCGF);
1813       DtorCGF.StartFunction(GlobalDecl(), CGM.getContext().VoidTy, Fn, FI, Args,
1814                             Loc, Loc);
1815       // Create a scope with an artificial location for the body of this function.
1816       auto AL = ApplyDebugLocation::CreateArtificial(DtorCGF);
1817       llvm::Value *ArgVal = DtorCGF.EmitLoadOfScalar(
1818           DtorCGF.GetAddrOfLocalVar(&Dst),
1819           /*Volatile=*/false, CGM.getContext().VoidPtrTy, Dst.getLocation());
1820       DtorCGF.emitDestroy(Address(ArgVal, VDAddr.getAlignment()), ASTTy,
1821                           DtorCGF.getDestroyer(ASTTy.isDestructedType()),
1822                           DtorCGF.needsEHCleanup(ASTTy.isDestructedType()));
1823       DtorCGF.FinishFunction();
1824       Dtor = Fn;
1825     }
1826     // Do not emit init function if it is not required.
1827     if (!Ctor && !Dtor)
1828       return nullptr;
1829 
1830     llvm::Type *CopyCtorTyArgs[] = {CGM.VoidPtrTy, CGM.VoidPtrTy};
1831     auto *CopyCtorTy = llvm::FunctionType::get(CGM.VoidPtrTy, CopyCtorTyArgs,
1832                                                /*isVarArg=*/false)
1833                            ->getPointerTo();
1834     // Copying constructor for the threadprivate variable.
1835     // Must be NULL - reserved by runtime, but currently it requires that this
1836     // parameter is always NULL. Otherwise it fires assertion.
1837     CopyCtor = llvm::Constant::getNullValue(CopyCtorTy);
1838     if (Ctor == nullptr) {
1839       auto *CtorTy = llvm::FunctionType::get(CGM.VoidPtrTy, CGM.VoidPtrTy,
1840                                              /*isVarArg=*/false)
1841                          ->getPointerTo();
1842       Ctor = llvm::Constant::getNullValue(CtorTy);
1843     }
1844     if (Dtor == nullptr) {
1845       auto *DtorTy = llvm::FunctionType::get(CGM.VoidTy, CGM.VoidPtrTy,
1846                                              /*isVarArg=*/false)
1847                          ->getPointerTo();
1848       Dtor = llvm::Constant::getNullValue(DtorTy);
1849     }
1850     if (!CGF) {
1851       auto *InitFunctionTy =
1852           llvm::FunctionType::get(CGM.VoidTy, /*isVarArg*/ false);
1853       std::string Name = getName({"__omp_threadprivate_init_", ""});
1854       llvm::Function *InitFunction = CGM.CreateGlobalInitOrCleanUpFunction(
1855           InitFunctionTy, Name, CGM.getTypes().arrangeNullaryFunction());
1856       CodeGenFunction InitCGF(CGM);
1857       FunctionArgList ArgList;
1858       InitCGF.StartFunction(GlobalDecl(), CGM.getContext().VoidTy, InitFunction,
1859                             CGM.getTypes().arrangeNullaryFunction(), ArgList,
1860                             Loc, Loc);
1861       emitThreadPrivateVarInit(InitCGF, VDAddr, Ctor, CopyCtor, Dtor, Loc);
1862       InitCGF.FinishFunction();
1863       return InitFunction;
1864     }
1865     emitThreadPrivateVarInit(*CGF, VDAddr, Ctor, CopyCtor, Dtor, Loc);
1866   }
1867   return nullptr;
1868 }
1869 
1870 bool CGOpenMPRuntime::emitDeclareTargetVarDefinition(const VarDecl *VD,
1871                                                      llvm::GlobalVariable *Addr,
1872                                                      bool PerformInit) {
1873   if (CGM.getLangOpts().OMPTargetTriples.empty() &&
1874       !CGM.getLangOpts().OpenMPIsDevice)
1875     return false;
1876   Optional<OMPDeclareTargetDeclAttr::MapTypeTy> Res =
1877       OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(VD);
1878   if (!Res || *Res == OMPDeclareTargetDeclAttr::MT_Link ||
1879       (*Res == OMPDeclareTargetDeclAttr::MT_To &&
1880        HasRequiresUnifiedSharedMemory))
1881     return CGM.getLangOpts().OpenMPIsDevice;
1882   VD = VD->getDefinition(CGM.getContext());
1883   assert(VD && "Unknown VarDecl");
1884 
1885   if (!DeclareTargetWithDefinition.insert(CGM.getMangledName(VD)).second)
1886     return CGM.getLangOpts().OpenMPIsDevice;
1887 
1888   QualType ASTTy = VD->getType();
1889   SourceLocation Loc = VD->getCanonicalDecl()->getBeginLoc();
1890 
1891   // Produce the unique prefix to identify the new target regions. We use
1892   // the source location of the variable declaration which we know to not
1893   // conflict with any target region.
1894   unsigned DeviceID;
1895   unsigned FileID;
1896   unsigned Line;
1897   getTargetEntryUniqueInfo(CGM.getContext(), Loc, DeviceID, FileID, Line);
1898   SmallString<128> Buffer, Out;
1899   {
1900     llvm::raw_svector_ostream OS(Buffer);
1901     OS << "__omp_offloading_" << llvm::format("_%x", DeviceID)
1902        << llvm::format("_%x_", FileID) << VD->getName() << "_l" << Line;
1903   }
1904 
1905   const Expr *Init = VD->getAnyInitializer();
1906   if (CGM.getLangOpts().CPlusPlus && PerformInit) {
1907     llvm::Constant *Ctor;
1908     llvm::Constant *ID;
1909     if (CGM.getLangOpts().OpenMPIsDevice) {
1910       // Generate function that re-emits the declaration's initializer into
1911       // the threadprivate copy of the variable VD
1912       CodeGenFunction CtorCGF(CGM);
1913 
1914       const CGFunctionInfo &FI = CGM.getTypes().arrangeNullaryFunction();
1915       llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(FI);
1916       llvm::Function *Fn = CGM.CreateGlobalInitOrCleanUpFunction(
1917           FTy, Twine(Buffer, "_ctor"), FI, Loc);
1918       auto NL = ApplyDebugLocation::CreateEmpty(CtorCGF);
1919       CtorCGF.StartFunction(GlobalDecl(), CGM.getContext().VoidTy, Fn, FI,
1920                             FunctionArgList(), Loc, Loc);
1921       auto AL = ApplyDebugLocation::CreateArtificial(CtorCGF);
1922       CtorCGF.EmitAnyExprToMem(Init,
1923                                Address(Addr, CGM.getContext().getDeclAlign(VD)),
1924                                Init->getType().getQualifiers(),
1925                                /*IsInitializer=*/true);
1926       CtorCGF.FinishFunction();
1927       Ctor = Fn;
1928       ID = llvm::ConstantExpr::getBitCast(Fn, CGM.Int8PtrTy);
1929       CGM.addUsedGlobal(cast<llvm::GlobalValue>(Ctor));
1930     } else {
1931       Ctor = new llvm::GlobalVariable(
1932           CGM.getModule(), CGM.Int8Ty, /*isConstant=*/true,
1933           llvm::GlobalValue::PrivateLinkage,
1934           llvm::Constant::getNullValue(CGM.Int8Ty), Twine(Buffer, "_ctor"));
1935       ID = Ctor;
1936     }
1937 
1938     // Register the information for the entry associated with the constructor.
1939     Out.clear();
1940     OffloadEntriesInfoManager.registerTargetRegionEntryInfo(
1941         DeviceID, FileID, Twine(Buffer, "_ctor").toStringRef(Out), Line, Ctor,
1942         ID, OffloadEntriesInfoManagerTy::OMPTargetRegionEntryCtor);
1943   }
1944   if (VD->getType().isDestructedType() != QualType::DK_none) {
1945     llvm::Constant *Dtor;
1946     llvm::Constant *ID;
1947     if (CGM.getLangOpts().OpenMPIsDevice) {
1948       // Generate function that emits destructor call for the threadprivate
1949       // copy of the variable VD
1950       CodeGenFunction DtorCGF(CGM);
1951 
1952       const CGFunctionInfo &FI = CGM.getTypes().arrangeNullaryFunction();
1953       llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(FI);
1954       llvm::Function *Fn = CGM.CreateGlobalInitOrCleanUpFunction(
1955           FTy, Twine(Buffer, "_dtor"), FI, Loc);
1956       auto NL = ApplyDebugLocation::CreateEmpty(DtorCGF);
1957       DtorCGF.StartFunction(GlobalDecl(), CGM.getContext().VoidTy, Fn, FI,
1958                             FunctionArgList(), Loc, Loc);
1959       // Create a scope with an artificial location for the body of this
1960       // function.
1961       auto AL = ApplyDebugLocation::CreateArtificial(DtorCGF);
1962       DtorCGF.emitDestroy(Address(Addr, CGM.getContext().getDeclAlign(VD)),
1963                           ASTTy, DtorCGF.getDestroyer(ASTTy.isDestructedType()),
1964                           DtorCGF.needsEHCleanup(ASTTy.isDestructedType()));
1965       DtorCGF.FinishFunction();
1966       Dtor = Fn;
1967       ID = llvm::ConstantExpr::getBitCast(Fn, CGM.Int8PtrTy);
1968       CGM.addUsedGlobal(cast<llvm::GlobalValue>(Dtor));
1969     } else {
1970       Dtor = new llvm::GlobalVariable(
1971           CGM.getModule(), CGM.Int8Ty, /*isConstant=*/true,
1972           llvm::GlobalValue::PrivateLinkage,
1973           llvm::Constant::getNullValue(CGM.Int8Ty), Twine(Buffer, "_dtor"));
1974       ID = Dtor;
1975     }
1976     // Register the information for the entry associated with the destructor.
1977     Out.clear();
1978     OffloadEntriesInfoManager.registerTargetRegionEntryInfo(
1979         DeviceID, FileID, Twine(Buffer, "_dtor").toStringRef(Out), Line, Dtor,
1980         ID, OffloadEntriesInfoManagerTy::OMPTargetRegionEntryDtor);
1981   }
1982   return CGM.getLangOpts().OpenMPIsDevice;
1983 }
1984 
1985 Address CGOpenMPRuntime::getAddrOfArtificialThreadPrivate(CodeGenFunction &CGF,
1986                                                           QualType VarType,
1987                                                           StringRef Name) {
1988   std::string Suffix = getName({"artificial", ""});
1989   llvm::Type *VarLVType = CGF.ConvertTypeForMem(VarType);
1990   llvm::Value *GAddr =
1991       getOrCreateInternalVariable(VarLVType, Twine(Name).concat(Suffix));
1992   if (CGM.getLangOpts().OpenMP && CGM.getLangOpts().OpenMPUseTLS &&
1993       CGM.getTarget().isTLSSupported()) {
1994     cast<llvm::GlobalVariable>(GAddr)->setThreadLocal(/*Val=*/true);
1995     return Address(GAddr, CGM.getContext().getTypeAlignInChars(VarType));
1996   }
1997   std::string CacheSuffix = getName({"cache", ""});
1998   llvm::Value *Args[] = {
1999       emitUpdateLocation(CGF, SourceLocation()),
2000       getThreadID(CGF, SourceLocation()),
2001       CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(GAddr, CGM.VoidPtrTy),
2002       CGF.Builder.CreateIntCast(CGF.getTypeSize(VarType), CGM.SizeTy,
2003                                 /*isSigned=*/false),
2004       getOrCreateInternalVariable(
2005           CGM.VoidPtrPtrTy, Twine(Name).concat(Suffix).concat(CacheSuffix))};
2006   return Address(
2007       CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
2008           CGF.EmitRuntimeCall(
2009               OMPBuilder.getOrCreateRuntimeFunction(
2010                   CGM.getModule(), OMPRTL___kmpc_threadprivate_cached),
2011               Args),
2012           VarLVType->getPointerTo(/*AddrSpace=*/0)),
2013       CGM.getContext().getTypeAlignInChars(VarType));
2014 }
2015 
2016 void CGOpenMPRuntime::emitIfClause(CodeGenFunction &CGF, const Expr *Cond,
2017                                    const RegionCodeGenTy &ThenGen,
2018                                    const RegionCodeGenTy &ElseGen) {
2019   CodeGenFunction::LexicalScope ConditionScope(CGF, Cond->getSourceRange());
2020 
2021   // If the condition constant folds and can be elided, try to avoid emitting
2022   // the condition and the dead arm of the if/else.
2023   bool CondConstant;
2024   if (CGF.ConstantFoldsToSimpleInteger(Cond, CondConstant)) {
2025     if (CondConstant)
2026       ThenGen(CGF);
2027     else
2028       ElseGen(CGF);
2029     return;
2030   }
2031 
2032   // Otherwise, the condition did not fold, or we couldn't elide it.  Just
2033   // emit the conditional branch.
2034   llvm::BasicBlock *ThenBlock = CGF.createBasicBlock("omp_if.then");
2035   llvm::BasicBlock *ElseBlock = CGF.createBasicBlock("omp_if.else");
2036   llvm::BasicBlock *ContBlock = CGF.createBasicBlock("omp_if.end");
2037   CGF.EmitBranchOnBoolExpr(Cond, ThenBlock, ElseBlock, /*TrueCount=*/0);
2038 
2039   // Emit the 'then' code.
2040   CGF.EmitBlock(ThenBlock);
2041   ThenGen(CGF);
2042   CGF.EmitBranch(ContBlock);
2043   // Emit the 'else' code if present.
2044   // There is no need to emit line number for unconditional branch.
2045   (void)ApplyDebugLocation::CreateEmpty(CGF);
2046   CGF.EmitBlock(ElseBlock);
2047   ElseGen(CGF);
2048   // There is no need to emit line number for unconditional branch.
2049   (void)ApplyDebugLocation::CreateEmpty(CGF);
2050   CGF.EmitBranch(ContBlock);
2051   // Emit the continuation block for code after the if.
2052   CGF.EmitBlock(ContBlock, /*IsFinished=*/true);
2053 }
2054 
2055 void CGOpenMPRuntime::emitParallelCall(CodeGenFunction &CGF, SourceLocation Loc,
2056                                        llvm::Function *OutlinedFn,
2057                                        ArrayRef<llvm::Value *> CapturedVars,
2058                                        const Expr *IfCond) {
2059   if (!CGF.HaveInsertPoint())
2060     return;
2061   llvm::Value *RTLoc = emitUpdateLocation(CGF, Loc);
2062   auto &M = CGM.getModule();
2063   auto &&ThenGen = [&M, OutlinedFn, CapturedVars, RTLoc,
2064                     this](CodeGenFunction &CGF, PrePostActionTy &) {
2065     // Build call __kmpc_fork_call(loc, n, microtask, var1, .., varn);
2066     CGOpenMPRuntime &RT = CGF.CGM.getOpenMPRuntime();
2067     llvm::Value *Args[] = {
2068         RTLoc,
2069         CGF.Builder.getInt32(CapturedVars.size()), // Number of captured vars
2070         CGF.Builder.CreateBitCast(OutlinedFn, RT.getKmpc_MicroPointerTy())};
2071     llvm::SmallVector<llvm::Value *, 16> RealArgs;
2072     RealArgs.append(std::begin(Args), std::end(Args));
2073     RealArgs.append(CapturedVars.begin(), CapturedVars.end());
2074 
2075     llvm::FunctionCallee RTLFn =
2076         OMPBuilder.getOrCreateRuntimeFunction(M, OMPRTL___kmpc_fork_call);
2077     CGF.EmitRuntimeCall(RTLFn, RealArgs);
2078   };
2079   auto &&ElseGen = [&M, OutlinedFn, CapturedVars, RTLoc, Loc,
2080                     this](CodeGenFunction &CGF, PrePostActionTy &) {
2081     CGOpenMPRuntime &RT = CGF.CGM.getOpenMPRuntime();
2082     llvm::Value *ThreadID = RT.getThreadID(CGF, Loc);
2083     // Build calls:
2084     // __kmpc_serialized_parallel(&Loc, GTid);
2085     llvm::Value *Args[] = {RTLoc, ThreadID};
2086     CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
2087                             M, OMPRTL___kmpc_serialized_parallel),
2088                         Args);
2089 
2090     // OutlinedFn(&GTid, &zero_bound, CapturedStruct);
2091     Address ThreadIDAddr = RT.emitThreadIDAddress(CGF, Loc);
2092     Address ZeroAddrBound =
2093         CGF.CreateDefaultAlignTempAlloca(CGF.Int32Ty,
2094                                          /*Name=*/".bound.zero.addr");
2095     CGF.InitTempAlloca(ZeroAddrBound, CGF.Builder.getInt32(/*C*/ 0));
2096     llvm::SmallVector<llvm::Value *, 16> OutlinedFnArgs;
2097     // ThreadId for serialized parallels is 0.
2098     OutlinedFnArgs.push_back(ThreadIDAddr.getPointer());
2099     OutlinedFnArgs.push_back(ZeroAddrBound.getPointer());
2100     OutlinedFnArgs.append(CapturedVars.begin(), CapturedVars.end());
2101     RT.emitOutlinedFunctionCall(CGF, Loc, OutlinedFn, OutlinedFnArgs);
2102 
2103     // __kmpc_end_serialized_parallel(&Loc, GTid);
2104     llvm::Value *EndArgs[] = {RT.emitUpdateLocation(CGF, Loc), ThreadID};
2105     CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
2106                             M, OMPRTL___kmpc_end_serialized_parallel),
2107                         EndArgs);
2108   };
2109   if (IfCond) {
2110     emitIfClause(CGF, IfCond, ThenGen, ElseGen);
2111   } else {
2112     RegionCodeGenTy ThenRCG(ThenGen);
2113     ThenRCG(CGF);
2114   }
2115 }
2116 
2117 // If we're inside an (outlined) parallel region, use the region info's
2118 // thread-ID variable (it is passed in a first argument of the outlined function
2119 // as "kmp_int32 *gtid"). Otherwise, if we're not inside parallel region, but in
2120 // regular serial code region, get thread ID by calling kmp_int32
2121 // kmpc_global_thread_num(ident_t *loc), stash this thread ID in a temporary and
2122 // return the address of that temp.
2123 Address CGOpenMPRuntime::emitThreadIDAddress(CodeGenFunction &CGF,
2124                                              SourceLocation Loc) {
2125   if (auto *OMPRegionInfo =
2126           dyn_cast_or_null<CGOpenMPRegionInfo>(CGF.CapturedStmtInfo))
2127     if (OMPRegionInfo->getThreadIDVariable())
2128       return OMPRegionInfo->getThreadIDVariableLValue(CGF).getAddress(CGF);
2129 
2130   llvm::Value *ThreadID = getThreadID(CGF, Loc);
2131   QualType Int32Ty =
2132       CGF.getContext().getIntTypeForBitwidth(/*DestWidth*/ 32, /*Signed*/ true);
2133   Address ThreadIDTemp = CGF.CreateMemTemp(Int32Ty, /*Name*/ ".threadid_temp.");
2134   CGF.EmitStoreOfScalar(ThreadID,
2135                         CGF.MakeAddrLValue(ThreadIDTemp, Int32Ty));
2136 
2137   return ThreadIDTemp;
2138 }
2139 
2140 llvm::Constant *CGOpenMPRuntime::getOrCreateInternalVariable(
2141     llvm::Type *Ty, const llvm::Twine &Name, unsigned AddressSpace) {
2142   SmallString<256> Buffer;
2143   llvm::raw_svector_ostream Out(Buffer);
2144   Out << Name;
2145   StringRef RuntimeName = Out.str();
2146   auto &Elem = *InternalVars.try_emplace(RuntimeName, nullptr).first;
2147   if (Elem.second) {
2148     assert(Elem.second->getType()->getPointerElementType() == Ty &&
2149            "OMP internal variable has different type than requested");
2150     return &*Elem.second;
2151   }
2152 
2153   return Elem.second = new llvm::GlobalVariable(
2154              CGM.getModule(), Ty, /*IsConstant*/ false,
2155              llvm::GlobalValue::CommonLinkage, llvm::Constant::getNullValue(Ty),
2156              Elem.first(), /*InsertBefore=*/nullptr,
2157              llvm::GlobalValue::NotThreadLocal, AddressSpace);
2158 }
2159 
2160 llvm::Value *CGOpenMPRuntime::getCriticalRegionLock(StringRef CriticalName) {
2161   std::string Prefix = Twine("gomp_critical_user_", CriticalName).str();
2162   std::string Name = getName({Prefix, "var"});
2163   return getOrCreateInternalVariable(KmpCriticalNameTy, Name);
2164 }
2165 
2166 namespace {
2167 /// Common pre(post)-action for different OpenMP constructs.
2168 class CommonActionTy final : public PrePostActionTy {
2169   llvm::FunctionCallee EnterCallee;
2170   ArrayRef<llvm::Value *> EnterArgs;
2171   llvm::FunctionCallee ExitCallee;
2172   ArrayRef<llvm::Value *> ExitArgs;
2173   bool Conditional;
2174   llvm::BasicBlock *ContBlock = nullptr;
2175 
2176 public:
2177   CommonActionTy(llvm::FunctionCallee EnterCallee,
2178                  ArrayRef<llvm::Value *> EnterArgs,
2179                  llvm::FunctionCallee ExitCallee,
2180                  ArrayRef<llvm::Value *> ExitArgs, bool Conditional = false)
2181       : EnterCallee(EnterCallee), EnterArgs(EnterArgs), ExitCallee(ExitCallee),
2182         ExitArgs(ExitArgs), Conditional(Conditional) {}
2183   void Enter(CodeGenFunction &CGF) override {
2184     llvm::Value *EnterRes = CGF.EmitRuntimeCall(EnterCallee, EnterArgs);
2185     if (Conditional) {
2186       llvm::Value *CallBool = CGF.Builder.CreateIsNotNull(EnterRes);
2187       auto *ThenBlock = CGF.createBasicBlock("omp_if.then");
2188       ContBlock = CGF.createBasicBlock("omp_if.end");
2189       // Generate the branch (If-stmt)
2190       CGF.Builder.CreateCondBr(CallBool, ThenBlock, ContBlock);
2191       CGF.EmitBlock(ThenBlock);
2192     }
2193   }
2194   void Done(CodeGenFunction &CGF) {
2195     // Emit the rest of blocks/branches
2196     CGF.EmitBranch(ContBlock);
2197     CGF.EmitBlock(ContBlock, true);
2198   }
2199   void Exit(CodeGenFunction &CGF) override {
2200     CGF.EmitRuntimeCall(ExitCallee, ExitArgs);
2201   }
2202 };
2203 } // anonymous namespace
2204 
2205 void CGOpenMPRuntime::emitCriticalRegion(CodeGenFunction &CGF,
2206                                          StringRef CriticalName,
2207                                          const RegionCodeGenTy &CriticalOpGen,
2208                                          SourceLocation Loc, const Expr *Hint) {
2209   // __kmpc_critical[_with_hint](ident_t *, gtid, Lock[, hint]);
2210   // CriticalOpGen();
2211   // __kmpc_end_critical(ident_t *, gtid, Lock);
2212   // Prepare arguments and build a call to __kmpc_critical
2213   if (!CGF.HaveInsertPoint())
2214     return;
2215   llvm::Value *Args[] = {emitUpdateLocation(CGF, Loc), getThreadID(CGF, Loc),
2216                          getCriticalRegionLock(CriticalName)};
2217   llvm::SmallVector<llvm::Value *, 4> EnterArgs(std::begin(Args),
2218                                                 std::end(Args));
2219   if (Hint) {
2220     EnterArgs.push_back(CGF.Builder.CreateIntCast(
2221         CGF.EmitScalarExpr(Hint), CGM.Int32Ty, /*isSigned=*/false));
2222   }
2223   CommonActionTy Action(
2224       OMPBuilder.getOrCreateRuntimeFunction(
2225           CGM.getModule(),
2226           Hint ? OMPRTL___kmpc_critical_with_hint : OMPRTL___kmpc_critical),
2227       EnterArgs,
2228       OMPBuilder.getOrCreateRuntimeFunction(CGM.getModule(),
2229                                             OMPRTL___kmpc_end_critical),
2230       Args);
2231   CriticalOpGen.setAction(Action);
2232   emitInlinedDirective(CGF, OMPD_critical, CriticalOpGen);
2233 }
2234 
2235 void CGOpenMPRuntime::emitMasterRegion(CodeGenFunction &CGF,
2236                                        const RegionCodeGenTy &MasterOpGen,
2237                                        SourceLocation Loc) {
2238   if (!CGF.HaveInsertPoint())
2239     return;
2240   // if(__kmpc_master(ident_t *, gtid)) {
2241   //   MasterOpGen();
2242   //   __kmpc_end_master(ident_t *, gtid);
2243   // }
2244   // Prepare arguments and build a call to __kmpc_master
2245   llvm::Value *Args[] = {emitUpdateLocation(CGF, Loc), getThreadID(CGF, Loc)};
2246   CommonActionTy Action(OMPBuilder.getOrCreateRuntimeFunction(
2247                             CGM.getModule(), OMPRTL___kmpc_master),
2248                         Args,
2249                         OMPBuilder.getOrCreateRuntimeFunction(
2250                             CGM.getModule(), OMPRTL___kmpc_end_master),
2251                         Args,
2252                         /*Conditional=*/true);
2253   MasterOpGen.setAction(Action);
2254   emitInlinedDirective(CGF, OMPD_master, MasterOpGen);
2255   Action.Done(CGF);
2256 }
2257 
2258 void CGOpenMPRuntime::emitTaskyieldCall(CodeGenFunction &CGF,
2259                                         SourceLocation Loc) {
2260   if (!CGF.HaveInsertPoint())
2261     return;
2262   if (CGF.CGM.getLangOpts().OpenMPIRBuilder) {
2263     OMPBuilder.createTaskyield(CGF.Builder);
2264   } else {
2265     // Build call __kmpc_omp_taskyield(loc, thread_id, 0);
2266     llvm::Value *Args[] = {
2267         emitUpdateLocation(CGF, Loc), getThreadID(CGF, Loc),
2268         llvm::ConstantInt::get(CGM.IntTy, /*V=*/0, /*isSigned=*/true)};
2269     CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
2270                             CGM.getModule(), OMPRTL___kmpc_omp_taskyield),
2271                         Args);
2272   }
2273 
2274   if (auto *Region = dyn_cast_or_null<CGOpenMPRegionInfo>(CGF.CapturedStmtInfo))
2275     Region->emitUntiedSwitch(CGF);
2276 }
2277 
2278 void CGOpenMPRuntime::emitTaskgroupRegion(CodeGenFunction &CGF,
2279                                           const RegionCodeGenTy &TaskgroupOpGen,
2280                                           SourceLocation Loc) {
2281   if (!CGF.HaveInsertPoint())
2282     return;
2283   // __kmpc_taskgroup(ident_t *, gtid);
2284   // TaskgroupOpGen();
2285   // __kmpc_end_taskgroup(ident_t *, gtid);
2286   // Prepare arguments and build a call to __kmpc_taskgroup
2287   llvm::Value *Args[] = {emitUpdateLocation(CGF, Loc), getThreadID(CGF, Loc)};
2288   CommonActionTy Action(OMPBuilder.getOrCreateRuntimeFunction(
2289                             CGM.getModule(), OMPRTL___kmpc_taskgroup),
2290                         Args,
2291                         OMPBuilder.getOrCreateRuntimeFunction(
2292                             CGM.getModule(), OMPRTL___kmpc_end_taskgroup),
2293                         Args);
2294   TaskgroupOpGen.setAction(Action);
2295   emitInlinedDirective(CGF, OMPD_taskgroup, TaskgroupOpGen);
2296 }
2297 
2298 /// Given an array of pointers to variables, project the address of a
2299 /// given variable.
2300 static Address emitAddrOfVarFromArray(CodeGenFunction &CGF, Address Array,
2301                                       unsigned Index, const VarDecl *Var) {
2302   // Pull out the pointer to the variable.
2303   Address PtrAddr = CGF.Builder.CreateConstArrayGEP(Array, Index);
2304   llvm::Value *Ptr = CGF.Builder.CreateLoad(PtrAddr);
2305 
2306   Address Addr = Address(Ptr, CGF.getContext().getDeclAlign(Var));
2307   Addr = CGF.Builder.CreateElementBitCast(
2308       Addr, CGF.ConvertTypeForMem(Var->getType()));
2309   return Addr;
2310 }
2311 
2312 static llvm::Value *emitCopyprivateCopyFunction(
2313     CodeGenModule &CGM, llvm::Type *ArgsType,
2314     ArrayRef<const Expr *> CopyprivateVars, ArrayRef<const Expr *> DestExprs,
2315     ArrayRef<const Expr *> SrcExprs, ArrayRef<const Expr *> AssignmentOps,
2316     SourceLocation Loc) {
2317   ASTContext &C = CGM.getContext();
2318   // void copy_func(void *LHSArg, void *RHSArg);
2319   FunctionArgList Args;
2320   ImplicitParamDecl LHSArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, C.VoidPtrTy,
2321                            ImplicitParamDecl::Other);
2322   ImplicitParamDecl RHSArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, C.VoidPtrTy,
2323                            ImplicitParamDecl::Other);
2324   Args.push_back(&LHSArg);
2325   Args.push_back(&RHSArg);
2326   const auto &CGFI =
2327       CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, Args);
2328   std::string Name =
2329       CGM.getOpenMPRuntime().getName({"omp", "copyprivate", "copy_func"});
2330   auto *Fn = llvm::Function::Create(CGM.getTypes().GetFunctionType(CGFI),
2331                                     llvm::GlobalValue::InternalLinkage, Name,
2332                                     &CGM.getModule());
2333   CGM.SetInternalFunctionAttributes(GlobalDecl(), Fn, CGFI);
2334   Fn->setDoesNotRecurse();
2335   CodeGenFunction CGF(CGM);
2336   CGF.StartFunction(GlobalDecl(), C.VoidTy, Fn, CGFI, Args, Loc, Loc);
2337   // Dest = (void*[n])(LHSArg);
2338   // Src = (void*[n])(RHSArg);
2339   Address LHS(CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
2340       CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&LHSArg)),
2341       ArgsType), CGF.getPointerAlign());
2342   Address RHS(CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
2343       CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&RHSArg)),
2344       ArgsType), CGF.getPointerAlign());
2345   // *(Type0*)Dst[0] = *(Type0*)Src[0];
2346   // *(Type1*)Dst[1] = *(Type1*)Src[1];
2347   // ...
2348   // *(Typen*)Dst[n] = *(Typen*)Src[n];
2349   for (unsigned I = 0, E = AssignmentOps.size(); I < E; ++I) {
2350     const auto *DestVar =
2351         cast<VarDecl>(cast<DeclRefExpr>(DestExprs[I])->getDecl());
2352     Address DestAddr = emitAddrOfVarFromArray(CGF, LHS, I, DestVar);
2353 
2354     const auto *SrcVar =
2355         cast<VarDecl>(cast<DeclRefExpr>(SrcExprs[I])->getDecl());
2356     Address SrcAddr = emitAddrOfVarFromArray(CGF, RHS, I, SrcVar);
2357 
2358     const auto *VD = cast<DeclRefExpr>(CopyprivateVars[I])->getDecl();
2359     QualType Type = VD->getType();
2360     CGF.EmitOMPCopy(Type, DestAddr, SrcAddr, DestVar, SrcVar, AssignmentOps[I]);
2361   }
2362   CGF.FinishFunction();
2363   return Fn;
2364 }
2365 
2366 void CGOpenMPRuntime::emitSingleRegion(CodeGenFunction &CGF,
2367                                        const RegionCodeGenTy &SingleOpGen,
2368                                        SourceLocation Loc,
2369                                        ArrayRef<const Expr *> CopyprivateVars,
2370                                        ArrayRef<const Expr *> SrcExprs,
2371                                        ArrayRef<const Expr *> DstExprs,
2372                                        ArrayRef<const Expr *> AssignmentOps) {
2373   if (!CGF.HaveInsertPoint())
2374     return;
2375   assert(CopyprivateVars.size() == SrcExprs.size() &&
2376          CopyprivateVars.size() == DstExprs.size() &&
2377          CopyprivateVars.size() == AssignmentOps.size());
2378   ASTContext &C = CGM.getContext();
2379   // int32 did_it = 0;
2380   // if(__kmpc_single(ident_t *, gtid)) {
2381   //   SingleOpGen();
2382   //   __kmpc_end_single(ident_t *, gtid);
2383   //   did_it = 1;
2384   // }
2385   // call __kmpc_copyprivate(ident_t *, gtid, <buf_size>, <copyprivate list>,
2386   // <copy_func>, did_it);
2387 
2388   Address DidIt = Address::invalid();
2389   if (!CopyprivateVars.empty()) {
2390     // int32 did_it = 0;
2391     QualType KmpInt32Ty =
2392         C.getIntTypeForBitwidth(/*DestWidth=*/32, /*Signed=*/1);
2393     DidIt = CGF.CreateMemTemp(KmpInt32Ty, ".omp.copyprivate.did_it");
2394     CGF.Builder.CreateStore(CGF.Builder.getInt32(0), DidIt);
2395   }
2396   // Prepare arguments and build a call to __kmpc_single
2397   llvm::Value *Args[] = {emitUpdateLocation(CGF, Loc), getThreadID(CGF, Loc)};
2398   CommonActionTy Action(OMPBuilder.getOrCreateRuntimeFunction(
2399                             CGM.getModule(), OMPRTL___kmpc_single),
2400                         Args,
2401                         OMPBuilder.getOrCreateRuntimeFunction(
2402                             CGM.getModule(), OMPRTL___kmpc_end_single),
2403                         Args,
2404                         /*Conditional=*/true);
2405   SingleOpGen.setAction(Action);
2406   emitInlinedDirective(CGF, OMPD_single, SingleOpGen);
2407   if (DidIt.isValid()) {
2408     // did_it = 1;
2409     CGF.Builder.CreateStore(CGF.Builder.getInt32(1), DidIt);
2410   }
2411   Action.Done(CGF);
2412   // call __kmpc_copyprivate(ident_t *, gtid, <buf_size>, <copyprivate list>,
2413   // <copy_func>, did_it);
2414   if (DidIt.isValid()) {
2415     llvm::APInt ArraySize(/*unsigned int numBits=*/32, CopyprivateVars.size());
2416     QualType CopyprivateArrayTy = C.getConstantArrayType(
2417         C.VoidPtrTy, ArraySize, nullptr, ArrayType::Normal,
2418         /*IndexTypeQuals=*/0);
2419     // Create a list of all private variables for copyprivate.
2420     Address CopyprivateList =
2421         CGF.CreateMemTemp(CopyprivateArrayTy, ".omp.copyprivate.cpr_list");
2422     for (unsigned I = 0, E = CopyprivateVars.size(); I < E; ++I) {
2423       Address Elem = CGF.Builder.CreateConstArrayGEP(CopyprivateList, I);
2424       CGF.Builder.CreateStore(
2425           CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
2426               CGF.EmitLValue(CopyprivateVars[I]).getPointer(CGF),
2427               CGF.VoidPtrTy),
2428           Elem);
2429     }
2430     // Build function that copies private values from single region to all other
2431     // threads in the corresponding parallel region.
2432     llvm::Value *CpyFn = emitCopyprivateCopyFunction(
2433         CGM, CGF.ConvertTypeForMem(CopyprivateArrayTy)->getPointerTo(),
2434         CopyprivateVars, SrcExprs, DstExprs, AssignmentOps, Loc);
2435     llvm::Value *BufSize = CGF.getTypeSize(CopyprivateArrayTy);
2436     Address CL =
2437       CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(CopyprivateList,
2438                                                       CGF.VoidPtrTy);
2439     llvm::Value *DidItVal = CGF.Builder.CreateLoad(DidIt);
2440     llvm::Value *Args[] = {
2441         emitUpdateLocation(CGF, Loc), // ident_t *<loc>
2442         getThreadID(CGF, Loc),        // i32 <gtid>
2443         BufSize,                      // size_t <buf_size>
2444         CL.getPointer(),              // void *<copyprivate list>
2445         CpyFn,                        // void (*) (void *, void *) <copy_func>
2446         DidItVal                      // i32 did_it
2447     };
2448     CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
2449                             CGM.getModule(), OMPRTL___kmpc_copyprivate),
2450                         Args);
2451   }
2452 }
2453 
2454 void CGOpenMPRuntime::emitOrderedRegion(CodeGenFunction &CGF,
2455                                         const RegionCodeGenTy &OrderedOpGen,
2456                                         SourceLocation Loc, bool IsThreads) {
2457   if (!CGF.HaveInsertPoint())
2458     return;
2459   // __kmpc_ordered(ident_t *, gtid);
2460   // OrderedOpGen();
2461   // __kmpc_end_ordered(ident_t *, gtid);
2462   // Prepare arguments and build a call to __kmpc_ordered
2463   if (IsThreads) {
2464     llvm::Value *Args[] = {emitUpdateLocation(CGF, Loc), getThreadID(CGF, Loc)};
2465     CommonActionTy Action(OMPBuilder.getOrCreateRuntimeFunction(
2466                               CGM.getModule(), OMPRTL___kmpc_ordered),
2467                           Args,
2468                           OMPBuilder.getOrCreateRuntimeFunction(
2469                               CGM.getModule(), OMPRTL___kmpc_end_ordered),
2470                           Args);
2471     OrderedOpGen.setAction(Action);
2472     emitInlinedDirective(CGF, OMPD_ordered, OrderedOpGen);
2473     return;
2474   }
2475   emitInlinedDirective(CGF, OMPD_ordered, OrderedOpGen);
2476 }
2477 
2478 unsigned CGOpenMPRuntime::getDefaultFlagsForBarriers(OpenMPDirectiveKind Kind) {
2479   unsigned Flags;
2480   if (Kind == OMPD_for)
2481     Flags = OMP_IDENT_BARRIER_IMPL_FOR;
2482   else if (Kind == OMPD_sections)
2483     Flags = OMP_IDENT_BARRIER_IMPL_SECTIONS;
2484   else if (Kind == OMPD_single)
2485     Flags = OMP_IDENT_BARRIER_IMPL_SINGLE;
2486   else if (Kind == OMPD_barrier)
2487     Flags = OMP_IDENT_BARRIER_EXPL;
2488   else
2489     Flags = OMP_IDENT_BARRIER_IMPL;
2490   return Flags;
2491 }
2492 
2493 void CGOpenMPRuntime::getDefaultScheduleAndChunk(
2494     CodeGenFunction &CGF, const OMPLoopDirective &S,
2495     OpenMPScheduleClauseKind &ScheduleKind, const Expr *&ChunkExpr) const {
2496   // Check if the loop directive is actually a doacross loop directive. In this
2497   // case choose static, 1 schedule.
2498   if (llvm::any_of(
2499           S.getClausesOfKind<OMPOrderedClause>(),
2500           [](const OMPOrderedClause *C) { return C->getNumForLoops(); })) {
2501     ScheduleKind = OMPC_SCHEDULE_static;
2502     // Chunk size is 1 in this case.
2503     llvm::APInt ChunkSize(32, 1);
2504     ChunkExpr = IntegerLiteral::Create(
2505         CGF.getContext(), ChunkSize,
2506         CGF.getContext().getIntTypeForBitwidth(32, /*Signed=*/0),
2507         SourceLocation());
2508   }
2509 }
2510 
2511 void CGOpenMPRuntime::emitBarrierCall(CodeGenFunction &CGF, SourceLocation Loc,
2512                                       OpenMPDirectiveKind Kind, bool EmitChecks,
2513                                       bool ForceSimpleCall) {
2514   // Check if we should use the OMPBuilder
2515   auto *OMPRegionInfo =
2516       dyn_cast_or_null<CGOpenMPRegionInfo>(CGF.CapturedStmtInfo);
2517   if (CGF.CGM.getLangOpts().OpenMPIRBuilder) {
2518     CGF.Builder.restoreIP(OMPBuilder.createBarrier(
2519         CGF.Builder, Kind, ForceSimpleCall, EmitChecks));
2520     return;
2521   }
2522 
2523   if (!CGF.HaveInsertPoint())
2524     return;
2525   // Build call __kmpc_cancel_barrier(loc, thread_id);
2526   // Build call __kmpc_barrier(loc, thread_id);
2527   unsigned Flags = getDefaultFlagsForBarriers(Kind);
2528   // Build call __kmpc_cancel_barrier(loc, thread_id) or __kmpc_barrier(loc,
2529   // thread_id);
2530   llvm::Value *Args[] = {emitUpdateLocation(CGF, Loc, Flags),
2531                          getThreadID(CGF, Loc)};
2532   if (OMPRegionInfo) {
2533     if (!ForceSimpleCall && OMPRegionInfo->hasCancel()) {
2534       llvm::Value *Result = CGF.EmitRuntimeCall(
2535           OMPBuilder.getOrCreateRuntimeFunction(CGM.getModule(),
2536                                                 OMPRTL___kmpc_cancel_barrier),
2537           Args);
2538       if (EmitChecks) {
2539         // if (__kmpc_cancel_barrier()) {
2540         //   exit from construct;
2541         // }
2542         llvm::BasicBlock *ExitBB = CGF.createBasicBlock(".cancel.exit");
2543         llvm::BasicBlock *ContBB = CGF.createBasicBlock(".cancel.continue");
2544         llvm::Value *Cmp = CGF.Builder.CreateIsNotNull(Result);
2545         CGF.Builder.CreateCondBr(Cmp, ExitBB, ContBB);
2546         CGF.EmitBlock(ExitBB);
2547         //   exit from construct;
2548         CodeGenFunction::JumpDest CancelDestination =
2549             CGF.getOMPCancelDestination(OMPRegionInfo->getDirectiveKind());
2550         CGF.EmitBranchThroughCleanup(CancelDestination);
2551         CGF.EmitBlock(ContBB, /*IsFinished=*/true);
2552       }
2553       return;
2554     }
2555   }
2556   CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
2557                           CGM.getModule(), OMPRTL___kmpc_barrier),
2558                       Args);
2559 }
2560 
2561 /// Map the OpenMP loop schedule to the runtime enumeration.
2562 static OpenMPSchedType getRuntimeSchedule(OpenMPScheduleClauseKind ScheduleKind,
2563                                           bool Chunked, bool Ordered) {
2564   switch (ScheduleKind) {
2565   case OMPC_SCHEDULE_static:
2566     return Chunked ? (Ordered ? OMP_ord_static_chunked : OMP_sch_static_chunked)
2567                    : (Ordered ? OMP_ord_static : OMP_sch_static);
2568   case OMPC_SCHEDULE_dynamic:
2569     return Ordered ? OMP_ord_dynamic_chunked : OMP_sch_dynamic_chunked;
2570   case OMPC_SCHEDULE_guided:
2571     return Ordered ? OMP_ord_guided_chunked : OMP_sch_guided_chunked;
2572   case OMPC_SCHEDULE_runtime:
2573     return Ordered ? OMP_ord_runtime : OMP_sch_runtime;
2574   case OMPC_SCHEDULE_auto:
2575     return Ordered ? OMP_ord_auto : OMP_sch_auto;
2576   case OMPC_SCHEDULE_unknown:
2577     assert(!Chunked && "chunk was specified but schedule kind not known");
2578     return Ordered ? OMP_ord_static : OMP_sch_static;
2579   }
2580   llvm_unreachable("Unexpected runtime schedule");
2581 }
2582 
2583 /// Map the OpenMP distribute schedule to the runtime enumeration.
2584 static OpenMPSchedType
2585 getRuntimeSchedule(OpenMPDistScheduleClauseKind ScheduleKind, bool Chunked) {
2586   // only static is allowed for dist_schedule
2587   return Chunked ? OMP_dist_sch_static_chunked : OMP_dist_sch_static;
2588 }
2589 
2590 bool CGOpenMPRuntime::isStaticNonchunked(OpenMPScheduleClauseKind ScheduleKind,
2591                                          bool Chunked) const {
2592   OpenMPSchedType Schedule =
2593       getRuntimeSchedule(ScheduleKind, Chunked, /*Ordered=*/false);
2594   return Schedule == OMP_sch_static;
2595 }
2596 
2597 bool CGOpenMPRuntime::isStaticNonchunked(
2598     OpenMPDistScheduleClauseKind ScheduleKind, bool Chunked) const {
2599   OpenMPSchedType Schedule = getRuntimeSchedule(ScheduleKind, Chunked);
2600   return Schedule == OMP_dist_sch_static;
2601 }
2602 
2603 bool CGOpenMPRuntime::isStaticChunked(OpenMPScheduleClauseKind ScheduleKind,
2604                                       bool Chunked) const {
2605   OpenMPSchedType Schedule =
2606       getRuntimeSchedule(ScheduleKind, Chunked, /*Ordered=*/false);
2607   return Schedule == OMP_sch_static_chunked;
2608 }
2609 
2610 bool CGOpenMPRuntime::isStaticChunked(
2611     OpenMPDistScheduleClauseKind ScheduleKind, bool Chunked) const {
2612   OpenMPSchedType Schedule = getRuntimeSchedule(ScheduleKind, Chunked);
2613   return Schedule == OMP_dist_sch_static_chunked;
2614 }
2615 
2616 bool CGOpenMPRuntime::isDynamic(OpenMPScheduleClauseKind ScheduleKind) const {
2617   OpenMPSchedType Schedule =
2618       getRuntimeSchedule(ScheduleKind, /*Chunked=*/false, /*Ordered=*/false);
2619   assert(Schedule != OMP_sch_static_chunked && "cannot be chunked here");
2620   return Schedule != OMP_sch_static;
2621 }
2622 
2623 static int addMonoNonMonoModifier(CodeGenModule &CGM, OpenMPSchedType Schedule,
2624                                   OpenMPScheduleClauseModifier M1,
2625                                   OpenMPScheduleClauseModifier M2) {
2626   int Modifier = 0;
2627   switch (M1) {
2628   case OMPC_SCHEDULE_MODIFIER_monotonic:
2629     Modifier = OMP_sch_modifier_monotonic;
2630     break;
2631   case OMPC_SCHEDULE_MODIFIER_nonmonotonic:
2632     Modifier = OMP_sch_modifier_nonmonotonic;
2633     break;
2634   case OMPC_SCHEDULE_MODIFIER_simd:
2635     if (Schedule == OMP_sch_static_chunked)
2636       Schedule = OMP_sch_static_balanced_chunked;
2637     break;
2638   case OMPC_SCHEDULE_MODIFIER_last:
2639   case OMPC_SCHEDULE_MODIFIER_unknown:
2640     break;
2641   }
2642   switch (M2) {
2643   case OMPC_SCHEDULE_MODIFIER_monotonic:
2644     Modifier = OMP_sch_modifier_monotonic;
2645     break;
2646   case OMPC_SCHEDULE_MODIFIER_nonmonotonic:
2647     Modifier = OMP_sch_modifier_nonmonotonic;
2648     break;
2649   case OMPC_SCHEDULE_MODIFIER_simd:
2650     if (Schedule == OMP_sch_static_chunked)
2651       Schedule = OMP_sch_static_balanced_chunked;
2652     break;
2653   case OMPC_SCHEDULE_MODIFIER_last:
2654   case OMPC_SCHEDULE_MODIFIER_unknown:
2655     break;
2656   }
2657   // OpenMP 5.0, 2.9.2 Worksharing-Loop Construct, Desription.
2658   // If the static schedule kind is specified or if the ordered clause is
2659   // specified, and if the nonmonotonic modifier is not specified, the effect is
2660   // as if the monotonic modifier is specified. Otherwise, unless the monotonic
2661   // modifier is specified, the effect is as if the nonmonotonic modifier is
2662   // specified.
2663   if (CGM.getLangOpts().OpenMP >= 50 && Modifier == 0) {
2664     if (!(Schedule == OMP_sch_static_chunked || Schedule == OMP_sch_static ||
2665           Schedule == OMP_sch_static_balanced_chunked ||
2666           Schedule == OMP_ord_static_chunked || Schedule == OMP_ord_static ||
2667           Schedule == OMP_dist_sch_static_chunked ||
2668           Schedule == OMP_dist_sch_static))
2669       Modifier = OMP_sch_modifier_nonmonotonic;
2670   }
2671   return Schedule | Modifier;
2672 }
2673 
2674 void CGOpenMPRuntime::emitForDispatchInit(
2675     CodeGenFunction &CGF, SourceLocation Loc,
2676     const OpenMPScheduleTy &ScheduleKind, unsigned IVSize, bool IVSigned,
2677     bool Ordered, const DispatchRTInput &DispatchValues) {
2678   if (!CGF.HaveInsertPoint())
2679     return;
2680   OpenMPSchedType Schedule = getRuntimeSchedule(
2681       ScheduleKind.Schedule, DispatchValues.Chunk != nullptr, Ordered);
2682   assert(Ordered ||
2683          (Schedule != OMP_sch_static && Schedule != OMP_sch_static_chunked &&
2684           Schedule != OMP_ord_static && Schedule != OMP_ord_static_chunked &&
2685           Schedule != OMP_sch_static_balanced_chunked));
2686   // Call __kmpc_dispatch_init(
2687   //          ident_t *loc, kmp_int32 tid, kmp_int32 schedule,
2688   //          kmp_int[32|64] lower, kmp_int[32|64] upper,
2689   //          kmp_int[32|64] stride, kmp_int[32|64] chunk);
2690 
2691   // If the Chunk was not specified in the clause - use default value 1.
2692   llvm::Value *Chunk = DispatchValues.Chunk ? DispatchValues.Chunk
2693                                             : CGF.Builder.getIntN(IVSize, 1);
2694   llvm::Value *Args[] = {
2695       emitUpdateLocation(CGF, Loc),
2696       getThreadID(CGF, Loc),
2697       CGF.Builder.getInt32(addMonoNonMonoModifier(
2698           CGM, Schedule, ScheduleKind.M1, ScheduleKind.M2)), // Schedule type
2699       DispatchValues.LB,                                     // Lower
2700       DispatchValues.UB,                                     // Upper
2701       CGF.Builder.getIntN(IVSize, 1),                        // Stride
2702       Chunk                                                  // Chunk
2703   };
2704   CGF.EmitRuntimeCall(createDispatchInitFunction(IVSize, IVSigned), Args);
2705 }
2706 
2707 static void emitForStaticInitCall(
2708     CodeGenFunction &CGF, llvm::Value *UpdateLocation, llvm::Value *ThreadId,
2709     llvm::FunctionCallee ForStaticInitFunction, OpenMPSchedType Schedule,
2710     OpenMPScheduleClauseModifier M1, OpenMPScheduleClauseModifier M2,
2711     const CGOpenMPRuntime::StaticRTInput &Values) {
2712   if (!CGF.HaveInsertPoint())
2713     return;
2714 
2715   assert(!Values.Ordered);
2716   assert(Schedule == OMP_sch_static || Schedule == OMP_sch_static_chunked ||
2717          Schedule == OMP_sch_static_balanced_chunked ||
2718          Schedule == OMP_ord_static || Schedule == OMP_ord_static_chunked ||
2719          Schedule == OMP_dist_sch_static ||
2720          Schedule == OMP_dist_sch_static_chunked);
2721 
2722   // Call __kmpc_for_static_init(
2723   //          ident_t *loc, kmp_int32 tid, kmp_int32 schedtype,
2724   //          kmp_int32 *p_lastiter, kmp_int[32|64] *p_lower,
2725   //          kmp_int[32|64] *p_upper, kmp_int[32|64] *p_stride,
2726   //          kmp_int[32|64] incr, kmp_int[32|64] chunk);
2727   llvm::Value *Chunk = Values.Chunk;
2728   if (Chunk == nullptr) {
2729     assert((Schedule == OMP_sch_static || Schedule == OMP_ord_static ||
2730             Schedule == OMP_dist_sch_static) &&
2731            "expected static non-chunked schedule");
2732     // If the Chunk was not specified in the clause - use default value 1.
2733     Chunk = CGF.Builder.getIntN(Values.IVSize, 1);
2734   } else {
2735     assert((Schedule == OMP_sch_static_chunked ||
2736             Schedule == OMP_sch_static_balanced_chunked ||
2737             Schedule == OMP_ord_static_chunked ||
2738             Schedule == OMP_dist_sch_static_chunked) &&
2739            "expected static chunked schedule");
2740   }
2741   llvm::Value *Args[] = {
2742       UpdateLocation,
2743       ThreadId,
2744       CGF.Builder.getInt32(addMonoNonMonoModifier(CGF.CGM, Schedule, M1,
2745                                                   M2)), // Schedule type
2746       Values.IL.getPointer(),                           // &isLastIter
2747       Values.LB.getPointer(),                           // &LB
2748       Values.UB.getPointer(),                           // &UB
2749       Values.ST.getPointer(),                           // &Stride
2750       CGF.Builder.getIntN(Values.IVSize, 1),            // Incr
2751       Chunk                                             // Chunk
2752   };
2753   CGF.EmitRuntimeCall(ForStaticInitFunction, Args);
2754 }
2755 
2756 void CGOpenMPRuntime::emitForStaticInit(CodeGenFunction &CGF,
2757                                         SourceLocation Loc,
2758                                         OpenMPDirectiveKind DKind,
2759                                         const OpenMPScheduleTy &ScheduleKind,
2760                                         const StaticRTInput &Values) {
2761   OpenMPSchedType ScheduleNum = getRuntimeSchedule(
2762       ScheduleKind.Schedule, Values.Chunk != nullptr, Values.Ordered);
2763   assert(isOpenMPWorksharingDirective(DKind) &&
2764          "Expected loop-based or sections-based directive.");
2765   llvm::Value *UpdatedLocation = emitUpdateLocation(CGF, Loc,
2766                                              isOpenMPLoopDirective(DKind)
2767                                                  ? OMP_IDENT_WORK_LOOP
2768                                                  : OMP_IDENT_WORK_SECTIONS);
2769   llvm::Value *ThreadId = getThreadID(CGF, Loc);
2770   llvm::FunctionCallee StaticInitFunction =
2771       createForStaticInitFunction(Values.IVSize, Values.IVSigned);
2772   auto DL = ApplyDebugLocation::CreateDefaultArtificial(CGF, Loc);
2773   emitForStaticInitCall(CGF, UpdatedLocation, ThreadId, StaticInitFunction,
2774                         ScheduleNum, ScheduleKind.M1, ScheduleKind.M2, Values);
2775 }
2776 
2777 void CGOpenMPRuntime::emitDistributeStaticInit(
2778     CodeGenFunction &CGF, SourceLocation Loc,
2779     OpenMPDistScheduleClauseKind SchedKind,
2780     const CGOpenMPRuntime::StaticRTInput &Values) {
2781   OpenMPSchedType ScheduleNum =
2782       getRuntimeSchedule(SchedKind, Values.Chunk != nullptr);
2783   llvm::Value *UpdatedLocation =
2784       emitUpdateLocation(CGF, Loc, OMP_IDENT_WORK_DISTRIBUTE);
2785   llvm::Value *ThreadId = getThreadID(CGF, Loc);
2786   llvm::FunctionCallee StaticInitFunction =
2787       createForStaticInitFunction(Values.IVSize, Values.IVSigned);
2788   emitForStaticInitCall(CGF, UpdatedLocation, ThreadId, StaticInitFunction,
2789                         ScheduleNum, OMPC_SCHEDULE_MODIFIER_unknown,
2790                         OMPC_SCHEDULE_MODIFIER_unknown, Values);
2791 }
2792 
2793 void CGOpenMPRuntime::emitForStaticFinish(CodeGenFunction &CGF,
2794                                           SourceLocation Loc,
2795                                           OpenMPDirectiveKind DKind) {
2796   if (!CGF.HaveInsertPoint())
2797     return;
2798   // Call __kmpc_for_static_fini(ident_t *loc, kmp_int32 tid);
2799   llvm::Value *Args[] = {
2800       emitUpdateLocation(CGF, Loc,
2801                          isOpenMPDistributeDirective(DKind)
2802                              ? OMP_IDENT_WORK_DISTRIBUTE
2803                              : isOpenMPLoopDirective(DKind)
2804                                    ? OMP_IDENT_WORK_LOOP
2805                                    : OMP_IDENT_WORK_SECTIONS),
2806       getThreadID(CGF, Loc)};
2807   auto DL = ApplyDebugLocation::CreateDefaultArtificial(CGF, Loc);
2808   CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
2809                           CGM.getModule(), OMPRTL___kmpc_for_static_fini),
2810                       Args);
2811 }
2812 
2813 void CGOpenMPRuntime::emitForOrderedIterationEnd(CodeGenFunction &CGF,
2814                                                  SourceLocation Loc,
2815                                                  unsigned IVSize,
2816                                                  bool IVSigned) {
2817   if (!CGF.HaveInsertPoint())
2818     return;
2819   // Call __kmpc_for_dynamic_fini_(4|8)[u](ident_t *loc, kmp_int32 tid);
2820   llvm::Value *Args[] = {emitUpdateLocation(CGF, Loc), getThreadID(CGF, Loc)};
2821   CGF.EmitRuntimeCall(createDispatchFiniFunction(IVSize, IVSigned), Args);
2822 }
2823 
2824 llvm::Value *CGOpenMPRuntime::emitForNext(CodeGenFunction &CGF,
2825                                           SourceLocation Loc, unsigned IVSize,
2826                                           bool IVSigned, Address IL,
2827                                           Address LB, Address UB,
2828                                           Address ST) {
2829   // Call __kmpc_dispatch_next(
2830   //          ident_t *loc, kmp_int32 tid, kmp_int32 *p_lastiter,
2831   //          kmp_int[32|64] *p_lower, kmp_int[32|64] *p_upper,
2832   //          kmp_int[32|64] *p_stride);
2833   llvm::Value *Args[] = {
2834       emitUpdateLocation(CGF, Loc),
2835       getThreadID(CGF, Loc),
2836       IL.getPointer(), // &isLastIter
2837       LB.getPointer(), // &Lower
2838       UB.getPointer(), // &Upper
2839       ST.getPointer()  // &Stride
2840   };
2841   llvm::Value *Call =
2842       CGF.EmitRuntimeCall(createDispatchNextFunction(IVSize, IVSigned), Args);
2843   return CGF.EmitScalarConversion(
2844       Call, CGF.getContext().getIntTypeForBitwidth(32, /*Signed=*/1),
2845       CGF.getContext().BoolTy, Loc);
2846 }
2847 
2848 void CGOpenMPRuntime::emitNumThreadsClause(CodeGenFunction &CGF,
2849                                            llvm::Value *NumThreads,
2850                                            SourceLocation Loc) {
2851   if (!CGF.HaveInsertPoint())
2852     return;
2853   // Build call __kmpc_push_num_threads(&loc, global_tid, num_threads)
2854   llvm::Value *Args[] = {
2855       emitUpdateLocation(CGF, Loc), getThreadID(CGF, Loc),
2856       CGF.Builder.CreateIntCast(NumThreads, CGF.Int32Ty, /*isSigned*/ true)};
2857   CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
2858                           CGM.getModule(), OMPRTL___kmpc_push_num_threads),
2859                       Args);
2860 }
2861 
2862 void CGOpenMPRuntime::emitProcBindClause(CodeGenFunction &CGF,
2863                                          ProcBindKind ProcBind,
2864                                          SourceLocation Loc) {
2865   if (!CGF.HaveInsertPoint())
2866     return;
2867   assert(ProcBind != OMP_PROC_BIND_unknown && "Unsupported proc_bind value.");
2868   // Build call __kmpc_push_proc_bind(&loc, global_tid, proc_bind)
2869   llvm::Value *Args[] = {
2870       emitUpdateLocation(CGF, Loc), getThreadID(CGF, Loc),
2871       llvm::ConstantInt::get(CGM.IntTy, unsigned(ProcBind), /*isSigned=*/true)};
2872   CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
2873                           CGM.getModule(), OMPRTL___kmpc_push_proc_bind),
2874                       Args);
2875 }
2876 
2877 void CGOpenMPRuntime::emitFlush(CodeGenFunction &CGF, ArrayRef<const Expr *>,
2878                                 SourceLocation Loc, llvm::AtomicOrdering AO) {
2879   if (CGF.CGM.getLangOpts().OpenMPIRBuilder) {
2880     OMPBuilder.createFlush(CGF.Builder);
2881   } else {
2882     if (!CGF.HaveInsertPoint())
2883       return;
2884     // Build call void __kmpc_flush(ident_t *loc)
2885     CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
2886                             CGM.getModule(), OMPRTL___kmpc_flush),
2887                         emitUpdateLocation(CGF, Loc));
2888   }
2889 }
2890 
2891 namespace {
2892 /// Indexes of fields for type kmp_task_t.
2893 enum KmpTaskTFields {
2894   /// List of shared variables.
2895   KmpTaskTShareds,
2896   /// Task routine.
2897   KmpTaskTRoutine,
2898   /// Partition id for the untied tasks.
2899   KmpTaskTPartId,
2900   /// Function with call of destructors for private variables.
2901   Data1,
2902   /// Task priority.
2903   Data2,
2904   /// (Taskloops only) Lower bound.
2905   KmpTaskTLowerBound,
2906   /// (Taskloops only) Upper bound.
2907   KmpTaskTUpperBound,
2908   /// (Taskloops only) Stride.
2909   KmpTaskTStride,
2910   /// (Taskloops only) Is last iteration flag.
2911   KmpTaskTLastIter,
2912   /// (Taskloops only) Reduction data.
2913   KmpTaskTReductions,
2914 };
2915 } // anonymous namespace
2916 
2917 bool CGOpenMPRuntime::OffloadEntriesInfoManagerTy::empty() const {
2918   return OffloadEntriesTargetRegion.empty() &&
2919          OffloadEntriesDeviceGlobalVar.empty();
2920 }
2921 
2922 /// Initialize target region entry.
2923 void CGOpenMPRuntime::OffloadEntriesInfoManagerTy::
2924     initializeTargetRegionEntryInfo(unsigned DeviceID, unsigned FileID,
2925                                     StringRef ParentName, unsigned LineNum,
2926                                     unsigned Order) {
2927   assert(CGM.getLangOpts().OpenMPIsDevice && "Initialization of entries is "
2928                                              "only required for the device "
2929                                              "code generation.");
2930   OffloadEntriesTargetRegion[DeviceID][FileID][ParentName][LineNum] =
2931       OffloadEntryInfoTargetRegion(Order, /*Addr=*/nullptr, /*ID=*/nullptr,
2932                                    OMPTargetRegionEntryTargetRegion);
2933   ++OffloadingEntriesNum;
2934 }
2935 
2936 void CGOpenMPRuntime::OffloadEntriesInfoManagerTy::
2937     registerTargetRegionEntryInfo(unsigned DeviceID, unsigned FileID,
2938                                   StringRef ParentName, unsigned LineNum,
2939                                   llvm::Constant *Addr, llvm::Constant *ID,
2940                                   OMPTargetRegionEntryKind Flags) {
2941   // If we are emitting code for a target, the entry is already initialized,
2942   // only has to be registered.
2943   if (CGM.getLangOpts().OpenMPIsDevice) {
2944     if (!hasTargetRegionEntryInfo(DeviceID, FileID, ParentName, LineNum)) {
2945       unsigned DiagID = CGM.getDiags().getCustomDiagID(
2946           DiagnosticsEngine::Error,
2947           "Unable to find target region on line '%0' in the device code.");
2948       CGM.getDiags().Report(DiagID) << LineNum;
2949       return;
2950     }
2951     auto &Entry =
2952         OffloadEntriesTargetRegion[DeviceID][FileID][ParentName][LineNum];
2953     assert(Entry.isValid() && "Entry not initialized!");
2954     Entry.setAddress(Addr);
2955     Entry.setID(ID);
2956     Entry.setFlags(Flags);
2957   } else {
2958     if (Flags ==
2959             OffloadEntriesInfoManagerTy::OMPTargetRegionEntryTargetRegion &&
2960         hasTargetRegionEntryInfo(DeviceID, FileID, ParentName, LineNum,
2961                                  /*IgnoreAddressId*/ true))
2962       return;
2963     assert(!hasTargetRegionEntryInfo(DeviceID, FileID, ParentName, LineNum) &&
2964            "Target region entry already registered!");
2965     OffloadEntryInfoTargetRegion Entry(OffloadingEntriesNum, Addr, ID, Flags);
2966     OffloadEntriesTargetRegion[DeviceID][FileID][ParentName][LineNum] = Entry;
2967     ++OffloadingEntriesNum;
2968   }
2969 }
2970 
2971 bool CGOpenMPRuntime::OffloadEntriesInfoManagerTy::hasTargetRegionEntryInfo(
2972     unsigned DeviceID, unsigned FileID, StringRef ParentName, unsigned LineNum,
2973     bool IgnoreAddressId) const {
2974   auto PerDevice = OffloadEntriesTargetRegion.find(DeviceID);
2975   if (PerDevice == OffloadEntriesTargetRegion.end())
2976     return false;
2977   auto PerFile = PerDevice->second.find(FileID);
2978   if (PerFile == PerDevice->second.end())
2979     return false;
2980   auto PerParentName = PerFile->second.find(ParentName);
2981   if (PerParentName == PerFile->second.end())
2982     return false;
2983   auto PerLine = PerParentName->second.find(LineNum);
2984   if (PerLine == PerParentName->second.end())
2985     return false;
2986   // Fail if this entry is already registered.
2987   if (!IgnoreAddressId &&
2988       (PerLine->second.getAddress() || PerLine->second.getID()))
2989     return false;
2990   return true;
2991 }
2992 
2993 void CGOpenMPRuntime::OffloadEntriesInfoManagerTy::actOnTargetRegionEntriesInfo(
2994     const OffloadTargetRegionEntryInfoActTy &Action) {
2995   // Scan all target region entries and perform the provided action.
2996   for (const auto &D : OffloadEntriesTargetRegion)
2997     for (const auto &F : D.second)
2998       for (const auto &P : F.second)
2999         for (const auto &L : P.second)
3000           Action(D.first, F.first, P.first(), L.first, L.second);
3001 }
3002 
3003 void CGOpenMPRuntime::OffloadEntriesInfoManagerTy::
3004     initializeDeviceGlobalVarEntryInfo(StringRef Name,
3005                                        OMPTargetGlobalVarEntryKind Flags,
3006                                        unsigned Order) {
3007   assert(CGM.getLangOpts().OpenMPIsDevice && "Initialization of entries is "
3008                                              "only required for the device "
3009                                              "code generation.");
3010   OffloadEntriesDeviceGlobalVar.try_emplace(Name, Order, Flags);
3011   ++OffloadingEntriesNum;
3012 }
3013 
3014 void CGOpenMPRuntime::OffloadEntriesInfoManagerTy::
3015     registerDeviceGlobalVarEntryInfo(StringRef VarName, llvm::Constant *Addr,
3016                                      CharUnits VarSize,
3017                                      OMPTargetGlobalVarEntryKind Flags,
3018                                      llvm::GlobalValue::LinkageTypes Linkage) {
3019   if (CGM.getLangOpts().OpenMPIsDevice) {
3020     auto &Entry = OffloadEntriesDeviceGlobalVar[VarName];
3021     assert(Entry.isValid() && Entry.getFlags() == Flags &&
3022            "Entry not initialized!");
3023     assert((!Entry.getAddress() || Entry.getAddress() == Addr) &&
3024            "Resetting with the new address.");
3025     if (Entry.getAddress() && hasDeviceGlobalVarEntryInfo(VarName)) {
3026       if (Entry.getVarSize().isZero()) {
3027         Entry.setVarSize(VarSize);
3028         Entry.setLinkage(Linkage);
3029       }
3030       return;
3031     }
3032     Entry.setVarSize(VarSize);
3033     Entry.setLinkage(Linkage);
3034     Entry.setAddress(Addr);
3035   } else {
3036     if (hasDeviceGlobalVarEntryInfo(VarName)) {
3037       auto &Entry = OffloadEntriesDeviceGlobalVar[VarName];
3038       assert(Entry.isValid() && Entry.getFlags() == Flags &&
3039              "Entry not initialized!");
3040       assert((!Entry.getAddress() || Entry.getAddress() == Addr) &&
3041              "Resetting with the new address.");
3042       if (Entry.getVarSize().isZero()) {
3043         Entry.setVarSize(VarSize);
3044         Entry.setLinkage(Linkage);
3045       }
3046       return;
3047     }
3048     OffloadEntriesDeviceGlobalVar.try_emplace(
3049         VarName, OffloadingEntriesNum, Addr, VarSize, Flags, Linkage);
3050     ++OffloadingEntriesNum;
3051   }
3052 }
3053 
3054 void CGOpenMPRuntime::OffloadEntriesInfoManagerTy::
3055     actOnDeviceGlobalVarEntriesInfo(
3056         const OffloadDeviceGlobalVarEntryInfoActTy &Action) {
3057   // Scan all target region entries and perform the provided action.
3058   for (const auto &E : OffloadEntriesDeviceGlobalVar)
3059     Action(E.getKey(), E.getValue());
3060 }
3061 
3062 void CGOpenMPRuntime::createOffloadEntry(
3063     llvm::Constant *ID, llvm::Constant *Addr, uint64_t Size, int32_t Flags,
3064     llvm::GlobalValue::LinkageTypes Linkage) {
3065   StringRef Name = Addr->getName();
3066   llvm::Module &M = CGM.getModule();
3067   llvm::LLVMContext &C = M.getContext();
3068 
3069   // Create constant string with the name.
3070   llvm::Constant *StrPtrInit = llvm::ConstantDataArray::getString(C, Name);
3071 
3072   std::string StringName = getName({"omp_offloading", "entry_name"});
3073   auto *Str = new llvm::GlobalVariable(
3074       M, StrPtrInit->getType(), /*isConstant=*/true,
3075       llvm::GlobalValue::InternalLinkage, StrPtrInit, StringName);
3076   Str->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
3077 
3078   llvm::Constant *Data[] = {llvm::ConstantExpr::getBitCast(ID, CGM.VoidPtrTy),
3079                             llvm::ConstantExpr::getBitCast(Str, CGM.Int8PtrTy),
3080                             llvm::ConstantInt::get(CGM.SizeTy, Size),
3081                             llvm::ConstantInt::get(CGM.Int32Ty, Flags),
3082                             llvm::ConstantInt::get(CGM.Int32Ty, 0)};
3083   std::string EntryName = getName({"omp_offloading", "entry", ""});
3084   llvm::GlobalVariable *Entry = createGlobalStruct(
3085       CGM, getTgtOffloadEntryQTy(), /*IsConstant=*/true, Data,
3086       Twine(EntryName).concat(Name), llvm::GlobalValue::WeakAnyLinkage);
3087 
3088   // The entry has to be created in the section the linker expects it to be.
3089   Entry->setSection("omp_offloading_entries");
3090 }
3091 
3092 void CGOpenMPRuntime::createOffloadEntriesAndInfoMetadata() {
3093   // Emit the offloading entries and metadata so that the device codegen side
3094   // can easily figure out what to emit. The produced metadata looks like
3095   // this:
3096   //
3097   // !omp_offload.info = !{!1, ...}
3098   //
3099   // Right now we only generate metadata for function that contain target
3100   // regions.
3101 
3102   // If we are in simd mode or there are no entries, we don't need to do
3103   // anything.
3104   if (CGM.getLangOpts().OpenMPSimd || OffloadEntriesInfoManager.empty())
3105     return;
3106 
3107   llvm::Module &M = CGM.getModule();
3108   llvm::LLVMContext &C = M.getContext();
3109   SmallVector<std::tuple<const OffloadEntriesInfoManagerTy::OffloadEntryInfo *,
3110                          SourceLocation, StringRef>,
3111               16>
3112       OrderedEntries(OffloadEntriesInfoManager.size());
3113   llvm::SmallVector<StringRef, 16> ParentFunctions(
3114       OffloadEntriesInfoManager.size());
3115 
3116   // Auxiliary methods to create metadata values and strings.
3117   auto &&GetMDInt = [this](unsigned V) {
3118     return llvm::ConstantAsMetadata::get(
3119         llvm::ConstantInt::get(CGM.Int32Ty, V));
3120   };
3121 
3122   auto &&GetMDString = [&C](StringRef V) { return llvm::MDString::get(C, V); };
3123 
3124   // Create the offloading info metadata node.
3125   llvm::NamedMDNode *MD = M.getOrInsertNamedMetadata("omp_offload.info");
3126 
3127   // Create function that emits metadata for each target region entry;
3128   auto &&TargetRegionMetadataEmitter =
3129       [this, &C, MD, &OrderedEntries, &ParentFunctions, &GetMDInt,
3130        &GetMDString](
3131           unsigned DeviceID, unsigned FileID, StringRef ParentName,
3132           unsigned Line,
3133           const OffloadEntriesInfoManagerTy::OffloadEntryInfoTargetRegion &E) {
3134         // Generate metadata for target regions. Each entry of this metadata
3135         // contains:
3136         // - Entry 0 -> Kind of this type of metadata (0).
3137         // - Entry 1 -> Device ID of the file where the entry was identified.
3138         // - Entry 2 -> File ID of the file where the entry was identified.
3139         // - Entry 3 -> Mangled name of the function where the entry was
3140         // identified.
3141         // - Entry 4 -> Line in the file where the entry was identified.
3142         // - Entry 5 -> Order the entry was created.
3143         // The first element of the metadata node is the kind.
3144         llvm::Metadata *Ops[] = {GetMDInt(E.getKind()), GetMDInt(DeviceID),
3145                                  GetMDInt(FileID),      GetMDString(ParentName),
3146                                  GetMDInt(Line),        GetMDInt(E.getOrder())};
3147 
3148         SourceLocation Loc;
3149         for (auto I = CGM.getContext().getSourceManager().fileinfo_begin(),
3150                   E = CGM.getContext().getSourceManager().fileinfo_end();
3151              I != E; ++I) {
3152           if (I->getFirst()->getUniqueID().getDevice() == DeviceID &&
3153               I->getFirst()->getUniqueID().getFile() == FileID) {
3154             Loc = CGM.getContext().getSourceManager().translateFileLineCol(
3155                 I->getFirst(), Line, 1);
3156             break;
3157           }
3158         }
3159         // Save this entry in the right position of the ordered entries array.
3160         OrderedEntries[E.getOrder()] = std::make_tuple(&E, Loc, ParentName);
3161         ParentFunctions[E.getOrder()] = ParentName;
3162 
3163         // Add metadata to the named metadata node.
3164         MD->addOperand(llvm::MDNode::get(C, Ops));
3165       };
3166 
3167   OffloadEntriesInfoManager.actOnTargetRegionEntriesInfo(
3168       TargetRegionMetadataEmitter);
3169 
3170   // Create function that emits metadata for each device global variable entry;
3171   auto &&DeviceGlobalVarMetadataEmitter =
3172       [&C, &OrderedEntries, &GetMDInt, &GetMDString,
3173        MD](StringRef MangledName,
3174            const OffloadEntriesInfoManagerTy::OffloadEntryInfoDeviceGlobalVar
3175                &E) {
3176         // Generate metadata for global variables. Each entry of this metadata
3177         // contains:
3178         // - Entry 0 -> Kind of this type of metadata (1).
3179         // - Entry 1 -> Mangled name of the variable.
3180         // - Entry 2 -> Declare target kind.
3181         // - Entry 3 -> Order the entry was created.
3182         // The first element of the metadata node is the kind.
3183         llvm::Metadata *Ops[] = {
3184             GetMDInt(E.getKind()), GetMDString(MangledName),
3185             GetMDInt(E.getFlags()), GetMDInt(E.getOrder())};
3186 
3187         // Save this entry in the right position of the ordered entries array.
3188         OrderedEntries[E.getOrder()] =
3189             std::make_tuple(&E, SourceLocation(), MangledName);
3190 
3191         // Add metadata to the named metadata node.
3192         MD->addOperand(llvm::MDNode::get(C, Ops));
3193       };
3194 
3195   OffloadEntriesInfoManager.actOnDeviceGlobalVarEntriesInfo(
3196       DeviceGlobalVarMetadataEmitter);
3197 
3198   for (const auto &E : OrderedEntries) {
3199     assert(std::get<0>(E) && "All ordered entries must exist!");
3200     if (const auto *CE =
3201             dyn_cast<OffloadEntriesInfoManagerTy::OffloadEntryInfoTargetRegion>(
3202                 std::get<0>(E))) {
3203       if (!CE->getID() || !CE->getAddress()) {
3204         // Do not blame the entry if the parent funtion is not emitted.
3205         StringRef FnName = ParentFunctions[CE->getOrder()];
3206         if (!CGM.GetGlobalValue(FnName))
3207           continue;
3208         unsigned DiagID = CGM.getDiags().getCustomDiagID(
3209             DiagnosticsEngine::Error,
3210             "Offloading entry for target region in %0 is incorrect: either the "
3211             "address or the ID is invalid.");
3212         CGM.getDiags().Report(std::get<1>(E), DiagID) << FnName;
3213         continue;
3214       }
3215       createOffloadEntry(CE->getID(), CE->getAddress(), /*Size=*/0,
3216                          CE->getFlags(), llvm::GlobalValue::WeakAnyLinkage);
3217     } else if (const auto *CE = dyn_cast<OffloadEntriesInfoManagerTy::
3218                                              OffloadEntryInfoDeviceGlobalVar>(
3219                    std::get<0>(E))) {
3220       OffloadEntriesInfoManagerTy::OMPTargetGlobalVarEntryKind Flags =
3221           static_cast<OffloadEntriesInfoManagerTy::OMPTargetGlobalVarEntryKind>(
3222               CE->getFlags());
3223       switch (Flags) {
3224       case OffloadEntriesInfoManagerTy::OMPTargetGlobalVarEntryTo: {
3225         if (CGM.getLangOpts().OpenMPIsDevice &&
3226             CGM.getOpenMPRuntime().hasRequiresUnifiedSharedMemory())
3227           continue;
3228         if (!CE->getAddress()) {
3229           unsigned DiagID = CGM.getDiags().getCustomDiagID(
3230               DiagnosticsEngine::Error, "Offloading entry for declare target "
3231                                         "variable %0 is incorrect: the "
3232                                         "address is invalid.");
3233           CGM.getDiags().Report(std::get<1>(E), DiagID) << std::get<2>(E);
3234           continue;
3235         }
3236         // The vaiable has no definition - no need to add the entry.
3237         if (CE->getVarSize().isZero())
3238           continue;
3239         break;
3240       }
3241       case OffloadEntriesInfoManagerTy::OMPTargetGlobalVarEntryLink:
3242         assert(((CGM.getLangOpts().OpenMPIsDevice && !CE->getAddress()) ||
3243                 (!CGM.getLangOpts().OpenMPIsDevice && CE->getAddress())) &&
3244                "Declaret target link address is set.");
3245         if (CGM.getLangOpts().OpenMPIsDevice)
3246           continue;
3247         if (!CE->getAddress()) {
3248           unsigned DiagID = CGM.getDiags().getCustomDiagID(
3249               DiagnosticsEngine::Error,
3250               "Offloading entry for declare target variable is incorrect: the "
3251               "address is invalid.");
3252           CGM.getDiags().Report(DiagID);
3253           continue;
3254         }
3255         break;
3256       }
3257       createOffloadEntry(CE->getAddress(), CE->getAddress(),
3258                          CE->getVarSize().getQuantity(), Flags,
3259                          CE->getLinkage());
3260     } else {
3261       llvm_unreachable("Unsupported entry kind.");
3262     }
3263   }
3264 }
3265 
3266 /// Loads all the offload entries information from the host IR
3267 /// metadata.
3268 void CGOpenMPRuntime::loadOffloadInfoMetadata() {
3269   // If we are in target mode, load the metadata from the host IR. This code has
3270   // to match the metadaata creation in createOffloadEntriesAndInfoMetadata().
3271 
3272   if (!CGM.getLangOpts().OpenMPIsDevice)
3273     return;
3274 
3275   if (CGM.getLangOpts().OMPHostIRFile.empty())
3276     return;
3277 
3278   auto Buf = llvm::MemoryBuffer::getFile(CGM.getLangOpts().OMPHostIRFile);
3279   if (auto EC = Buf.getError()) {
3280     CGM.getDiags().Report(diag::err_cannot_open_file)
3281         << CGM.getLangOpts().OMPHostIRFile << EC.message();
3282     return;
3283   }
3284 
3285   llvm::LLVMContext C;
3286   auto ME = expectedToErrorOrAndEmitErrors(
3287       C, llvm::parseBitcodeFile(Buf.get()->getMemBufferRef(), C));
3288 
3289   if (auto EC = ME.getError()) {
3290     unsigned DiagID = CGM.getDiags().getCustomDiagID(
3291         DiagnosticsEngine::Error, "Unable to parse host IR file '%0':'%1'");
3292     CGM.getDiags().Report(DiagID)
3293         << CGM.getLangOpts().OMPHostIRFile << EC.message();
3294     return;
3295   }
3296 
3297   llvm::NamedMDNode *MD = ME.get()->getNamedMetadata("omp_offload.info");
3298   if (!MD)
3299     return;
3300 
3301   for (llvm::MDNode *MN : MD->operands()) {
3302     auto &&GetMDInt = [MN](unsigned Idx) {
3303       auto *V = cast<llvm::ConstantAsMetadata>(MN->getOperand(Idx));
3304       return cast<llvm::ConstantInt>(V->getValue())->getZExtValue();
3305     };
3306 
3307     auto &&GetMDString = [MN](unsigned Idx) {
3308       auto *V = cast<llvm::MDString>(MN->getOperand(Idx));
3309       return V->getString();
3310     };
3311 
3312     switch (GetMDInt(0)) {
3313     default:
3314       llvm_unreachable("Unexpected metadata!");
3315       break;
3316     case OffloadEntriesInfoManagerTy::OffloadEntryInfo::
3317         OffloadingEntryInfoTargetRegion:
3318       OffloadEntriesInfoManager.initializeTargetRegionEntryInfo(
3319           /*DeviceID=*/GetMDInt(1), /*FileID=*/GetMDInt(2),
3320           /*ParentName=*/GetMDString(3), /*Line=*/GetMDInt(4),
3321           /*Order=*/GetMDInt(5));
3322       break;
3323     case OffloadEntriesInfoManagerTy::OffloadEntryInfo::
3324         OffloadingEntryInfoDeviceGlobalVar:
3325       OffloadEntriesInfoManager.initializeDeviceGlobalVarEntryInfo(
3326           /*MangledName=*/GetMDString(1),
3327           static_cast<OffloadEntriesInfoManagerTy::OMPTargetGlobalVarEntryKind>(
3328               /*Flags=*/GetMDInt(2)),
3329           /*Order=*/GetMDInt(3));
3330       break;
3331     }
3332   }
3333 }
3334 
3335 void CGOpenMPRuntime::emitKmpRoutineEntryT(QualType KmpInt32Ty) {
3336   if (!KmpRoutineEntryPtrTy) {
3337     // Build typedef kmp_int32 (* kmp_routine_entry_t)(kmp_int32, void *); type.
3338     ASTContext &C = CGM.getContext();
3339     QualType KmpRoutineEntryTyArgs[] = {KmpInt32Ty, C.VoidPtrTy};
3340     FunctionProtoType::ExtProtoInfo EPI;
3341     KmpRoutineEntryPtrQTy = C.getPointerType(
3342         C.getFunctionType(KmpInt32Ty, KmpRoutineEntryTyArgs, EPI));
3343     KmpRoutineEntryPtrTy = CGM.getTypes().ConvertType(KmpRoutineEntryPtrQTy);
3344   }
3345 }
3346 
3347 QualType CGOpenMPRuntime::getTgtOffloadEntryQTy() {
3348   // Make sure the type of the entry is already created. This is the type we
3349   // have to create:
3350   // struct __tgt_offload_entry{
3351   //   void      *addr;       // Pointer to the offload entry info.
3352   //                          // (function or global)
3353   //   char      *name;       // Name of the function or global.
3354   //   size_t     size;       // Size of the entry info (0 if it a function).
3355   //   int32_t    flags;      // Flags associated with the entry, e.g. 'link'.
3356   //   int32_t    reserved;   // Reserved, to use by the runtime library.
3357   // };
3358   if (TgtOffloadEntryQTy.isNull()) {
3359     ASTContext &C = CGM.getContext();
3360     RecordDecl *RD = C.buildImplicitRecord("__tgt_offload_entry");
3361     RD->startDefinition();
3362     addFieldToRecordDecl(C, RD, C.VoidPtrTy);
3363     addFieldToRecordDecl(C, RD, C.getPointerType(C.CharTy));
3364     addFieldToRecordDecl(C, RD, C.getSizeType());
3365     addFieldToRecordDecl(
3366         C, RD, C.getIntTypeForBitwidth(/*DestWidth=*/32, /*Signed=*/true));
3367     addFieldToRecordDecl(
3368         C, RD, C.getIntTypeForBitwidth(/*DestWidth=*/32, /*Signed=*/true));
3369     RD->completeDefinition();
3370     RD->addAttr(PackedAttr::CreateImplicit(C));
3371     TgtOffloadEntryQTy = C.getRecordType(RD);
3372   }
3373   return TgtOffloadEntryQTy;
3374 }
3375 
3376 namespace {
3377 struct PrivateHelpersTy {
3378   PrivateHelpersTy(const Expr *OriginalRef, const VarDecl *Original,
3379                    const VarDecl *PrivateCopy, const VarDecl *PrivateElemInit)
3380       : OriginalRef(OriginalRef), Original(Original), PrivateCopy(PrivateCopy),
3381         PrivateElemInit(PrivateElemInit) {}
3382   PrivateHelpersTy(const VarDecl *Original) : Original(Original) {}
3383   const Expr *OriginalRef = nullptr;
3384   const VarDecl *Original = nullptr;
3385   const VarDecl *PrivateCopy = nullptr;
3386   const VarDecl *PrivateElemInit = nullptr;
3387   bool isLocalPrivate() const {
3388     return !OriginalRef && !PrivateCopy && !PrivateElemInit;
3389   }
3390 };
3391 typedef std::pair<CharUnits /*Align*/, PrivateHelpersTy> PrivateDataTy;
3392 } // anonymous namespace
3393 
3394 static bool isAllocatableDecl(const VarDecl *VD) {
3395   const VarDecl *CVD = VD->getCanonicalDecl();
3396   if (!CVD->hasAttr<OMPAllocateDeclAttr>())
3397     return false;
3398   const auto *AA = CVD->getAttr<OMPAllocateDeclAttr>();
3399   // Use the default allocation.
3400   return !((AA->getAllocatorType() == OMPAllocateDeclAttr::OMPDefaultMemAlloc ||
3401             AA->getAllocatorType() == OMPAllocateDeclAttr::OMPNullMemAlloc) &&
3402            !AA->getAllocator());
3403 }
3404 
3405 static RecordDecl *
3406 createPrivatesRecordDecl(CodeGenModule &CGM, ArrayRef<PrivateDataTy> Privates) {
3407   if (!Privates.empty()) {
3408     ASTContext &C = CGM.getContext();
3409     // Build struct .kmp_privates_t. {
3410     //         /*  private vars  */
3411     //       };
3412     RecordDecl *RD = C.buildImplicitRecord(".kmp_privates.t");
3413     RD->startDefinition();
3414     for (const auto &Pair : Privates) {
3415       const VarDecl *VD = Pair.second.Original;
3416       QualType Type = VD->getType().getNonReferenceType();
3417       // If the private variable is a local variable with lvalue ref type,
3418       // allocate the pointer instead of the pointee type.
3419       if (Pair.second.isLocalPrivate()) {
3420         if (VD->getType()->isLValueReferenceType())
3421           Type = C.getPointerType(Type);
3422         if (isAllocatableDecl(VD))
3423           Type = C.getPointerType(Type);
3424       }
3425       FieldDecl *FD = addFieldToRecordDecl(C, RD, Type);
3426       if (VD->hasAttrs()) {
3427         for (specific_attr_iterator<AlignedAttr> I(VD->getAttrs().begin()),
3428              E(VD->getAttrs().end());
3429              I != E; ++I)
3430           FD->addAttr(*I);
3431       }
3432     }
3433     RD->completeDefinition();
3434     return RD;
3435   }
3436   return nullptr;
3437 }
3438 
3439 static RecordDecl *
3440 createKmpTaskTRecordDecl(CodeGenModule &CGM, OpenMPDirectiveKind Kind,
3441                          QualType KmpInt32Ty,
3442                          QualType KmpRoutineEntryPointerQTy) {
3443   ASTContext &C = CGM.getContext();
3444   // Build struct kmp_task_t {
3445   //         void *              shareds;
3446   //         kmp_routine_entry_t routine;
3447   //         kmp_int32           part_id;
3448   //         kmp_cmplrdata_t data1;
3449   //         kmp_cmplrdata_t data2;
3450   // For taskloops additional fields:
3451   //         kmp_uint64          lb;
3452   //         kmp_uint64          ub;
3453   //         kmp_int64           st;
3454   //         kmp_int32           liter;
3455   //         void *              reductions;
3456   //       };
3457   RecordDecl *UD = C.buildImplicitRecord("kmp_cmplrdata_t", TTK_Union);
3458   UD->startDefinition();
3459   addFieldToRecordDecl(C, UD, KmpInt32Ty);
3460   addFieldToRecordDecl(C, UD, KmpRoutineEntryPointerQTy);
3461   UD->completeDefinition();
3462   QualType KmpCmplrdataTy = C.getRecordType(UD);
3463   RecordDecl *RD = C.buildImplicitRecord("kmp_task_t");
3464   RD->startDefinition();
3465   addFieldToRecordDecl(C, RD, C.VoidPtrTy);
3466   addFieldToRecordDecl(C, RD, KmpRoutineEntryPointerQTy);
3467   addFieldToRecordDecl(C, RD, KmpInt32Ty);
3468   addFieldToRecordDecl(C, RD, KmpCmplrdataTy);
3469   addFieldToRecordDecl(C, RD, KmpCmplrdataTy);
3470   if (isOpenMPTaskLoopDirective(Kind)) {
3471     QualType KmpUInt64Ty =
3472         CGM.getContext().getIntTypeForBitwidth(/*DestWidth=*/64, /*Signed=*/0);
3473     QualType KmpInt64Ty =
3474         CGM.getContext().getIntTypeForBitwidth(/*DestWidth=*/64, /*Signed=*/1);
3475     addFieldToRecordDecl(C, RD, KmpUInt64Ty);
3476     addFieldToRecordDecl(C, RD, KmpUInt64Ty);
3477     addFieldToRecordDecl(C, RD, KmpInt64Ty);
3478     addFieldToRecordDecl(C, RD, KmpInt32Ty);
3479     addFieldToRecordDecl(C, RD, C.VoidPtrTy);
3480   }
3481   RD->completeDefinition();
3482   return RD;
3483 }
3484 
3485 static RecordDecl *
3486 createKmpTaskTWithPrivatesRecordDecl(CodeGenModule &CGM, QualType KmpTaskTQTy,
3487                                      ArrayRef<PrivateDataTy> Privates) {
3488   ASTContext &C = CGM.getContext();
3489   // Build struct kmp_task_t_with_privates {
3490   //         kmp_task_t task_data;
3491   //         .kmp_privates_t. privates;
3492   //       };
3493   RecordDecl *RD = C.buildImplicitRecord("kmp_task_t_with_privates");
3494   RD->startDefinition();
3495   addFieldToRecordDecl(C, RD, KmpTaskTQTy);
3496   if (const RecordDecl *PrivateRD = createPrivatesRecordDecl(CGM, Privates))
3497     addFieldToRecordDecl(C, RD, C.getRecordType(PrivateRD));
3498   RD->completeDefinition();
3499   return RD;
3500 }
3501 
3502 /// Emit a proxy function which accepts kmp_task_t as the second
3503 /// argument.
3504 /// \code
3505 /// kmp_int32 .omp_task_entry.(kmp_int32 gtid, kmp_task_t *tt) {
3506 ///   TaskFunction(gtid, tt->part_id, &tt->privates, task_privates_map, tt,
3507 ///   For taskloops:
3508 ///   tt->task_data.lb, tt->task_data.ub, tt->task_data.st, tt->task_data.liter,
3509 ///   tt->reductions, tt->shareds);
3510 ///   return 0;
3511 /// }
3512 /// \endcode
3513 static llvm::Function *
3514 emitProxyTaskFunction(CodeGenModule &CGM, SourceLocation Loc,
3515                       OpenMPDirectiveKind Kind, QualType KmpInt32Ty,
3516                       QualType KmpTaskTWithPrivatesPtrQTy,
3517                       QualType KmpTaskTWithPrivatesQTy, QualType KmpTaskTQTy,
3518                       QualType SharedsPtrTy, llvm::Function *TaskFunction,
3519                       llvm::Value *TaskPrivatesMap) {
3520   ASTContext &C = CGM.getContext();
3521   FunctionArgList Args;
3522   ImplicitParamDecl GtidArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, KmpInt32Ty,
3523                             ImplicitParamDecl::Other);
3524   ImplicitParamDecl TaskTypeArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr,
3525                                 KmpTaskTWithPrivatesPtrQTy.withRestrict(),
3526                                 ImplicitParamDecl::Other);
3527   Args.push_back(&GtidArg);
3528   Args.push_back(&TaskTypeArg);
3529   const auto &TaskEntryFnInfo =
3530       CGM.getTypes().arrangeBuiltinFunctionDeclaration(KmpInt32Ty, Args);
3531   llvm::FunctionType *TaskEntryTy =
3532       CGM.getTypes().GetFunctionType(TaskEntryFnInfo);
3533   std::string Name = CGM.getOpenMPRuntime().getName({"omp_task_entry", ""});
3534   auto *TaskEntry = llvm::Function::Create(
3535       TaskEntryTy, llvm::GlobalValue::InternalLinkage, Name, &CGM.getModule());
3536   CGM.SetInternalFunctionAttributes(GlobalDecl(), TaskEntry, TaskEntryFnInfo);
3537   TaskEntry->setDoesNotRecurse();
3538   CodeGenFunction CGF(CGM);
3539   CGF.StartFunction(GlobalDecl(), KmpInt32Ty, TaskEntry, TaskEntryFnInfo, Args,
3540                     Loc, Loc);
3541 
3542   // TaskFunction(gtid, tt->task_data.part_id, &tt->privates, task_privates_map,
3543   // tt,
3544   // For taskloops:
3545   // tt->task_data.lb, tt->task_data.ub, tt->task_data.st, tt->task_data.liter,
3546   // tt->task_data.shareds);
3547   llvm::Value *GtidParam = CGF.EmitLoadOfScalar(
3548       CGF.GetAddrOfLocalVar(&GtidArg), /*Volatile=*/false, KmpInt32Ty, Loc);
3549   LValue TDBase = CGF.EmitLoadOfPointerLValue(
3550       CGF.GetAddrOfLocalVar(&TaskTypeArg),
3551       KmpTaskTWithPrivatesPtrQTy->castAs<PointerType>());
3552   const auto *KmpTaskTWithPrivatesQTyRD =
3553       cast<RecordDecl>(KmpTaskTWithPrivatesQTy->getAsTagDecl());
3554   LValue Base =
3555       CGF.EmitLValueForField(TDBase, *KmpTaskTWithPrivatesQTyRD->field_begin());
3556   const auto *KmpTaskTQTyRD = cast<RecordDecl>(KmpTaskTQTy->getAsTagDecl());
3557   auto PartIdFI = std::next(KmpTaskTQTyRD->field_begin(), KmpTaskTPartId);
3558   LValue PartIdLVal = CGF.EmitLValueForField(Base, *PartIdFI);
3559   llvm::Value *PartidParam = PartIdLVal.getPointer(CGF);
3560 
3561   auto SharedsFI = std::next(KmpTaskTQTyRD->field_begin(), KmpTaskTShareds);
3562   LValue SharedsLVal = CGF.EmitLValueForField(Base, *SharedsFI);
3563   llvm::Value *SharedsParam = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
3564       CGF.EmitLoadOfScalar(SharedsLVal, Loc),
3565       CGF.ConvertTypeForMem(SharedsPtrTy));
3566 
3567   auto PrivatesFI = std::next(KmpTaskTWithPrivatesQTyRD->field_begin(), 1);
3568   llvm::Value *PrivatesParam;
3569   if (PrivatesFI != KmpTaskTWithPrivatesQTyRD->field_end()) {
3570     LValue PrivatesLVal = CGF.EmitLValueForField(TDBase, *PrivatesFI);
3571     PrivatesParam = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
3572         PrivatesLVal.getPointer(CGF), CGF.VoidPtrTy);
3573   } else {
3574     PrivatesParam = llvm::ConstantPointerNull::get(CGF.VoidPtrTy);
3575   }
3576 
3577   llvm::Value *CommonArgs[] = {GtidParam, PartidParam, PrivatesParam,
3578                                TaskPrivatesMap,
3579                                CGF.Builder
3580                                    .CreatePointerBitCastOrAddrSpaceCast(
3581                                        TDBase.getAddress(CGF), CGF.VoidPtrTy)
3582                                    .getPointer()};
3583   SmallVector<llvm::Value *, 16> CallArgs(std::begin(CommonArgs),
3584                                           std::end(CommonArgs));
3585   if (isOpenMPTaskLoopDirective(Kind)) {
3586     auto LBFI = std::next(KmpTaskTQTyRD->field_begin(), KmpTaskTLowerBound);
3587     LValue LBLVal = CGF.EmitLValueForField(Base, *LBFI);
3588     llvm::Value *LBParam = CGF.EmitLoadOfScalar(LBLVal, Loc);
3589     auto UBFI = std::next(KmpTaskTQTyRD->field_begin(), KmpTaskTUpperBound);
3590     LValue UBLVal = CGF.EmitLValueForField(Base, *UBFI);
3591     llvm::Value *UBParam = CGF.EmitLoadOfScalar(UBLVal, Loc);
3592     auto StFI = std::next(KmpTaskTQTyRD->field_begin(), KmpTaskTStride);
3593     LValue StLVal = CGF.EmitLValueForField(Base, *StFI);
3594     llvm::Value *StParam = CGF.EmitLoadOfScalar(StLVal, Loc);
3595     auto LIFI = std::next(KmpTaskTQTyRD->field_begin(), KmpTaskTLastIter);
3596     LValue LILVal = CGF.EmitLValueForField(Base, *LIFI);
3597     llvm::Value *LIParam = CGF.EmitLoadOfScalar(LILVal, Loc);
3598     auto RFI = std::next(KmpTaskTQTyRD->field_begin(), KmpTaskTReductions);
3599     LValue RLVal = CGF.EmitLValueForField(Base, *RFI);
3600     llvm::Value *RParam = CGF.EmitLoadOfScalar(RLVal, Loc);
3601     CallArgs.push_back(LBParam);
3602     CallArgs.push_back(UBParam);
3603     CallArgs.push_back(StParam);
3604     CallArgs.push_back(LIParam);
3605     CallArgs.push_back(RParam);
3606   }
3607   CallArgs.push_back(SharedsParam);
3608 
3609   CGM.getOpenMPRuntime().emitOutlinedFunctionCall(CGF, Loc, TaskFunction,
3610                                                   CallArgs);
3611   CGF.EmitStoreThroughLValue(RValue::get(CGF.Builder.getInt32(/*C=*/0)),
3612                              CGF.MakeAddrLValue(CGF.ReturnValue, KmpInt32Ty));
3613   CGF.FinishFunction();
3614   return TaskEntry;
3615 }
3616 
3617 static llvm::Value *emitDestructorsFunction(CodeGenModule &CGM,
3618                                             SourceLocation Loc,
3619                                             QualType KmpInt32Ty,
3620                                             QualType KmpTaskTWithPrivatesPtrQTy,
3621                                             QualType KmpTaskTWithPrivatesQTy) {
3622   ASTContext &C = CGM.getContext();
3623   FunctionArgList Args;
3624   ImplicitParamDecl GtidArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, KmpInt32Ty,
3625                             ImplicitParamDecl::Other);
3626   ImplicitParamDecl TaskTypeArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr,
3627                                 KmpTaskTWithPrivatesPtrQTy.withRestrict(),
3628                                 ImplicitParamDecl::Other);
3629   Args.push_back(&GtidArg);
3630   Args.push_back(&TaskTypeArg);
3631   const auto &DestructorFnInfo =
3632       CGM.getTypes().arrangeBuiltinFunctionDeclaration(KmpInt32Ty, Args);
3633   llvm::FunctionType *DestructorFnTy =
3634       CGM.getTypes().GetFunctionType(DestructorFnInfo);
3635   std::string Name =
3636       CGM.getOpenMPRuntime().getName({"omp_task_destructor", ""});
3637   auto *DestructorFn =
3638       llvm::Function::Create(DestructorFnTy, llvm::GlobalValue::InternalLinkage,
3639                              Name, &CGM.getModule());
3640   CGM.SetInternalFunctionAttributes(GlobalDecl(), DestructorFn,
3641                                     DestructorFnInfo);
3642   DestructorFn->setDoesNotRecurse();
3643   CodeGenFunction CGF(CGM);
3644   CGF.StartFunction(GlobalDecl(), KmpInt32Ty, DestructorFn, DestructorFnInfo,
3645                     Args, Loc, Loc);
3646 
3647   LValue Base = CGF.EmitLoadOfPointerLValue(
3648       CGF.GetAddrOfLocalVar(&TaskTypeArg),
3649       KmpTaskTWithPrivatesPtrQTy->castAs<PointerType>());
3650   const auto *KmpTaskTWithPrivatesQTyRD =
3651       cast<RecordDecl>(KmpTaskTWithPrivatesQTy->getAsTagDecl());
3652   auto FI = std::next(KmpTaskTWithPrivatesQTyRD->field_begin());
3653   Base = CGF.EmitLValueForField(Base, *FI);
3654   for (const auto *Field :
3655        cast<RecordDecl>(FI->getType()->getAsTagDecl())->fields()) {
3656     if (QualType::DestructionKind DtorKind =
3657             Field->getType().isDestructedType()) {
3658       LValue FieldLValue = CGF.EmitLValueForField(Base, Field);
3659       CGF.pushDestroy(DtorKind, FieldLValue.getAddress(CGF), Field->getType());
3660     }
3661   }
3662   CGF.FinishFunction();
3663   return DestructorFn;
3664 }
3665 
3666 /// Emit a privates mapping function for correct handling of private and
3667 /// firstprivate variables.
3668 /// \code
3669 /// void .omp_task_privates_map.(const .privates. *noalias privs, <ty1>
3670 /// **noalias priv1,...,  <tyn> **noalias privn) {
3671 ///   *priv1 = &.privates.priv1;
3672 ///   ...;
3673 ///   *privn = &.privates.privn;
3674 /// }
3675 /// \endcode
3676 static llvm::Value *
3677 emitTaskPrivateMappingFunction(CodeGenModule &CGM, SourceLocation Loc,
3678                                const OMPTaskDataTy &Data, QualType PrivatesQTy,
3679                                ArrayRef<PrivateDataTy> Privates) {
3680   ASTContext &C = CGM.getContext();
3681   FunctionArgList Args;
3682   ImplicitParamDecl TaskPrivatesArg(
3683       C, /*DC=*/nullptr, Loc, /*Id=*/nullptr,
3684       C.getPointerType(PrivatesQTy).withConst().withRestrict(),
3685       ImplicitParamDecl::Other);
3686   Args.push_back(&TaskPrivatesArg);
3687   llvm::DenseMap<CanonicalDeclPtr<const VarDecl>, unsigned> PrivateVarsPos;
3688   unsigned Counter = 1;
3689   for (const Expr *E : Data.PrivateVars) {
3690     Args.push_back(ImplicitParamDecl::Create(
3691         C, /*DC=*/nullptr, Loc, /*Id=*/nullptr,
3692         C.getPointerType(C.getPointerType(E->getType()))
3693             .withConst()
3694             .withRestrict(),
3695         ImplicitParamDecl::Other));
3696     const auto *VD = cast<VarDecl>(cast<DeclRefExpr>(E)->getDecl());
3697     PrivateVarsPos[VD] = Counter;
3698     ++Counter;
3699   }
3700   for (const Expr *E : Data.FirstprivateVars) {
3701     Args.push_back(ImplicitParamDecl::Create(
3702         C, /*DC=*/nullptr, Loc, /*Id=*/nullptr,
3703         C.getPointerType(C.getPointerType(E->getType()))
3704             .withConst()
3705             .withRestrict(),
3706         ImplicitParamDecl::Other));
3707     const auto *VD = cast<VarDecl>(cast<DeclRefExpr>(E)->getDecl());
3708     PrivateVarsPos[VD] = Counter;
3709     ++Counter;
3710   }
3711   for (const Expr *E : Data.LastprivateVars) {
3712     Args.push_back(ImplicitParamDecl::Create(
3713         C, /*DC=*/nullptr, Loc, /*Id=*/nullptr,
3714         C.getPointerType(C.getPointerType(E->getType()))
3715             .withConst()
3716             .withRestrict(),
3717         ImplicitParamDecl::Other));
3718     const auto *VD = cast<VarDecl>(cast<DeclRefExpr>(E)->getDecl());
3719     PrivateVarsPos[VD] = Counter;
3720     ++Counter;
3721   }
3722   for (const VarDecl *VD : Data.PrivateLocals) {
3723     QualType Ty = VD->getType().getNonReferenceType();
3724     if (VD->getType()->isLValueReferenceType())
3725       Ty = C.getPointerType(Ty);
3726     if (isAllocatableDecl(VD))
3727       Ty = C.getPointerType(Ty);
3728     Args.push_back(ImplicitParamDecl::Create(
3729         C, /*DC=*/nullptr, Loc, /*Id=*/nullptr,
3730         C.getPointerType(C.getPointerType(Ty)).withConst().withRestrict(),
3731         ImplicitParamDecl::Other));
3732     PrivateVarsPos[VD] = Counter;
3733     ++Counter;
3734   }
3735   const auto &TaskPrivatesMapFnInfo =
3736       CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, Args);
3737   llvm::FunctionType *TaskPrivatesMapTy =
3738       CGM.getTypes().GetFunctionType(TaskPrivatesMapFnInfo);
3739   std::string Name =
3740       CGM.getOpenMPRuntime().getName({"omp_task_privates_map", ""});
3741   auto *TaskPrivatesMap = llvm::Function::Create(
3742       TaskPrivatesMapTy, llvm::GlobalValue::InternalLinkage, Name,
3743       &CGM.getModule());
3744   CGM.SetInternalFunctionAttributes(GlobalDecl(), TaskPrivatesMap,
3745                                     TaskPrivatesMapFnInfo);
3746   if (CGM.getLangOpts().Optimize) {
3747     TaskPrivatesMap->removeFnAttr(llvm::Attribute::NoInline);
3748     TaskPrivatesMap->removeFnAttr(llvm::Attribute::OptimizeNone);
3749     TaskPrivatesMap->addFnAttr(llvm::Attribute::AlwaysInline);
3750   }
3751   CodeGenFunction CGF(CGM);
3752   CGF.StartFunction(GlobalDecl(), C.VoidTy, TaskPrivatesMap,
3753                     TaskPrivatesMapFnInfo, Args, Loc, Loc);
3754 
3755   // *privi = &.privates.privi;
3756   LValue Base = CGF.EmitLoadOfPointerLValue(
3757       CGF.GetAddrOfLocalVar(&TaskPrivatesArg),
3758       TaskPrivatesArg.getType()->castAs<PointerType>());
3759   const auto *PrivatesQTyRD = cast<RecordDecl>(PrivatesQTy->getAsTagDecl());
3760   Counter = 0;
3761   for (const FieldDecl *Field : PrivatesQTyRD->fields()) {
3762     LValue FieldLVal = CGF.EmitLValueForField(Base, Field);
3763     const VarDecl *VD = Args[PrivateVarsPos[Privates[Counter].second.Original]];
3764     LValue RefLVal =
3765         CGF.MakeAddrLValue(CGF.GetAddrOfLocalVar(VD), VD->getType());
3766     LValue RefLoadLVal = CGF.EmitLoadOfPointerLValue(
3767         RefLVal.getAddress(CGF), RefLVal.getType()->castAs<PointerType>());
3768     CGF.EmitStoreOfScalar(FieldLVal.getPointer(CGF), RefLoadLVal);
3769     ++Counter;
3770   }
3771   CGF.FinishFunction();
3772   return TaskPrivatesMap;
3773 }
3774 
3775 /// Emit initialization for private variables in task-based directives.
3776 static void emitPrivatesInit(CodeGenFunction &CGF,
3777                              const OMPExecutableDirective &D,
3778                              Address KmpTaskSharedsPtr, LValue TDBase,
3779                              const RecordDecl *KmpTaskTWithPrivatesQTyRD,
3780                              QualType SharedsTy, QualType SharedsPtrTy,
3781                              const OMPTaskDataTy &Data,
3782                              ArrayRef<PrivateDataTy> Privates, bool ForDup) {
3783   ASTContext &C = CGF.getContext();
3784   auto FI = std::next(KmpTaskTWithPrivatesQTyRD->field_begin());
3785   LValue PrivatesBase = CGF.EmitLValueForField(TDBase, *FI);
3786   OpenMPDirectiveKind Kind = isOpenMPTaskLoopDirective(D.getDirectiveKind())
3787                                  ? OMPD_taskloop
3788                                  : OMPD_task;
3789   const CapturedStmt &CS = *D.getCapturedStmt(Kind);
3790   CodeGenFunction::CGCapturedStmtInfo CapturesInfo(CS);
3791   LValue SrcBase;
3792   bool IsTargetTask =
3793       isOpenMPTargetDataManagementDirective(D.getDirectiveKind()) ||
3794       isOpenMPTargetExecutionDirective(D.getDirectiveKind());
3795   // For target-based directives skip 4 firstprivate arrays BasePointersArray,
3796   // PointersArray, SizesArray, and MappersArray. The original variables for
3797   // these arrays are not captured and we get their addresses explicitly.
3798   if ((!IsTargetTask && !Data.FirstprivateVars.empty() && ForDup) ||
3799       (IsTargetTask && KmpTaskSharedsPtr.isValid())) {
3800     SrcBase = CGF.MakeAddrLValue(
3801         CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
3802             KmpTaskSharedsPtr, CGF.ConvertTypeForMem(SharedsPtrTy)),
3803         SharedsTy);
3804   }
3805   FI = cast<RecordDecl>(FI->getType()->getAsTagDecl())->field_begin();
3806   for (const PrivateDataTy &Pair : Privates) {
3807     // Do not initialize private locals.
3808     if (Pair.second.isLocalPrivate()) {
3809       ++FI;
3810       continue;
3811     }
3812     const VarDecl *VD = Pair.second.PrivateCopy;
3813     const Expr *Init = VD->getAnyInitializer();
3814     if (Init && (!ForDup || (isa<CXXConstructExpr>(Init) &&
3815                              !CGF.isTrivialInitializer(Init)))) {
3816       LValue PrivateLValue = CGF.EmitLValueForField(PrivatesBase, *FI);
3817       if (const VarDecl *Elem = Pair.second.PrivateElemInit) {
3818         const VarDecl *OriginalVD = Pair.second.Original;
3819         // Check if the variable is the target-based BasePointersArray,
3820         // PointersArray, SizesArray, or MappersArray.
3821         LValue SharedRefLValue;
3822         QualType Type = PrivateLValue.getType();
3823         const FieldDecl *SharedField = CapturesInfo.lookup(OriginalVD);
3824         if (IsTargetTask && !SharedField) {
3825           assert(isa<ImplicitParamDecl>(OriginalVD) &&
3826                  isa<CapturedDecl>(OriginalVD->getDeclContext()) &&
3827                  cast<CapturedDecl>(OriginalVD->getDeclContext())
3828                          ->getNumParams() == 0 &&
3829                  isa<TranslationUnitDecl>(
3830                      cast<CapturedDecl>(OriginalVD->getDeclContext())
3831                          ->getDeclContext()) &&
3832                  "Expected artificial target data variable.");
3833           SharedRefLValue =
3834               CGF.MakeAddrLValue(CGF.GetAddrOfLocalVar(OriginalVD), Type);
3835         } else if (ForDup) {
3836           SharedRefLValue = CGF.EmitLValueForField(SrcBase, SharedField);
3837           SharedRefLValue = CGF.MakeAddrLValue(
3838               Address(SharedRefLValue.getPointer(CGF),
3839                       C.getDeclAlign(OriginalVD)),
3840               SharedRefLValue.getType(), LValueBaseInfo(AlignmentSource::Decl),
3841               SharedRefLValue.getTBAAInfo());
3842         } else if (CGF.LambdaCaptureFields.count(
3843                        Pair.second.Original->getCanonicalDecl()) > 0 ||
3844                    dyn_cast_or_null<BlockDecl>(CGF.CurCodeDecl)) {
3845           SharedRefLValue = CGF.EmitLValue(Pair.second.OriginalRef);
3846         } else {
3847           // Processing for implicitly captured variables.
3848           InlinedOpenMPRegionRAII Region(
3849               CGF, [](CodeGenFunction &, PrePostActionTy &) {}, OMPD_unknown,
3850               /*HasCancel=*/false);
3851           SharedRefLValue = CGF.EmitLValue(Pair.second.OriginalRef);
3852         }
3853         if (Type->isArrayType()) {
3854           // Initialize firstprivate array.
3855           if (!isa<CXXConstructExpr>(Init) || CGF.isTrivialInitializer(Init)) {
3856             // Perform simple memcpy.
3857             CGF.EmitAggregateAssign(PrivateLValue, SharedRefLValue, Type);
3858           } else {
3859             // Initialize firstprivate array using element-by-element
3860             // initialization.
3861             CGF.EmitOMPAggregateAssign(
3862                 PrivateLValue.getAddress(CGF), SharedRefLValue.getAddress(CGF),
3863                 Type,
3864                 [&CGF, Elem, Init, &CapturesInfo](Address DestElement,
3865                                                   Address SrcElement) {
3866                   // Clean up any temporaries needed by the initialization.
3867                   CodeGenFunction::OMPPrivateScope InitScope(CGF);
3868                   InitScope.addPrivate(
3869                       Elem, [SrcElement]() -> Address { return SrcElement; });
3870                   (void)InitScope.Privatize();
3871                   // Emit initialization for single element.
3872                   CodeGenFunction::CGCapturedStmtRAII CapInfoRAII(
3873                       CGF, &CapturesInfo);
3874                   CGF.EmitAnyExprToMem(Init, DestElement,
3875                                        Init->getType().getQualifiers(),
3876                                        /*IsInitializer=*/false);
3877                 });
3878           }
3879         } else {
3880           CodeGenFunction::OMPPrivateScope InitScope(CGF);
3881           InitScope.addPrivate(Elem, [SharedRefLValue, &CGF]() -> Address {
3882             return SharedRefLValue.getAddress(CGF);
3883           });
3884           (void)InitScope.Privatize();
3885           CodeGenFunction::CGCapturedStmtRAII CapInfoRAII(CGF, &CapturesInfo);
3886           CGF.EmitExprAsInit(Init, VD, PrivateLValue,
3887                              /*capturedByInit=*/false);
3888         }
3889       } else {
3890         CGF.EmitExprAsInit(Init, VD, PrivateLValue, /*capturedByInit=*/false);
3891       }
3892     }
3893     ++FI;
3894   }
3895 }
3896 
3897 /// Check if duplication function is required for taskloops.
3898 static bool checkInitIsRequired(CodeGenFunction &CGF,
3899                                 ArrayRef<PrivateDataTy> Privates) {
3900   bool InitRequired = false;
3901   for (const PrivateDataTy &Pair : Privates) {
3902     if (Pair.second.isLocalPrivate())
3903       continue;
3904     const VarDecl *VD = Pair.second.PrivateCopy;
3905     const Expr *Init = VD->getAnyInitializer();
3906     InitRequired = InitRequired || (Init && isa<CXXConstructExpr>(Init) &&
3907                                     !CGF.isTrivialInitializer(Init));
3908     if (InitRequired)
3909       break;
3910   }
3911   return InitRequired;
3912 }
3913 
3914 
3915 /// Emit task_dup function (for initialization of
3916 /// private/firstprivate/lastprivate vars and last_iter flag)
3917 /// \code
3918 /// void __task_dup_entry(kmp_task_t *task_dst, const kmp_task_t *task_src, int
3919 /// lastpriv) {
3920 /// // setup lastprivate flag
3921 ///    task_dst->last = lastpriv;
3922 /// // could be constructor calls here...
3923 /// }
3924 /// \endcode
3925 static llvm::Value *
3926 emitTaskDupFunction(CodeGenModule &CGM, SourceLocation Loc,
3927                     const OMPExecutableDirective &D,
3928                     QualType KmpTaskTWithPrivatesPtrQTy,
3929                     const RecordDecl *KmpTaskTWithPrivatesQTyRD,
3930                     const RecordDecl *KmpTaskTQTyRD, QualType SharedsTy,
3931                     QualType SharedsPtrTy, const OMPTaskDataTy &Data,
3932                     ArrayRef<PrivateDataTy> Privates, bool WithLastIter) {
3933   ASTContext &C = CGM.getContext();
3934   FunctionArgList Args;
3935   ImplicitParamDecl DstArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr,
3936                            KmpTaskTWithPrivatesPtrQTy,
3937                            ImplicitParamDecl::Other);
3938   ImplicitParamDecl SrcArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr,
3939                            KmpTaskTWithPrivatesPtrQTy,
3940                            ImplicitParamDecl::Other);
3941   ImplicitParamDecl LastprivArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, C.IntTy,
3942                                 ImplicitParamDecl::Other);
3943   Args.push_back(&DstArg);
3944   Args.push_back(&SrcArg);
3945   Args.push_back(&LastprivArg);
3946   const auto &TaskDupFnInfo =
3947       CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, Args);
3948   llvm::FunctionType *TaskDupTy = CGM.getTypes().GetFunctionType(TaskDupFnInfo);
3949   std::string Name = CGM.getOpenMPRuntime().getName({"omp_task_dup", ""});
3950   auto *TaskDup = llvm::Function::Create(
3951       TaskDupTy, llvm::GlobalValue::InternalLinkage, Name, &CGM.getModule());
3952   CGM.SetInternalFunctionAttributes(GlobalDecl(), TaskDup, TaskDupFnInfo);
3953   TaskDup->setDoesNotRecurse();
3954   CodeGenFunction CGF(CGM);
3955   CGF.StartFunction(GlobalDecl(), C.VoidTy, TaskDup, TaskDupFnInfo, Args, Loc,
3956                     Loc);
3957 
3958   LValue TDBase = CGF.EmitLoadOfPointerLValue(
3959       CGF.GetAddrOfLocalVar(&DstArg),
3960       KmpTaskTWithPrivatesPtrQTy->castAs<PointerType>());
3961   // task_dst->liter = lastpriv;
3962   if (WithLastIter) {
3963     auto LIFI = std::next(KmpTaskTQTyRD->field_begin(), KmpTaskTLastIter);
3964     LValue Base = CGF.EmitLValueForField(
3965         TDBase, *KmpTaskTWithPrivatesQTyRD->field_begin());
3966     LValue LILVal = CGF.EmitLValueForField(Base, *LIFI);
3967     llvm::Value *Lastpriv = CGF.EmitLoadOfScalar(
3968         CGF.GetAddrOfLocalVar(&LastprivArg), /*Volatile=*/false, C.IntTy, Loc);
3969     CGF.EmitStoreOfScalar(Lastpriv, LILVal);
3970   }
3971 
3972   // Emit initial values for private copies (if any).
3973   assert(!Privates.empty());
3974   Address KmpTaskSharedsPtr = Address::invalid();
3975   if (!Data.FirstprivateVars.empty()) {
3976     LValue TDBase = CGF.EmitLoadOfPointerLValue(
3977         CGF.GetAddrOfLocalVar(&SrcArg),
3978         KmpTaskTWithPrivatesPtrQTy->castAs<PointerType>());
3979     LValue Base = CGF.EmitLValueForField(
3980         TDBase, *KmpTaskTWithPrivatesQTyRD->field_begin());
3981     KmpTaskSharedsPtr = Address(
3982         CGF.EmitLoadOfScalar(CGF.EmitLValueForField(
3983                                  Base, *std::next(KmpTaskTQTyRD->field_begin(),
3984                                                   KmpTaskTShareds)),
3985                              Loc),
3986         CGM.getNaturalTypeAlignment(SharedsTy));
3987   }
3988   emitPrivatesInit(CGF, D, KmpTaskSharedsPtr, TDBase, KmpTaskTWithPrivatesQTyRD,
3989                    SharedsTy, SharedsPtrTy, Data, Privates, /*ForDup=*/true);
3990   CGF.FinishFunction();
3991   return TaskDup;
3992 }
3993 
3994 /// Checks if destructor function is required to be generated.
3995 /// \return true if cleanups are required, false otherwise.
3996 static bool
3997 checkDestructorsRequired(const RecordDecl *KmpTaskTWithPrivatesQTyRD,
3998                          ArrayRef<PrivateDataTy> Privates) {
3999   for (const PrivateDataTy &P : Privates) {
4000     if (P.second.isLocalPrivate())
4001       continue;
4002     QualType Ty = P.second.Original->getType().getNonReferenceType();
4003     if (Ty.isDestructedType())
4004       return true;
4005   }
4006   return false;
4007 }
4008 
4009 namespace {
4010 /// Loop generator for OpenMP iterator expression.
4011 class OMPIteratorGeneratorScope final
4012     : public CodeGenFunction::OMPPrivateScope {
4013   CodeGenFunction &CGF;
4014   const OMPIteratorExpr *E = nullptr;
4015   SmallVector<CodeGenFunction::JumpDest, 4> ContDests;
4016   SmallVector<CodeGenFunction::JumpDest, 4> ExitDests;
4017   OMPIteratorGeneratorScope() = delete;
4018   OMPIteratorGeneratorScope(OMPIteratorGeneratorScope &) = delete;
4019 
4020 public:
4021   OMPIteratorGeneratorScope(CodeGenFunction &CGF, const OMPIteratorExpr *E)
4022       : CodeGenFunction::OMPPrivateScope(CGF), CGF(CGF), E(E) {
4023     if (!E)
4024       return;
4025     SmallVector<llvm::Value *, 4> Uppers;
4026     for (unsigned I = 0, End = E->numOfIterators(); I < End; ++I) {
4027       Uppers.push_back(CGF.EmitScalarExpr(E->getHelper(I).Upper));
4028       const auto *VD = cast<VarDecl>(E->getIteratorDecl(I));
4029       addPrivate(VD, [&CGF, VD]() {
4030         return CGF.CreateMemTemp(VD->getType(), VD->getName());
4031       });
4032       const OMPIteratorHelperData &HelperData = E->getHelper(I);
4033       addPrivate(HelperData.CounterVD, [&CGF, &HelperData]() {
4034         return CGF.CreateMemTemp(HelperData.CounterVD->getType(),
4035                                  "counter.addr");
4036       });
4037     }
4038     Privatize();
4039 
4040     for (unsigned I = 0, End = E->numOfIterators(); I < End; ++I) {
4041       const OMPIteratorHelperData &HelperData = E->getHelper(I);
4042       LValue CLVal =
4043           CGF.MakeAddrLValue(CGF.GetAddrOfLocalVar(HelperData.CounterVD),
4044                              HelperData.CounterVD->getType());
4045       // Counter = 0;
4046       CGF.EmitStoreOfScalar(
4047           llvm::ConstantInt::get(CLVal.getAddress(CGF).getElementType(), 0),
4048           CLVal);
4049       CodeGenFunction::JumpDest &ContDest =
4050           ContDests.emplace_back(CGF.getJumpDestInCurrentScope("iter.cont"));
4051       CodeGenFunction::JumpDest &ExitDest =
4052           ExitDests.emplace_back(CGF.getJumpDestInCurrentScope("iter.exit"));
4053       // N = <number-of_iterations>;
4054       llvm::Value *N = Uppers[I];
4055       // cont:
4056       // if (Counter < N) goto body; else goto exit;
4057       CGF.EmitBlock(ContDest.getBlock());
4058       auto *CVal =
4059           CGF.EmitLoadOfScalar(CLVal, HelperData.CounterVD->getLocation());
4060       llvm::Value *Cmp =
4061           HelperData.CounterVD->getType()->isSignedIntegerOrEnumerationType()
4062               ? CGF.Builder.CreateICmpSLT(CVal, N)
4063               : CGF.Builder.CreateICmpULT(CVal, N);
4064       llvm::BasicBlock *BodyBB = CGF.createBasicBlock("iter.body");
4065       CGF.Builder.CreateCondBr(Cmp, BodyBB, ExitDest.getBlock());
4066       // body:
4067       CGF.EmitBlock(BodyBB);
4068       // Iteri = Begini + Counter * Stepi;
4069       CGF.EmitIgnoredExpr(HelperData.Update);
4070     }
4071   }
4072   ~OMPIteratorGeneratorScope() {
4073     if (!E)
4074       return;
4075     for (unsigned I = E->numOfIterators(); I > 0; --I) {
4076       // Counter = Counter + 1;
4077       const OMPIteratorHelperData &HelperData = E->getHelper(I - 1);
4078       CGF.EmitIgnoredExpr(HelperData.CounterUpdate);
4079       // goto cont;
4080       CGF.EmitBranchThroughCleanup(ContDests[I - 1]);
4081       // exit:
4082       CGF.EmitBlock(ExitDests[I - 1].getBlock(), /*IsFinished=*/I == 1);
4083     }
4084   }
4085 };
4086 } // namespace
4087 
4088 static std::pair<llvm::Value *, llvm::Value *>
4089 getPointerAndSize(CodeGenFunction &CGF, const Expr *E) {
4090   const auto *OASE = dyn_cast<OMPArrayShapingExpr>(E);
4091   llvm::Value *Addr;
4092   if (OASE) {
4093     const Expr *Base = OASE->getBase();
4094     Addr = CGF.EmitScalarExpr(Base);
4095   } else {
4096     Addr = CGF.EmitLValue(E).getPointer(CGF);
4097   }
4098   llvm::Value *SizeVal;
4099   QualType Ty = E->getType();
4100   if (OASE) {
4101     SizeVal = CGF.getTypeSize(OASE->getBase()->getType()->getPointeeType());
4102     for (const Expr *SE : OASE->getDimensions()) {
4103       llvm::Value *Sz = CGF.EmitScalarExpr(SE);
4104       Sz = CGF.EmitScalarConversion(
4105           Sz, SE->getType(), CGF.getContext().getSizeType(), SE->getExprLoc());
4106       SizeVal = CGF.Builder.CreateNUWMul(SizeVal, Sz);
4107     }
4108   } else if (const auto *ASE =
4109                  dyn_cast<OMPArraySectionExpr>(E->IgnoreParenImpCasts())) {
4110     LValue UpAddrLVal =
4111         CGF.EmitOMPArraySectionExpr(ASE, /*IsLowerBound=*/false);
4112     llvm::Value *UpAddr =
4113         CGF.Builder.CreateConstGEP1_32(UpAddrLVal.getPointer(CGF), /*Idx0=*/1);
4114     llvm::Value *LowIntPtr = CGF.Builder.CreatePtrToInt(Addr, CGF.SizeTy);
4115     llvm::Value *UpIntPtr = CGF.Builder.CreatePtrToInt(UpAddr, CGF.SizeTy);
4116     SizeVal = CGF.Builder.CreateNUWSub(UpIntPtr, LowIntPtr);
4117   } else {
4118     SizeVal = CGF.getTypeSize(Ty);
4119   }
4120   return std::make_pair(Addr, SizeVal);
4121 }
4122 
4123 /// Builds kmp_depend_info, if it is not built yet, and builds flags type.
4124 static void getKmpAffinityType(ASTContext &C, QualType &KmpTaskAffinityInfoTy) {
4125   QualType FlagsTy = C.getIntTypeForBitwidth(32, /*Signed=*/false);
4126   if (KmpTaskAffinityInfoTy.isNull()) {
4127     RecordDecl *KmpAffinityInfoRD =
4128         C.buildImplicitRecord("kmp_task_affinity_info_t");
4129     KmpAffinityInfoRD->startDefinition();
4130     addFieldToRecordDecl(C, KmpAffinityInfoRD, C.getIntPtrType());
4131     addFieldToRecordDecl(C, KmpAffinityInfoRD, C.getSizeType());
4132     addFieldToRecordDecl(C, KmpAffinityInfoRD, FlagsTy);
4133     KmpAffinityInfoRD->completeDefinition();
4134     KmpTaskAffinityInfoTy = C.getRecordType(KmpAffinityInfoRD);
4135   }
4136 }
4137 
4138 CGOpenMPRuntime::TaskResultTy
4139 CGOpenMPRuntime::emitTaskInit(CodeGenFunction &CGF, SourceLocation Loc,
4140                               const OMPExecutableDirective &D,
4141                               llvm::Function *TaskFunction, QualType SharedsTy,
4142                               Address Shareds, const OMPTaskDataTy &Data) {
4143   ASTContext &C = CGM.getContext();
4144   llvm::SmallVector<PrivateDataTy, 4> Privates;
4145   // Aggregate privates and sort them by the alignment.
4146   const auto *I = Data.PrivateCopies.begin();
4147   for (const Expr *E : Data.PrivateVars) {
4148     const auto *VD = cast<VarDecl>(cast<DeclRefExpr>(E)->getDecl());
4149     Privates.emplace_back(
4150         C.getDeclAlign(VD),
4151         PrivateHelpersTy(E, VD, cast<VarDecl>(cast<DeclRefExpr>(*I)->getDecl()),
4152                          /*PrivateElemInit=*/nullptr));
4153     ++I;
4154   }
4155   I = Data.FirstprivateCopies.begin();
4156   const auto *IElemInitRef = Data.FirstprivateInits.begin();
4157   for (const Expr *E : Data.FirstprivateVars) {
4158     const auto *VD = cast<VarDecl>(cast<DeclRefExpr>(E)->getDecl());
4159     Privates.emplace_back(
4160         C.getDeclAlign(VD),
4161         PrivateHelpersTy(
4162             E, VD, cast<VarDecl>(cast<DeclRefExpr>(*I)->getDecl()),
4163             cast<VarDecl>(cast<DeclRefExpr>(*IElemInitRef)->getDecl())));
4164     ++I;
4165     ++IElemInitRef;
4166   }
4167   I = Data.LastprivateCopies.begin();
4168   for (const Expr *E : Data.LastprivateVars) {
4169     const auto *VD = cast<VarDecl>(cast<DeclRefExpr>(E)->getDecl());
4170     Privates.emplace_back(
4171         C.getDeclAlign(VD),
4172         PrivateHelpersTy(E, VD, cast<VarDecl>(cast<DeclRefExpr>(*I)->getDecl()),
4173                          /*PrivateElemInit=*/nullptr));
4174     ++I;
4175   }
4176   for (const VarDecl *VD : Data.PrivateLocals) {
4177     if (isAllocatableDecl(VD))
4178       Privates.emplace_back(CGM.getPointerAlign(), PrivateHelpersTy(VD));
4179     else
4180       Privates.emplace_back(C.getDeclAlign(VD), PrivateHelpersTy(VD));
4181   }
4182   llvm::stable_sort(Privates,
4183                     [](const PrivateDataTy &L, const PrivateDataTy &R) {
4184                       return L.first > R.first;
4185                     });
4186   QualType KmpInt32Ty = C.getIntTypeForBitwidth(/*DestWidth=*/32, /*Signed=*/1);
4187   // Build type kmp_routine_entry_t (if not built yet).
4188   emitKmpRoutineEntryT(KmpInt32Ty);
4189   // Build type kmp_task_t (if not built yet).
4190   if (isOpenMPTaskLoopDirective(D.getDirectiveKind())) {
4191     if (SavedKmpTaskloopTQTy.isNull()) {
4192       SavedKmpTaskloopTQTy = C.getRecordType(createKmpTaskTRecordDecl(
4193           CGM, D.getDirectiveKind(), KmpInt32Ty, KmpRoutineEntryPtrQTy));
4194     }
4195     KmpTaskTQTy = SavedKmpTaskloopTQTy;
4196   } else {
4197     assert((D.getDirectiveKind() == OMPD_task ||
4198             isOpenMPTargetExecutionDirective(D.getDirectiveKind()) ||
4199             isOpenMPTargetDataManagementDirective(D.getDirectiveKind())) &&
4200            "Expected taskloop, task or target directive");
4201     if (SavedKmpTaskTQTy.isNull()) {
4202       SavedKmpTaskTQTy = C.getRecordType(createKmpTaskTRecordDecl(
4203           CGM, D.getDirectiveKind(), KmpInt32Ty, KmpRoutineEntryPtrQTy));
4204     }
4205     KmpTaskTQTy = SavedKmpTaskTQTy;
4206   }
4207   const auto *KmpTaskTQTyRD = cast<RecordDecl>(KmpTaskTQTy->getAsTagDecl());
4208   // Build particular struct kmp_task_t for the given task.
4209   const RecordDecl *KmpTaskTWithPrivatesQTyRD =
4210       createKmpTaskTWithPrivatesRecordDecl(CGM, KmpTaskTQTy, Privates);
4211   QualType KmpTaskTWithPrivatesQTy = C.getRecordType(KmpTaskTWithPrivatesQTyRD);
4212   QualType KmpTaskTWithPrivatesPtrQTy =
4213       C.getPointerType(KmpTaskTWithPrivatesQTy);
4214   llvm::Type *KmpTaskTWithPrivatesTy = CGF.ConvertType(KmpTaskTWithPrivatesQTy);
4215   llvm::Type *KmpTaskTWithPrivatesPtrTy =
4216       KmpTaskTWithPrivatesTy->getPointerTo();
4217   llvm::Value *KmpTaskTWithPrivatesTySize =
4218       CGF.getTypeSize(KmpTaskTWithPrivatesQTy);
4219   QualType SharedsPtrTy = C.getPointerType(SharedsTy);
4220 
4221   // Emit initial values for private copies (if any).
4222   llvm::Value *TaskPrivatesMap = nullptr;
4223   llvm::Type *TaskPrivatesMapTy =
4224       std::next(TaskFunction->arg_begin(), 3)->getType();
4225   if (!Privates.empty()) {
4226     auto FI = std::next(KmpTaskTWithPrivatesQTyRD->field_begin());
4227     TaskPrivatesMap =
4228         emitTaskPrivateMappingFunction(CGM, Loc, Data, FI->getType(), Privates);
4229     TaskPrivatesMap = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
4230         TaskPrivatesMap, TaskPrivatesMapTy);
4231   } else {
4232     TaskPrivatesMap = llvm::ConstantPointerNull::get(
4233         cast<llvm::PointerType>(TaskPrivatesMapTy));
4234   }
4235   // Build a proxy function kmp_int32 .omp_task_entry.(kmp_int32 gtid,
4236   // kmp_task_t *tt);
4237   llvm::Function *TaskEntry = emitProxyTaskFunction(
4238       CGM, Loc, D.getDirectiveKind(), KmpInt32Ty, KmpTaskTWithPrivatesPtrQTy,
4239       KmpTaskTWithPrivatesQTy, KmpTaskTQTy, SharedsPtrTy, TaskFunction,
4240       TaskPrivatesMap);
4241 
4242   // Build call kmp_task_t * __kmpc_omp_task_alloc(ident_t *, kmp_int32 gtid,
4243   // kmp_int32 flags, size_t sizeof_kmp_task_t, size_t sizeof_shareds,
4244   // kmp_routine_entry_t *task_entry);
4245   // Task flags. Format is taken from
4246   // https://github.com/llvm/llvm-project/blob/master/openmp/runtime/src/kmp.h,
4247   // description of kmp_tasking_flags struct.
4248   enum {
4249     TiedFlag = 0x1,
4250     FinalFlag = 0x2,
4251     DestructorsFlag = 0x8,
4252     PriorityFlag = 0x20,
4253     DetachableFlag = 0x40,
4254   };
4255   unsigned Flags = Data.Tied ? TiedFlag : 0;
4256   bool NeedsCleanup = false;
4257   if (!Privates.empty()) {
4258     NeedsCleanup =
4259         checkDestructorsRequired(KmpTaskTWithPrivatesQTyRD, Privates);
4260     if (NeedsCleanup)
4261       Flags = Flags | DestructorsFlag;
4262   }
4263   if (Data.Priority.getInt())
4264     Flags = Flags | PriorityFlag;
4265   if (D.hasClausesOfKind<OMPDetachClause>())
4266     Flags = Flags | DetachableFlag;
4267   llvm::Value *TaskFlags =
4268       Data.Final.getPointer()
4269           ? CGF.Builder.CreateSelect(Data.Final.getPointer(),
4270                                      CGF.Builder.getInt32(FinalFlag),
4271                                      CGF.Builder.getInt32(/*C=*/0))
4272           : CGF.Builder.getInt32(Data.Final.getInt() ? FinalFlag : 0);
4273   TaskFlags = CGF.Builder.CreateOr(TaskFlags, CGF.Builder.getInt32(Flags));
4274   llvm::Value *SharedsSize = CGM.getSize(C.getTypeSizeInChars(SharedsTy));
4275   SmallVector<llvm::Value *, 8> AllocArgs = {emitUpdateLocation(CGF, Loc),
4276       getThreadID(CGF, Loc), TaskFlags, KmpTaskTWithPrivatesTySize,
4277       SharedsSize, CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
4278           TaskEntry, KmpRoutineEntryPtrTy)};
4279   llvm::Value *NewTask;
4280   if (D.hasClausesOfKind<OMPNowaitClause>()) {
4281     // Check if we have any device clause associated with the directive.
4282     const Expr *Device = nullptr;
4283     if (auto *C = D.getSingleClause<OMPDeviceClause>())
4284       Device = C->getDevice();
4285     // Emit device ID if any otherwise use default value.
4286     llvm::Value *DeviceID;
4287     if (Device)
4288       DeviceID = CGF.Builder.CreateIntCast(CGF.EmitScalarExpr(Device),
4289                                            CGF.Int64Ty, /*isSigned=*/true);
4290     else
4291       DeviceID = CGF.Builder.getInt64(OMP_DEVICEID_UNDEF);
4292     AllocArgs.push_back(DeviceID);
4293     NewTask = CGF.EmitRuntimeCall(
4294         OMPBuilder.getOrCreateRuntimeFunction(
4295             CGM.getModule(), OMPRTL___kmpc_omp_target_task_alloc),
4296         AllocArgs);
4297   } else {
4298     NewTask =
4299         CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
4300                                 CGM.getModule(), OMPRTL___kmpc_omp_task_alloc),
4301                             AllocArgs);
4302   }
4303   // Emit detach clause initialization.
4304   // evt = (typeof(evt))__kmpc_task_allow_completion_event(loc, tid,
4305   // task_descriptor);
4306   if (const auto *DC = D.getSingleClause<OMPDetachClause>()) {
4307     const Expr *Evt = DC->getEventHandler()->IgnoreParenImpCasts();
4308     LValue EvtLVal = CGF.EmitLValue(Evt);
4309 
4310     // Build kmp_event_t *__kmpc_task_allow_completion_event(ident_t *loc_ref,
4311     // int gtid, kmp_task_t *task);
4312     llvm::Value *Loc = emitUpdateLocation(CGF, DC->getBeginLoc());
4313     llvm::Value *Tid = getThreadID(CGF, DC->getBeginLoc());
4314     Tid = CGF.Builder.CreateIntCast(Tid, CGF.IntTy, /*isSigned=*/false);
4315     llvm::Value *EvtVal = CGF.EmitRuntimeCall(
4316         OMPBuilder.getOrCreateRuntimeFunction(
4317             CGM.getModule(), OMPRTL___kmpc_task_allow_completion_event),
4318         {Loc, Tid, NewTask});
4319     EvtVal = CGF.EmitScalarConversion(EvtVal, C.VoidPtrTy, Evt->getType(),
4320                                       Evt->getExprLoc());
4321     CGF.EmitStoreOfScalar(EvtVal, EvtLVal);
4322   }
4323   // Process affinity clauses.
4324   if (D.hasClausesOfKind<OMPAffinityClause>()) {
4325     // Process list of affinity data.
4326     ASTContext &C = CGM.getContext();
4327     Address AffinitiesArray = Address::invalid();
4328     // Calculate number of elements to form the array of affinity data.
4329     llvm::Value *NumOfElements = nullptr;
4330     unsigned NumAffinities = 0;
4331     for (const auto *C : D.getClausesOfKind<OMPAffinityClause>()) {
4332       if (const Expr *Modifier = C->getModifier()) {
4333         const auto *IE = cast<OMPIteratorExpr>(Modifier->IgnoreParenImpCasts());
4334         for (unsigned I = 0, E = IE->numOfIterators(); I < E; ++I) {
4335           llvm::Value *Sz = CGF.EmitScalarExpr(IE->getHelper(I).Upper);
4336           Sz = CGF.Builder.CreateIntCast(Sz, CGF.SizeTy, /*isSigned=*/false);
4337           NumOfElements =
4338               NumOfElements ? CGF.Builder.CreateNUWMul(NumOfElements, Sz) : Sz;
4339         }
4340       } else {
4341         NumAffinities += C->varlist_size();
4342       }
4343     }
4344     getKmpAffinityType(CGM.getContext(), KmpTaskAffinityInfoTy);
4345     // Fields ids in kmp_task_affinity_info record.
4346     enum RTLAffinityInfoFieldsTy { BaseAddr, Len, Flags };
4347 
4348     QualType KmpTaskAffinityInfoArrayTy;
4349     if (NumOfElements) {
4350       NumOfElements = CGF.Builder.CreateNUWAdd(
4351           llvm::ConstantInt::get(CGF.SizeTy, NumAffinities), NumOfElements);
4352       OpaqueValueExpr OVE(
4353           Loc,
4354           C.getIntTypeForBitwidth(C.getTypeSize(C.getSizeType()), /*Signed=*/0),
4355           VK_RValue);
4356       CodeGenFunction::OpaqueValueMapping OpaqueMap(CGF, &OVE,
4357                                                     RValue::get(NumOfElements));
4358       KmpTaskAffinityInfoArrayTy =
4359           C.getVariableArrayType(KmpTaskAffinityInfoTy, &OVE, ArrayType::Normal,
4360                                  /*IndexTypeQuals=*/0, SourceRange(Loc, Loc));
4361       // Properly emit variable-sized array.
4362       auto *PD = ImplicitParamDecl::Create(C, KmpTaskAffinityInfoArrayTy,
4363                                            ImplicitParamDecl::Other);
4364       CGF.EmitVarDecl(*PD);
4365       AffinitiesArray = CGF.GetAddrOfLocalVar(PD);
4366       NumOfElements = CGF.Builder.CreateIntCast(NumOfElements, CGF.Int32Ty,
4367                                                 /*isSigned=*/false);
4368     } else {
4369       KmpTaskAffinityInfoArrayTy = C.getConstantArrayType(
4370           KmpTaskAffinityInfoTy,
4371           llvm::APInt(C.getTypeSize(C.getSizeType()), NumAffinities), nullptr,
4372           ArrayType::Normal, /*IndexTypeQuals=*/0);
4373       AffinitiesArray =
4374           CGF.CreateMemTemp(KmpTaskAffinityInfoArrayTy, ".affs.arr.addr");
4375       AffinitiesArray = CGF.Builder.CreateConstArrayGEP(AffinitiesArray, 0);
4376       NumOfElements = llvm::ConstantInt::get(CGM.Int32Ty, NumAffinities,
4377                                              /*isSigned=*/false);
4378     }
4379 
4380     const auto *KmpAffinityInfoRD = KmpTaskAffinityInfoTy->getAsRecordDecl();
4381     // Fill array by elements without iterators.
4382     unsigned Pos = 0;
4383     bool HasIterator = false;
4384     for (const auto *C : D.getClausesOfKind<OMPAffinityClause>()) {
4385       if (C->getModifier()) {
4386         HasIterator = true;
4387         continue;
4388       }
4389       for (const Expr *E : C->varlists()) {
4390         llvm::Value *Addr;
4391         llvm::Value *Size;
4392         std::tie(Addr, Size) = getPointerAndSize(CGF, E);
4393         LValue Base =
4394             CGF.MakeAddrLValue(CGF.Builder.CreateConstGEP(AffinitiesArray, Pos),
4395                                KmpTaskAffinityInfoTy);
4396         // affs[i].base_addr = &<Affinities[i].second>;
4397         LValue BaseAddrLVal = CGF.EmitLValueForField(
4398             Base, *std::next(KmpAffinityInfoRD->field_begin(), BaseAddr));
4399         CGF.EmitStoreOfScalar(CGF.Builder.CreatePtrToInt(Addr, CGF.IntPtrTy),
4400                               BaseAddrLVal);
4401         // affs[i].len = sizeof(<Affinities[i].second>);
4402         LValue LenLVal = CGF.EmitLValueForField(
4403             Base, *std::next(KmpAffinityInfoRD->field_begin(), Len));
4404         CGF.EmitStoreOfScalar(Size, LenLVal);
4405         ++Pos;
4406       }
4407     }
4408     LValue PosLVal;
4409     if (HasIterator) {
4410       PosLVal = CGF.MakeAddrLValue(
4411           CGF.CreateMemTemp(C.getSizeType(), "affs.counter.addr"),
4412           C.getSizeType());
4413       CGF.EmitStoreOfScalar(llvm::ConstantInt::get(CGF.SizeTy, Pos), PosLVal);
4414     }
4415     // Process elements with iterators.
4416     for (const auto *C : D.getClausesOfKind<OMPAffinityClause>()) {
4417       const Expr *Modifier = C->getModifier();
4418       if (!Modifier)
4419         continue;
4420       OMPIteratorGeneratorScope IteratorScope(
4421           CGF, cast_or_null<OMPIteratorExpr>(Modifier->IgnoreParenImpCasts()));
4422       for (const Expr *E : C->varlists()) {
4423         llvm::Value *Addr;
4424         llvm::Value *Size;
4425         std::tie(Addr, Size) = getPointerAndSize(CGF, E);
4426         llvm::Value *Idx = CGF.EmitLoadOfScalar(PosLVal, E->getExprLoc());
4427         LValue Base = CGF.MakeAddrLValue(
4428             Address(CGF.Builder.CreateGEP(AffinitiesArray.getPointer(), Idx),
4429                     AffinitiesArray.getAlignment()),
4430             KmpTaskAffinityInfoTy);
4431         // affs[i].base_addr = &<Affinities[i].second>;
4432         LValue BaseAddrLVal = CGF.EmitLValueForField(
4433             Base, *std::next(KmpAffinityInfoRD->field_begin(), BaseAddr));
4434         CGF.EmitStoreOfScalar(CGF.Builder.CreatePtrToInt(Addr, CGF.IntPtrTy),
4435                               BaseAddrLVal);
4436         // affs[i].len = sizeof(<Affinities[i].second>);
4437         LValue LenLVal = CGF.EmitLValueForField(
4438             Base, *std::next(KmpAffinityInfoRD->field_begin(), Len));
4439         CGF.EmitStoreOfScalar(Size, LenLVal);
4440         Idx = CGF.Builder.CreateNUWAdd(
4441             Idx, llvm::ConstantInt::get(Idx->getType(), 1));
4442         CGF.EmitStoreOfScalar(Idx, PosLVal);
4443       }
4444     }
4445     // Call to kmp_int32 __kmpc_omp_reg_task_with_affinity(ident_t *loc_ref,
4446     // kmp_int32 gtid, kmp_task_t *new_task, kmp_int32
4447     // naffins, kmp_task_affinity_info_t *affin_list);
4448     llvm::Value *LocRef = emitUpdateLocation(CGF, Loc);
4449     llvm::Value *GTid = getThreadID(CGF, Loc);
4450     llvm::Value *AffinListPtr = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
4451         AffinitiesArray.getPointer(), CGM.VoidPtrTy);
4452     // FIXME: Emit the function and ignore its result for now unless the
4453     // runtime function is properly implemented.
4454     (void)CGF.EmitRuntimeCall(
4455         OMPBuilder.getOrCreateRuntimeFunction(
4456             CGM.getModule(), OMPRTL___kmpc_omp_reg_task_with_affinity),
4457         {LocRef, GTid, NewTask, NumOfElements, AffinListPtr});
4458   }
4459   llvm::Value *NewTaskNewTaskTTy =
4460       CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
4461           NewTask, KmpTaskTWithPrivatesPtrTy);
4462   LValue Base = CGF.MakeNaturalAlignAddrLValue(NewTaskNewTaskTTy,
4463                                                KmpTaskTWithPrivatesQTy);
4464   LValue TDBase =
4465       CGF.EmitLValueForField(Base, *KmpTaskTWithPrivatesQTyRD->field_begin());
4466   // Fill the data in the resulting kmp_task_t record.
4467   // Copy shareds if there are any.
4468   Address KmpTaskSharedsPtr = Address::invalid();
4469   if (!SharedsTy->getAsStructureType()->getDecl()->field_empty()) {
4470     KmpTaskSharedsPtr =
4471         Address(CGF.EmitLoadOfScalar(
4472                     CGF.EmitLValueForField(
4473                         TDBase, *std::next(KmpTaskTQTyRD->field_begin(),
4474                                            KmpTaskTShareds)),
4475                     Loc),
4476                 CGM.getNaturalTypeAlignment(SharedsTy));
4477     LValue Dest = CGF.MakeAddrLValue(KmpTaskSharedsPtr, SharedsTy);
4478     LValue Src = CGF.MakeAddrLValue(Shareds, SharedsTy);
4479     CGF.EmitAggregateCopy(Dest, Src, SharedsTy, AggValueSlot::DoesNotOverlap);
4480   }
4481   // Emit initial values for private copies (if any).
4482   TaskResultTy Result;
4483   if (!Privates.empty()) {
4484     emitPrivatesInit(CGF, D, KmpTaskSharedsPtr, Base, KmpTaskTWithPrivatesQTyRD,
4485                      SharedsTy, SharedsPtrTy, Data, Privates,
4486                      /*ForDup=*/false);
4487     if (isOpenMPTaskLoopDirective(D.getDirectiveKind()) &&
4488         (!Data.LastprivateVars.empty() || checkInitIsRequired(CGF, Privates))) {
4489       Result.TaskDupFn = emitTaskDupFunction(
4490           CGM, Loc, D, KmpTaskTWithPrivatesPtrQTy, KmpTaskTWithPrivatesQTyRD,
4491           KmpTaskTQTyRD, SharedsTy, SharedsPtrTy, Data, Privates,
4492           /*WithLastIter=*/!Data.LastprivateVars.empty());
4493     }
4494   }
4495   // Fields of union "kmp_cmplrdata_t" for destructors and priority.
4496   enum { Priority = 0, Destructors = 1 };
4497   // Provide pointer to function with destructors for privates.
4498   auto FI = std::next(KmpTaskTQTyRD->field_begin(), Data1);
4499   const RecordDecl *KmpCmplrdataUD =
4500       (*FI)->getType()->getAsUnionType()->getDecl();
4501   if (NeedsCleanup) {
4502     llvm::Value *DestructorFn = emitDestructorsFunction(
4503         CGM, Loc, KmpInt32Ty, KmpTaskTWithPrivatesPtrQTy,
4504         KmpTaskTWithPrivatesQTy);
4505     LValue Data1LV = CGF.EmitLValueForField(TDBase, *FI);
4506     LValue DestructorsLV = CGF.EmitLValueForField(
4507         Data1LV, *std::next(KmpCmplrdataUD->field_begin(), Destructors));
4508     CGF.EmitStoreOfScalar(CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
4509                               DestructorFn, KmpRoutineEntryPtrTy),
4510                           DestructorsLV);
4511   }
4512   // Set priority.
4513   if (Data.Priority.getInt()) {
4514     LValue Data2LV = CGF.EmitLValueForField(
4515         TDBase, *std::next(KmpTaskTQTyRD->field_begin(), Data2));
4516     LValue PriorityLV = CGF.EmitLValueForField(
4517         Data2LV, *std::next(KmpCmplrdataUD->field_begin(), Priority));
4518     CGF.EmitStoreOfScalar(Data.Priority.getPointer(), PriorityLV);
4519   }
4520   Result.NewTask = NewTask;
4521   Result.TaskEntry = TaskEntry;
4522   Result.NewTaskNewTaskTTy = NewTaskNewTaskTTy;
4523   Result.TDBase = TDBase;
4524   Result.KmpTaskTQTyRD = KmpTaskTQTyRD;
4525   return Result;
4526 }
4527 
4528 namespace {
4529 /// Dependence kind for RTL.
4530 enum RTLDependenceKindTy {
4531   DepIn = 0x01,
4532   DepInOut = 0x3,
4533   DepMutexInOutSet = 0x4
4534 };
4535 /// Fields ids in kmp_depend_info record.
4536 enum RTLDependInfoFieldsTy { BaseAddr, Len, Flags };
4537 } // namespace
4538 
4539 /// Translates internal dependency kind into the runtime kind.
4540 static RTLDependenceKindTy translateDependencyKind(OpenMPDependClauseKind K) {
4541   RTLDependenceKindTy DepKind;
4542   switch (K) {
4543   case OMPC_DEPEND_in:
4544     DepKind = DepIn;
4545     break;
4546   // Out and InOut dependencies must use the same code.
4547   case OMPC_DEPEND_out:
4548   case OMPC_DEPEND_inout:
4549     DepKind = DepInOut;
4550     break;
4551   case OMPC_DEPEND_mutexinoutset:
4552     DepKind = DepMutexInOutSet;
4553     break;
4554   case OMPC_DEPEND_source:
4555   case OMPC_DEPEND_sink:
4556   case OMPC_DEPEND_depobj:
4557   case OMPC_DEPEND_unknown:
4558     llvm_unreachable("Unknown task dependence type");
4559   }
4560   return DepKind;
4561 }
4562 
4563 /// Builds kmp_depend_info, if it is not built yet, and builds flags type.
4564 static void getDependTypes(ASTContext &C, QualType &KmpDependInfoTy,
4565                            QualType &FlagsTy) {
4566   FlagsTy = C.getIntTypeForBitwidth(C.getTypeSize(C.BoolTy), /*Signed=*/false);
4567   if (KmpDependInfoTy.isNull()) {
4568     RecordDecl *KmpDependInfoRD = C.buildImplicitRecord("kmp_depend_info");
4569     KmpDependInfoRD->startDefinition();
4570     addFieldToRecordDecl(C, KmpDependInfoRD, C.getIntPtrType());
4571     addFieldToRecordDecl(C, KmpDependInfoRD, C.getSizeType());
4572     addFieldToRecordDecl(C, KmpDependInfoRD, FlagsTy);
4573     KmpDependInfoRD->completeDefinition();
4574     KmpDependInfoTy = C.getRecordType(KmpDependInfoRD);
4575   }
4576 }
4577 
4578 std::pair<llvm::Value *, LValue>
4579 CGOpenMPRuntime::getDepobjElements(CodeGenFunction &CGF, LValue DepobjLVal,
4580                                    SourceLocation Loc) {
4581   ASTContext &C = CGM.getContext();
4582   QualType FlagsTy;
4583   getDependTypes(C, KmpDependInfoTy, FlagsTy);
4584   RecordDecl *KmpDependInfoRD =
4585       cast<RecordDecl>(KmpDependInfoTy->getAsTagDecl());
4586   LValue Base = CGF.EmitLoadOfPointerLValue(
4587       DepobjLVal.getAddress(CGF),
4588       C.getPointerType(C.VoidPtrTy).castAs<PointerType>());
4589   QualType KmpDependInfoPtrTy = C.getPointerType(KmpDependInfoTy);
4590   Address Addr = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
4591           Base.getAddress(CGF), CGF.ConvertTypeForMem(KmpDependInfoPtrTy));
4592   Base = CGF.MakeAddrLValue(Addr, KmpDependInfoTy, Base.getBaseInfo(),
4593                             Base.getTBAAInfo());
4594   llvm::Value *DepObjAddr = CGF.Builder.CreateGEP(
4595       Addr.getPointer(),
4596       llvm::ConstantInt::get(CGF.IntPtrTy, -1, /*isSigned=*/true));
4597   LValue NumDepsBase = CGF.MakeAddrLValue(
4598       Address(DepObjAddr, Addr.getAlignment()), KmpDependInfoTy,
4599       Base.getBaseInfo(), Base.getTBAAInfo());
4600   // NumDeps = deps[i].base_addr;
4601   LValue BaseAddrLVal = CGF.EmitLValueForField(
4602       NumDepsBase, *std::next(KmpDependInfoRD->field_begin(), BaseAddr));
4603   llvm::Value *NumDeps = CGF.EmitLoadOfScalar(BaseAddrLVal, Loc);
4604   return std::make_pair(NumDeps, Base);
4605 }
4606 
4607 static void emitDependData(CodeGenFunction &CGF, QualType &KmpDependInfoTy,
4608                            llvm::PointerUnion<unsigned *, LValue *> Pos,
4609                            const OMPTaskDataTy::DependData &Data,
4610                            Address DependenciesArray) {
4611   CodeGenModule &CGM = CGF.CGM;
4612   ASTContext &C = CGM.getContext();
4613   QualType FlagsTy;
4614   getDependTypes(C, KmpDependInfoTy, FlagsTy);
4615   RecordDecl *KmpDependInfoRD =
4616       cast<RecordDecl>(KmpDependInfoTy->getAsTagDecl());
4617   llvm::Type *LLVMFlagsTy = CGF.ConvertTypeForMem(FlagsTy);
4618 
4619   OMPIteratorGeneratorScope IteratorScope(
4620       CGF, cast_or_null<OMPIteratorExpr>(
4621                Data.IteratorExpr ? Data.IteratorExpr->IgnoreParenImpCasts()
4622                                  : nullptr));
4623   for (const Expr *E : Data.DepExprs) {
4624     llvm::Value *Addr;
4625     llvm::Value *Size;
4626     std::tie(Addr, Size) = getPointerAndSize(CGF, E);
4627     LValue Base;
4628     if (unsigned *P = Pos.dyn_cast<unsigned *>()) {
4629       Base = CGF.MakeAddrLValue(
4630           CGF.Builder.CreateConstGEP(DependenciesArray, *P), KmpDependInfoTy);
4631     } else {
4632       LValue &PosLVal = *Pos.get<LValue *>();
4633       llvm::Value *Idx = CGF.EmitLoadOfScalar(PosLVal, E->getExprLoc());
4634       Base = CGF.MakeAddrLValue(
4635           Address(CGF.Builder.CreateGEP(DependenciesArray.getPointer(), Idx),
4636                   DependenciesArray.getAlignment()),
4637           KmpDependInfoTy);
4638     }
4639     // deps[i].base_addr = &<Dependencies[i].second>;
4640     LValue BaseAddrLVal = CGF.EmitLValueForField(
4641         Base, *std::next(KmpDependInfoRD->field_begin(), BaseAddr));
4642     CGF.EmitStoreOfScalar(CGF.Builder.CreatePtrToInt(Addr, CGF.IntPtrTy),
4643                           BaseAddrLVal);
4644     // deps[i].len = sizeof(<Dependencies[i].second>);
4645     LValue LenLVal = CGF.EmitLValueForField(
4646         Base, *std::next(KmpDependInfoRD->field_begin(), Len));
4647     CGF.EmitStoreOfScalar(Size, LenLVal);
4648     // deps[i].flags = <Dependencies[i].first>;
4649     RTLDependenceKindTy DepKind = translateDependencyKind(Data.DepKind);
4650     LValue FlagsLVal = CGF.EmitLValueForField(
4651         Base, *std::next(KmpDependInfoRD->field_begin(), Flags));
4652     CGF.EmitStoreOfScalar(llvm::ConstantInt::get(LLVMFlagsTy, DepKind),
4653                           FlagsLVal);
4654     if (unsigned *P = Pos.dyn_cast<unsigned *>()) {
4655       ++(*P);
4656     } else {
4657       LValue &PosLVal = *Pos.get<LValue *>();
4658       llvm::Value *Idx = CGF.EmitLoadOfScalar(PosLVal, E->getExprLoc());
4659       Idx = CGF.Builder.CreateNUWAdd(Idx,
4660                                      llvm::ConstantInt::get(Idx->getType(), 1));
4661       CGF.EmitStoreOfScalar(Idx, PosLVal);
4662     }
4663   }
4664 }
4665 
4666 static SmallVector<llvm::Value *, 4>
4667 emitDepobjElementsSizes(CodeGenFunction &CGF, QualType &KmpDependInfoTy,
4668                         const OMPTaskDataTy::DependData &Data) {
4669   assert(Data.DepKind == OMPC_DEPEND_depobj &&
4670          "Expected depobj dependecy kind.");
4671   SmallVector<llvm::Value *, 4> Sizes;
4672   SmallVector<LValue, 4> SizeLVals;
4673   ASTContext &C = CGF.getContext();
4674   QualType FlagsTy;
4675   getDependTypes(C, KmpDependInfoTy, FlagsTy);
4676   RecordDecl *KmpDependInfoRD =
4677       cast<RecordDecl>(KmpDependInfoTy->getAsTagDecl());
4678   QualType KmpDependInfoPtrTy = C.getPointerType(KmpDependInfoTy);
4679   llvm::Type *KmpDependInfoPtrT = CGF.ConvertTypeForMem(KmpDependInfoPtrTy);
4680   {
4681     OMPIteratorGeneratorScope IteratorScope(
4682         CGF, cast_or_null<OMPIteratorExpr>(
4683                  Data.IteratorExpr ? Data.IteratorExpr->IgnoreParenImpCasts()
4684                                    : nullptr));
4685     for (const Expr *E : Data.DepExprs) {
4686       LValue DepobjLVal = CGF.EmitLValue(E->IgnoreParenImpCasts());
4687       LValue Base = CGF.EmitLoadOfPointerLValue(
4688           DepobjLVal.getAddress(CGF),
4689           C.getPointerType(C.VoidPtrTy).castAs<PointerType>());
4690       Address Addr = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
4691           Base.getAddress(CGF), KmpDependInfoPtrT);
4692       Base = CGF.MakeAddrLValue(Addr, KmpDependInfoTy, Base.getBaseInfo(),
4693                                 Base.getTBAAInfo());
4694       llvm::Value *DepObjAddr = CGF.Builder.CreateGEP(
4695           Addr.getPointer(),
4696           llvm::ConstantInt::get(CGF.IntPtrTy, -1, /*isSigned=*/true));
4697       LValue NumDepsBase = CGF.MakeAddrLValue(
4698           Address(DepObjAddr, Addr.getAlignment()), KmpDependInfoTy,
4699           Base.getBaseInfo(), Base.getTBAAInfo());
4700       // NumDeps = deps[i].base_addr;
4701       LValue BaseAddrLVal = CGF.EmitLValueForField(
4702           NumDepsBase, *std::next(KmpDependInfoRD->field_begin(), BaseAddr));
4703       llvm::Value *NumDeps =
4704           CGF.EmitLoadOfScalar(BaseAddrLVal, E->getExprLoc());
4705       LValue NumLVal = CGF.MakeAddrLValue(
4706           CGF.CreateMemTemp(C.getUIntPtrType(), "depobj.size.addr"),
4707           C.getUIntPtrType());
4708       CGF.InitTempAlloca(NumLVal.getAddress(CGF),
4709                          llvm::ConstantInt::get(CGF.IntPtrTy, 0));
4710       llvm::Value *PrevVal = CGF.EmitLoadOfScalar(NumLVal, E->getExprLoc());
4711       llvm::Value *Add = CGF.Builder.CreateNUWAdd(PrevVal, NumDeps);
4712       CGF.EmitStoreOfScalar(Add, NumLVal);
4713       SizeLVals.push_back(NumLVal);
4714     }
4715   }
4716   for (unsigned I = 0, E = SizeLVals.size(); I < E; ++I) {
4717     llvm::Value *Size =
4718         CGF.EmitLoadOfScalar(SizeLVals[I], Data.DepExprs[I]->getExprLoc());
4719     Sizes.push_back(Size);
4720   }
4721   return Sizes;
4722 }
4723 
4724 static void emitDepobjElements(CodeGenFunction &CGF, QualType &KmpDependInfoTy,
4725                                LValue PosLVal,
4726                                const OMPTaskDataTy::DependData &Data,
4727                                Address DependenciesArray) {
4728   assert(Data.DepKind == OMPC_DEPEND_depobj &&
4729          "Expected depobj dependecy kind.");
4730   ASTContext &C = CGF.getContext();
4731   QualType FlagsTy;
4732   getDependTypes(C, KmpDependInfoTy, FlagsTy);
4733   RecordDecl *KmpDependInfoRD =
4734       cast<RecordDecl>(KmpDependInfoTy->getAsTagDecl());
4735   QualType KmpDependInfoPtrTy = C.getPointerType(KmpDependInfoTy);
4736   llvm::Type *KmpDependInfoPtrT = CGF.ConvertTypeForMem(KmpDependInfoPtrTy);
4737   llvm::Value *ElSize = CGF.getTypeSize(KmpDependInfoTy);
4738   {
4739     OMPIteratorGeneratorScope IteratorScope(
4740         CGF, cast_or_null<OMPIteratorExpr>(
4741                  Data.IteratorExpr ? Data.IteratorExpr->IgnoreParenImpCasts()
4742                                    : nullptr));
4743     for (unsigned I = 0, End = Data.DepExprs.size(); I < End; ++I) {
4744       const Expr *E = Data.DepExprs[I];
4745       LValue DepobjLVal = CGF.EmitLValue(E->IgnoreParenImpCasts());
4746       LValue Base = CGF.EmitLoadOfPointerLValue(
4747           DepobjLVal.getAddress(CGF),
4748           C.getPointerType(C.VoidPtrTy).castAs<PointerType>());
4749       Address Addr = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
4750           Base.getAddress(CGF), KmpDependInfoPtrT);
4751       Base = CGF.MakeAddrLValue(Addr, KmpDependInfoTy, Base.getBaseInfo(),
4752                                 Base.getTBAAInfo());
4753 
4754       // Get number of elements in a single depobj.
4755       llvm::Value *DepObjAddr = CGF.Builder.CreateGEP(
4756           Addr.getPointer(),
4757           llvm::ConstantInt::get(CGF.IntPtrTy, -1, /*isSigned=*/true));
4758       LValue NumDepsBase = CGF.MakeAddrLValue(
4759           Address(DepObjAddr, Addr.getAlignment()), KmpDependInfoTy,
4760           Base.getBaseInfo(), Base.getTBAAInfo());
4761       // NumDeps = deps[i].base_addr;
4762       LValue BaseAddrLVal = CGF.EmitLValueForField(
4763           NumDepsBase, *std::next(KmpDependInfoRD->field_begin(), BaseAddr));
4764       llvm::Value *NumDeps =
4765           CGF.EmitLoadOfScalar(BaseAddrLVal, E->getExprLoc());
4766 
4767       // memcopy dependency data.
4768       llvm::Value *Size = CGF.Builder.CreateNUWMul(
4769           ElSize,
4770           CGF.Builder.CreateIntCast(NumDeps, CGF.SizeTy, /*isSigned=*/false));
4771       llvm::Value *Pos = CGF.EmitLoadOfScalar(PosLVal, E->getExprLoc());
4772       Address DepAddr =
4773           Address(CGF.Builder.CreateGEP(DependenciesArray.getPointer(), Pos),
4774                   DependenciesArray.getAlignment());
4775       CGF.Builder.CreateMemCpy(DepAddr, Base.getAddress(CGF), Size);
4776 
4777       // Increase pos.
4778       // pos += size;
4779       llvm::Value *Add = CGF.Builder.CreateNUWAdd(Pos, NumDeps);
4780       CGF.EmitStoreOfScalar(Add, PosLVal);
4781     }
4782   }
4783 }
4784 
4785 std::pair<llvm::Value *, Address> CGOpenMPRuntime::emitDependClause(
4786     CodeGenFunction &CGF, ArrayRef<OMPTaskDataTy::DependData> Dependencies,
4787     SourceLocation Loc) {
4788   if (llvm::all_of(Dependencies, [](const OMPTaskDataTy::DependData &D) {
4789         return D.DepExprs.empty();
4790       }))
4791     return std::make_pair(nullptr, Address::invalid());
4792   // Process list of dependencies.
4793   ASTContext &C = CGM.getContext();
4794   Address DependenciesArray = Address::invalid();
4795   llvm::Value *NumOfElements = nullptr;
4796   unsigned NumDependencies = std::accumulate(
4797       Dependencies.begin(), Dependencies.end(), 0,
4798       [](unsigned V, const OMPTaskDataTy::DependData &D) {
4799         return D.DepKind == OMPC_DEPEND_depobj
4800                    ? V
4801                    : (V + (D.IteratorExpr ? 0 : D.DepExprs.size()));
4802       });
4803   QualType FlagsTy;
4804   getDependTypes(C, KmpDependInfoTy, FlagsTy);
4805   bool HasDepobjDeps = false;
4806   bool HasRegularWithIterators = false;
4807   llvm::Value *NumOfDepobjElements = llvm::ConstantInt::get(CGF.IntPtrTy, 0);
4808   llvm::Value *NumOfRegularWithIterators =
4809       llvm::ConstantInt::get(CGF.IntPtrTy, 1);
4810   // Calculate number of depobj dependecies and regular deps with the iterators.
4811   for (const OMPTaskDataTy::DependData &D : Dependencies) {
4812     if (D.DepKind == OMPC_DEPEND_depobj) {
4813       SmallVector<llvm::Value *, 4> Sizes =
4814           emitDepobjElementsSizes(CGF, KmpDependInfoTy, D);
4815       for (llvm::Value *Size : Sizes) {
4816         NumOfDepobjElements =
4817             CGF.Builder.CreateNUWAdd(NumOfDepobjElements, Size);
4818       }
4819       HasDepobjDeps = true;
4820       continue;
4821     }
4822     // Include number of iterations, if any.
4823     if (const auto *IE = cast_or_null<OMPIteratorExpr>(D.IteratorExpr)) {
4824       for (unsigned I = 0, E = IE->numOfIterators(); I < E; ++I) {
4825         llvm::Value *Sz = CGF.EmitScalarExpr(IE->getHelper(I).Upper);
4826         Sz = CGF.Builder.CreateIntCast(Sz, CGF.IntPtrTy, /*isSigned=*/false);
4827         NumOfRegularWithIterators =
4828             CGF.Builder.CreateNUWMul(NumOfRegularWithIterators, Sz);
4829       }
4830       HasRegularWithIterators = true;
4831       continue;
4832     }
4833   }
4834 
4835   QualType KmpDependInfoArrayTy;
4836   if (HasDepobjDeps || HasRegularWithIterators) {
4837     NumOfElements = llvm::ConstantInt::get(CGM.IntPtrTy, NumDependencies,
4838                                            /*isSigned=*/false);
4839     if (HasDepobjDeps) {
4840       NumOfElements =
4841           CGF.Builder.CreateNUWAdd(NumOfDepobjElements, NumOfElements);
4842     }
4843     if (HasRegularWithIterators) {
4844       NumOfElements =
4845           CGF.Builder.CreateNUWAdd(NumOfRegularWithIterators, NumOfElements);
4846     }
4847     OpaqueValueExpr OVE(Loc,
4848                         C.getIntTypeForBitwidth(/*DestWidth=*/64, /*Signed=*/0),
4849                         VK_RValue);
4850     CodeGenFunction::OpaqueValueMapping OpaqueMap(CGF, &OVE,
4851                                                   RValue::get(NumOfElements));
4852     KmpDependInfoArrayTy =
4853         C.getVariableArrayType(KmpDependInfoTy, &OVE, ArrayType::Normal,
4854                                /*IndexTypeQuals=*/0, SourceRange(Loc, Loc));
4855     // CGF.EmitVariablyModifiedType(KmpDependInfoArrayTy);
4856     // Properly emit variable-sized array.
4857     auto *PD = ImplicitParamDecl::Create(C, KmpDependInfoArrayTy,
4858                                          ImplicitParamDecl::Other);
4859     CGF.EmitVarDecl(*PD);
4860     DependenciesArray = CGF.GetAddrOfLocalVar(PD);
4861     NumOfElements = CGF.Builder.CreateIntCast(NumOfElements, CGF.Int32Ty,
4862                                               /*isSigned=*/false);
4863   } else {
4864     KmpDependInfoArrayTy = C.getConstantArrayType(
4865         KmpDependInfoTy, llvm::APInt(/*numBits=*/64, NumDependencies), nullptr,
4866         ArrayType::Normal, /*IndexTypeQuals=*/0);
4867     DependenciesArray =
4868         CGF.CreateMemTemp(KmpDependInfoArrayTy, ".dep.arr.addr");
4869     DependenciesArray = CGF.Builder.CreateConstArrayGEP(DependenciesArray, 0);
4870     NumOfElements = llvm::ConstantInt::get(CGM.Int32Ty, NumDependencies,
4871                                            /*isSigned=*/false);
4872   }
4873   unsigned Pos = 0;
4874   for (unsigned I = 0, End = Dependencies.size(); I < End; ++I) {
4875     if (Dependencies[I].DepKind == OMPC_DEPEND_depobj ||
4876         Dependencies[I].IteratorExpr)
4877       continue;
4878     emitDependData(CGF, KmpDependInfoTy, &Pos, Dependencies[I],
4879                    DependenciesArray);
4880   }
4881   // Copy regular dependecies with iterators.
4882   LValue PosLVal = CGF.MakeAddrLValue(
4883       CGF.CreateMemTemp(C.getSizeType(), "dep.counter.addr"), C.getSizeType());
4884   CGF.EmitStoreOfScalar(llvm::ConstantInt::get(CGF.SizeTy, Pos), PosLVal);
4885   for (unsigned I = 0, End = Dependencies.size(); I < End; ++I) {
4886     if (Dependencies[I].DepKind == OMPC_DEPEND_depobj ||
4887         !Dependencies[I].IteratorExpr)
4888       continue;
4889     emitDependData(CGF, KmpDependInfoTy, &PosLVal, Dependencies[I],
4890                    DependenciesArray);
4891   }
4892   // Copy final depobj arrays without iterators.
4893   if (HasDepobjDeps) {
4894     for (unsigned I = 0, End = Dependencies.size(); I < End; ++I) {
4895       if (Dependencies[I].DepKind != OMPC_DEPEND_depobj)
4896         continue;
4897       emitDepobjElements(CGF, KmpDependInfoTy, PosLVal, Dependencies[I],
4898                          DependenciesArray);
4899     }
4900   }
4901   DependenciesArray = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
4902       DependenciesArray, CGF.VoidPtrTy);
4903   return std::make_pair(NumOfElements, DependenciesArray);
4904 }
4905 
4906 Address CGOpenMPRuntime::emitDepobjDependClause(
4907     CodeGenFunction &CGF, const OMPTaskDataTy::DependData &Dependencies,
4908     SourceLocation Loc) {
4909   if (Dependencies.DepExprs.empty())
4910     return Address::invalid();
4911   // Process list of dependencies.
4912   ASTContext &C = CGM.getContext();
4913   Address DependenciesArray = Address::invalid();
4914   unsigned NumDependencies = Dependencies.DepExprs.size();
4915   QualType FlagsTy;
4916   getDependTypes(C, KmpDependInfoTy, FlagsTy);
4917   RecordDecl *KmpDependInfoRD =
4918       cast<RecordDecl>(KmpDependInfoTy->getAsTagDecl());
4919 
4920   llvm::Value *Size;
4921   // Define type kmp_depend_info[<Dependencies.size()>];
4922   // For depobj reserve one extra element to store the number of elements.
4923   // It is required to handle depobj(x) update(in) construct.
4924   // kmp_depend_info[<Dependencies.size()>] deps;
4925   llvm::Value *NumDepsVal;
4926   CharUnits Align = C.getTypeAlignInChars(KmpDependInfoTy);
4927   if (const auto *IE =
4928           cast_or_null<OMPIteratorExpr>(Dependencies.IteratorExpr)) {
4929     NumDepsVal = llvm::ConstantInt::get(CGF.SizeTy, 1);
4930     for (unsigned I = 0, E = IE->numOfIterators(); I < E; ++I) {
4931       llvm::Value *Sz = CGF.EmitScalarExpr(IE->getHelper(I).Upper);
4932       Sz = CGF.Builder.CreateIntCast(Sz, CGF.SizeTy, /*isSigned=*/false);
4933       NumDepsVal = CGF.Builder.CreateNUWMul(NumDepsVal, Sz);
4934     }
4935     Size = CGF.Builder.CreateNUWAdd(llvm::ConstantInt::get(CGF.SizeTy, 1),
4936                                     NumDepsVal);
4937     CharUnits SizeInBytes =
4938         C.getTypeSizeInChars(KmpDependInfoTy).alignTo(Align);
4939     llvm::Value *RecSize = CGM.getSize(SizeInBytes);
4940     Size = CGF.Builder.CreateNUWMul(Size, RecSize);
4941     NumDepsVal =
4942         CGF.Builder.CreateIntCast(NumDepsVal, CGF.IntPtrTy, /*isSigned=*/false);
4943   } else {
4944     QualType KmpDependInfoArrayTy = C.getConstantArrayType(
4945         KmpDependInfoTy, llvm::APInt(/*numBits=*/64, NumDependencies + 1),
4946         nullptr, ArrayType::Normal, /*IndexTypeQuals=*/0);
4947     CharUnits Sz = C.getTypeSizeInChars(KmpDependInfoArrayTy);
4948     Size = CGM.getSize(Sz.alignTo(Align));
4949     NumDepsVal = llvm::ConstantInt::get(CGF.IntPtrTy, NumDependencies);
4950   }
4951   // Need to allocate on the dynamic memory.
4952   llvm::Value *ThreadID = getThreadID(CGF, Loc);
4953   // Use default allocator.
4954   llvm::Value *Allocator = llvm::ConstantPointerNull::get(CGF.VoidPtrTy);
4955   llvm::Value *Args[] = {ThreadID, Size, Allocator};
4956 
4957   llvm::Value *Addr =
4958       CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
4959                               CGM.getModule(), OMPRTL___kmpc_alloc),
4960                           Args, ".dep.arr.addr");
4961   Addr = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
4962       Addr, CGF.ConvertTypeForMem(KmpDependInfoTy)->getPointerTo());
4963   DependenciesArray = Address(Addr, Align);
4964   // Write number of elements in the first element of array for depobj.
4965   LValue Base = CGF.MakeAddrLValue(DependenciesArray, KmpDependInfoTy);
4966   // deps[i].base_addr = NumDependencies;
4967   LValue BaseAddrLVal = CGF.EmitLValueForField(
4968       Base, *std::next(KmpDependInfoRD->field_begin(), BaseAddr));
4969   CGF.EmitStoreOfScalar(NumDepsVal, BaseAddrLVal);
4970   llvm::PointerUnion<unsigned *, LValue *> Pos;
4971   unsigned Idx = 1;
4972   LValue PosLVal;
4973   if (Dependencies.IteratorExpr) {
4974     PosLVal = CGF.MakeAddrLValue(
4975         CGF.CreateMemTemp(C.getSizeType(), "iterator.counter.addr"),
4976         C.getSizeType());
4977     CGF.EmitStoreOfScalar(llvm::ConstantInt::get(CGF.SizeTy, Idx), PosLVal,
4978                           /*IsInit=*/true);
4979     Pos = &PosLVal;
4980   } else {
4981     Pos = &Idx;
4982   }
4983   emitDependData(CGF, KmpDependInfoTy, Pos, Dependencies, DependenciesArray);
4984   DependenciesArray = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
4985       CGF.Builder.CreateConstGEP(DependenciesArray, 1), CGF.VoidPtrTy);
4986   return DependenciesArray;
4987 }
4988 
4989 void CGOpenMPRuntime::emitDestroyClause(CodeGenFunction &CGF, LValue DepobjLVal,
4990                                         SourceLocation Loc) {
4991   ASTContext &C = CGM.getContext();
4992   QualType FlagsTy;
4993   getDependTypes(C, KmpDependInfoTy, FlagsTy);
4994   LValue Base = CGF.EmitLoadOfPointerLValue(
4995       DepobjLVal.getAddress(CGF),
4996       C.getPointerType(C.VoidPtrTy).castAs<PointerType>());
4997   QualType KmpDependInfoPtrTy = C.getPointerType(KmpDependInfoTy);
4998   Address Addr = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
4999       Base.getAddress(CGF), CGF.ConvertTypeForMem(KmpDependInfoPtrTy));
5000   llvm::Value *DepObjAddr = CGF.Builder.CreateGEP(
5001       Addr.getPointer(),
5002       llvm::ConstantInt::get(CGF.IntPtrTy, -1, /*isSigned=*/true));
5003   DepObjAddr = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(DepObjAddr,
5004                                                                CGF.VoidPtrTy);
5005   llvm::Value *ThreadID = getThreadID(CGF, Loc);
5006   // Use default allocator.
5007   llvm::Value *Allocator = llvm::ConstantPointerNull::get(CGF.VoidPtrTy);
5008   llvm::Value *Args[] = {ThreadID, DepObjAddr, Allocator};
5009 
5010   // _kmpc_free(gtid, addr, nullptr);
5011   (void)CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
5012                                 CGM.getModule(), OMPRTL___kmpc_free),
5013                             Args);
5014 }
5015 
5016 void CGOpenMPRuntime::emitUpdateClause(CodeGenFunction &CGF, LValue DepobjLVal,
5017                                        OpenMPDependClauseKind NewDepKind,
5018                                        SourceLocation Loc) {
5019   ASTContext &C = CGM.getContext();
5020   QualType FlagsTy;
5021   getDependTypes(C, KmpDependInfoTy, FlagsTy);
5022   RecordDecl *KmpDependInfoRD =
5023       cast<RecordDecl>(KmpDependInfoTy->getAsTagDecl());
5024   llvm::Type *LLVMFlagsTy = CGF.ConvertTypeForMem(FlagsTy);
5025   llvm::Value *NumDeps;
5026   LValue Base;
5027   std::tie(NumDeps, Base) = getDepobjElements(CGF, DepobjLVal, Loc);
5028 
5029   Address Begin = Base.getAddress(CGF);
5030   // Cast from pointer to array type to pointer to single element.
5031   llvm::Value *End = CGF.Builder.CreateGEP(Begin.getPointer(), NumDeps);
5032   // The basic structure here is a while-do loop.
5033   llvm::BasicBlock *BodyBB = CGF.createBasicBlock("omp.body");
5034   llvm::BasicBlock *DoneBB = CGF.createBasicBlock("omp.done");
5035   llvm::BasicBlock *EntryBB = CGF.Builder.GetInsertBlock();
5036   CGF.EmitBlock(BodyBB);
5037   llvm::PHINode *ElementPHI =
5038       CGF.Builder.CreatePHI(Begin.getType(), 2, "omp.elementPast");
5039   ElementPHI->addIncoming(Begin.getPointer(), EntryBB);
5040   Begin = Address(ElementPHI, Begin.getAlignment());
5041   Base = CGF.MakeAddrLValue(Begin, KmpDependInfoTy, Base.getBaseInfo(),
5042                             Base.getTBAAInfo());
5043   // deps[i].flags = NewDepKind;
5044   RTLDependenceKindTy DepKind = translateDependencyKind(NewDepKind);
5045   LValue FlagsLVal = CGF.EmitLValueForField(
5046       Base, *std::next(KmpDependInfoRD->field_begin(), Flags));
5047   CGF.EmitStoreOfScalar(llvm::ConstantInt::get(LLVMFlagsTy, DepKind),
5048                         FlagsLVal);
5049 
5050   // Shift the address forward by one element.
5051   Address ElementNext =
5052       CGF.Builder.CreateConstGEP(Begin, /*Index=*/1, "omp.elementNext");
5053   ElementPHI->addIncoming(ElementNext.getPointer(),
5054                           CGF.Builder.GetInsertBlock());
5055   llvm::Value *IsEmpty =
5056       CGF.Builder.CreateICmpEQ(ElementNext.getPointer(), End, "omp.isempty");
5057   CGF.Builder.CreateCondBr(IsEmpty, DoneBB, BodyBB);
5058   // Done.
5059   CGF.EmitBlock(DoneBB, /*IsFinished=*/true);
5060 }
5061 
5062 void CGOpenMPRuntime::emitTaskCall(CodeGenFunction &CGF, SourceLocation Loc,
5063                                    const OMPExecutableDirective &D,
5064                                    llvm::Function *TaskFunction,
5065                                    QualType SharedsTy, Address Shareds,
5066                                    const Expr *IfCond,
5067                                    const OMPTaskDataTy &Data) {
5068   if (!CGF.HaveInsertPoint())
5069     return;
5070 
5071   TaskResultTy Result =
5072       emitTaskInit(CGF, Loc, D, TaskFunction, SharedsTy, Shareds, Data);
5073   llvm::Value *NewTask = Result.NewTask;
5074   llvm::Function *TaskEntry = Result.TaskEntry;
5075   llvm::Value *NewTaskNewTaskTTy = Result.NewTaskNewTaskTTy;
5076   LValue TDBase = Result.TDBase;
5077   const RecordDecl *KmpTaskTQTyRD = Result.KmpTaskTQTyRD;
5078   // Process list of dependences.
5079   Address DependenciesArray = Address::invalid();
5080   llvm::Value *NumOfElements;
5081   std::tie(NumOfElements, DependenciesArray) =
5082       emitDependClause(CGF, Data.Dependences, Loc);
5083 
5084   // NOTE: routine and part_id fields are initialized by __kmpc_omp_task_alloc()
5085   // libcall.
5086   // Build kmp_int32 __kmpc_omp_task_with_deps(ident_t *, kmp_int32 gtid,
5087   // kmp_task_t *new_task, kmp_int32 ndeps, kmp_depend_info_t *dep_list,
5088   // kmp_int32 ndeps_noalias, kmp_depend_info_t *noalias_dep_list) if dependence
5089   // list is not empty
5090   llvm::Value *ThreadID = getThreadID(CGF, Loc);
5091   llvm::Value *UpLoc = emitUpdateLocation(CGF, Loc);
5092   llvm::Value *TaskArgs[] = { UpLoc, ThreadID, NewTask };
5093   llvm::Value *DepTaskArgs[7];
5094   if (!Data.Dependences.empty()) {
5095     DepTaskArgs[0] = UpLoc;
5096     DepTaskArgs[1] = ThreadID;
5097     DepTaskArgs[2] = NewTask;
5098     DepTaskArgs[3] = NumOfElements;
5099     DepTaskArgs[4] = DependenciesArray.getPointer();
5100     DepTaskArgs[5] = CGF.Builder.getInt32(0);
5101     DepTaskArgs[6] = llvm::ConstantPointerNull::get(CGF.VoidPtrTy);
5102   }
5103   auto &&ThenCodeGen = [this, &Data, TDBase, KmpTaskTQTyRD, &TaskArgs,
5104                         &DepTaskArgs](CodeGenFunction &CGF, PrePostActionTy &) {
5105     if (!Data.Tied) {
5106       auto PartIdFI = std::next(KmpTaskTQTyRD->field_begin(), KmpTaskTPartId);
5107       LValue PartIdLVal = CGF.EmitLValueForField(TDBase, *PartIdFI);
5108       CGF.EmitStoreOfScalar(CGF.Builder.getInt32(0), PartIdLVal);
5109     }
5110     if (!Data.Dependences.empty()) {
5111       CGF.EmitRuntimeCall(
5112           OMPBuilder.getOrCreateRuntimeFunction(
5113               CGM.getModule(), OMPRTL___kmpc_omp_task_with_deps),
5114           DepTaskArgs);
5115     } else {
5116       CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
5117                               CGM.getModule(), OMPRTL___kmpc_omp_task),
5118                           TaskArgs);
5119     }
5120     // Check if parent region is untied and build return for untied task;
5121     if (auto *Region =
5122             dyn_cast_or_null<CGOpenMPRegionInfo>(CGF.CapturedStmtInfo))
5123       Region->emitUntiedSwitch(CGF);
5124   };
5125 
5126   llvm::Value *DepWaitTaskArgs[6];
5127   if (!Data.Dependences.empty()) {
5128     DepWaitTaskArgs[0] = UpLoc;
5129     DepWaitTaskArgs[1] = ThreadID;
5130     DepWaitTaskArgs[2] = NumOfElements;
5131     DepWaitTaskArgs[3] = DependenciesArray.getPointer();
5132     DepWaitTaskArgs[4] = CGF.Builder.getInt32(0);
5133     DepWaitTaskArgs[5] = llvm::ConstantPointerNull::get(CGF.VoidPtrTy);
5134   }
5135   auto &M = CGM.getModule();
5136   auto &&ElseCodeGen = [this, &M, &TaskArgs, ThreadID, NewTaskNewTaskTTy,
5137                         TaskEntry, &Data, &DepWaitTaskArgs,
5138                         Loc](CodeGenFunction &CGF, PrePostActionTy &) {
5139     CodeGenFunction::RunCleanupsScope LocalScope(CGF);
5140     // Build void __kmpc_omp_wait_deps(ident_t *, kmp_int32 gtid,
5141     // kmp_int32 ndeps, kmp_depend_info_t *dep_list, kmp_int32
5142     // ndeps_noalias, kmp_depend_info_t *noalias_dep_list); if dependence info
5143     // is specified.
5144     if (!Data.Dependences.empty())
5145       CGF.EmitRuntimeCall(
5146           OMPBuilder.getOrCreateRuntimeFunction(M, OMPRTL___kmpc_omp_wait_deps),
5147           DepWaitTaskArgs);
5148     // Call proxy_task_entry(gtid, new_task);
5149     auto &&CodeGen = [TaskEntry, ThreadID, NewTaskNewTaskTTy,
5150                       Loc](CodeGenFunction &CGF, PrePostActionTy &Action) {
5151       Action.Enter(CGF);
5152       llvm::Value *OutlinedFnArgs[] = {ThreadID, NewTaskNewTaskTTy};
5153       CGF.CGM.getOpenMPRuntime().emitOutlinedFunctionCall(CGF, Loc, TaskEntry,
5154                                                           OutlinedFnArgs);
5155     };
5156 
5157     // Build void __kmpc_omp_task_begin_if0(ident_t *, kmp_int32 gtid,
5158     // kmp_task_t *new_task);
5159     // Build void __kmpc_omp_task_complete_if0(ident_t *, kmp_int32 gtid,
5160     // kmp_task_t *new_task);
5161     RegionCodeGenTy RCG(CodeGen);
5162     CommonActionTy Action(OMPBuilder.getOrCreateRuntimeFunction(
5163                               M, OMPRTL___kmpc_omp_task_begin_if0),
5164                           TaskArgs,
5165                           OMPBuilder.getOrCreateRuntimeFunction(
5166                               M, OMPRTL___kmpc_omp_task_complete_if0),
5167                           TaskArgs);
5168     RCG.setAction(Action);
5169     RCG(CGF);
5170   };
5171 
5172   if (IfCond) {
5173     emitIfClause(CGF, IfCond, ThenCodeGen, ElseCodeGen);
5174   } else {
5175     RegionCodeGenTy ThenRCG(ThenCodeGen);
5176     ThenRCG(CGF);
5177   }
5178 }
5179 
5180 void CGOpenMPRuntime::emitTaskLoopCall(CodeGenFunction &CGF, SourceLocation Loc,
5181                                        const OMPLoopDirective &D,
5182                                        llvm::Function *TaskFunction,
5183                                        QualType SharedsTy, Address Shareds,
5184                                        const Expr *IfCond,
5185                                        const OMPTaskDataTy &Data) {
5186   if (!CGF.HaveInsertPoint())
5187     return;
5188   TaskResultTy Result =
5189       emitTaskInit(CGF, Loc, D, TaskFunction, SharedsTy, Shareds, Data);
5190   // NOTE: routine and part_id fields are initialized by __kmpc_omp_task_alloc()
5191   // libcall.
5192   // Call to void __kmpc_taskloop(ident_t *loc, int gtid, kmp_task_t *task, int
5193   // if_val, kmp_uint64 *lb, kmp_uint64 *ub, kmp_int64 st, int nogroup, int
5194   // sched, kmp_uint64 grainsize, void *task_dup);
5195   llvm::Value *ThreadID = getThreadID(CGF, Loc);
5196   llvm::Value *UpLoc = emitUpdateLocation(CGF, Loc);
5197   llvm::Value *IfVal;
5198   if (IfCond) {
5199     IfVal = CGF.Builder.CreateIntCast(CGF.EvaluateExprAsBool(IfCond), CGF.IntTy,
5200                                       /*isSigned=*/true);
5201   } else {
5202     IfVal = llvm::ConstantInt::getSigned(CGF.IntTy, /*V=*/1);
5203   }
5204 
5205   LValue LBLVal = CGF.EmitLValueForField(
5206       Result.TDBase,
5207       *std::next(Result.KmpTaskTQTyRD->field_begin(), KmpTaskTLowerBound));
5208   const auto *LBVar =
5209       cast<VarDecl>(cast<DeclRefExpr>(D.getLowerBoundVariable())->getDecl());
5210   CGF.EmitAnyExprToMem(LBVar->getInit(), LBLVal.getAddress(CGF),
5211                        LBLVal.getQuals(),
5212                        /*IsInitializer=*/true);
5213   LValue UBLVal = CGF.EmitLValueForField(
5214       Result.TDBase,
5215       *std::next(Result.KmpTaskTQTyRD->field_begin(), KmpTaskTUpperBound));
5216   const auto *UBVar =
5217       cast<VarDecl>(cast<DeclRefExpr>(D.getUpperBoundVariable())->getDecl());
5218   CGF.EmitAnyExprToMem(UBVar->getInit(), UBLVal.getAddress(CGF),
5219                        UBLVal.getQuals(),
5220                        /*IsInitializer=*/true);
5221   LValue StLVal = CGF.EmitLValueForField(
5222       Result.TDBase,
5223       *std::next(Result.KmpTaskTQTyRD->field_begin(), KmpTaskTStride));
5224   const auto *StVar =
5225       cast<VarDecl>(cast<DeclRefExpr>(D.getStrideVariable())->getDecl());
5226   CGF.EmitAnyExprToMem(StVar->getInit(), StLVal.getAddress(CGF),
5227                        StLVal.getQuals(),
5228                        /*IsInitializer=*/true);
5229   // Store reductions address.
5230   LValue RedLVal = CGF.EmitLValueForField(
5231       Result.TDBase,
5232       *std::next(Result.KmpTaskTQTyRD->field_begin(), KmpTaskTReductions));
5233   if (Data.Reductions) {
5234     CGF.EmitStoreOfScalar(Data.Reductions, RedLVal);
5235   } else {
5236     CGF.EmitNullInitialization(RedLVal.getAddress(CGF),
5237                                CGF.getContext().VoidPtrTy);
5238   }
5239   enum { NoSchedule = 0, Grainsize = 1, NumTasks = 2 };
5240   llvm::Value *TaskArgs[] = {
5241       UpLoc,
5242       ThreadID,
5243       Result.NewTask,
5244       IfVal,
5245       LBLVal.getPointer(CGF),
5246       UBLVal.getPointer(CGF),
5247       CGF.EmitLoadOfScalar(StLVal, Loc),
5248       llvm::ConstantInt::getSigned(
5249           CGF.IntTy, 1), // Always 1 because taskgroup emitted by the compiler
5250       llvm::ConstantInt::getSigned(
5251           CGF.IntTy, Data.Schedule.getPointer()
5252                          ? Data.Schedule.getInt() ? NumTasks : Grainsize
5253                          : NoSchedule),
5254       Data.Schedule.getPointer()
5255           ? CGF.Builder.CreateIntCast(Data.Schedule.getPointer(), CGF.Int64Ty,
5256                                       /*isSigned=*/false)
5257           : llvm::ConstantInt::get(CGF.Int64Ty, /*V=*/0),
5258       Result.TaskDupFn ? CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
5259                              Result.TaskDupFn, CGF.VoidPtrTy)
5260                        : llvm::ConstantPointerNull::get(CGF.VoidPtrTy)};
5261   CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
5262                           CGM.getModule(), OMPRTL___kmpc_taskloop),
5263                       TaskArgs);
5264 }
5265 
5266 /// Emit reduction operation for each element of array (required for
5267 /// array sections) LHS op = RHS.
5268 /// \param Type Type of array.
5269 /// \param LHSVar Variable on the left side of the reduction operation
5270 /// (references element of array in original variable).
5271 /// \param RHSVar Variable on the right side of the reduction operation
5272 /// (references element of array in original variable).
5273 /// \param RedOpGen Generator of reduction operation with use of LHSVar and
5274 /// RHSVar.
5275 static void EmitOMPAggregateReduction(
5276     CodeGenFunction &CGF, QualType Type, const VarDecl *LHSVar,
5277     const VarDecl *RHSVar,
5278     const llvm::function_ref<void(CodeGenFunction &CGF, const Expr *,
5279                                   const Expr *, const Expr *)> &RedOpGen,
5280     const Expr *XExpr = nullptr, const Expr *EExpr = nullptr,
5281     const Expr *UpExpr = nullptr) {
5282   // Perform element-by-element initialization.
5283   QualType ElementTy;
5284   Address LHSAddr = CGF.GetAddrOfLocalVar(LHSVar);
5285   Address RHSAddr = CGF.GetAddrOfLocalVar(RHSVar);
5286 
5287   // Drill down to the base element type on both arrays.
5288   const ArrayType *ArrayTy = Type->getAsArrayTypeUnsafe();
5289   llvm::Value *NumElements = CGF.emitArrayLength(ArrayTy, ElementTy, LHSAddr);
5290 
5291   llvm::Value *RHSBegin = RHSAddr.getPointer();
5292   llvm::Value *LHSBegin = LHSAddr.getPointer();
5293   // Cast from pointer to array type to pointer to single element.
5294   llvm::Value *LHSEnd = CGF.Builder.CreateGEP(LHSBegin, NumElements);
5295   // The basic structure here is a while-do loop.
5296   llvm::BasicBlock *BodyBB = CGF.createBasicBlock("omp.arraycpy.body");
5297   llvm::BasicBlock *DoneBB = CGF.createBasicBlock("omp.arraycpy.done");
5298   llvm::Value *IsEmpty =
5299       CGF.Builder.CreateICmpEQ(LHSBegin, LHSEnd, "omp.arraycpy.isempty");
5300   CGF.Builder.CreateCondBr(IsEmpty, DoneBB, BodyBB);
5301 
5302   // Enter the loop body, making that address the current address.
5303   llvm::BasicBlock *EntryBB = CGF.Builder.GetInsertBlock();
5304   CGF.EmitBlock(BodyBB);
5305 
5306   CharUnits ElementSize = CGF.getContext().getTypeSizeInChars(ElementTy);
5307 
5308   llvm::PHINode *RHSElementPHI = CGF.Builder.CreatePHI(
5309       RHSBegin->getType(), 2, "omp.arraycpy.srcElementPast");
5310   RHSElementPHI->addIncoming(RHSBegin, EntryBB);
5311   Address RHSElementCurrent =
5312       Address(RHSElementPHI,
5313               RHSAddr.getAlignment().alignmentOfArrayElement(ElementSize));
5314 
5315   llvm::PHINode *LHSElementPHI = CGF.Builder.CreatePHI(
5316       LHSBegin->getType(), 2, "omp.arraycpy.destElementPast");
5317   LHSElementPHI->addIncoming(LHSBegin, EntryBB);
5318   Address LHSElementCurrent =
5319       Address(LHSElementPHI,
5320               LHSAddr.getAlignment().alignmentOfArrayElement(ElementSize));
5321 
5322   // Emit copy.
5323   CodeGenFunction::OMPPrivateScope Scope(CGF);
5324   Scope.addPrivate(LHSVar, [=]() { return LHSElementCurrent; });
5325   Scope.addPrivate(RHSVar, [=]() { return RHSElementCurrent; });
5326   Scope.Privatize();
5327   RedOpGen(CGF, XExpr, EExpr, UpExpr);
5328   Scope.ForceCleanup();
5329 
5330   // Shift the address forward by one element.
5331   llvm::Value *LHSElementNext = CGF.Builder.CreateConstGEP1_32(
5332       LHSElementPHI, /*Idx0=*/1, "omp.arraycpy.dest.element");
5333   llvm::Value *RHSElementNext = CGF.Builder.CreateConstGEP1_32(
5334       RHSElementPHI, /*Idx0=*/1, "omp.arraycpy.src.element");
5335   // Check whether we've reached the end.
5336   llvm::Value *Done =
5337       CGF.Builder.CreateICmpEQ(LHSElementNext, LHSEnd, "omp.arraycpy.done");
5338   CGF.Builder.CreateCondBr(Done, DoneBB, BodyBB);
5339   LHSElementPHI->addIncoming(LHSElementNext, CGF.Builder.GetInsertBlock());
5340   RHSElementPHI->addIncoming(RHSElementNext, CGF.Builder.GetInsertBlock());
5341 
5342   // Done.
5343   CGF.EmitBlock(DoneBB, /*IsFinished=*/true);
5344 }
5345 
5346 /// Emit reduction combiner. If the combiner is a simple expression emit it as
5347 /// is, otherwise consider it as combiner of UDR decl and emit it as a call of
5348 /// UDR combiner function.
5349 static void emitReductionCombiner(CodeGenFunction &CGF,
5350                                   const Expr *ReductionOp) {
5351   if (const auto *CE = dyn_cast<CallExpr>(ReductionOp))
5352     if (const auto *OVE = dyn_cast<OpaqueValueExpr>(CE->getCallee()))
5353       if (const auto *DRE =
5354               dyn_cast<DeclRefExpr>(OVE->getSourceExpr()->IgnoreImpCasts()))
5355         if (const auto *DRD =
5356                 dyn_cast<OMPDeclareReductionDecl>(DRE->getDecl())) {
5357           std::pair<llvm::Function *, llvm::Function *> Reduction =
5358               CGF.CGM.getOpenMPRuntime().getUserDefinedReduction(DRD);
5359           RValue Func = RValue::get(Reduction.first);
5360           CodeGenFunction::OpaqueValueMapping Map(CGF, OVE, Func);
5361           CGF.EmitIgnoredExpr(ReductionOp);
5362           return;
5363         }
5364   CGF.EmitIgnoredExpr(ReductionOp);
5365 }
5366 
5367 llvm::Function *CGOpenMPRuntime::emitReductionFunction(
5368     SourceLocation Loc, llvm::Type *ArgsType, ArrayRef<const Expr *> Privates,
5369     ArrayRef<const Expr *> LHSExprs, ArrayRef<const Expr *> RHSExprs,
5370     ArrayRef<const Expr *> ReductionOps) {
5371   ASTContext &C = CGM.getContext();
5372 
5373   // void reduction_func(void *LHSArg, void *RHSArg);
5374   FunctionArgList Args;
5375   ImplicitParamDecl LHSArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, C.VoidPtrTy,
5376                            ImplicitParamDecl::Other);
5377   ImplicitParamDecl RHSArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, C.VoidPtrTy,
5378                            ImplicitParamDecl::Other);
5379   Args.push_back(&LHSArg);
5380   Args.push_back(&RHSArg);
5381   const auto &CGFI =
5382       CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, Args);
5383   std::string Name = getName({"omp", "reduction", "reduction_func"});
5384   auto *Fn = llvm::Function::Create(CGM.getTypes().GetFunctionType(CGFI),
5385                                     llvm::GlobalValue::InternalLinkage, Name,
5386                                     &CGM.getModule());
5387   CGM.SetInternalFunctionAttributes(GlobalDecl(), Fn, CGFI);
5388   Fn->setDoesNotRecurse();
5389   CodeGenFunction CGF(CGM);
5390   CGF.StartFunction(GlobalDecl(), C.VoidTy, Fn, CGFI, Args, Loc, Loc);
5391 
5392   // Dst = (void*[n])(LHSArg);
5393   // Src = (void*[n])(RHSArg);
5394   Address LHS(CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
5395       CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&LHSArg)),
5396       ArgsType), CGF.getPointerAlign());
5397   Address RHS(CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
5398       CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&RHSArg)),
5399       ArgsType), CGF.getPointerAlign());
5400 
5401   //  ...
5402   //  *(Type<i>*)lhs[i] = RedOp<i>(*(Type<i>*)lhs[i], *(Type<i>*)rhs[i]);
5403   //  ...
5404   CodeGenFunction::OMPPrivateScope Scope(CGF);
5405   auto IPriv = Privates.begin();
5406   unsigned Idx = 0;
5407   for (unsigned I = 0, E = ReductionOps.size(); I < E; ++I, ++IPriv, ++Idx) {
5408     const auto *RHSVar =
5409         cast<VarDecl>(cast<DeclRefExpr>(RHSExprs[I])->getDecl());
5410     Scope.addPrivate(RHSVar, [&CGF, RHS, Idx, RHSVar]() {
5411       return emitAddrOfVarFromArray(CGF, RHS, Idx, RHSVar);
5412     });
5413     const auto *LHSVar =
5414         cast<VarDecl>(cast<DeclRefExpr>(LHSExprs[I])->getDecl());
5415     Scope.addPrivate(LHSVar, [&CGF, LHS, Idx, LHSVar]() {
5416       return emitAddrOfVarFromArray(CGF, LHS, Idx, LHSVar);
5417     });
5418     QualType PrivTy = (*IPriv)->getType();
5419     if (PrivTy->isVariablyModifiedType()) {
5420       // Get array size and emit VLA type.
5421       ++Idx;
5422       Address Elem = CGF.Builder.CreateConstArrayGEP(LHS, Idx);
5423       llvm::Value *Ptr = CGF.Builder.CreateLoad(Elem);
5424       const VariableArrayType *VLA =
5425           CGF.getContext().getAsVariableArrayType(PrivTy);
5426       const auto *OVE = cast<OpaqueValueExpr>(VLA->getSizeExpr());
5427       CodeGenFunction::OpaqueValueMapping OpaqueMap(
5428           CGF, OVE, RValue::get(CGF.Builder.CreatePtrToInt(Ptr, CGF.SizeTy)));
5429       CGF.EmitVariablyModifiedType(PrivTy);
5430     }
5431   }
5432   Scope.Privatize();
5433   IPriv = Privates.begin();
5434   auto ILHS = LHSExprs.begin();
5435   auto IRHS = RHSExprs.begin();
5436   for (const Expr *E : ReductionOps) {
5437     if ((*IPriv)->getType()->isArrayType()) {
5438       // Emit reduction for array section.
5439       const auto *LHSVar = cast<VarDecl>(cast<DeclRefExpr>(*ILHS)->getDecl());
5440       const auto *RHSVar = cast<VarDecl>(cast<DeclRefExpr>(*IRHS)->getDecl());
5441       EmitOMPAggregateReduction(
5442           CGF, (*IPriv)->getType(), LHSVar, RHSVar,
5443           [=](CodeGenFunction &CGF, const Expr *, const Expr *, const Expr *) {
5444             emitReductionCombiner(CGF, E);
5445           });
5446     } else {
5447       // Emit reduction for array subscript or single variable.
5448       emitReductionCombiner(CGF, E);
5449     }
5450     ++IPriv;
5451     ++ILHS;
5452     ++IRHS;
5453   }
5454   Scope.ForceCleanup();
5455   CGF.FinishFunction();
5456   return Fn;
5457 }
5458 
5459 void CGOpenMPRuntime::emitSingleReductionCombiner(CodeGenFunction &CGF,
5460                                                   const Expr *ReductionOp,
5461                                                   const Expr *PrivateRef,
5462                                                   const DeclRefExpr *LHS,
5463                                                   const DeclRefExpr *RHS) {
5464   if (PrivateRef->getType()->isArrayType()) {
5465     // Emit reduction for array section.
5466     const auto *LHSVar = cast<VarDecl>(LHS->getDecl());
5467     const auto *RHSVar = cast<VarDecl>(RHS->getDecl());
5468     EmitOMPAggregateReduction(
5469         CGF, PrivateRef->getType(), LHSVar, RHSVar,
5470         [=](CodeGenFunction &CGF, const Expr *, const Expr *, const Expr *) {
5471           emitReductionCombiner(CGF, ReductionOp);
5472         });
5473   } else {
5474     // Emit reduction for array subscript or single variable.
5475     emitReductionCombiner(CGF, ReductionOp);
5476   }
5477 }
5478 
5479 void CGOpenMPRuntime::emitReduction(CodeGenFunction &CGF, SourceLocation Loc,
5480                                     ArrayRef<const Expr *> Privates,
5481                                     ArrayRef<const Expr *> LHSExprs,
5482                                     ArrayRef<const Expr *> RHSExprs,
5483                                     ArrayRef<const Expr *> ReductionOps,
5484                                     ReductionOptionsTy Options) {
5485   if (!CGF.HaveInsertPoint())
5486     return;
5487 
5488   bool WithNowait = Options.WithNowait;
5489   bool SimpleReduction = Options.SimpleReduction;
5490 
5491   // Next code should be emitted for reduction:
5492   //
5493   // static kmp_critical_name lock = { 0 };
5494   //
5495   // void reduce_func(void *lhs[<n>], void *rhs[<n>]) {
5496   //  *(Type0*)lhs[0] = ReductionOperation0(*(Type0*)lhs[0], *(Type0*)rhs[0]);
5497   //  ...
5498   //  *(Type<n>-1*)lhs[<n>-1] = ReductionOperation<n>-1(*(Type<n>-1*)lhs[<n>-1],
5499   //  *(Type<n>-1*)rhs[<n>-1]);
5500   // }
5501   //
5502   // ...
5503   // void *RedList[<n>] = {&<RHSExprs>[0], ..., &<RHSExprs>[<n>-1]};
5504   // switch (__kmpc_reduce{_nowait}(<loc>, <gtid>, <n>, sizeof(RedList),
5505   // RedList, reduce_func, &<lock>)) {
5506   // case 1:
5507   //  ...
5508   //  <LHSExprs>[i] = RedOp<i>(*<LHSExprs>[i], *<RHSExprs>[i]);
5509   //  ...
5510   // __kmpc_end_reduce{_nowait}(<loc>, <gtid>, &<lock>);
5511   // break;
5512   // case 2:
5513   //  ...
5514   //  Atomic(<LHSExprs>[i] = RedOp<i>(*<LHSExprs>[i], *<RHSExprs>[i]));
5515   //  ...
5516   // [__kmpc_end_reduce(<loc>, <gtid>, &<lock>);]
5517   // break;
5518   // default:;
5519   // }
5520   //
5521   // if SimpleReduction is true, only the next code is generated:
5522   //  ...
5523   //  <LHSExprs>[i] = RedOp<i>(*<LHSExprs>[i], *<RHSExprs>[i]);
5524   //  ...
5525 
5526   ASTContext &C = CGM.getContext();
5527 
5528   if (SimpleReduction) {
5529     CodeGenFunction::RunCleanupsScope Scope(CGF);
5530     auto IPriv = Privates.begin();
5531     auto ILHS = LHSExprs.begin();
5532     auto IRHS = RHSExprs.begin();
5533     for (const Expr *E : ReductionOps) {
5534       emitSingleReductionCombiner(CGF, E, *IPriv, cast<DeclRefExpr>(*ILHS),
5535                                   cast<DeclRefExpr>(*IRHS));
5536       ++IPriv;
5537       ++ILHS;
5538       ++IRHS;
5539     }
5540     return;
5541   }
5542 
5543   // 1. Build a list of reduction variables.
5544   // void *RedList[<n>] = {<ReductionVars>[0], ..., <ReductionVars>[<n>-1]};
5545   auto Size = RHSExprs.size();
5546   for (const Expr *E : Privates) {
5547     if (E->getType()->isVariablyModifiedType())
5548       // Reserve place for array size.
5549       ++Size;
5550   }
5551   llvm::APInt ArraySize(/*unsigned int numBits=*/32, Size);
5552   QualType ReductionArrayTy =
5553       C.getConstantArrayType(C.VoidPtrTy, ArraySize, nullptr, ArrayType::Normal,
5554                              /*IndexTypeQuals=*/0);
5555   Address ReductionList =
5556       CGF.CreateMemTemp(ReductionArrayTy, ".omp.reduction.red_list");
5557   auto IPriv = Privates.begin();
5558   unsigned Idx = 0;
5559   for (unsigned I = 0, E = RHSExprs.size(); I < E; ++I, ++IPriv, ++Idx) {
5560     Address Elem = CGF.Builder.CreateConstArrayGEP(ReductionList, Idx);
5561     CGF.Builder.CreateStore(
5562         CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
5563             CGF.EmitLValue(RHSExprs[I]).getPointer(CGF), CGF.VoidPtrTy),
5564         Elem);
5565     if ((*IPriv)->getType()->isVariablyModifiedType()) {
5566       // Store array size.
5567       ++Idx;
5568       Elem = CGF.Builder.CreateConstArrayGEP(ReductionList, Idx);
5569       llvm::Value *Size = CGF.Builder.CreateIntCast(
5570           CGF.getVLASize(
5571                  CGF.getContext().getAsVariableArrayType((*IPriv)->getType()))
5572               .NumElts,
5573           CGF.SizeTy, /*isSigned=*/false);
5574       CGF.Builder.CreateStore(CGF.Builder.CreateIntToPtr(Size, CGF.VoidPtrTy),
5575                               Elem);
5576     }
5577   }
5578 
5579   // 2. Emit reduce_func().
5580   llvm::Function *ReductionFn = emitReductionFunction(
5581       Loc, CGF.ConvertTypeForMem(ReductionArrayTy)->getPointerTo(), Privates,
5582       LHSExprs, RHSExprs, ReductionOps);
5583 
5584   // 3. Create static kmp_critical_name lock = { 0 };
5585   std::string Name = getName({"reduction"});
5586   llvm::Value *Lock = getCriticalRegionLock(Name);
5587 
5588   // 4. Build res = __kmpc_reduce{_nowait}(<loc>, <gtid>, <n>, sizeof(RedList),
5589   // RedList, reduce_func, &<lock>);
5590   llvm::Value *IdentTLoc = emitUpdateLocation(CGF, Loc, OMP_ATOMIC_REDUCE);
5591   llvm::Value *ThreadId = getThreadID(CGF, Loc);
5592   llvm::Value *ReductionArrayTySize = CGF.getTypeSize(ReductionArrayTy);
5593   llvm::Value *RL = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
5594       ReductionList.getPointer(), CGF.VoidPtrTy);
5595   llvm::Value *Args[] = {
5596       IdentTLoc,                             // ident_t *<loc>
5597       ThreadId,                              // i32 <gtid>
5598       CGF.Builder.getInt32(RHSExprs.size()), // i32 <n>
5599       ReductionArrayTySize,                  // size_type sizeof(RedList)
5600       RL,                                    // void *RedList
5601       ReductionFn, // void (*) (void *, void *) <reduce_func>
5602       Lock         // kmp_critical_name *&<lock>
5603   };
5604   llvm::Value *Res = CGF.EmitRuntimeCall(
5605       OMPBuilder.getOrCreateRuntimeFunction(
5606           CGM.getModule(),
5607           WithNowait ? OMPRTL___kmpc_reduce_nowait : OMPRTL___kmpc_reduce),
5608       Args);
5609 
5610   // 5. Build switch(res)
5611   llvm::BasicBlock *DefaultBB = CGF.createBasicBlock(".omp.reduction.default");
5612   llvm::SwitchInst *SwInst =
5613       CGF.Builder.CreateSwitch(Res, DefaultBB, /*NumCases=*/2);
5614 
5615   // 6. Build case 1:
5616   //  ...
5617   //  <LHSExprs>[i] = RedOp<i>(*<LHSExprs>[i], *<RHSExprs>[i]);
5618   //  ...
5619   // __kmpc_end_reduce{_nowait}(<loc>, <gtid>, &<lock>);
5620   // break;
5621   llvm::BasicBlock *Case1BB = CGF.createBasicBlock(".omp.reduction.case1");
5622   SwInst->addCase(CGF.Builder.getInt32(1), Case1BB);
5623   CGF.EmitBlock(Case1BB);
5624 
5625   // Add emission of __kmpc_end_reduce{_nowait}(<loc>, <gtid>, &<lock>);
5626   llvm::Value *EndArgs[] = {
5627       IdentTLoc, // ident_t *<loc>
5628       ThreadId,  // i32 <gtid>
5629       Lock       // kmp_critical_name *&<lock>
5630   };
5631   auto &&CodeGen = [Privates, LHSExprs, RHSExprs, ReductionOps](
5632                        CodeGenFunction &CGF, PrePostActionTy &Action) {
5633     CGOpenMPRuntime &RT = CGF.CGM.getOpenMPRuntime();
5634     auto IPriv = Privates.begin();
5635     auto ILHS = LHSExprs.begin();
5636     auto IRHS = RHSExprs.begin();
5637     for (const Expr *E : ReductionOps) {
5638       RT.emitSingleReductionCombiner(CGF, E, *IPriv, cast<DeclRefExpr>(*ILHS),
5639                                      cast<DeclRefExpr>(*IRHS));
5640       ++IPriv;
5641       ++ILHS;
5642       ++IRHS;
5643     }
5644   };
5645   RegionCodeGenTy RCG(CodeGen);
5646   CommonActionTy Action(
5647       nullptr, llvm::None,
5648       OMPBuilder.getOrCreateRuntimeFunction(
5649           CGM.getModule(), WithNowait ? OMPRTL___kmpc_end_reduce_nowait
5650                                       : OMPRTL___kmpc_end_reduce),
5651       EndArgs);
5652   RCG.setAction(Action);
5653   RCG(CGF);
5654 
5655   CGF.EmitBranch(DefaultBB);
5656 
5657   // 7. Build case 2:
5658   //  ...
5659   //  Atomic(<LHSExprs>[i] = RedOp<i>(*<LHSExprs>[i], *<RHSExprs>[i]));
5660   //  ...
5661   // break;
5662   llvm::BasicBlock *Case2BB = CGF.createBasicBlock(".omp.reduction.case2");
5663   SwInst->addCase(CGF.Builder.getInt32(2), Case2BB);
5664   CGF.EmitBlock(Case2BB);
5665 
5666   auto &&AtomicCodeGen = [Loc, Privates, LHSExprs, RHSExprs, ReductionOps](
5667                              CodeGenFunction &CGF, PrePostActionTy &Action) {
5668     auto ILHS = LHSExprs.begin();
5669     auto IRHS = RHSExprs.begin();
5670     auto IPriv = Privates.begin();
5671     for (const Expr *E : ReductionOps) {
5672       const Expr *XExpr = nullptr;
5673       const Expr *EExpr = nullptr;
5674       const Expr *UpExpr = nullptr;
5675       BinaryOperatorKind BO = BO_Comma;
5676       if (const auto *BO = dyn_cast<BinaryOperator>(E)) {
5677         if (BO->getOpcode() == BO_Assign) {
5678           XExpr = BO->getLHS();
5679           UpExpr = BO->getRHS();
5680         }
5681       }
5682       // Try to emit update expression as a simple atomic.
5683       const Expr *RHSExpr = UpExpr;
5684       if (RHSExpr) {
5685         // Analyze RHS part of the whole expression.
5686         if (const auto *ACO = dyn_cast<AbstractConditionalOperator>(
5687                 RHSExpr->IgnoreParenImpCasts())) {
5688           // If this is a conditional operator, analyze its condition for
5689           // min/max reduction operator.
5690           RHSExpr = ACO->getCond();
5691         }
5692         if (const auto *BORHS =
5693                 dyn_cast<BinaryOperator>(RHSExpr->IgnoreParenImpCasts())) {
5694           EExpr = BORHS->getRHS();
5695           BO = BORHS->getOpcode();
5696         }
5697       }
5698       if (XExpr) {
5699         const auto *VD = cast<VarDecl>(cast<DeclRefExpr>(*ILHS)->getDecl());
5700         auto &&AtomicRedGen = [BO, VD,
5701                                Loc](CodeGenFunction &CGF, const Expr *XExpr,
5702                                     const Expr *EExpr, const Expr *UpExpr) {
5703           LValue X = CGF.EmitLValue(XExpr);
5704           RValue E;
5705           if (EExpr)
5706             E = CGF.EmitAnyExpr(EExpr);
5707           CGF.EmitOMPAtomicSimpleUpdateExpr(
5708               X, E, BO, /*IsXLHSInRHSPart=*/true,
5709               llvm::AtomicOrdering::Monotonic, Loc,
5710               [&CGF, UpExpr, VD, Loc](RValue XRValue) {
5711                 CodeGenFunction::OMPPrivateScope PrivateScope(CGF);
5712                 PrivateScope.addPrivate(
5713                     VD, [&CGF, VD, XRValue, Loc]() {
5714                       Address LHSTemp = CGF.CreateMemTemp(VD->getType());
5715                       CGF.emitOMPSimpleStore(
5716                           CGF.MakeAddrLValue(LHSTemp, VD->getType()), XRValue,
5717                           VD->getType().getNonReferenceType(), Loc);
5718                       return LHSTemp;
5719                     });
5720                 (void)PrivateScope.Privatize();
5721                 return CGF.EmitAnyExpr(UpExpr);
5722               });
5723         };
5724         if ((*IPriv)->getType()->isArrayType()) {
5725           // Emit atomic reduction for array section.
5726           const auto *RHSVar =
5727               cast<VarDecl>(cast<DeclRefExpr>(*IRHS)->getDecl());
5728           EmitOMPAggregateReduction(CGF, (*IPriv)->getType(), VD, RHSVar,
5729                                     AtomicRedGen, XExpr, EExpr, UpExpr);
5730         } else {
5731           // Emit atomic reduction for array subscript or single variable.
5732           AtomicRedGen(CGF, XExpr, EExpr, UpExpr);
5733         }
5734       } else {
5735         // Emit as a critical region.
5736         auto &&CritRedGen = [E, Loc](CodeGenFunction &CGF, const Expr *,
5737                                            const Expr *, const Expr *) {
5738           CGOpenMPRuntime &RT = CGF.CGM.getOpenMPRuntime();
5739           std::string Name = RT.getName({"atomic_reduction"});
5740           RT.emitCriticalRegion(
5741               CGF, Name,
5742               [=](CodeGenFunction &CGF, PrePostActionTy &Action) {
5743                 Action.Enter(CGF);
5744                 emitReductionCombiner(CGF, E);
5745               },
5746               Loc);
5747         };
5748         if ((*IPriv)->getType()->isArrayType()) {
5749           const auto *LHSVar =
5750               cast<VarDecl>(cast<DeclRefExpr>(*ILHS)->getDecl());
5751           const auto *RHSVar =
5752               cast<VarDecl>(cast<DeclRefExpr>(*IRHS)->getDecl());
5753           EmitOMPAggregateReduction(CGF, (*IPriv)->getType(), LHSVar, RHSVar,
5754                                     CritRedGen);
5755         } else {
5756           CritRedGen(CGF, nullptr, nullptr, nullptr);
5757         }
5758       }
5759       ++ILHS;
5760       ++IRHS;
5761       ++IPriv;
5762     }
5763   };
5764   RegionCodeGenTy AtomicRCG(AtomicCodeGen);
5765   if (!WithNowait) {
5766     // Add emission of __kmpc_end_reduce(<loc>, <gtid>, &<lock>);
5767     llvm::Value *EndArgs[] = {
5768         IdentTLoc, // ident_t *<loc>
5769         ThreadId,  // i32 <gtid>
5770         Lock       // kmp_critical_name *&<lock>
5771     };
5772     CommonActionTy Action(nullptr, llvm::None,
5773                           OMPBuilder.getOrCreateRuntimeFunction(
5774                               CGM.getModule(), OMPRTL___kmpc_end_reduce),
5775                           EndArgs);
5776     AtomicRCG.setAction(Action);
5777     AtomicRCG(CGF);
5778   } else {
5779     AtomicRCG(CGF);
5780   }
5781 
5782   CGF.EmitBranch(DefaultBB);
5783   CGF.EmitBlock(DefaultBB, /*IsFinished=*/true);
5784 }
5785 
5786 /// Generates unique name for artificial threadprivate variables.
5787 /// Format is: <Prefix> "." <Decl_mangled_name> "_" "<Decl_start_loc_raw_enc>"
5788 static std::string generateUniqueName(CodeGenModule &CGM, StringRef Prefix,
5789                                       const Expr *Ref) {
5790   SmallString<256> Buffer;
5791   llvm::raw_svector_ostream Out(Buffer);
5792   const clang::DeclRefExpr *DE;
5793   const VarDecl *D = ::getBaseDecl(Ref, DE);
5794   if (!D)
5795     D = cast<VarDecl>(cast<DeclRefExpr>(Ref)->getDecl());
5796   D = D->getCanonicalDecl();
5797   std::string Name = CGM.getOpenMPRuntime().getName(
5798       {D->isLocalVarDeclOrParm() ? D->getName() : CGM.getMangledName(D)});
5799   Out << Prefix << Name << "_"
5800       << D->getCanonicalDecl()->getBeginLoc().getRawEncoding();
5801   return std::string(Out.str());
5802 }
5803 
5804 /// Emits reduction initializer function:
5805 /// \code
5806 /// void @.red_init(void* %arg, void* %orig) {
5807 /// %0 = bitcast void* %arg to <type>*
5808 /// store <type> <init>, <type>* %0
5809 /// ret void
5810 /// }
5811 /// \endcode
5812 static llvm::Value *emitReduceInitFunction(CodeGenModule &CGM,
5813                                            SourceLocation Loc,
5814                                            ReductionCodeGen &RCG, unsigned N) {
5815   ASTContext &C = CGM.getContext();
5816   QualType VoidPtrTy = C.VoidPtrTy;
5817   VoidPtrTy.addRestrict();
5818   FunctionArgList Args;
5819   ImplicitParamDecl Param(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, VoidPtrTy,
5820                           ImplicitParamDecl::Other);
5821   ImplicitParamDecl ParamOrig(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, VoidPtrTy,
5822                               ImplicitParamDecl::Other);
5823   Args.emplace_back(&Param);
5824   Args.emplace_back(&ParamOrig);
5825   const auto &FnInfo =
5826       CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, Args);
5827   llvm::FunctionType *FnTy = CGM.getTypes().GetFunctionType(FnInfo);
5828   std::string Name = CGM.getOpenMPRuntime().getName({"red_init", ""});
5829   auto *Fn = llvm::Function::Create(FnTy, llvm::GlobalValue::InternalLinkage,
5830                                     Name, &CGM.getModule());
5831   CGM.SetInternalFunctionAttributes(GlobalDecl(), Fn, FnInfo);
5832   Fn->setDoesNotRecurse();
5833   CodeGenFunction CGF(CGM);
5834   CGF.StartFunction(GlobalDecl(), C.VoidTy, Fn, FnInfo, Args, Loc, Loc);
5835   Address PrivateAddr = CGF.EmitLoadOfPointer(
5836       CGF.GetAddrOfLocalVar(&Param),
5837       C.getPointerType(C.VoidPtrTy).castAs<PointerType>());
5838   llvm::Value *Size = nullptr;
5839   // If the size of the reduction item is non-constant, load it from global
5840   // threadprivate variable.
5841   if (RCG.getSizes(N).second) {
5842     Address SizeAddr = CGM.getOpenMPRuntime().getAddrOfArtificialThreadPrivate(
5843         CGF, CGM.getContext().getSizeType(),
5844         generateUniqueName(CGM, "reduction_size", RCG.getRefExpr(N)));
5845     Size = CGF.EmitLoadOfScalar(SizeAddr, /*Volatile=*/false,
5846                                 CGM.getContext().getSizeType(), Loc);
5847   }
5848   RCG.emitAggregateType(CGF, N, Size);
5849   LValue OrigLVal;
5850   // If initializer uses initializer from declare reduction construct, emit a
5851   // pointer to the address of the original reduction item (reuired by reduction
5852   // initializer)
5853   if (RCG.usesReductionInitializer(N)) {
5854     Address SharedAddr = CGF.GetAddrOfLocalVar(&ParamOrig);
5855     SharedAddr = CGF.EmitLoadOfPointer(
5856         SharedAddr,
5857         CGM.getContext().VoidPtrTy.castAs<PointerType>()->getTypePtr());
5858     OrigLVal = CGF.MakeAddrLValue(SharedAddr, CGM.getContext().VoidPtrTy);
5859   } else {
5860     OrigLVal = CGF.MakeNaturalAlignAddrLValue(
5861         llvm::ConstantPointerNull::get(CGM.VoidPtrTy),
5862         CGM.getContext().VoidPtrTy);
5863   }
5864   // Emit the initializer:
5865   // %0 = bitcast void* %arg to <type>*
5866   // store <type> <init>, <type>* %0
5867   RCG.emitInitialization(CGF, N, PrivateAddr, OrigLVal,
5868                          [](CodeGenFunction &) { return false; });
5869   CGF.FinishFunction();
5870   return Fn;
5871 }
5872 
5873 /// Emits reduction combiner function:
5874 /// \code
5875 /// void @.red_comb(void* %arg0, void* %arg1) {
5876 /// %lhs = bitcast void* %arg0 to <type>*
5877 /// %rhs = bitcast void* %arg1 to <type>*
5878 /// %2 = <ReductionOp>(<type>* %lhs, <type>* %rhs)
5879 /// store <type> %2, <type>* %lhs
5880 /// ret void
5881 /// }
5882 /// \endcode
5883 static llvm::Value *emitReduceCombFunction(CodeGenModule &CGM,
5884                                            SourceLocation Loc,
5885                                            ReductionCodeGen &RCG, unsigned N,
5886                                            const Expr *ReductionOp,
5887                                            const Expr *LHS, const Expr *RHS,
5888                                            const Expr *PrivateRef) {
5889   ASTContext &C = CGM.getContext();
5890   const auto *LHSVD = cast<VarDecl>(cast<DeclRefExpr>(LHS)->getDecl());
5891   const auto *RHSVD = cast<VarDecl>(cast<DeclRefExpr>(RHS)->getDecl());
5892   FunctionArgList Args;
5893   ImplicitParamDecl ParamInOut(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr,
5894                                C.VoidPtrTy, ImplicitParamDecl::Other);
5895   ImplicitParamDecl ParamIn(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, C.VoidPtrTy,
5896                             ImplicitParamDecl::Other);
5897   Args.emplace_back(&ParamInOut);
5898   Args.emplace_back(&ParamIn);
5899   const auto &FnInfo =
5900       CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, Args);
5901   llvm::FunctionType *FnTy = CGM.getTypes().GetFunctionType(FnInfo);
5902   std::string Name = CGM.getOpenMPRuntime().getName({"red_comb", ""});
5903   auto *Fn = llvm::Function::Create(FnTy, llvm::GlobalValue::InternalLinkage,
5904                                     Name, &CGM.getModule());
5905   CGM.SetInternalFunctionAttributes(GlobalDecl(), Fn, FnInfo);
5906   Fn->setDoesNotRecurse();
5907   CodeGenFunction CGF(CGM);
5908   CGF.StartFunction(GlobalDecl(), C.VoidTy, Fn, FnInfo, Args, Loc, Loc);
5909   llvm::Value *Size = nullptr;
5910   // If the size of the reduction item is non-constant, load it from global
5911   // threadprivate variable.
5912   if (RCG.getSizes(N).second) {
5913     Address SizeAddr = CGM.getOpenMPRuntime().getAddrOfArtificialThreadPrivate(
5914         CGF, CGM.getContext().getSizeType(),
5915         generateUniqueName(CGM, "reduction_size", RCG.getRefExpr(N)));
5916     Size = CGF.EmitLoadOfScalar(SizeAddr, /*Volatile=*/false,
5917                                 CGM.getContext().getSizeType(), Loc);
5918   }
5919   RCG.emitAggregateType(CGF, N, Size);
5920   // Remap lhs and rhs variables to the addresses of the function arguments.
5921   // %lhs = bitcast void* %arg0 to <type>*
5922   // %rhs = bitcast void* %arg1 to <type>*
5923   CodeGenFunction::OMPPrivateScope PrivateScope(CGF);
5924   PrivateScope.addPrivate(LHSVD, [&C, &CGF, &ParamInOut, LHSVD]() {
5925     // Pull out the pointer to the variable.
5926     Address PtrAddr = CGF.EmitLoadOfPointer(
5927         CGF.GetAddrOfLocalVar(&ParamInOut),
5928         C.getPointerType(C.VoidPtrTy).castAs<PointerType>());
5929     return CGF.Builder.CreateElementBitCast(
5930         PtrAddr, CGF.ConvertTypeForMem(LHSVD->getType()));
5931   });
5932   PrivateScope.addPrivate(RHSVD, [&C, &CGF, &ParamIn, RHSVD]() {
5933     // Pull out the pointer to the variable.
5934     Address PtrAddr = CGF.EmitLoadOfPointer(
5935         CGF.GetAddrOfLocalVar(&ParamIn),
5936         C.getPointerType(C.VoidPtrTy).castAs<PointerType>());
5937     return CGF.Builder.CreateElementBitCast(
5938         PtrAddr, CGF.ConvertTypeForMem(RHSVD->getType()));
5939   });
5940   PrivateScope.Privatize();
5941   // Emit the combiner body:
5942   // %2 = <ReductionOp>(<type> *%lhs, <type> *%rhs)
5943   // store <type> %2, <type>* %lhs
5944   CGM.getOpenMPRuntime().emitSingleReductionCombiner(
5945       CGF, ReductionOp, PrivateRef, cast<DeclRefExpr>(LHS),
5946       cast<DeclRefExpr>(RHS));
5947   CGF.FinishFunction();
5948   return Fn;
5949 }
5950 
5951 /// Emits reduction finalizer function:
5952 /// \code
5953 /// void @.red_fini(void* %arg) {
5954 /// %0 = bitcast void* %arg to <type>*
5955 /// <destroy>(<type>* %0)
5956 /// ret void
5957 /// }
5958 /// \endcode
5959 static llvm::Value *emitReduceFiniFunction(CodeGenModule &CGM,
5960                                            SourceLocation Loc,
5961                                            ReductionCodeGen &RCG, unsigned N) {
5962   if (!RCG.needCleanups(N))
5963     return nullptr;
5964   ASTContext &C = CGM.getContext();
5965   FunctionArgList Args;
5966   ImplicitParamDecl Param(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, C.VoidPtrTy,
5967                           ImplicitParamDecl::Other);
5968   Args.emplace_back(&Param);
5969   const auto &FnInfo =
5970       CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, Args);
5971   llvm::FunctionType *FnTy = CGM.getTypes().GetFunctionType(FnInfo);
5972   std::string Name = CGM.getOpenMPRuntime().getName({"red_fini", ""});
5973   auto *Fn = llvm::Function::Create(FnTy, llvm::GlobalValue::InternalLinkage,
5974                                     Name, &CGM.getModule());
5975   CGM.SetInternalFunctionAttributes(GlobalDecl(), Fn, FnInfo);
5976   Fn->setDoesNotRecurse();
5977   CodeGenFunction CGF(CGM);
5978   CGF.StartFunction(GlobalDecl(), C.VoidTy, Fn, FnInfo, Args, Loc, Loc);
5979   Address PrivateAddr = CGF.EmitLoadOfPointer(
5980       CGF.GetAddrOfLocalVar(&Param),
5981       C.getPointerType(C.VoidPtrTy).castAs<PointerType>());
5982   llvm::Value *Size = nullptr;
5983   // If the size of the reduction item is non-constant, load it from global
5984   // threadprivate variable.
5985   if (RCG.getSizes(N).second) {
5986     Address SizeAddr = CGM.getOpenMPRuntime().getAddrOfArtificialThreadPrivate(
5987         CGF, CGM.getContext().getSizeType(),
5988         generateUniqueName(CGM, "reduction_size", RCG.getRefExpr(N)));
5989     Size = CGF.EmitLoadOfScalar(SizeAddr, /*Volatile=*/false,
5990                                 CGM.getContext().getSizeType(), Loc);
5991   }
5992   RCG.emitAggregateType(CGF, N, Size);
5993   // Emit the finalizer body:
5994   // <destroy>(<type>* %0)
5995   RCG.emitCleanups(CGF, N, PrivateAddr);
5996   CGF.FinishFunction(Loc);
5997   return Fn;
5998 }
5999 
6000 llvm::Value *CGOpenMPRuntime::emitTaskReductionInit(
6001     CodeGenFunction &CGF, SourceLocation Loc, ArrayRef<const Expr *> LHSExprs,
6002     ArrayRef<const Expr *> RHSExprs, const OMPTaskDataTy &Data) {
6003   if (!CGF.HaveInsertPoint() || Data.ReductionVars.empty())
6004     return nullptr;
6005 
6006   // Build typedef struct:
6007   // kmp_taskred_input {
6008   //   void *reduce_shar; // shared reduction item
6009   //   void *reduce_orig; // original reduction item used for initialization
6010   //   size_t reduce_size; // size of data item
6011   //   void *reduce_init; // data initialization routine
6012   //   void *reduce_fini; // data finalization routine
6013   //   void *reduce_comb; // data combiner routine
6014   //   kmp_task_red_flags_t flags; // flags for additional info from compiler
6015   // } kmp_taskred_input_t;
6016   ASTContext &C = CGM.getContext();
6017   RecordDecl *RD = C.buildImplicitRecord("kmp_taskred_input_t");
6018   RD->startDefinition();
6019   const FieldDecl *SharedFD = addFieldToRecordDecl(C, RD, C.VoidPtrTy);
6020   const FieldDecl *OrigFD = addFieldToRecordDecl(C, RD, C.VoidPtrTy);
6021   const FieldDecl *SizeFD = addFieldToRecordDecl(C, RD, C.getSizeType());
6022   const FieldDecl *InitFD  = addFieldToRecordDecl(C, RD, C.VoidPtrTy);
6023   const FieldDecl *FiniFD = addFieldToRecordDecl(C, RD, C.VoidPtrTy);
6024   const FieldDecl *CombFD = addFieldToRecordDecl(C, RD, C.VoidPtrTy);
6025   const FieldDecl *FlagsFD = addFieldToRecordDecl(
6026       C, RD, C.getIntTypeForBitwidth(/*DestWidth=*/32, /*Signed=*/false));
6027   RD->completeDefinition();
6028   QualType RDType = C.getRecordType(RD);
6029   unsigned Size = Data.ReductionVars.size();
6030   llvm::APInt ArraySize(/*numBits=*/64, Size);
6031   QualType ArrayRDType = C.getConstantArrayType(
6032       RDType, ArraySize, nullptr, ArrayType::Normal, /*IndexTypeQuals=*/0);
6033   // kmp_task_red_input_t .rd_input.[Size];
6034   Address TaskRedInput = CGF.CreateMemTemp(ArrayRDType, ".rd_input.");
6035   ReductionCodeGen RCG(Data.ReductionVars, Data.ReductionOrigs,
6036                        Data.ReductionCopies, Data.ReductionOps);
6037   for (unsigned Cnt = 0; Cnt < Size; ++Cnt) {
6038     // kmp_task_red_input_t &ElemLVal = .rd_input.[Cnt];
6039     llvm::Value *Idxs[] = {llvm::ConstantInt::get(CGM.SizeTy, /*V=*/0),
6040                            llvm::ConstantInt::get(CGM.SizeTy, Cnt)};
6041     llvm::Value *GEP = CGF.EmitCheckedInBoundsGEP(
6042         TaskRedInput.getPointer(), Idxs,
6043         /*SignedIndices=*/false, /*IsSubtraction=*/false, Loc,
6044         ".rd_input.gep.");
6045     LValue ElemLVal = CGF.MakeNaturalAlignAddrLValue(GEP, RDType);
6046     // ElemLVal.reduce_shar = &Shareds[Cnt];
6047     LValue SharedLVal = CGF.EmitLValueForField(ElemLVal, SharedFD);
6048     RCG.emitSharedOrigLValue(CGF, Cnt);
6049     llvm::Value *CastedShared =
6050         CGF.EmitCastToVoidPtr(RCG.getSharedLValue(Cnt).getPointer(CGF));
6051     CGF.EmitStoreOfScalar(CastedShared, SharedLVal);
6052     // ElemLVal.reduce_orig = &Origs[Cnt];
6053     LValue OrigLVal = CGF.EmitLValueForField(ElemLVal, OrigFD);
6054     llvm::Value *CastedOrig =
6055         CGF.EmitCastToVoidPtr(RCG.getOrigLValue(Cnt).getPointer(CGF));
6056     CGF.EmitStoreOfScalar(CastedOrig, OrigLVal);
6057     RCG.emitAggregateType(CGF, Cnt);
6058     llvm::Value *SizeValInChars;
6059     llvm::Value *SizeVal;
6060     std::tie(SizeValInChars, SizeVal) = RCG.getSizes(Cnt);
6061     // We use delayed creation/initialization for VLAs and array sections. It is
6062     // required because runtime does not provide the way to pass the sizes of
6063     // VLAs/array sections to initializer/combiner/finalizer functions. Instead
6064     // threadprivate global variables are used to store these values and use
6065     // them in the functions.
6066     bool DelayedCreation = !!SizeVal;
6067     SizeValInChars = CGF.Builder.CreateIntCast(SizeValInChars, CGM.SizeTy,
6068                                                /*isSigned=*/false);
6069     LValue SizeLVal = CGF.EmitLValueForField(ElemLVal, SizeFD);
6070     CGF.EmitStoreOfScalar(SizeValInChars, SizeLVal);
6071     // ElemLVal.reduce_init = init;
6072     LValue InitLVal = CGF.EmitLValueForField(ElemLVal, InitFD);
6073     llvm::Value *InitAddr =
6074         CGF.EmitCastToVoidPtr(emitReduceInitFunction(CGM, Loc, RCG, Cnt));
6075     CGF.EmitStoreOfScalar(InitAddr, InitLVal);
6076     // ElemLVal.reduce_fini = fini;
6077     LValue FiniLVal = CGF.EmitLValueForField(ElemLVal, FiniFD);
6078     llvm::Value *Fini = emitReduceFiniFunction(CGM, Loc, RCG, Cnt);
6079     llvm::Value *FiniAddr = Fini
6080                                 ? CGF.EmitCastToVoidPtr(Fini)
6081                                 : llvm::ConstantPointerNull::get(CGM.VoidPtrTy);
6082     CGF.EmitStoreOfScalar(FiniAddr, FiniLVal);
6083     // ElemLVal.reduce_comb = comb;
6084     LValue CombLVal = CGF.EmitLValueForField(ElemLVal, CombFD);
6085     llvm::Value *CombAddr = CGF.EmitCastToVoidPtr(emitReduceCombFunction(
6086         CGM, Loc, RCG, Cnt, Data.ReductionOps[Cnt], LHSExprs[Cnt],
6087         RHSExprs[Cnt], Data.ReductionCopies[Cnt]));
6088     CGF.EmitStoreOfScalar(CombAddr, CombLVal);
6089     // ElemLVal.flags = 0;
6090     LValue FlagsLVal = CGF.EmitLValueForField(ElemLVal, FlagsFD);
6091     if (DelayedCreation) {
6092       CGF.EmitStoreOfScalar(
6093           llvm::ConstantInt::get(CGM.Int32Ty, /*V=*/1, /*isSigned=*/true),
6094           FlagsLVal);
6095     } else
6096       CGF.EmitNullInitialization(FlagsLVal.getAddress(CGF),
6097                                  FlagsLVal.getType());
6098   }
6099   if (Data.IsReductionWithTaskMod) {
6100     // Build call void *__kmpc_taskred_modifier_init(ident_t *loc, int gtid, int
6101     // is_ws, int num, void *data);
6102     llvm::Value *IdentTLoc = emitUpdateLocation(CGF, Loc);
6103     llvm::Value *GTid = CGF.Builder.CreateIntCast(getThreadID(CGF, Loc),
6104                                                   CGM.IntTy, /*isSigned=*/true);
6105     llvm::Value *Args[] = {
6106         IdentTLoc, GTid,
6107         llvm::ConstantInt::get(CGM.IntTy, Data.IsWorksharingReduction ? 1 : 0,
6108                                /*isSigned=*/true),
6109         llvm::ConstantInt::get(CGM.IntTy, Size, /*isSigned=*/true),
6110         CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
6111             TaskRedInput.getPointer(), CGM.VoidPtrTy)};
6112     return CGF.EmitRuntimeCall(
6113         OMPBuilder.getOrCreateRuntimeFunction(
6114             CGM.getModule(), OMPRTL___kmpc_taskred_modifier_init),
6115         Args);
6116   }
6117   // Build call void *__kmpc_taskred_init(int gtid, int num_data, void *data);
6118   llvm::Value *Args[] = {
6119       CGF.Builder.CreateIntCast(getThreadID(CGF, Loc), CGM.IntTy,
6120                                 /*isSigned=*/true),
6121       llvm::ConstantInt::get(CGM.IntTy, Size, /*isSigned=*/true),
6122       CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(TaskRedInput.getPointer(),
6123                                                       CGM.VoidPtrTy)};
6124   return CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
6125                                  CGM.getModule(), OMPRTL___kmpc_taskred_init),
6126                              Args);
6127 }
6128 
6129 void CGOpenMPRuntime::emitTaskReductionFini(CodeGenFunction &CGF,
6130                                             SourceLocation Loc,
6131                                             bool IsWorksharingReduction) {
6132   // Build call void *__kmpc_taskred_modifier_init(ident_t *loc, int gtid, int
6133   // is_ws, int num, void *data);
6134   llvm::Value *IdentTLoc = emitUpdateLocation(CGF, Loc);
6135   llvm::Value *GTid = CGF.Builder.CreateIntCast(getThreadID(CGF, Loc),
6136                                                 CGM.IntTy, /*isSigned=*/true);
6137   llvm::Value *Args[] = {IdentTLoc, GTid,
6138                          llvm::ConstantInt::get(CGM.IntTy,
6139                                                 IsWorksharingReduction ? 1 : 0,
6140                                                 /*isSigned=*/true)};
6141   (void)CGF.EmitRuntimeCall(
6142       OMPBuilder.getOrCreateRuntimeFunction(
6143           CGM.getModule(), OMPRTL___kmpc_task_reduction_modifier_fini),
6144       Args);
6145 }
6146 
6147 void CGOpenMPRuntime::emitTaskReductionFixups(CodeGenFunction &CGF,
6148                                               SourceLocation Loc,
6149                                               ReductionCodeGen &RCG,
6150                                               unsigned N) {
6151   auto Sizes = RCG.getSizes(N);
6152   // Emit threadprivate global variable if the type is non-constant
6153   // (Sizes.second = nullptr).
6154   if (Sizes.second) {
6155     llvm::Value *SizeVal = CGF.Builder.CreateIntCast(Sizes.second, CGM.SizeTy,
6156                                                      /*isSigned=*/false);
6157     Address SizeAddr = getAddrOfArtificialThreadPrivate(
6158         CGF, CGM.getContext().getSizeType(),
6159         generateUniqueName(CGM, "reduction_size", RCG.getRefExpr(N)));
6160     CGF.Builder.CreateStore(SizeVal, SizeAddr, /*IsVolatile=*/false);
6161   }
6162 }
6163 
6164 Address CGOpenMPRuntime::getTaskReductionItem(CodeGenFunction &CGF,
6165                                               SourceLocation Loc,
6166                                               llvm::Value *ReductionsPtr,
6167                                               LValue SharedLVal) {
6168   // Build call void *__kmpc_task_reduction_get_th_data(int gtid, void *tg, void
6169   // *d);
6170   llvm::Value *Args[] = {CGF.Builder.CreateIntCast(getThreadID(CGF, Loc),
6171                                                    CGM.IntTy,
6172                                                    /*isSigned=*/true),
6173                          ReductionsPtr,
6174                          CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
6175                              SharedLVal.getPointer(CGF), CGM.VoidPtrTy)};
6176   return Address(
6177       CGF.EmitRuntimeCall(
6178           OMPBuilder.getOrCreateRuntimeFunction(
6179               CGM.getModule(), OMPRTL___kmpc_task_reduction_get_th_data),
6180           Args),
6181       SharedLVal.getAlignment());
6182 }
6183 
6184 void CGOpenMPRuntime::emitTaskwaitCall(CodeGenFunction &CGF,
6185                                        SourceLocation Loc) {
6186   if (!CGF.HaveInsertPoint())
6187     return;
6188 
6189   if (CGF.CGM.getLangOpts().OpenMPIRBuilder) {
6190     OMPBuilder.createTaskwait(CGF.Builder);
6191   } else {
6192     // Build call kmp_int32 __kmpc_omp_taskwait(ident_t *loc, kmp_int32
6193     // global_tid);
6194     llvm::Value *Args[] = {emitUpdateLocation(CGF, Loc), getThreadID(CGF, Loc)};
6195     // Ignore return result until untied tasks are supported.
6196     CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
6197                             CGM.getModule(), OMPRTL___kmpc_omp_taskwait),
6198                         Args);
6199   }
6200 
6201   if (auto *Region = dyn_cast_or_null<CGOpenMPRegionInfo>(CGF.CapturedStmtInfo))
6202     Region->emitUntiedSwitch(CGF);
6203 }
6204 
6205 void CGOpenMPRuntime::emitInlinedDirective(CodeGenFunction &CGF,
6206                                            OpenMPDirectiveKind InnerKind,
6207                                            const RegionCodeGenTy &CodeGen,
6208                                            bool HasCancel) {
6209   if (!CGF.HaveInsertPoint())
6210     return;
6211   InlinedOpenMPRegionRAII Region(CGF, CodeGen, InnerKind, HasCancel);
6212   CGF.CapturedStmtInfo->EmitBody(CGF, /*S=*/nullptr);
6213 }
6214 
6215 namespace {
6216 enum RTCancelKind {
6217   CancelNoreq = 0,
6218   CancelParallel = 1,
6219   CancelLoop = 2,
6220   CancelSections = 3,
6221   CancelTaskgroup = 4
6222 };
6223 } // anonymous namespace
6224 
6225 static RTCancelKind getCancellationKind(OpenMPDirectiveKind CancelRegion) {
6226   RTCancelKind CancelKind = CancelNoreq;
6227   if (CancelRegion == OMPD_parallel)
6228     CancelKind = CancelParallel;
6229   else if (CancelRegion == OMPD_for)
6230     CancelKind = CancelLoop;
6231   else if (CancelRegion == OMPD_sections)
6232     CancelKind = CancelSections;
6233   else {
6234     assert(CancelRegion == OMPD_taskgroup);
6235     CancelKind = CancelTaskgroup;
6236   }
6237   return CancelKind;
6238 }
6239 
6240 void CGOpenMPRuntime::emitCancellationPointCall(
6241     CodeGenFunction &CGF, SourceLocation Loc,
6242     OpenMPDirectiveKind CancelRegion) {
6243   if (!CGF.HaveInsertPoint())
6244     return;
6245   // Build call kmp_int32 __kmpc_cancellationpoint(ident_t *loc, kmp_int32
6246   // global_tid, kmp_int32 cncl_kind);
6247   if (auto *OMPRegionInfo =
6248           dyn_cast_or_null<CGOpenMPRegionInfo>(CGF.CapturedStmtInfo)) {
6249     // For 'cancellation point taskgroup', the task region info may not have a
6250     // cancel. This may instead happen in another adjacent task.
6251     if (CancelRegion == OMPD_taskgroup || OMPRegionInfo->hasCancel()) {
6252       llvm::Value *Args[] = {
6253           emitUpdateLocation(CGF, Loc), getThreadID(CGF, Loc),
6254           CGF.Builder.getInt32(getCancellationKind(CancelRegion))};
6255       // Ignore return result until untied tasks are supported.
6256       llvm::Value *Result = CGF.EmitRuntimeCall(
6257           OMPBuilder.getOrCreateRuntimeFunction(
6258               CGM.getModule(), OMPRTL___kmpc_cancellationpoint),
6259           Args);
6260       // if (__kmpc_cancellationpoint()) {
6261       //   exit from construct;
6262       // }
6263       llvm::BasicBlock *ExitBB = CGF.createBasicBlock(".cancel.exit");
6264       llvm::BasicBlock *ContBB = CGF.createBasicBlock(".cancel.continue");
6265       llvm::Value *Cmp = CGF.Builder.CreateIsNotNull(Result);
6266       CGF.Builder.CreateCondBr(Cmp, ExitBB, ContBB);
6267       CGF.EmitBlock(ExitBB);
6268       // exit from construct;
6269       CodeGenFunction::JumpDest CancelDest =
6270           CGF.getOMPCancelDestination(OMPRegionInfo->getDirectiveKind());
6271       CGF.EmitBranchThroughCleanup(CancelDest);
6272       CGF.EmitBlock(ContBB, /*IsFinished=*/true);
6273     }
6274   }
6275 }
6276 
6277 void CGOpenMPRuntime::emitCancelCall(CodeGenFunction &CGF, SourceLocation Loc,
6278                                      const Expr *IfCond,
6279                                      OpenMPDirectiveKind CancelRegion) {
6280   if (!CGF.HaveInsertPoint())
6281     return;
6282   // Build call kmp_int32 __kmpc_cancel(ident_t *loc, kmp_int32 global_tid,
6283   // kmp_int32 cncl_kind);
6284   auto &M = CGM.getModule();
6285   if (auto *OMPRegionInfo =
6286           dyn_cast_or_null<CGOpenMPRegionInfo>(CGF.CapturedStmtInfo)) {
6287     auto &&ThenGen = [this, &M, Loc, CancelRegion,
6288                       OMPRegionInfo](CodeGenFunction &CGF, PrePostActionTy &) {
6289       CGOpenMPRuntime &RT = CGF.CGM.getOpenMPRuntime();
6290       llvm::Value *Args[] = {
6291           RT.emitUpdateLocation(CGF, Loc), RT.getThreadID(CGF, Loc),
6292           CGF.Builder.getInt32(getCancellationKind(CancelRegion))};
6293       // Ignore return result until untied tasks are supported.
6294       llvm::Value *Result = CGF.EmitRuntimeCall(
6295           OMPBuilder.getOrCreateRuntimeFunction(M, OMPRTL___kmpc_cancel), Args);
6296       // if (__kmpc_cancel()) {
6297       //   exit from construct;
6298       // }
6299       llvm::BasicBlock *ExitBB = CGF.createBasicBlock(".cancel.exit");
6300       llvm::BasicBlock *ContBB = CGF.createBasicBlock(".cancel.continue");
6301       llvm::Value *Cmp = CGF.Builder.CreateIsNotNull(Result);
6302       CGF.Builder.CreateCondBr(Cmp, ExitBB, ContBB);
6303       CGF.EmitBlock(ExitBB);
6304       // exit from construct;
6305       CodeGenFunction::JumpDest CancelDest =
6306           CGF.getOMPCancelDestination(OMPRegionInfo->getDirectiveKind());
6307       CGF.EmitBranchThroughCleanup(CancelDest);
6308       CGF.EmitBlock(ContBB, /*IsFinished=*/true);
6309     };
6310     if (IfCond) {
6311       emitIfClause(CGF, IfCond, ThenGen,
6312                    [](CodeGenFunction &, PrePostActionTy &) {});
6313     } else {
6314       RegionCodeGenTy ThenRCG(ThenGen);
6315       ThenRCG(CGF);
6316     }
6317   }
6318 }
6319 
6320 namespace {
6321 /// Cleanup action for uses_allocators support.
6322 class OMPUsesAllocatorsActionTy final : public PrePostActionTy {
6323   ArrayRef<std::pair<const Expr *, const Expr *>> Allocators;
6324 
6325 public:
6326   OMPUsesAllocatorsActionTy(
6327       ArrayRef<std::pair<const Expr *, const Expr *>> Allocators)
6328       : Allocators(Allocators) {}
6329   void Enter(CodeGenFunction &CGF) override {
6330     if (!CGF.HaveInsertPoint())
6331       return;
6332     for (const auto &AllocatorData : Allocators) {
6333       CGF.CGM.getOpenMPRuntime().emitUsesAllocatorsInit(
6334           CGF, AllocatorData.first, AllocatorData.second);
6335     }
6336   }
6337   void Exit(CodeGenFunction &CGF) override {
6338     if (!CGF.HaveInsertPoint())
6339       return;
6340     for (const auto &AllocatorData : Allocators) {
6341       CGF.CGM.getOpenMPRuntime().emitUsesAllocatorsFini(CGF,
6342                                                         AllocatorData.first);
6343     }
6344   }
6345 };
6346 } // namespace
6347 
6348 void CGOpenMPRuntime::emitTargetOutlinedFunction(
6349     const OMPExecutableDirective &D, StringRef ParentName,
6350     llvm::Function *&OutlinedFn, llvm::Constant *&OutlinedFnID,
6351     bool IsOffloadEntry, const RegionCodeGenTy &CodeGen) {
6352   assert(!ParentName.empty() && "Invalid target region parent name!");
6353   HasEmittedTargetRegion = true;
6354   SmallVector<std::pair<const Expr *, const Expr *>, 4> Allocators;
6355   for (const auto *C : D.getClausesOfKind<OMPUsesAllocatorsClause>()) {
6356     for (unsigned I = 0, E = C->getNumberOfAllocators(); I < E; ++I) {
6357       const OMPUsesAllocatorsClause::Data D = C->getAllocatorData(I);
6358       if (!D.AllocatorTraits)
6359         continue;
6360       Allocators.emplace_back(D.Allocator, D.AllocatorTraits);
6361     }
6362   }
6363   OMPUsesAllocatorsActionTy UsesAllocatorAction(Allocators);
6364   CodeGen.setAction(UsesAllocatorAction);
6365   emitTargetOutlinedFunctionHelper(D, ParentName, OutlinedFn, OutlinedFnID,
6366                                    IsOffloadEntry, CodeGen);
6367 }
6368 
6369 void CGOpenMPRuntime::emitUsesAllocatorsInit(CodeGenFunction &CGF,
6370                                              const Expr *Allocator,
6371                                              const Expr *AllocatorTraits) {
6372   llvm::Value *ThreadId = getThreadID(CGF, Allocator->getExprLoc());
6373   ThreadId = CGF.Builder.CreateIntCast(ThreadId, CGF.IntTy, /*isSigned=*/true);
6374   // Use default memspace handle.
6375   llvm::Value *MemSpaceHandle = llvm::ConstantPointerNull::get(CGF.VoidPtrTy);
6376   llvm::Value *NumTraits = llvm::ConstantInt::get(
6377       CGF.IntTy, cast<ConstantArrayType>(
6378                      AllocatorTraits->getType()->getAsArrayTypeUnsafe())
6379                      ->getSize()
6380                      .getLimitedValue());
6381   LValue AllocatorTraitsLVal = CGF.EmitLValue(AllocatorTraits);
6382   Address Addr = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
6383       AllocatorTraitsLVal.getAddress(CGF), CGF.VoidPtrPtrTy);
6384   AllocatorTraitsLVal = CGF.MakeAddrLValue(Addr, CGF.getContext().VoidPtrTy,
6385                                            AllocatorTraitsLVal.getBaseInfo(),
6386                                            AllocatorTraitsLVal.getTBAAInfo());
6387   llvm::Value *Traits =
6388       CGF.EmitLoadOfScalar(AllocatorTraitsLVal, AllocatorTraits->getExprLoc());
6389 
6390   llvm::Value *AllocatorVal =
6391       CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
6392                               CGM.getModule(), OMPRTL___kmpc_init_allocator),
6393                           {ThreadId, MemSpaceHandle, NumTraits, Traits});
6394   // Store to allocator.
6395   CGF.EmitVarDecl(*cast<VarDecl>(
6396       cast<DeclRefExpr>(Allocator->IgnoreParenImpCasts())->getDecl()));
6397   LValue AllocatorLVal = CGF.EmitLValue(Allocator->IgnoreParenImpCasts());
6398   AllocatorVal =
6399       CGF.EmitScalarConversion(AllocatorVal, CGF.getContext().VoidPtrTy,
6400                                Allocator->getType(), Allocator->getExprLoc());
6401   CGF.EmitStoreOfScalar(AllocatorVal, AllocatorLVal);
6402 }
6403 
6404 void CGOpenMPRuntime::emitUsesAllocatorsFini(CodeGenFunction &CGF,
6405                                              const Expr *Allocator) {
6406   llvm::Value *ThreadId = getThreadID(CGF, Allocator->getExprLoc());
6407   ThreadId = CGF.Builder.CreateIntCast(ThreadId, CGF.IntTy, /*isSigned=*/true);
6408   LValue AllocatorLVal = CGF.EmitLValue(Allocator->IgnoreParenImpCasts());
6409   llvm::Value *AllocatorVal =
6410       CGF.EmitLoadOfScalar(AllocatorLVal, Allocator->getExprLoc());
6411   AllocatorVal = CGF.EmitScalarConversion(AllocatorVal, Allocator->getType(),
6412                                           CGF.getContext().VoidPtrTy,
6413                                           Allocator->getExprLoc());
6414   (void)CGF.EmitRuntimeCall(
6415       OMPBuilder.getOrCreateRuntimeFunction(CGM.getModule(),
6416                                             OMPRTL___kmpc_destroy_allocator),
6417       {ThreadId, AllocatorVal});
6418 }
6419 
6420 void CGOpenMPRuntime::emitTargetOutlinedFunctionHelper(
6421     const OMPExecutableDirective &D, StringRef ParentName,
6422     llvm::Function *&OutlinedFn, llvm::Constant *&OutlinedFnID,
6423     bool IsOffloadEntry, const RegionCodeGenTy &CodeGen) {
6424   // Create a unique name for the entry function using the source location
6425   // information of the current target region. The name will be something like:
6426   //
6427   // __omp_offloading_DD_FFFF_PP_lBB
6428   //
6429   // where DD_FFFF is an ID unique to the file (device and file IDs), PP is the
6430   // mangled name of the function that encloses the target region and BB is the
6431   // line number of the target region.
6432 
6433   unsigned DeviceID;
6434   unsigned FileID;
6435   unsigned Line;
6436   getTargetEntryUniqueInfo(CGM.getContext(), D.getBeginLoc(), DeviceID, FileID,
6437                            Line);
6438   SmallString<64> EntryFnName;
6439   {
6440     llvm::raw_svector_ostream OS(EntryFnName);
6441     OS << "__omp_offloading" << llvm::format("_%x", DeviceID)
6442        << llvm::format("_%x_", FileID) << ParentName << "_l" << Line;
6443   }
6444 
6445   const CapturedStmt &CS = *D.getCapturedStmt(OMPD_target);
6446 
6447   CodeGenFunction CGF(CGM, true);
6448   CGOpenMPTargetRegionInfo CGInfo(CS, CodeGen, EntryFnName);
6449   CodeGenFunction::CGCapturedStmtRAII CapInfoRAII(CGF, &CGInfo);
6450 
6451   OutlinedFn = CGF.GenerateOpenMPCapturedStmtFunction(CS, D.getBeginLoc());
6452 
6453   // If this target outline function is not an offload entry, we don't need to
6454   // register it.
6455   if (!IsOffloadEntry)
6456     return;
6457 
6458   // The target region ID is used by the runtime library to identify the current
6459   // target region, so it only has to be unique and not necessarily point to
6460   // anything. It could be the pointer to the outlined function that implements
6461   // the target region, but we aren't using that so that the compiler doesn't
6462   // need to keep that, and could therefore inline the host function if proven
6463   // worthwhile during optimization. In the other hand, if emitting code for the
6464   // device, the ID has to be the function address so that it can retrieved from
6465   // the offloading entry and launched by the runtime library. We also mark the
6466   // outlined function to have external linkage in case we are emitting code for
6467   // the device, because these functions will be entry points to the device.
6468 
6469   if (CGM.getLangOpts().OpenMPIsDevice) {
6470     OutlinedFnID = llvm::ConstantExpr::getBitCast(OutlinedFn, CGM.Int8PtrTy);
6471     OutlinedFn->setLinkage(llvm::GlobalValue::WeakAnyLinkage);
6472     OutlinedFn->setDSOLocal(false);
6473   } else {
6474     std::string Name = getName({EntryFnName, "region_id"});
6475     OutlinedFnID = new llvm::GlobalVariable(
6476         CGM.getModule(), CGM.Int8Ty, /*isConstant=*/true,
6477         llvm::GlobalValue::WeakAnyLinkage,
6478         llvm::Constant::getNullValue(CGM.Int8Ty), Name);
6479   }
6480 
6481   // Register the information for the entry associated with this target region.
6482   OffloadEntriesInfoManager.registerTargetRegionEntryInfo(
6483       DeviceID, FileID, ParentName, Line, OutlinedFn, OutlinedFnID,
6484       OffloadEntriesInfoManagerTy::OMPTargetRegionEntryTargetRegion);
6485 }
6486 
6487 /// Checks if the expression is constant or does not have non-trivial function
6488 /// calls.
6489 static bool isTrivial(ASTContext &Ctx, const Expr * E) {
6490   // We can skip constant expressions.
6491   // We can skip expressions with trivial calls or simple expressions.
6492   return (E->isEvaluatable(Ctx, Expr::SE_AllowUndefinedBehavior) ||
6493           !E->hasNonTrivialCall(Ctx)) &&
6494          !E->HasSideEffects(Ctx, /*IncludePossibleEffects=*/true);
6495 }
6496 
6497 const Stmt *CGOpenMPRuntime::getSingleCompoundChild(ASTContext &Ctx,
6498                                                     const Stmt *Body) {
6499   const Stmt *Child = Body->IgnoreContainers();
6500   while (const auto *C = dyn_cast_or_null<CompoundStmt>(Child)) {
6501     Child = nullptr;
6502     for (const Stmt *S : C->body()) {
6503       if (const auto *E = dyn_cast<Expr>(S)) {
6504         if (isTrivial(Ctx, E))
6505           continue;
6506       }
6507       // Some of the statements can be ignored.
6508       if (isa<AsmStmt>(S) || isa<NullStmt>(S) || isa<OMPFlushDirective>(S) ||
6509           isa<OMPBarrierDirective>(S) || isa<OMPTaskyieldDirective>(S))
6510         continue;
6511       // Analyze declarations.
6512       if (const auto *DS = dyn_cast<DeclStmt>(S)) {
6513         if (llvm::all_of(DS->decls(), [&Ctx](const Decl *D) {
6514               if (isa<EmptyDecl>(D) || isa<DeclContext>(D) ||
6515                   isa<TypeDecl>(D) || isa<PragmaCommentDecl>(D) ||
6516                   isa<PragmaDetectMismatchDecl>(D) || isa<UsingDecl>(D) ||
6517                   isa<UsingDirectiveDecl>(D) ||
6518                   isa<OMPDeclareReductionDecl>(D) ||
6519                   isa<OMPThreadPrivateDecl>(D) || isa<OMPAllocateDecl>(D))
6520                 return true;
6521               const auto *VD = dyn_cast<VarDecl>(D);
6522               if (!VD)
6523                 return false;
6524               return VD->isConstexpr() ||
6525                      ((VD->getType().isTrivialType(Ctx) ||
6526                        VD->getType()->isReferenceType()) &&
6527                       (!VD->hasInit() || isTrivial(Ctx, VD->getInit())));
6528             }))
6529           continue;
6530       }
6531       // Found multiple children - cannot get the one child only.
6532       if (Child)
6533         return nullptr;
6534       Child = S;
6535     }
6536     if (Child)
6537       Child = Child->IgnoreContainers();
6538   }
6539   return Child;
6540 }
6541 
6542 /// Emit the number of teams for a target directive.  Inspect the num_teams
6543 /// clause associated with a teams construct combined or closely nested
6544 /// with the target directive.
6545 ///
6546 /// Emit a team of size one for directives such as 'target parallel' that
6547 /// have no associated teams construct.
6548 ///
6549 /// Otherwise, return nullptr.
6550 static llvm::Value *
6551 emitNumTeamsForTargetDirective(CodeGenFunction &CGF,
6552                                const OMPExecutableDirective &D) {
6553   assert(!CGF.getLangOpts().OpenMPIsDevice &&
6554          "Clauses associated with the teams directive expected to be emitted "
6555          "only for the host!");
6556   OpenMPDirectiveKind DirectiveKind = D.getDirectiveKind();
6557   assert(isOpenMPTargetExecutionDirective(DirectiveKind) &&
6558          "Expected target-based executable directive.");
6559   CGBuilderTy &Bld = CGF.Builder;
6560   switch (DirectiveKind) {
6561   case OMPD_target: {
6562     const auto *CS = D.getInnermostCapturedStmt();
6563     const auto *Body =
6564         CS->getCapturedStmt()->IgnoreContainers(/*IgnoreCaptured=*/true);
6565     const Stmt *ChildStmt =
6566         CGOpenMPRuntime::getSingleCompoundChild(CGF.getContext(), Body);
6567     if (const auto *NestedDir =
6568             dyn_cast_or_null<OMPExecutableDirective>(ChildStmt)) {
6569       if (isOpenMPTeamsDirective(NestedDir->getDirectiveKind())) {
6570         if (NestedDir->hasClausesOfKind<OMPNumTeamsClause>()) {
6571           CGOpenMPInnerExprInfo CGInfo(CGF, *CS);
6572           CodeGenFunction::CGCapturedStmtRAII CapInfoRAII(CGF, &CGInfo);
6573           const Expr *NumTeams =
6574               NestedDir->getSingleClause<OMPNumTeamsClause>()->getNumTeams();
6575           llvm::Value *NumTeamsVal =
6576               CGF.EmitScalarExpr(NumTeams,
6577                                  /*IgnoreResultAssign*/ true);
6578           return Bld.CreateIntCast(NumTeamsVal, CGF.Int32Ty,
6579                                    /*isSigned=*/true);
6580         }
6581         return Bld.getInt32(0);
6582       }
6583       if (isOpenMPParallelDirective(NestedDir->getDirectiveKind()) ||
6584           isOpenMPSimdDirective(NestedDir->getDirectiveKind()))
6585         return Bld.getInt32(1);
6586       return Bld.getInt32(0);
6587     }
6588     return nullptr;
6589   }
6590   case OMPD_target_teams:
6591   case OMPD_target_teams_distribute:
6592   case OMPD_target_teams_distribute_simd:
6593   case OMPD_target_teams_distribute_parallel_for:
6594   case OMPD_target_teams_distribute_parallel_for_simd: {
6595     if (D.hasClausesOfKind<OMPNumTeamsClause>()) {
6596       CodeGenFunction::RunCleanupsScope NumTeamsScope(CGF);
6597       const Expr *NumTeams =
6598           D.getSingleClause<OMPNumTeamsClause>()->getNumTeams();
6599       llvm::Value *NumTeamsVal =
6600           CGF.EmitScalarExpr(NumTeams,
6601                              /*IgnoreResultAssign*/ true);
6602       return Bld.CreateIntCast(NumTeamsVal, CGF.Int32Ty,
6603                                /*isSigned=*/true);
6604     }
6605     return Bld.getInt32(0);
6606   }
6607   case OMPD_target_parallel:
6608   case OMPD_target_parallel_for:
6609   case OMPD_target_parallel_for_simd:
6610   case OMPD_target_simd:
6611     return Bld.getInt32(1);
6612   case OMPD_parallel:
6613   case OMPD_for:
6614   case OMPD_parallel_for:
6615   case OMPD_parallel_master:
6616   case OMPD_parallel_sections:
6617   case OMPD_for_simd:
6618   case OMPD_parallel_for_simd:
6619   case OMPD_cancel:
6620   case OMPD_cancellation_point:
6621   case OMPD_ordered:
6622   case OMPD_threadprivate:
6623   case OMPD_allocate:
6624   case OMPD_task:
6625   case OMPD_simd:
6626   case OMPD_sections:
6627   case OMPD_section:
6628   case OMPD_single:
6629   case OMPD_master:
6630   case OMPD_critical:
6631   case OMPD_taskyield:
6632   case OMPD_barrier:
6633   case OMPD_taskwait:
6634   case OMPD_taskgroup:
6635   case OMPD_atomic:
6636   case OMPD_flush:
6637   case OMPD_depobj:
6638   case OMPD_scan:
6639   case OMPD_teams:
6640   case OMPD_target_data:
6641   case OMPD_target_exit_data:
6642   case OMPD_target_enter_data:
6643   case OMPD_distribute:
6644   case OMPD_distribute_simd:
6645   case OMPD_distribute_parallel_for:
6646   case OMPD_distribute_parallel_for_simd:
6647   case OMPD_teams_distribute:
6648   case OMPD_teams_distribute_simd:
6649   case OMPD_teams_distribute_parallel_for:
6650   case OMPD_teams_distribute_parallel_for_simd:
6651   case OMPD_target_update:
6652   case OMPD_declare_simd:
6653   case OMPD_declare_variant:
6654   case OMPD_begin_declare_variant:
6655   case OMPD_end_declare_variant:
6656   case OMPD_declare_target:
6657   case OMPD_end_declare_target:
6658   case OMPD_declare_reduction:
6659   case OMPD_declare_mapper:
6660   case OMPD_taskloop:
6661   case OMPD_taskloop_simd:
6662   case OMPD_master_taskloop:
6663   case OMPD_master_taskloop_simd:
6664   case OMPD_parallel_master_taskloop:
6665   case OMPD_parallel_master_taskloop_simd:
6666   case OMPD_requires:
6667   case OMPD_unknown:
6668     break;
6669   default:
6670     break;
6671   }
6672   llvm_unreachable("Unexpected directive kind.");
6673 }
6674 
6675 static llvm::Value *getNumThreads(CodeGenFunction &CGF, const CapturedStmt *CS,
6676                                   llvm::Value *DefaultThreadLimitVal) {
6677   const Stmt *Child = CGOpenMPRuntime::getSingleCompoundChild(
6678       CGF.getContext(), CS->getCapturedStmt());
6679   if (const auto *Dir = dyn_cast_or_null<OMPExecutableDirective>(Child)) {
6680     if (isOpenMPParallelDirective(Dir->getDirectiveKind())) {
6681       llvm::Value *NumThreads = nullptr;
6682       llvm::Value *CondVal = nullptr;
6683       // Handle if clause. If if clause present, the number of threads is
6684       // calculated as <cond> ? (<numthreads> ? <numthreads> : 0 ) : 1.
6685       if (Dir->hasClausesOfKind<OMPIfClause>()) {
6686         CGOpenMPInnerExprInfo CGInfo(CGF, *CS);
6687         CodeGenFunction::CGCapturedStmtRAII CapInfoRAII(CGF, &CGInfo);
6688         const OMPIfClause *IfClause = nullptr;
6689         for (const auto *C : Dir->getClausesOfKind<OMPIfClause>()) {
6690           if (C->getNameModifier() == OMPD_unknown ||
6691               C->getNameModifier() == OMPD_parallel) {
6692             IfClause = C;
6693             break;
6694           }
6695         }
6696         if (IfClause) {
6697           const Expr *Cond = IfClause->getCondition();
6698           bool Result;
6699           if (Cond->EvaluateAsBooleanCondition(Result, CGF.getContext())) {
6700             if (!Result)
6701               return CGF.Builder.getInt32(1);
6702           } else {
6703             CodeGenFunction::LexicalScope Scope(CGF, Cond->getSourceRange());
6704             if (const auto *PreInit =
6705                     cast_or_null<DeclStmt>(IfClause->getPreInitStmt())) {
6706               for (const auto *I : PreInit->decls()) {
6707                 if (!I->hasAttr<OMPCaptureNoInitAttr>()) {
6708                   CGF.EmitVarDecl(cast<VarDecl>(*I));
6709                 } else {
6710                   CodeGenFunction::AutoVarEmission Emission =
6711                       CGF.EmitAutoVarAlloca(cast<VarDecl>(*I));
6712                   CGF.EmitAutoVarCleanups(Emission);
6713                 }
6714               }
6715             }
6716             CondVal = CGF.EvaluateExprAsBool(Cond);
6717           }
6718         }
6719       }
6720       // Check the value of num_threads clause iff if clause was not specified
6721       // or is not evaluated to false.
6722       if (Dir->hasClausesOfKind<OMPNumThreadsClause>()) {
6723         CGOpenMPInnerExprInfo CGInfo(CGF, *CS);
6724         CodeGenFunction::CGCapturedStmtRAII CapInfoRAII(CGF, &CGInfo);
6725         const auto *NumThreadsClause =
6726             Dir->getSingleClause<OMPNumThreadsClause>();
6727         CodeGenFunction::LexicalScope Scope(
6728             CGF, NumThreadsClause->getNumThreads()->getSourceRange());
6729         if (const auto *PreInit =
6730                 cast_or_null<DeclStmt>(NumThreadsClause->getPreInitStmt())) {
6731           for (const auto *I : PreInit->decls()) {
6732             if (!I->hasAttr<OMPCaptureNoInitAttr>()) {
6733               CGF.EmitVarDecl(cast<VarDecl>(*I));
6734             } else {
6735               CodeGenFunction::AutoVarEmission Emission =
6736                   CGF.EmitAutoVarAlloca(cast<VarDecl>(*I));
6737               CGF.EmitAutoVarCleanups(Emission);
6738             }
6739           }
6740         }
6741         NumThreads = CGF.EmitScalarExpr(NumThreadsClause->getNumThreads());
6742         NumThreads = CGF.Builder.CreateIntCast(NumThreads, CGF.Int32Ty,
6743                                                /*isSigned=*/false);
6744         if (DefaultThreadLimitVal)
6745           NumThreads = CGF.Builder.CreateSelect(
6746               CGF.Builder.CreateICmpULT(DefaultThreadLimitVal, NumThreads),
6747               DefaultThreadLimitVal, NumThreads);
6748       } else {
6749         NumThreads = DefaultThreadLimitVal ? DefaultThreadLimitVal
6750                                            : CGF.Builder.getInt32(0);
6751       }
6752       // Process condition of the if clause.
6753       if (CondVal) {
6754         NumThreads = CGF.Builder.CreateSelect(CondVal, NumThreads,
6755                                               CGF.Builder.getInt32(1));
6756       }
6757       return NumThreads;
6758     }
6759     if (isOpenMPSimdDirective(Dir->getDirectiveKind()))
6760       return CGF.Builder.getInt32(1);
6761     return DefaultThreadLimitVal;
6762   }
6763   return DefaultThreadLimitVal ? DefaultThreadLimitVal
6764                                : CGF.Builder.getInt32(0);
6765 }
6766 
6767 /// Emit the number of threads for a target directive.  Inspect the
6768 /// thread_limit clause associated with a teams construct combined or closely
6769 /// nested with the target directive.
6770 ///
6771 /// Emit the num_threads clause for directives such as 'target parallel' that
6772 /// have no associated teams construct.
6773 ///
6774 /// Otherwise, return nullptr.
6775 static llvm::Value *
6776 emitNumThreadsForTargetDirective(CodeGenFunction &CGF,
6777                                  const OMPExecutableDirective &D) {
6778   assert(!CGF.getLangOpts().OpenMPIsDevice &&
6779          "Clauses associated with the teams directive expected to be emitted "
6780          "only for the host!");
6781   OpenMPDirectiveKind DirectiveKind = D.getDirectiveKind();
6782   assert(isOpenMPTargetExecutionDirective(DirectiveKind) &&
6783          "Expected target-based executable directive.");
6784   CGBuilderTy &Bld = CGF.Builder;
6785   llvm::Value *ThreadLimitVal = nullptr;
6786   llvm::Value *NumThreadsVal = nullptr;
6787   switch (DirectiveKind) {
6788   case OMPD_target: {
6789     const CapturedStmt *CS = D.getInnermostCapturedStmt();
6790     if (llvm::Value *NumThreads = getNumThreads(CGF, CS, ThreadLimitVal))
6791       return NumThreads;
6792     const Stmt *Child = CGOpenMPRuntime::getSingleCompoundChild(
6793         CGF.getContext(), CS->getCapturedStmt());
6794     if (const auto *Dir = dyn_cast_or_null<OMPExecutableDirective>(Child)) {
6795       if (Dir->hasClausesOfKind<OMPThreadLimitClause>()) {
6796         CGOpenMPInnerExprInfo CGInfo(CGF, *CS);
6797         CodeGenFunction::CGCapturedStmtRAII CapInfoRAII(CGF, &CGInfo);
6798         const auto *ThreadLimitClause =
6799             Dir->getSingleClause<OMPThreadLimitClause>();
6800         CodeGenFunction::LexicalScope Scope(
6801             CGF, ThreadLimitClause->getThreadLimit()->getSourceRange());
6802         if (const auto *PreInit =
6803                 cast_or_null<DeclStmt>(ThreadLimitClause->getPreInitStmt())) {
6804           for (const auto *I : PreInit->decls()) {
6805             if (!I->hasAttr<OMPCaptureNoInitAttr>()) {
6806               CGF.EmitVarDecl(cast<VarDecl>(*I));
6807             } else {
6808               CodeGenFunction::AutoVarEmission Emission =
6809                   CGF.EmitAutoVarAlloca(cast<VarDecl>(*I));
6810               CGF.EmitAutoVarCleanups(Emission);
6811             }
6812           }
6813         }
6814         llvm::Value *ThreadLimit = CGF.EmitScalarExpr(
6815             ThreadLimitClause->getThreadLimit(), /*IgnoreResultAssign=*/true);
6816         ThreadLimitVal =
6817             Bld.CreateIntCast(ThreadLimit, CGF.Int32Ty, /*isSigned=*/false);
6818       }
6819       if (isOpenMPTeamsDirective(Dir->getDirectiveKind()) &&
6820           !isOpenMPDistributeDirective(Dir->getDirectiveKind())) {
6821         CS = Dir->getInnermostCapturedStmt();
6822         const Stmt *Child = CGOpenMPRuntime::getSingleCompoundChild(
6823             CGF.getContext(), CS->getCapturedStmt());
6824         Dir = dyn_cast_or_null<OMPExecutableDirective>(Child);
6825       }
6826       if (Dir && isOpenMPDistributeDirective(Dir->getDirectiveKind()) &&
6827           !isOpenMPSimdDirective(Dir->getDirectiveKind())) {
6828         CS = Dir->getInnermostCapturedStmt();
6829         if (llvm::Value *NumThreads = getNumThreads(CGF, CS, ThreadLimitVal))
6830           return NumThreads;
6831       }
6832       if (Dir && isOpenMPSimdDirective(Dir->getDirectiveKind()))
6833         return Bld.getInt32(1);
6834     }
6835     return ThreadLimitVal ? ThreadLimitVal : Bld.getInt32(0);
6836   }
6837   case OMPD_target_teams: {
6838     if (D.hasClausesOfKind<OMPThreadLimitClause>()) {
6839       CodeGenFunction::RunCleanupsScope ThreadLimitScope(CGF);
6840       const auto *ThreadLimitClause = D.getSingleClause<OMPThreadLimitClause>();
6841       llvm::Value *ThreadLimit = CGF.EmitScalarExpr(
6842           ThreadLimitClause->getThreadLimit(), /*IgnoreResultAssign=*/true);
6843       ThreadLimitVal =
6844           Bld.CreateIntCast(ThreadLimit, CGF.Int32Ty, /*isSigned=*/false);
6845     }
6846     const CapturedStmt *CS = D.getInnermostCapturedStmt();
6847     if (llvm::Value *NumThreads = getNumThreads(CGF, CS, ThreadLimitVal))
6848       return NumThreads;
6849     const Stmt *Child = CGOpenMPRuntime::getSingleCompoundChild(
6850         CGF.getContext(), CS->getCapturedStmt());
6851     if (const auto *Dir = dyn_cast_or_null<OMPExecutableDirective>(Child)) {
6852       if (Dir->getDirectiveKind() == OMPD_distribute) {
6853         CS = Dir->getInnermostCapturedStmt();
6854         if (llvm::Value *NumThreads = getNumThreads(CGF, CS, ThreadLimitVal))
6855           return NumThreads;
6856       }
6857     }
6858     return ThreadLimitVal ? ThreadLimitVal : Bld.getInt32(0);
6859   }
6860   case OMPD_target_teams_distribute:
6861     if (D.hasClausesOfKind<OMPThreadLimitClause>()) {
6862       CodeGenFunction::RunCleanupsScope ThreadLimitScope(CGF);
6863       const auto *ThreadLimitClause = D.getSingleClause<OMPThreadLimitClause>();
6864       llvm::Value *ThreadLimit = CGF.EmitScalarExpr(
6865           ThreadLimitClause->getThreadLimit(), /*IgnoreResultAssign=*/true);
6866       ThreadLimitVal =
6867           Bld.CreateIntCast(ThreadLimit, CGF.Int32Ty, /*isSigned=*/false);
6868     }
6869     return getNumThreads(CGF, D.getInnermostCapturedStmt(), ThreadLimitVal);
6870   case OMPD_target_parallel:
6871   case OMPD_target_parallel_for:
6872   case OMPD_target_parallel_for_simd:
6873   case OMPD_target_teams_distribute_parallel_for:
6874   case OMPD_target_teams_distribute_parallel_for_simd: {
6875     llvm::Value *CondVal = nullptr;
6876     // Handle if clause. If if clause present, the number of threads is
6877     // calculated as <cond> ? (<numthreads> ? <numthreads> : 0 ) : 1.
6878     if (D.hasClausesOfKind<OMPIfClause>()) {
6879       const OMPIfClause *IfClause = nullptr;
6880       for (const auto *C : D.getClausesOfKind<OMPIfClause>()) {
6881         if (C->getNameModifier() == OMPD_unknown ||
6882             C->getNameModifier() == OMPD_parallel) {
6883           IfClause = C;
6884           break;
6885         }
6886       }
6887       if (IfClause) {
6888         const Expr *Cond = IfClause->getCondition();
6889         bool Result;
6890         if (Cond->EvaluateAsBooleanCondition(Result, CGF.getContext())) {
6891           if (!Result)
6892             return Bld.getInt32(1);
6893         } else {
6894           CodeGenFunction::RunCleanupsScope Scope(CGF);
6895           CondVal = CGF.EvaluateExprAsBool(Cond);
6896         }
6897       }
6898     }
6899     if (D.hasClausesOfKind<OMPThreadLimitClause>()) {
6900       CodeGenFunction::RunCleanupsScope ThreadLimitScope(CGF);
6901       const auto *ThreadLimitClause = D.getSingleClause<OMPThreadLimitClause>();
6902       llvm::Value *ThreadLimit = CGF.EmitScalarExpr(
6903           ThreadLimitClause->getThreadLimit(), /*IgnoreResultAssign=*/true);
6904       ThreadLimitVal =
6905           Bld.CreateIntCast(ThreadLimit, CGF.Int32Ty, /*isSigned=*/false);
6906     }
6907     if (D.hasClausesOfKind<OMPNumThreadsClause>()) {
6908       CodeGenFunction::RunCleanupsScope NumThreadsScope(CGF);
6909       const auto *NumThreadsClause = D.getSingleClause<OMPNumThreadsClause>();
6910       llvm::Value *NumThreads = CGF.EmitScalarExpr(
6911           NumThreadsClause->getNumThreads(), /*IgnoreResultAssign=*/true);
6912       NumThreadsVal =
6913           Bld.CreateIntCast(NumThreads, CGF.Int32Ty, /*isSigned=*/false);
6914       ThreadLimitVal = ThreadLimitVal
6915                            ? Bld.CreateSelect(Bld.CreateICmpULT(NumThreadsVal,
6916                                                                 ThreadLimitVal),
6917                                               NumThreadsVal, ThreadLimitVal)
6918                            : NumThreadsVal;
6919     }
6920     if (!ThreadLimitVal)
6921       ThreadLimitVal = Bld.getInt32(0);
6922     if (CondVal)
6923       return Bld.CreateSelect(CondVal, ThreadLimitVal, Bld.getInt32(1));
6924     return ThreadLimitVal;
6925   }
6926   case OMPD_target_teams_distribute_simd:
6927   case OMPD_target_simd:
6928     return Bld.getInt32(1);
6929   case OMPD_parallel:
6930   case OMPD_for:
6931   case OMPD_parallel_for:
6932   case OMPD_parallel_master:
6933   case OMPD_parallel_sections:
6934   case OMPD_for_simd:
6935   case OMPD_parallel_for_simd:
6936   case OMPD_cancel:
6937   case OMPD_cancellation_point:
6938   case OMPD_ordered:
6939   case OMPD_threadprivate:
6940   case OMPD_allocate:
6941   case OMPD_task:
6942   case OMPD_simd:
6943   case OMPD_sections:
6944   case OMPD_section:
6945   case OMPD_single:
6946   case OMPD_master:
6947   case OMPD_critical:
6948   case OMPD_taskyield:
6949   case OMPD_barrier:
6950   case OMPD_taskwait:
6951   case OMPD_taskgroup:
6952   case OMPD_atomic:
6953   case OMPD_flush:
6954   case OMPD_depobj:
6955   case OMPD_scan:
6956   case OMPD_teams:
6957   case OMPD_target_data:
6958   case OMPD_target_exit_data:
6959   case OMPD_target_enter_data:
6960   case OMPD_distribute:
6961   case OMPD_distribute_simd:
6962   case OMPD_distribute_parallel_for:
6963   case OMPD_distribute_parallel_for_simd:
6964   case OMPD_teams_distribute:
6965   case OMPD_teams_distribute_simd:
6966   case OMPD_teams_distribute_parallel_for:
6967   case OMPD_teams_distribute_parallel_for_simd:
6968   case OMPD_target_update:
6969   case OMPD_declare_simd:
6970   case OMPD_declare_variant:
6971   case OMPD_begin_declare_variant:
6972   case OMPD_end_declare_variant:
6973   case OMPD_declare_target:
6974   case OMPD_end_declare_target:
6975   case OMPD_declare_reduction:
6976   case OMPD_declare_mapper:
6977   case OMPD_taskloop:
6978   case OMPD_taskloop_simd:
6979   case OMPD_master_taskloop:
6980   case OMPD_master_taskloop_simd:
6981   case OMPD_parallel_master_taskloop:
6982   case OMPD_parallel_master_taskloop_simd:
6983   case OMPD_requires:
6984   case OMPD_unknown:
6985     break;
6986   default:
6987     break;
6988   }
6989   llvm_unreachable("Unsupported directive kind.");
6990 }
6991 
6992 namespace {
6993 LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE();
6994 
6995 // Utility to handle information from clauses associated with a given
6996 // construct that use mappable expressions (e.g. 'map' clause, 'to' clause).
6997 // It provides a convenient interface to obtain the information and generate
6998 // code for that information.
6999 class MappableExprsHandler {
7000 public:
7001   /// Values for bit flags used to specify the mapping type for
7002   /// offloading.
7003   enum OpenMPOffloadMappingFlags : uint64_t {
7004     /// No flags
7005     OMP_MAP_NONE = 0x0,
7006     /// Allocate memory on the device and move data from host to device.
7007     OMP_MAP_TO = 0x01,
7008     /// Allocate memory on the device and move data from device to host.
7009     OMP_MAP_FROM = 0x02,
7010     /// Always perform the requested mapping action on the element, even
7011     /// if it was already mapped before.
7012     OMP_MAP_ALWAYS = 0x04,
7013     /// Delete the element from the device environment, ignoring the
7014     /// current reference count associated with the element.
7015     OMP_MAP_DELETE = 0x08,
7016     /// The element being mapped is a pointer-pointee pair; both the
7017     /// pointer and the pointee should be mapped.
7018     OMP_MAP_PTR_AND_OBJ = 0x10,
7019     /// This flags signals that the base address of an entry should be
7020     /// passed to the target kernel as an argument.
7021     OMP_MAP_TARGET_PARAM = 0x20,
7022     /// Signal that the runtime library has to return the device pointer
7023     /// in the current position for the data being mapped. Used when we have the
7024     /// use_device_ptr or use_device_addr clause.
7025     OMP_MAP_RETURN_PARAM = 0x40,
7026     /// This flag signals that the reference being passed is a pointer to
7027     /// private data.
7028     OMP_MAP_PRIVATE = 0x80,
7029     /// Pass the element to the device by value.
7030     OMP_MAP_LITERAL = 0x100,
7031     /// Implicit map
7032     OMP_MAP_IMPLICIT = 0x200,
7033     /// Close is a hint to the runtime to allocate memory close to
7034     /// the target device.
7035     OMP_MAP_CLOSE = 0x400,
7036     /// 0x800 is reserved for compatibility with XLC.
7037     /// Produce a runtime error if the data is not already allocated.
7038     OMP_MAP_PRESENT = 0x1000,
7039     /// Signal that the runtime library should use args as an array of
7040     /// descriptor_dim pointers and use args_size as dims. Used when we have
7041     /// non-contiguous list items in target update directive
7042     OMP_MAP_NON_CONTIG = 0x100000000000,
7043     /// The 16 MSBs of the flags indicate whether the entry is member of some
7044     /// struct/class.
7045     OMP_MAP_MEMBER_OF = 0xffff000000000000,
7046     LLVM_MARK_AS_BITMASK_ENUM(/* LargestFlag = */ OMP_MAP_MEMBER_OF),
7047   };
7048 
7049   /// Get the offset of the OMP_MAP_MEMBER_OF field.
7050   static unsigned getFlagMemberOffset() {
7051     unsigned Offset = 0;
7052     for (uint64_t Remain = OMP_MAP_MEMBER_OF; !(Remain & 1);
7053          Remain = Remain >> 1)
7054       Offset++;
7055     return Offset;
7056   }
7057 
7058   /// Class that holds debugging information for a data mapping to be passed to
7059   /// the runtime library.
7060   class MappingExprInfo {
7061     /// The variable declaration used for the data mapping.
7062     const ValueDecl *MapDecl = nullptr;
7063     /// The original expression used in the map clause, or null if there is
7064     /// none.
7065     const Expr *MapExpr = nullptr;
7066 
7067   public:
7068     MappingExprInfo(const ValueDecl *MapDecl, const Expr *MapExpr = nullptr)
7069         : MapDecl(MapDecl), MapExpr(MapExpr) {}
7070 
7071     const ValueDecl *getMapDecl() const { return MapDecl; }
7072     const Expr *getMapExpr() const { return MapExpr; }
7073   };
7074 
7075   /// Class that associates information with a base pointer to be passed to the
7076   /// runtime library.
7077   class BasePointerInfo {
7078     /// The base pointer.
7079     llvm::Value *Ptr = nullptr;
7080     /// The base declaration that refers to this device pointer, or null if
7081     /// there is none.
7082     const ValueDecl *DevPtrDecl = nullptr;
7083 
7084   public:
7085     BasePointerInfo(llvm::Value *Ptr, const ValueDecl *DevPtrDecl = nullptr)
7086         : Ptr(Ptr), DevPtrDecl(DevPtrDecl) {}
7087     llvm::Value *operator*() const { return Ptr; }
7088     const ValueDecl *getDevicePtrDecl() const { return DevPtrDecl; }
7089     void setDevicePtrDecl(const ValueDecl *D) { DevPtrDecl = D; }
7090   };
7091 
7092   using MapExprsArrayTy = SmallVector<MappingExprInfo, 4>;
7093   using MapBaseValuesArrayTy = SmallVector<BasePointerInfo, 4>;
7094   using MapValuesArrayTy = SmallVector<llvm::Value *, 4>;
7095   using MapFlagsArrayTy = SmallVector<OpenMPOffloadMappingFlags, 4>;
7096   using MapMappersArrayTy = SmallVector<const ValueDecl *, 4>;
7097   using MapDimArrayTy = SmallVector<uint64_t, 4>;
7098   using MapNonContiguousArrayTy = SmallVector<MapValuesArrayTy, 4>;
7099 
7100   /// This structure contains combined information generated for mappable
7101   /// clauses, including base pointers, pointers, sizes, map types, user-defined
7102   /// mappers, and non-contiguous information.
7103   struct MapCombinedInfoTy {
7104     struct StructNonContiguousInfo {
7105       bool IsNonContiguous = false;
7106       MapDimArrayTy Dims;
7107       MapNonContiguousArrayTy Offsets;
7108       MapNonContiguousArrayTy Counts;
7109       MapNonContiguousArrayTy Strides;
7110     };
7111     MapExprsArrayTy Exprs;
7112     MapBaseValuesArrayTy BasePointers;
7113     MapValuesArrayTy Pointers;
7114     MapValuesArrayTy Sizes;
7115     MapFlagsArrayTy Types;
7116     MapMappersArrayTy Mappers;
7117     StructNonContiguousInfo NonContigInfo;
7118 
7119     /// Append arrays in \a CurInfo.
7120     void append(MapCombinedInfoTy &CurInfo) {
7121       Exprs.append(CurInfo.Exprs.begin(), CurInfo.Exprs.end());
7122       BasePointers.append(CurInfo.BasePointers.begin(),
7123                           CurInfo.BasePointers.end());
7124       Pointers.append(CurInfo.Pointers.begin(), CurInfo.Pointers.end());
7125       Sizes.append(CurInfo.Sizes.begin(), CurInfo.Sizes.end());
7126       Types.append(CurInfo.Types.begin(), CurInfo.Types.end());
7127       Mappers.append(CurInfo.Mappers.begin(), CurInfo.Mappers.end());
7128       NonContigInfo.Dims.append(CurInfo.NonContigInfo.Dims.begin(),
7129                                  CurInfo.NonContigInfo.Dims.end());
7130       NonContigInfo.Offsets.append(CurInfo.NonContigInfo.Offsets.begin(),
7131                                     CurInfo.NonContigInfo.Offsets.end());
7132       NonContigInfo.Counts.append(CurInfo.NonContigInfo.Counts.begin(),
7133                                    CurInfo.NonContigInfo.Counts.end());
7134       NonContigInfo.Strides.append(CurInfo.NonContigInfo.Strides.begin(),
7135                                     CurInfo.NonContigInfo.Strides.end());
7136     }
7137   };
7138 
7139   /// Map between a struct and the its lowest & highest elements which have been
7140   /// mapped.
7141   /// [ValueDecl *] --> {LE(FieldIndex, Pointer),
7142   ///                    HE(FieldIndex, Pointer)}
7143   struct StructRangeInfoTy {
7144     std::pair<unsigned /*FieldIndex*/, Address /*Pointer*/> LowestElem = {
7145         0, Address::invalid()};
7146     std::pair<unsigned /*FieldIndex*/, Address /*Pointer*/> HighestElem = {
7147         0, Address::invalid()};
7148     Address Base = Address::invalid();
7149     bool IsArraySection = false;
7150   };
7151 
7152 private:
7153   /// Kind that defines how a device pointer has to be returned.
7154   struct MapInfo {
7155     OMPClauseMappableExprCommon::MappableExprComponentListRef Components;
7156     OpenMPMapClauseKind MapType = OMPC_MAP_unknown;
7157     ArrayRef<OpenMPMapModifierKind> MapModifiers;
7158     ArrayRef<OpenMPMotionModifierKind> MotionModifiers;
7159     bool ReturnDevicePointer = false;
7160     bool IsImplicit = false;
7161     const ValueDecl *Mapper = nullptr;
7162     const Expr *VarRef = nullptr;
7163     bool ForDeviceAddr = false;
7164 
7165     MapInfo() = default;
7166     MapInfo(
7167         OMPClauseMappableExprCommon::MappableExprComponentListRef Components,
7168         OpenMPMapClauseKind MapType,
7169         ArrayRef<OpenMPMapModifierKind> MapModifiers,
7170         ArrayRef<OpenMPMotionModifierKind> MotionModifiers,
7171         bool ReturnDevicePointer, bool IsImplicit,
7172         const ValueDecl *Mapper = nullptr, const Expr *VarRef = nullptr,
7173         bool ForDeviceAddr = false)
7174         : Components(Components), MapType(MapType), MapModifiers(MapModifiers),
7175           MotionModifiers(MotionModifiers),
7176           ReturnDevicePointer(ReturnDevicePointer), IsImplicit(IsImplicit),
7177           Mapper(Mapper), VarRef(VarRef), ForDeviceAddr(ForDeviceAddr) {}
7178   };
7179 
7180   /// If use_device_ptr or use_device_addr is used on a decl which is a struct
7181   /// member and there is no map information about it, then emission of that
7182   /// entry is deferred until the whole struct has been processed.
7183   struct DeferredDevicePtrEntryTy {
7184     const Expr *IE = nullptr;
7185     const ValueDecl *VD = nullptr;
7186     bool ForDeviceAddr = false;
7187 
7188     DeferredDevicePtrEntryTy(const Expr *IE, const ValueDecl *VD,
7189                              bool ForDeviceAddr)
7190         : IE(IE), VD(VD), ForDeviceAddr(ForDeviceAddr) {}
7191   };
7192 
7193   /// The target directive from where the mappable clauses were extracted. It
7194   /// is either a executable directive or a user-defined mapper directive.
7195   llvm::PointerUnion<const OMPExecutableDirective *,
7196                      const OMPDeclareMapperDecl *>
7197       CurDir;
7198 
7199   /// Function the directive is being generated for.
7200   CodeGenFunction &CGF;
7201 
7202   /// Set of all first private variables in the current directive.
7203   /// bool data is set to true if the variable is implicitly marked as
7204   /// firstprivate, false otherwise.
7205   llvm::DenseMap<CanonicalDeclPtr<const VarDecl>, bool> FirstPrivateDecls;
7206 
7207   /// Map between device pointer declarations and their expression components.
7208   /// The key value for declarations in 'this' is null.
7209   llvm::DenseMap<
7210       const ValueDecl *,
7211       SmallVector<OMPClauseMappableExprCommon::MappableExprComponentListRef, 4>>
7212       DevPointersMap;
7213 
7214   llvm::Value *getExprTypeSize(const Expr *E) const {
7215     QualType ExprTy = E->getType().getCanonicalType();
7216 
7217     // Calculate the size for array shaping expression.
7218     if (const auto *OAE = dyn_cast<OMPArrayShapingExpr>(E)) {
7219       llvm::Value *Size =
7220           CGF.getTypeSize(OAE->getBase()->getType()->getPointeeType());
7221       for (const Expr *SE : OAE->getDimensions()) {
7222         llvm::Value *Sz = CGF.EmitScalarExpr(SE);
7223         Sz = CGF.EmitScalarConversion(Sz, SE->getType(),
7224                                       CGF.getContext().getSizeType(),
7225                                       SE->getExprLoc());
7226         Size = CGF.Builder.CreateNUWMul(Size, Sz);
7227       }
7228       return Size;
7229     }
7230 
7231     // Reference types are ignored for mapping purposes.
7232     if (const auto *RefTy = ExprTy->getAs<ReferenceType>())
7233       ExprTy = RefTy->getPointeeType().getCanonicalType();
7234 
7235     // Given that an array section is considered a built-in type, we need to
7236     // do the calculation based on the length of the section instead of relying
7237     // on CGF.getTypeSize(E->getType()).
7238     if (const auto *OAE = dyn_cast<OMPArraySectionExpr>(E)) {
7239       QualType BaseTy = OMPArraySectionExpr::getBaseOriginalType(
7240                             OAE->getBase()->IgnoreParenImpCasts())
7241                             .getCanonicalType();
7242 
7243       // If there is no length associated with the expression and lower bound is
7244       // not specified too, that means we are using the whole length of the
7245       // base.
7246       if (!OAE->getLength() && OAE->getColonLocFirst().isValid() &&
7247           !OAE->getLowerBound())
7248         return CGF.getTypeSize(BaseTy);
7249 
7250       llvm::Value *ElemSize;
7251       if (const auto *PTy = BaseTy->getAs<PointerType>()) {
7252         ElemSize = CGF.getTypeSize(PTy->getPointeeType().getCanonicalType());
7253       } else {
7254         const auto *ATy = cast<ArrayType>(BaseTy.getTypePtr());
7255         assert(ATy && "Expecting array type if not a pointer type.");
7256         ElemSize = CGF.getTypeSize(ATy->getElementType().getCanonicalType());
7257       }
7258 
7259       // If we don't have a length at this point, that is because we have an
7260       // array section with a single element.
7261       if (!OAE->getLength() && OAE->getColonLocFirst().isInvalid())
7262         return ElemSize;
7263 
7264       if (const Expr *LenExpr = OAE->getLength()) {
7265         llvm::Value *LengthVal = CGF.EmitScalarExpr(LenExpr);
7266         LengthVal = CGF.EmitScalarConversion(LengthVal, LenExpr->getType(),
7267                                              CGF.getContext().getSizeType(),
7268                                              LenExpr->getExprLoc());
7269         return CGF.Builder.CreateNUWMul(LengthVal, ElemSize);
7270       }
7271       assert(!OAE->getLength() && OAE->getColonLocFirst().isValid() &&
7272              OAE->getLowerBound() && "expected array_section[lb:].");
7273       // Size = sizetype - lb * elemtype;
7274       llvm::Value *LengthVal = CGF.getTypeSize(BaseTy);
7275       llvm::Value *LBVal = CGF.EmitScalarExpr(OAE->getLowerBound());
7276       LBVal = CGF.EmitScalarConversion(LBVal, OAE->getLowerBound()->getType(),
7277                                        CGF.getContext().getSizeType(),
7278                                        OAE->getLowerBound()->getExprLoc());
7279       LBVal = CGF.Builder.CreateNUWMul(LBVal, ElemSize);
7280       llvm::Value *Cmp = CGF.Builder.CreateICmpUGT(LengthVal, LBVal);
7281       llvm::Value *TrueVal = CGF.Builder.CreateNUWSub(LengthVal, LBVal);
7282       LengthVal = CGF.Builder.CreateSelect(
7283           Cmp, TrueVal, llvm::ConstantInt::get(CGF.SizeTy, 0));
7284       return LengthVal;
7285     }
7286     return CGF.getTypeSize(ExprTy);
7287   }
7288 
7289   /// Return the corresponding bits for a given map clause modifier. Add
7290   /// a flag marking the map as a pointer if requested. Add a flag marking the
7291   /// map as the first one of a series of maps that relate to the same map
7292   /// expression.
7293   OpenMPOffloadMappingFlags getMapTypeBits(
7294       OpenMPMapClauseKind MapType, ArrayRef<OpenMPMapModifierKind> MapModifiers,
7295       ArrayRef<OpenMPMotionModifierKind> MotionModifiers, bool IsImplicit,
7296       bool AddPtrFlag, bool AddIsTargetParamFlag, bool IsNonContiguous) const {
7297     OpenMPOffloadMappingFlags Bits =
7298         IsImplicit ? OMP_MAP_IMPLICIT : OMP_MAP_NONE;
7299     switch (MapType) {
7300     case OMPC_MAP_alloc:
7301     case OMPC_MAP_release:
7302       // alloc and release is the default behavior in the runtime library,  i.e.
7303       // if we don't pass any bits alloc/release that is what the runtime is
7304       // going to do. Therefore, we don't need to signal anything for these two
7305       // type modifiers.
7306       break;
7307     case OMPC_MAP_to:
7308       Bits |= OMP_MAP_TO;
7309       break;
7310     case OMPC_MAP_from:
7311       Bits |= OMP_MAP_FROM;
7312       break;
7313     case OMPC_MAP_tofrom:
7314       Bits |= OMP_MAP_TO | OMP_MAP_FROM;
7315       break;
7316     case OMPC_MAP_delete:
7317       Bits |= OMP_MAP_DELETE;
7318       break;
7319     case OMPC_MAP_unknown:
7320       llvm_unreachable("Unexpected map type!");
7321     }
7322     if (AddPtrFlag)
7323       Bits |= OMP_MAP_PTR_AND_OBJ;
7324     if (AddIsTargetParamFlag)
7325       Bits |= OMP_MAP_TARGET_PARAM;
7326     if (llvm::find(MapModifiers, OMPC_MAP_MODIFIER_always)
7327         != MapModifiers.end())
7328       Bits |= OMP_MAP_ALWAYS;
7329     if (llvm::find(MapModifiers, OMPC_MAP_MODIFIER_close)
7330         != MapModifiers.end())
7331       Bits |= OMP_MAP_CLOSE;
7332     if (llvm::find(MapModifiers, OMPC_MAP_MODIFIER_present)
7333         != MapModifiers.end())
7334       Bits |= OMP_MAP_PRESENT;
7335     if (llvm::find(MotionModifiers, OMPC_MOTION_MODIFIER_present)
7336         != MotionModifiers.end())
7337       Bits |= OMP_MAP_PRESENT;
7338     if (IsNonContiguous)
7339       Bits |= OMP_MAP_NON_CONTIG;
7340     return Bits;
7341   }
7342 
7343   /// Return true if the provided expression is a final array section. A
7344   /// final array section, is one whose length can't be proved to be one.
7345   bool isFinalArraySectionExpression(const Expr *E) const {
7346     const auto *OASE = dyn_cast<OMPArraySectionExpr>(E);
7347 
7348     // It is not an array section and therefore not a unity-size one.
7349     if (!OASE)
7350       return false;
7351 
7352     // An array section with no colon always refer to a single element.
7353     if (OASE->getColonLocFirst().isInvalid())
7354       return false;
7355 
7356     const Expr *Length = OASE->getLength();
7357 
7358     // If we don't have a length we have to check if the array has size 1
7359     // for this dimension. Also, we should always expect a length if the
7360     // base type is pointer.
7361     if (!Length) {
7362       QualType BaseQTy = OMPArraySectionExpr::getBaseOriginalType(
7363                              OASE->getBase()->IgnoreParenImpCasts())
7364                              .getCanonicalType();
7365       if (const auto *ATy = dyn_cast<ConstantArrayType>(BaseQTy.getTypePtr()))
7366         return ATy->getSize().getSExtValue() != 1;
7367       // If we don't have a constant dimension length, we have to consider
7368       // the current section as having any size, so it is not necessarily
7369       // unitary. If it happen to be unity size, that's user fault.
7370       return true;
7371     }
7372 
7373     // Check if the length evaluates to 1.
7374     Expr::EvalResult Result;
7375     if (!Length->EvaluateAsInt(Result, CGF.getContext()))
7376       return true; // Can have more that size 1.
7377 
7378     llvm::APSInt ConstLength = Result.Val.getInt();
7379     return ConstLength.getSExtValue() != 1;
7380   }
7381 
7382   /// Generate the base pointers, section pointers, sizes, map type bits, and
7383   /// user-defined mappers (all included in \a CombinedInfo) for the provided
7384   /// map type, map or motion modifiers, and expression components.
7385   /// \a IsFirstComponent should be set to true if the provided set of
7386   /// components is the first associated with a capture.
7387   void generateInfoForComponentList(
7388       OpenMPMapClauseKind MapType, ArrayRef<OpenMPMapModifierKind> MapModifiers,
7389       ArrayRef<OpenMPMotionModifierKind> MotionModifiers,
7390       OMPClauseMappableExprCommon::MappableExprComponentListRef Components,
7391       MapCombinedInfoTy &CombinedInfo, StructRangeInfoTy &PartialStruct,
7392       bool IsFirstComponentList, bool IsImplicit,
7393       const ValueDecl *Mapper = nullptr, bool ForDeviceAddr = false,
7394       const ValueDecl *BaseDecl = nullptr, const Expr *MapExpr = nullptr,
7395       ArrayRef<OMPClauseMappableExprCommon::MappableExprComponentListRef>
7396           OverlappedElements = llvm::None) const {
7397     // The following summarizes what has to be generated for each map and the
7398     // types below. The generated information is expressed in this order:
7399     // base pointer, section pointer, size, flags
7400     // (to add to the ones that come from the map type and modifier).
7401     //
7402     // double d;
7403     // int i[100];
7404     // float *p;
7405     //
7406     // struct S1 {
7407     //   int i;
7408     //   float f[50];
7409     // }
7410     // struct S2 {
7411     //   int i;
7412     //   float f[50];
7413     //   S1 s;
7414     //   double *p;
7415     //   struct S2 *ps;
7416     // }
7417     // S2 s;
7418     // S2 *ps;
7419     //
7420     // map(d)
7421     // &d, &d, sizeof(double), TARGET_PARAM | TO | FROM
7422     //
7423     // map(i)
7424     // &i, &i, 100*sizeof(int), TARGET_PARAM | TO | FROM
7425     //
7426     // map(i[1:23])
7427     // &i(=&i[0]), &i[1], 23*sizeof(int), TARGET_PARAM | TO | FROM
7428     //
7429     // map(p)
7430     // &p, &p, sizeof(float*), TARGET_PARAM | TO | FROM
7431     //
7432     // map(p[1:24])
7433     // &p, &p[1], 24*sizeof(float), TARGET_PARAM | TO | FROM | PTR_AND_OBJ
7434     // in unified shared memory mode or for local pointers
7435     // p, &p[1], 24*sizeof(float), TARGET_PARAM | TO | FROM
7436     //
7437     // map(s)
7438     // &s, &s, sizeof(S2), TARGET_PARAM | TO | FROM
7439     //
7440     // map(s.i)
7441     // &s, &(s.i), sizeof(int), TARGET_PARAM | TO | FROM
7442     //
7443     // map(s.s.f)
7444     // &s, &(s.s.f[0]), 50*sizeof(float), TARGET_PARAM | TO | FROM
7445     //
7446     // map(s.p)
7447     // &s, &(s.p), sizeof(double*), TARGET_PARAM | TO | FROM
7448     //
7449     // map(to: s.p[:22])
7450     // &s, &(s.p), sizeof(double*), TARGET_PARAM (*)
7451     // &s, &(s.p), sizeof(double*), MEMBER_OF(1) (**)
7452     // &(s.p), &(s.p[0]), 22*sizeof(double),
7453     //   MEMBER_OF(1) | PTR_AND_OBJ | TO (***)
7454     // (*) alloc space for struct members, only this is a target parameter
7455     // (**) map the pointer (nothing to be mapped in this example) (the compiler
7456     //      optimizes this entry out, same in the examples below)
7457     // (***) map the pointee (map: to)
7458     //
7459     // map(s.ps)
7460     // &s, &(s.ps), sizeof(S2*), TARGET_PARAM | TO | FROM
7461     //
7462     // map(from: s.ps->s.i)
7463     // &s, &(s.ps), sizeof(S2*), TARGET_PARAM
7464     // &s, &(s.ps), sizeof(S2*), MEMBER_OF(1)
7465     // &(s.ps), &(s.ps->s.i), sizeof(int), MEMBER_OF(1) | PTR_AND_OBJ  | FROM
7466     //
7467     // map(to: s.ps->ps)
7468     // &s, &(s.ps), sizeof(S2*), TARGET_PARAM
7469     // &s, &(s.ps), sizeof(S2*), MEMBER_OF(1)
7470     // &(s.ps), &(s.ps->ps), sizeof(S2*), MEMBER_OF(1) | PTR_AND_OBJ  | TO
7471     //
7472     // map(s.ps->ps->ps)
7473     // &s, &(s.ps), sizeof(S2*), TARGET_PARAM
7474     // &s, &(s.ps), sizeof(S2*), MEMBER_OF(1)
7475     // &(s.ps), &(s.ps->ps), sizeof(S2*), MEMBER_OF(1) | PTR_AND_OBJ
7476     // &(s.ps->ps), &(s.ps->ps->ps), sizeof(S2*), PTR_AND_OBJ | TO | FROM
7477     //
7478     // map(to: s.ps->ps->s.f[:22])
7479     // &s, &(s.ps), sizeof(S2*), TARGET_PARAM
7480     // &s, &(s.ps), sizeof(S2*), MEMBER_OF(1)
7481     // &(s.ps), &(s.ps->ps), sizeof(S2*), MEMBER_OF(1) | PTR_AND_OBJ
7482     // &(s.ps->ps), &(s.ps->ps->s.f[0]), 22*sizeof(float), PTR_AND_OBJ | TO
7483     //
7484     // map(ps)
7485     // &ps, &ps, sizeof(S2*), TARGET_PARAM | TO | FROM
7486     //
7487     // map(ps->i)
7488     // ps, &(ps->i), sizeof(int), TARGET_PARAM | TO | FROM
7489     //
7490     // map(ps->s.f)
7491     // ps, &(ps->s.f[0]), 50*sizeof(float), TARGET_PARAM | TO | FROM
7492     //
7493     // map(from: ps->p)
7494     // ps, &(ps->p), sizeof(double*), TARGET_PARAM | FROM
7495     //
7496     // map(to: ps->p[:22])
7497     // ps, &(ps->p), sizeof(double*), TARGET_PARAM
7498     // ps, &(ps->p), sizeof(double*), MEMBER_OF(1)
7499     // &(ps->p), &(ps->p[0]), 22*sizeof(double), MEMBER_OF(1) | PTR_AND_OBJ | TO
7500     //
7501     // map(ps->ps)
7502     // ps, &(ps->ps), sizeof(S2*), TARGET_PARAM | TO | FROM
7503     //
7504     // map(from: ps->ps->s.i)
7505     // ps, &(ps->ps), sizeof(S2*), TARGET_PARAM
7506     // ps, &(ps->ps), sizeof(S2*), MEMBER_OF(1)
7507     // &(ps->ps), &(ps->ps->s.i), sizeof(int), MEMBER_OF(1) | PTR_AND_OBJ | FROM
7508     //
7509     // map(from: ps->ps->ps)
7510     // ps, &(ps->ps), sizeof(S2*), TARGET_PARAM
7511     // ps, &(ps->ps), sizeof(S2*), MEMBER_OF(1)
7512     // &(ps->ps), &(ps->ps->ps), sizeof(S2*), MEMBER_OF(1) | PTR_AND_OBJ | FROM
7513     //
7514     // map(ps->ps->ps->ps)
7515     // ps, &(ps->ps), sizeof(S2*), TARGET_PARAM
7516     // ps, &(ps->ps), sizeof(S2*), MEMBER_OF(1)
7517     // &(ps->ps), &(ps->ps->ps), sizeof(S2*), MEMBER_OF(1) | PTR_AND_OBJ
7518     // &(ps->ps->ps), &(ps->ps->ps->ps), sizeof(S2*), PTR_AND_OBJ | TO | FROM
7519     //
7520     // map(to: ps->ps->ps->s.f[:22])
7521     // ps, &(ps->ps), sizeof(S2*), TARGET_PARAM
7522     // ps, &(ps->ps), sizeof(S2*), MEMBER_OF(1)
7523     // &(ps->ps), &(ps->ps->ps), sizeof(S2*), MEMBER_OF(1) | PTR_AND_OBJ
7524     // &(ps->ps->ps), &(ps->ps->ps->s.f[0]), 22*sizeof(float), PTR_AND_OBJ | TO
7525     //
7526     // map(to: s.f[:22]) map(from: s.p[:33])
7527     // &s, &(s.f[0]), 50*sizeof(float) + sizeof(struct S1) +
7528     //     sizeof(double*) (**), TARGET_PARAM
7529     // &s, &(s.f[0]), 22*sizeof(float), MEMBER_OF(1) | TO
7530     // &s, &(s.p), sizeof(double*), MEMBER_OF(1)
7531     // &(s.p), &(s.p[0]), 33*sizeof(double), MEMBER_OF(1) | PTR_AND_OBJ | FROM
7532     // (*) allocate contiguous space needed to fit all mapped members even if
7533     //     we allocate space for members not mapped (in this example,
7534     //     s.f[22..49] and s.s are not mapped, yet we must allocate space for
7535     //     them as well because they fall between &s.f[0] and &s.p)
7536     //
7537     // map(from: s.f[:22]) map(to: ps->p[:33])
7538     // &s, &(s.f[0]), 22*sizeof(float), TARGET_PARAM | FROM
7539     // ps, &(ps->p), sizeof(S2*), TARGET_PARAM
7540     // ps, &(ps->p), sizeof(double*), MEMBER_OF(2) (*)
7541     // &(ps->p), &(ps->p[0]), 33*sizeof(double), MEMBER_OF(2) | PTR_AND_OBJ | TO
7542     // (*) the struct this entry pertains to is the 2nd element in the list of
7543     //     arguments, hence MEMBER_OF(2)
7544     //
7545     // map(from: s.f[:22], s.s) map(to: ps->p[:33])
7546     // &s, &(s.f[0]), 50*sizeof(float) + sizeof(struct S1), TARGET_PARAM
7547     // &s, &(s.f[0]), 22*sizeof(float), MEMBER_OF(1) | FROM
7548     // &s, &(s.s), sizeof(struct S1), MEMBER_OF(1) | FROM
7549     // ps, &(ps->p), sizeof(S2*), TARGET_PARAM
7550     // ps, &(ps->p), sizeof(double*), MEMBER_OF(4) (*)
7551     // &(ps->p), &(ps->p[0]), 33*sizeof(double), MEMBER_OF(4) | PTR_AND_OBJ | TO
7552     // (*) the struct this entry pertains to is the 4th element in the list
7553     //     of arguments, hence MEMBER_OF(4)
7554 
7555     // Track if the map information being generated is the first for a capture.
7556     bool IsCaptureFirstInfo = IsFirstComponentList;
7557     // When the variable is on a declare target link or in a to clause with
7558     // unified memory, a reference is needed to hold the host/device address
7559     // of the variable.
7560     bool RequiresReference = false;
7561 
7562     // Scan the components from the base to the complete expression.
7563     auto CI = Components.rbegin();
7564     auto CE = Components.rend();
7565     auto I = CI;
7566 
7567     // Track if the map information being generated is the first for a list of
7568     // components.
7569     bool IsExpressionFirstInfo = true;
7570     bool FirstPointerInComplexData = false;
7571     Address BP = Address::invalid();
7572     const Expr *AssocExpr = I->getAssociatedExpression();
7573     const auto *AE = dyn_cast<ArraySubscriptExpr>(AssocExpr);
7574     const auto *OASE = dyn_cast<OMPArraySectionExpr>(AssocExpr);
7575     const auto *OAShE = dyn_cast<OMPArrayShapingExpr>(AssocExpr);
7576 
7577     if (isa<MemberExpr>(AssocExpr)) {
7578       // The base is the 'this' pointer. The content of the pointer is going
7579       // to be the base of the field being mapped.
7580       BP = CGF.LoadCXXThisAddress();
7581     } else if ((AE && isa<CXXThisExpr>(AE->getBase()->IgnoreParenImpCasts())) ||
7582                (OASE &&
7583                 isa<CXXThisExpr>(OASE->getBase()->IgnoreParenImpCasts()))) {
7584       BP = CGF.EmitOMPSharedLValue(AssocExpr).getAddress(CGF);
7585     } else if (OAShE &&
7586                isa<CXXThisExpr>(OAShE->getBase()->IgnoreParenCasts())) {
7587       BP = Address(
7588           CGF.EmitScalarExpr(OAShE->getBase()),
7589           CGF.getContext().getTypeAlignInChars(OAShE->getBase()->getType()));
7590     } else {
7591       // The base is the reference to the variable.
7592       // BP = &Var.
7593       BP = CGF.EmitOMPSharedLValue(AssocExpr).getAddress(CGF);
7594       if (const auto *VD =
7595               dyn_cast_or_null<VarDecl>(I->getAssociatedDeclaration())) {
7596         if (llvm::Optional<OMPDeclareTargetDeclAttr::MapTypeTy> Res =
7597                 OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(VD)) {
7598           if ((*Res == OMPDeclareTargetDeclAttr::MT_Link) ||
7599               (*Res == OMPDeclareTargetDeclAttr::MT_To &&
7600                CGF.CGM.getOpenMPRuntime().hasRequiresUnifiedSharedMemory())) {
7601             RequiresReference = true;
7602             BP = CGF.CGM.getOpenMPRuntime().getAddrOfDeclareTargetVar(VD);
7603           }
7604         }
7605       }
7606 
7607       // If the variable is a pointer and is being dereferenced (i.e. is not
7608       // the last component), the base has to be the pointer itself, not its
7609       // reference. References are ignored for mapping purposes.
7610       QualType Ty =
7611           I->getAssociatedDeclaration()->getType().getNonReferenceType();
7612       if (Ty->isAnyPointerType() && std::next(I) != CE) {
7613         // No need to generate individual map information for the pointer, it
7614         // can be associated with the combined storage if shared memory mode is
7615         // active or the base declaration is not global variable.
7616         const auto *VD = dyn_cast<VarDecl>(I->getAssociatedDeclaration());
7617         if (CGF.CGM.getOpenMPRuntime().hasRequiresUnifiedSharedMemory() ||
7618             !VD || VD->hasLocalStorage())
7619           BP = CGF.EmitLoadOfPointer(BP, Ty->castAs<PointerType>());
7620         else
7621           FirstPointerInComplexData = true;
7622         ++I;
7623       }
7624     }
7625 
7626     // Track whether a component of the list should be marked as MEMBER_OF some
7627     // combined entry (for partial structs). Only the first PTR_AND_OBJ entry
7628     // in a component list should be marked as MEMBER_OF, all subsequent entries
7629     // do not belong to the base struct. E.g.
7630     // struct S2 s;
7631     // s.ps->ps->ps->f[:]
7632     //   (1) (2) (3) (4)
7633     // ps(1) is a member pointer, ps(2) is a pointee of ps(1), so it is a
7634     // PTR_AND_OBJ entry; the PTR is ps(1), so MEMBER_OF the base struct. ps(3)
7635     // is the pointee of ps(2) which is not member of struct s, so it should not
7636     // be marked as such (it is still PTR_AND_OBJ).
7637     // The variable is initialized to false so that PTR_AND_OBJ entries which
7638     // are not struct members are not considered (e.g. array of pointers to
7639     // data).
7640     bool ShouldBeMemberOf = false;
7641 
7642     // Variable keeping track of whether or not we have encountered a component
7643     // in the component list which is a member expression. Useful when we have a
7644     // pointer or a final array section, in which case it is the previous
7645     // component in the list which tells us whether we have a member expression.
7646     // E.g. X.f[:]
7647     // While processing the final array section "[:]" it is "f" which tells us
7648     // whether we are dealing with a member of a declared struct.
7649     const MemberExpr *EncounteredME = nullptr;
7650 
7651     // Track for the total number of dimension. Start from one for the dummy
7652     // dimension.
7653     uint64_t DimSize = 1;
7654 
7655     bool IsNonContiguous = CombinedInfo.NonContigInfo.IsNonContiguous;
7656 
7657     for (; I != CE; ++I) {
7658       // If the current component is member of a struct (parent struct) mark it.
7659       if (!EncounteredME) {
7660         EncounteredME = dyn_cast<MemberExpr>(I->getAssociatedExpression());
7661         // If we encounter a PTR_AND_OBJ entry from now on it should be marked
7662         // as MEMBER_OF the parent struct.
7663         if (EncounteredME) {
7664           ShouldBeMemberOf = true;
7665           // Do not emit as complex pointer if this is actually not array-like
7666           // expression.
7667           if (FirstPointerInComplexData) {
7668             QualType Ty = std::prev(I)
7669                               ->getAssociatedDeclaration()
7670                               ->getType()
7671                               .getNonReferenceType();
7672             BP = CGF.EmitLoadOfPointer(BP, Ty->castAs<PointerType>());
7673             FirstPointerInComplexData = false;
7674           }
7675         }
7676       }
7677 
7678       auto Next = std::next(I);
7679 
7680       // We need to generate the addresses and sizes if this is the last
7681       // component, if the component is a pointer or if it is an array section
7682       // whose length can't be proved to be one. If this is a pointer, it
7683       // becomes the base address for the following components.
7684 
7685       // A final array section, is one whose length can't be proved to be one.
7686       // If the map item is non-contiguous then we don't treat any array section
7687       // as final array section.
7688       bool IsFinalArraySection =
7689           !IsNonContiguous &&
7690           isFinalArraySectionExpression(I->getAssociatedExpression());
7691 
7692       // If we have a declaration for the mapping use that, otherwise use
7693       // the base declaration of the map clause.
7694       const ValueDecl *MapDecl = (I->getAssociatedDeclaration())
7695                                      ? I->getAssociatedDeclaration()
7696                                      : BaseDecl;
7697 
7698       // Get information on whether the element is a pointer. Have to do a
7699       // special treatment for array sections given that they are built-in
7700       // types.
7701       const auto *OASE =
7702           dyn_cast<OMPArraySectionExpr>(I->getAssociatedExpression());
7703       const auto *OAShE =
7704           dyn_cast<OMPArrayShapingExpr>(I->getAssociatedExpression());
7705       const auto *UO = dyn_cast<UnaryOperator>(I->getAssociatedExpression());
7706       const auto *BO = dyn_cast<BinaryOperator>(I->getAssociatedExpression());
7707       bool IsPointer =
7708           OAShE ||
7709           (OASE && OMPArraySectionExpr::getBaseOriginalType(OASE)
7710                        .getCanonicalType()
7711                        ->isAnyPointerType()) ||
7712           I->getAssociatedExpression()->getType()->isAnyPointerType();
7713       bool IsNonDerefPointer = IsPointer && !UO && !BO && !IsNonContiguous;
7714 
7715       if (OASE)
7716         ++DimSize;
7717 
7718       if (Next == CE || IsNonDerefPointer || IsFinalArraySection) {
7719         // If this is not the last component, we expect the pointer to be
7720         // associated with an array expression or member expression.
7721         assert((Next == CE ||
7722                 isa<MemberExpr>(Next->getAssociatedExpression()) ||
7723                 isa<ArraySubscriptExpr>(Next->getAssociatedExpression()) ||
7724                 isa<OMPArraySectionExpr>(Next->getAssociatedExpression()) ||
7725                 isa<OMPArrayShapingExpr>(Next->getAssociatedExpression()) ||
7726                 isa<UnaryOperator>(Next->getAssociatedExpression()) ||
7727                 isa<BinaryOperator>(Next->getAssociatedExpression())) &&
7728                "Unexpected expression");
7729 
7730         Address LB = Address::invalid();
7731         if (OAShE) {
7732           LB = Address(CGF.EmitScalarExpr(OAShE->getBase()),
7733                        CGF.getContext().getTypeAlignInChars(
7734                            OAShE->getBase()->getType()));
7735         } else {
7736           LB = CGF.EmitOMPSharedLValue(I->getAssociatedExpression())
7737                    .getAddress(CGF);
7738         }
7739 
7740         // If this component is a pointer inside the base struct then we don't
7741         // need to create any entry for it - it will be combined with the object
7742         // it is pointing to into a single PTR_AND_OBJ entry.
7743         bool IsMemberPointerOrAddr =
7744             (IsPointer || ForDeviceAddr) && EncounteredME &&
7745             (dyn_cast<MemberExpr>(I->getAssociatedExpression()) ==
7746              EncounteredME);
7747         if (!OverlappedElements.empty()) {
7748           // Handle base element with the info for overlapped elements.
7749           assert(!PartialStruct.Base.isValid() && "The base element is set.");
7750           assert(Next == CE &&
7751                  "Expected last element for the overlapped elements.");
7752           assert(!IsPointer &&
7753                  "Unexpected base element with the pointer type.");
7754           // Mark the whole struct as the struct that requires allocation on the
7755           // device.
7756           PartialStruct.LowestElem = {0, LB};
7757           CharUnits TypeSize = CGF.getContext().getTypeSizeInChars(
7758               I->getAssociatedExpression()->getType());
7759           Address HB = CGF.Builder.CreateConstGEP(
7760               CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(LB,
7761                                                               CGF.VoidPtrTy),
7762               TypeSize.getQuantity() - 1);
7763           PartialStruct.HighestElem = {
7764               std::numeric_limits<decltype(
7765                   PartialStruct.HighestElem.first)>::max(),
7766               HB};
7767           PartialStruct.Base = BP;
7768           // Emit data for non-overlapped data.
7769           OpenMPOffloadMappingFlags Flags =
7770               OMP_MAP_MEMBER_OF |
7771               getMapTypeBits(MapType, MapModifiers, MotionModifiers, IsImplicit,
7772                              /*AddPtrFlag=*/false,
7773                              /*AddIsTargetParamFlag=*/false, IsNonContiguous);
7774           LB = BP;
7775           llvm::Value *Size = nullptr;
7776           // Do bitcopy of all non-overlapped structure elements.
7777           for (OMPClauseMappableExprCommon::MappableExprComponentListRef
7778                    Component : OverlappedElements) {
7779             Address ComponentLB = Address::invalid();
7780             for (const OMPClauseMappableExprCommon::MappableComponent &MC :
7781                  Component) {
7782               if (MC.getAssociatedDeclaration()) {
7783                 ComponentLB =
7784                     CGF.EmitOMPSharedLValue(MC.getAssociatedExpression())
7785                         .getAddress(CGF);
7786                 Size = CGF.Builder.CreatePtrDiff(
7787                     CGF.EmitCastToVoidPtr(ComponentLB.getPointer()),
7788                     CGF.EmitCastToVoidPtr(LB.getPointer()));
7789                 break;
7790               }
7791             }
7792             assert(Size && "Failed to determine structure size");
7793             CombinedInfo.Exprs.emplace_back(MapDecl, MapExpr);
7794             CombinedInfo.BasePointers.push_back(BP.getPointer());
7795             CombinedInfo.Pointers.push_back(LB.getPointer());
7796             CombinedInfo.Sizes.push_back(CGF.Builder.CreateIntCast(
7797                 Size, CGF.Int64Ty, /*isSigned=*/true));
7798             CombinedInfo.Types.push_back(Flags);
7799             CombinedInfo.Mappers.push_back(nullptr);
7800             CombinedInfo.NonContigInfo.Dims.push_back(IsNonContiguous ? DimSize
7801                                                                       : 1);
7802             LB = CGF.Builder.CreateConstGEP(ComponentLB, 1);
7803           }
7804           CombinedInfo.Exprs.emplace_back(MapDecl, MapExpr);
7805           CombinedInfo.BasePointers.push_back(BP.getPointer());
7806           CombinedInfo.Pointers.push_back(LB.getPointer());
7807           Size = CGF.Builder.CreatePtrDiff(
7808               CGF.EmitCastToVoidPtr(
7809                   CGF.Builder.CreateConstGEP(HB, 1).getPointer()),
7810               CGF.EmitCastToVoidPtr(LB.getPointer()));
7811           CombinedInfo.Sizes.push_back(
7812               CGF.Builder.CreateIntCast(Size, CGF.Int64Ty, /*isSigned=*/true));
7813           CombinedInfo.Types.push_back(Flags);
7814           CombinedInfo.Mappers.push_back(nullptr);
7815           CombinedInfo.NonContigInfo.Dims.push_back(IsNonContiguous ? DimSize
7816                                                                     : 1);
7817           break;
7818         }
7819         llvm::Value *Size = getExprTypeSize(I->getAssociatedExpression());
7820         if (!IsMemberPointerOrAddr ||
7821             (Next == CE && MapType != OMPC_MAP_unknown)) {
7822           CombinedInfo.Exprs.emplace_back(MapDecl, MapExpr);
7823           CombinedInfo.BasePointers.push_back(BP.getPointer());
7824           CombinedInfo.Pointers.push_back(LB.getPointer());
7825           CombinedInfo.Sizes.push_back(
7826               CGF.Builder.CreateIntCast(Size, CGF.Int64Ty, /*isSigned=*/true));
7827           CombinedInfo.NonContigInfo.Dims.push_back(IsNonContiguous ? DimSize
7828                                                                     : 1);
7829 
7830           // If Mapper is valid, the last component inherits the mapper.
7831           bool HasMapper = Mapper && Next == CE;
7832           CombinedInfo.Mappers.push_back(HasMapper ? Mapper : nullptr);
7833 
7834           // We need to add a pointer flag for each map that comes from the
7835           // same expression except for the first one. We also need to signal
7836           // this map is the first one that relates with the current capture
7837           // (there is a set of entries for each capture).
7838           OpenMPOffloadMappingFlags Flags = getMapTypeBits(
7839               MapType, MapModifiers, MotionModifiers, IsImplicit,
7840               !IsExpressionFirstInfo || RequiresReference ||
7841                   FirstPointerInComplexData,
7842               IsCaptureFirstInfo && !RequiresReference, IsNonContiguous);
7843 
7844           if (!IsExpressionFirstInfo) {
7845             // If we have a PTR_AND_OBJ pair where the OBJ is a pointer as well,
7846             // then we reset the TO/FROM/ALWAYS/DELETE/CLOSE flags.
7847             if (IsPointer)
7848               Flags &= ~(OMP_MAP_TO | OMP_MAP_FROM | OMP_MAP_ALWAYS |
7849                          OMP_MAP_DELETE | OMP_MAP_CLOSE);
7850 
7851             if (ShouldBeMemberOf) {
7852               // Set placeholder value MEMBER_OF=FFFF to indicate that the flag
7853               // should be later updated with the correct value of MEMBER_OF.
7854               Flags |= OMP_MAP_MEMBER_OF;
7855               // From now on, all subsequent PTR_AND_OBJ entries should not be
7856               // marked as MEMBER_OF.
7857               ShouldBeMemberOf = false;
7858             }
7859           }
7860 
7861           CombinedInfo.Types.push_back(Flags);
7862         }
7863 
7864         // If we have encountered a member expression so far, keep track of the
7865         // mapped member. If the parent is "*this", then the value declaration
7866         // is nullptr.
7867         if (EncounteredME) {
7868           const auto *FD = cast<FieldDecl>(EncounteredME->getMemberDecl());
7869           unsigned FieldIndex = FD->getFieldIndex();
7870 
7871           // Update info about the lowest and highest elements for this struct
7872           if (!PartialStruct.Base.isValid()) {
7873             PartialStruct.LowestElem = {FieldIndex, LB};
7874             if (IsFinalArraySection) {
7875               Address HB =
7876                   CGF.EmitOMPArraySectionExpr(OASE, /*IsLowerBound=*/false)
7877                       .getAddress(CGF);
7878               PartialStruct.HighestElem = {FieldIndex, HB};
7879             } else {
7880               PartialStruct.HighestElem = {FieldIndex, LB};
7881             }
7882             PartialStruct.Base = BP;
7883           } else if (FieldIndex < PartialStruct.LowestElem.first) {
7884             PartialStruct.LowestElem = {FieldIndex, LB};
7885           } else if (FieldIndex > PartialStruct.HighestElem.first) {
7886             PartialStruct.HighestElem = {FieldIndex, LB};
7887           }
7888         }
7889 
7890         // Need to emit combined struct for array sections.
7891         if (IsFinalArraySection || IsNonContiguous)
7892           PartialStruct.IsArraySection = true;
7893 
7894         // If we have a final array section, we are done with this expression.
7895         if (IsFinalArraySection)
7896           break;
7897 
7898         // The pointer becomes the base for the next element.
7899         if (Next != CE)
7900           BP = LB;
7901 
7902         IsExpressionFirstInfo = false;
7903         IsCaptureFirstInfo = false;
7904         FirstPointerInComplexData = false;
7905       } else if (FirstPointerInComplexData) {
7906         BP = CGF.EmitOMPSharedLValue(I->getAssociatedExpression())
7907                  .getAddress(CGF);
7908         FirstPointerInComplexData = false;
7909       }
7910     }
7911 
7912     if (!IsNonContiguous)
7913       return;
7914 
7915     const ASTContext &Context = CGF.getContext();
7916 
7917     // For supporting stride in array section, we need to initialize the first
7918     // dimension size as 1, first offset as 0, and first count as 1
7919     MapValuesArrayTy CurOffsets = {llvm::ConstantInt::get(CGF.CGM.Int64Ty, 0)};
7920     MapValuesArrayTy CurCounts = {llvm::ConstantInt::get(CGF.CGM.Int64Ty, 1)};
7921     MapValuesArrayTy CurStrides;
7922     MapValuesArrayTy DimSizes{llvm::ConstantInt::get(CGF.CGM.Int64Ty, 1)};
7923     uint64_t ElementTypeSize;
7924 
7925     // Collect Size information for each dimension and get the element size as
7926     // the first Stride. For example, for `int arr[10][10]`, the DimSizes
7927     // should be [10, 10] and the first stride is 4 btyes.
7928     for (const OMPClauseMappableExprCommon::MappableComponent &Component :
7929          Components) {
7930       const Expr *AssocExpr = Component.getAssociatedExpression();
7931       const auto *OASE = dyn_cast<OMPArraySectionExpr>(AssocExpr);
7932 
7933       if (!OASE)
7934         continue;
7935 
7936       QualType Ty = OMPArraySectionExpr::getBaseOriginalType(OASE->getBase());
7937       auto *CAT = Context.getAsConstantArrayType(Ty);
7938       auto *VAT = Context.getAsVariableArrayType(Ty);
7939 
7940       // We need all the dimension size except for the last dimension.
7941       assert((VAT || CAT || &Component == &*Components.begin()) &&
7942              "Should be either ConstantArray or VariableArray if not the "
7943              "first Component");
7944 
7945       // Get element size if CurStrides is empty.
7946       if (CurStrides.empty()) {
7947         const Type *ElementType = nullptr;
7948         if (CAT)
7949           ElementType = CAT->getElementType().getTypePtr();
7950         else if (VAT)
7951           ElementType = VAT->getElementType().getTypePtr();
7952         else
7953           assert(&Component == &*Components.begin() &&
7954                  "Only expect pointer (non CAT or VAT) when this is the "
7955                  "first Component");
7956         // If ElementType is null, then it means the base is a pointer
7957         // (neither CAT nor VAT) and we'll attempt to get ElementType again
7958         // for next iteration.
7959         if (ElementType) {
7960           // For the case that having pointer as base, we need to remove one
7961           // level of indirection.
7962           if (&Component != &*Components.begin())
7963             ElementType = ElementType->getPointeeOrArrayElementType();
7964           ElementTypeSize =
7965               Context.getTypeSizeInChars(ElementType).getQuantity();
7966           CurStrides.push_back(
7967               llvm::ConstantInt::get(CGF.Int64Ty, ElementTypeSize));
7968         }
7969       }
7970       // Get dimension value except for the last dimension since we don't need
7971       // it.
7972       if (DimSizes.size() < Components.size() - 1) {
7973         if (CAT)
7974           DimSizes.push_back(llvm::ConstantInt::get(
7975               CGF.Int64Ty, CAT->getSize().getZExtValue()));
7976         else if (VAT)
7977           DimSizes.push_back(CGF.Builder.CreateIntCast(
7978               CGF.EmitScalarExpr(VAT->getSizeExpr()), CGF.Int64Ty,
7979               /*IsSigned=*/false));
7980       }
7981     }
7982 
7983     // Skip the dummy dimension since we have already have its information.
7984     auto DI = DimSizes.begin() + 1;
7985     // Product of dimension.
7986     llvm::Value *DimProd =
7987         llvm::ConstantInt::get(CGF.CGM.Int64Ty, ElementTypeSize);
7988 
7989     // Collect info for non-contiguous. Notice that offset, count, and stride
7990     // are only meaningful for array-section, so we insert a null for anything
7991     // other than array-section.
7992     // Also, the size of offset, count, and stride are not the same as
7993     // pointers, base_pointers, sizes, or dims. Instead, the size of offset,
7994     // count, and stride are the same as the number of non-contiguous
7995     // declaration in target update to/from clause.
7996     for (const OMPClauseMappableExprCommon::MappableComponent &Component :
7997          Components) {
7998       const Expr *AssocExpr = Component.getAssociatedExpression();
7999 
8000       if (const auto *AE = dyn_cast<ArraySubscriptExpr>(AssocExpr)) {
8001         llvm::Value *Offset = CGF.Builder.CreateIntCast(
8002             CGF.EmitScalarExpr(AE->getIdx()), CGF.Int64Ty,
8003             /*isSigned=*/false);
8004         CurOffsets.push_back(Offset);
8005         CurCounts.push_back(llvm::ConstantInt::get(CGF.Int64Ty, /*V=*/1));
8006         CurStrides.push_back(CurStrides.back());
8007         continue;
8008       }
8009 
8010       const auto *OASE = dyn_cast<OMPArraySectionExpr>(AssocExpr);
8011 
8012       if (!OASE)
8013         continue;
8014 
8015       // Offset
8016       const Expr *OffsetExpr = OASE->getLowerBound();
8017       llvm::Value *Offset = nullptr;
8018       if (!OffsetExpr) {
8019         // If offset is absent, then we just set it to zero.
8020         Offset = llvm::ConstantInt::get(CGF.Int64Ty, 0);
8021       } else {
8022         Offset = CGF.Builder.CreateIntCast(CGF.EmitScalarExpr(OffsetExpr),
8023                                            CGF.Int64Ty,
8024                                            /*isSigned=*/false);
8025       }
8026       CurOffsets.push_back(Offset);
8027 
8028       // Count
8029       const Expr *CountExpr = OASE->getLength();
8030       llvm::Value *Count = nullptr;
8031       if (!CountExpr) {
8032         // In Clang, once a high dimension is an array section, we construct all
8033         // the lower dimension as array section, however, for case like
8034         // arr[0:2][2], Clang construct the inner dimension as an array section
8035         // but it actually is not in an array section form according to spec.
8036         if (!OASE->getColonLocFirst().isValid() &&
8037             !OASE->getColonLocSecond().isValid()) {
8038           Count = llvm::ConstantInt::get(CGF.Int64Ty, 1);
8039         } else {
8040           // OpenMP 5.0, 2.1.5 Array Sections, Description.
8041           // When the length is absent it defaults to ⌈(size −
8042           // lower-bound)/stride⌉, where size is the size of the array
8043           // dimension.
8044           const Expr *StrideExpr = OASE->getStride();
8045           llvm::Value *Stride =
8046               StrideExpr
8047                   ? CGF.Builder.CreateIntCast(CGF.EmitScalarExpr(StrideExpr),
8048                                               CGF.Int64Ty, /*isSigned=*/false)
8049                   : nullptr;
8050           if (Stride)
8051             Count = CGF.Builder.CreateUDiv(
8052                 CGF.Builder.CreateNUWSub(*DI, Offset), Stride);
8053           else
8054             Count = CGF.Builder.CreateNUWSub(*DI, Offset);
8055         }
8056       } else {
8057         Count = CGF.EmitScalarExpr(CountExpr);
8058       }
8059       Count = CGF.Builder.CreateIntCast(Count, CGF.Int64Ty, /*isSigned=*/false);
8060       CurCounts.push_back(Count);
8061 
8062       // Stride_n' = Stride_n * (D_0 * D_1 ... * D_n-1) * Unit size
8063       // Take `int arr[5][5][5]` and `arr[0:2:2][1:2:1][0:2:2]` as an example:
8064       //              Offset      Count     Stride
8065       //    D0          0           1         4    (int)    <- dummy dimension
8066       //    D1          0           2         8    (2 * (1) * 4)
8067       //    D2          1           2         20   (1 * (1 * 5) * 4)
8068       //    D3          0           2         200  (2 * (1 * 5 * 4) * 4)
8069       const Expr *StrideExpr = OASE->getStride();
8070       llvm::Value *Stride =
8071           StrideExpr
8072               ? CGF.Builder.CreateIntCast(CGF.EmitScalarExpr(StrideExpr),
8073                                           CGF.Int64Ty, /*isSigned=*/false)
8074               : nullptr;
8075       DimProd = CGF.Builder.CreateNUWMul(DimProd, *(DI - 1));
8076       if (Stride)
8077         CurStrides.push_back(CGF.Builder.CreateNUWMul(DimProd, Stride));
8078       else
8079         CurStrides.push_back(DimProd);
8080       if (DI != DimSizes.end())
8081         ++DI;
8082     }
8083 
8084     CombinedInfo.NonContigInfo.Offsets.push_back(CurOffsets);
8085     CombinedInfo.NonContigInfo.Counts.push_back(CurCounts);
8086     CombinedInfo.NonContigInfo.Strides.push_back(CurStrides);
8087   }
8088 
8089   /// Return the adjusted map modifiers if the declaration a capture refers to
8090   /// appears in a first-private clause. This is expected to be used only with
8091   /// directives that start with 'target'.
8092   MappableExprsHandler::OpenMPOffloadMappingFlags
8093   getMapModifiersForPrivateClauses(const CapturedStmt::Capture &Cap) const {
8094     assert(Cap.capturesVariable() && "Expected capture by reference only!");
8095 
8096     // A first private variable captured by reference will use only the
8097     // 'private ptr' and 'map to' flag. Return the right flags if the captured
8098     // declaration is known as first-private in this handler.
8099     if (FirstPrivateDecls.count(Cap.getCapturedVar())) {
8100       if (Cap.getCapturedVar()->getType().isConstant(CGF.getContext()) &&
8101           Cap.getCaptureKind() == CapturedStmt::VCK_ByRef)
8102         return MappableExprsHandler::OMP_MAP_ALWAYS |
8103                MappableExprsHandler::OMP_MAP_TO;
8104       if (Cap.getCapturedVar()->getType()->isAnyPointerType())
8105         return MappableExprsHandler::OMP_MAP_TO |
8106                MappableExprsHandler::OMP_MAP_PTR_AND_OBJ;
8107       return MappableExprsHandler::OMP_MAP_PRIVATE |
8108              MappableExprsHandler::OMP_MAP_TO;
8109     }
8110     return MappableExprsHandler::OMP_MAP_TO |
8111            MappableExprsHandler::OMP_MAP_FROM;
8112   }
8113 
8114   static OpenMPOffloadMappingFlags getMemberOfFlag(unsigned Position) {
8115     // Rotate by getFlagMemberOffset() bits.
8116     return static_cast<OpenMPOffloadMappingFlags>(((uint64_t)Position + 1)
8117                                                   << getFlagMemberOffset());
8118   }
8119 
8120   static void setCorrectMemberOfFlag(OpenMPOffloadMappingFlags &Flags,
8121                                      OpenMPOffloadMappingFlags MemberOfFlag) {
8122     // If the entry is PTR_AND_OBJ but has not been marked with the special
8123     // placeholder value 0xFFFF in the MEMBER_OF field, then it should not be
8124     // marked as MEMBER_OF.
8125     if ((Flags & OMP_MAP_PTR_AND_OBJ) &&
8126         ((Flags & OMP_MAP_MEMBER_OF) != OMP_MAP_MEMBER_OF))
8127       return;
8128 
8129     // Reset the placeholder value to prepare the flag for the assignment of the
8130     // proper MEMBER_OF value.
8131     Flags &= ~OMP_MAP_MEMBER_OF;
8132     Flags |= MemberOfFlag;
8133   }
8134 
8135   void getPlainLayout(const CXXRecordDecl *RD,
8136                       llvm::SmallVectorImpl<const FieldDecl *> &Layout,
8137                       bool AsBase) const {
8138     const CGRecordLayout &RL = CGF.getTypes().getCGRecordLayout(RD);
8139 
8140     llvm::StructType *St =
8141         AsBase ? RL.getBaseSubobjectLLVMType() : RL.getLLVMType();
8142 
8143     unsigned NumElements = St->getNumElements();
8144     llvm::SmallVector<
8145         llvm::PointerUnion<const CXXRecordDecl *, const FieldDecl *>, 4>
8146         RecordLayout(NumElements);
8147 
8148     // Fill bases.
8149     for (const auto &I : RD->bases()) {
8150       if (I.isVirtual())
8151         continue;
8152       const auto *Base = I.getType()->getAsCXXRecordDecl();
8153       // Ignore empty bases.
8154       if (Base->isEmpty() || CGF.getContext()
8155                                  .getASTRecordLayout(Base)
8156                                  .getNonVirtualSize()
8157                                  .isZero())
8158         continue;
8159 
8160       unsigned FieldIndex = RL.getNonVirtualBaseLLVMFieldNo(Base);
8161       RecordLayout[FieldIndex] = Base;
8162     }
8163     // Fill in virtual bases.
8164     for (const auto &I : RD->vbases()) {
8165       const auto *Base = I.getType()->getAsCXXRecordDecl();
8166       // Ignore empty bases.
8167       if (Base->isEmpty())
8168         continue;
8169       unsigned FieldIndex = RL.getVirtualBaseIndex(Base);
8170       if (RecordLayout[FieldIndex])
8171         continue;
8172       RecordLayout[FieldIndex] = Base;
8173     }
8174     // Fill in all the fields.
8175     assert(!RD->isUnion() && "Unexpected union.");
8176     for (const auto *Field : RD->fields()) {
8177       // Fill in non-bitfields. (Bitfields always use a zero pattern, which we
8178       // will fill in later.)
8179       if (!Field->isBitField() && !Field->isZeroSize(CGF.getContext())) {
8180         unsigned FieldIndex = RL.getLLVMFieldNo(Field);
8181         RecordLayout[FieldIndex] = Field;
8182       }
8183     }
8184     for (const llvm::PointerUnion<const CXXRecordDecl *, const FieldDecl *>
8185              &Data : RecordLayout) {
8186       if (Data.isNull())
8187         continue;
8188       if (const auto *Base = Data.dyn_cast<const CXXRecordDecl *>())
8189         getPlainLayout(Base, Layout, /*AsBase=*/true);
8190       else
8191         Layout.push_back(Data.get<const FieldDecl *>());
8192     }
8193   }
8194 
8195 public:
8196   MappableExprsHandler(const OMPExecutableDirective &Dir, CodeGenFunction &CGF)
8197       : CurDir(&Dir), CGF(CGF) {
8198     // Extract firstprivate clause information.
8199     for (const auto *C : Dir.getClausesOfKind<OMPFirstprivateClause>())
8200       for (const auto *D : C->varlists())
8201         FirstPrivateDecls.try_emplace(
8202             cast<VarDecl>(cast<DeclRefExpr>(D)->getDecl()), C->isImplicit());
8203     // Extract implicit firstprivates from uses_allocators clauses.
8204     for (const auto *C : Dir.getClausesOfKind<OMPUsesAllocatorsClause>()) {
8205       for (unsigned I = 0, E = C->getNumberOfAllocators(); I < E; ++I) {
8206         OMPUsesAllocatorsClause::Data D = C->getAllocatorData(I);
8207         if (const auto *DRE = dyn_cast_or_null<DeclRefExpr>(D.AllocatorTraits))
8208           FirstPrivateDecls.try_emplace(cast<VarDecl>(DRE->getDecl()),
8209                                         /*Implicit=*/true);
8210         else if (const auto *VD = dyn_cast<VarDecl>(
8211                      cast<DeclRefExpr>(D.Allocator->IgnoreParenImpCasts())
8212                          ->getDecl()))
8213           FirstPrivateDecls.try_emplace(VD, /*Implicit=*/true);
8214       }
8215     }
8216     // Extract device pointer clause information.
8217     for (const auto *C : Dir.getClausesOfKind<OMPIsDevicePtrClause>())
8218       for (auto L : C->component_lists())
8219         DevPointersMap[std::get<0>(L)].push_back(std::get<1>(L));
8220   }
8221 
8222   /// Constructor for the declare mapper directive.
8223   MappableExprsHandler(const OMPDeclareMapperDecl &Dir, CodeGenFunction &CGF)
8224       : CurDir(&Dir), CGF(CGF) {}
8225 
8226   /// Generate code for the combined entry if we have a partially mapped struct
8227   /// and take care of the mapping flags of the arguments corresponding to
8228   /// individual struct members.
8229   void emitCombinedEntry(MapCombinedInfoTy &CombinedInfo,
8230                          MapFlagsArrayTy &CurTypes,
8231                          const StructRangeInfoTy &PartialStruct,
8232                          const ValueDecl *VD = nullptr,
8233                          bool NotTargetParams = false) const {
8234     if (CurTypes.size() == 1 &&
8235         ((CurTypes.back() & OMP_MAP_MEMBER_OF) != OMP_MAP_MEMBER_OF) &&
8236         !PartialStruct.IsArraySection)
8237       return;
8238     CombinedInfo.Exprs.push_back(VD);
8239     // Base is the base of the struct
8240     CombinedInfo.BasePointers.push_back(PartialStruct.Base.getPointer());
8241     // Pointer is the address of the lowest element
8242     llvm::Value *LB = PartialStruct.LowestElem.second.getPointer();
8243     CombinedInfo.Pointers.push_back(LB);
8244     // There should not be a mapper for a combined entry.
8245     CombinedInfo.Mappers.push_back(nullptr);
8246     // Size is (addr of {highest+1} element) - (addr of lowest element)
8247     llvm::Value *HB = PartialStruct.HighestElem.second.getPointer();
8248     llvm::Value *HAddr = CGF.Builder.CreateConstGEP1_32(HB, /*Idx0=*/1);
8249     llvm::Value *CLAddr = CGF.Builder.CreatePointerCast(LB, CGF.VoidPtrTy);
8250     llvm::Value *CHAddr = CGF.Builder.CreatePointerCast(HAddr, CGF.VoidPtrTy);
8251     llvm::Value *Diff = CGF.Builder.CreatePtrDiff(CHAddr, CLAddr);
8252     llvm::Value *Size = CGF.Builder.CreateIntCast(Diff, CGF.Int64Ty,
8253                                                   /*isSigned=*/false);
8254     CombinedInfo.Sizes.push_back(Size);
8255     // Map type is always TARGET_PARAM, if generate info for captures.
8256     CombinedInfo.Types.push_back(NotTargetParams ? OMP_MAP_NONE
8257                                                  : OMP_MAP_TARGET_PARAM);
8258     // If any element has the present modifier, then make sure the runtime
8259     // doesn't attempt to allocate the struct.
8260     if (CurTypes.end() !=
8261         llvm::find_if(CurTypes, [](OpenMPOffloadMappingFlags Type) {
8262           return Type & OMP_MAP_PRESENT;
8263         }))
8264       CombinedInfo.Types.back() |= OMP_MAP_PRESENT;
8265     // Remove TARGET_PARAM flag from the first element if any.
8266     if (!CurTypes.empty())
8267       CurTypes.front() &= ~OMP_MAP_TARGET_PARAM;
8268 
8269     // All other current entries will be MEMBER_OF the combined entry
8270     // (except for PTR_AND_OBJ entries which do not have a placeholder value
8271     // 0xFFFF in the MEMBER_OF field).
8272     OpenMPOffloadMappingFlags MemberOfFlag =
8273         getMemberOfFlag(CombinedInfo.BasePointers.size() - 1);
8274     for (auto &M : CurTypes)
8275       setCorrectMemberOfFlag(M, MemberOfFlag);
8276   }
8277 
8278   /// Generate all the base pointers, section pointers, sizes, map types, and
8279   /// mappers for the extracted mappable expressions (all included in \a
8280   /// CombinedInfo). Also, for each item that relates with a device pointer, a
8281   /// pair of the relevant declaration and index where it occurs is appended to
8282   /// the device pointers info array.
8283   void generateAllInfo(
8284       MapCombinedInfoTy &CombinedInfo, bool NotTargetParams = false,
8285       const llvm::DenseSet<CanonicalDeclPtr<const Decl>> &SkipVarSet =
8286           llvm::DenseSet<CanonicalDeclPtr<const Decl>>()) const {
8287     // We have to process the component lists that relate with the same
8288     // declaration in a single chunk so that we can generate the map flags
8289     // correctly. Therefore, we organize all lists in a map.
8290     llvm::MapVector<const ValueDecl *, SmallVector<MapInfo, 8>> Info;
8291 
8292     // Helper function to fill the information map for the different supported
8293     // clauses.
8294     auto &&InfoGen =
8295         [&Info, &SkipVarSet](
8296             const ValueDecl *D,
8297             OMPClauseMappableExprCommon::MappableExprComponentListRef L,
8298             OpenMPMapClauseKind MapType,
8299             ArrayRef<OpenMPMapModifierKind> MapModifiers,
8300             ArrayRef<OpenMPMotionModifierKind> MotionModifiers,
8301             bool ReturnDevicePointer, bool IsImplicit, const ValueDecl *Mapper,
8302             const Expr *VarRef = nullptr, bool ForDeviceAddr = false) {
8303           const ValueDecl *VD =
8304               D ? cast<ValueDecl>(D->getCanonicalDecl()) : nullptr;
8305           if (SkipVarSet.count(VD))
8306             return;
8307           Info[VD].emplace_back(L, MapType, MapModifiers, MotionModifiers,
8308                                 ReturnDevicePointer, IsImplicit, Mapper, VarRef,
8309                                 ForDeviceAddr);
8310         };
8311 
8312     assert(CurDir.is<const OMPExecutableDirective *>() &&
8313            "Expect a executable directive");
8314     const auto *CurExecDir = CurDir.get<const OMPExecutableDirective *>();
8315     for (const auto *C : CurExecDir->getClausesOfKind<OMPMapClause>()) {
8316       const auto *EI = C->getVarRefs().begin();
8317       for (const auto L : C->component_lists()) {
8318         // The Expression is not correct if the mapping is implicit
8319         const Expr *E = (C->getMapLoc().isValid()) ? *EI : nullptr;
8320         InfoGen(std::get<0>(L), std::get<1>(L), C->getMapType(),
8321                 C->getMapTypeModifiers(), llvm::None,
8322                 /*ReturnDevicePointer=*/false, C->isImplicit(), std::get<2>(L),
8323                 E);
8324         ++EI;
8325       }
8326     }
8327     for (const auto *C : CurExecDir->getClausesOfKind<OMPToClause>()) {
8328       const auto *EI = C->getVarRefs().begin();
8329       for (const auto L : C->component_lists()) {
8330         InfoGen(std::get<0>(L), std::get<1>(L), OMPC_MAP_to, llvm::None,
8331                 C->getMotionModifiers(), /*ReturnDevicePointer=*/false,
8332                 C->isImplicit(), std::get<2>(L), *EI);
8333         ++EI;
8334       }
8335     }
8336     for (const auto *C : CurExecDir->getClausesOfKind<OMPFromClause>()) {
8337       const auto *EI = C->getVarRefs().begin();
8338       for (const auto L : C->component_lists()) {
8339         InfoGen(std::get<0>(L), std::get<1>(L), OMPC_MAP_from, llvm::None,
8340                 C->getMotionModifiers(), /*ReturnDevicePointer=*/false,
8341                 C->isImplicit(), std::get<2>(L), *EI);
8342         ++EI;
8343       }
8344     }
8345 
8346     // Look at the use_device_ptr clause information and mark the existing map
8347     // entries as such. If there is no map information for an entry in the
8348     // use_device_ptr list, we create one with map type 'alloc' and zero size
8349     // section. It is the user fault if that was not mapped before. If there is
8350     // no map information and the pointer is a struct member, then we defer the
8351     // emission of that entry until the whole struct has been processed.
8352     llvm::MapVector<const ValueDecl *, SmallVector<DeferredDevicePtrEntryTy, 4>>
8353         DeferredInfo;
8354     MapCombinedInfoTy UseDevicePtrCombinedInfo;
8355 
8356     for (const auto *C :
8357          CurExecDir->getClausesOfKind<OMPUseDevicePtrClause>()) {
8358       for (const auto L : C->component_lists()) {
8359         OMPClauseMappableExprCommon::MappableExprComponentListRef Components =
8360             std::get<1>(L);
8361         assert(!Components.empty() &&
8362                "Not expecting empty list of components!");
8363         const ValueDecl *VD = Components.back().getAssociatedDeclaration();
8364         VD = cast<ValueDecl>(VD->getCanonicalDecl());
8365         const Expr *IE = Components.back().getAssociatedExpression();
8366         // If the first component is a member expression, we have to look into
8367         // 'this', which maps to null in the map of map information. Otherwise
8368         // look directly for the information.
8369         auto It = Info.find(isa<MemberExpr>(IE) ? nullptr : VD);
8370 
8371         // We potentially have map information for this declaration already.
8372         // Look for the first set of components that refer to it.
8373         if (It != Info.end()) {
8374           auto *CI = llvm::find_if(It->second, [VD](const MapInfo &MI) {
8375             return MI.Components.back().getAssociatedDeclaration() == VD;
8376           });
8377           // If we found a map entry, signal that the pointer has to be returned
8378           // and move on to the next declaration.
8379           // Exclude cases where the base pointer is mapped as array subscript,
8380           // array section or array shaping. The base address is passed as a
8381           // pointer to base in this case and cannot be used as a base for
8382           // use_device_ptr list item.
8383           if (CI != It->second.end()) {
8384             auto PrevCI = std::next(CI->Components.rbegin());
8385             const auto *VarD = dyn_cast<VarDecl>(VD);
8386             if (CGF.CGM.getOpenMPRuntime().hasRequiresUnifiedSharedMemory() ||
8387                 isa<MemberExpr>(IE) ||
8388                 !VD->getType().getNonReferenceType()->isPointerType() ||
8389                 PrevCI == CI->Components.rend() ||
8390                 isa<MemberExpr>(PrevCI->getAssociatedExpression()) || !VarD ||
8391                 VarD->hasLocalStorage()) {
8392               CI->ReturnDevicePointer = true;
8393               continue;
8394             }
8395           }
8396         }
8397 
8398         // We didn't find any match in our map information - generate a zero
8399         // size array section - if the pointer is a struct member we defer this
8400         // action until the whole struct has been processed.
8401         if (isa<MemberExpr>(IE)) {
8402           // Insert the pointer into Info to be processed by
8403           // generateInfoForComponentList. Because it is a member pointer
8404           // without a pointee, no entry will be generated for it, therefore
8405           // we need to generate one after the whole struct has been processed.
8406           // Nonetheless, generateInfoForComponentList must be called to take
8407           // the pointer into account for the calculation of the range of the
8408           // partial struct.
8409           InfoGen(nullptr, Components, OMPC_MAP_unknown, llvm::None, llvm::None,
8410                   /*ReturnDevicePointer=*/false, C->isImplicit(), nullptr);
8411           DeferredInfo[nullptr].emplace_back(IE, VD, /*ForDeviceAddr=*/false);
8412         } else {
8413           llvm::Value *Ptr =
8414               CGF.EmitLoadOfScalar(CGF.EmitLValue(IE), IE->getExprLoc());
8415           UseDevicePtrCombinedInfo.Exprs.push_back(VD);
8416           UseDevicePtrCombinedInfo.BasePointers.emplace_back(Ptr, VD);
8417           UseDevicePtrCombinedInfo.Pointers.push_back(Ptr);
8418           UseDevicePtrCombinedInfo.Sizes.push_back(
8419               llvm::Constant::getNullValue(CGF.Int64Ty));
8420           UseDevicePtrCombinedInfo.Types.push_back(
8421               OMP_MAP_RETURN_PARAM |
8422               (NotTargetParams ? OMP_MAP_NONE : OMP_MAP_TARGET_PARAM));
8423           UseDevicePtrCombinedInfo.Mappers.push_back(nullptr);
8424         }
8425       }
8426     }
8427 
8428     // Look at the use_device_addr clause information and mark the existing map
8429     // entries as such. If there is no map information for an entry in the
8430     // use_device_addr list, we create one with map type 'alloc' and zero size
8431     // section. It is the user fault if that was not mapped before. If there is
8432     // no map information and the pointer is a struct member, then we defer the
8433     // emission of that entry until the whole struct has been processed.
8434     llvm::SmallDenseSet<CanonicalDeclPtr<const Decl>, 4> Processed;
8435     for (const auto *C :
8436          CurExecDir->getClausesOfKind<OMPUseDeviceAddrClause>()) {
8437       for (const auto L : C->component_lists()) {
8438         assert(!std::get<1>(L).empty() &&
8439                "Not expecting empty list of components!");
8440         const ValueDecl *VD = std::get<1>(L).back().getAssociatedDeclaration();
8441         if (!Processed.insert(VD).second)
8442           continue;
8443         VD = cast<ValueDecl>(VD->getCanonicalDecl());
8444         const Expr *IE = std::get<1>(L).back().getAssociatedExpression();
8445         // If the first component is a member expression, we have to look into
8446         // 'this', which maps to null in the map of map information. Otherwise
8447         // look directly for the information.
8448         auto It = Info.find(isa<MemberExpr>(IE) ? nullptr : VD);
8449 
8450         // We potentially have map information for this declaration already.
8451         // Look for the first set of components that refer to it.
8452         if (It != Info.end()) {
8453           auto *CI = llvm::find_if(It->second, [VD](const MapInfo &MI) {
8454             return MI.Components.back().getAssociatedDeclaration() == VD;
8455           });
8456           // If we found a map entry, signal that the pointer has to be returned
8457           // and move on to the next declaration.
8458           if (CI != It->second.end()) {
8459             CI->ReturnDevicePointer = true;
8460             continue;
8461           }
8462         }
8463 
8464         // We didn't find any match in our map information - generate a zero
8465         // size array section - if the pointer is a struct member we defer this
8466         // action until the whole struct has been processed.
8467         if (isa<MemberExpr>(IE)) {
8468           // Insert the pointer into Info to be processed by
8469           // generateInfoForComponentList. Because it is a member pointer
8470           // without a pointee, no entry will be generated for it, therefore
8471           // we need to generate one after the whole struct has been processed.
8472           // Nonetheless, generateInfoForComponentList must be called to take
8473           // the pointer into account for the calculation of the range of the
8474           // partial struct.
8475           InfoGen(nullptr, std::get<1>(L), OMPC_MAP_unknown, llvm::None,
8476                   llvm::None, /*ReturnDevicePointer=*/false, C->isImplicit(),
8477                   nullptr, nullptr, /*ForDeviceAddr=*/true);
8478           DeferredInfo[nullptr].emplace_back(IE, VD, /*ForDeviceAddr=*/true);
8479         } else {
8480           llvm::Value *Ptr;
8481           if (IE->isGLValue())
8482             Ptr = CGF.EmitLValue(IE).getPointer(CGF);
8483           else
8484             Ptr = CGF.EmitScalarExpr(IE);
8485           CombinedInfo.Exprs.push_back(VD);
8486           CombinedInfo.BasePointers.emplace_back(Ptr, VD);
8487           CombinedInfo.Pointers.push_back(Ptr);
8488           CombinedInfo.Sizes.push_back(
8489               llvm::Constant::getNullValue(CGF.Int64Ty));
8490           CombinedInfo.Types.push_back(
8491               OMP_MAP_RETURN_PARAM |
8492               (NotTargetParams ? OMP_MAP_NONE : OMP_MAP_TARGET_PARAM));
8493           CombinedInfo.Mappers.push_back(nullptr);
8494         }
8495       }
8496     }
8497 
8498     for (const auto &M : Info) {
8499       // We need to know when we generate information for the first component
8500       // associated with a capture, because the mapping flags depend on it.
8501       bool IsFirstComponentList = !NotTargetParams;
8502 
8503       // Underlying variable declaration used in the map clause.
8504       const ValueDecl *VD = std::get<0>(M);
8505 
8506       // Temporary generated information.
8507       MapCombinedInfoTy CurInfo;
8508       StructRangeInfoTy PartialStruct;
8509 
8510       for (const MapInfo &L : M.second) {
8511         assert(!L.Components.empty() &&
8512                "Not expecting declaration with no component lists.");
8513 
8514         // Remember the current base pointer index.
8515         unsigned CurrentBasePointersIdx = CurInfo.BasePointers.size();
8516         CurInfo.NonContigInfo.IsNonContiguous =
8517             L.Components.back().isNonContiguous();
8518         generateInfoForComponentList(
8519             L.MapType, L.MapModifiers, L.MotionModifiers, L.Components, CurInfo,
8520             PartialStruct, IsFirstComponentList, L.IsImplicit, L.Mapper,
8521             L.ForDeviceAddr, VD, L.VarRef);
8522 
8523         // If this entry relates with a device pointer, set the relevant
8524         // declaration and add the 'return pointer' flag.
8525         if (L.ReturnDevicePointer) {
8526           assert(CurInfo.BasePointers.size() > CurrentBasePointersIdx &&
8527                  "Unexpected number of mapped base pointers.");
8528 
8529           const ValueDecl *RelevantVD =
8530               L.Components.back().getAssociatedDeclaration();
8531           assert(RelevantVD &&
8532                  "No relevant declaration related with device pointer??");
8533 
8534           CurInfo.BasePointers[CurrentBasePointersIdx].setDevicePtrDecl(
8535               RelevantVD);
8536           CurInfo.Types[CurrentBasePointersIdx] |= OMP_MAP_RETURN_PARAM;
8537         }
8538         IsFirstComponentList = false;
8539       }
8540 
8541       // Append any pending zero-length pointers which are struct members and
8542       // used with use_device_ptr or use_device_addr.
8543       auto CI = DeferredInfo.find(M.first);
8544       if (CI != DeferredInfo.end()) {
8545         for (const DeferredDevicePtrEntryTy &L : CI->second) {
8546           llvm::Value *BasePtr;
8547           llvm::Value *Ptr;
8548           if (L.ForDeviceAddr) {
8549             if (L.IE->isGLValue())
8550               Ptr = this->CGF.EmitLValue(L.IE).getPointer(CGF);
8551             else
8552               Ptr = this->CGF.EmitScalarExpr(L.IE);
8553             BasePtr = Ptr;
8554             // Entry is RETURN_PARAM. Also, set the placeholder value
8555             // MEMBER_OF=FFFF so that the entry is later updated with the
8556             // correct value of MEMBER_OF.
8557             CurInfo.Types.push_back(OMP_MAP_RETURN_PARAM | OMP_MAP_MEMBER_OF);
8558           } else {
8559             BasePtr = this->CGF.EmitLValue(L.IE).getPointer(CGF);
8560             Ptr = this->CGF.EmitLoadOfScalar(this->CGF.EmitLValue(L.IE),
8561                                              L.IE->getExprLoc());
8562             // Entry is PTR_AND_OBJ and RETURN_PARAM. Also, set the placeholder
8563             // value MEMBER_OF=FFFF so that the entry is later updated with the
8564             // correct value of MEMBER_OF.
8565             CurInfo.Types.push_back(OMP_MAP_PTR_AND_OBJ | OMP_MAP_RETURN_PARAM |
8566                                     OMP_MAP_MEMBER_OF);
8567           }
8568           CurInfo.Exprs.push_back(L.VD);
8569           CurInfo.BasePointers.emplace_back(BasePtr, L.VD);
8570           CurInfo.Pointers.push_back(Ptr);
8571           CurInfo.Sizes.push_back(
8572               llvm::Constant::getNullValue(this->CGF.Int64Ty));
8573           CurInfo.Mappers.push_back(nullptr);
8574         }
8575       }
8576 
8577       // If there is an entry in PartialStruct it means we have a struct with
8578       // individual members mapped. Emit an extra combined entry.
8579       if (PartialStruct.Base.isValid())
8580         emitCombinedEntry(CombinedInfo, CurInfo.Types, PartialStruct, VD,
8581                           NotTargetParams);
8582 
8583       // We need to append the results of this capture to what we already have.
8584       CombinedInfo.append(CurInfo);
8585     }
8586     // Append data for use_device_ptr clauses.
8587     CombinedInfo.append(UseDevicePtrCombinedInfo);
8588   }
8589 
8590   /// Generate all the base pointers, section pointers, sizes, map types, and
8591   /// mappers for the extracted map clauses of user-defined mapper (all included
8592   /// in \a CombinedInfo).
8593   void generateAllInfoForMapper(MapCombinedInfoTy &CombinedInfo) const {
8594     assert(CurDir.is<const OMPDeclareMapperDecl *>() &&
8595            "Expect a declare mapper directive");
8596     const auto *CurMapperDir = CurDir.get<const OMPDeclareMapperDecl *>();
8597     // We have to process the component lists that relate with the same
8598     // declaration in a single chunk so that we can generate the map flags
8599     // correctly. Therefore, we organize all lists in a map.
8600     llvm::MapVector<const ValueDecl *, SmallVector<MapInfo, 8>> Info;
8601 
8602     // Fill the information map for map clauses.
8603     for (const auto *C : CurMapperDir->clauselists()) {
8604       const auto *MC = cast<OMPMapClause>(C);
8605       const auto *EI = MC->getVarRefs().begin();
8606       for (const auto L : MC->component_lists()) {
8607         // The Expression is not correct if the mapping is implicit
8608         const Expr *E = (MC->getMapLoc().isValid()) ? *EI : nullptr;
8609         const ValueDecl *VD =
8610             std::get<0>(L) ? cast<ValueDecl>(std::get<0>(L)->getCanonicalDecl())
8611                            : nullptr;
8612         // Get the corresponding user-defined mapper.
8613         Info[VD].emplace_back(std::get<1>(L), MC->getMapType(),
8614                               MC->getMapTypeModifiers(), llvm::None,
8615                               /*ReturnDevicePointer=*/false, MC->isImplicit(),
8616                               std::get<2>(L), E);
8617         ++EI;
8618       }
8619     }
8620 
8621     for (const auto &M : Info) {
8622       // We need to know when we generate information for the first component
8623       // associated with a capture, because the mapping flags depend on it.
8624       bool IsFirstComponentList = true;
8625 
8626       // Underlying variable declaration used in the map clause.
8627       const ValueDecl *VD = std::get<0>(M);
8628 
8629       // Temporary generated information.
8630       MapCombinedInfoTy CurInfo;
8631       StructRangeInfoTy PartialStruct;
8632 
8633       for (const MapInfo &L : M.second) {
8634         assert(!L.Components.empty() &&
8635                "Not expecting declaration with no component lists.");
8636         generateInfoForComponentList(
8637             L.MapType, L.MapModifiers, L.MotionModifiers, L.Components, CurInfo,
8638             PartialStruct, IsFirstComponentList, L.IsImplicit, L.Mapper,
8639             L.ForDeviceAddr, VD, L.VarRef);
8640         IsFirstComponentList = false;
8641       }
8642 
8643       // If there is an entry in PartialStruct it means we have a struct with
8644       // individual members mapped. Emit an extra combined entry.
8645       if (PartialStruct.Base.isValid()) {
8646         CurInfo.NonContigInfo.Dims.push_back(0);
8647         emitCombinedEntry(CombinedInfo, CurInfo.Types, PartialStruct, VD);
8648       }
8649 
8650       // We need to append the results of this capture to what we already have.
8651       CombinedInfo.append(CurInfo);
8652     }
8653   }
8654 
8655   /// Emit capture info for lambdas for variables captured by reference.
8656   void generateInfoForLambdaCaptures(
8657       const ValueDecl *VD, llvm::Value *Arg, MapCombinedInfoTy &CombinedInfo,
8658       llvm::DenseMap<llvm::Value *, llvm::Value *> &LambdaPointers) const {
8659     const auto *RD = VD->getType()
8660                          .getCanonicalType()
8661                          .getNonReferenceType()
8662                          ->getAsCXXRecordDecl();
8663     if (!RD || !RD->isLambda())
8664       return;
8665     Address VDAddr = Address(Arg, CGF.getContext().getDeclAlign(VD));
8666     LValue VDLVal = CGF.MakeAddrLValue(
8667         VDAddr, VD->getType().getCanonicalType().getNonReferenceType());
8668     llvm::DenseMap<const VarDecl *, FieldDecl *> Captures;
8669     FieldDecl *ThisCapture = nullptr;
8670     RD->getCaptureFields(Captures, ThisCapture);
8671     if (ThisCapture) {
8672       LValue ThisLVal =
8673           CGF.EmitLValueForFieldInitialization(VDLVal, ThisCapture);
8674       LValue ThisLValVal = CGF.EmitLValueForField(VDLVal, ThisCapture);
8675       LambdaPointers.try_emplace(ThisLVal.getPointer(CGF),
8676                                  VDLVal.getPointer(CGF));
8677       CombinedInfo.Exprs.push_back(VD);
8678       CombinedInfo.BasePointers.push_back(ThisLVal.getPointer(CGF));
8679       CombinedInfo.Pointers.push_back(ThisLValVal.getPointer(CGF));
8680       CombinedInfo.Sizes.push_back(
8681           CGF.Builder.CreateIntCast(CGF.getTypeSize(CGF.getContext().VoidPtrTy),
8682                                     CGF.Int64Ty, /*isSigned=*/true));
8683       CombinedInfo.Types.push_back(OMP_MAP_PTR_AND_OBJ | OMP_MAP_LITERAL |
8684                                    OMP_MAP_MEMBER_OF | OMP_MAP_IMPLICIT);
8685       CombinedInfo.Mappers.push_back(nullptr);
8686     }
8687     for (const LambdaCapture &LC : RD->captures()) {
8688       if (!LC.capturesVariable())
8689         continue;
8690       const VarDecl *VD = LC.getCapturedVar();
8691       if (LC.getCaptureKind() != LCK_ByRef && !VD->getType()->isPointerType())
8692         continue;
8693       auto It = Captures.find(VD);
8694       assert(It != Captures.end() && "Found lambda capture without field.");
8695       LValue VarLVal = CGF.EmitLValueForFieldInitialization(VDLVal, It->second);
8696       if (LC.getCaptureKind() == LCK_ByRef) {
8697         LValue VarLValVal = CGF.EmitLValueForField(VDLVal, It->second);
8698         LambdaPointers.try_emplace(VarLVal.getPointer(CGF),
8699                                    VDLVal.getPointer(CGF));
8700         CombinedInfo.Exprs.push_back(VD);
8701         CombinedInfo.BasePointers.push_back(VarLVal.getPointer(CGF));
8702         CombinedInfo.Pointers.push_back(VarLValVal.getPointer(CGF));
8703         CombinedInfo.Sizes.push_back(CGF.Builder.CreateIntCast(
8704             CGF.getTypeSize(
8705                 VD->getType().getCanonicalType().getNonReferenceType()),
8706             CGF.Int64Ty, /*isSigned=*/true));
8707       } else {
8708         RValue VarRVal = CGF.EmitLoadOfLValue(VarLVal, RD->getLocation());
8709         LambdaPointers.try_emplace(VarLVal.getPointer(CGF),
8710                                    VDLVal.getPointer(CGF));
8711         CombinedInfo.Exprs.push_back(VD);
8712         CombinedInfo.BasePointers.push_back(VarLVal.getPointer(CGF));
8713         CombinedInfo.Pointers.push_back(VarRVal.getScalarVal());
8714         CombinedInfo.Sizes.push_back(llvm::ConstantInt::get(CGF.Int64Ty, 0));
8715       }
8716       CombinedInfo.Types.push_back(OMP_MAP_PTR_AND_OBJ | OMP_MAP_LITERAL |
8717                                    OMP_MAP_MEMBER_OF | OMP_MAP_IMPLICIT);
8718       CombinedInfo.Mappers.push_back(nullptr);
8719     }
8720   }
8721 
8722   /// Set correct indices for lambdas captures.
8723   void adjustMemberOfForLambdaCaptures(
8724       const llvm::DenseMap<llvm::Value *, llvm::Value *> &LambdaPointers,
8725       MapBaseValuesArrayTy &BasePointers, MapValuesArrayTy &Pointers,
8726       MapFlagsArrayTy &Types) const {
8727     for (unsigned I = 0, E = Types.size(); I < E; ++I) {
8728       // Set correct member_of idx for all implicit lambda captures.
8729       if (Types[I] != (OMP_MAP_PTR_AND_OBJ | OMP_MAP_LITERAL |
8730                        OMP_MAP_MEMBER_OF | OMP_MAP_IMPLICIT))
8731         continue;
8732       llvm::Value *BasePtr = LambdaPointers.lookup(*BasePointers[I]);
8733       assert(BasePtr && "Unable to find base lambda address.");
8734       int TgtIdx = -1;
8735       for (unsigned J = I; J > 0; --J) {
8736         unsigned Idx = J - 1;
8737         if (Pointers[Idx] != BasePtr)
8738           continue;
8739         TgtIdx = Idx;
8740         break;
8741       }
8742       assert(TgtIdx != -1 && "Unable to find parent lambda.");
8743       // All other current entries will be MEMBER_OF the combined entry
8744       // (except for PTR_AND_OBJ entries which do not have a placeholder value
8745       // 0xFFFF in the MEMBER_OF field).
8746       OpenMPOffloadMappingFlags MemberOfFlag = getMemberOfFlag(TgtIdx);
8747       setCorrectMemberOfFlag(Types[I], MemberOfFlag);
8748     }
8749   }
8750 
8751   /// Generate the base pointers, section pointers, sizes, map types, and
8752   /// mappers associated to a given capture (all included in \a CombinedInfo).
8753   void generateInfoForCapture(const CapturedStmt::Capture *Cap,
8754                               llvm::Value *Arg, MapCombinedInfoTy &CombinedInfo,
8755                               StructRangeInfoTy &PartialStruct) const {
8756     assert(!Cap->capturesVariableArrayType() &&
8757            "Not expecting to generate map info for a variable array type!");
8758 
8759     // We need to know when we generating information for the first component
8760     const ValueDecl *VD = Cap->capturesThis()
8761                               ? nullptr
8762                               : Cap->getCapturedVar()->getCanonicalDecl();
8763 
8764     // If this declaration appears in a is_device_ptr clause we just have to
8765     // pass the pointer by value. If it is a reference to a declaration, we just
8766     // pass its value.
8767     if (DevPointersMap.count(VD)) {
8768       CombinedInfo.Exprs.push_back(VD);
8769       CombinedInfo.BasePointers.emplace_back(Arg, VD);
8770       CombinedInfo.Pointers.push_back(Arg);
8771       CombinedInfo.Sizes.push_back(CGF.Builder.CreateIntCast(
8772           CGF.getTypeSize(CGF.getContext().VoidPtrTy), CGF.Int64Ty,
8773           /*isSigned=*/true));
8774       CombinedInfo.Types.push_back(
8775           (Cap->capturesVariable() ? OMP_MAP_TO : OMP_MAP_LITERAL) |
8776           OMP_MAP_TARGET_PARAM);
8777       CombinedInfo.Mappers.push_back(nullptr);
8778       return;
8779     }
8780 
8781     using MapData =
8782         std::tuple<OMPClauseMappableExprCommon::MappableExprComponentListRef,
8783                    OpenMPMapClauseKind, ArrayRef<OpenMPMapModifierKind>, bool,
8784                    const ValueDecl *, const Expr *>;
8785     SmallVector<MapData, 4> DeclComponentLists;
8786     assert(CurDir.is<const OMPExecutableDirective *>() &&
8787            "Expect a executable directive");
8788     const auto *CurExecDir = CurDir.get<const OMPExecutableDirective *>();
8789     for (const auto *C : CurExecDir->getClausesOfKind<OMPMapClause>()) {
8790       const auto *EI = C->getVarRefs().begin();
8791       for (const auto L : C->decl_component_lists(VD)) {
8792         const ValueDecl *VDecl, *Mapper;
8793         // The Expression is not correct if the mapping is implicit
8794         const Expr *E = (C->getMapLoc().isValid()) ? *EI : nullptr;
8795         OMPClauseMappableExprCommon::MappableExprComponentListRef Components;
8796         std::tie(VDecl, Components, Mapper) = L;
8797         assert(VDecl == VD && "We got information for the wrong declaration??");
8798         assert(!Components.empty() &&
8799                "Not expecting declaration with no component lists.");
8800         DeclComponentLists.emplace_back(Components, C->getMapType(),
8801                                         C->getMapTypeModifiers(),
8802                                         C->isImplicit(), Mapper, E);
8803         ++EI;
8804       }
8805     }
8806 
8807     // Find overlapping elements (including the offset from the base element).
8808     llvm::SmallDenseMap<
8809         const MapData *,
8810         llvm::SmallVector<
8811             OMPClauseMappableExprCommon::MappableExprComponentListRef, 4>,
8812         4>
8813         OverlappedData;
8814     size_t Count = 0;
8815     for (const MapData &L : DeclComponentLists) {
8816       OMPClauseMappableExprCommon::MappableExprComponentListRef Components;
8817       OpenMPMapClauseKind MapType;
8818       ArrayRef<OpenMPMapModifierKind> MapModifiers;
8819       bool IsImplicit;
8820       const ValueDecl *Mapper;
8821       const Expr *VarRef;
8822       std::tie(Components, MapType, MapModifiers, IsImplicit, Mapper, VarRef) =
8823           L;
8824       ++Count;
8825       for (const MapData &L1 : makeArrayRef(DeclComponentLists).slice(Count)) {
8826         OMPClauseMappableExprCommon::MappableExprComponentListRef Components1;
8827         std::tie(Components1, MapType, MapModifiers, IsImplicit, Mapper,
8828                  VarRef) = L1;
8829         auto CI = Components.rbegin();
8830         auto CE = Components.rend();
8831         auto SI = Components1.rbegin();
8832         auto SE = Components1.rend();
8833         for (; CI != CE && SI != SE; ++CI, ++SI) {
8834           if (CI->getAssociatedExpression()->getStmtClass() !=
8835               SI->getAssociatedExpression()->getStmtClass())
8836             break;
8837           // Are we dealing with different variables/fields?
8838           if (CI->getAssociatedDeclaration() != SI->getAssociatedDeclaration())
8839             break;
8840         }
8841         // Found overlapping if, at least for one component, reached the head of
8842         // the components list.
8843         if (CI == CE || SI == SE) {
8844           assert((CI != CE || SI != SE) &&
8845                  "Unexpected full match of the mapping components.");
8846           const MapData &BaseData = CI == CE ? L : L1;
8847           OMPClauseMappableExprCommon::MappableExprComponentListRef SubData =
8848               SI == SE ? Components : Components1;
8849           auto &OverlappedElements = OverlappedData.FindAndConstruct(&BaseData);
8850           OverlappedElements.getSecond().push_back(SubData);
8851         }
8852       }
8853     }
8854     // Sort the overlapped elements for each item.
8855     llvm::SmallVector<const FieldDecl *, 4> Layout;
8856     if (!OverlappedData.empty()) {
8857       if (const auto *CRD =
8858               VD->getType().getCanonicalType()->getAsCXXRecordDecl())
8859         getPlainLayout(CRD, Layout, /*AsBase=*/false);
8860       else {
8861         const auto *RD = VD->getType().getCanonicalType()->getAsRecordDecl();
8862         Layout.append(RD->field_begin(), RD->field_end());
8863       }
8864     }
8865     for (auto &Pair : OverlappedData) {
8866       llvm::sort(
8867           Pair.getSecond(),
8868           [&Layout](
8869               OMPClauseMappableExprCommon::MappableExprComponentListRef First,
8870               OMPClauseMappableExprCommon::MappableExprComponentListRef
8871                   Second) {
8872             auto CI = First.rbegin();
8873             auto CE = First.rend();
8874             auto SI = Second.rbegin();
8875             auto SE = Second.rend();
8876             for (; CI != CE && SI != SE; ++CI, ++SI) {
8877               if (CI->getAssociatedExpression()->getStmtClass() !=
8878                   SI->getAssociatedExpression()->getStmtClass())
8879                 break;
8880               // Are we dealing with different variables/fields?
8881               if (CI->getAssociatedDeclaration() !=
8882                   SI->getAssociatedDeclaration())
8883                 break;
8884             }
8885 
8886             // Lists contain the same elements.
8887             if (CI == CE && SI == SE)
8888               return false;
8889 
8890             // List with less elements is less than list with more elements.
8891             if (CI == CE || SI == SE)
8892               return CI == CE;
8893 
8894             const auto *FD1 = cast<FieldDecl>(CI->getAssociatedDeclaration());
8895             const auto *FD2 = cast<FieldDecl>(SI->getAssociatedDeclaration());
8896             if (FD1->getParent() == FD2->getParent())
8897               return FD1->getFieldIndex() < FD2->getFieldIndex();
8898             const auto It =
8899                 llvm::find_if(Layout, [FD1, FD2](const FieldDecl *FD) {
8900                   return FD == FD1 || FD == FD2;
8901                 });
8902             return *It == FD1;
8903           });
8904     }
8905 
8906     // Associated with a capture, because the mapping flags depend on it.
8907     // Go through all of the elements with the overlapped elements.
8908     for (const auto &Pair : OverlappedData) {
8909       const MapData &L = *Pair.getFirst();
8910       OMPClauseMappableExprCommon::MappableExprComponentListRef Components;
8911       OpenMPMapClauseKind MapType;
8912       ArrayRef<OpenMPMapModifierKind> MapModifiers;
8913       bool IsImplicit;
8914       const ValueDecl *Mapper;
8915       const Expr *VarRef;
8916       std::tie(Components, MapType, MapModifiers, IsImplicit, Mapper, VarRef) =
8917           L;
8918       ArrayRef<OMPClauseMappableExprCommon::MappableExprComponentListRef>
8919           OverlappedComponents = Pair.getSecond();
8920       bool IsFirstComponentList = true;
8921       generateInfoForComponentList(
8922           MapType, MapModifiers, llvm::None, Components, CombinedInfo,
8923           PartialStruct, IsFirstComponentList, IsImplicit, Mapper,
8924           /*ForDeviceAddr=*/false, VD, VarRef, OverlappedComponents);
8925     }
8926     // Go through other elements without overlapped elements.
8927     bool IsFirstComponentList = OverlappedData.empty();
8928     for (const MapData &L : DeclComponentLists) {
8929       OMPClauseMappableExprCommon::MappableExprComponentListRef Components;
8930       OpenMPMapClauseKind MapType;
8931       ArrayRef<OpenMPMapModifierKind> MapModifiers;
8932       bool IsImplicit;
8933       const ValueDecl *Mapper;
8934       const Expr *VarRef;
8935       std::tie(Components, MapType, MapModifiers, IsImplicit, Mapper, VarRef) =
8936           L;
8937       auto It = OverlappedData.find(&L);
8938       if (It == OverlappedData.end())
8939         generateInfoForComponentList(MapType, MapModifiers, llvm::None,
8940                                      Components, CombinedInfo, PartialStruct,
8941                                      IsFirstComponentList, IsImplicit, Mapper,
8942                                      /*ForDeviceAddr=*/false, VD, VarRef);
8943       IsFirstComponentList = false;
8944     }
8945   }
8946 
8947   /// Generate the default map information for a given capture \a CI,
8948   /// record field declaration \a RI and captured value \a CV.
8949   void generateDefaultMapInfo(const CapturedStmt::Capture &CI,
8950                               const FieldDecl &RI, llvm::Value *CV,
8951                               MapCombinedInfoTy &CombinedInfo) const {
8952     bool IsImplicit = true;
8953     // Do the default mapping.
8954     if (CI.capturesThis()) {
8955       CombinedInfo.Exprs.push_back(nullptr);
8956       CombinedInfo.BasePointers.push_back(CV);
8957       CombinedInfo.Pointers.push_back(CV);
8958       const auto *PtrTy = cast<PointerType>(RI.getType().getTypePtr());
8959       CombinedInfo.Sizes.push_back(
8960           CGF.Builder.CreateIntCast(CGF.getTypeSize(PtrTy->getPointeeType()),
8961                                     CGF.Int64Ty, /*isSigned=*/true));
8962       // Default map type.
8963       CombinedInfo.Types.push_back(OMP_MAP_TO | OMP_MAP_FROM);
8964     } else if (CI.capturesVariableByCopy()) {
8965       const VarDecl *VD = CI.getCapturedVar();
8966       CombinedInfo.Exprs.push_back(VD->getCanonicalDecl());
8967       CombinedInfo.BasePointers.push_back(CV);
8968       CombinedInfo.Pointers.push_back(CV);
8969       if (!RI.getType()->isAnyPointerType()) {
8970         // We have to signal to the runtime captures passed by value that are
8971         // not pointers.
8972         CombinedInfo.Types.push_back(OMP_MAP_LITERAL);
8973         CombinedInfo.Sizes.push_back(CGF.Builder.CreateIntCast(
8974             CGF.getTypeSize(RI.getType()), CGF.Int64Ty, /*isSigned=*/true));
8975       } else {
8976         // Pointers are implicitly mapped with a zero size and no flags
8977         // (other than first map that is added for all implicit maps).
8978         CombinedInfo.Types.push_back(OMP_MAP_NONE);
8979         CombinedInfo.Sizes.push_back(llvm::Constant::getNullValue(CGF.Int64Ty));
8980       }
8981       auto I = FirstPrivateDecls.find(VD);
8982       if (I != FirstPrivateDecls.end())
8983         IsImplicit = I->getSecond();
8984     } else {
8985       assert(CI.capturesVariable() && "Expected captured reference.");
8986       const auto *PtrTy = cast<ReferenceType>(RI.getType().getTypePtr());
8987       QualType ElementType = PtrTy->getPointeeType();
8988       CombinedInfo.Sizes.push_back(CGF.Builder.CreateIntCast(
8989           CGF.getTypeSize(ElementType), CGF.Int64Ty, /*isSigned=*/true));
8990       // The default map type for a scalar/complex type is 'to' because by
8991       // default the value doesn't have to be retrieved. For an aggregate
8992       // type, the default is 'tofrom'.
8993       CombinedInfo.Types.push_back(getMapModifiersForPrivateClauses(CI));
8994       const VarDecl *VD = CI.getCapturedVar();
8995       auto I = FirstPrivateDecls.find(VD);
8996       if (I != FirstPrivateDecls.end() &&
8997           VD->getType().isConstant(CGF.getContext())) {
8998         llvm::Constant *Addr =
8999             CGF.CGM.getOpenMPRuntime().registerTargetFirstprivateCopy(CGF, VD);
9000         // Copy the value of the original variable to the new global copy.
9001         CGF.Builder.CreateMemCpy(
9002             CGF.MakeNaturalAlignAddrLValue(Addr, ElementType).getAddress(CGF),
9003             Address(CV, CGF.getContext().getTypeAlignInChars(ElementType)),
9004             CombinedInfo.Sizes.back(), /*IsVolatile=*/false);
9005         // Use new global variable as the base pointers.
9006         CombinedInfo.Exprs.push_back(VD->getCanonicalDecl());
9007         CombinedInfo.BasePointers.push_back(Addr);
9008         CombinedInfo.Pointers.push_back(Addr);
9009       } else {
9010         CombinedInfo.Exprs.push_back(VD->getCanonicalDecl());
9011         CombinedInfo.BasePointers.push_back(CV);
9012         if (I != FirstPrivateDecls.end() && ElementType->isAnyPointerType()) {
9013           Address PtrAddr = CGF.EmitLoadOfReference(CGF.MakeAddrLValue(
9014               CV, ElementType, CGF.getContext().getDeclAlign(VD),
9015               AlignmentSource::Decl));
9016           CombinedInfo.Pointers.push_back(PtrAddr.getPointer());
9017         } else {
9018           CombinedInfo.Pointers.push_back(CV);
9019         }
9020       }
9021       if (I != FirstPrivateDecls.end())
9022         IsImplicit = I->getSecond();
9023     }
9024     // Every default map produces a single argument which is a target parameter.
9025     CombinedInfo.Types.back() |= OMP_MAP_TARGET_PARAM;
9026 
9027     // Add flag stating this is an implicit map.
9028     if (IsImplicit)
9029       CombinedInfo.Types.back() |= OMP_MAP_IMPLICIT;
9030 
9031     // No user-defined mapper for default mapping.
9032     CombinedInfo.Mappers.push_back(nullptr);
9033   }
9034 };
9035 } // anonymous namespace
9036 
9037 static void emitNonContiguousDescriptor(
9038     CodeGenFunction &CGF, MappableExprsHandler::MapCombinedInfoTy &CombinedInfo,
9039     CGOpenMPRuntime::TargetDataInfo &Info) {
9040   CodeGenModule &CGM = CGF.CGM;
9041   MappableExprsHandler::MapCombinedInfoTy::StructNonContiguousInfo
9042       &NonContigInfo = CombinedInfo.NonContigInfo;
9043 
9044   // Build an array of struct descriptor_dim and then assign it to
9045   // offload_args.
9046   //
9047   // struct descriptor_dim {
9048   //  uint64_t offset;
9049   //  uint64_t count;
9050   //  uint64_t stride
9051   // };
9052   ASTContext &C = CGF.getContext();
9053   QualType Int64Ty = C.getIntTypeForBitwidth(/*DestWidth=*/64, /*Signed=*/0);
9054   RecordDecl *RD;
9055   RD = C.buildImplicitRecord("descriptor_dim");
9056   RD->startDefinition();
9057   addFieldToRecordDecl(C, RD, Int64Ty);
9058   addFieldToRecordDecl(C, RD, Int64Ty);
9059   addFieldToRecordDecl(C, RD, Int64Ty);
9060   RD->completeDefinition();
9061   QualType DimTy = C.getRecordType(RD);
9062 
9063   enum { OffsetFD = 0, CountFD, StrideFD };
9064   // We need two index variable here since the size of "Dims" is the same as the
9065   // size of Components, however, the size of offset, count, and stride is equal
9066   // to the size of base declaration that is non-contiguous.
9067   for (unsigned I = 0, L = 0, E = NonContigInfo.Dims.size(); I < E; ++I) {
9068     // Skip emitting ir if dimension size is 1 since it cannot be
9069     // non-contiguous.
9070     if (NonContigInfo.Dims[I] == 1)
9071       continue;
9072     llvm::APInt Size(/*numBits=*/32, NonContigInfo.Dims[I]);
9073     QualType ArrayTy =
9074         C.getConstantArrayType(DimTy, Size, nullptr, ArrayType::Normal, 0);
9075     Address DimsAddr = CGF.CreateMemTemp(ArrayTy, "dims");
9076     for (unsigned II = 0, EE = NonContigInfo.Dims[I]; II < EE; ++II) {
9077       unsigned RevIdx = EE - II - 1;
9078       LValue DimsLVal = CGF.MakeAddrLValue(
9079           CGF.Builder.CreateConstArrayGEP(DimsAddr, II), DimTy);
9080       // Offset
9081       LValue OffsetLVal = CGF.EmitLValueForField(
9082           DimsLVal, *std::next(RD->field_begin(), OffsetFD));
9083       CGF.EmitStoreOfScalar(NonContigInfo.Offsets[L][RevIdx], OffsetLVal);
9084       // Count
9085       LValue CountLVal = CGF.EmitLValueForField(
9086           DimsLVal, *std::next(RD->field_begin(), CountFD));
9087       CGF.EmitStoreOfScalar(NonContigInfo.Counts[L][RevIdx], CountLVal);
9088       // Stride
9089       LValue StrideLVal = CGF.EmitLValueForField(
9090           DimsLVal, *std::next(RD->field_begin(), StrideFD));
9091       CGF.EmitStoreOfScalar(NonContigInfo.Strides[L][RevIdx], StrideLVal);
9092     }
9093     // args[I] = &dims
9094     Address DAddr = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
9095         DimsAddr, CGM.Int8PtrTy);
9096     llvm::Value *P = CGF.Builder.CreateConstInBoundsGEP2_32(
9097         llvm::ArrayType::get(CGM.VoidPtrTy, Info.NumberOfPtrs),
9098         Info.PointersArray, 0, I);
9099     Address PAddr(P, CGF.getPointerAlign());
9100     CGF.Builder.CreateStore(DAddr.getPointer(), PAddr);
9101     ++L;
9102   }
9103 }
9104 
9105 /// Emit a string constant containing the names of the values mapped to the
9106 /// offloading runtime library.
9107 llvm::Constant *
9108 emitMappingInformation(CodeGenFunction &CGF, llvm::OpenMPIRBuilder &OMPBuilder,
9109                        MappableExprsHandler::MappingExprInfo &MapExprs) {
9110   llvm::Constant *SrcLocStr;
9111   if (!MapExprs.getMapDecl()) {
9112     SrcLocStr = OMPBuilder.getOrCreateDefaultSrcLocStr();
9113   } else {
9114     std::string ExprName = "";
9115     if (MapExprs.getMapExpr()) {
9116       PrintingPolicy P(CGF.getContext().getLangOpts());
9117       llvm::raw_string_ostream OS(ExprName);
9118       MapExprs.getMapExpr()->printPretty(OS, nullptr, P);
9119       OS.flush();
9120     } else {
9121       ExprName = MapExprs.getMapDecl()->getNameAsString();
9122     }
9123 
9124     SourceLocation Loc = MapExprs.getMapDecl()->getLocation();
9125     PresumedLoc PLoc = CGF.getContext().getSourceManager().getPresumedLoc(Loc);
9126     const char *FileName = PLoc.getFilename();
9127     unsigned Line = PLoc.getLine();
9128     unsigned Column = PLoc.getColumn();
9129     SrcLocStr = OMPBuilder.getOrCreateSrcLocStr(FileName, ExprName.c_str(),
9130                                                 Line, Column);
9131   }
9132 
9133   return SrcLocStr;
9134 }
9135 
9136 /// Emit the arrays used to pass the captures and map information to the
9137 /// offloading runtime library. If there is no map or capture information,
9138 /// return nullptr by reference.
9139 static void emitOffloadingArrays(
9140     CodeGenFunction &CGF, MappableExprsHandler::MapCombinedInfoTy &CombinedInfo,
9141     CGOpenMPRuntime::TargetDataInfo &Info, llvm::OpenMPIRBuilder &OMPBuilder,
9142     bool IsNonContiguous = false) {
9143   CodeGenModule &CGM = CGF.CGM;
9144   ASTContext &Ctx = CGF.getContext();
9145 
9146   // Reset the array information.
9147   Info.clearArrayInfo();
9148   Info.NumberOfPtrs = CombinedInfo.BasePointers.size();
9149 
9150   if (Info.NumberOfPtrs) {
9151     // Detect if we have any capture size requiring runtime evaluation of the
9152     // size so that a constant array could be eventually used.
9153     bool hasRuntimeEvaluationCaptureSize = false;
9154     for (llvm::Value *S : CombinedInfo.Sizes)
9155       if (!isa<llvm::Constant>(S)) {
9156         hasRuntimeEvaluationCaptureSize = true;
9157         break;
9158       }
9159 
9160     llvm::APInt PointerNumAP(32, Info.NumberOfPtrs, /*isSigned=*/true);
9161     QualType PointerArrayType = Ctx.getConstantArrayType(
9162         Ctx.VoidPtrTy, PointerNumAP, nullptr, ArrayType::Normal,
9163         /*IndexTypeQuals=*/0);
9164 
9165     Info.BasePointersArray =
9166         CGF.CreateMemTemp(PointerArrayType, ".offload_baseptrs").getPointer();
9167     Info.PointersArray =
9168         CGF.CreateMemTemp(PointerArrayType, ".offload_ptrs").getPointer();
9169     Address MappersArray =
9170         CGF.CreateMemTemp(PointerArrayType, ".offload_mappers");
9171     Info.MappersArray = MappersArray.getPointer();
9172 
9173     // If we don't have any VLA types or other types that require runtime
9174     // evaluation, we can use a constant array for the map sizes, otherwise we
9175     // need to fill up the arrays as we do for the pointers.
9176     QualType Int64Ty =
9177         Ctx.getIntTypeForBitwidth(/*DestWidth=*/64, /*Signed=*/1);
9178     if (hasRuntimeEvaluationCaptureSize) {
9179       QualType SizeArrayType = Ctx.getConstantArrayType(
9180           Int64Ty, PointerNumAP, nullptr, ArrayType::Normal,
9181           /*IndexTypeQuals=*/0);
9182       Info.SizesArray =
9183           CGF.CreateMemTemp(SizeArrayType, ".offload_sizes").getPointer();
9184     } else {
9185       // We expect all the sizes to be constant, so we collect them to create
9186       // a constant array.
9187       SmallVector<llvm::Constant *, 16> ConstSizes;
9188       for (unsigned I = 0, E = CombinedInfo.Sizes.size(); I < E; ++I) {
9189         if (IsNonContiguous &&
9190             (CombinedInfo.Types[I] & MappableExprsHandler::OMP_MAP_NON_CONTIG)) {
9191           ConstSizes.push_back(llvm::ConstantInt::get(
9192               CGF.Int64Ty, CombinedInfo.NonContigInfo.Dims[I]));
9193         } else {
9194           ConstSizes.push_back(cast<llvm::Constant>(CombinedInfo.Sizes[I]));
9195         }
9196       }
9197 
9198       auto *SizesArrayInit = llvm::ConstantArray::get(
9199           llvm::ArrayType::get(CGM.Int64Ty, ConstSizes.size()), ConstSizes);
9200       std::string Name = CGM.getOpenMPRuntime().getName({"offload_sizes"});
9201       auto *SizesArrayGbl = new llvm::GlobalVariable(
9202           CGM.getModule(), SizesArrayInit->getType(),
9203           /*isConstant=*/true, llvm::GlobalValue::PrivateLinkage,
9204           SizesArrayInit, Name);
9205       SizesArrayGbl->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
9206       Info.SizesArray = SizesArrayGbl;
9207     }
9208 
9209     // The map types are always constant so we don't need to generate code to
9210     // fill arrays. Instead, we create an array constant.
9211     SmallVector<uint64_t, 4> Mapping(CombinedInfo.Types.size(), 0);
9212     llvm::copy(CombinedInfo.Types, Mapping.begin());
9213     llvm::Constant *MapTypesArrayInit =
9214         llvm::ConstantDataArray::get(CGF.Builder.getContext(), Mapping);
9215     std::string MaptypesName =
9216         CGM.getOpenMPRuntime().getName({"offload_maptypes"});
9217     auto *MapTypesArrayGbl = new llvm::GlobalVariable(
9218         CGM.getModule(), MapTypesArrayInit->getType(),
9219         /*isConstant=*/true, llvm::GlobalValue::PrivateLinkage,
9220         MapTypesArrayInit, MaptypesName);
9221     MapTypesArrayGbl->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
9222     Info.MapTypesArray = MapTypesArrayGbl;
9223 
9224     // The information types are only built if there is debug information
9225     // requested.
9226     if (CGM.getCodeGenOpts().getDebugInfo() == codegenoptions::NoDebugInfo) {
9227       Info.MapNamesArray = llvm::Constant::getNullValue(
9228           llvm::Type::getInt8Ty(CGF.Builder.getContext())->getPointerTo());
9229     } else {
9230       auto fillInfoMap = [&](MappableExprsHandler::MappingExprInfo &MapExpr) {
9231         return emitMappingInformation(CGF, OMPBuilder, MapExpr);
9232       };
9233       SmallVector<llvm::Constant *, 4> InfoMap(CombinedInfo.Exprs.size());
9234       llvm::transform(CombinedInfo.Exprs, InfoMap.begin(), fillInfoMap);
9235 
9236       llvm::Constant *MapNamesArrayInit = llvm::ConstantArray::get(
9237           llvm::ArrayType::get(
9238               llvm::Type::getInt8Ty(CGF.Builder.getContext())->getPointerTo(),
9239               CombinedInfo.Exprs.size()),
9240           InfoMap);
9241       auto *MapNamesArrayGbl = new llvm::GlobalVariable(
9242           CGM.getModule(), MapNamesArrayInit->getType(),
9243           /*isConstant=*/true, llvm::GlobalValue::PrivateLinkage,
9244           MapNamesArrayInit,
9245           CGM.getOpenMPRuntime().getName({"offload_mapnames"}));
9246       Info.MapNamesArray = MapNamesArrayGbl;
9247     }
9248 
9249     // If there's a present map type modifier, it must not be applied to the end
9250     // of a region, so generate a separate map type array in that case.
9251     if (Info.separateBeginEndCalls()) {
9252       bool EndMapTypesDiffer = false;
9253       for (uint64_t &Type : Mapping) {
9254         if (Type & MappableExprsHandler::OMP_MAP_PRESENT) {
9255           Type &= ~MappableExprsHandler::OMP_MAP_PRESENT;
9256           EndMapTypesDiffer = true;
9257         }
9258       }
9259       if (EndMapTypesDiffer) {
9260         MapTypesArrayInit =
9261             llvm::ConstantDataArray::get(CGF.Builder.getContext(), Mapping);
9262         MaptypesName = CGM.getOpenMPRuntime().getName({"offload_maptypes"});
9263         MapTypesArrayGbl = new llvm::GlobalVariable(
9264             CGM.getModule(), MapTypesArrayInit->getType(),
9265             /*isConstant=*/true, llvm::GlobalValue::PrivateLinkage,
9266             MapTypesArrayInit, MaptypesName);
9267         MapTypesArrayGbl->setUnnamedAddr(
9268             llvm::GlobalValue::UnnamedAddr::Global);
9269         Info.MapTypesArrayEnd = MapTypesArrayGbl;
9270       }
9271     }
9272 
9273     for (unsigned I = 0; I < Info.NumberOfPtrs; ++I) {
9274       llvm::Value *BPVal = *CombinedInfo.BasePointers[I];
9275       llvm::Value *BP = CGF.Builder.CreateConstInBoundsGEP2_32(
9276           llvm::ArrayType::get(CGM.VoidPtrTy, Info.NumberOfPtrs),
9277           Info.BasePointersArray, 0, I);
9278       BP = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
9279           BP, BPVal->getType()->getPointerTo(/*AddrSpace=*/0));
9280       Address BPAddr(BP, Ctx.getTypeAlignInChars(Ctx.VoidPtrTy));
9281       CGF.Builder.CreateStore(BPVal, BPAddr);
9282 
9283       if (Info.requiresDevicePointerInfo())
9284         if (const ValueDecl *DevVD =
9285                 CombinedInfo.BasePointers[I].getDevicePtrDecl())
9286           Info.CaptureDeviceAddrMap.try_emplace(DevVD, BPAddr);
9287 
9288       llvm::Value *PVal = CombinedInfo.Pointers[I];
9289       llvm::Value *P = CGF.Builder.CreateConstInBoundsGEP2_32(
9290           llvm::ArrayType::get(CGM.VoidPtrTy, Info.NumberOfPtrs),
9291           Info.PointersArray, 0, I);
9292       P = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
9293           P, PVal->getType()->getPointerTo(/*AddrSpace=*/0));
9294       Address PAddr(P, Ctx.getTypeAlignInChars(Ctx.VoidPtrTy));
9295       CGF.Builder.CreateStore(PVal, PAddr);
9296 
9297       if (hasRuntimeEvaluationCaptureSize) {
9298         llvm::Value *S = CGF.Builder.CreateConstInBoundsGEP2_32(
9299             llvm::ArrayType::get(CGM.Int64Ty, Info.NumberOfPtrs),
9300             Info.SizesArray,
9301             /*Idx0=*/0,
9302             /*Idx1=*/I);
9303         Address SAddr(S, Ctx.getTypeAlignInChars(Int64Ty));
9304         CGF.Builder.CreateStore(CGF.Builder.CreateIntCast(CombinedInfo.Sizes[I],
9305                                                           CGM.Int64Ty,
9306                                                           /*isSigned=*/true),
9307                                 SAddr);
9308       }
9309 
9310       // Fill up the mapper array.
9311       llvm::Value *MFunc = llvm::ConstantPointerNull::get(CGM.VoidPtrTy);
9312       if (CombinedInfo.Mappers[I]) {
9313         MFunc = CGM.getOpenMPRuntime().getOrCreateUserDefinedMapperFunc(
9314             cast<OMPDeclareMapperDecl>(CombinedInfo.Mappers[I]));
9315         MFunc = CGF.Builder.CreatePointerCast(MFunc, CGM.VoidPtrTy);
9316         Info.HasMapper = true;
9317       }
9318       Address MAddr = CGF.Builder.CreateConstArrayGEP(MappersArray, I);
9319       CGF.Builder.CreateStore(MFunc, MAddr);
9320     }
9321   }
9322 
9323   if (!IsNonContiguous || CombinedInfo.NonContigInfo.Offsets.empty() ||
9324       Info.NumberOfPtrs == 0)
9325     return;
9326 
9327   emitNonContiguousDescriptor(CGF, CombinedInfo, Info);
9328 }
9329 
9330 namespace {
9331 /// Additional arguments for emitOffloadingArraysArgument function.
9332 struct ArgumentsOptions {
9333   bool ForEndCall = false;
9334   ArgumentsOptions() = default;
9335   ArgumentsOptions(bool ForEndCall) : ForEndCall(ForEndCall) {}
9336 };
9337 } // namespace
9338 
9339 /// Emit the arguments to be passed to the runtime library based on the
9340 /// arrays of base pointers, pointers, sizes, map types, and mappers.  If
9341 /// ForEndCall, emit map types to be passed for the end of the region instead of
9342 /// the beginning.
9343 static void emitOffloadingArraysArgument(
9344     CodeGenFunction &CGF, llvm::Value *&BasePointersArrayArg,
9345     llvm::Value *&PointersArrayArg, llvm::Value *&SizesArrayArg,
9346     llvm::Value *&MapTypesArrayArg, llvm::Value *&MapNamesArrayArg,
9347     llvm::Value *&MappersArrayArg, CGOpenMPRuntime::TargetDataInfo &Info,
9348     const ArgumentsOptions &Options = ArgumentsOptions()) {
9349   assert((!Options.ForEndCall || Info.separateBeginEndCalls()) &&
9350          "expected region end call to runtime only when end call is separate");
9351   CodeGenModule &CGM = CGF.CGM;
9352   if (Info.NumberOfPtrs) {
9353     BasePointersArrayArg = CGF.Builder.CreateConstInBoundsGEP2_32(
9354         llvm::ArrayType::get(CGM.VoidPtrTy, Info.NumberOfPtrs),
9355         Info.BasePointersArray,
9356         /*Idx0=*/0, /*Idx1=*/0);
9357     PointersArrayArg = CGF.Builder.CreateConstInBoundsGEP2_32(
9358         llvm::ArrayType::get(CGM.VoidPtrTy, Info.NumberOfPtrs),
9359         Info.PointersArray,
9360         /*Idx0=*/0,
9361         /*Idx1=*/0);
9362     SizesArrayArg = CGF.Builder.CreateConstInBoundsGEP2_32(
9363         llvm::ArrayType::get(CGM.Int64Ty, Info.NumberOfPtrs), Info.SizesArray,
9364         /*Idx0=*/0, /*Idx1=*/0);
9365     MapTypesArrayArg = CGF.Builder.CreateConstInBoundsGEP2_32(
9366         llvm::ArrayType::get(CGM.Int64Ty, Info.NumberOfPtrs),
9367         Options.ForEndCall && Info.MapTypesArrayEnd ? Info.MapTypesArrayEnd
9368                                                     : Info.MapTypesArray,
9369         /*Idx0=*/0,
9370         /*Idx1=*/0);
9371 
9372     // Only emit the mapper information arrays if debug information is
9373     // requested.
9374     if (CGF.CGM.getCodeGenOpts().getDebugInfo() == codegenoptions::NoDebugInfo)
9375       MapNamesArrayArg = llvm::ConstantPointerNull::get(CGM.VoidPtrPtrTy);
9376     else
9377       MapNamesArrayArg = CGF.Builder.CreateConstInBoundsGEP2_32(
9378           llvm::ArrayType::get(CGM.VoidPtrTy, Info.NumberOfPtrs),
9379           Info.MapNamesArray,
9380           /*Idx0=*/0,
9381           /*Idx1=*/0);
9382     // If there is no user-defined mapper, set the mapper array to nullptr to
9383     // avoid an unnecessary data privatization
9384     if (!Info.HasMapper)
9385       MappersArrayArg = llvm::ConstantPointerNull::get(CGM.VoidPtrPtrTy);
9386     else
9387       MappersArrayArg =
9388           CGF.Builder.CreatePointerCast(Info.MappersArray, CGM.VoidPtrPtrTy);
9389   } else {
9390     BasePointersArrayArg = llvm::ConstantPointerNull::get(CGM.VoidPtrPtrTy);
9391     PointersArrayArg = llvm::ConstantPointerNull::get(CGM.VoidPtrPtrTy);
9392     SizesArrayArg = llvm::ConstantPointerNull::get(CGM.Int64Ty->getPointerTo());
9393     MapTypesArrayArg =
9394         llvm::ConstantPointerNull::get(CGM.Int64Ty->getPointerTo());
9395     MapNamesArrayArg = llvm::ConstantPointerNull::get(CGM.VoidPtrPtrTy);
9396     MappersArrayArg = llvm::ConstantPointerNull::get(CGM.VoidPtrPtrTy);
9397   }
9398 }
9399 
9400 /// Check for inner distribute directive.
9401 static const OMPExecutableDirective *
9402 getNestedDistributeDirective(ASTContext &Ctx, const OMPExecutableDirective &D) {
9403   const auto *CS = D.getInnermostCapturedStmt();
9404   const auto *Body =
9405       CS->getCapturedStmt()->IgnoreContainers(/*IgnoreCaptured=*/true);
9406   const Stmt *ChildStmt =
9407       CGOpenMPSIMDRuntime::getSingleCompoundChild(Ctx, Body);
9408 
9409   if (const auto *NestedDir =
9410           dyn_cast_or_null<OMPExecutableDirective>(ChildStmt)) {
9411     OpenMPDirectiveKind DKind = NestedDir->getDirectiveKind();
9412     switch (D.getDirectiveKind()) {
9413     case OMPD_target:
9414       if (isOpenMPDistributeDirective(DKind))
9415         return NestedDir;
9416       if (DKind == OMPD_teams) {
9417         Body = NestedDir->getInnermostCapturedStmt()->IgnoreContainers(
9418             /*IgnoreCaptured=*/true);
9419         if (!Body)
9420           return nullptr;
9421         ChildStmt = CGOpenMPSIMDRuntime::getSingleCompoundChild(Ctx, Body);
9422         if (const auto *NND =
9423                 dyn_cast_or_null<OMPExecutableDirective>(ChildStmt)) {
9424           DKind = NND->getDirectiveKind();
9425           if (isOpenMPDistributeDirective(DKind))
9426             return NND;
9427         }
9428       }
9429       return nullptr;
9430     case OMPD_target_teams:
9431       if (isOpenMPDistributeDirective(DKind))
9432         return NestedDir;
9433       return nullptr;
9434     case OMPD_target_parallel:
9435     case OMPD_target_simd:
9436     case OMPD_target_parallel_for:
9437     case OMPD_target_parallel_for_simd:
9438       return nullptr;
9439     case OMPD_target_teams_distribute:
9440     case OMPD_target_teams_distribute_simd:
9441     case OMPD_target_teams_distribute_parallel_for:
9442     case OMPD_target_teams_distribute_parallel_for_simd:
9443     case OMPD_parallel:
9444     case OMPD_for:
9445     case OMPD_parallel_for:
9446     case OMPD_parallel_master:
9447     case OMPD_parallel_sections:
9448     case OMPD_for_simd:
9449     case OMPD_parallel_for_simd:
9450     case OMPD_cancel:
9451     case OMPD_cancellation_point:
9452     case OMPD_ordered:
9453     case OMPD_threadprivate:
9454     case OMPD_allocate:
9455     case OMPD_task:
9456     case OMPD_simd:
9457     case OMPD_sections:
9458     case OMPD_section:
9459     case OMPD_single:
9460     case OMPD_master:
9461     case OMPD_critical:
9462     case OMPD_taskyield:
9463     case OMPD_barrier:
9464     case OMPD_taskwait:
9465     case OMPD_taskgroup:
9466     case OMPD_atomic:
9467     case OMPD_flush:
9468     case OMPD_depobj:
9469     case OMPD_scan:
9470     case OMPD_teams:
9471     case OMPD_target_data:
9472     case OMPD_target_exit_data:
9473     case OMPD_target_enter_data:
9474     case OMPD_distribute:
9475     case OMPD_distribute_simd:
9476     case OMPD_distribute_parallel_for:
9477     case OMPD_distribute_parallel_for_simd:
9478     case OMPD_teams_distribute:
9479     case OMPD_teams_distribute_simd:
9480     case OMPD_teams_distribute_parallel_for:
9481     case OMPD_teams_distribute_parallel_for_simd:
9482     case OMPD_target_update:
9483     case OMPD_declare_simd:
9484     case OMPD_declare_variant:
9485     case OMPD_begin_declare_variant:
9486     case OMPD_end_declare_variant:
9487     case OMPD_declare_target:
9488     case OMPD_end_declare_target:
9489     case OMPD_declare_reduction:
9490     case OMPD_declare_mapper:
9491     case OMPD_taskloop:
9492     case OMPD_taskloop_simd:
9493     case OMPD_master_taskloop:
9494     case OMPD_master_taskloop_simd:
9495     case OMPD_parallel_master_taskloop:
9496     case OMPD_parallel_master_taskloop_simd:
9497     case OMPD_requires:
9498     case OMPD_unknown:
9499     default:
9500       llvm_unreachable("Unexpected directive.");
9501     }
9502   }
9503 
9504   return nullptr;
9505 }
9506 
9507 /// Emit the user-defined mapper function. The code generation follows the
9508 /// pattern in the example below.
9509 /// \code
9510 /// void .omp_mapper.<type_name>.<mapper_id>.(void *rt_mapper_handle,
9511 ///                                           void *base, void *begin,
9512 ///                                           int64_t size, int64_t type) {
9513 ///   // Allocate space for an array section first.
9514 ///   if (size > 1 && !maptype.IsDelete)
9515 ///     __tgt_push_mapper_component(rt_mapper_handle, base, begin,
9516 ///                                 size*sizeof(Ty), clearToFrom(type));
9517 ///   // Map members.
9518 ///   for (unsigned i = 0; i < size; i++) {
9519 ///     // For each component specified by this mapper:
9520 ///     for (auto c : all_components) {
9521 ///       if (c.hasMapper())
9522 ///         (*c.Mapper())(rt_mapper_handle, c.arg_base, c.arg_begin, c.arg_size,
9523 ///                       c.arg_type);
9524 ///       else
9525 ///         __tgt_push_mapper_component(rt_mapper_handle, c.arg_base,
9526 ///                                     c.arg_begin, c.arg_size, c.arg_type);
9527 ///     }
9528 ///   }
9529 ///   // Delete the array section.
9530 ///   if (size > 1 && maptype.IsDelete)
9531 ///     __tgt_push_mapper_component(rt_mapper_handle, base, begin,
9532 ///                                 size*sizeof(Ty), clearToFrom(type));
9533 /// }
9534 /// \endcode
9535 void CGOpenMPRuntime::emitUserDefinedMapper(const OMPDeclareMapperDecl *D,
9536                                             CodeGenFunction *CGF) {
9537   if (UDMMap.count(D) > 0)
9538     return;
9539   ASTContext &C = CGM.getContext();
9540   QualType Ty = D->getType();
9541   QualType PtrTy = C.getPointerType(Ty).withRestrict();
9542   QualType Int64Ty = C.getIntTypeForBitwidth(/*DestWidth=*/64, /*Signed=*/true);
9543   auto *MapperVarDecl =
9544       cast<VarDecl>(cast<DeclRefExpr>(D->getMapperVarRef())->getDecl());
9545   SourceLocation Loc = D->getLocation();
9546   CharUnits ElementSize = C.getTypeSizeInChars(Ty);
9547 
9548   // Prepare mapper function arguments and attributes.
9549   ImplicitParamDecl HandleArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr,
9550                               C.VoidPtrTy, ImplicitParamDecl::Other);
9551   ImplicitParamDecl BaseArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, C.VoidPtrTy,
9552                             ImplicitParamDecl::Other);
9553   ImplicitParamDecl BeginArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr,
9554                              C.VoidPtrTy, ImplicitParamDecl::Other);
9555   ImplicitParamDecl SizeArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, Int64Ty,
9556                             ImplicitParamDecl::Other);
9557   ImplicitParamDecl TypeArg(C, /*DC=*/nullptr, Loc, /*Id=*/nullptr, Int64Ty,
9558                             ImplicitParamDecl::Other);
9559   FunctionArgList Args;
9560   Args.push_back(&HandleArg);
9561   Args.push_back(&BaseArg);
9562   Args.push_back(&BeginArg);
9563   Args.push_back(&SizeArg);
9564   Args.push_back(&TypeArg);
9565   const CGFunctionInfo &FnInfo =
9566       CGM.getTypes().arrangeBuiltinFunctionDeclaration(C.VoidTy, Args);
9567   llvm::FunctionType *FnTy = CGM.getTypes().GetFunctionType(FnInfo);
9568   SmallString<64> TyStr;
9569   llvm::raw_svector_ostream Out(TyStr);
9570   CGM.getCXXABI().getMangleContext().mangleTypeName(Ty, Out);
9571   std::string Name = getName({"omp_mapper", TyStr, D->getName()});
9572   auto *Fn = llvm::Function::Create(FnTy, llvm::GlobalValue::InternalLinkage,
9573                                     Name, &CGM.getModule());
9574   CGM.SetInternalFunctionAttributes(GlobalDecl(), Fn, FnInfo);
9575   Fn->removeFnAttr(llvm::Attribute::OptimizeNone);
9576   // Start the mapper function code generation.
9577   CodeGenFunction MapperCGF(CGM);
9578   MapperCGF.StartFunction(GlobalDecl(), C.VoidTy, Fn, FnInfo, Args, Loc, Loc);
9579   // Compute the starting and end addreses of array elements.
9580   llvm::Value *Size = MapperCGF.EmitLoadOfScalar(
9581       MapperCGF.GetAddrOfLocalVar(&SizeArg), /*Volatile=*/false,
9582       C.getPointerType(Int64Ty), Loc);
9583   // Convert the size in bytes into the number of array elements.
9584   Size = MapperCGF.Builder.CreateExactUDiv(
9585       Size, MapperCGF.Builder.getInt64(ElementSize.getQuantity()));
9586   llvm::Value *PtrBegin = MapperCGF.Builder.CreateBitCast(
9587       MapperCGF.GetAddrOfLocalVar(&BeginArg).getPointer(),
9588       CGM.getTypes().ConvertTypeForMem(C.getPointerType(PtrTy)));
9589   llvm::Value *PtrEnd = MapperCGF.Builder.CreateGEP(PtrBegin, Size);
9590   llvm::Value *MapType = MapperCGF.EmitLoadOfScalar(
9591       MapperCGF.GetAddrOfLocalVar(&TypeArg), /*Volatile=*/false,
9592       C.getPointerType(Int64Ty), Loc);
9593   // Prepare common arguments for array initiation and deletion.
9594   llvm::Value *Handle = MapperCGF.EmitLoadOfScalar(
9595       MapperCGF.GetAddrOfLocalVar(&HandleArg),
9596       /*Volatile=*/false, C.getPointerType(C.VoidPtrTy), Loc);
9597   llvm::Value *BaseIn = MapperCGF.EmitLoadOfScalar(
9598       MapperCGF.GetAddrOfLocalVar(&BaseArg),
9599       /*Volatile=*/false, C.getPointerType(C.VoidPtrTy), Loc);
9600   llvm::Value *BeginIn = MapperCGF.EmitLoadOfScalar(
9601       MapperCGF.GetAddrOfLocalVar(&BeginArg),
9602       /*Volatile=*/false, C.getPointerType(C.VoidPtrTy), Loc);
9603 
9604   // Emit array initiation if this is an array section and \p MapType indicates
9605   // that memory allocation is required.
9606   llvm::BasicBlock *HeadBB = MapperCGF.createBasicBlock("omp.arraymap.head");
9607   emitUDMapperArrayInitOrDel(MapperCGF, Handle, BaseIn, BeginIn, Size, MapType,
9608                              ElementSize, HeadBB, /*IsInit=*/true);
9609 
9610   // Emit a for loop to iterate through SizeArg of elements and map all of them.
9611 
9612   // Emit the loop header block.
9613   MapperCGF.EmitBlock(HeadBB);
9614   llvm::BasicBlock *BodyBB = MapperCGF.createBasicBlock("omp.arraymap.body");
9615   llvm::BasicBlock *DoneBB = MapperCGF.createBasicBlock("omp.done");
9616   // Evaluate whether the initial condition is satisfied.
9617   llvm::Value *IsEmpty =
9618       MapperCGF.Builder.CreateICmpEQ(PtrBegin, PtrEnd, "omp.arraymap.isempty");
9619   MapperCGF.Builder.CreateCondBr(IsEmpty, DoneBB, BodyBB);
9620   llvm::BasicBlock *EntryBB = MapperCGF.Builder.GetInsertBlock();
9621 
9622   // Emit the loop body block.
9623   MapperCGF.EmitBlock(BodyBB);
9624   llvm::BasicBlock *LastBB = BodyBB;
9625   llvm::PHINode *PtrPHI = MapperCGF.Builder.CreatePHI(
9626       PtrBegin->getType(), 2, "omp.arraymap.ptrcurrent");
9627   PtrPHI->addIncoming(PtrBegin, EntryBB);
9628   Address PtrCurrent =
9629       Address(PtrPHI, MapperCGF.GetAddrOfLocalVar(&BeginArg)
9630                           .getAlignment()
9631                           .alignmentOfArrayElement(ElementSize));
9632   // Privatize the declared variable of mapper to be the current array element.
9633   CodeGenFunction::OMPPrivateScope Scope(MapperCGF);
9634   Scope.addPrivate(MapperVarDecl, [&MapperCGF, PtrCurrent, PtrTy]() {
9635     return MapperCGF
9636         .EmitLoadOfPointerLValue(PtrCurrent, PtrTy->castAs<PointerType>())
9637         .getAddress(MapperCGF);
9638   });
9639   (void)Scope.Privatize();
9640 
9641   // Get map clause information. Fill up the arrays with all mapped variables.
9642   MappableExprsHandler::MapCombinedInfoTy Info;
9643   MappableExprsHandler MEHandler(*D, MapperCGF);
9644   MEHandler.generateAllInfoForMapper(Info);
9645 
9646   // Call the runtime API __tgt_mapper_num_components to get the number of
9647   // pre-existing components.
9648   llvm::Value *OffloadingArgs[] = {Handle};
9649   llvm::Value *PreviousSize = MapperCGF.EmitRuntimeCall(
9650       OMPBuilder.getOrCreateRuntimeFunction(CGM.getModule(),
9651                                             OMPRTL___tgt_mapper_num_components),
9652       OffloadingArgs);
9653   llvm::Value *ShiftedPreviousSize = MapperCGF.Builder.CreateShl(
9654       PreviousSize,
9655       MapperCGF.Builder.getInt64(MappableExprsHandler::getFlagMemberOffset()));
9656 
9657   // Fill up the runtime mapper handle for all components.
9658   for (unsigned I = 0; I < Info.BasePointers.size(); ++I) {
9659     llvm::Value *CurBaseArg = MapperCGF.Builder.CreateBitCast(
9660         *Info.BasePointers[I], CGM.getTypes().ConvertTypeForMem(C.VoidPtrTy));
9661     llvm::Value *CurBeginArg = MapperCGF.Builder.CreateBitCast(
9662         Info.Pointers[I], CGM.getTypes().ConvertTypeForMem(C.VoidPtrTy));
9663     llvm::Value *CurSizeArg = Info.Sizes[I];
9664 
9665     // Extract the MEMBER_OF field from the map type.
9666     llvm::BasicBlock *MemberBB = MapperCGF.createBasicBlock("omp.member");
9667     MapperCGF.EmitBlock(MemberBB);
9668     llvm::Value *OriMapType = MapperCGF.Builder.getInt64(Info.Types[I]);
9669     llvm::Value *Member = MapperCGF.Builder.CreateAnd(
9670         OriMapType,
9671         MapperCGF.Builder.getInt64(MappableExprsHandler::OMP_MAP_MEMBER_OF));
9672     llvm::BasicBlock *MemberCombineBB =
9673         MapperCGF.createBasicBlock("omp.member.combine");
9674     llvm::BasicBlock *TypeBB = MapperCGF.createBasicBlock("omp.type");
9675     llvm::Value *IsMember = MapperCGF.Builder.CreateIsNull(Member);
9676     MapperCGF.Builder.CreateCondBr(IsMember, TypeBB, MemberCombineBB);
9677     // Add the number of pre-existing components to the MEMBER_OF field if it
9678     // is valid.
9679     MapperCGF.EmitBlock(MemberCombineBB);
9680     llvm::Value *CombinedMember =
9681         MapperCGF.Builder.CreateNUWAdd(OriMapType, ShiftedPreviousSize);
9682     // Do nothing if it is not a member of previous components.
9683     MapperCGF.EmitBlock(TypeBB);
9684     llvm::PHINode *MemberMapType =
9685         MapperCGF.Builder.CreatePHI(CGM.Int64Ty, 4, "omp.membermaptype");
9686     MemberMapType->addIncoming(OriMapType, MemberBB);
9687     MemberMapType->addIncoming(CombinedMember, MemberCombineBB);
9688 
9689     // Combine the map type inherited from user-defined mapper with that
9690     // specified in the program. According to the OMP_MAP_TO and OMP_MAP_FROM
9691     // bits of the \a MapType, which is the input argument of the mapper
9692     // function, the following code will set the OMP_MAP_TO and OMP_MAP_FROM
9693     // bits of MemberMapType.
9694     // [OpenMP 5.0], 1.2.6. map-type decay.
9695     //        | alloc |  to   | from  | tofrom | release | delete
9696     // ----------------------------------------------------------
9697     // alloc  | alloc | alloc | alloc | alloc  | release | delete
9698     // to     | alloc |  to   | alloc |   to   | release | delete
9699     // from   | alloc | alloc | from  |  from  | release | delete
9700     // tofrom | alloc |  to   | from  | tofrom | release | delete
9701     llvm::Value *LeftToFrom = MapperCGF.Builder.CreateAnd(
9702         MapType,
9703         MapperCGF.Builder.getInt64(MappableExprsHandler::OMP_MAP_TO |
9704                                    MappableExprsHandler::OMP_MAP_FROM));
9705     llvm::BasicBlock *AllocBB = MapperCGF.createBasicBlock("omp.type.alloc");
9706     llvm::BasicBlock *AllocElseBB =
9707         MapperCGF.createBasicBlock("omp.type.alloc.else");
9708     llvm::BasicBlock *ToBB = MapperCGF.createBasicBlock("omp.type.to");
9709     llvm::BasicBlock *ToElseBB = MapperCGF.createBasicBlock("omp.type.to.else");
9710     llvm::BasicBlock *FromBB = MapperCGF.createBasicBlock("omp.type.from");
9711     llvm::BasicBlock *EndBB = MapperCGF.createBasicBlock("omp.type.end");
9712     llvm::Value *IsAlloc = MapperCGF.Builder.CreateIsNull(LeftToFrom);
9713     MapperCGF.Builder.CreateCondBr(IsAlloc, AllocBB, AllocElseBB);
9714     // In case of alloc, clear OMP_MAP_TO and OMP_MAP_FROM.
9715     MapperCGF.EmitBlock(AllocBB);
9716     llvm::Value *AllocMapType = MapperCGF.Builder.CreateAnd(
9717         MemberMapType,
9718         MapperCGF.Builder.getInt64(~(MappableExprsHandler::OMP_MAP_TO |
9719                                      MappableExprsHandler::OMP_MAP_FROM)));
9720     MapperCGF.Builder.CreateBr(EndBB);
9721     MapperCGF.EmitBlock(AllocElseBB);
9722     llvm::Value *IsTo = MapperCGF.Builder.CreateICmpEQ(
9723         LeftToFrom,
9724         MapperCGF.Builder.getInt64(MappableExprsHandler::OMP_MAP_TO));
9725     MapperCGF.Builder.CreateCondBr(IsTo, ToBB, ToElseBB);
9726     // In case of to, clear OMP_MAP_FROM.
9727     MapperCGF.EmitBlock(ToBB);
9728     llvm::Value *ToMapType = MapperCGF.Builder.CreateAnd(
9729         MemberMapType,
9730         MapperCGF.Builder.getInt64(~MappableExprsHandler::OMP_MAP_FROM));
9731     MapperCGF.Builder.CreateBr(EndBB);
9732     MapperCGF.EmitBlock(ToElseBB);
9733     llvm::Value *IsFrom = MapperCGF.Builder.CreateICmpEQ(
9734         LeftToFrom,
9735         MapperCGF.Builder.getInt64(MappableExprsHandler::OMP_MAP_FROM));
9736     MapperCGF.Builder.CreateCondBr(IsFrom, FromBB, EndBB);
9737     // In case of from, clear OMP_MAP_TO.
9738     MapperCGF.EmitBlock(FromBB);
9739     llvm::Value *FromMapType = MapperCGF.Builder.CreateAnd(
9740         MemberMapType,
9741         MapperCGF.Builder.getInt64(~MappableExprsHandler::OMP_MAP_TO));
9742     // In case of tofrom, do nothing.
9743     MapperCGF.EmitBlock(EndBB);
9744     LastBB = EndBB;
9745     llvm::PHINode *CurMapType =
9746         MapperCGF.Builder.CreatePHI(CGM.Int64Ty, 4, "omp.maptype");
9747     CurMapType->addIncoming(AllocMapType, AllocBB);
9748     CurMapType->addIncoming(ToMapType, ToBB);
9749     CurMapType->addIncoming(FromMapType, FromBB);
9750     CurMapType->addIncoming(MemberMapType, ToElseBB);
9751 
9752     llvm::Value *OffloadingArgs[] = {Handle, CurBaseArg, CurBeginArg,
9753                                      CurSizeArg, CurMapType};
9754     if (Info.Mappers[I]) {
9755       // Call the corresponding mapper function.
9756       llvm::Function *MapperFunc = getOrCreateUserDefinedMapperFunc(
9757           cast<OMPDeclareMapperDecl>(Info.Mappers[I]));
9758       assert(MapperFunc && "Expect a valid mapper function is available.");
9759       MapperCGF.EmitNounwindRuntimeCall(MapperFunc, OffloadingArgs);
9760     } else {
9761       // Call the runtime API __tgt_push_mapper_component to fill up the runtime
9762       // data structure.
9763       MapperCGF.EmitRuntimeCall(
9764           OMPBuilder.getOrCreateRuntimeFunction(
9765               CGM.getModule(), OMPRTL___tgt_push_mapper_component),
9766           OffloadingArgs);
9767     }
9768   }
9769 
9770   // Update the pointer to point to the next element that needs to be mapped,
9771   // and check whether we have mapped all elements.
9772   llvm::Value *PtrNext = MapperCGF.Builder.CreateConstGEP1_32(
9773       PtrPHI, /*Idx0=*/1, "omp.arraymap.next");
9774   PtrPHI->addIncoming(PtrNext, LastBB);
9775   llvm::Value *IsDone =
9776       MapperCGF.Builder.CreateICmpEQ(PtrNext, PtrEnd, "omp.arraymap.isdone");
9777   llvm::BasicBlock *ExitBB = MapperCGF.createBasicBlock("omp.arraymap.exit");
9778   MapperCGF.Builder.CreateCondBr(IsDone, ExitBB, BodyBB);
9779 
9780   MapperCGF.EmitBlock(ExitBB);
9781   // Emit array deletion if this is an array section and \p MapType indicates
9782   // that deletion is required.
9783   emitUDMapperArrayInitOrDel(MapperCGF, Handle, BaseIn, BeginIn, Size, MapType,
9784                              ElementSize, DoneBB, /*IsInit=*/false);
9785 
9786   // Emit the function exit block.
9787   MapperCGF.EmitBlock(DoneBB, /*IsFinished=*/true);
9788   MapperCGF.FinishFunction();
9789   UDMMap.try_emplace(D, Fn);
9790   if (CGF) {
9791     auto &Decls = FunctionUDMMap.FindAndConstruct(CGF->CurFn);
9792     Decls.second.push_back(D);
9793   }
9794 }
9795 
9796 /// Emit the array initialization or deletion portion for user-defined mapper
9797 /// code generation. First, it evaluates whether an array section is mapped and
9798 /// whether the \a MapType instructs to delete this section. If \a IsInit is
9799 /// true, and \a MapType indicates to not delete this array, array
9800 /// initialization code is generated. If \a IsInit is false, and \a MapType
9801 /// indicates to not this array, array deletion code is generated.
9802 void CGOpenMPRuntime::emitUDMapperArrayInitOrDel(
9803     CodeGenFunction &MapperCGF, llvm::Value *Handle, llvm::Value *Base,
9804     llvm::Value *Begin, llvm::Value *Size, llvm::Value *MapType,
9805     CharUnits ElementSize, llvm::BasicBlock *ExitBB, bool IsInit) {
9806   StringRef Prefix = IsInit ? ".init" : ".del";
9807 
9808   // Evaluate if this is an array section.
9809   llvm::BasicBlock *IsDeleteBB =
9810       MapperCGF.createBasicBlock(getName({"omp.array", Prefix, ".evaldelete"}));
9811   llvm::BasicBlock *BodyBB =
9812       MapperCGF.createBasicBlock(getName({"omp.array", Prefix}));
9813   llvm::Value *IsArray = MapperCGF.Builder.CreateICmpSGE(
9814       Size, MapperCGF.Builder.getInt64(1), "omp.arrayinit.isarray");
9815   MapperCGF.Builder.CreateCondBr(IsArray, IsDeleteBB, ExitBB);
9816 
9817   // Evaluate if we are going to delete this section.
9818   MapperCGF.EmitBlock(IsDeleteBB);
9819   llvm::Value *DeleteBit = MapperCGF.Builder.CreateAnd(
9820       MapType,
9821       MapperCGF.Builder.getInt64(MappableExprsHandler::OMP_MAP_DELETE));
9822   llvm::Value *DeleteCond;
9823   if (IsInit) {
9824     DeleteCond = MapperCGF.Builder.CreateIsNull(
9825         DeleteBit, getName({"omp.array", Prefix, ".delete"}));
9826   } else {
9827     DeleteCond = MapperCGF.Builder.CreateIsNotNull(
9828         DeleteBit, getName({"omp.array", Prefix, ".delete"}));
9829   }
9830   MapperCGF.Builder.CreateCondBr(DeleteCond, BodyBB, ExitBB);
9831 
9832   MapperCGF.EmitBlock(BodyBB);
9833   // Get the array size by multiplying element size and element number (i.e., \p
9834   // Size).
9835   llvm::Value *ArraySize = MapperCGF.Builder.CreateNUWMul(
9836       Size, MapperCGF.Builder.getInt64(ElementSize.getQuantity()));
9837   // Remove OMP_MAP_TO and OMP_MAP_FROM from the map type, so that it achieves
9838   // memory allocation/deletion purpose only.
9839   llvm::Value *MapTypeArg = MapperCGF.Builder.CreateAnd(
9840       MapType,
9841       MapperCGF.Builder.getInt64(~(MappableExprsHandler::OMP_MAP_TO |
9842                                    MappableExprsHandler::OMP_MAP_FROM)));
9843   // Call the runtime API __tgt_push_mapper_component to fill up the runtime
9844   // data structure.
9845   llvm::Value *OffloadingArgs[] = {Handle, Base, Begin, ArraySize, MapTypeArg};
9846   MapperCGF.EmitRuntimeCall(
9847       OMPBuilder.getOrCreateRuntimeFunction(CGM.getModule(),
9848                                             OMPRTL___tgt_push_mapper_component),
9849       OffloadingArgs);
9850 }
9851 
9852 llvm::Function *CGOpenMPRuntime::getOrCreateUserDefinedMapperFunc(
9853     const OMPDeclareMapperDecl *D) {
9854   auto I = UDMMap.find(D);
9855   if (I != UDMMap.end())
9856     return I->second;
9857   emitUserDefinedMapper(D);
9858   return UDMMap.lookup(D);
9859 }
9860 
9861 void CGOpenMPRuntime::emitTargetNumIterationsCall(
9862     CodeGenFunction &CGF, const OMPExecutableDirective &D,
9863     llvm::Value *DeviceID,
9864     llvm::function_ref<llvm::Value *(CodeGenFunction &CGF,
9865                                      const OMPLoopDirective &D)>
9866         SizeEmitter) {
9867   OpenMPDirectiveKind Kind = D.getDirectiveKind();
9868   const OMPExecutableDirective *TD = &D;
9869   // Get nested teams distribute kind directive, if any.
9870   if (!isOpenMPDistributeDirective(Kind) || !isOpenMPTeamsDirective(Kind))
9871     TD = getNestedDistributeDirective(CGM.getContext(), D);
9872   if (!TD)
9873     return;
9874   const auto *LD = cast<OMPLoopDirective>(TD);
9875   auto &&CodeGen = [LD, DeviceID, SizeEmitter, this](CodeGenFunction &CGF,
9876                                                      PrePostActionTy &) {
9877     if (llvm::Value *NumIterations = SizeEmitter(CGF, *LD)) {
9878       llvm::Value *Args[] = {DeviceID, NumIterations};
9879       CGF.EmitRuntimeCall(
9880           OMPBuilder.getOrCreateRuntimeFunction(
9881               CGM.getModule(), OMPRTL___kmpc_push_target_tripcount),
9882           Args);
9883     }
9884   };
9885   emitInlinedDirective(CGF, OMPD_unknown, CodeGen);
9886 }
9887 
9888 void CGOpenMPRuntime::emitTargetCall(
9889     CodeGenFunction &CGF, const OMPExecutableDirective &D,
9890     llvm::Function *OutlinedFn, llvm::Value *OutlinedFnID, const Expr *IfCond,
9891     llvm::PointerIntPair<const Expr *, 2, OpenMPDeviceClauseModifier> Device,
9892     llvm::function_ref<llvm::Value *(CodeGenFunction &CGF,
9893                                      const OMPLoopDirective &D)>
9894         SizeEmitter) {
9895   if (!CGF.HaveInsertPoint())
9896     return;
9897 
9898   assert(OutlinedFn && "Invalid outlined function!");
9899 
9900   const bool RequiresOuterTask = D.hasClausesOfKind<OMPDependClause>() ||
9901                                  D.hasClausesOfKind<OMPNowaitClause>();
9902   llvm::SmallVector<llvm::Value *, 16> CapturedVars;
9903   const CapturedStmt &CS = *D.getCapturedStmt(OMPD_target);
9904   auto &&ArgsCodegen = [&CS, &CapturedVars](CodeGenFunction &CGF,
9905                                             PrePostActionTy &) {
9906     CGF.GenerateOpenMPCapturedVars(CS, CapturedVars);
9907   };
9908   emitInlinedDirective(CGF, OMPD_unknown, ArgsCodegen);
9909 
9910   CodeGenFunction::OMPTargetDataInfo InputInfo;
9911   llvm::Value *MapTypesArray = nullptr;
9912   llvm::Value *MapNamesArray = nullptr;
9913   // Fill up the pointer arrays and transfer execution to the device.
9914   auto &&ThenGen = [this, Device, OutlinedFn, OutlinedFnID, &D, &InputInfo,
9915                     &MapTypesArray, &MapNamesArray, &CS, RequiresOuterTask,
9916                     &CapturedVars,
9917                     SizeEmitter](CodeGenFunction &CGF, PrePostActionTy &) {
9918     if (Device.getInt() == OMPC_DEVICE_ancestor) {
9919       // Reverse offloading is not supported, so just execute on the host.
9920       if (RequiresOuterTask) {
9921         CapturedVars.clear();
9922         CGF.GenerateOpenMPCapturedVars(CS, CapturedVars);
9923       }
9924       emitOutlinedFunctionCall(CGF, D.getBeginLoc(), OutlinedFn, CapturedVars);
9925       return;
9926     }
9927 
9928     // On top of the arrays that were filled up, the target offloading call
9929     // takes as arguments the device id as well as the host pointer. The host
9930     // pointer is used by the runtime library to identify the current target
9931     // region, so it only has to be unique and not necessarily point to
9932     // anything. It could be the pointer to the outlined function that
9933     // implements the target region, but we aren't using that so that the
9934     // compiler doesn't need to keep that, and could therefore inline the host
9935     // function if proven worthwhile during optimization.
9936 
9937     // From this point on, we need to have an ID of the target region defined.
9938     assert(OutlinedFnID && "Invalid outlined function ID!");
9939 
9940     // Emit device ID if any.
9941     llvm::Value *DeviceID;
9942     if (Device.getPointer()) {
9943       assert((Device.getInt() == OMPC_DEVICE_unknown ||
9944               Device.getInt() == OMPC_DEVICE_device_num) &&
9945              "Expected device_num modifier.");
9946       llvm::Value *DevVal = CGF.EmitScalarExpr(Device.getPointer());
9947       DeviceID =
9948           CGF.Builder.CreateIntCast(DevVal, CGF.Int64Ty, /*isSigned=*/true);
9949     } else {
9950       DeviceID = CGF.Builder.getInt64(OMP_DEVICEID_UNDEF);
9951     }
9952 
9953     // Emit the number of elements in the offloading arrays.
9954     llvm::Value *PointerNum =
9955         CGF.Builder.getInt32(InputInfo.NumberOfTargetItems);
9956 
9957     // Return value of the runtime offloading call.
9958     llvm::Value *Return;
9959 
9960     llvm::Value *NumTeams = emitNumTeamsForTargetDirective(CGF, D);
9961     llvm::Value *NumThreads = emitNumThreadsForTargetDirective(CGF, D);
9962 
9963     // Emit tripcount for the target loop-based directive.
9964     emitTargetNumIterationsCall(CGF, D, DeviceID, SizeEmitter);
9965 
9966     bool HasNowait = D.hasClausesOfKind<OMPNowaitClause>();
9967     // The target region is an outlined function launched by the runtime
9968     // via calls __tgt_target() or __tgt_target_teams().
9969     //
9970     // __tgt_target() launches a target region with one team and one thread,
9971     // executing a serial region.  This master thread may in turn launch
9972     // more threads within its team upon encountering a parallel region,
9973     // however, no additional teams can be launched on the device.
9974     //
9975     // __tgt_target_teams() launches a target region with one or more teams,
9976     // each with one or more threads.  This call is required for target
9977     // constructs such as:
9978     //  'target teams'
9979     //  'target' / 'teams'
9980     //  'target teams distribute parallel for'
9981     //  'target parallel'
9982     // and so on.
9983     //
9984     // Note that on the host and CPU targets, the runtime implementation of
9985     // these calls simply call the outlined function without forking threads.
9986     // The outlined functions themselves have runtime calls to
9987     // __kmpc_fork_teams() and __kmpc_fork() for this purpose, codegen'd by
9988     // the compiler in emitTeamsCall() and emitParallelCall().
9989     //
9990     // In contrast, on the NVPTX target, the implementation of
9991     // __tgt_target_teams() launches a GPU kernel with the requested number
9992     // of teams and threads so no additional calls to the runtime are required.
9993     if (NumTeams) {
9994       // If we have NumTeams defined this means that we have an enclosed teams
9995       // region. Therefore we also expect to have NumThreads defined. These two
9996       // values should be defined in the presence of a teams directive,
9997       // regardless of having any clauses associated. If the user is using teams
9998       // but no clauses, these two values will be the default that should be
9999       // passed to the runtime library - a 32-bit integer with the value zero.
10000       assert(NumThreads && "Thread limit expression should be available along "
10001                            "with number of teams.");
10002       llvm::Value *OffloadingArgs[] = {DeviceID,
10003                                        OutlinedFnID,
10004                                        PointerNum,
10005                                        InputInfo.BasePointersArray.getPointer(),
10006                                        InputInfo.PointersArray.getPointer(),
10007                                        InputInfo.SizesArray.getPointer(),
10008                                        MapTypesArray,
10009                                        MapNamesArray,
10010                                        InputInfo.MappersArray.getPointer(),
10011                                        NumTeams,
10012                                        NumThreads};
10013       Return = CGF.EmitRuntimeCall(
10014           OMPBuilder.getOrCreateRuntimeFunction(
10015               CGM.getModule(), HasNowait
10016                                    ? OMPRTL___tgt_target_teams_nowait_mapper
10017                                    : OMPRTL___tgt_target_teams_mapper),
10018           OffloadingArgs);
10019     } else {
10020       llvm::Value *OffloadingArgs[] = {DeviceID,
10021                                        OutlinedFnID,
10022                                        PointerNum,
10023                                        InputInfo.BasePointersArray.getPointer(),
10024                                        InputInfo.PointersArray.getPointer(),
10025                                        InputInfo.SizesArray.getPointer(),
10026                                        MapTypesArray,
10027                                        MapNamesArray,
10028                                        InputInfo.MappersArray.getPointer()};
10029       Return = CGF.EmitRuntimeCall(
10030           OMPBuilder.getOrCreateRuntimeFunction(
10031               CGM.getModule(), HasNowait ? OMPRTL___tgt_target_nowait_mapper
10032                                          : OMPRTL___tgt_target_mapper),
10033           OffloadingArgs);
10034     }
10035 
10036     // Check the error code and execute the host version if required.
10037     llvm::BasicBlock *OffloadFailedBlock =
10038         CGF.createBasicBlock("omp_offload.failed");
10039     llvm::BasicBlock *OffloadContBlock =
10040         CGF.createBasicBlock("omp_offload.cont");
10041     llvm::Value *Failed = CGF.Builder.CreateIsNotNull(Return);
10042     CGF.Builder.CreateCondBr(Failed, OffloadFailedBlock, OffloadContBlock);
10043 
10044     CGF.EmitBlock(OffloadFailedBlock);
10045     if (RequiresOuterTask) {
10046       CapturedVars.clear();
10047       CGF.GenerateOpenMPCapturedVars(CS, CapturedVars);
10048     }
10049     emitOutlinedFunctionCall(CGF, D.getBeginLoc(), OutlinedFn, CapturedVars);
10050     CGF.EmitBranch(OffloadContBlock);
10051 
10052     CGF.EmitBlock(OffloadContBlock, /*IsFinished=*/true);
10053   };
10054 
10055   // Notify that the host version must be executed.
10056   auto &&ElseGen = [this, &D, OutlinedFn, &CS, &CapturedVars,
10057                     RequiresOuterTask](CodeGenFunction &CGF,
10058                                        PrePostActionTy &) {
10059     if (RequiresOuterTask) {
10060       CapturedVars.clear();
10061       CGF.GenerateOpenMPCapturedVars(CS, CapturedVars);
10062     }
10063     emitOutlinedFunctionCall(CGF, D.getBeginLoc(), OutlinedFn, CapturedVars);
10064   };
10065 
10066   auto &&TargetThenGen = [this, &ThenGen, &D, &InputInfo, &MapTypesArray,
10067                           &MapNamesArray, &CapturedVars, RequiresOuterTask,
10068                           &CS](CodeGenFunction &CGF, PrePostActionTy &) {
10069     // Fill up the arrays with all the captured variables.
10070     MappableExprsHandler::MapCombinedInfoTy CombinedInfo;
10071 
10072     // Get mappable expression information.
10073     MappableExprsHandler MEHandler(D, CGF);
10074     llvm::DenseMap<llvm::Value *, llvm::Value *> LambdaPointers;
10075     llvm::DenseSet<CanonicalDeclPtr<const Decl>> MappedVarSet;
10076 
10077     auto RI = CS.getCapturedRecordDecl()->field_begin();
10078     auto CV = CapturedVars.begin();
10079     for (CapturedStmt::const_capture_iterator CI = CS.capture_begin(),
10080                                               CE = CS.capture_end();
10081          CI != CE; ++CI, ++RI, ++CV) {
10082       MappableExprsHandler::MapCombinedInfoTy CurInfo;
10083       MappableExprsHandler::StructRangeInfoTy PartialStruct;
10084 
10085       // VLA sizes are passed to the outlined region by copy and do not have map
10086       // information associated.
10087       if (CI->capturesVariableArrayType()) {
10088         CurInfo.Exprs.push_back(nullptr);
10089         CurInfo.BasePointers.push_back(*CV);
10090         CurInfo.Pointers.push_back(*CV);
10091         CurInfo.Sizes.push_back(CGF.Builder.CreateIntCast(
10092             CGF.getTypeSize(RI->getType()), CGF.Int64Ty, /*isSigned=*/true));
10093         // Copy to the device as an argument. No need to retrieve it.
10094         CurInfo.Types.push_back(MappableExprsHandler::OMP_MAP_LITERAL |
10095                                 MappableExprsHandler::OMP_MAP_TARGET_PARAM |
10096                                 MappableExprsHandler::OMP_MAP_IMPLICIT);
10097         CurInfo.Mappers.push_back(nullptr);
10098       } else {
10099         // If we have any information in the map clause, we use it, otherwise we
10100         // just do a default mapping.
10101         MEHandler.generateInfoForCapture(CI, *CV, CurInfo, PartialStruct);
10102         if (!CI->capturesThis())
10103           MappedVarSet.insert(CI->getCapturedVar());
10104         else
10105           MappedVarSet.insert(nullptr);
10106         if (CurInfo.BasePointers.empty() && !PartialStruct.Base.isValid())
10107           MEHandler.generateDefaultMapInfo(*CI, **RI, *CV, CurInfo);
10108         // Generate correct mapping for variables captured by reference in
10109         // lambdas.
10110         if (CI->capturesVariable())
10111           MEHandler.generateInfoForLambdaCaptures(CI->getCapturedVar(), *CV,
10112                                                   CurInfo, LambdaPointers);
10113       }
10114       // We expect to have at least an element of information for this capture.
10115       assert((!CurInfo.BasePointers.empty() || PartialStruct.Base.isValid()) &&
10116              "Non-existing map pointer for capture!");
10117       assert(CurInfo.BasePointers.size() == CurInfo.Pointers.size() &&
10118              CurInfo.BasePointers.size() == CurInfo.Sizes.size() &&
10119              CurInfo.BasePointers.size() == CurInfo.Types.size() &&
10120              CurInfo.BasePointers.size() == CurInfo.Mappers.size() &&
10121              "Inconsistent map information sizes!");
10122 
10123       // If there is an entry in PartialStruct it means we have a struct with
10124       // individual members mapped. Emit an extra combined entry.
10125       if (PartialStruct.Base.isValid())
10126         MEHandler.emitCombinedEntry(CombinedInfo, CurInfo.Types, PartialStruct);
10127 
10128       // We need to append the results of this capture to what we already have.
10129       CombinedInfo.append(CurInfo);
10130     }
10131     // Adjust MEMBER_OF flags for the lambdas captures.
10132     MEHandler.adjustMemberOfForLambdaCaptures(
10133         LambdaPointers, CombinedInfo.BasePointers, CombinedInfo.Pointers,
10134         CombinedInfo.Types);
10135     // Map any list items in a map clause that were not captures because they
10136     // weren't referenced within the construct.
10137     MEHandler.generateAllInfo(CombinedInfo, /*NotTargetParams=*/true,
10138                               MappedVarSet);
10139 
10140     TargetDataInfo Info;
10141     // Fill up the arrays and create the arguments.
10142     emitOffloadingArrays(CGF, CombinedInfo, Info, OMPBuilder);
10143     emitOffloadingArraysArgument(
10144         CGF, Info.BasePointersArray, Info.PointersArray, Info.SizesArray,
10145         Info.MapTypesArray, Info.MapNamesArray, Info.MappersArray, Info,
10146         {/*ForEndTask=*/false});
10147 
10148     InputInfo.NumberOfTargetItems = Info.NumberOfPtrs;
10149     InputInfo.BasePointersArray =
10150         Address(Info.BasePointersArray, CGM.getPointerAlign());
10151     InputInfo.PointersArray =
10152         Address(Info.PointersArray, CGM.getPointerAlign());
10153     InputInfo.SizesArray = Address(Info.SizesArray, CGM.getPointerAlign());
10154     InputInfo.MappersArray = Address(Info.MappersArray, CGM.getPointerAlign());
10155     MapTypesArray = Info.MapTypesArray;
10156     MapNamesArray = Info.MapNamesArray;
10157     if (RequiresOuterTask)
10158       CGF.EmitOMPTargetTaskBasedDirective(D, ThenGen, InputInfo);
10159     else
10160       emitInlinedDirective(CGF, D.getDirectiveKind(), ThenGen);
10161   };
10162 
10163   auto &&TargetElseGen = [this, &ElseGen, &D, RequiresOuterTask](
10164                              CodeGenFunction &CGF, PrePostActionTy &) {
10165     if (RequiresOuterTask) {
10166       CodeGenFunction::OMPTargetDataInfo InputInfo;
10167       CGF.EmitOMPTargetTaskBasedDirective(D, ElseGen, InputInfo);
10168     } else {
10169       emitInlinedDirective(CGF, D.getDirectiveKind(), ElseGen);
10170     }
10171   };
10172 
10173   // If we have a target function ID it means that we need to support
10174   // offloading, otherwise, just execute on the host. We need to execute on host
10175   // regardless of the conditional in the if clause if, e.g., the user do not
10176   // specify target triples.
10177   if (OutlinedFnID) {
10178     if (IfCond) {
10179       emitIfClause(CGF, IfCond, TargetThenGen, TargetElseGen);
10180     } else {
10181       RegionCodeGenTy ThenRCG(TargetThenGen);
10182       ThenRCG(CGF);
10183     }
10184   } else {
10185     RegionCodeGenTy ElseRCG(TargetElseGen);
10186     ElseRCG(CGF);
10187   }
10188 }
10189 
10190 void CGOpenMPRuntime::scanForTargetRegionsFunctions(const Stmt *S,
10191                                                     StringRef ParentName) {
10192   if (!S)
10193     return;
10194 
10195   // Codegen OMP target directives that offload compute to the device.
10196   bool RequiresDeviceCodegen =
10197       isa<OMPExecutableDirective>(S) &&
10198       isOpenMPTargetExecutionDirective(
10199           cast<OMPExecutableDirective>(S)->getDirectiveKind());
10200 
10201   if (RequiresDeviceCodegen) {
10202     const auto &E = *cast<OMPExecutableDirective>(S);
10203     unsigned DeviceID;
10204     unsigned FileID;
10205     unsigned Line;
10206     getTargetEntryUniqueInfo(CGM.getContext(), E.getBeginLoc(), DeviceID,
10207                              FileID, Line);
10208 
10209     // Is this a target region that should not be emitted as an entry point? If
10210     // so just signal we are done with this target region.
10211     if (!OffloadEntriesInfoManager.hasTargetRegionEntryInfo(DeviceID, FileID,
10212                                                             ParentName, Line))
10213       return;
10214 
10215     switch (E.getDirectiveKind()) {
10216     case OMPD_target:
10217       CodeGenFunction::EmitOMPTargetDeviceFunction(CGM, ParentName,
10218                                                    cast<OMPTargetDirective>(E));
10219       break;
10220     case OMPD_target_parallel:
10221       CodeGenFunction::EmitOMPTargetParallelDeviceFunction(
10222           CGM, ParentName, cast<OMPTargetParallelDirective>(E));
10223       break;
10224     case OMPD_target_teams:
10225       CodeGenFunction::EmitOMPTargetTeamsDeviceFunction(
10226           CGM, ParentName, cast<OMPTargetTeamsDirective>(E));
10227       break;
10228     case OMPD_target_teams_distribute:
10229       CodeGenFunction::EmitOMPTargetTeamsDistributeDeviceFunction(
10230           CGM, ParentName, cast<OMPTargetTeamsDistributeDirective>(E));
10231       break;
10232     case OMPD_target_teams_distribute_simd:
10233       CodeGenFunction::EmitOMPTargetTeamsDistributeSimdDeviceFunction(
10234           CGM, ParentName, cast<OMPTargetTeamsDistributeSimdDirective>(E));
10235       break;
10236     case OMPD_target_parallel_for:
10237       CodeGenFunction::EmitOMPTargetParallelForDeviceFunction(
10238           CGM, ParentName, cast<OMPTargetParallelForDirective>(E));
10239       break;
10240     case OMPD_target_parallel_for_simd:
10241       CodeGenFunction::EmitOMPTargetParallelForSimdDeviceFunction(
10242           CGM, ParentName, cast<OMPTargetParallelForSimdDirective>(E));
10243       break;
10244     case OMPD_target_simd:
10245       CodeGenFunction::EmitOMPTargetSimdDeviceFunction(
10246           CGM, ParentName, cast<OMPTargetSimdDirective>(E));
10247       break;
10248     case OMPD_target_teams_distribute_parallel_for:
10249       CodeGenFunction::EmitOMPTargetTeamsDistributeParallelForDeviceFunction(
10250           CGM, ParentName,
10251           cast<OMPTargetTeamsDistributeParallelForDirective>(E));
10252       break;
10253     case OMPD_target_teams_distribute_parallel_for_simd:
10254       CodeGenFunction::
10255           EmitOMPTargetTeamsDistributeParallelForSimdDeviceFunction(
10256               CGM, ParentName,
10257               cast<OMPTargetTeamsDistributeParallelForSimdDirective>(E));
10258       break;
10259     case OMPD_parallel:
10260     case OMPD_for:
10261     case OMPD_parallel_for:
10262     case OMPD_parallel_master:
10263     case OMPD_parallel_sections:
10264     case OMPD_for_simd:
10265     case OMPD_parallel_for_simd:
10266     case OMPD_cancel:
10267     case OMPD_cancellation_point:
10268     case OMPD_ordered:
10269     case OMPD_threadprivate:
10270     case OMPD_allocate:
10271     case OMPD_task:
10272     case OMPD_simd:
10273     case OMPD_sections:
10274     case OMPD_section:
10275     case OMPD_single:
10276     case OMPD_master:
10277     case OMPD_critical:
10278     case OMPD_taskyield:
10279     case OMPD_barrier:
10280     case OMPD_taskwait:
10281     case OMPD_taskgroup:
10282     case OMPD_atomic:
10283     case OMPD_flush:
10284     case OMPD_depobj:
10285     case OMPD_scan:
10286     case OMPD_teams:
10287     case OMPD_target_data:
10288     case OMPD_target_exit_data:
10289     case OMPD_target_enter_data:
10290     case OMPD_distribute:
10291     case OMPD_distribute_simd:
10292     case OMPD_distribute_parallel_for:
10293     case OMPD_distribute_parallel_for_simd:
10294     case OMPD_teams_distribute:
10295     case OMPD_teams_distribute_simd:
10296     case OMPD_teams_distribute_parallel_for:
10297     case OMPD_teams_distribute_parallel_for_simd:
10298     case OMPD_target_update:
10299     case OMPD_declare_simd:
10300     case OMPD_declare_variant:
10301     case OMPD_begin_declare_variant:
10302     case OMPD_end_declare_variant:
10303     case OMPD_declare_target:
10304     case OMPD_end_declare_target:
10305     case OMPD_declare_reduction:
10306     case OMPD_declare_mapper:
10307     case OMPD_taskloop:
10308     case OMPD_taskloop_simd:
10309     case OMPD_master_taskloop:
10310     case OMPD_master_taskloop_simd:
10311     case OMPD_parallel_master_taskloop:
10312     case OMPD_parallel_master_taskloop_simd:
10313     case OMPD_requires:
10314     case OMPD_unknown:
10315     default:
10316       llvm_unreachable("Unknown target directive for OpenMP device codegen.");
10317     }
10318     return;
10319   }
10320 
10321   if (const auto *E = dyn_cast<OMPExecutableDirective>(S)) {
10322     if (!E->hasAssociatedStmt() || !E->getAssociatedStmt())
10323       return;
10324 
10325     scanForTargetRegionsFunctions(E->getRawStmt(), ParentName);
10326     return;
10327   }
10328 
10329   // If this is a lambda function, look into its body.
10330   if (const auto *L = dyn_cast<LambdaExpr>(S))
10331     S = L->getBody();
10332 
10333   // Keep looking for target regions recursively.
10334   for (const Stmt *II : S->children())
10335     scanForTargetRegionsFunctions(II, ParentName);
10336 }
10337 
10338 bool CGOpenMPRuntime::emitTargetFunctions(GlobalDecl GD) {
10339   // If emitting code for the host, we do not process FD here. Instead we do
10340   // the normal code generation.
10341   if (!CGM.getLangOpts().OpenMPIsDevice) {
10342     if (const auto *FD = dyn_cast<FunctionDecl>(GD.getDecl())) {
10343       Optional<OMPDeclareTargetDeclAttr::DevTypeTy> DevTy =
10344           OMPDeclareTargetDeclAttr::getDeviceType(FD);
10345       // Do not emit device_type(nohost) functions for the host.
10346       if (DevTy && *DevTy == OMPDeclareTargetDeclAttr::DT_NoHost)
10347         return true;
10348     }
10349     return false;
10350   }
10351 
10352   const ValueDecl *VD = cast<ValueDecl>(GD.getDecl());
10353   // Try to detect target regions in the function.
10354   if (const auto *FD = dyn_cast<FunctionDecl>(VD)) {
10355     StringRef Name = CGM.getMangledName(GD);
10356     scanForTargetRegionsFunctions(FD->getBody(), Name);
10357     Optional<OMPDeclareTargetDeclAttr::DevTypeTy> DevTy =
10358         OMPDeclareTargetDeclAttr::getDeviceType(FD);
10359     // Do not emit device_type(nohost) functions for the host.
10360     if (DevTy && *DevTy == OMPDeclareTargetDeclAttr::DT_Host)
10361       return true;
10362   }
10363 
10364   // Do not to emit function if it is not marked as declare target.
10365   return !OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(VD) &&
10366          AlreadyEmittedTargetDecls.count(VD) == 0;
10367 }
10368 
10369 bool CGOpenMPRuntime::emitTargetGlobalVariable(GlobalDecl GD) {
10370   if (!CGM.getLangOpts().OpenMPIsDevice)
10371     return false;
10372 
10373   // Check if there are Ctors/Dtors in this declaration and look for target
10374   // regions in it. We use the complete variant to produce the kernel name
10375   // mangling.
10376   QualType RDTy = cast<VarDecl>(GD.getDecl())->getType();
10377   if (const auto *RD = RDTy->getBaseElementTypeUnsafe()->getAsCXXRecordDecl()) {
10378     for (const CXXConstructorDecl *Ctor : RD->ctors()) {
10379       StringRef ParentName =
10380           CGM.getMangledName(GlobalDecl(Ctor, Ctor_Complete));
10381       scanForTargetRegionsFunctions(Ctor->getBody(), ParentName);
10382     }
10383     if (const CXXDestructorDecl *Dtor = RD->getDestructor()) {
10384       StringRef ParentName =
10385           CGM.getMangledName(GlobalDecl(Dtor, Dtor_Complete));
10386       scanForTargetRegionsFunctions(Dtor->getBody(), ParentName);
10387     }
10388   }
10389 
10390   // Do not to emit variable if it is not marked as declare target.
10391   llvm::Optional<OMPDeclareTargetDeclAttr::MapTypeTy> Res =
10392       OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(
10393           cast<VarDecl>(GD.getDecl()));
10394   if (!Res || *Res == OMPDeclareTargetDeclAttr::MT_Link ||
10395       (*Res == OMPDeclareTargetDeclAttr::MT_To &&
10396        HasRequiresUnifiedSharedMemory)) {
10397     DeferredGlobalVariables.insert(cast<VarDecl>(GD.getDecl()));
10398     return true;
10399   }
10400   return false;
10401 }
10402 
10403 llvm::Constant *
10404 CGOpenMPRuntime::registerTargetFirstprivateCopy(CodeGenFunction &CGF,
10405                                                 const VarDecl *VD) {
10406   assert(VD->getType().isConstant(CGM.getContext()) &&
10407          "Expected constant variable.");
10408   StringRef VarName;
10409   llvm::Constant *Addr;
10410   llvm::GlobalValue::LinkageTypes Linkage;
10411   QualType Ty = VD->getType();
10412   SmallString<128> Buffer;
10413   {
10414     unsigned DeviceID;
10415     unsigned FileID;
10416     unsigned Line;
10417     getTargetEntryUniqueInfo(CGM.getContext(), VD->getLocation(), DeviceID,
10418                              FileID, Line);
10419     llvm::raw_svector_ostream OS(Buffer);
10420     OS << "__omp_offloading_firstprivate_" << llvm::format("_%x", DeviceID)
10421        << llvm::format("_%x_", FileID) << VD->getName() << "_l" << Line;
10422     VarName = OS.str();
10423   }
10424   Linkage = llvm::GlobalValue::InternalLinkage;
10425   Addr =
10426       getOrCreateInternalVariable(CGM.getTypes().ConvertTypeForMem(Ty), VarName,
10427                                   getDefaultFirstprivateAddressSpace());
10428   cast<llvm::GlobalValue>(Addr)->setLinkage(Linkage);
10429   CharUnits VarSize = CGM.getContext().getTypeSizeInChars(Ty);
10430   CGM.addCompilerUsedGlobal(cast<llvm::GlobalValue>(Addr));
10431   OffloadEntriesInfoManager.registerDeviceGlobalVarEntryInfo(
10432       VarName, Addr, VarSize,
10433       OffloadEntriesInfoManagerTy::OMPTargetGlobalVarEntryTo, Linkage);
10434   return Addr;
10435 }
10436 
10437 void CGOpenMPRuntime::registerTargetGlobalVariable(const VarDecl *VD,
10438                                                    llvm::Constant *Addr) {
10439   if (CGM.getLangOpts().OMPTargetTriples.empty() &&
10440       !CGM.getLangOpts().OpenMPIsDevice)
10441     return;
10442   llvm::Optional<OMPDeclareTargetDeclAttr::MapTypeTy> Res =
10443       OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(VD);
10444   if (!Res) {
10445     if (CGM.getLangOpts().OpenMPIsDevice) {
10446       // Register non-target variables being emitted in device code (debug info
10447       // may cause this).
10448       StringRef VarName = CGM.getMangledName(VD);
10449       EmittedNonTargetVariables.try_emplace(VarName, Addr);
10450     }
10451     return;
10452   }
10453   // Register declare target variables.
10454   OffloadEntriesInfoManagerTy::OMPTargetGlobalVarEntryKind Flags;
10455   StringRef VarName;
10456   CharUnits VarSize;
10457   llvm::GlobalValue::LinkageTypes Linkage;
10458 
10459   if (*Res == OMPDeclareTargetDeclAttr::MT_To &&
10460       !HasRequiresUnifiedSharedMemory) {
10461     Flags = OffloadEntriesInfoManagerTy::OMPTargetGlobalVarEntryTo;
10462     VarName = CGM.getMangledName(VD);
10463     if (VD->hasDefinition(CGM.getContext()) != VarDecl::DeclarationOnly) {
10464       VarSize = CGM.getContext().getTypeSizeInChars(VD->getType());
10465       assert(!VarSize.isZero() && "Expected non-zero size of the variable");
10466     } else {
10467       VarSize = CharUnits::Zero();
10468     }
10469     Linkage = CGM.getLLVMLinkageVarDefinition(VD, /*IsConstant=*/false);
10470     // Temp solution to prevent optimizations of the internal variables.
10471     if (CGM.getLangOpts().OpenMPIsDevice && !VD->isExternallyVisible()) {
10472       std::string RefName = getName({VarName, "ref"});
10473       if (!CGM.GetGlobalValue(RefName)) {
10474         llvm::Constant *AddrRef =
10475             getOrCreateInternalVariable(Addr->getType(), RefName);
10476         auto *GVAddrRef = cast<llvm::GlobalVariable>(AddrRef);
10477         GVAddrRef->setConstant(/*Val=*/true);
10478         GVAddrRef->setLinkage(llvm::GlobalValue::InternalLinkage);
10479         GVAddrRef->setInitializer(Addr);
10480         CGM.addCompilerUsedGlobal(GVAddrRef);
10481       }
10482     }
10483   } else {
10484     assert(((*Res == OMPDeclareTargetDeclAttr::MT_Link) ||
10485             (*Res == OMPDeclareTargetDeclAttr::MT_To &&
10486              HasRequiresUnifiedSharedMemory)) &&
10487            "Declare target attribute must link or to with unified memory.");
10488     if (*Res == OMPDeclareTargetDeclAttr::MT_Link)
10489       Flags = OffloadEntriesInfoManagerTy::OMPTargetGlobalVarEntryLink;
10490     else
10491       Flags = OffloadEntriesInfoManagerTy::OMPTargetGlobalVarEntryTo;
10492 
10493     if (CGM.getLangOpts().OpenMPIsDevice) {
10494       VarName = Addr->getName();
10495       Addr = nullptr;
10496     } else {
10497       VarName = getAddrOfDeclareTargetVar(VD).getName();
10498       Addr = cast<llvm::Constant>(getAddrOfDeclareTargetVar(VD).getPointer());
10499     }
10500     VarSize = CGM.getPointerSize();
10501     Linkage = llvm::GlobalValue::WeakAnyLinkage;
10502   }
10503 
10504   OffloadEntriesInfoManager.registerDeviceGlobalVarEntryInfo(
10505       VarName, Addr, VarSize, Flags, Linkage);
10506 }
10507 
10508 bool CGOpenMPRuntime::emitTargetGlobal(GlobalDecl GD) {
10509   if (isa<FunctionDecl>(GD.getDecl()) ||
10510       isa<OMPDeclareReductionDecl>(GD.getDecl()))
10511     return emitTargetFunctions(GD);
10512 
10513   return emitTargetGlobalVariable(GD);
10514 }
10515 
10516 void CGOpenMPRuntime::emitDeferredTargetDecls() const {
10517   for (const VarDecl *VD : DeferredGlobalVariables) {
10518     llvm::Optional<OMPDeclareTargetDeclAttr::MapTypeTy> Res =
10519         OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(VD);
10520     if (!Res)
10521       continue;
10522     if (*Res == OMPDeclareTargetDeclAttr::MT_To &&
10523         !HasRequiresUnifiedSharedMemory) {
10524       CGM.EmitGlobal(VD);
10525     } else {
10526       assert((*Res == OMPDeclareTargetDeclAttr::MT_Link ||
10527               (*Res == OMPDeclareTargetDeclAttr::MT_To &&
10528                HasRequiresUnifiedSharedMemory)) &&
10529              "Expected link clause or to clause with unified memory.");
10530       (void)CGM.getOpenMPRuntime().getAddrOfDeclareTargetVar(VD);
10531     }
10532   }
10533 }
10534 
10535 void CGOpenMPRuntime::adjustTargetSpecificDataForLambdas(
10536     CodeGenFunction &CGF, const OMPExecutableDirective &D) const {
10537   assert(isOpenMPTargetExecutionDirective(D.getDirectiveKind()) &&
10538          " Expected target-based directive.");
10539 }
10540 
10541 void CGOpenMPRuntime::processRequiresDirective(const OMPRequiresDecl *D) {
10542   for (const OMPClause *Clause : D->clauselists()) {
10543     if (Clause->getClauseKind() == OMPC_unified_shared_memory) {
10544       HasRequiresUnifiedSharedMemory = true;
10545     } else if (const auto *AC =
10546                    dyn_cast<OMPAtomicDefaultMemOrderClause>(Clause)) {
10547       switch (AC->getAtomicDefaultMemOrderKind()) {
10548       case OMPC_ATOMIC_DEFAULT_MEM_ORDER_acq_rel:
10549         RequiresAtomicOrdering = llvm::AtomicOrdering::AcquireRelease;
10550         break;
10551       case OMPC_ATOMIC_DEFAULT_MEM_ORDER_seq_cst:
10552         RequiresAtomicOrdering = llvm::AtomicOrdering::SequentiallyConsistent;
10553         break;
10554       case OMPC_ATOMIC_DEFAULT_MEM_ORDER_relaxed:
10555         RequiresAtomicOrdering = llvm::AtomicOrdering::Monotonic;
10556         break;
10557       case OMPC_ATOMIC_DEFAULT_MEM_ORDER_unknown:
10558         break;
10559       }
10560     }
10561   }
10562 }
10563 
10564 llvm::AtomicOrdering CGOpenMPRuntime::getDefaultMemoryOrdering() const {
10565   return RequiresAtomicOrdering;
10566 }
10567 
10568 bool CGOpenMPRuntime::hasAllocateAttributeForGlobalVar(const VarDecl *VD,
10569                                                        LangAS &AS) {
10570   if (!VD || !VD->hasAttr<OMPAllocateDeclAttr>())
10571     return false;
10572   const auto *A = VD->getAttr<OMPAllocateDeclAttr>();
10573   switch(A->getAllocatorType()) {
10574   case OMPAllocateDeclAttr::OMPNullMemAlloc:
10575   case OMPAllocateDeclAttr::OMPDefaultMemAlloc:
10576   // Not supported, fallback to the default mem space.
10577   case OMPAllocateDeclAttr::OMPLargeCapMemAlloc:
10578   case OMPAllocateDeclAttr::OMPCGroupMemAlloc:
10579   case OMPAllocateDeclAttr::OMPHighBWMemAlloc:
10580   case OMPAllocateDeclAttr::OMPLowLatMemAlloc:
10581   case OMPAllocateDeclAttr::OMPThreadMemAlloc:
10582   case OMPAllocateDeclAttr::OMPConstMemAlloc:
10583   case OMPAllocateDeclAttr::OMPPTeamMemAlloc:
10584     AS = LangAS::Default;
10585     return true;
10586   case OMPAllocateDeclAttr::OMPUserDefinedMemAlloc:
10587     llvm_unreachable("Expected predefined allocator for the variables with the "
10588                      "static storage.");
10589   }
10590   return false;
10591 }
10592 
10593 bool CGOpenMPRuntime::hasRequiresUnifiedSharedMemory() const {
10594   return HasRequiresUnifiedSharedMemory;
10595 }
10596 
10597 CGOpenMPRuntime::DisableAutoDeclareTargetRAII::DisableAutoDeclareTargetRAII(
10598     CodeGenModule &CGM)
10599     : CGM(CGM) {
10600   if (CGM.getLangOpts().OpenMPIsDevice) {
10601     SavedShouldMarkAsGlobal = CGM.getOpenMPRuntime().ShouldMarkAsGlobal;
10602     CGM.getOpenMPRuntime().ShouldMarkAsGlobal = false;
10603   }
10604 }
10605 
10606 CGOpenMPRuntime::DisableAutoDeclareTargetRAII::~DisableAutoDeclareTargetRAII() {
10607   if (CGM.getLangOpts().OpenMPIsDevice)
10608     CGM.getOpenMPRuntime().ShouldMarkAsGlobal = SavedShouldMarkAsGlobal;
10609 }
10610 
10611 bool CGOpenMPRuntime::markAsGlobalTarget(GlobalDecl GD) {
10612   if (!CGM.getLangOpts().OpenMPIsDevice || !ShouldMarkAsGlobal)
10613     return true;
10614 
10615   const auto *D = cast<FunctionDecl>(GD.getDecl());
10616   // Do not to emit function if it is marked as declare target as it was already
10617   // emitted.
10618   if (OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(D)) {
10619     if (D->hasBody() && AlreadyEmittedTargetDecls.count(D) == 0) {
10620       if (auto *F = dyn_cast_or_null<llvm::Function>(
10621               CGM.GetGlobalValue(CGM.getMangledName(GD))))
10622         return !F->isDeclaration();
10623       return false;
10624     }
10625     return true;
10626   }
10627 
10628   return !AlreadyEmittedTargetDecls.insert(D).second;
10629 }
10630 
10631 llvm::Function *CGOpenMPRuntime::emitRequiresDirectiveRegFun() {
10632   // If we don't have entries or if we are emitting code for the device, we
10633   // don't need to do anything.
10634   if (CGM.getLangOpts().OMPTargetTriples.empty() ||
10635       CGM.getLangOpts().OpenMPSimd || CGM.getLangOpts().OpenMPIsDevice ||
10636       (OffloadEntriesInfoManager.empty() &&
10637        !HasEmittedDeclareTargetRegion &&
10638        !HasEmittedTargetRegion))
10639     return nullptr;
10640 
10641   // Create and register the function that handles the requires directives.
10642   ASTContext &C = CGM.getContext();
10643 
10644   llvm::Function *RequiresRegFn;
10645   {
10646     CodeGenFunction CGF(CGM);
10647     const auto &FI = CGM.getTypes().arrangeNullaryFunction();
10648     llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(FI);
10649     std::string ReqName = getName({"omp_offloading", "requires_reg"});
10650     RequiresRegFn = CGM.CreateGlobalInitOrCleanUpFunction(FTy, ReqName, FI);
10651     CGF.StartFunction(GlobalDecl(), C.VoidTy, RequiresRegFn, FI, {});
10652     OpenMPOffloadingRequiresDirFlags Flags = OMP_REQ_NONE;
10653     // TODO: check for other requires clauses.
10654     // The requires directive takes effect only when a target region is
10655     // present in the compilation unit. Otherwise it is ignored and not
10656     // passed to the runtime. This avoids the runtime from throwing an error
10657     // for mismatching requires clauses across compilation units that don't
10658     // contain at least 1 target region.
10659     assert((HasEmittedTargetRegion ||
10660             HasEmittedDeclareTargetRegion ||
10661             !OffloadEntriesInfoManager.empty()) &&
10662            "Target or declare target region expected.");
10663     if (HasRequiresUnifiedSharedMemory)
10664       Flags = OMP_REQ_UNIFIED_SHARED_MEMORY;
10665     CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
10666                             CGM.getModule(), OMPRTL___tgt_register_requires),
10667                         llvm::ConstantInt::get(CGM.Int64Ty, Flags));
10668     CGF.FinishFunction();
10669   }
10670   return RequiresRegFn;
10671 }
10672 
10673 void CGOpenMPRuntime::emitTeamsCall(CodeGenFunction &CGF,
10674                                     const OMPExecutableDirective &D,
10675                                     SourceLocation Loc,
10676                                     llvm::Function *OutlinedFn,
10677                                     ArrayRef<llvm::Value *> CapturedVars) {
10678   if (!CGF.HaveInsertPoint())
10679     return;
10680 
10681   llvm::Value *RTLoc = emitUpdateLocation(CGF, Loc);
10682   CodeGenFunction::RunCleanupsScope Scope(CGF);
10683 
10684   // Build call __kmpc_fork_teams(loc, n, microtask, var1, .., varn);
10685   llvm::Value *Args[] = {
10686       RTLoc,
10687       CGF.Builder.getInt32(CapturedVars.size()), // Number of captured vars
10688       CGF.Builder.CreateBitCast(OutlinedFn, getKmpc_MicroPointerTy())};
10689   llvm::SmallVector<llvm::Value *, 16> RealArgs;
10690   RealArgs.append(std::begin(Args), std::end(Args));
10691   RealArgs.append(CapturedVars.begin(), CapturedVars.end());
10692 
10693   llvm::FunctionCallee RTLFn = OMPBuilder.getOrCreateRuntimeFunction(
10694       CGM.getModule(), OMPRTL___kmpc_fork_teams);
10695   CGF.EmitRuntimeCall(RTLFn, RealArgs);
10696 }
10697 
10698 void CGOpenMPRuntime::emitNumTeamsClause(CodeGenFunction &CGF,
10699                                          const Expr *NumTeams,
10700                                          const Expr *ThreadLimit,
10701                                          SourceLocation Loc) {
10702   if (!CGF.HaveInsertPoint())
10703     return;
10704 
10705   llvm::Value *RTLoc = emitUpdateLocation(CGF, Loc);
10706 
10707   llvm::Value *NumTeamsVal =
10708       NumTeams
10709           ? CGF.Builder.CreateIntCast(CGF.EmitScalarExpr(NumTeams),
10710                                       CGF.CGM.Int32Ty, /* isSigned = */ true)
10711           : CGF.Builder.getInt32(0);
10712 
10713   llvm::Value *ThreadLimitVal =
10714       ThreadLimit
10715           ? CGF.Builder.CreateIntCast(CGF.EmitScalarExpr(ThreadLimit),
10716                                       CGF.CGM.Int32Ty, /* isSigned = */ true)
10717           : CGF.Builder.getInt32(0);
10718 
10719   // Build call __kmpc_push_num_teamss(&loc, global_tid, num_teams, thread_limit)
10720   llvm::Value *PushNumTeamsArgs[] = {RTLoc, getThreadID(CGF, Loc), NumTeamsVal,
10721                                      ThreadLimitVal};
10722   CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
10723                           CGM.getModule(), OMPRTL___kmpc_push_num_teams),
10724                       PushNumTeamsArgs);
10725 }
10726 
10727 void CGOpenMPRuntime::emitTargetDataCalls(
10728     CodeGenFunction &CGF, const OMPExecutableDirective &D, const Expr *IfCond,
10729     const Expr *Device, const RegionCodeGenTy &CodeGen, TargetDataInfo &Info) {
10730   if (!CGF.HaveInsertPoint())
10731     return;
10732 
10733   // Action used to replace the default codegen action and turn privatization
10734   // off.
10735   PrePostActionTy NoPrivAction;
10736 
10737   // Generate the code for the opening of the data environment. Capture all the
10738   // arguments of the runtime call by reference because they are used in the
10739   // closing of the region.
10740   auto &&BeginThenGen = [this, &D, Device, &Info,
10741                          &CodeGen](CodeGenFunction &CGF, PrePostActionTy &) {
10742     // Fill up the arrays with all the mapped variables.
10743     MappableExprsHandler::MapCombinedInfoTy CombinedInfo;
10744 
10745     // Get map clause information.
10746     MappableExprsHandler MEHandler(D, CGF);
10747     MEHandler.generateAllInfo(CombinedInfo);
10748 
10749     // Fill up the arrays and create the arguments.
10750     emitOffloadingArrays(CGF, CombinedInfo, Info, OMPBuilder,
10751                          /*IsNonContiguous=*/true);
10752 
10753     llvm::Value *BasePointersArrayArg = nullptr;
10754     llvm::Value *PointersArrayArg = nullptr;
10755     llvm::Value *SizesArrayArg = nullptr;
10756     llvm::Value *MapTypesArrayArg = nullptr;
10757     llvm::Value *MapNamesArrayArg = nullptr;
10758     llvm::Value *MappersArrayArg = nullptr;
10759     emitOffloadingArraysArgument(CGF, BasePointersArrayArg, PointersArrayArg,
10760                                  SizesArrayArg, MapTypesArrayArg,
10761                                  MapNamesArrayArg, MappersArrayArg, Info);
10762 
10763     // Emit device ID if any.
10764     llvm::Value *DeviceID = nullptr;
10765     if (Device) {
10766       DeviceID = CGF.Builder.CreateIntCast(CGF.EmitScalarExpr(Device),
10767                                            CGF.Int64Ty, /*isSigned=*/true);
10768     } else {
10769       DeviceID = CGF.Builder.getInt64(OMP_DEVICEID_UNDEF);
10770     }
10771 
10772     // Emit the number of elements in the offloading arrays.
10773     llvm::Value *PointerNum = CGF.Builder.getInt32(Info.NumberOfPtrs);
10774 
10775     llvm::Value *OffloadingArgs[] = {
10776         DeviceID,      PointerNum,       BasePointersArrayArg, PointersArrayArg,
10777         SizesArrayArg, MapTypesArrayArg, MapNamesArrayArg,     MappersArrayArg};
10778     CGF.EmitRuntimeCall(
10779         OMPBuilder.getOrCreateRuntimeFunction(
10780             CGM.getModule(), OMPRTL___tgt_target_data_begin_mapper),
10781         OffloadingArgs);
10782 
10783     // If device pointer privatization is required, emit the body of the region
10784     // here. It will have to be duplicated: with and without privatization.
10785     if (!Info.CaptureDeviceAddrMap.empty())
10786       CodeGen(CGF);
10787   };
10788 
10789   // Generate code for the closing of the data region.
10790   auto &&EndThenGen = [this, Device, &Info](CodeGenFunction &CGF,
10791                                             PrePostActionTy &) {
10792     assert(Info.isValid() && "Invalid data environment closing arguments.");
10793 
10794     llvm::Value *BasePointersArrayArg = nullptr;
10795     llvm::Value *PointersArrayArg = nullptr;
10796     llvm::Value *SizesArrayArg = nullptr;
10797     llvm::Value *MapTypesArrayArg = nullptr;
10798     llvm::Value *MapNamesArrayArg = nullptr;
10799     llvm::Value *MappersArrayArg = nullptr;
10800     emitOffloadingArraysArgument(CGF, BasePointersArrayArg, PointersArrayArg,
10801                                  SizesArrayArg, MapTypesArrayArg,
10802                                  MapNamesArrayArg, MappersArrayArg, Info,
10803                                  {/*ForEndCall=*/true});
10804 
10805     // Emit device ID if any.
10806     llvm::Value *DeviceID = nullptr;
10807     if (Device) {
10808       DeviceID = CGF.Builder.CreateIntCast(CGF.EmitScalarExpr(Device),
10809                                            CGF.Int64Ty, /*isSigned=*/true);
10810     } else {
10811       DeviceID = CGF.Builder.getInt64(OMP_DEVICEID_UNDEF);
10812     }
10813 
10814     // Emit the number of elements in the offloading arrays.
10815     llvm::Value *PointerNum = CGF.Builder.getInt32(Info.NumberOfPtrs);
10816 
10817     llvm::Value *OffloadingArgs[] = {
10818         DeviceID,      PointerNum,       BasePointersArrayArg, PointersArrayArg,
10819         SizesArrayArg, MapTypesArrayArg, MapNamesArrayArg,     MappersArrayArg};
10820     CGF.EmitRuntimeCall(
10821         OMPBuilder.getOrCreateRuntimeFunction(
10822             CGM.getModule(), OMPRTL___tgt_target_data_end_mapper),
10823         OffloadingArgs);
10824   };
10825 
10826   // If we need device pointer privatization, we need to emit the body of the
10827   // region with no privatization in the 'else' branch of the conditional.
10828   // Otherwise, we don't have to do anything.
10829   auto &&BeginElseGen = [&Info, &CodeGen, &NoPrivAction](CodeGenFunction &CGF,
10830                                                          PrePostActionTy &) {
10831     if (!Info.CaptureDeviceAddrMap.empty()) {
10832       CodeGen.setAction(NoPrivAction);
10833       CodeGen(CGF);
10834     }
10835   };
10836 
10837   // We don't have to do anything to close the region if the if clause evaluates
10838   // to false.
10839   auto &&EndElseGen = [](CodeGenFunction &CGF, PrePostActionTy &) {};
10840 
10841   if (IfCond) {
10842     emitIfClause(CGF, IfCond, BeginThenGen, BeginElseGen);
10843   } else {
10844     RegionCodeGenTy RCG(BeginThenGen);
10845     RCG(CGF);
10846   }
10847 
10848   // If we don't require privatization of device pointers, we emit the body in
10849   // between the runtime calls. This avoids duplicating the body code.
10850   if (Info.CaptureDeviceAddrMap.empty()) {
10851     CodeGen.setAction(NoPrivAction);
10852     CodeGen(CGF);
10853   }
10854 
10855   if (IfCond) {
10856     emitIfClause(CGF, IfCond, EndThenGen, EndElseGen);
10857   } else {
10858     RegionCodeGenTy RCG(EndThenGen);
10859     RCG(CGF);
10860   }
10861 }
10862 
10863 void CGOpenMPRuntime::emitTargetDataStandAloneCall(
10864     CodeGenFunction &CGF, const OMPExecutableDirective &D, const Expr *IfCond,
10865     const Expr *Device) {
10866   if (!CGF.HaveInsertPoint())
10867     return;
10868 
10869   assert((isa<OMPTargetEnterDataDirective>(D) ||
10870           isa<OMPTargetExitDataDirective>(D) ||
10871           isa<OMPTargetUpdateDirective>(D)) &&
10872          "Expecting either target enter, exit data, or update directives.");
10873 
10874   CodeGenFunction::OMPTargetDataInfo InputInfo;
10875   llvm::Value *MapTypesArray = nullptr;
10876   llvm::Value *MapNamesArray = nullptr;
10877   // Generate the code for the opening of the data environment.
10878   auto &&ThenGen = [this, &D, Device, &InputInfo, &MapTypesArray,
10879                     &MapNamesArray](CodeGenFunction &CGF, PrePostActionTy &) {
10880     // Emit device ID if any.
10881     llvm::Value *DeviceID = nullptr;
10882     if (Device) {
10883       DeviceID = CGF.Builder.CreateIntCast(CGF.EmitScalarExpr(Device),
10884                                            CGF.Int64Ty, /*isSigned=*/true);
10885     } else {
10886       DeviceID = CGF.Builder.getInt64(OMP_DEVICEID_UNDEF);
10887     }
10888 
10889     // Emit the number of elements in the offloading arrays.
10890     llvm::Constant *PointerNum =
10891         CGF.Builder.getInt32(InputInfo.NumberOfTargetItems);
10892 
10893     llvm::Value *OffloadingArgs[] = {DeviceID,
10894                                      PointerNum,
10895                                      InputInfo.BasePointersArray.getPointer(),
10896                                      InputInfo.PointersArray.getPointer(),
10897                                      InputInfo.SizesArray.getPointer(),
10898                                      MapTypesArray,
10899                                      MapNamesArray,
10900                                      InputInfo.MappersArray.getPointer()};
10901 
10902     // Select the right runtime function call for each standalone
10903     // directive.
10904     const bool HasNowait = D.hasClausesOfKind<OMPNowaitClause>();
10905     RuntimeFunction RTLFn;
10906     switch (D.getDirectiveKind()) {
10907     case OMPD_target_enter_data:
10908       RTLFn = HasNowait ? OMPRTL___tgt_target_data_begin_nowait_mapper
10909                         : OMPRTL___tgt_target_data_begin_mapper;
10910       break;
10911     case OMPD_target_exit_data:
10912       RTLFn = HasNowait ? OMPRTL___tgt_target_data_end_nowait_mapper
10913                         : OMPRTL___tgt_target_data_end_mapper;
10914       break;
10915     case OMPD_target_update:
10916       RTLFn = HasNowait ? OMPRTL___tgt_target_data_update_nowait_mapper
10917                         : OMPRTL___tgt_target_data_update_mapper;
10918       break;
10919     case OMPD_parallel:
10920     case OMPD_for:
10921     case OMPD_parallel_for:
10922     case OMPD_parallel_master:
10923     case OMPD_parallel_sections:
10924     case OMPD_for_simd:
10925     case OMPD_parallel_for_simd:
10926     case OMPD_cancel:
10927     case OMPD_cancellation_point:
10928     case OMPD_ordered:
10929     case OMPD_threadprivate:
10930     case OMPD_allocate:
10931     case OMPD_task:
10932     case OMPD_simd:
10933     case OMPD_sections:
10934     case OMPD_section:
10935     case OMPD_single:
10936     case OMPD_master:
10937     case OMPD_critical:
10938     case OMPD_taskyield:
10939     case OMPD_barrier:
10940     case OMPD_taskwait:
10941     case OMPD_taskgroup:
10942     case OMPD_atomic:
10943     case OMPD_flush:
10944     case OMPD_depobj:
10945     case OMPD_scan:
10946     case OMPD_teams:
10947     case OMPD_target_data:
10948     case OMPD_distribute:
10949     case OMPD_distribute_simd:
10950     case OMPD_distribute_parallel_for:
10951     case OMPD_distribute_parallel_for_simd:
10952     case OMPD_teams_distribute:
10953     case OMPD_teams_distribute_simd:
10954     case OMPD_teams_distribute_parallel_for:
10955     case OMPD_teams_distribute_parallel_for_simd:
10956     case OMPD_declare_simd:
10957     case OMPD_declare_variant:
10958     case OMPD_begin_declare_variant:
10959     case OMPD_end_declare_variant:
10960     case OMPD_declare_target:
10961     case OMPD_end_declare_target:
10962     case OMPD_declare_reduction:
10963     case OMPD_declare_mapper:
10964     case OMPD_taskloop:
10965     case OMPD_taskloop_simd:
10966     case OMPD_master_taskloop:
10967     case OMPD_master_taskloop_simd:
10968     case OMPD_parallel_master_taskloop:
10969     case OMPD_parallel_master_taskloop_simd:
10970     case OMPD_target:
10971     case OMPD_target_simd:
10972     case OMPD_target_teams_distribute:
10973     case OMPD_target_teams_distribute_simd:
10974     case OMPD_target_teams_distribute_parallel_for:
10975     case OMPD_target_teams_distribute_parallel_for_simd:
10976     case OMPD_target_teams:
10977     case OMPD_target_parallel:
10978     case OMPD_target_parallel_for:
10979     case OMPD_target_parallel_for_simd:
10980     case OMPD_requires:
10981     case OMPD_unknown:
10982     default:
10983       llvm_unreachable("Unexpected standalone target data directive.");
10984       break;
10985     }
10986     CGF.EmitRuntimeCall(
10987         OMPBuilder.getOrCreateRuntimeFunction(CGM.getModule(), RTLFn),
10988         OffloadingArgs);
10989   };
10990 
10991   auto &&TargetThenGen = [this, &ThenGen, &D, &InputInfo, &MapTypesArray,
10992                           &MapNamesArray](CodeGenFunction &CGF,
10993                                           PrePostActionTy &) {
10994     // Fill up the arrays with all the mapped variables.
10995     MappableExprsHandler::MapCombinedInfoTy CombinedInfo;
10996 
10997     // Get map clause information.
10998     MappableExprsHandler MEHandler(D, CGF);
10999     MEHandler.generateAllInfo(CombinedInfo);
11000 
11001     TargetDataInfo Info;
11002     // Fill up the arrays and create the arguments.
11003     emitOffloadingArrays(CGF, CombinedInfo, Info, OMPBuilder,
11004                          /*IsNonContiguous=*/true);
11005     bool RequiresOuterTask = D.hasClausesOfKind<OMPDependClause>() ||
11006                              D.hasClausesOfKind<OMPNowaitClause>();
11007     emitOffloadingArraysArgument(
11008         CGF, Info.BasePointersArray, Info.PointersArray, Info.SizesArray,
11009         Info.MapTypesArray, Info.MapNamesArray, Info.MappersArray, Info,
11010         {/*ForEndTask=*/false});
11011     InputInfo.NumberOfTargetItems = Info.NumberOfPtrs;
11012     InputInfo.BasePointersArray =
11013         Address(Info.BasePointersArray, CGM.getPointerAlign());
11014     InputInfo.PointersArray =
11015         Address(Info.PointersArray, CGM.getPointerAlign());
11016     InputInfo.SizesArray =
11017         Address(Info.SizesArray, CGM.getPointerAlign());
11018     InputInfo.MappersArray = Address(Info.MappersArray, CGM.getPointerAlign());
11019     MapTypesArray = Info.MapTypesArray;
11020     MapNamesArray = Info.MapNamesArray;
11021     if (RequiresOuterTask)
11022       CGF.EmitOMPTargetTaskBasedDirective(D, ThenGen, InputInfo);
11023     else
11024       emitInlinedDirective(CGF, D.getDirectiveKind(), ThenGen);
11025   };
11026 
11027   if (IfCond) {
11028     emitIfClause(CGF, IfCond, TargetThenGen,
11029                  [](CodeGenFunction &CGF, PrePostActionTy &) {});
11030   } else {
11031     RegionCodeGenTy ThenRCG(TargetThenGen);
11032     ThenRCG(CGF);
11033   }
11034 }
11035 
11036 namespace {
11037   /// Kind of parameter in a function with 'declare simd' directive.
11038   enum ParamKindTy { LinearWithVarStride, Linear, Uniform, Vector };
11039   /// Attribute set of the parameter.
11040   struct ParamAttrTy {
11041     ParamKindTy Kind = Vector;
11042     llvm::APSInt StrideOrArg;
11043     llvm::APSInt Alignment;
11044   };
11045 } // namespace
11046 
11047 static unsigned evaluateCDTSize(const FunctionDecl *FD,
11048                                 ArrayRef<ParamAttrTy> ParamAttrs) {
11049   // Every vector variant of a SIMD-enabled function has a vector length (VLEN).
11050   // If OpenMP clause "simdlen" is used, the VLEN is the value of the argument
11051   // of that clause. The VLEN value must be power of 2.
11052   // In other case the notion of the function`s "characteristic data type" (CDT)
11053   // is used to compute the vector length.
11054   // CDT is defined in the following order:
11055   //   a) For non-void function, the CDT is the return type.
11056   //   b) If the function has any non-uniform, non-linear parameters, then the
11057   //   CDT is the type of the first such parameter.
11058   //   c) If the CDT determined by a) or b) above is struct, union, or class
11059   //   type which is pass-by-value (except for the type that maps to the
11060   //   built-in complex data type), the characteristic data type is int.
11061   //   d) If none of the above three cases is applicable, the CDT is int.
11062   // The VLEN is then determined based on the CDT and the size of vector
11063   // register of that ISA for which current vector version is generated. The
11064   // VLEN is computed using the formula below:
11065   //   VLEN  = sizeof(vector_register) / sizeof(CDT),
11066   // where vector register size specified in section 3.2.1 Registers and the
11067   // Stack Frame of original AMD64 ABI document.
11068   QualType RetType = FD->getReturnType();
11069   if (RetType.isNull())
11070     return 0;
11071   ASTContext &C = FD->getASTContext();
11072   QualType CDT;
11073   if (!RetType.isNull() && !RetType->isVoidType()) {
11074     CDT = RetType;
11075   } else {
11076     unsigned Offset = 0;
11077     if (const auto *MD = dyn_cast<CXXMethodDecl>(FD)) {
11078       if (ParamAttrs[Offset].Kind == Vector)
11079         CDT = C.getPointerType(C.getRecordType(MD->getParent()));
11080       ++Offset;
11081     }
11082     if (CDT.isNull()) {
11083       for (unsigned I = 0, E = FD->getNumParams(); I < E; ++I) {
11084         if (ParamAttrs[I + Offset].Kind == Vector) {
11085           CDT = FD->getParamDecl(I)->getType();
11086           break;
11087         }
11088       }
11089     }
11090   }
11091   if (CDT.isNull())
11092     CDT = C.IntTy;
11093   CDT = CDT->getCanonicalTypeUnqualified();
11094   if (CDT->isRecordType() || CDT->isUnionType())
11095     CDT = C.IntTy;
11096   return C.getTypeSize(CDT);
11097 }
11098 
11099 static void
11100 emitX86DeclareSimdFunction(const FunctionDecl *FD, llvm::Function *Fn,
11101                            const llvm::APSInt &VLENVal,
11102                            ArrayRef<ParamAttrTy> ParamAttrs,
11103                            OMPDeclareSimdDeclAttr::BranchStateTy State) {
11104   struct ISADataTy {
11105     char ISA;
11106     unsigned VecRegSize;
11107   };
11108   ISADataTy ISAData[] = {
11109       {
11110           'b', 128
11111       }, // SSE
11112       {
11113           'c', 256
11114       }, // AVX
11115       {
11116           'd', 256
11117       }, // AVX2
11118       {
11119           'e', 512
11120       }, // AVX512
11121   };
11122   llvm::SmallVector<char, 2> Masked;
11123   switch (State) {
11124   case OMPDeclareSimdDeclAttr::BS_Undefined:
11125     Masked.push_back('N');
11126     Masked.push_back('M');
11127     break;
11128   case OMPDeclareSimdDeclAttr::BS_Notinbranch:
11129     Masked.push_back('N');
11130     break;
11131   case OMPDeclareSimdDeclAttr::BS_Inbranch:
11132     Masked.push_back('M');
11133     break;
11134   }
11135   for (char Mask : Masked) {
11136     for (const ISADataTy &Data : ISAData) {
11137       SmallString<256> Buffer;
11138       llvm::raw_svector_ostream Out(Buffer);
11139       Out << "_ZGV" << Data.ISA << Mask;
11140       if (!VLENVal) {
11141         unsigned NumElts = evaluateCDTSize(FD, ParamAttrs);
11142         assert(NumElts && "Non-zero simdlen/cdtsize expected");
11143         Out << llvm::APSInt::getUnsigned(Data.VecRegSize / NumElts);
11144       } else {
11145         Out << VLENVal;
11146       }
11147       for (const ParamAttrTy &ParamAttr : ParamAttrs) {
11148         switch (ParamAttr.Kind){
11149         case LinearWithVarStride:
11150           Out << 's' << ParamAttr.StrideOrArg;
11151           break;
11152         case Linear:
11153           Out << 'l';
11154           if (ParamAttr.StrideOrArg != 1)
11155             Out << ParamAttr.StrideOrArg;
11156           break;
11157         case Uniform:
11158           Out << 'u';
11159           break;
11160         case Vector:
11161           Out << 'v';
11162           break;
11163         }
11164         if (!!ParamAttr.Alignment)
11165           Out << 'a' << ParamAttr.Alignment;
11166       }
11167       Out << '_' << Fn->getName();
11168       Fn->addFnAttr(Out.str());
11169     }
11170   }
11171 }
11172 
11173 // This are the Functions that are needed to mangle the name of the
11174 // vector functions generated by the compiler, according to the rules
11175 // defined in the "Vector Function ABI specifications for AArch64",
11176 // available at
11177 // https://developer.arm.com/products/software-development-tools/hpc/arm-compiler-for-hpc/vector-function-abi.
11178 
11179 /// Maps To Vector (MTV), as defined in 3.1.1 of the AAVFABI.
11180 ///
11181 /// TODO: Need to implement the behavior for reference marked with a
11182 /// var or no linear modifiers (1.b in the section). For this, we
11183 /// need to extend ParamKindTy to support the linear modifiers.
11184 static bool getAArch64MTV(QualType QT, ParamKindTy Kind) {
11185   QT = QT.getCanonicalType();
11186 
11187   if (QT->isVoidType())
11188     return false;
11189 
11190   if (Kind == ParamKindTy::Uniform)
11191     return false;
11192 
11193   if (Kind == ParamKindTy::Linear)
11194     return false;
11195 
11196   // TODO: Handle linear references with modifiers
11197 
11198   if (Kind == ParamKindTy::LinearWithVarStride)
11199     return false;
11200 
11201   return true;
11202 }
11203 
11204 /// Pass By Value (PBV), as defined in 3.1.2 of the AAVFABI.
11205 static bool getAArch64PBV(QualType QT, ASTContext &C) {
11206   QT = QT.getCanonicalType();
11207   unsigned Size = C.getTypeSize(QT);
11208 
11209   // Only scalars and complex within 16 bytes wide set PVB to true.
11210   if (Size != 8 && Size != 16 && Size != 32 && Size != 64 && Size != 128)
11211     return false;
11212 
11213   if (QT->isFloatingType())
11214     return true;
11215 
11216   if (QT->isIntegerType())
11217     return true;
11218 
11219   if (QT->isPointerType())
11220     return true;
11221 
11222   // TODO: Add support for complex types (section 3.1.2, item 2).
11223 
11224   return false;
11225 }
11226 
11227 /// Computes the lane size (LS) of a return type or of an input parameter,
11228 /// as defined by `LS(P)` in 3.2.1 of the AAVFABI.
11229 /// TODO: Add support for references, section 3.2.1, item 1.
11230 static unsigned getAArch64LS(QualType QT, ParamKindTy Kind, ASTContext &C) {
11231   if (!getAArch64MTV(QT, Kind) && QT.getCanonicalType()->isPointerType()) {
11232     QualType PTy = QT.getCanonicalType()->getPointeeType();
11233     if (getAArch64PBV(PTy, C))
11234       return C.getTypeSize(PTy);
11235   }
11236   if (getAArch64PBV(QT, C))
11237     return C.getTypeSize(QT);
11238 
11239   return C.getTypeSize(C.getUIntPtrType());
11240 }
11241 
11242 // Get Narrowest Data Size (NDS) and Widest Data Size (WDS) from the
11243 // signature of the scalar function, as defined in 3.2.2 of the
11244 // AAVFABI.
11245 static std::tuple<unsigned, unsigned, bool>
11246 getNDSWDS(const FunctionDecl *FD, ArrayRef<ParamAttrTy> ParamAttrs) {
11247   QualType RetType = FD->getReturnType().getCanonicalType();
11248 
11249   ASTContext &C = FD->getASTContext();
11250 
11251   bool OutputBecomesInput = false;
11252 
11253   llvm::SmallVector<unsigned, 8> Sizes;
11254   if (!RetType->isVoidType()) {
11255     Sizes.push_back(getAArch64LS(RetType, ParamKindTy::Vector, C));
11256     if (!getAArch64PBV(RetType, C) && getAArch64MTV(RetType, {}))
11257       OutputBecomesInput = true;
11258   }
11259   for (unsigned I = 0, E = FD->getNumParams(); I < E; ++I) {
11260     QualType QT = FD->getParamDecl(I)->getType().getCanonicalType();
11261     Sizes.push_back(getAArch64LS(QT, ParamAttrs[I].Kind, C));
11262   }
11263 
11264   assert(!Sizes.empty() && "Unable to determine NDS and WDS.");
11265   // The LS of a function parameter / return value can only be a power
11266   // of 2, starting from 8 bits, up to 128.
11267   assert(std::all_of(Sizes.begin(), Sizes.end(),
11268                      [](unsigned Size) {
11269                        return Size == 8 || Size == 16 || Size == 32 ||
11270                               Size == 64 || Size == 128;
11271                      }) &&
11272          "Invalid size");
11273 
11274   return std::make_tuple(*std::min_element(std::begin(Sizes), std::end(Sizes)),
11275                          *std::max_element(std::begin(Sizes), std::end(Sizes)),
11276                          OutputBecomesInput);
11277 }
11278 
11279 /// Mangle the parameter part of the vector function name according to
11280 /// their OpenMP classification. The mangling function is defined in
11281 /// section 3.5 of the AAVFABI.
11282 static std::string mangleVectorParameters(ArrayRef<ParamAttrTy> ParamAttrs) {
11283   SmallString<256> Buffer;
11284   llvm::raw_svector_ostream Out(Buffer);
11285   for (const auto &ParamAttr : ParamAttrs) {
11286     switch (ParamAttr.Kind) {
11287     case LinearWithVarStride:
11288       Out << "ls" << ParamAttr.StrideOrArg;
11289       break;
11290     case Linear:
11291       Out << 'l';
11292       // Don't print the step value if it is not present or if it is
11293       // equal to 1.
11294       if (ParamAttr.StrideOrArg != 1)
11295         Out << ParamAttr.StrideOrArg;
11296       break;
11297     case Uniform:
11298       Out << 'u';
11299       break;
11300     case Vector:
11301       Out << 'v';
11302       break;
11303     }
11304 
11305     if (!!ParamAttr.Alignment)
11306       Out << 'a' << ParamAttr.Alignment;
11307   }
11308 
11309   return std::string(Out.str());
11310 }
11311 
11312 // Function used to add the attribute. The parameter `VLEN` is
11313 // templated to allow the use of "x" when targeting scalable functions
11314 // for SVE.
11315 template <typename T>
11316 static void addAArch64VectorName(T VLEN, StringRef LMask, StringRef Prefix,
11317                                  char ISA, StringRef ParSeq,
11318                                  StringRef MangledName, bool OutputBecomesInput,
11319                                  llvm::Function *Fn) {
11320   SmallString<256> Buffer;
11321   llvm::raw_svector_ostream Out(Buffer);
11322   Out << Prefix << ISA << LMask << VLEN;
11323   if (OutputBecomesInput)
11324     Out << "v";
11325   Out << ParSeq << "_" << MangledName;
11326   Fn->addFnAttr(Out.str());
11327 }
11328 
11329 // Helper function to generate the Advanced SIMD names depending on
11330 // the value of the NDS when simdlen is not present.
11331 static void addAArch64AdvSIMDNDSNames(unsigned NDS, StringRef Mask,
11332                                       StringRef Prefix, char ISA,
11333                                       StringRef ParSeq, StringRef MangledName,
11334                                       bool OutputBecomesInput,
11335                                       llvm::Function *Fn) {
11336   switch (NDS) {
11337   case 8:
11338     addAArch64VectorName(8, Mask, Prefix, ISA, ParSeq, MangledName,
11339                          OutputBecomesInput, Fn);
11340     addAArch64VectorName(16, Mask, Prefix, ISA, ParSeq, MangledName,
11341                          OutputBecomesInput, Fn);
11342     break;
11343   case 16:
11344     addAArch64VectorName(4, Mask, Prefix, ISA, ParSeq, MangledName,
11345                          OutputBecomesInput, Fn);
11346     addAArch64VectorName(8, Mask, Prefix, ISA, ParSeq, MangledName,
11347                          OutputBecomesInput, Fn);
11348     break;
11349   case 32:
11350     addAArch64VectorName(2, Mask, Prefix, ISA, ParSeq, MangledName,
11351                          OutputBecomesInput, Fn);
11352     addAArch64VectorName(4, Mask, Prefix, ISA, ParSeq, MangledName,
11353                          OutputBecomesInput, Fn);
11354     break;
11355   case 64:
11356   case 128:
11357     addAArch64VectorName(2, Mask, Prefix, ISA, ParSeq, MangledName,
11358                          OutputBecomesInput, Fn);
11359     break;
11360   default:
11361     llvm_unreachable("Scalar type is too wide.");
11362   }
11363 }
11364 
11365 /// Emit vector function attributes for AArch64, as defined in the AAVFABI.
11366 static void emitAArch64DeclareSimdFunction(
11367     CodeGenModule &CGM, const FunctionDecl *FD, unsigned UserVLEN,
11368     ArrayRef<ParamAttrTy> ParamAttrs,
11369     OMPDeclareSimdDeclAttr::BranchStateTy State, StringRef MangledName,
11370     char ISA, unsigned VecRegSize, llvm::Function *Fn, SourceLocation SLoc) {
11371 
11372   // Get basic data for building the vector signature.
11373   const auto Data = getNDSWDS(FD, ParamAttrs);
11374   const unsigned NDS = std::get<0>(Data);
11375   const unsigned WDS = std::get<1>(Data);
11376   const bool OutputBecomesInput = std::get<2>(Data);
11377 
11378   // Check the values provided via `simdlen` by the user.
11379   // 1. A `simdlen(1)` doesn't produce vector signatures,
11380   if (UserVLEN == 1) {
11381     unsigned DiagID = CGM.getDiags().getCustomDiagID(
11382         DiagnosticsEngine::Warning,
11383         "The clause simdlen(1) has no effect when targeting aarch64.");
11384     CGM.getDiags().Report(SLoc, DiagID);
11385     return;
11386   }
11387 
11388   // 2. Section 3.3.1, item 1: user input must be a power of 2 for
11389   // Advanced SIMD output.
11390   if (ISA == 'n' && UserVLEN && !llvm::isPowerOf2_32(UserVLEN)) {
11391     unsigned DiagID = CGM.getDiags().getCustomDiagID(
11392         DiagnosticsEngine::Warning, "The value specified in simdlen must be a "
11393                                     "power of 2 when targeting Advanced SIMD.");
11394     CGM.getDiags().Report(SLoc, DiagID);
11395     return;
11396   }
11397 
11398   // 3. Section 3.4.1. SVE fixed lengh must obey the architectural
11399   // limits.
11400   if (ISA == 's' && UserVLEN != 0) {
11401     if ((UserVLEN * WDS > 2048) || (UserVLEN * WDS % 128 != 0)) {
11402       unsigned DiagID = CGM.getDiags().getCustomDiagID(
11403           DiagnosticsEngine::Warning, "The clause simdlen must fit the %0-bit "
11404                                       "lanes in the architectural constraints "
11405                                       "for SVE (min is 128-bit, max is "
11406                                       "2048-bit, by steps of 128-bit)");
11407       CGM.getDiags().Report(SLoc, DiagID) << WDS;
11408       return;
11409     }
11410   }
11411 
11412   // Sort out parameter sequence.
11413   const std::string ParSeq = mangleVectorParameters(ParamAttrs);
11414   StringRef Prefix = "_ZGV";
11415   // Generate simdlen from user input (if any).
11416   if (UserVLEN) {
11417     if (ISA == 's') {
11418       // SVE generates only a masked function.
11419       addAArch64VectorName(UserVLEN, "M", Prefix, ISA, ParSeq, MangledName,
11420                            OutputBecomesInput, Fn);
11421     } else {
11422       assert(ISA == 'n' && "Expected ISA either 's' or 'n'.");
11423       // Advanced SIMD generates one or two functions, depending on
11424       // the `[not]inbranch` clause.
11425       switch (State) {
11426       case OMPDeclareSimdDeclAttr::BS_Undefined:
11427         addAArch64VectorName(UserVLEN, "N", Prefix, ISA, ParSeq, MangledName,
11428                              OutputBecomesInput, Fn);
11429         addAArch64VectorName(UserVLEN, "M", Prefix, ISA, ParSeq, MangledName,
11430                              OutputBecomesInput, Fn);
11431         break;
11432       case OMPDeclareSimdDeclAttr::BS_Notinbranch:
11433         addAArch64VectorName(UserVLEN, "N", Prefix, ISA, ParSeq, MangledName,
11434                              OutputBecomesInput, Fn);
11435         break;
11436       case OMPDeclareSimdDeclAttr::BS_Inbranch:
11437         addAArch64VectorName(UserVLEN, "M", Prefix, ISA, ParSeq, MangledName,
11438                              OutputBecomesInput, Fn);
11439         break;
11440       }
11441     }
11442   } else {
11443     // If no user simdlen is provided, follow the AAVFABI rules for
11444     // generating the vector length.
11445     if (ISA == 's') {
11446       // SVE, section 3.4.1, item 1.
11447       addAArch64VectorName("x", "M", Prefix, ISA, ParSeq, MangledName,
11448                            OutputBecomesInput, Fn);
11449     } else {
11450       assert(ISA == 'n' && "Expected ISA either 's' or 'n'.");
11451       // Advanced SIMD, Section 3.3.1 of the AAVFABI, generates one or
11452       // two vector names depending on the use of the clause
11453       // `[not]inbranch`.
11454       switch (State) {
11455       case OMPDeclareSimdDeclAttr::BS_Undefined:
11456         addAArch64AdvSIMDNDSNames(NDS, "N", Prefix, ISA, ParSeq, MangledName,
11457                                   OutputBecomesInput, Fn);
11458         addAArch64AdvSIMDNDSNames(NDS, "M", Prefix, ISA, ParSeq, MangledName,
11459                                   OutputBecomesInput, Fn);
11460         break;
11461       case OMPDeclareSimdDeclAttr::BS_Notinbranch:
11462         addAArch64AdvSIMDNDSNames(NDS, "N", Prefix, ISA, ParSeq, MangledName,
11463                                   OutputBecomesInput, Fn);
11464         break;
11465       case OMPDeclareSimdDeclAttr::BS_Inbranch:
11466         addAArch64AdvSIMDNDSNames(NDS, "M", Prefix, ISA, ParSeq, MangledName,
11467                                   OutputBecomesInput, Fn);
11468         break;
11469       }
11470     }
11471   }
11472 }
11473 
11474 void CGOpenMPRuntime::emitDeclareSimdFunction(const FunctionDecl *FD,
11475                                               llvm::Function *Fn) {
11476   ASTContext &C = CGM.getContext();
11477   FD = FD->getMostRecentDecl();
11478   // Map params to their positions in function decl.
11479   llvm::DenseMap<const Decl *, unsigned> ParamPositions;
11480   if (isa<CXXMethodDecl>(FD))
11481     ParamPositions.try_emplace(FD, 0);
11482   unsigned ParamPos = ParamPositions.size();
11483   for (const ParmVarDecl *P : FD->parameters()) {
11484     ParamPositions.try_emplace(P->getCanonicalDecl(), ParamPos);
11485     ++ParamPos;
11486   }
11487   while (FD) {
11488     for (const auto *Attr : FD->specific_attrs<OMPDeclareSimdDeclAttr>()) {
11489       llvm::SmallVector<ParamAttrTy, 8> ParamAttrs(ParamPositions.size());
11490       // Mark uniform parameters.
11491       for (const Expr *E : Attr->uniforms()) {
11492         E = E->IgnoreParenImpCasts();
11493         unsigned Pos;
11494         if (isa<CXXThisExpr>(E)) {
11495           Pos = ParamPositions[FD];
11496         } else {
11497           const auto *PVD = cast<ParmVarDecl>(cast<DeclRefExpr>(E)->getDecl())
11498                                 ->getCanonicalDecl();
11499           Pos = ParamPositions[PVD];
11500         }
11501         ParamAttrs[Pos].Kind = Uniform;
11502       }
11503       // Get alignment info.
11504       auto NI = Attr->alignments_begin();
11505       for (const Expr *E : Attr->aligneds()) {
11506         E = E->IgnoreParenImpCasts();
11507         unsigned Pos;
11508         QualType ParmTy;
11509         if (isa<CXXThisExpr>(E)) {
11510           Pos = ParamPositions[FD];
11511           ParmTy = E->getType();
11512         } else {
11513           const auto *PVD = cast<ParmVarDecl>(cast<DeclRefExpr>(E)->getDecl())
11514                                 ->getCanonicalDecl();
11515           Pos = ParamPositions[PVD];
11516           ParmTy = PVD->getType();
11517         }
11518         ParamAttrs[Pos].Alignment =
11519             (*NI)
11520                 ? (*NI)->EvaluateKnownConstInt(C)
11521                 : llvm::APSInt::getUnsigned(
11522                       C.toCharUnitsFromBits(C.getOpenMPDefaultSimdAlign(ParmTy))
11523                           .getQuantity());
11524         ++NI;
11525       }
11526       // Mark linear parameters.
11527       auto SI = Attr->steps_begin();
11528       auto MI = Attr->modifiers_begin();
11529       for (const Expr *E : Attr->linears()) {
11530         E = E->IgnoreParenImpCasts();
11531         unsigned Pos;
11532         // Rescaling factor needed to compute the linear parameter
11533         // value in the mangled name.
11534         unsigned PtrRescalingFactor = 1;
11535         if (isa<CXXThisExpr>(E)) {
11536           Pos = ParamPositions[FD];
11537         } else {
11538           const auto *PVD = cast<ParmVarDecl>(cast<DeclRefExpr>(E)->getDecl())
11539                                 ->getCanonicalDecl();
11540           Pos = ParamPositions[PVD];
11541           if (auto *P = dyn_cast<PointerType>(PVD->getType()))
11542             PtrRescalingFactor = CGM.getContext()
11543                                      .getTypeSizeInChars(P->getPointeeType())
11544                                      .getQuantity();
11545         }
11546         ParamAttrTy &ParamAttr = ParamAttrs[Pos];
11547         ParamAttr.Kind = Linear;
11548         // Assuming a stride of 1, for `linear` without modifiers.
11549         ParamAttr.StrideOrArg = llvm::APSInt::getUnsigned(1);
11550         if (*SI) {
11551           Expr::EvalResult Result;
11552           if (!(*SI)->EvaluateAsInt(Result, C, Expr::SE_AllowSideEffects)) {
11553             if (const auto *DRE =
11554                     cast<DeclRefExpr>((*SI)->IgnoreParenImpCasts())) {
11555               if (const auto *StridePVD = cast<ParmVarDecl>(DRE->getDecl())) {
11556                 ParamAttr.Kind = LinearWithVarStride;
11557                 ParamAttr.StrideOrArg = llvm::APSInt::getUnsigned(
11558                     ParamPositions[StridePVD->getCanonicalDecl()]);
11559               }
11560             }
11561           } else {
11562             ParamAttr.StrideOrArg = Result.Val.getInt();
11563           }
11564         }
11565         // If we are using a linear clause on a pointer, we need to
11566         // rescale the value of linear_step with the byte size of the
11567         // pointee type.
11568         if (Linear == ParamAttr.Kind)
11569           ParamAttr.StrideOrArg = ParamAttr.StrideOrArg * PtrRescalingFactor;
11570         ++SI;
11571         ++MI;
11572       }
11573       llvm::APSInt VLENVal;
11574       SourceLocation ExprLoc;
11575       const Expr *VLENExpr = Attr->getSimdlen();
11576       if (VLENExpr) {
11577         VLENVal = VLENExpr->EvaluateKnownConstInt(C);
11578         ExprLoc = VLENExpr->getExprLoc();
11579       }
11580       OMPDeclareSimdDeclAttr::BranchStateTy State = Attr->getBranchState();
11581       if (CGM.getTriple().isX86()) {
11582         emitX86DeclareSimdFunction(FD, Fn, VLENVal, ParamAttrs, State);
11583       } else if (CGM.getTriple().getArch() == llvm::Triple::aarch64) {
11584         unsigned VLEN = VLENVal.getExtValue();
11585         StringRef MangledName = Fn->getName();
11586         if (CGM.getTarget().hasFeature("sve"))
11587           emitAArch64DeclareSimdFunction(CGM, FD, VLEN, ParamAttrs, State,
11588                                          MangledName, 's', 128, Fn, ExprLoc);
11589         if (CGM.getTarget().hasFeature("neon"))
11590           emitAArch64DeclareSimdFunction(CGM, FD, VLEN, ParamAttrs, State,
11591                                          MangledName, 'n', 128, Fn, ExprLoc);
11592       }
11593     }
11594     FD = FD->getPreviousDecl();
11595   }
11596 }
11597 
11598 namespace {
11599 /// Cleanup action for doacross support.
11600 class DoacrossCleanupTy final : public EHScopeStack::Cleanup {
11601 public:
11602   static const int DoacrossFinArgs = 2;
11603 
11604 private:
11605   llvm::FunctionCallee RTLFn;
11606   llvm::Value *Args[DoacrossFinArgs];
11607 
11608 public:
11609   DoacrossCleanupTy(llvm::FunctionCallee RTLFn,
11610                     ArrayRef<llvm::Value *> CallArgs)
11611       : RTLFn(RTLFn) {
11612     assert(CallArgs.size() == DoacrossFinArgs);
11613     std::copy(CallArgs.begin(), CallArgs.end(), std::begin(Args));
11614   }
11615   void Emit(CodeGenFunction &CGF, Flags /*flags*/) override {
11616     if (!CGF.HaveInsertPoint())
11617       return;
11618     CGF.EmitRuntimeCall(RTLFn, Args);
11619   }
11620 };
11621 } // namespace
11622 
11623 void CGOpenMPRuntime::emitDoacrossInit(CodeGenFunction &CGF,
11624                                        const OMPLoopDirective &D,
11625                                        ArrayRef<Expr *> NumIterations) {
11626   if (!CGF.HaveInsertPoint())
11627     return;
11628 
11629   ASTContext &C = CGM.getContext();
11630   QualType Int64Ty = C.getIntTypeForBitwidth(/*DestWidth=*/64, /*Signed=*/true);
11631   RecordDecl *RD;
11632   if (KmpDimTy.isNull()) {
11633     // Build struct kmp_dim {  // loop bounds info casted to kmp_int64
11634     //  kmp_int64 lo; // lower
11635     //  kmp_int64 up; // upper
11636     //  kmp_int64 st; // stride
11637     // };
11638     RD = C.buildImplicitRecord("kmp_dim");
11639     RD->startDefinition();
11640     addFieldToRecordDecl(C, RD, Int64Ty);
11641     addFieldToRecordDecl(C, RD, Int64Ty);
11642     addFieldToRecordDecl(C, RD, Int64Ty);
11643     RD->completeDefinition();
11644     KmpDimTy = C.getRecordType(RD);
11645   } else {
11646     RD = cast<RecordDecl>(KmpDimTy->getAsTagDecl());
11647   }
11648   llvm::APInt Size(/*numBits=*/32, NumIterations.size());
11649   QualType ArrayTy =
11650       C.getConstantArrayType(KmpDimTy, Size, nullptr, ArrayType::Normal, 0);
11651 
11652   Address DimsAddr = CGF.CreateMemTemp(ArrayTy, "dims");
11653   CGF.EmitNullInitialization(DimsAddr, ArrayTy);
11654   enum { LowerFD = 0, UpperFD, StrideFD };
11655   // Fill dims with data.
11656   for (unsigned I = 0, E = NumIterations.size(); I < E; ++I) {
11657     LValue DimsLVal = CGF.MakeAddrLValue(
11658         CGF.Builder.CreateConstArrayGEP(DimsAddr, I), KmpDimTy);
11659     // dims.upper = num_iterations;
11660     LValue UpperLVal = CGF.EmitLValueForField(
11661         DimsLVal, *std::next(RD->field_begin(), UpperFD));
11662     llvm::Value *NumIterVal = CGF.EmitScalarConversion(
11663         CGF.EmitScalarExpr(NumIterations[I]), NumIterations[I]->getType(),
11664         Int64Ty, NumIterations[I]->getExprLoc());
11665     CGF.EmitStoreOfScalar(NumIterVal, UpperLVal);
11666     // dims.stride = 1;
11667     LValue StrideLVal = CGF.EmitLValueForField(
11668         DimsLVal, *std::next(RD->field_begin(), StrideFD));
11669     CGF.EmitStoreOfScalar(llvm::ConstantInt::getSigned(CGM.Int64Ty, /*V=*/1),
11670                           StrideLVal);
11671   }
11672 
11673   // Build call void __kmpc_doacross_init(ident_t *loc, kmp_int32 gtid,
11674   // kmp_int32 num_dims, struct kmp_dim * dims);
11675   llvm::Value *Args[] = {
11676       emitUpdateLocation(CGF, D.getBeginLoc()),
11677       getThreadID(CGF, D.getBeginLoc()),
11678       llvm::ConstantInt::getSigned(CGM.Int32Ty, NumIterations.size()),
11679       CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
11680           CGF.Builder.CreateConstArrayGEP(DimsAddr, 0).getPointer(),
11681           CGM.VoidPtrTy)};
11682 
11683   llvm::FunctionCallee RTLFn = OMPBuilder.getOrCreateRuntimeFunction(
11684       CGM.getModule(), OMPRTL___kmpc_doacross_init);
11685   CGF.EmitRuntimeCall(RTLFn, Args);
11686   llvm::Value *FiniArgs[DoacrossCleanupTy::DoacrossFinArgs] = {
11687       emitUpdateLocation(CGF, D.getEndLoc()), getThreadID(CGF, D.getEndLoc())};
11688   llvm::FunctionCallee FiniRTLFn = OMPBuilder.getOrCreateRuntimeFunction(
11689       CGM.getModule(), OMPRTL___kmpc_doacross_fini);
11690   CGF.EHStack.pushCleanup<DoacrossCleanupTy>(NormalAndEHCleanup, FiniRTLFn,
11691                                              llvm::makeArrayRef(FiniArgs));
11692 }
11693 
11694 void CGOpenMPRuntime::emitDoacrossOrdered(CodeGenFunction &CGF,
11695                                           const OMPDependClause *C) {
11696   QualType Int64Ty =
11697       CGM.getContext().getIntTypeForBitwidth(/*DestWidth=*/64, /*Signed=*/1);
11698   llvm::APInt Size(/*numBits=*/32, C->getNumLoops());
11699   QualType ArrayTy = CGM.getContext().getConstantArrayType(
11700       Int64Ty, Size, nullptr, ArrayType::Normal, 0);
11701   Address CntAddr = CGF.CreateMemTemp(ArrayTy, ".cnt.addr");
11702   for (unsigned I = 0, E = C->getNumLoops(); I < E; ++I) {
11703     const Expr *CounterVal = C->getLoopData(I);
11704     assert(CounterVal);
11705     llvm::Value *CntVal = CGF.EmitScalarConversion(
11706         CGF.EmitScalarExpr(CounterVal), CounterVal->getType(), Int64Ty,
11707         CounterVal->getExprLoc());
11708     CGF.EmitStoreOfScalar(CntVal, CGF.Builder.CreateConstArrayGEP(CntAddr, I),
11709                           /*Volatile=*/false, Int64Ty);
11710   }
11711   llvm::Value *Args[] = {
11712       emitUpdateLocation(CGF, C->getBeginLoc()),
11713       getThreadID(CGF, C->getBeginLoc()),
11714       CGF.Builder.CreateConstArrayGEP(CntAddr, 0).getPointer()};
11715   llvm::FunctionCallee RTLFn;
11716   if (C->getDependencyKind() == OMPC_DEPEND_source) {
11717     RTLFn = OMPBuilder.getOrCreateRuntimeFunction(CGM.getModule(),
11718                                                   OMPRTL___kmpc_doacross_post);
11719   } else {
11720     assert(C->getDependencyKind() == OMPC_DEPEND_sink);
11721     RTLFn = OMPBuilder.getOrCreateRuntimeFunction(CGM.getModule(),
11722                                                   OMPRTL___kmpc_doacross_wait);
11723   }
11724   CGF.EmitRuntimeCall(RTLFn, Args);
11725 }
11726 
11727 void CGOpenMPRuntime::emitCall(CodeGenFunction &CGF, SourceLocation Loc,
11728                                llvm::FunctionCallee Callee,
11729                                ArrayRef<llvm::Value *> Args) const {
11730   assert(Loc.isValid() && "Outlined function call location must be valid.");
11731   auto DL = ApplyDebugLocation::CreateDefaultArtificial(CGF, Loc);
11732 
11733   if (auto *Fn = dyn_cast<llvm::Function>(Callee.getCallee())) {
11734     if (Fn->doesNotThrow()) {
11735       CGF.EmitNounwindRuntimeCall(Fn, Args);
11736       return;
11737     }
11738   }
11739   CGF.EmitRuntimeCall(Callee, Args);
11740 }
11741 
11742 void CGOpenMPRuntime::emitOutlinedFunctionCall(
11743     CodeGenFunction &CGF, SourceLocation Loc, llvm::FunctionCallee OutlinedFn,
11744     ArrayRef<llvm::Value *> Args) const {
11745   emitCall(CGF, Loc, OutlinedFn, Args);
11746 }
11747 
11748 void CGOpenMPRuntime::emitFunctionProlog(CodeGenFunction &CGF, const Decl *D) {
11749   if (const auto *FD = dyn_cast<FunctionDecl>(D))
11750     if (OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(FD))
11751       HasEmittedDeclareTargetRegion = true;
11752 }
11753 
11754 Address CGOpenMPRuntime::getParameterAddress(CodeGenFunction &CGF,
11755                                              const VarDecl *NativeParam,
11756                                              const VarDecl *TargetParam) const {
11757   return CGF.GetAddrOfLocalVar(NativeParam);
11758 }
11759 
11760 Address CGOpenMPRuntime::getAddressOfLocalVariable(CodeGenFunction &CGF,
11761                                                    const VarDecl *VD) {
11762   if (!VD)
11763     return Address::invalid();
11764   Address UntiedAddr = Address::invalid();
11765   Address UntiedRealAddr = Address::invalid();
11766   auto It = FunctionToUntiedTaskStackMap.find(CGF.CurFn);
11767   if (It != FunctionToUntiedTaskStackMap.end()) {
11768     const UntiedLocalVarsAddressesMap &UntiedData =
11769         UntiedLocalVarsStack[It->second];
11770     auto I = UntiedData.find(VD);
11771     if (I != UntiedData.end()) {
11772       UntiedAddr = I->second.first;
11773       UntiedRealAddr = I->second.second;
11774     }
11775   }
11776   const VarDecl *CVD = VD->getCanonicalDecl();
11777   if (CVD->hasAttr<OMPAllocateDeclAttr>()) {
11778     // Use the default allocation.
11779     if (!isAllocatableDecl(VD))
11780       return UntiedAddr;
11781     llvm::Value *Size;
11782     CharUnits Align = CGM.getContext().getDeclAlign(CVD);
11783     if (CVD->getType()->isVariablyModifiedType()) {
11784       Size = CGF.getTypeSize(CVD->getType());
11785       // Align the size: ((size + align - 1) / align) * align
11786       Size = CGF.Builder.CreateNUWAdd(
11787           Size, CGM.getSize(Align - CharUnits::fromQuantity(1)));
11788       Size = CGF.Builder.CreateUDiv(Size, CGM.getSize(Align));
11789       Size = CGF.Builder.CreateNUWMul(Size, CGM.getSize(Align));
11790     } else {
11791       CharUnits Sz = CGM.getContext().getTypeSizeInChars(CVD->getType());
11792       Size = CGM.getSize(Sz.alignTo(Align));
11793     }
11794     llvm::Value *ThreadID = getThreadID(CGF, CVD->getBeginLoc());
11795     const auto *AA = CVD->getAttr<OMPAllocateDeclAttr>();
11796     assert(AA->getAllocator() &&
11797            "Expected allocator expression for non-default allocator.");
11798     llvm::Value *Allocator = CGF.EmitScalarExpr(AA->getAllocator());
11799     // According to the standard, the original allocator type is a enum
11800     // (integer). Convert to pointer type, if required.
11801     Allocator = CGF.EmitScalarConversion(
11802         Allocator, AA->getAllocator()->getType(), CGF.getContext().VoidPtrTy,
11803         AA->getAllocator()->getExprLoc());
11804     llvm::Value *Args[] = {ThreadID, Size, Allocator};
11805 
11806     llvm::Value *Addr =
11807         CGF.EmitRuntimeCall(OMPBuilder.getOrCreateRuntimeFunction(
11808                                 CGM.getModule(), OMPRTL___kmpc_alloc),
11809                             Args, getName({CVD->getName(), ".void.addr"}));
11810     llvm::FunctionCallee FiniRTLFn = OMPBuilder.getOrCreateRuntimeFunction(
11811         CGM.getModule(), OMPRTL___kmpc_free);
11812     QualType Ty = CGM.getContext().getPointerType(CVD->getType());
11813     Addr = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
11814         Addr, CGF.ConvertTypeForMem(Ty), getName({CVD->getName(), ".addr"}));
11815     if (UntiedAddr.isValid())
11816       CGF.EmitStoreOfScalar(Addr, UntiedAddr, /*Volatile=*/false, Ty);
11817 
11818     // Cleanup action for allocate support.
11819     class OMPAllocateCleanupTy final : public EHScopeStack::Cleanup {
11820       llvm::FunctionCallee RTLFn;
11821       unsigned LocEncoding;
11822       Address Addr;
11823       const Expr *Allocator;
11824 
11825     public:
11826       OMPAllocateCleanupTy(llvm::FunctionCallee RTLFn, unsigned LocEncoding,
11827                            Address Addr, const Expr *Allocator)
11828           : RTLFn(RTLFn), LocEncoding(LocEncoding), Addr(Addr),
11829             Allocator(Allocator) {}
11830       void Emit(CodeGenFunction &CGF, Flags /*flags*/) override {
11831         if (!CGF.HaveInsertPoint())
11832           return;
11833         llvm::Value *Args[3];
11834         Args[0] = CGF.CGM.getOpenMPRuntime().getThreadID(
11835             CGF, SourceLocation::getFromRawEncoding(LocEncoding));
11836         Args[1] = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
11837             Addr.getPointer(), CGF.VoidPtrTy);
11838         llvm::Value *AllocVal = CGF.EmitScalarExpr(Allocator);
11839         // According to the standard, the original allocator type is a enum
11840         // (integer). Convert to pointer type, if required.
11841         AllocVal = CGF.EmitScalarConversion(AllocVal, Allocator->getType(),
11842                                             CGF.getContext().VoidPtrTy,
11843                                             Allocator->getExprLoc());
11844         Args[2] = AllocVal;
11845 
11846         CGF.EmitRuntimeCall(RTLFn, Args);
11847       }
11848     };
11849     Address VDAddr =
11850         UntiedRealAddr.isValid() ? UntiedRealAddr : Address(Addr, Align);
11851     CGF.EHStack.pushCleanup<OMPAllocateCleanupTy>(
11852         NormalAndEHCleanup, FiniRTLFn, CVD->getLocation().getRawEncoding(),
11853         VDAddr, AA->getAllocator());
11854     if (UntiedRealAddr.isValid())
11855       if (auto *Region =
11856               dyn_cast_or_null<CGOpenMPRegionInfo>(CGF.CapturedStmtInfo))
11857         Region->emitUntiedSwitch(CGF);
11858     return VDAddr;
11859   }
11860   return UntiedAddr;
11861 }
11862 
11863 bool CGOpenMPRuntime::isLocalVarInUntiedTask(CodeGenFunction &CGF,
11864                                              const VarDecl *VD) const {
11865   auto It = FunctionToUntiedTaskStackMap.find(CGF.CurFn);
11866   if (It == FunctionToUntiedTaskStackMap.end())
11867     return false;
11868   return UntiedLocalVarsStack[It->second].count(VD) > 0;
11869 }
11870 
11871 CGOpenMPRuntime::NontemporalDeclsRAII::NontemporalDeclsRAII(
11872     CodeGenModule &CGM, const OMPLoopDirective &S)
11873     : CGM(CGM), NeedToPush(S.hasClausesOfKind<OMPNontemporalClause>()) {
11874   assert(CGM.getLangOpts().OpenMP && "Not in OpenMP mode.");
11875   if (!NeedToPush)
11876     return;
11877   NontemporalDeclsSet &DS =
11878       CGM.getOpenMPRuntime().NontemporalDeclsStack.emplace_back();
11879   for (const auto *C : S.getClausesOfKind<OMPNontemporalClause>()) {
11880     for (const Stmt *Ref : C->private_refs()) {
11881       const auto *SimpleRefExpr = cast<Expr>(Ref)->IgnoreParenImpCasts();
11882       const ValueDecl *VD;
11883       if (const auto *DRE = dyn_cast<DeclRefExpr>(SimpleRefExpr)) {
11884         VD = DRE->getDecl();
11885       } else {
11886         const auto *ME = cast<MemberExpr>(SimpleRefExpr);
11887         assert((ME->isImplicitCXXThis() ||
11888                 isa<CXXThisExpr>(ME->getBase()->IgnoreParenImpCasts())) &&
11889                "Expected member of current class.");
11890         VD = ME->getMemberDecl();
11891       }
11892       DS.insert(VD);
11893     }
11894   }
11895 }
11896 
11897 CGOpenMPRuntime::NontemporalDeclsRAII::~NontemporalDeclsRAII() {
11898   if (!NeedToPush)
11899     return;
11900   CGM.getOpenMPRuntime().NontemporalDeclsStack.pop_back();
11901 }
11902 
11903 CGOpenMPRuntime::UntiedTaskLocalDeclsRAII::UntiedTaskLocalDeclsRAII(
11904     CodeGenFunction &CGF,
11905     const llvm::DenseMap<CanonicalDeclPtr<const VarDecl>,
11906                          std::pair<Address, Address>> &LocalVars)
11907     : CGM(CGF.CGM), NeedToPush(!LocalVars.empty()) {
11908   if (!NeedToPush)
11909     return;
11910   CGM.getOpenMPRuntime().FunctionToUntiedTaskStackMap.try_emplace(
11911       CGF.CurFn, CGM.getOpenMPRuntime().UntiedLocalVarsStack.size());
11912   CGM.getOpenMPRuntime().UntiedLocalVarsStack.push_back(LocalVars);
11913 }
11914 
11915 CGOpenMPRuntime::UntiedTaskLocalDeclsRAII::~UntiedTaskLocalDeclsRAII() {
11916   if (!NeedToPush)
11917     return;
11918   CGM.getOpenMPRuntime().UntiedLocalVarsStack.pop_back();
11919 }
11920 
11921 bool CGOpenMPRuntime::isNontemporalDecl(const ValueDecl *VD) const {
11922   assert(CGM.getLangOpts().OpenMP && "Not in OpenMP mode.");
11923 
11924   return llvm::any_of(
11925       CGM.getOpenMPRuntime().NontemporalDeclsStack,
11926       [VD](const NontemporalDeclsSet &Set) { return Set.count(VD) > 0; });
11927 }
11928 
11929 void CGOpenMPRuntime::LastprivateConditionalRAII::tryToDisableInnerAnalysis(
11930     const OMPExecutableDirective &S,
11931     llvm::DenseSet<CanonicalDeclPtr<const Decl>> &NeedToAddForLPCsAsDisabled)
11932     const {
11933   llvm::DenseSet<CanonicalDeclPtr<const Decl>> NeedToCheckForLPCs;
11934   // Vars in target/task regions must be excluded completely.
11935   if (isOpenMPTargetExecutionDirective(S.getDirectiveKind()) ||
11936       isOpenMPTaskingDirective(S.getDirectiveKind())) {
11937     SmallVector<OpenMPDirectiveKind, 4> CaptureRegions;
11938     getOpenMPCaptureRegions(CaptureRegions, S.getDirectiveKind());
11939     const CapturedStmt *CS = S.getCapturedStmt(CaptureRegions.front());
11940     for (const CapturedStmt::Capture &Cap : CS->captures()) {
11941       if (Cap.capturesVariable() || Cap.capturesVariableByCopy())
11942         NeedToCheckForLPCs.insert(Cap.getCapturedVar());
11943     }
11944   }
11945   // Exclude vars in private clauses.
11946   for (const auto *C : S.getClausesOfKind<OMPPrivateClause>()) {
11947     for (const Expr *Ref : C->varlists()) {
11948       if (!Ref->getType()->isScalarType())
11949         continue;
11950       const auto *DRE = dyn_cast<DeclRefExpr>(Ref->IgnoreParenImpCasts());
11951       if (!DRE)
11952         continue;
11953       NeedToCheckForLPCs.insert(DRE->getDecl());
11954     }
11955   }
11956   for (const auto *C : S.getClausesOfKind<OMPFirstprivateClause>()) {
11957     for (const Expr *Ref : C->varlists()) {
11958       if (!Ref->getType()->isScalarType())
11959         continue;
11960       const auto *DRE = dyn_cast<DeclRefExpr>(Ref->IgnoreParenImpCasts());
11961       if (!DRE)
11962         continue;
11963       NeedToCheckForLPCs.insert(DRE->getDecl());
11964     }
11965   }
11966   for (const auto *C : S.getClausesOfKind<OMPLastprivateClause>()) {
11967     for (const Expr *Ref : C->varlists()) {
11968       if (!Ref->getType()->isScalarType())
11969         continue;
11970       const auto *DRE = dyn_cast<DeclRefExpr>(Ref->IgnoreParenImpCasts());
11971       if (!DRE)
11972         continue;
11973       NeedToCheckForLPCs.insert(DRE->getDecl());
11974     }
11975   }
11976   for (const auto *C : S.getClausesOfKind<OMPReductionClause>()) {
11977     for (const Expr *Ref : C->varlists()) {
11978       if (!Ref->getType()->isScalarType())
11979         continue;
11980       const auto *DRE = dyn_cast<DeclRefExpr>(Ref->IgnoreParenImpCasts());
11981       if (!DRE)
11982         continue;
11983       NeedToCheckForLPCs.insert(DRE->getDecl());
11984     }
11985   }
11986   for (const auto *C : S.getClausesOfKind<OMPLinearClause>()) {
11987     for (const Expr *Ref : C->varlists()) {
11988       if (!Ref->getType()->isScalarType())
11989         continue;
11990       const auto *DRE = dyn_cast<DeclRefExpr>(Ref->IgnoreParenImpCasts());
11991       if (!DRE)
11992         continue;
11993       NeedToCheckForLPCs.insert(DRE->getDecl());
11994     }
11995   }
11996   for (const Decl *VD : NeedToCheckForLPCs) {
11997     for (const LastprivateConditionalData &Data :
11998          llvm::reverse(CGM.getOpenMPRuntime().LastprivateConditionalStack)) {
11999       if (Data.DeclToUniqueName.count(VD) > 0) {
12000         if (!Data.Disabled)
12001           NeedToAddForLPCsAsDisabled.insert(VD);
12002         break;
12003       }
12004     }
12005   }
12006 }
12007 
12008 CGOpenMPRuntime::LastprivateConditionalRAII::LastprivateConditionalRAII(
12009     CodeGenFunction &CGF, const OMPExecutableDirective &S, LValue IVLVal)
12010     : CGM(CGF.CGM),
12011       Action((CGM.getLangOpts().OpenMP >= 50 &&
12012               llvm::any_of(S.getClausesOfKind<OMPLastprivateClause>(),
12013                            [](const OMPLastprivateClause *C) {
12014                              return C->getKind() ==
12015                                     OMPC_LASTPRIVATE_conditional;
12016                            }))
12017                  ? ActionToDo::PushAsLastprivateConditional
12018                  : ActionToDo::DoNotPush) {
12019   assert(CGM.getLangOpts().OpenMP && "Not in OpenMP mode.");
12020   if (CGM.getLangOpts().OpenMP < 50 || Action == ActionToDo::DoNotPush)
12021     return;
12022   assert(Action == ActionToDo::PushAsLastprivateConditional &&
12023          "Expected a push action.");
12024   LastprivateConditionalData &Data =
12025       CGM.getOpenMPRuntime().LastprivateConditionalStack.emplace_back();
12026   for (const auto *C : S.getClausesOfKind<OMPLastprivateClause>()) {
12027     if (C->getKind() != OMPC_LASTPRIVATE_conditional)
12028       continue;
12029 
12030     for (const Expr *Ref : C->varlists()) {
12031       Data.DeclToUniqueName.insert(std::make_pair(
12032           cast<DeclRefExpr>(Ref->IgnoreParenImpCasts())->getDecl(),
12033           SmallString<16>(generateUniqueName(CGM, "pl_cond", Ref))));
12034     }
12035   }
12036   Data.IVLVal = IVLVal;
12037   Data.Fn = CGF.CurFn;
12038 }
12039 
12040 CGOpenMPRuntime::LastprivateConditionalRAII::LastprivateConditionalRAII(
12041     CodeGenFunction &CGF, const OMPExecutableDirective &S)
12042     : CGM(CGF.CGM), Action(ActionToDo::DoNotPush) {
12043   assert(CGM.getLangOpts().OpenMP && "Not in OpenMP mode.");
12044   if (CGM.getLangOpts().OpenMP < 50)
12045     return;
12046   llvm::DenseSet<CanonicalDeclPtr<const Decl>> NeedToAddForLPCsAsDisabled;
12047   tryToDisableInnerAnalysis(S, NeedToAddForLPCsAsDisabled);
12048   if (!NeedToAddForLPCsAsDisabled.empty()) {
12049     Action = ActionToDo::DisableLastprivateConditional;
12050     LastprivateConditionalData &Data =
12051         CGM.getOpenMPRuntime().LastprivateConditionalStack.emplace_back();
12052     for (const Decl *VD : NeedToAddForLPCsAsDisabled)
12053       Data.DeclToUniqueName.insert(std::make_pair(VD, SmallString<16>()));
12054     Data.Fn = CGF.CurFn;
12055     Data.Disabled = true;
12056   }
12057 }
12058 
12059 CGOpenMPRuntime::LastprivateConditionalRAII
12060 CGOpenMPRuntime::LastprivateConditionalRAII::disable(
12061     CodeGenFunction &CGF, const OMPExecutableDirective &S) {
12062   return LastprivateConditionalRAII(CGF, S);
12063 }
12064 
12065 CGOpenMPRuntime::LastprivateConditionalRAII::~LastprivateConditionalRAII() {
12066   if (CGM.getLangOpts().OpenMP < 50)
12067     return;
12068   if (Action == ActionToDo::DisableLastprivateConditional) {
12069     assert(CGM.getOpenMPRuntime().LastprivateConditionalStack.back().Disabled &&
12070            "Expected list of disabled private vars.");
12071     CGM.getOpenMPRuntime().LastprivateConditionalStack.pop_back();
12072   }
12073   if (Action == ActionToDo::PushAsLastprivateConditional) {
12074     assert(
12075         !CGM.getOpenMPRuntime().LastprivateConditionalStack.back().Disabled &&
12076         "Expected list of lastprivate conditional vars.");
12077     CGM.getOpenMPRuntime().LastprivateConditionalStack.pop_back();
12078   }
12079 }
12080 
12081 Address CGOpenMPRuntime::emitLastprivateConditionalInit(CodeGenFunction &CGF,
12082                                                         const VarDecl *VD) {
12083   ASTContext &C = CGM.getContext();
12084   auto I = LastprivateConditionalToTypes.find(CGF.CurFn);
12085   if (I == LastprivateConditionalToTypes.end())
12086     I = LastprivateConditionalToTypes.try_emplace(CGF.CurFn).first;
12087   QualType NewType;
12088   const FieldDecl *VDField;
12089   const FieldDecl *FiredField;
12090   LValue BaseLVal;
12091   auto VI = I->getSecond().find(VD);
12092   if (VI == I->getSecond().end()) {
12093     RecordDecl *RD = C.buildImplicitRecord("lasprivate.conditional");
12094     RD->startDefinition();
12095     VDField = addFieldToRecordDecl(C, RD, VD->getType().getNonReferenceType());
12096     FiredField = addFieldToRecordDecl(C, RD, C.CharTy);
12097     RD->completeDefinition();
12098     NewType = C.getRecordType(RD);
12099     Address Addr = CGF.CreateMemTemp(NewType, C.getDeclAlign(VD), VD->getName());
12100     BaseLVal = CGF.MakeAddrLValue(Addr, NewType, AlignmentSource::Decl);
12101     I->getSecond().try_emplace(VD, NewType, VDField, FiredField, BaseLVal);
12102   } else {
12103     NewType = std::get<0>(VI->getSecond());
12104     VDField = std::get<1>(VI->getSecond());
12105     FiredField = std::get<2>(VI->getSecond());
12106     BaseLVal = std::get<3>(VI->getSecond());
12107   }
12108   LValue FiredLVal =
12109       CGF.EmitLValueForField(BaseLVal, FiredField);
12110   CGF.EmitStoreOfScalar(
12111       llvm::ConstantInt::getNullValue(CGF.ConvertTypeForMem(C.CharTy)),
12112       FiredLVal);
12113   return CGF.EmitLValueForField(BaseLVal, VDField).getAddress(CGF);
12114 }
12115 
12116 namespace {
12117 /// Checks if the lastprivate conditional variable is referenced in LHS.
12118 class LastprivateConditionalRefChecker final
12119     : public ConstStmtVisitor<LastprivateConditionalRefChecker, bool> {
12120   ArrayRef<CGOpenMPRuntime::LastprivateConditionalData> LPM;
12121   const Expr *FoundE = nullptr;
12122   const Decl *FoundD = nullptr;
12123   StringRef UniqueDeclName;
12124   LValue IVLVal;
12125   llvm::Function *FoundFn = nullptr;
12126   SourceLocation Loc;
12127 
12128 public:
12129   bool VisitDeclRefExpr(const DeclRefExpr *E) {
12130     for (const CGOpenMPRuntime::LastprivateConditionalData &D :
12131          llvm::reverse(LPM)) {
12132       auto It = D.DeclToUniqueName.find(E->getDecl());
12133       if (It == D.DeclToUniqueName.end())
12134         continue;
12135       if (D.Disabled)
12136         return false;
12137       FoundE = E;
12138       FoundD = E->getDecl()->getCanonicalDecl();
12139       UniqueDeclName = It->second;
12140       IVLVal = D.IVLVal;
12141       FoundFn = D.Fn;
12142       break;
12143     }
12144     return FoundE == E;
12145   }
12146   bool VisitMemberExpr(const MemberExpr *E) {
12147     if (!CodeGenFunction::IsWrappedCXXThis(E->getBase()))
12148       return false;
12149     for (const CGOpenMPRuntime::LastprivateConditionalData &D :
12150          llvm::reverse(LPM)) {
12151       auto It = D.DeclToUniqueName.find(E->getMemberDecl());
12152       if (It == D.DeclToUniqueName.end())
12153         continue;
12154       if (D.Disabled)
12155         return false;
12156       FoundE = E;
12157       FoundD = E->getMemberDecl()->getCanonicalDecl();
12158       UniqueDeclName = It->second;
12159       IVLVal = D.IVLVal;
12160       FoundFn = D.Fn;
12161       break;
12162     }
12163     return FoundE == E;
12164   }
12165   bool VisitStmt(const Stmt *S) {
12166     for (const Stmt *Child : S->children()) {
12167       if (!Child)
12168         continue;
12169       if (const auto *E = dyn_cast<Expr>(Child))
12170         if (!E->isGLValue())
12171           continue;
12172       if (Visit(Child))
12173         return true;
12174     }
12175     return false;
12176   }
12177   explicit LastprivateConditionalRefChecker(
12178       ArrayRef<CGOpenMPRuntime::LastprivateConditionalData> LPM)
12179       : LPM(LPM) {}
12180   std::tuple<const Expr *, const Decl *, StringRef, LValue, llvm::Function *>
12181   getFoundData() const {
12182     return std::make_tuple(FoundE, FoundD, UniqueDeclName, IVLVal, FoundFn);
12183   }
12184 };
12185 } // namespace
12186 
12187 void CGOpenMPRuntime::emitLastprivateConditionalUpdate(CodeGenFunction &CGF,
12188                                                        LValue IVLVal,
12189                                                        StringRef UniqueDeclName,
12190                                                        LValue LVal,
12191                                                        SourceLocation Loc) {
12192   // Last updated loop counter for the lastprivate conditional var.
12193   // int<xx> last_iv = 0;
12194   llvm::Type *LLIVTy = CGF.ConvertTypeForMem(IVLVal.getType());
12195   llvm::Constant *LastIV =
12196       getOrCreateInternalVariable(LLIVTy, getName({UniqueDeclName, "iv"}));
12197   cast<llvm::GlobalVariable>(LastIV)->setAlignment(
12198       IVLVal.getAlignment().getAsAlign());
12199   LValue LastIVLVal = CGF.MakeNaturalAlignAddrLValue(LastIV, IVLVal.getType());
12200 
12201   // Last value of the lastprivate conditional.
12202   // decltype(priv_a) last_a;
12203   llvm::Constant *Last = getOrCreateInternalVariable(
12204       CGF.ConvertTypeForMem(LVal.getType()), UniqueDeclName);
12205   cast<llvm::GlobalVariable>(Last)->setAlignment(
12206       LVal.getAlignment().getAsAlign());
12207   LValue LastLVal =
12208       CGF.MakeAddrLValue(Last, LVal.getType(), LVal.getAlignment());
12209 
12210   // Global loop counter. Required to handle inner parallel-for regions.
12211   // iv
12212   llvm::Value *IVVal = CGF.EmitLoadOfScalar(IVLVal, Loc);
12213 
12214   // #pragma omp critical(a)
12215   // if (last_iv <= iv) {
12216   //   last_iv = iv;
12217   //   last_a = priv_a;
12218   // }
12219   auto &&CodeGen = [&LastIVLVal, &IVLVal, IVVal, &LVal, &LastLVal,
12220                     Loc](CodeGenFunction &CGF, PrePostActionTy &Action) {
12221     Action.Enter(CGF);
12222     llvm::Value *LastIVVal = CGF.EmitLoadOfScalar(LastIVLVal, Loc);
12223     // (last_iv <= iv) ? Check if the variable is updated and store new
12224     // value in global var.
12225     llvm::Value *CmpRes;
12226     if (IVLVal.getType()->isSignedIntegerType()) {
12227       CmpRes = CGF.Builder.CreateICmpSLE(LastIVVal, IVVal);
12228     } else {
12229       assert(IVLVal.getType()->isUnsignedIntegerType() &&
12230              "Loop iteration variable must be integer.");
12231       CmpRes = CGF.Builder.CreateICmpULE(LastIVVal, IVVal);
12232     }
12233     llvm::BasicBlock *ThenBB = CGF.createBasicBlock("lp_cond_then");
12234     llvm::BasicBlock *ExitBB = CGF.createBasicBlock("lp_cond_exit");
12235     CGF.Builder.CreateCondBr(CmpRes, ThenBB, ExitBB);
12236     // {
12237     CGF.EmitBlock(ThenBB);
12238 
12239     //   last_iv = iv;
12240     CGF.EmitStoreOfScalar(IVVal, LastIVLVal);
12241 
12242     //   last_a = priv_a;
12243     switch (CGF.getEvaluationKind(LVal.getType())) {
12244     case TEK_Scalar: {
12245       llvm::Value *PrivVal = CGF.EmitLoadOfScalar(LVal, Loc);
12246       CGF.EmitStoreOfScalar(PrivVal, LastLVal);
12247       break;
12248     }
12249     case TEK_Complex: {
12250       CodeGenFunction::ComplexPairTy PrivVal = CGF.EmitLoadOfComplex(LVal, Loc);
12251       CGF.EmitStoreOfComplex(PrivVal, LastLVal, /*isInit=*/false);
12252       break;
12253     }
12254     case TEK_Aggregate:
12255       llvm_unreachable(
12256           "Aggregates are not supported in lastprivate conditional.");
12257     }
12258     // }
12259     CGF.EmitBranch(ExitBB);
12260     // There is no need to emit line number for unconditional branch.
12261     (void)ApplyDebugLocation::CreateEmpty(CGF);
12262     CGF.EmitBlock(ExitBB, /*IsFinished=*/true);
12263   };
12264 
12265   if (CGM.getLangOpts().OpenMPSimd) {
12266     // Do not emit as a critical region as no parallel region could be emitted.
12267     RegionCodeGenTy ThenRCG(CodeGen);
12268     ThenRCG(CGF);
12269   } else {
12270     emitCriticalRegion(CGF, UniqueDeclName, CodeGen, Loc);
12271   }
12272 }
12273 
12274 void CGOpenMPRuntime::checkAndEmitLastprivateConditional(CodeGenFunction &CGF,
12275                                                          const Expr *LHS) {
12276   if (CGF.getLangOpts().OpenMP < 50 || LastprivateConditionalStack.empty())
12277     return;
12278   LastprivateConditionalRefChecker Checker(LastprivateConditionalStack);
12279   if (!Checker.Visit(LHS))
12280     return;
12281   const Expr *FoundE;
12282   const Decl *FoundD;
12283   StringRef UniqueDeclName;
12284   LValue IVLVal;
12285   llvm::Function *FoundFn;
12286   std::tie(FoundE, FoundD, UniqueDeclName, IVLVal, FoundFn) =
12287       Checker.getFoundData();
12288   if (FoundFn != CGF.CurFn) {
12289     // Special codegen for inner parallel regions.
12290     // ((struct.lastprivate.conditional*)&priv_a)->Fired = 1;
12291     auto It = LastprivateConditionalToTypes[FoundFn].find(FoundD);
12292     assert(It != LastprivateConditionalToTypes[FoundFn].end() &&
12293            "Lastprivate conditional is not found in outer region.");
12294     QualType StructTy = std::get<0>(It->getSecond());
12295     const FieldDecl* FiredDecl = std::get<2>(It->getSecond());
12296     LValue PrivLVal = CGF.EmitLValue(FoundE);
12297     Address StructAddr = CGF.Builder.CreatePointerBitCastOrAddrSpaceCast(
12298         PrivLVal.getAddress(CGF),
12299         CGF.ConvertTypeForMem(CGF.getContext().getPointerType(StructTy)));
12300     LValue BaseLVal =
12301         CGF.MakeAddrLValue(StructAddr, StructTy, AlignmentSource::Decl);
12302     LValue FiredLVal = CGF.EmitLValueForField(BaseLVal, FiredDecl);
12303     CGF.EmitAtomicStore(RValue::get(llvm::ConstantInt::get(
12304                             CGF.ConvertTypeForMem(FiredDecl->getType()), 1)),
12305                         FiredLVal, llvm::AtomicOrdering::Unordered,
12306                         /*IsVolatile=*/true, /*isInit=*/false);
12307     return;
12308   }
12309 
12310   // Private address of the lastprivate conditional in the current context.
12311   // priv_a
12312   LValue LVal = CGF.EmitLValue(FoundE);
12313   emitLastprivateConditionalUpdate(CGF, IVLVal, UniqueDeclName, LVal,
12314                                    FoundE->getExprLoc());
12315 }
12316 
12317 void CGOpenMPRuntime::checkAndEmitSharedLastprivateConditional(
12318     CodeGenFunction &CGF, const OMPExecutableDirective &D,
12319     const llvm::DenseSet<CanonicalDeclPtr<const VarDecl>> &IgnoredDecls) {
12320   if (CGF.getLangOpts().OpenMP < 50 || LastprivateConditionalStack.empty())
12321     return;
12322   auto Range = llvm::reverse(LastprivateConditionalStack);
12323   auto It = llvm::find_if(
12324       Range, [](const LastprivateConditionalData &D) { return !D.Disabled; });
12325   if (It == Range.end() || It->Fn != CGF.CurFn)
12326     return;
12327   auto LPCI = LastprivateConditionalToTypes.find(It->Fn);
12328   assert(LPCI != LastprivateConditionalToTypes.end() &&
12329          "Lastprivates must be registered already.");
12330   SmallVector<OpenMPDirectiveKind, 4> CaptureRegions;
12331   getOpenMPCaptureRegions(CaptureRegions, D.getDirectiveKind());
12332   const CapturedStmt *CS = D.getCapturedStmt(CaptureRegions.back());
12333   for (const auto &Pair : It->DeclToUniqueName) {
12334     const auto *VD = cast<VarDecl>(Pair.first->getCanonicalDecl());
12335     if (!CS->capturesVariable(VD) || IgnoredDecls.count(VD) > 0)
12336       continue;
12337     auto I = LPCI->getSecond().find(Pair.first);
12338     assert(I != LPCI->getSecond().end() &&
12339            "Lastprivate must be rehistered already.");
12340     // bool Cmp = priv_a.Fired != 0;
12341     LValue BaseLVal = std::get<3>(I->getSecond());
12342     LValue FiredLVal =
12343         CGF.EmitLValueForField(BaseLVal, std::get<2>(I->getSecond()));
12344     llvm::Value *Res = CGF.EmitLoadOfScalar(FiredLVal, D.getBeginLoc());
12345     llvm::Value *Cmp = CGF.Builder.CreateIsNotNull(Res);
12346     llvm::BasicBlock *ThenBB = CGF.createBasicBlock("lpc.then");
12347     llvm::BasicBlock *DoneBB = CGF.createBasicBlock("lpc.done");
12348     // if (Cmp) {
12349     CGF.Builder.CreateCondBr(Cmp, ThenBB, DoneBB);
12350     CGF.EmitBlock(ThenBB);
12351     Address Addr = CGF.GetAddrOfLocalVar(VD);
12352     LValue LVal;
12353     if (VD->getType()->isReferenceType())
12354       LVal = CGF.EmitLoadOfReferenceLValue(Addr, VD->getType(),
12355                                            AlignmentSource::Decl);
12356     else
12357       LVal = CGF.MakeAddrLValue(Addr, VD->getType().getNonReferenceType(),
12358                                 AlignmentSource::Decl);
12359     emitLastprivateConditionalUpdate(CGF, It->IVLVal, Pair.second, LVal,
12360                                      D.getBeginLoc());
12361     auto AL = ApplyDebugLocation::CreateArtificial(CGF);
12362     CGF.EmitBlock(DoneBB, /*IsFinal=*/true);
12363     // }
12364   }
12365 }
12366 
12367 void CGOpenMPRuntime::emitLastprivateConditionalFinalUpdate(
12368     CodeGenFunction &CGF, LValue PrivLVal, const VarDecl *VD,
12369     SourceLocation Loc) {
12370   if (CGF.getLangOpts().OpenMP < 50)
12371     return;
12372   auto It = LastprivateConditionalStack.back().DeclToUniqueName.find(VD);
12373   assert(It != LastprivateConditionalStack.back().DeclToUniqueName.end() &&
12374          "Unknown lastprivate conditional variable.");
12375   StringRef UniqueName = It->second;
12376   llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(UniqueName);
12377   // The variable was not updated in the region - exit.
12378   if (!GV)
12379     return;
12380   LValue LPLVal = CGF.MakeAddrLValue(
12381       GV, PrivLVal.getType().getNonReferenceType(), PrivLVal.getAlignment());
12382   llvm::Value *Res = CGF.EmitLoadOfScalar(LPLVal, Loc);
12383   CGF.EmitStoreOfScalar(Res, PrivLVal);
12384 }
12385 
12386 llvm::Function *CGOpenMPSIMDRuntime::emitParallelOutlinedFunction(
12387     const OMPExecutableDirective &D, const VarDecl *ThreadIDVar,
12388     OpenMPDirectiveKind InnermostKind, const RegionCodeGenTy &CodeGen) {
12389   llvm_unreachable("Not supported in SIMD-only mode");
12390 }
12391 
12392 llvm::Function *CGOpenMPSIMDRuntime::emitTeamsOutlinedFunction(
12393     const OMPExecutableDirective &D, const VarDecl *ThreadIDVar,
12394     OpenMPDirectiveKind InnermostKind, const RegionCodeGenTy &CodeGen) {
12395   llvm_unreachable("Not supported in SIMD-only mode");
12396 }
12397 
12398 llvm::Function *CGOpenMPSIMDRuntime::emitTaskOutlinedFunction(
12399     const OMPExecutableDirective &D, const VarDecl *ThreadIDVar,
12400     const VarDecl *PartIDVar, const VarDecl *TaskTVar,
12401     OpenMPDirectiveKind InnermostKind, const RegionCodeGenTy &CodeGen,
12402     bool Tied, unsigned &NumberOfParts) {
12403   llvm_unreachable("Not supported in SIMD-only mode");
12404 }
12405 
12406 void CGOpenMPSIMDRuntime::emitParallelCall(CodeGenFunction &CGF,
12407                                            SourceLocation Loc,
12408                                            llvm::Function *OutlinedFn,
12409                                            ArrayRef<llvm::Value *> CapturedVars,
12410                                            const Expr *IfCond) {
12411   llvm_unreachable("Not supported in SIMD-only mode");
12412 }
12413 
12414 void CGOpenMPSIMDRuntime::emitCriticalRegion(
12415     CodeGenFunction &CGF, StringRef CriticalName,
12416     const RegionCodeGenTy &CriticalOpGen, SourceLocation Loc,
12417     const Expr *Hint) {
12418   llvm_unreachable("Not supported in SIMD-only mode");
12419 }
12420 
12421 void CGOpenMPSIMDRuntime::emitMasterRegion(CodeGenFunction &CGF,
12422                                            const RegionCodeGenTy &MasterOpGen,
12423                                            SourceLocation Loc) {
12424   llvm_unreachable("Not supported in SIMD-only mode");
12425 }
12426 
12427 void CGOpenMPSIMDRuntime::emitTaskyieldCall(CodeGenFunction &CGF,
12428                                             SourceLocation Loc) {
12429   llvm_unreachable("Not supported in SIMD-only mode");
12430 }
12431 
12432 void CGOpenMPSIMDRuntime::emitTaskgroupRegion(
12433     CodeGenFunction &CGF, const RegionCodeGenTy &TaskgroupOpGen,
12434     SourceLocation Loc) {
12435   llvm_unreachable("Not supported in SIMD-only mode");
12436 }
12437 
12438 void CGOpenMPSIMDRuntime::emitSingleRegion(
12439     CodeGenFunction &CGF, const RegionCodeGenTy &SingleOpGen,
12440     SourceLocation Loc, ArrayRef<const Expr *> CopyprivateVars,
12441     ArrayRef<const Expr *> DestExprs, ArrayRef<const Expr *> SrcExprs,
12442     ArrayRef<const Expr *> AssignmentOps) {
12443   llvm_unreachable("Not supported in SIMD-only mode");
12444 }
12445 
12446 void CGOpenMPSIMDRuntime::emitOrderedRegion(CodeGenFunction &CGF,
12447                                             const RegionCodeGenTy &OrderedOpGen,
12448                                             SourceLocation Loc,
12449                                             bool IsThreads) {
12450   llvm_unreachable("Not supported in SIMD-only mode");
12451 }
12452 
12453 void CGOpenMPSIMDRuntime::emitBarrierCall(CodeGenFunction &CGF,
12454                                           SourceLocation Loc,
12455                                           OpenMPDirectiveKind Kind,
12456                                           bool EmitChecks,
12457                                           bool ForceSimpleCall) {
12458   llvm_unreachable("Not supported in SIMD-only mode");
12459 }
12460 
12461 void CGOpenMPSIMDRuntime::emitForDispatchInit(
12462     CodeGenFunction &CGF, SourceLocation Loc,
12463     const OpenMPScheduleTy &ScheduleKind, unsigned IVSize, bool IVSigned,
12464     bool Ordered, const DispatchRTInput &DispatchValues) {
12465   llvm_unreachable("Not supported in SIMD-only mode");
12466 }
12467 
12468 void CGOpenMPSIMDRuntime::emitForStaticInit(
12469     CodeGenFunction &CGF, SourceLocation Loc, OpenMPDirectiveKind DKind,
12470     const OpenMPScheduleTy &ScheduleKind, const StaticRTInput &Values) {
12471   llvm_unreachable("Not supported in SIMD-only mode");
12472 }
12473 
12474 void CGOpenMPSIMDRuntime::emitDistributeStaticInit(
12475     CodeGenFunction &CGF, SourceLocation Loc,
12476     OpenMPDistScheduleClauseKind SchedKind, const StaticRTInput &Values) {
12477   llvm_unreachable("Not supported in SIMD-only mode");
12478 }
12479 
12480 void CGOpenMPSIMDRuntime::emitForOrderedIterationEnd(CodeGenFunction &CGF,
12481                                                      SourceLocation Loc,
12482                                                      unsigned IVSize,
12483                                                      bool IVSigned) {
12484   llvm_unreachable("Not supported in SIMD-only mode");
12485 }
12486 
12487 void CGOpenMPSIMDRuntime::emitForStaticFinish(CodeGenFunction &CGF,
12488                                               SourceLocation Loc,
12489                                               OpenMPDirectiveKind DKind) {
12490   llvm_unreachable("Not supported in SIMD-only mode");
12491 }
12492 
12493 llvm::Value *CGOpenMPSIMDRuntime::emitForNext(CodeGenFunction &CGF,
12494                                               SourceLocation Loc,
12495                                               unsigned IVSize, bool IVSigned,
12496                                               Address IL, Address LB,
12497                                               Address UB, Address ST) {
12498   llvm_unreachable("Not supported in SIMD-only mode");
12499 }
12500 
12501 void CGOpenMPSIMDRuntime::emitNumThreadsClause(CodeGenFunction &CGF,
12502                                                llvm::Value *NumThreads,
12503                                                SourceLocation Loc) {
12504   llvm_unreachable("Not supported in SIMD-only mode");
12505 }
12506 
12507 void CGOpenMPSIMDRuntime::emitProcBindClause(CodeGenFunction &CGF,
12508                                              ProcBindKind ProcBind,
12509                                              SourceLocation Loc) {
12510   llvm_unreachable("Not supported in SIMD-only mode");
12511 }
12512 
12513 Address CGOpenMPSIMDRuntime::getAddrOfThreadPrivate(CodeGenFunction &CGF,
12514                                                     const VarDecl *VD,
12515                                                     Address VDAddr,
12516                                                     SourceLocation Loc) {
12517   llvm_unreachable("Not supported in SIMD-only mode");
12518 }
12519 
12520 llvm::Function *CGOpenMPSIMDRuntime::emitThreadPrivateVarDefinition(
12521     const VarDecl *VD, Address VDAddr, SourceLocation Loc, bool PerformInit,
12522     CodeGenFunction *CGF) {
12523   llvm_unreachable("Not supported in SIMD-only mode");
12524 }
12525 
12526 Address CGOpenMPSIMDRuntime::getAddrOfArtificialThreadPrivate(
12527     CodeGenFunction &CGF, QualType VarType, StringRef Name) {
12528   llvm_unreachable("Not supported in SIMD-only mode");
12529 }
12530 
12531 void CGOpenMPSIMDRuntime::emitFlush(CodeGenFunction &CGF,
12532                                     ArrayRef<const Expr *> Vars,
12533                                     SourceLocation Loc,
12534                                     llvm::AtomicOrdering AO) {
12535   llvm_unreachable("Not supported in SIMD-only mode");
12536 }
12537 
12538 void CGOpenMPSIMDRuntime::emitTaskCall(CodeGenFunction &CGF, SourceLocation Loc,
12539                                        const OMPExecutableDirective &D,
12540                                        llvm::Function *TaskFunction,
12541                                        QualType SharedsTy, Address Shareds,
12542                                        const Expr *IfCond,
12543                                        const OMPTaskDataTy &Data) {
12544   llvm_unreachable("Not supported in SIMD-only mode");
12545 }
12546 
12547 void CGOpenMPSIMDRuntime::emitTaskLoopCall(
12548     CodeGenFunction &CGF, SourceLocation Loc, const OMPLoopDirective &D,
12549     llvm::Function *TaskFunction, QualType SharedsTy, Address Shareds,
12550     const Expr *IfCond, const OMPTaskDataTy &Data) {
12551   llvm_unreachable("Not supported in SIMD-only mode");
12552 }
12553 
12554 void CGOpenMPSIMDRuntime::emitReduction(
12555     CodeGenFunction &CGF, SourceLocation Loc, ArrayRef<const Expr *> Privates,
12556     ArrayRef<const Expr *> LHSExprs, ArrayRef<const Expr *> RHSExprs,
12557     ArrayRef<const Expr *> ReductionOps, ReductionOptionsTy Options) {
12558   assert(Options.SimpleReduction && "Only simple reduction is expected.");
12559   CGOpenMPRuntime::emitReduction(CGF, Loc, Privates, LHSExprs, RHSExprs,
12560                                  ReductionOps, Options);
12561 }
12562 
12563 llvm::Value *CGOpenMPSIMDRuntime::emitTaskReductionInit(
12564     CodeGenFunction &CGF, SourceLocation Loc, ArrayRef<const Expr *> LHSExprs,
12565     ArrayRef<const Expr *> RHSExprs, const OMPTaskDataTy &Data) {
12566   llvm_unreachable("Not supported in SIMD-only mode");
12567 }
12568 
12569 void CGOpenMPSIMDRuntime::emitTaskReductionFini(CodeGenFunction &CGF,
12570                                                 SourceLocation Loc,
12571                                                 bool IsWorksharingReduction) {
12572   llvm_unreachable("Not supported in SIMD-only mode");
12573 }
12574 
12575 void CGOpenMPSIMDRuntime::emitTaskReductionFixups(CodeGenFunction &CGF,
12576                                                   SourceLocation Loc,
12577                                                   ReductionCodeGen &RCG,
12578                                                   unsigned N) {
12579   llvm_unreachable("Not supported in SIMD-only mode");
12580 }
12581 
12582 Address CGOpenMPSIMDRuntime::getTaskReductionItem(CodeGenFunction &CGF,
12583                                                   SourceLocation Loc,
12584                                                   llvm::Value *ReductionsPtr,
12585                                                   LValue SharedLVal) {
12586   llvm_unreachable("Not supported in SIMD-only mode");
12587 }
12588 
12589 void CGOpenMPSIMDRuntime::emitTaskwaitCall(CodeGenFunction &CGF,
12590                                            SourceLocation Loc) {
12591   llvm_unreachable("Not supported in SIMD-only mode");
12592 }
12593 
12594 void CGOpenMPSIMDRuntime::emitCancellationPointCall(
12595     CodeGenFunction &CGF, SourceLocation Loc,
12596     OpenMPDirectiveKind CancelRegion) {
12597   llvm_unreachable("Not supported in SIMD-only mode");
12598 }
12599 
12600 void CGOpenMPSIMDRuntime::emitCancelCall(CodeGenFunction &CGF,
12601                                          SourceLocation Loc, const Expr *IfCond,
12602                                          OpenMPDirectiveKind CancelRegion) {
12603   llvm_unreachable("Not supported in SIMD-only mode");
12604 }
12605 
12606 void CGOpenMPSIMDRuntime::emitTargetOutlinedFunction(
12607     const OMPExecutableDirective &D, StringRef ParentName,
12608     llvm::Function *&OutlinedFn, llvm::Constant *&OutlinedFnID,
12609     bool IsOffloadEntry, const RegionCodeGenTy &CodeGen) {
12610   llvm_unreachable("Not supported in SIMD-only mode");
12611 }
12612 
12613 void CGOpenMPSIMDRuntime::emitTargetCall(
12614     CodeGenFunction &CGF, const OMPExecutableDirective &D,
12615     llvm::Function *OutlinedFn, llvm::Value *OutlinedFnID, const Expr *IfCond,
12616     llvm::PointerIntPair<const Expr *, 2, OpenMPDeviceClauseModifier> Device,
12617     llvm::function_ref<llvm::Value *(CodeGenFunction &CGF,
12618                                      const OMPLoopDirective &D)>
12619         SizeEmitter) {
12620   llvm_unreachable("Not supported in SIMD-only mode");
12621 }
12622 
12623 bool CGOpenMPSIMDRuntime::emitTargetFunctions(GlobalDecl GD) {
12624   llvm_unreachable("Not supported in SIMD-only mode");
12625 }
12626 
12627 bool CGOpenMPSIMDRuntime::emitTargetGlobalVariable(GlobalDecl GD) {
12628   llvm_unreachable("Not supported in SIMD-only mode");
12629 }
12630 
12631 bool CGOpenMPSIMDRuntime::emitTargetGlobal(GlobalDecl GD) {
12632   return false;
12633 }
12634 
12635 void CGOpenMPSIMDRuntime::emitTeamsCall(CodeGenFunction &CGF,
12636                                         const OMPExecutableDirective &D,
12637                                         SourceLocation Loc,
12638                                         llvm::Function *OutlinedFn,
12639                                         ArrayRef<llvm::Value *> CapturedVars) {
12640   llvm_unreachable("Not supported in SIMD-only mode");
12641 }
12642 
12643 void CGOpenMPSIMDRuntime::emitNumTeamsClause(CodeGenFunction &CGF,
12644                                              const Expr *NumTeams,
12645                                              const Expr *ThreadLimit,
12646                                              SourceLocation Loc) {
12647   llvm_unreachable("Not supported in SIMD-only mode");
12648 }
12649 
12650 void CGOpenMPSIMDRuntime::emitTargetDataCalls(
12651     CodeGenFunction &CGF, const OMPExecutableDirective &D, const Expr *IfCond,
12652     const Expr *Device, const RegionCodeGenTy &CodeGen, TargetDataInfo &Info) {
12653   llvm_unreachable("Not supported in SIMD-only mode");
12654 }
12655 
12656 void CGOpenMPSIMDRuntime::emitTargetDataStandAloneCall(
12657     CodeGenFunction &CGF, const OMPExecutableDirective &D, const Expr *IfCond,
12658     const Expr *Device) {
12659   llvm_unreachable("Not supported in SIMD-only mode");
12660 }
12661 
12662 void CGOpenMPSIMDRuntime::emitDoacrossInit(CodeGenFunction &CGF,
12663                                            const OMPLoopDirective &D,
12664                                            ArrayRef<Expr *> NumIterations) {
12665   llvm_unreachable("Not supported in SIMD-only mode");
12666 }
12667 
12668 void CGOpenMPSIMDRuntime::emitDoacrossOrdered(CodeGenFunction &CGF,
12669                                               const OMPDependClause *C) {
12670   llvm_unreachable("Not supported in SIMD-only mode");
12671 }
12672 
12673 const VarDecl *
12674 CGOpenMPSIMDRuntime::translateParameter(const FieldDecl *FD,
12675                                         const VarDecl *NativeParam) const {
12676   llvm_unreachable("Not supported in SIMD-only mode");
12677 }
12678 
12679 Address
12680 CGOpenMPSIMDRuntime::getParameterAddress(CodeGenFunction &CGF,
12681                                          const VarDecl *NativeParam,
12682                                          const VarDecl *TargetParam) const {
12683   llvm_unreachable("Not supported in SIMD-only mode");
12684 }
12685