AbstractEntry.hh revision 8229:78bf55f23338 
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_SLICC_INTERFACE_ABSTRACTENTRY_HH__
30#define __MEM_RUBY_SLICC_INTERFACE_ABSTRACTENTRY_HH__
31
32#include <iostream>
33
34#include "mem/protocol/AccessPermission.hh"
35#include "mem/ruby/common/Address.hh"
36#include "mem/ruby/common/Global.hh"
37
38class DataBlock;
39
40class AbstractEntry
41{
42  public:
43    AbstractEntry();
44    virtual ~AbstractEntry() = 0;
45
46    // Get/Set permission of the entry
47    AccessPermission getPermission() const;
48    void changePermission(AccessPermission new_perm);
49
50    // The methods below are those called by ruby runtime, add when it
51    // is absolutely necessary and should all be virtual function.
52    virtual DataBlock& getDataBlk() = 0;
53
54    virtual void print(std::ostream& out) const = 0;
55
56    AccessPermission m_Permission; // Access permission for this
57                                   // block, required by CacheMemory
58};
59
60inline std::ostream&
61operator<<(std::ostream& out, const AbstractEntry& obj)
62{
63    obj.print(out);
64    out << std::flush;
65    return out;
66}
67
68#endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTENTRY_HH__
69
70