blob: 02b1b1b7d3b1e33189adb8b7a316fd5dd9b7e5ba [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"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000049#include "llvm/Transforms/IPO.h"
Chandler Carruthb72c19f2016-08-17 03:09:11 +000050#include "llvm/Transforms/IPO/AlwaysInliner.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000051#include "llvm/Transforms/IPO/PassManagerBuilder.h"
Tim Shen50fedec2017-06-01 23:27:51 +000052#include "llvm/Transforms/IPO/ThinLTOBitcodeWriter.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000053#include "llvm/Transforms/Instrumentation.h"
Chandler Carruthafce4492017-11-14 01:47:24 +000054#include "llvm/Transforms/Instrumentation/BoundsChecking.h"
David Blaikie4e1ae832018-03-23 22:16:59 +000055#include "llvm/Transforms/Instrumentation/GCOVProfiler.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"
David Blaikiec133b1e2018-03-28 17:45:10 +000059#include "llvm/Transforms/Utils.h"
Tim Shen66470692017-06-29 23:08:38 +000060#include "llvm/Transforms/Utils/NameAnonGlobals.h"
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +000061#include "llvm/Transforms/Utils/SymbolRewriter.h"
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000062#include <memory>
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000063using namespace clang;
64using namespace llvm;
65
66namespace {
67
Davide Italiano945de432017-02-13 16:07:05 +000068// Default filename used for profile generation.
69static constexpr StringLiteral DefaultProfileGenName = "default_%m.profraw";
70
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000071class EmitAssemblyHelper {
David Blaikie9c902b52011-09-25 23:23:43 +000072 DiagnosticsEngine &Diags;
Saleem Abdulrasool888e2892017-01-05 16:02:32 +000073 const HeaderSearchOptions &HSOpts;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000074 const CodeGenOptions &CodeGenOpts;
Nick Lewycky432add52011-12-02 22:17:00 +000075 const clang::TargetOptions &TargetOpts;
Dan Gohmanfec0ff82011-07-05 22:02:36 +000076 const LangOptions &LangOpts;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000077 Module *TheModule;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000078
79 Timer CodeGenerationTime;
80
Peter Collingbourne03f89072016-07-15 00:55:40 +000081 std::unique_ptr<raw_pwrite_stream> OS;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000082
Chandler Carruthd294bdb2015-02-01 12:26:23 +000083 TargetIRAnalysis getTargetIRAnalysis() const {
Chandler Carruthaab5ec02015-01-31 11:18:46 +000084 if (TM)
Chandler Carruthd294bdb2015-02-01 12:26:23 +000085 return TM->getTargetIRAnalysis();
Chandler Carruthaab5ec02015-01-31 11:18:46 +000086
Chandler Carruthd294bdb2015-02-01 12:26:23 +000087 return TargetIRAnalysis();
Chandler Carruthaab5ec02015-01-31 11:18:46 +000088 }
89
Teresa Johnson9e3f4742016-08-12 18:12:08 +000090 void CreatePasses(legacy::PassManager &MPM, legacy::FunctionPassManager &FPM);
Nadav Rotemec57ab32012-10-24 00:53:38 +000091
Rafael Espindola2f16bc12015-04-14 15:15:49 +000092 /// Generates the TargetMachine.
Peter Collingbourne03f89072016-07-15 00:55:40 +000093 /// Leaves TM unchanged if it is unable to create the target machine.
Nadav Rotemdc06b2d2012-10-24 03:52:31 +000094 /// Some of our clang tests specify triples which are not built
95 /// into clang. This is okay because these tests check the generated
96 /// IR, and they require DataLayout which depends on the triple.
97 /// In this case, we allow this method to fail and not report an error.
98 /// When MustCreateTM is used, we print an error if we are unable to load
99 /// the requested target.
Peter Collingbourne03f89072016-07-15 00:55:40 +0000100 void CreateTargetMachine(bool MustCreateTM);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000101
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000102 /// Add passes necessary to emit assembly or LLVM IR.
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000103 ///
104 /// \return True on success.
Peter Collingbourne03f89072016-07-15 00:55:40 +0000105 bool AddEmitPasses(legacy::PassManager &CodeGenPasses, BackendAction Action,
106 raw_pwrite_stream &OS);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000107
108public:
Saleem Abdulrasool888e2892017-01-05 16:02:32 +0000109 EmitAssemblyHelper(DiagnosticsEngine &_Diags,
110 const HeaderSearchOptions &HeaderSearchOpts,
111 const CodeGenOptions &CGOpts,
Nick Lewycky432add52011-12-02 22:17:00 +0000112 const clang::TargetOptions &TOpts,
Teresa Johnson4b4f4b92016-01-08 17:04:29 +0000113 const LangOptions &LOpts, Module *M)
Saleem Abdulrasool888e2892017-01-05 16:02:32 +0000114 : Diags(_Diags), HSOpts(HeaderSearchOpts), CodeGenOpts(CGOpts),
115 TargetOpts(TOpts), LangOpts(LOpts), TheModule(M),
116 CodeGenerationTime("codegen", "Code Generation Time") {}
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000117
118 ~EmitAssemblyHelper() {
Alp Tokerf4e22382013-12-20 20:26:53 +0000119 if (CodeGenOpts.DisableFree)
David Blaikiea97eaa12014-08-29 16:53:14 +0000120 BuryPointer(std::move(TM));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000121 }
122
Ahmed Charlesb8984322014-03-07 20:03:18 +0000123 std::unique_ptr<TargetMachine> TM;
Alp Tokerf4e22382013-12-20 20:26:53 +0000124
Peter Collingbourne03f89072016-07-15 00:55:40 +0000125 void EmitAssembly(BackendAction Action,
126 std::unique_ptr<raw_pwrite_stream> OS);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000127
128 void EmitAssemblyWithNewPassManager(BackendAction Action,
129 std::unique_ptr<raw_pwrite_stream> OS);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000130};
131
Alexey Samsonovc6515b62012-12-28 09:31:34 +0000132// We need this wrapper to access LangOpts and CGOpts from extension functions
133// that we add to the PassManagerBuilder.
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000134class PassManagerBuilderWrapper : public PassManagerBuilder {
135public:
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000136 PassManagerBuilderWrapper(const Triple &TargetTriple,
137 const CodeGenOptions &CGOpts,
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000138 const LangOptions &LangOpts)
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000139 : PassManagerBuilder(), TargetTriple(TargetTriple), CGOpts(CGOpts),
140 LangOpts(LangOpts) {}
141 const Triple &getTargetTriple() const { return TargetTriple; }
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000142 const CodeGenOptions &getCGOpts() const { return CGOpts; }
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000143 const LangOptions &getLangOpts() const { return LangOpts; }
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000144
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000145private:
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000146 const Triple &TargetTriple;
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000147 const CodeGenOptions &CGOpts;
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000148 const LangOptions &LangOpts;
149};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000150}
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000151
Dan Gohman5932ce22012-01-17 20:54:51 +0000152static void addObjCARCAPElimPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
153 if (Builder.OptLevel > 0)
154 PM.add(createObjCARCAPElimPass());
155}
156
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000157static void addObjCARCExpandPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
158 if (Builder.OptLevel > 0)
159 PM.add(createObjCARCExpandPass());
160}
161
162static void addObjCARCOptPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
163 if (Builder.OptLevel > 0)
164 PM.add(createObjCARCOptPass());
165}
166
Diego Novillob56be642014-03-03 20:06:18 +0000167static void addAddDiscriminatorsPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000168 legacy::PassManagerBase &PM) {
Diego Novillob56be642014-03-03 20:06:18 +0000169 PM.add(createAddDiscriminatorsPass());
170}
171
Nuno Lopesa4255892012-05-22 17:19:45 +0000172static void addBoundsCheckingPass(const PassManagerBuilder &Builder,
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000173 legacy::PassManagerBase &PM) {
Chandler Carruth00a301d2017-11-14 01:30:04 +0000174 PM.add(createBoundsCheckingLegacyPass());
Nuno Lopesa4255892012-05-22 17:19:45 +0000175}
176
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000177static void addSanitizerCoveragePass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000178 legacy::PassManagerBase &PM) {
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000179 const PassManagerBuilderWrapper &BuilderWrapper =
180 static_cast<const PassManagerBuilderWrapper&>(Builder);
181 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
Alexey Samsonov3f3b3ab2015-05-07 18:31:29 +0000182 SanitizerCoverageOptions Opts;
183 Opts.CoverageType =
184 static_cast<SanitizerCoverageOptions::Type>(CGOpts.SanitizeCoverageType);
185 Opts.IndirectCalls = CGOpts.SanitizeCoverageIndirectCalls;
186 Opts.TraceBB = CGOpts.SanitizeCoverageTraceBB;
187 Opts.TraceCmp = CGOpts.SanitizeCoverageTraceCmp;
Kostya Serebryany3b419712016-08-30 01:27:03 +0000188 Opts.TraceDiv = CGOpts.SanitizeCoverageTraceDiv;
189 Opts.TraceGep = CGOpts.SanitizeCoverageTraceGep;
Alexey Samsonov3f3b3ab2015-05-07 18:31:29 +0000190 Opts.Use8bitCounters = CGOpts.SanitizeCoverage8bitCounters;
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000191 Opts.TracePC = CGOpts.SanitizeCoverageTracePC;
Kostya Serebryany60cdd612016-09-14 01:39:49 +0000192 Opts.TracePCGuard = CGOpts.SanitizeCoverageTracePCGuard;
Kostya Serebryany50fb6182017-05-05 23:28:18 +0000193 Opts.NoPrune = CGOpts.SanitizeCoverageNoPrune;
Kostya Serebryany2c2fb882017-06-08 22:58:19 +0000194 Opts.Inline8bitCounters = CGOpts.SanitizeCoverageInline8bitCounters;
Kostya Serebryany61457762017-07-28 00:10:10 +0000195 Opts.PCTable = CGOpts.SanitizeCoveragePCTable;
Matt Morehouse5c7fc762017-08-18 18:43:30 +0000196 Opts.StackDepth = CGOpts.SanitizeCoverageStackDepth;
Alexey Samsonov3f3b3ab2015-05-07 18:31:29 +0000197 PM.add(createSanitizerCoverageModulePass(Opts));
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000198}
199
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000200// Check if ASan should use GC-friendly instrumentation for globals.
201// First of all, there is no point if -fdata-sections is off (expect for MachO,
202// where this is not a factor). Also, on ELF this feature requires an assembler
203// extension that only works with -integrated-as at the moment.
204static bool asanUseGlobalsGC(const Triple &T, const CodeGenOptions &CGOpts) {
Evgeniy Stepanovd991cdd2017-05-09 21:57:43 +0000205 if (!CGOpts.SanitizeAddressGlobalsDeadStripping)
206 return false;
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000207 switch (T.getObjectFormat()) {
208 case Triple::MachO:
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000209 case Triple::COFF:
Evgeniy Stepanovc7b90942017-04-26 00:51:06 +0000210 return true;
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000211 case Triple::ELF:
212 return CGOpts.DataSections && !CGOpts.DisableIntegratedAS;
213 default:
214 return false;
215 }
216}
217
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000218static void addAddressSanitizerPasses(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000219 legacy::PassManagerBase &PM) {
Yury Gribov5bfeca12015-11-11 10:45:48 +0000220 const PassManagerBuilderWrapper &BuilderWrapper =
221 static_cast<const PassManagerBuilderWrapper&>(Builder);
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000222 const Triple &T = BuilderWrapper.getTargetTriple();
Yury Gribov5bfeca12015-11-11 10:45:48 +0000223 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
224 bool Recover = CGOpts.SanitizeRecover.has(SanitizerKind::Address);
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000225 bool UseAfterScope = CGOpts.SanitizeAddressUseAfterScope;
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000226 bool UseGlobalsGC = asanUseGlobalsGC(T, CGOpts);
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000227 PM.add(createAddressSanitizerFunctionPass(/*CompileKernel*/ false, Recover,
228 UseAfterScope));
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000229 PM.add(createAddressSanitizerModulePass(/*CompileKernel*/ false, Recover,
230 UseGlobalsGC));
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000231}
232
233static void addKernelAddressSanitizerPasses(const PassManagerBuilder &Builder,
234 legacy::PassManagerBase &PM) {
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000235 PM.add(createAddressSanitizerFunctionPass(
236 /*CompileKernel*/ true,
237 /*Recover*/ true, /*UseAfterScope*/ false));
Yury Gribov5bfeca12015-11-11 10:45:48 +0000238 PM.add(createAddressSanitizerModulePass(/*CompileKernel*/true,
239 /*Recover*/true));
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000240}
241
Evgeniy Stepanov12817e52017-12-09 01:32:07 +0000242static void addHWAddressSanitizerPasses(const PassManagerBuilder &Builder,
243 legacy::PassManagerBase &PM) {
Evgeniy Stepanov3fd1b1a2017-12-20 19:05:44 +0000244 const PassManagerBuilderWrapper &BuilderWrapper =
245 static_cast<const PassManagerBuilderWrapper &>(Builder);
246 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
247 bool Recover = CGOpts.SanitizeRecover.has(SanitizerKind::HWAddress);
248 PM.add(createHWAddressSanitizerPass(Recover));
Evgeniy Stepanov12817e52017-12-09 01:32:07 +0000249}
250
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000251static void addMemorySanitizerPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000252 legacy::PassManagerBase &PM) {
Evgeniy Stepanovad8ab3d2012-12-24 08:42:34 +0000253 const PassManagerBuilderWrapper &BuilderWrapper =
254 static_cast<const PassManagerBuilderWrapper&>(Builder);
255 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
Evgeniy Stepanov5b5370a2016-11-07 21:02:11 +0000256 int TrackOrigins = CGOpts.SanitizeMemoryTrackOrigins;
257 bool Recover = CGOpts.SanitizeRecover.has(SanitizerKind::Memory);
258 PM.add(createMemorySanitizerPass(TrackOrigins, Recover));
Evgeniy Stepanov10284672013-01-31 09:53:29 +0000259
260 // MemorySanitizer inserts complex instrumentation that mostly follows
261 // the logic of the original code, but operates on "shadow" values.
262 // It can benefit from re-running some general purpose optimization passes.
263 if (Builder.OptLevel > 0) {
264 PM.add(createEarlyCSEPass());
265 PM.add(createReassociatePass());
266 PM.add(createLICMPass());
267 PM.add(createGVNPass());
268 PM.add(createInstructionCombiningPass());
269 PM.add(createDeadStoreEliminationPass());
270 }
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000271}
272
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000273static void addThreadSanitizerPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000274 legacy::PassManagerBase &PM) {
Alexey Samsonov1cf07ea2014-06-02 18:08:08 +0000275 PM.add(createThreadSanitizerPass());
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000276}
277
Peter Collingbournec3772752013-08-07 22:47:34 +0000278static void addDataFlowSanitizerPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000279 legacy::PassManagerBase &PM) {
Peter Collingbourne276be3c2013-08-14 18:54:18 +0000280 const PassManagerBuilderWrapper &BuilderWrapper =
281 static_cast<const PassManagerBuilderWrapper&>(Builder);
Alexey Samsonovae5804f2014-10-15 20:22:54 +0000282 const LangOptions &LangOpts = BuilderWrapper.getLangOpts();
Alexey Samsonova511cdd2015-02-04 17:40:08 +0000283 PM.add(createDataFlowSanitizerPass(LangOpts.SanitizerBlacklistFiles));
Peter Collingbournec3772752013-08-07 22:47:34 +0000284}
285
Derek Bruening256c2e12016-04-21 21:32:04 +0000286static void addEfficiencySanitizerPass(const PassManagerBuilder &Builder,
287 legacy::PassManagerBase &PM) {
288 const PassManagerBuilderWrapper &BuilderWrapper =
289 static_cast<const PassManagerBuilderWrapper&>(Builder);
290 const LangOptions &LangOpts = BuilderWrapper.getLangOpts();
291 EfficiencySanitizerOptions Opts;
292 if (LangOpts.Sanitize.has(SanitizerKind::EfficiencyCacheFrag))
293 Opts.ToolType = EfficiencySanitizerOptions::ESAN_CacheFrag;
Derek Bruening293772e2016-05-25 00:41:24 +0000294 else if (LangOpts.Sanitize.has(SanitizerKind::EfficiencyWorkingSet))
295 Opts.ToolType = EfficiencySanitizerOptions::ESAN_WorkingSet;
Derek Bruening256c2e12016-04-21 21:32:04 +0000296 PM.add(createEfficiencySanitizerPass(Opts));
297}
298
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000299static TargetLibraryInfoImpl *createTLII(llvm::Triple &TargetTriple,
300 const CodeGenOptions &CodeGenOpts) {
301 TargetLibraryInfoImpl *TLII = new TargetLibraryInfoImpl(TargetTriple);
Rafael Espindolab8a71c52014-08-21 17:58:42 +0000302 if (!CodeGenOpts.SimplifyLibCalls)
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000303 TLII->disableAllFunctions();
Chad Rosier7dbc9cf2016-01-06 14:35:46 +0000304 else {
305 // Disable individual libc/libm calls in TargetLibraryInfo.
David L. Jones7a7dd032017-01-23 23:16:58 +0000306 LibFunc F;
Chad Rosier7dbc9cf2016-01-06 14:35:46 +0000307 for (auto &FuncName : CodeGenOpts.getNoBuiltinFuncs())
308 if (TLII->getLibFunc(FuncName, F))
309 TLII->setUnavailable(F);
310 }
Michael Zolotukhinc888dd02015-03-17 20:03:11 +0000311
312 switch (CodeGenOpts.getVecLib()) {
313 case CodeGenOptions::Accelerate:
314 TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::Accelerate);
315 break;
Matt Masten6731dea2016-07-29 16:44:24 +0000316 case CodeGenOptions::SVML:
317 TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::SVML);
318 break;
Michael Zolotukhinc888dd02015-03-17 20:03:11 +0000319 default:
320 break;
321 }
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000322 return TLII;
Rafael Espindolab8a71c52014-08-21 17:58:42 +0000323}
324
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000325static void addSymbolRewriterPass(const CodeGenOptions &Opts,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000326 legacy::PassManager *MPM) {
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000327 llvm::SymbolRewriter::RewriteDescriptorList DL;
328
329 llvm::SymbolRewriter::RewriteMapParser MapParser;
330 for (const auto &MapFile : Opts.RewriteMapFiles)
331 MapParser.parse(MapFile, &DL);
332
333 MPM->add(createRewriteSymbolsPass(DL));
334}
335
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000336static CodeGenOpt::Level getCGOptLevel(const CodeGenOptions &CodeGenOpts) {
337 switch (CodeGenOpts.OptimizationLevel) {
338 default:
339 llvm_unreachable("Invalid optimization level!");
340 case 0:
341 return CodeGenOpt::None;
342 case 1:
343 return CodeGenOpt::Less;
344 case 2:
345 return CodeGenOpt::Default; // O2/Os/Oz
346 case 3:
347 return CodeGenOpt::Aggressive;
348 }
349}
350
Rafael Espindolaaa0226e2017-08-03 02:16:28 +0000351static Optional<llvm::CodeModel::Model>
352getCodeModel(const CodeGenOptions &CodeGenOpts) {
353 unsigned CodeModel = llvm::StringSwitch<unsigned>(CodeGenOpts.CodeModel)
354 .Case("small", llvm::CodeModel::Small)
355 .Case("kernel", llvm::CodeModel::Kernel)
356 .Case("medium", llvm::CodeModel::Medium)
357 .Case("large", llvm::CodeModel::Large)
358 .Case("default", ~1u)
359 .Default(~0u);
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000360 assert(CodeModel != ~0u && "invalid code model!");
Rafael Espindolaaa0226e2017-08-03 02:16:28 +0000361 if (CodeModel == ~1u)
362 return None;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000363 return static_cast<llvm::CodeModel::Model>(CodeModel);
364}
365
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000366static TargetMachine::CodeGenFileType getCodeGenFileType(BackendAction Action) {
367 if (Action == Backend_EmitObj)
368 return TargetMachine::CGFT_ObjectFile;
369 else if (Action == Backend_EmitMCNull)
370 return TargetMachine::CGFT_Null;
371 else {
372 assert(Action == Backend_EmitAssembly && "Invalid action!");
373 return TargetMachine::CGFT_AssemblyFile;
374 }
375}
376
377static void initTargetOptions(llvm::TargetOptions &Options,
378 const CodeGenOptions &CodeGenOpts,
379 const clang::TargetOptions &TargetOpts,
380 const LangOptions &LangOpts,
381 const HeaderSearchOptions &HSOpts) {
382 Options.ThreadModel =
383 llvm::StringSwitch<llvm::ThreadModel::Model>(CodeGenOpts.ThreadModel)
384 .Case("posix", llvm::ThreadModel::POSIX)
385 .Case("single", llvm::ThreadModel::Single);
386
387 // Set float ABI type.
388 assert((CodeGenOpts.FloatABI == "soft" || CodeGenOpts.FloatABI == "softfp" ||
389 CodeGenOpts.FloatABI == "hard" || CodeGenOpts.FloatABI.empty()) &&
390 "Invalid Floating Point ABI!");
391 Options.FloatABIType =
392 llvm::StringSwitch<llvm::FloatABI::ABIType>(CodeGenOpts.FloatABI)
393 .Case("soft", llvm::FloatABI::Soft)
394 .Case("softfp", llvm::FloatABI::Soft)
395 .Case("hard", llvm::FloatABI::Hard)
396 .Default(llvm::FloatABI::Default);
397
398 // Set FP fusion mode.
399 switch (LangOpts.getDefaultFPContractMode()) {
400 case LangOptions::FPC_Off:
Adam Nemet03af4242017-04-20 17:09:35 +0000401 // Preserve any contraction performed by the front-end. (Strict performs
402 // splitting of the muladd instrinsic in the backend.)
403 Options.AllowFPOpFusion = llvm::FPOpFusion::Standard;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000404 break;
405 case LangOptions::FPC_On:
406 Options.AllowFPOpFusion = llvm::FPOpFusion::Standard;
407 break;
408 case LangOptions::FPC_Fast:
409 Options.AllowFPOpFusion = llvm::FPOpFusion::Fast;
410 break;
411 }
412
413 Options.UseInitArray = CodeGenOpts.UseInitArray;
414 Options.DisableIntegratedAS = CodeGenOpts.DisableIntegratedAS;
Saleem Abdulrasool54448902017-06-09 00:40:30 +0000415 Options.CompressDebugSections = CodeGenOpts.getCompressDebugSections();
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000416 Options.RelaxELFRelocations = CodeGenOpts.RelaxELFRelocations;
417
418 // Set EABI version.
Yuka Takahashidc771502017-07-01 07:57:23 +0000419 Options.EABIVersion = TargetOpts.EABIVersion;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000420
421 if (LangOpts.SjLjExceptions)
422 Options.ExceptionModel = llvm::ExceptionHandling::SjLj;
Martell Malonec950c652017-11-29 07:25:12 +0000423 if (LangOpts.SEHExceptions)
424 Options.ExceptionModel = llvm::ExceptionHandling::WinEH;
425 if (LangOpts.DWARFExceptions)
426 Options.ExceptionModel = llvm::ExceptionHandling::DwarfCFI;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000427
428 Options.NoInfsFPMath = CodeGenOpts.NoInfsFPMath;
429 Options.NoNaNsFPMath = CodeGenOpts.NoNaNsFPMath;
430 Options.NoZerosInBSS = CodeGenOpts.NoZeroInitializedInBSS;
431 Options.UnsafeFPMath = CodeGenOpts.UnsafeFPMath;
432 Options.StackAlignmentOverride = CodeGenOpts.StackAlignment;
433 Options.FunctionSections = CodeGenOpts.FunctionSections;
434 Options.DataSections = CodeGenOpts.DataSections;
435 Options.UniqueSectionNames = CodeGenOpts.UniqueSectionNames;
436 Options.EmulatedTLS = CodeGenOpts.EmulatedTLS;
Chih-Hung Hsiehca552b82018-03-01 22:26:19 +0000437 Options.ExplicitEmulatedTLS = CodeGenOpts.ExplicitEmulatedTLS;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000438 Options.DebuggerTuning = CodeGenOpts.getDebuggerTuning();
Sean Eveson5110d4f2018-01-08 13:42:26 +0000439 Options.EmitStackSizeSection = CodeGenOpts.StackSizeSection;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000440
David Blaikie81503552017-04-21 23:35:36 +0000441 if (CodeGenOpts.EnableSplitDwarf)
442 Options.MCOptions.SplitDwarfFile = CodeGenOpts.SplitDwarfFile;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000443 Options.MCOptions.MCRelaxAll = CodeGenOpts.RelaxAll;
444 Options.MCOptions.MCSaveTempLabels = CodeGenOpts.SaveTempLabels;
445 Options.MCOptions.MCUseDwarfDirectory = !CodeGenOpts.NoDwarfDirectoryAsm;
446 Options.MCOptions.MCNoExecStack = CodeGenOpts.NoExecStack;
447 Options.MCOptions.MCIncrementalLinkerCompatible =
448 CodeGenOpts.IncrementalLinkerCompatible;
449 Options.MCOptions.MCPIECopyRelocations = CodeGenOpts.PIECopyRelocations;
450 Options.MCOptions.MCFatalWarnings = CodeGenOpts.FatalWarnings;
451 Options.MCOptions.AsmVerbose = CodeGenOpts.AsmVerbose;
452 Options.MCOptions.PreserveAsmComments = CodeGenOpts.PreserveAsmComments;
453 Options.MCOptions.ABIName = TargetOpts.ABI;
454 for (const auto &Entry : HSOpts.UserEntries)
455 if (!Entry.IsFramework &&
456 (Entry.Group == frontend::IncludeDirGroup::Quoted ||
457 Entry.Group == frontend::IncludeDirGroup::Angled ||
458 Entry.Group == frontend::IncludeDirGroup::System))
459 Options.MCOptions.IASSearchPaths.push_back(
460 Entry.IgnoreSysRoot ? Entry.Path : HSOpts.Sysroot + Entry.Path);
461}
David Blaikie7a4f7f52018-01-09 22:03:47 +0000462static Optional<GCOVOptions> getGCOVOptions(const CodeGenOptions &CodeGenOpts) {
463 if (CodeGenOpts.DisableGCov)
464 return None;
465 if (!CodeGenOpts.EmitGcovArcs && !CodeGenOpts.EmitGcovNotes)
466 return None;
467 // Not using 'GCOVOptions::getDefault' allows us to avoid exiting if
468 // LLVM's -default-gcov-version flag is set to something invalid.
469 GCOVOptions Options;
470 Options.EmitNotes = CodeGenOpts.EmitGcovNotes;
471 Options.EmitData = CodeGenOpts.EmitGcovArcs;
472 llvm::copy(CodeGenOpts.CoverageVersion, std::begin(Options.Version));
473 Options.UseCfgChecksum = CodeGenOpts.CoverageExtraChecksum;
474 Options.NoRedZone = CodeGenOpts.DisableRedZone;
475 Options.FunctionNamesInData = !CodeGenOpts.CoverageNoFunctionNamesInData;
476 Options.ExitBlockBeforeBody = CodeGenOpts.CoverageExitBlockBeforeBody;
477 return Options;
478}
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000479
Peter Collingbourne03f89072016-07-15 00:55:40 +0000480void EmitAssemblyHelper::CreatePasses(legacy::PassManager &MPM,
Teresa Johnson9e3f4742016-08-12 18:12:08 +0000481 legacy::FunctionPassManager &FPM) {
Chandler Carruth93786da2016-12-23 00:23:01 +0000482 // Handle disabling of all LLVM passes, where we want to preserve the
483 // internal module before any optimization.
Steven Wu546a1962015-07-17 20:09:56 +0000484 if (CodeGenOpts.DisableLLVMPasses)
485 return;
486
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000487 // Figure out TargetLibraryInfo. This needs to be added to MPM and FPM
488 // manually (and not via PMBuilder), since some passes (eg. InstrProfiling)
489 // are inserted before PMBuilder ones - they'd get the default-constructed
490 // TLI with an unknown target otherwise.
Teresa Johnsonaff22322015-12-07 19:21:34 +0000491 Triple TargetTriple(TheModule->getTargetTriple());
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000492 std::unique_ptr<TargetLibraryInfoImpl> TLII(
493 createTLII(TargetTriple, CodeGenOpts));
Teresa Johnsonaff22322015-12-07 19:21:34 +0000494
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000495 PassManagerBuilderWrapper PMBuilder(TargetTriple, CodeGenOpts, LangOpts);
496
Chandler Carruthfcd33142016-12-23 01:24:49 +0000497 // At O0 and O1 we only run the always inliner which is more efficient. At
498 // higher optimization levels we run the normal inliner.
499 if (CodeGenOpts.OptimizationLevel <= 1) {
Mehdi Amini7f873072017-01-06 23:18:09 +0000500 bool InsertLifetimeIntrinsics = (CodeGenOpts.OptimizationLevel != 0 &&
501 !CodeGenOpts.DisableLifetimeMarkers);
Chandler Carruthfcd33142016-12-23 01:24:49 +0000502 PMBuilder.Inliner = createAlwaysInlinerLegacyPass(InsertLifetimeIntrinsics);
503 } else {
Dehao Chence39fdd2017-03-21 19:55:46 +0000504 // We do not want to inline hot callsites for SamplePGO module-summary build
505 // because profile annotation will happen again in ThinLTO backend, and we
506 // want the IR of the hot path to match the profile.
Chandler Carruthfcd33142016-12-23 01:24:49 +0000507 PMBuilder.Inliner = createFunctionInliningPass(
Dehao Chence39fdd2017-03-21 19:55:46 +0000508 CodeGenOpts.OptimizationLevel, CodeGenOpts.OptimizeSize,
509 (!CodeGenOpts.SampleProfileFile.empty() &&
510 CodeGenOpts.EmitSummaryIndex));
Teresa Johnsonaff22322015-12-07 19:21:34 +0000511 }
512
Chandler Carruthfcd33142016-12-23 01:24:49 +0000513 PMBuilder.OptLevel = CodeGenOpts.OptimizationLevel;
Chris Lattnerecf0ba52011-05-21 23:50:44 +0000514 PMBuilder.SizeLevel = CodeGenOpts.OptimizeSize;
Nick Lewyckyd3f3e4f2013-06-25 01:49:44 +0000515 PMBuilder.SLPVectorize = CodeGenOpts.VectorizeSLP;
516 PMBuilder.LoopVectorize = CodeGenOpts.VectorizeLoop;
Andrew Trickb2a84722011-04-05 18:49:32 +0000517
Chris Lattnerecf0ba52011-05-21 23:50:44 +0000518 PMBuilder.DisableUnrollLoops = !CodeGenOpts.UnrollLoops;
Nick Lewyckyf04f2372014-10-24 00:49:29 +0000519 PMBuilder.MergeFunctions = CodeGenOpts.MergeFunctions;
Teresa Johnsona0d29402016-03-15 00:04:44 +0000520 PMBuilder.PrepareForThinLTO = CodeGenOpts.EmitSummaryIndex;
Teresa Johnson8749d8042015-07-06 16:23:00 +0000521 PMBuilder.PrepareForLTO = CodeGenOpts.PrepareForLTO;
Hal Finkelce0697f2013-11-17 16:03:29 +0000522 PMBuilder.RerollLoops = CodeGenOpts.RerollLoops;
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000523
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000524 MPM.add(new TargetLibraryInfoWrapperPass(*TLII));
525
Justin Lebar5a7df9c2016-04-27 19:12:56 +0000526 if (TM)
Stanislav Mekhanoshin61da0672017-01-26 16:49:21 +0000527 TM->adjustPassManager(PMBuilder);
Justin Lebar5a7df9c2016-04-27 19:12:56 +0000528
Dehao Chen7810d4f2017-02-21 20:36:21 +0000529 if (CodeGenOpts.DebugInfoForProfiling ||
530 !CodeGenOpts.SampleProfileFile.empty())
531 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
532 addAddDiscriminatorsPass);
Diego Novillob56be642014-03-03 20:06:18 +0000533
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000534 // In ObjC ARC mode, add the main ARC optimization passes.
535 if (LangOpts.ObjCAutoRefCount) {
536 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
537 addObjCARCExpandPass);
Dan Gohman5932ce22012-01-17 20:54:51 +0000538 PMBuilder.addExtension(PassManagerBuilder::EP_ModuleOptimizerEarly,
539 addObjCARCAPElimPass);
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000540 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
541 addObjCARCOptPass);
542 }
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000543
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000544 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds)) {
Nuno Lopesa4255892012-05-22 17:19:45 +0000545 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
546 addBoundsCheckingPass);
547 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
548 addBoundsCheckingPass);
549 }
550
Alexey Samsonovdfa908c2015-05-07 22:34:06 +0000551 if (CodeGenOpts.SanitizeCoverageType ||
552 CodeGenOpts.SanitizeCoverageIndirectCalls ||
553 CodeGenOpts.SanitizeCoverageTraceCmp) {
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000554 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
555 addSanitizerCoveragePass);
556 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
557 addSanitizerCoveragePass);
558 }
559
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000560 if (LangOpts.Sanitize.has(SanitizerKind::Address)) {
Kostya Serebryany7e247f22012-10-15 14:22:56 +0000561 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000562 addAddressSanitizerPasses);
Kostya Serebryanyd4768572011-11-30 22:20:21 +0000563 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000564 addAddressSanitizerPasses);
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000565 }
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000566
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000567 if (LangOpts.Sanitize.has(SanitizerKind::KernelAddress)) {
568 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
569 addKernelAddressSanitizerPasses);
570 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
571 addKernelAddressSanitizerPasses);
572 }
573
Evgeniy Stepanov12817e52017-12-09 01:32:07 +0000574 if (LangOpts.Sanitize.has(SanitizerKind::HWAddress)) {
575 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
576 addHWAddressSanitizerPasses);
577 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
578 addHWAddressSanitizerPasses);
579 }
580
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000581 if (LangOpts.Sanitize.has(SanitizerKind::Memory)) {
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000582 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
583 addMemorySanitizerPass);
584 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
585 addMemorySanitizerPass);
586 }
587
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000588 if (LangOpts.Sanitize.has(SanitizerKind::Thread)) {
Kostya Serebryanyd18cb502012-03-23 23:25:23 +0000589 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000590 addThreadSanitizerPass);
591 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
592 addThreadSanitizerPass);
593 }
594
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000595 if (LangOpts.Sanitize.has(SanitizerKind::DataFlow)) {
Peter Collingbournec3772752013-08-07 22:47:34 +0000596 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
597 addDataFlowSanitizerPass);
598 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
599 addDataFlowSanitizerPass);
600 }
601
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000602 if (LangOpts.CoroutinesTS)
603 addCoroutinePassesToExtensionPoints(PMBuilder);
604
Derek Bruening256c2e12016-04-21 21:32:04 +0000605 if (LangOpts.Sanitize.hasOneOf(SanitizerKind::Efficiency)) {
606 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
607 addEfficiencySanitizerPass);
608 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
609 addEfficiencySanitizerPass);
610 }
611
Chris Lattner5c123672011-05-21 20:40:11 +0000612 // Set up the per-function pass manager.
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000613 FPM.add(new TargetLibraryInfoWrapperPass(*TLII));
Chris Lattner5c123672011-05-21 20:40:11 +0000614 if (CodeGenOpts.VerifyModule)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000615 FPM.add(createVerifierPass());
Andrew Trickb2a84722011-04-05 18:49:32 +0000616
Chris Lattner5c123672011-05-21 20:40:11 +0000617 // Set up the per-module pass manager.
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000618 if (!CodeGenOpts.RewriteMapFiles.empty())
Peter Collingbourne03f89072016-07-15 00:55:40 +0000619 addSymbolRewriterPass(CodeGenOpts, &MPM);
Chris Lattnerd98cec52011-02-18 22:20:38 +0000620
David Blaikie7a4f7f52018-01-09 22:03:47 +0000621 if (Optional<GCOVOptions> Options = getGCOVOptions(CodeGenOpts)) {
622 MPM.add(createGCOVProfilerPass(*Options));
Benjamin Kramer8c305922016-02-02 11:06:51 +0000623 if (CodeGenOpts.getDebugInfo() == codegenoptions::NoDebugInfo)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000624 MPM.add(createStripSymbolsPass(true));
Nick Lewycky207bce32011-04-21 23:44:07 +0000625 }
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000626
Rong Xu9837ef52016-02-04 18:39:09 +0000627 if (CodeGenOpts.hasProfileClangInstr()) {
Justin Bogner970ac602014-12-08 19:04:51 +0000628 InstrProfOptions Options;
629 Options.NoRedZone = CodeGenOpts.DisableRedZone;
Justin Bognera71e6812015-04-30 23:49:42 +0000630 Options.InstrProfileOutput = CodeGenOpts.InstrProfileOutput;
Peter Collingbourne03f89072016-07-15 00:55:40 +0000631 MPM.add(createInstrProfilingLegacyPass(Options));
Justin Bogner970ac602014-12-08 19:04:51 +0000632 }
Rong Xu522b5cb2016-02-29 18:54:59 +0000633 if (CodeGenOpts.hasProfileIRInstr()) {
Xinliang David Lib65f8ae2016-07-23 04:28:59 +0000634 PMBuilder.EnablePGOInstrGen = true;
Rong Xu522b5cb2016-02-29 18:54:59 +0000635 if (!CodeGenOpts.InstrProfileOutput.empty())
636 PMBuilder.PGOInstrGen = CodeGenOpts.InstrProfileOutput;
637 else
Davide Italiano945de432017-02-13 16:07:05 +0000638 PMBuilder.PGOInstrGen = DefaultProfileGenName;
Rong Xu522b5cb2016-02-29 18:54:59 +0000639 }
Rong Xu9c6f1532016-03-02 20:59:36 +0000640 if (CodeGenOpts.hasProfileIRUse())
641 PMBuilder.PGOInstrUse = CodeGenOpts.ProfileInstrumentUsePath;
Justin Bogner970ac602014-12-08 19:04:51 +0000642
Dehao Chen5717aff2016-12-14 21:41:04 +0000643 if (!CodeGenOpts.SampleProfileFile.empty())
644 PMBuilder.PGOSampleUse = CodeGenOpts.SampleProfileFile;
Diego Novillod3ef1082015-08-25 15:25:13 +0000645
Peter Collingbourne03f89072016-07-15 00:55:40 +0000646 PMBuilder.populateFunctionPassManager(FPM);
647 PMBuilder.populateModulePassManager(MPM);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000648}
649
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000650static void setCommandLineOpts(const CodeGenOptions &CodeGenOpts) {
Yaxun Liub5e80c32016-04-12 20:22:32 +0000651 SmallVector<const char *, 16> BackendArgs;
652 BackendArgs.push_back("clang"); // Fake program name.
653 if (!CodeGenOpts.DebugPass.empty()) {
654 BackendArgs.push_back("-debug-pass");
655 BackendArgs.push_back(CodeGenOpts.DebugPass.c_str());
656 }
657 if (!CodeGenOpts.LimitFloatPrecision.empty()) {
658 BackendArgs.push_back("-limit-float-precision");
659 BackendArgs.push_back(CodeGenOpts.LimitFloatPrecision.c_str());
660 }
661 for (const std::string &BackendOption : CodeGenOpts.BackendOptions)
662 BackendArgs.push_back(BackendOption.c_str());
663 BackendArgs.push_back(nullptr);
664 llvm::cl::ParseCommandLineOptions(BackendArgs.size() - 1,
665 BackendArgs.data());
666}
667
Peter Collingbourne03f89072016-07-15 00:55:40 +0000668void EmitAssemblyHelper::CreateTargetMachine(bool MustCreateTM) {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000669 // Create the TargetMachine for generating code.
670 std::string Error;
671 std::string Triple = TheModule->getTargetTriple();
672 const llvm::Target *TheTarget = TargetRegistry::lookupTarget(Triple, Error);
673 if (!TheTarget) {
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000674 if (MustCreateTM)
Chad Rosierecafbe62013-03-27 00:14:35 +0000675 Diags.Report(diag::err_fe_unable_to_create_target) << Error;
Peter Collingbourne03f89072016-07-15 00:55:40 +0000676 return;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000677 }
678
Rafael Espindolaaa0226e2017-08-03 02:16:28 +0000679 Optional<llvm::CodeModel::Model> CM = getCodeModel(CodeGenOpts);
Eric Christopher583a1f72015-09-26 01:25:08 +0000680 std::string FeaturesStr =
681 llvm::join(TargetOpts.Features.begin(), TargetOpts.Features.end(), ",");
Rafael Espindolae1d70532018-01-18 00:20:03 +0000682 llvm::Reloc::Model RM = CodeGenOpts.RelocationModel;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000683 CodeGenOpt::Level OptLevel = getCGOptLevel(CodeGenOpts);
Evan Chengdd286bc2011-11-16 08:38:55 +0000684
Nick Lewycky432add52011-12-02 22:17:00 +0000685 llvm::TargetOptions Options;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000686 initTargetOptions(Options, CodeGenOpts, TargetOpts, LangOpts, HSOpts);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000687 TM.reset(TheTarget->createTargetMachine(Triple, TargetOpts.CPU, FeaturesStr,
688 Options, RM, CM, OptLevel));
Nadav Rotemec57ab32012-10-24 00:53:38 +0000689}
690
Peter Collingbourne03f89072016-07-15 00:55:40 +0000691bool EmitAssemblyHelper::AddEmitPasses(legacy::PassManager &CodeGenPasses,
692 BackendAction Action,
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000693 raw_pwrite_stream &OS) {
Chad Rosierb1cfc682012-02-29 20:14:59 +0000694 // Add LibraryInfo.
Daniel Dunbaraa437df2012-10-19 20:10:10 +0000695 llvm::Triple TargetTriple(TheModule->getTargetTriple());
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000696 std::unique_ptr<TargetLibraryInfoImpl> TLII(
697 createTLII(TargetTriple, CodeGenOpts));
Peter Collingbourne03f89072016-07-15 00:55:40 +0000698 CodeGenPasses.add(new TargetLibraryInfoWrapperPass(*TLII));
Chad Rosierb1cfc682012-02-29 20:14:59 +0000699
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000700 // Normal mode, emit a .s or .o file by running the code generator. Note,
701 // this also adds codegenerator level optimization passes.
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000702 TargetMachine::CodeGenFileType CGFT = getCodeGenFileType(Action);
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000703
704 // Add ObjC ARC final-cleanup optimizations. This is done as part of the
705 // "codegen" passes so that it isn't run multiple times when there is
706 // inlining happening.
Steven Wu1d56be82015-05-02 00:56:15 +0000707 if (CodeGenOpts.OptimizationLevel > 0)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000708 CodeGenPasses.add(createObjCARCContractPass());
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000709
Peter Collingbourne03f89072016-07-15 00:55:40 +0000710 if (TM->addPassesToEmitFile(CodeGenPasses, OS, CGFT,
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000711 /*DisableVerify=*/!CodeGenOpts.VerifyModule)) {
712 Diags.Report(diag::err_fe_unable_to_interface_with_target);
713 return false;
714 }
715
716 return true;
717}
718
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000719void EmitAssemblyHelper::EmitAssembly(BackendAction Action,
Peter Collingbourne03f89072016-07-15 00:55:40 +0000720 std::unique_ptr<raw_pwrite_stream> OS) {
Craig Topper8a13c412014-05-21 05:09:00 +0000721 TimeRegion Region(llvm::TimePassesIsEnabled ? &CodeGenerationTime : nullptr);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000722
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000723 setCommandLineOpts(CodeGenOpts);
Yaxun Liub5e80c32016-04-12 20:22:32 +0000724
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000725 bool UsesCodeGen = (Action != Backend_EmitNothing &&
726 Action != Backend_EmitBC &&
727 Action != Backend_EmitLL);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000728 CreateTargetMachine(UsesCodeGen);
Alp Tokerf4e22382013-12-20 20:26:53 +0000729
Rafael Espindolab633d202015-06-23 13:59:36 +0000730 if (UsesCodeGen && !TM)
731 return;
732 if (TM)
Mehdi Aminica3cf9e2015-07-24 16:04:29 +0000733 TheModule->setDataLayout(TM->createDataLayout());
Teresa Johnson4b4f4b92016-01-08 17:04:29 +0000734
Peter Collingbourne03f89072016-07-15 00:55:40 +0000735 legacy::PassManager PerModulePasses;
736 PerModulePasses.add(
737 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
738
739 legacy::FunctionPassManager PerFunctionPasses(TheModule);
740 PerFunctionPasses.add(
741 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
742
Teresa Johnson9e3f4742016-08-12 18:12:08 +0000743 CreatePasses(PerModulePasses, PerFunctionPasses);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000744
745 legacy::PassManager CodeGenPasses;
746 CodeGenPasses.add(
747 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
Nadav Rotemec57ab32012-10-24 00:53:38 +0000748
Teresa Johnson488d1dc2017-03-23 19:47:49 +0000749 std::unique_ptr<raw_fd_ostream> ThinLinkOS;
750
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000751 switch (Action) {
752 case Backend_EmitNothing:
753 break;
754
755 case Backend_EmitBC:
Teresa Johnson488d1dc2017-03-23 19:47:49 +0000756 if (CodeGenOpts.EmitSummaryIndex) {
757 if (!CodeGenOpts.ThinLinkBitcodeFile.empty()) {
758 std::error_code EC;
759 ThinLinkOS.reset(new llvm::raw_fd_ostream(
760 CodeGenOpts.ThinLinkBitcodeFile, EC,
761 llvm::sys::fs::F_None));
762 if (EC) {
763 Diags.Report(diag::err_fe_unable_to_open_output) << CodeGenOpts.ThinLinkBitcodeFile
764 << EC.message();
765 return;
766 }
767 }
768 PerModulePasses.add(
769 createWriteThinLTOBitcodePass(*OS, ThinLinkOS.get()));
770 }
Peter Collingbourneb8847162017-01-26 23:51:50 +0000771 else
772 PerModulePasses.add(
773 createBitcodeWriterPass(*OS, CodeGenOpts.EmitLLVMUseLists));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000774 break;
775
776 case Backend_EmitLL:
Peter Collingbourne03f89072016-07-15 00:55:40 +0000777 PerModulePasses.add(
Duncan P. N. Exon Smithbb9cadf2015-04-15 02:45:28 +0000778 createPrintModulePass(*OS, "", CodeGenOpts.EmitLLVMUseLists));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000779 break;
780
781 default:
Peter Collingbourne03f89072016-07-15 00:55:40 +0000782 if (!AddEmitPasses(CodeGenPasses, Action, *OS))
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000783 return;
784 }
785
Andrew Trick15e36e82011-04-05 18:56:55 +0000786 // Before executing passes, print the final values of the LLVM options.
787 cl::PrintOptionValues();
788
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000789 // Run passes. For now we do all passes at once, but eventually we
790 // would like to have the option of streaming code generation.
791
Peter Collingbourne03f89072016-07-15 00:55:40 +0000792 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000793 PrettyStackTraceString CrashInfo("Per-function optimization");
794
Peter Collingbourne03f89072016-07-15 00:55:40 +0000795 PerFunctionPasses.doInitialization();
Yaron Keren10d6d162015-06-05 09:40:53 +0000796 for (Function &F : *TheModule)
797 if (!F.isDeclaration())
Peter Collingbourne03f89072016-07-15 00:55:40 +0000798 PerFunctionPasses.run(F);
799 PerFunctionPasses.doFinalization();
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000800 }
801
Peter Collingbourne03f89072016-07-15 00:55:40 +0000802 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000803 PrettyStackTraceString CrashInfo("Per-module optimization passes");
Peter Collingbourne03f89072016-07-15 00:55:40 +0000804 PerModulePasses.run(*TheModule);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000805 }
806
Peter Collingbourne03f89072016-07-15 00:55:40 +0000807 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000808 PrettyStackTraceString CrashInfo("Code generation");
Peter Collingbourne03f89072016-07-15 00:55:40 +0000809 CodeGenPasses.run(*TheModule);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000810 }
811}
812
Chandler Carruth50f9e892016-12-23 20:44:01 +0000813static PassBuilder::OptimizationLevel mapToLevel(const CodeGenOptions &Opts) {
814 switch (Opts.OptimizationLevel) {
815 default:
816 llvm_unreachable("Invalid optimization level!");
817
818 case 1:
819 return PassBuilder::O1;
820
821 case 2:
822 switch (Opts.OptimizeSize) {
823 default:
824 llvm_unreachable("Invalide optimization level for size!");
825
826 case 0:
827 return PassBuilder::O2;
828
829 case 1:
830 return PassBuilder::Os;
831
832 case 2:
833 return PassBuilder::Oz;
834 }
835
836 case 3:
837 return PassBuilder::O3;
838 }
839}
840
841/// A clean version of `EmitAssembly` that uses the new pass manager.
842///
843/// Not all features are currently supported in this system, but where
844/// necessary it falls back to the legacy pass manager to at least provide
845/// basic functionality.
846///
847/// This API is planned to have its functionality finished and then to replace
848/// `EmitAssembly` at some point in the future when the default switches.
849void EmitAssemblyHelper::EmitAssemblyWithNewPassManager(
850 BackendAction Action, std::unique_ptr<raw_pwrite_stream> OS) {
851 TimeRegion Region(llvm::TimePassesIsEnabled ? &CodeGenerationTime : nullptr);
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000852 setCommandLineOpts(CodeGenOpts);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000853
854 // The new pass manager always makes a target machine available to passes
855 // during construction.
856 CreateTargetMachine(/*MustCreateTM*/ true);
857 if (!TM)
858 // This will already be diagnosed, just bail.
859 return;
860 TheModule->setDataLayout(TM->createDataLayout());
861
Dehao Chenc76a27e2017-07-27 15:29:53 +0000862 Optional<PGOOptions> PGOOpt;
Davide Italiano945de432017-02-13 16:07:05 +0000863
Dehao Chenc76a27e2017-07-27 15:29:53 +0000864 if (CodeGenOpts.hasProfileIRInstr())
865 // -fprofile-generate.
866 PGOOpt = PGOOptions(CodeGenOpts.InstrProfileOutput.empty()
867 ? DefaultProfileGenName
868 : CodeGenOpts.InstrProfileOutput,
869 "", "", true, CodeGenOpts.DebugInfoForProfiling);
870 else if (CodeGenOpts.hasProfileIRUse())
871 // -fprofile-use.
872 PGOOpt = PGOOptions("", CodeGenOpts.ProfileInstrumentUsePath, "", false,
873 CodeGenOpts.DebugInfoForProfiling);
874 else if (!CodeGenOpts.SampleProfileFile.empty())
875 // -fprofile-sample-use
876 PGOOpt = PGOOptions("", "", CodeGenOpts.SampleProfileFile, false,
877 CodeGenOpts.DebugInfoForProfiling);
878 else if (CodeGenOpts.DebugInfoForProfiling)
879 // -fdebug-info-for-profiling
880 PGOOpt = PGOOptions("", "", "", false, true);
Davide Italiano945de432017-02-13 16:07:05 +0000881
Dehao Chenc76a27e2017-07-27 15:29:53 +0000882 PassBuilder PB(TM.get(), PGOOpt);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000883
Craig Topper926b95c2017-11-14 08:48:28 +0000884 LoopAnalysisManager LAM(CodeGenOpts.DebugPassManager);
885 FunctionAnalysisManager FAM(CodeGenOpts.DebugPassManager);
886 CGSCCAnalysisManager CGAM(CodeGenOpts.DebugPassManager);
887 ModuleAnalysisManager MAM(CodeGenOpts.DebugPassManager);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000888
889 // Register the AA manager first so that our version is the one used.
890 FAM.registerPass([&] { return PB.buildDefaultAAPipeline(); });
891
Chandler Carruth9fdd5fa2017-07-25 10:46:07 +0000892 // Register the target library analysis directly and give it a customized
893 // preset TLI.
894 Triple TargetTriple(TheModule->getTargetTriple());
895 std::unique_ptr<TargetLibraryInfoImpl> TLII(
896 createTLII(TargetTriple, CodeGenOpts));
897 FAM.registerPass([&] { return TargetLibraryAnalysis(*TLII); });
898 MAM.registerPass([&] { return TargetLibraryAnalysis(*TLII); });
899
Chandler Carruth50f9e892016-12-23 20:44:01 +0000900 // Register all the basic analyses with the managers.
901 PB.registerModuleAnalyses(MAM);
902 PB.registerCGSCCAnalyses(CGAM);
903 PB.registerFunctionAnalyses(FAM);
904 PB.registerLoopAnalyses(LAM);
905 PB.crossRegisterProxies(LAM, FAM, CGAM, MAM);
906
Tim Shenb13eebe2017-06-29 23:10:13 +0000907 ModulePassManager MPM(CodeGenOpts.DebugPassManager);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000908
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000909 if (!CodeGenOpts.DisableLLVMPasses) {
Tim Shen66470692017-06-29 23:08:38 +0000910 bool IsThinLTO = CodeGenOpts.EmitSummaryIndex;
911 bool IsLTO = CodeGenOpts.PrepareForLTO;
912
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000913 if (CodeGenOpts.OptimizationLevel == 0) {
David Blaikieac904d02018-01-23 01:25:24 +0000914 if (Optional<GCOVOptions> Options = getGCOVOptions(CodeGenOpts))
915 MPM.addPass(GCOVProfilerPass(*Options));
916
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000917 // Build a minimal pipeline based on the semantics required by Clang,
918 // which is just that always inlining occurs.
919 MPM.addPass(AlwaysInlinerPass());
Chandler Carrutha8bd4e32017-11-14 01:59:18 +0000920
921 // At -O0 we directly run necessary sanitizer passes.
922 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds))
923 MPM.addPass(createModuleToFunctionPassAdaptor(BoundsCheckingPass()));
924
925 // Lastly, add a semantically necessary pass for ThinLTO.
Tim Shen66470692017-06-29 23:08:38 +0000926 if (IsThinLTO)
927 MPM.addPass(NameAnonGlobalPass());
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000928 } else {
Tim Shen66470692017-06-29 23:08:38 +0000929 // Map our optimization levels into one of the distinct levels used to
930 // configure the pipeline.
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000931 PassBuilder::OptimizationLevel Level = mapToLevel(CodeGenOpts);
932
Chandler Carrutha8bd4e32017-11-14 01:59:18 +0000933 // Register callbacks to schedule sanitizer passes at the appropriate part of
934 // the pipeline.
935 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds))
936 PB.registerScalarOptimizerLateEPCallback(
937 [](FunctionPassManager &FPM, PassBuilder::OptimizationLevel Level) {
938 FPM.addPass(BoundsCheckingPass());
939 });
David Blaikieac904d02018-01-23 01:25:24 +0000940 if (Optional<GCOVOptions> Options = getGCOVOptions(CodeGenOpts))
941 PB.registerPipelineStartEPCallback([Options](ModulePassManager &MPM) {
942 MPM.addPass(GCOVProfilerPass(*Options));
943 });
Chandler Carrutha8bd4e32017-11-14 01:59:18 +0000944
Tim Shen66470692017-06-29 23:08:38 +0000945 if (IsThinLTO) {
Tim Shenb13eebe2017-06-29 23:10:13 +0000946 MPM = PB.buildThinLTOPreLinkDefaultPipeline(
947 Level, CodeGenOpts.DebugPassManager);
Tim Shen66470692017-06-29 23:08:38 +0000948 MPM.addPass(NameAnonGlobalPass());
949 } else if (IsLTO) {
Tim Shenb13eebe2017-06-29 23:10:13 +0000950 MPM = PB.buildLTOPreLinkDefaultPipeline(Level,
951 CodeGenOpts.DebugPassManager);
Tim Shen66470692017-06-29 23:08:38 +0000952 } else {
Tim Shenb13eebe2017-06-29 23:10:13 +0000953 MPM = PB.buildPerModuleDefaultPipeline(Level,
954 CodeGenOpts.DebugPassManager);
Tim Shen66470692017-06-29 23:08:38 +0000955 }
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000956 }
Chandler Carruth50f9e892016-12-23 20:44:01 +0000957 }
958
959 // FIXME: We still use the legacy pass manager to do code generation. We
960 // create that pass manager here and use it as needed below.
961 legacy::PassManager CodeGenPasses;
962 bool NeedCodeGen = false;
Tim Shen50fedec2017-06-01 23:27:51 +0000963 Optional<raw_fd_ostream> ThinLinkOS;
Chandler Carruth50f9e892016-12-23 20:44:01 +0000964
965 // Append any output we need to the pass manager.
966 switch (Action) {
967 case Backend_EmitNothing:
968 break;
969
970 case Backend_EmitBC:
Tim Shen50fedec2017-06-01 23:27:51 +0000971 if (CodeGenOpts.EmitSummaryIndex) {
972 if (!CodeGenOpts.ThinLinkBitcodeFile.empty()) {
973 std::error_code EC;
974 ThinLinkOS.emplace(CodeGenOpts.ThinLinkBitcodeFile, EC,
975 llvm::sys::fs::F_None);
976 if (EC) {
977 Diags.Report(diag::err_fe_unable_to_open_output)
978 << CodeGenOpts.ThinLinkBitcodeFile << EC.message();
979 return;
980 }
981 }
982 MPM.addPass(
983 ThinLTOBitcodeWriterPass(*OS, ThinLinkOS ? &*ThinLinkOS : nullptr));
984 } else {
985 MPM.addPass(BitcodeWriterPass(*OS, CodeGenOpts.EmitLLVMUseLists,
986 CodeGenOpts.EmitSummaryIndex,
987 CodeGenOpts.EmitSummaryIndex));
988 }
Chandler Carruth50f9e892016-12-23 20:44:01 +0000989 break;
990
991 case Backend_EmitLL:
992 MPM.addPass(PrintModulePass(*OS, "", CodeGenOpts.EmitLLVMUseLists));
993 break;
994
995 case Backend_EmitAssembly:
996 case Backend_EmitMCNull:
997 case Backend_EmitObj:
998 NeedCodeGen = true;
999 CodeGenPasses.add(
1000 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
1001 if (!AddEmitPasses(CodeGenPasses, Action, *OS))
1002 // FIXME: Should we handle this error differently?
1003 return;
1004 break;
1005 }
1006
1007 // Before executing passes, print the final values of the LLVM options.
1008 cl::PrintOptionValues();
1009
1010 // Now that we have all of the passes ready, run them.
1011 {
1012 PrettyStackTraceString CrashInfo("Optimizer");
1013 MPM.run(*TheModule, MAM);
1014 }
1015
1016 // Now if needed, run the legacy PM for codegen.
1017 if (NeedCodeGen) {
1018 PrettyStackTraceString CrashInfo("Code generation");
1019 CodeGenPasses.run(*TheModule);
1020 }
1021}
1022
Peter Collingbourne47d23642017-01-24 19:54:37 +00001023Expected<BitcodeModule> clang::FindThinLTOModule(MemoryBufferRef MBRef) {
1024 Expected<std::vector<BitcodeModule>> BMsOrErr = getBitcodeModuleList(MBRef);
1025 if (!BMsOrErr)
1026 return BMsOrErr.takeError();
1027
Peter Collingbournedbd2fed2017-06-15 17:26:13 +00001028 // The bitcode file may contain multiple modules, we want the one that is
1029 // marked as being the ThinLTO module.
Vitaly Bukac35ff822018-02-16 23:34:16 +00001030 if (const BitcodeModule *Bm = FindThinLTOModule(*BMsOrErr))
1031 return *Bm;
Peter Collingbourne47d23642017-01-24 19:54:37 +00001032
1033 return make_error<StringError>("Could not find module summary",
1034 inconvertibleErrorCode());
1035}
1036
Vitaly Bukac35ff822018-02-16 23:34:16 +00001037BitcodeModule *clang::FindThinLTOModule(MutableArrayRef<BitcodeModule> BMs) {
1038 for (BitcodeModule &BM : BMs) {
1039 Expected<BitcodeLTOInfo> LTOInfo = BM.getLTOInfo();
1040 if (LTOInfo && LTOInfo->IsThinLTO)
1041 return &BM;
1042 }
1043 return nullptr;
1044}
1045
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001046static void runThinLTOBackend(ModuleSummaryIndex *CombinedIndex, Module *M,
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001047 const HeaderSearchOptions &HeaderOpts,
1048 const CodeGenOptions &CGOpts,
1049 const clang::TargetOptions &TOpts,
1050 const LangOptions &LOpts,
Dehao Chena1bd2d62017-01-13 00:51:55 +00001051 std::unique_ptr<raw_pwrite_stream> OS,
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001052 std::string SampleProfile,
1053 BackendAction Action) {
Dehao Chen5f83d0e2017-07-10 20:31:37 +00001054 StringMap<DenseMap<GlobalValue::GUID, GlobalValueSummary *>>
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001055 ModuleToDefinedGVSummaries;
1056 CombinedIndex->collectDefinedGVSummariesPerModule(ModuleToDefinedGVSummaries);
1057
David Blaikie6e2ec5f2017-04-19 20:08:21 +00001058 setCommandLineOpts(CGOpts);
1059
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001060 // We can simply import the values mentioned in the combined index, since
1061 // we should only invoke this using the individual indexes written out
1062 // via a WriteIndexesThinBackend.
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001063 FunctionImporter::ImportMapTy ImportList;
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001064 for (auto &GlobalList : *CombinedIndex) {
Peter Collingbourne9667b912017-05-04 18:03:25 +00001065 // Ignore entries for undefined references.
1066 if (GlobalList.second.SummaryList.empty())
1067 continue;
1068
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001069 auto GUID = GlobalList.first;
Peter Collingbourne9667b912017-05-04 18:03:25 +00001070 assert(GlobalList.second.SummaryList.size() == 1 &&
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001071 "Expected individual combined index to have one summary per GUID");
Peter Collingbourne9667b912017-05-04 18:03:25 +00001072 auto &Summary = GlobalList.second.SummaryList[0];
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001073 // Skip the summaries for the importing module. These are included to
1074 // e.g. record required linkage changes.
1075 if (Summary->modulePath() == M->getModuleIdentifier())
1076 continue;
1077 // Doesn't matter what value we plug in to the map, just needs an entry
1078 // to provoke importing by thinBackend.
1079 ImportList[Summary->modulePath()][GUID] = 1;
1080 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001081
1082 std::vector<std::unique_ptr<llvm::MemoryBuffer>> OwnedImports;
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001083 MapVector<llvm::StringRef, llvm::BitcodeModule> ModuleMap;
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001084
1085 for (auto &I : ImportList) {
1086 ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> MBOrErr =
1087 llvm::MemoryBuffer::getFile(I.first());
1088 if (!MBOrErr) {
1089 errs() << "Error loading imported file '" << I.first()
1090 << "': " << MBOrErr.getError().message() << "\n";
1091 return;
1092 }
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001093
Peter Collingbourne47d23642017-01-24 19:54:37 +00001094 Expected<BitcodeModule> BMOrErr = FindThinLTOModule(**MBOrErr);
1095 if (!BMOrErr) {
1096 handleAllErrors(BMOrErr.takeError(), [&](ErrorInfoBase &EIB) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001097 errs() << "Error loading imported file '" << I.first()
1098 << "': " << EIB.message() << '\n';
1099 });
1100 return;
1101 }
Peter Collingbourne47d23642017-01-24 19:54:37 +00001102 ModuleMap.insert({I.first(), *BMOrErr});
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001103
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001104 OwnedImports.push_back(std::move(*MBOrErr));
1105 }
Peter Collingbourne2d3a26f2016-09-23 21:43:51 +00001106 auto AddStream = [&](size_t Task) {
1107 return llvm::make_unique<lto::NativeObjectStream>(std::move(OS));
Mehdi Amini406aa222016-08-17 06:23:08 +00001108 };
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001109 lto::Config Conf;
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001110 Conf.CPU = TOpts.CPU;
1111 Conf.CodeModel = getCodeModel(CGOpts);
1112 Conf.MAttrs = TOpts.Features;
Rafael Espindolae1d70532018-01-18 00:20:03 +00001113 Conf.RelocModel = CGOpts.RelocationModel;
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001114 Conf.CGOptLevel = getCGOptLevel(CGOpts);
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001115 initTargetOptions(Conf.Options, CGOpts, TOpts, LOpts, HeaderOpts);
Benjamin Kramerf6021ec2017-03-21 21:35:04 +00001116 Conf.SampleProfile = std::move(SampleProfile);
Tim Shen50fedec2017-06-01 23:27:51 +00001117 Conf.UseNewPM = CGOpts.ExperimentalNewPassManager;
Teresa Johnson4cd016ab2017-11-13 15:38:33 +00001118 Conf.DebugPassManager = CGOpts.DebugPassManager;
Teresa Johnsonb637cb02017-03-31 22:35:47 +00001119 switch (Action) {
1120 case Backend_EmitNothing:
1121 Conf.PreCodeGenModuleHook = [](size_t Task, const Module &Mod) {
1122 return false;
1123 };
1124 break;
1125 case Backend_EmitLL:
1126 Conf.PreCodeGenModuleHook = [&](size_t Task, const Module &Mod) {
1127 M->print(*OS, nullptr, CGOpts.EmitLLVMUseLists);
1128 return false;
1129 };
1130 break;
1131 case Backend_EmitBC:
1132 Conf.PreCodeGenModuleHook = [&](size_t Task, const Module &Mod) {
Rafael Espindola76c8f822018-02-14 19:11:37 +00001133 WriteBitcodeToFile(*M, *OS, CGOpts.EmitLLVMUseLists);
Teresa Johnsonb637cb02017-03-31 22:35:47 +00001134 return false;
1135 };
1136 break;
1137 default:
1138 Conf.CGFileType = getCodeGenFileType(Action);
1139 break;
1140 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001141 if (Error E = thinBackend(
Peter Collingbourne2d3a26f2016-09-23 21:43:51 +00001142 Conf, 0, AddStream, *M, *CombinedIndex, ImportList,
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001143 ModuleToDefinedGVSummaries[M->getModuleIdentifier()], ModuleMap)) {
1144 handleAllErrors(std::move(E), [&](ErrorInfoBase &EIB) {
1145 errs() << "Error running ThinLTO backend: " << EIB.message() << '\n';
1146 });
1147 }
1148}
1149
David Blaikie9c902b52011-09-25 23:23:43 +00001150void clang::EmitBackendOutput(DiagnosticsEngine &Diags,
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001151 const HeaderSearchOptions &HeaderOpts,
David Blaikie9c902b52011-09-25 23:23:43 +00001152 const CodeGenOptions &CGOpts,
Nick Lewycky432add52011-12-02 22:17:00 +00001153 const clang::TargetOptions &TOpts,
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001154 const LangOptions &LOpts,
1155 const llvm::DataLayout &TDesc, Module *M,
1156 BackendAction Action,
Peter Collingbourne03f89072016-07-15 00:55:40 +00001157 std::unique_ptr<raw_pwrite_stream> OS) {
Vitaly Buka769134d2018-02-16 23:38:22 +00001158 std::unique_ptr<llvm::Module> EmptyModule;
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001159 if (!CGOpts.ThinLTOIndexFile.empty()) {
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001160 // If we are performing a ThinLTO importing compile, load the function index
1161 // into memory and pass it into runThinLTOBackend, which will run the
1162 // function importer and invoke LTO passes.
1163 Expected<std::unique_ptr<ModuleSummaryIndex>> IndexOrErr =
Teresa Johnson517729f2017-05-12 19:32:17 +00001164 llvm::getModuleSummaryIndexForFile(CGOpts.ThinLTOIndexFile,
1165 /*IgnoreEmptyThinLTOIndexFile*/true);
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001166 if (!IndexOrErr) {
1167 logAllUnhandledErrors(IndexOrErr.takeError(), errs(),
1168 "Error loading index file '" +
1169 CGOpts.ThinLTOIndexFile + "': ");
1170 return;
1171 }
1172 std::unique_ptr<ModuleSummaryIndex> CombinedIndex = std::move(*IndexOrErr);
1173 // A null CombinedIndex means we should skip ThinLTO compilation
1174 // (LLVM will optionally ignore empty index files, returning null instead
1175 // of an error).
Vitaly Buka769134d2018-02-16 23:38:22 +00001176 if (CombinedIndex) {
1177 if (!CombinedIndex->skipModuleByDistributedBackend()) {
1178 runThinLTOBackend(CombinedIndex.get(), M, HeaderOpts, CGOpts, TOpts,
1179 LOpts, std::move(OS), CGOpts.SampleProfileFile,
1180 Action);
1181 return;
1182 }
1183 // Distributed indexing detected that nothing from the module is needed
1184 // for the final linking. So we can skip the compilation. We sill need to
1185 // output an empty object file to make sure that a linker does not fail
1186 // trying to read it. Also for some features, like CFI, we must skip
1187 // the compilation as CombinedIndex does not contain all required
1188 // information.
1189 EmptyModule = llvm::make_unique<llvm::Module>("empty", M->getContext());
1190 EmptyModule->setTargetTriple(M->getTargetTriple());
1191 M = EmptyModule.get();
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001192 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001193 }
1194
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001195 EmitAssemblyHelper AsmHelper(Diags, HeaderOpts, CGOpts, TOpts, LOpts, M);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +00001196
Chandler Carruth50f9e892016-12-23 20:44:01 +00001197 if (CGOpts.ExperimentalNewPassManager)
1198 AsmHelper.EmitAssemblyWithNewPassManager(Action, std::move(OS));
1199 else
1200 AsmHelper.EmitAssembly(Action, std::move(OS));
Alp Tokere83b9062014-01-02 15:08:04 +00001201
James Y Knightb214cbc2016-03-04 19:00:41 +00001202 // Verify clang's TargetInfo DataLayout against the LLVM TargetMachine's
1203 // DataLayout.
1204 if (AsmHelper.TM) {
Mehdi Aminica3cf9e2015-07-24 16:04:29 +00001205 std::string DLDesc = M->getDataLayout().getStringRepresentation();
James Y Knightb214cbc2016-03-04 19:00:41 +00001206 if (DLDesc != TDesc.getStringRepresentation()) {
Alp Tokere83b9062014-01-02 15:08:04 +00001207 unsigned DiagID = Diags.getCustomDiagID(
1208 DiagnosticsEngine::Error, "backend data layout '%0' does not match "
1209 "expected target description '%1'");
James Y Knightb214cbc2016-03-04 19:00:41 +00001210 Diags.Report(DiagID) << DLDesc << TDesc.getStringRepresentation();
Alp Tokere83b9062014-01-02 15:08:04 +00001211 }
1212 }
Daniel Dunbarf976d1b2010-06-07 23:20:08 +00001213}
Steven Wu27fb5222016-05-11 16:26:03 +00001214
1215static const char* getSectionNameForBitcode(const Triple &T) {
1216 switch (T.getObjectFormat()) {
1217 case Triple::MachO:
1218 return "__LLVM,__bitcode";
1219 case Triple::COFF:
1220 case Triple::ELF:
Dan Gohman839f2152017-01-17 21:46:38 +00001221 case Triple::Wasm:
Steven Wu27fb5222016-05-11 16:26:03 +00001222 case Triple::UnknownObjectFormat:
1223 return ".llvmbc";
1224 }
Simon Pilgrimbff9dae2016-05-11 21:55:37 +00001225 llvm_unreachable("Unimplemented ObjectFormatType");
Steven Wu27fb5222016-05-11 16:26:03 +00001226}
1227
1228static const char* getSectionNameForCommandline(const Triple &T) {
1229 switch (T.getObjectFormat()) {
1230 case Triple::MachO:
1231 return "__LLVM,__cmdline";
1232 case Triple::COFF:
1233 case Triple::ELF:
Dan Gohman839f2152017-01-17 21:46:38 +00001234 case Triple::Wasm:
Steven Wu27fb5222016-05-11 16:26:03 +00001235 case Triple::UnknownObjectFormat:
1236 return ".llvmcmd";
1237 }
Simon Pilgrimbff9dae2016-05-11 21:55:37 +00001238 llvm_unreachable("Unimplemented ObjectFormatType");
Steven Wu27fb5222016-05-11 16:26:03 +00001239}
1240
1241// With -fembed-bitcode, save a copy of the llvm IR as data in the
1242// __LLVM,__bitcode section.
1243void clang::EmbedBitcode(llvm::Module *M, const CodeGenOptions &CGOpts,
1244 llvm::MemoryBufferRef Buf) {
1245 if (CGOpts.getEmbedBitcode() == CodeGenOptions::Embed_Off)
1246 return;
1247
Steven Wu2c059a52016-05-16 18:54:58 +00001248 // Save llvm.compiler.used and remote it.
1249 SmallVector<Constant*, 2> UsedArray;
1250 SmallSet<GlobalValue*, 4> UsedGlobals;
1251 Type *UsedElementType = Type::getInt8Ty(M->getContext())->getPointerTo(0);
1252 GlobalVariable *Used = collectUsedGlobalVariables(*M, UsedGlobals, true);
1253 for (auto *GV : UsedGlobals) {
1254 if (GV->getName() != "llvm.embedded.module" &&
1255 GV->getName() != "llvm.cmdline")
1256 UsedArray.push_back(
1257 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
1258 }
1259 if (Used)
1260 Used->eraseFromParent();
1261
Steven Wu27fb5222016-05-11 16:26:03 +00001262 // Embed the bitcode for the llvm module.
1263 std::string Data;
1264 ArrayRef<uint8_t> ModuleData;
1265 Triple T(M->getTargetTriple());
1266 // Create a constant that contains the bitcode.
1267 // In case of embedding a marker, ignore the input Buf and use the empty
1268 // ArrayRef. It is also legal to create a bitcode marker even Buf is empty.
1269 if (CGOpts.getEmbedBitcode() != CodeGenOptions::Embed_Marker) {
1270 if (!isBitcode((const unsigned char *)Buf.getBufferStart(),
1271 (const unsigned char *)Buf.getBufferEnd())) {
1272 // If the input is LLVM Assembly, bitcode is produced by serializing
1273 // the module. Use-lists order need to be perserved in this case.
1274 llvm::raw_string_ostream OS(Data);
Rafael Espindola76c8f822018-02-14 19:11:37 +00001275 llvm::WriteBitcodeToFile(*M, OS, /* ShouldPreserveUseListOrder */ true);
Steven Wu27fb5222016-05-11 16:26:03 +00001276 ModuleData =
1277 ArrayRef<uint8_t>((const uint8_t *)OS.str().data(), OS.str().size());
1278 } else
1279 // If the input is LLVM bitcode, write the input byte stream directly.
1280 ModuleData = ArrayRef<uint8_t>((const uint8_t *)Buf.getBufferStart(),
1281 Buf.getBufferSize());
1282 }
1283 llvm::Constant *ModuleConstant =
1284 llvm::ConstantDataArray::get(M->getContext(), ModuleData);
Steven Wu27fb5222016-05-11 16:26:03 +00001285 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
Steven Wu2c059a52016-05-16 18:54:58 +00001286 *M, ModuleConstant->getType(), true, llvm::GlobalValue::PrivateLinkage,
Steven Wu27fb5222016-05-11 16:26:03 +00001287 ModuleConstant);
1288 GV->setSection(getSectionNameForBitcode(T));
Steven Wu2c059a52016-05-16 18:54:58 +00001289 UsedArray.push_back(
1290 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
Steven Wu27fb5222016-05-11 16:26:03 +00001291 if (llvm::GlobalVariable *Old =
Steven Wu2c059a52016-05-16 18:54:58 +00001292 M->getGlobalVariable("llvm.embedded.module", true)) {
1293 assert(Old->hasOneUse() &&
1294 "llvm.embedded.module can only be used once in llvm.compiler.used");
Steven Wu27fb5222016-05-11 16:26:03 +00001295 GV->takeName(Old);
1296 Old->eraseFromParent();
1297 } else {
1298 GV->setName("llvm.embedded.module");
1299 }
1300
Steven Wu2c059a52016-05-16 18:54:58 +00001301 // Skip if only bitcode needs to be embedded.
1302 if (CGOpts.getEmbedBitcode() != CodeGenOptions::Embed_Bitcode) {
1303 // Embed command-line options.
Saleem Abdulrasoolb1d50c12016-05-20 03:58:12 +00001304 ArrayRef<uint8_t> CmdData(const_cast<uint8_t *>(CGOpts.CmdArgs.data()),
Steven Wu2c059a52016-05-16 18:54:58 +00001305 CGOpts.CmdArgs.size());
1306 llvm::Constant *CmdConstant =
1307 llvm::ConstantDataArray::get(M->getContext(), CmdData);
1308 GV = new llvm::GlobalVariable(*M, CmdConstant->getType(), true,
1309 llvm::GlobalValue::PrivateLinkage,
1310 CmdConstant);
1311 GV->setSection(getSectionNameForCommandline(T));
1312 UsedArray.push_back(
1313 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
1314 if (llvm::GlobalVariable *Old =
1315 M->getGlobalVariable("llvm.cmdline", true)) {
1316 assert(Old->hasOneUse() &&
1317 "llvm.cmdline can only be used once in llvm.compiler.used");
1318 GV->takeName(Old);
1319 Old->eraseFromParent();
1320 } else {
1321 GV->setName("llvm.cmdline");
1322 }
1323 }
1324
1325 if (UsedArray.empty())
Steven Wu27fb5222016-05-11 16:26:03 +00001326 return;
1327
Steven Wu2c059a52016-05-16 18:54:58 +00001328 // Recreate llvm.compiler.used.
1329 ArrayType *ATy = ArrayType::get(UsedElementType, UsedArray.size());
1330 auto *NewUsed = new GlobalVariable(
1331 *M, ATy, false, llvm::GlobalValue::AppendingLinkage,
1332 llvm::ConstantArray::get(ATy, UsedArray), "llvm.compiler.used");
1333 NewUsed->setSection("llvm.metadata");
Steven Wu27fb5222016-05-11 16:26:03 +00001334}