CodeViewYAMLTypes.cpp 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755
  1. //===- CodeViewYAMLTypes.cpp - CodeView YAMLIO types 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 CodeView
  11. // Debug Info.
  12. //
  13. //===----------------------------------------------------------------------===//
  14. #include "llvm/ObjectYAML/CodeViewYAMLTypes.h"
  15. #include "llvm/ADT/StringExtras.h"
  16. #include "llvm/ADT/StringSwitch.h"
  17. #include "llvm/DebugInfo/CodeView/CVTypeVisitor.h"
  18. #include "llvm/DebugInfo/CodeView/CodeViewError.h"
  19. #include "llvm/DebugInfo/CodeView/EnumTables.h"
  20. #include "llvm/DebugInfo/CodeView/TypeDeserializer.h"
  21. #include "llvm/DebugInfo/CodeView/TypeTableBuilder.h"
  22. #include "llvm/Support/BinaryStreamWriter.h"
  23. using namespace llvm;
  24. using namespace llvm::codeview;
  25. using namespace llvm::CodeViewYAML;
  26. using namespace llvm::CodeViewYAML::detail;
  27. using namespace llvm::yaml;
  28. LLVM_YAML_IS_SEQUENCE_VECTOR(OneMethodRecord)
  29. LLVM_YAML_IS_SEQUENCE_VECTOR(VFTableSlotKind)
  30. LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(TypeIndex)
  31. LLVM_YAML_DECLARE_SCALAR_TRAITS(TypeIndex, false)
  32. LLVM_YAML_DECLARE_SCALAR_TRAITS(APSInt, false)
  33. LLVM_YAML_DECLARE_ENUM_TRAITS(TypeLeafKind)
  34. LLVM_YAML_DECLARE_ENUM_TRAITS(PointerToMemberRepresentation)
  35. LLVM_YAML_DECLARE_ENUM_TRAITS(VFTableSlotKind)
  36. LLVM_YAML_DECLARE_ENUM_TRAITS(CallingConvention)
  37. LLVM_YAML_DECLARE_ENUM_TRAITS(PointerKind)
  38. LLVM_YAML_DECLARE_ENUM_TRAITS(PointerMode)
  39. LLVM_YAML_DECLARE_ENUM_TRAITS(HfaKind)
  40. LLVM_YAML_DECLARE_ENUM_TRAITS(MemberAccess)
  41. LLVM_YAML_DECLARE_ENUM_TRAITS(MethodKind)
  42. LLVM_YAML_DECLARE_ENUM_TRAITS(WindowsRTClassKind)
  43. LLVM_YAML_DECLARE_ENUM_TRAITS(LabelType)
  44. LLVM_YAML_DECLARE_BITSET_TRAITS(PointerOptions)
  45. LLVM_YAML_DECLARE_BITSET_TRAITS(ModifierOptions)
  46. LLVM_YAML_DECLARE_BITSET_TRAITS(FunctionOptions)
  47. LLVM_YAML_DECLARE_BITSET_TRAITS(ClassOptions)
  48. LLVM_YAML_DECLARE_BITSET_TRAITS(MethodOptions)
  49. LLVM_YAML_DECLARE_MAPPING_TRAITS(OneMethodRecord)
  50. LLVM_YAML_DECLARE_MAPPING_TRAITS(MemberPointerInfo)
  51. namespace llvm {
  52. namespace CodeViewYAML {
  53. namespace detail {
  54. struct LeafRecordBase {
  55. TypeLeafKind Kind;
  56. explicit LeafRecordBase(TypeLeafKind K) : Kind(K) {}
  57. virtual ~LeafRecordBase() {}
  58. virtual void map(yaml::IO &io) = 0;
  59. virtual CVType toCodeViewRecord(TypeTableBuilder &TTB) const = 0;
  60. virtual Error fromCodeViewRecord(CVType Type) = 0;
  61. };
  62. template <typename T> struct LeafRecordImpl : public LeafRecordBase {
  63. explicit LeafRecordImpl(TypeLeafKind K)
  64. : LeafRecordBase(K), Record(static_cast<TypeRecordKind>(K)) {}
  65. void map(yaml::IO &io) override;
  66. Error fromCodeViewRecord(CVType Type) override {
  67. return TypeDeserializer::deserializeAs<T>(Type, Record);
  68. }
  69. CVType toCodeViewRecord(TypeTableBuilder &TTB) const override {
  70. TTB.writeKnownType(Record);
  71. return CVType(Kind, TTB.records().back());
  72. }
  73. mutable T Record;
  74. };
  75. template <> struct LeafRecordImpl<FieldListRecord> : public LeafRecordBase {
  76. explicit LeafRecordImpl(TypeLeafKind K) : LeafRecordBase(K) {}
  77. void map(yaml::IO &io) override;
  78. CVType toCodeViewRecord(TypeTableBuilder &TTB) const override;
  79. Error fromCodeViewRecord(CVType Type) override;
  80. std::vector<MemberRecord> Members;
  81. };
  82. struct MemberRecordBase {
  83. TypeLeafKind Kind;
  84. explicit MemberRecordBase(TypeLeafKind K) : Kind(K) {}
  85. virtual ~MemberRecordBase() {}
  86. virtual void map(yaml::IO &io) = 0;
  87. virtual void writeTo(FieldListRecordBuilder &FLRB) = 0;
  88. };
  89. template <typename T> struct MemberRecordImpl : public MemberRecordBase {
  90. explicit MemberRecordImpl(TypeLeafKind K)
  91. : MemberRecordBase(K), Record(static_cast<TypeRecordKind>(K)) {}
  92. void map(yaml::IO &io) override;
  93. void writeTo(FieldListRecordBuilder &FLRB) override {
  94. FLRB.writeMemberType(Record);
  95. }
  96. mutable T Record;
  97. };
  98. }
  99. }
  100. }
  101. void ScalarTraits<TypeIndex>::output(const TypeIndex &S, void *,
  102. llvm::raw_ostream &OS) {
  103. OS << S.getIndex();
  104. }
  105. StringRef ScalarTraits<TypeIndex>::input(StringRef Scalar, void *Ctx,
  106. TypeIndex &S) {
  107. uint32_t I;
  108. StringRef Result = ScalarTraits<uint32_t>::input(Scalar, Ctx, I);
  109. S.setIndex(I);
  110. return Result;
  111. }
  112. void ScalarTraits<APSInt>::output(const APSInt &S, void *,
  113. llvm::raw_ostream &OS) {
  114. S.print(OS, S.isSigned());
  115. }
  116. StringRef ScalarTraits<APSInt>::input(StringRef Scalar, void *Ctx, APSInt &S) {
  117. S = APSInt(Scalar);
  118. return "";
  119. }
  120. void ScalarEnumerationTraits<TypeLeafKind>::enumeration(IO &io,
  121. TypeLeafKind &Value) {
  122. #define CV_TYPE(name, val) io.enumCase(Value, #name, name);
  123. #include "llvm/DebugInfo/CodeView/CodeViewTypes.def"
  124. #undef CV_TYPE
  125. }
  126. void ScalarEnumerationTraits<PointerToMemberRepresentation>::enumeration(
  127. IO &IO, PointerToMemberRepresentation &Value) {
  128. IO.enumCase(Value, "Unknown", PointerToMemberRepresentation::Unknown);
  129. IO.enumCase(Value, "SingleInheritanceData",
  130. PointerToMemberRepresentation::SingleInheritanceData);
  131. IO.enumCase(Value, "MultipleInheritanceData",
  132. PointerToMemberRepresentation::MultipleInheritanceData);
  133. IO.enumCase(Value, "VirtualInheritanceData",
  134. PointerToMemberRepresentation::VirtualInheritanceData);
  135. IO.enumCase(Value, "GeneralData", PointerToMemberRepresentation::GeneralData);
  136. IO.enumCase(Value, "SingleInheritanceFunction",
  137. PointerToMemberRepresentation::SingleInheritanceFunction);
  138. IO.enumCase(Value, "MultipleInheritanceFunction",
  139. PointerToMemberRepresentation::MultipleInheritanceFunction);
  140. IO.enumCase(Value, "VirtualInheritanceFunction",
  141. PointerToMemberRepresentation::VirtualInheritanceFunction);
  142. IO.enumCase(Value, "GeneralFunction",
  143. PointerToMemberRepresentation::GeneralFunction);
  144. }
  145. void ScalarEnumerationTraits<VFTableSlotKind>::enumeration(
  146. IO &IO, VFTableSlotKind &Kind) {
  147. IO.enumCase(Kind, "Near16", VFTableSlotKind::Near16);
  148. IO.enumCase(Kind, "Far16", VFTableSlotKind::Far16);
  149. IO.enumCase(Kind, "This", VFTableSlotKind::This);
  150. IO.enumCase(Kind, "Outer", VFTableSlotKind::Outer);
  151. IO.enumCase(Kind, "Meta", VFTableSlotKind::Meta);
  152. IO.enumCase(Kind, "Near", VFTableSlotKind::Near);
  153. IO.enumCase(Kind, "Far", VFTableSlotKind::Far);
  154. }
  155. void ScalarEnumerationTraits<CallingConvention>::enumeration(
  156. IO &IO, CallingConvention &Value) {
  157. IO.enumCase(Value, "NearC", CallingConvention::NearC);
  158. IO.enumCase(Value, "FarC", CallingConvention::FarC);
  159. IO.enumCase(Value, "NearPascal", CallingConvention::NearPascal);
  160. IO.enumCase(Value, "FarPascal", CallingConvention::FarPascal);
  161. IO.enumCase(Value, "NearFast", CallingConvention::NearFast);
  162. IO.enumCase(Value, "FarFast", CallingConvention::FarFast);
  163. IO.enumCase(Value, "NearStdCall", CallingConvention::NearStdCall);
  164. IO.enumCase(Value, "FarStdCall", CallingConvention::FarStdCall);
  165. IO.enumCase(Value, "NearSysCall", CallingConvention::NearSysCall);
  166. IO.enumCase(Value, "FarSysCall", CallingConvention::FarSysCall);
  167. IO.enumCase(Value, "ThisCall", CallingConvention::ThisCall);
  168. IO.enumCase(Value, "MipsCall", CallingConvention::MipsCall);
  169. IO.enumCase(Value, "Generic", CallingConvention::Generic);
  170. IO.enumCase(Value, "AlphaCall", CallingConvention::AlphaCall);
  171. IO.enumCase(Value, "PpcCall", CallingConvention::PpcCall);
  172. IO.enumCase(Value, "SHCall", CallingConvention::SHCall);
  173. IO.enumCase(Value, "ArmCall", CallingConvention::ArmCall);
  174. IO.enumCase(Value, "AM33Call", CallingConvention::AM33Call);
  175. IO.enumCase(Value, "TriCall", CallingConvention::TriCall);
  176. IO.enumCase(Value, "SH5Call", CallingConvention::SH5Call);
  177. IO.enumCase(Value, "M32RCall", CallingConvention::M32RCall);
  178. IO.enumCase(Value, "ClrCall", CallingConvention::ClrCall);
  179. IO.enumCase(Value, "Inline", CallingConvention::Inline);
  180. IO.enumCase(Value, "NearVector", CallingConvention::NearVector);
  181. }
  182. void ScalarEnumerationTraits<PointerKind>::enumeration(IO &IO,
  183. PointerKind &Kind) {
  184. IO.enumCase(Kind, "Near16", PointerKind::Near16);
  185. IO.enumCase(Kind, "Far16", PointerKind::Far16);
  186. IO.enumCase(Kind, "Huge16", PointerKind::Huge16);
  187. IO.enumCase(Kind, "BasedOnSegment", PointerKind::BasedOnSegment);
  188. IO.enumCase(Kind, "BasedOnValue", PointerKind::BasedOnValue);
  189. IO.enumCase(Kind, "BasedOnSegmentValue", PointerKind::BasedOnSegmentValue);
  190. IO.enumCase(Kind, "BasedOnAddress", PointerKind::BasedOnAddress);
  191. IO.enumCase(Kind, "BasedOnSegmentAddress",
  192. PointerKind::BasedOnSegmentAddress);
  193. IO.enumCase(Kind, "BasedOnType", PointerKind::BasedOnType);
  194. IO.enumCase(Kind, "BasedOnSelf", PointerKind::BasedOnSelf);
  195. IO.enumCase(Kind, "Near32", PointerKind::Near32);
  196. IO.enumCase(Kind, "Far32", PointerKind::Far32);
  197. IO.enumCase(Kind, "Near64", PointerKind::Near64);
  198. }
  199. void ScalarEnumerationTraits<PointerMode>::enumeration(IO &IO,
  200. PointerMode &Mode) {
  201. IO.enumCase(Mode, "Pointer", PointerMode::Pointer);
  202. IO.enumCase(Mode, "LValueReference", PointerMode::LValueReference);
  203. IO.enumCase(Mode, "PointerToDataMember", PointerMode::PointerToDataMember);
  204. IO.enumCase(Mode, "PointerToMemberFunction",
  205. PointerMode::PointerToMemberFunction);
  206. IO.enumCase(Mode, "RValueReference", PointerMode::RValueReference);
  207. }
  208. void ScalarEnumerationTraits<HfaKind>::enumeration(IO &IO, HfaKind &Value) {
  209. IO.enumCase(Value, "None", HfaKind::None);
  210. IO.enumCase(Value, "Float", HfaKind::Float);
  211. IO.enumCase(Value, "Double", HfaKind::Double);
  212. IO.enumCase(Value, "Other", HfaKind::Other);
  213. }
  214. void ScalarEnumerationTraits<MemberAccess>::enumeration(IO &IO,
  215. MemberAccess &Access) {
  216. IO.enumCase(Access, "None", MemberAccess::None);
  217. IO.enumCase(Access, "Private", MemberAccess::Private);
  218. IO.enumCase(Access, "Protected", MemberAccess::Protected);
  219. IO.enumCase(Access, "Public", MemberAccess::Public);
  220. }
  221. void ScalarEnumerationTraits<MethodKind>::enumeration(IO &IO,
  222. MethodKind &Kind) {
  223. IO.enumCase(Kind, "Vanilla", MethodKind::Vanilla);
  224. IO.enumCase(Kind, "Virtual", MethodKind::Virtual);
  225. IO.enumCase(Kind, "Static", MethodKind::Static);
  226. IO.enumCase(Kind, "Friend", MethodKind::Friend);
  227. IO.enumCase(Kind, "IntroducingVirtual", MethodKind::IntroducingVirtual);
  228. IO.enumCase(Kind, "PureVirtual", MethodKind::PureVirtual);
  229. IO.enumCase(Kind, "PureIntroducingVirtual",
  230. MethodKind::PureIntroducingVirtual);
  231. }
  232. void ScalarEnumerationTraits<WindowsRTClassKind>::enumeration(
  233. IO &IO, WindowsRTClassKind &Value) {
  234. IO.enumCase(Value, "None", WindowsRTClassKind::None);
  235. IO.enumCase(Value, "Ref", WindowsRTClassKind::RefClass);
  236. IO.enumCase(Value, "Value", WindowsRTClassKind::ValueClass);
  237. IO.enumCase(Value, "Interface", WindowsRTClassKind::Interface);
  238. }
  239. void ScalarEnumerationTraits<LabelType>::enumeration(IO &IO, LabelType &Value) {
  240. IO.enumCase(Value, "Near", LabelType::Near);
  241. IO.enumCase(Value, "Far", LabelType::Far);
  242. }
  243. void ScalarBitSetTraits<PointerOptions>::bitset(IO &IO,
  244. PointerOptions &Options) {
  245. IO.bitSetCase(Options, "None", PointerOptions::None);
  246. IO.bitSetCase(Options, "Flat32", PointerOptions::Flat32);
  247. IO.bitSetCase(Options, "Volatile", PointerOptions::Volatile);
  248. IO.bitSetCase(Options, "Const", PointerOptions::Const);
  249. IO.bitSetCase(Options, "Unaligned", PointerOptions::Unaligned);
  250. IO.bitSetCase(Options, "Restrict", PointerOptions::Restrict);
  251. IO.bitSetCase(Options, "WinRTSmartPointer",
  252. PointerOptions::WinRTSmartPointer);
  253. }
  254. void ScalarBitSetTraits<ModifierOptions>::bitset(IO &IO,
  255. ModifierOptions &Options) {
  256. IO.bitSetCase(Options, "None", ModifierOptions::None);
  257. IO.bitSetCase(Options, "Const", ModifierOptions::Const);
  258. IO.bitSetCase(Options, "Volatile", ModifierOptions::Volatile);
  259. IO.bitSetCase(Options, "Unaligned", ModifierOptions::Unaligned);
  260. }
  261. void ScalarBitSetTraits<FunctionOptions>::bitset(IO &IO,
  262. FunctionOptions &Options) {
  263. IO.bitSetCase(Options, "None", FunctionOptions::None);
  264. IO.bitSetCase(Options, "CxxReturnUdt", FunctionOptions::CxxReturnUdt);
  265. IO.bitSetCase(Options, "Constructor", FunctionOptions::Constructor);
  266. IO.bitSetCase(Options, "ConstructorWithVirtualBases",
  267. FunctionOptions::ConstructorWithVirtualBases);
  268. }
  269. void ScalarBitSetTraits<ClassOptions>::bitset(IO &IO, ClassOptions &Options) {
  270. IO.bitSetCase(Options, "None", ClassOptions::None);
  271. IO.bitSetCase(Options, "HasConstructorOrDestructor",
  272. ClassOptions::HasConstructorOrDestructor);
  273. IO.bitSetCase(Options, "HasOverloadedOperator",
  274. ClassOptions::HasOverloadedOperator);
  275. IO.bitSetCase(Options, "Nested", ClassOptions::Nested);
  276. IO.bitSetCase(Options, "ContainsNestedClass",
  277. ClassOptions::ContainsNestedClass);
  278. IO.bitSetCase(Options, "HasOverloadedAssignmentOperator",
  279. ClassOptions::HasOverloadedAssignmentOperator);
  280. IO.bitSetCase(Options, "HasConversionOperator",
  281. ClassOptions::HasConversionOperator);
  282. IO.bitSetCase(Options, "ForwardReference", ClassOptions::ForwardReference);
  283. IO.bitSetCase(Options, "Scoped", ClassOptions::Scoped);
  284. IO.bitSetCase(Options, "HasUniqueName", ClassOptions::HasUniqueName);
  285. IO.bitSetCase(Options, "Sealed", ClassOptions::Sealed);
  286. IO.bitSetCase(Options, "Intrinsic", ClassOptions::Intrinsic);
  287. }
  288. void ScalarBitSetTraits<MethodOptions>::bitset(IO &IO, MethodOptions &Options) {
  289. IO.bitSetCase(Options, "None", MethodOptions::None);
  290. IO.bitSetCase(Options, "Pseudo", MethodOptions::Pseudo);
  291. IO.bitSetCase(Options, "NoInherit", MethodOptions::NoInherit);
  292. IO.bitSetCase(Options, "NoConstruct", MethodOptions::NoConstruct);
  293. IO.bitSetCase(Options, "CompilerGenerated", MethodOptions::CompilerGenerated);
  294. IO.bitSetCase(Options, "Sealed", MethodOptions::Sealed);
  295. }
  296. void MappingTraits<MemberPointerInfo>::mapping(IO &IO, MemberPointerInfo &MPI) {
  297. IO.mapRequired("ContainingType", MPI.ContainingType);
  298. IO.mapRequired("Representation", MPI.Representation);
  299. }
  300. namespace llvm {
  301. namespace CodeViewYAML {
  302. namespace detail {
  303. template <> void LeafRecordImpl<ModifierRecord>::map(IO &IO) {
  304. IO.mapRequired("ModifiedType", Record.ModifiedType);
  305. IO.mapRequired("Modifiers", Record.Modifiers);
  306. }
  307. template <> void LeafRecordImpl<ProcedureRecord>::map(IO &IO) {
  308. IO.mapRequired("ReturnType", Record.ReturnType);
  309. IO.mapRequired("CallConv", Record.CallConv);
  310. IO.mapRequired("Options", Record.Options);
  311. IO.mapRequired("ParameterCount", Record.ParameterCount);
  312. IO.mapRequired("ArgumentList", Record.ArgumentList);
  313. }
  314. template <> void LeafRecordImpl<MemberFunctionRecord>::map(IO &IO) {
  315. IO.mapRequired("ReturnType", Record.ReturnType);
  316. IO.mapRequired("ClassType", Record.ClassType);
  317. IO.mapRequired("ThisType", Record.ThisType);
  318. IO.mapRequired("CallConv", Record.CallConv);
  319. IO.mapRequired("Options", Record.Options);
  320. IO.mapRequired("ParameterCount", Record.ParameterCount);
  321. IO.mapRequired("ArgumentList", Record.ArgumentList);
  322. IO.mapRequired("ThisPointerAdjustment", Record.ThisPointerAdjustment);
  323. }
  324. template <> void LeafRecordImpl<LabelRecord>::map(IO &IO) {
  325. IO.mapRequired("Mode", Record.Mode);
  326. }
  327. template <> void LeafRecordImpl<MemberFuncIdRecord>::map(IO &IO) {
  328. IO.mapRequired("ClassType", Record.ClassType);
  329. IO.mapRequired("FunctionType", Record.FunctionType);
  330. IO.mapRequired("Name", Record.Name);
  331. }
  332. template <> void LeafRecordImpl<ArgListRecord>::map(IO &IO) {
  333. IO.mapRequired("ArgIndices", Record.ArgIndices);
  334. }
  335. template <> void LeafRecordImpl<StringListRecord>::map(IO &IO) {
  336. IO.mapRequired("StringIndices", Record.StringIndices);
  337. }
  338. template <> void LeafRecordImpl<PointerRecord>::map(IO &IO) {
  339. IO.mapRequired("ReferentType", Record.ReferentType);
  340. IO.mapRequired("Attrs", Record.Attrs);
  341. IO.mapOptional("MemberInfo", Record.MemberInfo);
  342. }
  343. template <> void LeafRecordImpl<ArrayRecord>::map(IO &IO) {
  344. IO.mapRequired("ElementType", Record.ElementType);
  345. IO.mapRequired("IndexType", Record.IndexType);
  346. IO.mapRequired("Size", Record.Size);
  347. IO.mapRequired("Name", Record.Name);
  348. }
  349. void LeafRecordImpl<FieldListRecord>::map(IO &IO) {
  350. IO.mapRequired("FieldList", Members);
  351. }
  352. }
  353. }
  354. }
  355. namespace {
  356. class MemberRecordConversionVisitor : public TypeVisitorCallbacks {
  357. public:
  358. explicit MemberRecordConversionVisitor(std::vector<MemberRecord> &Records)
  359. : Records(Records) {}
  360. #define TYPE_RECORD(EnumName, EnumVal, Name)
  361. #define MEMBER_RECORD(EnumName, EnumVal, Name) \
  362. Error visitKnownMember(CVMemberRecord &CVR, Name##Record &Record) override { \
  363. return visitKnownMemberImpl(Record); \
  364. }
  365. #define TYPE_RECORD_ALIAS(EnumName, EnumVal, Name, AliasName)
  366. #define MEMBER_RECORD_ALIAS(EnumName, EnumVal, Name, AliasName)
  367. #include "llvm/DebugInfo/CodeView/CodeViewTypes.def"
  368. private:
  369. template <typename T> Error visitKnownMemberImpl(T &Record) {
  370. TypeLeafKind K = static_cast<TypeLeafKind>(Record.getKind());
  371. auto Impl = std::make_shared<MemberRecordImpl<T>>(K);
  372. Impl->Record = Record;
  373. Records.push_back(MemberRecord{Impl});
  374. return Error::success();
  375. }
  376. std::vector<MemberRecord> &Records;
  377. };
  378. }
  379. Error LeafRecordImpl<FieldListRecord>::fromCodeViewRecord(CVType Type) {
  380. MemberRecordConversionVisitor V(Members);
  381. return visitMemberRecordStream(Type.content(), V);
  382. }
  383. CVType
  384. LeafRecordImpl<FieldListRecord>::toCodeViewRecord(TypeTableBuilder &TTB) const {
  385. FieldListRecordBuilder FLRB(TTB);
  386. FLRB.begin();
  387. for (const auto &Member : Members) {
  388. Member.Member->writeTo(FLRB);
  389. }
  390. FLRB.end(true);
  391. return CVType(Kind, TTB.records().back());
  392. }
  393. void MappingTraits<OneMethodRecord>::mapping(IO &io, OneMethodRecord &Record) {
  394. io.mapRequired("Type", Record.Type);
  395. io.mapRequired("Attrs", Record.Attrs.Attrs);
  396. io.mapRequired("VFTableOffset", Record.VFTableOffset);
  397. io.mapRequired("Name", Record.Name);
  398. }
  399. namespace llvm {
  400. namespace CodeViewYAML {
  401. namespace detail {
  402. template <> void LeafRecordImpl<ClassRecord>::map(IO &IO) {
  403. IO.mapRequired("MemberCount", Record.MemberCount);
  404. IO.mapRequired("Options", Record.Options);
  405. IO.mapRequired("FieldList", Record.FieldList);
  406. IO.mapRequired("Name", Record.Name);
  407. IO.mapRequired("UniqueName", Record.UniqueName);
  408. IO.mapRequired("DerivationList", Record.DerivationList);
  409. IO.mapRequired("VTableShape", Record.VTableShape);
  410. IO.mapRequired("Size", Record.Size);
  411. }
  412. template <> void LeafRecordImpl<UnionRecord>::map(IO &IO) {
  413. IO.mapRequired("MemberCount", Record.MemberCount);
  414. IO.mapRequired("Options", Record.Options);
  415. IO.mapRequired("FieldList", Record.FieldList);
  416. IO.mapRequired("Name", Record.Name);
  417. IO.mapRequired("UniqueName", Record.UniqueName);
  418. IO.mapRequired("Size", Record.Size);
  419. }
  420. template <> void LeafRecordImpl<EnumRecord>::map(IO &IO) {
  421. IO.mapRequired("NumEnumerators", Record.MemberCount);
  422. IO.mapRequired("Options", Record.Options);
  423. IO.mapRequired("FieldList", Record.FieldList);
  424. IO.mapRequired("Name", Record.Name);
  425. IO.mapRequired("UniqueName", Record.UniqueName);
  426. IO.mapRequired("UnderlyingType", Record.UnderlyingType);
  427. }
  428. template <> void LeafRecordImpl<BitFieldRecord>::map(IO &IO) {
  429. IO.mapRequired("Type", Record.Type);
  430. IO.mapRequired("BitSize", Record.BitSize);
  431. IO.mapRequired("BitOffset", Record.BitOffset);
  432. }
  433. template <> void LeafRecordImpl<VFTableShapeRecord>::map(IO &IO) {
  434. IO.mapRequired("Slots", Record.Slots);
  435. }
  436. template <> void LeafRecordImpl<TypeServer2Record>::map(IO &IO) {
  437. IO.mapRequired("Guid", Record.Guid);
  438. IO.mapRequired("Age", Record.Age);
  439. IO.mapRequired("Name", Record.Name);
  440. }
  441. template <> void LeafRecordImpl<StringIdRecord>::map(IO &IO) {
  442. IO.mapRequired("Id", Record.Id);
  443. IO.mapRequired("String", Record.String);
  444. }
  445. template <> void LeafRecordImpl<FuncIdRecord>::map(IO &IO) {
  446. IO.mapRequired("ParentScope", Record.ParentScope);
  447. IO.mapRequired("FunctionType", Record.FunctionType);
  448. IO.mapRequired("Name", Record.Name);
  449. }
  450. template <> void LeafRecordImpl<UdtSourceLineRecord>::map(IO &IO) {
  451. IO.mapRequired("UDT", Record.UDT);
  452. IO.mapRequired("SourceFile", Record.SourceFile);
  453. IO.mapRequired("LineNumber", Record.LineNumber);
  454. }
  455. template <> void LeafRecordImpl<UdtModSourceLineRecord>::map(IO &IO) {
  456. IO.mapRequired("UDT", Record.UDT);
  457. IO.mapRequired("SourceFile", Record.SourceFile);
  458. IO.mapRequired("LineNumber", Record.LineNumber);
  459. IO.mapRequired("Module", Record.Module);
  460. }
  461. template <> void LeafRecordImpl<BuildInfoRecord>::map(IO &IO) {
  462. IO.mapRequired("ArgIndices", Record.ArgIndices);
  463. }
  464. template <> void LeafRecordImpl<VFTableRecord>::map(IO &IO) {
  465. IO.mapRequired("CompleteClass", Record.CompleteClass);
  466. IO.mapRequired("OverriddenVFTable", Record.OverriddenVFTable);
  467. IO.mapRequired("VFPtrOffset", Record.VFPtrOffset);
  468. IO.mapRequired("MethodNames", Record.MethodNames);
  469. }
  470. template <> void LeafRecordImpl<MethodOverloadListRecord>::map(IO &IO) {
  471. IO.mapRequired("Methods", Record.Methods);
  472. }
  473. template <> void MemberRecordImpl<OneMethodRecord>::map(IO &IO) {
  474. MappingTraits<OneMethodRecord>::mapping(IO, Record);
  475. }
  476. template <> void MemberRecordImpl<OverloadedMethodRecord>::map(IO &IO) {
  477. IO.mapRequired("NumOverloads", Record.NumOverloads);
  478. IO.mapRequired("MethodList", Record.MethodList);
  479. IO.mapRequired("Name", Record.Name);
  480. }
  481. template <> void MemberRecordImpl<NestedTypeRecord>::map(IO &IO) {
  482. IO.mapRequired("Type", Record.Type);
  483. IO.mapRequired("Name", Record.Name);
  484. }
  485. template <> void MemberRecordImpl<DataMemberRecord>::map(IO &IO) {
  486. IO.mapRequired("Attrs", Record.Attrs.Attrs);
  487. IO.mapRequired("Type", Record.Type);
  488. IO.mapRequired("FieldOffset", Record.FieldOffset);
  489. IO.mapRequired("Name", Record.Name);
  490. }
  491. template <> void MemberRecordImpl<StaticDataMemberRecord>::map(IO &IO) {
  492. IO.mapRequired("Attrs", Record.Attrs.Attrs);
  493. IO.mapRequired("Type", Record.Type);
  494. IO.mapRequired("Name", Record.Name);
  495. }
  496. template <> void MemberRecordImpl<EnumeratorRecord>::map(IO &IO) {
  497. IO.mapRequired("Attrs", Record.Attrs.Attrs);
  498. IO.mapRequired("Value", Record.Value);
  499. IO.mapRequired("Name", Record.Name);
  500. }
  501. template <> void MemberRecordImpl<VFPtrRecord>::map(IO &IO) {
  502. IO.mapRequired("Type", Record.Type);
  503. }
  504. template <> void MemberRecordImpl<BaseClassRecord>::map(IO &IO) {
  505. IO.mapRequired("Attrs", Record.Attrs.Attrs);
  506. IO.mapRequired("Type", Record.Type);
  507. IO.mapRequired("Offset", Record.Offset);
  508. }
  509. template <> void MemberRecordImpl<VirtualBaseClassRecord>::map(IO &IO) {
  510. IO.mapRequired("Attrs", Record.Attrs.Attrs);
  511. IO.mapRequired("BaseType", Record.BaseType);
  512. IO.mapRequired("VBPtrType", Record.VBPtrType);
  513. IO.mapRequired("VBPtrOffset", Record.VBPtrOffset);
  514. IO.mapRequired("VTableIndex", Record.VTableIndex);
  515. }
  516. template <> void MemberRecordImpl<ListContinuationRecord>::map(IO &IO) {
  517. IO.mapRequired("ContinuationIndex", Record.ContinuationIndex);
  518. }
  519. }
  520. }
  521. }
  522. template <typename T>
  523. static inline Expected<LeafRecord> fromCodeViewRecordImpl(CVType Type) {
  524. LeafRecord Result;
  525. auto Impl = std::make_shared<LeafRecordImpl<T>>(Type.kind());
  526. if (auto EC = Impl->fromCodeViewRecord(Type))
  527. return std::move(EC);
  528. Result.Leaf = Impl;
  529. return Result;
  530. }
  531. Expected<LeafRecord> LeafRecord::fromCodeViewRecord(CVType Type) {
  532. #define TYPE_RECORD(EnumName, EnumVal, ClassName) \
  533. case EnumName: \
  534. return fromCodeViewRecordImpl<ClassName##Record>(Type);
  535. #define TYPE_RECORD_ALIAS(EnumName, EnumVal, AliasName, ClassName) \
  536. TYPE_RECORD(EnumName, EnumVal, ClassName)
  537. #define MEMBER_RECORD(EnumName, EnumVal, ClassName)
  538. #define MEMBER_RECORD_ALIAS(EnumName, EnumVal, AliasName, ClassName)
  539. switch (Type.kind()) {
  540. #include "llvm/DebugInfo/CodeView/CodeViewTypes.def"
  541. default: { llvm_unreachable("Unknown leaf kind!"); }
  542. }
  543. return make_error<CodeViewError>(cv_error_code::corrupt_record);
  544. }
  545. CVType LeafRecord::toCodeViewRecord(BumpPtrAllocator &Alloc) const {
  546. TypeTableBuilder TTB(Alloc);
  547. return Leaf->toCodeViewRecord(TTB);
  548. }
  549. CVType LeafRecord::toCodeViewRecord(TypeTableBuilder &TTB) const {
  550. return Leaf->toCodeViewRecord(TTB);
  551. }
  552. namespace llvm {
  553. namespace yaml {
  554. template <> struct MappingTraits<LeafRecordBase> {
  555. static void mapping(IO &io, LeafRecordBase &Record) { Record.map(io); }
  556. };
  557. template <> struct MappingTraits<MemberRecordBase> {
  558. static void mapping(IO &io, MemberRecordBase &Record) { Record.map(io); }
  559. };
  560. }
  561. }
  562. template <typename ConcreteType>
  563. static void mapLeafRecordImpl(IO &IO, const char *Class, TypeLeafKind Kind,
  564. LeafRecord &Obj) {
  565. if (!IO.outputting())
  566. Obj.Leaf = std::make_shared<LeafRecordImpl<ConcreteType>>(Kind);
  567. if (Kind == LF_FIELDLIST)
  568. Obj.Leaf->map(IO);
  569. else
  570. IO.mapRequired(Class, *Obj.Leaf);
  571. }
  572. void MappingTraits<LeafRecord>::mapping(IO &IO, LeafRecord &Obj) {
  573. TypeLeafKind Kind;
  574. if (IO.outputting())
  575. Kind = Obj.Leaf->Kind;
  576. IO.mapRequired("Kind", Kind);
  577. #define TYPE_RECORD(EnumName, EnumVal, ClassName) \
  578. case EnumName: \
  579. mapLeafRecordImpl<ClassName##Record>(IO, #ClassName, Kind, Obj); \
  580. break;
  581. #define TYPE_RECORD_ALIAS(EnumName, EnumVal, AliasName, ClassName) \
  582. TYPE_RECORD(EnumName, EnumVal, ClassName)
  583. #define MEMBER_RECORD(EnumName, EnumVal, ClassName)
  584. #define MEMBER_RECORD_ALIAS(EnumName, EnumVal, AliasName, ClassName)
  585. switch (Kind) {
  586. #include "llvm/DebugInfo/CodeView/CodeViewTypes.def"
  587. default: { llvm_unreachable("Unknown leaf kind!"); }
  588. }
  589. }
  590. template <typename ConcreteType>
  591. static void mapMemberRecordImpl(IO &IO, const char *Class, TypeLeafKind Kind,
  592. MemberRecord &Obj) {
  593. if (!IO.outputting())
  594. Obj.Member = std::make_shared<MemberRecordImpl<ConcreteType>>(Kind);
  595. IO.mapRequired(Class, *Obj.Member);
  596. }
  597. void MappingTraits<MemberRecord>::mapping(IO &IO, MemberRecord &Obj) {
  598. TypeLeafKind Kind;
  599. if (IO.outputting())
  600. Kind = Obj.Member->Kind;
  601. IO.mapRequired("Kind", Kind);
  602. #define MEMBER_RECORD(EnumName, EnumVal, ClassName) \
  603. case EnumName: \
  604. mapMemberRecordImpl<ClassName##Record>(IO, #ClassName, Kind, Obj); \
  605. break;
  606. #define MEMBER_RECORD_ALIAS(EnumName, EnumVal, AliasName, ClassName) \
  607. MEMBER_RECORD(EnumName, EnumVal, ClassName)
  608. #define TYPE_RECORD(EnumName, EnumVal, ClassName)
  609. #define TYPE_RECORD_ALIAS(EnumName, EnumVal, AliasName, ClassName)
  610. switch (Kind) {
  611. #include "llvm/DebugInfo/CodeView/CodeViewTypes.def"
  612. default: { llvm_unreachable("Unknown member kind!"); }
  613. }
  614. }
  615. std::vector<LeafRecord>
  616. llvm::CodeViewYAML::fromDebugT(ArrayRef<uint8_t> DebugT) {
  617. ExitOnError Err("Invalid .debug$T section!");
  618. BinaryStreamReader Reader(DebugT, support::little);
  619. CVTypeArray Types;
  620. uint32_t Magic;
  621. Err(Reader.readInteger(Magic));
  622. assert(Magic == COFF::DEBUG_SECTION_MAGIC && "Invalid .debug$T section!");
  623. std::vector<LeafRecord> Result;
  624. Err(Reader.readArray(Types, Reader.bytesRemaining()));
  625. for (const auto &T : Types) {
  626. auto CVT = Err(LeafRecord::fromCodeViewRecord(T));
  627. Result.push_back(CVT);
  628. }
  629. return Result;
  630. }
  631. ArrayRef<uint8_t> llvm::CodeViewYAML::toDebugT(ArrayRef<LeafRecord> Leafs,
  632. BumpPtrAllocator &Alloc) {
  633. TypeTableBuilder TTB(Alloc, false);
  634. uint32_t Size = sizeof(uint32_t);
  635. for (const auto &Leaf : Leafs) {
  636. CVType T = Leaf.toCodeViewRecord(TTB);
  637. Size += T.length();
  638. assert(T.length() % 4 == 0 && "Improper type record alignment!");
  639. }
  640. uint8_t *ResultBuffer = Alloc.Allocate<uint8_t>(Size);
  641. MutableArrayRef<uint8_t> Output(ResultBuffer, Size);
  642. BinaryStreamWriter Writer(Output, support::little);
  643. ExitOnError Err("Error writing type record to .debug$T section");
  644. Err(Writer.writeInteger<uint32_t>(COFF::DEBUG_SECTION_MAGIC));
  645. for (const auto &R : TTB.records()) {
  646. Err(Writer.writeBytes(R));
  647. }
  648. assert(Writer.bytesRemaining() == 0 && "Didn't write all type record bytes!");
  649. return Output;
  650. }