1 /* The common simulator framework for GDB, the GNU Debugger.
3 Copyright 2002-2021 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 3 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, see <http://www.gnu.org/licenses/>. */
29 When scheduling an event, the a delta of zero/one refers to the
33 **queue**|--insn--|*queue*|--insn--|*queue*|--insn--|*queue*|
35 `- +0 ------------ +1 --.. `----- +0 ------------- +1 --..
37 When the queue is initialized, the time is set to zero with a
38 number of initialization events scheduled. Consequently, as also
39 illustrated above, the event queue should be processed before the
40 first instruction. That instruction being executed during tick 1.
42 The simulator main loop may take a form similar to:
44 if (halt-/restart-setjmp)
47 .... // Determine who should go next
48 last-cpu-nr = get-last-cpu-nr (sd);
49 next-cpu-nr = get-next-cpu-nr (sd);
50 events-were-last? = (last-cpu-nr >= nr-cpus);
51 events-were-next? = (next-cpu-nr >= nr-cpus);
53 .... // process any outstanding events
54 sim_events_preprocess (sd, events-were-last?, events-were-next?);
58 .... // prime main loop
62 .... // model one insn of next-cpu-nr .. nr-cpus
63 if (sim_events_tick (sd))
64 sim_events_process (sd);
69 NB. In the above pseudo code it is assumed that any cpu-nr >=
70 nr-cpus is a marker for the event queue. */
73 typedef void sim_event_handler(SIM_DESC sd
, void *data
);
75 typedef struct _sim_event sim_event
;
77 typedef struct _sim_events sim_events
;
79 int nr_ticks_to_process
;
81 sim_event
*watchpoints
;
82 sim_event
*watchedpoints
;
84 /* flag additional work needed */
85 volatile int work_pending
;
86 /* the asynchronous event queue */
87 #ifndef MAX_NR_SIGNAL_SIM_EVENTS
88 #define MAX_NR_SIGNAL_SIM_EVENTS 2
93 unsigned long elapsed_wallclock
;
94 SIM_ELAPSED_TIME resume_wallclock
;
95 signed64 time_of_event
;
96 signed64 time_from_event
;
101 /* Install the "events" module. */
103 extern SIM_RC
sim_events_install (SIM_DESC sd
);
106 /* Schedule an event DELTA_TIME ticks into the future */
108 extern sim_event
*sim_events_schedule
111 sim_event_handler
*handler
,
114 extern sim_event
*sim_events_schedule_tracef
117 sim_event_handler
*handler
,
120 ...) ATTRIBUTE_NULL_PRINTF (5, 6);
122 extern sim_event
*sim_events_schedule_vtracef
125 sim_event_handler
*handler
,
128 va_list ap
) ATTRIBUTE_NULL_PRINTF (5, 0);
131 extern void sim_events_schedule_after_signal
134 sim_event_handler
*handler
,
137 /* NB: signal level events can't have trace strings as malloc isn't
142 /* Schedule an event milli-seconds from NOW. The exact interpretation
143 of wallclock is host dependant. */
145 extern sim_event
*sim_events_watch_clock
147 unsigned delta_ms_time
,
148 sim_event_handler
*handler
,
152 /* Schedule an event when a PC matches a range. */
154 extern sim_event
*sim_events_watch_pc
159 sim_event_handler
*handler
,
163 /* Schedule an event when the test (IS_WITHIN == (VAL >= LB && VAL <=
164 UB)) of the NR_BYTES value at HOST_ADDR with BYTE_ORDER endian is
167 HOST_ADDR: pointer into the host address space.
168 BYTE_ORDER: BFD_ENDIAN_UNKNOWN - host endian; BFD_ENDIAN_BIG;
169 BFD_ENDIAN_LITTLE. */
171 extern sim_event
*sim_events_watch_sim
175 enum bfd_endian byte_order
,
179 sim_event_handler
*handler
,
183 /* Schedule an event when the test (IS_WITHIN == (VAL >= LB && VAL <=
184 UB)) of the NR_BYTES value at CORE_ADDR in BYTE_ORDER endian is
187 CORE_ADDR/MAP: pointer into the target address space.
188 BYTE_ORDER: BFD_ENDIAN_UNKNOWN - host endian; BFD_ENDIAN_BIG;
189 BFD_ENDIAN_LITTLE. */
191 extern sim_event
*sim_events_watch_core
193 address_word core_addr
,
196 enum bfd_endian byte_order
,
200 sim_event_handler
*handler
,
203 /* Deschedule the specified event */
205 extern void sim_events_deschedule
207 sim_event
*event_to_remove
);
210 /* Prepare for main simulator loop. Ensure that the next thing to do
211 is not event processing.
213 If the simulator halted part way through event processing then both
214 EVENTS_WERE_LAST and EVENTS_WERE_NEXT shall be true.
216 If the simulator halted after processing the last cpu, then only
217 EVENTS_WERE_NEXT shall be true. */
220 (void) sim_events_preprocess
222 int events_were_last
,
223 int events_were_next
);
228 Separated into two parts so that the main loop can save its context
229 before the event queue is processed. When sim_events_tick*()
230 returns true, any simulation context should be saved and
231 sim_events_process() called.
233 SIM_EVENTS_TICK advances the clock by 1 cycle.
235 SIM_EVENTS_TICKN advances the clock by N cycles (1..MAXINT). */
238 (int) sim_events_tick
242 (int) sim_events_tickn
247 (void) sim_events_process
251 /* Advance the clock by an additional SLIP cycles at the next call to
252 sim_events_tick*(). For multiple calls, the effect is
256 (void) sim_events_slip
261 /* Progress time such that an event shall occur upon the next call to
266 (void) sim_events_timewarp
271 /* local concept of elapsed target time */
274 (signed64
) sim_events_time
278 /* local concept of elapsed host time (milliseconds) */
281 (unsigned long) sim_events_elapsed_time
284 /* Returns the time that remains before the event is raised. */
286 (signed64
) sim_events_remain_time
287 (SIM_DESC sd
, sim_event
*event
);