misc: merge branch 'release-staging-v19.0.0.0' into develop
[gem5.git] / src / sim / eventq_impl.hh
1 /*
2 * Copyright (c) 2012 The Regents of The University of Michigan
3 * Copyright (c) 2012-2013 Mark D. Hill and David A. Wood
4 * Copyright (c) 2013 Advanced Micro Devices, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are
9 * met: redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer;
11 * redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution;
14 * neither the name of the copyright holders nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31 #ifndef __SIM_EVENTQ_IMPL_HH__
32 #define __SIM_EVENTQ_IMPL_HH__
33
34 #include "base/trace.hh"
35 #include "sim/eventq.hh"
36
37 inline void
38 EventQueue::schedule(Event *event, Tick when, bool global)
39 {
40 assert(when >= getCurTick());
41 assert(!event->scheduled());
42 assert(event->initialized());
43
44 event->setWhen(when, this);
45
46 // The check below is to make sure of two things
47 // a. a thread schedules local events on other queues through the asyncq
48 // b. a thread schedules global events on the asyncq, whether or not
49 // this event belongs to this eventq. This is required to maintain
50 // a total order amongst the global events. See global_event.{cc,hh}
51 // for more explanation.
52 if (inParallelMode && (this != curEventQueue() || global)) {
53 asyncInsert(event);
54 } else {
55 insert(event);
56 }
57 event->flags.set(Event::Scheduled);
58 event->acquire();
59
60 if (DTRACE(Event))
61 event->trace("scheduled");
62 }
63
64 inline void
65 EventQueue::deschedule(Event *event)
66 {
67 assert(event->scheduled());
68 assert(event->initialized());
69 assert(!inParallelMode || this == curEventQueue());
70
71 remove(event);
72
73 event->flags.clear(Event::Squashed);
74 event->flags.clear(Event::Scheduled);
75
76 if (DTRACE(Event))
77 event->trace("descheduled");
78
79 event->release();
80 }
81
82 inline void
83 EventQueue::reschedule(Event *event, Tick when, bool always)
84 {
85 assert(when >= getCurTick());
86 assert(always || event->scheduled());
87 assert(event->initialized());
88 assert(!inParallelMode || this == curEventQueue());
89
90 if (event->scheduled()) {
91 remove(event);
92 } else {
93 event->acquire();
94 }
95
96 event->setWhen(when, this);
97 insert(event);
98 event->flags.clear(Event::Squashed);
99 event->flags.set(Event::Scheduled);
100
101 if (DTRACE(Event))
102 event->trace("rescheduled");
103 }
104
105 #endif // __SIM_EVENTQ_IMPL_HH__