gem5  v21.1.0.2
goodbye_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/trace.hh"
32 #include "debug/HelloExample.hh"
33 #include "sim/sim_exit.hh"
34 
35 namespace gem5
36 {
37 
38 GoodbyeObject::GoodbyeObject(const GoodbyeObjectParams &params) :
39  SimObject(params), event([this]{ processEvent(); }, name() + ".event"),
40  bandwidth(params.write_bandwidth), bufferSize(params.buffer_size),
41  buffer(nullptr), bufferUsed(0)
42 {
43  buffer = new char[bufferSize]();
44  DPRINTF(HelloExample, "Created the goodbye object\n");
45 }
46 
48 {
49  delete[] buffer;
50 }
51 
52 void
54 {
55  DPRINTF(HelloExample, "Processing the event!\n");
56 
57  // Actually do the "work" of the event
58  fillBuffer();
59 }
60 
61 void
62 GoodbyeObject::sayGoodbye(std::string other_name)
63 {
64  DPRINTF(HelloExample, "Saying goodbye to %s\n", other_name);
65 
66  message = "Goodbye " + other_name + "!! ";
67 
68  // Kick off the the first buffer fill. If it can't fill the whole buffer
69  // because of a limited bandwidth, then this function will schedule another
70  // event to finish the fill
71  fillBuffer();
72 }
73 
74 void
76 {
77  // There better be a message
78  assert(message.length() > 0);
79 
80  // Copy from the message to the buffer per byte.
81  int bytes_copied = 0;
82  for (auto it = message.begin();
83  it < message.end() && bufferUsed < bufferSize - 1;
84  it++, bufferUsed++, bytes_copied++) {
85  // Copy the character into the buffer
86  buffer[bufferUsed] = *it;
87  }
88 
89  if (bufferUsed < bufferSize - 1) {
90  // Wait for the next copy for as long as it would have taken
91  DPRINTF(HelloExample, "Scheduling another fillBuffer in %d ticks\n",
92  bandwidth * bytes_copied);
93  schedule(event, curTick() + bandwidth * bytes_copied);
94  } else {
95  DPRINTF(HelloExample, "Goodbye done copying!\n");
96  // Be sure to take into account the time for the last bytes
97  exitSimLoop(buffer, 0, curTick() + bandwidth * bytes_copied);
98  }
99 }
100 
101 } // namespace gem5
gem5::GoodbyeObject::GoodbyeObject
GoodbyeObject(const GoodbyeObjectParams &p)
Definition: goodbye_object.cc:38
gem5::curTick
Tick curTick()
The universal simulation clock.
Definition: cur_tick.hh:46
gem5::GoodbyeObject::event
EventFunctionWrapper event
An event that wraps the above function.
Definition: goodbye_object.hh:49
gem5::GoodbyeObject::bandwidth
float bandwidth
The bytes processed per tick.
Definition: goodbye_object.hh:58
gem5::MipsISA::event
Bitfield< 10, 5 > event
Definition: pra_constants.hh:300
gem5::GoodbyeObject::fillBuffer
void fillBuffer()
Fills the buffer for one iteration.
Definition: goodbye_object.cc:75
gem5::GoodbyeObject::bufferUsed
int bufferUsed
The amount of the buffer we've used so far.
Definition: goodbye_object.hh:70
gem5::EventManager::schedule
void schedule(Event &event, Tick when)
Definition: eventq.hh:1019
sim_exit.hh
gem5::exitSimLoop
void exitSimLoop(const std::string &message, int exit_code, Tick when, Tick repeat, bool serialize)
Schedule an event to exit the simulation loop (returning to Python) at the end of the current cycle (...
Definition: sim_events.cc:88
gem5::GoodbyeObject::processEvent
void processEvent()
Fill the buffer with the next chunk of data.
Definition: goodbye_object.cc:53
DPRINTF
#define DPRINTF(x,...)
Definition: trace.hh:186
gem5::GoodbyeObject::sayGoodbye
void sayGoodbye(std::string name)
Called by an outside object.
Definition: goodbye_object.cc:62
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
name
const std::string & name()
Definition: trace.cc:49
goodbye_object.hh
gem5::GoodbyeObject::bufferSize
int bufferSize
The size of the buffer we are going to fill.
Definition: goodbye_object.hh:61
trace.hh
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::GoodbyeObject::message
std::string message
The message to put into the buffer.
Definition: goodbye_object.hh:67
gem5::GoodbyeObject::buffer
char * buffer
The buffer we are putting our message in.
Definition: goodbye_object.hh:64
gem5::GoodbyeObject::~GoodbyeObject
~GoodbyeObject()
Definition: goodbye_object.cc:47

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