10b57cec5SDimitry Andric //===- CVSymbolVisitor.cpp --------------------------------------*- 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 #include "llvm/DebugInfo/CodeView/CVSymbolVisitor.h"
100b57cec5SDimitry Andric
1181ad6265SDimitry Andric #include "llvm/DebugInfo/CodeView/CodeView.h"
1281ad6265SDimitry Andric #include "llvm/DebugInfo/CodeView/SymbolRecord.h"
1381ad6265SDimitry Andric #include "llvm/DebugInfo/CodeView/SymbolRecordHelpers.h"
140b57cec5SDimitry Andric #include "llvm/DebugInfo/CodeView/SymbolVisitorCallbacks.h"
1581ad6265SDimitry Andric #include "llvm/Support/BinaryStreamArray.h"
1681ad6265SDimitry Andric #include "llvm/Support/ErrorHandling.h"
170b57cec5SDimitry Andric
180b57cec5SDimitry Andric using namespace llvm;
190b57cec5SDimitry Andric using namespace llvm::codeview;
200b57cec5SDimitry Andric
CVSymbolVisitor(SymbolVisitorCallbacks & Callbacks)210b57cec5SDimitry Andric CVSymbolVisitor::CVSymbolVisitor(SymbolVisitorCallbacks &Callbacks)
220b57cec5SDimitry Andric : Callbacks(Callbacks) {}
230b57cec5SDimitry Andric
240b57cec5SDimitry Andric template <typename T>
visitKnownRecord(CVSymbol & Record,SymbolVisitorCallbacks & Callbacks)250b57cec5SDimitry Andric static Error visitKnownRecord(CVSymbol &Record,
260b57cec5SDimitry Andric SymbolVisitorCallbacks &Callbacks) {
270b57cec5SDimitry Andric SymbolRecordKind RK = static_cast<SymbolRecordKind>(Record.kind());
280b57cec5SDimitry Andric T KnownRecord(RK);
290b57cec5SDimitry Andric if (auto EC = Callbacks.visitKnownRecord(Record, KnownRecord))
300b57cec5SDimitry Andric return EC;
310b57cec5SDimitry Andric return Error::success();
320b57cec5SDimitry Andric }
330b57cec5SDimitry Andric
finishVisitation(CVSymbol & Record,SymbolVisitorCallbacks & Callbacks)340b57cec5SDimitry Andric static Error finishVisitation(CVSymbol &Record,
350b57cec5SDimitry Andric SymbolVisitorCallbacks &Callbacks) {
360b57cec5SDimitry Andric switch (Record.kind()) {
370b57cec5SDimitry Andric default:
380b57cec5SDimitry Andric if (auto EC = Callbacks.visitUnknownSymbol(Record))
390b57cec5SDimitry Andric return EC;
400b57cec5SDimitry Andric break;
410b57cec5SDimitry Andric #define SYMBOL_RECORD(EnumName, EnumVal, Name) \
420b57cec5SDimitry Andric case EnumName: { \
430b57cec5SDimitry Andric if (auto EC = visitKnownRecord<Name>(Record, Callbacks)) \
440b57cec5SDimitry Andric return EC; \
450b57cec5SDimitry Andric break; \
460b57cec5SDimitry Andric }
470b57cec5SDimitry Andric #define SYMBOL_RECORD_ALIAS(EnumName, EnumVal, Name, AliasName) \
480b57cec5SDimitry Andric SYMBOL_RECORD(EnumVal, EnumVal, AliasName)
490b57cec5SDimitry Andric #include "llvm/DebugInfo/CodeView/CodeViewSymbols.def"
500b57cec5SDimitry Andric }
510b57cec5SDimitry Andric
520b57cec5SDimitry Andric if (auto EC = Callbacks.visitSymbolEnd(Record))
530b57cec5SDimitry Andric return EC;
540b57cec5SDimitry Andric
550b57cec5SDimitry Andric return Error::success();
560b57cec5SDimitry Andric }
570b57cec5SDimitry Andric
visitSymbolRecord(CVSymbol & Record)580b57cec5SDimitry Andric Error CVSymbolVisitor::visitSymbolRecord(CVSymbol &Record) {
590b57cec5SDimitry Andric if (auto EC = Callbacks.visitSymbolBegin(Record))
600b57cec5SDimitry Andric return EC;
610b57cec5SDimitry Andric return finishVisitation(Record, Callbacks);
620b57cec5SDimitry Andric }
630b57cec5SDimitry Andric
visitSymbolRecord(CVSymbol & Record,uint32_t Offset)640b57cec5SDimitry Andric Error CVSymbolVisitor::visitSymbolRecord(CVSymbol &Record, uint32_t Offset) {
650b57cec5SDimitry Andric if (auto EC = Callbacks.visitSymbolBegin(Record, Offset))
660b57cec5SDimitry Andric return EC;
670b57cec5SDimitry Andric return finishVisitation(Record, Callbacks);
680b57cec5SDimitry Andric }
690b57cec5SDimitry Andric
visitSymbolStream(const CVSymbolArray & Symbols)700b57cec5SDimitry Andric Error CVSymbolVisitor::visitSymbolStream(const CVSymbolArray &Symbols) {
710b57cec5SDimitry Andric for (auto I : Symbols) {
720b57cec5SDimitry Andric if (auto EC = visitSymbolRecord(I))
730b57cec5SDimitry Andric return EC;
740b57cec5SDimitry Andric }
750b57cec5SDimitry Andric return Error::success();
760b57cec5SDimitry Andric }
770b57cec5SDimitry Andric
visitSymbolStream(const CVSymbolArray & Symbols,uint32_t InitialOffset)780b57cec5SDimitry Andric Error CVSymbolVisitor::visitSymbolStream(const CVSymbolArray &Symbols,
790b57cec5SDimitry Andric uint32_t InitialOffset) {
800b57cec5SDimitry Andric for (auto I : Symbols) {
810b57cec5SDimitry Andric if (auto EC = visitSymbolRecord(I, InitialOffset + Symbols.skew()))
820b57cec5SDimitry Andric return EC;
830b57cec5SDimitry Andric InitialOffset += I.length();
840b57cec5SDimitry Andric }
850b57cec5SDimitry Andric return Error::success();
860b57cec5SDimitry Andric }
8781ad6265SDimitry Andric
visitSymbolStreamFiltered(const CVSymbolArray & Symbols,const FilterOptions & Filter)8881ad6265SDimitry Andric Error CVSymbolVisitor::visitSymbolStreamFiltered(const CVSymbolArray &Symbols,
8981ad6265SDimitry Andric const FilterOptions &Filter) {
9081ad6265SDimitry Andric if (!Filter.SymbolOffset)
9181ad6265SDimitry Andric return visitSymbolStream(Symbols);
9281ad6265SDimitry Andric uint32_t SymbolOffset = *Filter.SymbolOffset;
9381ad6265SDimitry Andric uint32_t ParentRecurseDepth = Filter.ParentRecursiveDepth.value_or(0);
9481ad6265SDimitry Andric uint32_t ChildrenRecurseDepth = Filter.ChildRecursiveDepth.value_or(0);
9581ad6265SDimitry Andric if (!Symbols.isOffsetValid(SymbolOffset))
9681ad6265SDimitry Andric return createStringError(inconvertibleErrorCode(), "Invalid symbol offset");
9781ad6265SDimitry Andric CVSymbol Sym = *Symbols.at(SymbolOffset);
9881ad6265SDimitry Andric uint32_t SymEndOffset =
9981ad6265SDimitry Andric symbolOpensScope(Sym.kind()) ? getScopeEndOffset(Sym) : 0;
10081ad6265SDimitry Andric
10181ad6265SDimitry Andric std::vector<uint32_t> ParentOffsets;
10281ad6265SDimitry Andric std::vector<uint32_t> ParentEndOffsets;
10381ad6265SDimitry Andric uint32_t ChildrenDepth = 0;
10481ad6265SDimitry Andric for (auto Begin = Symbols.begin(), End = Symbols.end(); Begin != End;
10581ad6265SDimitry Andric ++Begin) {
10681ad6265SDimitry Andric uint32_t BeginOffset = Begin.offset();
10781ad6265SDimitry Andric CVSymbol BeginSym = *Begin;
10881ad6265SDimitry Andric if (BeginOffset < SymbolOffset) {
10981ad6265SDimitry Andric if (symbolOpensScope(Begin->kind())) {
11081ad6265SDimitry Andric uint32_t EndOffset = getScopeEndOffset(BeginSym);
11181ad6265SDimitry Andric if (SymbolOffset < EndOffset) {
11281ad6265SDimitry Andric ParentOffsets.push_back(BeginOffset);
11381ad6265SDimitry Andric ParentEndOffsets.push_back(EndOffset);
11481ad6265SDimitry Andric }
11581ad6265SDimitry Andric }
11681ad6265SDimitry Andric } else if (BeginOffset == SymbolOffset) {
11781ad6265SDimitry Andric // Found symbol at offset. Visit its parent up to ParentRecurseDepth.
11881ad6265SDimitry Andric if (ParentRecurseDepth >= ParentOffsets.size())
11981ad6265SDimitry Andric ParentRecurseDepth = ParentOffsets.size();
12081ad6265SDimitry Andric uint32_t StartIndex = ParentOffsets.size() - ParentRecurseDepth;
12181ad6265SDimitry Andric while (StartIndex < ParentOffsets.size()) {
12281ad6265SDimitry Andric if (!Symbols.isOffsetValid(ParentOffsets[StartIndex]))
12381ad6265SDimitry Andric break;
12481ad6265SDimitry Andric CVSymbol Parent = *Symbols.at(ParentOffsets[StartIndex]);
12581ad6265SDimitry Andric if (auto EC = visitSymbolRecord(Parent, ParentOffsets[StartIndex]))
12681ad6265SDimitry Andric return EC;
12781ad6265SDimitry Andric ++StartIndex;
12881ad6265SDimitry Andric }
12981ad6265SDimitry Andric if (auto EC = visitSymbolRecord(Sym, SymbolOffset))
13081ad6265SDimitry Andric return EC;
13181ad6265SDimitry Andric } else if (BeginOffset <= SymEndOffset) {
13281ad6265SDimitry Andric if (ChildrenRecurseDepth) {
13381ad6265SDimitry Andric // Visit children.
13481ad6265SDimitry Andric if (symbolEndsScope(Begin->kind()))
13581ad6265SDimitry Andric --ChildrenDepth;
13681ad6265SDimitry Andric if (ChildrenDepth < ChildrenRecurseDepth ||
13781ad6265SDimitry Andric BeginOffset == SymEndOffset) {
13881ad6265SDimitry Andric if (auto EC = visitSymbolRecord(BeginSym, BeginOffset))
13981ad6265SDimitry Andric return EC;
14081ad6265SDimitry Andric }
14181ad6265SDimitry Andric if (symbolOpensScope(Begin->kind()))
14281ad6265SDimitry Andric ++ChildrenDepth;
14381ad6265SDimitry Andric }
14481ad6265SDimitry Andric } else {
14581ad6265SDimitry Andric // Visit parents' ends.
14681ad6265SDimitry Andric if (ParentRecurseDepth && BeginOffset == ParentEndOffsets.back()) {
14781ad6265SDimitry Andric if (auto EC = visitSymbolRecord(BeginSym, BeginOffset))
14881ad6265SDimitry Andric return EC;
14981ad6265SDimitry Andric ParentEndOffsets.pop_back();
15081ad6265SDimitry Andric --ParentRecurseDepth;
15181ad6265SDimitry Andric }
15281ad6265SDimitry Andric }
15381ad6265SDimitry Andric }
15481ad6265SDimitry Andric return Error::success();
15581ad6265SDimitry Andric }
156