MCTargetOptions.h

Go to the documentation of this file.

//===- MCTargetOptions.h - MC Target Options --------------------*- 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
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_MC_MCTARGETOPTIONS_H
#define LLVM_MC_MCTARGETOPTIONS_H
 
#include "llvm/ADT/ArrayRef.h"
#include "llvm/Support/CodeGen.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/Compression.h"
#include <string>
#include <utility>
#include <vector>
 
namespace llvm {
 
enum class EmitDwarfUnwindType {
  Always,          // Always emit dwarf unwind
  NoCompactUnwind, // Only emit if compact unwind isn't available
  DwarfOnly,       // Force compact unwind to reference DWARF
  Default,         // Default behavior is based on the target
};
 
// For ELF targets, whether to adjust relocations referencing eligible local
// symbols to use section symbols.
enum class RelocSectionSymType {
  All,      // For all eligible local symbols (default)
  Internal, // For .L symbols
  None,     // Never use section symbols
};
 
class StringRef;
namespace cl {
class LibraryOptionsContext;
} // namespace cl
 
class MCTargetOptions {
public:
  enum AsmInstrumentation {
    AsmInstrumentationNone,
    AsmInstrumentationAddress
  };
 
  bool MCRelaxAll : 1;
  bool MCNoExecStack : 1;
  bool MCFatalWarnings : 1;
  bool MCNoWarn : 1;
  bool MCNoDeprecatedWarn : 1;
  bool MCNoTypeCheck : 1;
  bool MCSaveTempLabels : 1;
  bool MCIncrementalLinkerCompatible : 1;
  bool FDPIC : 1;
  bool ShowMCEncoding : 1;
  bool ShowMCInst : 1;
  bool AsmVerbose : 1;
 
  /// Preserve Comments in Assembly.
  bool PreserveAsmComments : 1;
 
  bool Dwarf64 : 1;
 
  // Use CREL relocation format for ELF.
  bool Crel = false;
 
  bool ImplicitMapSyms = false;
 
  /// Use relocations for DWARF cross-section offsets in Mach-O.
  bool MachORelocatableDwarf = false;
 
  // If true, prefer R_X86_64_[REX_]GOTPCRELX to R_X86_64_GOTPCREL on x86-64
  // ELF.
  bool X86RelaxRelocations = true;
 
  bool X86Sse2Avx = false;
 
  // Disable the integrated assembler.
  bool DisableIntegratedAS = false;
 
  // For ELF relocations, controls section symbol conversion.
  RelocSectionSymType RelocSectionSym = RelocSectionSymType::All;
 
  std::optional<unsigned> OutputAsmVariant;
 
  EmitDwarfUnwindType EmitDwarfUnwind;
 
  int DwarfVersion = 0;
 
  /// If greater than 0, overrides the default MCAsmInfo binutils version.
  std::pair<int, int> BinutilsVersion = {0, 0};
 
  enum DwarfDirectory {
    // Force disable
    DisableDwarfDirectory,
    // Force enable, for assemblers that support
    // `.file fileno directory filename' syntax
    EnableDwarfDirectory,
    // Default is based on the target
    DefaultDwarfDirectory
  };
  DwarfDirectory MCUseDwarfDirectory;
 
  // Whether to compress DWARF debug sections.
  DebugCompressionType CompressDebugSections = DebugCompressionType::None;
 
  std::string ABIName;
  std::string AssemblyLanguage;
  std::string SplitDwarfFile;
  std::string AsSecureLogFile;
 
  // Used for codeview debug info. These will be set as compiler path and commandline arguments in LF_BUILDINFO
  std::string Argv0;
  std::string CommandlineArgs;
 
  /// Additional paths to search for `.include` directives when using the
  /// integrated assembler.
  std::vector<std::string> IASSearchPaths;
 
  // InstPrinter options.
  std::vector<std::string> InstPrinterOptions;
 
  // Whether to emit compact-unwind for non-canonical personality
  // functions on Darwins.
  bool EmitCompactUnwindNonCanonical : 1;
 
  // Whether to emit SFrame unwind sections.
  bool EmitSFrameUnwind : 1;
 
  // Whether or not to use full register names on PowerPC.
  bool PPCUseFullRegisterNames : 1;
 
  // Force 8-byte (sdata8) pointer encodings for ELF exception-handling.
  // On x86_64 this affects the .eh_frame FDE CFI plus the personality, LSDA,
  // and TType encodings; on AArch64/PPC64 only the FDE CFI encoding changes
  // (personality/LSDA/TType already default to sdata8).
  bool LargeEHEncoding = false;
 
  // The library options of the compilation, usually its LLVMContext's.
  // TODO: Make it non-null once every tool sets it. Null means the global
  // values.
  const cl::LibraryOptionsContext *LibraryOptions = nullptr;
 
  LLVM_ABI MCTargetOptions();
 
  /// Parse a binutils version string ("major[.minor]" or "none") into a
  /// (major, minor) pair. "none" maps to {INT_MAX, INT_MAX}.
  LLVM_ABI static std::pair<int, int> parseBinutilsVersion(StringRef Version);
 
  /// getABIName - If this returns a non-empty string this represents the
  /// textual name of the ABI that we want the backend to use, e.g. o32, or
  /// aapcs-linux.
  LLVM_ABI StringRef getABIName() const;
 
  /// getAssemblyLanguage - If this returns a non-empty string this represents
  /// the textual name of the assembly language that we will use for this
  /// target, e.g. masm.
  LLVM_ABI StringRef getAssemblyLanguage() const;
};
 
} // end namespace llvm
 
#endif // LLVM_MC_MCTARGETOPTIONS_H