include/llvm/CodeGen/MachineCodeForInstruction.h

   1 //===-- llvm/CodeGen/MachineCodeForInstruction.h ----------------*- C++ -*-===//
   2 //
   3 // Representation of the sequence of machine instructions created for a single
   4 // VM instruction.  Additionally records information about hidden and implicit
   5 // values used by the machine instructions: about hidden values used by the
   6 // machine instructions:
   7 //
   8 // "Temporary values" are intermediate values used in the machine instruction
   9 // sequence, but not in the VM instruction Note that such values should be
  10 // treated as pure SSA values with no interpretation of their operands (i.e., as
  11 // a TmpInstruction object which actually represents such a value).
  12 //
  13 // (2) "Implicit uses" are values used in the VM instruction but not in
  14 //     the machine instruction sequence
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_CODEGEN_MACHINECODE_FOR_INSTRUCTION_H
  19 #define LLVM_CODEGEN_MACHINECODE_FOR_INSTRUCTION_H
  20
  21 #include "llvm/Annotation.h"
  22 #include <vector>
  23 class MachineInstr;
  24 class Instruction;
  25 class Value;
  26
  27 extern AnnotationID MCFI_AID;
  28
  29 class MachineCodeForInstruction : public Annotation {
  30   std::vector<Value*> tempVec;         // used by m/c instr but not VM instr
  31   std::vector<MachineInstr*> Contents;
  32 public:
  33   MachineCodeForInstruction() : Annotation(MCFI_AID) {}
  34   ~MachineCodeForInstruction();
  35
  36   static MachineCodeForInstruction &get(const Instruction *I) {
  37     assert(I != NULL);
  38     return *(MachineCodeForInstruction*)I->getOrCreateAnnotation(MCFI_AID);
  39   }
  40   static void destroy(const Instruction *I) {
  41     I->deleteAnnotation(MCFI_AID);
  42   }
  43
  44   // Access to underlying machine instructions...
  45   typedef std::vector<MachineInstr*>::iterator iterator;
  46   typedef std::vector<MachineInstr*>::const_iterator const_iterator;
  47
  48   unsigned size() const { return Contents.size(); }
  49   bool empty() const { return Contents.empty(); }
  50   MachineInstr *front() const { return Contents.front(); }
  51   MachineInstr *back() const { return Contents.back(); }
  52   MachineInstr *&operator[](unsigned i) { return Contents[i]; }
  53   MachineInstr *operator[](unsigned i) const { return Contents[i]; }
  54   void pop_back() { Contents.pop_back(); }
  55
  56   iterator begin() { return Contents.begin(); }
  57   iterator end()   { return Contents.end(); }
  58   const_iterator begin() const { return Contents.begin(); }
  59   const_iterator end()   const { return Contents.end(); }
  60
  61   template<class InIt>
  62   void insert(iterator where, InIt first, InIt last) {
  63     Contents.insert(where, first, last);
  64   }
  65   iterator erase(iterator where) { return Contents.erase(where); }
  66   iterator erase(iterator s, iterator e) { return Contents.erase(s, e); }
  67
  68
  69   // dropAllReferences() - This function drops all references within
  70   // temporary (hidden) instructions created in implementing the original
  71   // VM intruction.  This ensures there are no remaining "uses" within
  72   // these hidden instructions, before the values of a method are freed.
  73   //
  74   void dropAllReferences();
  75
  76   const std::vector<Value*> &getTempValues() const { return tempVec; }
  77         std::vector<Value*> &getTempValues()       { return tempVec; }
  78
  79   MachineCodeForInstruction &addTemp(Value *tmp) {
  80     tempVec.push_back(tmp);
  81     return *this;
  82   }
  83 };
  84
  85 #endif