Address.hh revision 6285
16285Snate@binkert.org 26145Snate@binkert.org/* 36239Snate@binkert.org * Copyright (c) 1999 Mark D. Hill and David A. Wood 46239Snate@binkert.org * All rights reserved. 56145Snate@binkert.org * 66239Snate@binkert.org * Redistribution and use in source and binary forms, with or without 76239Snate@binkert.org * modification, are permitted provided that the following conditions are 86239Snate@binkert.org * met: redistributions of source code must retain the above copyright 96239Snate@binkert.org * notice, this list of conditions and the following disclaimer; 106239Snate@binkert.org * redistributions in binary form must reproduce the above copyright 116239Snate@binkert.org * notice, this list of conditions and the following disclaimer in the 126239Snate@binkert.org * documentation and/or other materials provided with the distribution; 136239Snate@binkert.org * neither the name of the copyright holders nor the names of its 146239Snate@binkert.org * contributors may be used to endorse or promote products derived from 156239Snate@binkert.org * this software without specific prior written permission. 166145Snate@binkert.org * 176239Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 186239Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 196239Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 206239Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 216239Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 226239Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 236239Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 246239Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 256239Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 266239Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 276239Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 286145Snate@binkert.org */ 296145Snate@binkert.org 306285Snate@binkert.org/* 316285Snate@binkert.org * $Id$ 326285Snate@binkert.org */ 336285Snate@binkert.org 346145Snate@binkert.org#ifndef ADDRESS_H 356145Snate@binkert.org#define ADDRESS_H 366145Snate@binkert.org 376145Snate@binkert.org#include <iomanip> 386154Snate@binkert.org#include "mem/ruby/common/Global.hh" 396285Snate@binkert.org#include "mem/ruby/system/System.hh" 406154Snate@binkert.org#include "mem/ruby/system/NodeID.hh" 416154Snate@binkert.org#include "mem/ruby/system/MachineID.hh" 426145Snate@binkert.org 436145Snate@binkert.orgconst int ADDRESS_WIDTH = 64; // address width in bytes 446145Snate@binkert.org 456145Snate@binkert.orgclass Address; 466145Snate@binkert.orgtypedef Address PhysAddress; 476145Snate@binkert.orgtypedef Address VirtAddress; 486145Snate@binkert.org 496145Snate@binkert.orgclass Address { 506145Snate@binkert.orgpublic: 516145Snate@binkert.org // Constructors 526145Snate@binkert.org Address() { m_address = 0; } 536145Snate@binkert.org explicit Address(physical_address_t address) { m_address = address; } 546145Snate@binkert.org 556145Snate@binkert.org Address(const Address& obj); 566145Snate@binkert.org Address& operator=(const Address& obj); 576145Snate@binkert.org 586145Snate@binkert.org // Destructor 596145Snate@binkert.org // ~Address(); 606145Snate@binkert.org 616145Snate@binkert.org // Public Methods 626145Snate@binkert.org 636145Snate@binkert.org void setAddress(physical_address_t address) { m_address = address; } 646145Snate@binkert.org physical_address_t getAddress() const {return m_address;} 656145Snate@binkert.org // selects bits inclusive 666145Snate@binkert.org physical_address_t bitSelect(int small, int big) const; 676145Snate@binkert.org physical_address_t maskLowOrderBits(int number) const; 686145Snate@binkert.org physical_address_t maskHighOrderBits(int number) const; 696145Snate@binkert.org physical_address_t shiftLowOrderBits(int number) const; 706145Snate@binkert.org physical_address_t getLineAddress() const 716285Snate@binkert.org { return bitSelect(RubySystem::getBlockSizeBits(), ADDRESS_WIDTH); } 726145Snate@binkert.org physical_address_t getOffset() const 736285Snate@binkert.org { return bitSelect(0, RubySystem::getBlockSizeBits()-1); } 746145Snate@binkert.org 756285Snate@binkert.org void makeLineAddress() { m_address = maskLowOrderBits(RubySystem::getBlockSizeBits()); } 766145Snate@binkert.org // returns the next stride address based on line address 776145Snate@binkert.org void makeNextStrideAddress( int stride) { 786285Snate@binkert.org m_address = maskLowOrderBits(RubySystem::getBlockSizeBits()) 796285Snate@binkert.org + RubySystem::getBlockSizeBytes()*stride; 806145Snate@binkert.org } 816145Snate@binkert.org int getBankSetNum() const; 826145Snate@binkert.org int getBankSetDist() const; 836145Snate@binkert.org 846145Snate@binkert.org Index memoryModuleIndex() const; 856145Snate@binkert.org 866145Snate@binkert.org void print(ostream& out) const; 876145Snate@binkert.org void output(ostream& out) const; 886145Snate@binkert.org void input(istream& in); 896145Snate@binkert.org 906145Snate@binkert.org void setOffset( int offset ){ 916145Snate@binkert.org // first, zero out the offset bits 926145Snate@binkert.org makeLineAddress(); 936145Snate@binkert.org m_address |= (physical_address_t) offset; 946145Snate@binkert.org } 956145Snate@binkert.org 966145Snate@binkert.orgprivate: 976145Snate@binkert.org // Private Methods 986145Snate@binkert.org 996145Snate@binkert.org // Private copy constructor and assignment operator 1006145Snate@binkert.org // Address(const Address& obj); 1016145Snate@binkert.org // Address& operator=(const Address& obj); 1026145Snate@binkert.org 1036145Snate@binkert.org // Data Members (m_ prefix) 1046145Snate@binkert.org physical_address_t m_address; 1056145Snate@binkert.org}; 1066145Snate@binkert.org 1076145Snate@binkert.orginline 1086145Snate@binkert.orgAddress line_address(const Address& addr) { Address temp(addr); temp.makeLineAddress(); return temp; } 1096145Snate@binkert.org 1106285Snate@binkert.org/* 1116145Snate@binkert.orginline 1126145Snate@binkert.orgAddress next_stride_address(const Address& addr, int stride) { 1136145Snate@binkert.org Address temp = addr; 1146145Snate@binkert.org temp.makeNextStrideAddress(stride); 1156145Snate@binkert.org temp.setAddress(temp.maskHighOrderBits(ADDRESS_WIDTH-RubyConfig::memorySizeBits())); // surpress wrap-around problem 1166145Snate@binkert.org return temp; 1176145Snate@binkert.org} 1186285Snate@binkert.org*/ 1196145Snate@binkert.org 1206145Snate@binkert.org// Output operator declaration 1216145Snate@binkert.orgostream& operator<<(ostream& out, const Address& obj); 1226145Snate@binkert.org// comparison operator declaration 1236145Snate@binkert.orgbool operator==(const Address& obj1, const Address& obj2); 1246145Snate@binkert.orgbool operator!=(const Address& obj1, const Address& obj2); 1256145Snate@binkert.orgbool operator<(const Address& obj1, const Address& obj2); 1266145Snate@binkert.org/* Address& operator=(const physical_address_t address); */ 1276145Snate@binkert.org 1286145Snate@binkert.orginline 1296145Snate@binkert.orgbool operator<(const Address& obj1, const Address& obj2) 1306145Snate@binkert.org{ 1316145Snate@binkert.org return obj1.getAddress() < obj2.getAddress(); 1326145Snate@binkert.org} 1336145Snate@binkert.org 1346145Snate@binkert.org// ******************* Definitions ******************* 1356145Snate@binkert.org 1366145Snate@binkert.org// Output operator definition 1376145Snate@binkert.orginline 1386145Snate@binkert.orgostream& operator<<(ostream& out, const Address& obj) 1396145Snate@binkert.org{ 1406145Snate@binkert.org obj.print(out); 1416145Snate@binkert.org out << flush; 1426145Snate@binkert.org return out; 1436145Snate@binkert.org} 1446145Snate@binkert.org 1456145Snate@binkert.orginline 1466145Snate@binkert.orgbool operator==(const Address& obj1, const Address& obj2) 1476145Snate@binkert.org{ 1486145Snate@binkert.org return (obj1.getAddress() == obj2.getAddress()); 1496145Snate@binkert.org} 1506145Snate@binkert.org 1516145Snate@binkert.orginline 1526145Snate@binkert.orgbool operator!=(const Address& obj1, const Address& obj2) 1536145Snate@binkert.org{ 1546145Snate@binkert.org return (obj1.getAddress() != obj2.getAddress()); 1556145Snate@binkert.org} 1566145Snate@binkert.org 1576145Snate@binkert.orginline 1586145Snate@binkert.orgphysical_address_t Address::bitSelect(int small, int big) const // rips bits inclusive 1596145Snate@binkert.org{ 1606145Snate@binkert.org physical_address_t mask; 1616145Snate@binkert.org assert(big >= small); 1626145Snate@binkert.org 1636145Snate@binkert.org if (big >= ADDRESS_WIDTH - 1) { 1646145Snate@binkert.org return (m_address >> small); 1656145Snate@binkert.org } else { 1666145Snate@binkert.org mask = ~((physical_address_t)~0 << (big + 1)); 1676145Snate@binkert.org // FIXME - this is slow to manipulate a 64-bit number using 32-bits 1686145Snate@binkert.org physical_address_t partial = (m_address & mask); 1696145Snate@binkert.org return (partial >> small); 1706145Snate@binkert.org } 1716145Snate@binkert.org} 1726145Snate@binkert.org 1736145Snate@binkert.orginline 1746145Snate@binkert.orgphysical_address_t Address::maskLowOrderBits(int number) const 1756145Snate@binkert.org{ 1766145Snate@binkert.org physical_address_t mask; 1776145Snate@binkert.org 1786145Snate@binkert.org if (number >= ADDRESS_WIDTH - 1) { 1796145Snate@binkert.org mask = ~0; 1806145Snate@binkert.org } else { 1816145Snate@binkert.org mask = (physical_address_t)~0 << number; 1826145Snate@binkert.org } 1836145Snate@binkert.org return (m_address & mask); 1846145Snate@binkert.org} 1856145Snate@binkert.org 1866145Snate@binkert.orginline 1876145Snate@binkert.orgphysical_address_t Address::maskHighOrderBits(int number) const 1886145Snate@binkert.org{ 1896145Snate@binkert.org physical_address_t mask; 1906145Snate@binkert.org 1916145Snate@binkert.org if (number >= ADDRESS_WIDTH - 1) { 1926145Snate@binkert.org mask = ~0; 1936145Snate@binkert.org } else { 1946145Snate@binkert.org mask = (physical_address_t)~0 >> number; 1956145Snate@binkert.org } 1966145Snate@binkert.org return (m_address & mask); 1976145Snate@binkert.org} 1986145Snate@binkert.org 1996145Snate@binkert.orginline 2006145Snate@binkert.orgphysical_address_t Address::shiftLowOrderBits(int number) const 2016145Snate@binkert.org{ 2026145Snate@binkert.org return (m_address >> number); 2036145Snate@binkert.org} 2046145Snate@binkert.org 2056145Snate@binkert.orginline 2066145Snate@binkert.orginteger_t Address::memoryModuleIndex() const 2076145Snate@binkert.org{ 2086285Snate@binkert.org integer_t index = bitSelect(RubySystem::getBlockSizeBits()+RubySystem::getMemorySizeBits(), ADDRESS_WIDTH); 2096145Snate@binkert.org assert (index >= 0); 2106285Snate@binkert.org /* 2116145Snate@binkert.org if (index >= RubyConfig::memoryModuleBlocks()) { 2126285Snate@binkert.org cerr << " memoryBits: " << RubySystem::getMemorySizeBits() << " memorySizeBits: " << RubySystem::getMemorySizeBits() 2136285Snate@binkert.org << " Address: " << "[" << hex << "0x" << m_address << "," << " line 0x" << maskLowOrderBits(RubySystem::getBlockSizeBits()) << dec << "]" << flush 2146145Snate@binkert.org << "error: limit exceeded. " << 2156285Snate@binkert.org " getDataBlockBits: " << RubySystem::getBlockSizeBits() << 2166145Snate@binkert.org " memoryModuleBlocks: " << RubyConfig::memoryModuleBlocks() << 2176145Snate@binkert.org " index: " << index << endl; 2186145Snate@binkert.org } 2196145Snate@binkert.org assert (index < RubyConfig::memoryModuleBlocks()); 2206285Snate@binkert.org */ 2216145Snate@binkert.org return index; 2226145Snate@binkert.org 2236145Snate@binkert.org // Index indexHighPortion = address.bitSelect(MEMORY_SIZE_BITS-1, PAGE_SIZE_BITS+NUMBER_OF_MEMORY_MODULE_BITS); 2246145Snate@binkert.org // Index indexLowPortion = address.bitSelect(DATA_BLOCK_BITS, PAGE_SIZE_BITS-1); 2256145Snate@binkert.org 2266145Snate@binkert.org //Index index = indexLowPortion | (indexHighPortion << (PAGE_SIZE_BITS - DATA_BLOCK_BITS)); 2276145Snate@binkert.org 2286145Snate@binkert.org /* 2296145Snate@binkert.org Round-robin mapping of addresses, at page size granularity 2306145Snate@binkert.org 2316145Snate@binkert.orgADDRESS_WIDTH MEMORY_SIZE_BITS PAGE_SIZE_BITS DATA_BLOCK_BITS 2326145Snate@binkert.org | | | | 2336145Snate@binkert.org \ / \ / \ / \ / 0 2346145Snate@binkert.org ----------------------------------------------------------------------- 2356145Snate@binkert.org | unused |xxxxxxxxxxxxxxx| |xxxxxxxxxxxxxxx| | 2366145Snate@binkert.org | |xxxxxxxxxxxxxxx| |xxxxxxxxxxxxxxx| | 2376145Snate@binkert.org ----------------------------------------------------------------------- 2386145Snate@binkert.org indexHighPortion indexLowPortion 2396145Snate@binkert.org <-------> 2406145Snate@binkert.org NUMBER_OF_MEMORY_MODULE_BITS 2416145Snate@binkert.org */ 2426145Snate@binkert.org} 2436145Snate@binkert.org 2446145Snate@binkert.orginline 2456145Snate@binkert.orgvoid Address::print(ostream& out) const 2466145Snate@binkert.org{ 2476285Snate@binkert.org out << "[" << hex << "0x" << m_address << "," << " line 0x" << maskLowOrderBits(RubySystem::getBlockSizeBits()) << dec << "]" << flush; 2486145Snate@binkert.org} 2496145Snate@binkert.org 2506145Snate@binkert.orgclass Address; 2516145Snate@binkert.orgnamespace __gnu_cxx { 2526145Snate@binkert.org template <> struct hash<Address> 2536145Snate@binkert.org { 2546145Snate@binkert.org size_t operator()(const Address &s) const { return (size_t) s.getAddress(); } 2556145Snate@binkert.org }; 2566145Snate@binkert.org} 2576145Snate@binkert.orgnamespace std { 2586145Snate@binkert.org template <> struct equal_to<Address> 2596145Snate@binkert.org { 2606145Snate@binkert.org bool operator()(const Address& s1, const Address& s2) const { return s1 == s2; } 2616145Snate@binkert.org }; 2626145Snate@binkert.org} 2636145Snate@binkert.org 2646145Snate@binkert.org#endif //ADDRESS_H 2656145Snate@binkert.org 266