blob: 87fadbdd000845c8d693d5ea53cae7fc66c474b9 [file] [log] [blame]
Zonr Changc383a502010-10-12 01:52:08 +08001/*
Stephen Hines5e3b6772012-03-21 08:02:10 -07002 * Copyright 2010-2012, The Android Open Source Project
Zonr Changc383a502010-10-12 01:52:08 +08003 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
zonr6315f762010-10-05 15:35:14 +080017#include "slang_backend.h"
Shih-wei Liao462aefd2010-06-04 15:32:04 -070018
Stephen Hinese639eb52010-11-08 19:27:20 -080019#include <string>
20#include <vector>
21
22#include "clang/AST/ASTContext.h"
23#include "clang/AST/Decl.h"
24#include "clang/AST/DeclGroup.h"
25
26#include "clang/Basic/Diagnostic.h"
27#include "clang/Basic/TargetInfo.h"
28#include "clang/Basic/TargetOptions.h"
29
30#include "clang/CodeGen/ModuleBuilder.h"
31
32#include "clang/Frontend/CodeGenOptions.h"
33#include "clang/Frontend/FrontendDiagnostic.h"
34
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -070035#include "llvm/ADT/Twine.h"
36#include "llvm/ADT/StringExtras.h"
Stephen Hinese639eb52010-11-08 19:27:20 -080037
38#include "llvm/Bitcode/ReaderWriter.h"
39
40#include "llvm/CodeGen/RegAllocRegistry.h"
41#include "llvm/CodeGen/SchedulerRegistry.h"
42
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -070043#include "llvm/IR/Constant.h"
44#include "llvm/IR/Constants.h"
45#include "llvm/IR/DataLayout.h"
46#include "llvm/IR/DebugLoc.h"
47#include "llvm/IR/DerivedTypes.h"
48#include "llvm/IR/Function.h"
49#include "llvm/IR/IRBuilder.h"
50#include "llvm/IR/IRPrintingPasses.h"
Stephen Hines23c43582013-01-09 20:02:04 -080051#include "llvm/IR/LLVMContext.h"
Stephen Hines23c43582013-01-09 20:02:04 -080052#include "llvm/IR/Metadata.h"
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -070053#include "llvm/IR/Module.h"
Shih-wei Liao462aefd2010-06-04 15:32:04 -070054
Logan Chien9207a2e2011-10-21 15:39:28 +080055#include "llvm/Transforms/IPO/PassManagerBuilder.h"
Shih-wei Liaofcc654a2011-06-22 04:47:33 -070056
Shih-wei Liao9ef2f782010-10-01 12:31:37 -070057#include "llvm/Target/TargetMachine.h"
58#include "llvm/Target/TargetOptions.h"
Logan Chien9207a2e2011-10-21 15:39:28 +080059#include "llvm/Support/TargetRegistry.h"
Shih-wei Liao77703262011-07-02 11:30:32 -070060
61#include "llvm/MC/SubtargetFeature.h"
Shih-wei Liao462aefd2010-06-04 15:32:04 -070062
Stephen Hines6e6578a2011-02-07 18:05:48 -080063#include "slang_assert.h"
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -070064#include "slang.h"
Matt Waladabd2462015-07-15 18:39:41 -070065#include "slang_bitcode_gen.h"
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -070066#include "slang_rs_context.h"
67#include "slang_rs_export_foreach.h"
68#include "slang_rs_export_func.h"
Matt Walac0c5dd82015-07-23 17:29:37 -070069#include "slang_rs_export_reduce.h"
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -070070#include "slang_rs_export_type.h"
71#include "slang_rs_export_var.h"
72#include "slang_rs_metadata.h"
73
David Gross2770d0e2015-08-03 14:58:59 -070074#include "rs_cc_options.h"
75
Stephen Hines552d8722013-12-18 12:21:50 -080076#include "strip_unknown_attributes.h"
zonr6315f762010-10-05 15:35:14 +080077
Stephen Hinese639eb52010-11-08 19:27:20 -080078namespace slang {
Shih-wei Liao462aefd2010-06-04 15:32:04 -070079
Zonr Chang3a9ca1f2010-10-06 17:52:56 +080080void Backend::CreateFunctionPasses() {
81 if (!mPerFunctionPasses) {
Stephen Hinesc7069072015-03-18 14:53:14 -070082 mPerFunctionPasses = new llvm::legacy::FunctionPassManager(mpModule);
Zonr Chang3a9ca1f2010-10-06 17:52:56 +080083
Shih-wei Liaofcc654a2011-06-22 04:47:33 -070084 llvm::PassManagerBuilder PMBuilder;
85 PMBuilder.OptLevel = mCodeGenOpts.OptimizationLevel;
86 PMBuilder.populateFunctionPassManager(*mPerFunctionPasses);
Zonr Chang3a9ca1f2010-10-06 17:52:56 +080087 }
Zonr Chang3a9ca1f2010-10-06 17:52:56 +080088}
89
90void Backend::CreateModulePasses() {
91 if (!mPerModulePasses) {
Stephen Hinesc7069072015-03-18 14:53:14 -070092 mPerModulePasses = new llvm::legacy::PassManager();
Zonr Chang3a9ca1f2010-10-06 17:52:56 +080093
Shih-wei Liaofcc654a2011-06-22 04:47:33 -070094 llvm::PassManagerBuilder PMBuilder;
95 PMBuilder.OptLevel = mCodeGenOpts.OptimizationLevel;
96 PMBuilder.SizeLevel = mCodeGenOpts.OptimizeSize;
Shih-wei Liaofcc654a2011-06-22 04:47:33 -070097 if (mCodeGenOpts.UnitAtATime) {
98 PMBuilder.DisableUnitAtATime = 0;
99 } else {
100 PMBuilder.DisableUnitAtATime = 1;
101 }
102
103 if (mCodeGenOpts.UnrollLoops) {
104 PMBuilder.DisableUnrollLoops = 0;
105 } else {
106 PMBuilder.DisableUnrollLoops = 1;
107 }
108
Shih-wei Liaofcc654a2011-06-22 04:47:33 -0700109 PMBuilder.populateModulePassManager(*mPerModulePasses);
Stephen Hines552d8722013-12-18 12:21:50 -0800110 // Add a pass to strip off unknown/unsupported attributes.
111 mPerModulePasses->add(createStripUnknownAttributesPass());
Zonr Chang3a9ca1f2010-10-06 17:52:56 +0800112 }
Zonr Chang3a9ca1f2010-10-06 17:52:56 +0800113}
114
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700115bool Backend::CreateCodeGenPasses() {
Zonr Chang3a9ca1f2010-10-06 17:52:56 +0800116 if ((mOT != Slang::OT_Assembly) && (mOT != Slang::OT_Object))
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700117 return true;
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700118
119 // Now we add passes for code emitting
120 if (mCodeGenPasses) {
121 return true;
122 } else {
Stephen Hinesc7069072015-03-18 14:53:14 -0700123 mCodeGenPasses = new llvm::legacy::FunctionPassManager(mpModule);
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700124 }
125
126 // Create the TargetMachine for generating code.
127 std::string Triple = mpModule->getTargetTriple();
128
129 std::string Error;
130 const llvm::Target* TargetInfo =
131 llvm::TargetRegistry::lookupTarget(Triple, Error);
Chris Wailes5abbe0e2014-08-12 15:58:29 -0700132 if (TargetInfo == nullptr) {
Logan Chien9207a2e2011-10-21 15:39:28 +0800133 mDiagEngine.Report(clang::diag::err_fe_unable_to_create_target) << Error;
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700134 return false;
135 }
136
Logan Chienac4e1852011-12-16 13:37:10 +0800137 // Target Machine Options
138 llvm::TargetOptions Options;
139
Pirama Arumuga Nainar167bd792015-06-30 19:46:13 -0700140 // Use soft-float ABI for ARM (which is the target used by Slang during code
141 // generation). Codegen still uses hardware FPU by default. To use software
142 // floating point, add 'soft-float' feature to FeaturesStr below.
143 Options.FloatABIType = llvm::FloatABI::Soft;
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700144
145 // BCC needs all unknown symbols resolved at compilation time. So we don't
146 // need any relocation model.
Logan Chienab992e52011-07-20 22:06:52 +0800147 llvm::Reloc::Model RM = llvm::Reloc::Static;
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700148
Zonr Chang41ebf532010-10-13 18:29:18 +0800149 // This is set for the linker (specify how large of the virtual addresses we
150 // can access for all unknown symbols.)
Logan Chien9207a2e2011-10-21 15:39:28 +0800151 llvm::CodeModel::Model CM;
Stephen Hines0b754582015-04-07 13:59:57 -0700152 if (mpModule->getDataLayout().getPointerSize() == 4) {
Logan Chien9207a2e2011-10-21 15:39:28 +0800153 CM = llvm::CodeModel::Small;
154 } else {
Zonr Chang41ebf532010-10-13 18:29:18 +0800155 // The target may have pointer size greater than 32 (e.g. x86_64
156 // architecture) may need large data address model
Logan Chien9207a2e2011-10-21 15:39:28 +0800157 CM = llvm::CodeModel::Medium;
158 }
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700159
160 // Setup feature string
161 std::string FeaturesStr;
162 if (mTargetOpts.CPU.size() || mTargetOpts.Features.size()) {
163 llvm::SubtargetFeatures Features;
164
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700165 for (std::vector<std::string>::const_iterator
166 I = mTargetOpts.Features.begin(), E = mTargetOpts.Features.end();
167 I != E;
168 I++)
169 Features.AddFeature(*I);
170
171 FeaturesStr = Features.getString();
172 }
Logan Chien9207a2e2011-10-21 15:39:28 +0800173
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700174 llvm::TargetMachine *TM =
Logan Chien9207a2e2011-10-21 15:39:28 +0800175 TargetInfo->createTargetMachine(Triple, mTargetOpts.CPU, FeaturesStr,
Logan Chienac4e1852011-12-16 13:37:10 +0800176 Options, RM, CM);
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700177
178 // Register scheduler
179 llvm::RegisterScheduler::setDefault(llvm::createDefaultScheduler);
180
181 // Register allocation policy:
182 // createFastRegisterAllocator: fast but bad quality
Logan Chien2c6bad52011-11-15 15:57:33 +0800183 // createGreedyRegisterAllocator: not so fast but good quality
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700184 llvm::RegisterRegAlloc::setDefault((mCodeGenOpts.OptimizationLevel == 0) ?
185 llvm::createFastRegisterAllocator :
Logan Chien2c6bad52011-11-15 15:57:33 +0800186 llvm::createGreedyRegisterAllocator);
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700187
188 llvm::CodeGenOpt::Level OptLevel = llvm::CodeGenOpt::Default;
Shih-wei Liao77703262011-07-02 11:30:32 -0700189 if (mCodeGenOpts.OptimizationLevel == 0) {
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700190 OptLevel = llvm::CodeGenOpt::None;
Shih-wei Liao77703262011-07-02 11:30:32 -0700191 } else if (mCodeGenOpts.OptimizationLevel == 3) {
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700192 OptLevel = llvm::CodeGenOpt::Aggressive;
Shih-wei Liao77703262011-07-02 11:30:32 -0700193 }
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700194
195 llvm::TargetMachine::CodeGenFileType CGFT =
zonr6315f762010-10-05 15:35:14 +0800196 llvm::TargetMachine::CGFT_AssemblyFile;
Shih-wei Liao77703262011-07-02 11:30:32 -0700197 if (mOT == Slang::OT_Object) {
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700198 CGFT = llvm::TargetMachine::CGFT_ObjectFile;
Shih-wei Liao77703262011-07-02 11:30:32 -0700199 }
Pirama Arumuga Nainar21cc0182015-05-06 11:17:16 -0700200 if (TM->addPassesToEmitFile(*mCodeGenPasses, mBufferOutStream,
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700201 CGFT, OptLevel)) {
Logan Chien9207a2e2011-10-21 15:39:28 +0800202 mDiagEngine.Report(clang::diag::err_fe_unable_to_interface_with_target);
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700203 return false;
204 }
205
206 return true;
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700207}
208
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700209Backend::Backend(RSContext *Context, clang::DiagnosticsEngine *DiagEngine,
David Gross2770d0e2015-08-03 14:58:59 -0700210 const RSCCOptions &Opts, const clang::CodeGenOptions &CodeGenOpts,
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700211 const clang::TargetOptions &TargetOpts, PragmaList *Pragmas,
212 llvm::raw_ostream *OS, Slang::OutputType OT,
213 clang::SourceManager &SourceMgr, bool AllowRSPrefix,
214 bool IsFilterscript)
215 : ASTConsumer(), mTargetOpts(TargetOpts), mpModule(nullptr), mpOS(OS),
216 mOT(OT), mGen(nullptr), mPerFunctionPasses(nullptr),
Pirama Arumuga Nainar21cc0182015-05-06 11:17:16 -0700217 mPerModulePasses(nullptr), mCodeGenPasses(nullptr),
218 mBufferOutStream(*mpOS), mContext(Context),
David Gross2770d0e2015-08-03 14:58:59 -0700219 mSourceMgr(SourceMgr), mASTPrint(Opts.mASTPrint), mAllowRSPrefix(AllowRSPrefix),
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700220 mIsFilterscript(IsFilterscript), mExportVarMetadata(nullptr),
221 mExportFuncMetadata(nullptr), mExportForEachNameMetadata(nullptr),
Matt Walac0c5dd82015-07-23 17:29:37 -0700222 mExportForEachSignatureMetadata(nullptr), mExportReduceMetadata(nullptr),
223 mExportTypeMetadata(nullptr), mRSObjectSlotsMetadata(nullptr),
224 mRefCount(mContext->getASTContext()),
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700225 mASTChecker(Context, Context->getTargetAPI(), IsFilterscript),
Yang Nifb40ee22015-10-13 20:34:06 +0000226 mForEachHandler(Context),
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700227 mLLVMContext(llvm::getGlobalContext()), mDiagEngine(*DiagEngine),
228 mCodeGenOpts(CodeGenOpts), mPragmas(Pragmas) {
Stephen Hinesc7069072015-03-18 14:53:14 -0700229 mGen = CreateLLVMCodeGen(mDiagEngine, "", mCodeGenOpts, mLLVMContext);
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700230}
231
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700232void Backend::Initialize(clang::ASTContext &Ctx) {
233 mGen->Initialize(Ctx);
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700234
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700235 mpModule = mGen->GetModule();
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700236}
237
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700238void Backend::HandleTranslationUnit(clang::ASTContext &Ctx) {
Zonr Chang68fc02c2010-10-13 19:09:19 +0800239 HandleTranslationUnitPre(Ctx);
240
David Gross2770d0e2015-08-03 14:58:59 -0700241 if (mASTPrint)
242 Ctx.getTranslationUnitDecl()->dump();
243
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700244 mGen->HandleTranslationUnit(Ctx);
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700245
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700246 // Here, we complete a translation unit (whole translation unit is now in LLVM
247 // IR). Now, interact with LLVM backend to generate actual machine code (asm
248 // or machine code, whatever.)
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700249
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700250 // Silently ignore if we weren't initialized for some reason.
Zonr Chang41ebf532010-10-13 18:29:18 +0800251 if (!mpModule)
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700252 return;
253
254 llvm::Module *M = mGen->ReleaseModule();
255 if (!M) {
256 // The module has been released by IR gen on failures, do not double free.
Chris Wailes5abbe0e2014-08-12 15:58:29 -0700257 mpModule = nullptr;
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700258 return;
259 }
260
Stephen Hines6e6578a2011-02-07 18:05:48 -0800261 slangAssert(mpModule == M &&
262 "Unexpected module change during LLVM IR generation");
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700263
264 // Insert #pragma information into metadata section of module
Stephen Hines3fd0a942011-01-18 12:27:39 -0800265 if (!mPragmas->empty()) {
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700266 llvm::NamedMDNode *PragmaMetadata =
267 mpModule->getOrInsertNamedMetadata(Slang::PragmaMetadataName);
Stephen Hines3fd0a942011-01-18 12:27:39 -0800268 for (PragmaList::const_iterator I = mPragmas->begin(), E = mPragmas->end();
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700269 I != E;
270 I++) {
Stephen Hinesc7069072015-03-18 14:53:14 -0700271 llvm::SmallVector<llvm::Metadata*, 2> Pragma;
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700272 // Name goes first
273 Pragma.push_back(llvm::MDString::get(mLLVMContext, I->first));
274 // And then value
275 Pragma.push_back(llvm::MDString::get(mLLVMContext, I->second));
Shih-wei Liao83f0c622011-06-21 05:34:53 -0700276
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700277 // Create MDNode and insert into PragmaMetadata
278 PragmaMetadata->addOperand(
Stephen Hines18c88292011-07-14 22:46:15 -0700279 llvm::MDNode::get(mLLVMContext, Pragma));
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700280 }
281 }
282
Zonr Chang68fc02c2010-10-13 19:09:19 +0800283 HandleTranslationUnitPost(mpModule);
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700284
285 // Create passes for optimization and code emission
286
287 // Create and run per-function passes
288 CreateFunctionPasses();
289 if (mPerFunctionPasses) {
290 mPerFunctionPasses->doInitialization();
291
292 for (llvm::Module::iterator I = mpModule->begin(), E = mpModule->end();
293 I != E;
294 I++)
295 if (!I->isDeclaration())
296 mPerFunctionPasses->run(*I);
297
298 mPerFunctionPasses->doFinalization();
299 }
300
301 // Create and run module passes
302 CreateModulePasses();
303 if (mPerModulePasses)
304 mPerModulePasses->run(*mpModule);
305
Zonr Chang3a9ca1f2010-10-06 17:52:56 +0800306 switch (mOT) {
307 case Slang::OT_Assembly:
308 case Slang::OT_Object: {
zonr6315f762010-10-05 15:35:14 +0800309 if (!CreateCodeGenPasses())
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700310 return;
311
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700312 mCodeGenPasses->doInitialization();
313
314 for (llvm::Module::iterator I = mpModule->begin(), E = mpModule->end();
315 I != E;
316 I++)
zonr6315f762010-10-05 15:35:14 +0800317 if (!I->isDeclaration())
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700318 mCodeGenPasses->run(*I);
319
320 mCodeGenPasses->doFinalization();
321 break;
322 }
Zonr Chang3a9ca1f2010-10-06 17:52:56 +0800323 case Slang::OT_LLVMAssembly: {
Stephen Hinesc7069072015-03-18 14:53:14 -0700324 llvm::legacy::PassManager *LLEmitPM = new llvm::legacy::PassManager();
Pirama Arumuga Nainar21cc0182015-05-06 11:17:16 -0700325 LLEmitPM->add(llvm::createPrintModulePass(mBufferOutStream));
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700326 LLEmitPM->run(*mpModule);
327 break;
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700328 }
Zonr Chang3a9ca1f2010-10-06 17:52:56 +0800329 case Slang::OT_Bitcode: {
Matt Waladabd2462015-07-15 18:39:41 -0700330 writeBitcode(mBufferOutStream, *mpModule, getTargetAPI(),
Stephen McGroartyb130e152015-07-23 16:55:02 +0100331 mCodeGenOpts.OptimizationLevel, mCodeGenOpts.getDebugInfo());
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700332 break;
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700333 }
Zonr Chang3a9ca1f2010-10-06 17:52:56 +0800334 case Slang::OT_Nothing: {
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700335 return;
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700336 }
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700337 default: {
Stephen Hines6e6578a2011-02-07 18:05:48 -0800338 slangAssert(false && "Unknown output type");
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700339 }
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700340 }
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700341
Pirama Arumuga Nainar21cc0182015-05-06 11:17:16 -0700342 mBufferOutStream.flush();
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700343}
344
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700345void Backend::HandleTagDeclDefinition(clang::TagDecl *D) {
346 mGen->HandleTagDeclDefinition(D);
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700347}
348
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700349void Backend::CompleteTentativeDefinition(clang::VarDecl *D) {
350 mGen->CompleteTentativeDefinition(D);
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700351}
352
353Backend::~Backend() {
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700354 delete mpModule;
Shih-wei Liao9ef2f782010-10-01 12:31:37 -0700355 delete mGen;
356 delete mPerFunctionPasses;
357 delete mPerModulePasses;
358 delete mCodeGenPasses;
Shih-wei Liao462aefd2010-06-04 15:32:04 -0700359}
Stephen Hinese639eb52010-11-08 19:27:20 -0800360
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700361// 1) Add zero initialization of local RS object types
362void Backend::AnnotateFunction(clang::FunctionDecl *FD) {
363 if (FD &&
364 FD->hasBody() &&
365 !Slang::IsLocInRSHeaderFile(FD->getLocation(), mSourceMgr)) {
366 mRefCount.Init();
367 mRefCount.Visit(FD->getBody());
368 }
369}
370
Yang Nifb40ee22015-10-13 20:34:06 +0000371void Backend::LowerRSForEachCall(clang::FunctionDecl *FD) {
372 // Skip this AST walking for lower API levels.
373 if (getTargetAPI() < SLANG_DEVELOPMENT_TARGET_API) {
374 return;
375 }
376
377 if (!FD || !FD->hasBody() ||
378 Slang::IsLocInRSHeaderFile(FD->getLocation(), mSourceMgr)) {
379 return;
380 }
381
382 mForEachHandler.VisitStmt(FD->getBody());
383}
384
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700385bool Backend::HandleTopLevelDecl(clang::DeclGroupRef D) {
386 // Disallow user-defined functions with prefix "rs"
387 if (!mAllowRSPrefix) {
388 // Iterate all function declarations in the program.
389 for (clang::DeclGroupRef::iterator I = D.begin(), E = D.end();
390 I != E; I++) {
391 clang::FunctionDecl *FD = llvm::dyn_cast<clang::FunctionDecl>(*I);
392 if (FD == nullptr)
393 continue;
394 if (!FD->getName().startswith("rs")) // Check prefix
395 continue;
396 if (!Slang::IsLocInRSHeaderFile(FD->getLocation(), mSourceMgr))
397 mContext->ReportError(FD->getLocation(),
398 "invalid function name prefix, "
399 "\"rs\" is reserved: '%0'")
400 << FD->getName();
401 }
402 }
403
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700404 for (clang::DeclGroupRef::iterator I = D.begin(), E = D.end(); I != E; I++) {
405 clang::FunctionDecl *FD = llvm::dyn_cast<clang::FunctionDecl>(*I);
Yang Nifb40ee22015-10-13 20:34:06 +0000406 // Process any non-static function declarations
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700407 if (FD && FD->isGlobal()) {
408 // Check that we don't have any array parameters being misintrepeted as
409 // kernel pointers due to the C type system's array to pointer decay.
410 size_t numParams = FD->getNumParams();
411 for (size_t i = 0; i < numParams; i++) {
412 const clang::ParmVarDecl *PVD = FD->getParamDecl(i);
413 clang::QualType QT = PVD->getOriginalType();
414 if (QT->isArrayType()) {
415 mContext->ReportError(
416 PVD->getTypeSpecStartLoc(),
417 "exported function parameters may not have array type: %0")
418 << QT;
419 }
420 }
421 AnnotateFunction(FD);
422 }
Yang Nifb40ee22015-10-13 20:34:06 +0000423
Yang Ni19467492015-10-27 15:24:41 -0700424 if (getTargetAPI() == SLANG_DEVELOPMENT_TARGET_API) {
425 if (FD && FD->hasBody() &&
426 RSExportForEach::isRSForEachFunc(getTargetAPI(), FD)) {
427 // Log kernels by their names, and assign them slot numbers.
428 if (!Slang::IsLocInRSHeaderFile(FD->getLocation(), mSourceMgr)) {
429 mContext->addForEach(FD);
430 }
431 } else {
432 // Look for any kernel launch calls and translate them into using the
433 // internal API.
434 // TODO: Simply ignores kernel launch inside a kernel for now.
435 // Needs more rigorous and comprehensive checks.
436 LowerRSForEachCall(FD);
Yang Nifb40ee22015-10-13 20:34:06 +0000437 }
Yang Nifb40ee22015-10-13 20:34:06 +0000438 }
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700439 }
Yang Nifb40ee22015-10-13 20:34:06 +0000440
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700441 return mGen->HandleTopLevelDecl(D);
442}
443
444void Backend::HandleTranslationUnitPre(clang::ASTContext &C) {
445 clang::TranslationUnitDecl *TUDecl = C.getTranslationUnitDecl();
446
447 // If we have an invalid RS/FS AST, don't check further.
448 if (!mASTChecker.Validate()) {
449 return;
450 }
451
452 if (mIsFilterscript) {
453 mContext->addPragma("rs_fp_relaxed", "");
454 }
455
456 int version = mContext->getVersion();
457 if (version == 0) {
458 // Not setting a version is an error
459 mDiagEngine.Report(
460 mSourceMgr.getLocForEndOfFile(mSourceMgr.getMainFileID()),
461 mDiagEngine.getCustomDiagID(
462 clang::DiagnosticsEngine::Error,
463 "missing pragma for version in source file"));
464 } else {
465 slangAssert(version == 1);
466 }
467
468 if (mContext->getReflectJavaPackageName().empty()) {
469 mDiagEngine.Report(
470 mSourceMgr.getLocForEndOfFile(mSourceMgr.getMainFileID()),
471 mDiagEngine.getCustomDiagID(clang::DiagnosticsEngine::Error,
472 "missing \"#pragma rs "
473 "java_package_name(com.foo.bar)\" "
474 "in source file"));
475 return;
476 }
477
478 // Create a static global destructor if necessary (to handle RS object
479 // runtime cleanup).
480 clang::FunctionDecl *FD = mRefCount.CreateStaticGlobalDtor();
481 if (FD) {
482 HandleTopLevelDecl(clang::DeclGroupRef(FD));
483 }
484
485 // Process any static function declarations
486 for (clang::DeclContext::decl_iterator I = TUDecl->decls_begin(),
487 E = TUDecl->decls_end(); I != E; I++) {
488 if ((I->getKind() >= clang::Decl::firstFunction) &&
489 (I->getKind() <= clang::Decl::lastFunction)) {
490 clang::FunctionDecl *FD = llvm::dyn_cast<clang::FunctionDecl>(*I);
491 if (FD && !FD->isGlobal()) {
492 AnnotateFunction(FD);
493 }
494 }
495 }
496}
497
498///////////////////////////////////////////////////////////////////////////////
499void Backend::dumpExportVarInfo(llvm::Module *M) {
500 int slotCount = 0;
501 if (mExportVarMetadata == nullptr)
502 mExportVarMetadata = M->getOrInsertNamedMetadata(RS_EXPORT_VAR_MN);
503
504 llvm::SmallVector<llvm::Metadata *, 2> ExportVarInfo;
505
506 // We emit slot information (#rs_object_slots) for any reference counted
507 // RS type or pointer (which can also be bound).
508
509 for (RSContext::const_export_var_iterator I = mContext->export_vars_begin(),
510 E = mContext->export_vars_end();
511 I != E;
512 I++) {
513 const RSExportVar *EV = *I;
514 const RSExportType *ET = EV->getType();
515 bool countsAsRSObject = false;
516
517 // Variable name
518 ExportVarInfo.push_back(
519 llvm::MDString::get(mLLVMContext, EV->getName().c_str()));
520
521 // Type name
522 switch (ET->getClass()) {
523 case RSExportType::ExportClassPrimitive: {
524 const RSExportPrimitiveType *PT =
525 static_cast<const RSExportPrimitiveType*>(ET);
526 ExportVarInfo.push_back(
527 llvm::MDString::get(
528 mLLVMContext, llvm::utostr_32(PT->getType())));
529 if (PT->isRSObjectType()) {
530 countsAsRSObject = true;
531 }
532 break;
533 }
534 case RSExportType::ExportClassPointer: {
535 ExportVarInfo.push_back(
536 llvm::MDString::get(
537 mLLVMContext, ("*" + static_cast<const RSExportPointerType*>(ET)
538 ->getPointeeType()->getName()).c_str()));
539 break;
540 }
541 case RSExportType::ExportClassMatrix: {
542 ExportVarInfo.push_back(
543 llvm::MDString::get(
544 mLLVMContext, llvm::utostr_32(
545 /* TODO Strange value. This pushes just a number, quite
546 * different than the other cases. What is this used for?
547 * These are the metadata values that some partner drivers
548 * want to reference (for TBAA, etc.). We may want to look
549 * at whether these provide any reasonable value (or have
550 * distinct enough values to actually depend on).
551 */
552 DataTypeRSMatrix2x2 +
553 static_cast<const RSExportMatrixType*>(ET)->getDim() - 2)));
554 break;
555 }
556 case RSExportType::ExportClassVector:
557 case RSExportType::ExportClassConstantArray:
558 case RSExportType::ExportClassRecord: {
559 ExportVarInfo.push_back(
560 llvm::MDString::get(mLLVMContext,
561 EV->getType()->getName().c_str()));
562 break;
563 }
564 }
565
566 mExportVarMetadata->addOperand(
567 llvm::MDNode::get(mLLVMContext, ExportVarInfo));
568 ExportVarInfo.clear();
569
570 if (mRSObjectSlotsMetadata == nullptr) {
571 mRSObjectSlotsMetadata =
572 M->getOrInsertNamedMetadata(RS_OBJECT_SLOTS_MN);
573 }
574
575 if (countsAsRSObject) {
576 mRSObjectSlotsMetadata->addOperand(llvm::MDNode::get(mLLVMContext,
577 llvm::MDString::get(mLLVMContext, llvm::utostr_32(slotCount))));
578 }
579
580 slotCount++;
581 }
582}
583
584void Backend::dumpExportFunctionInfo(llvm::Module *M) {
585 if (mExportFuncMetadata == nullptr)
586 mExportFuncMetadata =
587 M->getOrInsertNamedMetadata(RS_EXPORT_FUNC_MN);
588
589 llvm::SmallVector<llvm::Metadata *, 1> ExportFuncInfo;
590
591 for (RSContext::const_export_func_iterator
592 I = mContext->export_funcs_begin(),
593 E = mContext->export_funcs_end();
594 I != E;
595 I++) {
596 const RSExportFunc *EF = *I;
597
598 // Function name
599 if (!EF->hasParam()) {
600 ExportFuncInfo.push_back(llvm::MDString::get(mLLVMContext,
601 EF->getName().c_str()));
602 } else {
603 llvm::Function *F = M->getFunction(EF->getName());
604 llvm::Function *HelperFunction;
605 const std::string HelperFunctionName(".helper_" + EF->getName());
606
607 slangAssert(F && "Function marked as exported disappeared in Bitcode");
608
609 // Create helper function
610 {
611 llvm::StructType *HelperFunctionParameterTy = nullptr;
612 std::vector<bool> isStructInput;
613
614 if (!F->getArgumentList().empty()) {
615 std::vector<llvm::Type*> HelperFunctionParameterTys;
616 for (llvm::Function::arg_iterator AI = F->arg_begin(),
617 AE = F->arg_end(); AI != AE; AI++) {
618 if (AI->getType()->isPointerTy() && AI->getType()->getPointerElementType()->isStructTy()) {
619 HelperFunctionParameterTys.push_back(AI->getType()->getPointerElementType());
620 isStructInput.push_back(true);
621 } else {
622 HelperFunctionParameterTys.push_back(AI->getType());
623 isStructInput.push_back(false);
624 }
625 }
626 HelperFunctionParameterTy =
627 llvm::StructType::get(mLLVMContext, HelperFunctionParameterTys);
628 }
629
630 if (!EF->checkParameterPacketType(HelperFunctionParameterTy)) {
631 fprintf(stderr, "Failed to export function %s: parameter type "
632 "mismatch during creation of helper function.\n",
633 EF->getName().c_str());
634
635 const RSExportRecordType *Expected = EF->getParamPacketType();
636 if (Expected) {
637 fprintf(stderr, "Expected:\n");
638 Expected->getLLVMType()->dump();
639 }
640 if (HelperFunctionParameterTy) {
641 fprintf(stderr, "Got:\n");
642 HelperFunctionParameterTy->dump();
643 }
644 }
645
646 std::vector<llvm::Type*> Params;
647 if (HelperFunctionParameterTy) {
648 llvm::PointerType *HelperFunctionParameterTyP =
649 llvm::PointerType::getUnqual(HelperFunctionParameterTy);
650 Params.push_back(HelperFunctionParameterTyP);
651 }
652
653 llvm::FunctionType * HelperFunctionType =
654 llvm::FunctionType::get(F->getReturnType(),
655 Params,
656 /* IsVarArgs = */false);
657
658 HelperFunction =
659 llvm::Function::Create(HelperFunctionType,
660 llvm::GlobalValue::ExternalLinkage,
661 HelperFunctionName,
662 M);
663
664 HelperFunction->addFnAttr(llvm::Attribute::NoInline);
665 HelperFunction->setCallingConv(F->getCallingConv());
666
667 // Create helper function body
668 {
669 llvm::Argument *HelperFunctionParameter =
670 &(*HelperFunction->arg_begin());
671 llvm::BasicBlock *BB =
672 llvm::BasicBlock::Create(mLLVMContext, "entry", HelperFunction);
673 llvm::IRBuilder<> *IB = new llvm::IRBuilder<>(BB);
674 llvm::SmallVector<llvm::Value*, 6> Params;
675 llvm::Value *Idx[2];
676
677 Idx[0] =
678 llvm::ConstantInt::get(llvm::Type::getInt32Ty(mLLVMContext), 0);
679
680 // getelementptr and load instruction for all elements in
681 // parameter .p
682 for (size_t i = 0; i < EF->getNumParameters(); i++) {
683 // getelementptr
684 Idx[1] = llvm::ConstantInt::get(
685 llvm::Type::getInt32Ty(mLLVMContext), i);
686
687 llvm::Value *Ptr = NULL;
688
689 Ptr = IB->CreateInBoundsGEP(HelperFunctionParameter, Idx);
690
691 // Load is only required for non-struct ptrs
692 if (isStructInput[i]) {
693 Params.push_back(Ptr);
694 } else {
695 llvm::Value *V = IB->CreateLoad(Ptr);
696 Params.push_back(V);
697 }
698 }
699
700 // Call and pass the all elements as parameter to F
701 llvm::CallInst *CI = IB->CreateCall(F, Params);
702
703 CI->setCallingConv(F->getCallingConv());
704
Yang Nifb40ee22015-10-13 20:34:06 +0000705 if (F->getReturnType() == llvm::Type::getVoidTy(mLLVMContext)) {
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700706 IB->CreateRetVoid();
Yang Nifb40ee22015-10-13 20:34:06 +0000707 } else {
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700708 IB->CreateRet(CI);
Yang Nifb40ee22015-10-13 20:34:06 +0000709 }
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700710
711 delete IB;
712 }
713 }
714
715 ExportFuncInfo.push_back(
716 llvm::MDString::get(mLLVMContext, HelperFunctionName.c_str()));
717 }
718
719 mExportFuncMetadata->addOperand(
720 llvm::MDNode::get(mLLVMContext, ExportFuncInfo));
721 ExportFuncInfo.clear();
722 }
723}
724
725void Backend::dumpExportForEachInfo(llvm::Module *M) {
726 if (mExportForEachNameMetadata == nullptr) {
727 mExportForEachNameMetadata =
728 M->getOrInsertNamedMetadata(RS_EXPORT_FOREACH_NAME_MN);
729 }
730 if (mExportForEachSignatureMetadata == nullptr) {
731 mExportForEachSignatureMetadata =
732 M->getOrInsertNamedMetadata(RS_EXPORT_FOREACH_MN);
733 }
734
735 llvm::SmallVector<llvm::Metadata *, 1> ExportForEachName;
736 llvm::SmallVector<llvm::Metadata *, 1> ExportForEachInfo;
737
738 for (RSContext::const_export_foreach_iterator
739 I = mContext->export_foreach_begin(),
740 E = mContext->export_foreach_end();
741 I != E;
742 I++) {
743 const RSExportForEach *EFE = *I;
744
745 ExportForEachName.push_back(
746 llvm::MDString::get(mLLVMContext, EFE->getName().c_str()));
747
748 mExportForEachNameMetadata->addOperand(
749 llvm::MDNode::get(mLLVMContext, ExportForEachName));
750 ExportForEachName.clear();
751
752 ExportForEachInfo.push_back(
753 llvm::MDString::get(mLLVMContext,
754 llvm::utostr_32(EFE->getSignatureMetadata())));
755
756 mExportForEachSignatureMetadata->addOperand(
757 llvm::MDNode::get(mLLVMContext, ExportForEachInfo));
758 ExportForEachInfo.clear();
759 }
760}
761
Matt Walac0c5dd82015-07-23 17:29:37 -0700762void Backend::dumpExportReduceInfo(llvm::Module *M) {
763 if (!mExportReduceMetadata) {
764 mExportReduceMetadata = M->getOrInsertNamedMetadata(RS_EXPORT_REDUCE_MN);
765 }
766
767 llvm::SmallVector<llvm::Metadata *, 1> ExportReduceInfo;
768
769 // Add the names of the reduce-style kernel functions to the metadata node.
770 for (auto I = mContext->export_reduce_begin(),
771 E = mContext->export_reduce_end(); I != E; ++I) {
772 ExportReduceInfo.clear();
773
774 ExportReduceInfo.push_back(
775 llvm::MDString::get(mLLVMContext, (*I)->getName().c_str()));
776
777 mExportReduceMetadata->addOperand(
778 llvm::MDNode::get(mLLVMContext, ExportReduceInfo));
779 }
780}
781
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700782void Backend::dumpExportTypeInfo(llvm::Module *M) {
783 llvm::SmallVector<llvm::Metadata *, 1> ExportTypeInfo;
784
785 for (RSContext::const_export_type_iterator
786 I = mContext->export_types_begin(),
787 E = mContext->export_types_end();
788 I != E;
789 I++) {
790 // First, dump type name list to export
791 const RSExportType *ET = I->getValue();
792
793 ExportTypeInfo.clear();
794 // Type name
795 ExportTypeInfo.push_back(
796 llvm::MDString::get(mLLVMContext, ET->getName().c_str()));
797
798 if (ET->getClass() == RSExportType::ExportClassRecord) {
799 const RSExportRecordType *ERT =
800 static_cast<const RSExportRecordType*>(ET);
801
802 if (mExportTypeMetadata == nullptr)
803 mExportTypeMetadata =
804 M->getOrInsertNamedMetadata(RS_EXPORT_TYPE_MN);
805
806 mExportTypeMetadata->addOperand(
807 llvm::MDNode::get(mLLVMContext, ExportTypeInfo));
808
809 // Now, export struct field information to %[struct name]
810 std::string StructInfoMetadataName("%");
811 StructInfoMetadataName.append(ET->getName());
812 llvm::NamedMDNode *StructInfoMetadata =
813 M->getOrInsertNamedMetadata(StructInfoMetadataName);
814 llvm::SmallVector<llvm::Metadata *, 3> FieldInfo;
815
816 slangAssert(StructInfoMetadata->getNumOperands() == 0 &&
817 "Metadata with same name was created before");
818 for (RSExportRecordType::const_field_iterator FI = ERT->fields_begin(),
819 FE = ERT->fields_end();
820 FI != FE;
821 FI++) {
822 const RSExportRecordType::Field *F = *FI;
823
824 // 1. field name
825 FieldInfo.push_back(llvm::MDString::get(mLLVMContext,
826 F->getName().c_str()));
827
828 // 2. field type name
829 FieldInfo.push_back(
830 llvm::MDString::get(mLLVMContext,
831 F->getType()->getName().c_str()));
832
833 StructInfoMetadata->addOperand(
834 llvm::MDNode::get(mLLVMContext, FieldInfo));
835 FieldInfo.clear();
836 }
837 } // ET->getClass() == RSExportType::ExportClassRecord
838 }
839}
840
841void Backend::HandleTranslationUnitPost(llvm::Module *M) {
842
843 if (!mContext->is64Bit()) {
844 M->setDataLayout("e-p:32:32-i64:64-v128:64:128-n32-S64");
845 }
846
Yang Nifb40ee22015-10-13 20:34:06 +0000847 if (!mContext->processExports()) {
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700848 return;
849 }
850
851 if (mContext->hasExportVar())
852 dumpExportVarInfo(M);
853
854 if (mContext->hasExportFunc())
855 dumpExportFunctionInfo(M);
856
857 if (mContext->hasExportForEach())
858 dumpExportForEachInfo(M);
859
Matt Walac0c5dd82015-07-23 17:29:37 -0700860 if (mContext->hasExportReduce())
861 dumpExportReduceInfo(M);
862
Jean-Luc Brouillet8024ed52015-05-04 23:02:25 -0700863 if (mContext->hasExportType())
864 dumpExportTypeInfo(M);
865}
866
Stephen Hinese639eb52010-11-08 19:27:20 -0800867} // namespace slang