DirectoryMemory.hh revision 10301:44839e8febbd
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#ifndef __MEM_RUBY_SYSTEM_DIRECTORYMEMORY_HH__ 30#define __MEM_RUBY_SYSTEM_DIRECTORYMEMORY_HH__ 31 32#include <iostream> 33#include <string> 34 35#include "mem/protocol/DirectoryRequestType.hh" 36#include "mem/ruby/common/Address.hh" 37#include "mem/ruby/slicc_interface/AbstractEntry.hh" 38#include "mem/ruby/structures/MemoryVector.hh" 39#include "mem/ruby/structures/SparseMemory.hh" 40#include "params/RubyDirectoryMemory.hh" 41#include "sim/sim_object.hh" 42 43class DirectoryMemory : public SimObject 44{ 45 public: 46 typedef RubyDirectoryMemoryParams Params; 47 DirectoryMemory(const Params *p); 48 ~DirectoryMemory(); 49 50 void init(); 51 52 uint64 mapAddressToLocalIdx(PhysAddress address); 53 static uint64 mapAddressToDirectoryVersion(PhysAddress address); 54 55 bool isSparseImplementation() { return m_use_map; } 56 uint64 getSize() { return m_size_bytes; } 57 58 bool isPresent(PhysAddress address); 59 AbstractEntry* lookup(PhysAddress address); 60 AbstractEntry* allocate(const PhysAddress& address, 61 AbstractEntry* new_entry); 62 63 void invalidateBlock(PhysAddress address); 64 65 void print(std::ostream& out) const; 66 void regStats(); 67 68 void recordRequestType(DirectoryRequestType requestType); 69 70 private: 71 // Private copy constructor and assignment operator 72 DirectoryMemory(const DirectoryMemory& obj); 73 DirectoryMemory& operator=(const DirectoryMemory& obj); 74 75 private: 76 const std::string m_name; 77 AbstractEntry **m_entries; 78 // int m_size; // # of memory module blocks this directory is 79 // responsible for 80 uint64 m_size_bytes; 81 uint64 m_size_bits; 82 uint64 m_num_entries; 83 int m_version; 84 85 static int m_num_directories; 86 static int m_num_directories_bits; 87 static uint64_t m_total_size_bytes; 88 static int m_numa_high_bit; 89 90 MemoryVector* m_ram; 91 SparseMemory* m_sparseMemory; 92 bool m_use_map; 93 int m_map_levels; 94}; 95 96inline std::ostream& 97operator<<(std::ostream& out, const DirectoryMemory& obj) 98{ 99 obj.print(out); 100 out << std::flush; 101 return out; 102} 103 104#endif // __MEM_RUBY_SYSTEM_DIRECTORYMEMORY_HH__ 105