Sort includes for files gdb/[a-f]*.[chyl].
[external/binutils.git] / gdb / frame-base.c
1 /* Definitions for frame address handler, for GDB, the GNU debugger.
2
3    Copyright (C) 2003-2019 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 "defs.h"
21
22 /* Local non-gdb includes.  */
23 #include "frame-base.h"
24 #include "frame.h"
25 #include "gdb_obstack.h"
26
27 /* A default frame base implementations.  If it wasn't for the old
28    DEPRECATED_FRAME_LOCALS_ADDRESS and DEPRECATED_FRAME_ARGS_ADDRESS,
29    these could be combined into a single function.  All architectures
30    really need to override this.  */
31
32 static CORE_ADDR
33 default_frame_base_address (struct frame_info *this_frame, void **this_cache)
34 {
35   return get_frame_base (this_frame); /* sigh! */
36 }
37
38 static CORE_ADDR
39 default_frame_locals_address (struct frame_info *this_frame, void **this_cache)
40 {
41   return default_frame_base_address (this_frame, this_cache);
42 }
43
44 static CORE_ADDR
45 default_frame_args_address (struct frame_info *this_frame, void **this_cache)
46 {
47   return default_frame_base_address (this_frame, this_cache);
48 }
49
50 const struct frame_base default_frame_base = {
51   NULL, /* No parent.  */
52   default_frame_base_address,
53   default_frame_locals_address,
54   default_frame_args_address
55 };
56
57 static struct gdbarch_data *frame_base_data;
58
59 struct frame_base_table_entry
60 {
61   frame_base_sniffer_ftype *sniffer;
62   struct frame_base_table_entry *next;
63 };
64
65 struct frame_base_table
66 {
67   struct frame_base_table_entry *head;
68   struct frame_base_table_entry **tail;
69   const struct frame_base *default_base;
70 };
71
72 static void *
73 frame_base_init (struct obstack *obstack)
74 {
75   struct frame_base_table *table
76     = OBSTACK_ZALLOC (obstack, struct frame_base_table);
77
78   table->tail = &table->head;
79   table->default_base = &default_frame_base;
80   return table;
81 }
82
83 void
84 frame_base_append_sniffer (struct gdbarch *gdbarch,
85                            frame_base_sniffer_ftype *sniffer)
86 {
87   struct frame_base_table *table
88     = (struct frame_base_table *) gdbarch_data (gdbarch, frame_base_data);
89
90   (*table->tail)
91     = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct frame_base_table_entry);
92   (*table->tail)->sniffer = sniffer;
93   table->tail = &(*table->tail)->next;
94 }
95
96 void
97 frame_base_set_default (struct gdbarch *gdbarch,
98                         const struct frame_base *default_base)
99 {
100   struct frame_base_table *table
101     = (struct frame_base_table *) gdbarch_data (gdbarch, frame_base_data);
102
103   table->default_base = default_base;
104 }
105
106 const struct frame_base *
107 frame_base_find_by_frame (struct frame_info *this_frame)
108 {
109   struct gdbarch *gdbarch = get_frame_arch (this_frame);
110   struct frame_base_table *table
111     = (struct frame_base_table *) gdbarch_data (gdbarch, frame_base_data);
112   struct frame_base_table_entry *entry;
113
114   for (entry = table->head; entry != NULL; entry = entry->next)
115     {
116       const struct frame_base *desc = NULL;
117
118       desc = entry->sniffer (this_frame);
119       if (desc != NULL)
120         return desc;
121     }
122   return table->default_base;
123 }
124
125 void
126 _initialize_frame_base (void)
127 {
128   frame_base_data = gdbarch_data_register_pre_init (frame_base_init);
129 }