Commit | Line | Data |
---|---|---|
252b5132 RH |
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 | #ifdef __cplusplus | |
24 | extern "C" { | |
25 | #endif | |
26 | ||
27 | /* This file is used when building stand-alone simulators, so isolate this | |
28 | file from gdb. */ | |
29 | ||
30 | /* Pick up CORE_ADDR_TYPE if defined (from gdb), otherwise use same value as | |
31 | gdb does (unsigned int - from defs.h). */ | |
32 | ||
33 | #ifndef CORE_ADDR_TYPE | |
34 | typedef unsigned int SIM_ADDR; | |
35 | #else | |
36 | typedef CORE_ADDR_TYPE SIM_ADDR; | |
37 | #endif | |
38 | ||
39 | ||
40 | /* Semi-opaque type used as result of sim_open and passed back to all | |
41 | other routines. "desc" is short for "descriptor". | |
42 | It is up to each simulator to define `sim_state'. */ | |
43 | ||
44 | typedef struct sim_state *SIM_DESC; | |
45 | ||
46 | ||
47 | /* Values for `kind' arg to sim_open. */ | |
48 | ||
49 | typedef enum { | |
50 | SIM_OPEN_STANDALONE, /* simulator used standalone (run.c) */ | |
51 | SIM_OPEN_DEBUG /* simulator used by debugger (gdb) */ | |
52 | } SIM_OPEN_KIND; | |
53 | ||
54 | ||
55 | /* Return codes from various functions. */ | |
56 | ||
57 | typedef enum { | |
58 | SIM_RC_FAIL = 0, | |
59 | SIM_RC_OK = 1, | |
60 | SIM_RC_UNKNOWN_BREAKPOINT = 2, | |
61 | SIM_RC_INSUFFICIENT_RESOURCES = 3, | |
62 | SIM_RC_DUPLICATE_BREAKPOINT = 4 | |
63 | } SIM_RC; | |
64 | ||
65 | ||
66 | /* The bfd struct, as an opaque type. */ | |
67 | ||
68 | struct _bfd; | |
69 | ||
70 | ||
71 | /* Main simulator entry points. */ | |
72 | ||
73 | ||
74 | /* Create a fully initialized simulator instance. | |
75 | ||
76 | (This function is called when the simulator is selected from the | |
77 | gdb command line.) | |
78 | ||
79 | KIND specifies how the simulator shall be used. Currently there | |
80 | are only two kinds: stand-alone and debug. | |
81 | ||
82 | CALLBACK specifies a standard host callback (defined in callback.h). | |
83 | ||
84 | ABFD, when non NULL, designates a target program. The program is | |
85 | not loaded. | |
86 | ||
87 | ARGV is a standard ARGV pointer such as that passed from the | |
88 | command line. The syntax of the argument list is is assumed to be | |
89 | ``SIM-PROG { SIM-OPTION } [ TARGET-PROGRAM { TARGET-OPTION } ]''. | |
90 | The trailing TARGET-PROGRAM and args are only valid for a | |
91 | stand-alone simulator. | |
92 | ||
93 | On success, the result is a non NULL descriptor that shall be | |
94 | passed to the other sim_foo functions. While the simulator | |
95 | configuration can be parameterized by (in decreasing precedence) | |
96 | ARGV's SIM-OPTION, ARGV's TARGET-PROGRAM and the ABFD argument, the | |
97 | successful creation of the simulator shall not dependent on the | |
98 | presence of any of these arguments/options. | |
99 | ||
100 | Hardware simulator: The created simulator shall be sufficiently | |
101 | initialized to handle, with out restrictions any client requests | |
102 | (including memory reads/writes, register fetch/stores and a | |
103 | resume). | |
104 | ||
105 | Process simulator: that process is not created until a call to | |
106 | sim_create_inferior. FIXME: What should the state of the simulator | |
107 | be? */ | |
108 | ||
109 | SIM_DESC sim_open PARAMS ((SIM_OPEN_KIND kind, struct host_callback_struct *callback, struct _bfd *abfd, char **argv)); | |
110 | ||
111 | ||
112 | /* Destory a simulator instance. | |
113 | ||
114 | QUITTING is non-zero if we cannot hang on errors. | |
115 | ||
116 | This may involve freeing target memory and closing any open files | |
117 | and mmap'd areas. You cannot assume sim_kill has already been | |
118 | called. */ | |
119 | ||
120 | void sim_close PARAMS ((SIM_DESC sd, int quitting)); | |
121 | ||
122 | ||
123 | /* Load program PROG into the simulators memory. | |
124 | ||
125 | If ABFD is non-NULL, the bfd for the file has already been opened. | |
126 | The result is a return code indicating success. | |
127 | ||
128 | Hardware simulator: Normally, each program section is written into | |
129 | memory according to that sections LMA using physical (direct) | |
130 | addressing. The exception being systems, such as PPC/CHRP, which | |
131 | support more complicated program loaders. A call to this function | |
132 | should not effect the state of the processor registers. Multiple | |
133 | calls to this function are permitted and have an accumulative | |
134 | effect. | |
135 | ||
136 | Process simulator: Calls to this function may be ignored. | |
137 | ||
138 | FIXME: Most hardware simulators load the image at the VMA using | |
139 | virtual addressing. | |
140 | ||
141 | FIXME: For some hardware targets, before a loaded program can be | |
142 | executed, it requires the manipulation of VM registers and tables. | |
143 | Such manipulation should probably (?) occure in | |
144 | sim_create_inferior. */ | |
145 | ||
146 | SIM_RC sim_load PARAMS ((SIM_DESC sd, char *prog, struct _bfd *abfd, int from_tty)); | |
147 | ||
148 | ||
149 | /* Prepare to run the simulated program. | |
150 | ||
151 | ABFD, if not NULL, provides initial processor state information. | |
152 | ARGV and ENV, if non NULL, are NULL terminated lists of pointers. | |
153 | ||
154 | Hardware simulator: This function shall initialize the processor | |
155 | registers to a known value. The program counter and possibly stack | |
156 | pointer shall be set using information obtained from ABFD (or | |
157 | hardware reset defaults). ARGV and ENV, dependant on the target | |
158 | ABI, may be written to memory. | |
159 | ||
160 | Process simulator: After a call to this function, a new process | |
161 | instance shall exist. The TEXT, DATA, BSS and stack regions shall | |
162 | all be initialized, ARGV and ENV shall be written to process | |
163 | address space (according to the applicable ABI) and the program | |
164 | counter and stack pointer set accordingly. */ | |
165 | ||
166 | SIM_RC sim_create_inferior PARAMS ((SIM_DESC sd, struct _bfd *abfd, char **argv, char **env)); | |
167 | ||
168 | ||
169 | /* Fetch LENGTH bytes of the simulated program's memory. Start fetch | |
170 | at virtual address MEM and store in BUF. Result is number of bytes | |
171 | read, or zero if error. */ | |
172 | ||
173 | int sim_read PARAMS ((SIM_DESC sd, SIM_ADDR mem, unsigned char *buf, int length)); | |
174 | ||
175 | ||
176 | /* Store LENGTH bytes from BUF into the simulated program's | |
177 | memory. Store bytes starting at virtual address MEM. Result is | |
178 | number of bytes write, or zero if error. */ | |
179 | ||
180 | int sim_write PARAMS ((SIM_DESC sd, SIM_ADDR mem, unsigned char *buf, int length)); | |
181 | ||
182 | ||
183 | /* Fetch register REGNO storing its raw (target endian) value in the | |
184 | LENGTH byte buffer BUF. Return the actual size of the register or | |
185 | zero if REGNO is not applicable. | |
186 | ||
187 | Legacy implementations ignore LENGTH and always return -1. | |
188 | ||
189 | If LENGTH does not match the size of REGNO no data is transfered | |
190 | (the actual register size is still returned). */ | |
191 | ||
192 | int sim_fetch_register PARAMS ((SIM_DESC sd, int regno, unsigned char *buf, int length)); | |
193 | ||
194 | ||
195 | /* Store register REGNO from the raw (target endian) value in BUF. | |
196 | Return the actual size of the register or zero if REGNO is not | |
197 | applicable. | |
198 | ||
199 | Legacy implementations ignore LENGTH and always return -1. | |
200 | ||
201 | If LENGTH does not match the size of REGNO no data is transfered | |
202 | (the actual register size is still returned). */ | |
203 | ||
204 | int sim_store_register PARAMS ((SIM_DESC sd, int regno, unsigned char *buf, int length)); | |
205 | ||
206 | ||
207 | /* Print whatever statistics the simulator has collected. | |
208 | ||
209 | VERBOSE is currently unused and must always be zero. */ | |
210 | ||
211 | void sim_info PARAMS ((SIM_DESC sd, int verbose)); | |
212 | ||
213 | ||
c1a8de50 AC |
214 | /* Run (or resume) the simulated program. |
215 | ||
216 | STEP, when non-zero indicates that only a single simulator cycle | |
217 | should be emulated. | |
218 | ||
219 | SIGGNAL, if non-zero is a (HOST) SIGRC value indicating the type of | |
220 | event (hardware interrupt, signal) to be delivered to the simulated | |
221 | program. | |
222 | ||
223 | Hardware simulator: If the SIGRC value returned by | |
224 | sim_stop_reason() is passed back to the simulator via SIGGNAL then | |
225 | the hardware simulator shall correctly deliver the hardware event | |
226 | indicated by that signal. If a value of zero is passed in then the | |
227 | simulation will continue as if there were no outstanding signal. | |
228 | The effect of any other SIGGNAL value is is implementation | |
229 | dependant. | |
230 | ||
231 | Process simulator: If SIGRC is non-zero then the corresponding | |
232 | signal is delivered to the simulated program and execution is then | |
233 | continued. A zero SIGRC value indicates that the program should | |
234 | continue as normal. */ | |
252b5132 RH |
235 | |
236 | void sim_resume PARAMS ((SIM_DESC sd, int step, int siggnal)); | |
237 | ||
238 | ||
239 | /* Asynchronous request to stop the simulation. | |
240 | A nonzero return indicates that the simulator is able to handle | |
241 | the request */ | |
242 | ||
243 | int sim_stop PARAMS ((SIM_DESC sd)); | |
244 | ||
245 | ||
246 | /* Fetch the REASON why the program stopped. | |
247 | ||
248 | SIM_EXITED: The program has terminated. SIGRC indicates the target | |
249 | dependant exit status. | |
250 | ||
251 | SIM_STOPPED: The program has stopped. SIGRC uses the host's signal | |
252 | numbering as a way of identifying the reaon: program interrupted by | |
253 | user via a sim_stop request (SIGINT); a breakpoint instruction | |
254 | (SIGTRAP); a completed single step (SIGTRAP); an internal error | |
255 | condition (SIGABRT); an illegal instruction (SIGILL); Access to an | |
256 | undefined memory region (SIGSEGV); Mis-aligned memory access | |
c1a8de50 AC |
257 | (SIGBUS). For some signals information in addition to the signal |
258 | number may be retained by the simulator (e.g. offending address), | |
259 | that information is not directly accessable via this interface. | |
252b5132 | 260 | |
c1a8de50 AC |
261 | SIM_SIGNALLED: The program has been terminated by a signal. The |
262 | simulator has encountered target code that causes the the program | |
263 | to exit with signal SIGRC. | |
252b5132 RH |
264 | |
265 | SIM_RUNNING, SIM_POLLING: The return of one of these values | |
266 | indicates a problem internal to the simulator. */ | |
267 | ||
268 | enum sim_stop { sim_running, sim_polling, sim_exited, sim_stopped, sim_signalled }; | |
269 | ||
270 | void sim_stop_reason PARAMS ((SIM_DESC sd, enum sim_stop *reason, int *sigrc)); | |
271 | ||
272 | ||
273 | /* Passthru for other commands that the simulator might support. | |
274 | Simulators should be prepared to deal with any combination of NULL | |
275 | or empty CMD. */ | |
276 | ||
277 | void sim_do_command PARAMS ((SIM_DESC sd, char *cmd)); | |
278 | ||
279 | /* Call these functions to set and clear breakpoints at ADDR. */ | |
280 | ||
281 | SIM_RC sim_set_breakpoint PARAMS ((SIM_DESC sd, SIM_ADDR addr)); | |
282 | SIM_RC sim_clear_breakpoint PARAMS ((SIM_DESC sd, SIM_ADDR addr)); | |
283 | SIM_RC sim_clear_all_breakpoints PARAMS ((SIM_DESC sd)); | |
284 | ||
285 | /* These functions are used to enable and disable breakpoints. */ | |
286 | ||
287 | SIM_RC sim_enable_breakpoint PARAMS ((SIM_DESC sd, SIM_ADDR addr)); | |
288 | SIM_RC sim_disable_breakpoint PARAMS ((SIM_DESC sd, SIM_ADDR addr)); | |
289 | SIM_RC sim_enable_all_breakpoints PARAMS ((SIM_DESC sd)); | |
290 | SIM_RC sim_disable_all_breakpoints PARAMS ((SIM_DESC sd)); | |
291 | \f | |
292 | ||
293 | /* Provide simulator with a default (global) host_callback_struct. | |
294 | THIS PROCEDURE IS DEPRECIATED. | |
295 | GDB and NRUN do not use this interface. | |
296 | This procedure does not take a SIM_DESC argument as it is | |
297 | used before sim_open. */ | |
298 | ||
299 | void sim_set_callbacks PARAMS ((struct host_callback_struct *)); | |
300 | ||
301 | ||
302 | /* Set the size of the simulator memory array. | |
303 | THIS PROCEDURE IS DEPRECIATED. | |
304 | GDB and NRUN do not use this interface. | |
305 | This procedure does not take a SIM_DESC argument as it is | |
306 | used before sim_open. */ | |
307 | ||
308 | void sim_size PARAMS ((int i)); | |
309 | ||
310 | ||
baa7ae6f | 311 | /* Single-step simulator with tracing enabled. |
252b5132 | 312 | THIS PROCEDURE IS DEPRECIATED. |
baa7ae6f | 313 | THIS PROCEDURE IS EVEN MORE DEPRECATED THAN SIM_SET_TRACE |
252b5132 | 314 | GDB and NRUN do not use this interface. |
baa7ae6f AC |
315 | This procedure returns: ``0'' indicating that the simulator should |
316 | be continued using sim_trace() calls; ``1'' indicating that the | |
317 | simulation has finished. */ | |
252b5132 RH |
318 | |
319 | int sim_trace PARAMS ((SIM_DESC sd)); | |
320 | ||
321 | ||
baa7ae6f AC |
322 | /* Enable tracing. |
323 | THIS PROCEDURE IS DEPRECIATED. | |
324 | GDB and NRUN do not use this interface. | |
325 | This procedure returns: ``0'' indicating that the simulator should | |
326 | be continued using sim_trace() calls; ``1'' indicating that the | |
327 | simulation has finished. */ | |
328 | ||
329 | void sim_set_trace PARAMS ((void)); | |
330 | ||
331 | ||
252b5132 RH |
332 | /* Configure the size of the profile buffer. |
333 | THIS PROCEDURE IS DEPRECIATED. | |
334 | GDB and NRUN do not use this interface. | |
335 | This procedure does not take a SIM_DESC argument as it is | |
336 | used before sim_open. */ | |
337 | ||
338 | void sim_set_profile_size PARAMS ((int n)); | |
339 | ||
340 | ||
341 | /* Kill the running program. | |
342 | THIS PROCEDURE IS DEPRECIATED. | |
343 | GDB and NRUN do not use this interface. | |
344 | This procedure will be replaced as part of the introduction of | |
345 | multi-cpu simulators. */ | |
346 | ||
347 | void sim_kill PARAMS ((SIM_DESC sd)); | |
348 | ||
349 | #ifdef __cplusplus | |
350 | } | |
351 | #endif | |
352 | ||
353 | #endif /* !defined (REMOTE_SIM_H) */ |