gem5  v21.1.0.2
hello_object.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Jason Lowe-Power
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 
30 
31 #include "base/logging.hh"
32 #include "base/trace.hh"
33 #include "debug/HelloExample.hh"
34 
35 namespace gem5
36 {
37 
38 HelloObject::HelloObject(const HelloObjectParams &params) :
39  SimObject(params),
40  // This is a C++ lambda. When the event is triggered, it will call the
41  // processEvent() function. (this must be captured)
42  event([this]{ processEvent(); }, name() + ".event"),
43  goodbye(params.goodbye_object),
44  // Note: This is not needed as you can *always* reference this->name()
45  myName(params.name),
46  latency(params.time_to_wait),
47  timesLeft(params.number_of_fires)
48 {
49  DPRINTF(HelloExample, "Created the hello object\n");
50  panic_if(!goodbye, "HelloObject must have a non-null GoodbyeObject");
51 }
52 
53 void
55 {
56  // Before simulation starts, we need to schedule the event
58 }
59 
60 void
62 {
63  timesLeft--;
64  DPRINTF(HelloExample, "Hello world! Processing the event! %d left\n",
65  timesLeft);
66 
67  if (timesLeft <= 0) {
68  DPRINTF(HelloExample, "Done firing!\n");
70  } else {
72  }
73 }
74 
75 } // namespace gem5
gem5::curTick
Tick curTick()
The universal simulation clock.
Definition: cur_tick.hh:46
gem5::MipsISA::event
Bitfield< 10, 5 > event
Definition: pra_constants.hh:300
gem5::EventManager::schedule
void schedule(Event &event, Tick when)
Definition: eventq.hh:1019
gem5::HelloObject::myName
const std::string myName
The name of this object in the Python config file.
Definition: hello_object.hh:56
gem5::HelloObject::processEvent
void processEvent()
Example function to execute on an event trigger.
Definition: hello_object.cc:61
DPRINTF
#define DPRINTF(x,...)
Definition: trace.hh:186
gem5::HelloObject::goodbye
GoodbyeObject * goodbye
Pointer to the corresponding GoodbyeObject. Set via Python.
Definition: hello_object.hh:53
gem5::GoodbyeObject::sayGoodbye
void sayGoodbye(std::string name)
Called by an outside object.
Definition: goodbye_object.cc:62
gem5::HelloObject::latency
const Tick latency
Latency between calling the event (in ticks)
Definition: hello_object.hh:59
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
hello_object.hh
gem5::HelloObject::event
EventFunctionWrapper event
An event that wraps the above function.
Definition: hello_object.hh:50
name
const std::string & name()
Definition: trace.cc:49
panic_if
#define panic_if(cond,...)
Conditional panic macro that checks the supplied condition and only panics if the condition is true a...
Definition: logging.hh:203
gem5::HelloObject::timesLeft
int timesLeft
Number of times left to fire the event before goodbye.
Definition: hello_object.hh:62
logging.hh
gem5::HelloObject::HelloObject
HelloObject(const HelloObjectParams &p)
Definition: hello_object.cc:38
trace.hh
gem5::HelloObject::startup
void startup()
Part of a SimObject's initilaization.
Definition: hello_object.cc:54
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40

Generated on Tue Sep 21 2021 12:25:25 for gem5 by doxygen 1.8.17