1 /* User visible, per-frame registers, for GDB, the GNU debugger.
3 Copyright (C) 2002-2014 Free Software Foundation, Inc.
5 Contributed by Red Hat.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "user-regs.h"
27 /* A table of user registers.
29 User registers have regnum's that live above of the range [0
30 .. gdbarch_num_regs + gdbarch_num_pseudo_regs)
31 (which is controlled by the target).
32 The target should never see a user register's regnum value.
34 Always append, never delete. By doing this, the relative regnum
35 (offset from gdbarch_num_regs + gdbarch_num_pseudo_regs)
36 assigned to each user register never changes. */
41 struct value *(*read) (struct frame_info * frame, const void *baton);
43 struct user_reg *next;
46 /* This structure is named gdb_user_regs instead of user_regs to avoid
47 conflicts with any "struct user_regs" in system headers. For instance,
48 on ARM GNU/Linux native builds, nm-linux.h includes <signal.h> includes
49 <sys/ucontext.h> includes <sys/procfs.h> includes <sys/user.h>, which
50 declares "struct user_regs". */
54 struct user_reg *first;
55 struct user_reg **last;
59 append_user_reg (struct gdb_user_regs *regs, const char *name,
60 user_reg_read_ftype *read, const void *baton,
63 /* The caller is responsible for allocating memory needed to store
64 the register. By doing this, the function can operate on a
65 register list stored in the common heap or a specific obstack. */
66 gdb_assert (reg != NULL);
72 regs->last = &(*regs->last)->next;
75 /* An array of the builtin user registers. */
77 static struct gdb_user_regs builtin_user_regs = {
78 NULL, &builtin_user_regs.first
82 user_reg_add_builtin (const char *name, user_reg_read_ftype *read,
85 append_user_reg (&builtin_user_regs, name, read, baton,
86 XNEW (struct user_reg));
89 /* Per-architecture user registers. Start with the builtin user
90 registers and then, again, append. */
92 static struct gdbarch_data *user_regs_data;
95 user_regs_init (struct gdbarch *gdbarch)
98 struct gdb_user_regs *regs
99 = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct gdb_user_regs);
101 regs->last = ®s->first;
102 for (reg = builtin_user_regs.first; reg != NULL; reg = reg->next)
103 append_user_reg (regs, reg->name, reg->read, reg->baton,
104 GDBARCH_OBSTACK_ZALLOC (gdbarch, struct user_reg));
109 user_reg_add (struct gdbarch *gdbarch, const char *name,
110 user_reg_read_ftype *read, const void *baton)
112 struct gdb_user_regs *regs = gdbarch_data (gdbarch, user_regs_data);
116 /* ULGH, called during architecture initialization. Patch
118 regs = user_regs_init (gdbarch);
119 deprecated_set_gdbarch_data (gdbarch, user_regs_data, regs);
121 append_user_reg (regs, name, read, baton,
122 GDBARCH_OBSTACK_ZALLOC (gdbarch, struct user_reg));
126 user_reg_map_name_to_regnum (struct gdbarch *gdbarch, const char *name,
129 /* Make life easy, set the len to something reasonable. */
133 /* Search register name space first - always let an architecture
134 specific register override the user registers. */
137 int maxregs = (gdbarch_num_regs (gdbarch)
138 + gdbarch_num_pseudo_regs (gdbarch));
140 for (i = 0; i < maxregs; i++)
142 const char *regname = gdbarch_register_name (gdbarch, i);
144 if (regname != NULL && len == strlen (regname)
145 && strncmp (regname, name, len) == 0)
152 /* Search the user name space. */
154 struct gdb_user_regs *regs = gdbarch_data (gdbarch, user_regs_data);
155 struct user_reg *reg;
158 for (nr = 0, reg = regs->first; reg != NULL; reg = reg->next, nr++)
160 if ((len < 0 && strcmp (reg->name, name))
161 || (len == strlen (reg->name)
162 && strncmp (reg->name, name, len) == 0))
163 return gdbarch_num_regs (gdbarch)
164 + gdbarch_num_pseudo_regs (gdbarch) + nr;
171 static struct user_reg *
172 usernum_to_user_reg (struct gdbarch *gdbarch, int usernum)
174 struct gdb_user_regs *regs = gdbarch_data (gdbarch, user_regs_data);
175 struct user_reg *reg;
177 for (reg = regs->first; reg != NULL; reg = reg->next)
187 user_reg_map_regnum_to_name (struct gdbarch *gdbarch, int regnum)
189 int maxregs = (gdbarch_num_regs (gdbarch)
190 + gdbarch_num_pseudo_regs (gdbarch));
194 else if (regnum < maxregs)
195 return gdbarch_register_name (gdbarch, regnum);
198 struct user_reg *reg = usernum_to_user_reg (gdbarch, regnum - maxregs);
207 value_of_user_reg (int regnum, struct frame_info *frame)
209 struct gdbarch *gdbarch = get_frame_arch (frame);
210 int maxregs = (gdbarch_num_regs (gdbarch)
211 + gdbarch_num_pseudo_regs (gdbarch));
212 struct user_reg *reg = usernum_to_user_reg (gdbarch, regnum - maxregs);
214 gdb_assert (reg != NULL);
215 return reg->read (frame, reg->baton);
218 extern initialize_file_ftype _initialize_user_regs; /* -Wmissing-prototypes */
221 _initialize_user_regs (void)
223 user_regs_data = gdbarch_data_register_post_init (user_regs_init);