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/goodbye_object.hh"
32
33#include "debug/HelloExample.hh"
34#include "sim/sim_exit.hh"
35
36GoodbyeObject::GoodbyeObject(GoodbyeObjectParams *params) :
37    SimObject(params), event([this]{ processEvent(); }, name() + ".event"),
38    bandwidth(params->write_bandwidth), bufferSize(params->buffer_size),
39    buffer(nullptr), bufferUsed(0)
40{
41    buffer = new char[bufferSize];
42    DPRINTF(HelloExample, "Created the goodbye object\n");
43}
44
45GoodbyeObject::~GoodbyeObject()
46{
47    delete[] buffer;
48}
49
50void
51GoodbyeObject::processEvent()
52{
53    DPRINTF(HelloExample, "Processing the event!\n");
54
55    // Actually do the "work" of the event
56    fillBuffer();
57}
58
59void
60GoodbyeObject::sayGoodbye(std::string other_name)
61{
62    DPRINTF(HelloExample, "Saying goodbye to %s\n", other_name);
63
64    message = "Goodbye " + other_name + "!! ";
65
66    // Kick off the the first buffer fill. If it can't fill the whole buffer
67    // because of a limited bandwidth, then this function will schedule another
68    // event to finish the fill
69    fillBuffer();
70}
71
72void
73GoodbyeObject::fillBuffer()
74{
75    // There better be a message
76    assert(message.length() > 0);
77
78    // Copy from the message to the buffer per byte.
79    int bytes_copied = 0;
80    for (auto it = message.begin();
81         it < message.end() && bufferUsed < bufferSize - 1;
82         it++, bufferUsed++, bytes_copied++) {
83        // Copy the character into the buffer
84        buffer[bufferUsed] = *it;
85    }
86
87    if (bufferUsed < bufferSize - 1) {
88        // Wait for the next copy for as long as it would have taken
89        DPRINTF(HelloExample, "Scheduling another fillBuffer in %d ticks\n",
90                bandwidth * bytes_copied);
91        schedule(event, curTick() + bandwidth * bytes_copied);
92    } else {
93        DPRINTF(HelloExample, "Goodbye done copying!\n");
94        // Be sure to take into account the time for the last bytes
95        exitSimLoop(buffer, 0, curTick() + bandwidth * bytes_copied);
96    }
97}
98
99GoodbyeObject*
100GoodbyeObjectParams::create()
101{
102    return new GoodbyeObject(this);
103}
104