LatencyTrackingHelper.java

/**
 * ****************************************************************************
 * Copyright (c) 2010-2016 by Min Cai (min.cai.china@gmail.com).
 * <p>
 * This file is part of the Archimulator multicore architectural simulator.
 * <p>
 * Archimulator is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * <p>
 * Archimulator is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with Archimulator. If not, see <http://www.gnu.org/licenses/>.
 * ****************************************************************************
 */
package archimulator.common;

import archimulator.common.report.ReportNode;
import archimulator.common.report.Reportable;
import archimulator.core.event.StaticInstructionFetchBeginEvent;
import archimulator.core.event.StaticInstructionFetchEndEvent;

//TODO: track dynamic instructions and memory hierarchy requests' life cycles.

/**
 * Latency tracking helper.
 *
 * @author Min Cai
 */
public class LatencyTrackingHelper implements Reportable {
    private Simulation simulation;

    /**
     * Create a latency tracking helper.
     *
     * @param simulation the parent simulation object
     */
    public LatencyTrackingHelper(Simulation simulation) {
        this.simulation = simulation;

        //TODO: to be recorded and sent to plots.
        simulation.getBlockingEventDispatcher().addListener(StaticInstructionFetchBeginEvent.class, event -> {
        });
        simulation.getBlockingEventDispatcher().addListener(StaticInstructionFetchEndEvent.class, event -> {
        });
    }

    @Override
    public void dumpStats(ReportNode reportNode) {
        reportNode.getChildren().add(new ReportNode(reportNode, "latencyTrackingHelper") {
            {
            }
        });
    }

    /**
     * Get the parent simulation object.
     *
     * @return the parent simulation object
     */
    public Simulation getSimulation() {
        return simulation;
    }
}