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