gem5  v20.1.0.0
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 HelloObject::HelloObject(HelloObjectParams *params) :
36  SimObject(params),
37  // This is a C++ lambda. When the event is triggered, it will call the
38  // processEvent() function. (this must be captured)
39  event([this]{ processEvent(); }, name() + ".event"),
40  goodbye(params->goodbye_object),
41  // Note: This is not needed as you can *always* reference this->name()
42  myName(params->name),
43  latency(params->time_to_wait),
44  timesLeft(params->number_of_fires)
45 {
46  DPRINTF(HelloExample, "Created the hello object\n");
47  panic_if(!goodbye, "HelloObject must have a non-null GoodbyeObject");
48 }
49 
50 void
52 {
53  // Before simulation starts, we need to schedule the event
55 }
56 
57 void
59 {
60  timesLeft--;
61  DPRINTF(HelloExample, "Hello world! Processing the event! %d left\n",
62  timesLeft);
63 
64  if (timesLeft <= 0) {
65  DPRINTF(HelloExample, "Done firing!\n");
67  } else {
69  }
70 }
71 
73 HelloObjectParams::create()
74 {
75  return new HelloObject(this);
76 }
HelloObject::myName
const std::string myName
The name of this object in the Python config file.
Definition: hello_object.hh:53
HelloObject::latency
const Tick latency
Latency between calling the event (in ticks)
Definition: hello_object.hh:56
GoodbyeObject::sayGoodbye
void sayGoodbye(std::string name)
Called by an outside object.
Definition: goodbye_object.cc:59
HelloObject::startup
void startup()
Part of a SimObject's initilaization.
Definition: hello_object.cc:51
HelloObject::processEvent
void processEvent()
Example function to execute on an event trigger.
Definition: hello_object.cc:58
HelloObject::HelloObject
HelloObject(HelloObjectParams *p)
Definition: hello_object.cc:35
HelloObject::timesLeft
int timesLeft
Number of times left to fire the event before goodbye.
Definition: hello_object.hh:59
EventManager::schedule
void schedule(Event &event, Tick when)
Definition: eventq.hh:1005
DPRINTF
#define DPRINTF(x,...)
Definition: trace.hh:234
MipsISA::event
Bitfield< 10, 5 > event
Definition: pra_constants.hh:297
HelloObject::event
EventFunctionWrapper event
An event that wraps the above function.
Definition: hello_object.hh:47
hello_object.hh
name
const std::string & name()
Definition: trace.cc:50
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:197
HelloObject
Definition: hello_object.hh:38
logging.hh
HelloObject::goodbye
GoodbyeObject * goodbye
Pointer to the corresponding GoodbyeObject. Set via Python.
Definition: hello_object.hh:50
trace.hh
curTick
Tick curTick()
The current simulated tick.
Definition: core.hh:45
SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:92

Generated on Wed Sep 30 2020 14:02:12 for gem5 by doxygen 1.8.17