blob: 746fd36208e187bba5c2aebd6d89a6caa244669b [file] [log] [blame]
//===- LookupResult.h -------------------------------------------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "llvm/DebugInfo/GSYM/Range.h"
#include "llvm/ADT/StringRef.h"
#include <inttypes.h>
#include <vector>
namespace llvm {
class raw_ostream;
namespace gsym {
struct FileEntry;
struct SourceLocation {
StringRef Name; ///< Function or symbol name.
StringRef Dir; ///< Line entry source file directory path.
StringRef Base; ///< Line entry source file basename.
uint32_t Line = 0; ///< Source file line number.
inline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) {
return LHS.Name == RHS.Name && LHS.Dir == RHS.Dir &&
LHS.Base == RHS.Base && LHS.Line == RHS.Line;
raw_ostream &operator<<(raw_ostream &OS, const SourceLocation &R);
using SourceLocations = std::vector<SourceLocation>;
struct LookupResult {
uint64_t LookupAddr = 0; ///< The address that this lookup pertains to.
AddressRange FuncRange; ///< The concrete function address range.
StringRef FuncName; ///< The concrete function name that contains LookupAddr.
/// The source locations that match this address. This information will only
/// be filled in if the FunctionInfo contains a line table. If an address is
/// for a concrete function with no inlined functions, this array will have
/// one entry. If an address points to an inline function, there will be one
/// SourceLocation for each inlined function with the last entry pointing to
/// the concrete function itself. This allows one address to generate
/// multiple locations and allows unwinding of inline call stacks. The
/// deepest inline function will appear at index zero in the source locations
/// array, and the concrete function will appear at the end of the array.
SourceLocations Locations;
std::string getSourceFile(uint32_t Index) const;
raw_ostream &operator<<(raw_ostream &OS, const LookupResult &R);
} // namespace gsym
} // namespace llvm