1//===- COFFYAML.cpp - COFF YAMLIO implementation --------------------------===//
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// This file defines classes for handling the YAML representation of COFF.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/Object/COFFYAML.h"
15
16#define ECase(X) IO.enumCase(Value, #X, COFF::X);
17namespace llvm {
18
19namespace COFFYAML {
20Section::Section() { memset(&Header, 0, sizeof(COFF::section)); }
21Symbol::Symbol() { memset(&Header, 0, sizeof(COFF::symbol)); }
22Object::Object() { memset(&Header, 0, sizeof(COFF::header)); }
23}
24
25namespace yaml {
26void ScalarEnumerationTraits<COFFYAML::COMDATType>::enumeration(
27    IO &IO, COFFYAML::COMDATType &Value) {
28  IO.enumCase(Value, "0", 0);
29  ECase(IMAGE_COMDAT_SELECT_NODUPLICATES);
30  ECase(IMAGE_COMDAT_SELECT_ANY);
31  ECase(IMAGE_COMDAT_SELECT_SAME_SIZE);
32  ECase(IMAGE_COMDAT_SELECT_EXACT_MATCH);
33  ECase(IMAGE_COMDAT_SELECT_ASSOCIATIVE);
34  ECase(IMAGE_COMDAT_SELECT_LARGEST);
35  ECase(IMAGE_COMDAT_SELECT_NEWEST);
36}
37
38void
39ScalarEnumerationTraits<COFFYAML::WeakExternalCharacteristics>::enumeration(
40    IO &IO, COFFYAML::WeakExternalCharacteristics &Value) {
41  IO.enumCase(Value, "0", 0);
42  ECase(IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY);
43  ECase(IMAGE_WEAK_EXTERN_SEARCH_LIBRARY);
44  ECase(IMAGE_WEAK_EXTERN_SEARCH_ALIAS);
45}
46
47void ScalarEnumerationTraits<COFFYAML::AuxSymbolType>::enumeration(
48    IO &IO, COFFYAML::AuxSymbolType &Value) {
49  ECase(IMAGE_AUX_SYMBOL_TYPE_TOKEN_DEF);
50}
51
52void ScalarEnumerationTraits<COFF::MachineTypes>::enumeration(
53    IO &IO, COFF::MachineTypes &Value) {
54  ECase(IMAGE_FILE_MACHINE_UNKNOWN);
55  ECase(IMAGE_FILE_MACHINE_AM33);
56  ECase(IMAGE_FILE_MACHINE_AMD64);
57  ECase(IMAGE_FILE_MACHINE_ARM);
58  ECase(IMAGE_FILE_MACHINE_ARMNT);
59  ECase(IMAGE_FILE_MACHINE_EBC);
60  ECase(IMAGE_FILE_MACHINE_I386);
61  ECase(IMAGE_FILE_MACHINE_IA64);
62  ECase(IMAGE_FILE_MACHINE_M32R);
63  ECase(IMAGE_FILE_MACHINE_MIPS16);
64  ECase(IMAGE_FILE_MACHINE_MIPSFPU);
65  ECase(IMAGE_FILE_MACHINE_MIPSFPU16);
66  ECase(IMAGE_FILE_MACHINE_POWERPC);
67  ECase(IMAGE_FILE_MACHINE_POWERPCFP);
68  ECase(IMAGE_FILE_MACHINE_R4000);
69  ECase(IMAGE_FILE_MACHINE_SH3);
70  ECase(IMAGE_FILE_MACHINE_SH3DSP);
71  ECase(IMAGE_FILE_MACHINE_SH4);
72  ECase(IMAGE_FILE_MACHINE_SH5);
73  ECase(IMAGE_FILE_MACHINE_THUMB);
74  ECase(IMAGE_FILE_MACHINE_WCEMIPSV2);
75}
76
77void ScalarEnumerationTraits<COFF::SymbolBaseType>::enumeration(
78    IO &IO, COFF::SymbolBaseType &Value) {
79  ECase(IMAGE_SYM_TYPE_NULL);
80  ECase(IMAGE_SYM_TYPE_VOID);
81  ECase(IMAGE_SYM_TYPE_CHAR);
82  ECase(IMAGE_SYM_TYPE_SHORT);
83  ECase(IMAGE_SYM_TYPE_INT);
84  ECase(IMAGE_SYM_TYPE_LONG);
85  ECase(IMAGE_SYM_TYPE_FLOAT);
86  ECase(IMAGE_SYM_TYPE_DOUBLE);
87  ECase(IMAGE_SYM_TYPE_STRUCT);
88  ECase(IMAGE_SYM_TYPE_UNION);
89  ECase(IMAGE_SYM_TYPE_ENUM);
90  ECase(IMAGE_SYM_TYPE_MOE);
91  ECase(IMAGE_SYM_TYPE_BYTE);
92  ECase(IMAGE_SYM_TYPE_WORD);
93  ECase(IMAGE_SYM_TYPE_UINT);
94  ECase(IMAGE_SYM_TYPE_DWORD);
95}
96
97void ScalarEnumerationTraits<COFF::SymbolStorageClass>::enumeration(
98    IO &IO, COFF::SymbolStorageClass &Value) {
99  ECase(IMAGE_SYM_CLASS_END_OF_FUNCTION);
100  ECase(IMAGE_SYM_CLASS_NULL);
101  ECase(IMAGE_SYM_CLASS_AUTOMATIC);
102  ECase(IMAGE_SYM_CLASS_EXTERNAL);
103  ECase(IMAGE_SYM_CLASS_STATIC);
104  ECase(IMAGE_SYM_CLASS_REGISTER);
105  ECase(IMAGE_SYM_CLASS_EXTERNAL_DEF);
106  ECase(IMAGE_SYM_CLASS_LABEL);
107  ECase(IMAGE_SYM_CLASS_UNDEFINED_LABEL);
108  ECase(IMAGE_SYM_CLASS_MEMBER_OF_STRUCT);
109  ECase(IMAGE_SYM_CLASS_ARGUMENT);
110  ECase(IMAGE_SYM_CLASS_STRUCT_TAG);
111  ECase(IMAGE_SYM_CLASS_MEMBER_OF_UNION);
112  ECase(IMAGE_SYM_CLASS_UNION_TAG);
113  ECase(IMAGE_SYM_CLASS_TYPE_DEFINITION);
114  ECase(IMAGE_SYM_CLASS_UNDEFINED_STATIC);
115  ECase(IMAGE_SYM_CLASS_ENUM_TAG);
116  ECase(IMAGE_SYM_CLASS_MEMBER_OF_ENUM);
117  ECase(IMAGE_SYM_CLASS_REGISTER_PARAM);
118  ECase(IMAGE_SYM_CLASS_BIT_FIELD);
119  ECase(IMAGE_SYM_CLASS_BLOCK);
120  ECase(IMAGE_SYM_CLASS_FUNCTION);
121  ECase(IMAGE_SYM_CLASS_END_OF_STRUCT);
122  ECase(IMAGE_SYM_CLASS_FILE);
123  ECase(IMAGE_SYM_CLASS_SECTION);
124  ECase(IMAGE_SYM_CLASS_WEAK_EXTERNAL);
125  ECase(IMAGE_SYM_CLASS_CLR_TOKEN);
126}
127
128void ScalarEnumerationTraits<COFF::SymbolComplexType>::enumeration(
129    IO &IO, COFF::SymbolComplexType &Value) {
130  ECase(IMAGE_SYM_DTYPE_NULL);
131  ECase(IMAGE_SYM_DTYPE_POINTER);
132  ECase(IMAGE_SYM_DTYPE_FUNCTION);
133  ECase(IMAGE_SYM_DTYPE_ARRAY);
134}
135
136void ScalarEnumerationTraits<COFF::RelocationTypeI386>::enumeration(
137    IO &IO, COFF::RelocationTypeI386 &Value) {
138  ECase(IMAGE_REL_I386_ABSOLUTE);
139  ECase(IMAGE_REL_I386_DIR16);
140  ECase(IMAGE_REL_I386_REL16);
141  ECase(IMAGE_REL_I386_DIR32);
142  ECase(IMAGE_REL_I386_DIR32NB);
143  ECase(IMAGE_REL_I386_SEG12);
144  ECase(IMAGE_REL_I386_SECTION);
145  ECase(IMAGE_REL_I386_SECREL);
146  ECase(IMAGE_REL_I386_TOKEN);
147  ECase(IMAGE_REL_I386_SECREL7);
148  ECase(IMAGE_REL_I386_REL32);
149}
150
151void ScalarEnumerationTraits<COFF::RelocationTypeAMD64>::enumeration(
152    IO &IO, COFF::RelocationTypeAMD64 &Value) {
153  ECase(IMAGE_REL_AMD64_ABSOLUTE);
154  ECase(IMAGE_REL_AMD64_ADDR64);
155  ECase(IMAGE_REL_AMD64_ADDR32);
156  ECase(IMAGE_REL_AMD64_ADDR32NB);
157  ECase(IMAGE_REL_AMD64_REL32);
158  ECase(IMAGE_REL_AMD64_REL32_1);
159  ECase(IMAGE_REL_AMD64_REL32_2);
160  ECase(IMAGE_REL_AMD64_REL32_3);
161  ECase(IMAGE_REL_AMD64_REL32_4);
162  ECase(IMAGE_REL_AMD64_REL32_5);
163  ECase(IMAGE_REL_AMD64_SECTION);
164  ECase(IMAGE_REL_AMD64_SECREL);
165  ECase(IMAGE_REL_AMD64_SECREL7);
166  ECase(IMAGE_REL_AMD64_TOKEN);
167  ECase(IMAGE_REL_AMD64_SREL32);
168  ECase(IMAGE_REL_AMD64_PAIR);
169  ECase(IMAGE_REL_AMD64_SSPAN32);
170}
171#undef ECase
172
173#define BCase(X) IO.bitSetCase(Value, #X, COFF::X);
174void ScalarBitSetTraits<COFF::Characteristics>::bitset(
175    IO &IO, COFF::Characteristics &Value) {
176  BCase(IMAGE_FILE_RELOCS_STRIPPED);
177  BCase(IMAGE_FILE_EXECUTABLE_IMAGE);
178  BCase(IMAGE_FILE_LINE_NUMS_STRIPPED);
179  BCase(IMAGE_FILE_LOCAL_SYMS_STRIPPED);
180  BCase(IMAGE_FILE_AGGRESSIVE_WS_TRIM);
181  BCase(IMAGE_FILE_LARGE_ADDRESS_AWARE);
182  BCase(IMAGE_FILE_BYTES_REVERSED_LO);
183  BCase(IMAGE_FILE_32BIT_MACHINE);
184  BCase(IMAGE_FILE_DEBUG_STRIPPED);
185  BCase(IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP);
186  BCase(IMAGE_FILE_NET_RUN_FROM_SWAP);
187  BCase(IMAGE_FILE_SYSTEM);
188  BCase(IMAGE_FILE_DLL);
189  BCase(IMAGE_FILE_UP_SYSTEM_ONLY);
190  BCase(IMAGE_FILE_BYTES_REVERSED_HI);
191}
192
193void ScalarBitSetTraits<COFF::SectionCharacteristics>::bitset(
194    IO &IO, COFF::SectionCharacteristics &Value) {
195  BCase(IMAGE_SCN_TYPE_NO_PAD);
196  BCase(IMAGE_SCN_CNT_CODE);
197  BCase(IMAGE_SCN_CNT_INITIALIZED_DATA);
198  BCase(IMAGE_SCN_CNT_UNINITIALIZED_DATA);
199  BCase(IMAGE_SCN_LNK_OTHER);
200  BCase(IMAGE_SCN_LNK_INFO);
201  BCase(IMAGE_SCN_LNK_REMOVE);
202  BCase(IMAGE_SCN_LNK_COMDAT);
203  BCase(IMAGE_SCN_GPREL);
204  BCase(IMAGE_SCN_MEM_PURGEABLE);
205  BCase(IMAGE_SCN_MEM_16BIT);
206  BCase(IMAGE_SCN_MEM_LOCKED);
207  BCase(IMAGE_SCN_MEM_PRELOAD);
208  BCase(IMAGE_SCN_LNK_NRELOC_OVFL);
209  BCase(IMAGE_SCN_MEM_DISCARDABLE);
210  BCase(IMAGE_SCN_MEM_NOT_CACHED);
211  BCase(IMAGE_SCN_MEM_NOT_PAGED);
212  BCase(IMAGE_SCN_MEM_SHARED);
213  BCase(IMAGE_SCN_MEM_EXECUTE);
214  BCase(IMAGE_SCN_MEM_READ);
215  BCase(IMAGE_SCN_MEM_WRITE);
216}
217#undef BCase
218
219namespace {
220struct NSectionSelectionType {
221  NSectionSelectionType(IO &)
222      : SelectionType(COFFYAML::COMDATType(0)) {}
223  NSectionSelectionType(IO &, uint8_t C)
224      : SelectionType(COFFYAML::COMDATType(C)) {}
225  uint8_t denormalize(IO &) { return SelectionType; }
226  COFFYAML::COMDATType SelectionType;
227};
228
229struct NWeakExternalCharacteristics {
230  NWeakExternalCharacteristics(IO &)
231      : Characteristics(COFFYAML::WeakExternalCharacteristics(0)) {}
232  NWeakExternalCharacteristics(IO &, uint32_t C)
233      : Characteristics(COFFYAML::WeakExternalCharacteristics(C)) {}
234  uint32_t denormalize(IO &) { return Characteristics; }
235  COFFYAML::WeakExternalCharacteristics Characteristics;
236};
237
238struct NSectionCharacteristics {
239  NSectionCharacteristics(IO &)
240      : Characteristics(COFF::SectionCharacteristics(0)) {}
241  NSectionCharacteristics(IO &, uint32_t C)
242      : Characteristics(COFF::SectionCharacteristics(C)) {}
243  uint32_t denormalize(IO &) { return Characteristics; }
244  COFF::SectionCharacteristics Characteristics;
245};
246
247struct NAuxTokenType {
248  NAuxTokenType(IO &)
249      : AuxType(COFFYAML::AuxSymbolType(0)) {}
250  NAuxTokenType(IO &, uint8_t C)
251      : AuxType(COFFYAML::AuxSymbolType(C)) {}
252  uint32_t denormalize(IO &) { return AuxType; }
253  COFFYAML::AuxSymbolType AuxType;
254};
255
256struct NStorageClass {
257  NStorageClass(IO &) : StorageClass(COFF::SymbolStorageClass(0)) {}
258  NStorageClass(IO &, uint8_t S) : StorageClass(COFF::SymbolStorageClass(S)) {}
259  uint8_t denormalize(IO &) { return StorageClass; }
260
261  COFF::SymbolStorageClass StorageClass;
262};
263
264struct NMachine {
265  NMachine(IO &) : Machine(COFF::MachineTypes(0)) {}
266  NMachine(IO &, uint16_t M) : Machine(COFF::MachineTypes(M)) {}
267  uint16_t denormalize(IO &) { return Machine; }
268  COFF::MachineTypes Machine;
269};
270
271struct NHeaderCharacteristics {
272  NHeaderCharacteristics(IO &) : Characteristics(COFF::Characteristics(0)) {}
273  NHeaderCharacteristics(IO &, uint16_t C)
274      : Characteristics(COFF::Characteristics(C)) {}
275  uint16_t denormalize(IO &) { return Characteristics; }
276
277  COFF::Characteristics Characteristics;
278};
279
280template <typename RelocType>
281struct NType {
282  NType(IO &) : Type(RelocType(0)) {}
283  NType(IO &, uint16_t T) : Type(RelocType(T)) {}
284  uint16_t denormalize(IO &) { return Type; }
285  RelocType Type;
286};
287
288}
289
290void MappingTraits<COFFYAML::Relocation>::mapping(IO &IO,
291                                                  COFFYAML::Relocation &Rel) {
292  IO.mapRequired("VirtualAddress", Rel.VirtualAddress);
293  IO.mapRequired("SymbolName", Rel.SymbolName);
294
295  COFF::header &H = *static_cast<COFF::header *>(IO.getContext());
296  if (H.Machine == COFF::IMAGE_FILE_MACHINE_I386) {
297    MappingNormalization<NType<COFF::RelocationTypeI386>, uint16_t> NT(
298        IO, Rel.Type);
299    IO.mapRequired("Type", NT->Type);
300  } else if (H.Machine == COFF::IMAGE_FILE_MACHINE_AMD64) {
301    MappingNormalization<NType<COFF::RelocationTypeAMD64>, uint16_t> NT(
302        IO, Rel.Type);
303    IO.mapRequired("Type", NT->Type);
304  } else {
305    IO.mapRequired("Type", Rel.Type);
306  }
307}
308
309void MappingTraits<COFF::header>::mapping(IO &IO, COFF::header &H) {
310  MappingNormalization<NMachine, uint16_t> NM(IO, H.Machine);
311  MappingNormalization<NHeaderCharacteristics, uint16_t> NC(IO,
312                                                            H.Characteristics);
313
314  IO.mapRequired("Machine", NM->Machine);
315  IO.mapOptional("Characteristics", NC->Characteristics);
316  IO.setContext(static_cast<void *>(&H));
317}
318
319void MappingTraits<COFF::AuxiliaryFunctionDefinition>::mapping(
320    IO &IO, COFF::AuxiliaryFunctionDefinition &AFD) {
321  IO.mapRequired("TagIndex", AFD.TagIndex);
322  IO.mapRequired("TotalSize", AFD.TotalSize);
323  IO.mapRequired("PointerToLinenumber", AFD.PointerToLinenumber);
324  IO.mapRequired("PointerToNextFunction", AFD.PointerToNextFunction);
325}
326
327void MappingTraits<COFF::AuxiliarybfAndefSymbol>::mapping(
328    IO &IO, COFF::AuxiliarybfAndefSymbol &AAS) {
329  IO.mapRequired("Linenumber", AAS.Linenumber);
330  IO.mapRequired("PointerToNextFunction", AAS.PointerToNextFunction);
331}
332
333void MappingTraits<COFF::AuxiliaryWeakExternal>::mapping(
334    IO &IO, COFF::AuxiliaryWeakExternal &AWE) {
335  MappingNormalization<NWeakExternalCharacteristics, uint32_t> NWEC(
336      IO, AWE.Characteristics);
337  IO.mapRequired("TagIndex", AWE.TagIndex);
338  IO.mapRequired("Characteristics", NWEC->Characteristics);
339}
340
341void MappingTraits<COFF::AuxiliarySectionDefinition>::mapping(
342    IO &IO, COFF::AuxiliarySectionDefinition &ASD) {
343  MappingNormalization<NSectionSelectionType, uint8_t> NSST(
344      IO, ASD.Selection);
345
346  IO.mapRequired("Length", ASD.Length);
347  IO.mapRequired("NumberOfRelocations", ASD.NumberOfRelocations);
348  IO.mapRequired("NumberOfLinenumbers", ASD.NumberOfLinenumbers);
349  IO.mapRequired("CheckSum", ASD.CheckSum);
350  IO.mapRequired("Number", ASD.Number);
351  IO.mapOptional("Selection", NSST->SelectionType, COFFYAML::COMDATType(0));
352}
353
354void MappingTraits<COFF::AuxiliaryCLRToken>::mapping(
355    IO &IO, COFF::AuxiliaryCLRToken &ACT) {
356  MappingNormalization<NAuxTokenType, uint8_t> NATT(IO, ACT.AuxType);
357  IO.mapRequired("AuxType", NATT->AuxType);
358  IO.mapRequired("SymbolTableIndex", ACT.SymbolTableIndex);
359}
360
361void MappingTraits<COFFYAML::Symbol>::mapping(IO &IO, COFFYAML::Symbol &S) {
362  MappingNormalization<NStorageClass, uint8_t> NS(IO, S.Header.StorageClass);
363
364  IO.mapRequired("Name", S.Name);
365  IO.mapRequired("Value", S.Header.Value);
366  IO.mapRequired("SectionNumber", S.Header.SectionNumber);
367  IO.mapRequired("SimpleType", S.SimpleType);
368  IO.mapRequired("ComplexType", S.ComplexType);
369  IO.mapRequired("StorageClass", NS->StorageClass);
370  IO.mapOptional("FunctionDefinition", S.FunctionDefinition);
371  IO.mapOptional("bfAndefSymbol", S.bfAndefSymbol);
372  IO.mapOptional("WeakExternal", S.WeakExternal);
373  IO.mapOptional("File", S.File, StringRef());
374  IO.mapOptional("SectionDefinition", S.SectionDefinition);
375  IO.mapOptional("CLRToken", S.CLRToken);
376}
377
378void MappingTraits<COFFYAML::Section>::mapping(IO &IO, COFFYAML::Section &Sec) {
379  MappingNormalization<NSectionCharacteristics, uint32_t> NC(
380      IO, Sec.Header.Characteristics);
381  IO.mapRequired("Name", Sec.Name);
382  IO.mapRequired("Characteristics", NC->Characteristics);
383  IO.mapOptional("Alignment", Sec.Alignment);
384  IO.mapRequired("SectionData", Sec.SectionData);
385  IO.mapOptional("Relocations", Sec.Relocations);
386}
387
388void MappingTraits<COFFYAML::Object>::mapping(IO &IO, COFFYAML::Object &Obj) {
389  IO.mapRequired("header", Obj.Header);
390  IO.mapRequired("sections", Obj.Sections);
391  IO.mapRequired("symbols", Obj.Symbols);
392}
393
394}
395}
396