xref: /dragonfly/contrib/gdb-7/gdb/arch-utils.h (revision 1b722dce)
1 /* Dynamic architecture support for GDB, the GNU debugger.
2 
3    Copyright (C) 1998, 1999, 2000, 2002, 2003, 2004, 2007, 2008, 2009
4    Free Software Foundation, Inc.
5 
6    This file is part of GDB.
7 
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12 
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17 
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
20 
21 #ifndef GDBARCH_UTILS_H
22 #define GDBARCH_UTILS_H
23 
24 struct gdbarch;
25 struct frame_info;
26 struct minimal_symbol;
27 struct type;
28 struct gdbarch_info;
29 
30 /* gdbarch trace variable */
31 extern int gdbarch_debug;
32 
33 /* An implementation of gdbarch_displaced_step_copy_insn for
34    processors that don't need to modify the instruction before
35    single-stepping the displaced copy.
36 
37    Simply copy gdbarch_max_insn_length (ARCH) bytes from FROM to TO.
38    The closure is an array of that many bytes containing the
39    instruction's bytes, allocated with xmalloc.  */
40 extern struct displaced_step_closure *
41   simple_displaced_step_copy_insn (struct gdbarch *gdbarch,
42                                    CORE_ADDR from, CORE_ADDR to,
43                                    struct regcache *regs);
44 
45 /* Simple implementation of gdbarch_displaced_step_free_closure: Call
46    xfree.
47    This is appropriate for use with simple_displaced_step_copy_insn.  */
48 extern void
49   simple_displaced_step_free_closure (struct gdbarch *gdbarch,
50                                       struct displaced_step_closure *closure);
51 
52 /* Default implementation of gdbarch_displaced_hw_singlestep.  */
53 extern int
54   default_displaced_step_hw_singlestep (struct gdbarch *gdbarch,
55 					struct displaced_step_closure *closure);
56 
57 /* Possible value for gdbarch_displaced_step_location:
58    Place displaced instructions at the program's entry point,
59    leaving space for inferior function call return breakpoints.  */
60 extern CORE_ADDR displaced_step_at_entry_point (struct gdbarch *gdbarch);
61 
62 /* The only possible cases for inner_than. */
63 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
64 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
65 
66 /* Identity functions on a CORE_ADDR.  Just return the "addr".  */
67 
68 extern CORE_ADDR core_addr_identity (struct gdbarch *gdbarch, CORE_ADDR addr);
69 extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
70 
71 /* No-op conversion of reg to regnum. */
72 
73 extern int no_op_reg_to_regnum (struct gdbarch *gdbarch, int reg);
74 
75 /* Do nothing version of elf_make_msymbol_special. */
76 
77 void default_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);
78 
79 /* Do nothing version of coff_make_msymbol_special. */
80 
81 void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
82 
83 /* Version of cannot_fetch_register() / cannot_store_register() that
84    always fails. */
85 
86 int cannot_register_not (struct gdbarch *gdbarch, int regnum);
87 
88 /* Legacy version of target_virtual_frame_pointer().  Assumes that
89    there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
90    raw.  */
91 
92 extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
93 
94 extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
95 					       CORE_ADDR pc);
96 
97 extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
98 					      CORE_ADDR pc);
99 
100 extern int generic_in_solib_return_trampoline (struct gdbarch *gdbarch,
101 					       CORE_ADDR pc, char *name);
102 
103 extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
104 
105 /* By default, registers are not convertible.  */
106 extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
107 				       struct type *type);
108 
109 extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
110 					    struct type *type);
111 
112 extern int generic_instruction_nullified (struct gdbarch *gdbarch,
113 					  struct regcache *regcache);
114 
115 int default_remote_register_number (struct gdbarch *gdbarch,
116 				    int regno);
117 
118 /* For compatibility with older architectures, returns
119    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
120    name.  */
121 
122 extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);
123 
124 /* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
125    order was explicitly selected.  */
126 extern enum bfd_endian selected_byte_order (void);
127 
128 /* Return the selected architecture's name, or NULL if no architecture
129    was explicitly selected.  */
130 extern const char *selected_architecture_name (void);
131 
132 /* Initialize a ``struct info''.  Can't use memset(0) since some
133    default values are not zero.  "fill" takes all available
134    information and fills in any unspecified fields.  */
135 
136 extern void gdbarch_info_init (struct gdbarch_info *info);
137 
138 /* Similar to init, but this time fill in the blanks.  Information is
139    obtained from the global "set ..." options and explicitly
140    initialized INFO fields.  */
141 extern void gdbarch_info_fill (struct gdbarch_info *info);
142 
143 /* Return the architecture for ABFD.  If no suitable architecture
144    could be find, return NULL.  */
145 
146 extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
147 
148 /* Return "current" architecture.  If the target is running, this is the
149    architecture of the selected frame.  Otherwise, the "current" architecture
150    defaults to the target architecture.
151 
152    This function should normally be called solely by the command interpreter
153    routines to determine the architecture to execute a command in.  */
154 extern struct gdbarch *get_current_arch (void);
155 
156 #endif
157