1/*
2 * Copyright (c) 2000-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Steve Reinhardt
29 * Nathan Binkert
30 */
31
32/* @file
33 * EventQueue interfaces
34 */
35
36#ifndef __SIM_EVENTQ_HH__
37#define __SIM_EVENTQ_HH__
38
39#include <algorithm>
40#include <cassert>
41#include <climits>
42#include <map>
43#include <string>
44#include <vector>
45
46#include "base/fast_alloc.hh"
47#include "base/flags.hh"
48#include "base/misc.hh"
49#include "base/trace.hh"
50#include "sim/serialize.hh"
51#include "sim/host.hh"
52
53class EventQueue; // forward declaration
54
55extern EventQueue mainEventQueue;
56
57/*
58 * An item on an event queue. The action caused by a given
59 * event is specified by deriving a subclass and overriding the
60 * process() member function.
61 *
62 * Caution, the order of members is chosen to maximize data packing.
63 */
64class Event : public Serializable, public FastAlloc
65{
66 friend class EventQueue;
67
68 protected:
69 typedef short FlagsType;
70 typedef ::Flags<FlagsType> Flags;
71
72 static const FlagsType PublicRead = 0x003f;
73 static const FlagsType PublicWrite = 0x001d;
74 static const FlagsType Squashed = 0x0001;
75 static const FlagsType Scheduled = 0x0002;
76 static const FlagsType AutoDelete = 0x0004;
77 static const FlagsType AutoSerialize = 0x0008;
78 static const FlagsType IsExitEvent = 0x0010;
79 static const FlagsType IsMainQueue = 0x0020;
| 1/*
2 * Copyright (c) 2000-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Steve Reinhardt
29 * Nathan Binkert
30 */
31
32/* @file
33 * EventQueue interfaces
34 */
35
36#ifndef __SIM_EVENTQ_HH__
37#define __SIM_EVENTQ_HH__
38
39#include <algorithm>
40#include <cassert>
41#include <climits>
42#include <map>
43#include <string>
44#include <vector>
45
46#include "base/fast_alloc.hh"
47#include "base/flags.hh"
48#include "base/misc.hh"
49#include "base/trace.hh"
50#include "sim/serialize.hh"
51#include "sim/host.hh"
52
53class EventQueue; // forward declaration
54
55extern EventQueue mainEventQueue;
56
57/*
58 * An item on an event queue. The action caused by a given
59 * event is specified by deriving a subclass and overriding the
60 * process() member function.
61 *
62 * Caution, the order of members is chosen to maximize data packing.
63 */
64class Event : public Serializable, public FastAlloc
65{
66 friend class EventQueue;
67
68 protected:
69 typedef short FlagsType;
70 typedef ::Flags<FlagsType> Flags;
71
72 static const FlagsType PublicRead = 0x003f;
73 static const FlagsType PublicWrite = 0x001d;
74 static const FlagsType Squashed = 0x0001;
75 static const FlagsType Scheduled = 0x0002;
76 static const FlagsType AutoDelete = 0x0004;
77 static const FlagsType AutoSerialize = 0x0008;
78 static const FlagsType IsExitEvent = 0x0010;
79 static const FlagsType IsMainQueue = 0x0020;
|
| 80#ifdef EVENTQ_DEBUG
81 static const FlagsType Initialized = 0xf000;
82#endif
|
80
81 private:
82 // The event queue is now a linked list of linked lists. The
83 // 'nextBin' pointer is to find the bin, where a bin is defined as
84 // when+priority. All events in the same bin will be stored in a
85 // second linked list (a stack) maintained by the 'nextInBin'
86 // pointer. The list will be accessed in LIFO order. The end
87 // result is that the insert/removal in 'nextBin' is
88 // linear/constant, and the lookup/removal in 'nextInBin' is
89 // constant/constant. Hopefully this is a significant improvement
90 // over the current fully linear insertion.
91 Event *nextBin;
92 Event *nextInBin;
93
94 static Event *insertBefore(Event *event, Event *curr);
95 static Event *removeItem(Event *event, Event *last);
96
97 Tick _when; //!< timestamp when event should be processed
98 short _priority; //!< event priority
99 Flags flags;
100
101#ifndef NDEBUG
102 /// Global counter to generate unique IDs for Event instances
103 static Counter instanceCounter;
104
105 /// This event's unique ID. We can also use pointer values for
106 /// this but they're not consistent across runs making debugging
107 /// more difficult. Thus we use a global counter value when
108 /// debugging.
109 Counter instance;
110
111 /// queue to which this event belongs (though it may or may not be
112 /// scheduled on this queue yet)
113 EventQueue *queue;
114#endif
115
116#ifdef EVENTQ_DEBUG
117 Tick whenCreated; //!< time created
118 Tick whenScheduled; //!< time scheduled
119#endif
120
121 void
122 setWhen(Tick when, EventQueue *q)
123 {
124 _when = when;
125#ifndef NDEBUG
126 queue = q;
127#endif
128#ifdef EVENTQ_DEBUG
129 whenScheduled = curTick;
130#endif
131 }
132
133 protected:
134 /// Accessor for flags.
135 Flags
136 getFlags() const
137 {
138 return flags & PublicRead;
139 }
140
141 Flags
142 getFlags(Flags _flags) const
143 {
144 assert(flags.noneSet(~PublicRead));
145 return flags.isSet(_flags);
146 }
147
148 Flags
149 allFlags(Flags _flags) const
150 {
151 assert(_flags.noneSet(~PublicRead));
152 return flags.allSet(_flags);
153 }
154
155 /// Accessor for flags.
156 void
157 setFlags(Flags _flags)
158 {
159 assert(_flags.noneSet(~PublicWrite));
160 flags.set(_flags);
161 }
162
163 void
164 clearFlags(Flags _flags)
165 {
166 assert(_flags.noneSet(~PublicWrite));
167 flags.clear(_flags);
168 }
169
170 void
171 clearFlags()
172 {
173 flags.clear(PublicWrite);
174 }
175
176 // This function isn't really useful if TRACING_ON is not defined
177 virtual void trace(const char *action); //!< trace event activity
178
179 public:
180 /// Event priorities, to provide tie-breakers for events scheduled
181 /// at the same cycle. Most events are scheduled at the default
182 /// priority; these values are used to control events that need to
183 /// be ordered within a cycle.
184 enum Priority {
185 /// Minimum priority
186 Minimum_Pri = SHRT_MIN,
187
188 /// If we enable tracing on a particular cycle, do that as the
189 /// very first thing so we don't miss any of the events on
190 /// that cycle (even if we enter the debugger).
191 Trace_Enable_Pri = -101,
192
193 /// Breakpoints should happen before anything else (except
194 /// enabling trace output), so we don't miss any action when
195 /// debugging.
196 Debug_Break_Pri = -100,
197
198 /// CPU switches schedule the new CPU's tick event for the
199 /// same cycle (after unscheduling the old CPU's tick event).
200 /// The switch needs to come before any tick events to make
201 /// sure we don't tick both CPUs in the same cycle.
202 CPU_Switch_Pri = -31,
203
204 /// For some reason "delayed" inter-cluster writebacks are
205 /// scheduled before regular writebacks (which have default
206 /// priority). Steve?
207 Delayed_Writeback_Pri = -1,
208
209 /// Default is zero for historical reasons.
210 Default_Pri = 0,
211
212 /// Serailization needs to occur before tick events also, so
213 /// that a serialize/unserialize is identical to an on-line
214 /// CPU switch.
215 Serialize_Pri = 32,
216
217 /// CPU ticks must come after other associated CPU events
218 /// (such as writebacks).
219 CPU_Tick_Pri = 50,
220
221 /// Statistics events (dump, reset, etc.) come after
222 /// everything else, but before exit.
223 Stat_Event_Pri = 90,
224
225 /// Progress events come at the end.
226 Progress_Event_Pri = 95,
227
228 /// If we want to exit on this cycle, it's the very last thing
229 /// we do.
230 Sim_Exit_Pri = 100,
231
232 /// Maximum priority
233 Maximum_Pri = SHRT_MAX
234 };
235
236 /*
237 * Event constructor
238 * @param queue that the event gets scheduled on
239 */
240 Event(Priority p = Default_Pri)
241 : nextBin(NULL), nextInBin(NULL), _priority(p)
242 {
243#ifndef NDEBUG
244 instance = ++instanceCounter;
245 queue = NULL;
246#endif
247#ifdef EVENTQ_DEBUG
| 83
84 private:
85 // The event queue is now a linked list of linked lists. The
86 // 'nextBin' pointer is to find the bin, where a bin is defined as
87 // when+priority. All events in the same bin will be stored in a
88 // second linked list (a stack) maintained by the 'nextInBin'
89 // pointer. The list will be accessed in LIFO order. The end
90 // result is that the insert/removal in 'nextBin' is
91 // linear/constant, and the lookup/removal in 'nextInBin' is
92 // constant/constant. Hopefully this is a significant improvement
93 // over the current fully linear insertion.
94 Event *nextBin;
95 Event *nextInBin;
96
97 static Event *insertBefore(Event *event, Event *curr);
98 static Event *removeItem(Event *event, Event *last);
99
100 Tick _when; //!< timestamp when event should be processed
101 short _priority; //!< event priority
102 Flags flags;
103
104#ifndef NDEBUG
105 /// Global counter to generate unique IDs for Event instances
106 static Counter instanceCounter;
107
108 /// This event's unique ID. We can also use pointer values for
109 /// this but they're not consistent across runs making debugging
110 /// more difficult. Thus we use a global counter value when
111 /// debugging.
112 Counter instance;
113
114 /// queue to which this event belongs (though it may or may not be
115 /// scheduled on this queue yet)
116 EventQueue *queue;
117#endif
118
119#ifdef EVENTQ_DEBUG
120 Tick whenCreated; //!< time created
121 Tick whenScheduled; //!< time scheduled
122#endif
123
124 void
125 setWhen(Tick when, EventQueue *q)
126 {
127 _when = when;
128#ifndef NDEBUG
129 queue = q;
130#endif
131#ifdef EVENTQ_DEBUG
132 whenScheduled = curTick;
133#endif
134 }
135
136 protected:
137 /// Accessor for flags.
138 Flags
139 getFlags() const
140 {
141 return flags & PublicRead;
142 }
143
144 Flags
145 getFlags(Flags _flags) const
146 {
147 assert(flags.noneSet(~PublicRead));
148 return flags.isSet(_flags);
149 }
150
151 Flags
152 allFlags(Flags _flags) const
153 {
154 assert(_flags.noneSet(~PublicRead));
155 return flags.allSet(_flags);
156 }
157
158 /// Accessor for flags.
159 void
160 setFlags(Flags _flags)
161 {
162 assert(_flags.noneSet(~PublicWrite));
163 flags.set(_flags);
164 }
165
166 void
167 clearFlags(Flags _flags)
168 {
169 assert(_flags.noneSet(~PublicWrite));
170 flags.clear(_flags);
171 }
172
173 void
174 clearFlags()
175 {
176 flags.clear(PublicWrite);
177 }
178
179 // This function isn't really useful if TRACING_ON is not defined
180 virtual void trace(const char *action); //!< trace event activity
181
182 public:
183 /// Event priorities, to provide tie-breakers for events scheduled
184 /// at the same cycle. Most events are scheduled at the default
185 /// priority; these values are used to control events that need to
186 /// be ordered within a cycle.
187 enum Priority {
188 /// Minimum priority
189 Minimum_Pri = SHRT_MIN,
190
191 /// If we enable tracing on a particular cycle, do that as the
192 /// very first thing so we don't miss any of the events on
193 /// that cycle (even if we enter the debugger).
194 Trace_Enable_Pri = -101,
195
196 /// Breakpoints should happen before anything else (except
197 /// enabling trace output), so we don't miss any action when
198 /// debugging.
199 Debug_Break_Pri = -100,
200
201 /// CPU switches schedule the new CPU's tick event for the
202 /// same cycle (after unscheduling the old CPU's tick event).
203 /// The switch needs to come before any tick events to make
204 /// sure we don't tick both CPUs in the same cycle.
205 CPU_Switch_Pri = -31,
206
207 /// For some reason "delayed" inter-cluster writebacks are
208 /// scheduled before regular writebacks (which have default
209 /// priority). Steve?
210 Delayed_Writeback_Pri = -1,
211
212 /// Default is zero for historical reasons.
213 Default_Pri = 0,
214
215 /// Serailization needs to occur before tick events also, so
216 /// that a serialize/unserialize is identical to an on-line
217 /// CPU switch.
218 Serialize_Pri = 32,
219
220 /// CPU ticks must come after other associated CPU events
221 /// (such as writebacks).
222 CPU_Tick_Pri = 50,
223
224 /// Statistics events (dump, reset, etc.) come after
225 /// everything else, but before exit.
226 Stat_Event_Pri = 90,
227
228 /// Progress events come at the end.
229 Progress_Event_Pri = 95,
230
231 /// If we want to exit on this cycle, it's the very last thing
232 /// we do.
233 Sim_Exit_Pri = 100,
234
235 /// Maximum priority
236 Maximum_Pri = SHRT_MAX
237 };
238
239 /*
240 * Event constructor
241 * @param queue that the event gets scheduled on
242 */
243 Event(Priority p = Default_Pri)
244 : nextBin(NULL), nextInBin(NULL), _priority(p)
245 {
246#ifndef NDEBUG
247 instance = ++instanceCounter;
248 queue = NULL;
249#endif
250#ifdef EVENTQ_DEBUG
|
| 251 flags.set(Initialized);
|
248 whenCreated = curTick;
249 whenScheduled = 0;
250#endif
251 }
252
253 virtual ~Event();
254 virtual const std::string name() const;
255
256 /// Return a C string describing the event. This string should
257 /// *not* be dynamically allocated; just a const char array
258 /// describing the event class.
259 virtual const char *description() const;
260
261 /// Dump the current event data
262 void dump() const;
263
264 public:
265 /*
266 * This member function is invoked when the event is processed
267 * (occurs). There is no default implementation; each subclass
268 * must provide its own implementation. The event is not
269 * automatically deleted after it is processed (to allow for
270 * statically allocated event objects).
271 *
272 * If the AutoDestroy flag is set, the object is deleted once it
273 * is processed.
274 */
275 virtual void process() = 0;
276
277 /// Determine if the current event is scheduled
278 bool scheduled() const { return flags.isSet(Scheduled); }
279
280 /// Squash the current event
281 void squash() { flags.set(Squashed); }
282
283 /// Check whether the event is squashed
284 bool squashed() const { return flags.isSet(Squashed); }
285
286 /// See if this is a SimExitEvent (without resorting to RTTI)
287 bool isExitEvent() const { return flags.isSet(IsExitEvent); }
288
289 /// Get the time that the event is scheduled
290 Tick when() const { return _when; }
291
292 /// Get the event priority
293 int priority() const { return _priority; }
294
295#ifndef SWIG
296 struct priority_compare
297 : public std::binary_function<Event *, Event *, bool>
298 {
299 bool
300 operator()(const Event *l, const Event *r) const
301 {
302 return l->when() >= r->when() || l->priority() >= r->priority();
303 }
304 };
305
306 virtual void serialize(std::ostream &os);
307 virtual void unserialize(Checkpoint *cp, const std::string §ion);
308#endif
309};
310
311/*
312 * Queue of events sorted in time order
313 */
314class EventQueue : public Serializable
315{
316 private:
317 std::string objName;
318 Event *head;
319
320 void insert(Event *event);
321 void remove(Event *event);
322
323 public:
324 EventQueue(const std::string &n)
325 : objName(n), head(NULL)
326 {}
327
328 virtual const std::string name() const { return objName; }
329
330 // schedule the given event on this queue
331 void schedule(Event *event, Tick when);
332 void deschedule(Event *event);
333 void reschedule(Event *event, Tick when, bool always = false);
334
335 Tick nextTick() const { return head->when(); }
336 Event *serviceOne();
337
338 // process all events up to the given timestamp. we inline a
339 // quick test to see if there are any events to process; if so,
340 // call the internal out-of-line version to process them all.
341 void
342 serviceEvents(Tick when)
343 {
344 while (!empty()) {
345 if (nextTick() > when)
346 break;
347
348 /**
349 * @todo this assert is a good bug catcher. I need to
350 * make it true again.
351 */
352 //assert(head->when() >= when && "event scheduled in the past");
353 serviceOne();
354 }
355 }
356
357 // default: process all events up to 'now' (curTick)
358 void serviceEvents() { serviceEvents(curTick); }
359
360 // return true if no events are queued
361 bool empty() const { return head == NULL; }
362
363 void dump() const;
364
365 Tick nextEventTime() { return empty() ? curTick : head->when(); }
366
367 bool debugVerify() const;
368
369#ifndef SWIG
370 virtual void serialize(std::ostream &os);
371 virtual void unserialize(Checkpoint *cp, const std::string §ion);
372#endif
373};
374
375#ifndef SWIG
376class EventManager
377{
378 protected:
379 /** A pointer to this object's event queue */
380 EventQueue *eventq;
381
382 public:
383 EventManager(EventManager &em) : eventq(em.queue()) {}
384 EventManager(EventManager *em) : eventq(em ? em->queue() : NULL) {}
385 EventManager(EventQueue *eq) : eventq(eq) {}
386
387 EventQueue *
388 queue() const
389 {
390 return eventq;
391 }
392
393 void
394 schedule(Event &event, Tick when)
395 {
396 eventq->schedule(&event, when);
397 }
398
399 void
400 deschedule(Event &event)
401 {
402 eventq->deschedule(&event);
403 }
404
405 void
406 reschedule(Event &event, Tick when, bool always = false)
407 {
408 eventq->reschedule(&event, when, always);
409 }
410
411 void
412 schedule(Event *event, Tick when)
413 {
414 eventq->schedule(event, when);
415 }
416
417 void
418 deschedule(Event *event)
419 {
420 eventq->deschedule(event);
421 }
422
423 void
424 reschedule(Event *event, Tick when, bool always = false)
425 {
426 eventq->reschedule(event, when, always);
427 }
428};
429
430template <class T, void (T::* F)()>
431void
432DelayFunction(EventQueue *eventq, Tick when, T *object)
433{
434 class DelayEvent : public Event
435 {
436 private:
437 T *object;
438
439 public:
440 DelayEvent(T *o)
441 : object(o)
442 { this->setFlags(AutoDelete); }
443 void process() { (object->*F)(); }
444 const char *description() const { return "delay"; }
445 };
446
447 eventq->schedule(new DelayEvent(object), when);
448}
449
450template <class T, void (T::* F)()>
451class EventWrapper : public Event
452{
453 private:
454 T *object;
455
456 public:
457 EventWrapper(T *obj, bool del = false, Priority p = Default_Pri)
458 : Event(p), object(obj)
459 {
460 if (del)
461 setFlags(AutoDelete);
462 }
463
464 void process() { (object->*F)(); }
465};
466
467inline void
468EventQueue::schedule(Event *event, Tick when)
469{
470 assert(when >= curTick);
471 assert(!event->scheduled());
| 252 whenCreated = curTick;
253 whenScheduled = 0;
254#endif
255 }
256
257 virtual ~Event();
258 virtual const std::string name() const;
259
260 /// Return a C string describing the event. This string should
261 /// *not* be dynamically allocated; just a const char array
262 /// describing the event class.
263 virtual const char *description() const;
264
265 /// Dump the current event data
266 void dump() const;
267
268 public:
269 /*
270 * This member function is invoked when the event is processed
271 * (occurs). There is no default implementation; each subclass
272 * must provide its own implementation. The event is not
273 * automatically deleted after it is processed (to allow for
274 * statically allocated event objects).
275 *
276 * If the AutoDestroy flag is set, the object is deleted once it
277 * is processed.
278 */
279 virtual void process() = 0;
280
281 /// Determine if the current event is scheduled
282 bool scheduled() const { return flags.isSet(Scheduled); }
283
284 /// Squash the current event
285 void squash() { flags.set(Squashed); }
286
287 /// Check whether the event is squashed
288 bool squashed() const { return flags.isSet(Squashed); }
289
290 /// See if this is a SimExitEvent (without resorting to RTTI)
291 bool isExitEvent() const { return flags.isSet(IsExitEvent); }
292
293 /// Get the time that the event is scheduled
294 Tick when() const { return _when; }
295
296 /// Get the event priority
297 int priority() const { return _priority; }
298
299#ifndef SWIG
300 struct priority_compare
301 : public std::binary_function<Event *, Event *, bool>
302 {
303 bool
304 operator()(const Event *l, const Event *r) const
305 {
306 return l->when() >= r->when() || l->priority() >= r->priority();
307 }
308 };
309
310 virtual void serialize(std::ostream &os);
311 virtual void unserialize(Checkpoint *cp, const std::string §ion);
312#endif
313};
314
315/*
316 * Queue of events sorted in time order
317 */
318class EventQueue : public Serializable
319{
320 private:
321 std::string objName;
322 Event *head;
323
324 void insert(Event *event);
325 void remove(Event *event);
326
327 public:
328 EventQueue(const std::string &n)
329 : objName(n), head(NULL)
330 {}
331
332 virtual const std::string name() const { return objName; }
333
334 // schedule the given event on this queue
335 void schedule(Event *event, Tick when);
336 void deschedule(Event *event);
337 void reschedule(Event *event, Tick when, bool always = false);
338
339 Tick nextTick() const { return head->when(); }
340 Event *serviceOne();
341
342 // process all events up to the given timestamp. we inline a
343 // quick test to see if there are any events to process; if so,
344 // call the internal out-of-line version to process them all.
345 void
346 serviceEvents(Tick when)
347 {
348 while (!empty()) {
349 if (nextTick() > when)
350 break;
351
352 /**
353 * @todo this assert is a good bug catcher. I need to
354 * make it true again.
355 */
356 //assert(head->when() >= when && "event scheduled in the past");
357 serviceOne();
358 }
359 }
360
361 // default: process all events up to 'now' (curTick)
362 void serviceEvents() { serviceEvents(curTick); }
363
364 // return true if no events are queued
365 bool empty() const { return head == NULL; }
366
367 void dump() const;
368
369 Tick nextEventTime() { return empty() ? curTick : head->when(); }
370
371 bool debugVerify() const;
372
373#ifndef SWIG
374 virtual void serialize(std::ostream &os);
375 virtual void unserialize(Checkpoint *cp, const std::string §ion);
376#endif
377};
378
379#ifndef SWIG
380class EventManager
381{
382 protected:
383 /** A pointer to this object's event queue */
384 EventQueue *eventq;
385
386 public:
387 EventManager(EventManager &em) : eventq(em.queue()) {}
388 EventManager(EventManager *em) : eventq(em ? em->queue() : NULL) {}
389 EventManager(EventQueue *eq) : eventq(eq) {}
390
391 EventQueue *
392 queue() const
393 {
394 return eventq;
395 }
396
397 void
398 schedule(Event &event, Tick when)
399 {
400 eventq->schedule(&event, when);
401 }
402
403 void
404 deschedule(Event &event)
405 {
406 eventq->deschedule(&event);
407 }
408
409 void
410 reschedule(Event &event, Tick when, bool always = false)
411 {
412 eventq->reschedule(&event, when, always);
413 }
414
415 void
416 schedule(Event *event, Tick when)
417 {
418 eventq->schedule(event, when);
419 }
420
421 void
422 deschedule(Event *event)
423 {
424 eventq->deschedule(event);
425 }
426
427 void
428 reschedule(Event *event, Tick when, bool always = false)
429 {
430 eventq->reschedule(event, when, always);
431 }
432};
433
434template <class T, void (T::* F)()>
435void
436DelayFunction(EventQueue *eventq, Tick when, T *object)
437{
438 class DelayEvent : public Event
439 {
440 private:
441 T *object;
442
443 public:
444 DelayEvent(T *o)
445 : object(o)
446 { this->setFlags(AutoDelete); }
447 void process() { (object->*F)(); }
448 const char *description() const { return "delay"; }
449 };
450
451 eventq->schedule(new DelayEvent(object), when);
452}
453
454template <class T, void (T::* F)()>
455class EventWrapper : public Event
456{
457 private:
458 T *object;
459
460 public:
461 EventWrapper(T *obj, bool del = false, Priority p = Default_Pri)
462 : Event(p), object(obj)
463 {
464 if (del)
465 setFlags(AutoDelete);
466 }
467
468 void process() { (object->*F)(); }
469};
470
471inline void
472EventQueue::schedule(Event *event, Tick when)
473{
474 assert(when >= curTick);
475 assert(!event->scheduled());
|
| 476#ifdef EVENTQ_DEBUG
477 assert((event->flags & Event::Initialized) == Event::Initialized);
478#endif
|
472
473 event->setWhen(when, this);
474 insert(event);
475 event->flags.set(Event::Scheduled);
476 if (this == &mainEventQueue)
477 event->flags.set(Event::IsMainQueue);
478 else
479 event->flags.clear(Event::IsMainQueue);
480
481 if (DTRACE(Event))
482 event->trace("scheduled");
483}
484
485inline void
486EventQueue::deschedule(Event *event)
487{
488 assert(event->scheduled());
| 479
480 event->setWhen(when, this);
481 insert(event);
482 event->flags.set(Event::Scheduled);
483 if (this == &mainEventQueue)
484 event->flags.set(Event::IsMainQueue);
485 else
486 event->flags.clear(Event::IsMainQueue);
487
488 if (DTRACE(Event))
489 event->trace("scheduled");
490}
491
492inline void
493EventQueue::deschedule(Event *event)
494{
495 assert(event->scheduled());
|
| 496#ifdef EVENTQ_DEBUG
497 assert((event->flags & Event::Initialized) == Event::Initialized);
498#endif
|
489
490 remove(event);
491
492 event->flags.clear(Event::Squashed);
493 event->flags.clear(Event::Scheduled);
494
495 if (event->flags.isSet(Event::AutoDelete))
496 delete event;
497
498 if (DTRACE(Event))
499 event->trace("descheduled");
500}
501
502inline void
503EventQueue::reschedule(Event *event, Tick when, bool always)
504{
505 assert(when >= curTick);
506 assert(always || event->scheduled());
| 499
500 remove(event);
501
502 event->flags.clear(Event::Squashed);
503 event->flags.clear(Event::Scheduled);
504
505 if (event->flags.isSet(Event::AutoDelete))
506 delete event;
507
508 if (DTRACE(Event))
509 event->trace("descheduled");
510}
511
512inline void
513EventQueue::reschedule(Event *event, Tick when, bool always)
514{
515 assert(when >= curTick);
516 assert(always || event->scheduled());
|
| 517#ifdef EVENTQ_DEBUG
518 assert((event->flags & Event::Initialized) == Event::Initialized);
519#endif
|
507
508 if (event->scheduled())
509 remove(event);
510
511 event->setWhen(when, this);
512 insert(event);
513 event->flags.clear(Event::Squashed);
514 event->flags.set(Event::Scheduled);
515 if (this == &mainEventQueue)
516 event->flags.set(Event::IsMainQueue);
517 else
518 event->flags.clear(Event::IsMainQueue);
519
520 if (DTRACE(Event))
521 event->trace("rescheduled");
522}
523
524inline bool
525operator<(const Event &l, const Event &r)
526{
527 return l.when() < r.when() ||
528 (l.when() == r.when() && l.priority() < r.priority());
529}
530
531inline bool
532operator>(const Event &l, const Event &r)
533{
534 return l.when() > r.when() ||
535 (l.when() == r.when() && l.priority() > r.priority());
536}
537
538inline bool
539operator<=(const Event &l, const Event &r)
540{
541 return l.when() < r.when() ||
542 (l.when() == r.when() && l.priority() <= r.priority());
543}
544inline bool
545operator>=(const Event &l, const Event &r)
546{
547 return l.when() > r.when() ||
548 (l.when() == r.when() && l.priority() >= r.priority());
549}
550
551inline bool
552operator==(const Event &l, const Event &r)
553{
554 return l.when() == r.when() && l.priority() == r.priority();
555}
556
557inline bool
558operator!=(const Event &l, const Event &r)
559{
560 return l.when() != r.when() || l.priority() != r.priority();
561}
562#endif
563
564#endif // __SIM_EVENTQ_HH__
| 520
521 if (event->scheduled())
522 remove(event);
523
524 event->setWhen(when, this);
525 insert(event);
526 event->flags.clear(Event::Squashed);
527 event->flags.set(Event::Scheduled);
528 if (this == &mainEventQueue)
529 event->flags.set(Event::IsMainQueue);
530 else
531 event->flags.clear(Event::IsMainQueue);
532
533 if (DTRACE(Event))
534 event->trace("rescheduled");
535}
536
537inline bool
538operator<(const Event &l, const Event &r)
539{
540 return l.when() < r.when() ||
541 (l.when() == r.when() && l.priority() < r.priority());
542}
543
544inline bool
545operator>(const Event &l, const Event &r)
546{
547 return l.when() > r.when() ||
548 (l.when() == r.when() && l.priority() > r.priority());
549}
550
551inline bool
552operator<=(const Event &l, const Event &r)
553{
554 return l.when() < r.when() ||
555 (l.when() == r.when() && l.priority() <= r.priority());
556}
557inline bool
558operator>=(const Event &l, const Event &r)
559{
560 return l.when() > r.when() ||
561 (l.when() == r.when() && l.priority() >= r.priority());
562}
563
564inline bool
565operator==(const Event &l, const Event &r)
566{
567 return l.when() == r.when() && l.priority() == r.priority();
568}
569
570inline bool
571operator!=(const Event &l, const Event &r)
572{
573 return l.when() != r.when() || l.priority() != r.priority();
574}
575#endif
576
577#endif // __SIM_EVENTQ_HH__
|