binutils-gdb/gdb/frame-base.c
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

118 lines
3.4 KiB
C

/* Definitions for frame address handler, for GDB, the GNU debugger.
Copyright (C) 2003-2024 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/>. */
#include "defs.h"
#include "frame-base.h"
#include "frame.h"
#include "gdbsupport/gdb_obstack.h"
#include "gdbarch.h"
/* A default frame base implementations. If it wasn't for the old
DEPRECATED_FRAME_LOCALS_ADDRESS and DEPRECATED_FRAME_ARGS_ADDRESS,
these could be combined into a single function. All architectures
really need to override this. */
static CORE_ADDR
default_frame_base_address (const frame_info_ptr &this_frame, void **this_cache)
{
return get_frame_base (this_frame); /* sigh! */
}
static CORE_ADDR
default_frame_locals_address (const frame_info_ptr &this_frame, void **this_cache)
{
return default_frame_base_address (this_frame, this_cache);
}
static CORE_ADDR
default_frame_args_address (const frame_info_ptr &this_frame, void **this_cache)
{
return default_frame_base_address (this_frame, this_cache);
}
const struct frame_base default_frame_base = {
NULL, /* No parent. */
default_frame_base_address,
default_frame_locals_address,
default_frame_args_address
};
struct frame_base_table_entry
{
frame_base_sniffer_ftype *sniffer;
struct frame_base_table_entry *next;
};
struct frame_base_table
{
struct frame_base_table_entry *head = nullptr;
struct frame_base_table_entry **tail = &head;
const struct frame_base *default_base = &default_frame_base;
};
static const registry<gdbarch>::key<struct frame_base_table> frame_base_data;
static struct frame_base_table *
get_frame_base_table (struct gdbarch *gdbarch)
{
struct frame_base_table *table = frame_base_data.get (gdbarch);
if (table == nullptr)
table = frame_base_data.emplace (gdbarch);
return table;
}
void
frame_base_append_sniffer (struct gdbarch *gdbarch,
frame_base_sniffer_ftype *sniffer)
{
struct frame_base_table *table = get_frame_base_table (gdbarch);
(*table->tail)
= GDBARCH_OBSTACK_ZALLOC (gdbarch, struct frame_base_table_entry);
(*table->tail)->sniffer = sniffer;
table->tail = &(*table->tail)->next;
}
void
frame_base_set_default (struct gdbarch *gdbarch,
const struct frame_base *default_base)
{
struct frame_base_table *table = get_frame_base_table (gdbarch);
table->default_base = default_base;
}
const struct frame_base *
frame_base_find_by_frame (const frame_info_ptr &this_frame)
{
struct gdbarch *gdbarch = get_frame_arch (this_frame);
struct frame_base_table *table = get_frame_base_table (gdbarch);
struct frame_base_table_entry *entry;
for (entry = table->head; entry != NULL; entry = entry->next)
{
const struct frame_base *desc = NULL;
desc = entry->sniffer (this_frame);
if (desc != NULL)
return desc;
}
return table->default_base;
}