bpred_unit.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2012, 2014 ARM Limited
 * Copyright (c) 2010,2022-2023 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/inst_seq.hh"
#include "cpu/pred/branch_type.hh"
#include "cpu/pred/btb.hh"
#include "cpu/pred/conditional.hh"
#include "cpu/pred/indirect.hh"
#include "cpu/pred/ras.hh"
#include "cpu/static_inst.hh"
#include "enums/TargetProvider.hh"
#include "params/BranchPredictor.hh"
#include "sim/probe/pmu.hh"
#include "sim/sim_object.hh"
 
namespace gem5
{
 
namespace branch_prediction
{

class BPredUnit : public SimObject
{
    typedef BranchPredictorParams Params;
    typedef enums::TargetProvider TargetProvider;

  public:
    BPredUnit(const Params &p);
 
    void regProbePoints() override;

    void drainSanityCheck() const;

    bool predict(const StaticInstPtr &inst, const InstSeqNum &seqNum,
                 PCStateBase &pc, ThreadID tid);

    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, bool from_commit=true);

    bool BTBValid(ThreadID tid, Addr pc)
    {
        return btb->valid(tid, pc);
    }

    const PCStateBase *
    BTBLookup(ThreadID tid, PCStateBase &pc)
    {
        return btb->lookup(tid, pc.instAddr());
    }

    const StaticInstPtr
    BTBGetInst(ThreadID tid, Addr pc)
    {
        return btb->getInst(tid, pc);
    }

    void
    BTBUpdate(ThreadID tid, Addr pc, const PCStateBase &target)
    {
        ++stats.BTBUpdates;
        return btb->update(tid, pc, target);
    }

    void branchPlaceholder(ThreadID tid, Addr pc,
                            bool uncond, void * &bp_history);
 
    void dump();

    struct PredictorHistory
    {
        PredictorHistory(ThreadID _tid, InstSeqNum sn, Addr _pc,
                         const StaticInstPtr & inst)
            : seqNum(sn), tid(_tid), pc(_pc),
              inst(inst), type(getBranchType(inst)),
              call(inst->isCall()), uncond(!inst->isCondCtrl()),
              predTaken(false), actuallyTaken(false), condPred(false),
              btbHit(false), targetProvider(TargetProvider::NoTarget),
              resteered(false), mispredict(false), target(nullptr),
              bpHistory(nullptr),
              indirectHistory(nullptr), rasHistory(nullptr)
        { }
 
        ~PredictorHistory()
        {
            assert(bpHistory == nullptr);
            assert(indirectHistory == nullptr);
            assert(rasHistory == nullptr);
        }
 
        PredictorHistory (const PredictorHistory&) = delete;
        PredictorHistory& operator= (const PredictorHistory&) = delete;
 
        bool
        operator==(const PredictorHistory &entry) const
        {
            return this->seqNum == entry.seqNum;
        }

        InstSeqNum seqNum;

        const ThreadID tid;

        const Addr pc;

        const StaticInstPtr inst;

        const BranchType type;

        const bool call;

        const bool uncond;

        bool predTaken;

        bool actuallyTaken;

        bool condPred;

        bool btbHit;

        TargetProvider targetProvider;

        bool resteered;

        bool mispredict;

        std::unique_ptr<PCStateBase> target;

        void *bpHistory = nullptr;
 
        void *indirectHistory = nullptr;
 
        void *rasHistory = nullptr;
 
    };

    void insertPredictorHistory(ThreadID tid, PredictorHistory *&bpu_history);

    bool predict(const StaticInstPtr &inst, const InstSeqNum &seqNum,
               PCStateBase &pc, ThreadID tid, PredictorHistory* &bpu_history);

    void squashHistory(ThreadID tid, PredictorHistory* &bpu_history);
 

    void commitBranch(ThreadID tid, PredictorHistory* &bpu_history);

    void updateBTB(ThreadID tid, PredictorHistory *&bpu_history);
 
  protected:
    const unsigned numThreads;

    const bool requiresBTBHit;

    const bool updateBTBAtSquash;

    const unsigned instShiftAmt;

    std::vector<std::deque<PredictorHistory *>> predHist;

    BranchTargetBuffer * btb;

    ReturnAddrStack * ras;

    ConditionalPredictor * cPred;

    IndirectPredictor * iPred;

    struct BPredUnitStats : public statistics::Group
    {
        BPredUnitStats(BPredUnit *bp);

        statistics::Vector2d lookups;
        statistics::Vector2d squashes;
        statistics::Vector2d corrected;
        statistics::Vector2d earlyResteers;
        statistics::Vector2d committed;
        statistics::Vector2d mispredicted;
        statistics::Vector2d mispredictDueToPredictor;
        statistics::Vector2d mispredictDueToBTBMiss;

        statistics::Vector2d targetProvider;
        statistics::Vector2d targetWrong;

        statistics::Scalar condPredicted;
        statistics::Scalar condPredictedTaken;
        statistics::Scalar condIncorrect;
        statistics::Scalar predTakenBTBMiss;

        statistics::Scalar BTBLookups;
        statistics::Scalar BTBUpdates;
        statistics::Scalar BTBHits;
        statistics::Formula BTBHitRatio;
        statistics::Scalar BTBMispredicted;

        statistics::Scalar indirectLookups;
        statistics::Scalar indirectHits;
        statistics::Scalar indirectMisses;
        statistics::Scalar indirectMispredicted;
 
    } stats;
 
  protected:


    probing::PMUUPtr pmuProbePoint(const char *name);
 

    probing::PMUUPtr ppBranches;

    probing::PMUUPtr ppMisses;

};
 
} // namespace branch_prediction
} // namespace gem5
 
#endif // __CPU_PRED_BPRED_UNIT_HH__