xref: /freebsd/contrib/llvm-project/llvm/lib/DebugInfo/CodeView/DebugInlineeLinesSubsection.cpp (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
1 //===- DebugInlineeLinesSubsection.cpp ------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "llvm/DebugInfo/CodeView/DebugInlineeLinesSubsection.h"
10 #include "llvm/ADT/ArrayRef.h"
11 #include "llvm/DebugInfo/CodeView/CodeView.h"
12 #include "llvm/DebugInfo/CodeView/DebugChecksumsSubsection.h"
13 #include "llvm/DebugInfo/CodeView/RecordSerialization.h"
14 #include "llvm/Support/BinaryStreamReader.h"
15 #include "llvm/Support/BinaryStreamWriter.h"
16 #include "llvm/Support/Endian.h"
17 #include "llvm/Support/Error.h"
18 #include <cassert>
19 #include <cstdint>
20 
21 using namespace llvm;
22 using namespace llvm::codeview;
23 
24 Error VarStreamArrayExtractor<InlineeSourceLine>::
25 operator()(BinaryStreamRef Stream, uint32_t &Len, InlineeSourceLine &Item) {
26   BinaryStreamReader Reader(Stream);
27 
28   if (auto EC = Reader.readObject(Item.Header))
29     return EC;
30 
31   if (HasExtraFiles) {
32     uint32_t ExtraFileCount;
33     if (auto EC = Reader.readInteger(ExtraFileCount))
34       return EC;
35     if (auto EC = Reader.readArray(Item.ExtraFiles, ExtraFileCount))
36       return EC;
37   }
38 
39   Len = Reader.getOffset();
40   return Error::success();
41 }
42 
43 DebugInlineeLinesSubsectionRef::DebugInlineeLinesSubsectionRef()
44     : DebugSubsectionRef(DebugSubsectionKind::InlineeLines) {}
45 
46 Error DebugInlineeLinesSubsectionRef::initialize(BinaryStreamReader Reader) {
47   if (auto EC = Reader.readEnum(Signature))
48     return EC;
49 
50   Lines.getExtractor().HasExtraFiles = hasExtraFiles();
51   if (auto EC = Reader.readArray(Lines, Reader.bytesRemaining()))
52     return EC;
53 
54   assert(Reader.bytesRemaining() == 0);
55   return Error::success();
56 }
57 
58 bool DebugInlineeLinesSubsectionRef::hasExtraFiles() const {
59   return Signature == InlineeLinesSignature::ExtraFiles;
60 }
61 
62 DebugInlineeLinesSubsection::DebugInlineeLinesSubsection(
63     DebugChecksumsSubsection &Checksums, bool HasExtraFiles)
64     : DebugSubsection(DebugSubsectionKind::InlineeLines), Checksums(Checksums),
65       HasExtraFiles(HasExtraFiles) {}
66 
67 uint32_t DebugInlineeLinesSubsection::calculateSerializedSize() const {
68   // 4 bytes for the signature
69   uint32_t Size = sizeof(InlineeLinesSignature);
70 
71   // one header for each entry.
72   Size += Entries.size() * sizeof(InlineeSourceLineHeader);
73   if (HasExtraFiles) {
74     // If extra files are enabled, one count for each entry.
75     Size += Entries.size() * sizeof(uint32_t);
76 
77     // And one file id for each file.
78     Size += ExtraFileCount * sizeof(uint32_t);
79   }
80   assert(Size % 4 == 0);
81   return Size;
82 }
83 
84 Error DebugInlineeLinesSubsection::commit(BinaryStreamWriter &Writer) const {
85   InlineeLinesSignature Sig = InlineeLinesSignature::Normal;
86   if (HasExtraFiles)
87     Sig = InlineeLinesSignature::ExtraFiles;
88 
89   if (auto EC = Writer.writeEnum(Sig))
90     return EC;
91 
92   for (const auto &E : Entries) {
93     if (auto EC = Writer.writeObject(E.Header))
94       return EC;
95 
96     if (!HasExtraFiles)
97       continue;
98 
99     if (auto EC = Writer.writeInteger<uint32_t>(E.ExtraFiles.size()))
100       return EC;
101     if (auto EC = Writer.writeArray(ArrayRef(E.ExtraFiles)))
102       return EC;
103   }
104 
105   return Error::success();
106 }
107 
108 void DebugInlineeLinesSubsection::addExtraFile(StringRef FileName) {
109   uint32_t Offset = Checksums.mapChecksumOffset(FileName);
110 
111   auto &Entry = Entries.back();
112   Entry.ExtraFiles.push_back(ulittle32_t(Offset));
113   ++ExtraFileCount;
114 }
115 
116 void DebugInlineeLinesSubsection::addInlineSite(TypeIndex FuncId,
117                                                 StringRef FileName,
118                                                 uint32_t SourceLine) {
119   uint32_t Offset = Checksums.mapChecksumOffset(FileName);
120 
121   Entries.emplace_back();
122   auto &Entry = Entries.back();
123   Entry.Header.FileID = Offset;
124   Entry.Header.SourceLineNum = SourceLine;
125   Entry.Header.Inlinee = FuncId;
126 }
127