commit.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2012, 2014, 2019 ARM Limited
 * 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-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.
 */
 
#ifndef __CPU_O3_COMMIT_HH__
#define __CPU_O3_COMMIT_HH__
 
#include <queue>
 
#include "base/statistics.hh"
#include "cpu/exetrace.hh"
#include "cpu/inst_seq.hh"
#include "cpu/o3/comm.hh"
#include "cpu/o3/dyn_inst_ptr.hh"
#include "cpu/o3/iew.hh"
#include "cpu/o3/limits.hh"
#include "cpu/o3/rename_map.hh"
#include "cpu/o3/rob.hh"
#include "cpu/timebuf.hh"
#include "enums/CommitPolicy.hh"
#include "sim/probe/probe.hh"
 
namespace gem5
{
 
struct O3CPUParams;
 
namespace o3
{
 
class ThreadState;
 
class Commit
{
  public:
    enum CommitStatus
    {
        Active,
        Inactive
    };
 
    enum ThreadStatus
    {
        Running,
        Idle,
        ROBSquashing,
        TrapPending,
        FetchTrapPending,
        SquashAfterPending, //< Committing instructions before a squash.
    };
 
  private:
    CommitStatus _status;
    CommitStatus _nextStatus;
    ThreadStatus commitStatus[MaxThreads];
    CommitPolicy commitPolicy;
 
    ProbePointArg<DynInstPtr> *ppCommit;
    ProbePointArg<DynInstPtr> *ppCommitStall;
    ProbePointArg<DynInstPtr> *ppSquash;
 
    void processTrapEvent(ThreadID tid);
 
  public:
    Commit(CPU *_cpu, const O3CPUParams &params);
 
    std::string name() const;
 
    void regProbePoints();
 
    void setThreads(std::vector<ThreadState *> &threads);
 
    void setTimeBuffer(TimeBuffer<TimeStruct> *tb_ptr);
 
    void setFetchQueue(TimeBuffer<FetchStruct> *fq_ptr);
 
    void setRenameQueue(TimeBuffer<RenameStruct> *rq_ptr);
 
    void setIEWQueue(TimeBuffer<IEWStruct> *iq_ptr);
 
    void setIEWStage(IEW *iew_stage);
 
    IEW *iewStage;
 
    void setActiveThreads(std::list<ThreadID> *at_ptr);
 
    void setRenameMap(UnifiedRenameMap rm_ptr[MaxThreads]);
 
    void setROB(ROB *rob_ptr);
 
    void startupStage();
 
    void clearStates(ThreadID tid);
 
    void drain();
 
    void drainResume();
 
    void drainSanityCheck() const;
 
    bool isDrained() const;
 
    void takeOverFrom();
 
    void deactivateThread(ThreadID tid);
 
    bool executingHtmTransaction(ThreadID) const;
 
    /* Reset HTM tracking, e.g. after an abort */
    void resetHtmStartsStops(ThreadID);
 
    void tick();
 
    void commit();
 
    size_t numROBFreeEntries(ThreadID tid);
 
    void generateTrapEvent(ThreadID tid, Fault inst_fault);
 
    void generateTCEvent(ThreadID tid);
 
  private:
    void updateStatus();
 
    bool changedROBEntries();
 
    void squashAll(ThreadID tid);
 
    void squashFromTrap(ThreadID tid);
 
    void squashFromTC(ThreadID tid);
 
    void squashFromSquashAfter(ThreadID tid);
 
    void squashAfter(ThreadID tid, const DynInstPtr &head_inst);
 
    void handleInterrupt();
 
    void propagateInterrupt();
 
    void commitInsts();
 
    bool commitHead(const DynInstPtr &head_inst, unsigned inst_num);
 
    void getInsts();
 
    void markCompletedInsts();
 
    ThreadID getCommittingThread();
 
    ThreadID roundRobin();
 
    ThreadID oldestReady();
 
  public:
    TheISA::PCState pcState(ThreadID tid) { return pc[tid]; }
 
    void pcState(const TheISA::PCState &val, ThreadID tid)
    { pc[tid] = val; }
 
    Addr instAddr(ThreadID tid) { return pc[tid].instAddr(); }
 
    Addr nextInstAddr(ThreadID tid) { return pc[tid].nextInstAddr(); }
 
    Addr microPC(ThreadID tid) { return pc[tid].microPC(); }
 
  private:
    TimeBuffer<TimeStruct> *timeBuffer;
 
    TimeBuffer<TimeStruct>::wire toIEW;
 
    TimeBuffer<TimeStruct>::wire robInfoFromIEW;
 
    TimeBuffer<FetchStruct> *fetchQueue;
 
    TimeBuffer<FetchStruct>::wire fromFetch;
 
    TimeBuffer<IEWStruct> *iewQueue;
 
    TimeBuffer<IEWStruct>::wire fromIEW;
 
    TimeBuffer<RenameStruct> *renameQueue;
 
    TimeBuffer<RenameStruct>::wire fromRename;
 
  public:
    ROB *rob;
 
  private:
    CPU *cpu;
 
    std::vector<ThreadState *> thread;
 
    bool wroteToTimeBuffer;
 
    bool changedROBNumEntries[MaxThreads];
 
    bool trapSquash[MaxThreads];
 
    bool tcSquash[MaxThreads];
 
    DynInstPtr squashAfterInst[MaxThreads];
 
    std::list<ThreadID> priority_list;
 
    const Cycles iewToCommitDelay;
 
    const Cycles commitToIEWDelay;
 
    const Cycles renameToROBDelay;
 
    const Cycles fetchToCommitDelay;
 
    const unsigned renameWidth;
 
    const unsigned commitWidth;
 
    const ThreadID numThreads;
 
    bool drainPending;
 
    bool drainImminent;
 
    const Cycles trapLatency;
 
    Fault interrupt;
 
    TheISA::PCState pc[MaxThreads];
 
    InstSeqNum youngestSeqNum[MaxThreads];
 
    InstSeqNum lastCommitedSeqNum[MaxThreads];
 
    bool trapInFlight[MaxThreads];
 
    bool committedStores[MaxThreads];
 
    bool checkEmptyROB[MaxThreads];
 
    std::list<ThreadID> *activeThreads;
 
    UnifiedRenameMap *renameMap[MaxThreads];
 
    bool canHandleInterrupts;
 
    bool avoidQuiesceLiveLock;
 
    void updateComInstStats(const DynInstPtr &inst);
 
    // HTM
    int htmStarts[MaxThreads];
    int htmStops[MaxThreads];
 
    struct CommitStats : public statistics::Group
    {
        CommitStats(CPU *cpu, Commit *commit);
        statistics::Scalar commitSquashedInsts;
        statistics::Scalar commitNonSpecStalls;
        statistics::Scalar branchMispredicts;
        statistics::Distribution numCommittedDist;
 
        statistics::Vector instsCommitted;
        statistics::Vector opsCommitted;
        statistics::Vector memRefs;
        statistics::Vector loads;
        statistics::Vector amos;
        statistics::Vector membars;
        statistics::Vector branches;
        statistics::Vector vectorInstructions;
        statistics::Vector floating;
        statistics::Vector integer;
        statistics::Vector functionCalls;
        statistics::Vector2d committedInstType;
 
        statistics::Scalar commitEligibleSamples;
    } stats;
};
 
} // namespace o3
} // namespace gem5
 
#endif // __CPU_O3_COMMIT_HH__