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