gem5  v22.0.0.2
Consumer.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020-2021 ARM Limited
3  * All rights reserved.
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
15  * All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions are
19  * met: redistributions of source code must retain the above copyright
20  * notice, this list of conditions and the following disclaimer;
21  * redistributions in binary form must reproduce the above copyright
22  * notice, this list of conditions and the following disclaimer in the
23  * documentation and/or other materials provided with the distribution;
24  * neither the name of the copyright holders nor the names of its
25  * contributors may be used to endorse or promote products derived from
26  * this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 /*
42  * This is the virtual base class of all classes that can be the
43  * targets of wakeup events. There is only two methods, wakeup() and
44  * print() and no data members.
45  */
46 
47 #ifndef __MEM_RUBY_COMMON_CONSUMER_HH__
48 #define __MEM_RUBY_COMMON_CONSUMER_HH__
49 
50 #include <iostream>
51 #include <set>
52 
53 #include "sim/clocked_object.hh"
54 
55 namespace gem5
56 {
57 
58 namespace ruby
59 {
60 
61 class Consumer
62 {
63  public:
66 
67  virtual
69  { }
70 
71  virtual void wakeup() = 0;
72  virtual void print(std::ostream& out) const = 0;
73  virtual void storeEventInfo(int info) {}
74 
75  bool
77  {
78  return m_wakeup_ticks.find(time) != m_wakeup_ticks.end();
79  }
80 
83  {
84  return em;
85  }
86 
87  void scheduleEventAbsolute(Tick timeAbs);
88  void scheduleEvent(Cycles timeDelta);
89 
90  private:
91  std::set<Tick> m_wakeup_ticks;
94 
95  void scheduleNextWakeup();
96  void processCurrentEvent();
97 };
98 
99 
100 inline std::ostream&
101 operator<<(std::ostream& out, const Consumer& obj)
102 {
103  obj.print(out);
104  out << std::flush;
105  return out;
106 }
107 
108 } // namespace ruby
109 } // namespace gem5
110 
111 #endif // __MEM_RUBY_COMMON_CONSUMER_HH__
gem5::ruby::operator<<
std::ostream & operator<<(std::ostream &os, const BoolVec &myvector)
Definition: BoolVec.cc:49
gem5::ruby::Consumer::~Consumer
virtual ~Consumer()
Definition: Consumer.hh:68
gem5::ruby::Consumer
Definition: Consumer.hh:61
gem5::ruby::Consumer::processCurrentEvent
void processCurrentEvent()
Definition: Consumer.cc:86
gem5::ruby::Consumer::m_wakeup_ticks
std::set< Tick > m_wakeup_ticks
Definition: Consumer.hh:91
gem5::Cycles
Cycles is a wrapper class for representing cycle counts, i.e.
Definition: types.hh:78
gem5::ruby::Consumer::storeEventInfo
virtual void storeEventInfo(int info)
Definition: Consumer.hh:73
gem5::ruby::Consumer::scheduleNextWakeup
void scheduleNextWakeup()
Definition: Consumer.cc:71
gem5::ruby::Consumer::scheduleEvent
void scheduleEvent(Cycles timeDelta)
Definition: Consumer.cc:56
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::ruby::Consumer::Consumer
Consumer(ClockedObject *em, Event::Priority ev_prio=Event::Default_Pri)
Definition: Consumer.cc:49
gem5::ClockedObject
The ClockedObject class extends the SimObject with a clock and accessor functions to relate ticks to ...
Definition: clocked_object.hh:234
gem5::EventFunctionWrapper
Definition: eventq.hh:1115
gem5::ruby::Consumer::wakeup
virtual void wakeup()=0
gem5::ruby::Consumer::em
ClockedObject * em
Definition: Consumer.hh:93
clocked_object.hh
gem5::EventBase::Priority
int8_t Priority
Definition: eventq.hh:123
gem5::ruby::Consumer::m_wakeup_event
EventFunctionWrapper m_wakeup_event
Definition: Consumer.hh:92
gem5::EventBase::Default_Pri
static const Priority Default_Pri
Default is zero for historical reasons.
Definition: eventq.hh:179
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: gpu_translation_state.hh:37
gem5::ruby::Consumer::print
virtual void print(std::ostream &out) const =0
gem5::ruby::Consumer::scheduleEventAbsolute
void scheduleEventAbsolute(Tick timeAbs)
Definition: Consumer.cc:63
gem5::ruby::Consumer::getObject
ClockedObject * getObject()
Definition: Consumer.hh:82
gem5::ruby::Consumer::alreadyScheduled
bool alreadyScheduled(Tick time)
Definition: Consumer.hh:76

Generated on Thu Jul 28 2022 13:32:35 for gem5 by doxygen 1.8.17