12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313 |
- //===--- BackendUtil.cpp - LLVM Backend Utilities -------------------------===//
- //
- // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
- // See https://llvm.org/LICENSE.txt for license information.
- // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
- //
- //===----------------------------------------------------------------------===//
- #include "clang/CodeGen/BackendUtil.h"
- #include "clang/Basic/CodeGenOptions.h"
- #include "clang/Basic/Diagnostic.h"
- #include "clang/Basic/LangOptions.h"
- #include "clang/Basic/TargetOptions.h"
- #include "clang/Frontend/FrontendDiagnostic.h"
- #include "clang/Frontend/Utils.h"
- #include "clang/Lex/HeaderSearchOptions.h"
- #include "llvm/ADT/SmallSet.h"
- #include "llvm/ADT/StringExtras.h"
- #include "llvm/ADT/StringSwitch.h"
- #include "llvm/ADT/Triple.h"
- #include "llvm/Analysis/AliasAnalysis.h"
- #include "llvm/Analysis/GlobalsModRef.h"
- #include "llvm/Analysis/StackSafetyAnalysis.h"
- #include "llvm/Analysis/TargetLibraryInfo.h"
- #include "llvm/Analysis/TargetTransformInfo.h"
- #include "llvm/Bitcode/BitcodeReader.h"
- #include "llvm/Bitcode/BitcodeWriter.h"
- #include "llvm/Bitcode/BitcodeWriterPass.h"
- #include "llvm/CodeGen/RegAllocRegistry.h"
- #include "llvm/CodeGen/SchedulerRegistry.h"
- #include "llvm/CodeGen/TargetSubtargetInfo.h"
- #include "llvm/IR/DataLayout.h"
- #include "llvm/IR/DebugInfo.h"
- #include "llvm/IR/LegacyPassManager.h"
- #include "llvm/IR/Module.h"
- #include "llvm/IR/ModuleSummaryIndex.h"
- #include "llvm/IR/PassManager.h"
- #include "llvm/IR/Verifier.h"
- #include "llvm/IRPrinter/IRPrintingPasses.h"
- #include "llvm/LTO/LTOBackend.h"
- #include "llvm/MC/MCAsmInfo.h"
- #include "llvm/MC/SubtargetFeature.h"
- #include "llvm/MC/TargetRegistry.h"
- #include "llvm/Object/OffloadBinary.h"
- #include "llvm/Passes/PassBuilder.h"
- #include "llvm/Passes/PassPlugin.h"
- #include "llvm/Passes/StandardInstrumentations.h"
- #include "llvm/Support/BuryPointer.h"
- #include "llvm/Support/CommandLine.h"
- #include "llvm/Support/MemoryBuffer.h"
- #include "llvm/Support/PrettyStackTrace.h"
- #include "llvm/Support/TimeProfiler.h"
- #include "llvm/Support/Timer.h"
- #include "llvm/Support/ToolOutputFile.h"
- #include "llvm/Support/raw_ostream.h"
- #include "llvm/Target/TargetMachine.h"
- #include "llvm/Target/TargetOptions.h"
- #include "llvm/Transforms/Coroutines/CoroCleanup.h"
- #include "llvm/Transforms/Coroutines/CoroEarly.h"
- #include "llvm/Transforms/Coroutines/CoroElide.h"
- #include "llvm/Transforms/Coroutines/CoroSplit.h"
- #include "llvm/Transforms/IPO.h"
- #include "llvm/Transforms/IPO/AlwaysInliner.h"
- #include "llvm/Transforms/IPO/LowerTypeTests.h"
- #include "llvm/Transforms/IPO/ThinLTOBitcodeWriter.h"
- #include "llvm/Transforms/InstCombine/InstCombine.h"
- #include "llvm/Transforms/Instrumentation.h"
- #include "llvm/Transforms/Instrumentation/AddressSanitizer.h"
- #include "llvm/Transforms/Instrumentation/AddressSanitizerOptions.h"
- #include "llvm/Transforms/Instrumentation/BoundsChecking.h"
- #include "llvm/Transforms/Instrumentation/DataFlowSanitizer.h"
- #include "llvm/Transforms/Instrumentation/GCOVProfiler.h"
- #include "llvm/Transforms/Instrumentation/HWAddressSanitizer.h"
- #include "llvm/Transforms/Instrumentation/InstrProfiling.h"
- #include "llvm/Transforms/Instrumentation/KCFI.h"
- #include "llvm/Transforms/Instrumentation/MemProfiler.h"
- #include "llvm/Transforms/Instrumentation/MemorySanitizer.h"
- #include "llvm/Transforms/Instrumentation/SanitizerBinaryMetadata.h"
- #include "llvm/Transforms/Instrumentation/SanitizerCoverage.h"
- #include "llvm/Transforms/Instrumentation/ThreadSanitizer.h"
- #include "llvm/Transforms/ObjCARC.h"
- #include "llvm/Transforms/Scalar.h"
- #include "llvm/Transforms/Scalar/EarlyCSE.h"
- #include "llvm/Transforms/Scalar/GVN.h"
- #include "llvm/Transforms/Scalar/JumpThreading.h"
- #include "llvm/Transforms/Scalar/LowerMatrixIntrinsics.h"
- #include "llvm/Transforms/Utils.h"
- #include "llvm/Transforms/Utils/CanonicalizeAliases.h"
- #include "llvm/Transforms/Utils/Debugify.h"
- #include "llvm/Transforms/Utils/EntryExitInstrumenter.h"
- #include "llvm/Transforms/Utils/ModuleUtils.h"
- #include "llvm/Transforms/Utils/NameAnonGlobals.h"
- #include "llvm/Transforms/Utils/SymbolRewriter.h"
- #include <memory>
- #include <optional>
- using namespace clang;
- using namespace llvm;
- #define HANDLE_EXTENSION(Ext) \
- llvm::PassPluginLibraryInfo get##Ext##PluginInfo();
- #include "llvm/Support/Extension.def"
- namespace llvm {
- extern cl::opt<bool> DebugInfoCorrelate;
- // Experiment to move sanitizers earlier.
- static cl::opt<bool> ClSanitizeOnOptimizerEarlyEP(
- "sanitizer-early-opt-ep", cl::Optional,
- cl::desc("Insert sanitizers on OptimizerEarlyEP."), cl::init(false));
- }
- namespace {
- // Default filename used for profile generation.
- std::string getDefaultProfileGenName() {
- return DebugInfoCorrelate ? "default_%p.proflite" : "default_%m.profraw";
- }
- class EmitAssemblyHelper {
- DiagnosticsEngine &Diags;
- const HeaderSearchOptions &HSOpts;
- const CodeGenOptions &CodeGenOpts;
- const clang::TargetOptions &TargetOpts;
- const LangOptions &LangOpts;
- Module *TheModule;
- Timer CodeGenerationTime;
- std::unique_ptr<raw_pwrite_stream> OS;
- Triple TargetTriple;
- TargetIRAnalysis getTargetIRAnalysis() const {
- if (TM)
- return TM->getTargetIRAnalysis();
- return TargetIRAnalysis();
- }
- /// Generates the TargetMachine.
- /// Leaves TM unchanged if it is unable to create the target machine.
- /// Some of our clang tests specify triples which are not built
- /// into clang. This is okay because these tests check the generated
- /// IR, and they require DataLayout which depends on the triple.
- /// In this case, we allow this method to fail and not report an error.
- /// When MustCreateTM is used, we print an error if we are unable to load
- /// the requested target.
- void CreateTargetMachine(bool MustCreateTM);
- /// Add passes necessary to emit assembly or LLVM IR.
- ///
- /// \return True on success.
- bool AddEmitPasses(legacy::PassManager &CodeGenPasses, BackendAction Action,
- raw_pwrite_stream &OS, raw_pwrite_stream *DwoOS);
- std::unique_ptr<llvm::ToolOutputFile> openOutputFile(StringRef Path) {
- std::error_code EC;
- auto F = std::make_unique<llvm::ToolOutputFile>(Path, EC,
- llvm::sys::fs::OF_None);
- if (EC) {
- Diags.Report(diag::err_fe_unable_to_open_output) << Path << EC.message();
- F.reset();
- }
- return F;
- }
- void
- RunOptimizationPipeline(BackendAction Action,
- std::unique_ptr<raw_pwrite_stream> &OS,
- std::unique_ptr<llvm::ToolOutputFile> &ThinLinkOS);
- void RunCodegenPipeline(BackendAction Action,
- std::unique_ptr<raw_pwrite_stream> &OS,
- std::unique_ptr<llvm::ToolOutputFile> &DwoOS);
- /// Check whether we should emit a module summary for regular LTO.
- /// The module summary should be emitted by default for regular LTO
- /// except for ld64 targets.
- ///
- /// \return True if the module summary should be emitted.
- bool shouldEmitRegularLTOSummary() const {
- return CodeGenOpts.PrepareForLTO && !CodeGenOpts.DisableLLVMPasses &&
- TargetTriple.getVendor() != llvm::Triple::Apple;
- }
- public:
- EmitAssemblyHelper(DiagnosticsEngine &_Diags,
- const HeaderSearchOptions &HeaderSearchOpts,
- const CodeGenOptions &CGOpts,
- const clang::TargetOptions &TOpts,
- const LangOptions &LOpts, Module *M)
- : Diags(_Diags), HSOpts(HeaderSearchOpts), CodeGenOpts(CGOpts),
- TargetOpts(TOpts), LangOpts(LOpts), TheModule(M),
- CodeGenerationTime("codegen", "Code Generation Time"),
- TargetTriple(TheModule->getTargetTriple()) {}
- ~EmitAssemblyHelper() {
- if (CodeGenOpts.DisableFree)
- BuryPointer(std::move(TM));
- }
- std::unique_ptr<TargetMachine> TM;
- // Emit output using the new pass manager for the optimization pipeline.
- void EmitAssembly(BackendAction Action,
- std::unique_ptr<raw_pwrite_stream> OS);
- };
- }
- static SanitizerCoverageOptions
- getSancovOptsFromCGOpts(const CodeGenOptions &CGOpts) {
- SanitizerCoverageOptions Opts;
- Opts.CoverageType =
- static_cast<SanitizerCoverageOptions::Type>(CGOpts.SanitizeCoverageType);
- Opts.IndirectCalls = CGOpts.SanitizeCoverageIndirectCalls;
- Opts.TraceBB = CGOpts.SanitizeCoverageTraceBB;
- Opts.TraceCmp = CGOpts.SanitizeCoverageTraceCmp;
- Opts.TraceDiv = CGOpts.SanitizeCoverageTraceDiv;
- Opts.TraceGep = CGOpts.SanitizeCoverageTraceGep;
- Opts.Use8bitCounters = CGOpts.SanitizeCoverage8bitCounters;
- Opts.TracePC = CGOpts.SanitizeCoverageTracePC;
- Opts.TracePCGuard = CGOpts.SanitizeCoverageTracePCGuard;
- Opts.NoPrune = CGOpts.SanitizeCoverageNoPrune;
- Opts.Inline8bitCounters = CGOpts.SanitizeCoverageInline8bitCounters;
- Opts.InlineBoolFlag = CGOpts.SanitizeCoverageInlineBoolFlag;
- Opts.PCTable = CGOpts.SanitizeCoveragePCTable;
- Opts.StackDepth = CGOpts.SanitizeCoverageStackDepth;
- Opts.TraceLoads = CGOpts.SanitizeCoverageTraceLoads;
- Opts.TraceStores = CGOpts.SanitizeCoverageTraceStores;
- Opts.CollectControlFlow = CGOpts.SanitizeCoverageControlFlow;
- return Opts;
- }
- static SanitizerBinaryMetadataOptions
- getSanitizerBinaryMetadataOptions(const CodeGenOptions &CGOpts) {
- SanitizerBinaryMetadataOptions Opts;
- Opts.Covered = CGOpts.SanitizeBinaryMetadataCovered;
- Opts.Atomics = CGOpts.SanitizeBinaryMetadataAtomics;
- Opts.UAR = CGOpts.SanitizeBinaryMetadataUAR;
- return Opts;
- }
- // Check if ASan should use GC-friendly instrumentation for globals.
- // First of all, there is no point if -fdata-sections is off (expect for MachO,
- // where this is not a factor). Also, on ELF this feature requires an assembler
- // extension that only works with -integrated-as at the moment.
- static bool asanUseGlobalsGC(const Triple &T, const CodeGenOptions &CGOpts) {
- if (!CGOpts.SanitizeAddressGlobalsDeadStripping)
- return false;
- switch (T.getObjectFormat()) {
- case Triple::MachO:
- case Triple::COFF:
- return true;
- case Triple::ELF:
- return !CGOpts.DisableIntegratedAS;
- case Triple::GOFF:
- llvm::report_fatal_error("ASan not implemented for GOFF");
- case Triple::XCOFF:
- llvm::report_fatal_error("ASan not implemented for XCOFF.");
- case Triple::Wasm:
- case Triple::DXContainer:
- case Triple::SPIRV:
- case Triple::UnknownObjectFormat:
- break;
- }
- return false;
- }
- static TargetLibraryInfoImpl *createTLII(llvm::Triple &TargetTriple,
- const CodeGenOptions &CodeGenOpts) {
- TargetLibraryInfoImpl *TLII = new TargetLibraryInfoImpl(TargetTriple);
- switch (CodeGenOpts.getVecLib()) {
- case CodeGenOptions::Accelerate:
- TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::Accelerate,
- TargetTriple);
- break;
- case CodeGenOptions::LIBMVEC:
- TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::LIBMVEC_X86,
- TargetTriple);
- break;
- case CodeGenOptions::MASSV:
- TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::MASSV,
- TargetTriple);
- break;
- case CodeGenOptions::SVML:
- TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::SVML,
- TargetTriple);
- break;
- case CodeGenOptions::SLEEF:
- TLII->addVectorizableFunctionsFromVecLib(TargetLibraryInfoImpl::SLEEFGNUABI,
- TargetTriple);
- break;
- case CodeGenOptions::Darwin_libsystem_m:
- TLII->addVectorizableFunctionsFromVecLib(
- TargetLibraryInfoImpl::DarwinLibSystemM, TargetTriple);
- break;
- default:
- break;
- }
- return TLII;
- }
- static std::optional<llvm::CodeModel::Model>
- getCodeModel(const CodeGenOptions &CodeGenOpts) {
- unsigned CodeModel = llvm::StringSwitch<unsigned>(CodeGenOpts.CodeModel)
- .Case("tiny", llvm::CodeModel::Tiny)
- .Case("small", llvm::CodeModel::Small)
- .Case("kernel", llvm::CodeModel::Kernel)
- .Case("medium", llvm::CodeModel::Medium)
- .Case("large", llvm::CodeModel::Large)
- .Case("default", ~1u)
- .Default(~0u);
- assert(CodeModel != ~0u && "invalid code model!");
- if (CodeModel == ~1u)
- return std::nullopt;
- return static_cast<llvm::CodeModel::Model>(CodeModel);
- }
- static CodeGenFileType getCodeGenFileType(BackendAction Action) {
- if (Action == Backend_EmitObj)
- return CGFT_ObjectFile;
- else if (Action == Backend_EmitMCNull)
- return CGFT_Null;
- else {
- assert(Action == Backend_EmitAssembly && "Invalid action!");
- return CGFT_AssemblyFile;
- }
- }
- static bool actionRequiresCodeGen(BackendAction Action) {
- return Action != Backend_EmitNothing && Action != Backend_EmitBC &&
- Action != Backend_EmitLL;
- }
- static bool initTargetOptions(DiagnosticsEngine &Diags,
- llvm::TargetOptions &Options,
- const CodeGenOptions &CodeGenOpts,
- const clang::TargetOptions &TargetOpts,
- const LangOptions &LangOpts,
- const HeaderSearchOptions &HSOpts) {
- switch (LangOpts.getThreadModel()) {
- case LangOptions::ThreadModelKind::POSIX:
- Options.ThreadModel = llvm::ThreadModel::POSIX;
- break;
- case LangOptions::ThreadModelKind::Single:
- Options.ThreadModel = llvm::ThreadModel::Single;
- break;
- }
- // Set float ABI type.
- assert((CodeGenOpts.FloatABI == "soft" || CodeGenOpts.FloatABI == "softfp" ||
- CodeGenOpts.FloatABI == "hard" || CodeGenOpts.FloatABI.empty()) &&
- "Invalid Floating Point ABI!");
- Options.FloatABIType =
- llvm::StringSwitch<llvm::FloatABI::ABIType>(CodeGenOpts.FloatABI)
- .Case("soft", llvm::FloatABI::Soft)
- .Case("softfp", llvm::FloatABI::Soft)
- .Case("hard", llvm::FloatABI::Hard)
- .Default(llvm::FloatABI::Default);
- // Set FP fusion mode.
- switch (LangOpts.getDefaultFPContractMode()) {
- case LangOptions::FPM_Off:
- // Preserve any contraction performed by the front-end. (Strict performs
- // splitting of the muladd intrinsic in the backend.)
- Options.AllowFPOpFusion = llvm::FPOpFusion::Standard;
- break;
- case LangOptions::FPM_On:
- case LangOptions::FPM_FastHonorPragmas:
- Options.AllowFPOpFusion = llvm::FPOpFusion::Standard;
- break;
- case LangOptions::FPM_Fast:
- Options.AllowFPOpFusion = llvm::FPOpFusion::Fast;
- break;
- }
- Options.BinutilsVersion =
- llvm::TargetMachine::parseBinutilsVersion(CodeGenOpts.BinutilsVersion);
- Options.UseInitArray = CodeGenOpts.UseInitArray;
- Options.LowerGlobalDtorsViaCxaAtExit =
- CodeGenOpts.RegisterGlobalDtorsWithAtExit;
- Options.DisableIntegratedAS = CodeGenOpts.DisableIntegratedAS;
- Options.CompressDebugSections = CodeGenOpts.getCompressDebugSections();
- Options.RelaxELFRelocations = CodeGenOpts.RelaxELFRelocations;
- // Set EABI version.
- Options.EABIVersion = TargetOpts.EABIVersion;
- if (LangOpts.hasSjLjExceptions())
- Options.ExceptionModel = llvm::ExceptionHandling::SjLj;
- if (LangOpts.hasSEHExceptions())
- Options.ExceptionModel = llvm::ExceptionHandling::WinEH;
- if (LangOpts.hasDWARFExceptions())
- Options.ExceptionModel = llvm::ExceptionHandling::DwarfCFI;
- if (LangOpts.hasWasmExceptions())
- Options.ExceptionModel = llvm::ExceptionHandling::Wasm;
- Options.NoInfsFPMath = LangOpts.NoHonorInfs;
- Options.NoNaNsFPMath = LangOpts.NoHonorNaNs;
- Options.NoZerosInBSS = CodeGenOpts.NoZeroInitializedInBSS;
- Options.UnsafeFPMath = LangOpts.AllowFPReassoc && LangOpts.AllowRecip &&
- LangOpts.NoSignedZero && LangOpts.ApproxFunc &&
- (LangOpts.getDefaultFPContractMode() ==
- LangOptions::FPModeKind::FPM_Fast ||
- LangOpts.getDefaultFPContractMode() ==
- LangOptions::FPModeKind::FPM_FastHonorPragmas);
- Options.ApproxFuncFPMath = LangOpts.ApproxFunc;
- Options.BBSections =
- llvm::StringSwitch<llvm::BasicBlockSection>(CodeGenOpts.BBSections)
- .Case("all", llvm::BasicBlockSection::All)
- .Case("labels", llvm::BasicBlockSection::Labels)
- .StartsWith("list=", llvm::BasicBlockSection::List)
- .Case("none", llvm::BasicBlockSection::None)
- .Default(llvm::BasicBlockSection::None);
- if (Options.BBSections == llvm::BasicBlockSection::List) {
- ErrorOr<std::unique_ptr<MemoryBuffer>> MBOrErr =
- MemoryBuffer::getFile(CodeGenOpts.BBSections.substr(5));
- if (!MBOrErr) {
- Diags.Report(diag::err_fe_unable_to_load_basic_block_sections_file)
- << MBOrErr.getError().message();
- return false;
- }
- Options.BBSectionsFuncListBuf = std::move(*MBOrErr);
- }
- Options.EnableMachineFunctionSplitter = CodeGenOpts.SplitMachineFunctions;
- Options.FunctionSections = CodeGenOpts.FunctionSections;
- Options.DataSections = CodeGenOpts.DataSections;
- Options.IgnoreXCOFFVisibility = LangOpts.IgnoreXCOFFVisibility;
- Options.UniqueSectionNames = CodeGenOpts.UniqueSectionNames;
- Options.UniqueBasicBlockSectionNames =
- CodeGenOpts.UniqueBasicBlockSectionNames;
- Options.TLSSize = CodeGenOpts.TLSSize;
- Options.EmulatedTLS = CodeGenOpts.EmulatedTLS;
- Options.ExplicitEmulatedTLS = true;
- Options.DebuggerTuning = CodeGenOpts.getDebuggerTuning();
- Options.EmitStackSizeSection = CodeGenOpts.StackSizeSection;
- Options.StackUsageOutput = CodeGenOpts.StackUsageOutput;
- Options.EmitAddrsig = CodeGenOpts.Addrsig;
- Options.ForceDwarfFrameSection = CodeGenOpts.ForceDwarfFrameSection;
- Options.EmitCallSiteInfo = CodeGenOpts.EmitCallSiteInfo;
- Options.EnableAIXExtendedAltivecABI = CodeGenOpts.EnableAIXExtendedAltivecABI;
- Options.XRayOmitFunctionIndex = CodeGenOpts.XRayOmitFunctionIndex;
- Options.LoopAlignment = CodeGenOpts.LoopAlignment;
- Options.DebugStrictDwarf = CodeGenOpts.DebugStrictDwarf;
- Options.ObjectFilenameForDebug = CodeGenOpts.ObjectFilenameForDebug;
- Options.Hotpatch = CodeGenOpts.HotPatch;
- Options.JMCInstrument = CodeGenOpts.JMCInstrument;
- switch (CodeGenOpts.getSwiftAsyncFramePointer()) {
- case CodeGenOptions::SwiftAsyncFramePointerKind::Auto:
- Options.SwiftAsyncFramePointer =
- SwiftAsyncFramePointerMode::DeploymentBased;
- break;
- case CodeGenOptions::SwiftAsyncFramePointerKind::Always:
- Options.SwiftAsyncFramePointer = SwiftAsyncFramePointerMode::Always;
- break;
- case CodeGenOptions::SwiftAsyncFramePointerKind::Never:
- Options.SwiftAsyncFramePointer = SwiftAsyncFramePointerMode::Never;
- break;
- }
- Options.MCOptions.SplitDwarfFile = CodeGenOpts.SplitDwarfFile;
- Options.MCOptions.EmitDwarfUnwind = CodeGenOpts.getEmitDwarfUnwind();
- Options.MCOptions.MCRelaxAll = CodeGenOpts.RelaxAll;
- Options.MCOptions.MCSaveTempLabels = CodeGenOpts.SaveTempLabels;
- Options.MCOptions.MCUseDwarfDirectory =
- CodeGenOpts.NoDwarfDirectoryAsm
- ? llvm::MCTargetOptions::DisableDwarfDirectory
- : llvm::MCTargetOptions::EnableDwarfDirectory;
- Options.MCOptions.MCNoExecStack = CodeGenOpts.NoExecStack;
- Options.MCOptions.MCIncrementalLinkerCompatible =
- CodeGenOpts.IncrementalLinkerCompatible;
- Options.MCOptions.MCFatalWarnings = CodeGenOpts.FatalWarnings;
- Options.MCOptions.MCNoWarn = CodeGenOpts.NoWarn;
- Options.MCOptions.AsmVerbose = CodeGenOpts.AsmVerbose;
- Options.MCOptions.Dwarf64 = CodeGenOpts.Dwarf64;
- Options.MCOptions.PreserveAsmComments = CodeGenOpts.PreserveAsmComments;
- Options.MCOptions.ABIName = TargetOpts.ABI;
- for (const auto &Entry : HSOpts.UserEntries)
- if (!Entry.IsFramework &&
- (Entry.Group == frontend::IncludeDirGroup::Quoted ||
- Entry.Group == frontend::IncludeDirGroup::Angled ||
- Entry.Group == frontend::IncludeDirGroup::System))
- Options.MCOptions.IASSearchPaths.push_back(
- Entry.IgnoreSysRoot ? Entry.Path : HSOpts.Sysroot + Entry.Path);
- Options.MCOptions.Argv0 = CodeGenOpts.Argv0;
- Options.MCOptions.CommandLineArgs = CodeGenOpts.CommandLineArgs;
- Options.MCOptions.AsSecureLogFile = CodeGenOpts.AsSecureLogFile;
- Options.MisExpect = CodeGenOpts.MisExpect;
- return true;
- }
- static std::optional<GCOVOptions>
- getGCOVOptions(const CodeGenOptions &CodeGenOpts, const LangOptions &LangOpts) {
- if (!CodeGenOpts.EmitGcovArcs && !CodeGenOpts.EmitGcovNotes)
- return std::nullopt;
- // Not using 'GCOVOptions::getDefault' allows us to avoid exiting if
- // LLVM's -default-gcov-version flag is set to something invalid.
- GCOVOptions Options;
- Options.EmitNotes = CodeGenOpts.EmitGcovNotes;
- Options.EmitData = CodeGenOpts.EmitGcovArcs;
- llvm::copy(CodeGenOpts.CoverageVersion, std::begin(Options.Version));
- Options.NoRedZone = CodeGenOpts.DisableRedZone;
- Options.Filter = CodeGenOpts.ProfileFilterFiles;
- Options.Exclude = CodeGenOpts.ProfileExcludeFiles;
- Options.Atomic = CodeGenOpts.AtomicProfileUpdate;
- return Options;
- }
- static std::optional<InstrProfOptions>
- getInstrProfOptions(const CodeGenOptions &CodeGenOpts,
- const LangOptions &LangOpts) {
- if (!CodeGenOpts.hasProfileClangInstr())
- return std::nullopt;
- InstrProfOptions Options;
- Options.NoRedZone = CodeGenOpts.DisableRedZone;
- Options.InstrProfileOutput = CodeGenOpts.InstrProfileOutput;
- Options.Atomic = CodeGenOpts.AtomicProfileUpdate;
- return Options;
- }
- static void setCommandLineOpts(const CodeGenOptions &CodeGenOpts) {
- SmallVector<const char *, 16> BackendArgs;
- BackendArgs.push_back("clang"); // Fake program name.
- if (!CodeGenOpts.DebugPass.empty()) {
- BackendArgs.push_back("-debug-pass");
- BackendArgs.push_back(CodeGenOpts.DebugPass.c_str());
- }
- if (!CodeGenOpts.LimitFloatPrecision.empty()) {
- BackendArgs.push_back("-limit-float-precision");
- BackendArgs.push_back(CodeGenOpts.LimitFloatPrecision.c_str());
- }
- // Check for the default "clang" invocation that won't set any cl::opt values.
- // Skip trying to parse the command line invocation to avoid the issues
- // described below.
- if (BackendArgs.size() == 1)
- return;
- BackendArgs.push_back(nullptr);
- // FIXME: The command line parser below is not thread-safe and shares a global
- // state, so this call might crash or overwrite the options of another Clang
- // instance in the same process.
- llvm::cl::ParseCommandLineOptions(BackendArgs.size() - 1,
- BackendArgs.data());
- }
- void EmitAssemblyHelper::CreateTargetMachine(bool MustCreateTM) {
- // Create the TargetMachine for generating code.
- std::string Error;
- std::string Triple = TheModule->getTargetTriple();
- const llvm::Target *TheTarget = TargetRegistry::lookupTarget(Triple, Error);
- if (!TheTarget) {
- if (MustCreateTM)
- Diags.Report(diag::err_fe_unable_to_create_target) << Error;
- return;
- }
- std::optional<llvm::CodeModel::Model> CM = getCodeModel(CodeGenOpts);
- std::string FeaturesStr =
- llvm::join(TargetOpts.Features.begin(), TargetOpts.Features.end(), ",");
- llvm::Reloc::Model RM = CodeGenOpts.RelocationModel;
- std::optional<CodeGenOpt::Level> OptLevelOrNone =
- CodeGenOpt::getLevel(CodeGenOpts.OptimizationLevel);
- assert(OptLevelOrNone && "Invalid optimization level!");
- CodeGenOpt::Level OptLevel = *OptLevelOrNone;
- llvm::TargetOptions Options;
- if (!initTargetOptions(Diags, Options, CodeGenOpts, TargetOpts, LangOpts,
- HSOpts))
- return;
- TM.reset(TheTarget->createTargetMachine(Triple, TargetOpts.CPU, FeaturesStr,
- Options, RM, CM, OptLevel));
- }
- bool EmitAssemblyHelper::AddEmitPasses(legacy::PassManager &CodeGenPasses,
- BackendAction Action,
- raw_pwrite_stream &OS,
- raw_pwrite_stream *DwoOS) {
- // Add LibraryInfo.
- std::unique_ptr<TargetLibraryInfoImpl> TLII(
- createTLII(TargetTriple, CodeGenOpts));
- CodeGenPasses.add(new TargetLibraryInfoWrapperPass(*TLII));
- // Normal mode, emit a .s or .o file by running the code generator. Note,
- // this also adds codegenerator level optimization passes.
- CodeGenFileType CGFT = getCodeGenFileType(Action);
- // Add ObjC ARC final-cleanup optimizations. This is done as part of the
- // "codegen" passes so that it isn't run multiple times when there is
- // inlining happening.
- if (CodeGenOpts.OptimizationLevel > 0)
- CodeGenPasses.add(createObjCARCContractPass());
- if (TM->addPassesToEmitFile(CodeGenPasses, OS, DwoOS, CGFT,
- /*DisableVerify=*/!CodeGenOpts.VerifyModule)) {
- Diags.Report(diag::err_fe_unable_to_interface_with_target);
- return false;
- }
- return true;
- }
- static OptimizationLevel mapToLevel(const CodeGenOptions &Opts) {
- switch (Opts.OptimizationLevel) {
- default:
- llvm_unreachable("Invalid optimization level!");
- case 0:
- return OptimizationLevel::O0;
- case 1:
- return OptimizationLevel::O1;
- case 2:
- switch (Opts.OptimizeSize) {
- default:
- llvm_unreachable("Invalid optimization level for size!");
- case 0:
- return OptimizationLevel::O2;
- case 1:
- return OptimizationLevel::Os;
- case 2:
- return OptimizationLevel::Oz;
- }
- case 3:
- return OptimizationLevel::O3;
- }
- }
- static void addKCFIPass(const Triple &TargetTriple, const LangOptions &LangOpts,
- PassBuilder &PB) {
- // If the back-end supports KCFI operand bundle lowering, skip KCFIPass.
- if (TargetTriple.getArch() == llvm::Triple::x86_64 ||
- TargetTriple.isAArch64(64))
- return;
- // Ensure we lower KCFI operand bundles with -O0.
- PB.registerOptimizerLastEPCallback(
- [&](ModulePassManager &MPM, OptimizationLevel Level) {
- if (Level == OptimizationLevel::O0 &&
- LangOpts.Sanitize.has(SanitizerKind::KCFI))
- MPM.addPass(createModuleToFunctionPassAdaptor(KCFIPass()));
- });
- // When optimizations are requested, run KCIFPass after InstCombine to
- // avoid unnecessary checks.
- PB.registerPeepholeEPCallback(
- [&](FunctionPassManager &FPM, OptimizationLevel Level) {
- if (Level != OptimizationLevel::O0 &&
- LangOpts.Sanitize.has(SanitizerKind::KCFI))
- FPM.addPass(KCFIPass());
- });
- }
- static void addSanitizers(const Triple &TargetTriple,
- const CodeGenOptions &CodeGenOpts,
- const LangOptions &LangOpts, PassBuilder &PB) {
- auto SanitizersCallback = [&](ModulePassManager &MPM,
- OptimizationLevel Level) {
- if (CodeGenOpts.hasSanitizeCoverage()) {
- auto SancovOpts = getSancovOptsFromCGOpts(CodeGenOpts);
- MPM.addPass(SanitizerCoveragePass(
- SancovOpts, CodeGenOpts.SanitizeCoverageAllowlistFiles,
- CodeGenOpts.SanitizeCoverageIgnorelistFiles));
- }
- if (CodeGenOpts.hasSanitizeBinaryMetadata()) {
- MPM.addPass(SanitizerBinaryMetadataPass(
- getSanitizerBinaryMetadataOptions(CodeGenOpts)));
- }
- auto MSanPass = [&](SanitizerMask Mask, bool CompileKernel) {
- if (LangOpts.Sanitize.has(Mask)) {
- int TrackOrigins = CodeGenOpts.SanitizeMemoryTrackOrigins;
- bool Recover = CodeGenOpts.SanitizeRecover.has(Mask);
- MemorySanitizerOptions options(TrackOrigins, Recover, CompileKernel,
- CodeGenOpts.SanitizeMemoryParamRetval);
- MPM.addPass(MemorySanitizerPass(options));
- if (Level != OptimizationLevel::O0) {
- // MemorySanitizer inserts complex instrumentation that mostly follows
- // the logic of the original code, but operates on "shadow" values. It
- // can benefit from re-running some general purpose optimization
- // passes.
- MPM.addPass(RequireAnalysisPass<GlobalsAA, Module>());
- FunctionPassManager FPM;
- FPM.addPass(EarlyCSEPass(true /* Enable mem-ssa. */));
- FPM.addPass(InstCombinePass());
- FPM.addPass(JumpThreadingPass());
- FPM.addPass(GVNPass());
- FPM.addPass(InstCombinePass());
- MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
- }
- }
- };
- MSanPass(SanitizerKind::Memory, false);
- MSanPass(SanitizerKind::KernelMemory, true);
- if (LangOpts.Sanitize.has(SanitizerKind::Thread)) {
- MPM.addPass(ModuleThreadSanitizerPass());
- MPM.addPass(createModuleToFunctionPassAdaptor(ThreadSanitizerPass()));
- }
- auto ASanPass = [&](SanitizerMask Mask, bool CompileKernel) {
- if (LangOpts.Sanitize.has(Mask)) {
- bool UseGlobalGC = asanUseGlobalsGC(TargetTriple, CodeGenOpts);
- bool UseOdrIndicator = CodeGenOpts.SanitizeAddressUseOdrIndicator;
- llvm::AsanDtorKind DestructorKind =
- CodeGenOpts.getSanitizeAddressDtor();
- AddressSanitizerOptions Opts;
- Opts.CompileKernel = CompileKernel;
- Opts.Recover = CodeGenOpts.SanitizeRecover.has(Mask);
- Opts.UseAfterScope = CodeGenOpts.SanitizeAddressUseAfterScope;
- Opts.UseAfterReturn = CodeGenOpts.getSanitizeAddressUseAfterReturn();
- MPM.addPass(AddressSanitizerPass(Opts, UseGlobalGC, UseOdrIndicator,
- DestructorKind));
- }
- };
- ASanPass(SanitizerKind::Address, false);
- ASanPass(SanitizerKind::KernelAddress, true);
- auto HWASanPass = [&](SanitizerMask Mask, bool CompileKernel) {
- if (LangOpts.Sanitize.has(Mask)) {
- bool Recover = CodeGenOpts.SanitizeRecover.has(Mask);
- MPM.addPass(HWAddressSanitizerPass(
- {CompileKernel, Recover,
- /*DisableOptimization=*/CodeGenOpts.OptimizationLevel == 0}));
- }
- };
- HWASanPass(SanitizerKind::HWAddress, false);
- HWASanPass(SanitizerKind::KernelHWAddress, true);
- if (LangOpts.Sanitize.has(SanitizerKind::DataFlow)) {
- MPM.addPass(DataFlowSanitizerPass(LangOpts.NoSanitizeFiles));
- }
- };
- if (ClSanitizeOnOptimizerEarlyEP) {
- PB.registerOptimizerEarlyEPCallback(
- [SanitizersCallback](ModulePassManager &MPM, OptimizationLevel Level) {
- ModulePassManager NewMPM;
- SanitizersCallback(NewMPM, Level);
- if (!NewMPM.isEmpty()) {
- // Sanitizers can abandon<GlobalsAA>.
- NewMPM.addPass(RequireAnalysisPass<GlobalsAA, Module>());
- MPM.addPass(std::move(NewMPM));
- }
- });
- } else {
- // LastEP does not need GlobalsAA.
- PB.registerOptimizerLastEPCallback(SanitizersCallback);
- }
- }
- void EmitAssemblyHelper::RunOptimizationPipeline(
- BackendAction Action, std::unique_ptr<raw_pwrite_stream> &OS,
- std::unique_ptr<llvm::ToolOutputFile> &ThinLinkOS) {
- std::optional<PGOOptions> PGOOpt;
- if (CodeGenOpts.hasProfileIRInstr())
- // -fprofile-generate.
- PGOOpt = PGOOptions(CodeGenOpts.InstrProfileOutput.empty()
- ? getDefaultProfileGenName()
- : CodeGenOpts.InstrProfileOutput,
- "", "", PGOOptions::IRInstr, PGOOptions::NoCSAction,
- CodeGenOpts.DebugInfoForProfiling);
- else if (CodeGenOpts.hasProfileIRUse()) {
- // -fprofile-use.
- auto CSAction = CodeGenOpts.hasProfileCSIRUse() ? PGOOptions::CSIRUse
- : PGOOptions::NoCSAction;
- PGOOpt = PGOOptions(CodeGenOpts.ProfileInstrumentUsePath, "",
- CodeGenOpts.ProfileRemappingFile, PGOOptions::IRUse,
- CSAction, CodeGenOpts.DebugInfoForProfiling);
- } else if (!CodeGenOpts.SampleProfileFile.empty())
- // -fprofile-sample-use
- PGOOpt = PGOOptions(
- CodeGenOpts.SampleProfileFile, "", CodeGenOpts.ProfileRemappingFile,
- PGOOptions::SampleUse, PGOOptions::NoCSAction,
- CodeGenOpts.DebugInfoForProfiling, CodeGenOpts.PseudoProbeForProfiling);
- else if (CodeGenOpts.PseudoProbeForProfiling)
- // -fpseudo-probe-for-profiling
- PGOOpt =
- PGOOptions("", "", "", PGOOptions::NoAction, PGOOptions::NoCSAction,
- CodeGenOpts.DebugInfoForProfiling, true);
- else if (CodeGenOpts.DebugInfoForProfiling)
- // -fdebug-info-for-profiling
- PGOOpt = PGOOptions("", "", "", PGOOptions::NoAction,
- PGOOptions::NoCSAction, true);
- // Check to see if we want to generate a CS profile.
- if (CodeGenOpts.hasProfileCSIRInstr()) {
- assert(!CodeGenOpts.hasProfileCSIRUse() &&
- "Cannot have both CSProfileUse pass and CSProfileGen pass at "
- "the same time");
- if (PGOOpt) {
- assert(PGOOpt->Action != PGOOptions::IRInstr &&
- PGOOpt->Action != PGOOptions::SampleUse &&
- "Cannot run CSProfileGen pass with ProfileGen or SampleUse "
- " pass");
- PGOOpt->CSProfileGenFile = CodeGenOpts.InstrProfileOutput.empty()
- ? getDefaultProfileGenName()
- : CodeGenOpts.InstrProfileOutput;
- PGOOpt->CSAction = PGOOptions::CSIRInstr;
- } else
- PGOOpt = PGOOptions("",
- CodeGenOpts.InstrProfileOutput.empty()
- ? getDefaultProfileGenName()
- : CodeGenOpts.InstrProfileOutput,
- "", PGOOptions::NoAction, PGOOptions::CSIRInstr,
- CodeGenOpts.DebugInfoForProfiling);
- }
- if (TM)
- TM->setPGOOption(PGOOpt);
- PipelineTuningOptions PTO;
- PTO.LoopUnrolling = CodeGenOpts.UnrollLoops;
- // For historical reasons, loop interleaving is set to mirror setting for loop
- // unrolling.
- PTO.LoopInterleaving = CodeGenOpts.UnrollLoops;
- PTO.LoopVectorization = CodeGenOpts.VectorizeLoop;
- PTO.SLPVectorization = CodeGenOpts.VectorizeSLP;
- PTO.MergeFunctions = CodeGenOpts.MergeFunctions;
- // Only enable CGProfilePass when using integrated assembler, since
- // non-integrated assemblers don't recognize .cgprofile section.
- PTO.CallGraphProfile = !CodeGenOpts.DisableIntegratedAS;
- LoopAnalysisManager LAM;
- FunctionAnalysisManager FAM;
- CGSCCAnalysisManager CGAM;
- ModuleAnalysisManager MAM;
- bool DebugPassStructure = CodeGenOpts.DebugPass == "Structure";
- PassInstrumentationCallbacks PIC;
- PrintPassOptions PrintPassOpts;
- PrintPassOpts.Indent = DebugPassStructure;
- PrintPassOpts.SkipAnalyses = DebugPassStructure;
- StandardInstrumentations SI(
- TheModule->getContext(),
- (CodeGenOpts.DebugPassManager || DebugPassStructure),
- /*VerifyEach*/ false, PrintPassOpts);
- SI.registerCallbacks(PIC, &FAM);
- PassBuilder PB(TM.get(), PTO, PGOOpt, &PIC);
- if (CodeGenOpts.EnableAssignmentTracking) {
- PB.registerPipelineStartEPCallback(
- [&](ModulePassManager &MPM, OptimizationLevel Level) {
- MPM.addPass(AssignmentTrackingPass());
- });
- }
- // Enable verify-debuginfo-preserve-each for new PM.
- DebugifyEachInstrumentation Debugify;
- DebugInfoPerPass DebugInfoBeforePass;
- if (CodeGenOpts.EnableDIPreservationVerify) {
- Debugify.setDebugifyMode(DebugifyMode::OriginalDebugInfo);
- Debugify.setDebugInfoBeforePass(DebugInfoBeforePass);
- if (!CodeGenOpts.DIBugsReportFilePath.empty())
- Debugify.setOrigDIVerifyBugsReportFilePath(
- CodeGenOpts.DIBugsReportFilePath);
- Debugify.registerCallbacks(PIC);
- }
- // Attempt to load pass plugins and register their callbacks with PB.
- for (auto &PluginFN : CodeGenOpts.PassPlugins) {
- auto PassPlugin = PassPlugin::Load(PluginFN);
- if (PassPlugin) {
- PassPlugin->registerPassBuilderCallbacks(PB);
- } else {
- Diags.Report(diag::err_fe_unable_to_load_plugin)
- << PluginFN << toString(PassPlugin.takeError());
- }
- }
- #define HANDLE_EXTENSION(Ext) \
- get##Ext##PluginInfo().RegisterPassBuilderCallbacks(PB);
- #include "llvm/Support/Extension.def"
- // Register the target library analysis directly and give it a customized
- // preset TLI.
- std::unique_ptr<TargetLibraryInfoImpl> TLII(
- createTLII(TargetTriple, CodeGenOpts));
- FAM.registerPass([&] { return TargetLibraryAnalysis(*TLII); });
- // Register all the basic analyses with the managers.
- PB.registerModuleAnalyses(MAM);
- PB.registerCGSCCAnalyses(CGAM);
- PB.registerFunctionAnalyses(FAM);
- PB.registerLoopAnalyses(LAM);
- PB.crossRegisterProxies(LAM, FAM, CGAM, MAM);
- ModulePassManager MPM;
- if (!CodeGenOpts.DisableLLVMPasses) {
- // Map our optimization levels into one of the distinct levels used to
- // configure the pipeline.
- OptimizationLevel Level = mapToLevel(CodeGenOpts);
- bool IsThinLTO = CodeGenOpts.PrepareForThinLTO;
- bool IsLTO = CodeGenOpts.PrepareForLTO;
- if (LangOpts.ObjCAutoRefCount) {
- PB.registerPipelineStartEPCallback(
- [](ModulePassManager &MPM, OptimizationLevel Level) {
- if (Level != OptimizationLevel::O0)
- MPM.addPass(
- createModuleToFunctionPassAdaptor(ObjCARCExpandPass()));
- });
- PB.registerPipelineEarlySimplificationEPCallback(
- [](ModulePassManager &MPM, OptimizationLevel Level) {
- if (Level != OptimizationLevel::O0)
- MPM.addPass(ObjCARCAPElimPass());
- });
- PB.registerScalarOptimizerLateEPCallback(
- [](FunctionPassManager &FPM, OptimizationLevel Level) {
- if (Level != OptimizationLevel::O0)
- FPM.addPass(ObjCARCOptPass());
- });
- }
- // If we reached here with a non-empty index file name, then the index
- // file was empty and we are not performing ThinLTO backend compilation
- // (used in testing in a distributed build environment).
- bool IsThinLTOPostLink = !CodeGenOpts.ThinLTOIndexFile.empty();
- // If so drop any the type test assume sequences inserted for whole program
- // vtables so that codegen doesn't complain.
- if (IsThinLTOPostLink)
- PB.registerPipelineStartEPCallback(
- [](ModulePassManager &MPM, OptimizationLevel Level) {
- MPM.addPass(LowerTypeTestsPass(/*ExportSummary=*/nullptr,
- /*ImportSummary=*/nullptr,
- /*DropTypeTests=*/true));
- });
- if (CodeGenOpts.InstrumentFunctions ||
- CodeGenOpts.InstrumentFunctionEntryBare ||
- CodeGenOpts.InstrumentFunctionsAfterInlining ||
- CodeGenOpts.InstrumentForProfiling) {
- PB.registerPipelineStartEPCallback(
- [](ModulePassManager &MPM, OptimizationLevel Level) {
- MPM.addPass(createModuleToFunctionPassAdaptor(
- EntryExitInstrumenterPass(/*PostInlining=*/false)));
- });
- PB.registerOptimizerLastEPCallback(
- [](ModulePassManager &MPM, OptimizationLevel Level) {
- MPM.addPass(createModuleToFunctionPassAdaptor(
- EntryExitInstrumenterPass(/*PostInlining=*/true)));
- });
- }
- // Register callbacks to schedule sanitizer passes at the appropriate part
- // of the pipeline.
- if (LangOpts.Sanitize.has(SanitizerKind::LocalBounds))
- PB.registerScalarOptimizerLateEPCallback(
- [](FunctionPassManager &FPM, OptimizationLevel Level) {
- FPM.addPass(BoundsCheckingPass());
- });
- // Don't add sanitizers if we are here from ThinLTO PostLink. That already
- // done on PreLink stage.
- if (!IsThinLTOPostLink) {
- addSanitizers(TargetTriple, CodeGenOpts, LangOpts, PB);
- addKCFIPass(TargetTriple, LangOpts, PB);
- }
- if (std::optional<GCOVOptions> Options =
- getGCOVOptions(CodeGenOpts, LangOpts))
- PB.registerPipelineStartEPCallback(
- [Options](ModulePassManager &MPM, OptimizationLevel Level) {
- MPM.addPass(GCOVProfilerPass(*Options));
- });
- if (std::optional<InstrProfOptions> Options =
- getInstrProfOptions(CodeGenOpts, LangOpts))
- PB.registerPipelineStartEPCallback(
- [Options](ModulePassManager &MPM, OptimizationLevel Level) {
- MPM.addPass(InstrProfiling(*Options, false));
- });
- if (CodeGenOpts.OptimizationLevel == 0) {
- MPM = PB.buildO0DefaultPipeline(Level, IsLTO || IsThinLTO);
- } else if (IsThinLTO) {
- MPM = PB.buildThinLTOPreLinkDefaultPipeline(Level);
- } else if (IsLTO) {
- MPM = PB.buildLTOPreLinkDefaultPipeline(Level);
- } else {
- MPM = PB.buildPerModuleDefaultPipeline(Level);
- }
- if (!CodeGenOpts.MemoryProfileOutput.empty()) {
- MPM.addPass(createModuleToFunctionPassAdaptor(MemProfilerPass()));
- MPM.addPass(ModuleMemProfilerPass());
- }
- }
- // Add a verifier pass if requested. We don't have to do this if the action
- // requires code generation because there will already be a verifier pass in
- // the code-generation pipeline.
- if (!actionRequiresCodeGen(Action) && CodeGenOpts.VerifyModule)
- MPM.addPass(VerifierPass());
- if (Action == Backend_EmitBC || Action == Backend_EmitLL) {
- if (CodeGenOpts.PrepareForThinLTO && !CodeGenOpts.DisableLLVMPasses) {
- if (!TheModule->getModuleFlag("EnableSplitLTOUnit"))
- TheModule->addModuleFlag(Module::Error, "EnableSplitLTOUnit",
- CodeGenOpts.EnableSplitLTOUnit);
- if (Action == Backend_EmitBC) {
- if (!CodeGenOpts.ThinLinkBitcodeFile.empty()) {
- ThinLinkOS = openOutputFile(CodeGenOpts.ThinLinkBitcodeFile);
- if (!ThinLinkOS)
- return;
- }
- MPM.addPass(ThinLTOBitcodeWriterPass(*OS, ThinLinkOS ? &ThinLinkOS->os()
- : nullptr));
- } else {
- MPM.addPass(PrintModulePass(*OS, "", CodeGenOpts.EmitLLVMUseLists,
- /*EmitLTOSummary=*/true));
- }
- } else {
- // Emit a module summary by default for Regular LTO except for ld64
- // targets
- bool EmitLTOSummary = shouldEmitRegularLTOSummary();
- if (EmitLTOSummary) {
- if (!TheModule->getModuleFlag("ThinLTO"))
- TheModule->addModuleFlag(Module::Error, "ThinLTO", uint32_t(0));
- if (!TheModule->getModuleFlag("EnableSplitLTOUnit"))
- TheModule->addModuleFlag(Module::Error, "EnableSplitLTOUnit",
- uint32_t(1));
- }
- if (Action == Backend_EmitBC)
- MPM.addPass(BitcodeWriterPass(*OS, CodeGenOpts.EmitLLVMUseLists,
- EmitLTOSummary));
- else
- MPM.addPass(PrintModulePass(*OS, "", CodeGenOpts.EmitLLVMUseLists,
- EmitLTOSummary));
- }
- }
- // Now that we have all of the passes ready, run them.
- {
- PrettyStackTraceString CrashInfo("Optimizer");
- llvm::TimeTraceScope TimeScope("Optimizer");
- MPM.run(*TheModule, MAM);
- }
- }
- void EmitAssemblyHelper::RunCodegenPipeline(
- BackendAction Action, std::unique_ptr<raw_pwrite_stream> &OS,
- std::unique_ptr<llvm::ToolOutputFile> &DwoOS) {
- // We still use the legacy PM to run the codegen pipeline since the new PM
- // does not work with the codegen pipeline.
- // FIXME: make the new PM work with the codegen pipeline.
- legacy::PassManager CodeGenPasses;
- // Append any output we need to the pass manager.
- switch (Action) {
- case Backend_EmitAssembly:
- case Backend_EmitMCNull:
- case Backend_EmitObj:
- CodeGenPasses.add(
- createTargetTransformInfoWrapperPass(getTargetIRAnalysis()));
- if (!CodeGenOpts.SplitDwarfOutput.empty()) {
- DwoOS = openOutputFile(CodeGenOpts.SplitDwarfOutput);
- if (!DwoOS)
- return;
- }
- if (!AddEmitPasses(CodeGenPasses, Action, *OS,
- DwoOS ? &DwoOS->os() : nullptr))
- // FIXME: Should we handle this error differently?
- return;
- break;
- default:
- return;
- }
- {
- PrettyStackTraceString CrashInfo("Code generation");
- llvm::TimeTraceScope TimeScope("CodeGenPasses");
- CodeGenPasses.run(*TheModule);
- }
- }
- void EmitAssemblyHelper::EmitAssembly(BackendAction Action,
- std::unique_ptr<raw_pwrite_stream> OS) {
- TimeRegion Region(CodeGenOpts.TimePasses ? &CodeGenerationTime : nullptr);
- setCommandLineOpts(CodeGenOpts);
- bool RequiresCodeGen = actionRequiresCodeGen(Action);
- CreateTargetMachine(RequiresCodeGen);
- if (RequiresCodeGen && !TM)
- return;
- if (TM)
- TheModule->setDataLayout(TM->createDataLayout());
- // Before executing passes, print the final values of the LLVM options.
- cl::PrintOptionValues();
- std::unique_ptr<llvm::ToolOutputFile> ThinLinkOS, DwoOS;
- RunOptimizationPipeline(Action, OS, ThinLinkOS);
- RunCodegenPipeline(Action, OS, DwoOS);
- if (ThinLinkOS)
- ThinLinkOS->keep();
- if (DwoOS)
- DwoOS->keep();
- }
- static void runThinLTOBackend(
- DiagnosticsEngine &Diags, ModuleSummaryIndex *CombinedIndex, Module *M,
- const HeaderSearchOptions &HeaderOpts, const CodeGenOptions &CGOpts,
- const clang::TargetOptions &TOpts, const LangOptions &LOpts,
- std::unique_ptr<raw_pwrite_stream> OS, std::string SampleProfile,
- std::string ProfileRemapping, BackendAction Action) {
- StringMap<DenseMap<GlobalValue::GUID, GlobalValueSummary *>>
- ModuleToDefinedGVSummaries;
- CombinedIndex->collectDefinedGVSummariesPerModule(ModuleToDefinedGVSummaries);
- setCommandLineOpts(CGOpts);
- // We can simply import the values mentioned in the combined index, since
- // we should only invoke this using the individual indexes written out
- // via a WriteIndexesThinBackend.
- FunctionImporter::ImportMapTy ImportList;
- if (!lto::initImportList(*M, *CombinedIndex, ImportList))
- return;
- auto AddStream = [&](size_t Task, const Twine &ModuleName) {
- return std::make_unique<CachedFileStream>(std::move(OS),
- CGOpts.ObjectFilenameForDebug);
- };
- lto::Config Conf;
- if (CGOpts.SaveTempsFilePrefix != "") {
- if (Error E = Conf.addSaveTemps(CGOpts.SaveTempsFilePrefix + ".",
- /* UseInputModulePath */ false)) {
- handleAllErrors(std::move(E), [&](ErrorInfoBase &EIB) {
- errs() << "Error setting up ThinLTO save-temps: " << EIB.message()
- << '\n';
- });
- }
- }
- Conf.CPU = TOpts.CPU;
- Conf.CodeModel = getCodeModel(CGOpts);
- Conf.MAttrs = TOpts.Features;
- Conf.RelocModel = CGOpts.RelocationModel;
- std::optional<CodeGenOpt::Level> OptLevelOrNone =
- CodeGenOpt::getLevel(CGOpts.OptimizationLevel);
- assert(OptLevelOrNone && "Invalid optimization level!");
- Conf.CGOptLevel = *OptLevelOrNone;
- Conf.OptLevel = CGOpts.OptimizationLevel;
- initTargetOptions(Diags, Conf.Options, CGOpts, TOpts, LOpts, HeaderOpts);
- Conf.SampleProfile = std::move(SampleProfile);
- Conf.PTO.LoopUnrolling = CGOpts.UnrollLoops;
- // For historical reasons, loop interleaving is set to mirror setting for loop
- // unrolling.
- Conf.PTO.LoopInterleaving = CGOpts.UnrollLoops;
- Conf.PTO.LoopVectorization = CGOpts.VectorizeLoop;
- Conf.PTO.SLPVectorization = CGOpts.VectorizeSLP;
- // Only enable CGProfilePass when using integrated assembler, since
- // non-integrated assemblers don't recognize .cgprofile section.
- Conf.PTO.CallGraphProfile = !CGOpts.DisableIntegratedAS;
- // Context sensitive profile.
- if (CGOpts.hasProfileCSIRInstr()) {
- Conf.RunCSIRInstr = true;
- Conf.CSIRProfile = std::move(CGOpts.InstrProfileOutput);
- } else if (CGOpts.hasProfileCSIRUse()) {
- Conf.RunCSIRInstr = false;
- Conf.CSIRProfile = std::move(CGOpts.ProfileInstrumentUsePath);
- }
- Conf.ProfileRemapping = std::move(ProfileRemapping);
- Conf.DebugPassManager = CGOpts.DebugPassManager;
- Conf.RemarksWithHotness = CGOpts.DiagnosticsWithHotness;
- Conf.RemarksFilename = CGOpts.OptRecordFile;
- Conf.RemarksPasses = CGOpts.OptRecordPasses;
- Conf.RemarksFormat = CGOpts.OptRecordFormat;
- Conf.SplitDwarfFile = CGOpts.SplitDwarfFile;
- Conf.SplitDwarfOutput = CGOpts.SplitDwarfOutput;
- switch (Action) {
- case Backend_EmitNothing:
- Conf.PreCodeGenModuleHook = [](size_t Task, const Module &Mod) {
- return false;
- };
- break;
- case Backend_EmitLL:
- Conf.PreCodeGenModuleHook = [&](size_t Task, const Module &Mod) {
- M->print(*OS, nullptr, CGOpts.EmitLLVMUseLists);
- return false;
- };
- break;
- case Backend_EmitBC:
- Conf.PreCodeGenModuleHook = [&](size_t Task, const Module &Mod) {
- WriteBitcodeToFile(*M, *OS, CGOpts.EmitLLVMUseLists);
- return false;
- };
- break;
- default:
- Conf.CGFileType = getCodeGenFileType(Action);
- break;
- }
- if (Error E =
- thinBackend(Conf, -1, AddStream, *M, *CombinedIndex, ImportList,
- ModuleToDefinedGVSummaries[M->getModuleIdentifier()],
- /* ModuleMap */ nullptr, CGOpts.CmdArgs)) {
- handleAllErrors(std::move(E), [&](ErrorInfoBase &EIB) {
- errs() << "Error running ThinLTO backend: " << EIB.message() << '\n';
- });
- }
- }
- void clang::EmitBackendOutput(DiagnosticsEngine &Diags,
- const HeaderSearchOptions &HeaderOpts,
- const CodeGenOptions &CGOpts,
- const clang::TargetOptions &TOpts,
- const LangOptions &LOpts,
- StringRef TDesc, Module *M,
- BackendAction Action,
- std::unique_ptr<raw_pwrite_stream> OS) {
- llvm::TimeTraceScope TimeScope("Backend");
- std::unique_ptr<llvm::Module> EmptyModule;
- if (!CGOpts.ThinLTOIndexFile.empty()) {
- // If we are performing a ThinLTO importing compile, load the function index
- // into memory and pass it into runThinLTOBackend, which will run the
- // function importer and invoke LTO passes.
- std::unique_ptr<ModuleSummaryIndex> CombinedIndex;
- if (Error E = llvm::getModuleSummaryIndexForFile(
- CGOpts.ThinLTOIndexFile,
- /*IgnoreEmptyThinLTOIndexFile*/ true)
- .moveInto(CombinedIndex)) {
- logAllUnhandledErrors(std::move(E), errs(),
- "Error loading index file '" +
- CGOpts.ThinLTOIndexFile + "': ");
- return;
- }
- // A null CombinedIndex means we should skip ThinLTO compilation
- // (LLVM will optionally ignore empty index files, returning null instead
- // of an error).
- if (CombinedIndex) {
- if (!CombinedIndex->skipModuleByDistributedBackend()) {
- runThinLTOBackend(Diags, CombinedIndex.get(), M, HeaderOpts, CGOpts,
- TOpts, LOpts, std::move(OS), CGOpts.SampleProfileFile,
- CGOpts.ProfileRemappingFile, Action);
- return;
- }
- // Distributed indexing detected that nothing from the module is needed
- // for the final linking. So we can skip the compilation. We sill need to
- // output an empty object file to make sure that a linker does not fail
- // trying to read it. Also for some features, like CFI, we must skip
- // the compilation as CombinedIndex does not contain all required
- // information.
- EmptyModule = std::make_unique<llvm::Module>("empty", M->getContext());
- EmptyModule->setTargetTriple(M->getTargetTriple());
- M = EmptyModule.get();
- }
- }
- EmitAssemblyHelper AsmHelper(Diags, HeaderOpts, CGOpts, TOpts, LOpts, M);
- AsmHelper.EmitAssembly(Action, std::move(OS));
- // Verify clang's TargetInfo DataLayout against the LLVM TargetMachine's
- // DataLayout.
- if (AsmHelper.TM) {
- std::string DLDesc = M->getDataLayout().getStringRepresentation();
- if (DLDesc != TDesc) {
- unsigned DiagID = Diags.getCustomDiagID(
- DiagnosticsEngine::Error, "backend data layout '%0' does not match "
- "expected target description '%1'");
- Diags.Report(DiagID) << DLDesc << TDesc;
- }
- }
- }
- // With -fembed-bitcode, save a copy of the llvm IR as data in the
- // __LLVM,__bitcode section.
- void clang::EmbedBitcode(llvm::Module *M, const CodeGenOptions &CGOpts,
- llvm::MemoryBufferRef Buf) {
- if (CGOpts.getEmbedBitcode() == CodeGenOptions::Embed_Off)
- return;
- llvm::embedBitcodeInModule(
- *M, Buf, CGOpts.getEmbedBitcode() != CodeGenOptions::Embed_Marker,
- CGOpts.getEmbedBitcode() != CodeGenOptions::Embed_Bitcode,
- CGOpts.CmdArgs);
- }
- void clang::EmbedObject(llvm::Module *M, const CodeGenOptions &CGOpts,
- DiagnosticsEngine &Diags) {
- if (CGOpts.OffloadObjects.empty())
- return;
- for (StringRef OffloadObject : CGOpts.OffloadObjects) {
- llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> ObjectOrErr =
- llvm::MemoryBuffer::getFileOrSTDIN(OffloadObject);
- if (std::error_code EC = ObjectOrErr.getError()) {
- auto DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
- "could not open '%0' for embedding");
- Diags.Report(DiagID) << OffloadObject;
- return;
- }
- llvm::embedBufferInModule(*M, **ObjectOrErr, ".llvm.offloading",
- Align(object::OffloadBinary::getAlignment()));
- }
- }
|