move: put predictor includes and cc files into the same place

--HG--
rename : src/cpu/2bit_local_pred.cc => src/cpu/pred/2bit_local.cc
rename : src/cpu/o3/2bit_local_pred.hh => src/cpu/pred/2bit_local.hh
rename : src/cpu/btb.cc => src/cpu/pred/btb.cc
rename : src/cpu/o3/btb.hh => src/cpu/pred/btb.hh
rename : src/cpu/ras.cc => src/cpu/pred/ras.cc
rename : src/cpu/o3/ras.hh => src/cpu/pred/ras.hh
rename : src/cpu/tournament_pred.cc => src/cpu/pred/tournament.cc
rename : src/cpu/o3/tournament_pred.hh => src/cpu/pred/tournament.hh

5 files changed, 4 insertions, 564 deletions

diff --git a/src/cpu/o3/2bit_local_pred.hh b/src/cpu/o3/2bit_local_pred.hh
deleted file mode 100644
index 8b7bb8463..000000000
--- a/src/cpu/o3/2bit_local_pred.hh
+++ /dev/null
@@ -1,110 +0,0 @@
-/*
- * Copyright (c) 2004-2006 The Regents of The University of Michigan
- * 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.
- *
- * Authors: Kevin Lim
- */
-
-#ifndef __CPU_O3_2BIT_LOCAL_PRED_HH__
-#define __CPU_O3_2BIT_LOCAL_PRED_HH__
-
-#include <vector>
-
-#include "base/types.hh"
-#include "cpu/o3/sat_counter.hh"
-
-/**
- * Implements a local predictor that uses the PC to index into a table of
- * counters.  Note that any time a pointer to the bp_history is given, it
- * should be NULL using this predictor because it does not have any branch
- * predictor state that needs to be recorded or updated; the update can be
- * determined solely by the branch being taken or not taken.
- */
-class LocalBP
-{
-  public:
-    /**
-     * Default branch predictor constructor.
-     * @param localPredictorSize Size of the local predictor.
-     * @param localCtrBits Number of bits per counter.
-     * @param instShiftAmt Offset amount for instructions to ignore alignment.
-     */
-    LocalBP(unsigned localPredictorSize, unsigned localCtrBits,
-            unsigned instShiftAmt);
-
-    /**
-     * Looks up the given address in the branch predictor and returns
-     * a true/false value as to whether it is taken.
-     * @param branch_addr The address of the branch to look up.
-     * @param bp_history Pointer to any bp history state.
-     * @return Whether or not the branch is taken.
-     */
-    bool lookup(Addr &branch_addr, void * &bp_history);
-
-    /**
-     * Updates the branch predictor with the actual result of a branch.
-     * @param branch_addr The address of the branch to update.
-     * @param taken Whether or not the branch was taken.
-     */
-    void update(Addr &branch_addr, bool taken, void *bp_history);
-
-    void squash(void *bp_history)
-    { assert(bp_history == NULL); }
-
-    void reset();
-
-  private:
-    /**
-     *  Returns the taken/not taken prediction given the value of the
-     *  counter.
-     *  @param count The value of the counter.
-     *  @return The prediction based on the counter value.
-     */
-    inline bool getPrediction(uint8_t &count);
-
-    /** Calculates the local index based on the PC. */
-    inline unsigned getLocalIndex(Addr &PC);
-
-    /** Array of counters that make up the local predictor. */
-    std::vector<SatCounter> localCtrs;
-
-    /** Size of the local predictor. */
-    unsigned localPredictorSize;
-
-    /** Number of sets. */
-    unsigned localPredictorSets;
-
-    /** Number of bits of the local predictor's counters. */
-    unsigned localCtrBits;
-
-    /** Number of bits to shift the PC when calculating index. */
-    unsigned instShiftAmt;
-
-    /** Mask to get index bits. */
-    unsigned indexMask;
-};
-
-#endif // __CPU_O3_2BIT_LOCAL_PRED_HH__
diff --git a/src/cpu/o3/bpred_unit.hh b/src/cpu/o3/bpred_unit.hh
index 49cb4233b..f199bdd75 100644
--- a/src/cpu/o3/bpred_unit.hh
+++ b/src/cpu/o3/bpred_unit.hh
@@ -36,10 +36,10 @@
 #include "base/statistics.hh"
 #include "base/types.hh"
 #include "cpu/inst_seq.hh"
