1 /* The common simulator framework for GDB, the GNU Debugger.
3 Copyright 2002, 2007 Free Software Foundation, Inc.
5 Contributed by Andrew Cagney and Red Hat.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
31 When scheduling an event, the a delta of zero/one refers to the
35 **queue**|--insn--|*queue*|--insn--|*queue*|--insn--|*queue*|
37 `- +0 ------------ +1 --.. `----- +0 ------------- +1 --..
39 When the queue is initialized, the time is set to zero with a
40 number of initialization events scheduled. Consequently, as also
41 illustrated above, the event queue should be processed before the
42 first instruction. That instruction being executed during tick 1.
44 The simulator main loop may take a form similar to:
46 if (halt-/restart-setjmp)
49 .... // Determine who should go next
50 last-cpu-nr = get-last-cpu-nr (sd);
51 next-cpu-nr = get-next-cpu-nr (sd);
52 events-were-last? = (last-cpu-nr >= nr-cpus);
53 events-were-next? = (next-cpu-nr >= nr-cpus);
55 .... // process any outstanding events
56 sim_events_preprocess (sd, events-were-last?, events-were-next?);
60 .... // prime main loop
64 .... // model one insn of next-cpu-nr .. nr-cpus
65 if (sim_events_tick (sd))
66 sim_events_process (sd);
71 NB. In the above pseudo code it is assumed that any cpu-nr >=
72 nr-cpus is a marker for the event queue. */
75 typedef void sim_event_handler(SIM_DESC sd
, void *data
);
77 typedef struct _sim_event sim_event
;
79 typedef struct _sim_events sim_events
;
81 int nr_ticks_to_process
;
83 sim_event
*watchpoints
;
84 sim_event
*watchedpoints
;
86 /* flag additional work needed */
87 volatile int work_pending
;
88 /* the asynchronous event queue */
89 #ifndef MAX_NR_SIGNAL_SIM_EVENTS
90 #define MAX_NR_SIGNAL_SIM_EVENTS 2
95 unsigned long elapsed_wallclock
;
96 SIM_ELAPSED_TIME resume_wallclock
;
97 signed64 time_of_event
;
104 /* Install the "events" module. */
106 extern SIM_RC
sim_events_install (SIM_DESC sd
);
109 /* Schedule an event DELTA_TIME ticks into the future */
111 extern sim_event
*sim_events_schedule
114 sim_event_handler
*handler
,
117 extern sim_event
*sim_events_schedule_tracef
120 sim_event_handler
*handler
,
123 ...) __attribute__ ((format (printf
, 5, 6)));
125 extern sim_event
*sim_events_schedule_vtracef
128 sim_event_handler
*handler
,
134 extern void sim_events_schedule_after_signal
137 sim_event_handler
*handler
,
140 /* NB: signal level events can't have trace strings as malloc isn't
145 /* Schedule an event milli-seconds from NOW. The exact interpretation
146 of wallclock is host dependant. */
148 extern sim_event
*sim_events_watch_clock
150 unsigned delta_ms_time
,
151 sim_event_handler
*handler
,
155 /* Schedule an event when the test (IS_WITHIN == (VAL >= LB && VAL <=
156 UB)) of the NR_BYTES value at HOST_ADDR with BYTE_ORDER endian is
159 HOST_ADDR: pointer into the host address space.
160 BYTE_ORDER: 0 - host endian; BIG_ENDIAN; LITTLE_ENDIAN */
162 extern sim_event
*sim_events_watch_sim
170 sim_event_handler
*handler
,
174 /* Schedule an event when the test (IS_WITHIN == (VAL >= LB && VAL <=
175 UB)) of the NR_BYTES value at CORE_ADDR in BYTE_ORDER endian is
178 CORE_ADDR/MAP: pointer into the target address space.
179 BYTE_ORDER: 0 - current target endian; BIG_ENDIAN; LITTLE_ENDIAN */
181 extern sim_event
*sim_events_watch_core
183 address_word core_addr
,
190 sim_event_handler
*handler
,
193 /* Deschedule the specified event */
195 extern void sim_events_deschedule
197 sim_event
*event_to_remove
);
200 /* Prepare for main simulator loop. Ensure that the next thing to do
201 is not event processing.
203 If the simulator halted part way through event processing then both
204 EVENTS_WERE_LAST and EVENTS_WERE_NEXT shall be true.
206 If the simulator halted after processing the last cpu, then only
207 EVENTS_WERE_NEXT shall be true. */
210 (void) sim_events_preprocess
212 int events_were_last
,
213 int events_were_next
);
218 Separated into two parts so that the main loop can save its context
219 before the event queue is processed. When sim_events_tick*()
220 returns true, any simulation context should be saved and
221 sim_events_process() called.
223 SIM_EVENTS_TICK advances the clock by 1 cycle.
225 SIM_EVENTS_TICKN advances the clock by N cycles (1..MAXINT). */
228 (int) sim_events_tick
232 (int) sim_events_tickn
237 (void) sim_events_process
241 /* Advance the clock by an additional SLIP cycles at the next call to
242 sim_events_tick*(). For multiple calls, the effect is
246 (void) sim_events_slip
251 /* Progress time such that an event shall occur upon the next call to
256 (void) sim_events_timewarp
261 /* local concept of elapsed target time */
264 (signed64
) sim_events_time
268 /* local concept of elapsed host time (milliseconds) */
271 (unsigned long) sim_events_elapsed_time
274 /* Returns the time that remains before the event is raised. */
276 (signed64
) sim_events_remain_time
277 (SIM_DESC sd
, sim_event
*event
);