LLDB  mainline
Statistics.cpp
Go to the documentation of this file.
1 //===-- Statistics.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 
10 
11 #include "lldb/Core/Debugger.h"
12 #include "lldb/Core/Module.h"
13 #include "lldb/Symbol/SymbolFile.h"
14 #include "lldb/Target/Process.h"
15 #include "lldb/Target/Target.h"
17 
18 using namespace lldb;
19 using namespace lldb_private;
20 using namespace llvm;
21 
22 static void EmplaceSafeString(llvm::json::Object &obj, llvm::StringRef key,
23  const std::string &str) {
24  if (str.empty())
25  return;
26  if (LLVM_LIKELY(llvm::json::isUTF8(str)))
27  obj.try_emplace(key, str);
28  else
29  obj.try_emplace(key, llvm::json::fixUTF8(str));
30 }
31 
32 json::Value StatsSuccessFail::ToJSON() const {
33  return json::Object{{"successes", successes}, {"failures", failures}};
34 }
35 
36 static double elapsed(const StatsTimepoint &start, const StatsTimepoint &end) {
38  end.time_since_epoch() - start.time_since_epoch();
39  return elapsed.count();
40 }
41 
42 void TargetStats::CollectStats(Target &target) {
43  m_module_identifiers.clear();
44  for (ModuleSP module_sp : target.GetImages().Modules())
45  m_module_identifiers.emplace_back((intptr_t)module_sp.get());
46 }
47 
48 json::Value ModuleStats::ToJSON() const {
49  json::Object module;
50  EmplaceSafeString(module, "path", path);
51  EmplaceSafeString(module, "uuid", uuid);
52  EmplaceSafeString(module, "triple", triple);
53  module.try_emplace("identifier", identifier);
54  module.try_emplace("symbolTableParseTime", symtab_parse_time);
55  module.try_emplace("symbolTableIndexTime", symtab_index_time);
56  module.try_emplace("symbolTableLoadedFromCache", symtab_loaded_from_cache);
57  module.try_emplace("symbolTableSavedToCache", symtab_saved_to_cache);
58  module.try_emplace("debugInfoParseTime", debug_parse_time);
59  module.try_emplace("debugInfoIndexTime", debug_index_time);
60  module.try_emplace("debugInfoByteSize", (int64_t)debug_info_size);
61  module.try_emplace("debugInfoIndexLoadedFromCache",
62  debug_info_index_loaded_from_cache);
63  module.try_emplace("debugInfoIndexSavedToCache",
64  debug_info_index_saved_to_cache);
65  return module;
66 }
67 
68 json::Value TargetStats::ToJSON(Target &target) {
69  CollectStats(target);
70 
71  json::Array json_module_uuid_array;
72  for (auto module_identifier : m_module_identifiers)
73  json_module_uuid_array.emplace_back(module_identifier);
74 
75  json::Object target_metrics_json{
76  {m_expr_eval.name, m_expr_eval.ToJSON()},
77  {m_frame_var.name, m_frame_var.ToJSON()},
78  {"moduleIdentifiers", std::move(json_module_uuid_array)}};
79 
80  if (m_launch_or_attach_time && m_first_private_stop_time) {
81  double elapsed_time =
82  elapsed(*m_launch_or_attach_time, *m_first_private_stop_time);
83  target_metrics_json.try_emplace("launchOrAttachTime", elapsed_time);
84  }
85  if (m_launch_or_attach_time && m_first_public_stop_time) {
86  double elapsed_time =
87  elapsed(*m_launch_or_attach_time, *m_first_public_stop_time);
88  target_metrics_json.try_emplace("firstStopTime", elapsed_time);
89  }
90  target_metrics_json.try_emplace("targetCreateTime",
91  m_create_time.get().count());
92 
93  json::Array breakpoints_array;
94  double totalBreakpointResolveTime = 0.0;
95  // Rport both the normal breakpoint list and the internal breakpoint list.
96  for (int i = 0; i < 2; ++i) {
97  BreakpointList &breakpoints = target.GetBreakpointList(i == 1);
98  std::unique_lock<std::recursive_mutex> lock;
99  breakpoints.GetListMutex(lock);
100  size_t num_breakpoints = breakpoints.GetSize();
101  for (size_t i = 0; i < num_breakpoints; i++) {
102  Breakpoint *bp = breakpoints.GetBreakpointAtIndex(i).get();
103  breakpoints_array.push_back(bp->GetStatistics());
104  totalBreakpointResolveTime += bp->GetResolveTime().count();
105  }
106  }
107 
108  ProcessSP process_sp = target.GetProcessSP();
109  if (process_sp) {
110  UnixSignalsSP unix_signals_sp = process_sp->GetUnixSignals();
111  if (unix_signals_sp)
112  target_metrics_json.try_emplace("signals",
113  unix_signals_sp->GetHitCountStatistics());
114  uint32_t stop_id = process_sp->GetStopID();
115  target_metrics_json.try_emplace("stopCount", stop_id);
116  }
117  target_metrics_json.try_emplace("breakpoints", std::move(breakpoints_array));
118  target_metrics_json.try_emplace("totalBreakpointResolveTime",
119  totalBreakpointResolveTime);
120 
121  return target_metrics_json;
122 }
123 
124 void TargetStats::SetLaunchOrAttachTime() {
125  m_launch_or_attach_time = StatsClock::now();
126  m_first_private_stop_time = llvm::None;
127 }
128 
129 void TargetStats::SetFirstPrivateStopTime() {
130  // Launching and attaching has many paths depending on if synchronous mode
131  // was used or if we are stopping at the entry point or not. Only set the
132  // first stop time if it hasn't already been set.
133  if (!m_first_private_stop_time)
134  m_first_private_stop_time = StatsClock::now();
135 }
136 
137 void TargetStats::SetFirstPublicStopTime() {
138  // Launching and attaching has many paths depending on if synchronous mode
139  // was used or if we are stopping at the entry point or not. Only set the
140  // first stop time if it hasn't already been set.
141  if (!m_first_public_stop_time)
142  m_first_public_stop_time = StatsClock::now();
143 }
144 
145 bool DebuggerStats::g_collecting_stats = false;
146 
147 llvm::json::Value DebuggerStats::ReportStatistics(Debugger &debugger,
148  Target *target) {
149  json::Array json_targets;
150  json::Array json_modules;
151  double symtab_parse_time = 0.0;
152  double symtab_index_time = 0.0;
153  double debug_parse_time = 0.0;
154  double debug_index_time = 0.0;
155  uint32_t symtabs_loaded = 0;
156  uint32_t symtabs_saved = 0;
157  uint32_t debug_index_loaded = 0;
158  uint32_t debug_index_saved = 0;
159  uint64_t debug_info_size = 0;
160  if (target) {
161  json_targets.emplace_back(target->ReportStatistics());
162  } else {
163  for (const auto &target : debugger.GetTargetList().Targets())
164  json_targets.emplace_back(target->ReportStatistics());
165  }
166  std::vector<ModuleStats> modules;
167  std::lock_guard<std::recursive_mutex> guard(
168  Module::GetAllocationModuleCollectionMutex());
169  const size_t num_modules = Module::GetNumberAllocatedModules();
170  for (size_t image_idx = 0; image_idx < num_modules; ++image_idx) {
171  Module *module = Module::GetAllocatedModuleAtIndex(image_idx);
172  ModuleStats module_stat;
173  module_stat.identifier = (intptr_t)module;
174  module_stat.path = module->GetFileSpec().GetPath();
175  if (ConstString object_name = module->GetObjectName()) {
176  module_stat.path.append(1, '(');
177  module_stat.path.append(object_name.GetStringRef().str());
178  module_stat.path.append(1, ')');
179  }
180  module_stat.uuid = module->GetUUID().GetAsString();
181  module_stat.triple = module->GetArchitecture().GetTriple().str();
182  module_stat.symtab_parse_time = module->GetSymtabParseTime().get().count();
183  module_stat.symtab_index_time = module->GetSymtabIndexTime().get().count();
184  Symtab *symtab = module->GetSymtab();
185  if (symtab) {
186  module_stat.symtab_loaded_from_cache = symtab->GetWasLoadedFromCache();
187  if (module_stat.symtab_loaded_from_cache)
188  ++symtabs_loaded;
189  module_stat.symtab_saved_to_cache = symtab->GetWasSavedToCache();
190  if (module_stat.symtab_saved_to_cache)
191  ++symtabs_saved;
192  }
193  SymbolFile *sym_file = module->GetSymbolFile();
194  if (sym_file) {
195  module_stat.debug_index_time = sym_file->GetDebugInfoIndexTime().count();
196  module_stat.debug_parse_time = sym_file->GetDebugInfoParseTime().count();
197  module_stat.debug_info_size = sym_file->GetDebugInfoSize();
200  if (module_stat.debug_info_index_loaded_from_cache)
201  ++debug_index_loaded;
202  module_stat.debug_info_index_saved_to_cache =
204  if (module_stat.debug_info_index_saved_to_cache)
205  ++debug_index_saved;
206  }
207  symtab_parse_time += module_stat.symtab_parse_time;
208  symtab_index_time += module_stat.symtab_index_time;
209  debug_parse_time += module_stat.debug_parse_time;
210  debug_index_time += module_stat.debug_index_time;
211  debug_info_size += module_stat.debug_info_size;
212  json_modules.emplace_back(module_stat.ToJSON());
213  }
214 
215  json::Object global_stats{
216  {"targets", std::move(json_targets)},
217  {"modules", std::move(json_modules)},
218  {"totalSymbolTableParseTime", symtab_parse_time},
219  {"totalSymbolTableIndexTime", symtab_index_time},
220  {"totalSymbolTablesLoadedFromCache", symtabs_loaded},
221  {"totalSymbolTablesSavedToCache", symtabs_saved},
222  {"totalDebugInfoParseTime", debug_parse_time},
223  {"totalDebugInfoIndexTime", debug_index_time},
224  {"totalDebugInfoIndexLoadedFromCache", debug_index_loaded},
225  {"totalDebugInfoIndexSavedToCache", debug_index_saved},
226  {"totalDebugInfoByteSize", debug_info_size},
227  };
228  return std::move(global_stats);
229 }
lldb_private::Breakpoint::GetStatistics
llvm::json::Value GetStatistics()
Get statistics associated with this breakpoint in JSON format.
Definition: Breakpoint.cpp:1094
lldb_private::ModuleStats::ToJSON
llvm::json::Value ToJSON() const
Definition: Statistics.cpp:48
lldb_private::SymbolFile
Definition: SymbolFile.h:38
llvm
Definition: Debugger.h:49
lldb_private::BreakpointList
General Outline: Allows adding and removing breakpoints and find by ID and index.
Definition: BreakpointList.h:25
lldb_private::Module::GetSymtabIndexTime
StatsDuration & GetSymtabIndexTime()
Accessor for the symbol table index time metric.
Definition: Module.h:883
lldb_private::Module::GetSymtabParseTime
StatsDuration & GetSymtabParseTime()
Accessor for the symbol table parse time metric.
Definition: Module.h:877
lldb_private::ModuleStats::debug_info_index_loaded_from_cache
bool debug_info_index_loaded_from_cache
Definition: Statistics.h:109
lldb_private::ModuleList::Modules
ModuleIterable Modules() const
Definition: ModuleList.h:489
lldb_private::SymbolFile::GetDebugInfoIndexTime
virtual StatsDuration::Duration GetDebugInfoIndexTime()
Return the time it took to index the debug information in the object file.
Definition: SymbolFile.h:326
lldb_private::Symtab::GetWasSavedToCache
bool GetWasSavedToCache() const
Definition: Symtab.h:231
lldb_private::ModuleStats::debug_info_index_saved_to_cache
bool debug_info_index_saved_to_cache
Definition: Statistics.h:110
lldb_private::Module::GetSymtab
Symtab * GetSymtab()
Definition: Module.cpp:1052
lldb_private::StatsDuration::Duration
std::chrono::duration< double > Duration
Definition: Statistics.h:28
lldb_private::SymbolFile::GetDebugInfoIndexWasSavedToCache
bool GetDebugInfoIndexWasSavedToCache() const
Definition: SymbolFile.h:343
lldb_private::ModuleStats::symtab_saved_to_cache
bool symtab_saved_to_cache
Definition: Statistics.h:108
Module.h
lldb_private::ModuleStats::triple
std::string triple
Definition: Statistics.h:101
EmplaceSafeString
static void EmplaceSafeString(llvm::json::Object &obj, llvm::StringRef key, const std::string &str)
Definition: Statistics.cpp:22
lldb_private::Module::GetSymbolFile
virtual SymbolFile * GetSymbolFile(bool can_create=true, Stream *feedback_strm=nullptr)
Get the module's symbol file.
Definition: Module.cpp:1036
lldb_private::Module
Definition: Module.h:85
lldb_private::ArchSpec::GetTriple
llvm::Triple & GetTriple()
Architecture triple accessor.
Definition: ArchSpec.h:444
lldb_private::Target::GetBreakpointList
BreakpointList & GetBreakpointList(bool internal=false)
Definition: Target.cpp:289
lldb_private::ModuleStats::symtab_loaded_from_cache
bool symtab_loaded_from_cache
Definition: Statistics.h:107
lldb_private::ModuleStats::identifier
intptr_t identifier
Definition: Statistics.h:98
lldb_private::ModuleStats::debug_parse_time
double debug_parse_time
Definition: Statistics.h:104
Debugger.h
lldb_private::Target
Definition: Target.h:452
lldb_private::Target::GetImages
const ModuleList & GetImages() const
Get accessor for the images for this process.
Definition: Target.h:926
lldb_private::UUID::GetAsString
std::string GetAsString(llvm::StringRef separator="-") const
Definition: UUID.cpp:48
lldb_private::ModuleStats::symtab_index_time
double symtab_index_time
Definition: Statistics.h:103
Process.h
Target.h
lldb_private::Module::GetFileSpec
const FileSpec & GetFileSpec() const
Get const accessor for the module file specification.
Definition: Module.h:477
elapsed
static double elapsed(const StatsTimepoint &start, const StatsTimepoint &end)
Definition: Statistics.cpp:36
lldb_private::ModuleStats
A class that represents statistics for a since lldb_private::Module.
Definition: Statistics.h:96
UnixSignals.h
lldb_private::SymbolFile::GetDebugInfoIndexWasLoadedFromCache
bool GetDebugInfoIndexWasLoadedFromCache() const
Accessors for the bool that indicates if the debug info index was loaded from, or saved to the module...
Definition: SymbolFile.h:337
lldb_private::ConstString
Definition: ConstString.h:40
lldb_private::Module::GetObjectName
ConstString GetObjectName() const
Definition: Module.cpp:1237
lldb_private::Debugger
Definition: Debugger.h:70
lldb_private::ModuleStats::debug_info_size
uint64_t debug_info_size
Definition: Statistics.h:106
string
string(SUBSTRING ${p} 10 -1 pStripped) if($
Definition: Plugins/CMakeLists.txt:40
lldb_private::BreakpointList::GetListMutex
void GetListMutex(std::unique_lock< std::recursive_mutex > &lock)
Sets the passed in Locker to hold the Breakpoint List mutex.
Definition: BreakpointList.cpp:190
lldb_private::Debugger::GetTargetList
TargetList & GetTargetList()
Get accessor for the target list.
Definition: Debugger.h:229
lldb_private::Breakpoint::GetResolveTime
StatsDuration::Duration GetResolveTime() const
Get the time it took to resolve all locations in this breakpoint.
Definition: Breakpoint.h:584
lldb_private::ModuleStats::uuid
std::string uuid
Definition: Statistics.h:100
lldb_private::StatsTimepoint
std::chrono::time_point< StatsClock > StatsTimepoint
Definition: Statistics.h:24
lldb_private::Target::GetProcessSP
const lldb::ProcessSP & GetProcessSP() const
Definition: Target.cpp:211
lldb_private::TargetList::Targets
TargetIterable Targets()
Definition: TargetList.h:188
lldb_private::BreakpointList::GetBreakpointAtIndex
lldb::BreakpointSP GetBreakpointAtIndex(size_t i) const
Returns a shared pointer to the breakpoint with index i.
Definition: BreakpointList.cpp:163
lldb_private::Symtab
Definition: Symtab.h:22
uint32_t
lldb_private::SymbolFile::GetDebugInfoParseTime
virtual StatsDuration::Duration GetDebugInfoParseTime()
Return the time taken to parse the debug information.
Definition: SymbolFile.h:319
lldb_private::ModuleStats::path
std::string path
Definition: Statistics.h:99
lldb_private::ModuleStats::symtab_parse_time
double symtab_parse_time
Definition: Statistics.h:102
lldb_private::StatsDuration::get
Duration get() const
Definition: Statistics.h:30
lldb_private::Symtab::GetWasLoadedFromCache
bool GetWasLoadedFromCache() const
Accessors for the bool that indicates if the debug info index was loaded from, or saved to the module...
Definition: Symtab.h:225
lldb_private::BreakpointList::GetSize
size_t GetSize() const
Returns the number of elements in this breakpoint list.
Definition: BreakpointList.h:79
Statistics.h
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
lldb_private::ModuleStats::debug_index_time
double debug_index_time
Definition: Statistics.h:105
lldb_private::Module::GetArchitecture
const ArchSpec & GetArchitecture() const
Get const accessor for the module architecture.
Definition: Module.cpp:1067
lldb_private::Module::GetUUID
const lldb_private::UUID & GetUUID()
Get a reference to the UUID value contained in this object.
Definition: Module.cpp:349
lldb_private::FileSpec::GetPath
size_t GetPath(char *path, size_t max_path_length, bool denormalize=true) const
Extract the full path to the file.
Definition: FileSpec.cpp:346
lldb
Definition: SBAddress.h:15
lldb_private::Target::ReportStatistics
llvm::json::Value ReportStatistics()
Get metrics associated with this target in JSON format.
Definition: Target.cpp:4513
SymbolFile.h
lldb_private::SymbolFile::GetDebugInfoSize
virtual uint64_t GetDebugInfoSize()
Metrics gathering functions.
Definition: SymbolFile.cpp:240
lldb_private::Breakpoint
General Outline: A breakpoint has four main parts, a filter, a resolver, the list of breakpoint locat...
Definition: Breakpoint.h:80