LoadFlow.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.coherence.msi.flow;

import archimulator.uncore.MemoryHierarchyAccess;
import archimulator.uncore.coherence.msi.controller.CacheController;

/**
 * Load flow.
 *
 * @author Min Cai
 */
public class LoadFlow extends CacheCoherenceFlow {
    private Runnable onCompletedCallback;

    /**
     * Create a load flow.
     *
     * @param generator           the generator L1 cache controller
     * @param tag                 the tag
     * @param onCompletedCallback the callback action performed when the load flow is completed
     * @param access              the memory hierarchy access
     */
    public LoadFlow(final CacheController generator, int tag, final Runnable onCompletedCallback, MemoryHierarchyAccess access) {
        super(generator, null, access, tag);

        this.onCompletedCallback = () -> {
            onCompletedCallback.run();
            onCompleted();
        };
    }

    /**
     * Get the callback action performed when the load flow is completed.
     *
     * @return the callback action performed when the load flow is completed
     */
    public Runnable getOnCompletedCallback() {
        return onCompletedCallback;
    }

    @Override
    public String toString() {
        return String.format("[%d] %s: LoadFlow{id=%d, tag=0x%08x}", getBeginCycle(), getGenerator(), getId(), getTag());
    }
}