inst_tracker.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2024 The Regents of the University of California.
 * 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_PROBES_INST_TRACKER_HH__
#define __CPU_PROBES_INST_TRACKER_HH__
 
#include <unordered_set>
 
#include "debug/InstTracker.hh"
#include "params/GlobalInstTracker.hh"
#include "params/LocalInstTracker.hh"
#include "sim/probe/probe.hh"
#include "sim/sim_exit.hh"
 
namespace gem5
{
 
class LocalInstTracker : public ProbeListenerObject
{
  public:
    LocalInstTracker(const LocalInstTrackerParams &params);
 
    virtual void regProbeListeners();
 
    void retiredInstsHandler(const uint64_t& inst);
 
  private:
    typedef ProbeListenerArg<LocalInstTracker, uint64_t>
        LocalInstTrackerListener;
 
    bool ifListening;
 
    GlobalInstTracker *globalInstTracker;
 
  public:
    void stopListening();
 
    void
    startListening()
    {
        ifListening = true;
        regProbeListeners();
    }
    startListening() {…}
 
};
class LocalInstTracker : public ProbeListenerObject {…};
 
class GlobalInstTracker : public SimObject
{
  public:
    GlobalInstTracker(const GlobalInstTrackerParams &params);
 
    void updateAndCheckInstCount(const uint64_t& inst);
 
  private:
    uint64_t instCount;
 
    std::unordered_set<uint64_t> instThresholdSet;
 
  public:
    void
    addThreshold(uint64_t new_threshold)
    {
        instThresholdSet.insert(new_threshold);
        DPRINTF(InstTracker, "adding the instruction threshold %lu\n",
                                                              new_threshold);
    };
    addThreshold(uint64_t new_threshold) {…}
 
    uint64_t
    getCounter() const
    {
        return instCount;
    };
    getCounter() const {…}
 
    void
    resetCounter()
    {
        instCount = 0;
        DPRINTF(InstTracker, "Resetting the instruction counter\n"
                                              "instCount = %lu\n", instCount);
    };
    resetCounter() {…}
 
    std::unordered_set<uint64_t>
    getThresholds() const
    {
        return instThresholdSet;
    };
    getThresholds() const {…}
 
    void
    resetThresholds()
    {
        instThresholdSet.clear();
        DPRINTF(InstTracker, "Resetting the instruction thresholds\n");
    };
    resetThresholds() {…}
};
class GlobalInstTracker : public SimObject {…};
 
}
 
#endif // __CPU_PROBES_INST_TRACKER_HH__