CSVFields.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.startup;

import archimulator.common.Experiment;
import archimulator.common.NoCConfig;
import archimulator.uncore.noc.NoCExperiment;
import archimulator.uncore.noc.routers.FlitState;
import archimulator.util.csv.CSVField;

import java.util.ArrayList;
import java.util.List;

/**
 * CSV fields.
 *
 * @author Min Cai
 */
public class CSVFields {
    public static final String NOC_PREFIX = "noc/";
    public static final String SIMULATION_PREFIX = "simulation/";

    public static List<CSVField<NoCExperiment>> csvFields = new ArrayList<>();

    static {
        csvFields.add(new CSVField<>("Data_Packet_Traffic", CSVFields::getDataPacketTraffic));
        csvFields.add(new CSVField<>("Data_Packet_Injection_Rate_(packets/cycle/node)", CSVFields::getDataPacketInjectionRate));
        csvFields.add(new CSVField<>("Routing_Algorithm", CSVFields::getRouting));
        csvFields.add(new CSVField<>("Selection_Policy", CSVFields::getSelection));
        csvFields.add(new CSVField<>("Routing+Selection", CSVFields::getRoutingAndSelection));
        csvFields.add(new CSVField<>("Ant_Packet_Traffic", CSVFields::getAntPacketTraffic));
        csvFields.add(new CSVField<>("Ant_Packet_Injection_Rate_(packets/cycle/node)", CSVFields::getAntPacketInjectionRate));
        csvFields.add(new CSVField<>("Alpha", CSVFields::getAcoSelectionAlpha));
        csvFields.add(new CSVField<>("Reinforcement_Factor", CSVFields::getReinforcementFactor));
        csvFields.add(new CSVField<>("NoC_Routing_Solution", CSVFields::getNoCRoutingSolution));
        csvFields.add(new CSVField<>("Simulation_Time", CSVFields::getSimulationTime));
        csvFields.add(new CSVField<>("Total_Cycles", CSVFields::getTotalCycles));
        csvFields.add(new CSVField<>("Packets_Transmitted", CSVFields::getNumPacketsTransmitted));
        csvFields.add(new CSVField<>("Throughput_(packets/cycle/node)", CSVFields::getThroughput));
        csvFields.add(new CSVField<>("Avg._Packet_Delay_(cycles)", CSVFields::getAveragePacketDelay));
        csvFields.add(new CSVField<>("Avg._Packet_Hops", CSVFields::getAveragePacketHops));
        csvFields.add(new CSVField<>("Payload_Packets_Transmitted", CSVFields::getNumPayloadPacketsTransmitted));
        csvFields.add(new CSVField<>("Payload_Throughput_(packets/cycle/node)", CSVFields::getPayloadThroughput));
        csvFields.add(new CSVField<>("Avg._Payload_Packet_Delay_(cycles)", CSVFields::getAveragePayloadPacketDelay));
        csvFields.add(new CSVField<>("Avg._Payload_Packet_Hops", CSVFields::getAveragePayloadPacketHops));

        for (FlitState state : FlitState.values()) {
            csvFields.add(new CSVField<>(String.format("Average_Flit_per_State_Delay::%s", state),
                    e -> getAverageFlitPerStateDelay(e, state)));
            csvFields.add(new CSVField<>(String.format("Max_Flit_per_State_Delay::%s", state),
                    e -> getMaxFlitPerStateDelay(e, state)));
        }
    }

    public static String getDataPacketTraffic(NoCExperiment experiment) {
        return experiment.getConfig().getDataPacketTraffic();
    }

    public static String getDataPacketInjectionRate(NoCExperiment experiment) {
        return String.format("%s", experiment.getConfig().getDataPacketInjectionRate());
    }

    public static String getRouting(Experiment<? extends NoCConfig> experiment) {
        return experiment.getConfig().getRouting();
    }

    public static String getSelection(Experiment<? extends NoCConfig> experiment) {
        return experiment.getConfig().getSelection();
    }

    public static String getRoutingAndSelection(Experiment<? extends NoCConfig> experiment) {
        return String.format(
                "%s+%s",
                getRouting(experiment),
                getSelection(experiment)
        );
    }

    public static String getAntPacketTraffic(Experiment<? extends NoCConfig> experiment) {
        return String.format("%s", experiment.getConfig().getAntPacketTraffic());
    }

