RubySlicc_Util.hh revision 10348:c91b23c72d5e 
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/DataBlock.hh"
41#include "mem/packet.hh"
42
43inline Cycles zero_time() { return Cycles(0); }
44
45inline NodeID
46intToID(int nodenum)
47{
48    NodeID id = nodenum;
49    return id;
50}
51
52inline int
53IDToInt(NodeID id)
54{
55    int nodenum = id;
56    return nodenum;
57}
58
59// Appends an offset to an address
60inline Address
61setOffset(Address addr, int offset)
62{
63    Address result = addr;
64    result.setOffset(offset);
65    return result;
66}
67
68// Makes an address into a line address
69inline Address
70makeLineAddress(Address addr)
71{
72    Address result = addr;
73    result.makeLineAddress();
74    return result;
75}
76
77inline int
78addressOffset(Address addr)
79{
80    return addr.getOffset();
81}
82
83inline int
84mod(int val, int mod)
85{
86    return val % mod;
87}
88
89inline int max_tokens()
90{
91  return 1024;
92}
93
94/**
95 * This function accepts an address, a data block and a packet. If the address
96 * range for the data block contains the address which the packet needs to
97 * read, then the data from the data block is written to the packet. True is
98 * returned if the data block was read, otherwise false is returned.
99 */
100inline bool
101testAndRead(Address addr, DataBlock& blk, Packet *pkt)
102{
103    Address pktLineAddr(pkt->getAddr());
104    pktLineAddr.makeLineAddress();
105
106    Address lineAddr = addr;
107    lineAddr.makeLineAddress();
108
109    if (pktLineAddr == lineAddr) {
110        uint8_t *data = pkt->getPtr<uint8_t>(true);
111        unsigned int size_in_bytes = pkt->getSize();
112        unsigned startByte = pkt->getAddr() - lineAddr.getAddress();
113
114        for (unsigned i = 0; i < size_in_bytes; ++i) {
115            data[i] = blk.getByte(i + startByte);
116        }
117        return true;
118    }
119    return false;
120}
121
122/**
123 * This function accepts an address, a data block and a packet. If the address
124 * range for the data block contains the address which the packet needs to
125 * write, then the data from the packet is written to the data block. True is
126 * returned if the data block was written, otherwise false is returned.
127 */
128inline bool
129testAndWrite(Address addr, DataBlock& blk, Packet *pkt)
130{
131    Address pktLineAddr(pkt->getAddr());
132    pktLineAddr.makeLineAddress();
133
134    Address lineAddr = addr;
135    lineAddr.makeLineAddress();
136
137    if (pktLineAddr == lineAddr) {
138        uint8_t *data = pkt->getPtr<uint8_t>(true);
139        unsigned int size_in_bytes = pkt->getSize();
140        unsigned startByte = pkt->getAddr() - lineAddr.getAddress();
141
142        for (unsigned i = 0; i < size_in_bytes; ++i) {
143            blk.setByte(i + startByte, data[i]);
144        }
145        return true;
146    }
147    return false;
148}
149
150#endif // __MEM_RUBY_SLICC_INTERFACE_RUBYSLICCUTIL_HH__
151