blob: 36a6c638e6f244c21bf5d545c5484fb05b51aafe [file] [log] [blame]
Daniel Dunbarf976d1b2010-06-07 23:20:08 +00001//===--- BackendUtil.cpp - LLVM Backend Utilities -------------------------===//
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
Daniel Dunbarc1b17292010-06-15 17:48:49 +000010#include "clang/CodeGen/BackendUtil.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000011#include "clang/Basic/Diagnostic.h"
Dan Gohmanfec0ff82011-07-05 22:02:36 +000012#include "clang/Basic/LangOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000013#include "clang/Basic/TargetOptions.h"
Chandler Carruth85098242010-06-15 23:19:56 +000014#include "clang/Frontend/CodeGenOptions.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000015#include "clang/Frontend/FrontendDiagnostic.h"
Kostya Serebryanyce2c7262013-12-27 08:11:08 +000016#include "clang/Frontend/Utils.h"
Saleem Abdulrasool62849c62014-05-08 02:28:32 +000017#include "llvm/ADT/StringSwitch.h"
Chandler Carruth1b3304d2014-01-13 07:47:38 +000018#include "llvm/Bitcode/BitcodeWriterPass.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000019#include "llvm/CodeGen/RegAllocRegistry.h"
20#include "llvm/CodeGen/SchedulerRegistry.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000021#include "llvm/IR/DataLayout.h"
Chandler Carruth0a50c492014-01-12 11:11:50 +000022#include "llvm/IR/IRPrintingPasses.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000023#include "llvm/IR/Module.h"
Chandler Carruthca884742014-01-13 09:26:48 +000024#include "llvm/IR/Verifier.h"
Evan Chengeeb486d2011-06-29 01:14:32 +000025#include "llvm/MC/SubtargetFeature.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000026#include "llvm/PassManager.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000027#include "llvm/Support/CommandLine.h"
28#include "llvm/Support/FormattedStream.h"
29#include "llvm/Support/PrettyStackTrace.h"
Evan Cheng494eb062011-08-24 18:09:14 +000030#include "llvm/Support/TargetRegistry.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000031#include "llvm/Support/Timer.h"
32#include "llvm/Support/raw_ostream.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000033#include "llvm/Target/TargetLibraryInfo.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000034#include "llvm/Target/TargetMachine.h"
35#include "llvm/Target/TargetOptions.h"
Eric Christopher3de08532014-08-04 21:33:42 +000036#include "llvm/Target/TargetSubtargetInfo.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000037#include "llvm/Transforms/IPO.h"
38#include "llvm/Transforms/IPO/PassManagerBuilder.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000039#include "llvm/Transforms/Instrumentation.h"
Michael Gottesman90cae772013-01-28 01:36:00 +000040#include "llvm/Transforms/ObjCARC.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000041#include "llvm/Transforms/Scalar.h"
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000042#include <memory>
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000043using namespace clang;
44using namespace llvm;
45
46namespace {
47
48class EmitAssemblyHelper {
David Blaikie9c902b52011-09-25 23:23:43 +000049 DiagnosticsEngine &Diags;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000050 const CodeGenOptions &CodeGenOpts;
Nick Lewycky432add52011-12-02 22:17:00 +000051 const clang::TargetOptions &TargetOpts;
Dan Gohmanfec0ff82011-07-05 22:02:36 +000052 const LangOptions &LangOpts;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000053 Module *TheModule;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000054
55 Timer CodeGenerationTime;
56
Daniel Dunbar195fa002010-09-17 07:35:16 +000057 mutable PassManager *CodeGenPasses;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000058 mutable PassManager *PerModulePasses;
59 mutable FunctionPassManager *PerFunctionPasses;
60
61private:
Alp Tokerf4e22382013-12-20 20:26:53 +000062 PassManager *getCodeGenPasses() const {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000063 if (!CodeGenPasses) {
Daniel Dunbar195fa002010-09-17 07:35:16 +000064 CodeGenPasses = new PassManager();
Rafael Espindola303f8b02014-02-25 17:30:40 +000065 CodeGenPasses->add(new DataLayoutPass(TheModule));
Chandler Carruthed0f133b2013-01-07 01:38:01 +000066 if (TM)
67 TM->addAnalysisPasses(*CodeGenPasses);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000068 }
69 return CodeGenPasses;
70 }
71
Alp Tokerf4e22382013-12-20 20:26:53 +000072 PassManager *getPerModulePasses() const {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000073 if (!PerModulePasses) {
74 PerModulePasses = new PassManager();
Rafael Espindola303f8b02014-02-25 17:30:40 +000075 PerModulePasses->add(new DataLayoutPass(TheModule));
Chandler Carruthed0f133b2013-01-07 01:38:01 +000076 if (TM)
77 TM->addAnalysisPasses(*PerModulePasses);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000078 }
79 return PerModulePasses;
80 }
81
Alp Tokerf4e22382013-12-20 20:26:53 +000082 FunctionPassManager *getPerFunctionPasses() const {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000083 if (!PerFunctionPasses) {
84 PerFunctionPasses = new FunctionPassManager(TheModule);
Rafael Espindola303f8b02014-02-25 17:30:40 +000085 PerFunctionPasses->add(new DataLayoutPass(TheModule));
Chandler Carruthed0f133b2013-01-07 01:38:01 +000086 if (TM)
87 TM->addAnalysisPasses(*PerFunctionPasses);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000088 }
89 return PerFunctionPasses;
90 }
91
Alp Tokerf4e22382013-12-20 20:26:53 +000092 void CreatePasses();
Nadav Rotemec57ab32012-10-24 00:53:38 +000093
Nadav Rotemdc06b2d2012-10-24 03:52:31 +000094 /// CreateTargetMachine - Generates the TargetMachine.
95 /// Returns Null if it is unable to create the target machine.
96 /// Some of our clang tests specify triples which are not built
97 /// into clang. This is okay because these tests check the generated
98 /// IR, and they require DataLayout which depends on the triple.
99 /// In this case, we allow this method to fail and not report an error.
100 /// When MustCreateTM is used, we print an error if we are unable to load
101 /// the requested target.
102 TargetMachine *CreateTargetMachine(bool MustCreateTM);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000103
104 /// AddEmitPasses - Add passes necessary to emit assembly or LLVM IR.
105 ///
106 /// \return True on success.
Alp Tokerf4e22382013-12-20 20:26:53 +0000107 bool AddEmitPasses(BackendAction Action, formatted_raw_ostream &OS);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000108
109public:
David Blaikie9c902b52011-09-25 23:23:43 +0000110 EmitAssemblyHelper(DiagnosticsEngine &_Diags,
Nick Lewycky432add52011-12-02 22:17:00 +0000111 const CodeGenOptions &CGOpts,
112 const clang::TargetOptions &TOpts,
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000113 const LangOptions &LOpts,
Daniel Dunbar3e111522010-06-07 23:21:04 +0000114 Module *M)
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000115 : Diags(_Diags), CodeGenOpts(CGOpts), TargetOpts(TOpts), LangOpts(LOpts),
Daniel Dunbar3e111522010-06-07 23:21:04 +0000116 TheModule(M), CodeGenerationTime("Code Generation Time"),
Craig Topper8a13c412014-05-21 05:09:00 +0000117 CodeGenPasses(nullptr), PerModulePasses(nullptr),
118 PerFunctionPasses(nullptr) {}
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000119
120 ~EmitAssemblyHelper() {
121 delete CodeGenPasses;
122 delete PerModulePasses;
123 delete PerFunctionPasses;
Alp Tokerf4e22382013-12-20 20:26:53 +0000124 if (CodeGenOpts.DisableFree)
Ahmed Charles9a16beb2014-03-07 19:33:25 +0000125 BuryPointer(TM.release());
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000126 }
127
Ahmed Charlesb8984322014-03-07 20:03:18 +0000128 std::unique_ptr<TargetMachine> TM;
Alp Tokerf4e22382013-12-20 20:26:53 +0000129
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000130 void EmitAssembly(BackendAction Action, raw_ostream *OS);
131};
132
Alexey Samsonovc6515b62012-12-28 09:31:34 +0000133// We need this wrapper to access LangOpts and CGOpts from extension functions
134// that we add to the PassManagerBuilder.
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000135class PassManagerBuilderWrapper : public PassManagerBuilder {
136public:
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000137 PassManagerBuilderWrapper(const CodeGenOptions &CGOpts,
138 const LangOptions &LangOpts)
139 : PassManagerBuilder(), CGOpts(CGOpts), LangOpts(LangOpts) {}
140 const CodeGenOptions &getCGOpts() const { return CGOpts; }
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000141 const LangOptions &getLangOpts() const { return LangOpts; }
142private:
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000143 const CodeGenOptions &CGOpts;
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000144 const LangOptions &LangOpts;
145};
146
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000147}
148
Dan Gohman5932ce22012-01-17 20:54:51 +0000149static void addObjCARCAPElimPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
150 if (Builder.OptLevel > 0)
151 PM.add(createObjCARCAPElimPass());
152}
153
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000154static void addObjCARCExpandPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
155 if (Builder.OptLevel > 0)
156 PM.add(createObjCARCExpandPass());
157}
158
159static void addObjCARCOptPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
160 if (Builder.OptLevel > 0)
161 PM.add(createObjCARCOptPass());
162}
163
Diego Novillo5c297052013-11-13 12:22:39 +0000164static void addSampleProfileLoaderPass(const PassManagerBuilder &Builder,
165 PassManagerBase &PM) {
166 const PassManagerBuilderWrapper &BuilderWrapper =
167 static_cast<const PassManagerBuilderWrapper &>(Builder);
168 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
169 PM.add(createSampleProfileLoaderPass(CGOpts.SampleProfileFile));
170}
171
Diego Novillob56be642014-03-03 20:06:18 +0000172static void addAddDiscriminatorsPass(const PassManagerBuilder &Builder,
173 PassManagerBase &PM) {
174 PM.add(createAddDiscriminatorsPass());
175}
176
Nuno Lopesa4255892012-05-22 17:19:45 +0000177static void addBoundsCheckingPass(const PassManagerBuilder &Builder,
178 PassManagerBase &PM) {
Joey Goulyebc59d52012-11-23 10:39:49 +0000179 PM.add(createBoundsCheckingPass());
Nuno Lopesa4255892012-05-22 17:19:45 +0000180}
181
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000182static void addAddressSanitizerPasses(const PassManagerBuilder &Builder,
183 PassManagerBase &PM) {
Alexey Samsonove595e1a2014-06-13 17:53:44 +0000184 PM.add(createAddressSanitizerFunctionPass());
Alexey Samsonovc94285a2014-07-08 00:50:49 +0000185 PM.add(createAddressSanitizerModulePass());
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000186}
187
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000188static void addMemorySanitizerPass(const PassManagerBuilder &Builder,
189 PassManagerBase &PM) {
Evgeniy Stepanovad8ab3d2012-12-24 08:42:34 +0000190 const PassManagerBuilderWrapper &BuilderWrapper =
191 static_cast<const PassManagerBuilderWrapper&>(Builder);
192 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
Alexey Samsonov1cf07ea2014-06-02 18:08:08 +0000193 PM.add(createMemorySanitizerPass(CGOpts.SanitizeMemoryTrackOrigins));
Evgeniy Stepanov10284672013-01-31 09:53:29 +0000194
195 // MemorySanitizer inserts complex instrumentation that mostly follows
196 // the logic of the original code, but operates on "shadow" values.
197 // It can benefit from re-running some general purpose optimization passes.
198 if (Builder.OptLevel > 0) {
199 PM.add(createEarlyCSEPass());
200 PM.add(createReassociatePass());
201 PM.add(createLICMPass());
202 PM.add(createGVNPass());
203 PM.add(createInstructionCombiningPass());
204 PM.add(createDeadStoreEliminationPass());
205 }
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000206}
207
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000208static void addThreadSanitizerPass(const PassManagerBuilder &Builder,
209 PassManagerBase &PM) {
Alexey Samsonov1cf07ea2014-06-02 18:08:08 +0000210 PM.add(createThreadSanitizerPass());
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000211}
212
Peter Collingbournec3772752013-08-07 22:47:34 +0000213static void addDataFlowSanitizerPass(const PassManagerBuilder &Builder,
214 PassManagerBase &PM) {
Peter Collingbourne276be3c2013-08-14 18:54:18 +0000215 const PassManagerBuilderWrapper &BuilderWrapper =
216 static_cast<const PassManagerBuilderWrapper&>(Builder);
217 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
218 PM.add(createDataFlowSanitizerPass(CGOpts.SanitizerBlacklistFile));
Peter Collingbournec3772752013-08-07 22:47:34 +0000219}
220
Rafael Espindolab8a71c52014-08-21 17:58:42 +0000221static TargetLibraryInfo *createTLI(llvm::Triple &TargetTriple,
222 const CodeGenOptions &CodeGenOpts) {
223 TargetLibraryInfo *TLI = new TargetLibraryInfo(TargetTriple);
224 if (!CodeGenOpts.SimplifyLibCalls)
225 TLI->disableAllFunctions();
226 return TLI;
227}
228
Alp Tokerf4e22382013-12-20 20:26:53 +0000229void EmitAssemblyHelper::CreatePasses() {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000230 unsigned OptLevel = CodeGenOpts.OptimizationLevel;
Douglas Gregorb0eea8b2012-10-23 20:05:01 +0000231 CodeGenOptions::InliningMethod Inlining = CodeGenOpts.getInlining();
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000232
233 // Handle disabling of LLVM optimization, where we want to preserve the
234 // internal module before any optimization.
235 if (CodeGenOpts.DisableLLVMOpts) {
236 OptLevel = 0;
237 Inlining = CodeGenOpts.NoInlining;
238 }
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000239
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000240 PassManagerBuilderWrapper PMBuilder(CodeGenOpts, LangOpts);
Chris Lattnerecf0ba52011-05-21 23:50:44 +0000241 PMBuilder.OptLevel = OptLevel;
242 PMBuilder.SizeLevel = CodeGenOpts.OptimizeSize;
Nick Lewyckyd3f3e4f2013-06-25 01:49:44 +0000243 PMBuilder.BBVectorize = CodeGenOpts.VectorizeBB;
244 PMBuilder.SLPVectorize = CodeGenOpts.VectorizeSLP;
245 PMBuilder.LoopVectorize = CodeGenOpts.VectorizeLoop;
Andrew Trickb2a84722011-04-05 18:49:32 +0000246
Duncan P. N. Exon Smith85e349f2014-04-18 01:05:25 +0000247 PMBuilder.DisableTailCalls = CodeGenOpts.DisableTailCalls;
Chris Lattnerecf0ba52011-05-21 23:50:44 +0000248 PMBuilder.DisableUnitAtATime = !CodeGenOpts.UnitAtATime;
249 PMBuilder.DisableUnrollLoops = !CodeGenOpts.UnrollLoops;
Hal Finkelce0697f2013-11-17 16:03:29 +0000250 PMBuilder.RerollLoops = CodeGenOpts.RerollLoops;
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000251
Diego Novillob56be642014-03-03 20:06:18 +0000252 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
253 addAddDiscriminatorsPass);
254
Diego Novillo5c297052013-11-13 12:22:39 +0000255 if (!CodeGenOpts.SampleProfileFile.empty())
256 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
257 addSampleProfileLoaderPass);
258
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000259 // In ObjC ARC mode, add the main ARC optimization passes.
260 if (LangOpts.ObjCAutoRefCount) {
261 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
262 addObjCARCExpandPass);
Dan Gohman5932ce22012-01-17 20:54:51 +0000263 PMBuilder.addExtension(PassManagerBuilder::EP_ModuleOptimizerEarly,
264 addObjCARCAPElimPass);
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000265 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
266 addObjCARCOptPass);
267 }
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000268
Richard Smith6b53e222013-10-22 22:51:04 +0000269 if (LangOpts.Sanitize.LocalBounds) {
Nuno Lopesa4255892012-05-22 17:19:45 +0000270 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
271 addBoundsCheckingPass);
272 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
273 addBoundsCheckingPass);
274 }
275
Will Dietzf54319c2013-01-18 11:30:38 +0000276 if (LangOpts.Sanitize.Address) {
Kostya Serebryany7e247f22012-10-15 14:22:56 +0000277 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000278 addAddressSanitizerPasses);
Kostya Serebryanyd4768572011-11-30 22:20:21 +0000279 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000280 addAddressSanitizerPasses);
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000281 }
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000282
Will Dietzf54319c2013-01-18 11:30:38 +0000283 if (LangOpts.Sanitize.Memory) {
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000284 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
285 addMemorySanitizerPass);
286 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
287 addMemorySanitizerPass);
288 }
289
Will Dietzf54319c2013-01-18 11:30:38 +0000290 if (LangOpts.Sanitize.Thread) {
Kostya Serebryanyd18cb502012-03-23 23:25:23 +0000291 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000292 addThreadSanitizerPass);
293 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
294 addThreadSanitizerPass);
295 }
296
Peter Collingbournec3772752013-08-07 22:47:34 +0000297 if (LangOpts.Sanitize.DataFlow) {
298 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
299 addDataFlowSanitizerPass);
300 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
301 addDataFlowSanitizerPass);
302 }
303
Chris Lattner5c123672011-05-21 20:40:11 +0000304 // Figure out TargetLibraryInfo.
Bill Wendling28b9e8b2011-05-17 23:06:23 +0000305 Triple TargetTriple(TheModule->getTargetTriple());
Rafael Espindolab8a71c52014-08-21 17:58:42 +0000306 PMBuilder.LibraryInfo = createTLI(TargetTriple, CodeGenOpts);
Eli Benderskyb5cfa8c2014-03-12 16:30:34 +0000307
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000308 switch (Inlining) {
309 case CodeGenOptions::NoInlining: break;
310 case CodeGenOptions::NormalInlining: {
Eli Benderskyb5cfa8c2014-03-12 16:30:34 +0000311 PMBuilder.Inliner =
312 createFunctionInliningPass(OptLevel, CodeGenOpts.OptimizeSize);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000313 break;
314 }
315 case CodeGenOptions::OnlyAlwaysInlining:
Chris Lattner5c123672011-05-21 20:40:11 +0000316 // Respect always_inline.
Chad Rosiere2c45062012-02-25 02:56:13 +0000317 if (OptLevel == 0)
318 // Do not insert lifetime intrinsics at -O0.
319 PMBuilder.Inliner = createAlwaysInlinerPass(false);
320 else
321 PMBuilder.Inliner = createAlwaysInlinerPass();
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000322 break;
323 }
324
Chris Lattner5c123672011-05-21 20:40:11 +0000325 // Set up the per-function pass manager.
Alp Tokerf4e22382013-12-20 20:26:53 +0000326 FunctionPassManager *FPM = getPerFunctionPasses();
Chris Lattner5c123672011-05-21 20:40:11 +0000327 if (CodeGenOpts.VerifyModule)
328 FPM->add(createVerifierPass());
329 PMBuilder.populateFunctionPassManager(*FPM);
Andrew Trickb2a84722011-04-05 18:49:32 +0000330
Chris Lattner5c123672011-05-21 20:40:11 +0000331 // Set up the per-module pass manager.
Alp Tokerf4e22382013-12-20 20:26:53 +0000332 PassManager *MPM = getPerModulePasses();
Duncan P. N. Exon Smith52eaffe2014-04-15 16:27:43 +0000333 if (CodeGenOpts.VerifyModule)
334 MPM->add(createDebugInfoVerifierPass());
Chris Lattnerd98cec52011-02-18 22:20:38 +0000335
Nick Lewyckyc02bbb62013-03-20 01:38:16 +0000336 if (!CodeGenOpts.DisableGCov &&
337 (CodeGenOpts.EmitGcovArcs || CodeGenOpts.EmitGcovNotes)) {
Nick Lewyckyc8bf8242013-03-14 05:14:01 +0000338 // Not using 'GCOVOptions::getDefault' allows us to avoid exiting if
339 // LLVM's -default-gcov-version flag is set to something invalid.
340 GCOVOptions Options;
341 Options.EmitNotes = CodeGenOpts.EmitGcovNotes;
342 Options.EmitData = CodeGenOpts.EmitGcovArcs;
343 memcpy(Options.Version, CodeGenOpts.CoverageVersion, 4);
344 Options.UseCfgChecksum = CodeGenOpts.CoverageExtraChecksum;
345 Options.NoRedZone = CodeGenOpts.DisableRedZone;
Nick Lewyckyc8bf8242013-03-14 05:14:01 +0000346 Options.FunctionNamesInData =
Nick Lewycky6f15b2902013-03-20 02:14:38 +0000347 !CodeGenOpts.CoverageNoFunctionNamesInData;
Nick Lewyckyc8bf8242013-03-14 05:14:01 +0000348 MPM->add(createGCOVProfilerPass(Options));
Douglas Gregorb0eea8b2012-10-23 20:05:01 +0000349 if (CodeGenOpts.getDebugInfo() == CodeGenOptions::NoDebugInfo)
Nick Lewycky207bce32011-04-21 23:44:07 +0000350 MPM->add(createStripSymbolsPass(true));
351 }
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000352
Chris Lattner5c123672011-05-21 20:40:11 +0000353 PMBuilder.populateModulePassManager(*MPM);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000354}
355
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000356TargetMachine *EmitAssemblyHelper::CreateTargetMachine(bool MustCreateTM) {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000357 // Create the TargetMachine for generating code.
358 std::string Error;
359 std::string Triple = TheModule->getTargetTriple();
360 const llvm::Target *TheTarget = TargetRegistry::lookupTarget(Triple, Error);
361 if (!TheTarget) {
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000362 if (MustCreateTM)
Chad Rosierecafbe62013-03-27 00:14:35 +0000363 Diags.Report(diag::err_fe_unable_to_create_target) << Error;
Craig Topper8a13c412014-05-21 05:09:00 +0000364 return nullptr;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000365 }
366
Saleem Abdulrasool62849c62014-05-08 02:28:32 +0000367 unsigned CodeModel =
368 llvm::StringSwitch<unsigned>(CodeGenOpts.CodeModel)
369 .Case("small", llvm::CodeModel::Small)
370 .Case("kernel", llvm::CodeModel::Kernel)
371 .Case("medium", llvm::CodeModel::Medium)
Saleem Abdulrasool61449c62014-05-08 16:28:48 +0000372 .Case("large", llvm::CodeModel::Large)
Saleem Abdulrasool62849c62014-05-08 02:28:32 +0000373 .Case("default", llvm::CodeModel::Default)
374 .Default(~0u);
375 assert(CodeModel != ~0u && "invalid code model!");
376 llvm::CodeModel::Model CM = static_cast<llvm::CodeModel::Model>(CodeModel);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000377
David Blaikie09d20ee2012-02-07 19:36:38 +0000378 SmallVector<const char *, 16> BackendArgs;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000379 BackendArgs.push_back("clang"); // Fake program name.
380 if (!CodeGenOpts.DebugPass.empty()) {
381 BackendArgs.push_back("-debug-pass");
382 BackendArgs.push_back(CodeGenOpts.DebugPass.c_str());
383 }
384 if (!CodeGenOpts.LimitFloatPrecision.empty()) {
385 BackendArgs.push_back("-limit-float-precision");
386 BackendArgs.push_back(CodeGenOpts.LimitFloatPrecision.c_str());
387 }
388 if (llvm::TimePassesIsEnabled)
389 BackendArgs.push_back("-time-passes");
Daniel Dunbar12100e22011-03-22 16:48:17 +0000390 for (unsigned i = 0, e = CodeGenOpts.BackendOptions.size(); i != e; ++i)
391 BackendArgs.push_back(CodeGenOpts.BackendOptions[i].c_str());
Chad Rosierba3df1d2011-08-26 00:26:29 +0000392 if (CodeGenOpts.NoGlobalMerge)
Bob Wilson25363c02014-07-26 00:37:28 +0000393 BackendArgs.push_back("-enable-global-merge=false");
Craig Topper8a13c412014-05-21 05:09:00 +0000394 BackendArgs.push_back(nullptr);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000395 llvm::cl::ParseCommandLineOptions(BackendArgs.size() - 1,
David Blaikie09d20ee2012-02-07 19:36:38 +0000396 BackendArgs.data());
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000397
398 std::string FeaturesStr;
Evan Chengadc79592011-06-30 02:06:32 +0000399 if (TargetOpts.Features.size()) {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000400 SubtargetFeatures Features;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000401 for (std::vector<std::string>::const_iterator
402 it = TargetOpts.Features.begin(),
403 ie = TargetOpts.Features.end(); it != ie; ++it)
404 Features.AddFeature(*it);
405 FeaturesStr = Features.getString();
406 }
Evan Cheng3f37dd02011-07-19 06:37:41 +0000407
408 llvm::Reloc::Model RM = llvm::Reloc::Default;
409 if (CodeGenOpts.RelocationModel == "static") {
410 RM = llvm::Reloc::Static;
411 } else if (CodeGenOpts.RelocationModel == "pic") {
412 RM = llvm::Reloc::PIC_;
413 } else {
414 assert(CodeGenOpts.RelocationModel == "dynamic-no-pic" &&
415 "Invalid PIC model!");
416 RM = llvm::Reloc::DynamicNoPIC;
417 }
418
Evan Chengdd286bc2011-11-16 08:38:55 +0000419 CodeGenOpt::Level OptLevel = CodeGenOpt::Default;
420 switch (CodeGenOpts.OptimizationLevel) {
421 default: break;
422 case 0: OptLevel = CodeGenOpt::None; break;
423 case 3: OptLevel = CodeGenOpt::Aggressive; break;
424 }
425
Nick Lewycky432add52011-12-02 22:17:00 +0000426 llvm::TargetOptions Options;
427
Rafael Espindola33ebd212014-02-21 03:14:07 +0000428 if (CodeGenOpts.DisableIntegratedAS)
429 Options.DisableIntegratedAS = true;
430
David Blaikie7e2fd942014-03-27 20:47:30 +0000431 if (CodeGenOpts.CompressDebugSections)
432 Options.CompressDebugSections = true;
433
Nick Lewycky432add52011-12-02 22:17:00 +0000434 // Set frame pointer elimination mode.
435 if (!CodeGenOpts.DisableFPElim) {
436 Options.NoFramePointerElim = false;
Nick Lewycky432add52011-12-02 22:17:00 +0000437 } else if (CodeGenOpts.OmitLeafFramePointer) {
438 Options.NoFramePointerElim = false;
Nick Lewycky432add52011-12-02 22:17:00 +0000439 } else {
440 Options.NoFramePointerElim = true;
Nick Lewycky432add52011-12-02 22:17:00 +0000441 }
442
Rafael Espindola66aa0452012-06-19 01:26:10 +0000443 if (CodeGenOpts.UseInitArray)
444 Options.UseInitArray = true;
445
Nick Lewycky432add52011-12-02 22:17:00 +0000446 // Set float ABI type.
447 if (CodeGenOpts.FloatABI == "soft" || CodeGenOpts.FloatABI == "softfp")
448 Options.FloatABIType = llvm::FloatABI::Soft;
449 else if (CodeGenOpts.FloatABI == "hard")
450 Options.FloatABIType = llvm::FloatABI::Hard;
451 else {
452 assert(CodeGenOpts.FloatABI.empty() && "Invalid float abi!");
453 Options.FloatABIType = llvm::FloatABI::Default;
454 }
455
Lang Hamesaa53b932012-07-06 00:59:19 +0000456 // Set FP fusion mode.
Lang Hames65992f42012-11-15 07:51:26 +0000457 switch (CodeGenOpts.getFPContractMode()) {
458 case CodeGenOptions::FPC_Off:
Lang Hamesaa53b932012-07-06 00:59:19 +0000459 Options.AllowFPOpFusion = llvm::FPOpFusion::Strict;
460 break;
Lang Hames65992f42012-11-15 07:51:26 +0000461 case CodeGenOptions::FPC_On:
Lang Hamesaa53b932012-07-06 00:59:19 +0000462 Options.AllowFPOpFusion = llvm::FPOpFusion::Standard;
463 break;
Lang Hames65992f42012-11-15 07:51:26 +0000464 case CodeGenOptions::FPC_Fast:
Lang Hamesaa53b932012-07-06 00:59:19 +0000465 Options.AllowFPOpFusion = llvm::FPOpFusion::Fast;
Nadav Roteme9c233b2012-10-19 04:15:32 +0000466 break;
Lang Hamesaa53b932012-07-06 00:59:19 +0000467 }
468
Nick Lewycky432add52011-12-02 22:17:00 +0000469 Options.LessPreciseFPMADOption = CodeGenOpts.LessPreciseFPMAD;
470 Options.NoInfsFPMath = CodeGenOpts.NoInfsFPMath;
471 Options.NoNaNsFPMath = CodeGenOpts.NoNaNsFPMath;
472 Options.NoZerosInBSS = CodeGenOpts.NoZeroInitializedInBSS;
473 Options.UnsafeFPMath = CodeGenOpts.UnsafeFPMath;
474 Options.UseSoftFloat = CodeGenOpts.SoftFloat;
Nick Lewyckyf4d3f7a2011-12-06 03:33:03 +0000475 Options.StackAlignmentOverride = CodeGenOpts.StackAlignment;
Nick Lewycky1c8c4362012-01-23 08:29:12 +0000476 Options.DisableTailCalls = CodeGenOpts.DisableTailCalls;
Bob Wilson14adb362012-02-03 06:27:22 +0000477 Options.TrapFuncName = CodeGenOpts.TrapFuncName;
Chandler Carruth097d0192012-04-08 21:09:51 +0000478 Options.PositionIndependentExecutable = LangOpts.PIELevel != 0;
Eric Christopheracca0082014-05-20 21:25:41 +0000479 Options.FunctionSections = CodeGenOpts.FunctionSections;
480 Options.DataSections = CodeGenOpts.DataSections;
Nick Lewycky432add52011-12-02 22:17:00 +0000481
Eric Christopher7e72a092014-05-15 01:21:56 +0000482 Options.MCOptions.MCRelaxAll = CodeGenOpts.RelaxAll;
483 Options.MCOptions.MCSaveTempLabels = CodeGenOpts.SaveTempLabels;
Eric Christophere76eee42014-05-16 20:46:14 +0000484 Options.MCOptions.MCUseDwarfDirectory = !CodeGenOpts.NoDwarfDirectoryAsm;
Eric Christopher7e72a092014-05-15 01:21:56 +0000485 Options.MCOptions.MCNoExecStack = CodeGenOpts.NoExecStack;
Eric Christopher4015e124e2014-05-21 00:00:03 +0000486 Options.MCOptions.AsmVerbose = CodeGenOpts.AsmVerbose;
Eric Christopher7e72a092014-05-15 01:21:56 +0000487
Evan Chengadc79592011-06-30 02:06:32 +0000488 TargetMachine *TM = TheTarget->createTargetMachine(Triple, TargetOpts.CPU,
Nick Lewycky432add52011-12-02 22:17:00 +0000489 FeaturesStr, Options,
490 RM, CM, OptLevel);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000491
Nadav Rotemec57ab32012-10-24 00:53:38 +0000492 return TM;
493}
494
495bool EmitAssemblyHelper::AddEmitPasses(BackendAction Action,
Alp Tokerf4e22382013-12-20 20:26:53 +0000496 formatted_raw_ostream &OS) {
Nadav Rotemec57ab32012-10-24 00:53:38 +0000497
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000498 // Create the code generator passes.
Alp Tokerf4e22382013-12-20 20:26:53 +0000499 PassManager *PM = getCodeGenPasses();
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000500
Chad Rosierb1cfc682012-02-29 20:14:59 +0000501 // Add LibraryInfo.
Daniel Dunbaraa437df2012-10-19 20:10:10 +0000502 llvm::Triple TargetTriple(TheModule->getTargetTriple());
Rafael Espindolab8a71c52014-08-21 17:58:42 +0000503 PM->add(createTLI(TargetTriple, CodeGenOpts));
Chad Rosierb1cfc682012-02-29 20:14:59 +0000504
Chandler Carruthed0f133b2013-01-07 01:38:01 +0000505 // Add Target specific analysis passes.
506 TM->addAnalysisPasses(*PM);
Nadav Roteme9c233b2012-10-19 04:15:32 +0000507
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000508 // Normal mode, emit a .s or .o file by running the code generator. Note,
509 // this also adds codegenerator level optimization passes.
510 TargetMachine::CodeGenFileType CGFT = TargetMachine::CGFT_AssemblyFile;
511 if (Action == Backend_EmitObj)
512 CGFT = TargetMachine::CGFT_ObjectFile;
513 else if (Action == Backend_EmitMCNull)
514 CGFT = TargetMachine::CGFT_Null;
515 else
516 assert(Action == Backend_EmitAssembly && "Invalid action!");
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000517
518 // Add ObjC ARC final-cleanup optimizations. This is done as part of the
519 // "codegen" passes so that it isn't run multiple times when there is
520 // inlining happening.
Dan Gohman1170b082012-04-04 21:04:56 +0000521 if (LangOpts.ObjCAutoRefCount &&
522 CodeGenOpts.OptimizationLevel > 0)
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000523 PM->add(createObjCARCContractPass());
524
Evan Chengdd286bc2011-11-16 08:38:55 +0000525 if (TM->addPassesToEmitFile(*PM, OS, CGFT,
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000526 /*DisableVerify=*/!CodeGenOpts.VerifyModule)) {
527 Diags.Report(diag::err_fe_unable_to_interface_with_target);
528 return false;
529 }
530
531 return true;
532}
533
534void EmitAssemblyHelper::EmitAssembly(BackendAction Action, raw_ostream *OS) {
Craig Topper8a13c412014-05-21 05:09:00 +0000535 TimeRegion Region(llvm::TimePassesIsEnabled ? &CodeGenerationTime : nullptr);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000536 llvm::formatted_raw_ostream FormattedOS;
537
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000538 bool UsesCodeGen = (Action != Backend_EmitNothing &&
539 Action != Backend_EmitBC &&
540 Action != Backend_EmitLL);
Alp Tokerf4e22382013-12-20 20:26:53 +0000541 if (!TM)
542 TM.reset(CreateTargetMachine(UsesCodeGen));
543
Chad Rosierecafbe62013-03-27 00:14:35 +0000544 if (UsesCodeGen && !TM) return;
Alp Tokerf4e22382013-12-20 20:26:53 +0000545 CreatePasses();
Nadav Rotemec57ab32012-10-24 00:53:38 +0000546
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000547 switch (Action) {
548 case Backend_EmitNothing:
549 break;
550
551 case Backend_EmitBC:
Alp Tokerf4e22382013-12-20 20:26:53 +0000552 getPerModulePasses()->add(createBitcodeWriterPass(*OS));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000553 break;
554
555 case Backend_EmitLL:
556 FormattedOS.setStream(*OS, formatted_raw_ostream::PRESERVE_STREAM);
Chandler Carruth809403f2014-01-12 11:31:22 +0000557 getPerModulePasses()->add(createPrintModulePass(FormattedOS));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000558 break;
559
560 default:
561 FormattedOS.setStream(*OS, formatted_raw_ostream::PRESERVE_STREAM);
Alp Tokerf4e22382013-12-20 20:26:53 +0000562 if (!AddEmitPasses(Action, FormattedOS))
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000563 return;
564 }
565
Andrew Trick15e36e82011-04-05 18:56:55 +0000566 // Before executing passes, print the final values of the LLVM options.
567 cl::PrintOptionValues();
568
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000569 // Run passes. For now we do all passes at once, but eventually we
570 // would like to have the option of streaming code generation.
571
572 if (PerFunctionPasses) {
573 PrettyStackTraceString CrashInfo("Per-function optimization");
574
575 PerFunctionPasses->doInitialization();
576 for (Module::iterator I = TheModule->begin(),
577 E = TheModule->end(); I != E; ++I)
578 if (!I->isDeclaration())
579 PerFunctionPasses->run(*I);
580 PerFunctionPasses->doFinalization();
581 }
582
583 if (PerModulePasses) {
584 PrettyStackTraceString CrashInfo("Per-module optimization passes");
585 PerModulePasses->run(*TheModule);
586 }
587
588 if (CodeGenPasses) {
589 PrettyStackTraceString CrashInfo("Code generation");
Daniel Dunbar195fa002010-09-17 07:35:16 +0000590 CodeGenPasses->run(*TheModule);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000591 }
592}
593
David Blaikie9c902b52011-09-25 23:23:43 +0000594void clang::EmitBackendOutput(DiagnosticsEngine &Diags,
595 const CodeGenOptions &CGOpts,
Nick Lewycky432add52011-12-02 22:17:00 +0000596 const clang::TargetOptions &TOpts,
Alp Tokere83b9062014-01-02 15:08:04 +0000597 const LangOptions &LOpts, StringRef TDesc,
598 Module *M, BackendAction Action,
599 raw_ostream *OS) {
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000600 EmitAssemblyHelper AsmHelper(Diags, CGOpts, TOpts, LOpts, M);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000601
602 AsmHelper.EmitAssembly(Action, OS);
Alp Tokere83b9062014-01-02 15:08:04 +0000603
604 // If an optional clang TargetInfo description string was passed in, use it to
605 // verify the LLVM TargetMachine's DataLayout.
606 if (AsmHelper.TM && !TDesc.empty()) {
Eric Christopher3de08532014-08-04 21:33:42 +0000607 std::string DLDesc = AsmHelper.TM->getSubtargetImpl()
608 ->getDataLayout()
609 ->getStringRepresentation();
Alp Tokere83b9062014-01-02 15:08:04 +0000610 if (DLDesc != TDesc) {
611 unsigned DiagID = Diags.getCustomDiagID(
612 DiagnosticsEngine::Error, "backend data layout '%0' does not match "
613 "expected target description '%1'");
614 Diags.Report(DiagID) << DLDesc << TDesc;
615 }
616 }
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000617}