org.cloudbus.cloudsim.provisioners.ResourceProvisionerAbstract Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cloudsim-plus Show documentation

CloudSim Plus: A modern, highly extensible and easier-to-use Java 8 Framework for Modeling and Simulation of Cloud Computing Infrastructures and Services

There is a newer version: 8.0.0

Show newest version

/*
 * Title:        CloudSim Toolkit
 * Description:  CloudSim (Cloud Simulation) Toolkit for Modeling and Simulation of Clouds
 * Licence:      GPL - http://www.gnu.org/copyleft/gpl.html
 *
 * Copyright (c) 2009-2012, The University of Melbourne, Australia
 */

package org.cloudbus.cloudsim.provisioners;

import org.cloudbus.cloudsim.hosts.Host;
import org.cloudbus.cloudsim.resources.ResourceManageable;
import org.cloudbus.cloudsim.vms.Vm;

import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

/**
 * An abstract class that implements the basic features of a provisioning policy used by a {@link Host}
 * to provide a given resource to its virtual machines.
 *
 * @see ResourceProvisioner
 * @author Rodrigo N. Calheiros
 * @author Anton Beloglazov
 * @author Manoel Campos da Silva Filho
 * @since 3.0.4
 */
public abstract class ResourceProvisionerAbstract implements ResourceProvisioner {
    /**
     * @see #getResource()
     */
    private ResourceManageable resource;

    /** @see #getResourceAllocationMap()  */
    private final Map resourceAllocationMap;

    /**
     * @see #getResourceClass()
     */
    private Class resourceClass;

    /**
     * Creates a new ResourceManageable Provisioner for which the {@link #getResource() resource}
     * must be set further.
     */
    protected ResourceProvisionerAbstract() {
        this(ResourceManageable.NULL);
    }

    /**
     * Creates a new ResourceManageable Provisioner.
     *
     * @param resource The resource to be managed by the provisioner
     */
    public ResourceProvisionerAbstract(final ResourceManageable resource) {
        this.setResource(resource);
        this.resourceAllocationMap = new HashMap<>();
    }

    @Override
    public long getAllocatedResourceForVm(final Vm vm) {
        return resourceAllocationMap.getOrDefault(vm, 0L);
    }

    @Override
    public void deallocateResourceForAllVms() {
        for(final Vm vm: resourceAllocationMap.keySet()){
            deallocateResourceForVmAndSetAllocationMapEntryToZero(vm);
        }
        getResourceAllocationMap().clear();
    }

    /**
     * Deallocate the resource for the given VM, without removing
     * the VM fro the allocation map. The resource usage of the VM entry on the allocation map
     * is just set to 0.
     * @param vm the VM to deallocate resource
     * @return the amount of allocated VM resource or zero if VM is not found
     */
    protected abstract long deallocateResourceForVmAndSetAllocationMapEntryToZero(Vm vm);

    @Override
    public ResourceManageable getResource() {
        return resource;
    }

    @Override
    public final void setResource(final ResourceManageable resource) {
        this.resource = Objects.requireNonNull(resource);
        this.resourceClass = resource.getClass();
    }

    /**
     * Gets the class of the resource that this provisioner manages.
     * @return the resource class
     */
    protected Class getResourceClass() {
        return resourceClass;
    }

    /**
     * Gets the VM resource allocation map, where each key is a VM and each value
     * is the amount of resource allocated to that VM.
     * @return the resource allocation Map
     */
    protected Map getResourceAllocationMap() {
        return resourceAllocationMap;
    }

    @Override
    public long getCapacity() {
        return resource.getCapacity();
    }

    @Override
    public long getTotalAllocatedResource() {
        return resource.getAllocatedResource();
    }

    @Override
    public long getAvailableResource() {
        return resource.getAvailableResource();
    }

    @Override
    public boolean isResourceAllocatedToVm(Vm vm) {
        return resourceAllocationMap.keySet().contains(vm);
    }
}