xref: /llvm-project/llvm/lib/DebugInfo/PDB/PDBSymbolFunc.cpp (revision 7999b4fa48b31f67efa3662443a5c78343eb6f19)
1 //===- PDBSymbolFunc.cpp - --------------------------------------*- C++ -*-===//
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 #include "llvm/DebugInfo/PDB/PDBSymbolFunc.h"
11 
12 #include "llvm/DebugInfo/PDB/ConcreteSymbolEnumerator.h"
13 #include "llvm/DebugInfo/PDB/IPDBEnumChildren.h"
14 #include "llvm/DebugInfo/PDB/IPDBSession.h"
15 #include "llvm/DebugInfo/PDB/PDBSymDumper.h"
16 #include "llvm/DebugInfo/PDB/PDBSymbolData.h"
17 #include "llvm/DebugInfo/PDB/PDBSymbolTypeFunctionSig.h"
18 #include "llvm/DebugInfo/PDB/PDBTypes.h"
19 
20 #include <unordered_set>
21 #include <utility>
22 #include <vector>
23 
24 using namespace llvm;
25 using namespace llvm::pdb;
26 
27 namespace {
28 class FunctionArgEnumerator : public IPDBEnumChildren<PDBSymbolData> {
29 public:
30   typedef ConcreteSymbolEnumerator<PDBSymbolData> ArgEnumeratorType;
31 
32   FunctionArgEnumerator(const IPDBSession &PDBSession,
33                         const PDBSymbolFunc &PDBFunc)
34       : Session(PDBSession), Func(PDBFunc) {
35     // Arguments can appear multiple times if they have live range
36     // information, so we only take the first occurrence.
37     std::unordered_set<std::string> SeenNames;
38     auto DataChildren = Func.findAllChildren<PDBSymbolData>();
39     while (auto Child = DataChildren->getNext()) {
40       if (Child->getDataKind() == PDB_DataKind::Param) {
41         std::string Name = Child->getName();
42         if (SeenNames.find(Name) != SeenNames.end())
43           continue;
44         Args.push_back(std::move(Child));
45         SeenNames.insert(Name);
46       }
47     }
48     reset();
49   }
50 
51   uint32_t getChildCount() const override { return Args.size(); }
52 
53   std::unique_ptr<PDBSymbolData>
54   getChildAtIndex(uint32_t Index) const override {
55     if (Index >= Args.size())
56       return nullptr;
57 
58     return Session.getConcreteSymbolById<PDBSymbolData>(
59         Args[Index]->getSymIndexId());
60   }
61 
62   std::unique_ptr<PDBSymbolData> getNext() override {
63     if (CurIter == Args.end())
64       return nullptr;
65     const auto &Result = **CurIter;
66     ++CurIter;
67     return Session.getConcreteSymbolById<PDBSymbolData>(Result.getSymIndexId());
68   }
69 
70   void reset() override { CurIter = Args.empty() ? Args.end() : Args.begin(); }
71 
72   FunctionArgEnumerator *clone() const override {
73     return new FunctionArgEnumerator(Session, Func);
74   }
75 
76 private:
77   typedef std::vector<std::unique_ptr<PDBSymbolData>> ArgListType;
78   const IPDBSession &Session;
79   const PDBSymbolFunc &Func;
80   ArgListType Args;
81   ArgListType::const_iterator CurIter;
82 };
83 }
84 
85 std::unique_ptr<IPDBEnumChildren<PDBSymbolData>>
86 PDBSymbolFunc::getArguments() const {
87   return llvm::make_unique<FunctionArgEnumerator>(Session, *this);
88 }
89 
90 void PDBSymbolFunc::dump(PDBSymDumper &Dumper) const { Dumper.dump(*this); }
91 
92 bool PDBSymbolFunc::isDestructor() const {
93   std::string Name = getName();
94   if (Name.empty())
95     return false;
96   if (Name[0] == '~')
97     return true;
98   if (Name == "__vecDelDtor")
99     return true;
100   return false;
101 }
102 
103 std::unique_ptr<IPDBEnumLineNumbers> PDBSymbolFunc::getLineNumbers() const {
104   auto Len = RawSymbol->getLength();
105   return Session.findLineNumbersByAddress(RawSymbol->getVirtualAddress(),
106                                           Len ? Len : 1);
107 }
108 
109 uint32_t PDBSymbolFunc::getCompilandId() const {
110   if (auto Lines = getLineNumbers()) {
111     if (auto FirstLine = Lines->getNext()) {
112       return FirstLine->getCompilandId();
113     }
114   }
115   return 0;
116 }
117