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_STRUCTURES_PERSISTENTTABLE_HH__
30#define __MEM_RUBY_STRUCTURES_PERSISTENTTABLE_HH__
31
32#include <iostream>
33#include <unordered_map>
34
35#include "mem/ruby/common/Address.hh"
36#include "mem/ruby/common/MachineID.hh"
37#include "mem/ruby/common/NetDest.hh"
38#include "mem/ruby/protocol/AccessType.hh"
39
40class PersistentTableEntry
41{
42  public:
43    PersistentTableEntry() {}
44    void print(std::ostream& out) const {}
45
46    NetDest m_starving;
47    NetDest m_marked;
48    NetDest m_request_to_write;
49};
50
51class PersistentTable
52{
53  public:
54    // Constructors
55    PersistentTable();
56
57    // Destructor
58    ~PersistentTable();
59
60    // Public Methods
61    void persistentRequestLock(Addr address, MachineID locker,
62                               AccessType type);
63    void persistentRequestUnlock(Addr address, MachineID unlocker);
64    bool okToIssueStarving(Addr address, MachineID machID) const;
65    MachineID findSmallest(Addr address) const;
66    AccessType typeOfSmallest(Addr address) const;
67    void markEntries(Addr address);
68    bool isLocked(Addr addr) const;
69    int countStarvingForAddress(Addr addr) const;
70    int countReadStarvingForAddress(Addr addr) const;
71
72    void print(std::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    typedef std::unordered_map<Addr, PersistentTableEntry> AddressMap;
81    AddressMap m_map;
82};
83
84inline std::ostream&
85operator<<(std::ostream& out, const PersistentTable& obj)
86{
87    obj.print(out);
88    out << std::flush;
89    return out;
90}
91
92inline std::ostream&
93operator<<(std::ostream& out, const PersistentTableEntry& obj)
94{
95    obj.print(out);
96    out << std::flush;
97    return out;
98}
99
100#endif // __MEM_RUBY_STRUCTURES_PERSISTENTTABLE_HH__
101