Move annotation to support library
[oota-llvm.git] / lib / Target / SparcV9 / 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 "Support/Annotation.h"
22 #include <vector>
23 class MachineInstr;
24 class Instruction;
25 class Value;
26 class CallArgsDescriptor;
27
28 extern AnnotationID MCFI_AID;
29
30 class MachineCodeForInstruction : public Annotation {
31   std::vector<Value*> tempVec;          // used by m/c instr but not VM instr
32   std::vector<MachineInstr*> Contents;  // the machine instr for this VM instr
33   CallArgsDescriptor* callArgsDesc;     // only used for CALL instructions
34 public:
35   MachineCodeForInstruction() : Annotation(MCFI_AID), callArgsDesc(NULL) {}
36   ~MachineCodeForInstruction();
37   
38   static MachineCodeForInstruction &get(const Instruction *I) {
39     assert(I != NULL);
40     return *(MachineCodeForInstruction*)
41       ((Annotable*)I)->getOrCreateAnnotation(MCFI_AID);
42   }
43   static void destroy(const Instruction *I) {
44     ((Annotable*)I)->deleteAnnotation(MCFI_AID);
45   }
46
47   // Access to underlying machine instructions...
48   typedef std::vector<MachineInstr*>::iterator iterator;
49   typedef std::vector<MachineInstr*>::const_iterator const_iterator;
50
51   unsigned size() const { return Contents.size(); }
52   bool empty() const { return Contents.empty(); }
53   MachineInstr *front() const { return Contents.front(); }
54   MachineInstr *back() const { return Contents.back(); }
55   MachineInstr *&operator[](unsigned i) { return Contents[i]; }
56   MachineInstr *operator[](unsigned i) const { return Contents[i]; }
57   void pop_back() { Contents.pop_back(); }
58
59   iterator begin() { return Contents.begin(); }
60   iterator end()   { return Contents.end(); }
61   const_iterator begin() const { return Contents.begin(); }
62   const_iterator end()   const { return Contents.end(); }
63
64   template<class InIt>
65   void insert(iterator where, InIt first, InIt last) {
66     Contents.insert(where, first, last);
67   }
68   iterator erase(iterator where) { return Contents.erase(where); }
69   iterator erase(iterator s, iterator e) { return Contents.erase(s, e); }
70   
71
72   // dropAllReferences() - This function drops all references within
73   // temporary (hidden) instructions created in implementing the original
74   // VM intruction.  This ensures there are no remaining "uses" within
75   // these hidden instructions, before the values of a method are freed.
76   //
77   void dropAllReferences();
78
79   const std::vector<Value*> &getTempValues() const { return tempVec; }
80         std::vector<Value*> &getTempValues()       { return tempVec; }
81   
82   MachineCodeForInstruction &addTemp(Value *tmp) {
83     tempVec.push_back(tmp);
84     return *this;
85   }
86
87   void setCallArgsDescriptor(CallArgsDescriptor* desc) { callArgsDesc = desc; }
88   CallArgsDescriptor* getCallArgsDescriptor() const    { return callArgsDesc; }
89 };
90
91 #endif