AbstractEntry.hh revision 6882:898047a3672c 
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#ifndef AbstractEntry_H
31#define AbstractEntry_H
32
33#include "mem/ruby/common/Global.hh"
34#include "mem/ruby/common/Address.hh"
35#include "mem/protocol/AccessPermission.hh"
36
37class DataBlock;
38
39class AbstractEntry {
40public:
41  // Constructors
42  AbstractEntry();
43
44  // Destructor, prevent it from instantiation
45  virtual ~AbstractEntry() = 0;
46
47  // Public Methods
48
49  // The methods below are those called by ruby runtime, add when it is
50  // absolutely necessary and should all be virtual function.
51  virtual DataBlock& getDataBlk() = 0;
52
53
54  virtual void print(ostream& out) const = 0;
55
56};
57
58// Output operator declaration
59ostream& operator<<(ostream& out, const AbstractEntry& obj);
60
61// ******************* Definitions *******************
62
63// Output operator definition
64extern inline
65ostream& operator<<(ostream& out, const AbstractEntry& obj)
66{
67  obj.print(out);
68  out << flush;
69  return out;
70}
71
72#endif //AbstractEntry_H
73
74