summaryrefslogtreecommitdiff
path: root/src/mem/gems_common/RefCnt.hh
blob: fc1ddbae999b66fe8931f19f5c8e0e821652622f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/*
 * Copyright (c) 1999-2005 Mark D. Hill and David A. Wood
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef REFCNT_H
#define REFCNT_H

template <class TYPE>
class RefCnt {
public:
  // Constructors
  RefCnt();
  RefCnt(const TYPE& data);

  // Destructor
  ~RefCnt();

  // Public Methods
  const TYPE* ref() const { return m_data_ptr; }
  TYPE* ref() { return m_data_ptr; }
  TYPE* mod_ref() const { return m_data_ptr; }
  void freeRef();
  void print(ostream& out) const;

  // Public copy constructor and assignment operator
  RefCnt(const RefCnt& obj);
  RefCnt& operator=(const RefCnt& obj);

private:
  // Private Methods

  // Data Members (m_ prefix)
  TYPE* m_data_ptr;
  //  int* m_count_ptr; // Not used yet
};

// Output operator declaration
template <class TYPE>
inline
ostream& operator<<(ostream& out, const RefCnt<TYPE>& obj);

// ******************* Definitions *******************

// Constructors
template <class TYPE>
inline
RefCnt<TYPE>::RefCnt()
{
  m_data_ptr = NULL;
}

template <class TYPE>
inline
RefCnt<TYPE>::RefCnt(const TYPE& data)
{
  m_data_ptr = data.clone();
  m_data_ptr->setRefCnt(1);
}

template <class TYPE>
inline
RefCnt<TYPE>::~RefCnt()
{
  freeRef();
}

template <class TYPE>
inline
void RefCnt<TYPE>::freeRef()
{
  if (m_data_ptr != NULL) {
    m_data_ptr->decRefCnt();
    if (m_data_ptr->getRefCnt() == 0) {
      m_data_ptr->destroy();
    }
    m_data_ptr = NULL;
  }
}

template <class TYPE>
inline
void RefCnt<TYPE>::print(ostream& out) const
{
  if (m_data_ptr == NULL) {
    out << "[RefCnt: Null]";
  } else {
    out << "[RefCnt: ";
    m_data_ptr->print(out);
    out << "]";
  }
}

// Copy constructor
template <class TYPE>
inline
RefCnt<TYPE>::RefCnt(const RefCnt<TYPE>& obj)
{
  //  m_data_ptr = obj.m_data_ptr->clone();
  m_data_ptr = obj.m_data_ptr;

  // Increment the reference count
  if (m_data_ptr != NULL) {
    m_data_ptr->incRefCnt();
  }
}

// Assignment operator
template <class TYPE>
inline
RefCnt<TYPE>& RefCnt<TYPE>::operator=(const RefCnt<TYPE>& obj)
{
  if (this == &obj) {
    // If this is the case, do nothing
    //    assert(false);
  } else {
    freeRef();
    m_data_ptr = obj.m_data_ptr;
    if (m_data_ptr != NULL) {
      m_data_ptr->incRefCnt();
    }
  }
  return *this;
}


// Output operator definition
template <class TYPE>
inline
ostream& operator<<(ostream& out, const RefCnt<TYPE>& obj)
{
  obj.print(out);
  out << flush;
  return out;
}



#endif //REFCNT_H