Remove gdbarch_remote_breakpoint_from_pc
[external/binutils.git] / gdb / arch-utils.h
1 /* Dynamic architecture support for GDB, the GNU debugger.
2
3    Copyright (C) 1998-2016 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 #ifndef GDBARCH_UTILS_H
21 #define GDBARCH_UTILS_H
22
23 struct gdbarch;
24 struct frame_info;
25 struct minimal_symbol;
26 struct type;
27 struct gdbarch_info;
28
29 #define GDBARCH_BREAKPOINT_FROM_PC(ARCH)                               \
30   static const gdb_byte *                                              \
31   ARCH##_breakpoint_from_pc (struct gdbarch *gdbarch,                  \
32                              CORE_ADDR *pcptr,                          \
33                              int *lenptr)                               \
34   {                                                                     \
35     int kind = ARCH##_breakpoint_kind_from_pc (gdbarch, pcptr); \
36                                                                      \
37     return ARCH##_sw_breakpoint_from_kind (gdbarch, kind, lenptr);   \
38   }
39
40 #define GDBARCH_BREAKPOINT_MANIPULATION(ARCH,BREAK_INSN)              \
41   static int                                                          \
42   ARCH##_breakpoint_kind_from_pc (struct gdbarch *gdbarch,            \
43                                   CORE_ADDR *pcptr)                   \
44   {                                                                   \
45     return sizeof (BREAK_INSN);                               \
46   }                                                                   \
47   static const gdb_byte *                                             \
48   ARCH##_sw_breakpoint_from_kind (struct gdbarch *gdbarch,            \
49                                   int kind, int *size)                \
50   {                                                                   \
51     *size = kind;                                                     \
52     return BREAK_INSN;                                                \
53   }                                                                   \
54   GDBARCH_BREAKPOINT_FROM_PC (ARCH)
55
56 #define SET_GDBARCH_BREAKPOINT_MANIPULATION(ARCH)                       \
57   set_gdbarch_breakpoint_from_pc (gdbarch, ARCH##_breakpoint_from_pc);  \
58   set_gdbarch_breakpoint_kind_from_pc (gdbarch,                 \
59                                        ARCH##_breakpoint_kind_from_pc); \
60   set_gdbarch_sw_breakpoint_from_kind (gdbarch,                 \
61                                        ARCH##_sw_breakpoint_from_kind)
62
63 #define GDBARCH_BREAKPOINT_MANIPULATION_ENDIAN(ARCH, \
64                                                LITTLE_BREAK_INSN,       \
65                                                BIG_BREAK_INSN)          \
66   static int                                                            \
67   ARCH##_breakpoint_kind_from_pc (struct gdbarch *gdbarch,              \
68                                   CORE_ADDR *pcptr)                     \
69   {                                                                     \
70     gdb_static_assert (ARRAY_SIZE (LITTLE_BREAK_INSN)                   \
71                        == ARRAY_SIZE (BIG_BREAK_INSN));         \
72     return sizeof (BIG_BREAK_INSN);                                     \
73   }                                                                     \
74   static const gdb_byte *                                             \
75   ARCH##_sw_breakpoint_from_kind (struct gdbarch *gdbarch,            \
76                                   int kind, int *size)                \
77   {                                                                   \
78     *size = kind;                                                     \
79     if (gdbarch_byte_order (gdbarch) == BFD_ENDIAN_BIG)       \
80       return BIG_BREAK_INSN;                                          \
81     else                                                              \
82       return LITTLE_BREAK_INSN;                               \
83   }                                                                   \
84   GDBARCH_BREAKPOINT_FROM_PC (ARCH)
85
86 /* An implementation of gdbarch_displaced_step_copy_insn for
87    processors that don't need to modify the instruction before
88    single-stepping the displaced copy.
89
90    Simply copy gdbarch_max_insn_length (ARCH) bytes from FROM to TO.
91    The closure is an array of that many bytes containing the
92    instruction's bytes, allocated with xmalloc.  */
93 extern struct displaced_step_closure *
94   simple_displaced_step_copy_insn (struct gdbarch *gdbarch,
95                                    CORE_ADDR from, CORE_ADDR to,
96                                    struct regcache *regs);
97
98 /* Simple implementation of gdbarch_displaced_step_free_closure: Call
99    xfree.
100    This is appropriate for use with simple_displaced_step_copy_insn.  */
101 extern void
102   simple_displaced_step_free_closure (struct gdbarch *gdbarch,
103                                       struct displaced_step_closure *closure);
104
105 /* Default implementation of gdbarch_displaced_hw_singlestep.  */
106 extern int
107   default_displaced_step_hw_singlestep (struct gdbarch *,
108                                         struct displaced_step_closure *);
109
110 /* Possible value for gdbarch_displaced_step_location:
111    Place displaced instructions at the program's entry point,
112    leaving space for inferior function call return breakpoints.  */
113 extern CORE_ADDR displaced_step_at_entry_point (struct gdbarch *gdbarch);
114
115 /* The only possible cases for inner_than.  */
116 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
117 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
118
119 /* Identity functions on a CORE_ADDR.  Just return the "addr".  */
120
121 extern CORE_ADDR core_addr_identity (struct gdbarch *gdbarch, CORE_ADDR addr);
122 extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
123
124 /* No-op conversion of reg to regnum.  */
125
126 extern int no_op_reg_to_regnum (struct gdbarch *gdbarch, int reg);
127
128 /* Do nothing version of coff_make_msymbol_special.  */
129
130 void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
131
132 /* Do nothing default implementation of gdbarch_make_symbol_special.  */
133
134 void default_make_symbol_special (struct symbol *sym, struct objfile *objfile);
135
136 /* Do nothing default implementation of gdbarch_adjust_dwarf2_addr.  */
137
138 CORE_ADDR default_adjust_dwarf2_addr (CORE_ADDR pc);
139
140 /* Do nothing default implementation of gdbarch_adjust_dwarf2_line.  */
141
142 CORE_ADDR default_adjust_dwarf2_line (CORE_ADDR addr, int rel);
143
144 /* Version of cannot_fetch_register() / cannot_store_register() that
145    always fails.  */
146
147 int cannot_register_not (struct gdbarch *gdbarch, int regnum);
148
149 /* Legacy version of target_virtual_frame_pointer().  Assumes that
150    there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
151    raw.  */
152
153 extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
154
155 /* Default implementation of gdbarch_floatformat_for_type.  */
156 extern const struct floatformat **
157   default_floatformat_for_type (struct gdbarch *gdbarch,
158                                 const char *name, int len);
159
160 extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
161                                                CORE_ADDR pc);
162
163 extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
164                                               CORE_ADDR pc);
165
166 extern int generic_in_solib_return_trampoline (struct gdbarch *gdbarch,
167                                                CORE_ADDR pc, const char *name);
168
169 extern int generic_stack_frame_destroyed_p (struct gdbarch *gdbarch,
170                                             CORE_ADDR pc);
171
172 extern int default_code_of_frame_writable (struct gdbarch *gdbarch,
173                                            struct frame_info *frame);
174
175 /* By default, registers are not convertible.  */
176 extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
177                                        struct type *type);
178
179 extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
180                                             struct type *type);
181
182 extern int generic_instruction_nullified (struct gdbarch *gdbarch,
183                                           struct regcache *regcache);
184
185 int default_remote_register_number (struct gdbarch *gdbarch,
186                                     int regno);
187
188 /* For compatibility with older architectures, returns
189    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
190    name.  */
191
192 extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);
193
194 /* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
195    order was explicitly selected.  */
196 extern enum bfd_endian selected_byte_order (void);
197
198 /* Return the selected architecture's name, or NULL if no architecture
199    was explicitly selected.  */
200 extern const char *selected_architecture_name (void);
201
202 /* Initialize a ``struct info''.  Can't use memset(0) since some
203    default values are not zero.  "fill" takes all available
204    information and fills in any unspecified fields.  */
205
206 extern void gdbarch_info_init (struct gdbarch_info *info);
207
208 /* Similar to init, but this time fill in the blanks.  Information is
209    obtained from the global "set ..." options and explicitly
210    initialized INFO fields.  */
211 extern void gdbarch_info_fill (struct gdbarch_info *info);
212
213 /* Return the architecture for ABFD.  If no suitable architecture
214    could be find, return NULL.  */
215
216 extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
217
218 /* Return "current" architecture.  If the target is running, this is the
219    architecture of the selected frame.  Otherwise, the "current" architecture
220    defaults to the target architecture.
221
222    This function should normally be called solely by the command interpreter
223    routines to determine the architecture to execute a command in.  */
224 extern struct gdbarch *get_current_arch (void);
225
226 extern int default_has_shared_address_space (struct gdbarch *);
227
228 extern int default_fast_tracepoint_valid_at (struct gdbarch *gdbarch,
229                                              CORE_ADDR addr, char **msg);
230
231 extern void default_gen_return_address (struct gdbarch *gdbarch,
232                                         struct agent_expr *ax,
233                                         struct axs_value *value,
234                                         CORE_ADDR scope);
235
236 extern const char *default_auto_charset (void);
237 extern const char *default_auto_wide_charset (void);
238
239 extern int default_return_in_first_hidden_param_p (struct gdbarch *,
240                                                    struct type *);
241
242 extern int default_insn_is_call (struct gdbarch *, CORE_ADDR);
243 extern int default_insn_is_ret (struct gdbarch *, CORE_ADDR);
244 extern int default_insn_is_jump (struct gdbarch *, CORE_ADDR);
245
246 /* Do-nothing version of vsyscall_range.  Returns false.  */
247
248 extern int default_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
249
250 /* Default way to advance the PC to the next instruction in order to
251    skip a permanent breakpoint.  Increments the PC by the size of a
252    software breakpoint instruction, as determined with
253    gdbarch_breakpoint_from_pc.  This matches how the breakpoints
254    module determines whether a breakpoint is permanent.  */
255 extern void default_skip_permanent_breakpoint (struct regcache *regcache);
256
257 /* Symbols for gdbarch_infcall_mmap; their Linux PROT_* system
258    definitions would be dependent on compilation host.  */
259 #define GDB_MMAP_PROT_READ      0x1     /* Page can be read.  */
260 #define GDB_MMAP_PROT_WRITE     0x2     /* Page can be written.  */
261 #define GDB_MMAP_PROT_EXEC      0x4     /* Page can be executed.  */
262
263 extern CORE_ADDR default_infcall_mmap (CORE_ADDR size, unsigned prot);
264 extern void default_infcall_munmap (CORE_ADDR addr, CORE_ADDR size);
265 extern char *default_gcc_target_options (struct gdbarch *gdbarch);
266 extern const char *default_gnu_triplet_regexp (struct gdbarch *gdbarch);
267 extern int default_addressable_memory_unit_size (struct gdbarch *gdbarch);
268
269 extern void default_guess_tracepoint_registers (struct gdbarch *gdbarch,
270                                                 struct regcache *regcache,
271                                                 CORE_ADDR addr);
272
273 #endif