lib/Target/X86/X86AsmPrinter.h

   1 //===-- X86AsmPrinter.h - X86 implementation of AsmPrinter ------*- C++ -*-===//
   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
  10 #ifndef LLVM_LIB_TARGET_X86_X86ASMPRINTER_H
  11 #define LLVM_LIB_TARGET_X86_X86ASMPRINTER_H
  12
  13 #include "X86Subtarget.h"
  14 #include "llvm/CodeGen/AsmPrinter.h"
  15 #include "llvm/CodeGen/FaultMaps.h"
  16 #include "llvm/CodeGen/StackMaps.h"
  17 #include "llvm/Target/TargetMachine.h"
  18
  19 // Implemented in X86MCInstLower.cpp
  20 namespace {
  21   class X86MCInstLower;
  22 }
  23
  24 namespace llvm {
  25 class MCStreamer;
  26 class MCSymbol;
  27
  28 class LLVM_LIBRARY_VISIBILITY X86AsmPrinter : public AsmPrinter {
  29   const X86Subtarget *Subtarget;
  30   StackMaps SM;
  31   FaultMaps FM;
  32
  33   void GenerateExportDirective(const MCSymbol *Sym, bool IsData);
  34
  35   // This utility class tracks the length of a stackmap instruction's 'shadow'.
  36   // It is used by the X86AsmPrinter to ensure that the stackmap shadow
  37   // invariants (i.e. no other stackmaps, patchpoints, or control flow within
  38   // the shadow) are met, while outputting a minimal number of NOPs for padding.
  39   //
  40   // To minimise the number of NOPs used, the shadow tracker counts the number
  41   // of instruction bytes output since the last stackmap. Only if there are too
  42   // few instruction bytes to cover the shadow are NOPs used for padding.
  43   class StackMapShadowTracker {
  44   public:
  45     StackMapShadowTracker(TargetMachine &TM);
  46     ~StackMapShadowTracker();
  47     void startFunction(MachineFunction &MF);
  48     void count(MCInst &Inst, const MCSubtargetInfo &STI);
  49
  50     // Called to signal the start of a shadow of RequiredSize bytes.
  51     void reset(unsigned RequiredSize) {
  52       RequiredShadowSize = RequiredSize;
  53       CurrentShadowSize = 0;
  54       InShadow = true;
  55     }
  56
  57     // Called before every stackmap/patchpoint, and at the end of basic blocks,
  58     // to emit any necessary padding-NOPs.
  59     void emitShadowPadding(MCStreamer &OutStreamer, const MCSubtargetInfo &STI);
  60   private:
  61     TargetMachine &TM;
  62     const MachineFunction *MF;
  63     std::unique_ptr<MCCodeEmitter> CodeEmitter;
  64     bool InShadow;
  65
  66     // RequiredShadowSize holds the length of the shadow specified in the most
  67     // recently encountered STACKMAP instruction.
  68     // CurrentShadowSize counts the number of bytes encoded since the most
  69     // recently encountered STACKMAP, stopping when that number is greater than
  70     // or equal to RequiredShadowSize.
  71     unsigned RequiredShadowSize, CurrentShadowSize;
  72   };
  73
  74   StackMapShadowTracker SMShadowTracker;
  75
  76   // All instructions emitted by the X86AsmPrinter should use this helper
  77   // method.
  78   //
  79   // This helper function invokes the SMShadowTracker on each instruction before
  80   // outputting it to the OutStream. This allows the shadow tracker to minimise
  81   // the number of NOPs used for stackmap padding.
  82   void EmitAndCountInstruction(MCInst &Inst);
  83
  84   void InsertStackMapShadows(MachineFunction &MF);
  85   void LowerSTACKMAP(const MachineInstr &MI);
  86   void LowerPATCHPOINT(const MachineInstr &MI, X86MCInstLower &MCIL);
  87   void LowerSTATEPOINT(const MachineInstr &MI, X86MCInstLower &MCIL);
  88   void LowerFAULTING_LOAD_OP(const MachineInstr &MI, X86MCInstLower &MCIL);
  89
  90   void LowerTlsAddr(X86MCInstLower &MCInstLowering, const MachineInstr &MI);
  91
  92  public:
  93    explicit X86AsmPrinter(TargetMachine &TM,
  94                           std::unique_ptr<MCStreamer> Streamer)
  95        : AsmPrinter(TM, std::move(Streamer)), SM(*this), FM(*this),
  96          SMShadowTracker(TM) {}
  97
  98   const char *getPassName() const override {
  99     return "X86 Assembly / Object Emitter";
 100   }
 101
 102   const X86Subtarget &getSubtarget() const { return *Subtarget; }
 103
 104   void EmitStartOfAsmFile(Module &M) override;
 105
 106   void EmitEndOfAsmFile(Module &M) override;
 107
 108   void EmitInstruction(const MachineInstr *MI) override;
 109
 110   void EmitBasicBlockEnd(const MachineBasicBlock &MBB) override {
 111     SMShadowTracker.emitShadowPadding(*OutStreamer, getSubtargetInfo());
 112   }
 113
 114   bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 115                        unsigned AsmVariant, const char *ExtraCode,
 116                        raw_ostream &OS) override;
 117   bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
 118                              unsigned AsmVariant, const char *ExtraCode,
 119                              raw_ostream &OS) override;
 120
 121   /// \brief Return the symbol for the specified constant pool entry.
 122   MCSymbol *GetCPISymbol(unsigned CPID) const override;
 123
 124   bool doInitialization(Module &M) override {
 125     SMShadowTracker.reset(0);
 126     SM.reset();
 127     return AsmPrinter::doInitialization(M);
 128   }
 129
 130   bool runOnMachineFunction(MachineFunction &F) override;
 131 };
 132
 133 } // end namespace llvm
 134
 135 #endif