org.btrplace.plan.event.MigrateVM Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scheduler-api Show documentation
Core components for a scheduler
The newest version!
/*
 * Copyright  2020 The BtrPlace Authors. All rights reserved.
 * Use of this source code is governed by a LGPL-style
 * license that can be found in the LICENSE.txt file.
 */

package org.btrplace.plan.event;

import org.btrplace.model.Mapping;
import org.btrplace.model.Model;
import org.btrplace.model.Node;
import org.btrplace.model.VM;

import java.util.Objects;

/**
 * Migrate a running VM from one online node to another one.
 *
 * It is possible to parametrise the action with the amount of bandwidth
 * to reserve to perform the operation.
 *
 * @author Fabien Hermenier
 */
public class MigrateVM extends Action implements RunningVMPlacement {

  private final VM vm;

  private final Node src;
  private final Node dst;

  private int bw;

  /**
   * Make a new action.
   *
   * @param v         the VM to migrate
   * @param from      the node the VM is currently running on
   * @param to        the node where to place the VM
   * @param start     the moment the action will consume
     * @param end       the moment the action will stop
     * @param bandwidth the reserved bandwidth in MB. {@link Integer#MAX_VALUE} for an unlimited bandwidth
     */
    public MigrateVM(VM v, Node from, Node to, int start, int end, int bandwidth) {
        super(start, end);
        this.vm = v;
        this.src = from;
        this.dst = to;
        this.bw = bandwidth;
    }

    /**
     * Make a new action with an unlimited bandwidth.
     *
     * @param v         the VM to migrate
     * @param from      the node the VM is currently running on
     * @param to        the node where to place the VM
     * @param start     the moment the action will consume
     * @param end       the moment the action will stop
     */
    public MigrateVM(VM v, Node from, Node to, int start, int end) {
        this(v, from, to, start, end, Integer.MAX_VALUE);
    }

    /**
     * Get the source node that is currently hosting the VM.
     *
     * @return the node identifier
     */
    public Node getSourceNode() {
        return src;
    }

    /**
     * Get the bandwidth reserved for the migration
     *
     * @return an amount in megabytes. {@link Integer#MAX_VALUE} for an unlimited bandwidth
     */
    public int getBandwidth() {
        return bw;
    }

    @Override
    public Node getDestinationNode() {
        return dst;
    }

    @Override
    public VM getVM() {
        return vm;
    }

    /**
     * Make the VM running on the destination node
     * in the given model.
     *
     * @param i the model to alter with the action
     * @return {@code true} iff the VM is running on the destination node
     */
    @Override
    public boolean applyAction(Model i) {
        Mapping c = i.getMapping();
        return c.isRunning(vm)
                && c.getVMLocation(vm).equals(src)
                && !src.equals(dst)
                && c.addRunningVM(vm, dst);
    }

    @Override
    public boolean equals(Object o) {
        if (!super.equals(o)) {
            return false;
        }
        MigrateVM that = (MigrateVM) o;
        return this.vm.equals(that.vm) &&
                this.src.equals(that.src) &&
                this.dst.equals(that.dst) &&
                this.bw == that.bw;
    }

    @Override
    public int hashCode() {
        return Objects.hash(getStart(), getEnd(), src, dst, vm, bw);
    }

    @Override
    public String pretty() {
        String pretty = "migrate(vm=" + vm + ", from=" + src + ", to=" + dst;
        if (bw > 0) {
            pretty += ", bw=" + bw;
        }
        return pretty + ')';
    }

    @Override
    public Object visit(ActionVisitor v) {
        return v.visit(this);
    }

    /**
     * Set the bandwidth to reserve for the operation.
     * The value is in MB
     * @param bandwidth a positive value. {@link java.lang.Integer#MAX_VALUE} for an unlimited bandwidth
     * @return {@code true} if the value was positive
     */
    public boolean setBandwidth(int bandwidth) {
        if (bandwidth > 0) {
            this.bw = bandwidth;
        }
        return bandwidth > 0;
    }
}