//===-- CommandFlags.cpp - Command Line Flags Interface ---------*- C++ -*-===// // // 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 // //===----------------------------------------------------------------------===// // // This file contains codegen-specific flags that are shared between different // command line tools. The tools "llc" and "opt" both use this file to prevent // flag duplication. // //===----------------------------------------------------------------------===// #include "llvm/CodeGen/CommandFlags.h" #include "llvm/IR/Module.h" #include "llvm/MC/SubtargetFeature.h" #include "llvm/Support/CommandLine.h" #include "llvm/Support/Host.h" using namespace llvm; #define CGOPT(TY, NAME) \ static cl::opt *NAME##View; \ TY codegen::get##NAME() { \ assert(NAME##View && "RegisterCodeGenFlags not created."); \ return *NAME##View; \ } #define CGLIST(TY, NAME) \ static cl::list *NAME##View; \ std::vector codegen::get##NAME() { \ assert(NAME##View && "RegisterCodeGenFlags not created."); \ return *NAME##View; \ } #define CGOPT_EXP(TY, NAME) \ CGOPT(TY, NAME) \ Optional codegen::getExplicit##NAME() { \ if (NAME##View->getNumOccurrences()) { \ TY res = *NAME##View; \ return res; \ } \ return None; \ } CGOPT(std::string, MArch) CGOPT(std::string, MCPU) CGLIST(std::string, MAttrs) CGOPT_EXP(Reloc::Model, RelocModel) CGOPT(ThreadModel::Model, ThreadModel) CGOPT_EXP(CodeModel::Model, CodeModel) CGOPT(ExceptionHandling, ExceptionModel) CGOPT_EXP(CodeGenFileType, FileType) CGOPT(FramePointer::FP, FramePointerUsage) CGOPT(bool, EnableUnsafeFPMath) CGOPT(bool, EnableNoInfsFPMath) CGOPT(bool, EnableNoNaNsFPMath) CGOPT(bool, EnableNoSignedZerosFPMath) CGOPT(bool, EnableNoTrappingFPMath) CGOPT(DenormalMode::DenormalModeKind, DenormalFPMath) CGOPT(DenormalMode::DenormalModeKind, DenormalFP32Math) CGOPT(bool, EnableHonorSignDependentRoundingFPMath) CGOPT(FloatABI::ABIType, FloatABIForCalls) CGOPT(FPOpFusion::FPOpFusionMode, FuseFPOps) CGOPT(bool, DontPlaceZerosInBSS) CGOPT(bool, EnableGuaranteedTailCallOpt) CGOPT(bool, DisableTailCalls) CGOPT(bool, StackSymbolOrdering) CGOPT(unsigned, OverrideStackAlignment) CGOPT(bool, StackRealign) CGOPT(std::string, TrapFuncName) CGOPT(bool, UseCtors) CGOPT(bool, RelaxELFRelocations) CGOPT_EXP(bool, DataSections) CGOPT_EXP(bool, FunctionSections) CGOPT(std::string, BBSections) CGOPT(unsigned, TLSSize) CGOPT(bool, EmulatedTLS) CGOPT(bool, UniqueSectionNames) CGOPT(bool, UniqueBasicBlockSectionNames) CGOPT(EABI, EABIVersion) CGOPT(DebuggerKind, DebuggerTuningOpt) CGOPT(bool, EnableStackSizeSection) CGOPT(bool, EnableAddrsig) CGOPT(bool, EmitCallSiteInfo) CGOPT(bool, EnableDebugEntryValues) CGOPT(bool, ForceDwarfFrameSection) CGOPT(bool, XRayOmitFunctionIndex) codegen::RegisterCodeGenFlags::RegisterCodeGenFlags() { #define CGBINDOPT(NAME) \ do { \ NAME##View = std::addressof(NAME); \ } while (0) static cl::opt MArch( "march", cl::desc("Architecture to generate code for (see --version)")); CGBINDOPT(MArch); static cl::opt MCPU( "mcpu", cl::desc("Target a specific cpu type (-mcpu=help for details)"), cl::value_desc("cpu-name"), cl::init("")); CGBINDOPT(MCPU); static cl::list MAttrs( "mattr", cl::CommaSeparated, cl::desc("Target specific attributes (-mattr=help for details)"), cl::value_desc("a1,+a2,-a3,...")); CGBINDOPT(MAttrs); static cl::opt RelocModel( "relocation-model", cl::desc("Choose relocation model"), cl::values( clEnumValN(Reloc::Static, "static", "Non-relocatable code"), clEnumValN(Reloc::PIC_, "pic", "Fully relocatable, position independent code"), clEnumValN(Reloc::DynamicNoPIC, "dynamic-no-pic", "Relocatable external references, non-relocatable code"), clEnumValN( Reloc::ROPI, "ropi", "Code and read-only data relocatable, accessed PC-relative"), clEnumValN( Reloc::RWPI, "rwpi", "Read-write data relocatable, accessed relative to static base"), clEnumValN(Reloc::ROPI_RWPI, "ropi-rwpi", "Combination of ropi and rwpi"))); CGBINDOPT(RelocModel); static cl::opt ThreadModel( "thread-model", cl::desc("Choose threading model"), cl::init(ThreadModel::POSIX), cl::values( clEnumValN(ThreadModel::POSIX, "posix", "POSIX thread model"), clEnumValN(ThreadModel::Single, "single", "Single thread model"))); CGBINDOPT(ThreadModel); static cl::opt CodeModel( "code-model", cl::desc("Choose code model"), cl::values(clEnumValN(CodeModel::Tiny, "tiny", "Tiny code model"), clEnumValN(CodeModel::Small, "small", "Small code model"), clEnumValN(CodeModel::Kernel, "kernel", "Kernel code model"), clEnumValN(CodeModel::Medium, "medium", "Medium code model"), clEnumValN(CodeModel::Large, "large", "Large code model"))); CGBINDOPT(CodeModel); static cl::opt ExceptionModel( "exception-model", cl::desc("exception model"), cl::init(ExceptionHandling::None), cl::values( clEnumValN(ExceptionHandling::None, "default", "default exception handling model"), clEnumValN(ExceptionHandling::DwarfCFI, "dwarf", "DWARF-like CFI based exception handling"), clEnumValN(ExceptionHandling::SjLj, "sjlj", "SjLj exception handling"), clEnumValN(ExceptionHandling::ARM, "arm", "ARM EHABI exceptions"), clEnumValN(ExceptionHandling::WinEH, "wineh", "Windows exception model"), clEnumValN(ExceptionHandling::Wasm, "wasm", "WebAssembly exception handling"))); CGBINDOPT(ExceptionModel); static cl::opt FileType( "filetype", cl::init(CGFT_AssemblyFile), cl::desc( "Choose a file type (not all types are supported by all targets):"), cl::values( clEnumValN(CGFT_AssemblyFile, "asm", "Emit an assembly ('.s') file"), clEnumValN(CGFT_ObjectFile, "obj", "Emit a native object ('.o') file"), clEnumValN(CGFT_Null, "null", "Emit nothing, for performance testing"))); CGBINDOPT(FileType); static cl::opt FramePointerUsage( "frame-pointer", cl::desc("Specify frame pointer elimination optimization"), cl::init(FramePointer::None), cl::values( clEnumValN(FramePointer::All, "all", "Disable frame pointer elimination"), clEnumValN(FramePointer::NonLeaf, "non-leaf", "Disable frame pointer elimination for non-leaf frame"), clEnumValN(FramePointer::None, "none", "Enable frame pointer elimination"))); CGBINDOPT(FramePointerUsage); static cl::opt EnableUnsafeFPMath( "enable-unsafe-fp-math", cl::desc("Enable optimizations that may decrease FP precision"), cl::init(false)); CGBINDOPT(EnableUnsafeFPMath); static cl::opt EnableNoInfsFPMath( "enable-no-infs-fp-math", cl::desc("Enable FP math optimizations that assume no +-Infs"), cl::init(false)); CGBINDOPT(EnableNoInfsFPMath); static cl::opt EnableNoNaNsFPMath( "enable-no-nans-fp-math", cl::desc("Enable FP math optimizations that assume no NaNs"), cl::init(false)); CGBINDOPT(EnableNoNaNsFPMath); static cl::opt EnableNoSignedZerosFPMath( "enable-no-signed-zeros-fp-math", cl::desc("Enable FP math optimizations that assume " "the sign of 0 is insignificant"), cl::init(false)); CGBINDOPT(EnableNoSignedZerosFPMath); static cl::opt EnableNoTrappingFPMath( "enable-no-trapping-fp-math", cl::desc("Enable setting the FP exceptions build " "attribute not to use exceptions"), cl::init(false)); CGBINDOPT(EnableNoTrappingFPMath); static const auto DenormFlagEnumOptions = cl::values(clEnumValN(DenormalMode::IEEE, "ieee", "IEEE 754 denormal numbers"), clEnumValN(DenormalMode::PreserveSign, "preserve-sign", "the sign of a flushed-to-zero number is preserved " "in the sign of 0"), clEnumValN(DenormalMode::PositiveZero, "positive-zero", "denormals are flushed to positive zero")); // FIXME: Doesn't have way to specify separate input and output modes. static cl::opt DenormalFPMath( "denormal-fp-math", cl::desc("Select which denormal numbers the code is permitted to require"), cl::init(DenormalMode::IEEE), DenormFlagEnumOptions); CGBINDOPT(DenormalFPMath); static cl::opt DenormalFP32Math( "denormal-fp-math-f32", cl::desc("Select which denormal numbers the code is permitted to require for float"), cl::init(DenormalMode::Invalid), DenormFlagEnumOptions); CGBINDOPT(DenormalFP32Math); static cl::opt EnableHonorSignDependentRoundingFPMath( "enable-sign-dependent-rounding-fp-math", cl::Hidden, cl::desc("Force codegen to assume rounding mode can change dynamically"), cl::init(false)); CGBINDOPT(EnableHonorSignDependentRoundingFPMath); static cl::opt FloatABIForCalls( "float-abi", cl::desc("Choose float ABI type"), cl::init(FloatABI::Default), cl::values(clEnumValN(FloatABI::Default, "default", "Target default float ABI type"), clEnumValN(FloatABI::Soft, "soft", "Soft float ABI (implied by -soft-float)"), clEnumValN(FloatABI::Hard, "hard", "Hard float ABI (uses FP registers)"))); CGBINDOPT(FloatABIForCalls); static cl::opt FuseFPOps( "fp-contract", cl::desc("Enable aggressive formation of fused FP ops"), cl::init(FPOpFusion::Standard), cl::values( clEnumValN(FPOpFusion::Fast, "fast", "Fuse FP ops whenever profitable"), clEnumValN(FPOpFusion::Standard, "on", "Only fuse 'blessed' FP ops."), clEnumValN(FPOpFusion::Strict, "off", "Only fuse FP ops when the result won't be affected."))); CGBINDOPT(FuseFPOps); static cl::opt DontPlaceZerosInBSS( "nozero-initialized-in-bss", cl::desc("Don't place zero-initialized symbols into bss section"), cl::init(false)); CGBINDOPT(DontPlaceZerosInBSS); static cl::opt EnableGuaranteedTailCallOpt( "tailcallopt", cl::desc( "Turn fastcc calls into tail calls by (potentially) changing ABI."), cl::init(false)); CGBINDOPT(EnableGuaranteedTailCallOpt); static cl::opt DisableTailCalls( "disable-tail-calls", cl::desc("Never emit tail calls"), cl::init(false)); CGBINDOPT(DisableTailCalls); static cl::opt StackSymbolOrdering( "stack-symbol-ordering", cl::desc("Order local stack symbols."), cl::init(true)); CGBINDOPT(StackSymbolOrdering); static cl::opt OverrideStackAlignment( "stack-alignment", cl::desc("Override default stack alignment"), cl::init(0)); CGBINDOPT(OverrideStackAlignment); static cl::opt StackRealign( "stackrealign", cl::desc("Force align the stack to the minimum alignment"), cl::init(false)); CGBINDOPT(StackRealign); static cl::opt TrapFuncName( "trap-func", cl::Hidden, cl::desc("Emit a call to trap function rather than a trap instruction"), cl::init("")); CGBINDOPT(TrapFuncName); static cl::opt UseCtors("use-ctors", cl::desc("Use .ctors instead of .init_array."), cl::init(false)); CGBINDOPT(UseCtors); static cl::opt RelaxELFRelocations( "relax-elf-relocations", cl::desc( "Emit GOTPCRELX/REX_GOTPCRELX instead of GOTPCREL on x86-64 ELF"), cl::init(false)); CGBINDOPT(RelaxELFRelocations); static cl::opt DataSections( "data-sections", cl::desc("Emit data into separate sections"), cl::init(false)); CGBINDOPT(DataSections); static cl::opt FunctionSections( "function-sections", cl::desc("Emit functions into separate sections"), cl::init(false)); CGBINDOPT(FunctionSections); static cl::opt BBSections( "basicblock-sections", cl::desc("Emit basic blocks into separate sections"), cl::value_desc("all | | labels | none"), cl::init("none")); CGBINDOPT(BBSections); static cl::opt TLSSize( "tls-size", cl::desc("Bit size of immediate TLS offsets"), cl::init(0)); CGBINDOPT(TLSSize); static cl::opt EmulatedTLS( "emulated-tls", cl::desc("Use emulated TLS model"), cl::init(false)); CGBINDOPT(EmulatedTLS); static cl::opt UniqueSectionNames( "unique-section-names", cl::desc("Give unique names to every section"), cl::init(true)); CGBINDOPT(UniqueSectionNames); static cl::opt UniqueBasicBlockSectionNames( "unique-bb-section-names", cl::desc("Give unique names to every basic block section"), cl::init(false)); CGBINDOPT(UniqueBasicBlockSectionNames); static cl::opt EABIVersion( "meabi", cl::desc("Set EABI type (default depends on triple):"), cl::init(EABI::Default), cl::values( clEnumValN(EABI::Default, "default", "Triple default EABI version"), clEnumValN(EABI::EABI4, "4", "EABI version 4"), clEnumValN(EABI::EABI5, "5", "EABI version 5"), clEnumValN(EABI::GNU, "gnu", "EABI GNU"))); CGBINDOPT(EABIVersion); static cl::opt DebuggerTuningOpt( "debugger-tune", cl::desc("Tune debug info for a particular debugger"), cl::init(DebuggerKind::Default), cl::values( clEnumValN(DebuggerKind::GDB, "gdb", "gdb"), clEnumValN(DebuggerKind::LLDB, "lldb", "lldb"), clEnumValN(DebuggerKind::SCE, "sce", "SCE targets (e.g. PS4)"))); CGBINDOPT(DebuggerTuningOpt); static cl::opt EnableStackSizeSection( "stack-size-section", cl::desc("Emit a section containing stack size metadata"), cl::init(false)); CGBINDOPT(EnableStackSizeSection); static cl::opt EnableAddrsig( "addrsig", cl::desc("Emit an address-significance table"), cl::init(false)); CGBINDOPT(EnableAddrsig); static cl::opt EmitCallSiteInfo( "emit-call-site-info", cl::desc( "Emit call site debug information, if debug information is enabled."), cl::init(false)); CGBINDOPT(EmitCallSiteInfo); static cl::opt EnableDebugEntryValues( "debug-entry-values", cl::desc("Enable debug info for the debug entry values."), cl::init(false)); CGBINDOPT(EnableDebugEntryValues); static cl::opt ForceDwarfFrameSection( "force-dwarf-frame-section", cl::desc("Always emit a debug frame section."), cl::init(false)); CGBINDOPT(ForceDwarfFrameSection); static cl::opt XRayOmitFunctionIndex( "no-xray-index", cl::desc("Don't emit xray_fn_idx section"), cl::init(false)); CGBINDOPT(XRayOmitFunctionIndex); #undef CGBINDOPT mc::RegisterMCTargetOptionsFlags(); } llvm::BasicBlockSection codegen::getBBSectionsMode(llvm::TargetOptions &Options) { if (getBBSections() == "all") return BasicBlockSection::All; else if (getBBSections() == "labels") return BasicBlockSection::Labels; else if (getBBSections() == "none") return BasicBlockSection::None; else { ErrorOr> MBOrErr = MemoryBuffer::getFile(getBBSections()); if (!MBOrErr) { errs() << "Error loading basic block sections function list file: " << MBOrErr.getError().message() << "\n"; } else { Options.BBSectionsFuncListBuf = std::move(*MBOrErr); } return BasicBlockSection::List; } } // Common utility function tightly tied to the options listed here. Initializes // a TargetOptions object with CodeGen flags and returns it. TargetOptions codegen::InitTargetOptionsFromCodeGenFlags() { TargetOptions Options; Options.AllowFPOpFusion = getFuseFPOps(); Options.UnsafeFPMath = getEnableUnsafeFPMath(); Options.NoInfsFPMath = getEnableNoInfsFPMath(); Options.NoNaNsFPMath = getEnableNoNaNsFPMath(); Options.NoSignedZerosFPMath = getEnableNoSignedZerosFPMath(); Options.NoTrappingFPMath = getEnableNoTrappingFPMath(); DenormalMode::DenormalModeKind DenormKind = getDenormalFPMath(); // FIXME: Should have separate input and output flags Options.setFPDenormalMode(DenormalMode(DenormKind, DenormKind)); Options.HonorSignDependentRoundingFPMathOption = getEnableHonorSignDependentRoundingFPMath(); if (getFloatABIForCalls() != FloatABI::Default) Options.FloatABIType = getFloatABIForCalls(); Options.NoZerosInBSS = getDontPlaceZerosInBSS(); Options.GuaranteedTailCallOpt = getEnableGuaranteedTailCallOpt(); Options.StackAlignmentOverride = getOverrideStackAlignment(); Options.StackSymbolOrdering = getStackSymbolOrdering(); Options.UseInitArray = !getUseCtors(); Options.RelaxELFRelocations = getRelaxELFRelocations(); Options.DataSections = getDataSections(); Options.FunctionSections = getFunctionSections(); Options.BBSections = getBBSectionsMode(Options); Options.UniqueSectionNames = getUniqueSectionNames(); Options.UniqueBasicBlockSectionNames = getUniqueBasicBlockSectionNames(); Options.TLSSize = getTLSSize(); Options.EmulatedTLS = getEmulatedTLS(); Options.ExplicitEmulatedTLS = EmulatedTLSView->getNumOccurrences() > 0; Options.ExceptionModel = getExceptionModel(); Options.EmitStackSizeSection = getEnableStackSizeSection(); Options.EmitAddrsig = getEnableAddrsig(); Options.EmitCallSiteInfo = getEmitCallSiteInfo(); Options.EnableDebugEntryValues = getEnableDebugEntryValues(); Options.ForceDwarfFrameSection = getForceDwarfFrameSection(); Options.XRayOmitFunctionIndex = getXRayOmitFunctionIndex(); Options.MCOptions = mc::InitMCTargetOptionsFromFlags(); Options.ThreadModel = getThreadModel(); Options.EABIVersion = getEABIVersion(); Options.DebuggerTuning = getDebuggerTuningOpt(); return Options; } std::string codegen::getCPUStr() { // If user asked for the 'native' CPU, autodetect here. If autodection fails, // this will set the CPU to an empty string which tells the target to // pick a basic default. if (getMCPU() == "native") return std::string(sys::getHostCPUName()); return getMCPU(); } std::string codegen::getFeaturesStr() { SubtargetFeatures Features; // If user asked for the 'native' CPU, we need to autodetect features. // This is necessary for x86 where the CPU might not support all the // features the autodetected CPU name lists in the target. For example, // not all Sandybridge processors support AVX. if (getMCPU() == "native") { StringMap HostFeatures; if (sys::getHostCPUFeatures(HostFeatures)) for (auto &F : HostFeatures) Features.AddFeature(F.first(), F.second); } for (auto const &MAttr : getMAttrs()) Features.AddFeature(MAttr); return Features.getString(); } std::vector codegen::getFeatureList() { SubtargetFeatures Features; // If user asked for the 'native' CPU, we need to autodetect features. // This is necessary for x86 where the CPU might not support all the // features the autodetected CPU name lists in the target. For example, // not all Sandybridge processors support AVX. if (getMCPU() == "native") { StringMap HostFeatures; if (sys::getHostCPUFeatures(HostFeatures)) for (auto &F : HostFeatures) Features.AddFeature(F.first(), F.second); } for (auto const &MAttr : getMAttrs()) Features.AddFeature(MAttr); return Features.getFeatures(); } void codegen::renderBoolStringAttr(AttrBuilder &B, StringRef Name, bool Val) { B.addAttribute(Name, Val ? "true" : "false"); } #define HANDLE_BOOL_ATTR(CL, AttrName) \ do { \ if (CL->getNumOccurrences() > 0 && !F.hasFnAttribute(AttrName)) \ renderBoolStringAttr(NewAttrs, AttrName, *CL); \ } while (0) /// Set function attributes of function \p F based on CPU, Features, and command /// line flags. void codegen::setFunctionAttributes(StringRef CPU, StringRef Features, Function &F) { auto &Ctx = F.getContext(); AttributeList Attrs = F.getAttributes(); AttrBuilder NewAttrs; if (!CPU.empty() && !F.hasFnAttribute("target-cpu")) NewAttrs.addAttribute("target-cpu", CPU); if (!Features.empty()) { // Append the command line features to any that are already on the function. StringRef OldFeatures = F.getFnAttribute("target-features").getValueAsString(); if (OldFeatures.empty()) NewAttrs.addAttribute("target-features", Features); else { SmallString<256> Appended(OldFeatures); Appended.push_back(','); Appended.append(Features); NewAttrs.addAttribute("target-features", Appended); } } if (FramePointerUsageView->getNumOccurrences() > 0 && !F.hasFnAttribute("frame-pointer")) { if (getFramePointerUsage() == FramePointer::All) NewAttrs.addAttribute("frame-pointer", "all"); else if (getFramePointerUsage() == FramePointer::NonLeaf) NewAttrs.addAttribute("frame-pointer", "non-leaf"); else if (getFramePointerUsage() == FramePointer::None) NewAttrs.addAttribute("frame-pointer", "none"); } if (DisableTailCallsView->getNumOccurrences() > 0) NewAttrs.addAttribute("disable-tail-calls", toStringRef(getDisableTailCalls())); if (getStackRealign()) NewAttrs.addAttribute("stackrealign"); HANDLE_BOOL_ATTR(EnableUnsafeFPMathView, "unsafe-fp-math"); HANDLE_BOOL_ATTR(EnableNoInfsFPMathView, "no-infs-fp-math"); HANDLE_BOOL_ATTR(EnableNoNaNsFPMathView, "no-nans-fp-math"); HANDLE_BOOL_ATTR(EnableNoSignedZerosFPMathView, "no-signed-zeros-fp-math"); if (DenormalFPMathView->getNumOccurrences() > 0 && !F.hasFnAttribute("denormal-fp-math")) { DenormalMode::DenormalModeKind DenormKind = getDenormalFPMath(); // FIXME: Command line flag should expose separate input/output modes. NewAttrs.addAttribute("denormal-fp-math", DenormalMode(DenormKind, DenormKind).str()); } if (DenormalFP32MathView->getNumOccurrences() > 0 && !F.hasFnAttribute("denormal-fp-math-f32")) { // FIXME: Command line flag should expose separate input/output modes. DenormalMode::DenormalModeKind DenormKind = getDenormalFP32Math(); NewAttrs.addAttribute( "denormal-fp-math-f32", DenormalMode(DenormKind, DenormKind).str()); } if (TrapFuncNameView->getNumOccurrences() > 0) for (auto &B : F) for (auto &I : B) if (auto *Call = dyn_cast(&I)) if (const auto *F = Call->getCalledFunction()) if (F->getIntrinsicID() == Intrinsic::debugtrap || F->getIntrinsicID() == Intrinsic::trap) Call->addAttribute( AttributeList::FunctionIndex, Attribute::get(Ctx, "trap-func-name", getTrapFuncName())); // Let NewAttrs override Attrs. F.setAttributes( Attrs.addAttributes(Ctx, AttributeList::FunctionIndex, NewAttrs)); } /// Set function attributes of functions in Module M based on CPU, /// Features, and command line flags. void codegen::setFunctionAttributes(StringRef CPU, StringRef Features, Module &M) { for (Function &F : M) setFunctionAttributes(CPU, Features, F); }