LLVM  16.0.0git
LookupResult.h
Go to the documentation of this file.
1 //===- LookupResult.h -------------------------------------------*- C++ -*-===//
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 #ifndef LLVM_DEBUGINFO_GSYM_LOOKUPRESULT_H
10 #define LLVM_DEBUGINFO_GSYM_LOOKUPRESULT_H
11 
12 #include "llvm/ADT/AddressRanges.h"
13 #include "llvm/ADT/StringRef.h"
14 #include <inttypes.h>
15 #include <vector>
16 
17 namespace llvm {
18 class raw_ostream;
19 namespace gsym {
20 
22  StringRef Name; ///< Function or symbol name.
23  StringRef Dir; ///< Line entry source file directory path.
24  StringRef Base; ///< Line entry source file basename.
25  uint32_t Line = 0; ///< Source file line number.
26  uint32_t Offset = 0; ///< Byte size offset within the named function.
27 };
28 
29 inline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) {
30  return LHS.Name == RHS.Name && LHS.Dir == RHS.Dir && LHS.Base == RHS.Base &&
31  LHS.Line == RHS.Line && LHS.Offset == RHS.Offset;
32 }
33 
34 raw_ostream &operator<<(raw_ostream &OS, const SourceLocation &R);
35 
36 using SourceLocations = std::vector<SourceLocation>;
37 
38 struct LookupResult {
39  uint64_t LookupAddr = 0; ///< The address that this lookup pertains to.
40  AddressRange FuncRange; ///< The concrete function address range.
41  StringRef FuncName; ///< The concrete function name that contains LookupAddr.
42  /// The source locations that match this address. This information will only
43  /// be filled in if the FunctionInfo contains a line table. If an address is
44  /// for a concrete function with no inlined functions, this array will have
45  /// one entry. If an address points to an inline function, there will be one
46  /// SourceLocation for each inlined function with the last entry pointing to
47  /// the concrete function itself. This allows one address to generate
48  /// multiple locations and allows unwinding of inline call stacks. The
49  /// deepest inline function will appear at index zero in the source locations
50  /// array, and the concrete function will appear at the end of the array.
52  std::string getSourceFile(uint32_t Index) const;
53 };
54 
56 
57 } // namespace gsym
58 } // namespace llvm
59 
60 #endif // LLVM_DEBUGINFO_GSYM_LOOKUPRESULT_H
llvm::gsym::SourceLocations
std::vector< SourceLocation > SourceLocations
Definition: LookupResult.h:36
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
llvm::gsym::LookupResult::getSourceFile
std::string getSourceFile(uint32_t Index) const
Definition: LookupResult.cpp:20
StringRef.h
llvm::gsym::LookupResult
Definition: LookupResult.h:38
llvm::gsym::LookupResult::Locations
SourceLocations Locations
The source locations that match this address.
Definition: LookupResult.h:51
llvm::gsym::SourceLocation::Name
StringRef Name
Function or symbol name.
Definition: LookupResult.h:22
RHS
Value * RHS
Definition: X86PartialReduction.cpp:76
llvm::gsym::SourceLocation::Dir
StringRef Dir
Line entry source file directory path.
Definition: LookupResult.h:23
llvm::gsym::SourceLocation::Offset
uint32_t Offset
Byte size offset within the named function.
Definition: LookupResult.h:26
llvm::gsym::operator==
bool operator==(const FunctionInfo &LHS, const FunctionInfo &RHS)
Definition: FunctionInfo.h:183
LHS
Value * LHS
Definition: X86PartialReduction.cpp:75
AddressRanges.h
llvm::gsym::operator<<
raw_ostream & operator<<(raw_ostream &OS, const FunctionInfo &R)
Definition: FunctionInfo.cpp:28
llvm::dwarf::Index
Index
Definition: Dwarf.h:472
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:53
llvm::gsym::LookupResult::FuncRange
AddressRange FuncRange
The concrete function address range.
Definition: LookupResult.h:40
llvm::AddressRange
A class that represents an address range.
Definition: AddressRanges.h:22
uint64_t
llvm::gsym::LookupResult::LookupAddr
uint64_t LookupAddr
The address that this lookup pertains to.
Definition: LookupResult.h:39
llvm::gsym::SourceLocation::Base
StringRef Base
Line entry source file basename.
Definition: LookupResult.h:24
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
uint32_t
llvm::gsym::LookupResult::FuncName
StringRef FuncName
The concrete function name that contains LookupAddr.
Definition: LookupResult.h:41
llvm::gsym::SourceLocation
Definition: LookupResult.h:21
llvm::gsym::SourceLocation::Line
uint32_t Line
Source file line number.
Definition: LookupResult.h:25