blob: 235ab2db52d6b23e3a98e0370d856463d0e836a9 [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"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +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 Abdulrasool888e2892017-01-05 16:02:32 +000017#include "clang/Lex/HeaderSearchOptions.h"
Hal Finkel1a328f52016-12-15 02:19:17 +000018#include "llvm/ADT/SmallSet.h"
Eric Christopher583a1f72015-09-26 01:25:08 +000019#include "llvm/ADT/StringExtras.h"
Saleem Abdulrasool62849c62014-05-08 02:28:32 +000020#include "llvm/ADT/StringSwitch.h"
Steven Wu27fb5222016-05-11 16:26:03 +000021#include "llvm/ADT/Triple.h"
Chandler Carruth418bd1a2015-01-15 02:16:55 +000022#include "llvm/Analysis/TargetLibraryInfo.h"
Chandler Carruthaab5ec02015-01-31 11:18:46 +000023#include "llvm/Analysis/TargetTransformInfo.h"
Teresa Johnsonffc4e242016-11-11 05:35:12 +000024#include "llvm/Bitcode/BitcodeReader.h"
Chandler Carruth50f9e892016-12-23 20:44:01 +000025#include "llvm/Bitcode/BitcodeWriter.h"
26#include "llvm/Bitcode/BitcodeWriterPass.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000027#include "llvm/CodeGen/RegAllocRegistry.h"
28#include "llvm/CodeGen/SchedulerRegistry.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000029#include "llvm/IR/DataLayout.h"
Chandler Carruth0a50c492014-01-12 11:11:50 +000030#include "llvm/IR/IRPrintingPasses.h"
Chandler Carruth9828e692015-02-13 09:57:03 +000031#include "llvm/IR/LegacyPassManager.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000032#include "llvm/IR/Module.h"
Chandler Carruth50f9e892016-12-23 20:44:01 +000033#include "llvm/IR/ModuleSummaryIndex.h"
Chandler Carruthca884742014-01-13 09:26:48 +000034#include "llvm/IR/Verifier.h"
Teresa Johnson9e3f4742016-08-12 18:12:08 +000035#include "llvm/LTO/LTOBackend.h"
Saleem Abdulrasool888e2892017-01-05 16:02:32 +000036#include "llvm/MC/MCAsmInfo.h"
Evan Chengeeb486d2011-06-29 01:14:32 +000037#include "llvm/MC/SubtargetFeature.h"
Chandler Carruth50f9e892016-12-23 20:44:01 +000038#include "llvm/Passes/PassBuilder.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000039#include "llvm/Support/CommandLine.h"
Teresa Johnson9e3f4742016-08-12 18:12:08 +000040#include "llvm/Support/MemoryBuffer.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000041#include "llvm/Support/PrettyStackTrace.h"
Evan Cheng494eb062011-08-24 18:09:14 +000042#include "llvm/Support/TargetRegistry.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000043#include "llvm/Support/Timer.h"
44#include "llvm/Support/raw_ostream.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000045#include "llvm/Target/TargetMachine.h"
46#include "llvm/Target/TargetOptions.h"
David Blaikie68d00b02017-11-17 01:07:20 +000047#include "llvm/CodeGen/TargetSubtargetInfo.h"
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000048#include "llvm/Transforms/Coroutines.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000049#include "llvm/Transforms/IPO.h"
Chandler Carruthb72c19f2016-08-17 03:09:11 +000050#include "llvm/Transforms/IPO/AlwaysInliner.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000051#include "llvm/Transforms/IPO/PassManagerBuilder.h"
Tim Shen50fedec2017-06-01 23:27:51 +000052#include "llvm/Transforms/IPO/ThinLTOBitcodeWriter.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000053#include "llvm/Transforms/Instrumentation.h"
Chandler Carruthafce4492017-11-14 01:47:24 +000054#include "llvm/Transforms/Instrumentation/BoundsChecking.h"
Michael Gottesman90cae772013-01-28 01:36:00 +000055#include "llvm/Transforms/ObjCARC.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000056#include "llvm/Transforms/Scalar.h"
Chandler Carruth4ddaadc2016-03-11 09:02:43 +000057#include "llvm/Transforms/Scalar/GVN.h"
Tim Shen66470692017-06-29 23:08:38 +000058#include "llvm/Transforms/Utils/NameAnonGlobals.h"
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +000059#include "llvm/Transforms/Utils/SymbolRewriter.h"
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000060#include <memory>
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000061using namespace clang;
62using namespace llvm;
63
64namespace {
65
Davide Italiano945de432017-02-13 16:07:05 +000066// Default filename used for profile generation.
67static constexpr StringLiteral DefaultProfileGenName = "default_%m.profraw";
68
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000069class EmitAssemblyHelper {
David Blaikie9c902b52011-09-25 23:23:43 +000070 DiagnosticsEngine &Diags;
Saleem Abdulrasool888e2892017-01-05 16:02:32 +000071 const HeaderSearchOptions &HSOpts;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000072 const CodeGenOptions &CodeGenOpts;
Nick Lewycky432add52011-12-02 22:17:00 +000073 const clang::TargetOptions &TargetOpts;
Dan Gohmanfec0ff82011-07-05 22:02:36 +000074 const LangOptions &LangOpts;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000075 Module *TheModule;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000076
77 Timer CodeGenerationTime;
78
Peter Collingbourne03f89072016-07-15 00:55:40 +000079 std::unique_ptr<raw_pwrite_stream> OS;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000080
Chandler Carruthd294bdb2015-02-01 12:26:23 +000081 TargetIRAnalysis getTargetIRAnalysis() const {
Chandler Carruthaab5ec02015-01-31 11:18:46 +000082 if (TM)
Chandler Carruthd294bdb2015-02-01 12:26:23 +000083 return TM->getTargetIRAnalysis();
Chandler Carruthaab5ec02015-01-31 11:18:46 +000084
Chandler Carruthd294bdb2015-02-01 12:26:23 +000085 return TargetIRAnalysis();
Chandler Carruthaab5ec02015-01-31 11:18:46 +000086 }
87
Teresa Johnson9e3f4742016-08-12 18:12:08 +000088 void CreatePasses(legacy::PassManager &MPM, legacy::FunctionPassManager &FPM);
Nadav Rotemec57ab32012-10-24 00:53:38 +000089
Rafael Espindola2f16bc12015-04-14 15:15:49 +000090 /// Generates the TargetMachine.
Peter Collingbourne03f89072016-07-15 00:55:40 +000091 /// Leaves TM unchanged if it is unable to create the target machine.
Nadav Rotemdc06b2d2012-10-24 03:52:31 +000092 /// Some of our clang tests specify triples which are not built
93 /// into clang. This is okay because these tests check the generated
94 /// IR, and they require DataLayout which depends on the triple.
95 /// In this case, we allow this method to fail and not report an error.
96 /// When MustCreateTM is used, we print an error if we are unable to load
97 /// the requested target.
Peter Collingbourne03f89072016-07-15 00:55:40 +000098 void CreateTargetMachine(bool MustCreateTM);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000099
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000100 /// Add passes necessary to emit assembly or LLVM IR.
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000101 ///
102 /// \return True on success.
Peter Collingbourne03f89072016-07-15 00:55:40 +0000103 bool AddEmitPasses(legacy::PassManager &CodeGenPasses, BackendAction Action,
104 raw_pwrite_stream &OS);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000105
106public:
Saleem Abdulrasool888e2892017-01-05 16:02:32 +0000107 EmitAssemblyHelper(DiagnosticsEngine &_Diags,
108 const HeaderSearchOptions &HeaderSearchOpts,
109 const CodeGenOptions &CGOpts,
Nick Lewycky432add52011-12-02 22:17:00 +0000110 const clang::TargetOptions &TOpts,
Teresa Johnson4b4f4b92016-01-08 17:04:29 +0000111 const LangOptions &LOpts, Module *M)
Saleem Abdulrasool888e2892017-01-05 16:02:32 +0000112 : Diags(_Diags), HSOpts(HeaderSearchOpts), CodeGenOpts(CGOpts),
113 TargetOpts(TOpts), LangOpts(LOpts), TheModule(M),
114 CodeGenerationTime("codegen", "Code Generation Time") {}
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000115
116 ~EmitAssemblyHelper() {
Alp Tokerf4e22382013-12-20 20:26:53 +0000117 if (CodeGenOpts.DisableFree)
David Blaikiea97eaa12014-08-29 16:53:14 +0000118 BuryPointer(std::move(TM));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000119 }
120
Ahmed Charlesb8984322014-03-07 20:03:18 +0000121 std::unique_ptr<TargetMachine> TM;
Alp Tokerf4e22382013-12-20 20:26:53 +0000122
Peter Collingbourne03f89072016-07-15 00:55:40 +0000123 void EmitAssembly(BackendAction Action,
124 std::unique_ptr<raw_pwrite_stream> OS);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000125
126 void EmitAssemblyWithNewPassManager(BackendAction Action,
127 std::unique_ptr<raw_pwrite_stream> OS);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000128};
129
Alexey Samsonovc6515b62012-12-28 09:31:34 +0000130// We need this wrapper to access LangOpts and CGOpts from extension functions
131// that we add to the PassManagerBuilder.
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000132class PassManagerBuilderWrapper : public PassManagerBuilder {
133public:
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000134 PassManagerBuilderWrapper(const Triple &TargetTriple,
135 const CodeGenOptions &CGOpts,
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000136 const LangOptions &LangOpts)
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000137 : PassManagerBuilder(), TargetTriple(TargetTriple), CGOpts(CGOpts),
138 LangOpts(LangOpts) {}
139 const Triple &getTargetTriple() const { return TargetTriple; }
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000140 const CodeGenOptions &getCGOpts() const { return CGOpts; }
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000141 const LangOptions &getLangOpts() const { return LangOpts; }
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000142
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000143private:
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000144 const Triple &TargetTriple;
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000145 const CodeGenOptions &CGOpts;
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000146 const LangOptions &LangOpts;
147};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000148}
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000149
Dan Gohman5932ce22012-01-17 20:54:51 +0000150static void addObjCARCAPElimPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
151 if (Builder.OptLevel > 0)
152 PM.add(createObjCARCAPElimPass());
153}
154
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000155static void addObjCARCExpandPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
156 if (Builder.OptLevel > 0)
157 PM.add(createObjCARCExpandPass());
158}
159
160static void addObjCARCOptPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
161 if (Builder.OptLevel > 0)
162 PM.add(createObjCARCOptPass());
163}
164
Diego Novillob56be642014-03-03 20:06:18 +0000165static void addAddDiscriminatorsPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000166 legacy::PassManagerBase &PM) {
Diego Novillob56be642014-03-03 20:06:18 +0000167 PM.add(createAddDiscriminatorsPass());
168}
169
Nuno Lopesa4255892012-05-22 17:19:45 +0000170static void addBoundsCheckingPass(const PassManagerBuilder &Builder,
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000171 legacy::PassManagerBase &PM) {
Chandler Carruth00a301d2017-11-14 01:30:04 +0000172 PM.add(createBoundsCheckingLegacyPass());
Nuno Lopesa4255892012-05-22 17:19:45 +0000173}
174
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000175static void addSanitizerCoveragePass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000176 legacy::PassManagerBase &PM) {
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000177 const PassManagerBuilderWrapper &BuilderWrapper =
178 static_cast<const PassManagerBuilderWrapper&>(Builder);
179 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
Alexey Samsonov3f3b3ab2015-05-07 18:31:29 +0000180 SanitizerCoverageOptions Opts;
181 Opts.CoverageType =
182 static_cast<SanitizerCoverageOptions::Type>(CGOpts.SanitizeCoverageType);
183 Opts.IndirectCalls = CGOpts.SanitizeCoverageIndirectCalls;
184 Opts.TraceBB = CGOpts.SanitizeCoverageTraceBB;
185 Opts.TraceCmp = CGOpts.SanitizeCoverageTraceCmp;
Kostya Serebryany3b419712016-08-30 01:27:03 +0000186 Opts.TraceDiv = CGOpts.SanitizeCoverageTraceDiv;
187 Opts.TraceGep = CGOpts.SanitizeCoverageTraceGep;
Alexey Samsonov3f3b3ab2015-05-07 18:31:29 +0000188 Opts.Use8bitCounters = CGOpts.SanitizeCoverage8bitCounters;
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000189 Opts.TracePC = CGOpts.SanitizeCoverageTracePC;
Kostya Serebryany60cdd612016-09-14 01:39:49 +0000190 Opts.TracePCGuard = CGOpts.SanitizeCoverageTracePCGuard;
Kostya Serebryany50fb6182017-05-05 23:28:18 +0000191 Opts.NoPrune = CGOpts.SanitizeCoverageNoPrune;
Kostya Serebryany2c2fb882017-06-08 22:58:19 +0000192 Opts.Inline8bitCounters = CGOpts.SanitizeCoverageInline8bitCounters;
Kostya Serebryany61457762017-07-28 00:10:10 +0000193 Opts.PCTable = CGOpts.SanitizeCoveragePCTable;
Matt Morehouse5c7fc762017-08-18 18:43:30 +0000194 Opts.StackDepth = CGOpts.SanitizeCoverageStackDepth;
Alexey Samsonov3f3b3ab2015-05-07 18:31:29 +0000195 PM.add(createSanitizerCoverageModulePass(Opts));
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000196}
197
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000198// Check if ASan should use GC-friendly instrumentation for globals.
199// First of all, there is no point if -fdata-sections is off (expect for MachO,
200// where this is not a factor). Also, on ELF this feature requires an assembler
201// extension that only works with -integrated-as at the moment.
202static bool asanUseGlobalsGC(const Triple &T, const CodeGenOptions &CGOpts) {
Evgeniy Stepanovd991cdd2017-05-09 21:57:43 +0000203 if (!CGOpts.SanitizeAddressGlobalsDeadStripping)
204 return false;
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000205 switch (T.getObjectFormat()) {
206 case Triple::MachO:
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000207 case Triple::COFF:
Evgeniy Stepanovc7b90942017-04-26 00:51:06 +0000208 return true;
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000209 case Triple::ELF:
210 return CGOpts.DataSections && !CGOpts.DisableIntegratedAS;
211 default:
212 return false;
213 }
214}
215
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000216static void addAddressSanitizerPasses(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000217 legacy::PassManagerBase &PM) {
Yury Gribov5bfeca12015-11-11 10:45:48 +0000218 const PassManagerBuilderWrapper &BuilderWrapper =
219 static_cast<const PassManagerBuilderWrapper&>(Builder);
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000220 const Triple &T = BuilderWrapper.getTargetTriple();
Yury Gribov5bfeca12015-11-11 10:45:48 +0000221 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
222 bool Recover = CGOpts.SanitizeRecover.has(SanitizerKind::Address);
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000223 bool UseAfterScope = CGOpts.SanitizeAddressUseAfterScope;
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000224 bool UseGlobalsGC = asanUseGlobalsGC(T, CGOpts);
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000225 PM.add(createAddressSanitizerFunctionPass(/*CompileKernel*/ false, Recover,
226 UseAfterScope));
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000227 PM.add(createAddressSanitizerModulePass(/*CompileKernel*/ false, Recover,
228 UseGlobalsGC));
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000229}
230
231static void addKernelAddressSanitizerPasses(const PassManagerBuilder &Builder,
232 legacy::PassManagerBase &PM) {
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000233 PM.add(createAddressSanitizerFunctionPass(
234 /*CompileKernel*/ true,
235 /*Recover*/ true, /*UseAfterScope*/ false));
Yury Gribov5bfeca12015-11-11 10:45:48 +0000236 PM.add(createAddressSanitizerModulePass(/*CompileKernel*/true,
237 /*Recover*/true));
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000238}
239
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000240static void addMemorySanitizerPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000241 legacy::PassManagerBase &PM) {
Evgeniy Stepanovad8ab3d2012-12-24 08:42:34 +0000242 const PassManagerBuilderWrapper &BuilderWrapper =
243 static_cast<const PassManagerBuilderWrapper&>(Builder);
244 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
Evgeniy Stepanov5b5370a2016-11-07 21:02:11 +0000245 int TrackOrigins = CGOpts.SanitizeMemoryTrackOrigins;
246 bool Recover = CGOpts.SanitizeRecover.has(SanitizerKind::Memory);
247 PM.add(createMemorySanitizerPass(TrackOrigins, Recover));
Evgeniy Stepanov10284672013-01-31 09:53:29 +0000248
249 // MemorySanitizer inserts complex instrumentation that mostly follows
250 // the logic of the original code, but operates on "shadow" values.
251 // It can benefit from re-running some general purpose optimization passes.
252 if (Builder.OptLevel > 0) {
253 PM.add(createEarlyCSEPass());
254 PM.add(createReassociatePass());
255 PM.add(createLICMPass());
256 PM.add(createGVNPass());
257 PM.add(createInstructionCombiningPass());
258 PM.add(createDeadStoreEliminationPass());
259 }
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000260}
261
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000262static void addThreadSanitizerPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000263 legacy::PassManagerBase &PM) {
Alexey Samsonov1cf07ea2014-06-02 18:08:08 +0000264 PM.add(createThreadSanitizerPass());
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000265}
266
Peter Collingbournec3772752013-08-07 22:47:34 +0000267static void addDataFlowSanitizerPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000268 legacy::PassManagerBase &PM) {
Peter Collingbourne276be3c2013-08-14 18:54:18 +0000269 const PassManagerBuilderWrapper &BuilderWrapper =
270 static_cast<const PassManagerBuilderWrapper&>(Builder);
Alexey Samsonovae5804f2014-10-15 20:22:54 +0000271 const LangOptions &LangOpts = BuilderWrapper.getLangOpts();
Alexey Samsonova511cdd2015-02-04 17:40:08 +0000272 PM.add(createDataFlowSanitizerPass(LangOpts.SanitizerBlacklistFiles));
Peter Collingbournec3772752013-08-07 22:47:34 +0000273}
274
Derek Bruening256c2e12016-04-21 21:32:04 +0000275static void addEfficiencySanitizerPass(const PassManagerBuilder &Builder,
276 legacy::PassManagerBase &PM) {
277 const PassManagerBuilderWrapper &BuilderWrapper =
278 static_cast<const PassManagerBuilderWrapper&>(Builder);
279 const LangOptions &LangOpts = BuilderWrapper.getLangOpts();
280 EfficiencySanitizerOptions Opts;
281 if (LangOpts.Sanitize.has(SanitizerKind::EfficiencyCacheFrag))
282 Opts.ToolType = EfficiencySanitizerOptions::ESAN_CacheFrag;
Derek Bruening293772e2016-05-25 00:41:24 +0000283 else if (LangOpts.Sanitize.has(SanitizerKind::EfficiencyWorkingSet))
284 Opts.ToolType = EfficiencySanitizerOptions::ESAN_WorkingSet;
Derek Bruening256c2e12016-04-21 21:32:04 +0000285 PM.add(createEfficiencySanitizerPass(Opts));
286}
287
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000288static TargetLibraryInfoImpl *createTLII(llvm::Triple &TargetTriple,
289 const CodeGenOptions &CodeGenOpts) {
290 TargetLibraryInfoImpl *TLII = new TargetLibraryInfoImpl(TargetTriple);
Rafael Espindolab8a71c52014-08-21 17:58:42 +0000291 if (!CodeGenOpts.SimplifyLibCalls)
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000292 TLII->disableAllFunctions();
Chad Rosier7dbc9cf2016-01-06 14:35:46 +0000293 else {
294 // Disable individual libc/libm calls in TargetLibraryInfo.
David L. Jones7a7dd032017-01-23 23:16:58 +0000295 LibFunc F;
Chad Rosier7dbc9cf2016-01-06 14:35:46 +0000296 for (auto &FuncName : CodeGenOpts.getNoBuiltinFuncs())
297 if (TLII->getLibFunc(FuncName, F))
298 TLII->setUnavailable(F);
299 }
Michael Zolotukhinc888dd02015-03-17 20:03:11 +0000300
301 switch (CodeGenOpts.getVecLib()) {
302 case CodeGenOptions::Accelerate:
303 TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::Accelerate);
304 break;
Matt Masten6731dea2016-07-29 16:44:24 +0000305 case CodeGenOptions::SVML:
306 TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::SVML);
307 break;
Michael Zolotukhinc888dd02015-03-17 20:03:11 +0000308 default:
309 break;
310 }
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000311 return TLII;
Rafael Espindolab8a71c52014-08-21 17:58:42 +0000312}
313
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000314static void addSymbolRewriterPass(const CodeGenOptions &Opts,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000315 legacy::PassManager *MPM) {
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000316 llvm::SymbolRewriter::RewriteDescriptorList DL;
317
318 llvm::SymbolRewriter::RewriteMapParser MapParser;
319 for (const auto &MapFile : Opts.RewriteMapFiles)
320 MapParser.parse(MapFile, &DL);
321
322 MPM->add(createRewriteSymbolsPass(DL));
323}
324
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000325static CodeGenOpt::Level getCGOptLevel(const CodeGenOptions &CodeGenOpts) {
326 switch (CodeGenOpts.OptimizationLevel) {
327 default:
328 llvm_unreachable("Invalid optimization level!");
329 case 0:
330 return CodeGenOpt::None;
331 case 1:
332 return CodeGenOpt::Less;
333 case 2:
334 return CodeGenOpt::Default; // O2/Os/Oz
335 case 3:
336 return CodeGenOpt::Aggressive;
337 }
338}
339
Rafael Espindolaaa0226e2017-08-03 02:16:28 +0000340static Optional<llvm::CodeModel::Model>
341getCodeModel(const CodeGenOptions &CodeGenOpts) {
342 unsigned CodeModel = llvm::StringSwitch<unsigned>(CodeGenOpts.CodeModel)
343 .Case("small", llvm::CodeModel::Small)
344 .Case("kernel", llvm::CodeModel::Kernel)
345 .Case("medium", llvm::CodeModel::Medium)
346 .Case("large", llvm::CodeModel::Large)
347 .Case("default", ~1u)
348 .Default(~0u);
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000349 assert(CodeModel != ~0u && "invalid code model!");
Rafael Espindolaaa0226e2017-08-03 02:16:28 +0000350 if (CodeModel == ~1u)
351 return None;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000352 return static_cast<llvm::CodeModel::Model>(CodeModel);
353}
354
355static llvm::Reloc::Model getRelocModel(const CodeGenOptions &CodeGenOpts) {
Davide Italiano1a3665bb2017-04-01 21:07:07 +0000356 // Keep this synced with the equivalent code in
357 // lib/Frontend/CompilerInvocation.cpp
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000358 llvm::Optional<llvm::Reloc::Model> RM;
359 RM = llvm::StringSwitch<llvm::Reloc::Model>(CodeGenOpts.RelocationModel)
360 .Case("static", llvm::Reloc::Static)
361 .Case("pic", llvm::Reloc::PIC_)
362 .Case("ropi", llvm::Reloc::ROPI)
363 .Case("rwpi", llvm::Reloc::RWPI)
364 .Case("ropi-rwpi", llvm::Reloc::ROPI_RWPI)
365 .Case("dynamic-no-pic", llvm::Reloc::DynamicNoPIC);
366 assert(RM.hasValue() && "invalid PIC model!");
367 return *RM;
368}
369
370static TargetMachine::CodeGenFileType getCodeGenFileType(BackendAction Action) {
371 if (Action == Backend_EmitObj)
372 return TargetMachine::CGFT_ObjectFile;
373 else if (Action == Backend_EmitMCNull)
374 return TargetMachine::CGFT_Null;
375 else {
376 assert(Action == Backend_EmitAssembly && "Invalid action!");
377 return TargetMachine::CGFT_AssemblyFile;
378 }
379}
380
381static void initTargetOptions(llvm::TargetOptions &Options,
382 const CodeGenOptions &CodeGenOpts,
383 const clang::TargetOptions &TargetOpts,
384 const LangOptions &LangOpts,
385 const HeaderSearchOptions &HSOpts) {
386 Options.ThreadModel =
387 llvm::StringSwitch<llvm::ThreadModel::Model>(CodeGenOpts.ThreadModel)
388 .Case("posix", llvm::ThreadModel::POSIX)
389 .Case("single", llvm::ThreadModel::Single);
390
391 // Set float ABI type.
392 assert((CodeGenOpts.FloatABI == "soft" || CodeGenOpts.FloatABI == "softfp" ||
393 CodeGenOpts.FloatABI == "hard" || CodeGenOpts.FloatABI.empty()) &&
394 "Invalid Floating Point ABI!");
395 Options.FloatABIType =
396 llvm::StringSwitch<llvm::FloatABI::ABIType>(CodeGenOpts.FloatABI)
397 .Case("soft", llvm::FloatABI::Soft)
398 .Case("softfp", llvm::FloatABI::Soft)
399 .Case("hard", llvm::FloatABI::Hard)
400 .Default(llvm::FloatABI::Default);
401
402 // Set FP fusion mode.
403 switch (LangOpts.getDefaultFPContractMode()) {
404 case LangOptions::FPC_Off:
Adam Nemet03af4242017-04-20 17:09:35 +0000405 // Preserve any contraction performed by the front-end. (Strict performs
406 // splitting of the muladd instrinsic in the backend.)
407 Options.AllowFPOpFusion = llvm::FPOpFusion::Standard;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000408 break;
409 case LangOptions::FPC_On:
410 Options.AllowFPOpFusion = llvm::FPOpFusion::Standard;
411 break;
412 case LangOptions::FPC_Fast:
413 Options.AllowFPOpFusion = llvm::FPOpFusion::Fast;
414 break;
415 }
416
417 Options.UseInitArray = CodeGenOpts.UseInitArray;
418 Options.DisableIntegratedAS = CodeGenOpts.DisableIntegratedAS;
Saleem Abdulrasool54448902017-06-09 00:40:30 +0000419 Options.CompressDebugSections = CodeGenOpts.getCompressDebugSections();
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000420 Options.RelaxELFRelocations = CodeGenOpts.RelaxELFRelocations;
421
422 // Set EABI version.
Yuka Takahashidc771502017-07-01 07:57:23 +0000423 Options.EABIVersion = TargetOpts.EABIVersion;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000424
425 if (LangOpts.SjLjExceptions)
426 Options.ExceptionModel = llvm::ExceptionHandling::SjLj;
Martell Malonec950c652017-11-29 07:25:12 +0000427 if (LangOpts.SEHExceptions)
428 Options.ExceptionModel = llvm::ExceptionHandling::WinEH;
429 if (LangOpts.DWARFExceptions)
430 Options.ExceptionModel = llvm::ExceptionHandling::DwarfCFI;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000431
432 Options.NoInfsFPMath = CodeGenOpts.NoInfsFPMath;
433 Options.NoNaNsFPMath = CodeGenOpts.NoNaNsFPMath;
434 Options.NoZerosInBSS = CodeGenOpts.NoZeroInitializedInBSS;
435 Options.UnsafeFPMath = CodeGenOpts.UnsafeFPMath;
436 Options.StackAlignmentOverride = CodeGenOpts.StackAlignment;
437 Options.FunctionSections = CodeGenOpts.FunctionSections;
438 Options.DataSections = CodeGenOpts.DataSections;
439 Options.UniqueSectionNames = CodeGenOpts.UniqueSectionNames;
440 Options.EmulatedTLS = CodeGenOpts.EmulatedTLS;
441 Options.DebuggerTuning = CodeGenOpts.getDebuggerTuning();
442
David Blaikie81503552017-04-21 23:35:36 +0000443 if (CodeGenOpts.EnableSplitDwarf)
444 Options.MCOptions.SplitDwarfFile = CodeGenOpts.SplitDwarfFile;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000445 Options.MCOptions.MCRelaxAll = CodeGenOpts.RelaxAll;
446 Options.MCOptions.MCSaveTempLabels = CodeGenOpts.SaveTempLabels;
447 Options.MCOptions.MCUseDwarfDirectory = !CodeGenOpts.NoDwarfDirectoryAsm;
448 Options.MCOptions.MCNoExecStack = CodeGenOpts.NoExecStack;
449 Options.MCOptions.MCIncrementalLinkerCompatible =
450 CodeGenOpts.IncrementalLinkerCompatible;
451 Options.MCOptions.MCPIECopyRelocations = CodeGenOpts.PIECopyRelocations;
452 Options.MCOptions.MCFatalWarnings = CodeGenOpts.FatalWarnings;
453 Options.MCOptions.AsmVerbose = CodeGenOpts.AsmVerbose;
454 Options.MCOptions.PreserveAsmComments = CodeGenOpts.PreserveAsmComments;
455 Options.MCOptions.ABIName = TargetOpts.ABI;
456 for (const auto &Entry : HSOpts.UserEntries)
457 if (!Entry.IsFramework &&
458 (Entry.Group == frontend::IncludeDirGroup::Quoted ||
459 Entry.Group == frontend::IncludeDirGroup::Angled ||
460 Entry.Group == frontend::IncludeDirGroup::System))
461 Options.MCOptions.IASSearchPaths.push_back(
462 Entry.IgnoreSysRoot ? Entry.Path : HSOpts.Sysroot + Entry.Path);
463}
464
Peter Collingbourne03f89072016-07-15 00:55:40 +0000465void EmitAssemblyHelper::CreatePasses(legacy::PassManager &MPM,
Teresa Johnson9e3f4742016-08-12 18:12:08 +0000466 legacy::FunctionPassManager &FPM) {
Chandler Carruth93786da2016-12-23 00:23:01 +0000467 // Handle disabling of all LLVM passes, where we want to preserve the
468 // internal module before any optimization.
Steven Wu546a1962015-07-17 20:09:56 +0000469 if (CodeGenOpts.DisableLLVMPasses)
470 return;
471
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000472 // Figure out TargetLibraryInfo. This needs to be added to MPM and FPM
473 // manually (and not via PMBuilder), since some passes (eg. InstrProfiling)
474 // are inserted before PMBuilder ones - they'd get the default-constructed
475 // TLI with an unknown target otherwise.
Teresa Johnsonaff22322015-12-07 19:21:34 +0000476 Triple TargetTriple(TheModule->getTargetTriple());
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000477 std::unique_ptr<TargetLibraryInfoImpl> TLII(
478 createTLII(TargetTriple, CodeGenOpts));
Teresa Johnsonaff22322015-12-07 19:21:34 +0000479
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000480 PassManagerBuilderWrapper PMBuilder(TargetTriple, CodeGenOpts, LangOpts);
481
Chandler Carruthfcd33142016-12-23 01:24:49 +0000482 // At O0 and O1 we only run the always inliner which is more efficient. At
483 // higher optimization levels we run the normal inliner.
484 if (CodeGenOpts.OptimizationLevel <= 1) {
Mehdi Amini7f873072017-01-06 23:18:09 +0000485 bool InsertLifetimeIntrinsics = (CodeGenOpts.OptimizationLevel != 0 &&
486 !CodeGenOpts.DisableLifetimeMarkers);
Chandler Carruthfcd33142016-12-23 01:24:49 +0000487 PMBuilder.Inliner = createAlwaysInlinerLegacyPass(InsertLifetimeIntrinsics);
488 } else {
Dehao Chence39fdd2017-03-21 19:55:46 +0000489 // We do not want to inline hot callsites for SamplePGO module-summary build
490 // because profile annotation will happen again in ThinLTO backend, and we
491 // want the IR of the hot path to match the profile.
Chandler Carruthfcd33142016-12-23 01:24:49 +0000492 PMBuilder.Inliner = createFunctionInliningPass(
Dehao Chence39fdd2017-03-21 19:55:46 +0000493 CodeGenOpts.OptimizationLevel, CodeGenOpts.OptimizeSize,
494 (!CodeGenOpts.SampleProfileFile.empty() &&
495 CodeGenOpts.EmitSummaryIndex));
Teresa Johnsonaff22322015-12-07 19:21:34 +0000496 }
497
Chandler Carruthfcd33142016-12-23 01:24:49 +0000498 PMBuilder.OptLevel = CodeGenOpts.OptimizationLevel;
Chris Lattnerecf0ba52011-05-21 23:50:44 +0000499 PMBuilder.SizeLevel = CodeGenOpts.OptimizeSize;
Nick Lewyckyd3f3e4f2013-06-25 01:49:44 +0000500 PMBuilder.SLPVectorize = CodeGenOpts.VectorizeSLP;
501 PMBuilder.LoopVectorize = CodeGenOpts.VectorizeLoop;
Andrew Trickb2a84722011-04-05 18:49:32 +0000502
Chris Lattnerecf0ba52011-05-21 23:50:44 +0000503 PMBuilder.DisableUnrollLoops = !CodeGenOpts.UnrollLoops;
Nick Lewyckyf04f2372014-10-24 00:49:29 +0000504 PMBuilder.MergeFunctions = CodeGenOpts.MergeFunctions;
Teresa Johnsona0d29402016-03-15 00:04:44 +0000505 PMBuilder.PrepareForThinLTO = CodeGenOpts.EmitSummaryIndex;
Teresa Johnson8749d8042015-07-06 16:23:00 +0000506 PMBuilder.PrepareForLTO = CodeGenOpts.PrepareForLTO;
Hal Finkelce0697f2013-11-17 16:03:29 +0000507 PMBuilder.RerollLoops = CodeGenOpts.RerollLoops;
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000508
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000509 MPM.add(new TargetLibraryInfoWrapperPass(*TLII));
510
Justin Lebar5a7df9c2016-04-27 19:12:56 +0000511 if (TM)
Stanislav Mekhanoshin61da0672017-01-26 16:49:21 +0000512 TM->adjustPassManager(PMBuilder);
Justin Lebar5a7df9c2016-04-27 19:12:56 +0000513
Dehao Chen7810d4f2017-02-21 20:36:21 +0000514 if (CodeGenOpts.DebugInfoForProfiling ||
515 !CodeGenOpts.SampleProfileFile.empty())
516 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
517 addAddDiscriminatorsPass);
Diego Novillob56be642014-03-03 20:06:18 +0000518
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000519 // In ObjC ARC mode, add the main ARC optimization passes.
520 if (LangOpts.ObjCAutoRefCount) {
521 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
522 addObjCARCExpandPass);
Dan Gohman5932ce22012-01-17 20:54:51 +0000523 PMBuilder.addExtension(PassManagerBuilder::EP_ModuleOptimizerEarly,
524 addObjCARCAPElimPass);
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000525 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
526 addObjCARCOptPass);
527 }
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000528
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000529 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds)) {
Nuno Lopesa4255892012-05-22 17:19:45 +0000530 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
531 addBoundsCheckingPass);
532 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
533 addBoundsCheckingPass);
534 }
535
Alexey Samsonovdfa908c2015-05-07 22:34:06 +0000536 if (CodeGenOpts.SanitizeCoverageType ||
537 CodeGenOpts.SanitizeCoverageIndirectCalls ||
538 CodeGenOpts.SanitizeCoverageTraceCmp) {
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000539 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
540 addSanitizerCoveragePass);
541 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
542 addSanitizerCoveragePass);
543 }
544
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000545 if (LangOpts.Sanitize.has(SanitizerKind::Address)) {
Kostya Serebryany7e247f22012-10-15 14:22:56 +0000546 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000547 addAddressSanitizerPasses);
Kostya Serebryanyd4768572011-11-30 22:20:21 +0000548 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000549 addAddressSanitizerPasses);
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000550 }
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000551
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000552 if (LangOpts.Sanitize.has(SanitizerKind::KernelAddress)) {
553 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
554 addKernelAddressSanitizerPasses);
555 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
556 addKernelAddressSanitizerPasses);
557 }
558
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000559 if (LangOpts.Sanitize.has(SanitizerKind::Memory)) {
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000560 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
561 addMemorySanitizerPass);
562 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
563 addMemorySanitizerPass);
564 }
565
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000566 if (LangOpts.Sanitize.has(SanitizerKind::Thread)) {
Kostya Serebryanyd18cb502012-03-23 23:25:23 +0000567 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000568 addThreadSanitizerPass);
569 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
570 addThreadSanitizerPass);
571 }
572
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000573 if (LangOpts.Sanitize.has(SanitizerKind::DataFlow)) {
Peter Collingbournec3772752013-08-07 22:47:34 +0000574 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
575 addDataFlowSanitizerPass);
576 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
577 addDataFlowSanitizerPass);
578 }
579
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000580 if (LangOpts.CoroutinesTS)
581 addCoroutinePassesToExtensionPoints(PMBuilder);
582
Derek Bruening256c2e12016-04-21 21:32:04 +0000583 if (LangOpts.Sanitize.hasOneOf(SanitizerKind::Efficiency)) {
584 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
585 addEfficiencySanitizerPass);
586 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
587 addEfficiencySanitizerPass);
588 }
589
Chris Lattner5c123672011-05-21 20:40:11 +0000590 // Set up the per-function pass manager.
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000591 FPM.add(new TargetLibraryInfoWrapperPass(*TLII));
Chris Lattner5c123672011-05-21 20:40:11 +0000592 if (CodeGenOpts.VerifyModule)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000593 FPM.add(createVerifierPass());
Andrew Trickb2a84722011-04-05 18:49:32 +0000594
Chris Lattner5c123672011-05-21 20:40:11 +0000595 // Set up the per-module pass manager.
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000596 if (!CodeGenOpts.RewriteMapFiles.empty())
Peter Collingbourne03f89072016-07-15 00:55:40 +0000597 addSymbolRewriterPass(CodeGenOpts, &MPM);
Chris Lattnerd98cec52011-02-18 22:20:38 +0000598
Nick Lewyckyc02bbb62013-03-20 01:38:16 +0000599 if (!CodeGenOpts.DisableGCov &&
600 (CodeGenOpts.EmitGcovArcs || CodeGenOpts.EmitGcovNotes)) {
Nick Lewyckyc8bf8242013-03-14 05:14:01 +0000601 // Not using 'GCOVOptions::getDefault' allows us to avoid exiting if
602 // LLVM's -default-gcov-version flag is set to something invalid.
603 GCOVOptions Options;
604 Options.EmitNotes = CodeGenOpts.EmitGcovNotes;
605 Options.EmitData = CodeGenOpts.EmitGcovArcs;
606 memcpy(Options.Version, CodeGenOpts.CoverageVersion, 4);
607 Options.UseCfgChecksum = CodeGenOpts.CoverageExtraChecksum;
608 Options.NoRedZone = CodeGenOpts.DisableRedZone;
Nick Lewyckyc8bf8242013-03-14 05:14:01 +0000609 Options.FunctionNamesInData =
Nick Lewycky6f15b2902013-03-20 02:14:38 +0000610 !CodeGenOpts.CoverageNoFunctionNamesInData;
Justin Bogner4e462372015-03-16 23:52:21 +0000611 Options.ExitBlockBeforeBody = CodeGenOpts.CoverageExitBlockBeforeBody;
Peter Collingbourne03f89072016-07-15 00:55:40 +0000612 MPM.add(createGCOVProfilerPass(Options));
Benjamin Kramer8c305922016-02-02 11:06:51 +0000613 if (CodeGenOpts.getDebugInfo() == codegenoptions::NoDebugInfo)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000614 MPM.add(createStripSymbolsPass(true));
Nick Lewycky207bce32011-04-21 23:44:07 +0000615 }
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000616
Rong Xu9837ef52016-02-04 18:39:09 +0000617 if (CodeGenOpts.hasProfileClangInstr()) {
Justin Bogner970ac602014-12-08 19:04:51 +0000618 InstrProfOptions Options;
619 Options.NoRedZone = CodeGenOpts.DisableRedZone;
Justin Bognera71e6812015-04-30 23:49:42 +0000620 Options.InstrProfileOutput = CodeGenOpts.InstrProfileOutput;
Peter Collingbourne03f89072016-07-15 00:55:40 +0000621 MPM.add(createInstrProfilingLegacyPass(Options));
Justin Bogner970ac602014-12-08 19:04:51 +0000622 }
Rong Xu522b5cb2016-02-29 18:54:59 +0000623 if (CodeGenOpts.hasProfileIRInstr()) {
Xinliang David Lib65f8ae2016-07-23 04:28:59 +0000624 PMBuilder.EnablePGOInstrGen = true;
Rong Xu522b5cb2016-02-29 18:54:59 +0000625 if (!CodeGenOpts.InstrProfileOutput.empty())
626 PMBuilder.PGOInstrGen = CodeGenOpts.InstrProfileOutput;
627 else
Davide Italiano945de432017-02-13 16:07:05 +0000628 PMBuilder.PGOInstrGen = DefaultProfileGenName;
Rong Xu522b5cb2016-02-29 18:54:59 +0000629 }
Rong Xu9c6f1532016-03-02 20:59:36 +0000630 if (CodeGenOpts.hasProfileIRUse())
631 PMBuilder.PGOInstrUse = CodeGenOpts.ProfileInstrumentUsePath;
Justin Bogner970ac602014-12-08 19:04:51 +0000632
Dehao Chen5717aff2016-12-14 21:41:04 +0000633 if (!CodeGenOpts.SampleProfileFile.empty())
634 PMBuilder.PGOSampleUse = CodeGenOpts.SampleProfileFile;
Diego Novillod3ef1082015-08-25 15:25:13 +0000635
Peter Collingbourne03f89072016-07-15 00:55:40 +0000636 PMBuilder.populateFunctionPassManager(FPM);
637 PMBuilder.populateModulePassManager(MPM);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000638}
639
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000640static void setCommandLineOpts(const CodeGenOptions &CodeGenOpts) {
Yaxun Liub5e80c32016-04-12 20:22:32 +0000641 SmallVector<const char *, 16> BackendArgs;
642 BackendArgs.push_back("clang"); // Fake program name.
643 if (!CodeGenOpts.DebugPass.empty()) {
644 BackendArgs.push_back("-debug-pass");
645 BackendArgs.push_back(CodeGenOpts.DebugPass.c_str());
646 }
647 if (!CodeGenOpts.LimitFloatPrecision.empty()) {
648 BackendArgs.push_back("-limit-float-precision");
649 BackendArgs.push_back(CodeGenOpts.LimitFloatPrecision.c_str());
650 }
651 for (const std::string &BackendOption : CodeGenOpts.BackendOptions)
652 BackendArgs.push_back(BackendOption.c_str());
653 BackendArgs.push_back(nullptr);
654 llvm::cl::ParseCommandLineOptions(BackendArgs.size() - 1,
655 BackendArgs.data());
656}
657
Peter Collingbourne03f89072016-07-15 00:55:40 +0000658void EmitAssemblyHelper::CreateTargetMachine(bool MustCreateTM) {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000659 // Create the TargetMachine for generating code.
660 std::string Error;
661 std::string Triple = TheModule->getTargetTriple();
662 const llvm::Target *TheTarget = TargetRegistry::lookupTarget(Triple, Error);
663 if (!TheTarget) {
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000664 if (MustCreateTM)
Chad Rosierecafbe62013-03-27 00:14:35 +0000665 Diags.Report(diag::err_fe_unable_to_create_target) << Error;
Peter Collingbourne03f89072016-07-15 00:55:40 +0000666 return;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000667 }
668
Rafael Espindolaaa0226e2017-08-03 02:16:28 +0000669 Optional<llvm::CodeModel::Model> CM = getCodeModel(CodeGenOpts);
Eric Christopher583a1f72015-09-26 01:25:08 +0000670 std::string FeaturesStr =
671 llvm::join(TargetOpts.Features.begin(), TargetOpts.Features.end(), ",");
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000672 llvm::Reloc::Model RM = getRelocModel(CodeGenOpts);
673 CodeGenOpt::Level OptLevel = getCGOptLevel(CodeGenOpts);
Evan Chengdd286bc2011-11-16 08:38:55 +0000674
Nick Lewycky432add52011-12-02 22:17:00 +0000675 llvm::TargetOptions Options;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000676 initTargetOptions(Options, CodeGenOpts, TargetOpts, LangOpts, HSOpts);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000677 TM.reset(TheTarget->createTargetMachine(Triple, TargetOpts.CPU, FeaturesStr,
678 Options, RM, CM, OptLevel));
Nadav Rotemec57ab32012-10-24 00:53:38 +0000679}
680
Peter Collingbourne03f89072016-07-15 00:55:40 +0000681bool EmitAssemblyHelper::AddEmitPasses(legacy::PassManager &CodeGenPasses,
682 BackendAction Action,
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000683 raw_pwrite_stream &OS) {
Chad Rosierb1cfc682012-02-29 20:14:59 +0000684 // Add LibraryInfo.
Daniel Dunbaraa437df2012-10-19 20:10:10 +0000685 llvm::Triple TargetTriple(TheModule->getTargetTriple());
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000686 std::unique_ptr<TargetLibraryInfoImpl> TLII(
687 createTLII(TargetTriple, CodeGenOpts));
Peter Collingbourne03f89072016-07-15 00:55:40 +0000688 CodeGenPasses.add(new TargetLibraryInfoWrapperPass(*TLII));
Chad Rosierb1cfc682012-02-29 20:14:59 +0000689
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000690 // Normal mode, emit a .s or .o file by running the code generator. Note,
691 // this also adds codegenerator level optimization passes.
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000692 TargetMachine::CodeGenFileType CGFT = getCodeGenFileType(Action);
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000693
694 // Add ObjC ARC final-cleanup optimizations. This is done as part of the
695 // "codegen" passes so that it isn't run multiple times when there is
696 // inlining happening.
Steven Wu1d56be82015-05-02 00:56:15 +0000697 if (CodeGenOpts.OptimizationLevel > 0)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000698 CodeGenPasses.add(createObjCARCContractPass());
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000699
Peter Collingbourne03f89072016-07-15 00:55:40 +0000700 if (TM->addPassesToEmitFile(CodeGenPasses, OS, CGFT,
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000701 /*DisableVerify=*/!CodeGenOpts.VerifyModule)) {
702 Diags.Report(diag::err_fe_unable_to_interface_with_target);
703 return false;
704 }
705
706 return true;
707}
708
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000709void EmitAssemblyHelper::EmitAssembly(BackendAction Action,
Peter Collingbourne03f89072016-07-15 00:55:40 +0000710 std::unique_ptr<raw_pwrite_stream> OS) {
Craig Topper8a13c412014-05-21 05:09:00 +0000711 TimeRegion Region(llvm::TimePassesIsEnabled ? &CodeGenerationTime : nullptr);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000712
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000713 setCommandLineOpts(CodeGenOpts);
Yaxun Liub5e80c32016-04-12 20:22:32 +0000714
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000715 bool UsesCodeGen = (Action != Backend_EmitNothing &&
716 Action != Backend_EmitBC &&
717 Action != Backend_EmitLL);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000718 CreateTargetMachine(UsesCodeGen);
Alp Tokerf4e22382013-12-20 20:26:53 +0000719
Rafael Espindolab633d202015-06-23 13:59:36 +0000720 if (UsesCodeGen && !TM)
721 return;
722 if (TM)
Mehdi Aminica3cf9e2015-07-24 16:04:29 +0000723 TheModule->setDataLayout(TM->createDataLayout());
Teresa Johnson4b4f4b92016-01-08 17:04:29 +0000724
Peter Collingbourne03f89072016-07-15 00:55:40 +0000725 legacy::PassManager PerModulePasses;
726 PerModulePasses.add(
727 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
728
729 legacy::FunctionPassManager PerFunctionPasses(TheModule);
730 PerFunctionPasses.add(
731 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
732
Teresa Johnson9e3f4742016-08-12 18:12:08 +0000733 CreatePasses(PerModulePasses, PerFunctionPasses);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000734
735 legacy::PassManager CodeGenPasses;
736 CodeGenPasses.add(
737 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
Nadav Rotemec57ab32012-10-24 00:53:38 +0000738
Teresa Johnson488d1dc2017-03-23 19:47:49 +0000739 std::unique_ptr<raw_fd_ostream> ThinLinkOS;
740
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000741 switch (Action) {
742 case Backend_EmitNothing:
743 break;
744
745 case Backend_EmitBC:
Teresa Johnson488d1dc2017-03-23 19:47:49 +0000746 if (CodeGenOpts.EmitSummaryIndex) {
747 if (!CodeGenOpts.ThinLinkBitcodeFile.empty()) {
748 std::error_code EC;
749 ThinLinkOS.reset(new llvm::raw_fd_ostream(
750 CodeGenOpts.ThinLinkBitcodeFile, EC,
751 llvm::sys::fs::F_None));
752 if (EC) {
753 Diags.Report(diag::err_fe_unable_to_open_output) << CodeGenOpts.ThinLinkBitcodeFile
754 << EC.message();
755 return;
756 }
757 }
758 PerModulePasses.add(
759 createWriteThinLTOBitcodePass(*OS, ThinLinkOS.get()));
760 }
Peter Collingbourneb8847162017-01-26 23:51:50 +0000761 else
762 PerModulePasses.add(
763 createBitcodeWriterPass(*OS, CodeGenOpts.EmitLLVMUseLists));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000764 break;
765
766 case Backend_EmitLL:
Peter Collingbourne03f89072016-07-15 00:55:40 +0000767 PerModulePasses.add(
Duncan P. N. Exon Smithbb9cadf2015-04-15 02:45:28 +0000768 createPrintModulePass(*OS, "", CodeGenOpts.EmitLLVMUseLists));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000769 break;
770
771 default:
Peter Collingbourne03f89072016-07-15 00:55:40 +0000772 if (!AddEmitPasses(CodeGenPasses, Action, *OS))
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000773 return;
774 }
775
Andrew Trick15e36e82011-04-05 18:56:55 +0000776 // Before executing passes, print the final values of the LLVM options.
777 cl::PrintOptionValues();
778
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000779 // Run passes. For now we do all passes at once, but eventually we
780 // would like to have the option of streaming code generation.
781
Peter Collingbourne03f89072016-07-15 00:55:40 +0000782 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000783 PrettyStackTraceString CrashInfo("Per-function optimization");
784
Peter Collingbourne03f89072016-07-15 00:55:40 +0000785 PerFunctionPasses.doInitialization();
Yaron Keren10d6d162015-06-05 09:40:53 +0000786 for (Function &F : *TheModule)
787 if (!F.isDeclaration())
Peter Collingbourne03f89072016-07-15 00:55:40 +0000788 PerFunctionPasses.run(F);
789 PerFunctionPasses.doFinalization();
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000790 }
791
Peter Collingbourne03f89072016-07-15 00:55:40 +0000792 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000793 PrettyStackTraceString CrashInfo("Per-module optimization passes");
Peter Collingbourne03f89072016-07-15 00:55:40 +0000794 PerModulePasses.run(*TheModule);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000795 }
796
Peter Collingbourne03f89072016-07-15 00:55:40 +0000797 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000798 PrettyStackTraceString CrashInfo("Code generation");
Peter Collingbourne03f89072016-07-15 00:55:40 +0000799 CodeGenPasses.run(*TheModule);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000800 }
801}
802
Chandler Carruth50f9e892016-12-23 20:44:01 +0000803static PassBuilder::OptimizationLevel mapToLevel(const CodeGenOptions &Opts) {
804 switch (Opts.OptimizationLevel) {
805 default:
806 llvm_unreachable("Invalid optimization level!");
807
808 case 1:
809 return PassBuilder::O1;
810
811 case 2:
812 switch (Opts.OptimizeSize) {
813 default:
814 llvm_unreachable("Invalide optimization level for size!");
815
816 case 0:
817 return PassBuilder::O2;
818
819 case 1:
820 return PassBuilder::Os;
821
822 case 2:
823 return PassBuilder::Oz;
824 }
825
826 case 3:
827 return PassBuilder::O3;
828 }
829}
830
831/// A clean version of `EmitAssembly` that uses the new pass manager.
832///
833/// Not all features are currently supported in this system, but where
834/// necessary it falls back to the legacy pass manager to at least provide
835/// basic functionality.
836///
837/// This API is planned to have its functionality finished and then to replace
838/// `EmitAssembly` at some point in the future when the default switches.
839void EmitAssemblyHelper::EmitAssemblyWithNewPassManager(
840 BackendAction Action, std::unique_ptr<raw_pwrite_stream> OS) {
841 TimeRegion Region(llvm::TimePassesIsEnabled ? &CodeGenerationTime : nullptr);
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000842 setCommandLineOpts(CodeGenOpts);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000843
844 // The new pass manager always makes a target machine available to passes
845 // during construction.
846 CreateTargetMachine(/*MustCreateTM*/ true);
847 if (!TM)
848 // This will already be diagnosed, just bail.
849 return;
850 TheModule->setDataLayout(TM->createDataLayout());
851
Dehao Chenc76a27e2017-07-27 15:29:53 +0000852 Optional<PGOOptions> PGOOpt;
Davide Italiano945de432017-02-13 16:07:05 +0000853
Dehao Chenc76a27e2017-07-27 15:29:53 +0000854 if (CodeGenOpts.hasProfileIRInstr())
855 // -fprofile-generate.
856 PGOOpt = PGOOptions(CodeGenOpts.InstrProfileOutput.empty()
857 ? DefaultProfileGenName
858 : CodeGenOpts.InstrProfileOutput,
859 "", "", true, CodeGenOpts.DebugInfoForProfiling);
860 else if (CodeGenOpts.hasProfileIRUse())
861 // -fprofile-use.
862 PGOOpt = PGOOptions("", CodeGenOpts.ProfileInstrumentUsePath, "", false,
863 CodeGenOpts.DebugInfoForProfiling);
864 else if (!CodeGenOpts.SampleProfileFile.empty())
865 // -fprofile-sample-use
866 PGOOpt = PGOOptions("", "", CodeGenOpts.SampleProfileFile, false,
867 CodeGenOpts.DebugInfoForProfiling);
868 else if (CodeGenOpts.DebugInfoForProfiling)
869 // -fdebug-info-for-profiling
870 PGOOpt = PGOOptions("", "", "", false, true);
Davide Italiano945de432017-02-13 16:07:05 +0000871
Dehao Chenc76a27e2017-07-27 15:29:53 +0000872 PassBuilder PB(TM.get(), PGOOpt);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000873
Craig Topper926b95c2017-11-14 08:48:28 +0000874 LoopAnalysisManager LAM(CodeGenOpts.DebugPassManager);
875 FunctionAnalysisManager FAM(CodeGenOpts.DebugPassManager);
876 CGSCCAnalysisManager CGAM(CodeGenOpts.DebugPassManager);
877 ModuleAnalysisManager MAM(CodeGenOpts.DebugPassManager);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000878
879 // Register the AA manager first so that our version is the one used.
880 FAM.registerPass([&] { return PB.buildDefaultAAPipeline(); });
881
Chandler Carruth9fdd5fa2017-07-25 10:46:07 +0000882 // Register the target library analysis directly and give it a customized
883 // preset TLI.
884 Triple TargetTriple(TheModule->getTargetTriple());
885 std::unique_ptr<TargetLibraryInfoImpl> TLII(
886 createTLII(TargetTriple, CodeGenOpts));
887 FAM.registerPass([&] { return TargetLibraryAnalysis(*TLII); });
888 MAM.registerPass([&] { return TargetLibraryAnalysis(*TLII); });
889
Chandler Carruth50f9e892016-12-23 20:44:01 +0000890 // Register all the basic analyses with the managers.
891 PB.registerModuleAnalyses(MAM);
892 PB.registerCGSCCAnalyses(CGAM);
893 PB.registerFunctionAnalyses(FAM);
894 PB.registerLoopAnalyses(LAM);
895 PB.crossRegisterProxies(LAM, FAM, CGAM, MAM);
896
Tim Shenb13eebe2017-06-29 23:10:13 +0000897 ModulePassManager MPM(CodeGenOpts.DebugPassManager);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000898
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000899 if (!CodeGenOpts.DisableLLVMPasses) {
Tim Shen66470692017-06-29 23:08:38 +0000900 bool IsThinLTO = CodeGenOpts.EmitSummaryIndex;
901 bool IsLTO = CodeGenOpts.PrepareForLTO;
902
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000903 if (CodeGenOpts.OptimizationLevel == 0) {
904 // Build a minimal pipeline based on the semantics required by Clang,
905 // which is just that always inlining occurs.
906 MPM.addPass(AlwaysInlinerPass());
Chandler Carrutha8bd4e32017-11-14 01:59:18 +0000907
908 // At -O0 we directly run necessary sanitizer passes.
909 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds))
910 MPM.addPass(createModuleToFunctionPassAdaptor(BoundsCheckingPass()));
911
912 // Lastly, add a semantically necessary pass for ThinLTO.
Tim Shen66470692017-06-29 23:08:38 +0000913 if (IsThinLTO)
914 MPM.addPass(NameAnonGlobalPass());
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000915 } else {
Tim Shen66470692017-06-29 23:08:38 +0000916 // Map our optimization levels into one of the distinct levels used to
917 // configure the pipeline.
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000918 PassBuilder::OptimizationLevel Level = mapToLevel(CodeGenOpts);
919
Chandler Carrutha8bd4e32017-11-14 01:59:18 +0000920 // Register callbacks to schedule sanitizer passes at the appropriate part of
921 // the pipeline.
922 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds))
923 PB.registerScalarOptimizerLateEPCallback(
924 [](FunctionPassManager &FPM, PassBuilder::OptimizationLevel Level) {
925 FPM.addPass(BoundsCheckingPass());
926 });
927
Tim Shen66470692017-06-29 23:08:38 +0000928 if (IsThinLTO) {
Tim Shenb13eebe2017-06-29 23:10:13 +0000929 MPM = PB.buildThinLTOPreLinkDefaultPipeline(
930 Level, CodeGenOpts.DebugPassManager);
Tim Shen66470692017-06-29 23:08:38 +0000931 MPM.addPass(NameAnonGlobalPass());
932 } else if (IsLTO) {
Tim Shenb13eebe2017-06-29 23:10:13 +0000933 MPM = PB.buildLTOPreLinkDefaultPipeline(Level,
934 CodeGenOpts.DebugPassManager);
Tim Shen66470692017-06-29 23:08:38 +0000935 } else {
Tim Shenb13eebe2017-06-29 23:10:13 +0000936 MPM = PB.buildPerModuleDefaultPipeline(Level,
937 CodeGenOpts.DebugPassManager);
Tim Shen66470692017-06-29 23:08:38 +0000938 }
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000939 }
Chandler Carruth50f9e892016-12-23 20:44:01 +0000940 }
941
942 // FIXME: We still use the legacy pass manager to do code generation. We
943 // create that pass manager here and use it as needed below.
944 legacy::PassManager CodeGenPasses;
945 bool NeedCodeGen = false;
Tim Shen50fedec2017-06-01 23:27:51 +0000946 Optional<raw_fd_ostream> ThinLinkOS;
Chandler Carruth50f9e892016-12-23 20:44:01 +0000947
948 // Append any output we need to the pass manager.
949 switch (Action) {
950 case Backend_EmitNothing:
951 break;
952
953 case Backend_EmitBC:
Tim Shen50fedec2017-06-01 23:27:51 +0000954 if (CodeGenOpts.EmitSummaryIndex) {
955 if (!CodeGenOpts.ThinLinkBitcodeFile.empty()) {
956 std::error_code EC;
957 ThinLinkOS.emplace(CodeGenOpts.ThinLinkBitcodeFile, EC,
958 llvm::sys::fs::F_None);
959 if (EC) {
960 Diags.Report(diag::err_fe_unable_to_open_output)
961 << CodeGenOpts.ThinLinkBitcodeFile << EC.message();
962 return;
963 }
964 }
965 MPM.addPass(
966 ThinLTOBitcodeWriterPass(*OS, ThinLinkOS ? &*ThinLinkOS : nullptr));
967 } else {
968 MPM.addPass(BitcodeWriterPass(*OS, CodeGenOpts.EmitLLVMUseLists,
969 CodeGenOpts.EmitSummaryIndex,
970 CodeGenOpts.EmitSummaryIndex));
971 }
Chandler Carruth50f9e892016-12-23 20:44:01 +0000972 break;
973
974 case Backend_EmitLL:
975 MPM.addPass(PrintModulePass(*OS, "", CodeGenOpts.EmitLLVMUseLists));
976 break;
977
978 case Backend_EmitAssembly:
979 case Backend_EmitMCNull:
980 case Backend_EmitObj:
981 NeedCodeGen = true;
982 CodeGenPasses.add(
983 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
984 if (!AddEmitPasses(CodeGenPasses, Action, *OS))
985 // FIXME: Should we handle this error differently?
986 return;
987 break;
988 }
989
990 // Before executing passes, print the final values of the LLVM options.
991 cl::PrintOptionValues();
992
993 // Now that we have all of the passes ready, run them.
994 {
995 PrettyStackTraceString CrashInfo("Optimizer");
996 MPM.run(*TheModule, MAM);
997 }
998
999 // Now if needed, run the legacy PM for codegen.
1000 if (NeedCodeGen) {
1001 PrettyStackTraceString CrashInfo("Code generation");
1002 CodeGenPasses.run(*TheModule);
1003 }
1004}
1005
Peter Collingbourne47d23642017-01-24 19:54:37 +00001006Expected<BitcodeModule> clang::FindThinLTOModule(MemoryBufferRef MBRef) {
1007 Expected<std::vector<BitcodeModule>> BMsOrErr = getBitcodeModuleList(MBRef);
1008 if (!BMsOrErr)
1009 return BMsOrErr.takeError();
1010
Peter Collingbournedbd2fed2017-06-15 17:26:13 +00001011 // The bitcode file may contain multiple modules, we want the one that is
1012 // marked as being the ThinLTO module.
Peter Collingbourne47d23642017-01-24 19:54:37 +00001013 for (BitcodeModule &BM : *BMsOrErr) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +00001014 Expected<BitcodeLTOInfo> LTOInfo = BM.getLTOInfo();
1015 if (LTOInfo && LTOInfo->IsThinLTO)
Peter Collingbourne47d23642017-01-24 19:54:37 +00001016 return BM;
1017 }
1018
1019 return make_error<StringError>("Could not find module summary",
1020 inconvertibleErrorCode());
1021}
1022
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001023static void runThinLTOBackend(ModuleSummaryIndex *CombinedIndex, Module *M,
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001024 const HeaderSearchOptions &HeaderOpts,
1025 const CodeGenOptions &CGOpts,
1026 const clang::TargetOptions &TOpts,
1027 const LangOptions &LOpts,
Dehao Chena1bd2d62017-01-13 00:51:55 +00001028 std::unique_ptr<raw_pwrite_stream> OS,
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001029 std::string SampleProfile,
1030 BackendAction Action) {
Dehao Chen5f83d0e2017-07-10 20:31:37 +00001031 StringMap<DenseMap<GlobalValue::GUID, GlobalValueSummary *>>
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001032 ModuleToDefinedGVSummaries;
1033 CombinedIndex->collectDefinedGVSummariesPerModule(ModuleToDefinedGVSummaries);
1034
David Blaikie6e2ec5f2017-04-19 20:08:21 +00001035 setCommandLineOpts(CGOpts);
1036
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001037 // We can simply import the values mentioned in the combined index, since
1038 // we should only invoke this using the individual indexes written out
1039 // via a WriteIndexesThinBackend.
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001040 FunctionImporter::ImportMapTy ImportList;
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001041 for (auto &GlobalList : *CombinedIndex) {
Peter Collingbourne9667b912017-05-04 18:03:25 +00001042 // Ignore entries for undefined references.
1043 if (GlobalList.second.SummaryList.empty())
1044 continue;
1045
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001046 auto GUID = GlobalList.first;
Peter Collingbourne9667b912017-05-04 18:03:25 +00001047 assert(GlobalList.second.SummaryList.size() == 1 &&
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001048 "Expected individual combined index to have one summary per GUID");
Peter Collingbourne9667b912017-05-04 18:03:25 +00001049 auto &Summary = GlobalList.second.SummaryList[0];
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001050 // Skip the summaries for the importing module. These are included to
1051 // e.g. record required linkage changes.
1052 if (Summary->modulePath() == M->getModuleIdentifier())
1053 continue;
1054 // Doesn't matter what value we plug in to the map, just needs an entry
1055 // to provoke importing by thinBackend.
1056 ImportList[Summary->modulePath()][GUID] = 1;
1057 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001058
1059 std::vector<std::unique_ptr<llvm::MemoryBuffer>> OwnedImports;
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001060 MapVector<llvm::StringRef, llvm::BitcodeModule> ModuleMap;
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001061
1062 for (auto &I : ImportList) {
1063 ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> MBOrErr =
1064 llvm::MemoryBuffer::getFile(I.first());
1065 if (!MBOrErr) {
1066 errs() << "Error loading imported file '" << I.first()
1067 << "': " << MBOrErr.getError().message() << "\n";
1068 return;
1069 }
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001070
Peter Collingbourne47d23642017-01-24 19:54:37 +00001071 Expected<BitcodeModule> BMOrErr = FindThinLTOModule(**MBOrErr);
1072 if (!BMOrErr) {
1073 handleAllErrors(BMOrErr.takeError(), [&](ErrorInfoBase &EIB) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001074 errs() << "Error loading imported file '" << I.first()
1075 << "': " << EIB.message() << '\n';
1076 });
1077 return;
1078 }
Peter Collingbourne47d23642017-01-24 19:54:37 +00001079 ModuleMap.insert({I.first(), *BMOrErr});
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001080
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001081 OwnedImports.push_back(std::move(*MBOrErr));
1082 }
Peter Collingbourne2d3a26f2016-09-23 21:43:51 +00001083 auto AddStream = [&](size_t Task) {
1084 return llvm::make_unique<lto::NativeObjectStream>(std::move(OS));
Mehdi Amini406aa222016-08-17 06:23:08 +00001085 };
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001086 lto::Config Conf;
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001087 Conf.CPU = TOpts.CPU;
1088 Conf.CodeModel = getCodeModel(CGOpts);
1089 Conf.MAttrs = TOpts.Features;
1090 Conf.RelocModel = getRelocModel(CGOpts);
1091 Conf.CGOptLevel = getCGOptLevel(CGOpts);
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001092 initTargetOptions(Conf.Options, CGOpts, TOpts, LOpts, HeaderOpts);
Benjamin Kramerf6021ec2017-03-21 21:35:04 +00001093 Conf.SampleProfile = std::move(SampleProfile);
Tim Shen50fedec2017-06-01 23:27:51 +00001094 Conf.UseNewPM = CGOpts.ExperimentalNewPassManager;
Teresa Johnson4cd016ab2017-11-13 15:38:33 +00001095 Conf.DebugPassManager = CGOpts.DebugPassManager;
Teresa Johnsonb637cb02017-03-31 22:35:47 +00001096 switch (Action) {
1097 case Backend_EmitNothing:
1098 Conf.PreCodeGenModuleHook = [](size_t Task, const Module &Mod) {
1099 return false;
1100 };
1101 break;
1102 case Backend_EmitLL:
1103 Conf.PreCodeGenModuleHook = [&](size_t Task, const Module &Mod) {
1104 M->print(*OS, nullptr, CGOpts.EmitLLVMUseLists);
1105 return false;
1106 };
1107 break;
1108 case Backend_EmitBC:
1109 Conf.PreCodeGenModuleHook = [&](size_t Task, const Module &Mod) {
1110 WriteBitcodeToFile(M, *OS, CGOpts.EmitLLVMUseLists);
1111 return false;
1112 };
1113 break;
1114 default:
1115 Conf.CGFileType = getCodeGenFileType(Action);
1116 break;
1117 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001118 if (Error E = thinBackend(
Peter Collingbourne2d3a26f2016-09-23 21:43:51 +00001119 Conf, 0, AddStream, *M, *CombinedIndex, ImportList,
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001120 ModuleToDefinedGVSummaries[M->getModuleIdentifier()], ModuleMap)) {
1121 handleAllErrors(std::move(E), [&](ErrorInfoBase &EIB) {
1122 errs() << "Error running ThinLTO backend: " << EIB.message() << '\n';
1123 });
1124 }
1125}
1126
David Blaikie9c902b52011-09-25 23:23:43 +00001127void clang::EmitBackendOutput(DiagnosticsEngine &Diags,
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001128 const HeaderSearchOptions &HeaderOpts,
David Blaikie9c902b52011-09-25 23:23:43 +00001129 const CodeGenOptions &CGOpts,
Nick Lewycky432add52011-12-02 22:17:00 +00001130 const clang::TargetOptions &TOpts,
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001131 const LangOptions &LOpts,
1132 const llvm::DataLayout &TDesc, Module *M,
1133 BackendAction Action,
Peter Collingbourne03f89072016-07-15 00:55:40 +00001134 std::unique_ptr<raw_pwrite_stream> OS) {
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001135 if (!CGOpts.ThinLTOIndexFile.empty()) {
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001136 // If we are performing a ThinLTO importing compile, load the function index
1137 // into memory and pass it into runThinLTOBackend, which will run the
1138 // function importer and invoke LTO passes.
1139 Expected<std::unique_ptr<ModuleSummaryIndex>> IndexOrErr =
Teresa Johnson517729f2017-05-12 19:32:17 +00001140 llvm::getModuleSummaryIndexForFile(CGOpts.ThinLTOIndexFile,
1141 /*IgnoreEmptyThinLTOIndexFile*/true);
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001142 if (!IndexOrErr) {
1143 logAllUnhandledErrors(IndexOrErr.takeError(), errs(),
1144 "Error loading index file '" +
1145 CGOpts.ThinLTOIndexFile + "': ");
1146 return;
1147 }
1148 std::unique_ptr<ModuleSummaryIndex> CombinedIndex = std::move(*IndexOrErr);
1149 // A null CombinedIndex means we should skip ThinLTO compilation
1150 // (LLVM will optionally ignore empty index files, returning null instead
1151 // of an error).
1152 bool DoThinLTOBackend = CombinedIndex != nullptr;
1153 if (DoThinLTOBackend) {
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001154 runThinLTOBackend(CombinedIndex.get(), M, HeaderOpts, CGOpts, TOpts,
1155 LOpts, std::move(OS), CGOpts.SampleProfileFile, Action);
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001156 return;
1157 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001158 }
1159
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001160 EmitAssemblyHelper AsmHelper(Diags, HeaderOpts, CGOpts, TOpts, LOpts, M);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +00001161
Chandler Carruth50f9e892016-12-23 20:44:01 +00001162 if (CGOpts.ExperimentalNewPassManager)
1163 AsmHelper.EmitAssemblyWithNewPassManager(Action, std::move(OS));
1164 else
1165 AsmHelper.EmitAssembly(Action, std::move(OS));
Alp Tokere83b9062014-01-02 15:08:04 +00001166
James Y Knightb214cbc2016-03-04 19:00:41 +00001167 // Verify clang's TargetInfo DataLayout against the LLVM TargetMachine's
1168 // DataLayout.
1169 if (AsmHelper.TM) {
Mehdi Aminica3cf9e2015-07-24 16:04:29 +00001170 std::string DLDesc = M->getDataLayout().getStringRepresentation();
James Y Knightb214cbc2016-03-04 19:00:41 +00001171 if (DLDesc != TDesc.getStringRepresentation()) {
Alp Tokere83b9062014-01-02 15:08:04 +00001172 unsigned DiagID = Diags.getCustomDiagID(
1173 DiagnosticsEngine::Error, "backend data layout '%0' does not match "
1174 "expected target description '%1'");
James Y Knightb214cbc2016-03-04 19:00:41 +00001175 Diags.Report(DiagID) << DLDesc << TDesc.getStringRepresentation();
Alp Tokere83b9062014-01-02 15:08:04 +00001176 }
1177 }
Daniel Dunbarf976d1b2010-06-07 23:20:08 +00001178}
Steven Wu27fb5222016-05-11 16:26:03 +00001179
1180static const char* getSectionNameForBitcode(const Triple &T) {
1181 switch (T.getObjectFormat()) {
1182 case Triple::MachO:
1183 return "__LLVM,__bitcode";
1184 case Triple::COFF:
1185 case Triple::ELF:
Dan Gohman839f2152017-01-17 21:46:38 +00001186 case Triple::Wasm:
Steven Wu27fb5222016-05-11 16:26:03 +00001187 case Triple::UnknownObjectFormat:
1188 return ".llvmbc";
1189 }
Simon Pilgrimbff9dae2016-05-11 21:55:37 +00001190 llvm_unreachable("Unimplemented ObjectFormatType");
Steven Wu27fb5222016-05-11 16:26:03 +00001191}
1192
1193static const char* getSectionNameForCommandline(const Triple &T) {
1194 switch (T.getObjectFormat()) {
1195 case Triple::MachO:
1196 return "__LLVM,__cmdline";
1197 case Triple::COFF:
1198 case Triple::ELF:
Dan Gohman839f2152017-01-17 21:46:38 +00001199 case Triple::Wasm:
Steven Wu27fb5222016-05-11 16:26:03 +00001200 case Triple::UnknownObjectFormat:
1201 return ".llvmcmd";
1202 }
Simon Pilgrimbff9dae2016-05-11 21:55:37 +00001203 llvm_unreachable("Unimplemented ObjectFormatType");
Steven Wu27fb5222016-05-11 16:26:03 +00001204}
1205
1206// With -fembed-bitcode, save a copy of the llvm IR as data in the
1207// __LLVM,__bitcode section.
1208void clang::EmbedBitcode(llvm::Module *M, const CodeGenOptions &CGOpts,
1209 llvm::MemoryBufferRef Buf) {
1210 if (CGOpts.getEmbedBitcode() == CodeGenOptions::Embed_Off)
1211 return;
1212
Steven Wu2c059a52016-05-16 18:54:58 +00001213 // Save llvm.compiler.used and remote it.
1214 SmallVector<Constant*, 2> UsedArray;
1215 SmallSet<GlobalValue*, 4> UsedGlobals;
1216 Type *UsedElementType = Type::getInt8Ty(M->getContext())->getPointerTo(0);
1217 GlobalVariable *Used = collectUsedGlobalVariables(*M, UsedGlobals, true);
1218 for (auto *GV : UsedGlobals) {
1219 if (GV->getName() != "llvm.embedded.module" &&
1220 GV->getName() != "llvm.cmdline")
1221 UsedArray.push_back(
1222 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
1223 }
1224 if (Used)
1225 Used->eraseFromParent();
1226
Steven Wu27fb5222016-05-11 16:26:03 +00001227 // Embed the bitcode for the llvm module.
1228 std::string Data;
1229 ArrayRef<uint8_t> ModuleData;
1230 Triple T(M->getTargetTriple());
1231 // Create a constant that contains the bitcode.
1232 // In case of embedding a marker, ignore the input Buf and use the empty
1233 // ArrayRef. It is also legal to create a bitcode marker even Buf is empty.
1234 if (CGOpts.getEmbedBitcode() != CodeGenOptions::Embed_Marker) {
1235 if (!isBitcode((const unsigned char *)Buf.getBufferStart(),
1236 (const unsigned char *)Buf.getBufferEnd())) {
1237 // If the input is LLVM Assembly, bitcode is produced by serializing
1238 // the module. Use-lists order need to be perserved in this case.
1239 llvm::raw_string_ostream OS(Data);
1240 llvm::WriteBitcodeToFile(M, OS, /* ShouldPreserveUseListOrder */ true);
1241 ModuleData =
1242 ArrayRef<uint8_t>((const uint8_t *)OS.str().data(), OS.str().size());
1243 } else
1244 // If the input is LLVM bitcode, write the input byte stream directly.
1245 ModuleData = ArrayRef<uint8_t>((const uint8_t *)Buf.getBufferStart(),
1246 Buf.getBufferSize());
1247 }
1248 llvm::Constant *ModuleConstant =
1249 llvm::ConstantDataArray::get(M->getContext(), ModuleData);
Steven Wu27fb5222016-05-11 16:26:03 +00001250 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
Steven Wu2c059a52016-05-16 18:54:58 +00001251 *M, ModuleConstant->getType(), true, llvm::GlobalValue::PrivateLinkage,
Steven Wu27fb5222016-05-11 16:26:03 +00001252 ModuleConstant);
1253 GV->setSection(getSectionNameForBitcode(T));
Steven Wu2c059a52016-05-16 18:54:58 +00001254 UsedArray.push_back(
1255 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
Steven Wu27fb5222016-05-11 16:26:03 +00001256 if (llvm::GlobalVariable *Old =
Steven Wu2c059a52016-05-16 18:54:58 +00001257 M->getGlobalVariable("llvm.embedded.module", true)) {
1258 assert(Old->hasOneUse() &&
1259 "llvm.embedded.module can only be used once in llvm.compiler.used");
Steven Wu27fb5222016-05-11 16:26:03 +00001260 GV->takeName(Old);
1261 Old->eraseFromParent();
1262 } else {
1263 GV->setName("llvm.embedded.module");
1264 }
1265
Steven Wu2c059a52016-05-16 18:54:58 +00001266 // Skip if only bitcode needs to be embedded.
1267 if (CGOpts.getEmbedBitcode() != CodeGenOptions::Embed_Bitcode) {
1268 // Embed command-line options.
Saleem Abdulrasoolb1d50c12016-05-20 03:58:12 +00001269 ArrayRef<uint8_t> CmdData(const_cast<uint8_t *>(CGOpts.CmdArgs.data()),
Steven Wu2c059a52016-05-16 18:54:58 +00001270 CGOpts.CmdArgs.size());
1271 llvm::Constant *CmdConstant =
1272 llvm::ConstantDataArray::get(M->getContext(), CmdData);
1273 GV = new llvm::GlobalVariable(*M, CmdConstant->getType(), true,
1274 llvm::GlobalValue::PrivateLinkage,
1275 CmdConstant);
1276 GV->setSection(getSectionNameForCommandline(T));
1277 UsedArray.push_back(
1278 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
1279 if (llvm::GlobalVariable *Old =
1280 M->getGlobalVariable("llvm.cmdline", true)) {
1281 assert(Old->hasOneUse() &&
1282 "llvm.cmdline can only be used once in llvm.compiler.used");
1283 GV->takeName(Old);
1284 Old->eraseFromParent();
1285 } else {
1286 GV->setName("llvm.cmdline");
1287 }
1288 }
1289
1290 if (UsedArray.empty())
Steven Wu27fb5222016-05-11 16:26:03 +00001291 return;
1292
Steven Wu2c059a52016-05-16 18:54:58 +00001293 // Recreate llvm.compiler.used.
1294 ArrayType *ATy = ArrayType::get(UsedElementType, UsedArray.size());
1295 auto *NewUsed = new GlobalVariable(
1296 *M, ATy, false, llvm::GlobalValue::AppendingLinkage,
1297 llvm::ConstantArray::get(ATy, UsedArray), "llvm.compiler.used");
1298 NewUsed->setSection("llvm.metadata");
Steven Wu27fb5222016-05-11 16:26:03 +00001299}