    public static String getAntPacketInjectionRate(Experiment<? extends NoCConfig> experiment) {
        if(experiment.getConfig().getSelection().equals("aco")) {
            return String.format("%s", experiment.getConfig().getAntPacketInjectionRate());
        }

        return "";
    }

    public static String getAcoSelectionAlpha(Experiment<? extends NoCConfig> experiment) {
        if(experiment.getConfig().getSelection().equals("aco")) {
            return String.format(
                    "%s",
                    experiment.getConfig().getAcoSelectionAlpha()
            );
        }

        return "";
    }

    public static String getReinforcementFactor(Experiment<? extends NoCConfig> experiment) {
        if(experiment.getConfig().getSelection().equals("aco")) {
            return String.format(
                    "%s",
                    experiment.getConfig().getReinforcementFactor()
            );
        }

        return "";
    }

    public static String getNoCRoutingSolution(Experiment<? extends NoCConfig> experiment) {
        switch (experiment.getConfig().getRouting()) {
            case "xy":
                return "XY";
            case "oddEven":
                switch (experiment.getConfig().getSelection()) {
                    case "random":
                        return "Rand";
                    case "bufferLevel":
                        return "BL";
                    case "neighborOnPath":
                        return "NoP";
                    case "aco":
                        return String.format(
                                "ACO/aj=%s/a=%s/rf=%s",
                                getAntPacketInjectionRate(experiment),
                                getAcoSelectionAlpha(experiment),
                                getReinforcementFactor(experiment)
                        );
                    default:
                        throw new IllegalArgumentException();
                }
            default:
                throw new IllegalArgumentException();
        }
    }

    public static String getSimulationTime(Experiment<? extends NoCConfig> experiment) {
        return (String) experiment.getStatsMap().get(SIMULATION_PREFIX + "durationInSeconds");
    }

    public static String getTotalCycles(Experiment<? extends NoCConfig> experiment) {
        return String.format(
                "%s",
                experiment.getStatsMap().get(SIMULATION_PREFIX + "cycleAccurateEventQueue/currentCycle")
        );
    }

    public static String getNumPacketsTransmitted(Experiment<? extends NoCConfig> experiment) {
        return String.format(
                "%s",
                experiment.getStatsMap().get(NOC_PREFIX + "numPacketsTransmitted")
        );
    }

    public static String getThroughput(Experiment<? extends NoCConfig> experiment) {
        return String.format(
                "%s",
                experiment.getStatsMap().get(NOC_PREFIX + "throughput")
        );
    }

    public static String getAveragePacketDelay(Experiment<? extends NoCConfig> experiment) {
        return String.format(
                "%s",
                experiment.getStatsMap().get(NOC_PREFIX + "averagePacketDelay")
        );
    }

    public static String getAveragePacketHops(Experiment<? extends NoCConfig> experiment) {
        return String.format(
                "%s",
                experiment.getStatsMap().get(NOC_PREFIX + "averagePacketHops")
        );
    }

    public static String getNumPayloadPacketsTransmitted(Experiment<? extends NoCConfig> experiment) {
        return String.format(
                "%s",
                experiment.getStatsMap().get(NOC_PREFIX + "numPayloadPacketsTransmitted")
        );
    }

    public static String getPayloadThroughput(Experiment<? extends NoCConfig> experiment) {
        return String.format(
                "%s",
                experiment.getStatsMap().get(NOC_PREFIX + "payloadThroughput")
        );
    }

    public static String getAveragePayloadPacketDelay(Experiment<? extends NoCConfig> experiment) {
        return String.format(
                "%s",
                experiment.getStatsMap().get(NOC_PREFIX + "averagePayloadPacketDelay")
        );
    }

    public static String getAveragePayloadPacketHops(Experiment<? extends NoCConfig> experiment) {
        return String.format(
                "%s",
                experiment.getStatsMap().get(NOC_PREFIX + "averagePayloadPacketHops")
        );
    }

    public static String getAverageFlitPerStateDelay(Experiment<? extends NoCConfig> experiment, FlitState state) {
        return String.format(
                "%s",
                experiment.getStatsMap().get(NOC_PREFIX + String.format("averageFlitPerStateDelay::%s", state))
        );
    }

    public static String getMaxFlitPerStateDelay(Experiment<? extends NoCConfig> experiment, FlitState state) {
        return String.format(
                "%s",
                experiment.getStatsMap().get(NOC_PREFIX + String.format("maxFlitPerStateDelay::%s", state))
        );
    }
}