1/*
2 * Copyright (c) 2014 ARM Limited
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 * Authors: Mitch Hayenga
29 */
30
31#ifndef __CPU_PRED_INDIRECT_HH__
32#define __CPU_PRED_INDIRECT_HH__
33
34#include <deque>
35
36#include "arch/isa_traits.hh"
37#include "config/the_isa.hh"
38#include "cpu/inst_seq.hh"
39#include "cpu/pred/indirect.hh"
40#include "params/SimpleIndirectPredictor.hh"
41
42class SimpleIndirectPredictor : public IndirectPredictor
43{
44  public:
45    SimpleIndirectPredictor(const SimpleIndirectPredictorParams * params);
46
47    bool lookup(Addr br_addr, TheISA::PCState& br_target, ThreadID tid);
48    void recordIndirect(Addr br_addr, Addr tgt_addr, InstSeqNum seq_num,
49                        ThreadID tid);
50    void commit(InstSeqNum seq_num, ThreadID tid, void * indirect_history);
51    void squash(InstSeqNum seq_num, ThreadID tid);
52    void recordTarget(InstSeqNum seq_num, void * indirect_history,
53                      const TheISA::PCState& target, ThreadID tid);
54    void genIndirectInfo(ThreadID tid, void* & indirect_history);
55    void updateDirectionInfo(ThreadID tid, bool actually_taken);
56    void deleteIndirectInfo(ThreadID tid, void * indirect_history);
57    void changeDirectionPrediction(ThreadID tid, void * indirect_history,
58                                   bool actually_taken);
59
60  private:
61    const bool hashGHR;
62    const bool hashTargets;
63    const unsigned numSets;
64    const unsigned numWays;
65    const unsigned tagBits;
66    const unsigned pathLength;
67    const unsigned instShift;
68    const unsigned ghrNumBits;
69    const unsigned ghrMask;
70
71    struct IPredEntry
72    {
73        IPredEntry() : tag(0), target(0) { }
74        Addr tag;
75        TheISA::PCState target;
76    };
77
78    std::vector<std::vector<IPredEntry> > targetCache;
79
80    Addr getSetIndex(Addr br_addr, unsigned ghr, ThreadID tid);
81    Addr getTag(Addr br_addr);
82
83    struct HistoryEntry
84    {
85        HistoryEntry(Addr br_addr, Addr tgt_addr, InstSeqNum seq_num)
86            : pcAddr(br_addr), targetAddr(tgt_addr), seqNum(seq_num) { }
87        Addr pcAddr;
88        Addr targetAddr;
89        InstSeqNum seqNum;
90    };
91
92
93    struct ThreadInfo {
94        ThreadInfo() : headHistEntry(0), ghr(0) { }
95
96        std::deque<HistoryEntry> pathHist;
97        unsigned headHistEntry;
98        unsigned ghr;
99    };
100
101    std::vector<ThreadInfo> threadInfo;
102};
103
104#endif // __CPU_PRED_INDIRECT_HH__
105