RubySlicc_Util.hh revision 9484:e96ff45795bc 
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"
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
51zero_time()
52{
53    return 0;
54}
55
56inline NodeID
57intToID(int nodenum)
58{
59    NodeID id = nodenum;
60    return id;
61}
62
63inline int
64IDToInt(NodeID id)
65{
66    int nodenum = id;
67    return nodenum;
68}
69
70inline Time
71getTimeModInt(Time time, int modulus)
72{
73    return time % modulus;
74}
75
76inline Time
77getTimePlusInt(Time addend1, int addend2)
78{
79    return (Time) addend1 + addend2;
80}
81
82inline Time
83getTimeMinusTime(Time t1, Time t2)
84{
85    assert(t1 >= t2);
86    return t1 - t2;
87}
88
89// Return type for time_to_int is "Time" and not "int" so we get a
90// 64-bit integer
91inline Time
92time_to_int(Time time)
93{
94    return time;
95}
96
97// Appends an offset to an address
98inline Address
99setOffset(Address addr, int offset)
100{
101    Address result = addr;
102    result.setOffset(offset);
103    return result;
104}
105
106// Makes an address into a line address
107inline Address
108makeLineAddress(Address addr)
109{
110    Address result = addr;
111    result.makeLineAddress();
112    return result;
113}
114
115inline int
116addressOffset(Address addr)
117{
118    return addr.getOffset();
119}
120
121inline int
122mod(int val, int mod)
123{
124    return val % mod;
125}
126
127inline int max_tokens()
128{
129  return 1024;
130}
131
132/**
133 * This function accepts an address, a data block and a packet. If the address
134 * range for the data block contains the address which the packet needs to
135 * read, then the data from the data block is written to the packet. True is
136 * returned if the data block was read, otherwise false is returned.
137 */
138inline bool
139testAndRead(Address addr, DataBlock& blk, Packet *pkt)
140{
141    Address pktLineAddr(pkt->getAddr());
142    pktLineAddr.makeLineAddress();
143
144    Address lineAddr = addr;
145    lineAddr.makeLineAddress();
146
147    if (pktLineAddr == lineAddr) {
148        uint8_t *data = pkt->getPtr<uint8_t>(true);
149        unsigned int size_in_bytes = pkt->getSize();
150        unsigned startByte = pkt->getAddr() - lineAddr.getAddress();
151
152        for (unsigned i = 0; i < size_in_bytes; ++i) {
153            data[i] = blk.getByte(i + startByte);
154        }
155        return true;
156    }
157    return false;
158}
159
160/**
161 * This function accepts an address, a data block and a packet. If the address
162 * range for the data block contains the address which the packet needs to
163 * write, then the data from the packet is written to the data block. True is
164 * returned if the data block was written, otherwise false is returned.
165 */
166inline bool
167testAndWrite(Address addr, DataBlock& blk, Packet *pkt)
168{
169    Address pktLineAddr(pkt->getAddr());
170    pktLineAddr.makeLineAddress();
171
172    Address lineAddr = addr;
173    lineAddr.makeLineAddress();
174
175    if (pktLineAddr == lineAddr) {
176        uint8_t *data = pkt->getPtr<uint8_t>(true);
177        unsigned int size_in_bytes = pkt->getSize();
178        unsigned startByte = pkt->getAddr() - lineAddr.getAddress();
179
180        for (unsigned i = 0; i < size_in_bytes; ++i) {
181            blk.setByte(i + startByte, data[i]);
182        }
183        return true;
184    }
185    return false;
186}
187
188#endif // __MEM_RUBY_SLICC_INTERFACE_RUBYSLICCUTIL_HH__
189