RubySlicc_Util.hh (9171:ae88ecf37145) RubySlicc_Util.hh (9302:c2e70a9bc340)
1/*
2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
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
29/*
30 * These are the functions that exported to slicc from ruby.
31 */
32
33#ifndef __MEM_RUBY_SLICC_INTERFACE_RUBYSLICCUTIL_HH__
34#define __MEM_RUBY_SLICC_INTERFACE_RUBYSLICCUTIL_HH__
35
36#include <cassert>
37
1/*
2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
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
29/*
30 * These are the functions that exported to slicc from ruby.
31 */
32
33#ifndef __MEM_RUBY_SLICC_INTERFACE_RUBYSLICCUTIL_HH__
34#define __MEM_RUBY_SLICC_INTERFACE_RUBYSLICCUTIL_HH__
35
36#include <cassert>
37
38#include "debug/RubySlicc.hh"
38#include "mem/ruby/common/Address.hh"
39#include "mem/ruby/common/Global.hh"
40#include "mem/ruby/slicc_interface/RubySlicc_ComponentMapping.hh"
41#include "mem/ruby/system/System.hh"
42
43inline int
44random(int n)
45{
46 return random() % n;
47}
48
49inline Time
50get_time()
51{
52 return g_system_ptr->getTime();
53}
54
55inline Time
56zero_time()
57{
58 return 0;
59}
60
61inline NodeID
62intToID(int nodenum)
63{
64 NodeID id = nodenum;
65 return id;
66}
67
68inline int
69IDToInt(NodeID id)
70{
71 int nodenum = id;
72 return nodenum;
73}
74
75inline Time
76getTimeModInt(Time time, int modulus)
77{
78 return time % modulus;
79}
80
81inline Time
82getTimePlusInt(Time addend1, int addend2)
83{
84 return (Time) addend1 + addend2;
85}
86
87inline Time
88getTimeMinusTime(Time t1, Time t2)
89{
90 assert(t1 >= t2);
91 return t1 - t2;
92}
93
94// Return type for time_to_int is "Time" and not "int" so we get a
95// 64-bit integer
96inline Time
97time_to_int(Time time)
98{
99 return time;
100}
101
102// Appends an offset to an address
103inline Address
104setOffset(Address addr, int offset)
105{
106 Address result = addr;
107 result.setOffset(offset);
108 return result;
109}
110
111// Makes an address into a line address
112inline Address
113makeLineAddress(Address addr)
114{
115 Address result = addr;
116 result.makeLineAddress();
117 return result;
118}
119
120inline int
121addressOffset(Address addr)
122{
123 return addr.getOffset();
124}
125
126inline int
127mod(int val, int mod)
128{
129 return val % mod;
130}
131
39#include "mem/ruby/common/Address.hh"
40#include "mem/ruby/common/Global.hh"
41#include "mem/ruby/slicc_interface/RubySlicc_ComponentMapping.hh"
42#include "mem/ruby/system/System.hh"
43
44inline int
45random(int n)
46{
47 return random() % n;
48}
49
50inline Time
51get_time()
52{
53 return g_system_ptr->getTime();
54}
55
56inline Time
57zero_time()
58{
59 return 0;
60}
61
62inline NodeID
63intToID(int nodenum)
64{
65 NodeID id = nodenum;
66 return id;
67}
68
69inline int
70IDToInt(NodeID id)
71{
72 int nodenum = id;
73 return nodenum;
74}
75
76inline Time
77getTimeModInt(Time time, int modulus)
78{
79 return time % modulus;
80}
81
82inline Time
83getTimePlusInt(Time addend1, int addend2)
84{
85 return (Time) addend1 + addend2;
86}
87
88inline Time
89getTimeMinusTime(Time t1, Time t2)
90{
91 assert(t1 >= t2);
92 return t1 - t2;
93}
94
95// Return type for time_to_int is "Time" and not "int" so we get a
96// 64-bit integer
97inline Time
98time_to_int(Time time)
99{
100 return time;
101}
102
103// Appends an offset to an address
104inline Address
105setOffset(Address addr, int offset)
106{
107 Address result = addr;
108 result.setOffset(offset);
109 return result;
110}
111
112// Makes an address into a line address
113inline Address
114makeLineAddress(Address addr)
115{
116 Address result = addr;
117 result.makeLineAddress();
118 return result;
119}
120
121inline int
122addressOffset(Address addr)
123{
124 return addr.getOffset();
125}
126
127inline int
128mod(int val, int mod)
129{
130 return val % mod;
131}
132
133/**
134 * This function accepts an address, a data block and a packet. If the address
135 * range for the data block contains the address which the packet needs to
136 * read, then the data from the data block is written to the packet. True is
137 * returned if the data block was read, otherwise false is returned.
138 */
139inline bool
140testAndRead(Address addr, DataBlock& blk, Packet *pkt)
141{
142 Address pktLineAddr(pkt->getAddr());
143 pktLineAddr.makeLineAddress();
144
145 Address lineAddr = addr;
146 lineAddr.makeLineAddress();
147
148 if (pktLineAddr == lineAddr) {
149 uint8_t *data = pkt->getPtr<uint8_t>(true);
150 unsigned int size_in_bytes = pkt->getSize();
151 unsigned startByte = pkt->getAddr() - lineAddr.getAddress();
152
153 for (unsigned i = 0; i < size_in_bytes; ++i) {
154 data[i] = blk.getByte(i + startByte);
155 }
156 return true;
157 }
158 return false;
159}
160
161/**
162 * This function accepts an address, a data block and a packet. If the address
163 * range for the data block contains the address which the packet needs to
164 * write, then the data from the packet is written to the data block. True is
165 * returned if the data block was written, otherwise false is returned.
166 */
167inline bool
168testAndWrite(Address addr, DataBlock& blk, Packet *pkt)
169{
170 Address pktLineAddr(pkt->getAddr());
171 pktLineAddr.makeLineAddress();
172
173 Address lineAddr = addr;
174 lineAddr.makeLineAddress();
175
176 if (pktLineAddr == lineAddr) {
177 uint8_t *data = pkt->getPtr<uint8_t>(true);
178 unsigned int size_in_bytes = pkt->getSize();
179 unsigned startByte = pkt->getAddr() - lineAddr.getAddress();
180
181 for (unsigned i = 0; i < size_in_bytes; ++i) {
182 blk.setByte(i + startByte, data[i]);
183 }
184 return true;
185 }
186 return false;
187}
188
132#endif // __MEM_RUBY_SLICC_INTERFACE_RUBYSLICCUTIL_HH__
189#endif // __MEM_RUBY_SLICC_INTERFACE_RUBYSLICCUTIL_HH__