xref: /src/external/gpl3/gdb/dist/gdb/maint.h

/* 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;
#ifdef HAVE_USEFUL_SBRK
  long m_start_space;
#endif
  /* 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;
};

/* If true, display time usage both at startup and for each command.  */

extern bool per_command_time;

/* 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, bool enabled = per_command_time);

  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 */