gem5 v24.1.0.1
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
WireBuffer.hh
Go to the documentation of this file.
1/*
2 * Copyright (c) 2010 Advanced Micro Devices, Inc.
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 * Author: Lisa Hsu
29 *
30 */
31
32#ifndef __MEM_RUBY_STRUCTURES_WIREBUFFER_HH__
33#define __MEM_RUBY_STRUCTURES_WIREBUFFER_HH__
34
35#include <iostream>
36#include <string>
37#include <vector>
38
41#include "params/RubyWireBuffer.hh"
42#include "sim/sim_object.hh"
43
44namespace gem5
45{
46
47namespace ruby
48{
49
51// This object was written to literally mimic a Wire in Ruby, in the sense
52// that there is no way for messages to get reordered en route on the WireBuffer.
53// With Message Buffers, even if randomization is off and ordered is on,
54// messages can arrive in different orders than they were sent because of
55// network issues. This mimics a Wire, such that that is not possible. This can
56// allow for messages between closely coupled controllers that are not actually
57// separated by a network in real systems to simplify coherence.
59
60class Message;
61
62class WireBuffer : public SimObject
63{
64 public:
65 typedef RubyWireBufferParams Params;
66 WireBuffer(const Params &p);
67 void init();
68
70
71 void wakeup();
72
73 void setConsumer(Consumer* consumer_ptr)
74 {
75 m_consumer_ptr = consumer_ptr;
76 }
78 void setDescription(const std::string& name) { m_description = name; };
79 std::string getDescription() { return m_description; };
80
81 // ruby_is_random and ruby_warmup are not used, but this method signature
82 // must match that of MessageBuffer.
83 void enqueue(MsgPtr message, Tick current_time, Tick delta,
84 bool ruby_is_random = false, bool ruby_warmup = false);
85 void dequeue(Tick current_time);
86 const Message* peek();
87 void recycle(Tick current_time, Tick recycle_latency);
88 bool isReady(Tick current_time);
89 // infinite queue length
90 bool areNSlotsAvailable(int n, Tick current_time) { return true; };
91
92 void print(std::ostream& out) const;
93 uint64_t m_msg_counter;
94
95 private:
96 // Private copy constructor and assignment operator
97 WireBuffer (const WireBuffer& obj);
99
100 // data members
101 Consumer* m_consumer_ptr; // Consumer to signal a wakeup()
102 std::string m_description;
103
104 // queues where memory requests live
106};
107
108std::ostream& operator<<(std::ostream& out, const WireBuffer& obj);
109
110} // namespace ruby
111} // namespace gem5
112
113#endif // __MEM_RUBY_STRUCTURES_WireBuffer_HH__
virtual std::string name() const
Definition named.hh:47
Abstract superclass for simulation objects.
std::string getDescription()
Definition WireBuffer.hh:79
WireBuffer(const WireBuffer &obj)
void init()
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition WireBuffer.cc:67
void setDescription(const std::string &name)
Definition WireBuffer.hh:78
void recycle(Tick current_time, Tick recycle_latency)
std::string m_description
void print(std::ostream &out) const
void setConsumer(Consumer *consumer_ptr)
Definition WireBuffer.hh:73
std::vector< MsgPtr > m_message_queue
const Message * peek()
WireBuffer & operator=(const WireBuffer &obj)
bool areNSlotsAvailable(int n, Tick current_time)
Definition WireBuffer.hh:90
void dequeue(Tick current_time)
Definition WireBuffer.cc:95
RubyWireBufferParams Params
Definition WireBuffer.hh:65
bool isReady(Tick current_time)
void enqueue(MsgPtr message, Tick current_time, Tick delta, bool ruby_is_random=false, bool ruby_warmup=false)
Definition WireBuffer.cc:76
Consumer * getConsumer()
Definition WireBuffer.hh:77
STL vector class.
Definition stl.hh:37
Bitfield< 31 > n
Bitfield< 0 > p
std::shared_ptr< Message > MsgPtr
Definition Message.hh:60
Copyright (c) 2024 Arm Limited All rights reserved.
Definition binary32.hh:36
uint64_t Tick
Tick count type.
Definition types.hh:58
std::ostream & operator<<(std::ostream &os, const BaseSemihosting::InPlaceArg &ipa)

Generated on Mon Jan 13 2025 04:28:41 for gem5 by doxygen 1.9.8