Files
binutils-gdb/gdb/maint.h
Simon Marchi 0b79576c9d gdb: add scoped_time_it
New in v2:

 - actually use m_enabled in the constructor and destructor
 - output using gdb_stdlog->write_async_safe instead of gdb_printf

scoped_time_it is a small utility that measures and prints how much time
a given thread spent in a given scope.  Similar to the time(1) command,
it prints the time spent in user mode, system mode, and the wall clock
time.  It also prints the CPU utilization percentage, which is:

  (user + sys) / wall

This can help spot cases where the workload is not well balanced between
workers, or the CPU utilization is not optimal (perhaps due to
contention around a lock for example).

To use it, just add it in some scope.  For instance, a subsequent patch
adds it here:

      workers.add_task ([this, task_count, iter, last] ()
	{
	  scoped_time_it time_it ("DWARF indexing worker");
	  process_cus (task_count, iter, last);
	});

On destruction, if enabled, it prints a line showing the time spent by
that thread, similar to what time(1) prints.

The example above prints this (one line for each worker thread):

    Time for "DWARF indexing worker": wall 0.173, user 0.120, sys 0.034, user+sys 0.154, 89.0 % CPU
    Time for "DWARF indexing worker": wall 0.211, user 0.144, sys 0.047, user+sys 0.191, 90.5 % CPU
    Time for "DWARF indexing worker": wall 0.368, user 0.295, sys 0.057, user+sys 0.352, 95.7 % CPU
    Time for "DWARF indexing worker": wall 0.445, user 0.361, sys 0.072, user+sys 0.433, 97.3 % CPU
    Time for "DWARF indexing worker": wall 0.592, user 0.459, sys 0.113, user+sys 0.572, 96.6 % CPU
    Time for "DWARF indexing worker": wall 0.739, user 0.608, sys 0.115, user+sys 0.723, 97.8 % CPU
    Time for "DWARF indexing worker": wall 0.831, user 0.677, sys 0.140, user+sys 0.817, 98.3 % CPU
    Time for "DWARF indexing worker": wall 0.949, user 0.789, sys 0.144, user+sys 0.933, 98.3 % CPU

The object is only enabled if per_command_time (controlled by "maint set
per-command time") is true at construction time.  I wanted to avoid
adding a new command for now, but eventually if there are too many
scoped_time_it around the code base and we want to be able to enabled
them selectively (e.g. just the ones in the DWARF reader, or in the
symbol searching functions, etc), we could have a dedicated command for
that.

I added this functionality to GDB because it relies on gdb_printf and
per_command_time, but if we ever need it in gdbsupport, I'm sure we
could find a way to put it there.

Change-Id: I5416ac1448f960f44d85f8449943d994198a271e
Approved-By: Tom Tromey <tom@tromey.com>
2025-04-29 15:10:11 -04:00

104 lines
3.0 KiB
C++

/* Support for GDB maintenance commands.
Copyright (C) 2013-2025 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef GDB_MAINT_H
#define GDB_MAINT_H
#include "gdbsupport/run-time-clock.h"
#include <chrono>
struct obj_section;
struct objfile;
extern void set_per_command_time (int);
extern void set_per_command_space (int);
/* Update the thread pool for the desired number of threads. */
extern void update_thread_pool_size ();
/* Records a run time and space usage to be used as a base for
reporting elapsed time or change in space. */
class scoped_command_stats
{
public:
explicit scoped_command_stats (bool msg_type);
~scoped_command_stats ();
private:
DISABLE_COPY_AND_ASSIGN (scoped_command_stats);
/* Print the time, along with a string. */
void print_time (const char *msg);
/* Zero if the saved time is from the beginning of GDB execution.
One if from the beginning of an individual command execution. */
bool m_msg_type;
/* Track whether the stat was enabled at the start of the command
so that we can avoid printing anything if it gets turned on by
the current command. */
bool m_time_enabled : 1;
bool m_space_enabled : 1;
bool m_symtab_enabled : 1;
run_time_clock::time_point m_start_cpu_time;
std::chrono::steady_clock::time_point m_start_wall_time;
long m_start_space;
/* Total number of symtabs (over all objfiles). */
int m_start_nr_symtabs;
/* A count of the compunits. */
int m_start_nr_compunit_symtabs;
/* Total number of blocks. */
int m_start_nr_blocks;
};
/* RAII structure used to measure the time spent by the current thread in a
given scope. */
struct scoped_time_it
{
/* WHAT is the prefix to show when the summary line is printed. */
scoped_time_it (const char *what);
DISABLE_COPY_AND_ASSIGN (scoped_time_it);
~scoped_time_it ();
private:
bool m_enabled;
/* Summary line prefix. */
const char *m_what;
/* User time at the start of execution. */
user_cpu_time_clock::time_point m_start_user;
/* System time at the start of execution. */
system_cpu_time_clock::time_point m_start_sys;
/* Wall-clock time at the start of execution. */
std::chrono::steady_clock::time_point m_start_wall;
};
extern obj_section *maint_obj_section_from_bfd_section (bfd *abfd,
asection *asection,
objfile *ofile);
#endif /* GDB_MAINT_H */