DirectoryMemory.hh revision 9104
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/ruby/common/Address.hh" 36#include "mem/protocol/DirectoryRequestType.hh" 37#include "mem/ruby/slicc_interface/AbstractEntry.hh" 38#include "mem/ruby/system/MemoryVector.hh" 39#include "mem/ruby/system/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 void printConfig(std::ostream& out) const; 59 static void printGlobalConfig(std::ostream & out); 60 bool isPresent(PhysAddress address); 61 AbstractEntry* lookup(PhysAddress address); 62 AbstractEntry* allocate(const PhysAddress& address, 63 AbstractEntry* new_entry); 64 65 void invalidateBlock(PhysAddress address); 66 67 void print(std::ostream& out) const; 68 void printStats(std::ostream& out) const; 69 70 void recordRequestType(DirectoryRequestType requestType); 71 72 private: 73 // Private copy constructor and assignment operator 74 DirectoryMemory(const DirectoryMemory& obj); 75 DirectoryMemory& operator=(const DirectoryMemory& obj); 76 77 private: 78 const std::string m_name; 79 AbstractEntry **m_entries; 80 // int m_size; // # of memory module blocks this directory is 81 // responsible for 82 uint64 m_size_bytes; 83 uint64 m_size_bits; 84 uint64 m_num_entries; 85 int m_version; 86 87 static int m_num_directories; 88 static int m_num_directories_bits; 89 static uint64_t m_total_size_bytes; 90 static int m_numa_high_bit; 91 92 MemoryVector* m_ram; 93 SparseMemory* m_sparseMemory; 94 bool m_use_map; 95 int m_map_levels; 96}; 97 98inline std::ostream& 99operator<<(std::ostream& out, const DirectoryMemory& obj) 100{ 101 obj.print(out); 102 out << std::flush; 103 return out; 104} 105 106#endif // __MEM_RUBY_SYSTEM_DIRECTORYMEMORY_HH__ 107