MIR Serialization: Initial serialization of stack objects.
[oota-llvm.git] / include / llvm / CodeGen / MIRYamlMapping.h
1 //===- MIRYAMLMapping.h - Describes the mapping between MIR and YAML ------===//
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 // The MIR serialization library is currently a work in progress. It can't
11 // serialize machine functions at this time.
12 //
13 // This file implements the mapping between various MIR data structures and
14 // their corresponding YAML representation.
15 //
16 //===----------------------------------------------------------------------===//
17
18 #ifndef LLVM_LIB_CODEGEN_MIRYAMLMAPPING_H
19 #define LLVM_LIB_CODEGEN_MIRYAMLMAPPING_H
20
21 #include "llvm/ADT/StringRef.h"
22 #include "llvm/Support/YAMLTraits.h"
23 #include <vector>
24
25 namespace llvm {
26 namespace yaml {
27
28 /// A wrapper around std::string which contains a source range that's being
29 /// set during parsing.
30 struct StringValue {
31   std::string Value;
32   SMRange SourceRange;
33
34   StringValue() {}
35   StringValue(std::string Value) : Value(std::move(Value)) {}
36
37   bool operator==(const StringValue &Other) const {
38     return Value == Other.Value;
39   }
40 };
41
42 template <> struct ScalarTraits<StringValue> {
43   static void output(const StringValue &S, void *, llvm::raw_ostream &OS) {
44     OS << S.Value;
45   }
46
47   static StringRef input(StringRef Scalar, void *Ctx, StringValue &S) {
48     S.Value = Scalar.str();
49     if (const auto *Node =
50             reinterpret_cast<yaml::Input *>(Ctx)->getCurrentNode())
51       S.SourceRange = Node->getSourceRange();
52     return "";
53   }
54
55   static bool mustQuote(StringRef Scalar) { return needsQuotes(Scalar); }
56 };
57
58 struct FlowStringValue : StringValue {
59   FlowStringValue() {}
60   FlowStringValue(std::string Value) : StringValue(Value) {}
61 };
62
63 template <> struct ScalarTraits<FlowStringValue> {
64   static void output(const FlowStringValue &S, void *, llvm::raw_ostream &OS) {
65     return ScalarTraits<StringValue>::output(S, nullptr, OS);
66   }
67
68   static StringRef input(StringRef Scalar, void *Ctx, FlowStringValue &S) {
69     return ScalarTraits<StringValue>::input(Scalar, Ctx, S);
70   }
71
72   static bool mustQuote(StringRef Scalar) { return needsQuotes(Scalar); }
73 };
74
75 } // end namespace yaml
76 } // end namespace llvm
77
78 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::yaml::StringValue)
79 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(llvm::yaml::FlowStringValue)
80
81 namespace llvm {
82 namespace yaml {
83
84 struct VirtualRegisterDefinition {
85   unsigned ID;
86   StringValue Class;
87   // TODO: Serialize the virtual register hints.
88 };
89
90 template <> struct MappingTraits<VirtualRegisterDefinition> {
91   static void mapping(IO &YamlIO, VirtualRegisterDefinition &Reg) {
92     YamlIO.mapRequired("id", Reg.ID);
93     YamlIO.mapRequired("class", Reg.Class);
94   }
95
96   static const bool flow = true;
97 };
98
99 struct MachineBasicBlock {
100   unsigned ID;
101   StringValue Name;
102   unsigned Alignment = 0;
103   bool IsLandingPad = false;
104   bool AddressTaken = false;
105   // TODO: Serialize the successor weights and liveins.
106   std::vector<FlowStringValue> Successors;
107
108   std::vector<StringValue> Instructions;
109 };
110
111 template <> struct MappingTraits<MachineBasicBlock> {
112   static void mapping(IO &YamlIO, MachineBasicBlock &MBB) {
113     YamlIO.mapRequired("id", MBB.ID);
114     YamlIO.mapOptional("name", MBB.Name,
115                        StringValue()); // Don't print out an empty name.
116     YamlIO.mapOptional("alignment", MBB.Alignment);
117     YamlIO.mapOptional("isLandingPad", MBB.IsLandingPad);
118     YamlIO.mapOptional("addressTaken", MBB.AddressTaken);
119     YamlIO.mapOptional("successors", MBB.Successors);
120     YamlIO.mapOptional("instructions", MBB.Instructions);
121   }
122 };
123
124 /// Serializable representation of stack object from the MachineFrameInfo class.
125 ///
126 /// The flags 'isImmutable' and 'isAliased' aren't serialized, as they are
127 /// determined by the object's type and frame information flags.
128 /// Dead stack objects aren't serialized.
129 ///
130 /// TODO: Determine isPreallocated flag by mapping between objects and local
131 /// objects (Serialize local objects).
132 /// TODO: Serialize variable sized and fixed stack objects.
133 struct MachineStackObject {
134   enum ObjectType { DefaultType, SpillSlot };
135   // TODO: Serialize LLVM alloca reference.
136   unsigned ID;
137   ObjectType Type = DefaultType;
138   int64_t Offset = 0;
139   uint64_t Size = 0;
140   unsigned Alignment = 0;
141 };
142
143 template <> struct ScalarEnumerationTraits<MachineStackObject::ObjectType> {
144   static void enumeration(yaml::IO &IO, MachineStackObject::ObjectType &Type) {
145     IO.enumCase(Type, "default", MachineStackObject::DefaultType);
146     IO.enumCase(Type, "spill-slot", MachineStackObject::SpillSlot);
147   }
148 };
149
150 template <> struct MappingTraits<MachineStackObject> {
151   static void mapping(yaml::IO &YamlIO, MachineStackObject &Object) {
152     YamlIO.mapRequired("id", Object.ID);
153     YamlIO.mapOptional(
154         "type", Object.Type,
155         MachineStackObject::DefaultType); // Don't print the default type.
156     YamlIO.mapOptional("offset", Object.Offset);
157     YamlIO.mapRequired("size", Object.Size);
158     YamlIO.mapOptional("alignment", Object.Alignment);
159   }
160
161   static const bool flow = true;
162 };
163
164 } // end namespace yaml
165 } // end namespace llvm
166
167 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::yaml::VirtualRegisterDefinition)
168 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::yaml::MachineBasicBlock)
169 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::yaml::MachineStackObject)
170
171 namespace llvm {
172 namespace yaml {
173
174 /// Serializable representation of MachineFrameInfo.
175 ///
176 /// Doesn't serialize attributes like 'StackAlignment', 'IsStackRealignable' and
177 /// 'RealignOption' as they are determined by the target and LLVM function
178 /// attributes.
179 /// It also doesn't serialize attributes like 'NumFixedObject' and
180 /// 'HasVarSizedObjects' as they are determined by the frame objects themselves.
181 struct MachineFrameInfo {
182   bool IsFrameAddressTaken = false;
183   bool IsReturnAddressTaken = false;
184   bool HasStackMap = false;
185   bool HasPatchPoint = false;
186   uint64_t StackSize = 0;
187   int OffsetAdjustment = 0;
188   unsigned MaxAlignment = 0;
189   bool AdjustsStack = false;
190   bool HasCalls = false;
191   // TODO: Serialize StackProtectorIdx and FunctionContextIdx
192   unsigned MaxCallFrameSize = 0;
193   // TODO: Serialize callee saved info.
194   // TODO: Serialize local frame objects.
195   bool HasOpaqueSPAdjustment = false;
196   bool HasVAStart = false;
197   bool HasMustTailInVarArgFunc = false;
198   // TODO: Serialize save and restore MBB references.
199 };
200
201 template <> struct MappingTraits<MachineFrameInfo> {
202   static void mapping(IO &YamlIO, MachineFrameInfo &MFI) {
203     YamlIO.mapOptional("isFrameAddressTaken", MFI.IsFrameAddressTaken);
204     YamlIO.mapOptional("isReturnAddressTaken", MFI.IsReturnAddressTaken);
205     YamlIO.mapOptional("hasStackMap", MFI.HasStackMap);
206     YamlIO.mapOptional("hasPatchPoint", MFI.HasPatchPoint);
207     YamlIO.mapOptional("stackSize", MFI.StackSize);
208     YamlIO.mapOptional("offsetAdjustment", MFI.OffsetAdjustment);
209     YamlIO.mapOptional("maxAlignment", MFI.MaxAlignment);
210     YamlIO.mapOptional("adjustsStack", MFI.AdjustsStack);
211     YamlIO.mapOptional("hasCalls", MFI.HasCalls);
212     YamlIO.mapOptional("maxCallFrameSize", MFI.MaxCallFrameSize);
213     YamlIO.mapOptional("hasOpaqueSPAdjustment", MFI.HasOpaqueSPAdjustment);
214     YamlIO.mapOptional("hasVAStart", MFI.HasVAStart);
215     YamlIO.mapOptional("hasMustTailInVarArgFunc", MFI.HasMustTailInVarArgFunc);
216   }
217 };
218
219 struct MachineFunction {
220   StringRef Name;
221   unsigned Alignment = 0;
222   bool ExposesReturnsTwice = false;
223   bool HasInlineAsm = false;
224   // Register information
225   bool IsSSA = false;
226   bool TracksRegLiveness = false;
227   bool TracksSubRegLiveness = false;
228   std::vector<VirtualRegisterDefinition> VirtualRegisters;
229   // TODO: Serialize the various register masks.
230   // TODO: Serialize live in registers.
231   // Frame information
232   MachineFrameInfo FrameInfo;
233   std::vector<MachineStackObject> StackObjects;
234
235   std::vector<MachineBasicBlock> BasicBlocks;
236 };
237
238 template <> struct MappingTraits<MachineFunction> {
239   static void mapping(IO &YamlIO, MachineFunction &MF) {
240     YamlIO.mapRequired("name", MF.Name);
241     YamlIO.mapOptional("alignment", MF.Alignment);
242     YamlIO.mapOptional("exposesReturnsTwice", MF.ExposesReturnsTwice);
243     YamlIO.mapOptional("hasInlineAsm", MF.HasInlineAsm);
244     YamlIO.mapOptional("isSSA", MF.IsSSA);
245     YamlIO.mapOptional("tracksRegLiveness", MF.TracksRegLiveness);
246     YamlIO.mapOptional("tracksSubRegLiveness", MF.TracksSubRegLiveness);
247     YamlIO.mapOptional("registers", MF.VirtualRegisters);
248     YamlIO.mapOptional("frameInfo", MF.FrameInfo);
249     YamlIO.mapOptional("stack", MF.StackObjects);
250     YamlIO.mapOptional("body", MF.BasicBlocks);
251   }
252 };
253
254 } // end namespace yaml
255 } // end namespace llvm
256
257 #endif