blob: c7557236573bc366ce1df86f52d10916f8d09bff [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"
David Blaikie7a4f7f52018-01-09 22:03:47 +000029#include "llvm/CodeGen/TargetSubtargetInfo.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000030#include "llvm/IR/DataLayout.h"
Chandler Carruth0a50c492014-01-12 11:11:50 +000031#include "llvm/IR/IRPrintingPasses.h"
Chandler Carruth9828e692015-02-13 09:57:03 +000032#include "llvm/IR/LegacyPassManager.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000033#include "llvm/IR/Module.h"
Chandler Carruth50f9e892016-12-23 20:44:01 +000034#include "llvm/IR/ModuleSummaryIndex.h"
Chandler Carruthca884742014-01-13 09:26:48 +000035#include "llvm/IR/Verifier.h"
Teresa Johnson9e3f4742016-08-12 18:12:08 +000036#include "llvm/LTO/LTOBackend.h"
Saleem Abdulrasool888e2892017-01-05 16:02:32 +000037#include "llvm/MC/MCAsmInfo.h"
Evan Chengeeb486d2011-06-29 01:14:32 +000038#include "llvm/MC/SubtargetFeature.h"
Chandler Carruth50f9e892016-12-23 20:44:01 +000039#include "llvm/Passes/PassBuilder.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000040#include "llvm/Support/CommandLine.h"
Teresa Johnson9e3f4742016-08-12 18:12:08 +000041#include "llvm/Support/MemoryBuffer.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000042#include "llvm/Support/PrettyStackTrace.h"
Evan Cheng494eb062011-08-24 18:09:14 +000043#include "llvm/Support/TargetRegistry.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000044#include "llvm/Support/Timer.h"
45#include "llvm/Support/raw_ostream.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000046#include "llvm/Target/TargetMachine.h"
47#include "llvm/Target/TargetOptions.h"
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000048#include "llvm/Transforms/Coroutines.h"
David Blaikie7a4f7f52018-01-09 22:03:47 +000049#include "llvm/Transforms/GCOVProfiler.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000050#include "llvm/Transforms/IPO.h"
Chandler Carruthb72c19f2016-08-17 03:09:11 +000051#include "llvm/Transforms/IPO/AlwaysInliner.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000052#include "llvm/Transforms/IPO/PassManagerBuilder.h"
Tim Shen50fedec2017-06-01 23:27:51 +000053#include "llvm/Transforms/IPO/ThinLTOBitcodeWriter.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000054#include "llvm/Transforms/Instrumentation.h"
Chandler Carruthafce4492017-11-14 01:47:24 +000055#include "llvm/Transforms/Instrumentation/BoundsChecking.h"
Michael Gottesman90cae772013-01-28 01:36:00 +000056#include "llvm/Transforms/ObjCARC.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000057#include "llvm/Transforms/Scalar.h"
Chandler Carruth4ddaadc2016-03-11 09:02:43 +000058#include "llvm/Transforms/Scalar/GVN.h"
Tim Shen66470692017-06-29 23:08:38 +000059#include "llvm/Transforms/Utils/NameAnonGlobals.h"
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +000060#include "llvm/Transforms/Utils/SymbolRewriter.h"
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000061#include <memory>
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000062using namespace clang;
63using namespace llvm;
64
65namespace {
66
Davide Italiano945de432017-02-13 16:07:05 +000067// Default filename used for profile generation.
68static constexpr StringLiteral DefaultProfileGenName = "default_%m.profraw";
69
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000070class EmitAssemblyHelper {
David Blaikie9c902b52011-09-25 23:23:43 +000071 DiagnosticsEngine &Diags;
Saleem Abdulrasool888e2892017-01-05 16:02:32 +000072 const HeaderSearchOptions &HSOpts;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000073 const CodeGenOptions &CodeGenOpts;
Nick Lewycky432add52011-12-02 22:17:00 +000074 const clang::TargetOptions &TargetOpts;
Dan Gohmanfec0ff82011-07-05 22:02:36 +000075 const LangOptions &LangOpts;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000076 Module *TheModule;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000077
78 Timer CodeGenerationTime;
79
Peter Collingbourne03f89072016-07-15 00:55:40 +000080 std::unique_ptr<raw_pwrite_stream> OS;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000081
Chandler Carruthd294bdb2015-02-01 12:26:23 +000082 TargetIRAnalysis getTargetIRAnalysis() const {
Chandler Carruthaab5ec02015-01-31 11:18:46 +000083 if (TM)
Chandler Carruthd294bdb2015-02-01 12:26:23 +000084 return TM->getTargetIRAnalysis();
Chandler Carruthaab5ec02015-01-31 11:18:46 +000085
Chandler Carruthd294bdb2015-02-01 12:26:23 +000086 return TargetIRAnalysis();
Chandler Carruthaab5ec02015-01-31 11:18:46 +000087 }
88
Teresa Johnson9e3f4742016-08-12 18:12:08 +000089 void CreatePasses(legacy::PassManager &MPM, legacy::FunctionPassManager &FPM);
Nadav Rotemec57ab32012-10-24 00:53:38 +000090
Rafael Espindola2f16bc12015-04-14 15:15:49 +000091 /// Generates the TargetMachine.
Peter Collingbourne03f89072016-07-15 00:55:40 +000092 /// Leaves TM unchanged if it is unable to create the target machine.
Nadav Rotemdc06b2d2012-10-24 03:52:31 +000093 /// 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.
Peter Collingbourne03f89072016-07-15 00:55:40 +000099 void CreateTargetMachine(bool MustCreateTM);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000100
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000101 /// Add passes necessary to emit assembly or LLVM IR.
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000102 ///
103 /// \return True on success.
Peter Collingbourne03f89072016-07-15 00:55:40 +0000104 bool AddEmitPasses(legacy::PassManager &CodeGenPasses, BackendAction Action,
105 raw_pwrite_stream &OS);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000106
107public:
Saleem Abdulrasool888e2892017-01-05 16:02:32 +0000108 EmitAssemblyHelper(DiagnosticsEngine &_Diags,
109 const HeaderSearchOptions &HeaderSearchOpts,
110 const CodeGenOptions &CGOpts,
Nick Lewycky432add52011-12-02 22:17:00 +0000111 const clang::TargetOptions &TOpts,
Teresa Johnson4b4f4b92016-01-08 17:04:29 +0000112 const LangOptions &LOpts, Module *M)
Saleem Abdulrasool888e2892017-01-05 16:02:32 +0000113 : Diags(_Diags), HSOpts(HeaderSearchOpts), CodeGenOpts(CGOpts),
114 TargetOpts(TOpts), LangOpts(LOpts), TheModule(M),
115 CodeGenerationTime("codegen", "Code Generation Time") {}
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000116
117 ~EmitAssemblyHelper() {
Alp Tokerf4e22382013-12-20 20:26:53 +0000118 if (CodeGenOpts.DisableFree)
David Blaikiea97eaa12014-08-29 16:53:14 +0000119 BuryPointer(std::move(TM));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000120 }
121
Ahmed Charlesb8984322014-03-07 20:03:18 +0000122 std::unique_ptr<TargetMachine> TM;
Alp Tokerf4e22382013-12-20 20:26:53 +0000123
Peter Collingbourne03f89072016-07-15 00:55:40 +0000124 void EmitAssembly(BackendAction Action,
125 std::unique_ptr<raw_pwrite_stream> OS);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000126
127 void EmitAssemblyWithNewPassManager(BackendAction Action,
128 std::unique_ptr<raw_pwrite_stream> OS);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000129};
130
Alexey Samsonovc6515b62012-12-28 09:31:34 +0000131// We need this wrapper to access LangOpts and CGOpts from extension functions
132// that we add to the PassManagerBuilder.
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000133class PassManagerBuilderWrapper : public PassManagerBuilder {
134public:
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000135 PassManagerBuilderWrapper(const Triple &TargetTriple,
136 const CodeGenOptions &CGOpts,
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000137 const LangOptions &LangOpts)
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000138 : PassManagerBuilder(), TargetTriple(TargetTriple), CGOpts(CGOpts),
139 LangOpts(LangOpts) {}
140 const Triple &getTargetTriple() const { return TargetTriple; }
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000141 const CodeGenOptions &getCGOpts() const { return CGOpts; }
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000142 const LangOptions &getLangOpts() const { return LangOpts; }
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000143
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000144private:
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000145 const Triple &TargetTriple;
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000146 const CodeGenOptions &CGOpts;
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000147 const LangOptions &LangOpts;
148};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000149}
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000150
Dan Gohman5932ce22012-01-17 20:54:51 +0000151static void addObjCARCAPElimPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
152 if (Builder.OptLevel > 0)
153 PM.add(createObjCARCAPElimPass());
154}
155
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000156static void addObjCARCExpandPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
157 if (Builder.OptLevel > 0)
158 PM.add(createObjCARCExpandPass());
159}
160
161static void addObjCARCOptPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
162 if (Builder.OptLevel > 0)
163 PM.add(createObjCARCOptPass());
164}
165
Diego Novillob56be642014-03-03 20:06:18 +0000166static void addAddDiscriminatorsPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000167 legacy::PassManagerBase &PM) {
Diego Novillob56be642014-03-03 20:06:18 +0000168 PM.add(createAddDiscriminatorsPass());
169}
170
Nuno Lopesa4255892012-05-22 17:19:45 +0000171static void addBoundsCheckingPass(const PassManagerBuilder &Builder,
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000172 legacy::PassManagerBase &PM) {
Chandler Carruth00a301d2017-11-14 01:30:04 +0000173 PM.add(createBoundsCheckingLegacyPass());
Nuno Lopesa4255892012-05-22 17:19:45 +0000174}
175
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000176static void addSanitizerCoveragePass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000177 legacy::PassManagerBase &PM) {
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000178 const PassManagerBuilderWrapper &BuilderWrapper =
179 static_cast<const PassManagerBuilderWrapper&>(Builder);
180 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
Alexey Samsonov3f3b3ab2015-05-07 18:31:29 +0000181 SanitizerCoverageOptions Opts;
182 Opts.CoverageType =
183 static_cast<SanitizerCoverageOptions::Type>(CGOpts.SanitizeCoverageType);
184 Opts.IndirectCalls = CGOpts.SanitizeCoverageIndirectCalls;
185 Opts.TraceBB = CGOpts.SanitizeCoverageTraceBB;
186 Opts.TraceCmp = CGOpts.SanitizeCoverageTraceCmp;
Kostya Serebryany3b419712016-08-30 01:27:03 +0000187 Opts.TraceDiv = CGOpts.SanitizeCoverageTraceDiv;
188 Opts.TraceGep = CGOpts.SanitizeCoverageTraceGep;
Alexey Samsonov3f3b3ab2015-05-07 18:31:29 +0000189 Opts.Use8bitCounters = CGOpts.SanitizeCoverage8bitCounters;
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000190 Opts.TracePC = CGOpts.SanitizeCoverageTracePC;
Kostya Serebryany60cdd612016-09-14 01:39:49 +0000191 Opts.TracePCGuard = CGOpts.SanitizeCoverageTracePCGuard;
Kostya Serebryany50fb6182017-05-05 23:28:18 +0000192 Opts.NoPrune = CGOpts.SanitizeCoverageNoPrune;
Kostya Serebryany2c2fb882017-06-08 22:58:19 +0000193 Opts.Inline8bitCounters = CGOpts.SanitizeCoverageInline8bitCounters;
Kostya Serebryany61457762017-07-28 00:10:10 +0000194 Opts.PCTable = CGOpts.SanitizeCoveragePCTable;
Matt Morehouse5c7fc762017-08-18 18:43:30 +0000195 Opts.StackDepth = CGOpts.SanitizeCoverageStackDepth;
Alexey Samsonov3f3b3ab2015-05-07 18:31:29 +0000196 PM.add(createSanitizerCoverageModulePass(Opts));
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000197}
198
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000199// Check if ASan should use GC-friendly instrumentation for globals.
200// First of all, there is no point if -fdata-sections is off (expect for MachO,
201// where this is not a factor). Also, on ELF this feature requires an assembler
202// extension that only works with -integrated-as at the moment.
203static bool asanUseGlobalsGC(const Triple &T, const CodeGenOptions &CGOpts) {
Evgeniy Stepanovd991cdd2017-05-09 21:57:43 +0000204 if (!CGOpts.SanitizeAddressGlobalsDeadStripping)
205 return false;
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000206 switch (T.getObjectFormat()) {
207 case Triple::MachO:
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000208 case Triple::COFF:
Evgeniy Stepanovc7b90942017-04-26 00:51:06 +0000209 return true;
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000210 case Triple::ELF:
211 return CGOpts.DataSections && !CGOpts.DisableIntegratedAS;
212 default:
213 return false;
214 }
215}
216
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000217static void addAddressSanitizerPasses(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000218 legacy::PassManagerBase &PM) {
Yury Gribov5bfeca12015-11-11 10:45:48 +0000219 const PassManagerBuilderWrapper &BuilderWrapper =
220 static_cast<const PassManagerBuilderWrapper&>(Builder);
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000221 const Triple &T = BuilderWrapper.getTargetTriple();
Yury Gribov5bfeca12015-11-11 10:45:48 +0000222 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
223 bool Recover = CGOpts.SanitizeRecover.has(SanitizerKind::Address);
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000224 bool UseAfterScope = CGOpts.SanitizeAddressUseAfterScope;
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000225 bool UseGlobalsGC = asanUseGlobalsGC(T, CGOpts);
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000226 PM.add(createAddressSanitizerFunctionPass(/*CompileKernel*/ false, Recover,
227 UseAfterScope));
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000228 PM.add(createAddressSanitizerModulePass(/*CompileKernel*/ false, Recover,
229 UseGlobalsGC));
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000230}
231
232static void addKernelAddressSanitizerPasses(const PassManagerBuilder &Builder,
233 legacy::PassManagerBase &PM) {
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000234 PM.add(createAddressSanitizerFunctionPass(
235 /*CompileKernel*/ true,
236 /*Recover*/ true, /*UseAfterScope*/ false));
Yury Gribov5bfeca12015-11-11 10:45:48 +0000237 PM.add(createAddressSanitizerModulePass(/*CompileKernel*/true,
238 /*Recover*/true));
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000239}
240
Evgeniy Stepanov12817e52017-12-09 01:32:07 +0000241static void addHWAddressSanitizerPasses(const PassManagerBuilder &Builder,
242 legacy::PassManagerBase &PM) {
Evgeniy Stepanov3fd1b1a2017-12-20 19:05:44 +0000243 const PassManagerBuilderWrapper &BuilderWrapper =
244 static_cast<const PassManagerBuilderWrapper &>(Builder);
245 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
246 bool Recover = CGOpts.SanitizeRecover.has(SanitizerKind::HWAddress);
247 PM.add(createHWAddressSanitizerPass(Recover));
Evgeniy Stepanov12817e52017-12-09 01:32:07 +0000248}
249
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000250static void addMemorySanitizerPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000251 legacy::PassManagerBase &PM) {
Evgeniy Stepanovad8ab3d2012-12-24 08:42:34 +0000252 const PassManagerBuilderWrapper &BuilderWrapper =
253 static_cast<const PassManagerBuilderWrapper&>(Builder);
254 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
Evgeniy Stepanov5b5370a2016-11-07 21:02:11 +0000255 int TrackOrigins = CGOpts.SanitizeMemoryTrackOrigins;
256 bool Recover = CGOpts.SanitizeRecover.has(SanitizerKind::Memory);
257 PM.add(createMemorySanitizerPass(TrackOrigins, Recover));
Evgeniy Stepanov10284672013-01-31 09:53:29 +0000258
259 // MemorySanitizer inserts complex instrumentation that mostly follows
260 // the logic of the original code, but operates on "shadow" values.
261 // It can benefit from re-running some general purpose optimization passes.
262 if (Builder.OptLevel > 0) {
263 PM.add(createEarlyCSEPass());
264 PM.add(createReassociatePass());
265 PM.add(createLICMPass());
266 PM.add(createGVNPass());
267 PM.add(createInstructionCombiningPass());
268 PM.add(createDeadStoreEliminationPass());
269 }
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000270}
271
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000272static void addThreadSanitizerPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000273 legacy::PassManagerBase &PM) {
Alexey Samsonov1cf07ea2014-06-02 18:08:08 +0000274 PM.add(createThreadSanitizerPass());
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000275}
276
Peter Collingbournec3772752013-08-07 22:47:34 +0000277static void addDataFlowSanitizerPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000278 legacy::PassManagerBase &PM) {
Peter Collingbourne276be3c2013-08-14 18:54:18 +0000279 const PassManagerBuilderWrapper &BuilderWrapper =
280 static_cast<const PassManagerBuilderWrapper&>(Builder);
Alexey Samsonovae5804f2014-10-15 20:22:54 +0000281 const LangOptions &LangOpts = BuilderWrapper.getLangOpts();
Alexey Samsonova511cdd2015-02-04 17:40:08 +0000282 PM.add(createDataFlowSanitizerPass(LangOpts.SanitizerBlacklistFiles));
Peter Collingbournec3772752013-08-07 22:47:34 +0000283}
284
Derek Bruening256c2e12016-04-21 21:32:04 +0000285static void addEfficiencySanitizerPass(const PassManagerBuilder &Builder,
286 legacy::PassManagerBase &PM) {
287 const PassManagerBuilderWrapper &BuilderWrapper =
288 static_cast<const PassManagerBuilderWrapper&>(Builder);
289 const LangOptions &LangOpts = BuilderWrapper.getLangOpts();
290 EfficiencySanitizerOptions Opts;
291 if (LangOpts.Sanitize.has(SanitizerKind::EfficiencyCacheFrag))
292 Opts.ToolType = EfficiencySanitizerOptions::ESAN_CacheFrag;
Derek Bruening293772e2016-05-25 00:41:24 +0000293 else if (LangOpts.Sanitize.has(SanitizerKind::EfficiencyWorkingSet))
294 Opts.ToolType = EfficiencySanitizerOptions::ESAN_WorkingSet;
Derek Bruening256c2e12016-04-21 21:32:04 +0000295 PM.add(createEfficiencySanitizerPass(Opts));
296}
297
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000298static TargetLibraryInfoImpl *createTLII(llvm::Triple &TargetTriple,
299 const CodeGenOptions &CodeGenOpts) {
300 TargetLibraryInfoImpl *TLII = new TargetLibraryInfoImpl(TargetTriple);
Rafael Espindolab8a71c52014-08-21 17:58:42 +0000301 if (!CodeGenOpts.SimplifyLibCalls)
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000302 TLII->disableAllFunctions();
Chad Rosier7dbc9cf2016-01-06 14:35:46 +0000303 else {
304 // Disable individual libc/libm calls in TargetLibraryInfo.
David L. Jones7a7dd032017-01-23 23:16:58 +0000305 LibFunc F;
Chad Rosier7dbc9cf2016-01-06 14:35:46 +0000306 for (auto &FuncName : CodeGenOpts.getNoBuiltinFuncs())
307 if (TLII->getLibFunc(FuncName, F))
308 TLII->setUnavailable(F);
309 }
Michael Zolotukhinc888dd02015-03-17 20:03:11 +0000310
311 switch (CodeGenOpts.getVecLib()) {
312 case CodeGenOptions::Accelerate:
313 TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::Accelerate);
314 break;
Matt Masten6731dea2016-07-29 16:44:24 +0000315 case CodeGenOptions::SVML:
316 TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::SVML);
317 break;
Michael Zolotukhinc888dd02015-03-17 20:03:11 +0000318 default:
319 break;
320 }
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000321 return TLII;
Rafael Espindolab8a71c52014-08-21 17:58:42 +0000322}
323
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000324static void addSymbolRewriterPass(const CodeGenOptions &Opts,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000325 legacy::PassManager *MPM) {
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000326 llvm::SymbolRewriter::RewriteDescriptorList DL;
327
328 llvm::SymbolRewriter::RewriteMapParser MapParser;
329 for (const auto &MapFile : Opts.RewriteMapFiles)
330 MapParser.parse(MapFile, &DL);
331
332 MPM->add(createRewriteSymbolsPass(DL));
333}
334
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000335static CodeGenOpt::Level getCGOptLevel(const CodeGenOptions &CodeGenOpts) {
336 switch (CodeGenOpts.OptimizationLevel) {
337 default:
338 llvm_unreachable("Invalid optimization level!");
339 case 0:
340 return CodeGenOpt::None;
341 case 1:
342 return CodeGenOpt::Less;
343 case 2:
344 return CodeGenOpt::Default; // O2/Os/Oz
345 case 3:
346 return CodeGenOpt::Aggressive;
347 }
348}
349
Rafael Espindolaaa0226e2017-08-03 02:16:28 +0000350static Optional<llvm::CodeModel::Model>
351getCodeModel(const CodeGenOptions &CodeGenOpts) {
352 unsigned CodeModel = llvm::StringSwitch<unsigned>(CodeGenOpts.CodeModel)
353 .Case("small", llvm::CodeModel::Small)
354 .Case("kernel", llvm::CodeModel::Kernel)
355 .Case("medium", llvm::CodeModel::Medium)
356 .Case("large", llvm::CodeModel::Large)
357 .Case("default", ~1u)
358 .Default(~0u);
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000359 assert(CodeModel != ~0u && "invalid code model!");
Rafael Espindolaaa0226e2017-08-03 02:16:28 +0000360 if (CodeModel == ~1u)
361 return None;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000362 return static_cast<llvm::CodeModel::Model>(CodeModel);
363}
364
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000365static TargetMachine::CodeGenFileType getCodeGenFileType(BackendAction Action) {
366 if (Action == Backend_EmitObj)
367 return TargetMachine::CGFT_ObjectFile;
368 else if (Action == Backend_EmitMCNull)
369 return TargetMachine::CGFT_Null;
370 else {
371 assert(Action == Backend_EmitAssembly && "Invalid action!");
372 return TargetMachine::CGFT_AssemblyFile;
373 }
374}
375
376static void initTargetOptions(llvm::TargetOptions &Options,
377 const CodeGenOptions &CodeGenOpts,
378 const clang::TargetOptions &TargetOpts,
379 const LangOptions &LangOpts,
380 const HeaderSearchOptions &HSOpts) {
381 Options.ThreadModel =
382 llvm::StringSwitch<llvm::ThreadModel::Model>(CodeGenOpts.ThreadModel)
383 .Case("posix", llvm::ThreadModel::POSIX)
384 .Case("single", llvm::ThreadModel::Single);
385
386 // Set float ABI type.
387 assert((CodeGenOpts.FloatABI == "soft" || CodeGenOpts.FloatABI == "softfp" ||
388 CodeGenOpts.FloatABI == "hard" || CodeGenOpts.FloatABI.empty()) &&
389 "Invalid Floating Point ABI!");
390 Options.FloatABIType =
391 llvm::StringSwitch<llvm::FloatABI::ABIType>(CodeGenOpts.FloatABI)
392 .Case("soft", llvm::FloatABI::Soft)
393 .Case("softfp", llvm::FloatABI::Soft)
394 .Case("hard", llvm::FloatABI::Hard)
395 .Default(llvm::FloatABI::Default);
396
397 // Set FP fusion mode.
398 switch (LangOpts.getDefaultFPContractMode()) {
399 case LangOptions::FPC_Off:
Adam Nemet03af4242017-04-20 17:09:35 +0000400 // Preserve any contraction performed by the front-end. (Strict performs
401 // splitting of the muladd instrinsic in the backend.)
402 Options.AllowFPOpFusion = llvm::FPOpFusion::Standard;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000403 break;
404 case LangOptions::FPC_On:
405 Options.AllowFPOpFusion = llvm::FPOpFusion::Standard;
406 break;
407 case LangOptions::FPC_Fast:
408 Options.AllowFPOpFusion = llvm::FPOpFusion::Fast;
409 break;
410 }
411
412 Options.UseInitArray = CodeGenOpts.UseInitArray;
413 Options.DisableIntegratedAS = CodeGenOpts.DisableIntegratedAS;
Saleem Abdulrasool54448902017-06-09 00:40:30 +0000414 Options.CompressDebugSections = CodeGenOpts.getCompressDebugSections();
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000415 Options.RelaxELFRelocations = CodeGenOpts.RelaxELFRelocations;
416
417 // Set EABI version.
Yuka Takahashidc771502017-07-01 07:57:23 +0000418 Options.EABIVersion = TargetOpts.EABIVersion;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000419
420 if (LangOpts.SjLjExceptions)
421 Options.ExceptionModel = llvm::ExceptionHandling::SjLj;
Martell Malonec950c652017-11-29 07:25:12 +0000422 if (LangOpts.SEHExceptions)
423 Options.ExceptionModel = llvm::ExceptionHandling::WinEH;
424 if (LangOpts.DWARFExceptions)
425 Options.ExceptionModel = llvm::ExceptionHandling::DwarfCFI;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000426
427 Options.NoInfsFPMath = CodeGenOpts.NoInfsFPMath;
428 Options.NoNaNsFPMath = CodeGenOpts.NoNaNsFPMath;
429 Options.NoZerosInBSS = CodeGenOpts.NoZeroInitializedInBSS;
430 Options.UnsafeFPMath = CodeGenOpts.UnsafeFPMath;
431 Options.StackAlignmentOverride = CodeGenOpts.StackAlignment;
432 Options.FunctionSections = CodeGenOpts.FunctionSections;
433 Options.DataSections = CodeGenOpts.DataSections;
434 Options.UniqueSectionNames = CodeGenOpts.UniqueSectionNames;
435 Options.EmulatedTLS = CodeGenOpts.EmulatedTLS;
436 Options.DebuggerTuning = CodeGenOpts.getDebuggerTuning();
Sean Eveson5110d4f2018-01-08 13:42:26 +0000437 Options.EmitStackSizeSection = CodeGenOpts.StackSizeSection;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000438
David Blaikie81503552017-04-21 23:35:36 +0000439 if (CodeGenOpts.EnableSplitDwarf)
440 Options.MCOptions.SplitDwarfFile = CodeGenOpts.SplitDwarfFile;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000441 Options.MCOptions.MCRelaxAll = CodeGenOpts.RelaxAll;
442 Options.MCOptions.MCSaveTempLabels = CodeGenOpts.SaveTempLabels;
443 Options.MCOptions.MCUseDwarfDirectory = !CodeGenOpts.NoDwarfDirectoryAsm;
444 Options.MCOptions.MCNoExecStack = CodeGenOpts.NoExecStack;
445 Options.MCOptions.MCIncrementalLinkerCompatible =
446 CodeGenOpts.IncrementalLinkerCompatible;
447 Options.MCOptions.MCPIECopyRelocations = CodeGenOpts.PIECopyRelocations;
448 Options.MCOptions.MCFatalWarnings = CodeGenOpts.FatalWarnings;
449 Options.MCOptions.AsmVerbose = CodeGenOpts.AsmVerbose;
450 Options.MCOptions.PreserveAsmComments = CodeGenOpts.PreserveAsmComments;
451 Options.MCOptions.ABIName = TargetOpts.ABI;
452 for (const auto &Entry : HSOpts.UserEntries)
453 if (!Entry.IsFramework &&
454 (Entry.Group == frontend::IncludeDirGroup::Quoted ||
455 Entry.Group == frontend::IncludeDirGroup::Angled ||
456 Entry.Group == frontend::IncludeDirGroup::System))
457 Options.MCOptions.IASSearchPaths.push_back(
458 Entry.IgnoreSysRoot ? Entry.Path : HSOpts.Sysroot + Entry.Path);
459}
David Blaikie7a4f7f52018-01-09 22:03:47 +0000460static Optional<GCOVOptions> getGCOVOptions(const CodeGenOptions &CodeGenOpts) {
461 if (CodeGenOpts.DisableGCov)
462 return None;
463 if (!CodeGenOpts.EmitGcovArcs && !CodeGenOpts.EmitGcovNotes)
464 return None;
465 // Not using 'GCOVOptions::getDefault' allows us to avoid exiting if
466 // LLVM's -default-gcov-version flag is set to something invalid.
467 GCOVOptions Options;
468 Options.EmitNotes = CodeGenOpts.EmitGcovNotes;
469 Options.EmitData = CodeGenOpts.EmitGcovArcs;
470 llvm::copy(CodeGenOpts.CoverageVersion, std::begin(Options.Version));
471 Options.UseCfgChecksum = CodeGenOpts.CoverageExtraChecksum;
472 Options.NoRedZone = CodeGenOpts.DisableRedZone;
473 Options.FunctionNamesInData = !CodeGenOpts.CoverageNoFunctionNamesInData;
474 Options.ExitBlockBeforeBody = CodeGenOpts.CoverageExitBlockBeforeBody;
475 return Options;
476}
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000477
Peter Collingbourne03f89072016-07-15 00:55:40 +0000478void EmitAssemblyHelper::CreatePasses(legacy::PassManager &MPM,
Teresa Johnson9e3f4742016-08-12 18:12:08 +0000479 legacy::FunctionPassManager &FPM) {
Chandler Carruth93786da2016-12-23 00:23:01 +0000480 // Handle disabling of all LLVM passes, where we want to preserve the
481 // internal module before any optimization.
Steven Wu546a1962015-07-17 20:09:56 +0000482 if (CodeGenOpts.DisableLLVMPasses)
483 return;
484
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000485 // Figure out TargetLibraryInfo. This needs to be added to MPM and FPM
486 // manually (and not via PMBuilder), since some passes (eg. InstrProfiling)
487 // are inserted before PMBuilder ones - they'd get the default-constructed
488 // TLI with an unknown target otherwise.
Teresa Johnsonaff22322015-12-07 19:21:34 +0000489 Triple TargetTriple(TheModule->getTargetTriple());
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000490 std::unique_ptr<TargetLibraryInfoImpl> TLII(
491 createTLII(TargetTriple, CodeGenOpts));
Teresa Johnsonaff22322015-12-07 19:21:34 +0000492
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000493 PassManagerBuilderWrapper PMBuilder(TargetTriple, CodeGenOpts, LangOpts);
494
Chandler Carruthfcd33142016-12-23 01:24:49 +0000495 // At O0 and O1 we only run the always inliner which is more efficient. At
496 // higher optimization levels we run the normal inliner.
497 if (CodeGenOpts.OptimizationLevel <= 1) {
Mehdi Amini7f873072017-01-06 23:18:09 +0000498 bool InsertLifetimeIntrinsics = (CodeGenOpts.OptimizationLevel != 0 &&
499 !CodeGenOpts.DisableLifetimeMarkers);
Chandler Carruthfcd33142016-12-23 01:24:49 +0000500 PMBuilder.Inliner = createAlwaysInlinerLegacyPass(InsertLifetimeIntrinsics);
501 } else {
Dehao Chence39fdd2017-03-21 19:55:46 +0000502 // We do not want to inline hot callsites for SamplePGO module-summary build
503 // because profile annotation will happen again in ThinLTO backend, and we
504 // want the IR of the hot path to match the profile.
Chandler Carruthfcd33142016-12-23 01:24:49 +0000505 PMBuilder.Inliner = createFunctionInliningPass(
Dehao Chence39fdd2017-03-21 19:55:46 +0000506 CodeGenOpts.OptimizationLevel, CodeGenOpts.OptimizeSize,
507 (!CodeGenOpts.SampleProfileFile.empty() &&
508 CodeGenOpts.EmitSummaryIndex));
Teresa Johnsonaff22322015-12-07 19:21:34 +0000509 }
510
Chandler Carruthfcd33142016-12-23 01:24:49 +0000511 PMBuilder.OptLevel = CodeGenOpts.OptimizationLevel;
Chris Lattnerecf0ba52011-05-21 23:50:44 +0000512 PMBuilder.SizeLevel = CodeGenOpts.OptimizeSize;
Nick Lewyckyd3f3e4f2013-06-25 01:49:44 +0000513 PMBuilder.SLPVectorize = CodeGenOpts.VectorizeSLP;
514 PMBuilder.LoopVectorize = CodeGenOpts.VectorizeLoop;
Andrew Trickb2a84722011-04-05 18:49:32 +0000515
Chris Lattnerecf0ba52011-05-21 23:50:44 +0000516 PMBuilder.DisableUnrollLoops = !CodeGenOpts.UnrollLoops;
Nick Lewyckyf04f2372014-10-24 00:49:29 +0000517 PMBuilder.MergeFunctions = CodeGenOpts.MergeFunctions;
Teresa Johnsona0d29402016-03-15 00:04:44 +0000518 PMBuilder.PrepareForThinLTO = CodeGenOpts.EmitSummaryIndex;
Teresa Johnson8749d8042015-07-06 16:23:00 +0000519 PMBuilder.PrepareForLTO = CodeGenOpts.PrepareForLTO;
Hal Finkelce0697f2013-11-17 16:03:29 +0000520 PMBuilder.RerollLoops = CodeGenOpts.RerollLoops;
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000521
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000522 MPM.add(new TargetLibraryInfoWrapperPass(*TLII));
523
Justin Lebar5a7df9c2016-04-27 19:12:56 +0000524 if (TM)
Stanislav Mekhanoshin61da0672017-01-26 16:49:21 +0000525 TM->adjustPassManager(PMBuilder);
Justin Lebar5a7df9c2016-04-27 19:12:56 +0000526
Dehao Chen7810d4f2017-02-21 20:36:21 +0000527 if (CodeGenOpts.DebugInfoForProfiling ||
528 !CodeGenOpts.SampleProfileFile.empty())
529 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
530 addAddDiscriminatorsPass);
Diego Novillob56be642014-03-03 20:06:18 +0000531
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000532 // In ObjC ARC mode, add the main ARC optimization passes.
533 if (LangOpts.ObjCAutoRefCount) {
534 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
535 addObjCARCExpandPass);
Dan Gohman5932ce22012-01-17 20:54:51 +0000536 PMBuilder.addExtension(PassManagerBuilder::EP_ModuleOptimizerEarly,
537 addObjCARCAPElimPass);
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000538 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
539 addObjCARCOptPass);
540 }
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000541
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000542 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds)) {
Nuno Lopesa4255892012-05-22 17:19:45 +0000543 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
544 addBoundsCheckingPass);
545 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
546 addBoundsCheckingPass);
547 }
548
Alexey Samsonovdfa908c2015-05-07 22:34:06 +0000549 if (CodeGenOpts.SanitizeCoverageType ||
550 CodeGenOpts.SanitizeCoverageIndirectCalls ||
551 CodeGenOpts.SanitizeCoverageTraceCmp) {
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000552 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
553 addSanitizerCoveragePass);
554 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
555 addSanitizerCoveragePass);
556 }
557
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000558 if (LangOpts.Sanitize.has(SanitizerKind::Address)) {
Kostya Serebryany7e247f22012-10-15 14:22:56 +0000559 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000560 addAddressSanitizerPasses);
Kostya Serebryanyd4768572011-11-30 22:20:21 +0000561 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000562 addAddressSanitizerPasses);
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000563 }
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000564
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000565 if (LangOpts.Sanitize.has(SanitizerKind::KernelAddress)) {
566 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
567 addKernelAddressSanitizerPasses);
568 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
569 addKernelAddressSanitizerPasses);
570 }
571
Evgeniy Stepanov12817e52017-12-09 01:32:07 +0000572 if (LangOpts.Sanitize.has(SanitizerKind::HWAddress)) {
573 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
574 addHWAddressSanitizerPasses);
575 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
576 addHWAddressSanitizerPasses);
577 }
578
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000579 if (LangOpts.Sanitize.has(SanitizerKind::Memory)) {
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000580 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
581 addMemorySanitizerPass);
582 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
583 addMemorySanitizerPass);
584 }
585
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000586 if (LangOpts.Sanitize.has(SanitizerKind::Thread)) {
Kostya Serebryanyd18cb502012-03-23 23:25:23 +0000587 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000588 addThreadSanitizerPass);
589 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
590 addThreadSanitizerPass);
591 }
592
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000593 if (LangOpts.Sanitize.has(SanitizerKind::DataFlow)) {
Peter Collingbournec3772752013-08-07 22:47:34 +0000594 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
595 addDataFlowSanitizerPass);
596 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
597 addDataFlowSanitizerPass);
598 }
599
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000600 if (LangOpts.CoroutinesTS)
601 addCoroutinePassesToExtensionPoints(PMBuilder);
602
Derek Bruening256c2e12016-04-21 21:32:04 +0000603 if (LangOpts.Sanitize.hasOneOf(SanitizerKind::Efficiency)) {
604 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
605 addEfficiencySanitizerPass);
606 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
607 addEfficiencySanitizerPass);
608 }
609
Chris Lattner5c123672011-05-21 20:40:11 +0000610 // Set up the per-function pass manager.
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000611 FPM.add(new TargetLibraryInfoWrapperPass(*TLII));
Chris Lattner5c123672011-05-21 20:40:11 +0000612 if (CodeGenOpts.VerifyModule)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000613 FPM.add(createVerifierPass());
Andrew Trickb2a84722011-04-05 18:49:32 +0000614
Chris Lattner5c123672011-05-21 20:40:11 +0000615 // Set up the per-module pass manager.
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000616 if (!CodeGenOpts.RewriteMapFiles.empty())
Peter Collingbourne03f89072016-07-15 00:55:40 +0000617 addSymbolRewriterPass(CodeGenOpts, &MPM);
Chris Lattnerd98cec52011-02-18 22:20:38 +0000618
David Blaikie7a4f7f52018-01-09 22:03:47 +0000619 if (Optional<GCOVOptions> Options = getGCOVOptions(CodeGenOpts)) {
620 MPM.add(createGCOVProfilerPass(*Options));
Benjamin Kramer8c305922016-02-02 11:06:51 +0000621 if (CodeGenOpts.getDebugInfo() == codegenoptions::NoDebugInfo)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000622 MPM.add(createStripSymbolsPass(true));
Nick Lewycky207bce32011-04-21 23:44:07 +0000623 }
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000624
Rong Xu9837ef52016-02-04 18:39:09 +0000625 if (CodeGenOpts.hasProfileClangInstr()) {
Justin Bogner970ac602014-12-08 19:04:51 +0000626 InstrProfOptions Options;
627 Options.NoRedZone = CodeGenOpts.DisableRedZone;
Justin Bognera71e6812015-04-30 23:49:42 +0000628 Options.InstrProfileOutput = CodeGenOpts.InstrProfileOutput;
Peter Collingbourne03f89072016-07-15 00:55:40 +0000629 MPM.add(createInstrProfilingLegacyPass(Options));
Justin Bogner970ac602014-12-08 19:04:51 +0000630 }
Rong Xu522b5cb2016-02-29 18:54:59 +0000631 if (CodeGenOpts.hasProfileIRInstr()) {
Xinliang David Lib65f8ae2016-07-23 04:28:59 +0000632 PMBuilder.EnablePGOInstrGen = true;
Rong Xu522b5cb2016-02-29 18:54:59 +0000633 if (!CodeGenOpts.InstrProfileOutput.empty())
634 PMBuilder.PGOInstrGen = CodeGenOpts.InstrProfileOutput;
635 else
Davide Italiano945de432017-02-13 16:07:05 +0000636 PMBuilder.PGOInstrGen = DefaultProfileGenName;
Rong Xu522b5cb2016-02-29 18:54:59 +0000637 }
Rong Xu9c6f1532016-03-02 20:59:36 +0000638 if (CodeGenOpts.hasProfileIRUse())
639 PMBuilder.PGOInstrUse = CodeGenOpts.ProfileInstrumentUsePath;
Justin Bogner970ac602014-12-08 19:04:51 +0000640
Dehao Chen5717aff2016-12-14 21:41:04 +0000641 if (!CodeGenOpts.SampleProfileFile.empty())
642 PMBuilder.PGOSampleUse = CodeGenOpts.SampleProfileFile;
Diego Novillod3ef1082015-08-25 15:25:13 +0000643
Peter Collingbourne03f89072016-07-15 00:55:40 +0000644 PMBuilder.populateFunctionPassManager(FPM);
645 PMBuilder.populateModulePassManager(MPM);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000646}
647
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000648static void setCommandLineOpts(const CodeGenOptions &CodeGenOpts) {
Yaxun Liub5e80c32016-04-12 20:22:32 +0000649 SmallVector<const char *, 16> BackendArgs;
650 BackendArgs.push_back("clang"); // Fake program name.
651 if (!CodeGenOpts.DebugPass.empty()) {
652 BackendArgs.push_back("-debug-pass");
653 BackendArgs.push_back(CodeGenOpts.DebugPass.c_str());
654 }
655 if (!CodeGenOpts.LimitFloatPrecision.empty()) {
656 BackendArgs.push_back("-limit-float-precision");
657 BackendArgs.push_back(CodeGenOpts.LimitFloatPrecision.c_str());
658 }
659 for (const std::string &BackendOption : CodeGenOpts.BackendOptions)
660 BackendArgs.push_back(BackendOption.c_str());
661 BackendArgs.push_back(nullptr);
662 llvm::cl::ParseCommandLineOptions(BackendArgs.size() - 1,
663 BackendArgs.data());
664}
665
Peter Collingbourne03f89072016-07-15 00:55:40 +0000666void EmitAssemblyHelper::CreateTargetMachine(bool MustCreateTM) {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000667 // Create the TargetMachine for generating code.
668 std::string Error;
669 std::string Triple = TheModule->getTargetTriple();
670 const llvm::Target *TheTarget = TargetRegistry::lookupTarget(Triple, Error);
671 if (!TheTarget) {
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000672 if (MustCreateTM)
Chad Rosierecafbe62013-03-27 00:14:35 +0000673 Diags.Report(diag::err_fe_unable_to_create_target) << Error;
Peter Collingbourne03f89072016-07-15 00:55:40 +0000674 return;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000675 }
676
Rafael Espindolaaa0226e2017-08-03 02:16:28 +0000677 Optional<llvm::CodeModel::Model> CM = getCodeModel(CodeGenOpts);
Eric Christopher583a1f72015-09-26 01:25:08 +0000678 std::string FeaturesStr =
679 llvm::join(TargetOpts.Features.begin(), TargetOpts.Features.end(), ",");
Rafael Espindolae1d70532018-01-18 00:20:03 +0000680 llvm::Reloc::Model RM = CodeGenOpts.RelocationModel;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000681 CodeGenOpt::Level OptLevel = getCGOptLevel(CodeGenOpts);
Evan Chengdd286bc2011-11-16 08:38:55 +0000682
Nick Lewycky432add52011-12-02 22:17:00 +0000683 llvm::TargetOptions Options;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000684 initTargetOptions(Options, CodeGenOpts, TargetOpts, LangOpts, HSOpts);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000685 TM.reset(TheTarget->createTargetMachine(Triple, TargetOpts.CPU, FeaturesStr,
686 Options, RM, CM, OptLevel));
Nadav Rotemec57ab32012-10-24 00:53:38 +0000687}
688
Peter Collingbourne03f89072016-07-15 00:55:40 +0000689bool EmitAssemblyHelper::AddEmitPasses(legacy::PassManager &CodeGenPasses,
690 BackendAction Action,
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000691 raw_pwrite_stream &OS) {
Chad Rosierb1cfc682012-02-29 20:14:59 +0000692 // Add LibraryInfo.
Daniel Dunbaraa437df2012-10-19 20:10:10 +0000693 llvm::Triple TargetTriple(TheModule->getTargetTriple());
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000694 std::unique_ptr<TargetLibraryInfoImpl> TLII(
695 createTLII(TargetTriple, CodeGenOpts));
Peter Collingbourne03f89072016-07-15 00:55:40 +0000696 CodeGenPasses.add(new TargetLibraryInfoWrapperPass(*TLII));
Chad Rosierb1cfc682012-02-29 20:14:59 +0000697
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000698 // Normal mode, emit a .s or .o file by running the code generator. Note,
699 // this also adds codegenerator level optimization passes.
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000700 TargetMachine::CodeGenFileType CGFT = getCodeGenFileType(Action);
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000701
702 // Add ObjC ARC final-cleanup optimizations. This is done as part of the
703 // "codegen" passes so that it isn't run multiple times when there is
704 // inlining happening.
Steven Wu1d56be82015-05-02 00:56:15 +0000705 if (CodeGenOpts.OptimizationLevel > 0)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000706 CodeGenPasses.add(createObjCARCContractPass());
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000707
Peter Collingbourne03f89072016-07-15 00:55:40 +0000708 if (TM->addPassesToEmitFile(CodeGenPasses, OS, CGFT,
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000709 /*DisableVerify=*/!CodeGenOpts.VerifyModule)) {
710 Diags.Report(diag::err_fe_unable_to_interface_with_target);
711 return false;
712 }
713
714 return true;
715}
716
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000717void EmitAssemblyHelper::EmitAssembly(BackendAction Action,
Peter Collingbourne03f89072016-07-15 00:55:40 +0000718 std::unique_ptr<raw_pwrite_stream> OS) {
Craig Topper8a13c412014-05-21 05:09:00 +0000719 TimeRegion Region(llvm::TimePassesIsEnabled ? &CodeGenerationTime : nullptr);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000720
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000721 setCommandLineOpts(CodeGenOpts);
Yaxun Liub5e80c32016-04-12 20:22:32 +0000722
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000723 bool UsesCodeGen = (Action != Backend_EmitNothing &&
724 Action != Backend_EmitBC &&
725 Action != Backend_EmitLL);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000726 CreateTargetMachine(UsesCodeGen);
Alp Tokerf4e22382013-12-20 20:26:53 +0000727
Rafael Espindolab633d202015-06-23 13:59:36 +0000728 if (UsesCodeGen && !TM)
729 return;
730 if (TM)
Mehdi Aminica3cf9e2015-07-24 16:04:29 +0000731 TheModule->setDataLayout(TM->createDataLayout());
Teresa Johnson4b4f4b92016-01-08 17:04:29 +0000732
Peter Collingbourne03f89072016-07-15 00:55:40 +0000733 legacy::PassManager PerModulePasses;
734 PerModulePasses.add(
735 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
736
737 legacy::FunctionPassManager PerFunctionPasses(TheModule);
738 PerFunctionPasses.add(
739 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
740
Teresa Johnson9e3f4742016-08-12 18:12:08 +0000741 CreatePasses(PerModulePasses, PerFunctionPasses);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000742
743 legacy::PassManager CodeGenPasses;
744 CodeGenPasses.add(
745 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
Nadav Rotemec57ab32012-10-24 00:53:38 +0000746
Teresa Johnson488d1dc2017-03-23 19:47:49 +0000747 std::unique_ptr<raw_fd_ostream> ThinLinkOS;
748
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000749 switch (Action) {
750 case Backend_EmitNothing:
751 break;
752
753 case Backend_EmitBC:
Teresa Johnson488d1dc2017-03-23 19:47:49 +0000754 if (CodeGenOpts.EmitSummaryIndex) {
755 if (!CodeGenOpts.ThinLinkBitcodeFile.empty()) {
756 std::error_code EC;
757 ThinLinkOS.reset(new llvm::raw_fd_ostream(
758 CodeGenOpts.ThinLinkBitcodeFile, EC,
759 llvm::sys::fs::F_None));
760 if (EC) {
761 Diags.Report(diag::err_fe_unable_to_open_output) << CodeGenOpts.ThinLinkBitcodeFile
762 << EC.message();
763 return;
764 }
765 }
766 PerModulePasses.add(
767 createWriteThinLTOBitcodePass(*OS, ThinLinkOS.get()));
768 }
Peter Collingbourneb8847162017-01-26 23:51:50 +0000769 else
770 PerModulePasses.add(
771 createBitcodeWriterPass(*OS, CodeGenOpts.EmitLLVMUseLists));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000772 break;
773
774 case Backend_EmitLL:
Peter Collingbourne03f89072016-07-15 00:55:40 +0000775 PerModulePasses.add(
Duncan P. N. Exon Smithbb9cadf2015-04-15 02:45:28 +0000776 createPrintModulePass(*OS, "", CodeGenOpts.EmitLLVMUseLists));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000777 break;
778
779 default:
Peter Collingbourne03f89072016-07-15 00:55:40 +0000780 if (!AddEmitPasses(CodeGenPasses, Action, *OS))
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000781 return;
782 }
783
Andrew Trick15e36e82011-04-05 18:56:55 +0000784 // Before executing passes, print the final values of the LLVM options.
785 cl::PrintOptionValues();
786
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000787 // Run passes. For now we do all passes at once, but eventually we
788 // would like to have the option of streaming code generation.
789
Peter Collingbourne03f89072016-07-15 00:55:40 +0000790 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000791 PrettyStackTraceString CrashInfo("Per-function optimization");
792
Peter Collingbourne03f89072016-07-15 00:55:40 +0000793 PerFunctionPasses.doInitialization();
Yaron Keren10d6d162015-06-05 09:40:53 +0000794 for (Function &F : *TheModule)
795 if (!F.isDeclaration())
Peter Collingbourne03f89072016-07-15 00:55:40 +0000796 PerFunctionPasses.run(F);
797 PerFunctionPasses.doFinalization();
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000798 }
799
Peter Collingbourne03f89072016-07-15 00:55:40 +0000800 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000801 PrettyStackTraceString CrashInfo("Per-module optimization passes");
Peter Collingbourne03f89072016-07-15 00:55:40 +0000802 PerModulePasses.run(*TheModule);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000803 }
804
Peter Collingbourne03f89072016-07-15 00:55:40 +0000805 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000806 PrettyStackTraceString CrashInfo("Code generation");
Peter Collingbourne03f89072016-07-15 00:55:40 +0000807 CodeGenPasses.run(*TheModule);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000808 }
809}
810
Chandler Carruth50f9e892016-12-23 20:44:01 +0000811static PassBuilder::OptimizationLevel mapToLevel(const CodeGenOptions &Opts) {
812 switch (Opts.OptimizationLevel) {
813 default:
814 llvm_unreachable("Invalid optimization level!");
815
816 case 1:
817 return PassBuilder::O1;
818
819 case 2:
820 switch (Opts.OptimizeSize) {
821 default:
822 llvm_unreachable("Invalide optimization level for size!");
823
824 case 0:
825 return PassBuilder::O2;
826
827 case 1:
828 return PassBuilder::Os;
829
830 case 2:
831 return PassBuilder::Oz;
832 }
833
834 case 3:
835 return PassBuilder::O3;
836 }
837}
838
839/// A clean version of `EmitAssembly` that uses the new pass manager.
840///
841/// Not all features are currently supported in this system, but where
842/// necessary it falls back to the legacy pass manager to at least provide
843/// basic functionality.
844///
845/// This API is planned to have its functionality finished and then to replace
846/// `EmitAssembly` at some point in the future when the default switches.
847void EmitAssemblyHelper::EmitAssemblyWithNewPassManager(
848 BackendAction Action, std::unique_ptr<raw_pwrite_stream> OS) {
849 TimeRegion Region(llvm::TimePassesIsEnabled ? &CodeGenerationTime : nullptr);
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000850 setCommandLineOpts(CodeGenOpts);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000851
852 // The new pass manager always makes a target machine available to passes
853 // during construction.
854 CreateTargetMachine(/*MustCreateTM*/ true);
855 if (!TM)
856 // This will already be diagnosed, just bail.
857 return;
858 TheModule->setDataLayout(TM->createDataLayout());
859
Dehao Chenc76a27e2017-07-27 15:29:53 +0000860 Optional<PGOOptions> PGOOpt;
Davide Italiano945de432017-02-13 16:07:05 +0000861
Dehao Chenc76a27e2017-07-27 15:29:53 +0000862 if (CodeGenOpts.hasProfileIRInstr())
863 // -fprofile-generate.
864 PGOOpt = PGOOptions(CodeGenOpts.InstrProfileOutput.empty()
865 ? DefaultProfileGenName
866 : CodeGenOpts.InstrProfileOutput,
867 "", "", true, CodeGenOpts.DebugInfoForProfiling);
868 else if (CodeGenOpts.hasProfileIRUse())
869 // -fprofile-use.
870 PGOOpt = PGOOptions("", CodeGenOpts.ProfileInstrumentUsePath, "", false,
871 CodeGenOpts.DebugInfoForProfiling);
872 else if (!CodeGenOpts.SampleProfileFile.empty())
873 // -fprofile-sample-use
874 PGOOpt = PGOOptions("", "", CodeGenOpts.SampleProfileFile, false,
875 CodeGenOpts.DebugInfoForProfiling);
876 else if (CodeGenOpts.DebugInfoForProfiling)
877 // -fdebug-info-for-profiling
878 PGOOpt = PGOOptions("", "", "", false, true);
Davide Italiano945de432017-02-13 16:07:05 +0000879
Dehao Chenc76a27e2017-07-27 15:29:53 +0000880 PassBuilder PB(TM.get(), PGOOpt);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000881
Craig Topper926b95c2017-11-14 08:48:28 +0000882 LoopAnalysisManager LAM(CodeGenOpts.DebugPassManager);
883 FunctionAnalysisManager FAM(CodeGenOpts.DebugPassManager);
884 CGSCCAnalysisManager CGAM(CodeGenOpts.DebugPassManager);
885 ModuleAnalysisManager MAM(CodeGenOpts.DebugPassManager);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000886
887 // Register the AA manager first so that our version is the one used.
888 FAM.registerPass([&] { return PB.buildDefaultAAPipeline(); });
889
Chandler Carruth9fdd5fa2017-07-25 10:46:07 +0000890 // Register the target library analysis directly and give it a customized
891 // preset TLI.
892 Triple TargetTriple(TheModule->getTargetTriple());
893 std::unique_ptr<TargetLibraryInfoImpl> TLII(
894 createTLII(TargetTriple, CodeGenOpts));
895 FAM.registerPass([&] { return TargetLibraryAnalysis(*TLII); });
896 MAM.registerPass([&] { return TargetLibraryAnalysis(*TLII); });
897
Chandler Carruth50f9e892016-12-23 20:44:01 +0000898 // Register all the basic analyses with the managers.
899 PB.registerModuleAnalyses(MAM);
900 PB.registerCGSCCAnalyses(CGAM);
901 PB.registerFunctionAnalyses(FAM);
902 PB.registerLoopAnalyses(LAM);
903 PB.crossRegisterProxies(LAM, FAM, CGAM, MAM);
904
Tim Shenb13eebe2017-06-29 23:10:13 +0000905 ModulePassManager MPM(CodeGenOpts.DebugPassManager);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000906
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000907 if (!CodeGenOpts.DisableLLVMPasses) {
Tim Shen66470692017-06-29 23:08:38 +0000908 bool IsThinLTO = CodeGenOpts.EmitSummaryIndex;
909 bool IsLTO = CodeGenOpts.PrepareForLTO;
910
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000911 if (CodeGenOpts.OptimizationLevel == 0) {
912 // Build a minimal pipeline based on the semantics required by Clang,
913 // which is just that always inlining occurs.
914 MPM.addPass(AlwaysInlinerPass());
Chandler Carrutha8bd4e32017-11-14 01:59:18 +0000915
916 // At -O0 we directly run necessary sanitizer passes.
917 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds))
918 MPM.addPass(createModuleToFunctionPassAdaptor(BoundsCheckingPass()));
919
920 // Lastly, add a semantically necessary pass for ThinLTO.
Tim Shen66470692017-06-29 23:08:38 +0000921 if (IsThinLTO)
922 MPM.addPass(NameAnonGlobalPass());
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000923 } else {
Tim Shen66470692017-06-29 23:08:38 +0000924 // Map our optimization levels into one of the distinct levels used to
925 // configure the pipeline.
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000926 PassBuilder::OptimizationLevel Level = mapToLevel(CodeGenOpts);
927
Chandler Carrutha8bd4e32017-11-14 01:59:18 +0000928 // Register callbacks to schedule sanitizer passes at the appropriate part of
929 // the pipeline.
930 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds))
931 PB.registerScalarOptimizerLateEPCallback(
932 [](FunctionPassManager &FPM, PassBuilder::OptimizationLevel Level) {
933 FPM.addPass(BoundsCheckingPass());
934 });
935
Tim Shen66470692017-06-29 23:08:38 +0000936 if (IsThinLTO) {
Tim Shenb13eebe2017-06-29 23:10:13 +0000937 MPM = PB.buildThinLTOPreLinkDefaultPipeline(
938 Level, CodeGenOpts.DebugPassManager);
Tim Shen66470692017-06-29 23:08:38 +0000939 MPM.addPass(NameAnonGlobalPass());
940 } else if (IsLTO) {
Tim Shenb13eebe2017-06-29 23:10:13 +0000941 MPM = PB.buildLTOPreLinkDefaultPipeline(Level,
942 CodeGenOpts.DebugPassManager);
Tim Shen66470692017-06-29 23:08:38 +0000943 } else {
Tim Shenb13eebe2017-06-29 23:10:13 +0000944 MPM = PB.buildPerModuleDefaultPipeline(Level,
945 CodeGenOpts.DebugPassManager);
Tim Shen66470692017-06-29 23:08:38 +0000946 }
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000947 }
David Blaikie7a4f7f52018-01-09 22:03:47 +0000948 if (Optional<GCOVOptions> Options = getGCOVOptions(CodeGenOpts)) {
949 MPM.addPass(GCOVProfilerPass(*Options));
950 }
Chandler Carruth50f9e892016-12-23 20:44:01 +0000951 }
952
953 // FIXME: We still use the legacy pass manager to do code generation. We
954 // create that pass manager here and use it as needed below.
955 legacy::PassManager CodeGenPasses;
956 bool NeedCodeGen = false;
Tim Shen50fedec2017-06-01 23:27:51 +0000957 Optional<raw_fd_ostream> ThinLinkOS;
Chandler Carruth50f9e892016-12-23 20:44:01 +0000958
959 // Append any output we need to the pass manager.
960 switch (Action) {
961 case Backend_EmitNothing:
962 break;
963
964 case Backend_EmitBC:
Tim Shen50fedec2017-06-01 23:27:51 +0000965 if (CodeGenOpts.EmitSummaryIndex) {
966 if (!CodeGenOpts.ThinLinkBitcodeFile.empty()) {
967 std::error_code EC;
968 ThinLinkOS.emplace(CodeGenOpts.ThinLinkBitcodeFile, EC,
969 llvm::sys::fs::F_None);
970 if (EC) {
971 Diags.Report(diag::err_fe_unable_to_open_output)
972 << CodeGenOpts.ThinLinkBitcodeFile << EC.message();
973 return;
974 }
975 }
976 MPM.addPass(
977 ThinLTOBitcodeWriterPass(*OS, ThinLinkOS ? &*ThinLinkOS : nullptr));
978 } else {
979 MPM.addPass(BitcodeWriterPass(*OS, CodeGenOpts.EmitLLVMUseLists,
980 CodeGenOpts.EmitSummaryIndex,
981 CodeGenOpts.EmitSummaryIndex));
982 }
Chandler Carruth50f9e892016-12-23 20:44:01 +0000983 break;
984
985 case Backend_EmitLL:
986 MPM.addPass(PrintModulePass(*OS, "", CodeGenOpts.EmitLLVMUseLists));
987 break;
988
989 case Backend_EmitAssembly:
990 case Backend_EmitMCNull:
991 case Backend_EmitObj:
992 NeedCodeGen = true;
993 CodeGenPasses.add(
994 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
995 if (!AddEmitPasses(CodeGenPasses, Action, *OS))
996 // FIXME: Should we handle this error differently?
997 return;
998 break;
999 }
1000
1001 // Before executing passes, print the final values of the LLVM options.
1002 cl::PrintOptionValues();
1003
1004 // Now that we have all of the passes ready, run them.
1005 {
1006 PrettyStackTraceString CrashInfo("Optimizer");
1007 MPM.run(*TheModule, MAM);
1008 }
1009
1010 // Now if needed, run the legacy PM for codegen.
1011 if (NeedCodeGen) {
1012 PrettyStackTraceString CrashInfo("Code generation");
1013 CodeGenPasses.run(*TheModule);
1014 }
1015}
1016
Peter Collingbourne47d23642017-01-24 19:54:37 +00001017Expected<BitcodeModule> clang::FindThinLTOModule(MemoryBufferRef MBRef) {
1018 Expected<std::vector<BitcodeModule>> BMsOrErr = getBitcodeModuleList(MBRef);
1019 if (!BMsOrErr)
1020 return BMsOrErr.takeError();
1021
Peter Collingbournedbd2fed2017-06-15 17:26:13 +00001022 // The bitcode file may contain multiple modules, we want the one that is
1023 // marked as being the ThinLTO module.
Peter Collingbourne47d23642017-01-24 19:54:37 +00001024 for (BitcodeModule &BM : *BMsOrErr) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +00001025 Expected<BitcodeLTOInfo> LTOInfo = BM.getLTOInfo();
1026 if (LTOInfo && LTOInfo->IsThinLTO)
Peter Collingbourne47d23642017-01-24 19:54:37 +00001027 return BM;
1028 }
1029
1030 return make_error<StringError>("Could not find module summary",
1031 inconvertibleErrorCode());
1032}
1033
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001034static void runThinLTOBackend(ModuleSummaryIndex *CombinedIndex, Module *M,
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001035 const HeaderSearchOptions &HeaderOpts,
1036 const CodeGenOptions &CGOpts,
1037 const clang::TargetOptions &TOpts,
1038 const LangOptions &LOpts,
Dehao Chena1bd2d62017-01-13 00:51:55 +00001039 std::unique_ptr<raw_pwrite_stream> OS,
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001040 std::string SampleProfile,
1041 BackendAction Action) {
Dehao Chen5f83d0e2017-07-10 20:31:37 +00001042 StringMap<DenseMap<GlobalValue::GUID, GlobalValueSummary *>>
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001043 ModuleToDefinedGVSummaries;
1044 CombinedIndex->collectDefinedGVSummariesPerModule(ModuleToDefinedGVSummaries);
1045
David Blaikie6e2ec5f2017-04-19 20:08:21 +00001046 setCommandLineOpts(CGOpts);
1047
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001048 // We can simply import the values mentioned in the combined index, since
1049 // we should only invoke this using the individual indexes written out
1050 // via a WriteIndexesThinBackend.
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001051 FunctionImporter::ImportMapTy ImportList;
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001052 for (auto &GlobalList : *CombinedIndex) {
Peter Collingbourne9667b912017-05-04 18:03:25 +00001053 // Ignore entries for undefined references.
1054 if (GlobalList.second.SummaryList.empty())
1055 continue;
1056
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001057 auto GUID = GlobalList.first;
Peter Collingbourne9667b912017-05-04 18:03:25 +00001058 assert(GlobalList.second.SummaryList.size() == 1 &&
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001059 "Expected individual combined index to have one summary per GUID");
Peter Collingbourne9667b912017-05-04 18:03:25 +00001060 auto &Summary = GlobalList.second.SummaryList[0];
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001061 // Skip the summaries for the importing module. These are included to
1062 // e.g. record required linkage changes.
1063 if (Summary->modulePath() == M->getModuleIdentifier())
1064 continue;
1065 // Doesn't matter what value we plug in to the map, just needs an entry
1066 // to provoke importing by thinBackend.
1067 ImportList[Summary->modulePath()][GUID] = 1;
1068 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001069
1070 std::vector<std::unique_ptr<llvm::MemoryBuffer>> OwnedImports;
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001071 MapVector<llvm::StringRef, llvm::BitcodeModule> ModuleMap;
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001072
1073 for (auto &I : ImportList) {
1074 ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> MBOrErr =
1075 llvm::MemoryBuffer::getFile(I.first());
1076 if (!MBOrErr) {
1077 errs() << "Error loading imported file '" << I.first()
1078 << "': " << MBOrErr.getError().message() << "\n";
1079 return;
1080 }
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001081
Peter Collingbourne47d23642017-01-24 19:54:37 +00001082 Expected<BitcodeModule> BMOrErr = FindThinLTOModule(**MBOrErr);
1083 if (!BMOrErr) {
1084 handleAllErrors(BMOrErr.takeError(), [&](ErrorInfoBase &EIB) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001085 errs() << "Error loading imported file '" << I.first()
1086 << "': " << EIB.message() << '\n';
1087 });
1088 return;
1089 }
Peter Collingbourne47d23642017-01-24 19:54:37 +00001090 ModuleMap.insert({I.first(), *BMOrErr});
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001091
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001092 OwnedImports.push_back(std::move(*MBOrErr));
1093 }
Peter Collingbourne2d3a26f2016-09-23 21:43:51 +00001094 auto AddStream = [&](size_t Task) {
1095 return llvm::make_unique<lto::NativeObjectStream>(std::move(OS));
Mehdi Amini406aa222016-08-17 06:23:08 +00001096 };
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001097 lto::Config Conf;
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001098 Conf.CPU = TOpts.CPU;
1099 Conf.CodeModel = getCodeModel(CGOpts);
1100 Conf.MAttrs = TOpts.Features;
Rafael Espindolae1d70532018-01-18 00:20:03 +00001101 Conf.RelocModel = CGOpts.RelocationModel;
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001102 Conf.CGOptLevel = getCGOptLevel(CGOpts);
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001103 initTargetOptions(Conf.Options, CGOpts, TOpts, LOpts, HeaderOpts);
Benjamin Kramerf6021ec2017-03-21 21:35:04 +00001104 Conf.SampleProfile = std::move(SampleProfile);
Tim Shen50fedec2017-06-01 23:27:51 +00001105 Conf.UseNewPM = CGOpts.ExperimentalNewPassManager;
Teresa Johnson4cd016ab2017-11-13 15:38:33 +00001106 Conf.DebugPassManager = CGOpts.DebugPassManager;
Teresa Johnsonb637cb02017-03-31 22:35:47 +00001107 switch (Action) {
1108 case Backend_EmitNothing:
1109 Conf.PreCodeGenModuleHook = [](size_t Task, const Module &Mod) {
1110 return false;
1111 };
1112 break;
1113 case Backend_EmitLL:
1114 Conf.PreCodeGenModuleHook = [&](size_t Task, const Module &Mod) {
1115 M->print(*OS, nullptr, CGOpts.EmitLLVMUseLists);
1116 return false;
1117 };
1118 break;
1119 case Backend_EmitBC:
1120 Conf.PreCodeGenModuleHook = [&](size_t Task, const Module &Mod) {
1121 WriteBitcodeToFile(M, *OS, CGOpts.EmitLLVMUseLists);
1122 return false;
1123 };
1124 break;
1125 default:
1126 Conf.CGFileType = getCodeGenFileType(Action);
1127 break;
1128 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001129 if (Error E = thinBackend(
Peter Collingbourne2d3a26f2016-09-23 21:43:51 +00001130 Conf, 0, AddStream, *M, *CombinedIndex, ImportList,
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001131 ModuleToDefinedGVSummaries[M->getModuleIdentifier()], ModuleMap)) {
1132 handleAllErrors(std::move(E), [&](ErrorInfoBase &EIB) {
1133 errs() << "Error running ThinLTO backend: " << EIB.message() << '\n';
1134 });
1135 }
1136}
1137
David Blaikie9c902b52011-09-25 23:23:43 +00001138void clang::EmitBackendOutput(DiagnosticsEngine &Diags,
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001139 const HeaderSearchOptions &HeaderOpts,
David Blaikie9c902b52011-09-25 23:23:43 +00001140 const CodeGenOptions &CGOpts,
Nick Lewycky432add52011-12-02 22:17:00 +00001141 const clang::TargetOptions &TOpts,
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001142 const LangOptions &LOpts,
1143 const llvm::DataLayout &TDesc, Module *M,
1144 BackendAction Action,
Peter Collingbourne03f89072016-07-15 00:55:40 +00001145 std::unique_ptr<raw_pwrite_stream> OS) {
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001146 if (!CGOpts.ThinLTOIndexFile.empty()) {
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001147 // If we are performing a ThinLTO importing compile, load the function index
1148 // into memory and pass it into runThinLTOBackend, which will run the
1149 // function importer and invoke LTO passes.
1150 Expected<std::unique_ptr<ModuleSummaryIndex>> IndexOrErr =
Teresa Johnson517729f2017-05-12 19:32:17 +00001151 llvm::getModuleSummaryIndexForFile(CGOpts.ThinLTOIndexFile,
1152 /*IgnoreEmptyThinLTOIndexFile*/true);
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001153 if (!IndexOrErr) {
1154 logAllUnhandledErrors(IndexOrErr.takeError(), errs(),
1155 "Error loading index file '" +
1156 CGOpts.ThinLTOIndexFile + "': ");
1157 return;
1158 }
1159 std::unique_ptr<ModuleSummaryIndex> CombinedIndex = std::move(*IndexOrErr);
1160 // A null CombinedIndex means we should skip ThinLTO compilation
1161 // (LLVM will optionally ignore empty index files, returning null instead
1162 // of an error).
1163 bool DoThinLTOBackend = CombinedIndex != nullptr;
1164 if (DoThinLTOBackend) {
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001165 runThinLTOBackend(CombinedIndex.get(), M, HeaderOpts, CGOpts, TOpts,
1166 LOpts, std::move(OS), CGOpts.SampleProfileFile, Action);
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001167 return;
1168 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001169 }
1170
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001171 EmitAssemblyHelper AsmHelper(Diags, HeaderOpts, CGOpts, TOpts, LOpts, M);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +00001172
Chandler Carruth50f9e892016-12-23 20:44:01 +00001173 if (CGOpts.ExperimentalNewPassManager)
1174 AsmHelper.EmitAssemblyWithNewPassManager(Action, std::move(OS));
1175 else
1176 AsmHelper.EmitAssembly(Action, std::move(OS));
Alp Tokere83b9062014-01-02 15:08:04 +00001177
James Y Knightb214cbc2016-03-04 19:00:41 +00001178 // Verify clang's TargetInfo DataLayout against the LLVM TargetMachine's
1179 // DataLayout.
1180 if (AsmHelper.TM) {
Mehdi Aminica3cf9e2015-07-24 16:04:29 +00001181 std::string DLDesc = M->getDataLayout().getStringRepresentation();
James Y Knightb214cbc2016-03-04 19:00:41 +00001182 if (DLDesc != TDesc.getStringRepresentation()) {
Alp Tokere83b9062014-01-02 15:08:04 +00001183 unsigned DiagID = Diags.getCustomDiagID(
1184 DiagnosticsEngine::Error, "backend data layout '%0' does not match "
1185 "expected target description '%1'");
James Y Knightb214cbc2016-03-04 19:00:41 +00001186 Diags.Report(DiagID) << DLDesc << TDesc.getStringRepresentation();
Alp Tokere83b9062014-01-02 15:08:04 +00001187 }
1188 }
Daniel Dunbarf976d1b2010-06-07 23:20:08 +00001189}
Steven Wu27fb5222016-05-11 16:26:03 +00001190
1191static const char* getSectionNameForBitcode(const Triple &T) {
1192 switch (T.getObjectFormat()) {
1193 case Triple::MachO:
1194 return "__LLVM,__bitcode";
1195 case Triple::COFF:
1196 case Triple::ELF:
Dan Gohman839f2152017-01-17 21:46:38 +00001197 case Triple::Wasm:
Steven Wu27fb5222016-05-11 16:26:03 +00001198 case Triple::UnknownObjectFormat:
1199 return ".llvmbc";
1200 }
Simon Pilgrimbff9dae2016-05-11 21:55:37 +00001201 llvm_unreachable("Unimplemented ObjectFormatType");
Steven Wu27fb5222016-05-11 16:26:03 +00001202}
1203
1204static const char* getSectionNameForCommandline(const Triple &T) {
1205 switch (T.getObjectFormat()) {
1206 case Triple::MachO:
1207 return "__LLVM,__cmdline";
1208 case Triple::COFF:
1209 case Triple::ELF:
Dan Gohman839f2152017-01-17 21:46:38 +00001210 case Triple::Wasm:
Steven Wu27fb5222016-05-11 16:26:03 +00001211 case Triple::UnknownObjectFormat:
1212 return ".llvmcmd";
1213 }
Simon Pilgrimbff9dae2016-05-11 21:55:37 +00001214 llvm_unreachable("Unimplemented ObjectFormatType");
Steven Wu27fb5222016-05-11 16:26:03 +00001215}
1216
1217// With -fembed-bitcode, save a copy of the llvm IR as data in the
1218// __LLVM,__bitcode section.
1219void clang::EmbedBitcode(llvm::Module *M, const CodeGenOptions &CGOpts,
1220 llvm::MemoryBufferRef Buf) {
1221 if (CGOpts.getEmbedBitcode() == CodeGenOptions::Embed_Off)
1222 return;
1223
Steven Wu2c059a52016-05-16 18:54:58 +00001224 // Save llvm.compiler.used and remote it.
1225 SmallVector<Constant*, 2> UsedArray;
1226 SmallSet<GlobalValue*, 4> UsedGlobals;
1227 Type *UsedElementType = Type::getInt8Ty(M->getContext())->getPointerTo(0);
1228 GlobalVariable *Used = collectUsedGlobalVariables(*M, UsedGlobals, true);
1229 for (auto *GV : UsedGlobals) {
1230 if (GV->getName() != "llvm.embedded.module" &&
1231 GV->getName() != "llvm.cmdline")
1232 UsedArray.push_back(
1233 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
1234 }
1235 if (Used)
1236 Used->eraseFromParent();
1237
Steven Wu27fb5222016-05-11 16:26:03 +00001238 // Embed the bitcode for the llvm module.
1239 std::string Data;
1240 ArrayRef<uint8_t> ModuleData;
1241 Triple T(M->getTargetTriple());
1242 // Create a constant that contains the bitcode.
1243 // In case of embedding a marker, ignore the input Buf and use the empty
1244 // ArrayRef. It is also legal to create a bitcode marker even Buf is empty.
1245 if (CGOpts.getEmbedBitcode() != CodeGenOptions::Embed_Marker) {
1246 if (!isBitcode((const unsigned char *)Buf.getBufferStart(),
1247 (const unsigned char *)Buf.getBufferEnd())) {
1248 // If the input is LLVM Assembly, bitcode is produced by serializing
1249 // the module. Use-lists order need to be perserved in this case.
1250 llvm::raw_string_ostream OS(Data);
1251 llvm::WriteBitcodeToFile(M, OS, /* ShouldPreserveUseListOrder */ true);
1252 ModuleData =
1253 ArrayRef<uint8_t>((const uint8_t *)OS.str().data(), OS.str().size());
1254 } else
1255 // If the input is LLVM bitcode, write the input byte stream directly.
1256 ModuleData = ArrayRef<uint8_t>((const uint8_t *)Buf.getBufferStart(),
1257 Buf.getBufferSize());
1258 }
1259 llvm::Constant *ModuleConstant =
1260 llvm::ConstantDataArray::get(M->getContext(), ModuleData);
Steven Wu27fb5222016-05-11 16:26:03 +00001261 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
Steven Wu2c059a52016-05-16 18:54:58 +00001262 *M, ModuleConstant->getType(), true, llvm::GlobalValue::PrivateLinkage,
Steven Wu27fb5222016-05-11 16:26:03 +00001263 ModuleConstant);
1264 GV->setSection(getSectionNameForBitcode(T));
Steven Wu2c059a52016-05-16 18:54:58 +00001265 UsedArray.push_back(
1266 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
Steven Wu27fb5222016-05-11 16:26:03 +00001267 if (llvm::GlobalVariable *Old =
Steven Wu2c059a52016-05-16 18:54:58 +00001268 M->getGlobalVariable("llvm.embedded.module", true)) {
1269 assert(Old->hasOneUse() &&
1270 "llvm.embedded.module can only be used once in llvm.compiler.used");
Steven Wu27fb5222016-05-11 16:26:03 +00001271 GV->takeName(Old);
1272 Old->eraseFromParent();
1273 } else {
1274 GV->setName("llvm.embedded.module");
1275 }
1276
Steven Wu2c059a52016-05-16 18:54:58 +00001277 // Skip if only bitcode needs to be embedded.
1278 if (CGOpts.getEmbedBitcode() != CodeGenOptions::Embed_Bitcode) {
1279 // Embed command-line options.
Saleem Abdulrasoolb1d50c12016-05-20 03:58:12 +00001280 ArrayRef<uint8_t> CmdData(const_cast<uint8_t *>(CGOpts.CmdArgs.data()),
Steven Wu2c059a52016-05-16 18:54:58 +00001281 CGOpts.CmdArgs.size());
1282 llvm::Constant *CmdConstant =
1283 llvm::ConstantDataArray::get(M->getContext(), CmdData);
1284 GV = new llvm::GlobalVariable(*M, CmdConstant->getType(), true,
1285 llvm::GlobalValue::PrivateLinkage,
1286 CmdConstant);
1287 GV->setSection(getSectionNameForCommandline(T));
1288 UsedArray.push_back(
1289 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
1290 if (llvm::GlobalVariable *Old =
1291 M->getGlobalVariable("llvm.cmdline", true)) {
1292 assert(Old->hasOneUse() &&
1293 "llvm.cmdline can only be used once in llvm.compiler.used");
1294 GV->takeName(Old);
1295 Old->eraseFromParent();
1296 } else {
1297 GV->setName("llvm.cmdline");
1298 }
1299 }
1300
1301 if (UsedArray.empty())
Steven Wu27fb5222016-05-11 16:26:03 +00001302 return;
1303
Steven Wu2c059a52016-05-16 18:54:58 +00001304 // Recreate llvm.compiler.used.
1305 ArrayType *ATy = ArrayType::get(UsedElementType, UsedArray.size());
1306 auto *NewUsed = new GlobalVariable(
1307 *M, ATy, false, llvm::GlobalValue::AppendingLinkage,
1308 llvm::ConstantArray::get(ATy, UsedArray), "llvm.compiler.used");
1309 NewUsed->setSection("llvm.metadata");
Steven Wu27fb5222016-05-11 16:26:03 +00001310}