blob: 7d1a3c82e8429fa4cd429d96563d31796984b0cd [file] [log] [blame]
Daniel Dunbar897c6762010-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 Dunbar9b414d32010-06-15 17:48:49 +000010#include "clang/CodeGen/BackendUtil.h"
Daniel Dunbar897c6762010-06-07 23:20:08 +000011#include "clang/Basic/Diagnostic.h"
Dan Gohmanb18b8ad2011-07-05 22:02:36 +000012#include "clang/Basic/LangOptions.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000013#include "clang/Basic/TargetOptions.h"
Chandler Carruth06057ce2010-06-15 23:19:56 +000014#include "clang/Frontend/CodeGenOptions.h"
Daniel Dunbar897c6762010-06-07 23:20:08 +000015#include "clang/Frontend/FrontendDiagnostic.h"
Rafael Espindolacf565c52011-08-02 21:51:02 +000016#include "llvm/Analysis/Verifier.h"
Daniel Dunbar897c6762010-06-07 23:20:08 +000017#include "llvm/Assembly/PrintModulePass.h"
18#include "llvm/Bitcode/ReaderWriter.h"
19#include "llvm/CodeGen/RegAllocRegistry.h"
20#include "llvm/CodeGen/SchedulerRegistry.h"
Chandler Carruth3b844ba2013-01-02 11:45:17 +000021#include "llvm/IR/DataLayout.h"
22#include "llvm/IR/Module.h"
Evan Cheng693769c2011-06-29 01:14:32 +000023#include "llvm/MC/SubtargetFeature.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000024#include "llvm/PassManager.h"
Daniel Dunbar897c6762010-06-07 23:20:08 +000025#include "llvm/Support/CommandLine.h"
26#include "llvm/Support/FormattedStream.h"
27#include "llvm/Support/PrettyStackTrace.h"
Evan Chenga6b40452011-08-24 18:09:14 +000028#include "llvm/Support/TargetRegistry.h"
Daniel Dunbar897c6762010-06-07 23:20:08 +000029#include "llvm/Support/Timer.h"
30#include "llvm/Support/raw_ostream.h"
Rafael Espindolacf565c52011-08-02 21:51:02 +000031#include "llvm/Target/TargetLibraryInfo.h"
Daniel Dunbar897c6762010-06-07 23:20:08 +000032#include "llvm/Target/TargetMachine.h"
33#include "llvm/Target/TargetOptions.h"
Rafael Espindolacf565c52011-08-02 21:51:02 +000034#include "llvm/Transforms/IPO.h"
35#include "llvm/Transforms/IPO/PassManagerBuilder.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000036#include "llvm/Transforms/Instrumentation.h"
Michael Gottesman23d5b092013-01-28 01:36:00 +000037#include "llvm/Transforms/ObjCARC.h"
Rafael Espindolacf565c52011-08-02 21:51:02 +000038#include "llvm/Transforms/Scalar.h"
Daniel Dunbar897c6762010-06-07 23:20:08 +000039using namespace clang;
40using namespace llvm;
41
42namespace {
43
44class EmitAssemblyHelper {
David Blaikied6471f72011-09-25 23:23:43 +000045 DiagnosticsEngine &Diags;
Daniel Dunbar897c6762010-06-07 23:20:08 +000046 const CodeGenOptions &CodeGenOpts;
Nick Lewycky3aaeccc2011-12-02 22:17:00 +000047 const clang::TargetOptions &TargetOpts;
Dan Gohmanb18b8ad2011-07-05 22:02:36 +000048 const LangOptions &LangOpts;
Daniel Dunbar897c6762010-06-07 23:20:08 +000049 Module *TheModule;
Daniel Dunbar897c6762010-06-07 23:20:08 +000050
51 Timer CodeGenerationTime;
52
Daniel Dunbardb2f2372010-09-17 07:35:16 +000053 mutable PassManager *CodeGenPasses;
Daniel Dunbar897c6762010-06-07 23:20:08 +000054 mutable PassManager *PerModulePasses;
55 mutable FunctionPassManager *PerFunctionPasses;
56
57private:
Nadav Rotemfa60be02012-10-24 00:53:38 +000058 PassManager *getCodeGenPasses(TargetMachine *TM) const {
Daniel Dunbar897c6762010-06-07 23:20:08 +000059 if (!CodeGenPasses) {
Daniel Dunbardb2f2372010-09-17 07:35:16 +000060 CodeGenPasses = new PassManager();
Micah Villmow25a6a842012-10-08 16:25:52 +000061 CodeGenPasses->add(new DataLayout(TheModule));
Chandler Carruthd938e872013-01-07 01:38:01 +000062 if (TM)
63 TM->addAnalysisPasses(*CodeGenPasses);
Daniel Dunbar897c6762010-06-07 23:20:08 +000064 }
65 return CodeGenPasses;
66 }
67
Nadav Rotemfa60be02012-10-24 00:53:38 +000068 PassManager *getPerModulePasses(TargetMachine *TM) const {
Daniel Dunbar897c6762010-06-07 23:20:08 +000069 if (!PerModulePasses) {
70 PerModulePasses = new PassManager();
Micah Villmow25a6a842012-10-08 16:25:52 +000071 PerModulePasses->add(new DataLayout(TheModule));
Chandler Carruthd938e872013-01-07 01:38:01 +000072 if (TM)
73 TM->addAnalysisPasses(*PerModulePasses);
Daniel Dunbar897c6762010-06-07 23:20:08 +000074 }
75 return PerModulePasses;
76 }
77
Nadav Rotemfa60be02012-10-24 00:53:38 +000078 FunctionPassManager *getPerFunctionPasses(TargetMachine *TM) const {
Daniel Dunbar897c6762010-06-07 23:20:08 +000079 if (!PerFunctionPasses) {
80 PerFunctionPasses = new FunctionPassManager(TheModule);
Micah Villmow25a6a842012-10-08 16:25:52 +000081 PerFunctionPasses->add(new DataLayout(TheModule));
Chandler Carruthd938e872013-01-07 01:38:01 +000082 if (TM)
83 TM->addAnalysisPasses(*PerFunctionPasses);
Daniel Dunbar897c6762010-06-07 23:20:08 +000084 }
85 return PerFunctionPasses;
86 }
87
Nadav Rotemfa60be02012-10-24 00:53:38 +000088
89 void CreatePasses(TargetMachine *TM);
90
Nadav Rotem129369d2012-10-24 03:52:31 +000091 /// CreateTargetMachine - Generates the TargetMachine.
92 /// Returns Null if it is unable to create the target machine.
93 /// Some of our clang tests specify triples which are not built
94 /// into clang. This is okay because these tests check the generated
95 /// IR, and they require DataLayout which depends on the triple.
96 /// In this case, we allow this method to fail and not report an error.
97 /// When MustCreateTM is used, we print an error if we are unable to load
98 /// the requested target.
99 TargetMachine *CreateTargetMachine(bool MustCreateTM);
Daniel Dunbar897c6762010-06-07 23:20:08 +0000100
101 /// AddEmitPasses - Add passes necessary to emit assembly or LLVM IR.
102 ///
103 /// \return True on success.
Nadav Rotemfa60be02012-10-24 00:53:38 +0000104 bool AddEmitPasses(BackendAction Action, formatted_raw_ostream &OS,
105 TargetMachine *TM);
Daniel Dunbar897c6762010-06-07 23:20:08 +0000106
107public:
David Blaikied6471f72011-09-25 23:23:43 +0000108 EmitAssemblyHelper(DiagnosticsEngine &_Diags,
Nick Lewycky3aaeccc2011-12-02 22:17:00 +0000109 const CodeGenOptions &CGOpts,
110 const clang::TargetOptions &TOpts,
Dan Gohmanb18b8ad2011-07-05 22:02:36 +0000111 const LangOptions &LOpts,
Daniel Dunbar05a7f3d2010-06-07 23:21:04 +0000112 Module *M)
Dan Gohmanb18b8ad2011-07-05 22:02:36 +0000113 : Diags(_Diags), CodeGenOpts(CGOpts), TargetOpts(TOpts), LangOpts(LOpts),
Daniel Dunbar05a7f3d2010-06-07 23:21:04 +0000114 TheModule(M), CodeGenerationTime("Code Generation Time"),
Daniel Dunbar897c6762010-06-07 23:20:08 +0000115 CodeGenPasses(0), PerModulePasses(0), PerFunctionPasses(0) {}
116
117 ~EmitAssemblyHelper() {
118 delete CodeGenPasses;
119 delete PerModulePasses;
120 delete PerFunctionPasses;
121 }
122
123 void EmitAssembly(BackendAction Action, raw_ostream *OS);
124};
125
Alexey Samsonove8c03222012-12-28 09:31:34 +0000126// We need this wrapper to access LangOpts and CGOpts from extension functions
127// that we add to the PassManagerBuilder.
Alexey Samsonov4d1a6e42012-11-29 22:36:21 +0000128class PassManagerBuilderWrapper : public PassManagerBuilder {
129public:
Alexey Samsonov91ecfa62012-12-03 19:12:58 +0000130 PassManagerBuilderWrapper(const CodeGenOptions &CGOpts,
131 const LangOptions &LangOpts)
132 : PassManagerBuilder(), CGOpts(CGOpts), LangOpts(LangOpts) {}
133 const CodeGenOptions &getCGOpts() const { return CGOpts; }
Alexey Samsonov4d1a6e42012-11-29 22:36:21 +0000134 const LangOptions &getLangOpts() const { return LangOpts; }
135private:
Alexey Samsonov91ecfa62012-12-03 19:12:58 +0000136 const CodeGenOptions &CGOpts;
Alexey Samsonov4d1a6e42012-11-29 22:36:21 +0000137 const LangOptions &LangOpts;
138};
139
Daniel Dunbar897c6762010-06-07 23:20:08 +0000140}
141
Dan Gohmana8398ea2012-01-17 20:54:51 +0000142static void addObjCARCAPElimPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
143 if (Builder.OptLevel > 0)
144 PM.add(createObjCARCAPElimPass());
145}
146
Dan Gohmanb18b8ad2011-07-05 22:02:36 +0000147static void addObjCARCExpandPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
148 if (Builder.OptLevel > 0)
149 PM.add(createObjCARCExpandPass());
150}
151
152static void addObjCARCOptPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
153 if (Builder.OptLevel > 0)
154 PM.add(createObjCARCOptPass());
155}
156
Nuno Lopesdef18492012-05-22 17:19:45 +0000157static void addBoundsCheckingPass(const PassManagerBuilder &Builder,
158 PassManagerBase &PM) {
Joey Gouly85489082012-11-23 10:39:49 +0000159 PM.add(createBoundsCheckingPass());
Nuno Lopesdef18492012-05-22 17:19:45 +0000160}
161
Alexey Samsonov4d1a6e42012-11-29 22:36:21 +0000162static void addAddressSanitizerPasses(const PassManagerBuilder &Builder,
163 PassManagerBase &PM) {
164 const PassManagerBuilderWrapper &BuilderWrapper =
165 static_cast<const PassManagerBuilderWrapper&>(Builder);
Alexey Samsonov91ecfa62012-12-03 19:12:58 +0000166 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
Alexey Samsonov4d1a6e42012-11-29 22:36:21 +0000167 const LangOptions &LangOpts = BuilderWrapper.getLangOpts();
Alexey Samsonov4bdc6042013-01-20 13:12:12 +0000168 PM.add(createAddressSanitizerFunctionPass(
169 LangOpts.Sanitize.InitOrder,
170 LangOpts.Sanitize.UseAfterReturn,
171 LangOpts.Sanitize.UseAfterScope,
172 CGOpts.SanitizerBlacklistFile,
173 CGOpts.SanitizeAddressZeroBaseShadow));
174 PM.add(createAddressSanitizerModulePass(
175 LangOpts.Sanitize.InitOrder,
176 CGOpts.SanitizerBlacklistFile,
177 CGOpts.SanitizeAddressZeroBaseShadow));
Kostya Serebryany1b4eca62011-11-16 17:34:26 +0000178}
179
Evgeniy Stepanov09ccf392012-12-03 13:20:43 +0000180static void addMemorySanitizerPass(const PassManagerBuilder &Builder,
181 PassManagerBase &PM) {
Evgeniy Stepanov34ef11b2012-12-24 08:42:34 +0000182 const PassManagerBuilderWrapper &BuilderWrapper =
183 static_cast<const PassManagerBuilderWrapper&>(Builder);
184 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
Alexey Samsonov4bdc6042013-01-20 13:12:12 +0000185 PM.add(createMemorySanitizerPass(CGOpts.SanitizeMemoryTrackOrigins,
Alexey Samsonove8c03222012-12-28 09:31:34 +0000186 CGOpts.SanitizerBlacklistFile));
Evgeniy Stepanova8d39042013-01-31 09:53:29 +0000187
188 // MemorySanitizer inserts complex instrumentation that mostly follows
189 // the logic of the original code, but operates on "shadow" values.
190 // It can benefit from re-running some general purpose optimization passes.
191 if (Builder.OptLevel > 0) {
192 PM.add(createEarlyCSEPass());
193 PM.add(createReassociatePass());
194 PM.add(createLICMPass());
195 PM.add(createGVNPass());
196 PM.add(createInstructionCombiningPass());
197 PM.add(createDeadStoreEliminationPass());
198 }
Evgeniy Stepanov09ccf392012-12-03 13:20:43 +0000199}
200
Kostya Serebryany3c931222012-03-01 22:27:08 +0000201static void addThreadSanitizerPass(const PassManagerBuilder &Builder,
202 PassManagerBase &PM) {
Alexey Samsonove8c03222012-12-28 09:31:34 +0000203 const PassManagerBuilderWrapper &BuilderWrapper =
204 static_cast<const PassManagerBuilderWrapper&>(Builder);
205 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
206 PM.add(createThreadSanitizerPass(CGOpts.SanitizerBlacklistFile));
Kostya Serebryany3c931222012-03-01 22:27:08 +0000207}
208
Nadav Rotemfa60be02012-10-24 00:53:38 +0000209void EmitAssemblyHelper::CreatePasses(TargetMachine *TM) {
Daniel Dunbar897c6762010-06-07 23:20:08 +0000210 unsigned OptLevel = CodeGenOpts.OptimizationLevel;
Douglas Gregor4cdad312012-10-23 20:05:01 +0000211 CodeGenOptions::InliningMethod Inlining = CodeGenOpts.getInlining();
Daniel Dunbar897c6762010-06-07 23:20:08 +0000212
213 // Handle disabling of LLVM optimization, where we want to preserve the
214 // internal module before any optimization.
215 if (CodeGenOpts.DisableLLVMOpts) {
216 OptLevel = 0;
217 Inlining = CodeGenOpts.NoInlining;
218 }
Alexey Samsonov4d1a6e42012-11-29 22:36:21 +0000219
Alexey Samsonov91ecfa62012-12-03 19:12:58 +0000220 PassManagerBuilderWrapper PMBuilder(CodeGenOpts, LangOpts);
Chris Lattner9ca02e52011-05-21 23:50:44 +0000221 PMBuilder.OptLevel = OptLevel;
222 PMBuilder.SizeLevel = CodeGenOpts.OptimizeSize;
Andrew Trick6445d622011-04-05 18:49:32 +0000223
Chris Lattner9ca02e52011-05-21 23:50:44 +0000224 PMBuilder.DisableUnitAtATime = !CodeGenOpts.UnitAtATime;
225 PMBuilder.DisableUnrollLoops = !CodeGenOpts.UnrollLoops;
Dan Gohmanb18b8ad2011-07-05 22:02:36 +0000226
227 // In ObjC ARC mode, add the main ARC optimization passes.
228 if (LangOpts.ObjCAutoRefCount) {
229 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
230 addObjCARCExpandPass);
Dan Gohmana8398ea2012-01-17 20:54:51 +0000231 PMBuilder.addExtension(PassManagerBuilder::EP_ModuleOptimizerEarly,
232 addObjCARCAPElimPass);
Dan Gohmanb18b8ad2011-07-05 22:02:36 +0000233 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
234 addObjCARCOptPass);
235 }
Kostya Serebryany1b4eca62011-11-16 17:34:26 +0000236
Will Dietz4f45bc02013-01-18 11:30:38 +0000237 if (LangOpts.Sanitize.Bounds) {
Nuno Lopesdef18492012-05-22 17:19:45 +0000238 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
239 addBoundsCheckingPass);
240 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
241 addBoundsCheckingPass);
242 }
243
Will Dietz4f45bc02013-01-18 11:30:38 +0000244 if (LangOpts.Sanitize.Address) {
Kostya Serebryanyba1f0402012-10-15 14:22:56 +0000245 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Alexey Samsonov4d1a6e42012-11-29 22:36:21 +0000246 addAddressSanitizerPasses);
Kostya Serebryanye5dd2ea2011-11-30 22:20:21 +0000247 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
Alexey Samsonov4d1a6e42012-11-29 22:36:21 +0000248 addAddressSanitizerPasses);
Kostya Serebryany1b4eca62011-11-16 17:34:26 +0000249 }
Kostya Serebryany3c931222012-03-01 22:27:08 +0000250
Will Dietz4f45bc02013-01-18 11:30:38 +0000251 if (LangOpts.Sanitize.Memory) {
Evgeniy Stepanov09ccf392012-12-03 13:20:43 +0000252 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
253 addMemorySanitizerPass);
254 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
255 addMemorySanitizerPass);
256 }
257
Will Dietz4f45bc02013-01-18 11:30:38 +0000258 if (LangOpts.Sanitize.Thread) {
Kostya Serebryanye78ec3e2012-03-23 23:25:23 +0000259 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Kostya Serebryany3c931222012-03-01 22:27:08 +0000260 addThreadSanitizerPass);
261 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
262 addThreadSanitizerPass);
263 }
264
Chris Lattner33c09d52011-05-21 20:40:11 +0000265 // Figure out TargetLibraryInfo.
Bill Wendling3621b312011-05-17 23:06:23 +0000266 Triple TargetTriple(TheModule->getTargetTriple());
Chris Lattner9ca02e52011-05-21 23:50:44 +0000267 PMBuilder.LibraryInfo = new TargetLibraryInfo(TargetTriple);
Chris Lattner98ec3f72011-02-18 22:34:47 +0000268 if (!CodeGenOpts.SimplifyLibCalls)
Chris Lattner9ca02e52011-05-21 23:50:44 +0000269 PMBuilder.LibraryInfo->disableAllFunctions();
Chris Lattner33c09d52011-05-21 20:40:11 +0000270
Daniel Dunbar897c6762010-06-07 23:20:08 +0000271 switch (Inlining) {
272 case CodeGenOptions::NoInlining: break;
273 case CodeGenOptions::NormalInlining: {
Daniel Dunbar897c6762010-06-07 23:20:08 +0000274 // FIXME: Derive these constants in a principled fashion.
275 unsigned Threshold = 225;
Chris Lattner33c09d52011-05-21 20:40:11 +0000276 if (CodeGenOpts.OptimizeSize == 1) // -Os
Daniel Dunbar897c6762010-06-07 23:20:08 +0000277 Threshold = 75;
Chris Lattner33c09d52011-05-21 20:40:11 +0000278 else if (CodeGenOpts.OptimizeSize == 2) // -Oz
Bob Wilsona0fa2032011-04-29 22:49:50 +0000279 Threshold = 25;
Daniel Dunbar897c6762010-06-07 23:20:08 +0000280 else if (OptLevel > 2)
281 Threshold = 275;
Chris Lattner9ca02e52011-05-21 23:50:44 +0000282 PMBuilder.Inliner = createFunctionInliningPass(Threshold);
Daniel Dunbar897c6762010-06-07 23:20:08 +0000283 break;
284 }
285 case CodeGenOptions::OnlyAlwaysInlining:
Chris Lattner33c09d52011-05-21 20:40:11 +0000286 // Respect always_inline.
Chad Rosier98759622012-02-25 02:56:13 +0000287 if (OptLevel == 0)
288 // Do not insert lifetime intrinsics at -O0.
289 PMBuilder.Inliner = createAlwaysInlinerPass(false);
290 else
291 PMBuilder.Inliner = createAlwaysInlinerPass();
Daniel Dunbar897c6762010-06-07 23:20:08 +0000292 break;
293 }
294
Chris Lattner33c09d52011-05-21 20:40:11 +0000295 // Set up the per-function pass manager.
Nadav Rotemfa60be02012-10-24 00:53:38 +0000296 FunctionPassManager *FPM = getPerFunctionPasses(TM);
Chris Lattner33c09d52011-05-21 20:40:11 +0000297 if (CodeGenOpts.VerifyModule)
298 FPM->add(createVerifierPass());
299 PMBuilder.populateFunctionPassManager(*FPM);
Andrew Trick6445d622011-04-05 18:49:32 +0000300
Chris Lattner33c09d52011-05-21 20:40:11 +0000301 // Set up the per-module pass manager.
Nadav Rotemfa60be02012-10-24 00:53:38 +0000302 PassManager *MPM = getPerModulePasses(TM);
Chris Lattnerdf619762011-02-18 22:20:38 +0000303
Nick Lewyckyf2b5e072013-03-20 01:38:16 +0000304 if (!CodeGenOpts.DisableGCov &&
305 (CodeGenOpts.EmitGcovArcs || CodeGenOpts.EmitGcovNotes)) {
Nick Lewyckyc3ae5832013-03-14 05:14:01 +0000306 // Not using 'GCOVOptions::getDefault' allows us to avoid exiting if
307 // LLVM's -default-gcov-version flag is set to something invalid.
308 GCOVOptions Options;
309 Options.EmitNotes = CodeGenOpts.EmitGcovNotes;
310 Options.EmitData = CodeGenOpts.EmitGcovArcs;
311 memcpy(Options.Version, CodeGenOpts.CoverageVersion, 4);
312 Options.UseCfgChecksum = CodeGenOpts.CoverageExtraChecksum;
313 Options.NoRedZone = CodeGenOpts.DisableRedZone;
Nick Lewyckyc3ae5832013-03-14 05:14:01 +0000314 Options.FunctionNamesInData =
Nick Lewycky83c546a2013-03-20 02:14:38 +0000315 !CodeGenOpts.CoverageNoFunctionNamesInData;
Nick Lewyckyc3ae5832013-03-14 05:14:01 +0000316 MPM->add(createGCOVProfilerPass(Options));
Douglas Gregor4cdad312012-10-23 20:05:01 +0000317 if (CodeGenOpts.getDebugInfo() == CodeGenOptions::NoDebugInfo)
Nick Lewyckye8ba8d72011-04-21 23:44:07 +0000318 MPM->add(createStripSymbolsPass(true));
319 }
Nadav Rotem129369d2012-10-24 03:52:31 +0000320
Chris Lattner33c09d52011-05-21 20:40:11 +0000321 PMBuilder.populateModulePassManager(*MPM);
Daniel Dunbar897c6762010-06-07 23:20:08 +0000322}
323
Nadav Rotem129369d2012-10-24 03:52:31 +0000324TargetMachine *EmitAssemblyHelper::CreateTargetMachine(bool MustCreateTM) {
Daniel Dunbar897c6762010-06-07 23:20:08 +0000325 // Create the TargetMachine for generating code.
326 std::string Error;
327 std::string Triple = TheModule->getTargetTriple();
328 const llvm::Target *TheTarget = TargetRegistry::lookupTarget(Triple, Error);
329 if (!TheTarget) {
Nadav Rotem129369d2012-10-24 03:52:31 +0000330 if (MustCreateTM)
Chad Rosiera03fc6e2013-03-27 00:14:35 +0000331 Diags.Report(diag::err_fe_unable_to_create_target) << Error;
Nadav Rotemfa60be02012-10-24 00:53:38 +0000332 return 0;
Daniel Dunbar897c6762010-06-07 23:20:08 +0000333 }
334
335 // FIXME: Expose these capabilities via actual APIs!!!! Aside from just
336 // being gross, this is also totally broken if we ever care about
337 // concurrency.
Daniel Dunbar1ad66482010-07-01 01:31:45 +0000338
Daniel Dunbar897c6762010-06-07 23:20:08 +0000339 TargetMachine::setAsmVerbosityDefault(CodeGenOpts.AsmVerbose);
340
341 TargetMachine::setFunctionSections(CodeGenOpts.FunctionSections);
342 TargetMachine::setDataSections (CodeGenOpts.DataSections);
343
344 // FIXME: Parse this earlier.
Benjamin Kramer77577ce2011-07-20 14:43:06 +0000345 llvm::CodeModel::Model CM;
Daniel Dunbar897c6762010-06-07 23:20:08 +0000346 if (CodeGenOpts.CodeModel == "small") {
Benjamin Kramer77577ce2011-07-20 14:43:06 +0000347 CM = llvm::CodeModel::Small;
Daniel Dunbar897c6762010-06-07 23:20:08 +0000348 } else if (CodeGenOpts.CodeModel == "kernel") {
Benjamin Kramer77577ce2011-07-20 14:43:06 +0000349 CM = llvm::CodeModel::Kernel;
Daniel Dunbar897c6762010-06-07 23:20:08 +0000350 } else if (CodeGenOpts.CodeModel == "medium") {
Benjamin Kramer77577ce2011-07-20 14:43:06 +0000351 CM = llvm::CodeModel::Medium;
Daniel Dunbar897c6762010-06-07 23:20:08 +0000352 } else if (CodeGenOpts.CodeModel == "large") {
Benjamin Kramer77577ce2011-07-20 14:43:06 +0000353 CM = llvm::CodeModel::Large;
Daniel Dunbar897c6762010-06-07 23:20:08 +0000354 } else {
355 assert(CodeGenOpts.CodeModel.empty() && "Invalid code model!");
Benjamin Kramer77577ce2011-07-20 14:43:06 +0000356 CM = llvm::CodeModel::Default;
Daniel Dunbar897c6762010-06-07 23:20:08 +0000357 }
358
David Blaikie6bd17d22012-02-07 19:36:38 +0000359 SmallVector<const char *, 16> BackendArgs;
Daniel Dunbar897c6762010-06-07 23:20:08 +0000360 BackendArgs.push_back("clang"); // Fake program name.
361 if (!CodeGenOpts.DebugPass.empty()) {
362 BackendArgs.push_back("-debug-pass");
363 BackendArgs.push_back(CodeGenOpts.DebugPass.c_str());
364 }
365 if (!CodeGenOpts.LimitFloatPrecision.empty()) {
366 BackendArgs.push_back("-limit-float-precision");
367 BackendArgs.push_back(CodeGenOpts.LimitFloatPrecision.c_str());
368 }
369 if (llvm::TimePassesIsEnabled)
370 BackendArgs.push_back("-time-passes");
Daniel Dunbar3c66d302011-03-22 16:48:17 +0000371 for (unsigned i = 0, e = CodeGenOpts.BackendOptions.size(); i != e; ++i)
372 BackendArgs.push_back(CodeGenOpts.BackendOptions[i].c_str());
Chad Rosier1b906052011-08-26 00:26:29 +0000373 if (CodeGenOpts.NoGlobalMerge)
374 BackendArgs.push_back("-global-merge=false");
Daniel Dunbar897c6762010-06-07 23:20:08 +0000375 BackendArgs.push_back(0);
376 llvm::cl::ParseCommandLineOptions(BackendArgs.size() - 1,
David Blaikie6bd17d22012-02-07 19:36:38 +0000377 BackendArgs.data());
Daniel Dunbar897c6762010-06-07 23:20:08 +0000378
379 std::string FeaturesStr;
Evan Cheng368691e2011-06-30 02:06:32 +0000380 if (TargetOpts.Features.size()) {
Daniel Dunbar897c6762010-06-07 23:20:08 +0000381 SubtargetFeatures Features;
Daniel Dunbar897c6762010-06-07 23:20:08 +0000382 for (std::vector<std::string>::const_iterator
383 it = TargetOpts.Features.begin(),
384 ie = TargetOpts.Features.end(); it != ie; ++it)
385 Features.AddFeature(*it);
386 FeaturesStr = Features.getString();
387 }
Evan Cheng2860e302011-07-19 06:37:41 +0000388
389 llvm::Reloc::Model RM = llvm::Reloc::Default;
390 if (CodeGenOpts.RelocationModel == "static") {
391 RM = llvm::Reloc::Static;
392 } else if (CodeGenOpts.RelocationModel == "pic") {
393 RM = llvm::Reloc::PIC_;
394 } else {
395 assert(CodeGenOpts.RelocationModel == "dynamic-no-pic" &&
396 "Invalid PIC model!");
397 RM = llvm::Reloc::DynamicNoPIC;
398 }
399
Evan Cheng9254bf72011-11-16 08:38:55 +0000400 CodeGenOpt::Level OptLevel = CodeGenOpt::Default;
401 switch (CodeGenOpts.OptimizationLevel) {
402 default: break;
403 case 0: OptLevel = CodeGenOpt::None; break;
404 case 3: OptLevel = CodeGenOpt::Aggressive; break;
405 }
406
Nick Lewycky3aaeccc2011-12-02 22:17:00 +0000407 llvm::TargetOptions Options;
408
409 // Set frame pointer elimination mode.
410 if (!CodeGenOpts.DisableFPElim) {
411 Options.NoFramePointerElim = false;
412 Options.NoFramePointerElimNonLeaf = false;
413 } else if (CodeGenOpts.OmitLeafFramePointer) {
414 Options.NoFramePointerElim = false;
415 Options.NoFramePointerElimNonLeaf = true;
416 } else {
417 Options.NoFramePointerElim = true;
418 Options.NoFramePointerElimNonLeaf = true;
419 }
420
Rafael Espindola8af669f2012-06-19 01:26:10 +0000421 if (CodeGenOpts.UseInitArray)
422 Options.UseInitArray = true;
423
Nick Lewycky3aaeccc2011-12-02 22:17:00 +0000424 // Set float ABI type.
425 if (CodeGenOpts.FloatABI == "soft" || CodeGenOpts.FloatABI == "softfp")
426 Options.FloatABIType = llvm::FloatABI::Soft;
427 else if (CodeGenOpts.FloatABI == "hard")
428 Options.FloatABIType = llvm::FloatABI::Hard;
429 else {
430 assert(CodeGenOpts.FloatABI.empty() && "Invalid float abi!");
431 Options.FloatABIType = llvm::FloatABI::Default;
432 }
433
Lang Hamesc9686712012-07-06 00:59:19 +0000434 // Set FP fusion mode.
Lang Hames931c0832012-11-15 07:51:26 +0000435 switch (CodeGenOpts.getFPContractMode()) {
436 case CodeGenOptions::FPC_Off:
Lang Hamesc9686712012-07-06 00:59:19 +0000437 Options.AllowFPOpFusion = llvm::FPOpFusion::Strict;
438 break;
Lang Hames931c0832012-11-15 07:51:26 +0000439 case CodeGenOptions::FPC_On:
Lang Hamesc9686712012-07-06 00:59:19 +0000440 Options.AllowFPOpFusion = llvm::FPOpFusion::Standard;
441 break;
Lang Hames931c0832012-11-15 07:51:26 +0000442 case CodeGenOptions::FPC_Fast:
Lang Hamesc9686712012-07-06 00:59:19 +0000443 Options.AllowFPOpFusion = llvm::FPOpFusion::Fast;
Nadav Rotem25030c42012-10-19 04:15:32 +0000444 break;
Lang Hamesc9686712012-07-06 00:59:19 +0000445 }
446
Nick Lewycky3aaeccc2011-12-02 22:17:00 +0000447 Options.LessPreciseFPMADOption = CodeGenOpts.LessPreciseFPMAD;
448 Options.NoInfsFPMath = CodeGenOpts.NoInfsFPMath;
449 Options.NoNaNsFPMath = CodeGenOpts.NoNaNsFPMath;
450 Options.NoZerosInBSS = CodeGenOpts.NoZeroInitializedInBSS;
451 Options.UnsafeFPMath = CodeGenOpts.UnsafeFPMath;
452 Options.UseSoftFloat = CodeGenOpts.SoftFloat;
Nick Lewycky4e785c92011-12-06 03:33:03 +0000453 Options.StackAlignmentOverride = CodeGenOpts.StackAlignment;
454 Options.RealignStack = CodeGenOpts.StackRealignment;
Nick Lewycky1db772b2012-01-23 08:29:12 +0000455 Options.DisableTailCalls = CodeGenOpts.DisableTailCalls;
Bob Wilson71fd6cc2012-02-03 06:27:22 +0000456 Options.TrapFuncName = CodeGenOpts.TrapFuncName;
Chandler Carruth5081de52012-04-08 21:09:51 +0000457 Options.PositionIndependentExecutable = LangOpts.PIELevel != 0;
Chad Rosiera7afeb02012-08-21 16:16:06 +0000458 Options.SSPBufferSize = CodeGenOpts.SSPBufferSize;
Eric Christopher31056272013-04-04 06:29:47 +0000459 Options.EnableSegmentedStacks = CodeGenOpts.EnableSegmentedStacks;
Nick Lewycky3aaeccc2011-12-02 22:17:00 +0000460
Evan Cheng368691e2011-06-30 02:06:32 +0000461 TargetMachine *TM = TheTarget->createTargetMachine(Triple, TargetOpts.CPU,
Nick Lewycky3aaeccc2011-12-02 22:17:00 +0000462 FeaturesStr, Options,
463 RM, CM, OptLevel);
Daniel Dunbar897c6762010-06-07 23:20:08 +0000464
465 if (CodeGenOpts.RelaxAll)
466 TM->setMCRelaxAll(true);
Daniel Dunbar96932322011-03-28 22:49:28 +0000467 if (CodeGenOpts.SaveTempLabels)
468 TM->setMCSaveTempLabels(true);
Rafael Espindolaf24a1512011-04-30 18:35:43 +0000469 if (CodeGenOpts.NoDwarf2CFIAsm)
470 TM->setMCUseCFI(false);
Nick Lewyckyaaf2f362011-10-31 01:06:42 +0000471 if (!CodeGenOpts.NoDwarfDirectoryAsm)
472 TM->setMCUseDwarfDirectory(true);
Nick Lewyckyc3b90142011-06-21 00:14:18 +0000473 if (CodeGenOpts.NoExecStack)
474 TM->setMCNoExecStack(true);
Daniel Dunbar897c6762010-06-07 23:20:08 +0000475
Nadav Rotemfa60be02012-10-24 00:53:38 +0000476 return TM;
477}
478
479bool EmitAssemblyHelper::AddEmitPasses(BackendAction Action,
480 formatted_raw_ostream &OS,
481 TargetMachine *TM) {
482
Daniel Dunbar897c6762010-06-07 23:20:08 +0000483 // Create the code generator passes.
Nadav Rotemfa60be02012-10-24 00:53:38 +0000484 PassManager *PM = getCodeGenPasses(TM);
Daniel Dunbar897c6762010-06-07 23:20:08 +0000485
Chad Rosier3f3335d2012-02-29 20:14:59 +0000486 // Add LibraryInfo.
Daniel Dunbarcbbe2c02012-10-19 20:10:10 +0000487 llvm::Triple TargetTriple(TheModule->getTargetTriple());
488 TargetLibraryInfo *TLI = new TargetLibraryInfo(TargetTriple);
Chad Rosier3f3335d2012-02-29 20:14:59 +0000489 if (!CodeGenOpts.SimplifyLibCalls)
490 TLI->disableAllFunctions();
491 PM->add(TLI);
492
Chandler Carruthd938e872013-01-07 01:38:01 +0000493 // Add Target specific analysis passes.
494 TM->addAnalysisPasses(*PM);
Nadav Rotem25030c42012-10-19 04:15:32 +0000495
Daniel Dunbar897c6762010-06-07 23:20:08 +0000496 // Normal mode, emit a .s or .o file by running the code generator. Note,
497 // this also adds codegenerator level optimization passes.
498 TargetMachine::CodeGenFileType CGFT = TargetMachine::CGFT_AssemblyFile;
499 if (Action == Backend_EmitObj)
500 CGFT = TargetMachine::CGFT_ObjectFile;
501 else if (Action == Backend_EmitMCNull)
502 CGFT = TargetMachine::CGFT_Null;
503 else
504 assert(Action == Backend_EmitAssembly && "Invalid action!");
Dan Gohmanb18b8ad2011-07-05 22:02:36 +0000505
506 // Add ObjC ARC final-cleanup optimizations. This is done as part of the
507 // "codegen" passes so that it isn't run multiple times when there is
508 // inlining happening.
Dan Gohman465a8992012-04-04 21:04:56 +0000509 if (LangOpts.ObjCAutoRefCount &&
510 CodeGenOpts.OptimizationLevel > 0)
Dan Gohmanb18b8ad2011-07-05 22:02:36 +0000511 PM->add(createObjCARCContractPass());
512
Evan Cheng9254bf72011-11-16 08:38:55 +0000513 if (TM->addPassesToEmitFile(*PM, OS, CGFT,
Daniel Dunbar897c6762010-06-07 23:20:08 +0000514 /*DisableVerify=*/!CodeGenOpts.VerifyModule)) {
515 Diags.Report(diag::err_fe_unable_to_interface_with_target);
516 return false;
517 }
518
519 return true;
520}
521
522void EmitAssemblyHelper::EmitAssembly(BackendAction Action, raw_ostream *OS) {
523 TimeRegion Region(llvm::TimePassesIsEnabled ? &CodeGenerationTime : 0);
524 llvm::formatted_raw_ostream FormattedOS;
525
Nadav Rotem129369d2012-10-24 03:52:31 +0000526 bool UsesCodeGen = (Action != Backend_EmitNothing &&
527 Action != Backend_EmitBC &&
528 Action != Backend_EmitLL);
529 TargetMachine *TM = CreateTargetMachine(UsesCodeGen);
Chad Rosiera03fc6e2013-03-27 00:14:35 +0000530 if (UsesCodeGen && !TM) return;
Nick Lewycky73b8d4b2013-06-21 21:15:32 +0000531 llvm::OwningPtr<TargetMachine> TMOwner(CodeGenOpts.DisableFree ? 0 : TM);
Nadav Rotemfa60be02012-10-24 00:53:38 +0000532 CreatePasses(TM);
533
Daniel Dunbar897c6762010-06-07 23:20:08 +0000534 switch (Action) {
535 case Backend_EmitNothing:
536 break;
537
538 case Backend_EmitBC:
Nadav Rotemfa60be02012-10-24 00:53:38 +0000539 getPerModulePasses(TM)->add(createBitcodeWriterPass(*OS));
Daniel Dunbar897c6762010-06-07 23:20:08 +0000540 break;
541
542 case Backend_EmitLL:
543 FormattedOS.setStream(*OS, formatted_raw_ostream::PRESERVE_STREAM);
Nadav Rotemfa60be02012-10-24 00:53:38 +0000544 getPerModulePasses(TM)->add(createPrintModulePass(&FormattedOS));
Daniel Dunbar897c6762010-06-07 23:20:08 +0000545 break;
546
547 default:
548 FormattedOS.setStream(*OS, formatted_raw_ostream::PRESERVE_STREAM);
Nadav Rotemfa60be02012-10-24 00:53:38 +0000549 if (!AddEmitPasses(Action, FormattedOS, TM))
Daniel Dunbar897c6762010-06-07 23:20:08 +0000550 return;
551 }
552
Andrew Trick92b5d942011-04-05 18:56:55 +0000553 // Before executing passes, print the final values of the LLVM options.
554 cl::PrintOptionValues();
555
Daniel Dunbar897c6762010-06-07 23:20:08 +0000556 // Run passes. For now we do all passes at once, but eventually we
557 // would like to have the option of streaming code generation.
558
559 if (PerFunctionPasses) {
560 PrettyStackTraceString CrashInfo("Per-function optimization");
561
562 PerFunctionPasses->doInitialization();
563 for (Module::iterator I = TheModule->begin(),
564 E = TheModule->end(); I != E; ++I)
565 if (!I->isDeclaration())
566 PerFunctionPasses->run(*I);
567 PerFunctionPasses->doFinalization();
568 }
569
570 if (PerModulePasses) {
571 PrettyStackTraceString CrashInfo("Per-module optimization passes");
572 PerModulePasses->run(*TheModule);
573 }
574
575 if (CodeGenPasses) {
576 PrettyStackTraceString CrashInfo("Code generation");
Daniel Dunbardb2f2372010-09-17 07:35:16 +0000577 CodeGenPasses->run(*TheModule);
Daniel Dunbar897c6762010-06-07 23:20:08 +0000578 }
579}
580
David Blaikied6471f72011-09-25 23:23:43 +0000581void clang::EmitBackendOutput(DiagnosticsEngine &Diags,
582 const CodeGenOptions &CGOpts,
Nick Lewycky3aaeccc2011-12-02 22:17:00 +0000583 const clang::TargetOptions &TOpts,
Dan Gohmanb18b8ad2011-07-05 22:02:36 +0000584 const LangOptions &LOpts,
585 Module *M,
Daniel Dunbar05a7f3d2010-06-07 23:21:04 +0000586 BackendAction Action, raw_ostream *OS) {
Dan Gohmanb18b8ad2011-07-05 22:02:36 +0000587 EmitAssemblyHelper AsmHelper(Diags, CGOpts, TOpts, LOpts, M);
Daniel Dunbar897c6762010-06-07 23:20:08 +0000588
589 AsmHelper.EmitAssembly(Action, OS);
590}