10b57cec5SDimitry Andric //===- DebugInlineeLinesSubsection.h ----------------------------*- 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 #ifndef LLVM_DEBUGINFO_CODEVIEW_DEBUGINLINEELINESSUBSECTION_H 100b57cec5SDimitry Andric #define LLVM_DEBUGINFO_CODEVIEW_DEBUGINLINEELINESSUBSECTION_H 110b57cec5SDimitry Andric 120b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h" 130b57cec5SDimitry Andric #include "llvm/DebugInfo/CodeView/CodeView.h" 140b57cec5SDimitry Andric #include "llvm/DebugInfo/CodeView/DebugSubsection.h" 150b57cec5SDimitry Andric #include "llvm/DebugInfo/CodeView/TypeIndex.h" 160b57cec5SDimitry Andric #include "llvm/Support/BinaryStreamArray.h" 170b57cec5SDimitry Andric #include "llvm/Support/BinaryStreamReader.h" 180b57cec5SDimitry Andric #include "llvm/Support/BinaryStreamRef.h" 190b57cec5SDimitry Andric #include "llvm/Support/Endian.h" 200b57cec5SDimitry Andric #include "llvm/Support/Error.h" 210b57cec5SDimitry Andric #include <cstdint> 220b57cec5SDimitry Andric #include <vector> 230b57cec5SDimitry Andric 240b57cec5SDimitry Andric namespace llvm { 250b57cec5SDimitry Andric 260b57cec5SDimitry Andric namespace codeview { 270b57cec5SDimitry Andric 280b57cec5SDimitry Andric class DebugChecksumsSubsection; 290b57cec5SDimitry Andric 300b57cec5SDimitry Andric enum class InlineeLinesSignature : uint32_t { 310b57cec5SDimitry Andric Normal, // CV_INLINEE_SOURCE_LINE_SIGNATURE 320b57cec5SDimitry Andric ExtraFiles // CV_INLINEE_SOURCE_LINE_SIGNATURE_EX 330b57cec5SDimitry Andric }; 340b57cec5SDimitry Andric 350b57cec5SDimitry Andric struct InlineeSourceLineHeader { 360b57cec5SDimitry Andric TypeIndex Inlinee; // ID of the function that was inlined. 370b57cec5SDimitry Andric support::ulittle32_t FileID; // Offset into FileChecksums subsection. 380b57cec5SDimitry Andric support::ulittle32_t SourceLineNum; // First line of inlined code. 390b57cec5SDimitry Andric // If extra files present: 400b57cec5SDimitry Andric // ulittle32_t ExtraFileCount; 410b57cec5SDimitry Andric // ulittle32_t Files[]; 420b57cec5SDimitry Andric }; 430b57cec5SDimitry Andric 440b57cec5SDimitry Andric struct InlineeSourceLine { 450b57cec5SDimitry Andric const InlineeSourceLineHeader *Header; 460b57cec5SDimitry Andric FixedStreamArray<support::ulittle32_t> ExtraFiles; 470b57cec5SDimitry Andric }; 480b57cec5SDimitry Andric 490b57cec5SDimitry Andric } // end namespace codeview 500b57cec5SDimitry Andric 510b57cec5SDimitry Andric template <> struct VarStreamArrayExtractor<codeview::InlineeSourceLine> { 520b57cec5SDimitry Andric Error operator()(BinaryStreamRef Stream, uint32_t &Len, 530b57cec5SDimitry Andric codeview::InlineeSourceLine &Item); 540b57cec5SDimitry Andric 550b57cec5SDimitry Andric bool HasExtraFiles = false; 560b57cec5SDimitry Andric }; 570b57cec5SDimitry Andric 580b57cec5SDimitry Andric namespace codeview { 590b57cec5SDimitry Andric 600b57cec5SDimitry Andric class DebugInlineeLinesSubsectionRef final : public DebugSubsectionRef { 610b57cec5SDimitry Andric using LinesArray = VarStreamArray<InlineeSourceLine>; 620b57cec5SDimitry Andric using Iterator = LinesArray::Iterator; 630b57cec5SDimitry Andric 640b57cec5SDimitry Andric public: 650b57cec5SDimitry Andric DebugInlineeLinesSubsectionRef(); 660b57cec5SDimitry Andric 670b57cec5SDimitry Andric static bool classof(const DebugSubsectionRef *S) { 680b57cec5SDimitry Andric return S->kind() == DebugSubsectionKind::InlineeLines; 690b57cec5SDimitry Andric } 700b57cec5SDimitry Andric 710b57cec5SDimitry Andric Error initialize(BinaryStreamReader Reader); 720b57cec5SDimitry Andric Error initialize(BinaryStreamRef Section) { 730b57cec5SDimitry Andric return initialize(BinaryStreamReader(Section)); 740b57cec5SDimitry Andric } 750b57cec5SDimitry Andric 760b57cec5SDimitry Andric bool valid() const { return Lines.valid(); } 770b57cec5SDimitry Andric bool hasExtraFiles() const; 780b57cec5SDimitry Andric 790b57cec5SDimitry Andric Iterator begin() const { return Lines.begin(); } 800b57cec5SDimitry Andric Iterator end() const { return Lines.end(); } 810b57cec5SDimitry Andric 820b57cec5SDimitry Andric private: 830b57cec5SDimitry Andric InlineeLinesSignature Signature; 840b57cec5SDimitry Andric LinesArray Lines; 850b57cec5SDimitry Andric }; 860b57cec5SDimitry Andric 870b57cec5SDimitry Andric class DebugInlineeLinesSubsection final : public DebugSubsection { 880b57cec5SDimitry Andric public: 890b57cec5SDimitry Andric struct Entry { 900b57cec5SDimitry Andric std::vector<support::ulittle32_t> ExtraFiles; 910b57cec5SDimitry Andric InlineeSourceLineHeader Header; 920b57cec5SDimitry Andric }; 930b57cec5SDimitry Andric 940b57cec5SDimitry Andric DebugInlineeLinesSubsection(DebugChecksumsSubsection &Checksums, 950b57cec5SDimitry Andric bool HasExtraFiles = false); 960b57cec5SDimitry Andric 970b57cec5SDimitry Andric static bool classof(const DebugSubsection *S) { 980b57cec5SDimitry Andric return S->kind() == DebugSubsectionKind::InlineeLines; 990b57cec5SDimitry Andric } 1000b57cec5SDimitry Andric 1010b57cec5SDimitry Andric Error commit(BinaryStreamWriter &Writer) const override; 1020b57cec5SDimitry Andric uint32_t calculateSerializedSize() const override; 1030b57cec5SDimitry Andric 1040b57cec5SDimitry Andric void addInlineSite(TypeIndex FuncId, StringRef FileName, uint32_t SourceLine); 1050b57cec5SDimitry Andric void addExtraFile(StringRef FileName); 1060b57cec5SDimitry Andric 1070b57cec5SDimitry Andric bool hasExtraFiles() const { return HasExtraFiles; } 1080b57cec5SDimitry Andric void setHasExtraFiles(bool Has) { HasExtraFiles = Has; } 1090b57cec5SDimitry Andric 1100b57cec5SDimitry Andric std::vector<Entry>::const_iterator begin() const { return Entries.begin(); } 1110b57cec5SDimitry Andric std::vector<Entry>::const_iterator end() const { return Entries.end(); } 1120b57cec5SDimitry Andric 1130b57cec5SDimitry Andric private: 1140b57cec5SDimitry Andric DebugChecksumsSubsection &Checksums; 1150b57cec5SDimitry Andric bool HasExtraFiles = false; 1160b57cec5SDimitry Andric uint32_t ExtraFileCount = 0; 1170b57cec5SDimitry Andric std::vector<Entry> Entries; 1180b57cec5SDimitry Andric }; 1190b57cec5SDimitry Andric 1200b57cec5SDimitry Andric } // end namespace codeview 1210b57cec5SDimitry Andric 1220b57cec5SDimitry Andric } // end namespace llvm 1230b57cec5SDimitry Andric 1240b57cec5SDimitry Andric #endif // LLVM_DEBUGINFO_CODEVIEW_DEBUGINLINEELINESSUBSECTION_H 125