bpred_unit.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2012, 2014 ARM Limited
 * Copyright (c) 2010 The University of Edinburgh
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * 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.
 */
 
#ifndef __CPU_PRED_BPRED_UNIT_HH__
#define __CPU_PRED_BPRED_UNIT_HH__
 
#include <deque>
 
#include "base/statistics.hh"
#include "base/types.hh"
#include "cpu/pred/btb.hh"
#include "cpu/pred/indirect.hh"
#include "cpu/pred/ras.hh"
#include "cpu/inst_seq.hh"
#include "cpu/static_inst.hh"
#include "params/BranchPredictor.hh"
#include "sim/probe/pmu.hh"
#include "sim/sim_object.hh"
 
namespace gem5
{
 
namespace branch_prediction
{
 
class BPredUnit : public SimObject
{
  public:
      typedef BranchPredictorParams Params;
    BPredUnit(const Params &p);
 
    void regProbePoints() override;
 
    void drainSanityCheck() const;
 
    bool predict(const StaticInstPtr &inst, const InstSeqNum &seqNum,
                 PCStateBase &pc, ThreadID tid);
 
    // @todo: Rename this function.
    virtual void uncondBranch(ThreadID tid, Addr pc, void * &bp_history) = 0;
 
    void update(const InstSeqNum &done_sn, ThreadID tid);
 
    void squash(const InstSeqNum &squashed_sn, ThreadID tid);
 
    void squash(const InstSeqNum &squashed_sn,
                const PCStateBase &corr_target,
                bool actually_taken, ThreadID tid);
 
    virtual void squash(ThreadID tid, void *bp_history) = 0;
 
    virtual bool lookup(ThreadID tid, Addr instPC, void * &bp_history) = 0;
 
    virtual void btbUpdate(ThreadID tid, Addr instPC, void * &bp_history) = 0;
 
    bool BTBValid(Addr instPC) { return BTB.valid(instPC, 0); }
 
    const PCStateBase *
    BTBLookup(Addr inst_pc)
    {
        return BTB.lookup(inst_pc, 0);
    }
 
    virtual void update(ThreadID tid, Addr instPC, bool taken,
                   void *bp_history, bool squashed,
                   const StaticInstPtr &inst, Addr corrTarget) = 0;
    void
    BTBUpdate(Addr instPC, const PCStateBase &target)
    {
        BTB.update(instPC, target, 0);
    }
 
 
    void dump();
 
  private:
    struct PredictorHistory
    {
        PredictorHistory(const InstSeqNum &seq_num, Addr instPC,
                         bool pred_taken, void *bp_history,
                         void *indirect_history, ThreadID _tid,
                         const StaticInstPtr & inst)
            : seqNum(seq_num), pc(instPC), bpHistory(bp_history),
              indirectHistory(indirect_history), tid(_tid),
              predTaken(pred_taken), inst(inst)
        {}
 
        PredictorHistory(const PredictorHistory &other) :
            seqNum(other.seqNum), pc(other.pc), bpHistory(other.bpHistory),
            indirectHistory(other.indirectHistory), RASIndex(other.RASIndex),
            tid(other.tid), predTaken(other.predTaken), usedRAS(other.usedRAS),
            pushedRAS(other.pushedRAS), wasCall(other.wasCall),
            wasReturn(other.wasReturn), wasIndirect(other.wasIndirect),
            target(other.target), inst(other.inst)
        {
            set(RASTarget, other.RASTarget);
        }
 
        bool
        operator==(const PredictorHistory &entry) const
        {
            return this->seqNum == entry.seqNum;
        }
 
        InstSeqNum seqNum;
 
        Addr pc;
 
        void *bpHistory = nullptr;
 
        void *indirectHistory = nullptr;
 
        std::unique_ptr<PCStateBase> RASTarget;
 
        unsigned RASIndex = 0;
 
        ThreadID tid;
 
        bool predTaken;
 
        bool usedRAS = false;
 
        /* Whether or not the RAS was pushed */
        bool pushedRAS = false;
 
        bool wasCall = false;
 
        bool wasReturn = false;
 
        bool wasIndirect = false;
 
        Addr target = MaxAddr;
 
        const StaticInstPtr inst;
    };
 
    typedef std::deque<PredictorHistory> History;
 
    const unsigned numThreads;
 
 
    std::vector<History> predHist;
 
    DefaultBTB BTB;
 
    std::vector<ReturnAddrStack> RAS;
 
    IndirectPredictor * iPred;
 
    struct BPredUnitStats : public statistics::Group
    {
        BPredUnitStats(statistics::Group *parent);
 
        statistics::Scalar lookups;
        statistics::Scalar condPredicted;
        statistics::Scalar condIncorrect;
        statistics::Scalar BTBLookups;
        statistics::Scalar BTBHits;
        statistics::Formula BTBHitRatio;
        statistics::Scalar RASUsed;
        statistics::Scalar RASIncorrect;
 
        statistics::Scalar indirectLookups;
        statistics::Scalar indirectHits;
        statistics::Scalar indirectMisses;
        statistics::Scalar indirectMispredicted;
    } stats;
 
  protected:
    const unsigned instShiftAmt;
 
    probing::PMUUPtr pmuProbePoint(const char *name);
 
 
    probing::PMUUPtr ppBranches;
 
    probing::PMUUPtr ppMisses;
 
};
 
} // namespace branch_prediction
} // namespace gem5
 
#endif // __CPU_PRED_BPRED_UNIT_HH__