1 //===-- Function.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 "lldb/Symbol/Function.h"
11 #include "lldb/Core/Disassembler.h"
12 #include "lldb/Core/Module.h"
13 #include "lldb/Core/Section.h"
14 #include "lldb/Host/Host.h"
15 #include "lldb/Symbol/CompileUnit.h"
16 #include "lldb/Symbol/CompilerType.h"
17 #include "lldb/Symbol/LineTable.h"
18 #include "lldb/Symbol/SymbolFile.h"
19 #include "lldb/Symbol/SymbolVendor.h"
20 #include "lldb/Target/Language.h"
21 #include "llvm/Support/Casting.h"
22 
23 using namespace lldb;
24 using namespace lldb_private;
25 
26 //----------------------------------------------------------------------
27 // Basic function information is contained in the FunctionInfo class.
28 // It is designed to contain the name, linkage name, and declaration
29 // location.
30 //----------------------------------------------------------------------
31 FunctionInfo::FunctionInfo(const char *name, const Declaration *decl_ptr)
32     : m_name(name), m_declaration(decl_ptr) {}
33 
34 FunctionInfo::FunctionInfo(const ConstString &name, const Declaration *decl_ptr)
35     : m_name(name), m_declaration(decl_ptr) {}
36 
37 FunctionInfo::~FunctionInfo() {}
38 
39 void FunctionInfo::Dump(Stream *s, bool show_fullpaths) const {
40   if (m_name)
41     *s << ", name = \"" << m_name << "\"";
42   m_declaration.Dump(s, show_fullpaths);
43 }
44 
45 int FunctionInfo::Compare(const FunctionInfo &a, const FunctionInfo &b) {
46   int result = ConstString::Compare(a.GetName(), b.GetName());
47   if (result)
48     return result;
49 
50   return Declaration::Compare(a.m_declaration, b.m_declaration);
51 }
52 
53 Declaration &FunctionInfo::GetDeclaration() { return m_declaration; }
54 
55 const Declaration &FunctionInfo::GetDeclaration() const {
56   return m_declaration;
57 }
58 
59 ConstString FunctionInfo::GetName() const { return m_name; }
60 
61 size_t FunctionInfo::MemorySize() const {
62   return m_name.MemorySize() + m_declaration.MemorySize();
63 }
64 
65 InlineFunctionInfo::InlineFunctionInfo(const char *name, const char *mangled,
66                                        const Declaration *decl_ptr,
67                                        const Declaration *call_decl_ptr)
68     : FunctionInfo(name, decl_ptr), m_mangled(ConstString(mangled), true),
69       m_call_decl(call_decl_ptr) {}
70 
71 InlineFunctionInfo::InlineFunctionInfo(const ConstString &name,
72                                        const Mangled &mangled,
73                                        const Declaration *decl_ptr,
74                                        const Declaration *call_decl_ptr)
75     : FunctionInfo(name, decl_ptr), m_mangled(mangled),
76       m_call_decl(call_decl_ptr) {}
77 
78 InlineFunctionInfo::~InlineFunctionInfo() {}
79 
80 int InlineFunctionInfo::Compare(const InlineFunctionInfo &a,
81                                 const InlineFunctionInfo &b) {
82 
83   int result = FunctionInfo::Compare(a, b);
84   if (result)
85     return result;
86   // only compare the mangled names if both have them
87   return Mangled::Compare(a.m_mangled, a.m_mangled);
88 }
89 
90 void InlineFunctionInfo::Dump(Stream *s, bool show_fullpaths) const {
91   FunctionInfo::Dump(s, show_fullpaths);
92   if (m_mangled)
93     m_mangled.Dump(s);
94 }
95 
96 void InlineFunctionInfo::DumpStopContext(Stream *s,
97                                          LanguageType language) const {
98   //    s->Indent("[inlined] ");
99   s->Indent();
100   if (m_mangled)
101     s->PutCString(m_mangled.GetName(language).AsCString());
102   else
103     s->PutCString(m_name.AsCString());
104 }
105 
106 ConstString InlineFunctionInfo::GetName(LanguageType language) const {
107   if (m_mangled)
108     return m_mangled.GetName(language);
109   return m_name;
110 }
111 
112 ConstString InlineFunctionInfo::GetDisplayName(LanguageType language) const {
113   if (m_mangled)
114     return m_mangled.GetDisplayDemangledName(language);
115   return m_name;
116 }
117 
118 Declaration &InlineFunctionInfo::GetCallSite() { return m_call_decl; }
119 
120 const Declaration &InlineFunctionInfo::GetCallSite() const {
121   return m_call_decl;
122 }
123 
124 Mangled &InlineFunctionInfo::GetMangled() { return m_mangled; }
125 
126 const Mangled &InlineFunctionInfo::GetMangled() const { return m_mangled; }
127 
128 size_t InlineFunctionInfo::MemorySize() const {
129   return FunctionInfo::MemorySize() + m_mangled.MemorySize();
130 }
131 
132 //----------------------------------------------------------------------
133 //
134 //----------------------------------------------------------------------
135 Function::Function(CompileUnit *comp_unit, lldb::user_id_t func_uid,
136                    lldb::user_id_t type_uid, const Mangled &mangled, Type *type,
137                    const AddressRange &range)
138     : UserID(func_uid), m_comp_unit(comp_unit), m_type_uid(type_uid),
139       m_type(type), m_mangled(mangled), m_block(func_uid), m_range(range),
140       m_frame_base(nullptr), m_flags(), m_prologue_byte_size(0) {
141   m_block.SetParentScope(this);
142   assert(comp_unit != nullptr);
143 }
144 
145 Function::Function(CompileUnit *comp_unit, lldb::user_id_t func_uid,
146                    lldb::user_id_t type_uid, const char *mangled, Type *type,
147                    const AddressRange &range)
148     : UserID(func_uid), m_comp_unit(comp_unit), m_type_uid(type_uid),
149       m_type(type), m_mangled(ConstString(mangled), true), m_block(func_uid),
150       m_range(range), m_frame_base(nullptr), m_flags(),
151       m_prologue_byte_size(0) {
152   m_block.SetParentScope(this);
153   assert(comp_unit != nullptr);
154 }
155 
156 Function::~Function() {}
157 
158 void Function::GetStartLineSourceInfo(FileSpec &source_file,
159                                       uint32_t &line_no) {
160   line_no = 0;
161   source_file.Clear();
162 
163   if (m_comp_unit == nullptr)
164     return;
165 
166   // Initialize m_type if it hasn't been initialized already
167   GetType();
168 
169   if (m_type != nullptr && m_type->GetDeclaration().GetLine() != 0) {
170     source_file = m_type->GetDeclaration().GetFile();
171     line_no = m_type->GetDeclaration().GetLine();
172   } else {
173     LineTable *line_table = m_comp_unit->GetLineTable();
174     if (line_table == nullptr)
175       return;
176 
177     LineEntry line_entry;
178     if (line_table->FindLineEntryByAddress(GetAddressRange().GetBaseAddress(),
179                                            line_entry, nullptr)) {
180       line_no = line_entry.line;
181       source_file = line_entry.file;
182     }
183   }
184 }
185 
186 void Function::GetEndLineSourceInfo(FileSpec &source_file, uint32_t &line_no) {
187   line_no = 0;
188   source_file.Clear();
189 
190   // The -1 is kind of cheesy, but I want to get the last line entry for the
191   // given function, not the
192   // first entry of the next.
193   Address scratch_addr(GetAddressRange().GetBaseAddress());
194   scratch_addr.SetOffset(scratch_addr.GetOffset() +
195                          GetAddressRange().GetByteSize() - 1);
196 
197   LineTable *line_table = m_comp_unit->GetLineTable();
198   if (line_table == nullptr)
199     return;
200 
201   LineEntry line_entry;
202   if (line_table->FindLineEntryByAddress(scratch_addr, line_entry, nullptr)) {
203     line_no = line_entry.line;
204     source_file = line_entry.file;
205   }
206 }
207 
208 Block &Function::GetBlock(bool can_create) {
209   if (!m_block.BlockInfoHasBeenParsed() && can_create) {
210     SymbolContext sc;
211     CalculateSymbolContext(&sc);
212     if (sc.module_sp) {
213       sc.module_sp->GetSymbolVendor()->ParseFunctionBlocks(sc);
214     } else {
215       Host::SystemLog(Host::eSystemLogError, "error: unable to find module "
216                                              "shared pointer for function '%s' "
217                                              "in %s\n",
218                       GetName().GetCString(), m_comp_unit->GetPath().c_str());
219     }
220     m_block.SetBlockInfoHasBeenParsed(true, true);
221   }
222   return m_block;
223 }
224 
225 CompileUnit *Function::GetCompileUnit() { return m_comp_unit; }
226 
227 const CompileUnit *Function::GetCompileUnit() const { return m_comp_unit; }
228 
229 void Function::GetDescription(Stream *s, lldb::DescriptionLevel level,
230                               Target *target) {
231   Type *func_type = GetType();
232   const char *name = func_type ? func_type->GetName().AsCString() : "<unknown>";
233 
234   *s << "id = " << (const UserID &)*this << ", name = \"" << name
235      << "\", range = ";
236 
237   Address::DumpStyle fallback_style;
238   if (level == eDescriptionLevelVerbose)
239     fallback_style = Address::DumpStyleModuleWithFileAddress;
240   else
241     fallback_style = Address::DumpStyleFileAddress;
242   GetAddressRange().Dump(s, target, Address::DumpStyleLoadAddress,
243                          fallback_style);
244 }
245 
246 void Function::Dump(Stream *s, bool show_context) const {
247   s->Printf("%p: ", static_cast<const void *>(this));
248   s->Indent();
249   *s << "Function" << static_cast<const UserID &>(*this);
250 
251   m_mangled.Dump(s);
252 
253   if (m_type)
254     s->Printf(", type = %p", static_cast<void *>(m_type));
255   else if (m_type_uid != LLDB_INVALID_UID)
256     s->Printf(", type_uid = 0x%8.8" PRIx64, m_type_uid);
257 
258   s->EOL();
259   // Dump the root object
260   if (m_block.BlockInfoHasBeenParsed())
261     m_block.Dump(s, m_range.GetBaseAddress().GetFileAddress(), INT_MAX,
262                  show_context);
263 }
264 
265 void Function::CalculateSymbolContext(SymbolContext *sc) {
266   sc->function = this;
267   m_comp_unit->CalculateSymbolContext(sc);
268 }
269 
270 ModuleSP Function::CalculateSymbolContextModule() {
271   SectionSP section_sp(m_range.GetBaseAddress().GetSection());
272   if (section_sp)
273     return section_sp->GetModule();
274 
275   return this->GetCompileUnit()->GetModule();
276 }
277 
278 CompileUnit *Function::CalculateSymbolContextCompileUnit() {
279   return this->GetCompileUnit();
280 }
281 
282 Function *Function::CalculateSymbolContextFunction() { return this; }
283 
284 lldb::DisassemblerSP Function::GetInstructions(const ExecutionContext &exe_ctx,
285                                                const char *flavor,
286                                                bool prefer_file_cache) {
287   ModuleSP module_sp(GetAddressRange().GetBaseAddress().GetModule());
288   if (module_sp) {
289     const bool prefer_file_cache = false;
290     return Disassembler::DisassembleRange(module_sp->GetArchitecture(), nullptr,
291                                           flavor, exe_ctx, GetAddressRange(),
292                                           prefer_file_cache);
293   }
294   return lldb::DisassemblerSP();
295 }
296 
297 bool Function::GetDisassembly(const ExecutionContext &exe_ctx,
298                               const char *flavor, bool prefer_file_cache,
299                               Stream &strm) {
300   lldb::DisassemblerSP disassembler_sp =
301       GetInstructions(exe_ctx, flavor, prefer_file_cache);
302   if (disassembler_sp) {
303     const bool show_address = true;
304     const bool show_bytes = false;
305     disassembler_sp->GetInstructionList().Dump(&strm, show_address, show_bytes,
306                                                &exe_ctx);
307     return true;
308   }
309   return false;
310 }
311 
312 // Symbol *
313 // Function::CalculateSymbolContextSymbol ()
314 //{
315 //    return // TODO: find the symbol for the function???
316 //}
317 
318 void Function::DumpSymbolContext(Stream *s) {
319   m_comp_unit->DumpSymbolContext(s);
320   s->Printf(", Function{0x%8.8" PRIx64 "}", GetID());
321 }
322 
323 size_t Function::MemorySize() const {
324   size_t mem_size = sizeof(Function) + m_block.MemorySize();
325   return mem_size;
326 }
327 
328 bool Function::GetIsOptimized() {
329   bool result = false;
330 
331   // Currently optimization is only indicted by the
332   // vendor extension DW_AT_APPLE_optimized which
333   // is set on a compile unit level.
334   if (m_comp_unit) {
335     result = m_comp_unit->GetIsOptimized();
336   }
337   return result;
338 }
339 
340 bool Function::IsTopLevelFunction() {
341   bool result = false;
342 
343   if (Language *language = Language::FindPlugin(GetLanguage()))
344     result = language->IsTopLevelFunction(*this);
345 
346   return result;
347 }
348 
349 ConstString Function::GetDisplayName() const {
350   return m_mangled.GetDisplayDemangledName(GetLanguage());
351 }
352 
353 CompilerDeclContext Function::GetDeclContext() {
354   ModuleSP module_sp = CalculateSymbolContextModule();
355 
356   if (module_sp) {
357     SymbolVendor *sym_vendor = module_sp->GetSymbolVendor();
358 
359     if (sym_vendor) {
360       SymbolFile *sym_file = sym_vendor->GetSymbolFile();
361 
362       if (sym_file)
363         return sym_file->GetDeclContextForUID(GetID());
364     }
365   }
366   return CompilerDeclContext();
367 }
368 
369 Type *Function::GetType() {
370   if (m_type == nullptr) {
371     SymbolContext sc;
372 
373     CalculateSymbolContext(&sc);
374 
375     if (!sc.module_sp)
376       return nullptr;
377 
378     SymbolVendor *sym_vendor = sc.module_sp->GetSymbolVendor();
379 
380     if (sym_vendor == nullptr)
381       return nullptr;
382 
383     SymbolFile *sym_file = sym_vendor->GetSymbolFile();
384 
385     if (sym_file == nullptr)
386       return nullptr;
387 
388     m_type = sym_file->ResolveTypeUID(m_type_uid);
389   }
390   return m_type;
391 }
392 
393 const Type *Function::GetType() const { return m_type; }
394 
395 CompilerType Function::GetCompilerType() {
396   Type *function_type = GetType();
397   if (function_type)
398     return function_type->GetFullCompilerType();
399   return CompilerType();
400 }
401 
402 uint32_t Function::GetPrologueByteSize() {
403   if (m_prologue_byte_size == 0 &&
404       m_flags.IsClear(flagsCalculatedPrologueSize)) {
405     m_flags.Set(flagsCalculatedPrologueSize);
406     LineTable *line_table = m_comp_unit->GetLineTable();
407     uint32_t prologue_end_line_idx = 0;
408 
409     if (line_table) {
410       LineEntry first_line_entry;
411       uint32_t first_line_entry_idx = UINT32_MAX;
412       if (line_table->FindLineEntryByAddress(GetAddressRange().GetBaseAddress(),
413                                              first_line_entry,
414                                              &first_line_entry_idx)) {
415         // Make sure the first line entry isn't already the end of the prologue
416         addr_t prologue_end_file_addr = LLDB_INVALID_ADDRESS;
417         addr_t line_zero_end_file_addr = LLDB_INVALID_ADDRESS;
418 
419         if (first_line_entry.is_prologue_end) {
420           prologue_end_file_addr =
421               first_line_entry.range.GetBaseAddress().GetFileAddress();
422           prologue_end_line_idx = first_line_entry_idx;
423         } else {
424           // Check the first few instructions and look for one that has
425           // is_prologue_end set to true.
426           const uint32_t last_line_entry_idx = first_line_entry_idx + 6;
427           for (uint32_t idx = first_line_entry_idx + 1;
428                idx < last_line_entry_idx; ++idx) {
429             LineEntry line_entry;
430             if (line_table->GetLineEntryAtIndex(idx, line_entry)) {
431               if (line_entry.is_prologue_end) {
432                 prologue_end_file_addr =
433                     line_entry.range.GetBaseAddress().GetFileAddress();
434                 prologue_end_line_idx = idx;
435                 break;
436               }
437             }
438           }
439         }
440 
441         // If we didn't find the end of the prologue in the line tables,
442         // then just use the end address of the first line table entry
443         if (prologue_end_file_addr == LLDB_INVALID_ADDRESS) {
444           // Check the first few instructions and look for one that has
445           // a line number that's different than the first entry.
446           uint32_t last_line_entry_idx = first_line_entry_idx + 6;
447           for (uint32_t idx = first_line_entry_idx + 1;
448                idx < last_line_entry_idx; ++idx) {
449             LineEntry line_entry;
450             if (line_table->GetLineEntryAtIndex(idx, line_entry)) {
451               if (line_entry.line != first_line_entry.line) {
452                 prologue_end_file_addr =
453                     line_entry.range.GetBaseAddress().GetFileAddress();
454                 prologue_end_line_idx = idx;
455                 break;
456               }
457             }
458           }
459 
460           if (prologue_end_file_addr == LLDB_INVALID_ADDRESS) {
461             prologue_end_file_addr =
462                 first_line_entry.range.GetBaseAddress().GetFileAddress() +
463                 first_line_entry.range.GetByteSize();
464             prologue_end_line_idx = first_line_entry_idx;
465           }
466         }
467 
468         const addr_t func_start_file_addr =
469             m_range.GetBaseAddress().GetFileAddress();
470         const addr_t func_end_file_addr =
471             func_start_file_addr + m_range.GetByteSize();
472 
473         // Now calculate the offset to pass the subsequent line 0 entries.
474         uint32_t first_non_zero_line = prologue_end_line_idx;
475         while (1) {
476           LineEntry line_entry;
477           if (line_table->GetLineEntryAtIndex(first_non_zero_line,
478                                               line_entry)) {
479             if (line_entry.line != 0)
480               break;
481           }
482           if (line_entry.range.GetBaseAddress().GetFileAddress() >=
483               func_end_file_addr)
484             break;
485 
486           first_non_zero_line++;
487         }
488 
489         if (first_non_zero_line > prologue_end_line_idx) {
490           LineEntry first_non_zero_entry;
491           if (line_table->GetLineEntryAtIndex(first_non_zero_line,
492                                               first_non_zero_entry)) {
493             line_zero_end_file_addr =
494                 first_non_zero_entry.range.GetBaseAddress().GetFileAddress();
495           }
496         }
497 
498         // Verify that this prologue end file address in the function's
499         // address range just to be sure
500         if (func_start_file_addr < prologue_end_file_addr &&
501             prologue_end_file_addr < func_end_file_addr) {
502           m_prologue_byte_size = prologue_end_file_addr - func_start_file_addr;
503         }
504 
505         if (prologue_end_file_addr < line_zero_end_file_addr &&
506             line_zero_end_file_addr < func_end_file_addr) {
507           m_prologue_byte_size +=
508               line_zero_end_file_addr - prologue_end_file_addr;
509         }
510       }
511     }
512   }
513 
514   return m_prologue_byte_size;
515 }
516 
517 lldb::LanguageType Function::GetLanguage() const {
518   if (m_comp_unit)
519     return m_comp_unit->GetLanguage();
520   else
521     return lldb::eLanguageTypeUnknown;
522 }
523 
524 ConstString Function::GetName() const {
525   LanguageType language = lldb::eLanguageTypeUnknown;
526   if (m_comp_unit)
527     language = m_comp_unit->GetLanguage();
528   return m_mangled.GetName(language);
529 }
530 
531 ConstString Function::GetNameNoArguments() const {
532   LanguageType language = lldb::eLanguageTypeUnknown;
533   if (m_comp_unit)
534     language = m_comp_unit->GetLanguage();
535   return m_mangled.GetName(language, Mangled::ePreferDemangledWithoutArguments);
536 }
537