1 //===-- CompileUnit.cpp ---------------------------------------------------===//
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 #include "lldb/Symbol/CompileUnit.h"
10 #include "lldb/Core/Module.h"
11 #include "lldb/Symbol/LineTable.h"
12 #include "lldb/Symbol/SymbolFile.h"
13 #include "lldb/Symbol/VariableList.h"
14 #include "lldb/Target/Language.h"
15 #include "lldb/Utility/Timer.h"
16 
17 using namespace lldb;
18 using namespace lldb_private;
19 
20 CompileUnit::CompileUnit(const lldb::ModuleSP &module_sp, void *user_data,
21                          const char *pathname, const lldb::user_id_t cu_sym_id,
22                          lldb::LanguageType language,
23                          lldb_private::LazyBool is_optimized)
24     : CompileUnit(module_sp, user_data, FileSpec(pathname), cu_sym_id, language,
25                   is_optimized) {}
26 
27 CompileUnit::CompileUnit(const lldb::ModuleSP &module_sp, void *user_data,
28                          const FileSpec &fspec, const lldb::user_id_t cu_sym_id,
29                          lldb::LanguageType language,
30                          lldb_private::LazyBool is_optimized)
31     : ModuleChild(module_sp), UserID(cu_sym_id), m_user_data(user_data),
32       m_language(language), m_flags(0), m_file_spec(fspec),
33       m_is_optimized(is_optimized) {
34   if (language != eLanguageTypeUnknown)
35     m_flags.Set(flagsParsedLanguage);
36   assert(module_sp);
37 }
38 
39 void CompileUnit::CalculateSymbolContext(SymbolContext *sc) {
40   sc->comp_unit = this;
41   GetModule()->CalculateSymbolContext(sc);
42 }
43 
44 ModuleSP CompileUnit::CalculateSymbolContextModule() { return GetModule(); }
45 
46 CompileUnit *CompileUnit::CalculateSymbolContextCompileUnit() { return this; }
47 
48 void CompileUnit::DumpSymbolContext(Stream *s) {
49   GetModule()->DumpSymbolContext(s);
50   s->Printf(", CompileUnit{0x%8.8" PRIx64 "}", GetID());
51 }
52 
53 void CompileUnit::GetDescription(Stream *s,
54                                  lldb::DescriptionLevel level) const {
55   const char *language = GetCachedLanguage();
56   *s << "id = " << (const UserID &)*this << ", file = \""
57      << this->GetPrimaryFile() << "\", language = \"" << language << '"';
58 }
59 
60 void CompileUnit::ForeachFunction(
61     llvm::function_ref<bool(const FunctionSP &)> lambda) const {
62   std::vector<lldb::FunctionSP> sorted_functions;
63   sorted_functions.reserve(m_functions_by_uid.size());
64   for (auto &p : m_functions_by_uid)
65     sorted_functions.push_back(p.second);
66   llvm::sort(sorted_functions.begin(), sorted_functions.end(),
67              [](const lldb::FunctionSP &a, const lldb::FunctionSP &b) {
68                return a->GetID() < b->GetID();
69              });
70 
71   for (auto &f : sorted_functions)
72     if (lambda(f))
73       return;
74 }
75 
76 lldb::FunctionSP CompileUnit::FindFunction(
77     llvm::function_ref<bool(const FunctionSP &)> matching_lambda) {
78   LLDB_SCOPED_TIMER();
79 
80   lldb::ModuleSP module = CalculateSymbolContextModule();
81 
82   if (!module)
83     return {};
84 
85   SymbolFile *symbol_file = module->GetSymbolFile();
86 
87   if (!symbol_file)
88     return {};
89 
90   // m_functions_by_uid is filled in lazily but we need all the entries.
91   symbol_file->ParseFunctions(*this);
92 
93   for (auto &p : m_functions_by_uid) {
94     if (matching_lambda(p.second))
95       return p.second;
96   }
97   return {};
98 }
99 
100 const char *CompileUnit::GetCachedLanguage() const {
101   if (m_flags.IsClear(flagsParsedLanguage))
102     return "<not loaded>";
103   return Language::GetNameForLanguageType(m_language);
104 }
105 
106 // Dump the current contents of this object. No functions that cause on demand
107 // parsing of functions, globals, statics are called, so this is a good
108 // function to call to get an idea of the current contents of the CompileUnit
109 // object.
110 void CompileUnit::Dump(Stream *s, bool show_context) const {
111   const char *language = GetCachedLanguage();
112 
113   s->Printf("%p: ", static_cast<const void *>(this));
114   s->Indent();
115   *s << "CompileUnit" << static_cast<const UserID &>(*this) << ", language = \""
116      << language << "\", file = '" << GetPrimaryFile() << "'\n";
117 
118   //  m_types.Dump(s);
119 
120   if (m_variables.get()) {
121     s->IndentMore();
122     m_variables->Dump(s, show_context);
123     s->IndentLess();
124   }
125 
126   if (!m_functions_by_uid.empty()) {
127     s->IndentMore();
128     ForeachFunction([&s, show_context](const FunctionSP &f) {
129       f->Dump(s, show_context);
130       return false;
131     });
132 
133     s->IndentLess();
134     s->EOL();
135   }
136 }
137 
138 // Add a function to this compile unit
139 void CompileUnit::AddFunction(FunctionSP &funcSP) {
140   m_functions_by_uid[funcSP->GetID()] = funcSP;
141 }
142 
143 FunctionSP CompileUnit::FindFunctionByUID(lldb::user_id_t func_uid) {
144   auto it = m_functions_by_uid.find(func_uid);
145   if (it == m_functions_by_uid.end())
146     return FunctionSP();
147   return it->second;
148 }
149 
150 lldb::LanguageType CompileUnit::GetLanguage() {
151   if (m_language == eLanguageTypeUnknown) {
152     if (m_flags.IsClear(flagsParsedLanguage)) {
153       m_flags.Set(flagsParsedLanguage);
154       if (SymbolFile *symfile = GetModule()->GetSymbolFile())
155         m_language = symfile->ParseLanguage(*this);
156     }
157   }
158   return m_language;
159 }
160 
161 LineTable *CompileUnit::GetLineTable() {
162   if (m_line_table_up == nullptr) {
163     if (m_flags.IsClear(flagsParsedLineTable)) {
164       m_flags.Set(flagsParsedLineTable);
165       if (SymbolFile *symfile = GetModule()->GetSymbolFile())
166         symfile->ParseLineTable(*this);
167     }
168   }
169   return m_line_table_up.get();
170 }
171 
172 void CompileUnit::SetLineTable(LineTable *line_table) {
173   if (line_table == nullptr)
174     m_flags.Clear(flagsParsedLineTable);
175   else
176     m_flags.Set(flagsParsedLineTable);
177   m_line_table_up.reset(line_table);
178 }
179 
180 void CompileUnit::SetSupportFiles(const FileSpecList &support_files) {
181   m_support_files = support_files;
182 }
183 
184 DebugMacros *CompileUnit::GetDebugMacros() {
185   if (m_debug_macros_sp.get() == nullptr) {
186     if (m_flags.IsClear(flagsParsedDebugMacros)) {
187       m_flags.Set(flagsParsedDebugMacros);
188       if (SymbolFile *symfile = GetModule()->GetSymbolFile())
189         symfile->ParseDebugMacros(*this);
190     }
191   }
192 
193   return m_debug_macros_sp.get();
194 }
195 
196 void CompileUnit::SetDebugMacros(const DebugMacrosSP &debug_macros_sp) {
197   if (debug_macros_sp.get() == nullptr)
198     m_flags.Clear(flagsParsedDebugMacros);
199   else
200     m_flags.Set(flagsParsedDebugMacros);
201   m_debug_macros_sp = debug_macros_sp;
202 }
203 
204 VariableListSP CompileUnit::GetVariableList(bool can_create) {
205   if (m_variables.get() == nullptr && can_create) {
206     SymbolContext sc;
207     CalculateSymbolContext(&sc);
208     assert(sc.module_sp);
209     sc.module_sp->GetSymbolFile()->ParseVariablesForContext(sc);
210   }
211 
212   return m_variables;
213 }
214 
215 std::vector<uint32_t> FindFileIndexes(const FileSpecList &files, const FileSpec &file) {
216   std::vector<uint32_t> result;
217   uint32_t idx = -1;
218   while ((idx = files.FindFileIndex(idx + 1, file, /*full=*/true)) !=
219          UINT32_MAX)
220     result.push_back(idx);
221   return result;
222 }
223 
224 uint32_t CompileUnit::FindLineEntry(uint32_t start_idx, uint32_t line,
225                                     const FileSpec *file_spec_ptr, bool exact,
226                                     LineEntry *line_entry_ptr) {
227   if (!file_spec_ptr)
228     file_spec_ptr = &GetPrimaryFile();
229   std::vector<uint32_t> file_indexes = FindFileIndexes(GetSupportFiles(), *file_spec_ptr);
230   if (file_indexes.empty())
231     return UINT32_MAX;
232 
233   // TODO: Handle SourceLocationSpec column information
234   SourceLocationSpec location_spec(*file_spec_ptr, line, /*column=*/llvm::None,
235                                    /*check_inlines=*/false, exact);
236 
237   LineTable *line_table = GetLineTable();
238   if (line_table)
239     return line_table->FindLineEntryIndexByFileIndex(
240         start_idx, file_indexes, location_spec, line_entry_ptr);
241   return UINT32_MAX;
242 }
243 
244 void CompileUnit::ResolveSymbolContext(
245     const SourceLocationSpec &src_location_spec,
246     SymbolContextItem resolve_scope, SymbolContextList &sc_list) {
247   const FileSpec file_spec = src_location_spec.GetFileSpec();
248   const uint32_t line = src_location_spec.GetLine().getValueOr(0);
249   const bool check_inlines = src_location_spec.GetCheckInlines();
250 
251   // First find all of the file indexes that match our "file_spec". If
252   // "file_spec" has an empty directory, then only compare the basenames when
253   // finding file indexes
254   std::vector<uint32_t> file_indexes;
255   bool file_spec_matches_cu_file_spec =
256       FileSpec::Match(file_spec, this->GetPrimaryFile());
257 
258   // If we are not looking for inlined functions and our file spec doesn't
259   // match then we are done...
260   if (!file_spec_matches_cu_file_spec && !check_inlines)
261     return;
262 
263   SymbolContext sc(GetModule());
264   sc.comp_unit = this;
265 
266   if (line == 0) {
267     if (file_spec_matches_cu_file_spec && !check_inlines) {
268       // only append the context if we aren't looking for inline call sites by
269       // file and line and if the file spec matches that of the compile unit
270       sc_list.Append(sc);
271     }
272     return;
273   }
274 
275   uint32_t file_idx =
276       GetSupportFiles().FindFileIndex(0, file_spec, true);
277   while (file_idx != UINT32_MAX) {
278     file_indexes.push_back(file_idx);
279     file_idx = GetSupportFiles().FindFileIndex(file_idx + 1, file_spec, true);
280   }
281 
282   const size_t num_file_indexes = file_indexes.size();
283   if (num_file_indexes == 0)
284     return;
285 
286   LineTable *line_table = sc.comp_unit->GetLineTable();
287 
288   if (line_table == nullptr) {
289     if (file_spec_matches_cu_file_spec && !check_inlines) {
290       sc_list.Append(sc);
291     }
292     return;
293   }
294 
295   uint32_t line_idx;
296   LineEntry line_entry;
297 
298   if (num_file_indexes == 1) {
299     // We only have a single support file that matches, so use the line
300     // table function that searches for a line entries that match a single
301     // support file index
302     line_idx = line_table->FindLineEntryIndexByFileIndex(
303         0, file_indexes.front(), src_location_spec, &line_entry);
304   } else {
305     // We found multiple support files that match "file_spec" so use the
306     // line table function that searches for a line entries that match a
307     // multiple support file indexes.
308     line_idx = line_table->FindLineEntryIndexByFileIndex(
309         0, file_indexes, src_location_spec, &line_entry);
310   }
311 
312   // If "exact == true", then "found_line" will be the same as "line". If
313   // "exact == false", the "found_line" will be the closest line entry
314   // with a line number greater than "line" and we will use this for our
315   // subsequent line exact matches below.
316   const bool inlines = false;
317   const bool exact = true;
318   SourceLocationSpec found_entry(line_entry.file, line_entry.line,
319                                  line_entry.column, inlines, exact);
320 
321   while (line_idx != UINT32_MAX) {
322     // If they only asked for the line entry, then we're done, we can
323     // just copy that over. But if they wanted more than just the line
324     // number, fill it in.
325     if (resolve_scope == eSymbolContextLineEntry) {
326       sc.line_entry = line_entry;
327     } else {
328       line_entry.range.GetBaseAddress().CalculateSymbolContext(&sc,
329                                                                resolve_scope);
330     }
331 
332     sc_list.Append(sc);
333     if (num_file_indexes == 1)
334       line_idx = line_table->FindLineEntryIndexByFileIndex(
335           line_idx + 1, file_indexes.front(), found_entry, &line_entry);
336     else
337       line_idx = line_table->FindLineEntryIndexByFileIndex(
338           line_idx + 1, file_indexes, found_entry, &line_entry);
339   }
340 }
341 
342 bool CompileUnit::GetIsOptimized() {
343   if (m_is_optimized == eLazyBoolCalculate) {
344     m_is_optimized = eLazyBoolNo;
345     if (SymbolFile *symfile = GetModule()->GetSymbolFile()) {
346       if (symfile->ParseIsOptimized(*this))
347         m_is_optimized = eLazyBoolYes;
348     }
349   }
350   return m_is_optimized;
351 }
352 
353 void CompileUnit::SetVariableList(VariableListSP &variables) {
354   m_variables = variables;
355 }
356 
357 const std::vector<SourceModule> &CompileUnit::GetImportedModules() {
358   if (m_imported_modules.empty() &&
359       m_flags.IsClear(flagsParsedImportedModules)) {
360     m_flags.Set(flagsParsedImportedModules);
361     if (SymbolFile *symfile = GetModule()->GetSymbolFile()) {
362       SymbolContext sc;
363       CalculateSymbolContext(&sc);
364       symfile->ParseImportedModules(sc, m_imported_modules);
365     }
366   }
367   return m_imported_modules;
368 }
369 
370 bool CompileUnit::ForEachExternalModule(
371     llvm::DenseSet<SymbolFile *> &visited_symbol_files,
372     llvm::function_ref<bool(Module &)> lambda) {
373   if (SymbolFile *symfile = GetModule()->GetSymbolFile())
374     return symfile->ForEachExternalModule(*this, visited_symbol_files, lambda);
375   return false;
376 }
377 
378 const FileSpecList &CompileUnit::GetSupportFiles() {
379   if (m_support_files.GetSize() == 0) {
380     if (m_flags.IsClear(flagsParsedSupportFiles)) {
381       m_flags.Set(flagsParsedSupportFiles);
382       if (SymbolFile *symfile = GetModule()->GetSymbolFile())
383         symfile->ParseSupportFiles(*this, m_support_files);
384     }
385   }
386   return m_support_files;
387 }
388 
389 void *CompileUnit::GetUserData() const { return m_user_data; }
390