DirectoryMemory.hh revision 6145 
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.h
32 *
33 * Description:
34 *
35 * $Id$
36 *
37 */
38
39#ifndef DIRECTORYMEMORY_H
40#define DIRECTORYMEMORY_H
41
42#include "Global.hh"
43#include "Address.hh"
44#include "Directory_Entry.hh"
45
46class Chip;
47
48class DirectoryMemory {
49public:
50  // Constructors
51  DirectoryMemory(Chip* chip_ptr, int version);
52
53  // Destructor
54  ~DirectoryMemory();
55
56  // Public Methods
57  static void printConfig(ostream& out);
58  bool isPresent(PhysAddress address);
59  Directory_Entry& lookup(PhysAddress address);
60
61  void print(ostream& out) const;
62
63private:
64  // Private Methods
65
66  // Private copy constructor and assignment operator
67  DirectoryMemory(const DirectoryMemory& obj);
68  DirectoryMemory& operator=(const DirectoryMemory& obj);
69
70  // Data Members (m_ prefix)
71  Directory_Entry **m_entries;
72  Chip* m_chip_ptr;
73  int m_size;  // # of memory module blocks for this directory
74  int m_version;
75};
76
77// Output operator declaration
78ostream& operator<<(ostream& out, const DirectoryMemory& obj);
79
80// ******************* Definitions *******************
81
82// Output operator definition
83extern inline
84ostream& operator<<(ostream& out, const DirectoryMemory& obj)
85{
86  obj.print(out);
87  out << flush;
88  return out;
89}
90
91#endif //DIRECTORYMEMORY_H
92