gdb/frame-base.c

   1 /* Definitions for frame address handler, for GDB, the GNU debugger.
   2
   3    Copyright (C) 2003-2024 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #include "frame-base.h"
  21 #include "frame.h"
  22 #include "gdbsupport/gdb_obstack.h"
  23 #include "gdbarch.h"
  24
  25 /* A default frame base implementations.  If it wasn't for the old
  26    DEPRECATED_FRAME_LOCALS_ADDRESS and DEPRECATED_FRAME_ARGS_ADDRESS,
  27    these could be combined into a single function.  All architectures
  28    really need to override this.  */
  29
  30 static CORE_ADDR
  31 default_frame_base_address (const frame_info_ptr &this_frame, void **this_cache)
  32 {
  33   return get_frame_base (this_frame); /* sigh! */
  34 }
  35
  36 static CORE_ADDR
  37 default_frame_locals_address (const frame_info_ptr &this_frame, void **this_cache)
  38 {
  39   return default_frame_base_address (this_frame, this_cache);
  40 }
  41
  42 static CORE_ADDR
  43 default_frame_args_address (const frame_info_ptr &this_frame, void **this_cache)
  44 {
  45   return default_frame_base_address (this_frame, this_cache);
  46 }
  47
  48 const struct frame_base default_frame_base = {
  49   NULL, /* No parent.  */
  50   default_frame_base_address,
  51   default_frame_locals_address,
  52   default_frame_args_address
  53 };
  54
  55 struct frame_base_table_entry
  56 {
  57   frame_base_sniffer_ftype *sniffer;
  58   struct frame_base_table_entry *next;
  59 };
  60
  61 struct frame_base_table
  62 {
  63   struct frame_base_table_entry *head = nullptr;
  64   struct frame_base_table_entry **tail = &head;
  65   const struct frame_base *default_base = &default_frame_base;
  66 };
  67
  68 static const registry<gdbarch>::key<struct frame_base_table> frame_base_data;
  69
  70 static struct frame_base_table *
  71 get_frame_base_table (struct gdbarch *gdbarch)
  72 {
  73   struct frame_base_table *table = frame_base_data.get (gdbarch);
  74   if (table == nullptr)
  75     table = frame_base_data.emplace (gdbarch);
  76   return table;
  77 }
  78
  79 void
  80 frame_base_append_sniffer (struct gdbarch *gdbarch,
  81                            frame_base_sniffer_ftype *sniffer)
  82 {
  83   struct frame_base_table *table = get_frame_base_table (gdbarch);
  84
  85   (*table->tail)
  86     = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct frame_base_table_entry);
  87   (*table->tail)->sniffer = sniffer;
  88   table->tail = &(*table->tail)->next;
  89 }
  90
  91 void
  92 frame_base_set_default (struct gdbarch *gdbarch,
  93                         const struct frame_base *default_base)
  94 {
  95   struct frame_base_table *table = get_frame_base_table (gdbarch);
  96
  97   table->default_base = default_base;
  98 }
  99
 100 const struct frame_base *
 101 frame_base_find_by_frame (const frame_info_ptr &this_frame)
 102 {
 103   struct gdbarch *gdbarch = get_frame_arch (this_frame);
 104   struct frame_base_table *table = get_frame_base_table (gdbarch);
 105   struct frame_base_table_entry *entry;
 106
 107   for (entry = table->head; entry != NULL; entry = entry->next)
 108     {
 109       const struct frame_base *desc = NULL;
 110
 111       desc = entry->sniffer (this_frame);
 112       if (desc != NULL)
 113         return desc;
 114     }
 115   return table->default_base;
 116 }