llvm-project/lldb/source/Symbol/Function.cpp

610 lines
15 KiB
C++
Raw Normal View History

//===-- Function.cpp --------------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "lldb/Symbol/Function.h"
#include "lldb/Core/Module.h"
#include "lldb/Core/Section.h"
#include "lldb/Host/Host.h"
#include "lldb/Symbol/ClangASTType.h"
#include "lldb/Symbol/ClangASTContext.h"
#include "lldb/Symbol/CompileUnit.h"
#include "lldb/Symbol/LineTable.h"
#include "lldb/Symbol/SymbolFile.h"
#include "lldb/Symbol/SymbolVendor.h"
#include "clang/AST/Type.h"
#include "clang/AST/CanonicalType.h"
#include "llvm/Support/Casting.h"
using namespace lldb;
using namespace lldb_private;
//----------------------------------------------------------------------
// Basic function information is contained in the FunctionInfo class.
// It is designed to contain the name, linkage name, and declaration
// location.
//----------------------------------------------------------------------
FunctionInfo::FunctionInfo (const char *name, const Declaration *decl_ptr) :
m_name(name),
m_declaration(decl_ptr)
{
}
FunctionInfo::FunctionInfo (const ConstString& name, const Declaration *decl_ptr) :
m_name(name),
m_declaration(decl_ptr)
{
}
FunctionInfo::~FunctionInfo()
{
}
void
FunctionInfo::Dump(Stream *s, bool show_fullpaths) const
{
if (m_name)
*s << ", name = \"" << m_name << "\"";
m_declaration.Dump(s, show_fullpaths);
}
int
FunctionInfo::Compare(const FunctionInfo& a, const FunctionInfo& b)
{
int result = ConstString::Compare(a.GetName(), b.GetName());
if (result)
return result;
return Declaration::Compare(a.m_declaration, b.m_declaration);
}
Declaration&
FunctionInfo::GetDeclaration()
{
return m_declaration;
}
const Declaration&
FunctionInfo::GetDeclaration() const
{
return m_declaration;
}
const ConstString&
FunctionInfo::GetName() const
{
return m_name;
}
size_t
FunctionInfo::MemorySize() const
{
return m_name.MemorySize() + m_declaration.MemorySize();
}
InlineFunctionInfo::InlineFunctionInfo
(
const char *name,
const char *mangled,
const Declaration *decl_ptr,
const Declaration *call_decl_ptr
) :
FunctionInfo(name, decl_ptr),
m_mangled(mangled, true),
m_call_decl (call_decl_ptr)
{
}
InlineFunctionInfo::InlineFunctionInfo
(
const ConstString& name,
const Mangled &mangled,
const Declaration *decl_ptr,
const Declaration *call_decl_ptr
) :
FunctionInfo(name, decl_ptr),
m_mangled(mangled),
m_call_decl (call_decl_ptr)
{
}
InlineFunctionInfo::~InlineFunctionInfo()
{
}
int
InlineFunctionInfo::Compare(const InlineFunctionInfo& a, const InlineFunctionInfo& b)
{
int result = FunctionInfo::Compare(a, b);
if (result)
return result;
// only compare the mangled names if both have them
return Mangled::Compare(a.m_mangled, a.m_mangled);
}
void
InlineFunctionInfo::Dump(Stream *s, bool show_fullpaths) const
{
FunctionInfo::Dump(s, show_fullpaths);
if (m_mangled)
m_mangled.Dump(s);
}
void
InlineFunctionInfo::DumpStopContext (Stream *s) const
{
// s->Indent("[inlined] ");
s->Indent();
if (m_mangled)
s->PutCString (m_mangled.GetName().AsCString());
else
s->PutCString (m_name.AsCString());
}
Added support for inlined stack frames being represented as real stack frames which is now on by default. Frames are gotten from the unwinder as concrete frames, then if inline frames are to be shown, extra information to track and reconstruct these frames is cached with each Thread and exanded as needed. I added an inline height as part of the lldb_private::StackID class, the class that helps us uniquely identify stack frames. This allows for two frames to shared the same call frame address, yet differ only in inline height. Fixed setting breakpoint by address to not require addresses to resolve. A quick example: % cat main.cpp % ./build/Debug/lldb test/stl/a.out Current executable set to 'test/stl/a.out' (x86_64). (lldb) breakpoint set --address 0x0000000100000d31 Breakpoint created: 1: address = 0x0000000100000d31, locations = 1 (lldb) r Launching 'a.out' (x86_64) (lldb) Process 38031 Stopped * thread #1: tid = 0x2e03, pc = 0x0000000100000d31, where = a.out`main [inlined] std::string::_M_data() const at /usr/include/c++/4.2.1/bits/basic_string.h:280, stop reason = breakpoint 1.1, queue = com.apple.main-thread 277 278 _CharT* 279 _M_data() const 280 -> { return _M_dataplus._M_p; } 281 282 _CharT* 283 _M_data(_CharT* __p) (lldb) bt thread #1: tid = 0x2e03, stop reason = breakpoint 1.1, queue = com.apple.main-thread frame #0: pc = 0x0000000100000d31, where = a.out`main [inlined] std::string::_M_data() const at /usr/include/c++/4.2.1/bits/basic_string.h:280 frame #1: pc = 0x0000000100000d31, where = a.out`main [inlined] std::string::_M_rep() const at /usr/include/c++/4.2.1/bits/basic_string.h:288 frame #2: pc = 0x0000000100000d31, where = a.out`main [inlined] std::string::size() const at /usr/include/c++/4.2.1/bits/basic_string.h:606 frame #3: pc = 0x0000000100000d31, where = a.out`main [inlined] operator<< <char, std::char_traits<char>, std::allocator<char> > at /usr/include/c++/4.2.1/bits/basic_string.h:2414 frame #4: pc = 0x0000000100000d31, where = a.out`main + 33 at /Volumes/work/gclayton/Documents/src/lldb/test/stl/main.cpp:14 frame #5: pc = 0x0000000100000d08, where = a.out`start + 52 Each inline frame contains only the variables that they contain and each inlined stack frame is treated as a single entity. llvm-svn: 111877
2010-08-24 08:45:41 +08:00
const ConstString &
InlineFunctionInfo::GetName () const
{
if (m_mangled)
return m_mangled.GetName();
return m_name;
}
Declaration &
InlineFunctionInfo::GetCallSite ()
{
return m_call_decl;
}
const Declaration &
InlineFunctionInfo::GetCallSite () const
{
return m_call_decl;
}
Mangled&
InlineFunctionInfo::GetMangled()
{
return m_mangled;
}
const Mangled&
InlineFunctionInfo::GetMangled() const
{
return m_mangled;
}
size_t
InlineFunctionInfo::MemorySize() const
{
return FunctionInfo::MemorySize() + m_mangled.MemorySize();
}
//----------------------------------------------------------------------
//
//----------------------------------------------------------------------
Function::Function
(
CompileUnit *comp_unit,
lldb::user_id_t func_uid,
lldb::user_id_t type_uid,
const Mangled &mangled,
Type * type,
const AddressRange& range
) :
UserID (func_uid),
m_comp_unit (comp_unit),
m_type_uid (type_uid),
m_type (type),
m_mangled (mangled),
m_block (func_uid),
m_range (range),
m_frame_base (),
m_flags (),
m_prologue_byte_size (0)
{
m_block.SetParentScope(this);
assert(comp_unit != NULL);
}
Function::Function
(
CompileUnit *comp_unit,
lldb::user_id_t func_uid,
lldb::user_id_t type_uid,
const char *mangled,
Type *type,
const AddressRange &range
) :
UserID (func_uid),
m_comp_unit (comp_unit),
m_type_uid (type_uid),
m_type (type),
m_mangled (mangled, true),
m_block (func_uid),
m_range (range),
m_frame_base (),
m_flags (),
m_prologue_byte_size (0)
{
m_block.SetParentScope(this);
assert(comp_unit != NULL);
}
Function::~Function()
{
}
void
Function::GetStartLineSourceInfo (FileSpec &source_file, uint32_t &line_no)
{
line_no = 0;
source_file.Clear();
if (m_comp_unit == NULL)
return;
if (m_type != NULL && m_type->GetDeclaration().GetLine() != 0)
{
source_file = m_type->GetDeclaration().GetFile();
line_no = m_type->GetDeclaration().GetLine();
}
else
{
LineTable *line_table = m_comp_unit->GetLineTable();
if (line_table == NULL)
return;
LineEntry line_entry;
if (line_table->FindLineEntryByAddress (GetAddressRange().GetBaseAddress(), line_entry, NULL))
{
line_no = line_entry.line;
source_file = line_entry.file;
}
}
}
void
Function::GetEndLineSourceInfo (FileSpec &source_file, uint32_t &line_no)
{
line_no = 0;
source_file.Clear();
// The -1 is kind of cheesy, but I want to get the last line entry for the given function, not the
// first entry of the next.
Address scratch_addr(GetAddressRange().GetBaseAddress());
scratch_addr.SetOffset (scratch_addr.GetOffset() + GetAddressRange().GetByteSize() - 1);
LineTable *line_table = m_comp_unit->GetLineTable();
if (line_table == NULL)
return;
LineEntry line_entry;
if (line_table->FindLineEntryByAddress (scratch_addr, line_entry, NULL))
{
line_no = line_entry.line;
source_file = line_entry.file;
}
}
Block &
Function::GetBlock (bool can_create)
{
if (!m_block.BlockInfoHasBeenParsed() && can_create)
{
SymbolContext sc;
CalculateSymbolContext(&sc);
if (sc.module_sp)
{
sc.module_sp->GetSymbolVendor()->ParseFunctionBlocks(sc);
}
else
{
Host::SystemLog (Host::eSystemLogError,
"error: unable to find module shared pointer for function '%s' in %s%s%s\n",
GetName().GetCString(),
m_comp_unit->GetDirectory().GetCString(),
m_comp_unit->GetDirectory() ? "/" : "",
m_comp_unit->GetFilename().GetCString());
}
m_block.SetBlockInfoHasBeenParsed (true, true);
}
return m_block;
}
CompileUnit*
Function::GetCompileUnit()
{
return m_comp_unit;
}
const CompileUnit*
Function::GetCompileUnit() const
{
return m_comp_unit;
}
Added function name types to allow us to set breakpoints by name more intelligently. The four name types we currently have are: eFunctionNameTypeFull = (1 << 1), // The function name. // For C this is the same as just the name of the function // For C++ this is the demangled version of the mangled name. // For ObjC this is the full function signature with the + or // - and the square brackets and the class and selector eFunctionNameTypeBase = (1 << 2), // The function name only, no namespaces or arguments and no class // methods or selectors will be searched. eFunctionNameTypeMethod = (1 << 3), // Find function by method name (C++) with no namespace or arguments eFunctionNameTypeSelector = (1 << 4) // Find function by selector name (ObjC) names this allows much more flexibility when setting breakoints: (lldb) breakpoint set --name main --basename (lldb) breakpoint set --name main --fullname (lldb) breakpoint set --name main --method (lldb) breakpoint set --name main --selector The default: (lldb) breakpoint set --name main will inspect the name "main" and look for any parens, or if the name starts with "-[" or "+[" and if any are found then a full name search will happen. Else a basename search will be the default. Fixed some command option structures so not all options are required when they shouldn't be. Cleaned up the breakpoint output summary. Made the "image lookup --address <addr>" output much more verbose so it shows all the important symbol context results. Added a GetDescription method to many of the SymbolContext objects for the more verbose output. llvm-svn: 107075
2010-06-29 05:30:43 +08:00
void
Function::GetDescription(Stream *s, lldb::DescriptionLevel level, Target *target)
Added function name types to allow us to set breakpoints by name more intelligently. The four name types we currently have are: eFunctionNameTypeFull = (1 << 1), // The function name. // For C this is the same as just the name of the function // For C++ this is the demangled version of the mangled name. // For ObjC this is the full function signature with the + or // - and the square brackets and the class and selector eFunctionNameTypeBase = (1 << 2), // The function name only, no namespaces or arguments and no class // methods or selectors will be searched. eFunctionNameTypeMethod = (1 << 3), // Find function by method name (C++) with no namespace or arguments eFunctionNameTypeSelector = (1 << 4) // Find function by selector name (ObjC) names this allows much more flexibility when setting breakoints: (lldb) breakpoint set --name main --basename (lldb) breakpoint set --name main --fullname (lldb) breakpoint set --name main --method (lldb) breakpoint set --name main --selector The default: (lldb) breakpoint set --name main will inspect the name "main" and look for any parens, or if the name starts with "-[" or "+[" and if any are found then a full name search will happen. Else a basename search will be the default. Fixed some command option structures so not all options are required when they shouldn't be. Cleaned up the breakpoint output summary. Made the "image lookup --address <addr>" output much more verbose so it shows all the important symbol context results. Added a GetDescription method to many of the SymbolContext objects for the more verbose output. llvm-svn: 107075
2010-06-29 05:30:43 +08:00
{
Type* func_type = GetType();
*s << "id = " << (const UserID&)*this << ", name = \"" << func_type->GetName() << "\", range = ";
Address::DumpStyle fallback_style;
if (level == eDescriptionLevelVerbose)
fallback_style = Address::DumpStyleModuleWithFileAddress;
else
fallback_style = Address::DumpStyleFileAddress;
GetAddressRange().Dump(s, target, Address::DumpStyleLoadAddress, fallback_style);
Added function name types to allow us to set breakpoints by name more intelligently. The four name types we currently have are: eFunctionNameTypeFull = (1 << 1), // The function name. // For C this is the same as just the name of the function // For C++ this is the demangled version of the mangled name. // For ObjC this is the full function signature with the + or // - and the square brackets and the class and selector eFunctionNameTypeBase = (1 << 2), // The function name only, no namespaces or arguments and no class // methods or selectors will be searched. eFunctionNameTypeMethod = (1 << 3), // Find function by method name (C++) with no namespace or arguments eFunctionNameTypeSelector = (1 << 4) // Find function by selector name (ObjC) names this allows much more flexibility when setting breakoints: (lldb) breakpoint set --name main --basename (lldb) breakpoint set --name main --fullname (lldb) breakpoint set --name main --method (lldb) breakpoint set --name main --selector The default: (lldb) breakpoint set --name main will inspect the name "main" and look for any parens, or if the name starts with "-[" or "+[" and if any are found then a full name search will happen. Else a basename search will be the default. Fixed some command option structures so not all options are required when they shouldn't be. Cleaned up the breakpoint output summary. Made the "image lookup --address <addr>" output much more verbose so it shows all the important symbol context results. Added a GetDescription method to many of the SymbolContext objects for the more verbose output. llvm-svn: 107075
2010-06-29 05:30:43 +08:00
}
void
Function::Dump(Stream *s, bool show_context) const
{
s->Printf("%p: ", this);
s->Indent();
*s << "Function" << (const UserID&)*this;
m_mangled.Dump(s);
if (m_type)
{
s->Printf(", type = %p", m_type);
}
else if (m_type_uid != LLDB_INVALID_UID)
{
s->Printf(", type_uid = 0x%8.8llx", m_type_uid);
}
s->EOL();
// Dump the root object
if (m_block.BlockInfoHasBeenParsed ())
m_block.Dump(s, m_range.GetBaseAddress().GetFileAddress(), INT_MAX, show_context);
}
void
Function::CalculateSymbolContext(SymbolContext* sc)
{
sc->function = this;
m_comp_unit->CalculateSymbolContext(sc);
}
ModuleSP
Function::CalculateSymbolContextModule ()
{
SectionSP section_sp (m_range.GetBaseAddress().GetSection());
if (section_sp)
{
SectionSP linked_section_sp (section_sp->GetLinkedSection());
if (linked_section_sp)
return linked_section_sp->GetModule();
else
return section_sp->GetModule();
}
return this->GetCompileUnit()->GetModule();
}
CompileUnit *
Function::CalculateSymbolContextCompileUnit ()
{
return this->GetCompileUnit();
}
Function *
Function::CalculateSymbolContextFunction ()
{
return this;
}
//Symbol *
//Function::CalculateSymbolContextSymbol ()
//{
// return // TODO: find the symbol for the function???
//}
void
Function::DumpSymbolContext(Stream *s)
{
m_comp_unit->DumpSymbolContext(s);
s->Printf(", Function{0x%8.8llx}", GetID());
}
size_t
Function::MemorySize () const
{
size_t mem_size = sizeof(Function) + m_block.MemorySize();
return mem_size;
}
clang::DeclContext *
Function::GetClangDeclContext()
{
SymbolContext sc;
CalculateSymbolContext (&sc);
if (!sc.module_sp)
return NULL;
SymbolVendor *sym_vendor = sc.module_sp->GetSymbolVendor();
if (!sym_vendor)
return NULL;
SymbolFile *sym_file = sym_vendor->GetSymbolFile();
if (!sym_file)
return NULL;
return sym_file->GetClangDeclContextForTypeUID (sc, m_uid);
}
Type*
Function::GetType()
{
if (m_type == NULL)
{
SymbolContext sc;
CalculateSymbolContext (&sc);
if (!sc.module_sp)
return NULL;
SymbolVendor *sym_vendor = sc.module_sp->GetSymbolVendor();
if (sym_vendor == NULL)
return NULL;
SymbolFile *sym_file = sym_vendor->GetSymbolFile();
if (sym_file == NULL)
return NULL;
m_type = sym_file->ResolveTypeUID(m_type_uid);
}
return m_type;
}
const Type*
Function::GetType() const
{
return m_type;
}
clang_type_t
Function::GetReturnClangType ()
{
clang::QualType clang_type (clang::QualType::getFromOpaquePtr(GetType()->GetClangFullType()));
const clang::FunctionType *function_type = llvm::dyn_cast<clang::FunctionType> (clang_type);
if (function_type)
return function_type->getResultType().getAsOpaquePtr();
return NULL;
}
int
Function::GetArgumentCount ()
{
clang::QualType clang_type (clang::QualType::getFromOpaquePtr(GetType()->GetClangFullType()));
assert (clang_type->isFunctionType());
if (!clang_type->isFunctionProtoType())
return -1;
const clang::FunctionProtoType *function_proto_type = llvm::dyn_cast<clang::FunctionProtoType>(clang_type);
if (function_proto_type != NULL)
return function_proto_type->getNumArgs();
return 0;
}
clang_type_t
Function::GetArgumentTypeAtIndex (size_t idx)
{
clang::QualType clang_type (clang::QualType::getFromOpaquePtr(GetType()->GetClangFullType()));
const clang::FunctionProtoType *function_proto_type = llvm::dyn_cast<clang::FunctionProtoType>(clang_type);
if (function_proto_type)
{
unsigned num_args = function_proto_type->getNumArgs();
if (idx >= num_args)
return NULL;
return (function_proto_type->arg_type_begin())[idx].getAsOpaquePtr();
}
return NULL;
}
bool
Function::IsVariadic ()
{
const clang::Type *clang_type = static_cast<clang::QualType *>(GetType()->GetClangFullType())->getTypePtr();
assert (clang_type->isFunctionType());
if (!clang_type->isFunctionProtoType())
return false;
const clang::FunctionProtoType *function_proto_type = llvm::dyn_cast<clang::FunctionProtoType>(clang_type);
if (function_proto_type)
return function_proto_type->isVariadic();
return false;
}
uint32_t
Function::GetPrologueByteSize ()
{
if (m_prologue_byte_size == 0 && m_flags.IsClear(flagsCalculatedPrologueSize))
{
m_flags.Set(flagsCalculatedPrologueSize);
LineTable* line_table = m_comp_unit->GetLineTable ();
if (line_table)
{
LineEntry first_line_entry;
uint32_t first_line_entry_idx = UINT32_MAX;
if (line_table->FindLineEntryByAddress(GetAddressRange().GetBaseAddress(), first_line_entry, &first_line_entry_idx))
{
// Make sure the first line entry isn't already the end of the prologue
addr_t prologue_end_file_addr = LLDB_INVALID_ADDRESS;
if (first_line_entry.is_prologue_end)
{
prologue_end_file_addr = first_line_entry.range.GetBaseAddress().GetFileAddress();
}
else
{
// Check the first few instructions and look for one that has
// is_prologue_end set to true.
const uint32_t last_line_entry_idx = first_line_entry_idx + 6;
LineEntry line_entry;
for (uint32_t idx = first_line_entry_idx + 1; idx < last_line_entry_idx; ++idx)
{
if (line_table->GetLineEntryAtIndex (idx, line_entry))
{
if (line_entry.is_prologue_end)
{
prologue_end_file_addr = line_entry.range.GetBaseAddress().GetFileAddress();
break;
}
}
}
}
// If we didn't find the end of the prologue in the line tables,
// then just use the end address of the first line table entry
if (prologue_end_file_addr == LLDB_INVALID_ADDRESS)
{
prologue_end_file_addr = first_line_entry.range.GetBaseAddress().GetFileAddress() + first_line_entry.range.GetByteSize();
}
const addr_t func_start_file_addr = m_range.GetBaseAddress().GetFileAddress();
const addr_t func_end_file_addr = func_start_file_addr + m_range.GetByteSize();
// Verify that this prologue end file address in the function's
// address range just to be sure
if (func_start_file_addr < prologue_end_file_addr && prologue_end_file_addr < func_end_file_addr)
{
m_prologue_byte_size = prologue_end_file_addr - func_start_file_addr;
}
}
}
}
return m_prologue_byte_size;
}