PersistentTable.hh revision 7054 
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_PERSISTENTTABLE_HH__
30#define __MEM_RUBY_SYSTEM_PERSISTENTTABLE_HH__
31
32#include "mem/gems_common/Map.hh"
33#include "mem/protocol/AccessType.hh"
34#include "mem/ruby/common/Address.hh"
35#include "mem/ruby/common/Global.hh"
36#include "mem/ruby/common/NetDest.hh"
37#include "mem/ruby/system/MachineID.hh"
38
39class PersistentTableEntry
40{
41  public:
42    void print(ostream& out) const {}
43
44    NetDest m_starving;
45    NetDest m_marked;
46    NetDest m_request_to_write;
47};
48
49class PersistentTable
50{
51  public:
52    // Constructors
53    PersistentTable();
54
55    // Destructor
56    ~PersistentTable();
57
58    // Public Methods
59    void persistentRequestLock(const Address& address, MachineID locker,
60                               AccessType type);
61    void persistentRequestUnlock(const Address& address, MachineID unlocker);
62    bool okToIssueStarving(const Address& address, MachineID machID) const;
63    MachineID findSmallest(const Address& address) const;
64    AccessType typeOfSmallest(const Address& address) const;
65    void markEntries(const Address& address);
66    bool isLocked(const Address& addr) const;
67    int countStarvingForAddress(const Address& addr) const;
68    int countReadStarvingForAddress(const Address& addr) const;
69
70    static void printConfig(ostream& out) {}
71
72    void print(ostream& out) const;
73
74  private:
75    // Private copy constructor and assignment operator
76    PersistentTable(const PersistentTable& obj);
77    PersistentTable& operator=(const PersistentTable& obj);
78
79    // Data Members (m_prefix)
80    Map<Address, PersistentTableEntry>* m_map_ptr;
81};
82
83inline ostream&
84operator<<(ostream& out, const PersistentTable& obj)
85{
86    obj.print(out);
87    out << flush;
88    return out;
89}
90
91inline ostream&
92operator<<(ostream& out, const PersistentTableEntry& obj)
93{
94    obj.print(out);
95    out << flush;
96    return out;
97}
98
99#endif // __MEM_RUBY_SYSTEM_PERSISTENTTABLE_HH__
100