blob: 9c4316fb1cd5abf7c1376b593cd3a7f3fd4676ec [file] [log] [blame]
Daniel Dunbarf976d1b2010-06-07 23:20:08 +00001//===--- BackendUtil.cpp - LLVM Backend Utilities -------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Daniel Dunbarc1b17292010-06-15 17:48:49 +000010#include "clang/CodeGen/BackendUtil.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000011#include "clang/Basic/Diagnostic.h"
Dan Gohmanfec0ff82011-07-05 22:02:36 +000012#include "clang/Basic/LangOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000013#include "clang/Basic/TargetOptions.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000014#include "clang/Frontend/CodeGenOptions.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000015#include "clang/Frontend/FrontendDiagnostic.h"
Kostya Serebryanyce2c7262013-12-27 08:11:08 +000016#include "clang/Frontend/Utils.h"
Saleem Abdulrasool888e2892017-01-05 16:02:32 +000017#include "clang/Lex/HeaderSearchOptions.h"
Hal Finkel1a328f52016-12-15 02:19:17 +000018#include "llvm/ADT/SmallSet.h"
Eric Christopher583a1f72015-09-26 01:25:08 +000019#include "llvm/ADT/StringExtras.h"
Saleem Abdulrasool62849c62014-05-08 02:28:32 +000020#include "llvm/ADT/StringSwitch.h"
Steven Wu27fb5222016-05-11 16:26:03 +000021#include "llvm/ADT/Triple.h"
Chandler Carruth418bd1a2015-01-15 02:16:55 +000022#include "llvm/Analysis/TargetLibraryInfo.h"
Chandler Carruthaab5ec02015-01-31 11:18:46 +000023#include "llvm/Analysis/TargetTransformInfo.h"
Teresa Johnsonffc4e242016-11-11 05:35:12 +000024#include "llvm/Bitcode/BitcodeReader.h"
Chandler Carruth50f9e892016-12-23 20:44:01 +000025#include "llvm/Bitcode/BitcodeWriter.h"
26#include "llvm/Bitcode/BitcodeWriterPass.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000027#include "llvm/CodeGen/RegAllocRegistry.h"
28#include "llvm/CodeGen/SchedulerRegistry.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000029#include "llvm/IR/DataLayout.h"
Chandler Carruth0a50c492014-01-12 11:11:50 +000030#include "llvm/IR/IRPrintingPasses.h"
Chandler Carruth9828e692015-02-13 09:57:03 +000031#include "llvm/IR/LegacyPassManager.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000032#include "llvm/IR/Module.h"
Chandler Carruth50f9e892016-12-23 20:44:01 +000033#include "llvm/IR/ModuleSummaryIndex.h"
Chandler Carruthca884742014-01-13 09:26:48 +000034#include "llvm/IR/Verifier.h"
Teresa Johnson9e3f4742016-08-12 18:12:08 +000035#include "llvm/LTO/LTOBackend.h"
Saleem Abdulrasool888e2892017-01-05 16:02:32 +000036#include "llvm/MC/MCAsmInfo.h"
Evan Chengeeb486d2011-06-29 01:14:32 +000037#include "llvm/MC/SubtargetFeature.h"
Chandler Carruth50f9e892016-12-23 20:44:01 +000038#include "llvm/Passes/PassBuilder.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000039#include "llvm/Support/CommandLine.h"
Teresa Johnson9e3f4742016-08-12 18:12:08 +000040#include "llvm/Support/MemoryBuffer.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000041#include "llvm/Support/PrettyStackTrace.h"
Evan Cheng494eb062011-08-24 18:09:14 +000042#include "llvm/Support/TargetRegistry.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000043#include "llvm/Support/Timer.h"
44#include "llvm/Support/raw_ostream.h"
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000045#include "llvm/Target/TargetMachine.h"
46#include "llvm/Target/TargetOptions.h"
Eric Christopher3de08532014-08-04 21:33:42 +000047#include "llvm/Target/TargetSubtargetInfo.h"
Gor Nishanov97e3b6d2016-10-03 22:44:48 +000048#include "llvm/Transforms/Coroutines.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000049#include "llvm/Transforms/IPO.h"
Chandler Carruthb72c19f2016-08-17 03:09:11 +000050#include "llvm/Transforms/IPO/AlwaysInliner.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000051#include "llvm/Transforms/IPO/PassManagerBuilder.h"
Tim Shen50fedec2017-06-01 23:27:51 +000052#include "llvm/Transforms/IPO/ThinLTOBitcodeWriter.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000053#include "llvm/Transforms/Instrumentation.h"
Michael Gottesman90cae772013-01-28 01:36:00 +000054#include "llvm/Transforms/ObjCARC.h"
Rafael Espindola56a7dab02011-08-02 21:51:02 +000055#include "llvm/Transforms/Scalar.h"
Chandler Carruth4ddaadc2016-03-11 09:02:43 +000056#include "llvm/Transforms/Scalar/GVN.h"
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +000057#include "llvm/Transforms/Utils/SymbolRewriter.h"
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000058#include <memory>
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000059using namespace clang;
60using namespace llvm;
61
62namespace {
63
Davide Italiano945de432017-02-13 16:07:05 +000064// Default filename used for profile generation.
65static constexpr StringLiteral DefaultProfileGenName = "default_%m.profraw";
66
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000067class EmitAssemblyHelper {
David Blaikie9c902b52011-09-25 23:23:43 +000068 DiagnosticsEngine &Diags;
Saleem Abdulrasool888e2892017-01-05 16:02:32 +000069 const HeaderSearchOptions &HSOpts;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000070 const CodeGenOptions &CodeGenOpts;
Nick Lewycky432add52011-12-02 22:17:00 +000071 const clang::TargetOptions &TargetOpts;
Dan Gohmanfec0ff82011-07-05 22:02:36 +000072 const LangOptions &LangOpts;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000073 Module *TheModule;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000074
75 Timer CodeGenerationTime;
76
Peter Collingbourne03f89072016-07-15 00:55:40 +000077 std::unique_ptr<raw_pwrite_stream> OS;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000078
Chandler Carruthd294bdb2015-02-01 12:26:23 +000079 TargetIRAnalysis getTargetIRAnalysis() const {
Chandler Carruthaab5ec02015-01-31 11:18:46 +000080 if (TM)
Chandler Carruthd294bdb2015-02-01 12:26:23 +000081 return TM->getTargetIRAnalysis();
Chandler Carruthaab5ec02015-01-31 11:18:46 +000082
Chandler Carruthd294bdb2015-02-01 12:26:23 +000083 return TargetIRAnalysis();
Chandler Carruthaab5ec02015-01-31 11:18:46 +000084 }
85
Teresa Johnson9e3f4742016-08-12 18:12:08 +000086 void CreatePasses(legacy::PassManager &MPM, legacy::FunctionPassManager &FPM);
Nadav Rotemec57ab32012-10-24 00:53:38 +000087
Rafael Espindola2f16bc12015-04-14 15:15:49 +000088 /// Generates the TargetMachine.
Peter Collingbourne03f89072016-07-15 00:55:40 +000089 /// Leaves TM unchanged if it is unable to create the target machine.
Nadav Rotemdc06b2d2012-10-24 03:52:31 +000090 /// Some of our clang tests specify triples which are not built
91 /// into clang. This is okay because these tests check the generated
92 /// IR, and they require DataLayout which depends on the triple.
93 /// In this case, we allow this method to fail and not report an error.
94 /// When MustCreateTM is used, we print an error if we are unable to load
95 /// the requested target.
Peter Collingbourne03f89072016-07-15 00:55:40 +000096 void CreateTargetMachine(bool MustCreateTM);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000097
Rafael Espindola2f16bc12015-04-14 15:15:49 +000098 /// Add passes necessary to emit assembly or LLVM IR.
Daniel Dunbarf976d1b2010-06-07 23:20:08 +000099 ///
100 /// \return True on success.
Peter Collingbourne03f89072016-07-15 00:55:40 +0000101 bool AddEmitPasses(legacy::PassManager &CodeGenPasses, BackendAction Action,
102 raw_pwrite_stream &OS);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000103
104public:
Saleem Abdulrasool888e2892017-01-05 16:02:32 +0000105 EmitAssemblyHelper(DiagnosticsEngine &_Diags,
106 const HeaderSearchOptions &HeaderSearchOpts,
107 const CodeGenOptions &CGOpts,
Nick Lewycky432add52011-12-02 22:17:00 +0000108 const clang::TargetOptions &TOpts,
Teresa Johnson4b4f4b92016-01-08 17:04:29 +0000109 const LangOptions &LOpts, Module *M)
Saleem Abdulrasool888e2892017-01-05 16:02:32 +0000110 : Diags(_Diags), HSOpts(HeaderSearchOpts), CodeGenOpts(CGOpts),
111 TargetOpts(TOpts), LangOpts(LOpts), TheModule(M),
112 CodeGenerationTime("codegen", "Code Generation Time") {}
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000113
114 ~EmitAssemblyHelper() {
Alp Tokerf4e22382013-12-20 20:26:53 +0000115 if (CodeGenOpts.DisableFree)
David Blaikiea97eaa12014-08-29 16:53:14 +0000116 BuryPointer(std::move(TM));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000117 }
118
Ahmed Charlesb8984322014-03-07 20:03:18 +0000119 std::unique_ptr<TargetMachine> TM;
Alp Tokerf4e22382013-12-20 20:26:53 +0000120
Peter Collingbourne03f89072016-07-15 00:55:40 +0000121 void EmitAssembly(BackendAction Action,
122 std::unique_ptr<raw_pwrite_stream> OS);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000123
124 void EmitAssemblyWithNewPassManager(BackendAction Action,
125 std::unique_ptr<raw_pwrite_stream> OS);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000126};
127
Alexey Samsonovc6515b62012-12-28 09:31:34 +0000128// We need this wrapper to access LangOpts and CGOpts from extension functions
129// that we add to the PassManagerBuilder.
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000130class PassManagerBuilderWrapper : public PassManagerBuilder {
131public:
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000132 PassManagerBuilderWrapper(const Triple &TargetTriple,
133 const CodeGenOptions &CGOpts,
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000134 const LangOptions &LangOpts)
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000135 : PassManagerBuilder(), TargetTriple(TargetTriple), CGOpts(CGOpts),
136 LangOpts(LangOpts) {}
137 const Triple &getTargetTriple() const { return TargetTriple; }
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000138 const CodeGenOptions &getCGOpts() const { return CGOpts; }
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000139 const LangOptions &getLangOpts() const { return LangOpts; }
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000140
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000141private:
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000142 const Triple &TargetTriple;
Alexey Samsonov9ab73622012-12-03 19:12:58 +0000143 const CodeGenOptions &CGOpts;
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000144 const LangOptions &LangOpts;
145};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000146}
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000147
Dan Gohman5932ce22012-01-17 20:54:51 +0000148static void addObjCARCAPElimPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
149 if (Builder.OptLevel > 0)
150 PM.add(createObjCARCAPElimPass());
151}
152
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000153static void addObjCARCExpandPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
154 if (Builder.OptLevel > 0)
155 PM.add(createObjCARCExpandPass());
156}
157
158static void addObjCARCOptPass(const PassManagerBuilder &Builder, PassManagerBase &PM) {
159 if (Builder.OptLevel > 0)
160 PM.add(createObjCARCOptPass());
161}
162
Diego Novillob56be642014-03-03 20:06:18 +0000163static void addAddDiscriminatorsPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000164 legacy::PassManagerBase &PM) {
Diego Novillob56be642014-03-03 20:06:18 +0000165 PM.add(createAddDiscriminatorsPass());
166}
167
Nuno Lopesa4255892012-05-22 17:19:45 +0000168static void addBoundsCheckingPass(const PassManagerBuilder &Builder,
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000169 legacy::PassManagerBase &PM) {
Joey Goulyebc59d52012-11-23 10:39:49 +0000170 PM.add(createBoundsCheckingPass());
Nuno Lopesa4255892012-05-22 17:19:45 +0000171}
172
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000173static void addSanitizerCoveragePass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000174 legacy::PassManagerBase &PM) {
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000175 const PassManagerBuilderWrapper &BuilderWrapper =
176 static_cast<const PassManagerBuilderWrapper&>(Builder);
177 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
Alexey Samsonov3f3b3ab2015-05-07 18:31:29 +0000178 SanitizerCoverageOptions Opts;
179 Opts.CoverageType =
180 static_cast<SanitizerCoverageOptions::Type>(CGOpts.SanitizeCoverageType);
181 Opts.IndirectCalls = CGOpts.SanitizeCoverageIndirectCalls;
182 Opts.TraceBB = CGOpts.SanitizeCoverageTraceBB;
183 Opts.TraceCmp = CGOpts.SanitizeCoverageTraceCmp;
Kostya Serebryany3b419712016-08-30 01:27:03 +0000184 Opts.TraceDiv = CGOpts.SanitizeCoverageTraceDiv;
185 Opts.TraceGep = CGOpts.SanitizeCoverageTraceGep;
Alexey Samsonov3f3b3ab2015-05-07 18:31:29 +0000186 Opts.Use8bitCounters = CGOpts.SanitizeCoverage8bitCounters;
Kostya Serebryanyd4590c72016-02-17 21:34:43 +0000187 Opts.TracePC = CGOpts.SanitizeCoverageTracePC;
Kostya Serebryany60cdd612016-09-14 01:39:49 +0000188 Opts.TracePCGuard = CGOpts.SanitizeCoverageTracePCGuard;
Kostya Serebryany50fb6182017-05-05 23:28:18 +0000189 Opts.NoPrune = CGOpts.SanitizeCoverageNoPrune;
Kostya Serebryany2c2fb882017-06-08 22:58:19 +0000190 Opts.Inline8bitCounters = CGOpts.SanitizeCoverageInline8bitCounters;
Alexey Samsonov3f3b3ab2015-05-07 18:31:29 +0000191 PM.add(createSanitizerCoverageModulePass(Opts));
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000192}
193
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000194// Check if ASan should use GC-friendly instrumentation for globals.
195// First of all, there is no point if -fdata-sections is off (expect for MachO,
196// where this is not a factor). Also, on ELF this feature requires an assembler
197// extension that only works with -integrated-as at the moment.
198static bool asanUseGlobalsGC(const Triple &T, const CodeGenOptions &CGOpts) {
Evgeniy Stepanovd991cdd2017-05-09 21:57:43 +0000199 if (!CGOpts.SanitizeAddressGlobalsDeadStripping)
200 return false;
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000201 switch (T.getObjectFormat()) {
202 case Triple::MachO:
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000203 case Triple::COFF:
Evgeniy Stepanovc7b90942017-04-26 00:51:06 +0000204 return true;
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000205 case Triple::ELF:
206 return CGOpts.DataSections && !CGOpts.DisableIntegratedAS;
207 default:
208 return false;
209 }
210}
211
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000212static void addAddressSanitizerPasses(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000213 legacy::PassManagerBase &PM) {
Yury Gribov5bfeca12015-11-11 10:45:48 +0000214 const PassManagerBuilderWrapper &BuilderWrapper =
215 static_cast<const PassManagerBuilderWrapper&>(Builder);
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000216 const Triple &T = BuilderWrapper.getTargetTriple();
Yury Gribov5bfeca12015-11-11 10:45:48 +0000217 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
218 bool Recover = CGOpts.SanitizeRecover.has(SanitizerKind::Address);
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000219 bool UseAfterScope = CGOpts.SanitizeAddressUseAfterScope;
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000220 bool UseGlobalsGC = asanUseGlobalsGC(T, CGOpts);
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000221 PM.add(createAddressSanitizerFunctionPass(/*CompileKernel*/ false, Recover,
222 UseAfterScope));
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000223 PM.add(createAddressSanitizerModulePass(/*CompileKernel*/ false, Recover,
224 UseGlobalsGC));
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000225}
226
227static void addKernelAddressSanitizerPasses(const PassManagerBuilder &Builder,
228 legacy::PassManagerBase &PM) {
Vitaly Buka9d4eb6f2016-06-02 00:24:20 +0000229 PM.add(createAddressSanitizerFunctionPass(
230 /*CompileKernel*/ true,
231 /*Recover*/ true, /*UseAfterScope*/ false));
Yury Gribov5bfeca12015-11-11 10:45:48 +0000232 PM.add(createAddressSanitizerModulePass(/*CompileKernel*/true,
233 /*Recover*/true));
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000234}
235
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000236static void addMemorySanitizerPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000237 legacy::PassManagerBase &PM) {
Evgeniy Stepanovad8ab3d2012-12-24 08:42:34 +0000238 const PassManagerBuilderWrapper &BuilderWrapper =
239 static_cast<const PassManagerBuilderWrapper&>(Builder);
240 const CodeGenOptions &CGOpts = BuilderWrapper.getCGOpts();
Evgeniy Stepanov5b5370a2016-11-07 21:02:11 +0000241 int TrackOrigins = CGOpts.SanitizeMemoryTrackOrigins;
242 bool Recover = CGOpts.SanitizeRecover.has(SanitizerKind::Memory);
243 PM.add(createMemorySanitizerPass(TrackOrigins, Recover));
Evgeniy Stepanov10284672013-01-31 09:53:29 +0000244
245 // MemorySanitizer inserts complex instrumentation that mostly follows
246 // the logic of the original code, but operates on "shadow" values.
247 // It can benefit from re-running some general purpose optimization passes.
248 if (Builder.OptLevel > 0) {
249 PM.add(createEarlyCSEPass());
250 PM.add(createReassociatePass());
251 PM.add(createLICMPass());
252 PM.add(createGVNPass());
253 PM.add(createInstructionCombiningPass());
254 PM.add(createDeadStoreEliminationPass());
255 }
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000256}
257
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000258static void addThreadSanitizerPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000259 legacy::PassManagerBase &PM) {
Alexey Samsonov1cf07ea2014-06-02 18:08:08 +0000260 PM.add(createThreadSanitizerPass());
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000261}
262
Peter Collingbournec3772752013-08-07 22:47:34 +0000263static void addDataFlowSanitizerPass(const PassManagerBuilder &Builder,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000264 legacy::PassManagerBase &PM) {
Peter Collingbourne276be3c2013-08-14 18:54:18 +0000265 const PassManagerBuilderWrapper &BuilderWrapper =
266 static_cast<const PassManagerBuilderWrapper&>(Builder);
Alexey Samsonovae5804f2014-10-15 20:22:54 +0000267 const LangOptions &LangOpts = BuilderWrapper.getLangOpts();
Alexey Samsonova511cdd2015-02-04 17:40:08 +0000268 PM.add(createDataFlowSanitizerPass(LangOpts.SanitizerBlacklistFiles));
Peter Collingbournec3772752013-08-07 22:47:34 +0000269}
270
Derek Bruening256c2e12016-04-21 21:32:04 +0000271static void addEfficiencySanitizerPass(const PassManagerBuilder &Builder,
272 legacy::PassManagerBase &PM) {
273 const PassManagerBuilderWrapper &BuilderWrapper =
274 static_cast<const PassManagerBuilderWrapper&>(Builder);
275 const LangOptions &LangOpts = BuilderWrapper.getLangOpts();
276 EfficiencySanitizerOptions Opts;
277 if (LangOpts.Sanitize.has(SanitizerKind::EfficiencyCacheFrag))
278 Opts.ToolType = EfficiencySanitizerOptions::ESAN_CacheFrag;
Derek Bruening293772e2016-05-25 00:41:24 +0000279 else if (LangOpts.Sanitize.has(SanitizerKind::EfficiencyWorkingSet))
280 Opts.ToolType = EfficiencySanitizerOptions::ESAN_WorkingSet;
Derek Bruening256c2e12016-04-21 21:32:04 +0000281 PM.add(createEfficiencySanitizerPass(Opts));
282}
283
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000284static TargetLibraryInfoImpl *createTLII(llvm::Triple &TargetTriple,
285 const CodeGenOptions &CodeGenOpts) {
286 TargetLibraryInfoImpl *TLII = new TargetLibraryInfoImpl(TargetTriple);
Rafael Espindolab8a71c52014-08-21 17:58:42 +0000287 if (!CodeGenOpts.SimplifyLibCalls)
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000288 TLII->disableAllFunctions();
Chad Rosier7dbc9cf2016-01-06 14:35:46 +0000289 else {
290 // Disable individual libc/libm calls in TargetLibraryInfo.
David L. Jones7a7dd032017-01-23 23:16:58 +0000291 LibFunc F;
Chad Rosier7dbc9cf2016-01-06 14:35:46 +0000292 for (auto &FuncName : CodeGenOpts.getNoBuiltinFuncs())
293 if (TLII->getLibFunc(FuncName, F))
294 TLII->setUnavailable(F);
295 }
Michael Zolotukhinc888dd02015-03-17 20:03:11 +0000296
297 switch (CodeGenOpts.getVecLib()) {
298 case CodeGenOptions::Accelerate:
299 TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::Accelerate);
300 break;
Matt Masten6731dea2016-07-29 16:44:24 +0000301 case CodeGenOptions::SVML:
302 TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::SVML);
303 break;
Michael Zolotukhinc888dd02015-03-17 20:03:11 +0000304 default:
305 break;
306 }
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000307 return TLII;
Rafael Espindolab8a71c52014-08-21 17:58:42 +0000308}
309
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000310static void addSymbolRewriterPass(const CodeGenOptions &Opts,
Chandler Carruth8f4f5092015-02-13 09:47:49 +0000311 legacy::PassManager *MPM) {
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000312 llvm::SymbolRewriter::RewriteDescriptorList DL;
313
314 llvm::SymbolRewriter::RewriteMapParser MapParser;
315 for (const auto &MapFile : Opts.RewriteMapFiles)
316 MapParser.parse(MapFile, &DL);
317
318 MPM->add(createRewriteSymbolsPass(DL));
319}
320
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000321static CodeGenOpt::Level getCGOptLevel(const CodeGenOptions &CodeGenOpts) {
322 switch (CodeGenOpts.OptimizationLevel) {
323 default:
324 llvm_unreachable("Invalid optimization level!");
325 case 0:
326 return CodeGenOpt::None;
327 case 1:
328 return CodeGenOpt::Less;
329 case 2:
330 return CodeGenOpt::Default; // O2/Os/Oz
331 case 3:
332 return CodeGenOpt::Aggressive;
333 }
334}
335
336static llvm::CodeModel::Model getCodeModel(const CodeGenOptions &CodeGenOpts) {
337 unsigned CodeModel =
338 llvm::StringSwitch<unsigned>(CodeGenOpts.CodeModel)
339 .Case("small", llvm::CodeModel::Small)
340 .Case("kernel", llvm::CodeModel::Kernel)
341 .Case("medium", llvm::CodeModel::Medium)
342 .Case("large", llvm::CodeModel::Large)
343 .Case("default", llvm::CodeModel::Default)
344 .Default(~0u);
345 assert(CodeModel != ~0u && "invalid code model!");
346 return static_cast<llvm::CodeModel::Model>(CodeModel);
347}
348
349static llvm::Reloc::Model getRelocModel(const CodeGenOptions &CodeGenOpts) {
Davide Italiano1a3665bb2017-04-01 21:07:07 +0000350 // Keep this synced with the equivalent code in
351 // lib/Frontend/CompilerInvocation.cpp
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000352 llvm::Optional<llvm::Reloc::Model> RM;
353 RM = llvm::StringSwitch<llvm::Reloc::Model>(CodeGenOpts.RelocationModel)
354 .Case("static", llvm::Reloc::Static)
355 .Case("pic", llvm::Reloc::PIC_)
356 .Case("ropi", llvm::Reloc::ROPI)
357 .Case("rwpi", llvm::Reloc::RWPI)
358 .Case("ropi-rwpi", llvm::Reloc::ROPI_RWPI)
359 .Case("dynamic-no-pic", llvm::Reloc::DynamicNoPIC);
360 assert(RM.hasValue() && "invalid PIC model!");
361 return *RM;
362}
363
364static TargetMachine::CodeGenFileType getCodeGenFileType(BackendAction Action) {
365 if (Action == Backend_EmitObj)
366 return TargetMachine::CGFT_ObjectFile;
367 else if (Action == Backend_EmitMCNull)
368 return TargetMachine::CGFT_Null;
369 else {
370 assert(Action == Backend_EmitAssembly && "Invalid action!");
371 return TargetMachine::CGFT_AssemblyFile;
372 }
373}
374
375static void initTargetOptions(llvm::TargetOptions &Options,
376 const CodeGenOptions &CodeGenOpts,
377 const clang::TargetOptions &TargetOpts,
378 const LangOptions &LangOpts,
379 const HeaderSearchOptions &HSOpts) {
380 Options.ThreadModel =
381 llvm::StringSwitch<llvm::ThreadModel::Model>(CodeGenOpts.ThreadModel)
382 .Case("posix", llvm::ThreadModel::POSIX)
383 .Case("single", llvm::ThreadModel::Single);
384
385 // Set float ABI type.
386 assert((CodeGenOpts.FloatABI == "soft" || CodeGenOpts.FloatABI == "softfp" ||
387 CodeGenOpts.FloatABI == "hard" || CodeGenOpts.FloatABI.empty()) &&
388 "Invalid Floating Point ABI!");
389 Options.FloatABIType =
390 llvm::StringSwitch<llvm::FloatABI::ABIType>(CodeGenOpts.FloatABI)
391 .Case("soft", llvm::FloatABI::Soft)
392 .Case("softfp", llvm::FloatABI::Soft)
393 .Case("hard", llvm::FloatABI::Hard)
394 .Default(llvm::FloatABI::Default);
395
396 // Set FP fusion mode.
397 switch (LangOpts.getDefaultFPContractMode()) {
398 case LangOptions::FPC_Off:
Adam Nemet03af4242017-04-20 17:09:35 +0000399 // Preserve any contraction performed by the front-end. (Strict performs
400 // splitting of the muladd instrinsic in the backend.)
401 Options.AllowFPOpFusion = llvm::FPOpFusion::Standard;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000402 break;
403 case LangOptions::FPC_On:
404 Options.AllowFPOpFusion = llvm::FPOpFusion::Standard;
405 break;
406 case LangOptions::FPC_Fast:
407 Options.AllowFPOpFusion = llvm::FPOpFusion::Fast;
408 break;
409 }
410
411 Options.UseInitArray = CodeGenOpts.UseInitArray;
412 Options.DisableIntegratedAS = CodeGenOpts.DisableIntegratedAS;
Saleem Abdulrasool54448902017-06-09 00:40:30 +0000413 Options.CompressDebugSections = CodeGenOpts.getCompressDebugSections();
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000414 Options.RelaxELFRelocations = CodeGenOpts.RelaxELFRelocations;
415
416 // Set EABI version.
417 Options.EABIVersion = llvm::StringSwitch<llvm::EABI>(TargetOpts.EABIVersion)
418 .Case("4", llvm::EABI::EABI4)
419 .Case("5", llvm::EABI::EABI5)
420 .Case("gnu", llvm::EABI::GNU)
421 .Default(llvm::EABI::Default);
422
423 if (LangOpts.SjLjExceptions)
424 Options.ExceptionModel = llvm::ExceptionHandling::SjLj;
425
426 Options.NoInfsFPMath = CodeGenOpts.NoInfsFPMath;
427 Options.NoNaNsFPMath = CodeGenOpts.NoNaNsFPMath;
428 Options.NoZerosInBSS = CodeGenOpts.NoZeroInitializedInBSS;
429 Options.UnsafeFPMath = CodeGenOpts.UnsafeFPMath;
430 Options.StackAlignmentOverride = CodeGenOpts.StackAlignment;
431 Options.FunctionSections = CodeGenOpts.FunctionSections;
432 Options.DataSections = CodeGenOpts.DataSections;
433 Options.UniqueSectionNames = CodeGenOpts.UniqueSectionNames;
434 Options.EmulatedTLS = CodeGenOpts.EmulatedTLS;
435 Options.DebuggerTuning = CodeGenOpts.getDebuggerTuning();
436
David Blaikie81503552017-04-21 23:35:36 +0000437 if (CodeGenOpts.EnableSplitDwarf)
438 Options.MCOptions.SplitDwarfFile = CodeGenOpts.SplitDwarfFile;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000439 Options.MCOptions.MCRelaxAll = CodeGenOpts.RelaxAll;
440 Options.MCOptions.MCSaveTempLabels = CodeGenOpts.SaveTempLabels;
441 Options.MCOptions.MCUseDwarfDirectory = !CodeGenOpts.NoDwarfDirectoryAsm;
442 Options.MCOptions.MCNoExecStack = CodeGenOpts.NoExecStack;
443 Options.MCOptions.MCIncrementalLinkerCompatible =
444 CodeGenOpts.IncrementalLinkerCompatible;
445 Options.MCOptions.MCPIECopyRelocations = CodeGenOpts.PIECopyRelocations;
446 Options.MCOptions.MCFatalWarnings = CodeGenOpts.FatalWarnings;
447 Options.MCOptions.AsmVerbose = CodeGenOpts.AsmVerbose;
448 Options.MCOptions.PreserveAsmComments = CodeGenOpts.PreserveAsmComments;
449 Options.MCOptions.ABIName = TargetOpts.ABI;
450 for (const auto &Entry : HSOpts.UserEntries)
451 if (!Entry.IsFramework &&
452 (Entry.Group == frontend::IncludeDirGroup::Quoted ||
453 Entry.Group == frontend::IncludeDirGroup::Angled ||
454 Entry.Group == frontend::IncludeDirGroup::System))
455 Options.MCOptions.IASSearchPaths.push_back(
456 Entry.IgnoreSysRoot ? Entry.Path : HSOpts.Sysroot + Entry.Path);
457}
458
Peter Collingbourne03f89072016-07-15 00:55:40 +0000459void EmitAssemblyHelper::CreatePasses(legacy::PassManager &MPM,
Teresa Johnson9e3f4742016-08-12 18:12:08 +0000460 legacy::FunctionPassManager &FPM) {
Chandler Carruth93786da2016-12-23 00:23:01 +0000461 // Handle disabling of all LLVM passes, where we want to preserve the
462 // internal module before any optimization.
Steven Wu546a1962015-07-17 20:09:56 +0000463 if (CodeGenOpts.DisableLLVMPasses)
464 return;
465
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000466 // Figure out TargetLibraryInfo. This needs to be added to MPM and FPM
467 // manually (and not via PMBuilder), since some passes (eg. InstrProfiling)
468 // are inserted before PMBuilder ones - they'd get the default-constructed
469 // TLI with an unknown target otherwise.
Teresa Johnsonaff22322015-12-07 19:21:34 +0000470 Triple TargetTriple(TheModule->getTargetTriple());
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000471 std::unique_ptr<TargetLibraryInfoImpl> TLII(
472 createTLII(TargetTriple, CodeGenOpts));
Teresa Johnsonaff22322015-12-07 19:21:34 +0000473
Evgeniy Stepanovdf217a22017-04-24 19:34:12 +0000474 PassManagerBuilderWrapper PMBuilder(TargetTriple, CodeGenOpts, LangOpts);
475
Chandler Carruthfcd33142016-12-23 01:24:49 +0000476 // At O0 and O1 we only run the always inliner which is more efficient. At
477 // higher optimization levels we run the normal inliner.
478 if (CodeGenOpts.OptimizationLevel <= 1) {
Mehdi Amini7f873072017-01-06 23:18:09 +0000479 bool InsertLifetimeIntrinsics = (CodeGenOpts.OptimizationLevel != 0 &&
480 !CodeGenOpts.DisableLifetimeMarkers);
Chandler Carruthfcd33142016-12-23 01:24:49 +0000481 PMBuilder.Inliner = createAlwaysInlinerLegacyPass(InsertLifetimeIntrinsics);
482 } else {
Dehao Chence39fdd2017-03-21 19:55:46 +0000483 // We do not want to inline hot callsites for SamplePGO module-summary build
484 // because profile annotation will happen again in ThinLTO backend, and we
485 // want the IR of the hot path to match the profile.
Chandler Carruthfcd33142016-12-23 01:24:49 +0000486 PMBuilder.Inliner = createFunctionInliningPass(
Dehao Chence39fdd2017-03-21 19:55:46 +0000487 CodeGenOpts.OptimizationLevel, CodeGenOpts.OptimizeSize,
488 (!CodeGenOpts.SampleProfileFile.empty() &&
489 CodeGenOpts.EmitSummaryIndex));
Teresa Johnsonaff22322015-12-07 19:21:34 +0000490 }
491
Chandler Carruthfcd33142016-12-23 01:24:49 +0000492 PMBuilder.OptLevel = CodeGenOpts.OptimizationLevel;
Chris Lattnerecf0ba52011-05-21 23:50:44 +0000493 PMBuilder.SizeLevel = CodeGenOpts.OptimizeSize;
Nick Lewyckyd3f3e4f2013-06-25 01:49:44 +0000494 PMBuilder.BBVectorize = CodeGenOpts.VectorizeBB;
495 PMBuilder.SLPVectorize = CodeGenOpts.VectorizeSLP;
496 PMBuilder.LoopVectorize = CodeGenOpts.VectorizeLoop;
Andrew Trickb2a84722011-04-05 18:49:32 +0000497
Chris Lattnerecf0ba52011-05-21 23:50:44 +0000498 PMBuilder.DisableUnrollLoops = !CodeGenOpts.UnrollLoops;
Nick Lewyckyf04f2372014-10-24 00:49:29 +0000499 PMBuilder.MergeFunctions = CodeGenOpts.MergeFunctions;
Teresa Johnsona0d29402016-03-15 00:04:44 +0000500 PMBuilder.PrepareForThinLTO = CodeGenOpts.EmitSummaryIndex;
Teresa Johnson8749d8042015-07-06 16:23:00 +0000501 PMBuilder.PrepareForLTO = CodeGenOpts.PrepareForLTO;
Hal Finkelce0697f2013-11-17 16:03:29 +0000502 PMBuilder.RerollLoops = CodeGenOpts.RerollLoops;
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000503
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000504 MPM.add(new TargetLibraryInfoWrapperPass(*TLII));
505
Justin Lebar5a7df9c2016-04-27 19:12:56 +0000506 if (TM)
Stanislav Mekhanoshin61da0672017-01-26 16:49:21 +0000507 TM->adjustPassManager(PMBuilder);
Justin Lebar5a7df9c2016-04-27 19:12:56 +0000508
Dehao Chen7810d4f2017-02-21 20:36:21 +0000509 if (CodeGenOpts.DebugInfoForProfiling ||
510 !CodeGenOpts.SampleProfileFile.empty())
511 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
512 addAddDiscriminatorsPass);
Diego Novillob56be642014-03-03 20:06:18 +0000513
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000514 // In ObjC ARC mode, add the main ARC optimization passes.
515 if (LangOpts.ObjCAutoRefCount) {
516 PMBuilder.addExtension(PassManagerBuilder::EP_EarlyAsPossible,
517 addObjCARCExpandPass);
Dan Gohman5932ce22012-01-17 20:54:51 +0000518 PMBuilder.addExtension(PassManagerBuilder::EP_ModuleOptimizerEarly,
519 addObjCARCAPElimPass);
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000520 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
521 addObjCARCOptPass);
522 }
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000523
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000524 if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds)) {
Nuno Lopesa4255892012-05-22 17:19:45 +0000525 PMBuilder.addExtension(PassManagerBuilder::EP_ScalarOptimizerLate,
526 addBoundsCheckingPass);
527 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
528 addBoundsCheckingPass);
529 }
530
Alexey Samsonovdfa908c2015-05-07 22:34:06 +0000531 if (CodeGenOpts.SanitizeCoverageType ||
532 CodeGenOpts.SanitizeCoverageIndirectCalls ||
533 CodeGenOpts.SanitizeCoverageTraceCmp) {
Kostya Serebryany75b4f9e2014-11-11 22:15:07 +0000534 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
535 addSanitizerCoveragePass);
536 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
537 addSanitizerCoveragePass);
538 }
539
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000540 if (LangOpts.Sanitize.has(SanitizerKind::Address)) {
Kostya Serebryany7e247f22012-10-15 14:22:56 +0000541 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000542 addAddressSanitizerPasses);
Kostya Serebryanyd4768572011-11-30 22:20:21 +0000543 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
Alexey Samsonov0e96bec2012-11-29 22:36:21 +0000544 addAddressSanitizerPasses);
Kostya Serebryany8855ff62011-11-16 17:34:26 +0000545 }
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000546
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000547 if (LangOpts.Sanitize.has(SanitizerKind::KernelAddress)) {
548 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
549 addKernelAddressSanitizerPasses);
550 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
551 addKernelAddressSanitizerPasses);
552 }
553
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000554 if (LangOpts.Sanitize.has(SanitizerKind::Memory)) {
Evgeniy Stepanovaea92e52012-12-03 13:20:43 +0000555 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
556 addMemorySanitizerPass);
557 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
558 addMemorySanitizerPass);
559 }
560
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000561 if (LangOpts.Sanitize.has(SanitizerKind::Thread)) {
Kostya Serebryanyd18cb502012-03-23 23:25:23 +0000562 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
Kostya Serebryany28a7a112012-03-01 22:27:08 +0000563 addThreadSanitizerPass);
564 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
565 addThreadSanitizerPass);
566 }
567
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000568 if (LangOpts.Sanitize.has(SanitizerKind::DataFlow)) {
Peter Collingbournec3772752013-08-07 22:47:34 +0000569 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
570 addDataFlowSanitizerPass);
571 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
572 addDataFlowSanitizerPass);
573 }
574
Gor Nishanov97e3b6d2016-10-03 22:44:48 +0000575 if (LangOpts.CoroutinesTS)
576 addCoroutinePassesToExtensionPoints(PMBuilder);
577
Derek Bruening256c2e12016-04-21 21:32:04 +0000578 if (LangOpts.Sanitize.hasOneOf(SanitizerKind::Efficiency)) {
579 PMBuilder.addExtension(PassManagerBuilder::EP_OptimizerLast,
580 addEfficiencySanitizerPass);
581 PMBuilder.addExtension(PassManagerBuilder::EP_EnabledOnOptLevel0,
582 addEfficiencySanitizerPass);
583 }
584
Chris Lattner5c123672011-05-21 20:40:11 +0000585 // Set up the per-function pass manager.
Marcin Koscielnicki9a063e72016-11-22 20:03:35 +0000586 FPM.add(new TargetLibraryInfoWrapperPass(*TLII));
Chris Lattner5c123672011-05-21 20:40:11 +0000587 if (CodeGenOpts.VerifyModule)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000588 FPM.add(createVerifierPass());
Andrew Trickb2a84722011-04-05 18:49:32 +0000589
Chris Lattner5c123672011-05-21 20:40:11 +0000590 // Set up the per-module pass manager.
Saleem Abdulrasool76a4b952015-01-09 05:10:20 +0000591 if (!CodeGenOpts.RewriteMapFiles.empty())
Peter Collingbourne03f89072016-07-15 00:55:40 +0000592 addSymbolRewriterPass(CodeGenOpts, &MPM);
Chris Lattnerd98cec52011-02-18 22:20:38 +0000593
Nick Lewyckyc02bbb62013-03-20 01:38:16 +0000594 if (!CodeGenOpts.DisableGCov &&
595 (CodeGenOpts.EmitGcovArcs || CodeGenOpts.EmitGcovNotes)) {
Nick Lewyckyc8bf8242013-03-14 05:14:01 +0000596 // Not using 'GCOVOptions::getDefault' allows us to avoid exiting if
597 // LLVM's -default-gcov-version flag is set to something invalid.
598 GCOVOptions Options;
599 Options.EmitNotes = CodeGenOpts.EmitGcovNotes;
600 Options.EmitData = CodeGenOpts.EmitGcovArcs;
601 memcpy(Options.Version, CodeGenOpts.CoverageVersion, 4);
602 Options.UseCfgChecksum = CodeGenOpts.CoverageExtraChecksum;
603 Options.NoRedZone = CodeGenOpts.DisableRedZone;
Nick Lewyckyc8bf8242013-03-14 05:14:01 +0000604 Options.FunctionNamesInData =
Nick Lewycky6f15b2902013-03-20 02:14:38 +0000605 !CodeGenOpts.CoverageNoFunctionNamesInData;
Justin Bogner4e462372015-03-16 23:52:21 +0000606 Options.ExitBlockBeforeBody = CodeGenOpts.CoverageExitBlockBeforeBody;
Peter Collingbourne03f89072016-07-15 00:55:40 +0000607 MPM.add(createGCOVProfilerPass(Options));
Benjamin Kramer8c305922016-02-02 11:06:51 +0000608 if (CodeGenOpts.getDebugInfo() == codegenoptions::NoDebugInfo)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000609 MPM.add(createStripSymbolsPass(true));
Nick Lewycky207bce32011-04-21 23:44:07 +0000610 }
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000611
Rong Xu9837ef52016-02-04 18:39:09 +0000612 if (CodeGenOpts.hasProfileClangInstr()) {
Justin Bogner970ac602014-12-08 19:04:51 +0000613 InstrProfOptions Options;
614 Options.NoRedZone = CodeGenOpts.DisableRedZone;
Justin Bognera71e6812015-04-30 23:49:42 +0000615 Options.InstrProfileOutput = CodeGenOpts.InstrProfileOutput;
Peter Collingbourne03f89072016-07-15 00:55:40 +0000616 MPM.add(createInstrProfilingLegacyPass(Options));
Justin Bogner970ac602014-12-08 19:04:51 +0000617 }
Rong Xu522b5cb2016-02-29 18:54:59 +0000618 if (CodeGenOpts.hasProfileIRInstr()) {
Xinliang David Lib65f8ae2016-07-23 04:28:59 +0000619 PMBuilder.EnablePGOInstrGen = true;
Rong Xu522b5cb2016-02-29 18:54:59 +0000620 if (!CodeGenOpts.InstrProfileOutput.empty())
621 PMBuilder.PGOInstrGen = CodeGenOpts.InstrProfileOutput;
622 else
Davide Italiano945de432017-02-13 16:07:05 +0000623 PMBuilder.PGOInstrGen = DefaultProfileGenName;
Rong Xu522b5cb2016-02-29 18:54:59 +0000624 }
Rong Xu9c6f1532016-03-02 20:59:36 +0000625 if (CodeGenOpts.hasProfileIRUse())
626 PMBuilder.PGOInstrUse = CodeGenOpts.ProfileInstrumentUsePath;
Justin Bogner970ac602014-12-08 19:04:51 +0000627
Dehao Chen5717aff2016-12-14 21:41:04 +0000628 if (!CodeGenOpts.SampleProfileFile.empty())
629 PMBuilder.PGOSampleUse = CodeGenOpts.SampleProfileFile;
Diego Novillod3ef1082015-08-25 15:25:13 +0000630
Peter Collingbourne03f89072016-07-15 00:55:40 +0000631 PMBuilder.populateFunctionPassManager(FPM);
632 PMBuilder.populateModulePassManager(MPM);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000633}
634
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000635static void setCommandLineOpts(const CodeGenOptions &CodeGenOpts) {
Yaxun Liub5e80c32016-04-12 20:22:32 +0000636 SmallVector<const char *, 16> BackendArgs;
637 BackendArgs.push_back("clang"); // Fake program name.
638 if (!CodeGenOpts.DebugPass.empty()) {
639 BackendArgs.push_back("-debug-pass");
640 BackendArgs.push_back(CodeGenOpts.DebugPass.c_str());
641 }
642 if (!CodeGenOpts.LimitFloatPrecision.empty()) {
643 BackendArgs.push_back("-limit-float-precision");
644 BackendArgs.push_back(CodeGenOpts.LimitFloatPrecision.c_str());
645 }
646 for (const std::string &BackendOption : CodeGenOpts.BackendOptions)
647 BackendArgs.push_back(BackendOption.c_str());
648 BackendArgs.push_back(nullptr);
649 llvm::cl::ParseCommandLineOptions(BackendArgs.size() - 1,
650 BackendArgs.data());
651}
652
Peter Collingbourne03f89072016-07-15 00:55:40 +0000653void EmitAssemblyHelper::CreateTargetMachine(bool MustCreateTM) {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000654 // Create the TargetMachine for generating code.
655 std::string Error;
656 std::string Triple = TheModule->getTargetTriple();
657 const llvm::Target *TheTarget = TargetRegistry::lookupTarget(Triple, Error);
658 if (!TheTarget) {
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000659 if (MustCreateTM)
Chad Rosierecafbe62013-03-27 00:14:35 +0000660 Diags.Report(diag::err_fe_unable_to_create_target) << Error;
Peter Collingbourne03f89072016-07-15 00:55:40 +0000661 return;
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000662 }
663
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000664 llvm::CodeModel::Model CM = getCodeModel(CodeGenOpts);
Eric Christopher583a1f72015-09-26 01:25:08 +0000665 std::string FeaturesStr =
666 llvm::join(TargetOpts.Features.begin(), TargetOpts.Features.end(), ",");
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000667 llvm::Reloc::Model RM = getRelocModel(CodeGenOpts);
668 CodeGenOpt::Level OptLevel = getCGOptLevel(CodeGenOpts);
Evan Chengdd286bc2011-11-16 08:38:55 +0000669
Nick Lewycky432add52011-12-02 22:17:00 +0000670 llvm::TargetOptions Options;
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000671 initTargetOptions(Options, CodeGenOpts, TargetOpts, LangOpts, HSOpts);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000672 TM.reset(TheTarget->createTargetMachine(Triple, TargetOpts.CPU, FeaturesStr,
673 Options, RM, CM, OptLevel));
Nadav Rotemec57ab32012-10-24 00:53:38 +0000674}
675
Peter Collingbourne03f89072016-07-15 00:55:40 +0000676bool EmitAssemblyHelper::AddEmitPasses(legacy::PassManager &CodeGenPasses,
677 BackendAction Action,
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000678 raw_pwrite_stream &OS) {
Chad Rosierb1cfc682012-02-29 20:14:59 +0000679 // Add LibraryInfo.
Daniel Dunbaraa437df2012-10-19 20:10:10 +0000680 llvm::Triple TargetTriple(TheModule->getTargetTriple());
Chandler Carruth57bb7c72015-01-24 02:25:21 +0000681 std::unique_ptr<TargetLibraryInfoImpl> TLII(
682 createTLII(TargetTriple, CodeGenOpts));
Peter Collingbourne03f89072016-07-15 00:55:40 +0000683 CodeGenPasses.add(new TargetLibraryInfoWrapperPass(*TLII));
Chad Rosierb1cfc682012-02-29 20:14:59 +0000684
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000685 // Normal mode, emit a .s or .o file by running the code generator. Note,
686 // this also adds codegenerator level optimization passes.
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000687 TargetMachine::CodeGenFileType CGFT = getCodeGenFileType(Action);
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000688
689 // Add ObjC ARC final-cleanup optimizations. This is done as part of the
690 // "codegen" passes so that it isn't run multiple times when there is
691 // inlining happening.
Steven Wu1d56be82015-05-02 00:56:15 +0000692 if (CodeGenOpts.OptimizationLevel > 0)
Peter Collingbourne03f89072016-07-15 00:55:40 +0000693 CodeGenPasses.add(createObjCARCContractPass());
Dan Gohmanfec0ff82011-07-05 22:02:36 +0000694
Peter Collingbourne03f89072016-07-15 00:55:40 +0000695 if (TM->addPassesToEmitFile(CodeGenPasses, OS, CGFT,
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000696 /*DisableVerify=*/!CodeGenOpts.VerifyModule)) {
697 Diags.Report(diag::err_fe_unable_to_interface_with_target);
698 return false;
699 }
700
701 return true;
702}
703
Rafael Espindola2f16bc12015-04-14 15:15:49 +0000704void EmitAssemblyHelper::EmitAssembly(BackendAction Action,
Peter Collingbourne03f89072016-07-15 00:55:40 +0000705 std::unique_ptr<raw_pwrite_stream> OS) {
Craig Topper8a13c412014-05-21 05:09:00 +0000706 TimeRegion Region(llvm::TimePassesIsEnabled ? &CodeGenerationTime : nullptr);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000707
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000708 setCommandLineOpts(CodeGenOpts);
Yaxun Liub5e80c32016-04-12 20:22:32 +0000709
Nadav Rotemdc06b2d2012-10-24 03:52:31 +0000710 bool UsesCodeGen = (Action != Backend_EmitNothing &&
711 Action != Backend_EmitBC &&
712 Action != Backend_EmitLL);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000713 CreateTargetMachine(UsesCodeGen);
Alp Tokerf4e22382013-12-20 20:26:53 +0000714
Rafael Espindolab633d202015-06-23 13:59:36 +0000715 if (UsesCodeGen && !TM)
716 return;
717 if (TM)
Mehdi Aminica3cf9e2015-07-24 16:04:29 +0000718 TheModule->setDataLayout(TM->createDataLayout());
Teresa Johnson4b4f4b92016-01-08 17:04:29 +0000719
Peter Collingbourne03f89072016-07-15 00:55:40 +0000720 legacy::PassManager PerModulePasses;
721 PerModulePasses.add(
722 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
723
724 legacy::FunctionPassManager PerFunctionPasses(TheModule);
725 PerFunctionPasses.add(
726 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
727
Teresa Johnson9e3f4742016-08-12 18:12:08 +0000728 CreatePasses(PerModulePasses, PerFunctionPasses);
Peter Collingbourne03f89072016-07-15 00:55:40 +0000729
730 legacy::PassManager CodeGenPasses;
731 CodeGenPasses.add(
732 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
Nadav Rotemec57ab32012-10-24 00:53:38 +0000733
Teresa Johnson488d1dc2017-03-23 19:47:49 +0000734 std::unique_ptr<raw_fd_ostream> ThinLinkOS;
735
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000736 switch (Action) {
737 case Backend_EmitNothing:
738 break;
739
740 case Backend_EmitBC:
Teresa Johnson488d1dc2017-03-23 19:47:49 +0000741 if (CodeGenOpts.EmitSummaryIndex) {
742 if (!CodeGenOpts.ThinLinkBitcodeFile.empty()) {
743 std::error_code EC;
744 ThinLinkOS.reset(new llvm::raw_fd_ostream(
745 CodeGenOpts.ThinLinkBitcodeFile, EC,
746 llvm::sys::fs::F_None));
747 if (EC) {
748 Diags.Report(diag::err_fe_unable_to_open_output) << CodeGenOpts.ThinLinkBitcodeFile
749 << EC.message();
750 return;
751 }
752 }
753 PerModulePasses.add(
754 createWriteThinLTOBitcodePass(*OS, ThinLinkOS.get()));
755 }
Peter Collingbourneb8847162017-01-26 23:51:50 +0000756 else
757 PerModulePasses.add(
758 createBitcodeWriterPass(*OS, CodeGenOpts.EmitLLVMUseLists));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000759 break;
760
761 case Backend_EmitLL:
Peter Collingbourne03f89072016-07-15 00:55:40 +0000762 PerModulePasses.add(
Duncan P. N. Exon Smithbb9cadf2015-04-15 02:45:28 +0000763 createPrintModulePass(*OS, "", CodeGenOpts.EmitLLVMUseLists));
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000764 break;
765
766 default:
Peter Collingbourne03f89072016-07-15 00:55:40 +0000767 if (!AddEmitPasses(CodeGenPasses, Action, *OS))
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000768 return;
769 }
770
Andrew Trick15e36e82011-04-05 18:56:55 +0000771 // Before executing passes, print the final values of the LLVM options.
772 cl::PrintOptionValues();
773
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000774 // Run passes. For now we do all passes at once, but eventually we
775 // would like to have the option of streaming code generation.
776
Peter Collingbourne03f89072016-07-15 00:55:40 +0000777 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000778 PrettyStackTraceString CrashInfo("Per-function optimization");
779
Peter Collingbourne03f89072016-07-15 00:55:40 +0000780 PerFunctionPasses.doInitialization();
Yaron Keren10d6d162015-06-05 09:40:53 +0000781 for (Function &F : *TheModule)
782 if (!F.isDeclaration())
Peter Collingbourne03f89072016-07-15 00:55:40 +0000783 PerFunctionPasses.run(F);
784 PerFunctionPasses.doFinalization();
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000785 }
786
Peter Collingbourne03f89072016-07-15 00:55:40 +0000787 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000788 PrettyStackTraceString CrashInfo("Per-module optimization passes");
Peter Collingbourne03f89072016-07-15 00:55:40 +0000789 PerModulePasses.run(*TheModule);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000790 }
791
Peter Collingbourne03f89072016-07-15 00:55:40 +0000792 {
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000793 PrettyStackTraceString CrashInfo("Code generation");
Peter Collingbourne03f89072016-07-15 00:55:40 +0000794 CodeGenPasses.run(*TheModule);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +0000795 }
796}
797
Chandler Carruth50f9e892016-12-23 20:44:01 +0000798static PassBuilder::OptimizationLevel mapToLevel(const CodeGenOptions &Opts) {
799 switch (Opts.OptimizationLevel) {
800 default:
801 llvm_unreachable("Invalid optimization level!");
802
803 case 1:
804 return PassBuilder::O1;
805
806 case 2:
807 switch (Opts.OptimizeSize) {
808 default:
809 llvm_unreachable("Invalide optimization level for size!");
810
811 case 0:
812 return PassBuilder::O2;
813
814 case 1:
815 return PassBuilder::Os;
816
817 case 2:
818 return PassBuilder::Oz;
819 }
820
821 case 3:
822 return PassBuilder::O3;
823 }
824}
825
826/// A clean version of `EmitAssembly` that uses the new pass manager.
827///
828/// Not all features are currently supported in this system, but where
829/// necessary it falls back to the legacy pass manager to at least provide
830/// basic functionality.
831///
832/// This API is planned to have its functionality finished and then to replace
833/// `EmitAssembly` at some point in the future when the default switches.
834void EmitAssemblyHelper::EmitAssemblyWithNewPassManager(
835 BackendAction Action, std::unique_ptr<raw_pwrite_stream> OS) {
836 TimeRegion Region(llvm::TimePassesIsEnabled ? &CodeGenerationTime : nullptr);
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000837 setCommandLineOpts(CodeGenOpts);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000838
839 // The new pass manager always makes a target machine available to passes
840 // during construction.
841 CreateTargetMachine(/*MustCreateTM*/ true);
842 if (!TM)
843 // This will already be diagnosed, just bail.
844 return;
845 TheModule->setDataLayout(TM->createDataLayout());
846
Davide Italiano945de432017-02-13 16:07:05 +0000847 PGOOptions PGOOpt;
848
849 // -fprofile-generate.
850 PGOOpt.RunProfileGen = CodeGenOpts.hasProfileIRInstr();
851 if (PGOOpt.RunProfileGen)
852 PGOOpt.ProfileGenFile = CodeGenOpts.InstrProfileOutput.empty() ?
853 DefaultProfileGenName : CodeGenOpts.InstrProfileOutput;
854
855 // -fprofile-use.
856 if (CodeGenOpts.hasProfileIRUse())
857 PGOOpt.ProfileUseFile = CodeGenOpts.ProfileInstrumentUsePath;
858
859 // Only pass a PGO options struct if -fprofile-generate or
860 // -fprofile-use were passed on the cmdline.
861 PassBuilder PB(TM.get(),
862 (PGOOpt.RunProfileGen ||
863 !PGOOpt.ProfileUseFile.empty()) ?
864 Optional<PGOOptions>(PGOOpt) : None);
Chandler Carruth50f9e892016-12-23 20:44:01 +0000865
866 LoopAnalysisManager LAM;
867 FunctionAnalysisManager FAM;
868 CGSCCAnalysisManager CGAM;
869 ModuleAnalysisManager MAM;
870
871 // Register the AA manager first so that our version is the one used.
872 FAM.registerPass([&] { return PB.buildDefaultAAPipeline(); });
873
874 // Register all the basic analyses with the managers.
875 PB.registerModuleAnalyses(MAM);
876 PB.registerCGSCCAnalyses(CGAM);
877 PB.registerFunctionAnalyses(FAM);
878 PB.registerLoopAnalyses(LAM);
879 PB.crossRegisterProxies(LAM, FAM, CGAM, MAM);
880
881 ModulePassManager MPM;
Chandler Carruth50f9e892016-12-23 20:44:01 +0000882
Chandler Carruth6d1b83e2016-12-27 00:13:09 +0000883 if (!CodeGenOpts.DisableLLVMPasses) {
884 if (CodeGenOpts.OptimizationLevel == 0) {
885 // Build a minimal pipeline based on the semantics required by Clang,
886 // which is just that always inlining occurs.
887 MPM.addPass(AlwaysInlinerPass());
888 } else {
889 // Otherwise, use the default pass pipeline. We also have to map our
890 // optimization levels into one of the distinct levels used to configure
891 // the pipeline.
892 PassBuilder::OptimizationLevel Level = mapToLevel(CodeGenOpts);
893
894 MPM = PB.buildPerModuleDefaultPipeline(Level);
895 }
Chandler Carruth50f9e892016-12-23 20:44:01 +0000896 }
897
898 // FIXME: We still use the legacy pass manager to do code generation. We
899 // create that pass manager here and use it as needed below.
900 legacy::PassManager CodeGenPasses;
901 bool NeedCodeGen = false;
Tim Shen50fedec2017-06-01 23:27:51 +0000902 Optional<raw_fd_ostream> ThinLinkOS;
Chandler Carruth50f9e892016-12-23 20:44:01 +0000903
904 // Append any output we need to the pass manager.
905 switch (Action) {
906 case Backend_EmitNothing:
907 break;
908
909 case Backend_EmitBC:
Tim Shen50fedec2017-06-01 23:27:51 +0000910 if (CodeGenOpts.EmitSummaryIndex) {
911 if (!CodeGenOpts.ThinLinkBitcodeFile.empty()) {
912 std::error_code EC;
913 ThinLinkOS.emplace(CodeGenOpts.ThinLinkBitcodeFile, EC,
914 llvm::sys::fs::F_None);
915 if (EC) {
916 Diags.Report(diag::err_fe_unable_to_open_output)
917 << CodeGenOpts.ThinLinkBitcodeFile << EC.message();
918 return;
919 }
920 }
921 MPM.addPass(
922 ThinLTOBitcodeWriterPass(*OS, ThinLinkOS ? &*ThinLinkOS : nullptr));
923 } else {
924 MPM.addPass(BitcodeWriterPass(*OS, CodeGenOpts.EmitLLVMUseLists,
925 CodeGenOpts.EmitSummaryIndex,
926 CodeGenOpts.EmitSummaryIndex));
927 }
Chandler Carruth50f9e892016-12-23 20:44:01 +0000928 break;
929
930 case Backend_EmitLL:
931 MPM.addPass(PrintModulePass(*OS, "", CodeGenOpts.EmitLLVMUseLists));
932 break;
933
934 case Backend_EmitAssembly:
935 case Backend_EmitMCNull:
936 case Backend_EmitObj:
937 NeedCodeGen = true;
938 CodeGenPasses.add(
939 createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
940 if (!AddEmitPasses(CodeGenPasses, Action, *OS))
941 // FIXME: Should we handle this error differently?
942 return;
943 break;
944 }
945
946 // Before executing passes, print the final values of the LLVM options.
947 cl::PrintOptionValues();
948
949 // Now that we have all of the passes ready, run them.
950 {
951 PrettyStackTraceString CrashInfo("Optimizer");
952 MPM.run(*TheModule, MAM);
953 }
954
955 // Now if needed, run the legacy PM for codegen.
956 if (NeedCodeGen) {
957 PrettyStackTraceString CrashInfo("Code generation");
958 CodeGenPasses.run(*TheModule);
959 }
960}
961
Peter Collingbourne47d23642017-01-24 19:54:37 +0000962Expected<BitcodeModule> clang::FindThinLTOModule(MemoryBufferRef MBRef) {
963 Expected<std::vector<BitcodeModule>> BMsOrErr = getBitcodeModuleList(MBRef);
964 if (!BMsOrErr)
965 return BMsOrErr.takeError();
966
967 // The bitcode file may contain multiple modules, we want the one with a
968 // summary.
969 for (BitcodeModule &BM : *BMsOrErr) {
970 Expected<bool> HasSummary = BM.hasSummary();
971 if (HasSummary && *HasSummary)
972 return BM;
973 }
974
975 return make_error<StringError>("Could not find module summary",
976 inconvertibleErrorCode());
977}
978
Teresa Johnsoncffeb542017-01-06 23:37:33 +0000979static void runThinLTOBackend(ModuleSummaryIndex *CombinedIndex, Module *M,
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000980 const HeaderSearchOptions &HeaderOpts,
981 const CodeGenOptions &CGOpts,
982 const clang::TargetOptions &TOpts,
983 const LangOptions &LOpts,
Dehao Chena1bd2d62017-01-13 00:51:55 +0000984 std::unique_ptr<raw_pwrite_stream> OS,
Teresa Johnson5ed6c102017-03-31 02:05:15 +0000985 std::string SampleProfile,
986 BackendAction Action) {
Teresa Johnson9e3f4742016-08-12 18:12:08 +0000987 StringMap<std::map<GlobalValue::GUID, GlobalValueSummary *>>
988 ModuleToDefinedGVSummaries;
989 CombinedIndex->collectDefinedGVSummariesPerModule(ModuleToDefinedGVSummaries);
990
David Blaikie6e2ec5f2017-04-19 20:08:21 +0000991 setCommandLineOpts(CGOpts);
992
Teresa Johnsonf9b17d42016-12-28 18:00:08 +0000993 // We can simply import the values mentioned in the combined index, since
994 // we should only invoke this using the individual indexes written out
995 // via a WriteIndexesThinBackend.
Teresa Johnson9e3f4742016-08-12 18:12:08 +0000996 FunctionImporter::ImportMapTy ImportList;
Teresa Johnsonf9b17d42016-12-28 18:00:08 +0000997 for (auto &GlobalList : *CombinedIndex) {
Peter Collingbourne9667b912017-05-04 18:03:25 +0000998 // Ignore entries for undefined references.
999 if (GlobalList.second.SummaryList.empty())
1000 continue;
1001
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001002 auto GUID = GlobalList.first;
Peter Collingbourne9667b912017-05-04 18:03:25 +00001003 assert(GlobalList.second.SummaryList.size() == 1 &&
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001004 "Expected individual combined index to have one summary per GUID");
Peter Collingbourne9667b912017-05-04 18:03:25 +00001005 auto &Summary = GlobalList.second.SummaryList[0];
Teresa Johnsonf9b17d42016-12-28 18:00:08 +00001006 // Skip the summaries for the importing module. These are included to
1007 // e.g. record required linkage changes.
1008 if (Summary->modulePath() == M->getModuleIdentifier())
1009 continue;
1010 // Doesn't matter what value we plug in to the map, just needs an entry
1011 // to provoke importing by thinBackend.
1012 ImportList[Summary->modulePath()][GUID] = 1;
1013 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001014
1015 std::vector<std::unique_ptr<llvm::MemoryBuffer>> OwnedImports;
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001016 MapVector<llvm::StringRef, llvm::BitcodeModule> ModuleMap;
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001017
1018 for (auto &I : ImportList) {
1019 ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> MBOrErr =
1020 llvm::MemoryBuffer::getFile(I.first());
1021 if (!MBOrErr) {
1022 errs() << "Error loading imported file '" << I.first()
1023 << "': " << MBOrErr.getError().message() << "\n";
1024 return;
1025 }
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001026
Peter Collingbourne47d23642017-01-24 19:54:37 +00001027 Expected<BitcodeModule> BMOrErr = FindThinLTOModule(**MBOrErr);
1028 if (!BMOrErr) {
1029 handleAllErrors(BMOrErr.takeError(), [&](ErrorInfoBase &EIB) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001030 errs() << "Error loading imported file '" << I.first()
1031 << "': " << EIB.message() << '\n';
1032 });
1033 return;
1034 }
Peter Collingbourne47d23642017-01-24 19:54:37 +00001035 ModuleMap.insert({I.first(), *BMOrErr});
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001036
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001037 OwnedImports.push_back(std::move(*MBOrErr));
1038 }
Peter Collingbourne2d3a26f2016-09-23 21:43:51 +00001039 auto AddStream = [&](size_t Task) {
1040 return llvm::make_unique<lto::NativeObjectStream>(std::move(OS));
Mehdi Amini406aa222016-08-17 06:23:08 +00001041 };
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001042 lto::Config Conf;
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001043 Conf.CPU = TOpts.CPU;
1044 Conf.CodeModel = getCodeModel(CGOpts);
1045 Conf.MAttrs = TOpts.Features;
1046 Conf.RelocModel = getRelocModel(CGOpts);
1047 Conf.CGOptLevel = getCGOptLevel(CGOpts);
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001048 initTargetOptions(Conf.Options, CGOpts, TOpts, LOpts, HeaderOpts);
Benjamin Kramerf6021ec2017-03-21 21:35:04 +00001049 Conf.SampleProfile = std::move(SampleProfile);
Tim Shen50fedec2017-06-01 23:27:51 +00001050 Conf.UseNewPM = CGOpts.ExperimentalNewPassManager;
Teresa Johnsonb637cb02017-03-31 22:35:47 +00001051 switch (Action) {
1052 case Backend_EmitNothing:
1053 Conf.PreCodeGenModuleHook = [](size_t Task, const Module &Mod) {
1054 return false;
1055 };
1056 break;
1057 case Backend_EmitLL:
1058 Conf.PreCodeGenModuleHook = [&](size_t Task, const Module &Mod) {
1059 M->print(*OS, nullptr, CGOpts.EmitLLVMUseLists);
1060 return false;
1061 };
1062 break;
1063 case Backend_EmitBC:
1064 Conf.PreCodeGenModuleHook = [&](size_t Task, const Module &Mod) {
1065 WriteBitcodeToFile(M, *OS, CGOpts.EmitLLVMUseLists);
1066 return false;
1067 };
1068 break;
1069 default:
1070 Conf.CGFileType = getCodeGenFileType(Action);
1071 break;
1072 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001073 if (Error E = thinBackend(
Peter Collingbourne2d3a26f2016-09-23 21:43:51 +00001074 Conf, 0, AddStream, *M, *CombinedIndex, ImportList,
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001075 ModuleToDefinedGVSummaries[M->getModuleIdentifier()], ModuleMap)) {
1076 handleAllErrors(std::move(E), [&](ErrorInfoBase &EIB) {
1077 errs() << "Error running ThinLTO backend: " << EIB.message() << '\n';
1078 });
1079 }
1080}
1081
David Blaikie9c902b52011-09-25 23:23:43 +00001082void clang::EmitBackendOutput(DiagnosticsEngine &Diags,
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001083 const HeaderSearchOptions &HeaderOpts,
David Blaikie9c902b52011-09-25 23:23:43 +00001084 const CodeGenOptions &CGOpts,
Nick Lewycky432add52011-12-02 22:17:00 +00001085 const clang::TargetOptions &TOpts,
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001086 const LangOptions &LOpts,
1087 const llvm::DataLayout &TDesc, Module *M,
1088 BackendAction Action,
Peter Collingbourne03f89072016-07-15 00:55:40 +00001089 std::unique_ptr<raw_pwrite_stream> OS) {
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001090 if (!CGOpts.ThinLTOIndexFile.empty()) {
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001091 // If we are performing a ThinLTO importing compile, load the function index
1092 // into memory and pass it into runThinLTOBackend, which will run the
1093 // function importer and invoke LTO passes.
1094 Expected<std::unique_ptr<ModuleSummaryIndex>> IndexOrErr =
Teresa Johnson517729f2017-05-12 19:32:17 +00001095 llvm::getModuleSummaryIndexForFile(CGOpts.ThinLTOIndexFile,
1096 /*IgnoreEmptyThinLTOIndexFile*/true);
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001097 if (!IndexOrErr) {
1098 logAllUnhandledErrors(IndexOrErr.takeError(), errs(),
1099 "Error loading index file '" +
1100 CGOpts.ThinLTOIndexFile + "': ");
1101 return;
1102 }
1103 std::unique_ptr<ModuleSummaryIndex> CombinedIndex = std::move(*IndexOrErr);
1104 // A null CombinedIndex means we should skip ThinLTO compilation
1105 // (LLVM will optionally ignore empty index files, returning null instead
1106 // of an error).
1107 bool DoThinLTOBackend = CombinedIndex != nullptr;
1108 if (DoThinLTOBackend) {
Teresa Johnson5ed6c102017-03-31 02:05:15 +00001109 runThinLTOBackend(CombinedIndex.get(), M, HeaderOpts, CGOpts, TOpts,
1110 LOpts, std::move(OS), CGOpts.SampleProfileFile, Action);
Teresa Johnsoncffeb542017-01-06 23:37:33 +00001111 return;
1112 }
Teresa Johnson9e3f4742016-08-12 18:12:08 +00001113 }
1114
Saleem Abdulrasool888e2892017-01-05 16:02:32 +00001115 EmitAssemblyHelper AsmHelper(Diags, HeaderOpts, CGOpts, TOpts, LOpts, M);
Daniel Dunbarf976d1b2010-06-07 23:20:08 +00001116
Chandler Carruth50f9e892016-12-23 20:44:01 +00001117 if (CGOpts.ExperimentalNewPassManager)
1118 AsmHelper.EmitAssemblyWithNewPassManager(Action, std::move(OS));
1119 else
1120 AsmHelper.EmitAssembly(Action, std::move(OS));
Alp Tokere83b9062014-01-02 15:08:04 +00001121
James Y Knightb214cbc2016-03-04 19:00:41 +00001122 // Verify clang's TargetInfo DataLayout against the LLVM TargetMachine's
1123 // DataLayout.
1124 if (AsmHelper.TM) {
Mehdi Aminica3cf9e2015-07-24 16:04:29 +00001125 std::string DLDesc = M->getDataLayout().getStringRepresentation();
James Y Knightb214cbc2016-03-04 19:00:41 +00001126 if (DLDesc != TDesc.getStringRepresentation()) {
Alp Tokere83b9062014-01-02 15:08:04 +00001127 unsigned DiagID = Diags.getCustomDiagID(
1128 DiagnosticsEngine::Error, "backend data layout '%0' does not match "
1129 "expected target description '%1'");
James Y Knightb214cbc2016-03-04 19:00:41 +00001130 Diags.Report(DiagID) << DLDesc << TDesc.getStringRepresentation();
Alp Tokere83b9062014-01-02 15:08:04 +00001131 }
1132 }
Daniel Dunbarf976d1b2010-06-07 23:20:08 +00001133}
Steven Wu27fb5222016-05-11 16:26:03 +00001134
1135static const char* getSectionNameForBitcode(const Triple &T) {
1136 switch (T.getObjectFormat()) {
1137 case Triple::MachO:
1138 return "__LLVM,__bitcode";
1139 case Triple::COFF:
1140 case Triple::ELF:
Dan Gohman839f2152017-01-17 21:46:38 +00001141 case Triple::Wasm:
Steven Wu27fb5222016-05-11 16:26:03 +00001142 case Triple::UnknownObjectFormat:
1143 return ".llvmbc";
1144 }
Simon Pilgrimbff9dae2016-05-11 21:55:37 +00001145 llvm_unreachable("Unimplemented ObjectFormatType");
Steven Wu27fb5222016-05-11 16:26:03 +00001146}
1147
1148static const char* getSectionNameForCommandline(const Triple &T) {
1149 switch (T.getObjectFormat()) {
1150 case Triple::MachO:
1151 return "__LLVM,__cmdline";
1152 case Triple::COFF:
1153 case Triple::ELF:
Dan Gohman839f2152017-01-17 21:46:38 +00001154 case Triple::Wasm:
Steven Wu27fb5222016-05-11 16:26:03 +00001155 case Triple::UnknownObjectFormat:
1156 return ".llvmcmd";
1157 }
Simon Pilgrimbff9dae2016-05-11 21:55:37 +00001158 llvm_unreachable("Unimplemented ObjectFormatType");
Steven Wu27fb5222016-05-11 16:26:03 +00001159}
1160
1161// With -fembed-bitcode, save a copy of the llvm IR as data in the
1162// __LLVM,__bitcode section.
1163void clang::EmbedBitcode(llvm::Module *M, const CodeGenOptions &CGOpts,
1164 llvm::MemoryBufferRef Buf) {
1165 if (CGOpts.getEmbedBitcode() == CodeGenOptions::Embed_Off)
1166 return;
1167
Steven Wu2c059a52016-05-16 18:54:58 +00001168 // Save llvm.compiler.used and remote it.
1169 SmallVector<Constant*, 2> UsedArray;
1170 SmallSet<GlobalValue*, 4> UsedGlobals;
1171 Type *UsedElementType = Type::getInt8Ty(M->getContext())->getPointerTo(0);
1172 GlobalVariable *Used = collectUsedGlobalVariables(*M, UsedGlobals, true);
1173 for (auto *GV : UsedGlobals) {
1174 if (GV->getName() != "llvm.embedded.module" &&
1175 GV->getName() != "llvm.cmdline")
1176 UsedArray.push_back(
1177 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
1178 }
1179 if (Used)
1180 Used->eraseFromParent();
1181
Steven Wu27fb5222016-05-11 16:26:03 +00001182 // Embed the bitcode for the llvm module.
1183 std::string Data;
1184 ArrayRef<uint8_t> ModuleData;
1185 Triple T(M->getTargetTriple());
1186 // Create a constant that contains the bitcode.
1187 // In case of embedding a marker, ignore the input Buf and use the empty
1188 // ArrayRef. It is also legal to create a bitcode marker even Buf is empty.
1189 if (CGOpts.getEmbedBitcode() != CodeGenOptions::Embed_Marker) {
1190 if (!isBitcode((const unsigned char *)Buf.getBufferStart(),
1191 (const unsigned char *)Buf.getBufferEnd())) {
1192 // If the input is LLVM Assembly, bitcode is produced by serializing
1193 // the module. Use-lists order need to be perserved in this case.
1194 llvm::raw_string_ostream OS(Data);
1195 llvm::WriteBitcodeToFile(M, OS, /* ShouldPreserveUseListOrder */ true);
1196 ModuleData =
1197 ArrayRef<uint8_t>((const uint8_t *)OS.str().data(), OS.str().size());
1198 } else
1199 // If the input is LLVM bitcode, write the input byte stream directly.
1200 ModuleData = ArrayRef<uint8_t>((const uint8_t *)Buf.getBufferStart(),
1201 Buf.getBufferSize());
1202 }
1203 llvm::Constant *ModuleConstant =
1204 llvm::ConstantDataArray::get(M->getContext(), ModuleData);
Steven Wu27fb5222016-05-11 16:26:03 +00001205 llvm::GlobalVariable *GV = new llvm::GlobalVariable(
Steven Wu2c059a52016-05-16 18:54:58 +00001206 *M, ModuleConstant->getType(), true, llvm::GlobalValue::PrivateLinkage,
Steven Wu27fb5222016-05-11 16:26:03 +00001207 ModuleConstant);
1208 GV->setSection(getSectionNameForBitcode(T));
Steven Wu2c059a52016-05-16 18:54:58 +00001209 UsedArray.push_back(
1210 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
Steven Wu27fb5222016-05-11 16:26:03 +00001211 if (llvm::GlobalVariable *Old =
Steven Wu2c059a52016-05-16 18:54:58 +00001212 M->getGlobalVariable("llvm.embedded.module", true)) {
1213 assert(Old->hasOneUse() &&
1214 "llvm.embedded.module can only be used once in llvm.compiler.used");
Steven Wu27fb5222016-05-11 16:26:03 +00001215 GV->takeName(Old);
1216 Old->eraseFromParent();
1217 } else {
1218 GV->setName("llvm.embedded.module");
1219 }
1220
Steven Wu2c059a52016-05-16 18:54:58 +00001221 // Skip if only bitcode needs to be embedded.
1222 if (CGOpts.getEmbedBitcode() != CodeGenOptions::Embed_Bitcode) {
1223 // Embed command-line options.
Saleem Abdulrasoolb1d50c12016-05-20 03:58:12 +00001224 ArrayRef<uint8_t> CmdData(const_cast<uint8_t *>(CGOpts.CmdArgs.data()),
Steven Wu2c059a52016-05-16 18:54:58 +00001225 CGOpts.CmdArgs.size());
1226 llvm::Constant *CmdConstant =
1227 llvm::ConstantDataArray::get(M->getContext(), CmdData);
1228 GV = new llvm::GlobalVariable(*M, CmdConstant->getType(), true,
1229 llvm::GlobalValue::PrivateLinkage,
1230 CmdConstant);
1231 GV->setSection(getSectionNameForCommandline(T));
1232 UsedArray.push_back(
1233 ConstantExpr::getPointerBitCastOrAddrSpaceCast(GV, UsedElementType));
1234 if (llvm::GlobalVariable *Old =
1235 M->getGlobalVariable("llvm.cmdline", true)) {
1236 assert(Old->hasOneUse() &&
1237 "llvm.cmdline can only be used once in llvm.compiler.used");
1238 GV->takeName(Old);
1239 Old->eraseFromParent();
1240 } else {
1241 GV->setName("llvm.cmdline");
1242 }
1243 }
1244
1245 if (UsedArray.empty())
Steven Wu27fb5222016-05-11 16:26:03 +00001246 return;
1247
Steven Wu2c059a52016-05-16 18:54:58 +00001248 // Recreate llvm.compiler.used.
1249 ArrayType *ATy = ArrayType::get(UsedElementType, UsedArray.size());
1250 auto *NewUsed = new GlobalVariable(
1251 *M, ATy, false, llvm::GlobalValue::AppendingLinkage,
1252 llvm::ConstantArray::get(ATy, UsedArray), "llvm.compiler.used");
1253 NewUsed->setSection("llvm.metadata");
Steven Wu27fb5222016-05-11 16:26:03 +00001254}