SelectionAlgorithm.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.uncore.noc.selection;

import archimulator.uncore.noc.Direction;
import archimulator.uncore.noc.Packet;
import archimulator.uncore.noc.routers.InputVirtualChannel;

import java.util.List;

/**
 * Selection algorithm.
 *
 * @author MIn Cai
 */
public interface SelectionAlgorithm {
    /**
     * Handle the event when a packet has arrived at its destination node.
     *
     * @param packet the packet
     * @param inputVirtualChannel the input virtual channel
     */
    void handleDestArrived(Packet packet, InputVirtualChannel inputVirtualChannel);

    /**
     * Do route calculation for a packet.
     *
     * @param packet the packet
     * @param inputVirtualChannel input virtual channel
     * @return the newly calculated output direction for routing the packet
     */
    Direction doRouteCalculation(Packet packet, InputVirtualChannel inputVirtualChannel);

    /**
     * Select the best output direction from a list of candidate output directions.
     *
     * @param src the source node ID
     * @param dest the destination node ID
     * @param ivc the input virtual channel ID
     * @param directions the list of candidate output directions
     * @return the best output direction selected from a list of candidate output directions
     */
    Direction select(int src, int dest, int ivc, List<Direction> directions);
}