EIC code displayed by LXR master/​include/​llvm/​MC/​MCInstPrinter.h	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-05-10 08:44:13

 //===- MCInstPrinter.h - MCInst to target assembly syntax -------*- 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_MCINSTPRINTER_H
 #define LLVM_MC_MCINSTPRINTER_H
 
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/Support/Compiler.h"
 #include "llvm/Support/Format.h"
 #include "llvm/Support/raw_ostream.h"
 #include <cstdint>
 
 namespace llvm {
 
 class MCAsmInfo;
 class MCInst;
 class MCInstrAnalysis;
 class MCInstrInfo;
 class MCOperand;
 class MCRegister;
 class MCRegisterInfo;
 class MCSubtargetInfo;
 class StringRef;
 
 /// Convert `Bytes' to a hex string and output to `OS'
 void dumpBytes(ArrayRef<uint8_t> Bytes, raw_ostream &OS);
 
 namespace HexStyle {
 
 enum Style {
   C,  ///< 0xff
   Asm ///< 0ffh
 };
 
 } // end namespace HexStyle
 
 struct AliasMatchingData;
 
 /// This is an instance of a target assembly language printer that
 /// converts an MCInst to valid target assembly syntax.
 class MCInstPrinter {
 protected:
   /// A stream that comments can be emitted to if desired.  Each comment
   /// must end with a newline.  This will be null if verbose assembly emission
   /// is disabled.
   raw_ostream *CommentStream = nullptr;
   const MCAsmInfo &MAI;
   const MCInstrInfo &MII;
   const MCRegisterInfo &MRI;
   const MCInstrAnalysis *MIA = nullptr;
 
   /// True if we are printing marked up assembly.
   bool UseMarkup = false;
 
   /// True if we are printing colored assembly.
   bool UseColor = false;
 
   /// True if we prefer aliases (e.g. nop) to raw mnemonics.
   bool PrintAliases = true;
 
   /// True if we are printing immediates as hex.
   bool PrintImmHex = false;
 
   /// Which style to use for printing hexadecimal values.
   HexStyle::Style PrintHexStyle = HexStyle::C;
 
   /// If true, a branch immediate (e.g. bl 4) will be printed as a hexadecimal
   /// address (e.g. bl 0x20004). This is useful for a stream disassembler
   /// (llvm-objdump -d).
   bool PrintBranchImmAsAddress = false;
 
   /// If true, symbolize branch target and memory reference operands.
   bool SymbolizeOperands = false;
 
   SmallVector<raw_ostream::Colors, 4> ColorStack{raw_ostream::Colors::RESET};
 
   /// Utility function for printing annotations.
   void printAnnotation(raw_ostream &OS, StringRef Annot);
 
   /// Helper for matching MCInsts to alias patterns when printing instructions.
   const char *matchAliasPatterns(const MCInst *MI, const MCSubtargetInfo *STI,
                                  const AliasMatchingData &M);
 
 public:
   MCInstPrinter(const MCAsmInfo &mai, const MCInstrInfo &mii,
                 const MCRegisterInfo &mri) : MAI(mai), MII(mii), MRI(mri) {}
 
   virtual ~MCInstPrinter();
 
   enum class Markup {
     Immediate,
     Register,
     Target,
     Memory,
   };
 
   class WithMarkup {
   public:
     LLVM_CTOR_NODISCARD WithMarkup(MCInstPrinter &IP, raw_ostream &OS, Markup M,
                                    bool EnableMarkup, bool EnableColor);
     ~WithMarkup();
 
     template <typename T> WithMarkup &operator<<(T &O) {
       OS << O;
       return *this;
     }
 
     template <typename T> WithMarkup &operator<<(const T &O) {
       OS << O;
       return *this;
     }
 
   private:
     MCInstPrinter &IP;
     raw_ostream &OS;
     bool EnableMarkup;
     bool EnableColor;
   };
 
   /// Customize the printer according to a command line option.
   /// @return true if the option is recognized and applied.
   virtual bool applyTargetSpecificCLOption(StringRef Opt) { return false; }
 
   /// Specify a stream to emit comments to.
   void setCommentStream(raw_ostream &OS) { CommentStream = &OS; }
 
   /// Returns a pair containing the mnemonic for \p MI and the number of bits
   /// left for further processing by printInstruction (generated by tablegen).
   virtual std::pair<const char *, uint64_t>
   getMnemonic(const MCInst &MI) const = 0;
 
   /// Print the specified MCInst to the specified raw_ostream.
   ///
   /// \p Address the address of current instruction on most targets, used to
   /// print a PC relative immediate as the target address. On targets where a PC
   /// relative immediate is relative to the next instruction and the length of a
   /// MCInst is difficult to measure (e.g. x86), this is the address of the next
   /// instruction. If Address is 0, the immediate will be printed.
   virtual void printInst(const MCInst *MI, uint64_t Address, StringRef Annot,
                          const MCSubtargetInfo &STI, raw_ostream &OS) = 0;
 
   /// Return the name of the specified opcode enum (e.g. "MOV32ri") or
   /// empty if we can't resolve it.
   StringRef getOpcodeName(unsigned Opcode) const;
 
   /// Print the assembler register name.
   virtual void printRegName(raw_ostream &OS, MCRegister Reg);
 
   bool getUseMarkup() const { return UseMarkup; }
   void setUseMarkup(bool Value) { UseMarkup = Value; }
 
   bool getUseColor() const { return UseColor; }
   void setUseColor(bool Value) { UseColor = Value; }
 
   WithMarkup markup(raw_ostream &OS, Markup M);
 
   bool getPrintImmHex() const { return PrintImmHex; }
   void setPrintImmHex(bool Value) { PrintImmHex = Value; }
 
   void setPrintHexStyle(HexStyle::Style Value) { PrintHexStyle = Value; }
 
   void setPrintBranchImmAsAddress(bool Value) {
     PrintBranchImmAsAddress = Value;
   }
 
   void setSymbolizeOperands(bool Value) { SymbolizeOperands = Value; }
   void setMCInstrAnalysis(const MCInstrAnalysis *Value) { MIA = Value; }
 
   /// Utility function to print immediates in decimal or hex.
   format_object<int64_t> formatImm(int64_t Value) const {
     return PrintImmHex ? formatHex(Value) : formatDec(Value);
   }
 
   /// Utility functions to print decimal/hexadecimal values.
   format_object<int64_t> formatDec(int64_t Value) const;
   format_object<int64_t> formatHex(int64_t Value) const;
   format_object<uint64_t> formatHex(uint64_t Value) const;
 };
 
 /// Map from opcode to pattern list by binary search.
 struct PatternsForOpcode {
   uint32_t Opcode;
   uint16_t PatternStart;
   uint16_t NumPatterns;
 };
 
 /// Data for each alias pattern. Includes feature bits, string, number of
 /// operands, and a variadic list of conditions to check.
 struct AliasPattern {
   uint32_t AsmStrOffset;
   uint32_t AliasCondStart;
   uint8_t NumOperands;
   uint8_t NumConds;
 };
 
 struct AliasPatternCond {
   enum CondKind : uint8_t {
     K_Feature,       // Match only if a feature is enabled.
     K_NegFeature,    // Match only if a feature is disabled.
     K_OrFeature,     // Match only if one of a set of features is enabled.
     K_OrNegFeature,  // Match only if one of a set of features is disabled.
     K_EndOrFeatures, // Note end of list of K_Or(Neg)?Features.
     K_Ignore,        // Match any operand.
     K_Reg,           // Match a specific register.
     K_TiedReg,       // Match another already matched register.
     K_Imm,           // Match a specific immediate.
     K_RegClass,      // Match registers in a class.
     K_Custom,        // Call custom matcher by index.
   };
 
   CondKind Kind;
   uint32_t Value;
 };
 
 /// Tablegenerated data structures needed to match alias patterns.
 struct AliasMatchingData {
   ArrayRef<PatternsForOpcode> OpToPatterns;
   ArrayRef<AliasPattern> Patterns;
   ArrayRef<AliasPatternCond> PatternConds;
   StringRef AsmStrings;
   bool (*ValidateMCOperand)(const MCOperand &MCOp, const MCSubtargetInfo &STI,
                             unsigned PredicateIndex);
 };
 
 } // end namespace llvm
 
 #endif // LLVM_MC_MCINSTPRINTER_H

This page was automatically generated by the 2.3.7 LXR engine. The LXR team