org.cloudsimplus.builders.VmBuilder Maven / Gradle / Ivy

Go to download
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
/*
 * CloudSim Plus: A modern, highly-extensible and easier-to-use Framework for
 * Modeling and Simulation of Cloud Computing Infrastructures and Services.
 * http://cloudsimplus.org
 *
 *     Copyright (C) 2015-2021 Universidade da Beira Interior (UBI, Portugal) and
 *     the Instituto Federal de Educação Ciência e Tecnologia do Tocantins (IFTO, Brazil).
 *
 *     This file is part of CloudSim Plus.
 *
 *     CloudSim Plus 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.
 *
 *     CloudSim Plus 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.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with CloudSim Plus. If not, see .
 */
package org.cloudsimplus.builders;

import org.cloudbus.cloudsim.brokers.DatacenterBrokerSimple;
import org.cloudbus.cloudsim.resources.Pe;
import org.cloudbus.cloudsim.schedulers.cloudlet.CloudletScheduler;
import org.cloudbus.cloudsim.vms.Vm;
import org.cloudbus.cloudsim.vms.VmSimple;
import org.cloudsimplus.listeners.EventListener;
import org.cloudsimplus.listeners.VmDatacenterEventInfo;
import org.cloudsimplus.listeners.VmHostEventInfo;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.function.BiFunction;
import java.util.function.Supplier;

/**
 * A Builder class to create {@link Vm} objects using the default
 * values defined in {@link Vm} class.
 *
 * @author Manoel Campos da Silva Filho
 * @since CloudSim Plus 1.0
 *
 * @see VmSimple#setDefaultRamCapacity(long)
 * @see VmSimple#setDefaultBwCapacity(long)
 * @see VmSimple#setDefaultStorageCapacity(long)
 *
 */
public class VmBuilder implements Builder {
    private BiFunction vmCreationFunction;
    private double mips = 1000;
    private long pes = 1;
    private int numberOfCreatedVms;
    private final DatacenterBrokerSimple broker;
    private Supplier cloudletSchedulerSupplier;
    private EventListener onHostAllocationListener = EventListener.NULL;
    private EventListener onHostDeallocationListener = EventListener.NULL;
    private EventListener onVmCreationFailureListener = EventListener.NULL;
    private EventListener onUpdateVmProcessingListener = EventListener.NULL;

    public VmBuilder(final DatacenterBrokerSimple broker) {
        this.broker = Objects.requireNonNull(broker);
        this.numberOfCreatedVms = 0;
        this.vmCreationFunction = this::defaultVmCreationFunction;
    }

    /**
     * Creates and submits one VM to its broker.
     * @return
     */
    public VmBuilder createAndSubmit() {
        return createAndSubmit(1);
    }

    /**
     * Creates and submits a list of VM to its broker.
     * @return
     */
    public VmBuilder createAndSubmit(final int amount) {
        final List vms = new ArrayList<>(amount);
        for (int i = 0; i < amount; i++) {
            final Vm vm = vmCreationFunction.apply(mips, pes);
            if(cloudletSchedulerSupplier != null) {
                vm.setCloudletScheduler(cloudletSchedulerSupplier.get());
            }

            vm.addOnHostAllocationListener(onHostAllocationListener)
              .addOnHostDeallocationListener(onHostDeallocationListener)
              .addOnCreationFailureListener(onVmCreationFailureListener)
              .addOnUpdateProcessingListener(onUpdateVmProcessingListener)
              .setBroker(broker);
            vms.add(vm);
        }
        broker.submitVmList(vms);
        return this;
    }

    public List getVms() {
        return broker.getVmWaitingList();
    }

    private Vm defaultVmCreationFunction(final double mips, final long pes) {
        return new VmSimple(numberOfCreatedVms++, mips, pes);
    }

    public VmBuilder setMips(final double defaultMIPS) {
        this.mips = defaultMIPS;
        return this;
    }

    public VmBuilder setPes(final long defaultPEs) {
        this.pes = defaultPEs;
        return this;
    }

    public Vm getVmById(final int id) {
        return broker.getVmWaitingList().stream()
            .filter(vm -> vm.getId() == id)
            .findFirst().orElse(Vm.NULL);
    }

    public double getMips() {
        return mips;
    }

    public long getPes() {
        return pes;
    }

    /**
     * Sets a {@link BiFunction} used to create VMs.
     * It must receive the MIPS capacity of each {@link Pe} and the number of PEs for the VM it will create.
     * @param vmCreationFunction
     */
    public VmBuilder setVmCreationFunction(final BiFunction vmCreationFunction) {
        this.vmCreationFunction = Objects.requireNonNull(vmCreationFunction);
        return this;
    }

    public VmBuilder setCloudletSchedulerSupplier(final Supplier cloudletSchedulerSupplier) {
        this.cloudletSchedulerSupplier = Objects.requireNonNull(cloudletSchedulerSupplier);
        return this;
    }

    public VmBuilder setOnHostAllocationListener(final EventListener listener) {
        this.onHostAllocationListener = Objects.requireNonNull(listener);
        return this;
    }

    public VmBuilder setOnHostDeallocationListener(final EventListener listener) {
        this.onHostDeallocationListener = Objects.requireNonNull(listener);
        return this;
    }

    public VmBuilder setOnVmCreationFailureListener(final EventListener listener) {
        this.onVmCreationFailureListener = Objects.requireNonNull(listener);
        return this;
    }

    public VmBuilder setOnUpdateVmProcessingListener(final EventListener listener) {
        this.onUpdateVmProcessingListener = Objects.requireNonNull(listener);
        return this;
    }
}