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#ifndef __LEARNING_GEM5_GOODBYE_OBJECT_HH__
32#define __LEARNING_GEM5_GOODBYE_OBJECT_HH__
33
34#include <string>
35
36#include "params/GoodbyeObject.hh"
37#include "sim/sim_object.hh"
38
39class GoodbyeObject : public SimObject
40{
41  private:
42    /**
43     * Fill the buffer with the next chunk of data
44     */
45    void processEvent();
46
47    /// An event that wraps the above function
48    EventFunctionWrapper event;
49
50    /**
51     * Fills the buffer for one iteration. If the buffer isn't full, this
52     * function will enqueue another event to continue filling.
53     */
54    void fillBuffer();
55
56    /// The bytes processed per tick
57    float bandwidth;
58
59    /// The size of the buffer we are going to fill
60    int bufferSize;
61
62    /// The buffer we are putting our message in
63    char *buffer;
64
65    /// The message to put into the buffer.
66    std::string message;
67
68    /// The amount of the buffer we've used so far.
69    int bufferUsed;
70
71  public:
72    GoodbyeObject(GoodbyeObjectParams *p);
73    ~GoodbyeObject();
74
75    /**
76     * Called by an outside object. Starts off the events to fill the buffer
77     * with a goodbye message.
78     *
79     * @param name the name of the object we are saying goodbye to.
80     */
81    void sayGoodbye(std::string name);
82};
83
84#endif // __LEARNING_GEM5_GOODBYE_OBJECT_HH__
85