1 //===------ PPCGCodeGeneration.cpp - Polly Accelerator Code Generation. ---===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // Take a scop created by ScopInfo and map it to GPU code using the ppcg
11 // GPU mapping strategy.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "polly/CodeGen/PPCGCodeGeneration.h"
16 #include "polly/CodeGen/CodeGeneration.h"
17 #include "polly/CodeGen/IslAst.h"
18 #include "polly/CodeGen/IslNodeBuilder.h"
19 #include "polly/CodeGen/PerfMonitor.h"
20 #include "polly/CodeGen/Utils.h"
21 #include "polly/DependenceInfo.h"
22 #include "polly/LinkAllPasses.h"
23 #include "polly/Options.h"
24 #include "polly/ScopDetection.h"
25 #include "polly/ScopInfo.h"
26 #include "polly/Support/SCEVValidator.h"
27 #include "llvm/ADT/PostOrderIterator.h"
28 #include "llvm/Analysis/AliasAnalysis.h"
29 #include "llvm/Analysis/BasicAliasAnalysis.h"
30 #include "llvm/Analysis/GlobalsModRef.h"
31 #include "llvm/Analysis/ScalarEvolutionAliasAnalysis.h"
32 #include "llvm/Analysis/TargetLibraryInfo.h"
33 #include "llvm/Analysis/TargetTransformInfo.h"
34 #include "llvm/IR/LegacyPassManager.h"
35 #include "llvm/IR/Verifier.h"
36 #include "llvm/IRReader/IRReader.h"
37 #include "llvm/Linker/Linker.h"
38 #include "llvm/Support/TargetRegistry.h"
39 #include "llvm/Support/TargetSelect.h"
40 #include "llvm/Target/TargetMachine.h"
41 #include "llvm/Transforms/IPO/PassManagerBuilder.h"
42 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
43 
44 #include "isl/union_map.h"
45 
46 extern "C" {
47 #include "ppcg/cuda.h"
48 #include "ppcg/gpu.h"
49 #include "ppcg/gpu_print.h"
50 #include "ppcg/ppcg.h"
51 #include "ppcg/schedule.h"
52 }
53 
54 #include "llvm/Support/Debug.h"
55 
56 using namespace polly;
57 using namespace llvm;
58 
59 #define DEBUG_TYPE "polly-codegen-ppcg"
60 
61 static cl::opt<bool> DumpSchedule("polly-acc-dump-schedule",
62                                   cl::desc("Dump the computed GPU Schedule"),
63                                   cl::Hidden, cl::init(false), cl::ZeroOrMore,
64                                   cl::cat(PollyCategory));
65 
66 static cl::opt<bool>
67     DumpCode("polly-acc-dump-code",
68              cl::desc("Dump C code describing the GPU mapping"), cl::Hidden,
69              cl::init(false), cl::ZeroOrMore, cl::cat(PollyCategory));
70 
71 static cl::opt<bool> DumpKernelIR("polly-acc-dump-kernel-ir",
72                                   cl::desc("Dump the kernel LLVM-IR"),
73                                   cl::Hidden, cl::init(false), cl::ZeroOrMore,
74                                   cl::cat(PollyCategory));
75 
76 static cl::opt<bool> DumpKernelASM("polly-acc-dump-kernel-asm",
77                                    cl::desc("Dump the kernel assembly code"),
78                                    cl::Hidden, cl::init(false), cl::ZeroOrMore,
79                                    cl::cat(PollyCategory));
80 
81 static cl::opt<bool> FastMath("polly-acc-fastmath",
82                               cl::desc("Allow unsafe math optimizations"),
83                               cl::Hidden, cl::init(false), cl::ZeroOrMore,
84                               cl::cat(PollyCategory));
85 static cl::opt<bool> SharedMemory("polly-acc-use-shared",
86                                   cl::desc("Use shared memory"), cl::Hidden,
87                                   cl::init(false), cl::ZeroOrMore,
88                                   cl::cat(PollyCategory));
89 static cl::opt<bool> PrivateMemory("polly-acc-use-private",
90                                    cl::desc("Use private memory"), cl::Hidden,
91                                    cl::init(false), cl::ZeroOrMore,
92                                    cl::cat(PollyCategory));
93 
94 bool polly::PollyManagedMemory;
95 static cl::opt<bool, true>
96     XManagedMemory("polly-acc-codegen-managed-memory",
97                    cl::desc("Generate Host kernel code assuming"
98                             " that all memory has been"
99                             " declared as managed memory"),
100                    cl::location(PollyManagedMemory), cl::Hidden,
101                    cl::init(false), cl::ZeroOrMore, cl::cat(PollyCategory));
102 
103 static cl::opt<bool>
104     FailOnVerifyModuleFailure("polly-acc-fail-on-verify-module-failure",
105                               cl::desc("Fail and generate a backtrace if"
106                                        " verifyModule fails on the GPU "
107                                        " kernel module."),
108                               cl::Hidden, cl::init(false), cl::ZeroOrMore,
109                               cl::cat(PollyCategory));
110 
111 static cl::opt<std::string> CUDALibDevice(
112     "polly-acc-libdevice", cl::desc("Path to CUDA libdevice"), cl::Hidden,
113     cl::init("/usr/local/cuda/nvvm/libdevice/libdevice.compute_20.10.ll"),
114     cl::ZeroOrMore, cl::cat(PollyCategory));
115 
116 static cl::opt<std::string>
117     CudaVersion("polly-acc-cuda-version",
118                 cl::desc("The CUDA version to compile for"), cl::Hidden,
119                 cl::init("sm_30"), cl::ZeroOrMore, cl::cat(PollyCategory));
120 
121 static cl::opt<int>
122     MinCompute("polly-acc-mincompute",
123                cl::desc("Minimal number of compute statements to run on GPU."),
124                cl::Hidden, cl::init(10 * 512 * 512));
125 
126 extern bool polly::PerfMonitoring;
127 
128 /// Return  a unique name for a Scop, which is the scop region with the
129 /// function name.
130 std::string getUniqueScopName(const Scop *S) {
131   return "Scop Region: " + S->getNameStr() +
132          " | Function: " + std::string(S->getFunction().getName());
133 }
134 
135 /// Used to store information PPCG wants for kills. This information is
136 /// used by live range reordering.
137 ///
138 /// @see computeLiveRangeReordering
139 /// @see GPUNodeBuilder::createPPCGScop
140 /// @see GPUNodeBuilder::createPPCGProg
141 struct MustKillsInfo {
142   /// Collection of all kill statements that will be sequenced at the end of
143   /// PPCGScop->schedule.
144   ///
145   /// The nodes in `KillsSchedule` will be merged using `isl_schedule_set`
146   /// which merges schedules in *arbitrary* order.
147   /// (we don't care about the order of the kills anyway).
148   isl::schedule KillsSchedule;
149   /// Map from kill statement instances to scalars that need to be
150   /// killed.
151   ///
152   /// We currently derive kill information for:
153   ///  1. phi nodes. PHI nodes are not alive outside the scop and can
154   ///     consequently all be killed.
155   ///  2. Scalar arrays that are not used outside the Scop. This is
156   ///     checked by `isScalarUsesContainedInScop`.
157   /// [params] -> { [Stmt_phantom[] -> ref_phantom[]] -> scalar_to_kill[] }
158   isl::union_map TaggedMustKills;
159 
160   /// Tagged must kills stripped of the tags.
161   /// [params] -> { Stmt_phantom[]  -> scalar_to_kill[] }
162   isl::union_map MustKills;
163 
164   MustKillsInfo() : KillsSchedule(nullptr) {}
165 };
166 
167 /// Check if SAI's uses are entirely contained within Scop S.
168 /// If a scalar is used only with a Scop, we are free to kill it, as no data
169 /// can flow in/out of the value any more.
170 /// @see computeMustKillsInfo
171 static bool isScalarUsesContainedInScop(const Scop &S,
172                                         const ScopArrayInfo *SAI) {
173   assert(SAI->isValueKind() && "this function only deals with scalars."
174                                " Dealing with arrays required alias analysis");
175 
176   const Region &R = S.getRegion();
177   for (User *U : SAI->getBasePtr()->users()) {
178     Instruction *I = dyn_cast<Instruction>(U);
179     assert(I && "invalid user of scop array info");
180     if (!R.contains(I))
181       return false;
182   }
183   return true;
184 }
185 
186 /// Compute must-kills needed to enable live range reordering with PPCG.
187 ///
188 /// @params S The Scop to compute live range reordering information
189 /// @returns live range reordering information that can be used to setup
190 /// PPCG.
191 static MustKillsInfo computeMustKillsInfo(const Scop &S) {
192   const isl::space ParamSpace = S.getParamSpace();
193   MustKillsInfo Info;
194 
195   // 1. Collect all ScopArrayInfo that satisfy *any* of the criteria:
196   //      1.1 phi nodes in scop.
197   //      1.2 scalars that are only used within the scop
198   SmallVector<isl::id, 4> KillMemIds;
199   for (ScopArrayInfo *SAI : S.arrays()) {
200     if (SAI->isPHIKind() ||
201         (SAI->isValueKind() && isScalarUsesContainedInScop(S, SAI)))
202       KillMemIds.push_back(isl::manage(SAI->getBasePtrId().release()));
203   }
204 
205   Info.TaggedMustKills = isl::union_map::empty(ParamSpace);
206   Info.MustKills = isl::union_map::empty(ParamSpace);
207 
208   // Initialising KillsSchedule to `isl_set_empty` creates an empty node in the
209   // schedule:
210   //     - filter: "[control] -> { }"
211   // So, we choose to not create this to keep the output a little nicer,
212   // at the cost of some code complexity.
213   Info.KillsSchedule = nullptr;
214 
215   for (isl::id &ToKillId : KillMemIds) {
216     isl::id KillStmtId = isl::id::alloc(
217         S.getIslCtx(),
218         std::string("SKill_phantom_").append(ToKillId.get_name()), nullptr);
219 
220     // NOTE: construction of tagged_must_kill:
221     // 2. We need to construct a map:
222     //     [param] -> { [Stmt_phantom[] -> ref_phantom[]] -> scalar_to_kill[] }
223     // To construct this, we use `isl_map_domain_product` on 2 maps`:
224     // 2a. StmtToScalar:
225     //         [param] -> { Stmt_phantom[] -> scalar_to_kill[] }
226     // 2b. PhantomRefToScalar:
227     //         [param] -> { ref_phantom[] -> scalar_to_kill[] }
228     //
229     // Combining these with `isl_map_domain_product` gives us
230     // TaggedMustKill:
231     //     [param] -> { [Stmt[] -> phantom_ref[]] -> scalar_to_kill[] }
232 
233     // 2a. [param] -> { Stmt[] -> scalar_to_kill[] }
234     isl::map StmtToScalar = isl::map::universe(ParamSpace);
235     StmtToScalar = StmtToScalar.set_tuple_id(isl::dim::in, isl::id(KillStmtId));
236     StmtToScalar = StmtToScalar.set_tuple_id(isl::dim::out, isl::id(ToKillId));
237 
238     isl::id PhantomRefId = isl::id::alloc(
239         S.getIslCtx(), std::string("ref_phantom") + ToKillId.get_name(),
240         nullptr);
241 
242     // 2b. [param] -> { phantom_ref[] -> scalar_to_kill[] }
243     isl::map PhantomRefToScalar = isl::map::universe(ParamSpace);
244     PhantomRefToScalar =
245         PhantomRefToScalar.set_tuple_id(isl::dim::in, PhantomRefId);
246     PhantomRefToScalar =
247         PhantomRefToScalar.set_tuple_id(isl::dim::out, ToKillId);
248 
249     // 2. [param] -> { [Stmt[] -> phantom_ref[]] -> scalar_to_kill[] }
250     isl::map TaggedMustKill = StmtToScalar.domain_product(PhantomRefToScalar);
251     Info.TaggedMustKills = Info.TaggedMustKills.unite(TaggedMustKill);
252 
253     // 2. [param] -> { Stmt[] -> scalar_to_kill[] }
254     Info.MustKills = Info.TaggedMustKills.domain_factor_domain();
255 
256     // 3. Create the kill schedule of the form:
257     //     "[param] -> { Stmt_phantom[] }"
258     // Then add this to Info.KillsSchedule.
259     isl::space KillStmtSpace = ParamSpace;
260     KillStmtSpace = KillStmtSpace.set_tuple_id(isl::dim::set, KillStmtId);
261     isl::union_set KillStmtDomain = isl::set::universe(KillStmtSpace);
262 
263     isl::schedule KillSchedule = isl::schedule::from_domain(KillStmtDomain);
264     if (Info.KillsSchedule)
265       Info.KillsSchedule = Info.KillsSchedule.set(KillSchedule);
266     else
267       Info.KillsSchedule = KillSchedule;
268   }
269 
270   return Info;
271 }
272 
273 /// Create the ast expressions for a ScopStmt.
274 ///
275 /// This function is a callback for to generate the ast expressions for each
276 /// of the scheduled ScopStmts.
277 static __isl_give isl_id_to_ast_expr *pollyBuildAstExprForStmt(
278     void *StmtT, __isl_take isl_ast_build *Build_C,
279     isl_multi_pw_aff *(*FunctionIndex)(__isl_take isl_multi_pw_aff *MPA,
280                                        isl_id *Id, void *User),
281     void *UserIndex,
282     isl_ast_expr *(*FunctionExpr)(isl_ast_expr *Expr, isl_id *Id, void *User),
283     void *UserExpr) {
284 
285   ScopStmt *Stmt = (ScopStmt *)StmtT;
286 
287   if (!Stmt || !Build_C)
288     return NULL;
289 
290   isl::ast_build Build = isl::manage_copy(Build_C);
291   isl::ctx Ctx = Build.get_ctx();
292   isl::id_to_ast_expr RefToExpr = isl::id_to_ast_expr::alloc(Ctx, 0);
293 
294   Stmt->setAstBuild(Build);
295 
296   for (MemoryAccess *Acc : *Stmt) {
297     isl::map AddrFunc = Acc->getAddressFunction();
298     AddrFunc = AddrFunc.intersect_domain(Stmt->getDomain());
299 
300     isl::id RefId = Acc->getId();
301     isl::pw_multi_aff PMA = isl::pw_multi_aff::from_map(AddrFunc);
302 
303     isl::multi_pw_aff MPA = isl::multi_pw_aff(PMA);
304     MPA = MPA.coalesce();
305     MPA = isl::manage(FunctionIndex(MPA.release(), RefId.get(), UserIndex));
306 
307     isl::ast_expr Access = Build.access_from(MPA);
308     Access = isl::manage(FunctionExpr(Access.release(), RefId.get(), UserExpr));
309     RefToExpr = RefToExpr.set(RefId, Access);
310   }
311 
312   return RefToExpr.release();
313 }
314 
315 /// Given a LLVM Type, compute its size in bytes,
316 static int computeSizeInBytes(const Type *T) {
317   int bytes = T->getPrimitiveSizeInBits() / 8;
318   if (bytes == 0)
319     bytes = T->getScalarSizeInBits() / 8;
320   return bytes;
321 }
322 
323 /// Generate code for a GPU specific isl AST.
324 ///
325 /// The GPUNodeBuilder augments the general existing IslNodeBuilder, which
326 /// generates code for general-purpose AST nodes, with special functionality
327 /// for generating GPU specific user nodes.
328 ///
329 /// @see GPUNodeBuilder::createUser
330 class GPUNodeBuilder : public IslNodeBuilder {
331 public:
332   GPUNodeBuilder(PollyIRBuilder &Builder, ScopAnnotator &Annotator,
333                  const DataLayout &DL, LoopInfo &LI, ScalarEvolution &SE,
334                  DominatorTree &DT, Scop &S, BasicBlock *StartBlock,
335                  gpu_prog *Prog, GPURuntime Runtime, GPUArch Arch)
336       : IslNodeBuilder(Builder, Annotator, DL, LI, SE, DT, S, StartBlock),
337         Prog(Prog), Runtime(Runtime), Arch(Arch) {
338     getExprBuilder().setIDToSAI(&IDToSAI);
339   }
340 
341   /// Create after-run-time-check initialization code.
342   void initializeAfterRTH();
343 
344   /// Finalize the generated scop.
345   virtual void finalize();
346 
347   /// Track if the full build process was successful.
348   ///
349   /// This value is set to false, if throughout the build process an error
350   /// occurred which prevents us from generating valid GPU code.
351   bool BuildSuccessful = true;
352 
353   /// The maximal number of loops surrounding a sequential kernel.
354   unsigned DeepestSequential = 0;
355 
356   /// The maximal number of loops surrounding a parallel kernel.
357   unsigned DeepestParallel = 0;
358 
359   /// Return the name to set for the ptx_kernel.
360   std::string getKernelFuncName(int Kernel_id);
361 
362 private:
363   /// A vector of array base pointers for which a new ScopArrayInfo was created.
364   ///
365   /// This vector is used to delete the ScopArrayInfo when it is not needed any
366   /// more.
367   std::vector<Value *> LocalArrays;
368 
369   /// A map from ScopArrays to their corresponding device allocations.
370   std::map<ScopArrayInfo *, Value *> DeviceAllocations;
371 
372   /// The current GPU context.
373   Value *GPUContext;
374 
375   /// The set of isl_ids allocated in the kernel
376   std::vector<isl_id *> KernelIds;
377 
378   /// A module containing GPU code.
379   ///
380   /// This pointer is only set in case we are currently generating GPU code.
381   std::unique_ptr<Module> GPUModule;
382 
383   /// The GPU program we generate code for.
384   gpu_prog *Prog;
385 
386   /// The GPU Runtime implementation to use (OpenCL or CUDA).
387   GPURuntime Runtime;
388 
389   /// The GPU Architecture to target.
390   GPUArch Arch;
391 
392   /// Class to free isl_ids.
393   class IslIdDeleter {
394   public:
395     void operator()(__isl_take isl_id *Id) { isl_id_free(Id); };
396   };
397 
398   /// A set containing all isl_ids allocated in a GPU kernel.
399   ///
400   /// By releasing this set all isl_ids will be freed.
401   std::set<std::unique_ptr<isl_id, IslIdDeleter>> KernelIDs;
402 
403   IslExprBuilder::IDToScopArrayInfoTy IDToSAI;
404 
405   /// Create code for user-defined AST nodes.
406   ///
407   /// These AST nodes can be of type:
408   ///
409   ///   - ScopStmt:      A computational statement (TODO)
410   ///   - Kernel:        A GPU kernel call (TODO)
411   ///   - Data-Transfer: A GPU <-> CPU data-transfer
412   ///   - In-kernel synchronization
413   ///   - In-kernel memory copy statement
414   ///
415   /// @param UserStmt The ast node to generate code for.
416   virtual void createUser(__isl_take isl_ast_node *UserStmt);
417 
418   virtual void createFor(__isl_take isl_ast_node *Node);
419 
420   enum DataDirection { HOST_TO_DEVICE, DEVICE_TO_HOST };
421 
422   /// Create code for a data transfer statement
423   ///
424   /// @param TransferStmt The data transfer statement.
425   /// @param Direction The direction in which to transfer data.
426   void createDataTransfer(__isl_take isl_ast_node *TransferStmt,
427                           enum DataDirection Direction);
428 
429   /// Find llvm::Values referenced in GPU kernel.
430   ///
431   /// @param Kernel The kernel to scan for llvm::Values
432   ///
433   /// @returns A tuple, whose:
434   ///          - First element contains the set of values referenced by the
435   ///            kernel
436   ///          - Second element contains the set of functions referenced by the
437   ///             kernel. All functions in the set satisfy
438   ///             `isValidFunctionInKernel`.
439   ///          - Third element contains loops that have induction variables
440   ///            which are used in the kernel, *and* these loops are *neither*
441   ///            in the scop, nor do they immediately surroung the Scop.
442   ///            See [Code generation of induction variables of loops outside
443   ///            Scops]
444   std::tuple<SetVector<Value *>, SetVector<Function *>, SetVector<const Loop *>,
445              isl::space>
446   getReferencesInKernel(ppcg_kernel *Kernel);
447 
448   /// Compute the sizes of the execution grid for a given kernel.
449   ///
450   /// @param Kernel The kernel to compute grid sizes for.
451   ///
452   /// @returns A tuple with grid sizes for X and Y dimension
453   std::tuple<Value *, Value *> getGridSizes(ppcg_kernel *Kernel);
454 
455   /// Get the managed array pointer for sending host pointers to the device.
456   /// \note
457   /// This is to be used only with managed memory
458   Value *getManagedDeviceArray(gpu_array_info *Array, ScopArrayInfo *ArrayInfo);
459 
460   /// Compute the sizes of the thread blocks for a given kernel.
461   ///
462   /// @param Kernel The kernel to compute thread block sizes for.
463   ///
464   /// @returns A tuple with thread block sizes for X, Y, and Z dimensions.
465   std::tuple<Value *, Value *, Value *> getBlockSizes(ppcg_kernel *Kernel);
466 
467   /// Store a specific kernel launch parameter in the array of kernel launch
468   /// parameters.
469   ///
470   /// @param Parameters The list of parameters in which to store.
471   /// @param Param      The kernel launch parameter to store.
472   /// @param Index      The index in the parameter list, at which to store the
473   ///                   parameter.
474   void insertStoreParameter(Instruction *Parameters, Instruction *Param,
475                             int Index);
476 
477   /// Create kernel launch parameters.
478   ///
479   /// @param Kernel        The kernel to create parameters for.
480   /// @param F             The kernel function that has been created.
481   /// @param SubtreeValues The set of llvm::Values referenced by this kernel.
482   ///
483   /// @returns A stack allocated array with pointers to the parameter
484   ///          values that are passed to the kernel.
485   Value *createLaunchParameters(ppcg_kernel *Kernel, Function *F,
486                                 SetVector<Value *> SubtreeValues);
487 
488   /// Create declarations for kernel variable.
489   ///
490   /// This includes shared memory declarations.
491   ///
492   /// @param Kernel        The kernel definition to create variables for.
493   /// @param FN            The function into which to generate the variables.
494   void createKernelVariables(ppcg_kernel *Kernel, Function *FN);
495 
496   /// Add CUDA annotations to module.
497   ///
498   /// Add a set of CUDA annotations that declares the maximal block dimensions
499   /// that will be used to execute the CUDA kernel. This allows the NVIDIA
500   /// PTX compiler to bound the number of allocated registers to ensure the
501   /// resulting kernel is known to run with up to as many block dimensions
502   /// as specified here.
503   ///
504   /// @param M         The module to add the annotations to.
505   /// @param BlockDimX The size of block dimension X.
506   /// @param BlockDimY The size of block dimension Y.
507   /// @param BlockDimZ The size of block dimension Z.
508   void addCUDAAnnotations(Module *M, Value *BlockDimX, Value *BlockDimY,
509                           Value *BlockDimZ);
510 
511   /// Create GPU kernel.
512   ///
513   /// Code generate the kernel described by @p KernelStmt.
514   ///
515   /// @param KernelStmt The ast node to generate kernel code for.
516   void createKernel(__isl_take isl_ast_node *KernelStmt);
517 
518   /// Generate code that computes the size of an array.
519   ///
520   /// @param Array The array for which to compute a size.
521   Value *getArraySize(gpu_array_info *Array);
522 
523   /// Generate code to compute the minimal offset at which an array is accessed.
524   ///
525   /// The offset of an array is the minimal array location accessed in a scop.
526   ///
527   /// Example:
528   ///
529   ///   for (long i = 0; i < 100; i++)
530   ///     A[i + 42] += ...
531   ///
532   ///   getArrayOffset(A) results in 42.
533   ///
534   /// @param Array The array for which to compute the offset.
535   /// @returns An llvm::Value that contains the offset of the array.
536   Value *getArrayOffset(gpu_array_info *Array);
537 
538   /// Prepare the kernel arguments for kernel code generation
539   ///
540   /// @param Kernel The kernel to generate code for.
541   /// @param FN     The function created for the kernel.
542   void prepareKernelArguments(ppcg_kernel *Kernel, Function *FN);
543 
544   /// Create kernel function.
545   ///
546   /// Create a kernel function located in a newly created module that can serve
547   /// as target for device code generation. Set the Builder to point to the
548   /// start block of this newly created function.
549   ///
550   /// @param Kernel The kernel to generate code for.
551   /// @param SubtreeValues The set of llvm::Values referenced by this kernel.
552   /// @param SubtreeFunctions The set of llvm::Functions referenced by this
553   ///                         kernel.
554   void createKernelFunction(ppcg_kernel *Kernel,
555                             SetVector<Value *> &SubtreeValues,
556                             SetVector<Function *> &SubtreeFunctions);
557 
558   /// Create the declaration of a kernel function.
559   ///
560   /// The kernel function takes as arguments:
561   ///
562   ///   - One i8 pointer for each external array reference used in the kernel.
563   ///   - Host iterators
564   ///   - Parameters
565   ///   - Other LLVM Value references (TODO)
566   ///
567   /// @param Kernel The kernel to generate the function declaration for.
568   /// @param SubtreeValues The set of llvm::Values referenced by this kernel.
569   ///
570   /// @returns The newly declared function.
571   Function *createKernelFunctionDecl(ppcg_kernel *Kernel,
572                                      SetVector<Value *> &SubtreeValues);
573 
574   /// Insert intrinsic functions to obtain thread and block ids.
575   ///
576   /// @param The kernel to generate the intrinsic functions for.
577   void insertKernelIntrinsics(ppcg_kernel *Kernel);
578 
579   /// Insert function calls to retrieve the SPIR group/local ids.
580   ///
581   /// @param The kernel to generate the function calls for.
582   void insertKernelCallsSPIR(ppcg_kernel *Kernel);
583 
584   /// Setup the creation of functions referenced by the GPU kernel.
585   ///
586   /// 1. Create new function declarations in GPUModule which are the same as
587   /// SubtreeFunctions.
588   ///
589   /// 2. Populate IslNodeBuilder::ValueMap with mappings from
590   /// old functions (that come from the original module) to new functions
591   /// (that are created within GPUModule). That way, we generate references
592   /// to the correct function (in GPUModule) in BlockGenerator.
593   ///
594   /// @see IslNodeBuilder::ValueMap
595   /// @see BlockGenerator::GlobalMap
596   /// @see BlockGenerator::getNewValue
597   /// @see GPUNodeBuilder::getReferencesInKernel.
598   ///
599   /// @param SubtreeFunctions The set of llvm::Functions referenced by
600   ///                         this kernel.
601   void setupKernelSubtreeFunctions(SetVector<Function *> SubtreeFunctions);
602 
603   /// Create a global-to-shared or shared-to-global copy statement.
604   ///
605   /// @param CopyStmt The copy statement to generate code for
606   void createKernelCopy(ppcg_kernel_stmt *CopyStmt);
607 
608   /// Create code for a ScopStmt called in @p Expr.
609   ///
610   /// @param Expr The expression containing the call.
611   /// @param KernelStmt The kernel statement referenced in the call.
612   void createScopStmt(isl_ast_expr *Expr, ppcg_kernel_stmt *KernelStmt);
613 
614   /// Create an in-kernel synchronization call.
615   void createKernelSync();
616 
617   /// Create a PTX assembly string for the current GPU kernel.
618   ///
619   /// @returns A string containing the corresponding PTX assembly code.
620   std::string createKernelASM();
621 
622   /// Remove references from the dominator tree to the kernel function @p F.
623   ///
624   /// @param F The function to remove references to.
625   void clearDominators(Function *F);
626 
627   /// Remove references from scalar evolution to the kernel function @p F.
628   ///
629   /// @param F The function to remove references to.
630   void clearScalarEvolution(Function *F);
631 
632   /// Remove references from loop info to the kernel function @p F.
633   ///
634   /// @param F The function to remove references to.
635   void clearLoops(Function *F);
636 
637   /// Check if the scop requires to be linked with CUDA's libdevice.
638   bool requiresCUDALibDevice();
639 
640   /// Link with the NVIDIA libdevice library (if needed and available).
641   void addCUDALibDevice();
642 
643   /// Finalize the generation of the kernel function.
644   ///
645   /// Free the LLVM-IR module corresponding to the kernel and -- if requested --
646   /// dump its IR to stderr.
647   ///
648   /// @returns The Assembly string of the kernel.
649   std::string finalizeKernelFunction();
650 
651   /// Finalize the generation of the kernel arguments.
652   ///
653   /// This function ensures that not-read-only scalars used in a kernel are
654   /// stored back to the global memory location they are backed with before
655   /// the kernel terminates.
656   ///
657   /// @params Kernel The kernel to finalize kernel arguments for.
658   void finalizeKernelArguments(ppcg_kernel *Kernel);
659 
660   /// Create code that allocates memory to store arrays on device.
661   void allocateDeviceArrays();
662 
663   /// Create code to prepare the managed device pointers.
664   void prepareManagedDeviceArrays();
665 
666   /// Free all allocated device arrays.
667   void freeDeviceArrays();
668 
669   /// Create a call to initialize the GPU context.
670   ///
671   /// @returns A pointer to the newly initialized context.
672   Value *createCallInitContext();
673 
674   /// Create a call to get the device pointer for a kernel allocation.
675   ///
676   /// @param Allocation The Polly GPU allocation
677   ///
678   /// @returns The device parameter corresponding to this allocation.
679   Value *createCallGetDevicePtr(Value *Allocation);
680 
681   /// Create a call to free the GPU context.
682   ///
683   /// @param Context A pointer to an initialized GPU context.
684   void createCallFreeContext(Value *Context);
685 
686   /// Create a call to allocate memory on the device.
687   ///
688   /// @param Size The size of memory to allocate
689   ///
690   /// @returns A pointer that identifies this allocation.
691   Value *createCallAllocateMemoryForDevice(Value *Size);
692 
693   /// Create a call to free a device array.
694   ///
695   /// @param Array The device array to free.
696   void createCallFreeDeviceMemory(Value *Array);
697 
698   /// Create a call to copy data from host to device.
699   ///
700   /// @param HostPtr A pointer to the host data that should be copied.
701   /// @param DevicePtr A device pointer specifying the location to copy to.
702   void createCallCopyFromHostToDevice(Value *HostPtr, Value *DevicePtr,
703                                       Value *Size);
704 
705   /// Create a call to copy data from device to host.
706   ///
707   /// @param DevicePtr A pointer to the device data that should be copied.
708   /// @param HostPtr A host pointer specifying the location to copy to.
709   void createCallCopyFromDeviceToHost(Value *DevicePtr, Value *HostPtr,
710                                       Value *Size);
711 
712   /// Create a call to synchronize Host & Device.
713   /// \note
714   /// This is to be used only with managed memory.
715   void createCallSynchronizeDevice();
716 
717   /// Create a call to get a kernel from an assembly string.
718   ///
719   /// @param Buffer The string describing the kernel.
720   /// @param Entry  The name of the kernel function to call.
721   ///
722   /// @returns A pointer to a kernel object
723   Value *createCallGetKernel(Value *Buffer, Value *Entry);
724 
725   /// Create a call to free a GPU kernel.
726   ///
727   /// @param GPUKernel THe kernel to free.
728   void createCallFreeKernel(Value *GPUKernel);
729 
730   /// Create a call to launch a GPU kernel.
731   ///
732   /// @param GPUKernel  The kernel to launch.
733   /// @param GridDimX   The size of the first grid dimension.
734   /// @param GridDimY   The size of the second grid dimension.
735   /// @param GridBlockX The size of the first block dimension.
736   /// @param GridBlockY The size of the second block dimension.
737   /// @param GridBlockZ The size of the third block dimension.
738   /// @param Parameters A pointer to an array that contains itself pointers to
739   ///                   the parameter values passed for each kernel argument.
740   void createCallLaunchKernel(Value *GPUKernel, Value *GridDimX,
741                               Value *GridDimY, Value *BlockDimX,
742                               Value *BlockDimY, Value *BlockDimZ,
743                               Value *Parameters);
744 };
745 
746 std::string GPUNodeBuilder::getKernelFuncName(int Kernel_id) {
747   return "FUNC_" + S.getFunction().getName().str() + "_SCOP_" +
748          std::to_string(S.getID()) + "_KERNEL_" + std::to_string(Kernel_id);
749 }
750 
751 void GPUNodeBuilder::initializeAfterRTH() {
752   BasicBlock *NewBB = SplitBlock(Builder.GetInsertBlock(),
753                                  &*Builder.GetInsertPoint(), &DT, &LI);
754   NewBB->setName("polly.acc.initialize");
755   Builder.SetInsertPoint(&NewBB->front());
756 
757   GPUContext = createCallInitContext();
758 
759   if (!PollyManagedMemory)
760     allocateDeviceArrays();
761   else
762     prepareManagedDeviceArrays();
763 }
764 
765 void GPUNodeBuilder::finalize() {
766   if (!PollyManagedMemory)
767     freeDeviceArrays();
768 
769   createCallFreeContext(GPUContext);
770   IslNodeBuilder::finalize();
771 }
772 
773 void GPUNodeBuilder::allocateDeviceArrays() {
774   assert(!PollyManagedMemory &&
775          "Managed memory will directly send host pointers "
776          "to the kernel. There is no need for device arrays");
777   isl_ast_build *Build = isl_ast_build_from_context(S.getContext().release());
778 
779   for (int i = 0; i < Prog->n_array; ++i) {
780     gpu_array_info *Array = &Prog->array[i];
781     auto *ScopArray = (ScopArrayInfo *)Array->user;
782     std::string DevArrayName("p_dev_array_");
783     DevArrayName.append(Array->name);
784 
785     Value *ArraySize = getArraySize(Array);
786     Value *Offset = getArrayOffset(Array);
787     if (Offset)
788       ArraySize = Builder.CreateSub(
789           ArraySize,
790           Builder.CreateMul(Offset,
791                             Builder.getInt64(ScopArray->getElemSizeInBytes())));
792     const SCEV *SizeSCEV = SE.getSCEV(ArraySize);
793     // It makes no sense to have an array of size 0. The CUDA API will
794     // throw an error anyway if we invoke `cuMallocManaged` with size `0`. We
795     // choose to be defensive and catch this at the compile phase. It is
796     // most likely that we are doing something wrong with size computation.
797     if (SizeSCEV->isZero()) {
798       errs() << getUniqueScopName(&S)
799              << " has computed array size 0: " << *ArraySize
800              << " | for array: " << *(ScopArray->getBasePtr())
801              << ". This is illegal, exiting.\n";
802       report_fatal_error("array size was computed to be 0");
803     }
804 
805     Value *DevArray = createCallAllocateMemoryForDevice(ArraySize);
806     DevArray->setName(DevArrayName);
807     DeviceAllocations[ScopArray] = DevArray;
808   }
809 
810   isl_ast_build_free(Build);
811 }
812 
813 void GPUNodeBuilder::prepareManagedDeviceArrays() {
814   assert(PollyManagedMemory &&
815          "Device array most only be prepared in managed-memory mode");
816   for (int i = 0; i < Prog->n_array; ++i) {
817     gpu_array_info *Array = &Prog->array[i];
818     ScopArrayInfo *ScopArray = (ScopArrayInfo *)Array->user;
819     Value *HostPtr;
820 
821     if (gpu_array_is_scalar(Array))
822       HostPtr = BlockGen.getOrCreateAlloca(ScopArray);
823     else
824       HostPtr = ScopArray->getBasePtr();
825     HostPtr = getLatestValue(HostPtr);
826 
827     Value *Offset = getArrayOffset(Array);
828     if (Offset) {
829       HostPtr = Builder.CreatePointerCast(
830           HostPtr, ScopArray->getElementType()->getPointerTo());
831       HostPtr = Builder.CreateGEP(HostPtr, Offset);
832     }
833 
834     HostPtr = Builder.CreatePointerCast(HostPtr, Builder.getInt8PtrTy());
835     DeviceAllocations[ScopArray] = HostPtr;
836   }
837 }
838 
839 void GPUNodeBuilder::addCUDAAnnotations(Module *M, Value *BlockDimX,
840                                         Value *BlockDimY, Value *BlockDimZ) {
841   auto AnnotationNode = M->getOrInsertNamedMetadata("nvvm.annotations");
842 
843   for (auto &F : *M) {
844     if (F.getCallingConv() != CallingConv::PTX_Kernel)
845       continue;
846 
847     Value *V[] = {BlockDimX, BlockDimY, BlockDimZ};
848 
849     Metadata *Elements[] = {
850         ValueAsMetadata::get(&F),   MDString::get(M->getContext(), "maxntidx"),
851         ValueAsMetadata::get(V[0]), MDString::get(M->getContext(), "maxntidy"),
852         ValueAsMetadata::get(V[1]), MDString::get(M->getContext(), "maxntidz"),
853         ValueAsMetadata::get(V[2]),
854     };
855     MDNode *Node = MDNode::get(M->getContext(), Elements);
856     AnnotationNode->addOperand(Node);
857   }
858 }
859 
860 void GPUNodeBuilder::freeDeviceArrays() {
861   assert(!PollyManagedMemory && "Managed memory does not use device arrays");
862   for (auto &Array : DeviceAllocations)
863     createCallFreeDeviceMemory(Array.second);
864 }
865 
866 Value *GPUNodeBuilder::createCallGetKernel(Value *Buffer, Value *Entry) {
867   const char *Name = "polly_getKernel";
868   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
869   Function *F = M->getFunction(Name);
870 
871   // If F is not available, declare it.
872   if (!F) {
873     GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
874     std::vector<Type *> Args;
875     Args.push_back(Builder.getInt8PtrTy());
876     Args.push_back(Builder.getInt8PtrTy());
877     FunctionType *Ty = FunctionType::get(Builder.getInt8PtrTy(), Args, false);
878     F = Function::Create(Ty, Linkage, Name, M);
879   }
880 
881   return Builder.CreateCall(F, {Buffer, Entry});
882 }
883 
884 Value *GPUNodeBuilder::createCallGetDevicePtr(Value *Allocation) {
885   const char *Name = "polly_getDevicePtr";
886   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
887   Function *F = M->getFunction(Name);
888 
889   // If F is not available, declare it.
890   if (!F) {
891     GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
892     std::vector<Type *> Args;
893     Args.push_back(Builder.getInt8PtrTy());
894     FunctionType *Ty = FunctionType::get(Builder.getInt8PtrTy(), Args, false);
895     F = Function::Create(Ty, Linkage, Name, M);
896   }
897 
898   return Builder.CreateCall(F, {Allocation});
899 }
900 
901 void GPUNodeBuilder::createCallLaunchKernel(Value *GPUKernel, Value *GridDimX,
902                                             Value *GridDimY, Value *BlockDimX,
903                                             Value *BlockDimY, Value *BlockDimZ,
904                                             Value *Parameters) {
905   const char *Name = "polly_launchKernel";
906   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
907   Function *F = M->getFunction(Name);
908 
909   // If F is not available, declare it.
910   if (!F) {
911     GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
912     std::vector<Type *> Args;
913     Args.push_back(Builder.getInt8PtrTy());
914     Args.push_back(Builder.getInt32Ty());
915     Args.push_back(Builder.getInt32Ty());
916     Args.push_back(Builder.getInt32Ty());
917     Args.push_back(Builder.getInt32Ty());
918     Args.push_back(Builder.getInt32Ty());
919     Args.push_back(Builder.getInt8PtrTy());
920     FunctionType *Ty = FunctionType::get(Builder.getVoidTy(), Args, false);
921     F = Function::Create(Ty, Linkage, Name, M);
922   }
923 
924   Builder.CreateCall(F, {GPUKernel, GridDimX, GridDimY, BlockDimX, BlockDimY,
925                          BlockDimZ, Parameters});
926 }
927 
928 void GPUNodeBuilder::createCallFreeKernel(Value *GPUKernel) {
929   const char *Name = "polly_freeKernel";
930   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
931   Function *F = M->getFunction(Name);
932 
933   // If F is not available, declare it.
934   if (!F) {
935     GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
936     std::vector<Type *> Args;
937     Args.push_back(Builder.getInt8PtrTy());
938     FunctionType *Ty = FunctionType::get(Builder.getVoidTy(), Args, false);
939     F = Function::Create(Ty, Linkage, Name, M);
940   }
941 
942   Builder.CreateCall(F, {GPUKernel});
943 }
944 
945 void GPUNodeBuilder::createCallFreeDeviceMemory(Value *Array) {
946   assert(!PollyManagedMemory &&
947          "Managed memory does not allocate or free memory "
948          "for device");
949   const char *Name = "polly_freeDeviceMemory";
950   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
951   Function *F = M->getFunction(Name);
952 
953   // If F is not available, declare it.
954   if (!F) {
955     GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
956     std::vector<Type *> Args;
957     Args.push_back(Builder.getInt8PtrTy());
958     FunctionType *Ty = FunctionType::get(Builder.getVoidTy(), Args, false);
959     F = Function::Create(Ty, Linkage, Name, M);
960   }
961 
962   Builder.CreateCall(F, {Array});
963 }
964 
965 Value *GPUNodeBuilder::createCallAllocateMemoryForDevice(Value *Size) {
966   assert(!PollyManagedMemory &&
967          "Managed memory does not allocate or free memory "
968          "for device");
969   const char *Name = "polly_allocateMemoryForDevice";
970   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
971   Function *F = M->getFunction(Name);
972 
973   // If F is not available, declare it.
974   if (!F) {
975     GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
976     std::vector<Type *> Args;
977     Args.push_back(Builder.getInt64Ty());
978     FunctionType *Ty = FunctionType::get(Builder.getInt8PtrTy(), Args, false);
979     F = Function::Create(Ty, Linkage, Name, M);
980   }
981 
982   return Builder.CreateCall(F, {Size});
983 }
984 
985 void GPUNodeBuilder::createCallCopyFromHostToDevice(Value *HostData,
986                                                     Value *DeviceData,
987                                                     Value *Size) {
988   assert(!PollyManagedMemory &&
989          "Managed memory does not transfer memory between "
990          "device and host");
991   const char *Name = "polly_copyFromHostToDevice";
992   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
993   Function *F = M->getFunction(Name);
994 
995   // If F is not available, declare it.
996   if (!F) {
997     GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
998     std::vector<Type *> Args;
999     Args.push_back(Builder.getInt8PtrTy());
1000     Args.push_back(Builder.getInt8PtrTy());
1001     Args.push_back(Builder.getInt64Ty());
1002     FunctionType *Ty = FunctionType::get(Builder.getVoidTy(), Args, false);
1003     F = Function::Create(Ty, Linkage, Name, M);
1004   }
1005 
1006   Builder.CreateCall(F, {HostData, DeviceData, Size});
1007 }
1008 
1009 void GPUNodeBuilder::createCallCopyFromDeviceToHost(Value *DeviceData,
1010                                                     Value *HostData,
1011                                                     Value *Size) {
1012   assert(!PollyManagedMemory &&
1013          "Managed memory does not transfer memory between "
1014          "device and host");
1015   const char *Name = "polly_copyFromDeviceToHost";
1016   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
1017   Function *F = M->getFunction(Name);
1018 
1019   // If F is not available, declare it.
1020   if (!F) {
1021     GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
1022     std::vector<Type *> Args;
1023     Args.push_back(Builder.getInt8PtrTy());
1024     Args.push_back(Builder.getInt8PtrTy());
1025     Args.push_back(Builder.getInt64Ty());
1026     FunctionType *Ty = FunctionType::get(Builder.getVoidTy(), Args, false);
1027     F = Function::Create(Ty, Linkage, Name, M);
1028   }
1029 
1030   Builder.CreateCall(F, {DeviceData, HostData, Size});
1031 }
1032 
1033 void GPUNodeBuilder::createCallSynchronizeDevice() {
1034   assert(PollyManagedMemory && "explicit synchronization is only necessary for "
1035                                "managed memory");
1036   const char *Name = "polly_synchronizeDevice";
1037   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
1038   Function *F = M->getFunction(Name);
1039 
1040   // If F is not available, declare it.
1041   if (!F) {
1042     GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
1043     FunctionType *Ty = FunctionType::get(Builder.getVoidTy(), false);
1044     F = Function::Create(Ty, Linkage, Name, M);
1045   }
1046 
1047   Builder.CreateCall(F);
1048 }
1049 
1050 Value *GPUNodeBuilder::createCallInitContext() {
1051   const char *Name;
1052 
1053   switch (Runtime) {
1054   case GPURuntime::CUDA:
1055     Name = "polly_initContextCUDA";
1056     break;
1057   case GPURuntime::OpenCL:
1058     Name = "polly_initContextCL";
1059     break;
1060   }
1061 
1062   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
1063   Function *F = M->getFunction(Name);
1064 
1065   // If F is not available, declare it.
1066   if (!F) {
1067     GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
1068     std::vector<Type *> Args;
1069     FunctionType *Ty = FunctionType::get(Builder.getInt8PtrTy(), Args, false);
1070     F = Function::Create(Ty, Linkage, Name, M);
1071   }
1072 
1073   return Builder.CreateCall(F, {});
1074 }
1075 
1076 void GPUNodeBuilder::createCallFreeContext(Value *Context) {
1077   const char *Name = "polly_freeContext";
1078   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
1079   Function *F = M->getFunction(Name);
1080 
1081   // If F is not available, declare it.
1082   if (!F) {
1083     GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
1084     std::vector<Type *> Args;
1085     Args.push_back(Builder.getInt8PtrTy());
1086     FunctionType *Ty = FunctionType::get(Builder.getVoidTy(), Args, false);
1087     F = Function::Create(Ty, Linkage, Name, M);
1088   }
1089 
1090   Builder.CreateCall(F, {Context});
1091 }
1092 
1093 /// Check if one string is a prefix of another.
1094 ///
1095 /// @param String The string in which to look for the prefix.
1096 /// @param Prefix The prefix to look for.
1097 static bool isPrefix(std::string String, std::string Prefix) {
1098   return String.find(Prefix) == 0;
1099 }
1100 
1101 Value *GPUNodeBuilder::getArraySize(gpu_array_info *Array) {
1102   isl::ast_build Build = isl::ast_build::from_context(S.getContext());
1103   Value *ArraySize = ConstantInt::get(Builder.getInt64Ty(), Array->size);
1104 
1105   if (!gpu_array_is_scalar(Array)) {
1106     isl::multi_pw_aff ArrayBound = isl::manage_copy(Array->bound);
1107 
1108     isl::pw_aff OffsetDimZero = ArrayBound.get_pw_aff(0);
1109     isl::ast_expr Res = Build.expr_from(OffsetDimZero);
1110 
1111     for (unsigned int i = 1; i < Array->n_index; i++) {
1112       isl::pw_aff Bound_I = ArrayBound.get_pw_aff(i);
1113       isl::ast_expr Expr = Build.expr_from(Bound_I);
1114       Res = Res.mul(Expr);
1115     }
1116 
1117     Value *NumElements = ExprBuilder.create(Res.release());
1118     if (NumElements->getType() != ArraySize->getType())
1119       NumElements = Builder.CreateSExt(NumElements, ArraySize->getType());
1120     ArraySize = Builder.CreateMul(ArraySize, NumElements);
1121   }
1122   return ArraySize;
1123 }
1124 
1125 Value *GPUNodeBuilder::getArrayOffset(gpu_array_info *Array) {
1126   if (gpu_array_is_scalar(Array))
1127     return nullptr;
1128 
1129   isl::ast_build Build = isl::ast_build::from_context(S.getContext());
1130 
1131   isl::set Min = isl::manage_copy(Array->extent).lexmin();
1132 
1133   isl::set ZeroSet = isl::set::universe(Min.get_space());
1134 
1135   for (long i = 0, n = Min.dim(isl::dim::set); i < n; i++)
1136     ZeroSet = ZeroSet.fix_si(isl::dim::set, i, 0);
1137 
1138   if (Min.is_subset(ZeroSet)) {
1139     return nullptr;
1140   }
1141 
1142   isl::ast_expr Result = isl::ast_expr::from_val(isl::val(Min.get_ctx(), 0));
1143 
1144   for (long i = 0, n = Min.dim(isl::dim::set); i < n; i++) {
1145     if (i > 0) {
1146       isl::pw_aff Bound_I =
1147           isl::manage(isl_multi_pw_aff_get_pw_aff(Array->bound, i - 1));
1148       isl::ast_expr BExpr = Build.expr_from(Bound_I);
1149       Result = Result.mul(BExpr);
1150     }
1151     isl::pw_aff DimMin = Min.dim_min(i);
1152     isl::ast_expr MExpr = Build.expr_from(DimMin);
1153     Result = Result.add(MExpr);
1154   }
1155 
1156   return ExprBuilder.create(Result.release());
1157 }
1158 
1159 Value *GPUNodeBuilder::getManagedDeviceArray(gpu_array_info *Array,
1160                                              ScopArrayInfo *ArrayInfo) {
1161   assert(PollyManagedMemory && "Only used when you wish to get a host "
1162                                "pointer for sending data to the kernel, "
1163                                "with managed memory");
1164   std::map<ScopArrayInfo *, Value *>::iterator it;
1165   it = DeviceAllocations.find(ArrayInfo);
1166   assert(it != DeviceAllocations.end() &&
1167          "Device array expected to be available");
1168   return it->second;
1169 }
1170 
1171 void GPUNodeBuilder::createDataTransfer(__isl_take isl_ast_node *TransferStmt,
1172                                         enum DataDirection Direction) {
1173   assert(!PollyManagedMemory && "Managed memory needs no data transfers");
1174   isl_ast_expr *Expr = isl_ast_node_user_get_expr(TransferStmt);
1175   isl_ast_expr *Arg = isl_ast_expr_get_op_arg(Expr, 0);
1176   isl_id *Id = isl_ast_expr_get_id(Arg);
1177   auto Array = (gpu_array_info *)isl_id_get_user(Id);
1178   auto ScopArray = (ScopArrayInfo *)(Array->user);
1179 
1180   Value *Size = getArraySize(Array);
1181   Value *Offset = getArrayOffset(Array);
1182   Value *DevPtr = DeviceAllocations[ScopArray];
1183 
1184   Value *HostPtr;
1185 
1186   if (gpu_array_is_scalar(Array))
1187     HostPtr = BlockGen.getOrCreateAlloca(ScopArray);
1188   else
1189     HostPtr = ScopArray->getBasePtr();
1190   HostPtr = getLatestValue(HostPtr);
1191 
1192   if (Offset) {
1193     HostPtr = Builder.CreatePointerCast(
1194         HostPtr, ScopArray->getElementType()->getPointerTo());
1195     HostPtr = Builder.CreateGEP(HostPtr, Offset);
1196   }
1197 
1198   HostPtr = Builder.CreatePointerCast(HostPtr, Builder.getInt8PtrTy());
1199 
1200   if (Offset) {
1201     Size = Builder.CreateSub(
1202         Size, Builder.CreateMul(
1203                   Offset, Builder.getInt64(ScopArray->getElemSizeInBytes())));
1204   }
1205 
1206   if (Direction == HOST_TO_DEVICE)
1207     createCallCopyFromHostToDevice(HostPtr, DevPtr, Size);
1208   else
1209     createCallCopyFromDeviceToHost(DevPtr, HostPtr, Size);
1210 
1211   isl_id_free(Id);
1212   isl_ast_expr_free(Arg);
1213   isl_ast_expr_free(Expr);
1214   isl_ast_node_free(TransferStmt);
1215 }
1216 
1217 void GPUNodeBuilder::createUser(__isl_take isl_ast_node *UserStmt) {
1218   isl_ast_expr *Expr = isl_ast_node_user_get_expr(UserStmt);
1219   isl_ast_expr *StmtExpr = isl_ast_expr_get_op_arg(Expr, 0);
1220   isl_id *Id = isl_ast_expr_get_id(StmtExpr);
1221   isl_id_free(Id);
1222   isl_ast_expr_free(StmtExpr);
1223 
1224   const char *Str = isl_id_get_name(Id);
1225   if (!strcmp(Str, "kernel")) {
1226     createKernel(UserStmt);
1227     if (PollyManagedMemory)
1228       createCallSynchronizeDevice();
1229     isl_ast_expr_free(Expr);
1230     return;
1231   }
1232   if (!strcmp(Str, "init_device")) {
1233     initializeAfterRTH();
1234     isl_ast_node_free(UserStmt);
1235     isl_ast_expr_free(Expr);
1236     return;
1237   }
1238   if (!strcmp(Str, "clear_device")) {
1239     finalize();
1240     isl_ast_node_free(UserStmt);
1241     isl_ast_expr_free(Expr);
1242     return;
1243   }
1244   if (isPrefix(Str, "to_device")) {
1245     if (!PollyManagedMemory)
1246       createDataTransfer(UserStmt, HOST_TO_DEVICE);
1247     else
1248       isl_ast_node_free(UserStmt);
1249 
1250     isl_ast_expr_free(Expr);
1251     return;
1252   }
1253 
1254   if (isPrefix(Str, "from_device")) {
1255     if (!PollyManagedMemory) {
1256       createDataTransfer(UserStmt, DEVICE_TO_HOST);
1257     } else {
1258       isl_ast_node_free(UserStmt);
1259     }
1260     isl_ast_expr_free(Expr);
1261     return;
1262   }
1263 
1264   isl_id *Anno = isl_ast_node_get_annotation(UserStmt);
1265   struct ppcg_kernel_stmt *KernelStmt =
1266       (struct ppcg_kernel_stmt *)isl_id_get_user(Anno);
1267   isl_id_free(Anno);
1268 
1269   switch (KernelStmt->type) {
1270   case ppcg_kernel_domain:
1271     createScopStmt(Expr, KernelStmt);
1272     isl_ast_node_free(UserStmt);
1273     return;
1274   case ppcg_kernel_copy:
1275     createKernelCopy(KernelStmt);
1276     isl_ast_expr_free(Expr);
1277     isl_ast_node_free(UserStmt);
1278     return;
1279   case ppcg_kernel_sync:
1280     createKernelSync();
1281     isl_ast_expr_free(Expr);
1282     isl_ast_node_free(UserStmt);
1283     return;
1284   }
1285 
1286   isl_ast_expr_free(Expr);
1287   isl_ast_node_free(UserStmt);
1288 }
1289 
1290 void GPUNodeBuilder::createFor(__isl_take isl_ast_node *Node) {
1291   createForSequential(Node, false);
1292 }
1293 
1294 void GPUNodeBuilder::createKernelCopy(ppcg_kernel_stmt *KernelStmt) {
1295   isl_ast_expr *LocalIndex = isl_ast_expr_copy(KernelStmt->u.c.local_index);
1296   LocalIndex = isl_ast_expr_address_of(LocalIndex);
1297   Value *LocalAddr = ExprBuilder.create(LocalIndex);
1298   isl_ast_expr *Index = isl_ast_expr_copy(KernelStmt->u.c.index);
1299   Index = isl_ast_expr_address_of(Index);
1300   Value *GlobalAddr = ExprBuilder.create(Index);
1301 
1302   if (KernelStmt->u.c.read) {
1303     LoadInst *Load = Builder.CreateLoad(GlobalAddr, "shared.read");
1304     Builder.CreateStore(Load, LocalAddr);
1305   } else {
1306     LoadInst *Load = Builder.CreateLoad(LocalAddr, "shared.write");
1307     Builder.CreateStore(Load, GlobalAddr);
1308   }
1309 }
1310 
1311 void GPUNodeBuilder::createScopStmt(isl_ast_expr *Expr,
1312                                     ppcg_kernel_stmt *KernelStmt) {
1313   auto Stmt = (ScopStmt *)KernelStmt->u.d.stmt->stmt;
1314   isl_id_to_ast_expr *Indexes = KernelStmt->u.d.ref2expr;
1315 
1316   LoopToScevMapT LTS;
1317   LTS.insert(OutsideLoopIterations.begin(), OutsideLoopIterations.end());
1318 
1319   createSubstitutions(Expr, Stmt, LTS);
1320 
1321   if (Stmt->isBlockStmt())
1322     BlockGen.copyStmt(*Stmt, LTS, Indexes);
1323   else
1324     RegionGen.copyStmt(*Stmt, LTS, Indexes);
1325 }
1326 
1327 void GPUNodeBuilder::createKernelSync() {
1328   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
1329   const char *SpirName = "__gen_ocl_barrier_global";
1330 
1331   Function *Sync;
1332 
1333   switch (Arch) {
1334   case GPUArch::SPIR64:
1335   case GPUArch::SPIR32:
1336     Sync = M->getFunction(SpirName);
1337 
1338     // If Sync is not available, declare it.
1339     if (!Sync) {
1340       GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
1341       std::vector<Type *> Args;
1342       FunctionType *Ty = FunctionType::get(Builder.getVoidTy(), Args, false);
1343       Sync = Function::Create(Ty, Linkage, SpirName, M);
1344       Sync->setCallingConv(CallingConv::SPIR_FUNC);
1345     }
1346     break;
1347   case GPUArch::NVPTX64:
1348     Sync = Intrinsic::getDeclaration(M, Intrinsic::nvvm_barrier0);
1349     break;
1350   }
1351 
1352   Builder.CreateCall(Sync, {});
1353 }
1354 
1355 /// Collect llvm::Values referenced from @p Node
1356 ///
1357 /// This function only applies to isl_ast_nodes that are user_nodes referring
1358 /// to a ScopStmt. All other node types are ignore.
1359 ///
1360 /// @param Node The node to collect references for.
1361 /// @param User A user pointer used as storage for the data that is collected.
1362 ///
1363 /// @returns isl_bool_true if data could be collected successfully.
1364 isl_bool collectReferencesInGPUStmt(__isl_keep isl_ast_node *Node, void *User) {
1365   if (isl_ast_node_get_type(Node) != isl_ast_node_user)
1366     return isl_bool_true;
1367 
1368   isl_ast_expr *Expr = isl_ast_node_user_get_expr(Node);
1369   isl_ast_expr *StmtExpr = isl_ast_expr_get_op_arg(Expr, 0);
1370   isl_id *Id = isl_ast_expr_get_id(StmtExpr);
1371   const char *Str = isl_id_get_name(Id);
1372   isl_id_free(Id);
1373   isl_ast_expr_free(StmtExpr);
1374   isl_ast_expr_free(Expr);
1375 
1376   if (!isPrefix(Str, "Stmt"))
1377     return isl_bool_true;
1378 
1379   Id = isl_ast_node_get_annotation(Node);
1380   auto *KernelStmt = (ppcg_kernel_stmt *)isl_id_get_user(Id);
1381   auto Stmt = (ScopStmt *)KernelStmt->u.d.stmt->stmt;
1382   isl_id_free(Id);
1383 
1384   addReferencesFromStmt(Stmt, User, false /* CreateScalarRefs */);
1385 
1386   return isl_bool_true;
1387 }
1388 
1389 /// A list of functions that are available in NVIDIA's libdevice.
1390 const std::set<std::string> CUDALibDeviceFunctions = {
1391     "exp",      "expf",      "expl",      "cos", "cosf", "sqrt", "sqrtf",
1392     "copysign", "copysignf", "copysignl", "log", "logf", "powi", "powif"};
1393 
1394 // A map from intrinsics to their corresponding libdevice functions.
1395 const std::map<std::string, std::string> IntrinsicToLibdeviceFunc = {
1396     {"llvm.exp.f64", "exp"},
1397     {"llvm.exp.f32", "expf"},
1398     {"llvm.powi.f64", "powi"},
1399     {"llvm.powi.f32", "powif"}};
1400 
1401 /// Return the corresponding CUDA libdevice function name for @p F.
1402 /// Note that this function will try to convert instrinsics in the list
1403 /// IntrinsicToLibdeviceFunc into libdevice functions.
1404 /// This is because some intrinsics such as `exp`
1405 /// are not supported by the NVPTX backend.
1406 /// If this restriction of the backend is lifted, we should refactor our code
1407 /// so that we use intrinsics whenever possible.
1408 ///
1409 /// Return "" if we are not compiling for CUDA.
1410 std::string getCUDALibDeviceFuntion(Function *F) {
1411   const std::string FnName = [&] {
1412     auto It = IntrinsicToLibdeviceFunc.find(F->getName());
1413     if (It != IntrinsicToLibdeviceFunc.end())
1414       return It->second;
1415 
1416     return std::string(F->getName());
1417   }();
1418 
1419   if (CUDALibDeviceFunctions.count(FnName))
1420     return "__nv_" + FnName;
1421 
1422   return "";
1423 }
1424 
1425 /// Check if F is a function that we can code-generate in a GPU kernel.
1426 static bool isValidFunctionInKernel(llvm::Function *F, bool AllowLibDevice) {
1427   assert(F && "F is an invalid pointer");
1428   // We string compare against the name of the function to allow
1429   // all variants of the intrinsic "llvm.sqrt.*", "llvm.fabs", and
1430   // "llvm.copysign".
1431   const StringRef Name = F->getName();
1432 
1433   if (AllowLibDevice && getCUDALibDeviceFuntion(F).length() > 0)
1434     return true;
1435 
1436   return F->isIntrinsic() &&
1437          (Name.startswith("llvm.sqrt") || Name.startswith("llvm.fabs") ||
1438           Name.startswith("llvm.copysign"));
1439 }
1440 
1441 /// Do not take `Function` as a subtree value.
1442 ///
1443 /// We try to take the reference of all subtree values and pass them along
1444 /// to the kernel from the host. Taking an address of any function and
1445 /// trying to pass along is nonsensical. Only allow `Value`s that are not
1446 /// `Function`s.
1447 static bool isValidSubtreeValue(llvm::Value *V) { return !isa<Function>(V); }
1448 
1449 /// Return `Function`s from `RawSubtreeValues`.
1450 static SetVector<Function *>
1451 getFunctionsFromRawSubtreeValues(SetVector<Value *> RawSubtreeValues,
1452                                  bool AllowCUDALibDevice) {
1453   SetVector<Function *> SubtreeFunctions;
1454   for (Value *It : RawSubtreeValues) {
1455     Function *F = dyn_cast<Function>(It);
1456     if (F) {
1457       assert(isValidFunctionInKernel(F, AllowCUDALibDevice) &&
1458              "Code should have bailed out by "
1459              "this point if an invalid function "
1460              "were present in a kernel.");
1461       SubtreeFunctions.insert(F);
1462     }
1463   }
1464   return SubtreeFunctions;
1465 }
1466 
1467 std::tuple<SetVector<Value *>, SetVector<Function *>, SetVector<const Loop *>,
1468            isl::space>
1469 GPUNodeBuilder::getReferencesInKernel(ppcg_kernel *Kernel) {
1470   SetVector<Value *> SubtreeValues;
1471   SetVector<const SCEV *> SCEVs;
1472   SetVector<const Loop *> Loops;
1473   isl::space ParamSpace = isl::space(S.getIslCtx(), 0, 0).params();
1474   SubtreeReferences References = {
1475       LI,         SE, S, ValueMap, SubtreeValues, SCEVs, getBlockGenerator(),
1476       &ParamSpace};
1477 
1478   for (const auto &I : IDToValue)
1479     SubtreeValues.insert(I.second);
1480 
1481   // NOTE: this is populated in IslNodeBuilder::addParameters
1482   // See [Code generation of induction variables of loops outside Scops].
1483   for (const auto &I : OutsideLoopIterations)
1484     SubtreeValues.insert(cast<SCEVUnknown>(I.second)->getValue());
1485 
1486   isl_ast_node_foreach_descendant_top_down(
1487       Kernel->tree, collectReferencesInGPUStmt, &References);
1488 
1489   for (const SCEV *Expr : SCEVs) {
1490     findValues(Expr, SE, SubtreeValues);
1491     findLoops(Expr, Loops);
1492   }
1493 
1494   Loops.remove_if([this](const Loop *L) {
1495     return S.contains(L) || L->contains(S.getEntry());
1496   });
1497 
1498   for (auto &SAI : S.arrays())
1499     SubtreeValues.remove(SAI->getBasePtr());
1500 
1501   isl_space *Space = S.getParamSpace().release();
1502   for (long i = 0, n = isl_space_dim(Space, isl_dim_param); i < n; i++) {
1503     isl_id *Id = isl_space_get_dim_id(Space, isl_dim_param, i);
1504     assert(IDToValue.count(Id));
1505     Value *Val = IDToValue[Id];
1506     SubtreeValues.remove(Val);
1507     isl_id_free(Id);
1508   }
1509   isl_space_free(Space);
1510 
1511   for (long i = 0, n = isl_space_dim(Kernel->space, isl_dim_set); i < n; i++) {
1512     isl_id *Id = isl_space_get_dim_id(Kernel->space, isl_dim_set, i);
1513     assert(IDToValue.count(Id));
1514     Value *Val = IDToValue[Id];
1515     SubtreeValues.remove(Val);
1516     isl_id_free(Id);
1517   }
1518 
1519   // Note: { ValidSubtreeValues, ValidSubtreeFunctions } partitions
1520   // SubtreeValues. This is important, because we should not lose any
1521   // SubtreeValues in the process of constructing the
1522   // "ValidSubtree{Values, Functions} sets. Nor should the set
1523   // ValidSubtree{Values, Functions} have any common element.
1524   auto ValidSubtreeValuesIt =
1525       make_filter_range(SubtreeValues, isValidSubtreeValue);
1526   SetVector<Value *> ValidSubtreeValues(ValidSubtreeValuesIt.begin(),
1527                                         ValidSubtreeValuesIt.end());
1528 
1529   bool AllowCUDALibDevice = Arch == GPUArch::NVPTX64;
1530 
1531   SetVector<Function *> ValidSubtreeFunctions(
1532       getFunctionsFromRawSubtreeValues(SubtreeValues, AllowCUDALibDevice));
1533 
1534   // @see IslNodeBuilder::getReferencesInSubtree
1535   SetVector<Value *> ReplacedValues;
1536   for (Value *V : ValidSubtreeValues) {
1537     auto It = ValueMap.find(V);
1538     if (It == ValueMap.end())
1539       ReplacedValues.insert(V);
1540     else
1541       ReplacedValues.insert(It->second);
1542   }
1543   return std::make_tuple(ReplacedValues, ValidSubtreeFunctions, Loops,
1544                          ParamSpace);
1545 }
1546 
1547 void GPUNodeBuilder::clearDominators(Function *F) {
1548   DomTreeNode *N = DT.getNode(&F->getEntryBlock());
1549   std::vector<BasicBlock *> Nodes;
1550   for (po_iterator<DomTreeNode *> I = po_begin(N), E = po_end(N); I != E; ++I)
1551     Nodes.push_back(I->getBlock());
1552 
1553   for (BasicBlock *BB : Nodes)
1554     DT.eraseNode(BB);
1555 }
1556 
1557 void GPUNodeBuilder::clearScalarEvolution(Function *F) {
1558   for (auto *L : LI)
1559     if (L)
1560       SE.forgetLoop(L);
1561 }
1562 
1563 void GPUNodeBuilder::clearLoops(Function *F) {
1564   clearScalarEvolution(F);
1565   SmallVector<Loop *, 1> Loops(LI.begin(), LI.end());
1566   for (auto *L : Loops)
1567     LI.erase(L);
1568 }
1569 
1570 std::tuple<Value *, Value *> GPUNodeBuilder::getGridSizes(ppcg_kernel *Kernel) {
1571   std::vector<Value *> Sizes;
1572   isl::ast_build Context = isl::ast_build::from_context(S.getContext());
1573 
1574   isl::multi_pw_aff GridSizePwAffs = isl::manage_copy(Kernel->grid_size);
1575   for (long i = 0; i < Kernel->n_grid; i++) {
1576     isl::pw_aff Size = GridSizePwAffs.get_pw_aff(i);
1577     isl::ast_expr GridSize = Context.expr_from(Size);
1578     Value *Res = ExprBuilder.create(GridSize.release());
1579     Res = Builder.CreateTrunc(Res, Builder.getInt32Ty());
1580     Sizes.push_back(Res);
1581   }
1582 
1583   for (long i = Kernel->n_grid; i < 3; i++)
1584     Sizes.push_back(ConstantInt::get(Builder.getInt32Ty(), 1));
1585 
1586   return std::make_tuple(Sizes[0], Sizes[1]);
1587 }
1588 
1589 std::tuple<Value *, Value *, Value *>
1590 GPUNodeBuilder::getBlockSizes(ppcg_kernel *Kernel) {
1591   std::vector<Value *> Sizes;
1592 
1593   for (long i = 0; i < Kernel->n_block; i++) {
1594     Value *Res = ConstantInt::get(Builder.getInt32Ty(), Kernel->block_dim[i]);
1595     Sizes.push_back(Res);
1596   }
1597 
1598   for (long i = Kernel->n_block; i < 3; i++)
1599     Sizes.push_back(ConstantInt::get(Builder.getInt32Ty(), 1));
1600 
1601   return std::make_tuple(Sizes[0], Sizes[1], Sizes[2]);
1602 }
1603 
1604 void GPUNodeBuilder::insertStoreParameter(Instruction *Parameters,
1605                                           Instruction *Param, int Index) {
1606   Value *Slot = Builder.CreateGEP(
1607       Parameters, {Builder.getInt64(0), Builder.getInt64(Index)});
1608   Value *ParamTyped = Builder.CreatePointerCast(Param, Builder.getInt8PtrTy());
1609   Builder.CreateStore(ParamTyped, Slot);
1610 }
1611 
1612 Value *
1613 GPUNodeBuilder::createLaunchParameters(ppcg_kernel *Kernel, Function *F,
1614                                        SetVector<Value *> SubtreeValues) {
1615   const int NumArgs = F->arg_size();
1616   std::vector<int> ArgSizes(NumArgs);
1617 
1618   // If we are using the OpenCL Runtime, we need to add the kernel argument
1619   // sizes to the end of the launch-parameter list, so OpenCL can determine
1620   // how big the respective kernel arguments are.
1621   // Here we need to reserve adequate space for that.
1622   Type *ArrayTy;
1623   if (Runtime == GPURuntime::OpenCL)
1624     ArrayTy = ArrayType::get(Builder.getInt8PtrTy(), 2 * NumArgs);
1625   else
1626     ArrayTy = ArrayType::get(Builder.getInt8PtrTy(), NumArgs);
1627 
1628   BasicBlock *EntryBlock =
1629       &Builder.GetInsertBlock()->getParent()->getEntryBlock();
1630   auto AddressSpace = F->getParent()->getDataLayout().getAllocaAddrSpace();
1631   std::string Launch = "polly_launch_" + std::to_string(Kernel->id);
1632   Instruction *Parameters = new AllocaInst(
1633       ArrayTy, AddressSpace, Launch + "_params", EntryBlock->getTerminator());
1634 
1635   int Index = 0;
1636   for (long i = 0; i < Prog->n_array; i++) {
1637     if (!ppcg_kernel_requires_array_argument(Kernel, i))
1638       continue;
1639 
1640     isl_id *Id = isl_space_get_tuple_id(Prog->array[i].space, isl_dim_set);
1641     const ScopArrayInfo *SAI = ScopArrayInfo::getFromId(isl::manage(Id));
1642 
1643     if (Runtime == GPURuntime::OpenCL)
1644       ArgSizes[Index] = SAI->getElemSizeInBytes();
1645 
1646     Value *DevArray = nullptr;
1647     if (PollyManagedMemory) {
1648       DevArray = getManagedDeviceArray(&Prog->array[i],
1649                                        const_cast<ScopArrayInfo *>(SAI));
1650     } else {
1651       DevArray = DeviceAllocations[const_cast<ScopArrayInfo *>(SAI)];
1652       DevArray = createCallGetDevicePtr(DevArray);
1653     }
1654     assert(DevArray != nullptr && "Array to be offloaded to device not "
1655                                   "initialized");
1656     Value *Offset = getArrayOffset(&Prog->array[i]);
1657 
1658     if (Offset) {
1659       DevArray = Builder.CreatePointerCast(
1660           DevArray, SAI->getElementType()->getPointerTo());
1661       DevArray = Builder.CreateGEP(DevArray, Builder.CreateNeg(Offset));
1662       DevArray = Builder.CreatePointerCast(DevArray, Builder.getInt8PtrTy());
1663     }
1664     Value *Slot = Builder.CreateGEP(
1665         Parameters, {Builder.getInt64(0), Builder.getInt64(Index)});
1666 
1667     if (gpu_array_is_read_only_scalar(&Prog->array[i])) {
1668       Value *ValPtr = nullptr;
1669       if (PollyManagedMemory)
1670         ValPtr = DevArray;
1671       else
1672         ValPtr = BlockGen.getOrCreateAlloca(SAI);
1673 
1674       assert(ValPtr != nullptr && "ValPtr that should point to a valid object"
1675                                   " to be stored into Parameters");
1676       Value *ValPtrCast =
1677           Builder.CreatePointerCast(ValPtr, Builder.getInt8PtrTy());
1678       Builder.CreateStore(ValPtrCast, Slot);
1679     } else {
1680       Instruction *Param =
1681           new AllocaInst(Builder.getInt8PtrTy(), AddressSpace,
1682                          Launch + "_param_" + std::to_string(Index),
1683                          EntryBlock->getTerminator());
1684       Builder.CreateStore(DevArray, Param);
1685       Value *ParamTyped =
1686           Builder.CreatePointerCast(Param, Builder.getInt8PtrTy());
1687       Builder.CreateStore(ParamTyped, Slot);
1688     }
1689     Index++;
1690   }
1691 
1692   int NumHostIters = isl_space_dim(Kernel->space, isl_dim_set);
1693 
1694   for (long i = 0; i < NumHostIters; i++) {
1695     isl_id *Id = isl_space_get_dim_id(Kernel->space, isl_dim_set, i);
1696     Value *Val = IDToValue[Id];
1697     isl_id_free(Id);
1698 
1699     if (Runtime == GPURuntime::OpenCL)
1700       ArgSizes[Index] = computeSizeInBytes(Val->getType());
1701 
1702     Instruction *Param =
1703         new AllocaInst(Val->getType(), AddressSpace,
1704                        Launch + "_param_" + std::to_string(Index),
1705                        EntryBlock->getTerminator());
1706     Builder.CreateStore(Val, Param);
1707     insertStoreParameter(Parameters, Param, Index);
1708     Index++;
1709   }
1710 
1711   int NumVars = isl_space_dim(Kernel->space, isl_dim_param);
1712 
1713   for (long i = 0; i < NumVars; i++) {
1714     isl_id *Id = isl_space_get_dim_id(Kernel->space, isl_dim_param, i);
1715     Value *Val = IDToValue[Id];
1716     if (ValueMap.count(Val))
1717       Val = ValueMap[Val];
1718     isl_id_free(Id);
1719 
1720     if (Runtime == GPURuntime::OpenCL)
1721       ArgSizes[Index] = computeSizeInBytes(Val->getType());
1722 
1723     Instruction *Param =
1724         new AllocaInst(Val->getType(), AddressSpace,
1725                        Launch + "_param_" + std::to_string(Index),
1726                        EntryBlock->getTerminator());
1727     Builder.CreateStore(Val, Param);
1728     insertStoreParameter(Parameters, Param, Index);
1729     Index++;
1730   }
1731 
1732   for (auto Val : SubtreeValues) {
1733     if (Runtime == GPURuntime::OpenCL)
1734       ArgSizes[Index] = computeSizeInBytes(Val->getType());
1735 
1736     Instruction *Param =
1737         new AllocaInst(Val->getType(), AddressSpace,
1738                        Launch + "_param_" + std::to_string(Index),
1739                        EntryBlock->getTerminator());
1740     Builder.CreateStore(Val, Param);
1741     insertStoreParameter(Parameters, Param, Index);
1742     Index++;
1743   }
1744 
1745   if (Runtime == GPURuntime::OpenCL) {
1746     for (int i = 0; i < NumArgs; i++) {
1747       Value *Val = ConstantInt::get(Builder.getInt32Ty(), ArgSizes[i]);
1748       Instruction *Param =
1749           new AllocaInst(Builder.getInt32Ty(), AddressSpace,
1750                          Launch + "_param_size_" + std::to_string(i),
1751                          EntryBlock->getTerminator());
1752       Builder.CreateStore(Val, Param);
1753       insertStoreParameter(Parameters, Param, Index);
1754       Index++;
1755     }
1756   }
1757 
1758   auto Location = EntryBlock->getTerminator();
1759   return new BitCastInst(Parameters, Builder.getInt8PtrTy(),
1760                          Launch + "_params_i8ptr", Location);
1761 }
1762 
1763 void GPUNodeBuilder::setupKernelSubtreeFunctions(
1764     SetVector<Function *> SubtreeFunctions) {
1765   for (auto Fn : SubtreeFunctions) {
1766     const std::string ClonedFnName = Fn->getName();
1767     Function *Clone = GPUModule->getFunction(ClonedFnName);
1768     if (!Clone)
1769       Clone =
1770           Function::Create(Fn->getFunctionType(), GlobalValue::ExternalLinkage,
1771                            ClonedFnName, GPUModule.get());
1772     assert(Clone && "Expected cloned function to be initialized.");
1773     assert(ValueMap.find(Fn) == ValueMap.end() &&
1774            "Fn already present in ValueMap");
1775     ValueMap[Fn] = Clone;
1776   }
1777 }
1778 void GPUNodeBuilder::createKernel(__isl_take isl_ast_node *KernelStmt) {
1779   isl_id *Id = isl_ast_node_get_annotation(KernelStmt);
1780   ppcg_kernel *Kernel = (ppcg_kernel *)isl_id_get_user(Id);
1781   isl_id_free(Id);
1782   isl_ast_node_free(KernelStmt);
1783 
1784   if (Kernel->n_grid > 1)
1785     DeepestParallel =
1786         std::max(DeepestParallel, isl_space_dim(Kernel->space, isl_dim_set));
1787   else
1788     DeepestSequential =
1789         std::max(DeepestSequential, isl_space_dim(Kernel->space, isl_dim_set));
1790 
1791   Value *BlockDimX, *BlockDimY, *BlockDimZ;
1792   std::tie(BlockDimX, BlockDimY, BlockDimZ) = getBlockSizes(Kernel);
1793 
1794   SetVector<Value *> SubtreeValues;
1795   SetVector<Function *> SubtreeFunctions;
1796   SetVector<const Loop *> Loops;
1797   isl::space ParamSpace;
1798   std::tie(SubtreeValues, SubtreeFunctions, Loops, ParamSpace) =
1799       getReferencesInKernel(Kernel);
1800 
1801   // Add parameters that appear only in the access function to the kernel
1802   // space. This is important to make sure that all isl_ids are passed as
1803   // parameters to the kernel, even though we may not have all parameters
1804   // in the context to improve compile time.
1805   Kernel->space = isl_space_align_params(Kernel->space, ParamSpace.release());
1806 
1807   assert(Kernel->tree && "Device AST of kernel node is empty");
1808 
1809   Instruction &HostInsertPoint = *Builder.GetInsertPoint();
1810   IslExprBuilder::IDToValueTy HostIDs = IDToValue;
1811   ValueMapT HostValueMap = ValueMap;
1812   BlockGenerator::AllocaMapTy HostScalarMap = ScalarMap;
1813   ScalarMap.clear();
1814   BlockGenerator::EscapeUsersAllocaMapTy HostEscapeMap = EscapeMap;
1815   EscapeMap.clear();
1816 
1817   // Create for all loops we depend on values that contain the current loop
1818   // iteration. These values are necessary to generate code for SCEVs that
1819   // depend on such loops. As a result we need to pass them to the subfunction.
1820   for (const Loop *L : Loops) {
1821     const SCEV *OuterLIV = SE.getAddRecExpr(SE.getUnknown(Builder.getInt64(0)),
1822                                             SE.getUnknown(Builder.getInt64(1)),
1823                                             L, SCEV::FlagAnyWrap);
1824     Value *V = generateSCEV(OuterLIV);
1825     OutsideLoopIterations[L] = SE.getUnknown(V);
1826     SubtreeValues.insert(V);
1827   }
1828 
1829   createKernelFunction(Kernel, SubtreeValues, SubtreeFunctions);
1830   setupKernelSubtreeFunctions(SubtreeFunctions);
1831 
1832   create(isl_ast_node_copy(Kernel->tree));
1833 
1834   finalizeKernelArguments(Kernel);
1835   Function *F = Builder.GetInsertBlock()->getParent();
1836   if (Arch == GPUArch::NVPTX64)
1837     addCUDAAnnotations(F->getParent(), BlockDimX, BlockDimY, BlockDimZ);
1838   clearDominators(F);
1839   clearScalarEvolution(F);
1840   clearLoops(F);
1841 
1842   IDToValue = HostIDs;
1843 
1844   ValueMap = std::move(HostValueMap);
1845   ScalarMap = std::move(HostScalarMap);
1846   EscapeMap = std::move(HostEscapeMap);
1847   IDToSAI.clear();
1848   Annotator.resetAlternativeAliasBases();
1849   for (auto &BasePtr : LocalArrays)
1850     S.invalidateScopArrayInfo(BasePtr, MemoryKind::Array);
1851   LocalArrays.clear();
1852 
1853   std::string ASMString = finalizeKernelFunction();
1854   Builder.SetInsertPoint(&HostInsertPoint);
1855   Value *Parameters = createLaunchParameters(Kernel, F, SubtreeValues);
1856 
1857   std::string Name = getKernelFuncName(Kernel->id);
1858   Value *KernelString = Builder.CreateGlobalStringPtr(ASMString, Name);
1859   Value *NameString = Builder.CreateGlobalStringPtr(Name, Name + "_name");
1860   Value *GPUKernel = createCallGetKernel(KernelString, NameString);
1861 
1862   Value *GridDimX, *GridDimY;
1863   std::tie(GridDimX, GridDimY) = getGridSizes(Kernel);
1864 
1865   createCallLaunchKernel(GPUKernel, GridDimX, GridDimY, BlockDimX, BlockDimY,
1866                          BlockDimZ, Parameters);
1867   createCallFreeKernel(GPUKernel);
1868 
1869   for (auto Id : KernelIds)
1870     isl_id_free(Id);
1871 
1872   KernelIds.clear();
1873 }
1874 
1875 /// Compute the DataLayout string for the NVPTX backend.
1876 ///
1877 /// @param is64Bit Are we looking for a 64 bit architecture?
1878 static std::string computeNVPTXDataLayout(bool is64Bit) {
1879   std::string Ret = "";
1880 
1881   if (!is64Bit) {
1882     Ret += "e-p:32:32:32-i1:8:8-i8:8:8-i16:16:16-i32:32:32-i64:64:"
1883            "64-i128:128:128-f32:32:32-f64:64:64-v16:16:16-v32:32:32-v64:64:"
1884            "64-v128:128:128-n16:32:64";
1885   } else {
1886     Ret += "e-p:64:64:64-i1:8:8-i8:8:8-i16:16:16-i32:32:32-i64:64:"
1887            "64-i128:128:128-f32:32:32-f64:64:64-v16:16:16-v32:32:32-v64:64:"
1888            "64-v128:128:128-n16:32:64";
1889   }
1890 
1891   return Ret;
1892 }
1893 
1894 /// Compute the DataLayout string for a SPIR kernel.
1895 ///
1896 /// @param is64Bit Are we looking for a 64 bit architecture?
1897 static std::string computeSPIRDataLayout(bool is64Bit) {
1898   std::string Ret = "";
1899 
1900   if (!is64Bit) {
1901     Ret += "e-p:32:32:32-i1:8:8-i8:8:8-i16:16:16-i32:32:32-i64:64:"
1902            "64-i128:128:128-f32:32:32-f64:64:64-v16:16:16-v24:32:32-v32:32:"
1903            "32-v48:64:64-v64:64:64-v96:128:128-v128:128:128-v192:"
1904            "256:256-v256:256:256-v512:512:512-v1024:1024:1024";
1905   } else {
1906     Ret += "e-p:64:64:64-i1:8:8-i8:8:8-i16:16:16-i32:32:32-i64:64:"
1907            "64-i128:128:128-f32:32:32-f64:64:64-v16:16:16-v24:32:32-v32:32:"
1908            "32-v48:64:64-v64:64:64-v96:128:128-v128:128:128-v192:"
1909            "256:256-v256:256:256-v512:512:512-v1024:1024:1024";
1910   }
1911 
1912   return Ret;
1913 }
1914 
1915 Function *
1916 GPUNodeBuilder::createKernelFunctionDecl(ppcg_kernel *Kernel,
1917                                          SetVector<Value *> &SubtreeValues) {
1918   std::vector<Type *> Args;
1919   std::string Identifier = getKernelFuncName(Kernel->id);
1920 
1921   std::vector<Metadata *> MemoryType;
1922 
1923   for (long i = 0; i < Prog->n_array; i++) {
1924     if (!ppcg_kernel_requires_array_argument(Kernel, i))
1925       continue;
1926 
1927     if (gpu_array_is_read_only_scalar(&Prog->array[i])) {
1928       isl_id *Id = isl_space_get_tuple_id(Prog->array[i].space, isl_dim_set);
1929       const ScopArrayInfo *SAI = ScopArrayInfo::getFromId(isl::manage(Id));
1930       Args.push_back(SAI->getElementType());
1931       MemoryType.push_back(
1932           ConstantAsMetadata::get(ConstantInt::get(Builder.getInt32Ty(), 0)));
1933     } else {
1934       static const int UseGlobalMemory = 1;
1935       Args.push_back(Builder.getInt8PtrTy(UseGlobalMemory));
1936       MemoryType.push_back(
1937           ConstantAsMetadata::get(ConstantInt::get(Builder.getInt32Ty(), 1)));
1938     }
1939   }
1940 
1941   int NumHostIters = isl_space_dim(Kernel->space, isl_dim_set);
1942 
1943   for (long i = 0; i < NumHostIters; i++) {
1944     Args.push_back(Builder.getInt64Ty());
1945     MemoryType.push_back(
1946         ConstantAsMetadata::get(ConstantInt::get(Builder.getInt32Ty(), 0)));
1947   }
1948 
1949   int NumVars = isl_space_dim(Kernel->space, isl_dim_param);
1950 
1951   for (long i = 0; i < NumVars; i++) {
1952     isl_id *Id = isl_space_get_dim_id(Kernel->space, isl_dim_param, i);
1953     Value *Val = IDToValue[Id];
1954     isl_id_free(Id);
1955     Args.push_back(Val->getType());
1956     MemoryType.push_back(
1957         ConstantAsMetadata::get(ConstantInt::get(Builder.getInt32Ty(), 0)));
1958   }
1959 
1960   for (auto *V : SubtreeValues) {
1961     Args.push_back(V->getType());
1962     MemoryType.push_back(
1963         ConstantAsMetadata::get(ConstantInt::get(Builder.getInt32Ty(), 0)));
1964   }
1965 
1966   auto *FT = FunctionType::get(Builder.getVoidTy(), Args, false);
1967   auto *FN = Function::Create(FT, Function::ExternalLinkage, Identifier,
1968                               GPUModule.get());
1969 
1970   std::vector<Metadata *> EmptyStrings;
1971 
1972   for (unsigned int i = 0; i < MemoryType.size(); i++) {
1973     EmptyStrings.push_back(MDString::get(FN->getContext(), ""));
1974   }
1975 
1976   if (Arch == GPUArch::SPIR32 || Arch == GPUArch::SPIR64) {
1977     FN->setMetadata("kernel_arg_addr_space",
1978                     MDNode::get(FN->getContext(), MemoryType));
1979     FN->setMetadata("kernel_arg_name",
1980                     MDNode::get(FN->getContext(), EmptyStrings));
1981     FN->setMetadata("kernel_arg_access_qual",
1982                     MDNode::get(FN->getContext(), EmptyStrings));
1983     FN->setMetadata("kernel_arg_type",
1984                     MDNode::get(FN->getContext(), EmptyStrings));
1985     FN->setMetadata("kernel_arg_type_qual",
1986                     MDNode::get(FN->getContext(), EmptyStrings));
1987     FN->setMetadata("kernel_arg_base_type",
1988                     MDNode::get(FN->getContext(), EmptyStrings));
1989   }
1990 
1991   switch (Arch) {
1992   case GPUArch::NVPTX64:
1993     FN->setCallingConv(CallingConv::PTX_Kernel);
1994     break;
1995   case GPUArch::SPIR32:
1996   case GPUArch::SPIR64:
1997     FN->setCallingConv(CallingConv::SPIR_KERNEL);
1998     break;
1999   }
2000 
2001   auto Arg = FN->arg_begin();
2002   for (long i = 0; i < Kernel->n_array; i++) {
2003     if (!ppcg_kernel_requires_array_argument(Kernel, i))
2004       continue;
2005 
2006     Arg->setName(Kernel->array[i].array->name);
2007 
2008     isl_id *Id = isl_space_get_tuple_id(Prog->array[i].space, isl_dim_set);
2009     const ScopArrayInfo *SAI = ScopArrayInfo::getFromId(isl::manage_copy(Id));
2010     Type *EleTy = SAI->getElementType();
2011     Value *Val = &*Arg;
2012     SmallVector<const SCEV *, 4> Sizes;
2013     isl_ast_build *Build =
2014         isl_ast_build_from_context(isl_set_copy(Prog->context));
2015     Sizes.push_back(nullptr);
2016     for (long j = 1, n = Kernel->array[i].array->n_index; j < n; j++) {
2017       isl_ast_expr *DimSize = isl_ast_build_expr_from_pw_aff(
2018           Build, isl_multi_pw_aff_get_pw_aff(Kernel->array[i].array->bound, j));
2019       auto V = ExprBuilder.create(DimSize);
2020       Sizes.push_back(SE.getSCEV(V));
2021     }
2022     const ScopArrayInfo *SAIRep =
2023         S.getOrCreateScopArrayInfo(Val, EleTy, Sizes, MemoryKind::Array);
2024     LocalArrays.push_back(Val);
2025 
2026     isl_ast_build_free(Build);
2027     KernelIds.push_back(Id);
2028     IDToSAI[Id] = SAIRep;
2029     Arg++;
2030   }
2031 
2032   for (long i = 0; i < NumHostIters; i++) {
2033     isl_id *Id = isl_space_get_dim_id(Kernel->space, isl_dim_set, i);
2034     Arg->setName(isl_id_get_name(Id));
2035     IDToValue[Id] = &*Arg;
2036     KernelIDs.insert(std::unique_ptr<isl_id, IslIdDeleter>(Id));
2037     Arg++;
2038   }
2039 
2040   for (long i = 0; i < NumVars; i++) {
2041     isl_id *Id = isl_space_get_dim_id(Kernel->space, isl_dim_param, i);
2042     Arg->setName(isl_id_get_name(Id));
2043     Value *Val = IDToValue[Id];
2044     ValueMap[Val] = &*Arg;
2045     IDToValue[Id] = &*Arg;
2046     KernelIDs.insert(std::unique_ptr<isl_id, IslIdDeleter>(Id));
2047     Arg++;
2048   }
2049 
2050   for (auto *V : SubtreeValues) {
2051     Arg->setName(V->getName());
2052     ValueMap[V] = &*Arg;
2053     Arg++;
2054   }
2055 
2056   return FN;
2057 }
2058 
2059 void GPUNodeBuilder::insertKernelIntrinsics(ppcg_kernel *Kernel) {
2060   Intrinsic::ID IntrinsicsBID[2];
2061   Intrinsic::ID IntrinsicsTID[3];
2062 
2063   switch (Arch) {
2064   case GPUArch::SPIR64:
2065   case GPUArch::SPIR32:
2066     llvm_unreachable("Cannot generate NVVM intrinsics for SPIR");
2067   case GPUArch::NVPTX64:
2068     IntrinsicsBID[0] = Intrinsic::nvvm_read_ptx_sreg_ctaid_x;
2069     IntrinsicsBID[1] = Intrinsic::nvvm_read_ptx_sreg_ctaid_y;
2070 
2071     IntrinsicsTID[0] = Intrinsic::nvvm_read_ptx_sreg_tid_x;
2072     IntrinsicsTID[1] = Intrinsic::nvvm_read_ptx_sreg_tid_y;
2073     IntrinsicsTID[2] = Intrinsic::nvvm_read_ptx_sreg_tid_z;
2074     break;
2075   }
2076 
2077   auto addId = [this](__isl_take isl_id *Id, Intrinsic::ID Intr) mutable {
2078     std::string Name = isl_id_get_name(Id);
2079     Module *M = Builder.GetInsertBlock()->getParent()->getParent();
2080     Function *IntrinsicFn = Intrinsic::getDeclaration(M, Intr);
2081     Value *Val = Builder.CreateCall(IntrinsicFn, {});
2082     Val = Builder.CreateIntCast(Val, Builder.getInt64Ty(), false, Name);
2083     IDToValue[Id] = Val;
2084     KernelIDs.insert(std::unique_ptr<isl_id, IslIdDeleter>(Id));
2085   };
2086 
2087   for (int i = 0; i < Kernel->n_grid; ++i) {
2088     isl_id *Id = isl_id_list_get_id(Kernel->block_ids, i);
2089     addId(Id, IntrinsicsBID[i]);
2090   }
2091 
2092   for (int i = 0; i < Kernel->n_block; ++i) {
2093     isl_id *Id = isl_id_list_get_id(Kernel->thread_ids, i);
2094     addId(Id, IntrinsicsTID[i]);
2095   }
2096 }
2097 
2098 void GPUNodeBuilder::insertKernelCallsSPIR(ppcg_kernel *Kernel) {
2099   const char *GroupName[3] = {"__gen_ocl_get_group_id0",
2100                               "__gen_ocl_get_group_id1",
2101                               "__gen_ocl_get_group_id2"};
2102 
2103   const char *LocalName[3] = {"__gen_ocl_get_local_id0",
2104                               "__gen_ocl_get_local_id1",
2105                               "__gen_ocl_get_local_id2"};
2106 
2107   auto createFunc = [this](const char *Name, __isl_take isl_id *Id) mutable {
2108     Module *M = Builder.GetInsertBlock()->getParent()->getParent();
2109     Function *FN = M->getFunction(Name);
2110 
2111     // If FN is not available, declare it.
2112     if (!FN) {
2113       GlobalValue::LinkageTypes Linkage = Function::ExternalLinkage;
2114       std::vector<Type *> Args;
2115       FunctionType *Ty = FunctionType::get(Builder.getInt32Ty(), Args, false);
2116       FN = Function::Create(Ty, Linkage, Name, M);
2117       FN->setCallingConv(CallingConv::SPIR_FUNC);
2118     }
2119 
2120     Value *Val = Builder.CreateCall(FN, {});
2121     Val = Builder.CreateIntCast(Val, Builder.getInt64Ty(), false, Name);
2122     IDToValue[Id] = Val;
2123     KernelIDs.insert(std::unique_ptr<isl_id, IslIdDeleter>(Id));
2124   };
2125 
2126   for (int i = 0; i < Kernel->n_grid; ++i)
2127     createFunc(GroupName[i], isl_id_list_get_id(Kernel->block_ids, i));
2128 
2129   for (int i = 0; i < Kernel->n_block; ++i)
2130     createFunc(LocalName[i], isl_id_list_get_id(Kernel->thread_ids, i));
2131 }
2132 
2133 void GPUNodeBuilder::prepareKernelArguments(ppcg_kernel *Kernel, Function *FN) {
2134   auto Arg = FN->arg_begin();
2135   for (long i = 0; i < Kernel->n_array; i++) {
2136     if (!ppcg_kernel_requires_array_argument(Kernel, i))
2137       continue;
2138 
2139     isl_id *Id = isl_space_get_tuple_id(Prog->array[i].space, isl_dim_set);
2140     const ScopArrayInfo *SAI = ScopArrayInfo::getFromId(isl::manage_copy(Id));
2141     isl_id_free(Id);
2142 
2143     if (SAI->getNumberOfDimensions() > 0) {
2144       Arg++;
2145       continue;
2146     }
2147 
2148     Value *Val = &*Arg;
2149 
2150     if (!gpu_array_is_read_only_scalar(&Prog->array[i])) {
2151       Type *TypePtr = SAI->getElementType()->getPointerTo();
2152       Value *TypedArgPtr = Builder.CreatePointerCast(Val, TypePtr);
2153       Val = Builder.CreateLoad(TypedArgPtr);
2154     }
2155 
2156     Value *Alloca = BlockGen.getOrCreateAlloca(SAI);
2157     Builder.CreateStore(Val, Alloca);
2158 
2159     Arg++;
2160   }
2161 }
2162 
2163 void GPUNodeBuilder::finalizeKernelArguments(ppcg_kernel *Kernel) {
2164   auto *FN = Builder.GetInsertBlock()->getParent();
2165   auto Arg = FN->arg_begin();
2166 
2167   bool StoredScalar = false;
2168   for (long i = 0; i < Kernel->n_array; i++) {
2169     if (!ppcg_kernel_requires_array_argument(Kernel, i))
2170       continue;
2171 
2172     isl_id *Id = isl_space_get_tuple_id(Prog->array[i].space, isl_dim_set);
2173     const ScopArrayInfo *SAI = ScopArrayInfo::getFromId(isl::manage_copy(Id));
2174     isl_id_free(Id);
2175 
2176     if (SAI->getNumberOfDimensions() > 0) {
2177       Arg++;
2178       continue;
2179     }
2180 
2181     if (gpu_array_is_read_only_scalar(&Prog->array[i])) {
2182       Arg++;
2183       continue;
2184     }
2185 
2186     Value *Alloca = BlockGen.getOrCreateAlloca(SAI);
2187     Value *ArgPtr = &*Arg;
2188     Type *TypePtr = SAI->getElementType()->getPointerTo();
2189     Value *TypedArgPtr = Builder.CreatePointerCast(ArgPtr, TypePtr);
2190     Value *Val = Builder.CreateLoad(Alloca);
2191     Builder.CreateStore(Val, TypedArgPtr);
2192     StoredScalar = true;
2193 
2194     Arg++;
2195   }
2196 
2197   if (StoredScalar) {
2198     /// In case more than one thread contains scalar stores, the generated
2199     /// code might be incorrect, if we only store at the end of the kernel.
2200     /// To support this case we need to store these scalars back at each
2201     /// memory store or at least before each kernel barrier.
2202     if (Kernel->n_block != 0 || Kernel->n_grid != 0) {
2203       BuildSuccessful = 0;
2204       DEBUG(
2205           dbgs() << getUniqueScopName(&S)
2206                  << " has a store to a scalar value that"
2207                     " would be undefined to run in parallel. Bailing out.\n";);
2208     }
2209   }
2210 }
2211 
2212 void GPUNodeBuilder::createKernelVariables(ppcg_kernel *Kernel, Function *FN) {
2213   Module *M = Builder.GetInsertBlock()->getParent()->getParent();
2214 
2215   for (int i = 0; i < Kernel->n_var; ++i) {
2216     struct ppcg_kernel_var &Var = Kernel->var[i];
2217     isl_id *Id = isl_space_get_tuple_id(Var.array->space, isl_dim_set);
2218     Type *EleTy = ScopArrayInfo::getFromId(isl::manage(Id))->getElementType();
2219 
2220     Type *ArrayTy = EleTy;
2221     SmallVector<const SCEV *, 4> Sizes;
2222 
2223     Sizes.push_back(nullptr);
2224     for (unsigned int j = 1; j < Var.array->n_index; ++j) {
2225       isl_val *Val = isl_vec_get_element_val(Var.size, j);
2226       long Bound = isl_val_get_num_si(Val);
2227       isl_val_free(Val);
2228       Sizes.push_back(S.getSE()->getConstant(Builder.getInt64Ty(), Bound));
2229     }
2230 
2231     for (int j = Var.array->n_index - 1; j >= 0; --j) {
2232       isl_val *Val = isl_vec_get_element_val(Var.size, j);
2233       long Bound = isl_val_get_num_si(Val);
2234       isl_val_free(Val);
2235       ArrayTy = ArrayType::get(ArrayTy, Bound);
2236     }
2237 
2238     const ScopArrayInfo *SAI;
2239     Value *Allocation;
2240     if (Var.type == ppcg_access_shared) {
2241       auto GlobalVar = new GlobalVariable(
2242           *M, ArrayTy, false, GlobalValue::InternalLinkage, 0, Var.name,
2243           nullptr, GlobalValue::ThreadLocalMode::NotThreadLocal, 3);
2244       GlobalVar->setAlignment(EleTy->getPrimitiveSizeInBits() / 8);
2245       GlobalVar->setInitializer(Constant::getNullValue(ArrayTy));
2246 
2247       Allocation = GlobalVar;
2248     } else if (Var.type == ppcg_access_private) {
2249       Allocation = Builder.CreateAlloca(ArrayTy, 0, "private_array");
2250     } else {
2251       llvm_unreachable("unknown variable type");
2252     }
2253     SAI =
2254         S.getOrCreateScopArrayInfo(Allocation, EleTy, Sizes, MemoryKind::Array);
2255     Id = isl_id_alloc(S.getIslCtx().get(), Var.name, nullptr);
2256     IDToValue[Id] = Allocation;
2257     LocalArrays.push_back(Allocation);
2258     KernelIds.push_back(Id);
2259     IDToSAI[Id] = SAI;
2260   }
2261 }
2262 
2263 void GPUNodeBuilder::createKernelFunction(
2264     ppcg_kernel *Kernel, SetVector<Value *> &SubtreeValues,
2265     SetVector<Function *> &SubtreeFunctions) {
2266   std::string Identifier = getKernelFuncName(Kernel->id);
2267   GPUModule.reset(new Module(Identifier, Builder.getContext()));
2268 
2269   switch (Arch) {
2270   case GPUArch::NVPTX64:
2271     if (Runtime == GPURuntime::CUDA)
2272       GPUModule->setTargetTriple(Triple::normalize("nvptx64-nvidia-cuda"));
2273     else if (Runtime == GPURuntime::OpenCL)
2274       GPUModule->setTargetTriple(Triple::normalize("nvptx64-nvidia-nvcl"));
2275     GPUModule->setDataLayout(computeNVPTXDataLayout(true /* is64Bit */));
2276     break;
2277   case GPUArch::SPIR32:
2278     GPUModule->setTargetTriple(Triple::normalize("spir-unknown-unknown"));
2279     GPUModule->setDataLayout(computeSPIRDataLayout(false /* is64Bit */));
2280     break;
2281   case GPUArch::SPIR64:
2282     GPUModule->setTargetTriple(Triple::normalize("spir64-unknown-unknown"));
2283     GPUModule->setDataLayout(computeSPIRDataLayout(true /* is64Bit */));
2284     break;
2285   }
2286 
2287   Function *FN = createKernelFunctionDecl(Kernel, SubtreeValues);
2288 
2289   BasicBlock *PrevBlock = Builder.GetInsertBlock();
2290   auto EntryBlock = BasicBlock::Create(Builder.getContext(), "entry", FN);
2291 
2292   DT.addNewBlock(EntryBlock, PrevBlock);
2293 
2294   Builder.SetInsertPoint(EntryBlock);
2295   Builder.CreateRetVoid();
2296   Builder.SetInsertPoint(EntryBlock, EntryBlock->begin());
2297 
2298   ScopDetection::markFunctionAsInvalid(FN);
2299 
2300   prepareKernelArguments(Kernel, FN);
2301   createKernelVariables(Kernel, FN);
2302 
2303   switch (Arch) {
2304   case GPUArch::NVPTX64:
2305     insertKernelIntrinsics(Kernel);
2306     break;
2307   case GPUArch::SPIR32:
2308   case GPUArch::SPIR64:
2309     insertKernelCallsSPIR(Kernel);
2310     break;
2311   }
2312 }
2313 
2314 std::string GPUNodeBuilder::createKernelASM() {
2315   llvm::Triple GPUTriple;
2316 
2317   switch (Arch) {
2318   case GPUArch::NVPTX64:
2319     switch (Runtime) {
2320     case GPURuntime::CUDA:
2321       GPUTriple = llvm::Triple(Triple::normalize("nvptx64-nvidia-cuda"));
2322       break;
2323     case GPURuntime::OpenCL:
2324       GPUTriple = llvm::Triple(Triple::normalize("nvptx64-nvidia-nvcl"));
2325       break;
2326     }
2327     break;
2328   case GPUArch::SPIR64:
2329   case GPUArch::SPIR32:
2330     std::string SPIRAssembly;
2331     raw_string_ostream IROstream(SPIRAssembly);
2332     IROstream << *GPUModule;
2333     IROstream.flush();
2334     return SPIRAssembly;
2335   }
2336 
2337   std::string ErrMsg;
2338   auto GPUTarget = TargetRegistry::lookupTarget(GPUTriple.getTriple(), ErrMsg);
2339 
2340   if (!GPUTarget) {
2341     errs() << ErrMsg << "\n";
2342     return "";
2343   }
2344 
2345   TargetOptions Options;
2346   Options.UnsafeFPMath = FastMath;
2347 
2348   std::string subtarget;
2349 
2350   switch (Arch) {
2351   case GPUArch::NVPTX64:
2352     subtarget = CudaVersion;
2353     break;
2354   case GPUArch::SPIR32:
2355   case GPUArch::SPIR64:
2356     llvm_unreachable("No subtarget for SPIR architecture");
2357   }
2358 
2359   std::unique_ptr<TargetMachine> TargetM(GPUTarget->createTargetMachine(
2360       GPUTriple.getTriple(), subtarget, "", Options, Optional<Reloc::Model>()));
2361 
2362   SmallString<0> ASMString;
2363   raw_svector_ostream ASMStream(ASMString);
2364   llvm::legacy::PassManager PM;
2365 
2366   PM.add(createTargetTransformInfoWrapperPass(TargetM->getTargetIRAnalysis()));
2367 
2368   if (TargetM->addPassesToEmitFile(
2369           PM, ASMStream, TargetMachine::CGFT_AssemblyFile, true /* verify */)) {
2370     errs() << "The target does not support generation of this file type!\n";
2371     return "";
2372   }
2373 
2374   PM.run(*GPUModule);
2375 
2376   return ASMStream.str();
2377 }
2378 
2379 bool GPUNodeBuilder::requiresCUDALibDevice() {
2380   bool RequiresLibDevice = false;
2381   for (Function &F : GPUModule->functions()) {
2382     if (!F.isDeclaration())
2383       continue;
2384 
2385     const std::string CUDALibDeviceFunc = getCUDALibDeviceFuntion(&F);
2386     if (CUDALibDeviceFunc.length() != 0) {
2387       // We need to handle the case where a module looks like this:
2388       // @expf(..)
2389       // @llvm.exp.f64(..)
2390       // Both of these functions would be renamed to `__nv_expf`.
2391       //
2392       // So, we must first check for the existence of the libdevice function.
2393       // If this exists, we replace our current function with it.
2394       //
2395       // If it does not exist, we rename the current function to the
2396       // libdevice functiono name.
2397       if (Function *Replacement = F.getParent()->getFunction(CUDALibDeviceFunc))
2398         F.replaceAllUsesWith(Replacement);
2399       else
2400         F.setName(CUDALibDeviceFunc);
2401       RequiresLibDevice = true;
2402     }
2403   }
2404 
2405   return RequiresLibDevice;
2406 }
2407 
2408 void GPUNodeBuilder::addCUDALibDevice() {
2409   if (Arch != GPUArch::NVPTX64)
2410     return;
2411 
2412   if (requiresCUDALibDevice()) {
2413     SMDiagnostic Error;
2414 
2415     errs() << CUDALibDevice << "\n";
2416     auto LibDeviceModule =
2417         parseIRFile(CUDALibDevice, Error, GPUModule->getContext());
2418 
2419     if (!LibDeviceModule) {
2420       BuildSuccessful = false;
2421       report_fatal_error("Could not find or load libdevice. Skipping GPU "
2422                          "kernel generation. Please set -polly-acc-libdevice "
2423                          "accordingly.\n");
2424       return;
2425     }
2426 
2427     Linker L(*GPUModule);
2428 
2429     // Set an nvptx64 target triple to avoid linker warnings. The original
2430     // triple of the libdevice files are nvptx-unknown-unknown.
2431     LibDeviceModule->setTargetTriple(Triple::normalize("nvptx64-nvidia-cuda"));
2432     L.linkInModule(std::move(LibDeviceModule), Linker::LinkOnlyNeeded);
2433   }
2434 }
2435 
2436 std::string GPUNodeBuilder::finalizeKernelFunction() {
2437 
2438   if (verifyModule(*GPUModule)) {
2439     DEBUG(dbgs() << "verifyModule failed on module:\n";
2440           GPUModule->print(dbgs(), nullptr); dbgs() << "\n";);
2441     DEBUG(dbgs() << "verifyModule Error:\n";
2442           verifyModule(*GPUModule, &dbgs()););
2443 
2444     if (FailOnVerifyModuleFailure)
2445       llvm_unreachable("VerifyModule failed.");
2446 
2447     BuildSuccessful = false;
2448     return "";
2449   }
2450 
2451   addCUDALibDevice();
2452 
2453   if (DumpKernelIR)
2454     outs() << *GPUModule << "\n";
2455 
2456   if (Arch != GPUArch::SPIR32 && Arch != GPUArch::SPIR64) {
2457     // Optimize module.
2458     llvm::legacy::PassManager OptPasses;
2459     PassManagerBuilder PassBuilder;
2460     PassBuilder.OptLevel = 3;
2461     PassBuilder.SizeLevel = 0;
2462     PassBuilder.populateModulePassManager(OptPasses);
2463     OptPasses.run(*GPUModule);
2464   }
2465 
2466   std::string Assembly = createKernelASM();
2467 
2468   if (DumpKernelASM)
2469     outs() << Assembly << "\n";
2470 
2471   GPUModule.release();
2472   KernelIDs.clear();
2473 
2474   return Assembly;
2475 }
2476 /// Construct an `isl_pw_aff_list` from a vector of `isl_pw_aff`
2477 /// @param PwAffs The list of piecewise affine functions to create an
2478 ///               `isl_pw_aff_list` from. We expect an rvalue ref because
2479 ///               all the isl_pw_aff are used up by this function.
2480 ///
2481 /// @returns  The `isl_pw_aff_list`.
2482 __isl_give isl_pw_aff_list *
2483 createPwAffList(isl_ctx *Context,
2484                 const std::vector<__isl_take isl_pw_aff *> &&PwAffs) {
2485   isl_pw_aff_list *List = isl_pw_aff_list_alloc(Context, PwAffs.size());
2486 
2487   for (unsigned i = 0; i < PwAffs.size(); i++) {
2488     List = isl_pw_aff_list_insert(List, i, PwAffs[i]);
2489   }
2490   return List;
2491 }
2492 
2493 /// Align all the `PwAffs` such that they have the same parameter dimensions.
2494 ///
2495 /// We loop over all `pw_aff` and align all of their spaces together to
2496 /// create a common space for all the `pw_aff`. This common space is the
2497 /// `AlignSpace`. We then align all the `pw_aff` to this space. We start
2498 /// with the given `SeedSpace`.
2499 /// @param PwAffs    The list of piecewise affine functions we want to align.
2500 ///                  This is an rvalue reference because the entire vector is
2501 ///                  used up by the end of the operation.
2502 /// @param SeedSpace The space to start the alignment process with.
2503 /// @returns         A std::pair, whose first element is the aligned space,
2504 ///                  whose second element is the vector of aligned piecewise
2505 ///                  affines.
2506 static std::pair<__isl_give isl_space *, std::vector<__isl_give isl_pw_aff *>>
2507 alignPwAffs(const std::vector<__isl_take isl_pw_aff *> &&PwAffs,
2508             __isl_take isl_space *SeedSpace) {
2509   assert(SeedSpace && "Invalid seed space given.");
2510 
2511   isl_space *AlignSpace = SeedSpace;
2512   for (isl_pw_aff *PwAff : PwAffs) {
2513     isl_space *PwAffSpace = isl_pw_aff_get_domain_space(PwAff);
2514     AlignSpace = isl_space_align_params(AlignSpace, PwAffSpace);
2515   }
2516   std::vector<isl_pw_aff *> AdjustedPwAffs;
2517 
2518   for (unsigned i = 0; i < PwAffs.size(); i++) {
2519     isl_pw_aff *Adjusted = PwAffs[i];
2520     assert(Adjusted && "Invalid pw_aff given.");
2521     Adjusted = isl_pw_aff_align_params(Adjusted, isl_space_copy(AlignSpace));
2522     AdjustedPwAffs.push_back(Adjusted);
2523   }
2524   return std::make_pair(AlignSpace, AdjustedPwAffs);
2525 }
2526 
2527 namespace {
2528 class PPCGCodeGeneration : public ScopPass {
2529 public:
2530   static char ID;
2531 
2532   GPURuntime Runtime = GPURuntime::CUDA;
2533 
2534   GPUArch Architecture = GPUArch::NVPTX64;
2535 
2536   /// The scop that is currently processed.
2537   Scop *S;
2538 
2539   LoopInfo *LI;
2540   DominatorTree *DT;
2541   ScalarEvolution *SE;
2542   const DataLayout *DL;
2543   RegionInfo *RI;
2544 
2545   PPCGCodeGeneration() : ScopPass(ID) {}
2546 
2547   /// Construct compilation options for PPCG.
2548   ///
2549   /// @returns The compilation options.
2550   ppcg_options *createPPCGOptions() {
2551     auto DebugOptions =
2552         (ppcg_debug_options *)malloc(sizeof(ppcg_debug_options));
2553     auto Options = (ppcg_options *)malloc(sizeof(ppcg_options));
2554 
2555     DebugOptions->dump_schedule_constraints = false;
2556     DebugOptions->dump_schedule = false;
2557     DebugOptions->dump_final_schedule = false;
2558     DebugOptions->dump_sizes = false;
2559     DebugOptions->verbose = false;
2560 
2561     Options->debug = DebugOptions;
2562 
2563     Options->group_chains = false;
2564     Options->reschedule = true;
2565     Options->scale_tile_loops = false;
2566     Options->wrap = false;
2567 
2568     Options->non_negative_parameters = false;
2569     Options->ctx = nullptr;
2570     Options->sizes = nullptr;
2571 
2572     Options->tile = true;
2573     Options->tile_size = 32;
2574 
2575     Options->isolate_full_tiles = false;
2576 
2577     Options->use_private_memory = PrivateMemory;
2578     Options->use_shared_memory = SharedMemory;
2579     Options->max_shared_memory = 48 * 1024;
2580 
2581     Options->target = PPCG_TARGET_CUDA;
2582     Options->openmp = false;
2583     Options->linearize_device_arrays = true;
2584     Options->allow_gnu_extensions = false;
2585 
2586     Options->unroll_copy_shared = false;
2587     Options->unroll_gpu_tile = false;
2588     Options->live_range_reordering = true;
2589 
2590     Options->live_range_reordering = true;
2591     Options->hybrid = false;
2592     Options->opencl_compiler_options = nullptr;
2593     Options->opencl_use_gpu = false;
2594     Options->opencl_n_include_file = 0;
2595     Options->opencl_include_files = nullptr;
2596     Options->opencl_print_kernel_types = false;
2597     Options->opencl_embed_kernel_code = false;
2598 
2599     Options->save_schedule_file = nullptr;
2600     Options->load_schedule_file = nullptr;
2601 
2602     return Options;
2603   }
2604 
2605   /// Get a tagged access relation containing all accesses of type @p AccessTy.
2606   ///
2607   /// Instead of a normal access of the form:
2608   ///
2609   ///   Stmt[i,j,k] -> Array[f_0(i,j,k), f_1(i,j,k)]
2610   ///
2611   /// a tagged access has the form
2612   ///
2613   ///   [Stmt[i,j,k] -> id[]] -> Array[f_0(i,j,k), f_1(i,j,k)]
2614   ///
2615   /// where 'id' is an additional space that references the memory access that
2616   /// triggered the access.
2617   ///
2618   /// @param AccessTy The type of the memory accesses to collect.
2619   ///
2620   /// @return The relation describing all tagged memory accesses.
2621   isl_union_map *getTaggedAccesses(enum MemoryAccess::AccessType AccessTy) {
2622     isl_union_map *Accesses = isl_union_map_empty(S->getParamSpace().release());
2623 
2624     for (auto &Stmt : *S)
2625       for (auto &Acc : Stmt)
2626         if (Acc->getType() == AccessTy) {
2627           isl_map *Relation = Acc->getAccessRelation().release();
2628           Relation =
2629               isl_map_intersect_domain(Relation, Stmt.getDomain().release());
2630 
2631           isl_space *Space = isl_map_get_space(Relation);
2632           Space = isl_space_range(Space);
2633           Space = isl_space_from_range(Space);
2634           Space =
2635               isl_space_set_tuple_id(Space, isl_dim_in, Acc->getId().release());
2636           isl_map *Universe = isl_map_universe(Space);
2637           Relation = isl_map_domain_product(Relation, Universe);
2638           Accesses = isl_union_map_add_map(Accesses, Relation);
2639         }
2640 
2641     return Accesses;
2642   }
2643 
2644   /// Get the set of all read accesses, tagged with the access id.
2645   ///
2646   /// @see getTaggedAccesses
2647   isl_union_map *getTaggedReads() {
2648     return getTaggedAccesses(MemoryAccess::READ);
2649   }
2650 
2651   /// Get the set of all may (and must) accesses, tagged with the access id.
2652   ///
2653   /// @see getTaggedAccesses
2654   isl_union_map *getTaggedMayWrites() {
2655     return isl_union_map_union(getTaggedAccesses(MemoryAccess::MAY_WRITE),
2656                                getTaggedAccesses(MemoryAccess::MUST_WRITE));
2657   }
2658 
2659   /// Get the set of all must accesses, tagged with the access id.
2660   ///
2661   /// @see getTaggedAccesses
2662   isl_union_map *getTaggedMustWrites() {
2663     return getTaggedAccesses(MemoryAccess::MUST_WRITE);
2664   }
2665 
2666   /// Collect parameter and array names as isl_ids.
2667   ///
2668   /// To reason about the different parameters and arrays used, ppcg requires
2669   /// a list of all isl_ids in use. As PPCG traditionally performs
2670   /// source-to-source compilation each of these isl_ids is mapped to the
2671   /// expression that represents it. As we do not have a corresponding
2672   /// expression in Polly, we just map each id to a 'zero' expression to match
2673   /// the data format that ppcg expects.
2674   ///
2675   /// @returns Retun a map from collected ids to 'zero' ast expressions.
2676   __isl_give isl_id_to_ast_expr *getNames() {
2677     auto *Names = isl_id_to_ast_expr_alloc(
2678         S->getIslCtx().get(),
2679         S->getNumParams() + std::distance(S->array_begin(), S->array_end()));
2680     auto *Zero = isl_ast_expr_from_val(isl_val_zero(S->getIslCtx().get()));
2681 
2682     for (const SCEV *P : S->parameters()) {
2683       isl_id *Id = S->getIdForParam(P).release();
2684       Names = isl_id_to_ast_expr_set(Names, Id, isl_ast_expr_copy(Zero));
2685     }
2686 
2687     for (auto &Array : S->arrays()) {
2688       auto Id = Array->getBasePtrId().release();
2689       Names = isl_id_to_ast_expr_set(Names, Id, isl_ast_expr_copy(Zero));
2690     }
2691 
2692     isl_ast_expr_free(Zero);
2693 
2694     return Names;
2695   }
2696 
2697   /// Create a new PPCG scop from the current scop.
2698   ///
2699   /// The PPCG scop is initialized with data from the current polly::Scop. From
2700   /// this initial data, the data-dependences in the PPCG scop are initialized.
2701   /// We do not use Polly's dependence analysis for now, to ensure we match
2702   /// the PPCG default behaviour more closely.
2703   ///
2704   /// @returns A new ppcg scop.
2705   ppcg_scop *createPPCGScop() {
2706     MustKillsInfo KillsInfo = computeMustKillsInfo(*S);
2707 
2708     auto PPCGScop = (ppcg_scop *)malloc(sizeof(ppcg_scop));
2709 
2710     PPCGScop->options = createPPCGOptions();
2711     // enable live range reordering
2712     PPCGScop->options->live_range_reordering = 1;
2713 
2714     PPCGScop->start = 0;
2715     PPCGScop->end = 0;
2716 
2717     PPCGScop->context = S->getContext().release();
2718     PPCGScop->domain = S->getDomains().release();
2719     // TODO: investigate this further. PPCG calls collect_call_domains.
2720     PPCGScop->call = isl_union_set_from_set(S->getContext().release());
2721     PPCGScop->tagged_reads = getTaggedReads();
2722     PPCGScop->reads = S->getReads().release();
2723     PPCGScop->live_in = nullptr;
2724     PPCGScop->tagged_may_writes = getTaggedMayWrites();
2725     PPCGScop->may_writes = S->getWrites().release();
2726     PPCGScop->tagged_must_writes = getTaggedMustWrites();
2727     PPCGScop->must_writes = S->getMustWrites().release();
2728     PPCGScop->live_out = nullptr;
2729     PPCGScop->tagged_must_kills = KillsInfo.TaggedMustKills.take();
2730     PPCGScop->must_kills = KillsInfo.MustKills.take();
2731 
2732     PPCGScop->tagger = nullptr;
2733     PPCGScop->independence =
2734         isl_union_map_empty(isl_set_get_space(PPCGScop->context));
2735     PPCGScop->dep_flow = nullptr;
2736     PPCGScop->tagged_dep_flow = nullptr;
2737     PPCGScop->dep_false = nullptr;
2738     PPCGScop->dep_forced = nullptr;
2739     PPCGScop->dep_order = nullptr;
2740     PPCGScop->tagged_dep_order = nullptr;
2741 
2742     PPCGScop->schedule = S->getScheduleTree().release();
2743     // If we have something non-trivial to kill, add it to the schedule
2744     if (KillsInfo.KillsSchedule.get())
2745       PPCGScop->schedule = isl_schedule_sequence(
2746           PPCGScop->schedule, KillsInfo.KillsSchedule.take());
2747 
2748     PPCGScop->names = getNames();
2749     PPCGScop->pet = nullptr;
2750 
2751     compute_tagger(PPCGScop);
2752     compute_dependences(PPCGScop);
2753     eliminate_dead_code(PPCGScop);
2754 
2755     return PPCGScop;
2756   }
2757 
2758   /// Collect the array accesses in a statement.
2759   ///
2760   /// @param Stmt The statement for which to collect the accesses.
2761   ///
2762   /// @returns A list of array accesses.
2763   gpu_stmt_access *getStmtAccesses(ScopStmt &Stmt) {
2764     gpu_stmt_access *Accesses = nullptr;
2765 
2766     for (MemoryAccess *Acc : Stmt) {
2767       auto Access =
2768           isl_alloc_type(S->getIslCtx().get(), struct gpu_stmt_access);
2769       Access->read = Acc->isRead();
2770       Access->write = Acc->isWrite();
2771       Access->access = Acc->getAccessRelation().release();
2772       isl_space *Space = isl_map_get_space(Access->access);
2773       Space = isl_space_range(Space);
2774       Space = isl_space_from_range(Space);
2775       Space = isl_space_set_tuple_id(Space, isl_dim_in, Acc->getId().release());
2776       isl_map *Universe = isl_map_universe(Space);
2777       Access->tagged_access =
2778           isl_map_domain_product(Acc->getAccessRelation().release(), Universe);
2779       Access->exact_write = !Acc->isMayWrite();
2780       Access->ref_id = Acc->getId().release();
2781       Access->next = Accesses;
2782       Access->n_index = Acc->getScopArrayInfo()->getNumberOfDimensions();
2783       // TODO: Also mark one-element accesses to arrays as fixed-element.
2784       Access->fixed_element =
2785           Acc->isLatestScalarKind() ? isl_bool_true : isl_bool_false;
2786       Accesses = Access;
2787     }
2788 
2789     return Accesses;
2790   }
2791 
2792   /// Collect the list of GPU statements.
2793   ///
2794   /// Each statement has an id, a pointer to the underlying data structure,
2795   /// as well as a list with all memory accesses.
2796   ///
2797   /// TODO: Initialize the list of memory accesses.
2798   ///
2799   /// @returns A linked-list of statements.
2800   gpu_stmt *getStatements() {
2801     gpu_stmt *Stmts = isl_calloc_array(S->getIslCtx().get(), struct gpu_stmt,
2802                                        std::distance(S->begin(), S->end()));
2803 
2804     int i = 0;
2805     for (auto &Stmt : *S) {
2806       gpu_stmt *GPUStmt = &Stmts[i];
2807 
2808       GPUStmt->id = Stmt.getDomainId().release();
2809 
2810       // We use the pet stmt pointer to keep track of the Polly statements.
2811       GPUStmt->stmt = (pet_stmt *)&Stmt;
2812       GPUStmt->accesses = getStmtAccesses(Stmt);
2813       i++;
2814     }
2815 
2816     return Stmts;
2817   }
2818 
2819   /// Derive the extent of an array.
2820   ///
2821   /// The extent of an array is the set of elements that are within the
2822   /// accessed array. For the inner dimensions, the extent constraints are
2823   /// 0 and the size of the corresponding array dimension. For the first
2824   /// (outermost) dimension, the extent constraints are the minimal and maximal
2825   /// subscript value for the first dimension.
2826   ///
2827   /// @param Array The array to derive the extent for.
2828   ///
2829   /// @returns An isl_set describing the extent of the array.
2830   isl::set getExtent(ScopArrayInfo *Array) {
2831     unsigned NumDims = Array->getNumberOfDimensions();
2832 
2833     if (Array->getNumberOfDimensions() == 0)
2834       return isl::set::universe(Array->getSpace());
2835 
2836     isl::union_map Accesses = S->getAccesses(Array);
2837     isl::union_set AccessUSet = Accesses.range();
2838     AccessUSet = AccessUSet.coalesce();
2839     AccessUSet = AccessUSet.detect_equalities();
2840     AccessUSet = AccessUSet.coalesce();
2841 
2842     if (AccessUSet.is_empty())
2843       return isl::set::empty(Array->getSpace());
2844 
2845     isl::set AccessSet = AccessUSet.extract_set(Array->getSpace());
2846 
2847     isl::local_space LS = isl::local_space(Array->getSpace());
2848 
2849     isl::pw_aff Val = isl::aff::var_on_domain(LS, isl::dim::set, 0);
2850     isl::pw_aff OuterMin = AccessSet.dim_min(0);
2851     isl::pw_aff OuterMax = AccessSet.dim_max(0);
2852     OuterMin = OuterMin.add_dims(isl::dim::in, Val.dim(isl::dim::in));
2853     OuterMax = OuterMax.add_dims(isl::dim::in, Val.dim(isl::dim::in));
2854     OuterMin = OuterMin.set_tuple_id(isl::dim::in, Array->getBasePtrId());
2855     OuterMax = OuterMax.set_tuple_id(isl::dim::in, Array->getBasePtrId());
2856 
2857     isl::set Extent = isl::set::universe(Array->getSpace());
2858 
2859     Extent = Extent.intersect(OuterMin.le_set(Val));
2860     Extent = Extent.intersect(OuterMax.ge_set(Val));
2861 
2862     for (unsigned i = 1; i < NumDims; ++i)
2863       Extent = Extent.lower_bound_si(isl::dim::set, i, 0);
2864 
2865     for (unsigned i = 0; i < NumDims; ++i) {
2866       isl::pw_aff PwAff = Array->getDimensionSizePw(i);
2867 
2868       // isl_pw_aff can be NULL for zero dimension. Only in the case of a
2869       // Fortran array will we have a legitimate dimension.
2870       if (PwAff.is_null()) {
2871         assert(i == 0 && "invalid dimension isl_pw_aff for nonzero dimension");
2872         continue;
2873       }
2874 
2875       isl::pw_aff Val = isl::aff::var_on_domain(
2876           isl::local_space(Array->getSpace()), isl::dim::set, i);
2877       PwAff = PwAff.add_dims(isl::dim::in, Val.dim(isl::dim::in));
2878       PwAff = PwAff.set_tuple_id(isl::dim::in, Val.get_tuple_id(isl::dim::in));
2879       isl::set Set = PwAff.gt_set(Val);
2880       Extent = Set.intersect(Extent);
2881     }
2882 
2883     return Extent;
2884   }
2885 
2886   /// Derive the bounds of an array.
2887   ///
2888   /// For the first dimension we derive the bound of the array from the extent
2889   /// of this dimension. For inner dimensions we obtain their size directly from
2890   /// ScopArrayInfo.
2891   ///
2892   /// @param PPCGArray The array to compute bounds for.
2893   /// @param Array The polly array from which to take the information.
2894   void setArrayBounds(gpu_array_info &PPCGArray, ScopArrayInfo *Array) {
2895     std::vector<isl_pw_aff *> Bounds;
2896 
2897     if (PPCGArray.n_index > 0) {
2898       if (isl_set_is_empty(PPCGArray.extent)) {
2899         isl_set *Dom = isl_set_copy(PPCGArray.extent);
2900         isl_local_space *LS = isl_local_space_from_space(
2901             isl_space_params(isl_set_get_space(Dom)));
2902         isl_set_free(Dom);
2903         isl_pw_aff *Zero = isl_pw_aff_from_aff(isl_aff_zero_on_domain(LS));
2904         Bounds.push_back(Zero);
2905       } else {
2906         isl_set *Dom = isl_set_copy(PPCGArray.extent);
2907         Dom = isl_set_project_out(Dom, isl_dim_set, 1, PPCGArray.n_index - 1);
2908         isl_pw_aff *Bound = isl_set_dim_max(isl_set_copy(Dom), 0);
2909         isl_set_free(Dom);
2910         Dom = isl_pw_aff_domain(isl_pw_aff_copy(Bound));
2911         isl_local_space *LS =
2912             isl_local_space_from_space(isl_set_get_space(Dom));
2913         isl_aff *One = isl_aff_zero_on_domain(LS);
2914         One = isl_aff_add_constant_si(One, 1);
2915         Bound = isl_pw_aff_add(Bound, isl_pw_aff_alloc(Dom, One));
2916         Bound = isl_pw_aff_gist(Bound, S->getContext().release());
2917         Bounds.push_back(Bound);
2918       }
2919     }
2920 
2921     for (unsigned i = 1; i < PPCGArray.n_index; ++i) {
2922       isl_pw_aff *Bound = Array->getDimensionSizePw(i).release();
2923       auto LS = isl_pw_aff_get_domain_space(Bound);
2924       auto Aff = isl_multi_aff_zero(LS);
2925 
2926       // We need types to work out, which is why we perform this weird dance
2927       // with `Aff` and `Bound`. Consider this example:
2928 
2929       // LS: [p] -> { [] }
2930       // Zero: [p] -> { [] } | Implicitly, is [p] -> { ~ -> [] }.
2931       // This `~` is used to denote a "null space" (which is different from
2932       // a *zero dimensional* space), which is something that ISL does not
2933       // show you when pretty printing.
2934 
2935       // Bound: [p] -> { [] -> [(10p)] } | Here, the [] is a *zero dimensional*
2936       // space, not a "null space" which does not exist at all.
2937 
2938       // When we pullback (precompose) `Bound` with `Zero`, we get:
2939       // Bound . Zero =
2940       //     ([p] -> { [] -> [(10p)] }) . ([p] -> {~ -> [] }) =
2941       //     [p] -> { ~ -> [(10p)] } =
2942       //     [p] -> [(10p)] (as ISL pretty prints it)
2943       // Bound Pullback: [p] -> { [(10p)] }
2944 
2945       // We want this kind of an expression for Bound, without a
2946       // zero dimensional input, but with a "null space" input for the types
2947       // to work out later on, as far as I (Siddharth Bhat) understand.
2948       // I was unable to find a reference to this in the ISL manual.
2949       // References: Tobias Grosser.
2950 
2951       Bound = isl_pw_aff_pullback_multi_aff(Bound, Aff);
2952       Bounds.push_back(Bound);
2953     }
2954 
2955     /// To construct a `isl_multi_pw_aff`, we need all the indivisual `pw_aff`
2956     /// to have the same parameter dimensions. So, we need to align them to an
2957     /// appropriate space.
2958     /// Scop::Context is _not_ an appropriate space, because when we have
2959     /// `-polly-ignore-parameter-bounds` enabled, the Scop::Context does not
2960     /// contain all parameter dimensions.
2961     /// So, use the helper `alignPwAffs` to align all the `isl_pw_aff` together.
2962     isl_space *SeedAlignSpace = S->getParamSpace().release();
2963     SeedAlignSpace = isl_space_add_dims(SeedAlignSpace, isl_dim_set, 1);
2964 
2965     isl_space *AlignSpace = nullptr;
2966     std::vector<isl_pw_aff *> AlignedBounds;
2967     std::tie(AlignSpace, AlignedBounds) =
2968         alignPwAffs(std::move(Bounds), SeedAlignSpace);
2969 
2970     assert(AlignSpace && "alignPwAffs did not initialise AlignSpace");
2971 
2972     isl_pw_aff_list *BoundsList =
2973         createPwAffList(S->getIslCtx().get(), std::move(AlignedBounds));
2974 
2975     isl_space *BoundsSpace = isl_set_get_space(PPCGArray.extent);
2976     BoundsSpace = isl_space_align_params(BoundsSpace, AlignSpace);
2977 
2978     assert(BoundsSpace && "Unable to access space of array.");
2979     assert(BoundsList && "Unable to access list of bounds.");
2980 
2981     PPCGArray.bound =
2982         isl_multi_pw_aff_from_pw_aff_list(BoundsSpace, BoundsList);
2983     assert(PPCGArray.bound && "PPCGArray.bound was not constructed correctly.");
2984   }
2985 
2986   /// Create the arrays for @p PPCGProg.
2987   ///
2988   /// @param PPCGProg The program to compute the arrays for.
2989   void createArrays(gpu_prog *PPCGProg,
2990                     const SmallVector<ScopArrayInfo *, 4> &ValidSAIs) {
2991     int i = 0;
2992     for (auto &Array : ValidSAIs) {
2993       std::string TypeName;
2994       raw_string_ostream OS(TypeName);
2995 
2996       OS << *Array->getElementType();
2997       TypeName = OS.str();
2998 
2999       gpu_array_info &PPCGArray = PPCGProg->array[i];
3000 
3001       PPCGArray.space = Array->getSpace().release();
3002       PPCGArray.type = strdup(TypeName.c_str());
3003       PPCGArray.size = DL->getTypeAllocSize(Array->getElementType());
3004       PPCGArray.name = strdup(Array->getName().c_str());
3005       PPCGArray.extent = nullptr;
3006       PPCGArray.n_index = Array->getNumberOfDimensions();
3007       PPCGArray.extent = getExtent(Array).release();
3008       PPCGArray.n_ref = 0;
3009       PPCGArray.refs = nullptr;
3010       PPCGArray.accessed = true;
3011       PPCGArray.read_only_scalar =
3012           Array->isReadOnly() && Array->getNumberOfDimensions() == 0;
3013       PPCGArray.has_compound_element = false;
3014       PPCGArray.local = false;
3015       PPCGArray.declare_local = false;
3016       PPCGArray.global = false;
3017       PPCGArray.linearize = false;
3018       PPCGArray.dep_order = nullptr;
3019       PPCGArray.user = Array;
3020 
3021       PPCGArray.bound = nullptr;
3022       setArrayBounds(PPCGArray, Array);
3023       i++;
3024 
3025       collect_references(PPCGProg, &PPCGArray);
3026       PPCGArray.only_fixed_element = only_fixed_element_accessed(&PPCGArray);
3027     }
3028   }
3029 
3030   /// Create an identity map between the arrays in the scop.
3031   ///
3032   /// @returns An identity map between the arrays in the scop.
3033   isl_union_map *getArrayIdentity() {
3034     isl_union_map *Maps = isl_union_map_empty(S->getParamSpace().release());
3035 
3036     for (auto &Array : S->arrays()) {
3037       isl_space *Space = Array->getSpace().release();
3038       Space = isl_space_map_from_set(Space);
3039       isl_map *Identity = isl_map_identity(Space);
3040       Maps = isl_union_map_add_map(Maps, Identity);
3041     }
3042 
3043     return Maps;
3044   }
3045 
3046   /// Create a default-initialized PPCG GPU program.
3047   ///
3048   /// @returns A new gpu program description.
3049   gpu_prog *createPPCGProg(ppcg_scop *PPCGScop) {
3050 
3051     if (!PPCGScop)
3052       return nullptr;
3053 
3054     auto PPCGProg = isl_calloc_type(S->getIslCtx().get(), struct gpu_prog);
3055 
3056     PPCGProg->ctx = S->getIslCtx().get();
3057     PPCGProg->scop = PPCGScop;
3058     PPCGProg->context = isl_set_copy(PPCGScop->context);
3059     PPCGProg->read = isl_union_map_copy(PPCGScop->reads);
3060     PPCGProg->may_write = isl_union_map_copy(PPCGScop->may_writes);
3061     PPCGProg->must_write = isl_union_map_copy(PPCGScop->must_writes);
3062     PPCGProg->tagged_must_kill =
3063         isl_union_map_copy(PPCGScop->tagged_must_kills);
3064     PPCGProg->to_inner = getArrayIdentity();
3065     PPCGProg->to_outer = getArrayIdentity();
3066     // TODO: verify that this assignment is correct.
3067     PPCGProg->any_to_outer = nullptr;
3068     PPCGProg->n_stmts = std::distance(S->begin(), S->end());
3069     PPCGProg->stmts = getStatements();
3070 
3071     // Only consider arrays that have a non-empty extent.
3072     // Otherwise, this will cause us to consider the following kinds of
3073     // empty arrays:
3074     //     1. Invariant loads that are represented by SAI objects.
3075     //     2. Arrays with statically known zero size.
3076     auto ValidSAIsRange =
3077         make_filter_range(S->arrays(), [this](ScopArrayInfo *SAI) -> bool {
3078           return !getExtent(SAI).is_empty();
3079         });
3080     SmallVector<ScopArrayInfo *, 4> ValidSAIs(ValidSAIsRange.begin(),
3081                                               ValidSAIsRange.end());
3082 
3083     PPCGProg->n_array =
3084         ValidSAIs.size(); // std::distance(S->array_begin(), S->array_end());
3085     PPCGProg->array = isl_calloc_array(
3086         S->getIslCtx().get(), struct gpu_array_info, PPCGProg->n_array);
3087 
3088     createArrays(PPCGProg, ValidSAIs);
3089 
3090     PPCGProg->array_order = nullptr;
3091     collect_order_dependences(PPCGProg);
3092 
3093     PPCGProg->may_persist = compute_may_persist(PPCGProg);
3094     return PPCGProg;
3095   }
3096 
3097   struct PrintGPUUserData {
3098     struct cuda_info *CudaInfo;
3099     struct gpu_prog *PPCGProg;
3100     std::vector<ppcg_kernel *> Kernels;
3101   };
3102 
3103   /// Print a user statement node in the host code.
3104   ///
3105   /// We use ppcg's printing facilities to print the actual statement and
3106   /// additionally build up a list of all kernels that are encountered in the
3107   /// host ast.
3108   ///
3109   /// @param P The printer to print to
3110   /// @param Options The printing options to use
3111   /// @param Node The node to print
3112   /// @param User A user pointer to carry additional data. This pointer is
3113   ///             expected to be of type PrintGPUUserData.
3114   ///
3115   /// @returns A printer to which the output has been printed.
3116   static __isl_give isl_printer *
3117   printHostUser(__isl_take isl_printer *P,
3118                 __isl_take isl_ast_print_options *Options,
3119                 __isl_take isl_ast_node *Node, void *User) {
3120     auto Data = (struct PrintGPUUserData *)User;
3121     auto Id = isl_ast_node_get_annotation(Node);
3122 
3123     if (Id) {
3124       bool IsUser = !strcmp(isl_id_get_name(Id), "user");
3125 
3126       // If this is a user statement, format it ourselves as ppcg would
3127       // otherwise try to call pet functionality that is not available in
3128       // Polly.
3129       if (IsUser) {
3130         P = isl_printer_start_line(P);
3131         P = isl_printer_print_ast_node(P, Node);
3132         P = isl_printer_end_line(P);
3133         isl_id_free(Id);
3134         isl_ast_print_options_free(Options);
3135         return P;
3136       }
3137 
3138       auto Kernel = (struct ppcg_kernel *)isl_id_get_user(Id);
3139       isl_id_free(Id);
3140       Data->Kernels.push_back(Kernel);
3141     }
3142 
3143     return print_host_user(P, Options, Node, User);
3144   }
3145 
3146   /// Print C code corresponding to the control flow in @p Kernel.
3147   ///
3148   /// @param Kernel The kernel to print
3149   void printKernel(ppcg_kernel *Kernel) {
3150     auto *P = isl_printer_to_str(S->getIslCtx().get());
3151     P = isl_printer_set_output_format(P, ISL_FORMAT_C);
3152     auto *Options = isl_ast_print_options_alloc(S->getIslCtx().get());
3153     P = isl_ast_node_print(Kernel->tree, P, Options);
3154     char *String = isl_printer_get_str(P);
3155     printf("%s\n", String);
3156     free(String);
3157     isl_printer_free(P);
3158   }
3159 
3160   /// Print C code corresponding to the GPU code described by @p Tree.
3161   ///
3162   /// @param Tree An AST describing GPU code
3163   /// @param PPCGProg The PPCG program from which @Tree has been constructed.
3164   void printGPUTree(isl_ast_node *Tree, gpu_prog *PPCGProg) {
3165     auto *P = isl_printer_to_str(S->getIslCtx().get());
3166     P = isl_printer_set_output_format(P, ISL_FORMAT_C);
3167 
3168     PrintGPUUserData Data;
3169     Data.PPCGProg = PPCGProg;
3170 
3171     auto *Options = isl_ast_print_options_alloc(S->getIslCtx().get());
3172     Options =
3173         isl_ast_print_options_set_print_user(Options, printHostUser, &Data);
3174     P = isl_ast_node_print(Tree, P, Options);
3175     char *String = isl_printer_get_str(P);
3176     printf("# host\n");
3177     printf("%s\n", String);
3178     free(String);
3179     isl_printer_free(P);
3180 
3181     for (auto Kernel : Data.Kernels) {
3182       printf("# kernel%d\n", Kernel->id);
3183       printKernel(Kernel);
3184     }
3185   }
3186 
3187   // Generate a GPU program using PPCG.
3188   //
3189   // GPU mapping consists of multiple steps:
3190   //
3191   //  1) Compute new schedule for the program.
3192   //  2) Map schedule to GPU (TODO)
3193   //  3) Generate code for new schedule (TODO)
3194   //
3195   // We do not use here the Polly ScheduleOptimizer, as the schedule optimizer
3196   // is mostly CPU specific. Instead, we use PPCG's GPU code generation
3197   // strategy directly from this pass.
3198   gpu_gen *generateGPU(ppcg_scop *PPCGScop, gpu_prog *PPCGProg) {
3199 
3200     auto PPCGGen = isl_calloc_type(S->getIslCtx().get(), struct gpu_gen);
3201 
3202     PPCGGen->ctx = S->getIslCtx().get();
3203     PPCGGen->options = PPCGScop->options;
3204     PPCGGen->print = nullptr;
3205     PPCGGen->print_user = nullptr;
3206     PPCGGen->build_ast_expr = &pollyBuildAstExprForStmt;
3207     PPCGGen->prog = PPCGProg;
3208     PPCGGen->tree = nullptr;
3209     PPCGGen->types.n = 0;
3210     PPCGGen->types.name = nullptr;
3211     PPCGGen->sizes = nullptr;
3212     PPCGGen->used_sizes = nullptr;
3213     PPCGGen->kernel_id = 0;
3214 
3215     // Set scheduling strategy to same strategy PPCG is using.
3216     isl_options_set_schedule_outer_coincidence(PPCGGen->ctx, true);
3217     isl_options_set_schedule_maximize_band_depth(PPCGGen->ctx, true);
3218     isl_options_set_schedule_whole_component(PPCGGen->ctx, false);
3219 
3220     isl_schedule *Schedule = get_schedule(PPCGGen);
3221 
3222     int has_permutable = has_any_permutable_node(Schedule);
3223 
3224     Schedule =
3225         isl_schedule_align_params(Schedule, S->getFullParamSpace().release());
3226 
3227     if (!has_permutable || has_permutable < 0) {
3228       Schedule = isl_schedule_free(Schedule);
3229       DEBUG(dbgs() << getUniqueScopName(S)
3230                    << " does not have permutable bands. Bailing out\n";);
3231     } else {
3232       const bool CreateTransferToFromDevice = !PollyManagedMemory;
3233       Schedule = map_to_device(PPCGGen, Schedule, CreateTransferToFromDevice);
3234       PPCGGen->tree = generate_code(PPCGGen, isl_schedule_copy(Schedule));
3235     }
3236 
3237     if (DumpSchedule) {
3238       isl_printer *P = isl_printer_to_str(S->getIslCtx().get());
3239       P = isl_printer_set_yaml_style(P, ISL_YAML_STYLE_BLOCK);
3240       P = isl_printer_print_str(P, "Schedule\n");
3241       P = isl_printer_print_str(P, "========\n");
3242       if (Schedule)
3243         P = isl_printer_print_schedule(P, Schedule);
3244       else
3245         P = isl_printer_print_str(P, "No schedule found\n");
3246 
3247       printf("%s\n", isl_printer_get_str(P));
3248       isl_printer_free(P);
3249     }
3250 
3251     if (DumpCode) {
3252       printf("Code\n");
3253       printf("====\n");
3254       if (PPCGGen->tree)
3255         printGPUTree(PPCGGen->tree, PPCGProg);
3256       else
3257         printf("No code generated\n");
3258     }
3259 
3260     isl_schedule_free(Schedule);
3261 
3262     return PPCGGen;
3263   }
3264 
3265   /// Free gpu_gen structure.
3266   ///
3267   /// @param PPCGGen The ppcg_gen object to free.
3268   void freePPCGGen(gpu_gen *PPCGGen) {
3269     isl_ast_node_free(PPCGGen->tree);
3270     isl_union_map_free(PPCGGen->sizes);
3271     isl_union_map_free(PPCGGen->used_sizes);
3272     free(PPCGGen);
3273   }
3274 
3275   /// Free the options in the ppcg scop structure.
3276   ///
3277   /// ppcg is not freeing these options for us. To avoid leaks we do this
3278   /// ourselves.
3279   ///
3280   /// @param PPCGScop The scop referencing the options to free.
3281   void freeOptions(ppcg_scop *PPCGScop) {
3282     free(PPCGScop->options->debug);
3283     PPCGScop->options->debug = nullptr;
3284     free(PPCGScop->options);
3285     PPCGScop->options = nullptr;
3286   }
3287 
3288   /// Approximate the number of points in the set.
3289   ///
3290   /// This function returns an ast expression that overapproximates the number
3291   /// of points in an isl set through the rectangular hull surrounding this set.
3292   ///
3293   /// @param Set   The set to count.
3294   /// @param Build The isl ast build object to use for creating the ast
3295   ///              expression.
3296   ///
3297   /// @returns An approximation of the number of points in the set.
3298   __isl_give isl_ast_expr *approxPointsInSet(__isl_take isl_set *Set,
3299                                              __isl_keep isl_ast_build *Build) {
3300 
3301     isl_val *One = isl_val_int_from_si(isl_set_get_ctx(Set), 1);
3302     auto *Expr = isl_ast_expr_from_val(isl_val_copy(One));
3303 
3304     isl_space *Space = isl_set_get_space(Set);
3305     Space = isl_space_params(Space);
3306     auto *Univ = isl_set_universe(Space);
3307     isl_pw_aff *OneAff = isl_pw_aff_val_on_domain(Univ, One);
3308 
3309     for (long i = 0, n = isl_set_dim(Set, isl_dim_set); i < n; i++) {
3310       isl_pw_aff *Max = isl_set_dim_max(isl_set_copy(Set), i);
3311       isl_pw_aff *Min = isl_set_dim_min(isl_set_copy(Set), i);
3312       isl_pw_aff *DimSize = isl_pw_aff_sub(Max, Min);
3313       DimSize = isl_pw_aff_add(DimSize, isl_pw_aff_copy(OneAff));
3314       auto DimSizeExpr = isl_ast_build_expr_from_pw_aff(Build, DimSize);
3315       Expr = isl_ast_expr_mul(Expr, DimSizeExpr);
3316     }
3317 
3318     isl_set_free(Set);
3319     isl_pw_aff_free(OneAff);
3320 
3321     return Expr;
3322   }
3323 
3324   /// Approximate a number of dynamic instructions executed by a given
3325   /// statement.
3326   ///
3327   /// @param Stmt  The statement for which to compute the number of dynamic
3328   ///              instructions.
3329   /// @param Build The isl ast build object to use for creating the ast
3330   ///              expression.
3331   /// @returns An approximation of the number of dynamic instructions executed
3332   ///          by @p Stmt.
3333   __isl_give isl_ast_expr *approxDynamicInst(ScopStmt &Stmt,
3334                                              __isl_keep isl_ast_build *Build) {
3335     auto Iterations = approxPointsInSet(Stmt.getDomain().release(), Build);
3336 
3337     long InstCount = 0;
3338 
3339     if (Stmt.isBlockStmt()) {
3340       auto *BB = Stmt.getBasicBlock();
3341       InstCount = std::distance(BB->begin(), BB->end());
3342     } else {
3343       auto *R = Stmt.getRegion();
3344 
3345       for (auto *BB : R->blocks()) {
3346         InstCount += std::distance(BB->begin(), BB->end());
3347       }
3348     }
3349 
3350     isl_val *InstVal = isl_val_int_from_si(S->getIslCtx().get(), InstCount);
3351     auto *InstExpr = isl_ast_expr_from_val(InstVal);
3352     return isl_ast_expr_mul(InstExpr, Iterations);
3353   }
3354 
3355   /// Approximate dynamic instructions executed in scop.
3356   ///
3357   /// @param S     The scop for which to approximate dynamic instructions.
3358   /// @param Build The isl ast build object to use for creating the ast
3359   ///              expression.
3360   /// @returns An approximation of the number of dynamic instructions executed
3361   ///          in @p S.
3362   __isl_give isl_ast_expr *
3363   getNumberOfIterations(Scop &S, __isl_keep isl_ast_build *Build) {
3364     isl_ast_expr *Instructions;
3365 
3366     isl_val *Zero = isl_val_int_from_si(S.getIslCtx().get(), 0);
3367     Instructions = isl_ast_expr_from_val(Zero);
3368 
3369     for (ScopStmt &Stmt : S) {
3370       isl_ast_expr *StmtInstructions = approxDynamicInst(Stmt, Build);
3371       Instructions = isl_ast_expr_add(Instructions, StmtInstructions);
3372     }
3373     return Instructions;
3374   }
3375 
3376   /// Create a check that ensures sufficient compute in scop.
3377   ///
3378   /// @param S     The scop for which to ensure sufficient compute.
3379   /// @param Build The isl ast build object to use for creating the ast
3380   ///              expression.
3381   /// @returns An expression that evaluates to TRUE in case of sufficient
3382   ///          compute and to FALSE, otherwise.
3383   __isl_give isl_ast_expr *
3384   createSufficientComputeCheck(Scop &S, __isl_keep isl_ast_build *Build) {
3385     auto Iterations = getNumberOfIterations(S, Build);
3386     auto *MinComputeVal = isl_val_int_from_si(S.getIslCtx().get(), MinCompute);
3387     auto *MinComputeExpr = isl_ast_expr_from_val(MinComputeVal);
3388     return isl_ast_expr_ge(Iterations, MinComputeExpr);
3389   }
3390 
3391   /// Check if the basic block contains a function we cannot codegen for GPU
3392   /// kernels.
3393   ///
3394   /// If this basic block does something with a `Function` other than calling
3395   /// a function that we support in a kernel, return true.
3396   bool containsInvalidKernelFunctionInBlock(const BasicBlock *BB,
3397                                             bool AllowCUDALibDevice) {
3398     for (const Instruction &Inst : *BB) {
3399       const CallInst *Call = dyn_cast<CallInst>(&Inst);
3400       if (Call && isValidFunctionInKernel(Call->getCalledFunction(),
3401                                           AllowCUDALibDevice))
3402         continue;
3403 
3404       for (Value *Op : Inst.operands())
3405         // Look for (<func-type>*) among operands of Inst
3406         if (auto PtrTy = dyn_cast<PointerType>(Op->getType())) {
3407           if (isa<FunctionType>(PtrTy->getElementType())) {
3408             DEBUG(dbgs() << Inst
3409                          << " has illegal use of function in kernel.\n");
3410             return true;
3411           }
3412         }
3413     }
3414     return false;
3415   }
3416 
3417   /// Return whether the Scop S uses functions in a way that we do not support.
3418   bool containsInvalidKernelFunction(const Scop &S, bool AllowCUDALibDevice) {
3419     for (auto &Stmt : S) {
3420       if (Stmt.isBlockStmt()) {
3421         if (containsInvalidKernelFunctionInBlock(Stmt.getBasicBlock(),
3422                                                  AllowCUDALibDevice))
3423           return true;
3424       } else {
3425         assert(Stmt.isRegionStmt() &&
3426                "Stmt was neither block nor region statement");
3427         for (const BasicBlock *BB : Stmt.getRegion()->blocks())
3428           if (containsInvalidKernelFunctionInBlock(BB, AllowCUDALibDevice))
3429             return true;
3430       }
3431     }
3432     return false;
3433   }
3434 
3435   /// Generate code for a given GPU AST described by @p Root.
3436   ///
3437   /// @param Root An isl_ast_node pointing to the root of the GPU AST.
3438   /// @param Prog The GPU Program to generate code for.
3439   void generateCode(__isl_take isl_ast_node *Root, gpu_prog *Prog) {
3440     ScopAnnotator Annotator;
3441     Annotator.buildAliasScopes(*S);
3442 
3443     Region *R = &S->getRegion();
3444 
3445     simplifyRegion(R, DT, LI, RI);
3446 
3447     BasicBlock *EnteringBB = R->getEnteringBlock();
3448 
3449     PollyIRBuilder Builder = createPollyIRBuilder(EnteringBB, Annotator);
3450 
3451     // Only build the run-time condition and parameters _after_ having
3452     // introduced the conditional branch. This is important as the conditional
3453     // branch will guard the original scop from new induction variables that
3454     // the SCEVExpander may introduce while code generating the parameters and
3455     // which may introduce scalar dependences that prevent us from correctly
3456     // code generating this scop.
3457     BBPair StartExitBlocks;
3458     BranchInst *CondBr = nullptr;
3459     std::tie(StartExitBlocks, CondBr) =
3460         executeScopConditionally(*S, Builder.getTrue(), *DT, *RI, *LI);
3461     BasicBlock *StartBlock = std::get<0>(StartExitBlocks);
3462 
3463     assert(CondBr && "CondBr not initialized by executeScopConditionally");
3464 
3465     GPUNodeBuilder NodeBuilder(Builder, Annotator, *DL, *LI, *SE, *DT, *S,
3466                                StartBlock, Prog, Runtime, Architecture);
3467 
3468     // TODO: Handle LICM
3469     auto SplitBlock = StartBlock->getSinglePredecessor();
3470     Builder.SetInsertPoint(SplitBlock->getTerminator());
3471 
3472     isl_ast_build *Build = isl_ast_build_alloc(S->getIslCtx().get());
3473     isl_ast_expr *Condition = IslAst::buildRunCondition(*S, Build);
3474     isl_ast_expr *SufficientCompute = createSufficientComputeCheck(*S, Build);
3475     Condition = isl_ast_expr_and(Condition, SufficientCompute);
3476     isl_ast_build_free(Build);
3477 
3478     // preload invariant loads. Note: This should happen before the RTC
3479     // because the RTC may depend on values that are invariant load hoisted.
3480     if (!NodeBuilder.preloadInvariantLoads()) {
3481       // Patch the introduced branch condition to ensure that we always execute
3482       // the original SCoP.
3483       auto *FalseI1 = Builder.getFalse();
3484       auto *SplitBBTerm = Builder.GetInsertBlock()->getTerminator();
3485       SplitBBTerm->setOperand(0, FalseI1);
3486 
3487       DEBUG(dbgs() << "preloading invariant loads failed in function: " +
3488                           S->getFunction().getName() +
3489                           " | Scop Region: " + S->getNameStr());
3490       // adjust the dominator tree accordingly.
3491       auto *ExitingBlock = StartBlock->getUniqueSuccessor();
3492       assert(ExitingBlock);
3493       auto *MergeBlock = ExitingBlock->getUniqueSuccessor();
3494       assert(MergeBlock);
3495       polly::markBlockUnreachable(*StartBlock, Builder);
3496       polly::markBlockUnreachable(*ExitingBlock, Builder);
3497       auto *ExitingBB = S->getExitingBlock();
3498       assert(ExitingBB);
3499 
3500       DT->changeImmediateDominator(MergeBlock, ExitingBB);
3501       DT->eraseNode(ExitingBlock);
3502       isl_ast_expr_free(Condition);
3503       isl_ast_node_free(Root);
3504     } else {
3505 
3506       if (polly::PerfMonitoring) {
3507         PerfMonitor P(*S, EnteringBB->getParent()->getParent());
3508         P.initialize();
3509         P.insertRegionStart(SplitBlock->getTerminator());
3510 
3511         // TODO: actually think if this is the correct exiting block to place
3512         // the `end` performance marker. Invariant load hoisting changes
3513         // the CFG in a way that I do not precisely understand, so I
3514         // (Siddharth<[email protected]>) should come back to this and
3515         // think about which exiting block to use.
3516         auto *ExitingBlock = StartBlock->getUniqueSuccessor();
3517         assert(ExitingBlock);
3518         BasicBlock *MergeBlock = ExitingBlock->getUniqueSuccessor();
3519         P.insertRegionEnd(MergeBlock->getTerminator());
3520       }
3521 
3522       NodeBuilder.addParameters(S->getContext().release());
3523       Value *RTC = NodeBuilder.createRTC(Condition);
3524       Builder.GetInsertBlock()->getTerminator()->setOperand(0, RTC);
3525 
3526       Builder.SetInsertPoint(&*StartBlock->begin());
3527 
3528       NodeBuilder.create(Root);
3529     }
3530 
3531     /// In case a sequential kernel has more surrounding loops as any parallel
3532     /// kernel, the SCoP is probably mostly sequential. Hence, there is no
3533     /// point in running it on a GPU.
3534     if (NodeBuilder.DeepestSequential > NodeBuilder.DeepestParallel)
3535       CondBr->setOperand(0, Builder.getFalse());
3536 
3537     if (!NodeBuilder.BuildSuccessful)
3538       CondBr->setOperand(0, Builder.getFalse());
3539   }
3540 
3541   bool runOnScop(Scop &CurrentScop) override {
3542     S = &CurrentScop;
3543     LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
3544     DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
3545     SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
3546     DL = &S->getRegion().getEntry()->getModule()->getDataLayout();
3547     RI = &getAnalysis<RegionInfoPass>().getRegionInfo();
3548 
3549     DEBUG(dbgs() << "PPCGCodeGen running on : " << getUniqueScopName(S)
3550                  << " | loop depth: " << S->getMaxLoopDepth() << "\n");
3551 
3552     // We currently do not support functions other than intrinsics inside
3553     // kernels, as code generation will need to offload function calls to the
3554     // kernel. This may lead to a kernel trying to call a function on the host.
3555     // This also allows us to prevent codegen from trying to take the
3556     // address of an intrinsic function to send to the kernel.
3557     if (containsInvalidKernelFunction(CurrentScop,
3558                                       Architecture == GPUArch::NVPTX64)) {
3559       DEBUG(
3560           dbgs() << getUniqueScopName(S)
3561                  << " contains function which cannot be materialised in a GPU "
3562                     "kernel. Bailing out.\n";);
3563       return false;
3564     }
3565 
3566     auto PPCGScop = createPPCGScop();
3567     auto PPCGProg = createPPCGProg(PPCGScop);
3568     auto PPCGGen = generateGPU(PPCGScop, PPCGProg);
3569 
3570     if (PPCGGen->tree) {
3571       generateCode(isl_ast_node_copy(PPCGGen->tree), PPCGProg);
3572       CurrentScop.markAsToBeSkipped();
3573     } else {
3574       DEBUG(dbgs() << getUniqueScopName(S)
3575                    << " has empty PPCGGen->tree. Bailing out.\n");
3576     }
3577 
3578     freeOptions(PPCGScop);
3579     freePPCGGen(PPCGGen);
3580     gpu_prog_free(PPCGProg);
3581     ppcg_scop_free(PPCGScop);
3582 
3583     return true;
3584   }
3585 
3586   void printScop(raw_ostream &, Scop &) const override {}
3587 
3588   void getAnalysisUsage(AnalysisUsage &AU) const override {
3589     ScopPass::getAnalysisUsage(AU);
3590 
3591     AU.addRequired<DominatorTreeWrapperPass>();
3592     AU.addRequired<RegionInfoPass>();
3593     AU.addRequired<ScalarEvolutionWrapperPass>();
3594     AU.addRequired<ScopDetectionWrapperPass>();
3595     AU.addRequired<ScopInfoRegionPass>();
3596     AU.addRequired<LoopInfoWrapperPass>();
3597 
3598     // FIXME: We do not yet add regions for the newly generated code to the
3599     //        region tree.
3600   }
3601 };
3602 } // namespace
3603 
3604 char PPCGCodeGeneration::ID = 1;
3605 
3606 Pass *polly::createPPCGCodeGenerationPass(GPUArch Arch, GPURuntime Runtime) {
3607   PPCGCodeGeneration *generator = new PPCGCodeGeneration();
3608   generator->Runtime = Runtime;
3609   generator->Architecture = Arch;
3610   return generator;
3611 }
3612 
3613 INITIALIZE_PASS_BEGIN(PPCGCodeGeneration, "polly-codegen-ppcg",
3614                       "Polly - Apply PPCG translation to SCOP", false, false)
3615 INITIALIZE_PASS_DEPENDENCY(DependenceInfo);
3616 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
3617 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
3618 INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
3619 INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
3620 INITIALIZE_PASS_DEPENDENCY(ScopDetectionWrapperPass);
3621 INITIALIZE_PASS_END(PPCGCodeGeneration, "polly-codegen-ppcg",
3622                     "Polly - Apply PPCG translation to SCOP", false, false)
3623