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