binutils-gdb/gdb/user-regs.h
Simon Marchi 8480a37e14 gdb: pass frames as const frame_info_ptr &
We currently pass frames to function by value, as `frame_info_ptr`.
This is somewhat expensive:

 - the size of `frame_info_ptr` is 64 bytes, which is a bit big to pass
   by value
 - the constructors and destructor link/unlink the object in the global
   `frame_info_ptr::frame_list` list.  This is an `intrusive_list`, so
   it's not so bad: it's just assigning a few points, there's no memory
   allocation as if it was `std::list`, but still it's useless to do
   that over and over.

As suggested by Tom Tromey, change many function signatures to accept
`const frame_info_ptr &` instead of `frame_info_ptr`.

Some functions reassign their `frame_info_ptr` parameter, like:

  void
  the_func (frame_info_ptr frame)
  {
    for (; frame != nullptr; frame = get_prev_frame (frame))
      {
        ...
      }
  }

I wondered what to do about them, do I leave them as-is or change them
(and need to introduce a separate local variable that can be
re-assigned).  I opted for the later for consistency.  It might not be
clear why some functions take `const frame_info_ptr &` while others take
`frame_info_ptr`.  Also, if a function took a `frame_info_ptr` because
it did re-assign its parameter, I doubt that we would think to change it
to `const frame_info_ptr &` should the implementation change such that
it doesn't need to take `frame_info_ptr` anymore.  It seems better to
have a simple rule and apply it everywhere.

Change-Id: I59d10addef687d157f82ccf4d54f5dde9a963fd0
Approved-By: Andrew Burgess <aburgess@redhat.com>
2024-02-20 10:42:25 -05:00

73 lines
2.6 KiB
C++

/* Per-frame user registers, for GDB, the GNU debugger.
Copyright (C) 2002-2024 Free Software Foundation, Inc.
Contributed by Red Hat.
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 USER_REGS_H
#define USER_REGS_H
/* Implement both builtin, and architecture specific, per-frame user
visible registers.
Builtin registers apply to all architectures, where as architecture
specific registers are present when the architecture is selected.
These registers are assigned register numbers outside the
architecture's register range
[0 .. gdbarch_num_regs + gdbarch_num_pseudo_regs].
Their values should be constructed using per-frame information. */
/* TODO: cagney/2003-06-27: Need to think more about how these
registers are added, read, and modified. At present they are kind
of assumed to be read-only. Should it, for instance, return a
register descriptor that contains all the relevant access methods. */
class frame_info_ptr;
struct gdbarch;
/* Given an architecture, map a user visible register name onto its
index. */
extern int user_reg_map_name_to_regnum (struct gdbarch *gdbarch,
const char *str, int len);
extern const char *user_reg_map_regnum_to_name (struct gdbarch *gdbarch,
int regnum);
/* Return the value of the frame register in the specified frame.
Note; These methods return a "struct value" instead of the raw
bytes as, at the time the register is being added, the type needed
to describe the register has not bee initialized. */
typedef struct value *(user_reg_read_ftype) (const frame_info_ptr &frame,
const void *baton);
extern struct value *value_of_user_reg (int regnum, const frame_info_ptr &frame);
/* Add a builtin register (present in all architectures). */
extern void user_reg_add_builtin (const char *name,
user_reg_read_ftype *read,
const void *baton);
/* Add a per-architecture frame register. */
extern void user_reg_add (struct gdbarch *gdbarch, const char *name,
user_reg_read_ftype *read, const void *baton);
#endif