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 | ||
35 | /* Semi-opaque type used as result of sim_open and passed back to all | |
36 | other routines. "desc" is short for "descriptor". | |
37 | It is up to each simulator to define `sim_state'. */ | |
38 | ||
39 | typedef struct sim_state *SIM_DESC; | |
40 | ||
b0d8c28f DE |
41 | /* Values for `kind' arg to sim_open. */ |
42 | typedef enum { | |
43 | SIM_OPEN_STANDALONE, /* simulator used standalone (run.c) */ | |
44 | SIM_OPEN_DEBUG /* simulator used by debugger (gdb) */ | |
45 | } SIM_OPEN_KIND; | |
46 | ||
47 | /* Return codes from various functions. */ | |
48 | typedef enum { | |
49 | SIM_RC_FAIL = 0, | |
50 | SIM_RC_OK = 1 | |
51 | } SIM_RC; | |
52 | ||
05e4e44f AC |
53 | /* Main simulator entry points. */ |
54 | ||
55 | /* Initialize the simulator. This function is called when the simulator | |
38498962 DE |
56 | is selected from the gdb command line. |
57 | KIND specifies how the simulator will be used. Currently there are only | |
58 | two kinds: standalone and debug. | |
59 | ARGV is passed from the command line and can be used to select whatever | |
60 | run time options the simulator provides. | |
05e4e44f AC |
61 | ARGV is the standard NULL terminated array of pointers, with argv[0] |
62 | being the program name. | |
63 | The result is a descriptor that must be passed back to the other sim_foo | |
64 | functions. */ | |
65 | ||
b0d8c28f | 66 | SIM_DESC sim_open PARAMS ((SIM_OPEN_KIND kind, char **argv)); |
05e4e44f AC |
67 | |
68 | /* Terminate usage of the simulator. This may involve freeing target memory | |
69 | and closing any open files and mmap'd areas. You cannot assume sim_kill | |
70 | has already been called. | |
71 | QUITTING is non-zero if we cannot hang on errors. */ | |
72 | ||
73 | void sim_close PARAMS ((SIM_DESC sd, int quitting)); | |
74 | ||
75 | /* Load program PROG into the simulator. | |
76 | Return non-zero if you wish the caller to handle it | |
77 | (it is done this way because most simulators can use gr_load_image, | |
78 | but defining it as a callback seems awkward). */ | |
79 | ||
80 | int sim_load PARAMS ((SIM_DESC sd, char *prog, int from_tty)); | |
81 | ||
82 | /* Prepare to run the simulated program. | |
83 | START_ADDRESS is, yes, you guessed it, the start address of the program. | |
84 | ARGV and ENV are NULL terminated lists of pointers. | |
85 | Gdb will set the start address via sim_store_register as well, but | |
86 | standalone versions of existing simulators are not set up to cleanly call | |
87 | sim_store_register, so the START_ADDRESS argument is there as a | |
88 | workaround. */ | |
89 | ||
90 | void sim_create_inferior PARAMS ((SIM_DESC sd, SIM_ADDR start_address, | |
91 | char **argv, char **env)); | |
92 | ||
93 | /* Kill the running program. | |
94 | This may involve closing any open files and deleting any mmap'd areas. */ | |
95 | ||
96 | void sim_kill PARAMS ((SIM_DESC sd)); | |
97 | ||
98 | /* Read LENGTH bytes of the simulated program's memory and store in BUF. | |
99 | Result is number of bytes read, or zero if error. */ | |
100 | ||
101 | int sim_read PARAMS ((SIM_DESC sd, SIM_ADDR mem, unsigned char *buf, int length)); | |
102 | ||
103 | /* Store LENGTH bytes from BUF in the simulated program's memory. | |
104 | Result is number of bytes write, or zero if error. */ | |
105 | ||
106 | int sim_write PARAMS ((SIM_DESC sd, SIM_ADDR mem, unsigned char *buf, int length)); | |
107 | ||
108 | /* Fetch register REGNO and store the raw value in BUF. */ | |
109 | ||
110 | void sim_fetch_register PARAMS ((SIM_DESC sd, int regno, unsigned char *buf)); | |
111 | ||
112 | /* Store register REGNO from BUF (in raw format). */ | |
113 | ||
114 | void sim_store_register PARAMS ((SIM_DESC sd, int regno, unsigned char *buf)); | |
115 | ||
116 | /* Print some interesting information about the simulator. | |
117 | VERBOSE is non-zero for the wordy version. */ | |
118 | ||
119 | void sim_info PARAMS ((SIM_DESC sd, int verbose)); | |
120 | ||
121 | /* Fetch why the program stopped. | |
122 | SIGRC will contain either the argument to exit() or the signal number. */ | |
123 | ||
124 | enum sim_stop { sim_exited, sim_stopped, sim_signalled }; | |
125 | ||
126 | void sim_stop_reason PARAMS ((SIM_DESC sd, enum sim_stop *reason, int *sigrc)); | |
127 | ||
128 | /* Run (or resume) the program. */ | |
129 | ||
130 | void sim_resume PARAMS ((SIM_DESC sd, int step, int siggnal)); | |
131 | ||
132 | /* Passthru for other commands that the simulator might support. | |
133 | If SD is NULL, the command is to be interpreted as refering to | |
134 | the global state, however the simulator defines that. */ | |
135 | ||
136 | void sim_do_command PARAMS ((SIM_DESC sd, char *cmd)); | |
137 | ||
138 | /* Provide simulator with a standard host_callback_struct. | |
139 | If SD is NULL, the command is to be interpreted as refering to | |
140 | the global state, however the simulator defines that. */ | |
141 | ||
142 | void sim_set_callbacks PARAMS ((SIM_DESC sd, struct host_callback_struct *)); | |
143 | ||
87e43259 AC |
144 | |
145 | /* NOTE: sim_size() and sim_trace() are going away */ | |
146 | ||
147 | void sim_size PARAMS ((int i)); | |
148 | ||
149 | int sim_trace PARAMS ((SIM_DESC sd)); | |
150 | ||
151 | ||
05e4e44f | 152 | #endif /* !defined (REMOTE_SIM_H) */ |