Commit | Line | Data |
---|---|---|
05e4e44f AC |
1 | /* This file defines the interface between the simulator and gdb. |
2 | Copyright (C) 1993, 1994, 1996, 1997 Free Software Foundation, Inc. | |
3 | ||
4 | This file is part of GDB. | |
5 | ||
6 | This program is free software; you can redistribute it and/or modify | |
7 | it under the terms of the GNU General Public License as published by | |
8 | the Free Software Foundation; either version 2 of the License, or | |
9 | (at your option) any later version. | |
10 | ||
11 | This program is distributed in the hope that it will be useful, | |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
17 | along with this program; if not, write to the Free Software | |
18 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ | |
19 | ||
20 | #if !defined (REMOTE_SIM_H) | |
21 | #define REMOTE_SIM_H 1 | |
22 | ||
23 | /* This file is used when building stand-alone simulators, so isolate this | |
24 | file from gdb. */ | |
25 | ||
26 | /* Pick up CORE_ADDR_TYPE if defined (from gdb), otherwise use same value as | |
27 | gdb does (unsigned int - from defs.h). */ | |
28 | ||
29 | #ifndef CORE_ADDR_TYPE | |
30 | typedef unsigned int SIM_ADDR; | |
31 | #else | |
32 | typedef CORE_ADDR_TYPE SIM_ADDR; | |
33 | #endif | |
34 | ||
1fa0cc2d | 35 | |
05e4e44f AC |
36 | /* Semi-opaque type used as result of sim_open and passed back to all |
37 | other routines. "desc" is short for "descriptor". | |
38 | It is up to each simulator to define `sim_state'. */ | |
39 | ||
40 | typedef struct sim_state *SIM_DESC; | |
41 | ||
1fa0cc2d | 42 | |
b0d8c28f | 43 | /* Values for `kind' arg to sim_open. */ |
1fa0cc2d | 44 | |
b0d8c28f DE |
45 | typedef enum { |
46 | SIM_OPEN_STANDALONE, /* simulator used standalone (run.c) */ | |
47 | SIM_OPEN_DEBUG /* simulator used by debugger (gdb) */ | |
48 | } SIM_OPEN_KIND; | |
49 | ||
1fa0cc2d | 50 | |
b0d8c28f | 51 | /* Return codes from various functions. */ |
1fa0cc2d | 52 | |
b0d8c28f DE |
53 | typedef enum { |
54 | SIM_RC_FAIL = 0, | |
94dbc121 SG |
55 | SIM_RC_OK = 1, |
56 | SIM_RC_UNKNOWN_BREAKPOINT = 2, | |
57 | SIM_RC_INSUFFICIENT_RESOURCES = 3, | |
58 | SIM_RC_DUPLICATE_BREAKPOINT = 4 | |
b0d8c28f DE |
59 | } SIM_RC; |
60 | ||
1fa0cc2d | 61 | |
a1cb1f4b | 62 | /* The bfd struct, as an opaque type. */ |
1fa0cc2d | 63 | |
a1cb1f4b DE |
64 | struct _bfd; |
65 | ||
8517f62b | 66 | |
05e4e44f AC |
67 | /* Main simulator entry points. */ |
68 | ||
8517f62b | 69 | |
247fccde AC |
70 | /* Create a fully initialized simulator instance. |
71 | ||
1fa0cc2d AC |
72 | (This function is called when the simulator is selected from the |
73 | gdb command line.) | |
247fccde | 74 | |
fafce69a AC |
75 | KIND specifies how the simulator shall be used. Currently there |
76 | are only two kinds: stand-alone and debug. | |
247fccde | 77 | |
1fa0cc2d | 78 | CALLBACK specifies a standard host callback (defined in callback.h). |
05e4e44f | 79 | |
247fccde AC |
80 | ABFD, when non NULL, designates a target program. The program is |
81 | not loaded. | |
82 | ||
83 | ARGV is a standard ARGV pointer such as that passed from the | |
84 | command line. The syntax of the argument list is is assumed to be | |
85 | ``SIM-PROG { SIM-OPTION } [ TARGET-PROGRAM { TARGET-OPTION } ]''. | |
fafce69a AC |
86 | The trailing TARGET-PROGRAM and args are only valid for a |
87 | stand-alone simulator. | |
247fccde AC |
88 | |
89 | On success, the result is a non NULL descriptor that shall be | |
90 | passed to the other sim_foo functions. While the simulator | |
91 | configuration can be parameterized by (in decreasing precedence) | |
92 | ARGV's SIM-OPTION, ARGV's TARGET-PROGRAM and the ABFD argument, the | |
93 | successful creation of the simulator shall not dependent on the | |
94 | presence of any of these arguments/options. | |
95 | ||
fafce69a AC |
96 | Hardware simulator: The created simulator shall be sufficiently |
97 | initialized to handle, with out restrictions any client requests | |
98 | (including memory reads/writes, register fetch/stores and a | |
99 | resume). | |
247fccde | 100 | |
fafce69a AC |
101 | Process simulator: that process is not created until a call to |
102 | sim_create_inferior. FIXME: What should the state of the simulator | |
103 | be? */ | |
247fccde AC |
104 | |
105 | SIM_DESC sim_open PARAMS ((SIM_OPEN_KIND kind, struct host_callback_struct *callback, struct _bfd *abfd, char **argv)); | |
05e4e44f | 106 | |
8517f62b | 107 | |
1fa0cc2d | 108 | /* Destory a simulator instance. |
247fccde AC |
109 | |
110 | QUITTING is non-zero if we cannot hang on errors. | |
111 | ||
1fa0cc2d AC |
112 | This may involve freeing target memory and closing any open files |
113 | and mmap'd areas. You cannot assume sim_kill has already been | |
247fccde | 114 | called. */ |
05e4e44f AC |
115 | |
116 | void sim_close PARAMS ((SIM_DESC sd, int quitting)); | |
117 | ||
8517f62b | 118 | |
247fccde AC |
119 | /* Load program PROG into the simulators memory. |
120 | ||
a1cb1f4b | 121 | If ABFD is non-NULL, the bfd for the file has already been opened. |
247fccde AC |
122 | The result is a return code indicating success. |
123 | ||
fafce69a AC |
124 | Hardware simulator: A call to this function should not effect the |
125 | state of the processor registers. Multiple calls to this function | |
126 | are permitted and have an accumulative effect. | |
247fccde | 127 | |
fafce69a AC |
128 | Process simulator: Calls to this function may be ignored. |
129 | ||
130 | FIXME: Some hardware targets, before a loaded program can be | |
131 | executed, require the manipulation of VM registers and tables. | |
132 | Such manipulation should probably (?) occure in | |
133 | sim_create_inferior. */ | |
05e4e44f | 134 | |
a1cb1f4b | 135 | SIM_RC sim_load PARAMS ((SIM_DESC sd, char *prog, struct _bfd *abfd, int from_tty)); |
05e4e44f | 136 | |
8517f62b | 137 | |
05e4e44f | 138 | /* Prepare to run the simulated program. |
247fccde | 139 | |
fafce69a AC |
140 | ABFD, if not NULL, provides initial processor state information. |
141 | ARGV and ENV, if non NULL, are NULL terminated lists of pointers. | |
247fccde | 142 | |
fafce69a AC |
143 | Hardware simulator: This function shall initialize the processor |
144 | registers to a known value. The program counter and possibly stack | |
145 | pointer shall be set using information obtained from ABFD (or | |
146 | hardware reset defaults). ARGV and ENV, dependant on the target | |
147 | ABI, may be written to memory. | |
247fccde | 148 | |
fafce69a AC |
149 | Process simulator: After a call to this function, a new process |
150 | instance shall exist. The TEXT, DATA, BSS and stack regions shall | |
151 | all be initialized, ARGV and ENV shall be written to process | |
152 | address space (according to the applicable ABI) and the program | |
153 | counter and stack pointer set accordingly. */ | |
05e4e44f | 154 | |
fafce69a | 155 | SIM_RC sim_create_inferior PARAMS ((SIM_DESC sd, struct _bfd *abfd, char **argv, char **env)); |
05e4e44f | 156 | |
8517f62b | 157 | |
5ccb9020 AC |
158 | /* Fetch LENGTH bytes of the simulated program's memory. Start fetch |
159 | at virtual address MEM and store in BUF. Result is number of bytes | |
160 | read, or zero if error. */ | |
05e4e44f AC |
161 | |
162 | int sim_read PARAMS ((SIM_DESC sd, SIM_ADDR mem, unsigned char *buf, int length)); | |
163 | ||
8517f62b | 164 | |
5ccb9020 AC |
165 | /* Store LENGTH bytes from BUF into the simulated program's |
166 | memory. Store bytes starting at virtual address MEM. Result is | |
167 | number of bytes write, or zero if error. */ | |
05e4e44f AC |
168 | |
169 | int sim_write PARAMS ((SIM_DESC sd, SIM_ADDR mem, unsigned char *buf, int length)); | |
170 | ||
8517f62b | 171 | |
247fccde AC |
172 | /* Fetch register REGNO and store the raw (target endian) value in |
173 | BUF. */ | |
05e4e44f AC |
174 | |
175 | void sim_fetch_register PARAMS ((SIM_DESC sd, int regno, unsigned char *buf)); | |
176 | ||
8517f62b | 177 | |
1fa0cc2d | 178 | /* Store register REGNO from the raw (target endian) value in BUF. */ |
05e4e44f AC |
179 | |
180 | void sim_store_register PARAMS ((SIM_DESC sd, int regno, unsigned char *buf)); | |
181 | ||
8517f62b | 182 | |
a1cb1f4b | 183 | /* Print whatever statistics the simulator has collected. |
247fccde | 184 | |
a1cb1f4b | 185 | VERBOSE is currently unused and must always be zero. */ |
05e4e44f AC |
186 | |
187 | void sim_info PARAMS ((SIM_DESC sd, int verbose)); | |
188 | ||
05e4e44f | 189 | |
1fa0cc2d | 190 | /* Run (or resume) the simulated program. */ |
05e4e44f AC |
191 | |
192 | void sim_resume PARAMS ((SIM_DESC sd, int step, int siggnal)); | |
193 | ||
8517f62b AC |
194 | |
195 | /* Asynchronous request to stop the simulation. | |
196 | A nonzero return indicates that the simulator is able to handle | |
197 | the request */ | |
198 | ||
199 | int sim_stop PARAMS ((SIM_DESC sd)); | |
200 | ||
201 | ||
1fa0cc2d | 202 | /* Fetch the REASON why the program stopped. |
247fccde | 203 | |
1fa0cc2d AC |
204 | SIM_EXITED: The program has terminated. SIGRC indicates the target |
205 | dependant exit status. | |
247fccde | 206 | |
5ccb9020 AC |
207 | SIM_STOPPED: The program has stopped. SIGRC uses the host's signal |
208 | numbering as a way of identifying the reaon: program interrupted by | |
209 | user via a sim_stop request (SIGINT); a breakpoint instruction | |
210 | (SIGTRAP); a completed single step (SIGTRAP); an internal error | |
211 | condition (SIGABRT); an illegal instruction (SIGILL); Access to an | |
212 | undefined memory region (SIGSEGV); Mis-aligned memory access | |
213 | (SIGBUS). | |
247fccde | 214 | |
1fa0cc2d AC |
215 | SIM_SIGNALLED: The simulator encountered target code that requires |
216 | the signal SIGRC to be delivered to the simulated program. | |
247fccde | 217 | |
1fa0cc2d AC |
218 | SIM_RUNNING, SIM_POLLING: The return of one of these values |
219 | indicates a problem internal to the simulator. */ | |
220 | ||
221 | enum sim_stop { sim_running, sim_polling, sim_exited, sim_stopped, sim_signalled }; | |
222 | ||
223 | void sim_stop_reason PARAMS ((SIM_DESC sd, enum sim_stop *reason, int *sigrc)); | |
05e4e44f | 224 | |
8517f62b | 225 | |
1fa0cc2d AC |
226 | /* Passthru for other commands that the simulator might support. |
227 | Simulators should be prepared to deal with any combination of NULL | |
228 | or empty CMD. */ | |
229 | ||
05e4e44f | 230 | void sim_do_command PARAMS ((SIM_DESC sd, char *cmd)); |
94dbc121 SG |
231 | |
232 | /* Call these functions to set and clear breakpoints at ADDR. */ | |
233 | ||
234 | SIM_RC sim_set_breakpoint PARAMS ((SIM_DESC sd, SIM_ADDR addr)); | |
235 | SIM_RC sim_clear_breakpoint PARAMS ((SIM_DESC sd, SIM_ADDR addr)); | |
236 | SIM_RC sim_clear_all_breakpoints PARAMS ((SIM_DESC sd)); | |
237 | ||
238 | /* These functions are used to enable and disable breakpoints. */ | |
239 | ||
240 | SIM_RC sim_enable_breakpoint PARAMS ((SIM_DESC sd, SIM_ADDR addr)); | |
241 | SIM_RC sim_disable_breakpoint PARAMS ((SIM_DESC sd, SIM_ADDR addr)); | |
242 | SIM_RC sim_enable_all_breakpoints PARAMS ((SIM_DESC sd)); | |
243 | SIM_RC sim_disable_all_breakpoints PARAMS ((SIM_DESC sd)); | |
247fccde | 244 | \f |
8517f62b | 245 | |
1fa0cc2d | 246 | /* Provide simulator with a default (global) host_callback_struct. |
247fccde | 247 | THIS PROCEDURE IS DEPRECIATED. |
aa02a0b0 | 248 | GDB and NRUN do not use this interface. |
1fa0cc2d AC |
249 | This procedure does not take a SIM_DESC argument as it is |
250 | used before sim_open. */ | |
251 | ||
ff82f214 AC |
252 | void sim_set_callbacks PARAMS ((struct host_callback_struct *)); |
253 | ||
24aa2b57 | 254 | |
1fa0cc2d | 255 | /* Set the size of the simulator memory array. |
247fccde | 256 | THIS PROCEDURE IS DEPRECIATED. |
aa02a0b0 | 257 | GDB and NRUN do not use this interface. |
1fa0cc2d AC |
258 | This procedure does not take a SIM_DESC argument as it is |
259 | used before sim_open. */ | |
260 | ||
ff82f214 | 261 | void sim_size PARAMS ((int i)); |
87e43259 | 262 | |
87e43259 | 263 | |
1fa0cc2d | 264 | /* Run a simulation with tracing enabled. |
247fccde | 265 | THIS PROCEDURE IS DEPRECIATED. |
aa02a0b0 | 266 | GDB and NRUN do not use this interface. |
1fa0cc2d AC |
267 | This procedure does not take a SIM_DESC argument as it is |
268 | used before sim_open. */ | |
269 | ||
87e43259 AC |
270 | int sim_trace PARAMS ((SIM_DESC sd)); |
271 | ||
272 | ||
1fa0cc2d | 273 | /* Configure the size of the profile buffer. |
247fccde | 274 | THIS PROCEDURE IS DEPRECIATED. |
aa02a0b0 | 275 | GDB and NRUN do not use this interface. |
1fa0cc2d AC |
276 | This procedure does not take a SIM_DESC argument as it is |
277 | used before sim_open. */ | |
50a2a691 | 278 | |
1fa0cc2d | 279 | void sim_set_profile_size PARAMS ((int n)); |
50a2a691 | 280 | |
aa02a0b0 AC |
281 | |
282 | /* Kill the running program. | |
247fccde | 283 | THIS PROCEDURE IS DEPRECIATED. |
aa02a0b0 AC |
284 | GDB and NRUN do not use this interface. |
285 | This procedure will be replaced as part of the introduction of | |
286 | multi-cpu simulators. */ | |
287 | ||
288 | void sim_kill PARAMS ((SIM_DESC sd)); | |
289 | ||
05e4e44f | 290 | #endif /* !defined (REMOTE_SIM_H) */ |