-#include "cpu/o3/2bit_local_pred.hh"
-#include "cpu/o3/btb.hh"
-#include "cpu/o3/ras.hh"
-#include "cpu/o3/tournament_pred.hh"
+#include "cpu/pred/2bit_local.hh"
+#include "cpu/pred/btb.hh"
+#include "cpu/pred/ras.hh"
+#include "cpu/pred/tournament.hh"
 
 class DerivO3CPUParams;
 
diff --git a/src/cpu/o3/btb.hh b/src/cpu/o3/btb.hh
deleted file mode 100644
index 6557522e0..000000000
--- a/src/cpu/o3/btb.hh
+++ /dev/null
@@ -1,129 +0,0 @@
-/*
- * Copyright (c) 2004-2005 The Regents of The University of Michigan
- * 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.
- *
- * Authors: Kevin Lim
- */
-
-#ifndef __CPU_O3_BTB_HH__
-#define __CPU_O3_BTB_HH__
-
-#include "base/misc.hh"
-#include "base/types.hh"
-
-class DefaultBTB
-{
-  private:
-    struct BTBEntry
-    {
-        BTBEntry()
-            : tag(0), target(0), valid(false)
-        {
-        }
-
-        /** The entry's tag. */
-        Addr tag;
-
-        /** The entry's target. */
-        Addr target;
-
-        /** The entry's thread id. */
-        ThreadID tid;
-
-        /** Whether or not the entry is valid. */
-        bool valid;
-    };
-
-  public:
-    /** Creates a BTB with the given number of entries, number of bits per
-     *  tag, and instruction offset amount.
-     *  @param numEntries Number of entries for the BTB.
-     *  @param tagBits Number of bits for each tag in the BTB.
-     *  @param instShiftAmt Offset amount for instructions to ignore alignment.
-     */
-    DefaultBTB(unsigned numEntries, unsigned tagBits,
-               unsigned instShiftAmt);
-
-    void reset();
-
-    /** Looks up an address in the BTB. Must call valid() first on the address.
-     *  @param inst_PC The address of the branch to look up.
-     *  @param tid The thread id.
-     *  @return Returns the target of the branch.
-     */
-    Addr lookup(const Addr &inst_PC, ThreadID tid);
-
-    /** Checks if a branch is in the BTB.
-     *  @param inst_PC The address of the branch to look up.
-     *  @param tid The thread id.
-     *  @return Whether or not the branch exists in the BTB.
-     */
-    bool valid(const Addr &inst_PC, ThreadID tid);
-
-    /** Updates the BTB with the target of a branch.
-     *  @param inst_PC The address of the branch being updated.
-     *  @param target_PC The target address of the branch.
-     *  @param tid The thread id.
-     */
-    void update(const Addr &inst_PC, const Addr &target_PC,
-                ThreadID tid);
-
-  private:
-    /** Returns the index into the BTB, based on the branch's PC.
-     *  @param inst_PC The branch to look up.
-     *  @return Returns the index into the BTB.
-     */
-    inline unsigned getIndex(const Addr &inst_PC);
-
-    /** Returns the tag bits of a given address.
-     *  @param inst_PC The branch's address.
-     *  @return Returns the tag bits.
-     */
-    inline Addr getTag(const Addr &inst_PC);
-
-    /** The actual BTB. */
-    std::vector<BTBEntry> btb;
-
-    /** The number of entries in the BTB. */
-    unsigned numEntries;
-
-    /** The index mask. */
-    unsigned idxMask;
-
-    /** The number of tag bits per entry. */
-    unsigned tagBits;
-
-    /** The tag mask. */
-    unsigned tagMask;
-
-    /** Number of bits to shift PC when calculating index. */
-    unsigned instShiftAmt;
-
-    /** Number of bits to shift PC when calculating tag. */
-    unsigned tagShiftAmt;
-};
-
-#endif // __CPU_O3_BTB_HH__
diff --git a/src/cpu/o3/ras.hh b/src/cpu/o3/ras.hh
deleted file mode 100644
index a36faf79a..000000000
--- a/src/cpu/o3/ras.hh
+++ /dev/null
@@ -1,100 +0,0 @@
-/*
- * Copyright (c) 2004-2005 The Regents of The University of Michigan
- * 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.
- *
- * Authors: Kevin Lim
- */
-
-#ifndef __CPU_O3_RAS_HH__
-#define __CPU_O3_RAS_HH__
-
-#include <vector>
-
-#include "base/types.hh"
-
-/** Return address stack class, implements a simple RAS. */
-class ReturnAddrStack
-{
-  public:
-    /** Creates a return address stack, but init() must be called prior to
-     *  use.
-     */
-    ReturnAddrStack() {}
-
-    /** Initializes RAS with a specified number of entries.
-     *  @param numEntries Number of entries in the RAS.
-     */
-    void init(unsigned numEntries);
-
-    void reset();
-
-    /** Returns the top address on the RAS. */
-    Addr top()
-    { return addrStack[tos]; }
-
-    /** Returns the index of the top of the RAS. */
-    unsigned topIdx()
-    { return tos; }
-
-    /** Pushes an address onto the RAS. */
-    void push(const Addr &return_addr);
-
-    /** Pops the top address from the RAS. */
-    void pop();
-
-    /** Changes index to the top of the RAS, and replaces the top address with
-     *  a new target.
-     *  @param top_entry_idx The index of the RAS that will now be the top.
-     *  @param restored_target The new target address of the new top of the RAS.
-     */
-    void restore(unsigned top_entry_idx, const Addr &restored_target);
-
-     bool empty() { return usedEntries == 0; }
-
-     bool full() { return usedEntries == numEntries; }
-  private:
-    /** Increments the top of stack index. */
-    inline void incrTos()
-    { if (++tos == numEntries) tos = 0; }
-
-    /** Decrements the top of stack index. */
-    inline void decrTos()
-    { tos = (tos == 0 ? numEntries - 1 : tos - 1); }
-
-    /** The RAS itself. */
-    std::vector<Addr> addrStack;
-
-    /** The number of entries in the RAS. */
-    unsigned numEntries;
-
-    /** The number of used entries in the RAS. */
-    unsigned usedEntries;
-
-    /** The top of stack index. */
-    unsigned tos;
-};
-
-#endif // __CPU_O3_RAS_HH__
diff --git a/src/cpu/o3/tournament_pred.hh b/src/cpu/o3/tournament_pred.hh
deleted file mode 100644
index 96bd43ed6..000000000
--- a/src/cpu/o3/tournament_pred.hh
+++ /dev/null
@@ -1,221 +0,0 @@
-/*
- * Copyright (c) 2004-2006 The Regents of The University of Michigan
- * 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.
- *
- * Authors: Kevin Lim
- */
-
-#ifndef __CPU_O3_TOURNAMENT_PRED_HH__
-#define __CPU_O3_TOURNAMENT_PRED_HH__
-
-#include <vector>
-
-#include "base/types.hh"
-#include "cpu/o3/sat_counter.hh"
-
-/**
- * Implements a tournament branch predictor, hopefully identical to the one
- * used in the 21264.  It has a local predictor, which uses a local history
- * table to index into a table of counters, and a global predictor, which
- * uses a global history to index into a table of counters.  A choice
- * predictor chooses between the two.  Only the global history register
- * is speculatively updated, the rest are updated upon branches committing
- * or misspeculating.
- */
-class TournamentBP
-{
-  public:
-    /**
-     * Default branch predictor constructor.
-     */
-    TournamentBP(unsigned localPredictorSize,
-                 unsigned localCtrBits,
-                 unsigned localHistoryTableSize,
-                 unsigned localHistoryBits,
-                 unsigned globalPredictorSize,
-                 unsigned globalHistoryBits,
-                 unsigned globalCtrBits,
-                 unsigned choicePredictorSize,
-                 unsigned choiceCtrBits,
-                 unsigned instShiftAmt);
-
-    /**
-     * Looks up the given address in the branch predictor and returns
-     * a true/false value as to whether it is taken.  Also creates a
-     * BPHistory object to store any state it will need on squash/update.
-     * @param branch_addr The address of the branch to look up.
-     * @param bp_history Pointer that will be set to the BPHistory object.
-     * @return Whether or not the branch is taken.
-     */
-    bool lookup(Addr &branch_addr, void * &bp_history);
-
-    /**
-     * Records that there was an unconditional branch, and modifies
-     * the bp history to point to an object that has the previous
-     * global history stored in it.
-     * @param bp_history Pointer that will be set to the BPHistory object.
-     */
-    void uncondBr(void * &bp_history);
-
-    /**
-     * Updates the branch predictor with the actual result of a branch.
-     * @param branch_addr The address of the branch to update.
-     * @param taken Whether or not the branch was taken.
-     * @param bp_history Pointer to the BPHistory object that was created
-     * when the branch was predicted.
-     */
-    void update(Addr &branch_addr, bool taken, void *bp_history);
-
-    /**
-     * Restores the global branch history on a squash.
-     * @param bp_history Pointer to the BPHistory object that has the
-     * previous global branch history in it.
-     */
-    void squash(void *bp_history);
-
-    /** Returns the global history. */
-    inline unsigned readGlobalHist() { return globalHistory; }
-
-  private:
-    /**
-     * Returns if the branch should be taken or not, given a counter
-     * value.
-     * @param count The counter value.
-     */
-    inline bool getPrediction(uint8_t &count);
-
-    /**
-     * Returns the local history index, given a branch address.
-     * @param branch_addr The branch's PC address.
-     */
-    inline unsigned calcLocHistIdx(Addr &branch_addr);
-
-    /** Updates global history as taken. */
-    inline void updateGlobalHistTaken();
-
-    /** Updates global history as not taken. */
-    inline void updateGlobalHistNotTaken();
-
-    /**
-     * Updates local histories as taken.
-     * @param local_history_idx The local history table entry that
-     * will be updated.
-     */
-    inline void updateLocalHistTaken(unsigned local_history_idx);
-
-    /**
-     * Updates local histories as not taken.
-     * @param local_history_idx The local history table entry that
-     * will be updated.
-     */
-    inline void updateLocalHistNotTaken(unsigned local_history_idx);
-
-    /**
-     * The branch history information that is created upon predicting
-     * a branch.  It will be passed back upon updating and squashing,
-     * when the BP can use this information to update/restore its
-     * state properly.
-     */
-    struct BPHistory {
-#ifdef DEBUG
-        BPHistory()
-        { newCount++; }
-        ~BPHistory()
-        { newCount--; }
-
-        static int newCount;
-#endif
-        unsigned globalHistory;
-        bool localPredTaken;
-        bool globalPredTaken;
-        bool globalUsed;
-    };
-
-    /** Local counters. */
-    std::vector<SatCounter> localCtrs;
-
-    /** Size of the local predictor. */
-    unsigned localPredictorSize;
-
-    /** Mask to get the proper index bits into the predictor. */
-    unsigned localPredictorMask;
-
-    /** Number of bits of the local predictor's counters. */
-    unsigned localCtrBits;
-
-    /** Array of local history table entries. */
-    std::vector<unsigned> localHistoryTable;
-
-    /** Size of the local history table. */
-    unsigned localHistoryTableSize;
-
-    /** Number of bits for each entry of the local history table.
-     *  @todo Doesn't this come from the size of the local predictor?
-     */
-    unsigned localHistoryBits;
-
-    /** Mask to get the proper local history. */
-    unsigned localHistoryMask;
-
-    /** Array of counters that make up the global predictor. */
-    std::vector<SatCounter> globalCtrs;
-
-    /** Size of the global predictor. */
-    unsigned globalPredictorSize;
-
-    /** Number of bits of the global predictor's counters. */
-    unsigned globalCtrBits;
-
-    /** Global history register. */
-    unsigned globalHistory;
-
-    /** Number of bits for the global history. */
-    unsigned globalHistoryBits;
-
-    /** Mask to get the proper global history. */
-    unsigned globalHistoryMask;
-
-    /** Array of counters that make up the choice predictor. */
-    std::vector<SatCounter> choiceCtrs;
-
-    /** Size of the choice predictor (identical to the global predictor). */
-    unsigned choicePredictorSize;
-
-    /** Number of bits of the choice predictor's counters. */
-    unsigned choiceCtrBits;
-
-    /** Number of bits to shift the instruction over to get rid of the word
-     *  offset.
-     */
-    unsigned instShiftAmt;
-
-    /** Threshold for the counter value; above the threshold is taken,
-     *  equal to or below the threshold is not taken.
-     */
-    unsigned threshold;
-};
-
-#endif // __CPU_O3_TOURNAMENT_PRED_HH__