ras.hh revision 2292 
1/*
2 * Copyright (c) 2004-2005 The Regents of The University of Michigan
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 __CPU_O3_RAS_HH__
30#define __CPU_O3_RAS_HH__
31
32// For Addr type.
33#include "arch/isa_traits.hh"
34#include <vector>
35
36/** Return address stack class, implements a simple RAS. */
37class ReturnAddrStack
38{
39  public:
40    /** Creates a return address stack, but init() must be called prior to
41     *  use.
42     */
43    ReturnAddrStack() {}
44
45    /** Initializes RAS with a specified number of entries.
46     *  @param numEntries Number of entries in the RAS.
47     */
48    void init(unsigned numEntries);
49
50    /** Returns the top address on the RAS. */
51    Addr top()
52    { return addrStack[tos]; }
53
54    /** Returns the index of the top of the RAS. */
55    unsigned topIdx()
56    { return tos; }
57
58    /** Pushes an address onto the RAS. */
59    void push(const Addr &return_addr);
60
61    /** Pops the top address from the RAS. */
62    void pop();
63
64    /** Changes index to the top of the RAS, and replaces the top address with
65     *  a new target.
66     *  @param top_entry_idx The index of the RAS that will now be the top.
67     *  @param restored_target The new target address of the new top of the RAS.
68     */
69    void restore(unsigned top_entry_idx, const Addr &restored_target);
70
71  private:
72    /** Increments the top of stack index. */
73    inline void incrTos()
74    { if (++tos == numEntries) tos = 0; }
75
76    /** Decrements the top of stack index. */
77    inline void decrTos()
78    { tos = (tos == 0 ? numEntries - 1 : tos - 1); }
79
80    /** The RAS itself. */
81    std::vector<Addr> addrStack;
82
83    /** The number of entries in the RAS. */
84    unsigned numEntries;
85
86    /** The number of used entries in the RAS. */
87    unsigned usedEntries;
88
89    /** The top of stack index. */
90    unsigned tos;
91};
92
93#endif // __CPU_O3_RAS_HH__
94