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

94 lines
2.5 KiB
C

/* Code dealing with register stack frames, for GDB, the GNU debugger.
Copyright (C) 1986-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 "regcache.h"
#include "sentinel-frame.h"
#include "inferior.h"
#include "frame-unwind.h"
struct frame_unwind_cache
{
struct regcache *regcache;
};
void *
sentinel_frame_cache (struct regcache *regcache)
{
struct frame_unwind_cache *cache =
FRAME_OBSTACK_ZALLOC (struct frame_unwind_cache);
cache->regcache = regcache;
return cache;
}
/* Here the register value is taken direct from the register cache. */
static struct value *
sentinel_frame_prev_register (const frame_info_ptr &this_frame,
void **this_prologue_cache,
int regnum)
{
struct frame_unwind_cache *cache
= (struct frame_unwind_cache *) *this_prologue_cache;
struct value *value;
frame_id this_frame_id = get_frame_id (this_frame);
gdb_assert (is_sentinel_frame_id (this_frame_id));
value = cache->regcache->cooked_read_value (regnum);
return value;
}
static void
sentinel_frame_this_id (const frame_info_ptr &this_frame,
void **this_prologue_cache,
struct frame_id *this_id)
{
/* The sentinel frame is used as a starting point for creating the
previous (inner most) frame. That frame's THIS_ID method will be
called to determine the inner most frame's ID. Not this one. */
internal_error (_("sentinel_frame_this_id called"));
}
static struct gdbarch *
sentinel_frame_prev_arch (const frame_info_ptr &this_frame,
void **this_prologue_cache)
{
struct frame_unwind_cache *cache
= (struct frame_unwind_cache *) *this_prologue_cache;
return cache->regcache->arch ();
}
const struct frame_unwind sentinel_frame_unwind =
{
"sentinel",
SENTINEL_FRAME,
default_frame_unwind_stop_reason,
sentinel_frame_this_id,
sentinel_frame_prev_register,
NULL,
NULL,
NULL,
sentinel_frame_prev_arch,
};