DirectoryMemory.hh revision 6285 
1
2/*
3 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/*
31 * DirectoryMemory.hh
32 *
33 * Description:
34 *
35 * $Id$
36 *
37 */
38
39#ifndef DIRECTORYMEMORY_H
40#define DIRECTORYMEMORY_H
41
42#include "mem/ruby/common/Global.hh"
43#include "mem/ruby/common/Address.hh"
44#include "mem/ruby/system/MemoryVector.hh"
45#include "mem/protocol/Directory_Entry.hh"
46
47class AbstractController;
48
49class DirectoryMemory {
50public:
51  // Constructors
52  DirectoryMemory(const string & name);
53  void init(const vector<string> & argv);
54  //  DirectoryMemory(int version);
55
56  // Destructor
57  ~DirectoryMemory();
58
59  int mapAddressToLocalIdx(PhysAddress address);
60  static int mapAddressToDirectoryVersion(PhysAddress address);
61
62  int getSize() { return m_size_bytes; }
63
64  // Public Methods
65  void printConfig(ostream& out) const;
66  static void printGlobalConfig(ostream & out);
67  bool isPresent(PhysAddress address);
68  Directory_Entry& lookup(PhysAddress address);
69
70  void invalidateBlock(PhysAddress address);
71
72  void print(ostream& out) const;
73
74private:
75  // Private Methods
76
77  // Private copy constructor and assignment operator
78  DirectoryMemory(const DirectoryMemory& obj);
79  DirectoryMemory& operator=(const DirectoryMemory& obj);
80
81private:
82  const string m_name;
83  AbstractController* m_controller;
84  // Data Members (m_ prefix)
85  Directory_Entry **m_entries;
86  //  int m_size;  // # of memory module blocks this directory is responsible for
87  uint32 m_size_bytes;
88  uint32 m_size_bits;
89  int m_num_entries;
90  int m_version;
91
92  static int m_num_directories;
93  static int m_num_directories_bits;
94  static int m_total_size_bytes;
95
96  MemoryVector* m_ram;
97};
98
99// Output operator declaration
100ostream& operator<<(ostream& out, const DirectoryMemory& obj);
101
102// ******************* Definitions *******************
103
104// Output operator definition
105extern inline
106ostream& operator<<(ostream& out, const DirectoryMemory& obj)
107{
108  obj.print(out);
109  out << flush;
110  return out;
111}
112
113#endif //DIRECTORYMEMORY_H
114