org.btrplace.model.constraint.Preserve 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.model.constraint;

import org.btrplace.model.VM;
import org.btrplace.model.view.ResourceRelated;

import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;

/**
 * Ensure the allocation of a given minimum amount of resources for
 * the given VM. If it is not running, the constraint ignores it.
 * The amount to allocate must be specified as a minimum or an exact value.
 * At most, the VM will have an allocation of resources equals to the maximum allowed
 * 
 * The restriction provided by the constraint is discrete.
 *
 * @author Fabien Hermenier
 */
public class Preserve implements SatConstraint, ResourceRelated {

    private VM vm;

    private int amount;

    private String rc;

    /*
     * Make a new constraint.
     *
     * @param vm the VM
     * @param r  the resource identifier
     * @param q  the minimum amount of resources to allocate to each VM. >= 0
     */
    public Preserve(VM vm, String r, int q) {
        this.vm = vm;
        if (q < 0) {
            throw new IllegalArgumentException("The amount of resource must be >= 0");
        }
        this.rc = r;
        this.amount = q;
    }


    @Override
    public String getResource() {
        return this.rc;
    }

    /**
     * Get the amount of resources.
     *
     * @return a positive integer
     */
    public int getAmount() {
        return this.amount;
    }

    @Override
    public String toString() {
        return "preserve(vm=" + vm +
                ", rc=" + rc +
                ", amount=" + amount +
                ", discrete" + ')';
    }

    @Override
    public boolean setContinuous(boolean b) {
        return !b;
    }

    @Override
    public SatConstraintChecker getChecker() {
        return new PreserveChecker(this);
    }

    @Override
    public Collection getInvolvedVMs() {
        return Collections.singleton(vm);
    }

    @Override
    public boolean isContinuous() {
        return false;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        Preserve preserve = (Preserve) o;
        return amount == preserve.amount &&
                Objects.equals(vm, preserve.vm) &&
                Objects.equals(rc, preserve.rc);
    }

    @Override
    public int hashCode() {
        return Objects.hash(vm, amount, rc);
    }

    /**
     * Make multiple constraints
     *
     * @param vms the VMs involved in the constraints
     * @param r   the resource identifier
     * @param q   the minimum amount of resources to allocate to each VM. Must be positive
     * @return a list of constraints
     */
    public static List newPreserve(Collection vms, String r, int q) {
        return vms.stream().map(v -> new Preserve(v, r, q)).collect(Collectors.toList());
    }
}