blob: f2733ce998ed4781d52227477af20552dcce19c2 [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;
Chih-Hung Hsiehca552b82018-03-01 22:26:19 +0000436 Options.ExplicitEmulatedTLS = CodeGenOpts.ExplicitEmulatedTLS;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000437 Options.DebuggerTuning = CodeGenOpts.getDebuggerTuning();
Sean Eveson5110d4f2018-01-08 13:42:26 +0000438 Options.EmitStackSizeSection = CodeGenOpts.StackSizeSection;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000439
David Blaikie81503552017-04-21 23:35:36 +0000440 if (CodeGenOpts.EnableSplitDwarf)
441 Options.MCOptions.SplitDwarfFile = CodeGenOpts.SplitDwarfFile;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000442 Options.MCOptions.MCRelaxAll = CodeGenOpts.RelaxAll;
443 Options.MCOptions.MCSaveTempLabels = CodeGenOpts.SaveTempLabels;
444 Options.MCOptions.MCUseDwarfDirectory = !CodeGenOpts.NoDwarfDirectoryAsm;
445 Options.MCOptions.MCNoExecStack = CodeGenOpts.NoExecStack;
446 Options.MCOptions.MCIncrementalLinkerCompatible =
447 CodeGenOpts.IncrementalLinkerCompatible;
448 Options.MCOptions.MCPIECopyRelocations = CodeGenOpts.PIECopyRelocations;
449 Options.MCOptions.MCFatalWarnings = CodeGenOpts.FatalWarnings;
450 Options.MCOptions.AsmVerbose = CodeGenOpts.AsmVerbose;
451 Options.MCOptions.PreserveAsmComments = CodeGenOpts.PreserveAsmComments;
452 Options.MCOptions.ABIName = TargetOpts.ABI;
453 for (const auto &Entry : HSOpts.UserEntries)
454 if (!Entry.IsFramework &&
455 (Entry.Group == frontend::IncludeDirGroup::Quoted ||
456 Entry.Group == frontend::IncludeDirGroup::Angled ||
457 Entry.Group == frontend::IncludeDirGroup::System))
458 Options.MCOptions.IASSearchPaths.push_back(
459 Entry.IgnoreSysRoot ? Entry.Path : HSOpts.Sysroot + Entry.Path);
460}
David Blaikie7a4f7f52018-01-09 22:03:47 +0000461static Optional<GCOVOptions> getGCOVOptions(const CodeGenOptions &CodeGenOpts) {
462 if (CodeGenOpts.DisableGCov)
463 return None;
464 if (!CodeGenOpts.EmitGcovArcs && !CodeGenOpts.EmitGcovNotes)
465 return None;
466 // Not using 'GCOVOptions::getDefault' allows us to avoid exiting if
467 // LLVM's -default-gcov-version flag is set to something invalid.
468 GCOVOptions Options;
469 Options.EmitNotes = CodeGenOpts.EmitGcovNotes;
470 Options.EmitData = CodeGenOpts.EmitGcovArcs;
471 llvm::copy(CodeGenOpts.CoverageVersion, std::begin(Options.Version));
472 Options.UseCfgChecksum = CodeGenOpts.CoverageExtraChecksum;
473 Options.NoRedZone = CodeGenOpts.DisableRedZone;
474 Options.FunctionNamesInData = !CodeGenOpts.CoverageNoFunctionNamesInData;
475 Options.ExitBlockBeforeBody = CodeGenOpts.CoverageExitBlockBeforeBody;
476 return Options;
477}
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000478
Peter Collingbourne03f89072016-07-15 00:55:40 +0000479void EmitAssemblyHelper::CreatePasses(legacy::PassManager &MPM,
Teresa Johnson9e3f4742016-08-12 18:12:08 +0000480 legacy::FunctionPassManager &FPM) {
Chandler Carruth93786da2016-12-23 00:23:01 +0000481 // Handle disabling of all LLVM passes, where we want to preserve the
482 // internal module before any optimization.
Steven Wu546a1962015-07-17 20:09:56 +0000483 if (CodeGenOpts.DisableLLVMPasses)
484 return;
485
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000486 // Figure out TargetLibraryInfo. This needs to be added to MPM and FPM
487 // manually (and not via PMBuilder), since some passes (eg. InstrProfiling)
488 // are inserted before PMBuilder ones - they'd get the default-constructed
489 // TLI with an unknown target otherwise.
Teresa Johnsonaff22322015-12-07 19:21:34 +0000490 Triple TargetTriple(TheModule->getTargetTriple());
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000491 std::unique_ptr<TargetLibraryInfoImpl> TLII(
492 createTLII(TargetTriple, CodeGenOpts));
Teresa Johnsonaff22322015-12-07 19:21:34 +0000493
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000494 PassManagerBuilderWrapper PMBuilder(TargetTriple, CodeGenOpts, LangOpts);
495
Chandler Carruthfcd33142016-12-23 01:24:49 +0000496 // At O0 and O1 we only run the always inliner which is more efficient. At
497 // higher optimization levels we run the normal inliner.
498 if (CodeGenOpts.OptimizationLevel <= 1) {
Mehdi Amini7f873072017-01-06 23:18:09 +0000499 bool InsertLifetimeIntrinsics = (CodeGenOpts.OptimizationLevel != 0 &&
500 !CodeGenOpts.DisableLifetimeMarkers);
Chandler Carruthfcd33142016-12-23 01:24:49 +0000501 PMBuilder.Inliner = createAlwaysInlinerLegacyPass(InsertLifetimeIntrinsics);
502 } else {
Dehao Chence39fdd2017-03-21 19:55:46 +0000503 // We do not want to inline hot callsites for SamplePGO module-summary build
504 // because profile annotation will happen again in ThinLTO backend, and we
505 // want the IR of the hot path to match the profile.
Chandler Carruthfcd33142016-12-23 01:24:49 +0000506 PMBuilder.Inliner = createFunctionInliningPass(
Dehao Chence39fdd2017-03-21 19:55:46 +0000507 CodeGenOpts.OptimizationLevel, CodeGenOpts.OptimizeSize,
508 (!CodeGenOpts.SampleProfileFile.empty() &&
509 CodeGenOpts.EmitSummaryIndex));
Teresa Johnsonaff22322015-12-07 19:21:34 +0000510 }
511
Chandler Carruthfcd33142016-12-23 01:24:49 +0000512 PMBuilder.OptLevel = CodeGenOpts.OptimizationLevel;
Chris Lattnerecf0ba52011-05-21 23:50:44 +0000513 PMBuilder.SizeLevel = CodeGenOpts.OptimizeSize;
Nick Lewyckyd3f3e4f2013-06-25 01:49:44 +0000514 PMBuilder.SLPVectorize = CodeGenOpts.VectorizeSLP;
515 PMBuilder.LoopVectorize = CodeGenOpts.VectorizeLoop;
Andrew Trickb2a84722011-04-05 18:49:32 +0000516
Chris Lattnerecf0ba52011-05-21 23:50:44 +0000517 PMBuilder.DisableUnrollLoops = !CodeGenOpts.UnrollLoops;
Nick Lewyckyf04f2372014-10-24 00:49:29 +0000518 PMBuilder.MergeFunctions = CodeGenOpts.MergeFunctions;
Teresa Johnsona0d29402016-03-15 00:04:44 +0000519 PMBuilder.PrepareForThinLTO = CodeGenOpts.EmitSummaryIndex;
Teresa Johnson8749d8042015-07-06 16:23:00 +0000520 PMBuilder.PrepareForLTO = CodeGenOpts.PrepareForLTO;
Hal Finkelce0697f2013-11-17 16:03:29 +0000521 PMBuilder.RerollLoops = CodeGenOpts.RerollLoops;
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000522
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000523 MPM.add(new TargetLibraryInfoWrapperPass(*TLII));
524
Justin Lebar5a7df9c2016-04-27 19:12:56 +0000525 if (TM)
Stanislav Mekhanoshin61da0672017-01-26 16:49:21 +0000526 TM->adjustPassManager(PMBuilder);
Justin Lebar5a7df9c2016-04-27 19:12:56 +0000527
Dehao Chen7810d4f2017-02-21 20:36:21 +0000528 if (CodeGenOpts.DebugInfoForProfiling ||
529 !CodeGenOpts.SampleProfileFile.empty())
530 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
531 addAddDiscriminatorsPass);
Diego Novillob56be642014-03-03 20:06:18 +0000532
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000533 // In ObjC ARC mode, add the main ARC optimization passes.
534 if (LangOpts.ObjCAutoRefCount) {
535 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
536 addObjCARCExpandPass);
Dan Gohman5932ce22012-01-17 20:54:51 +0000537 PMBuilder.addExtension(PassManagerBuilder::EP_ModuleOptimizerEarly,
538 addObjCARCAPElimPass);
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000539 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
540 addObjCARCOptPass);
541 }
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000542
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000543 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds)) {
Nuno Lopesa4255892012-05-22 17:19:45 +0000544 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
545 addBoundsCheckingPass);
546 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
547 addBoundsCheckingPass);
548 }
549
Alexey Samsonovdfa908c2015-05-07 22:34:06 +0000550 if (CodeGenOpts.SanitizeCoverageType ||
551 CodeGenOpts.SanitizeCoverageIndirectCalls ||
552 CodeGenOpts.SanitizeCoverageTraceCmp) {
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000553 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
554 addSanitizerCoveragePass);
555 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
556 addSanitizerCoveragePass);
557 }
558
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000559 if (LangOpts.Sanitize.has(SanitizerKind::Address)) {
Kostya Serebryany7e247f22012-10-15 14:22:56 +0000560 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000561 addAddressSanitizerPasses);
Kostya Serebryanyd4768572011-11-30 22:20:21 +0000562 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000563 addAddressSanitizerPasses);
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000564 }
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000565
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000566 if (LangOpts.Sanitize.has(SanitizerKind::KernelAddress)) {
567 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
568 addKernelAddressSanitizerPasses);
569 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
570 addKernelAddressSanitizerPasses);
571 }
572
Evgeniy Stepanov12817e52017-12-09 01:32:07 +0000573 if (LangOpts.Sanitize.has(SanitizerKind::HWAddress)) {
574 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
575 addHWAddressSanitizerPasses);
576 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
577 addHWAddressSanitizerPasses);
578 }
579
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000580 if (LangOpts.Sanitize.has(SanitizerKind::Memory)) {
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000581 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
582 addMemorySanitizerPass);
583 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
584 addMemorySanitizerPass);
585 }
586
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000587 if (LangOpts.Sanitize.has(SanitizerKind::Thread)) {
Kostya Serebryanyd18cb502012-03-23 23:25:23 +0000588 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000589 addThreadSanitizerPass);
590 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
591 addThreadSanitizerPass);
592 }
593
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000594 if (LangOpts.Sanitize.has(SanitizerKind::DataFlow)) {
Peter Collingbournec3772752013-08-07 22:47:34 +0000595 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
596 addDataFlowSanitizerPass);
597 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
598 addDataFlowSanitizerPass);
599 }
600
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000601 if (LangOpts.CoroutinesTS)
602 addCoroutinePassesToExtensionPoints(PMBuilder);
603
Derek Bruening256c2e12016-04-21 21:32:04 +0000604 if (LangOpts.Sanitize.hasOneOf(SanitizerKind::Efficiency)) {
605 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
606 addEfficiencySanitizerPass);
607 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
608 addEfficiencySanitizerPass);
609 }
610
Chris Lattner5c123672011-05-21 20:40:11 +0000611 // Set up the per-function pass manager.
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000612 FPM.add(new TargetLibraryInfoWrapperPass(*TLII));
Chris Lattner5c123672011-05-21 20:40:11 +0000613 if (CodeGenOpts.VerifyModule)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000614 FPM.add(createVerifierPass());
Andrew Trickb2a84722011-04-05 18:49:32 +0000615
Chris Lattner5c123672011-05-21 20:40:11 +0000616 // Set up the per-module pass manager.
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000617 if (!CodeGenOpts.RewriteMapFiles.empty())
Peter Collingbourne03f89072016-07-15 00:55:40 +0000618 addSymbolRewriterPass(CodeGenOpts, &MPM);
Chris Lattnerd98cec52011-02-18 22:20:38 +0000619
David Blaikie7a4f7f52018-01-09 22:03:47 +0000620 if (Optional<GCOVOptions> Options = getGCOVOptions(CodeGenOpts)) {
621 MPM.add(createGCOVProfilerPass(*Options));
Benjamin Kramer8c305922016-02-02 11:06:51 +0000622 if (CodeGenOpts.getDebugInfo() == codegenoptions::NoDebugInfo)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000623 MPM.add(createStripSymbolsPass(true));
Nick Lewycky207bce32011-04-21 23:44:07 +0000624 }
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000625
Rong Xu9837ef52016-02-04 18:39:09 +0000626 if (CodeGenOpts.hasProfileClangInstr()) {
Justin Bogner970ac602014-12-08 19:04:51 +0000627 InstrProfOptions Options;
628 Options.NoRedZone = CodeGenOpts.DisableRedZone;
Justin Bognera71e6812015-04-30 23:49:42 +0000629 Options.InstrProfileOutput = CodeGenOpts.InstrProfileOutput;
Peter Collingbourne03f89072016-07-15 00:55:40 +0000630 MPM.add(createInstrProfilingLegacyPass(Options));
Justin Bogner970ac602014-12-08 19:04:51 +0000631 }
Rong Xu522b5cb2016-02-29 18:54:59 +0000632 if (CodeGenOpts.hasProfileIRInstr()) {
Xinliang David Lib65f8ae2016-07-23 04:28:59 +0000633 PMBuilder.EnablePGOInstrGen = true;
Rong Xu522b5cb2016-02-29 18:54:59 +0000634 if (!CodeGenOpts.InstrProfileOutput.empty())
635 PMBuilder.PGOInstrGen = CodeGenOpts.InstrProfileOutput;
636 else
Davide Italiano945de432017-02-13 16:07:05 +0000637 PMBuilder.PGOInstrGen = DefaultProfileGenName;
Rong Xu522b5cb2016-02-29 18:54:59 +0000638 }
Rong Xu9c6f1532016-03-02 20:59:36 +0000639 if (CodeGenOpts.hasProfileIRUse())
640 PMBuilder.PGOInstrUse = CodeGenOpts.ProfileInstrumentUsePath;
Justin Bogner970ac602014-12-08 19:04:51 +0000641
Dehao Chen5717aff2016-12-14 21:41:04 +0000642 if (!CodeGenOpts.SampleProfileFile.empty())
643 PMBuilder.PGOSampleUse = CodeGenOpts.SampleProfileFile;
Diego Novillod3ef1082015-08-25 15:25:13 +0000644
Peter Collingbourne03f89072016-07-15 00:55:40 +0000645 PMBuilder.populateFunctionPassManager(FPM);
646 PMBuilder.populateModulePassManager(MPM);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000647}
648
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000649static void setCommandLineOpts(const CodeGenOptions &CodeGenOpts) {
Yaxun Liub5e80c32016-04-12 20:22:32 +0000650 SmallVector<const char *, 16> BackendArgs;
651 BackendArgs.push_back("clang"); // Fake program name.
652 if (!CodeGenOpts.DebugPass.empty()) {
653 BackendArgs.push_back("-debug-pass");
654 BackendArgs.push_back(CodeGenOpts.DebugPass.c_str());
655 }
656 if (!CodeGenOpts.LimitFloatPrecision.empty()) {
657 BackendArgs.push_back("-limit-float-precision");
658 BackendArgs.push_back(CodeGenOpts.LimitFloatPrecision.c_str());
659 }
660 for (const std::string &BackendOption : CodeGenOpts.BackendOptions)
661 BackendArgs.push_back(BackendOption.c_str());
662 BackendArgs.push_back(nullptr);
663 llvm::cl::ParseCommandLineOptions(BackendArgs.size() - 1,
664 BackendArgs.data());
665}
666
Peter Collingbourne03f89072016-07-15 00:55:40 +0000667void EmitAssemblyHelper::CreateTargetMachine(bool MustCreateTM) {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000668 // Create the TargetMachine for generating code.
669 std::string Error;
670 std::string Triple = TheModule->getTargetTriple();
671 const llvm::Target *TheTarget = TargetRegistry::lookupTarget(Triple, Error);
672 if (!TheTarget) {
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000673 if (MustCreateTM)
Chad Rosierecafbe62013-03-27 00:14:35 +0000674 Diags.Report(diag::err_fe_unable_to_create_target) << Error;
Peter Collingbourne03f89072016-07-15 00:55:40 +0000675 return;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000676 }
677
Rafael Espindolaaa0226e2017-08-03 02:16:28 +0000678 Optional<llvm::CodeModel::Model> CM = getCodeModel(CodeGenOpts);
Eric Christopher583a1f72015-09-26 01:25:08 +0000679 std::string FeaturesStr =
680 llvm::join(TargetOpts.Features.begin(), TargetOpts.Features.end(), ",");
Rafael Espindolae1d70532018-01-18 00:20:03 +0000681 llvm::Reloc::Model RM = CodeGenOpts.RelocationModel;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000682 CodeGenOpt::Level OptLevel = getCGOptLevel(CodeGenOpts);
Evan Chengdd286bc2011-11-16 08:38:55 +0000683
Nick Lewycky432add52011-12-02 22:17:00 +0000684 llvm::TargetOptions Options;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000685 initTargetOptions(Options, CodeGenOpts, TargetOpts, LangOpts, HSOpts);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000686 TM.reset(TheTarget->createTargetMachine(Triple, TargetOpts.CPU, FeaturesStr,
687 Options, RM, CM, OptLevel));
Nadav Rotemec57ab32012-10-24 00:53:38 +0000688}
689
Peter Collingbourne03f89072016-07-15 00:55:40 +0000690bool EmitAssemblyHelper::AddEmitPasses(legacy::PassManager &CodeGenPasses,
691 BackendAction Action,
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000692 raw_pwrite_stream &OS) {
Chad Rosierb1cfc682012-02-29 20:14:59 +0000693 // Add LibraryInfo.
Daniel Dunbaraa437df2012-10-19 20:10:10 +0000694 llvm::Triple TargetTriple(TheModule->getTargetTriple());
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000695 std::unique_ptr<TargetLibraryInfoImpl> TLII(
696 createTLII(TargetTriple, CodeGenOpts));
Peter Collingbourne03f89072016-07-15 00:55:40 +0000697 CodeGenPasses.add(new TargetLibraryInfoWrapperPass(*TLII));
Chad Rosierb1cfc682012-02-29 20:14:59 +0000698
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000699 // Normal mode, emit a .s or .o file by running the code generator. Note,
700 // this also adds codegenerator level optimization passes.
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000701 TargetMachine::CodeGenFileType CGFT = getCodeGenFileType(Action);
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000702
703 // Add ObjC ARC final-cleanup optimizations. This is done as part of the
704 // "codegen" passes so that it isn't run multiple times when there is
705 // inlining happening.
Steven Wu1d56be82015-05-02 00:56:15 +0000706 if (CodeGenOpts.OptimizationLevel > 0)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000707 CodeGenPasses.add(createObjCARCContractPass());
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000708
Peter Collingbourne03f89072016-07-15 00:55:40 +0000709 if (TM->addPassesToEmitFile(CodeGenPasses, OS, CGFT,
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000710 /*DisableVerify=*/!CodeGenOpts.VerifyModule)) {
711 Diags.Report(diag::err_fe_unable_to_interface_with_target);
712 return false;
713 }
714
715 return true;
716}
717
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000718void EmitAssemblyHelper::EmitAssembly(BackendAction Action,
Peter Collingbourne03f89072016-07-15 00:55:40 +0000719 std::unique_ptr<raw_pwrite_stream> OS) {
Craig Topper8a13c412014-05-21 05:09:00 +0000720 TimeRegion Region(llvm::TimePassesIsEnabled ? &CodeGenerationTime : nullptr);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000721
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000722 setCommandLineOpts(CodeGenOpts);
Yaxun Liub5e80c32016-04-12 20:22:32 +0000723
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000724 bool UsesCodeGen = (Action != Backend_EmitNothing &&
725 Action != Backend_EmitBC &&
726 Action != Backend_EmitLL);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000727 CreateTargetMachine(UsesCodeGen);
Alp Tokerf4e22382013-12-20 20:26:53 +0000728
Rafael Espindolab633d202015-06-23 13:59:36 +0000729 if (UsesCodeGen && !TM)
730 return;
731 if (TM)
Mehdi Aminica3cf9e2015-07-24 16:04:29 +0000732 TheModule->setDataLayout(TM->createDataLayout());
Teresa Johnson4b4f4b92016-01-08 17:04:29 +0000733
Peter Collingbourne03f89072016-07-15 00:55:40 +0000734 legacy::PassManager PerModulePasses;
735 PerModulePasses.add(
736 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
737
738 legacy::FunctionPassManager PerFunctionPasses(TheModule);
739 PerFunctionPasses.add(
740 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
741
Teresa Johnson9e3f4742016-08-12 18:12:08 +0000742 CreatePasses(PerModulePasses, PerFunctionPasses);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000743
744 legacy::PassManager CodeGenPasses;
745 CodeGenPasses.add(
746 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
Nadav Rotemec57ab32012-10-24 00:53:38 +0000747
Teresa Johnson488d1dc2017-03-23 19:47:49 +0000748 std::unique_ptr<raw_fd_ostream> ThinLinkOS;
749
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000750 switch (Action) {
751 case Backend_EmitNothing:
752 break;
753
754 case Backend_EmitBC:
Teresa Johnson488d1dc2017-03-23 19:47:49 +0000755 if (CodeGenOpts.EmitSummaryIndex) {
756 if (!CodeGenOpts.ThinLinkBitcodeFile.empty()) {
757 std::error_code EC;
758 ThinLinkOS.reset(new llvm::raw_fd_ostream(
759 CodeGenOpts.ThinLinkBitcodeFile, EC,
760 llvm::sys::fs::F_None));
761 if (EC) {
762 Diags.Report(diag::err_fe_unable_to_open_output) << CodeGenOpts.ThinLinkBitcodeFile
763 << EC.message();
764 return;
765 }
766 }
767 PerModulePasses.add(
768 createWriteThinLTOBitcodePass(*OS, ThinLinkOS.get()));
769 }
Peter Collingbourneb8847162017-01-26 23:51:50 +0000770 else
771 PerModulePasses.add(
772 createBitcodeWriterPass(*OS, CodeGenOpts.EmitLLVMUseLists));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000773 break;
774
775 case Backend_EmitLL:
Peter Collingbourne03f89072016-07-15 00:55:40 +0000776 PerModulePasses.add(
Duncan P. N. Exon Smithbb9cadf2015-04-15 02:45:28 +0000777 createPrintModulePass(*OS, "", CodeGenOpts.EmitLLVMUseLists));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000778 break;
779
780 default:
Peter Collingbourne03f89072016-07-15 00:55:40 +0000781 if (!AddEmitPasses(CodeGenPasses, Action, *OS))
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000782 return;
783 }
784
Andrew Trick15e36e82011-04-05 18:56:55 +0000785 // Before executing passes, print the final values of the LLVM options.
786 cl::PrintOptionValues();
787
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000788 // Run passes. For now we do all passes at once, but eventually we
789 // would like to have the option of streaming code generation.
790
Peter Collingbourne03f89072016-07-15 00:55:40 +0000791 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000792 PrettyStackTraceString CrashInfo("Per-function optimization");
793
Peter Collingbourne03f89072016-07-15 00:55:40 +0000794 PerFunctionPasses.doInitialization();
Yaron Keren10d6d162015-06-05 09:40:53 +0000795 for (Function &F : *TheModule)
796 if (!F.isDeclaration())
Peter Collingbourne03f89072016-07-15 00:55:40 +0000797 PerFunctionPasses.run(F);
798 PerFunctionPasses.doFinalization();
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000799 }
800
Peter Collingbourne03f89072016-07-15 00:55:40 +0000801 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000802 PrettyStackTraceString CrashInfo("Per-module optimization passes");
Peter Collingbourne03f89072016-07-15 00:55:40 +0000803 PerModulePasses.run(*TheModule);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000804 }
805
Peter Collingbourne03f89072016-07-15 00:55:40 +0000806 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000807 PrettyStackTraceString CrashInfo("Code generation");
Peter Collingbourne03f89072016-07-15 00:55:40 +0000808 CodeGenPasses.run(*TheModule);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000809 }
810}
811
Chandler Carruth50f9e892016-12-23 20:44:01 +0000812static PassBuilder::OptimizationLevel mapToLevel(const CodeGenOptions &Opts) {
813 switch (Opts.OptimizationLevel) {
814 default:
815 llvm_unreachable("Invalid optimization level!");
816
817 case 1:
818 return PassBuilder::O1;
819
820 case 2:
821 switch (Opts.OptimizeSize) {
822 default:
823 llvm_unreachable("Invalide optimization level for size!");
824
825 case 0:
826 return PassBuilder::O2;
827
828 case 1:
829 return PassBuilder::Os;
830
831 case 2:
832 return PassBuilder::Oz;
833 }
834
835 case 3:
836 return PassBuilder::O3;
837 }
838}
839
840/// A clean version of `EmitAssembly` that uses the new pass manager.
841///
842/// Not all features are currently supported in this system, but where
843/// necessary it falls back to the legacy pass manager to at least provide
844/// basic functionality.
845///
846/// This API is planned to have its functionality finished and then to replace
847/// `EmitAssembly` at some point in the future when the default switches.
848void EmitAssemblyHelper::EmitAssemblyWithNewPassManager(
849 BackendAction Action, std::unique_ptr<raw_pwrite_stream> OS) {
850 TimeRegion Region(llvm::TimePassesIsEnabled ? &CodeGenerationTime : nullptr);
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000851 setCommandLineOpts(CodeGenOpts);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000852
853 // The new pass manager always makes a target machine available to passes
854 // during construction.
855 CreateTargetMachine(/*MustCreateTM*/ true);
856 if (!TM)
857 // This will already be diagnosed, just bail.
858 return;
859 TheModule->setDataLayout(TM->createDataLayout());
860
Dehao Chenc76a27e2017-07-27 15:29:53 +0000861 Optional<PGOOptions> PGOOpt;
Davide Italiano945de432017-02-13 16:07:05 +0000862
Dehao Chenc76a27e2017-07-27 15:29:53 +0000863 if (CodeGenOpts.hasProfileIRInstr())
864 // -fprofile-generate.
865 PGOOpt = PGOOptions(CodeGenOpts.InstrProfileOutput.empty()
866 ? DefaultProfileGenName
867 : CodeGenOpts.InstrProfileOutput,
868 "", "", true, CodeGenOpts.DebugInfoForProfiling);
869 else if (CodeGenOpts.hasProfileIRUse())
870 // -fprofile-use.
871 PGOOpt = PGOOptions("", CodeGenOpts.ProfileInstrumentUsePath, "", false,
872 CodeGenOpts.DebugInfoForProfiling);
873 else if (!CodeGenOpts.SampleProfileFile.empty())
874 // -fprofile-sample-use
875 PGOOpt = PGOOptions("", "", CodeGenOpts.SampleProfileFile, false,
876 CodeGenOpts.DebugInfoForProfiling);
877 else if (CodeGenOpts.DebugInfoForProfiling)
878 // -fdebug-info-for-profiling
879 PGOOpt = PGOOptions("", "", "", false, true);
Davide Italiano945de432017-02-13 16:07:05 +0000880
Dehao Chenc76a27e2017-07-27 15:29:53 +0000881 PassBuilder PB(TM.get(), PGOOpt);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000882
Craig Topper926b95c2017-11-14 08:48:28 +0000883 LoopAnalysisManager LAM(CodeGenOpts.DebugPassManager);
884 FunctionAnalysisManager FAM(CodeGenOpts.DebugPassManager);
885 CGSCCAnalysisManager CGAM(CodeGenOpts.DebugPassManager);
886 ModuleAnalysisManager MAM(CodeGenOpts.DebugPassManager);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000887
888 // Register the AA manager first so that our version is the one used.
889 FAM.registerPass([&] { return PB.buildDefaultAAPipeline(); });
890
Chandler Carruth9fdd5fa2017-07-25 10:46:07 +0000891 // Register the target library analysis directly and give it a customized
892 // preset TLI.
893 Triple TargetTriple(TheModule->getTargetTriple());
894 std::unique_ptr<TargetLibraryInfoImpl> TLII(
895 createTLII(TargetTriple, CodeGenOpts));
896 FAM.registerPass([&] { return TargetLibraryAnalysis(*TLII); });
897 MAM.registerPass([&] { return TargetLibraryAnalysis(*TLII); });
898
Chandler Carruth50f9e892016-12-23 20:44:01 +0000899 // Register all the basic analyses with the managers.
900 PB.registerModuleAnalyses(MAM);
901 PB.registerCGSCCAnalyses(CGAM);
902 PB.registerFunctionAnalyses(FAM);
903 PB.registerLoopAnalyses(LAM);
904 PB.crossRegisterProxies(LAM, FAM, CGAM, MAM);
905
Tim Shenb13eebe2017-06-29 23:10:13 +0000906 ModulePassManager MPM(CodeGenOpts.DebugPassManager);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000907
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000908 if (!CodeGenOpts.DisableLLVMPasses) {
Tim Shen66470692017-06-29 23:08:38 +0000909 bool IsThinLTO = CodeGenOpts.EmitSummaryIndex;
910 bool IsLTO = CodeGenOpts.PrepareForLTO;
911
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000912 if (CodeGenOpts.OptimizationLevel == 0) {
David Blaikieac904d02018-01-23 01:25:24 +0000913 if (Optional<GCOVOptions> Options = getGCOVOptions(CodeGenOpts))
914 MPM.addPass(GCOVProfilerPass(*Options));
915
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000916 // Build a minimal pipeline based on the semantics required by Clang,
917 // which is just that always inlining occurs.
918 MPM.addPass(AlwaysInlinerPass());
Chandler Carrutha8bd4e32017-11-14 01:59:18 +0000919
920 // At -O0 we directly run necessary sanitizer passes.
921 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds))
922 MPM.addPass(createModuleToFunctionPassAdaptor(BoundsCheckingPass()));
923
924 // Lastly, add a semantically necessary pass for ThinLTO.
Tim Shen66470692017-06-29 23:08:38 +0000925 if (IsThinLTO)
926 MPM.addPass(NameAnonGlobalPass());
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000927 } else {
Tim Shen66470692017-06-29 23:08:38 +0000928 // Map our optimization levels into one of the distinct levels used to
929 // configure the pipeline.
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000930 PassBuilder::OptimizationLevel Level = mapToLevel(CodeGenOpts);
931
Chandler Carrutha8bd4e32017-11-14 01:59:18 +0000932 // Register callbacks to schedule sanitizer passes at the appropriate part of
933 // the pipeline.
934 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds))
935 PB.registerScalarOptimizerLateEPCallback(
936 [](FunctionPassManager &FPM, PassBuilder::OptimizationLevel Level) {
937 FPM.addPass(BoundsCheckingPass());
938 });
David Blaikieac904d02018-01-23 01:25:24 +0000939 if (Optional<GCOVOptions> Options = getGCOVOptions(CodeGenOpts))
940 PB.registerPipelineStartEPCallback([Options](ModulePassManager &MPM) {
941 MPM.addPass(GCOVProfilerPass(*Options));
942 });
Chandler Carrutha8bd4e32017-11-14 01:59:18 +0000943
Tim Shen66470692017-06-29 23:08:38 +0000944 if (IsThinLTO) {
Tim Shenb13eebe2017-06-29 23:10:13 +0000945 MPM = PB.buildThinLTOPreLinkDefaultPipeline(
946 Level, CodeGenOpts.DebugPassManager);
Tim Shen66470692017-06-29 23:08:38 +0000947 MPM.addPass(NameAnonGlobalPass());
948 } else if (IsLTO) {
Tim Shenb13eebe2017-06-29 23:10:13 +0000949 MPM = PB.buildLTOPreLinkDefaultPipeline(Level,
950 CodeGenOpts.DebugPassManager);
Tim Shen66470692017-06-29 23:08:38 +0000951 } else {
Tim Shenb13eebe2017-06-29 23:10:13 +0000952 MPM = PB.buildPerModuleDefaultPipeline(Level,
953 CodeGenOpts.DebugPassManager);
Tim Shen66470692017-06-29 23:08:38 +0000954 }
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000955 }
Chandler Carruth50f9e892016-12-23 20:44:01 +0000956 }
957
958 // FIXME: We still use the legacy pass manager to do code generation. We
959 // create that pass manager here and use it as needed below.
960 legacy::PassManager CodeGenPasses;
961 bool NeedCodeGen = false;
Tim Shen50fedec2017-06-01 23:27:51 +0000962 Optional<raw_fd_ostream> ThinLinkOS;
Chandler Carruth50f9e892016-12-23 20:44:01 +0000963
964 // Append any output we need to the pass manager.
965 switch (Action) {
966 case Backend_EmitNothing:
967 break;
968
969 case Backend_EmitBC:
Tim Shen50fedec2017-06-01 23:27:51 +0000970 if (CodeGenOpts.EmitSummaryIndex) {
971 if (!CodeGenOpts.ThinLinkBitcodeFile.empty()) {
972 std::error_code EC;
973 ThinLinkOS.emplace(CodeGenOpts.ThinLinkBitcodeFile, EC,
974 llvm::sys::fs::F_None);
975 if (EC) {
976 Diags.Report(diag::err_fe_unable_to_open_output)
977 << CodeGenOpts.ThinLinkBitcodeFile << EC.message();
978 return;
979 }
980 }
981 MPM.addPass(
982 ThinLTOBitcodeWriterPass(*OS, ThinLinkOS ? &*ThinLinkOS : nullptr));
983 } else {
984 MPM.addPass(BitcodeWriterPass(*OS, CodeGenOpts.EmitLLVMUseLists,
985 CodeGenOpts.EmitSummaryIndex,
986 CodeGenOpts.EmitSummaryIndex));
987 }
Chandler Carruth50f9e892016-12-23 20:44:01 +0000988 break;
989
990 case Backend_EmitLL:
991 MPM.addPass(PrintModulePass(*OS, "", CodeGenOpts.EmitLLVMUseLists));
992 break;
993
994 case Backend_EmitAssembly:
995 case Backend_EmitMCNull:
996 case Backend_EmitObj:
997 NeedCodeGen = true;
998 CodeGenPasses.add(
999 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
1000 if (!AddEmitPasses(CodeGenPasses, Action, *OS))
1001 // FIXME: Should we handle this error differently?
1002 return;
1003 break;
1004 }
1005
1006 // Before executing passes, print the final values of the LLVM options.
1007 cl::PrintOptionValues();
1008
1009 // Now that we have all of the passes ready, run them.
1010 {
1011 PrettyStackTraceString CrashInfo("Optimizer");
1012 MPM.run(*TheModule, MAM);
1013 }
1014
1015 // Now if needed, run the legacy PM for codegen.
1016 if (NeedCodeGen) {
1017 PrettyStackTraceString CrashInfo("Code generation");
1018 CodeGenPasses.run(*TheModule);
1019 }
1020}
1021
Peter Collingbourne47d23642017-01-24 19:54:37 +00001022Expected<BitcodeModule> clang::FindThinLTOModule(MemoryBufferRef MBRef) {
1023 Expected<std::vector<BitcodeModule>> BMsOrErr = getBitcodeModuleList(MBRef);
1024 if (!BMsOrErr)
1025 return BMsOrErr.takeError();
1026
Peter Collingbournedbd2fed2017-06-15 17:26:13 +00001027 // The bitcode file may contain multiple modules, we want the one that is
1028 // marked as being the ThinLTO module.
Vitaly Bukac35ff822018-02-16 23:34:16 +00001029 if (const BitcodeModule *Bm = FindThinLTOModule(*BMsOrErr))
1030 return *Bm;
Peter Collingbourne47d23642017-01-24 19:54:37 +00001031
1032 return make_error<StringError>("Could not find module summary",
1033 inconvertibleErrorCode());
1034}
1035
Vitaly Bukac35ff822018-02-16 23:34:16 +00001036BitcodeModule *clang::FindThinLTOModule(MutableArrayRef<BitcodeModule> BMs) {
1037 for (BitcodeModule &BM : BMs) {
1038 Expected<BitcodeLTOInfo> LTOInfo = BM.getLTOInfo();
1039 if (LTOInfo && LTOInfo->IsThinLTO)
1040 return &BM;
1041 }
1042 return nullptr;
1043}
1044
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001045static void runThinLTOBackend(ModuleSummaryIndex *CombinedIndex, Module *M,
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001046 const HeaderSearchOptions &HeaderOpts,
1047 const CodeGenOptions &CGOpts,
1048 const clang::TargetOptions &TOpts,
1049 const LangOptions &LOpts,
Dehao Chena1bd2d62017-01-13 00:51:55 +00001050 std::unique_ptr<raw_pwrite_stream> OS,
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001051 std::string SampleProfile,
1052 BackendAction Action) {
Dehao Chen5f83d0e2017-07-10 20:31:37 +00001053 StringMap<DenseMap<GlobalValue::GUID, GlobalValueSummary *>>
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001054 ModuleToDefinedGVSummaries;
1055 CombinedIndex->collectDefinedGVSummariesPerModule(ModuleToDefinedGVSummaries);
1056
David Blaikie6e2ec5f2017-04-19 20:08:21 +00001057 setCommandLineOpts(CGOpts);
1058
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001059 // We can simply import the values mentioned in the combined index, since
1060 // we should only invoke this using the individual indexes written out
1061 // via a WriteIndexesThinBackend.
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001062 FunctionImporter::ImportMapTy ImportList;
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001063 for (auto &GlobalList : *CombinedIndex) {
Peter Collingbourne9667b912017-05-04 18:03:25 +00001064 // Ignore entries for undefined references.
1065 if (GlobalList.second.SummaryList.empty())
1066 continue;
1067
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001068 auto GUID = GlobalList.first;
Peter Collingbourne9667b912017-05-04 18:03:25 +00001069 assert(GlobalList.second.SummaryList.size() == 1 &&
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001070 "Expected individual combined index to have one summary per GUID");
Peter Collingbourne9667b912017-05-04 18:03:25 +00001071 auto &Summary = GlobalList.second.SummaryList[0];
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001072 // Skip the summaries for the importing module. These are included to
1073 // e.g. record required linkage changes.
1074 if (Summary->modulePath() == M->getModuleIdentifier())
1075 continue;
1076 // Doesn't matter what value we plug in to the map, just needs an entry
1077 // to provoke importing by thinBackend.
1078 ImportList[Summary->modulePath()][GUID] = 1;
1079 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001080
1081 std::vector<std::unique_ptr<llvm::MemoryBuffer>> OwnedImports;
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001082 MapVector<llvm::StringRef, llvm::BitcodeModule> ModuleMap;
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001083
1084 for (auto &I : ImportList) {
1085 ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> MBOrErr =
1086 llvm::MemoryBuffer::getFile(I.first());
1087 if (!MBOrErr) {
1088 errs() << "Error loading imported file '" << I.first()
1089 << "': " << MBOrErr.getError().message() << "\n";
1090 return;
1091 }
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001092
Peter Collingbourne47d23642017-01-24 19:54:37 +00001093 Expected<BitcodeModule> BMOrErr = FindThinLTOModule(**MBOrErr);
1094 if (!BMOrErr) {
1095 handleAllErrors(BMOrErr.takeError(), [&](ErrorInfoBase &EIB) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001096 errs() << "Error loading imported file '" << I.first()
1097 << "': " << EIB.message() << '\n';
1098 });
1099 return;
1100 }
Peter Collingbourne47d23642017-01-24 19:54:37 +00001101 ModuleMap.insert({I.first(), *BMOrErr});
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001102
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001103 OwnedImports.push_back(std::move(*MBOrErr));
1104 }
Peter Collingbourne2d3a26f2016-09-23 21:43:51 +00001105 auto AddStream = [&](size_t Task) {
1106 return llvm::make_unique<lto::NativeObjectStream>(std::move(OS));
Mehdi Amini406aa222016-08-17 06:23:08 +00001107 };
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001108 lto::Config Conf;
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001109 Conf.CPU = TOpts.CPU;
1110 Conf.CodeModel = getCodeModel(CGOpts);
1111 Conf.MAttrs = TOpts.Features;
Rafael Espindolae1d70532018-01-18 00:20:03 +00001112 Conf.RelocModel = CGOpts.RelocationModel;
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001113 Conf.CGOptLevel = getCGOptLevel(CGOpts);
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001114 initTargetOptions(Conf.Options, CGOpts, TOpts, LOpts, HeaderOpts);
Benjamin Kramerf6021ec2017-03-21 21:35:04 +00001115 Conf.SampleProfile = std::move(SampleProfile);
Tim Shen50fedec2017-06-01 23:27:51 +00001116 Conf.UseNewPM = CGOpts.ExperimentalNewPassManager;
Teresa Johnson4cd016ab2017-11-13 15:38:33 +00001117 Conf.DebugPassManager = CGOpts.DebugPassManager;
Teresa Johnsonb637cb02017-03-31 22:35:47 +00001118 switch (Action) {
1119 case Backend_EmitNothing:
1120 Conf.PreCodeGenModuleHook = [](size_t Task, const Module &Mod) {
1121 return false;
1122 };
1123 break;
1124 case Backend_EmitLL:
1125 Conf.PreCodeGenModuleHook = [&](size_t Task, const Module &Mod) {
1126 M->print(*OS, nullptr, CGOpts.EmitLLVMUseLists);
1127 return false;
1128 };
1129 break;
1130 case Backend_EmitBC:
1131 Conf.PreCodeGenModuleHook = [&](size_t Task, const Module &Mod) {
Rafael Espindola76c8f822018-02-14 19:11:37 +00001132 WriteBitcodeToFile(*M, *OS, CGOpts.EmitLLVMUseLists);
Teresa Johnsonb637cb02017-03-31 22:35:47 +00001133 return false;
1134 };
1135 break;
1136 default:
1137 Conf.CGFileType = getCodeGenFileType(Action);
1138 break;
1139 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001140 if (Error E = thinBackend(
Peter Collingbourne2d3a26f2016-09-23 21:43:51 +00001141 Conf, 0, AddStream, *M, *CombinedIndex, ImportList,
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001142 ModuleToDefinedGVSummaries[M->getModuleIdentifier()], ModuleMap)) {
1143 handleAllErrors(std::move(E), [&](ErrorInfoBase &EIB) {
1144 errs() << "Error running ThinLTO backend: " << EIB.message() << '\n';
1145 });
1146 }
1147}
1148
David Blaikie9c902b52011-09-25 23:23:43 +00001149void clang::EmitBackendOutput(DiagnosticsEngine &Diags,
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001150 const HeaderSearchOptions &HeaderOpts,
David Blaikie9c902b52011-09-25 23:23:43 +00001151 const CodeGenOptions &CGOpts,
Nick Lewycky432add52011-12-02 22:17:00 +00001152 const clang::TargetOptions &TOpts,
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001153 const LangOptions &LOpts,
1154 const llvm::DataLayout &TDesc, Module *M,
1155 BackendAction Action,
Peter Collingbourne03f89072016-07-15 00:55:40 +00001156 std::unique_ptr<raw_pwrite_stream> OS) {
Vitaly Buka769134d2018-02-16 23:38:22 +00001157 std::unique_ptr<llvm::Module> EmptyModule;
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001158 if (!CGOpts.ThinLTOIndexFile.empty()) {
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001159 // If we are performing a ThinLTO importing compile, load the function index
1160 // into memory and pass it into runThinLTOBackend, which will run the
1161 // function importer and invoke LTO passes.
1162 Expected<std::unique_ptr<ModuleSummaryIndex>> IndexOrErr =
Teresa Johnson517729f2017-05-12 19:32:17 +00001163 llvm::getModuleSummaryIndexForFile(CGOpts.ThinLTOIndexFile,
1164 /*IgnoreEmptyThinLTOIndexFile*/true);
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001165 if (!IndexOrErr) {
1166 logAllUnhandledErrors(IndexOrErr.takeError(), errs(),
1167 "Error loading index file '" +
1168 CGOpts.ThinLTOIndexFile + "': ");
1169 return;
1170 }
1171 std::unique_ptr<ModuleSummaryIndex> CombinedIndex = std::move(*IndexOrErr);
1172 // A null CombinedIndex means we should skip ThinLTO compilation
1173 // (LLVM will optionally ignore empty index files, returning null instead
1174 // of an error).
Vitaly Buka769134d2018-02-16 23:38:22 +00001175 if (CombinedIndex) {
1176 if (!CombinedIndex->skipModuleByDistributedBackend()) {
1177 runThinLTOBackend(CombinedIndex.get(), M, HeaderOpts, CGOpts, TOpts,
1178 LOpts, std::move(OS), CGOpts.SampleProfileFile,
1179 Action);
1180 return;
1181 }
1182 // Distributed indexing detected that nothing from the module is needed
1183 // for the final linking. So we can skip the compilation. We sill need to
1184 // output an empty object file to make sure that a linker does not fail
1185 // trying to read it. Also for some features, like CFI, we must skip
1186 // the compilation as CombinedIndex does not contain all required
1187 // information.
1188 EmptyModule = llvm::make_unique<llvm::Module>("empty", M->getContext());
1189 EmptyModule->setTargetTriple(M->getTargetTriple());
1190 M = EmptyModule.get();
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001191 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001192 }
1193
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001194 EmitAssemblyHelper AsmHelper(Diags, HeaderOpts, CGOpts, TOpts, LOpts, M);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +00001195
Chandler Carruth50f9e892016-12-23 20:44:01 +00001196 if (CGOpts.ExperimentalNewPassManager)
1197 AsmHelper.EmitAssemblyWithNewPassManager(Action, std::move(OS));
1198 else
1199 AsmHelper.EmitAssembly(Action, std::move(OS));
Alp Tokere83b9062014-01-02 15:08:04 +00001200
James Y Knightb214cbc2016-03-04 19:00:41 +00001201 // Verify clang's TargetInfo DataLayout against the LLVM TargetMachine's
1202 // DataLayout.
1203 if (AsmHelper.TM) {
Mehdi Aminica3cf9e2015-07-24 16:04:29 +00001204 std::string DLDesc = M->getDataLayout().getStringRepresentation();
James Y Knightb214cbc2016-03-04 19:00:41 +00001205 if (DLDesc != TDesc.getStringRepresentation()) {
Alp Tokere83b9062014-01-02 15:08:04 +00001206 unsigned DiagID = Diags.getCustomDiagID(
1207 DiagnosticsEngine::Error, "backend data layout '%0' does not match "
1208 "expected target description '%1'");
James Y Knightb214cbc2016-03-04 19:00:41 +00001209 Diags.Report(DiagID) << DLDesc << TDesc.getStringRepresentation();
Alp Tokere83b9062014-01-02 15:08:04 +00001210 }
1211 }
Daniel Dunbarf976d1b2010-06-07 23:20:08 +00001212}
Steven Wu27fb5222016-05-11 16:26:03 +00001213
1214static const char* getSectionNameForBitcode(const Triple &T) {
1215 switch (T.getObjectFormat()) {
1216 case Triple::MachO:
1217 return "__LLVM,__bitcode";
1218 case Triple::COFF:
1219 case Triple::ELF:
Dan Gohman839f2152017-01-17 21:46:38 +00001220 case Triple::Wasm:
Steven Wu27fb5222016-05-11 16:26:03 +00001221 case Triple::UnknownObjectFormat:
1222 return ".llvmbc";
1223 }
Simon Pilgrimbff9dae2016-05-11 21:55:37 +00001224 llvm_unreachable("Unimplemented ObjectFormatType");
Steven Wu27fb5222016-05-11 16:26:03 +00001225}
1226
1227static const char* getSectionNameForCommandline(const Triple &T) {
1228 switch (T.getObjectFormat()) {
1229 case Triple::MachO:
1230 return "__LLVM,__cmdline";
1231 case Triple::COFF:
1232 case Triple::ELF:
Dan Gohman839f2152017-01-17 21:46:38 +00001233 case Triple::Wasm:
Steven Wu27fb5222016-05-11 16:26:03 +00001234 case Triple::UnknownObjectFormat:
1235 return ".llvmcmd";
1236 }
Simon Pilgrimbff9dae2016-05-11 21:55:37 +00001237 llvm_unreachable("Unimplemented ObjectFormatType");
Steven Wu27fb5222016-05-11 16:26:03 +00001238}
1239
1240// With -fembed-bitcode, save a copy of the llvm IR as data in the
1241// __LLVM,__bitcode section.
1242void clang::EmbedBitcode(llvm::Module *M, const CodeGenOptions &CGOpts,
1243 llvm::MemoryBufferRef Buf) {
1244 if (CGOpts.getEmbedBitcode() == CodeGenOptions::Embed_Off)
1245 return;
1246
Steven Wu2c059a52016-05-16 18:54:58 +00001247 // Save llvm.compiler.used and remote it.
1248 SmallVector<Constant*, 2> UsedArray;
1249 SmallSet<GlobalValue*, 4> UsedGlobals;
1250 Type *UsedElementType = Type::getInt8Ty(M->getContext())->getPointerTo(0);
1251 GlobalVariable *Used = collectUsedGlobalVariables(*M, UsedGlobals, true);
1252 for (auto *GV : UsedGlobals) {
1253 if (GV->getName() != "llvm.embedded.module" &&
1254 GV->getName() != "llvm.cmdline")
1255 UsedArray.push_back(
1256 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
1257 }
1258 if (Used)
1259 Used->eraseFromParent();
1260
Steven Wu27fb5222016-05-11 16:26:03 +00001261 // Embed the bitcode for the llvm module.
1262 std::string Data;
1263 ArrayRef<uint8_t> ModuleData;
1264 Triple T(M->getTargetTriple());
1265 // Create a constant that contains the bitcode.
1266 // In case of embedding a marker, ignore the input Buf and use the empty
1267 // ArrayRef. It is also legal to create a bitcode marker even Buf is empty.
1268 if (CGOpts.getEmbedBitcode() != CodeGenOptions::Embed_Marker) {
1269 if (!isBitcode((const unsigned char *)Buf.getBufferStart(),
1270 (const unsigned char *)Buf.getBufferEnd())) {
1271 // If the input is LLVM Assembly, bitcode is produced by serializing
1272 // the module. Use-lists order need to be perserved in this case.
1273 llvm::raw_string_ostream OS(Data);
Rafael Espindola76c8f822018-02-14 19:11:37 +00001274 llvm::WriteBitcodeToFile(*M, OS, /* ShouldPreserveUseListOrder */ true);
Steven Wu27fb5222016-05-11 16:26:03 +00001275 ModuleData =
1276 ArrayRef<uint8_t>((const uint8_t *)OS.str().data(), OS.str().size());
1277 } else
1278 // If the input is LLVM bitcode, write the input byte stream directly.
1279 ModuleData = ArrayRef<uint8_t>((const uint8_t *)Buf.getBufferStart(),
1280 Buf.getBufferSize());
1281 }
1282 llvm::Constant *ModuleConstant =
1283 llvm::ConstantDataArray::get(M->getContext(), ModuleData);
Steven Wu27fb5222016-05-11 16:26:03 +00001284 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
Steven Wu2c059a52016-05-16 18:54:58 +00001285 *M, ModuleConstant->getType(), true, llvm::GlobalValue::PrivateLinkage,
Steven Wu27fb5222016-05-11 16:26:03 +00001286 ModuleConstant);
1287 GV->setSection(getSectionNameForBitcode(T));
Steven Wu2c059a52016-05-16 18:54:58 +00001288 UsedArray.push_back(
1289 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
Steven Wu27fb5222016-05-11 16:26:03 +00001290 if (llvm::GlobalVariable *Old =
Steven Wu2c059a52016-05-16 18:54:58 +00001291 M->getGlobalVariable("llvm.embedded.module", true)) {
1292 assert(Old->hasOneUse() &&
1293 "llvm.embedded.module can only be used once in llvm.compiler.used");
Steven Wu27fb5222016-05-11 16:26:03 +00001294 GV->takeName(Old);
1295 Old->eraseFromParent();
1296 } else {
1297 GV->setName("llvm.embedded.module");
1298 }
1299
Steven Wu2c059a52016-05-16 18:54:58 +00001300 // Skip if only bitcode needs to be embedded.
1301 if (CGOpts.getEmbedBitcode() != CodeGenOptions::Embed_Bitcode) {
1302 // Embed command-line options.
Saleem Abdulrasoolb1d50c12016-05-20 03:58:12 +00001303 ArrayRef<uint8_t> CmdData(const_cast<uint8_t *>(CGOpts.CmdArgs.data()),
Steven Wu2c059a52016-05-16 18:54:58 +00001304 CGOpts.CmdArgs.size());
1305 llvm::Constant *CmdConstant =
1306 llvm::ConstantDataArray::get(M->getContext(), CmdData);
1307 GV = new llvm::GlobalVariable(*M, CmdConstant->getType(), true,
1308 llvm::GlobalValue::PrivateLinkage,
1309 CmdConstant);
1310 GV->setSection(getSectionNameForCommandline(T));
1311 UsedArray.push_back(
1312 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
1313 if (llvm::GlobalVariable *Old =
1314 M->getGlobalVariable("llvm.cmdline", true)) {
1315 assert(Old->hasOneUse() &&
1316 "llvm.cmdline can only be used once in llvm.compiler.used");
1317 GV->takeName(Old);
1318 Old->eraseFromParent();
1319 } else {
1320 GV->setName("llvm.cmdline");
1321 }
1322 }
1323
1324 if (UsedArray.empty())
Steven Wu27fb5222016-05-11 16:26:03 +00001325 return;
1326
Steven Wu2c059a52016-05-16 18:54:58 +00001327 // Recreate llvm.compiler.used.
1328 ArrayType *ATy = ArrayType::get(UsedElementType, UsedArray.size());
1329 auto *NewUsed = new GlobalVariable(
1330 *M, ATy, false, llvm::GlobalValue::AppendingLinkage,
1331 llvm::ConstantArray::get(ATy, UsedArray), "llvm.compiler.used");
1332 NewUsed->setSection("llvm.metadata");
Steven Wu27fb5222016-05-11 16:26:03 +00001333}