org.btrplace.scheduler.choco.view.ChocoView Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016 University Nice Sophia Antipolis
 *
 * This file is part of btrplace.
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */

package org.btrplace.scheduler.choco.view;

import org.btrplace.model.Instance;
import org.btrplace.model.VM;
import org.btrplace.plan.ReconfigurationPlan;
import org.btrplace.scheduler.SchedulerException;
import org.btrplace.scheduler.choco.Injectable;
import org.btrplace.scheduler.choco.MisplacedVMsEstimator;
import org.btrplace.scheduler.choco.Parameters;
import org.btrplace.scheduler.choco.ReconfigurationProblem;
import org.chocosolver.solver.search.solution.Solution;

import java.util.Collections;
import java.util.List;
import java.util.Set;


/**
 * Interface denoting the Choco implementation of a View. Such a view will be automatically
 * instantiated from {@link org.btrplace.scheduler.choco.constraint.ChocoMapper} using
 * the api-side view provided as a parameter or using a default constructor if this class
 * is a solver-only view provided by {@link Parameters#getChocoViews()}.
 *
 * @author Fabien Hermenier
 */
public interface ChocoView extends Injectable, MisplacedVMsEstimator {

    /**
     * Get the view unique identifier.
     *
     * @return a non-empty String
     */
    String getIdentifier();

    /**
     * An event that is send to indicate a RP will be solved.
     * The view can then customize the RP a last time.
     *
     * @return {@code false} iff there will be no solution to the RP.
     * @throws SchedulerException if an error occurred while building the problem
     */
    default boolean beforeSolve(ReconfigurationProblem rp) throws SchedulerException {
        return true;
    }

    /**
     * Allow the insertion of actions on the plan computed for a given problem.
     *
     * The variable values must be extracted from the solution object {@code s} and not directly.
     * @param rp the solver problem
     * @param s the solution computed by the solver.
     * @param p  the computed plan
     * @return {@code true} iff the insertion succeeded
     */
    default boolean insertActions(ReconfigurationProblem rp, Solution s, ReconfigurationPlan p) {
        return true;
    }

    /**
     * Notify a new VM will be a clone of an already known VM.
     *
     * @param vm    the old VM that will be substituted by the clone
     * @param clone the clone identifier
     * @return {@code true} iff the view validate the cloning process.
     */
    default boolean cloneVM(VM vm, VM clone) {
        return true;
    }

    /**
     * Get the view dependencies.
     * The dependencies will be injected in prior.
     *
     * @return a list of view identifiers that may be empty
     */
    default List getDependencies() {
        return Collections.emptyList();
    }

    /**
     * {@inheritDoc}
     *
     * @param i the model to use to inspect the VMs.
     * @return all the model VMs.
     */
    @Override
    default Set getMisPlacedVMs(Instance i) {
        return i.getModel().getMapping().getAllVMs();
    }
}