event.hh revision 13295 
1/*
2 * Copyright 2018 Google, Inc.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met: redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer;
8 * redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution;
11 * neither the name of the copyright holders nor the names of its
12 * contributors may be used to endorse or promote products derived from
13 * this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * Authors: Gabe Black
28 */
29
30#ifndef __SYSTEMC_CORE_EVENT_HH__
31#define __SYSTEMC_CORE_EVENT_HH__
32
33#include <list>
34#include <string>
35#include <vector>
36
37#include "sim/eventq.hh"
38#include "systemc/core/list.hh"
39#include "systemc/core/object.hh"
40#include "systemc/core/process.hh"
41#include "systemc/core/sched_event.hh"
42#include "systemc/core/sensitivity.hh"
43#include "systemc/ext/core/sc_prim.hh"
44#include "systemc/ext/core/sc_time.hh"
45
46namespace sc_core
47{
48
49class sc_event;
50
51} // namespace sc_core
52
53namespace sc_gem5
54{
55
56typedef std::vector<sc_core::sc_event *> Events;
57
58class Sensitivity;
59
60class Event
61{
62  public:
63    Event(sc_core::sc_event *_sc_event);
64    Event(sc_core::sc_event *_sc_event, const char *_basename);
65
66    ~Event();
67
68    sc_core::sc_event *sc_event() { return _sc_event; }
69
70    const std::string &name() const;
71    const std::string &basename() const;
72    bool inHierarchy() const;
73    sc_core::sc_object *getParentObject() const;
74
75    void notify(StaticSensitivities &senses);
76    void notify(DynamicSensitivities &senses);
77
78    void notify();
79    void notify(const sc_core::sc_time &t);
80    void
81    notify(double d, sc_core::sc_time_unit &u)
82    {
83        notify(sc_core::sc_time(d, u));
84    }
85    void cancel();
86
87    bool triggered() const;
88    uint64_t triggeredStamp() const { return _triggeredStamp; }
89
90    static Event *
91    getFromScEvent(sc_core::sc_event *e)
92    {
93        return e->_gem5_event;
94    }
95
96    static const Event *
97    getFromScEvent(const sc_core::sc_event *e)
98    {
99        return e->_gem5_event;
100    }
101
102    void
103    addSensitivity(StaticSensitivity *s) const
104    {
105        // Insert static sensitivities in reverse order to match Accellera's
106        // implementation.
107        auto &senses = s->ofMethod() ? staticSenseMethod : staticSenseThread;
108        senses.insert(senses.begin(), s);
109    }
110    void
111    delSensitivity(StaticSensitivity *s) const
112    {
113        auto &senses = s->ofMethod() ? staticSenseMethod : staticSenseThread;
114        for (auto &t: senses) {
115            if (t == s) {
116                t = senses.back();
117                senses.pop_back();
118                break;
119            }
120        }
121    }
122    void
123    addSensitivity(DynamicSensitivity *s) const
124    {
125        auto &senses = s->ofMethod() ? dynamicSenseMethod : dynamicSenseThread;
126        senses.push_back(s);
127    }
128    void
129    delSensitivity(DynamicSensitivity *s) const
130    {
131        auto &senses = s->ofMethod() ? dynamicSenseMethod : dynamicSenseThread;
132        for (auto &t: senses) {
133            if (t == s) {
134                t = senses.back();
135                senses.pop_back();
136                break;
137            }
138        }
139    }
140
141    void clearParent();
142
143  private:
144    sc_core::sc_event *_sc_event;
145
146    std::string _basename;
147    std::string _name;
148    bool _inHierarchy;
149
150    sc_core::sc_object *parent;
151
152    ScEvent delayedNotify;
153    mutable uint64_t _triggeredStamp;
154
155    mutable StaticSensitivities staticSenseMethod;
156    mutable StaticSensitivities staticSenseThread;
157    mutable DynamicSensitivities dynamicSenseMethod;
158    mutable DynamicSensitivities dynamicSenseThread;
159};
160
161extern Events topLevelEvents;
162extern Events allEvents;
163
164EventsIt findEvent(const std::string &name);
165
166} // namespace sc_gem5
167
168#endif  //__SYSTEMC_CORE_EVENT_HH__
169