3 * Copyright (c) 1999-2005 Mark D. Hill and David A. Wood
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 // **PLEASE NOTE!** When adding objects to this file you must also add a line
34 // in the src/mem/ruby/SConscript file. Otherwise the external object's .hh
35 // file will not be copied to the protocol directory and you will encounter a
36 // undefined declaration error.
39 external_type(MessageBuffer, buffer="yes", inport="yes", outport="yes");
41 external_type(OutPort, primitive="yes");
43 external_type(InPort, primitive="yes") {
46 int dequeue_getDelayCycles();
51 external_type(NodeID, default="0");
52 external_type(MachineID);
54 MessageBuffer getMandatoryQueue(int core_id);
56 external_type(Set, non_obj="yes") {
66 bool isElement(NodeID);
69 bool intersectionIsEmpty(Set);
70 NodeID smallestElement();
73 external_type(NetDest, non_obj="yes") {
75 void setSize(int, int);
79 void addNetDest(NetDest);
80 void setNetDest(MachineType, Set);
82 void remove(MachineID);
84 void removeNetDest(NetDest);
86 void broadcast(MachineType);
91 bool isElement(NodeID);
92 bool isElement(MachineID);
94 bool isSuperset(NetDest);
96 bool intersectionIsEmpty(Set);
97 bool intersectionIsEmpty(NetDest);
98 MachineID smallestElement(MachineType);
101 external_type(Sequencer) {
102 void readCallback(Address, DataBlock);
103 void readCallback(Address, GenericMachineType, DataBlock);
104 void readCallback(Address, GenericMachineType, DataBlock, Time, Time, Time);
105 void writeCallback(Address, DataBlock);
106 void writeCallback(Address, GenericMachineType, DataBlock);
107 void writeCallback(Address, GenericMachineType, DataBlock, Time, Time, Time);
108 void checkCoherence(Address);
109 void profileNack(Address, int, int, uint64);
112 external_type(AbstractEntry, primitive="yes");
114 external_type(DirectoryMemory) {
115 AbstractEntry lookup(Address);
116 bool isPresent(Address);
117 void invalidateBlock(Address);
120 external_type(AbstractCacheEntry, primitive="yes");
122 external_type(CacheMemory) {
123 bool cacheAvail(Address);
124 Address cacheProbe(Address);
125 void allocate(Address, AbstractCacheEntry);
126 void deallocate(Address);
127 AbstractCacheEntry lookup(Address);
128 void changePermission(Address, AccessPermission);
129 bool isTagPresent(Address);
130 void profileMiss(CacheMsg);
132 void profileGenericRequest(GenericRequestType,
136 void setMRU(Address);
139 external_type(MemoryControl, inport="yes", outport="yes") {
143 external_type(DMASequencer) {
145 void dataCallback(DataBlock);
148 external_type(TimerTable, inport="yes") {
150 Address readyAddress();
151 void set(Address, int);
156 external_type(GenericBloomFilter) {
159 void increment(Address, int);
160 void decrement(Address, int);
161 void set(Address, int);
162 void unset(Address, int);
164 bool isSet(Address, int);
165 int getCount(Address, int);