10b57cec5SDimitry Andric //=- CodeViewYAMLDebugSections.h - CodeView YAMLIO debug sections -*- C++ -*-=// 20b57cec5SDimitry Andric // 30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information. 50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 60b57cec5SDimitry Andric // 70b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 80b57cec5SDimitry Andric // 90b57cec5SDimitry Andric // This file defines classes for handling the YAML representation of CodeView 100b57cec5SDimitry Andric // Debug Info. 110b57cec5SDimitry Andric // 120b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 130b57cec5SDimitry Andric 140b57cec5SDimitry Andric #ifndef LLVM_OBJECTYAML_CODEVIEWYAMLDEBUGSECTIONS_H 150b57cec5SDimitry Andric #define LLVM_OBJECTYAML_CODEVIEWYAMLDEBUGSECTIONS_H 160b57cec5SDimitry Andric 170b57cec5SDimitry Andric #include "llvm/ADT/ArrayRef.h" 180b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h" 190b57cec5SDimitry Andric #include "llvm/DebugInfo/CodeView/CodeView.h" 200b57cec5SDimitry Andric #include "llvm/DebugInfo/CodeView/DebugSubsection.h" 210b57cec5SDimitry Andric #include "llvm/DebugInfo/CodeView/DebugSubsectionRecord.h" 220b57cec5SDimitry Andric #include "llvm/Support/Error.h" 230b57cec5SDimitry Andric #include "llvm/Support/YAMLTraits.h" 240b57cec5SDimitry Andric #include <cstdint> 250b57cec5SDimitry Andric #include <memory> 260b57cec5SDimitry Andric #include <vector> 270b57cec5SDimitry Andric 280b57cec5SDimitry Andric namespace llvm { 290b57cec5SDimitry Andric 300b57cec5SDimitry Andric namespace codeview { 310b57cec5SDimitry Andric 320b57cec5SDimitry Andric class StringsAndChecksums; 330b57cec5SDimitry Andric class StringsAndChecksumsRef; 340b57cec5SDimitry Andric 350b57cec5SDimitry Andric } // end namespace codeview 360b57cec5SDimitry Andric 370b57cec5SDimitry Andric namespace CodeViewYAML { 380b57cec5SDimitry Andric 390b57cec5SDimitry Andric namespace detail { 400b57cec5SDimitry Andric 410b57cec5SDimitry Andric struct YAMLSubsectionBase; 420b57cec5SDimitry Andric 430b57cec5SDimitry Andric } // end namespace detail 440b57cec5SDimitry Andric 450b57cec5SDimitry Andric struct YAMLFrameData { 460b57cec5SDimitry Andric uint32_t RvaStart; 470b57cec5SDimitry Andric uint32_t CodeSize; 480b57cec5SDimitry Andric uint32_t LocalSize; 490b57cec5SDimitry Andric uint32_t ParamsSize; 500b57cec5SDimitry Andric uint32_t MaxStackSize; 510b57cec5SDimitry Andric StringRef FrameFunc; 520b57cec5SDimitry Andric uint32_t PrologSize; 530b57cec5SDimitry Andric uint32_t SavedRegsSize; 540b57cec5SDimitry Andric uint32_t Flags; 550b57cec5SDimitry Andric }; 560b57cec5SDimitry Andric 570b57cec5SDimitry Andric struct YAMLCrossModuleImport { 580b57cec5SDimitry Andric StringRef ModuleName; 590b57cec5SDimitry Andric std::vector<uint32_t> ImportIds; 600b57cec5SDimitry Andric }; 610b57cec5SDimitry Andric 620b57cec5SDimitry Andric struct SourceLineEntry { 630b57cec5SDimitry Andric uint32_t Offset; 640b57cec5SDimitry Andric uint32_t LineStart; 650b57cec5SDimitry Andric uint32_t EndDelta; 660b57cec5SDimitry Andric bool IsStatement; 670b57cec5SDimitry Andric }; 680b57cec5SDimitry Andric 690b57cec5SDimitry Andric struct SourceColumnEntry { 700b57cec5SDimitry Andric uint16_t StartColumn; 710b57cec5SDimitry Andric uint16_t EndColumn; 720b57cec5SDimitry Andric }; 730b57cec5SDimitry Andric 740b57cec5SDimitry Andric struct SourceLineBlock { 750b57cec5SDimitry Andric StringRef FileName; 760b57cec5SDimitry Andric std::vector<SourceLineEntry> Lines; 770b57cec5SDimitry Andric std::vector<SourceColumnEntry> Columns; 780b57cec5SDimitry Andric }; 790b57cec5SDimitry Andric 800b57cec5SDimitry Andric struct HexFormattedString { 810b57cec5SDimitry Andric std::vector<uint8_t> Bytes; 820b57cec5SDimitry Andric }; 830b57cec5SDimitry Andric 840b57cec5SDimitry Andric struct SourceFileChecksumEntry { 850b57cec5SDimitry Andric StringRef FileName; 860b57cec5SDimitry Andric codeview::FileChecksumKind Kind; 870b57cec5SDimitry Andric HexFormattedString ChecksumBytes; 880b57cec5SDimitry Andric }; 890b57cec5SDimitry Andric 900b57cec5SDimitry Andric struct SourceLineInfo { 910b57cec5SDimitry Andric uint32_t RelocOffset; 920b57cec5SDimitry Andric uint32_t RelocSegment; 930b57cec5SDimitry Andric codeview::LineFlags Flags; 940b57cec5SDimitry Andric uint32_t CodeSize; 950b57cec5SDimitry Andric std::vector<SourceLineBlock> Blocks; 960b57cec5SDimitry Andric }; 970b57cec5SDimitry Andric 980b57cec5SDimitry Andric struct InlineeSite { 990b57cec5SDimitry Andric uint32_t Inlinee; 1000b57cec5SDimitry Andric StringRef FileName; 1010b57cec5SDimitry Andric uint32_t SourceLineNum; 1020b57cec5SDimitry Andric std::vector<StringRef> ExtraFiles; 1030b57cec5SDimitry Andric }; 1040b57cec5SDimitry Andric 1050b57cec5SDimitry Andric struct InlineeInfo { 1060b57cec5SDimitry Andric bool HasExtraFiles; 1070b57cec5SDimitry Andric std::vector<InlineeSite> Sites; 1080b57cec5SDimitry Andric }; 1090b57cec5SDimitry Andric 1100b57cec5SDimitry Andric struct YAMLDebugSubsection { 1110b57cec5SDimitry Andric static Expected<YAMLDebugSubsection> 1120b57cec5SDimitry Andric fromCodeViewSubection(const codeview::StringsAndChecksumsRef &SC, 1130b57cec5SDimitry Andric const codeview::DebugSubsectionRecord &SS); 1140b57cec5SDimitry Andric 1150b57cec5SDimitry Andric std::shared_ptr<detail::YAMLSubsectionBase> Subsection; 1160b57cec5SDimitry Andric }; 1170b57cec5SDimitry Andric 1180b57cec5SDimitry Andric Expected<std::vector<std::shared_ptr<codeview::DebugSubsection>>> 1190b57cec5SDimitry Andric toCodeViewSubsectionList(BumpPtrAllocator &Allocator, 1200b57cec5SDimitry Andric ArrayRef<YAMLDebugSubsection> Subsections, 1210b57cec5SDimitry Andric const codeview::StringsAndChecksums &SC); 1220b57cec5SDimitry Andric 1230b57cec5SDimitry Andric std::vector<YAMLDebugSubsection> 1240b57cec5SDimitry Andric fromDebugS(ArrayRef<uint8_t> Data, const codeview::StringsAndChecksumsRef &SC); 1250b57cec5SDimitry Andric 1260b57cec5SDimitry Andric void initializeStringsAndChecksums(ArrayRef<YAMLDebugSubsection> Sections, 1270b57cec5SDimitry Andric codeview::StringsAndChecksums &SC); 1280b57cec5SDimitry Andric 1290b57cec5SDimitry Andric } // end namespace CodeViewYAML 1300b57cec5SDimitry Andric 1310b57cec5SDimitry Andric } // end namespace llvm 1320b57cec5SDimitry Andric 1330b57cec5SDimitry Andric LLVM_YAML_DECLARE_MAPPING_TRAITS(CodeViewYAML::YAMLDebugSubsection) 1340b57cec5SDimitry Andric 1350b57cec5SDimitry Andric LLVM_YAML_IS_SEQUENCE_VECTOR(CodeViewYAML::YAMLDebugSubsection) 1360b57cec5SDimitry Andric 1370b57cec5SDimitry Andric #endif // LLVM_OBJECTYAML_CODEVIEWYAMLDEBUGSECTIONS_H 138