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 * Authors: Jason Lowe-Power
29 */
30
31#include "learning_gem5/part2/hello_object.hh"
32
33#include "base/logging.hh"
34#include "debug/HelloExample.hh"
35
36HelloObject::HelloObject(HelloObjectParams *params) :
37    SimObject(params),
38    // This is a C++ lambda. When the event is triggered, it will call the
39    // processEvent() function. (this must be captured)
40    event([this]{ processEvent(); }, name() + ".event"),
41    goodbye(params->goodbye_object),
42    // Note: This is not needed as you can *always* reference this->name()
43    myName(params->name),
44    latency(params->time_to_wait),
45    timesLeft(params->number_of_fires)
46{
47    DPRINTF(HelloExample, "Created the hello object\n");
48    panic_if(!goodbye, "HelloObject must have a non-null GoodbyeObject");
49}
50
51void
52HelloObject::startup()
53{
54    // Before simulation starts, we need to schedule the event
55    schedule(event, latency);
56}
57
58void
59HelloObject::processEvent()
60{
61    timesLeft--;
62    DPRINTF(HelloExample, "Hello world! Processing the event! %d left\n",
63                          timesLeft);
64
65    if (timesLeft <= 0) {
66        DPRINTF(HelloExample, "Done firing!\n");
67        goodbye->sayGoodbye(myName);
68    } else {
69        schedule(event, curTick() + latency);
70    }
71}
72
73HelloObject*
74HelloObjectParams::create()
75{
76    return new HelloObject(this);
77}
78