org.cloudbus.cloudsim.schedulers.MipsShare 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.cloudbus.cloudsim.schedulers;

import org.cloudbus.cloudsim.resources.Pe;
import org.cloudbus.cloudsim.resources.Processor;

/**
 * Represents the requested or allocated MIPS capacity for a given number of {@link Pe}s from a VM.
 * @author Manoel Campos da Silva Filho
 * @since CloudSim Plus 6.2.0
 */
public class MipsShare {
    public static final MipsShare NULL = new MipsShare();

    private long pes;
    private double mips;

    /**
     * Creates an empty MIPS share, with no PEs.
     */
    public MipsShare() {
        this(0,0);
    }

    /**
     * Creates a MIPS share with 1 PE having a given MIPS capacity.
     * @param mips the allocated or requested MIPS capacity for every {@link Pe}
     */
    public MipsShare(final double mips){
        this(1, mips);
    }

    /**
     * Creates a MIPS share according to a given {@link Processor} capacity.
     * @param processor the processor to get its capacity to create the MipsShare
     */
    public MipsShare(final Processor processor){
        this(processor.getCapacity(), processor.getMips());
    }

    /**
     * Creates a MIPS share with a defined number of PEs and MIPS capacity for each PE.
     * @param pes the number of PEs shared.
     * @param mips the allocated or requested MIPS capacity for every {@link Pe}
     */
    public MipsShare(final long pes, final double mips){
        if(pes < 0)
            throw new IllegalArgumentException("PEs number cannot be negative.");

        this.pes = pes;
        this.setMips(mips);
    }

    /**
     * A clone constructor.
     * @param share the MIPS share to clone
     */
    public MipsShare(final MipsShare share) {
        this(share.pes, share.mips);
    }

    public double mips() {
        return mips;
    }

    public final void setMips(final double mips) {
        if(mips < 0)
            throw new IllegalArgumentException("MIPS cannot be negative.");
        this.mips = mips;
    }

    /**
     * Gets the number of allocated/requested PEs,
     * which indicates the size of the MIPS share.
     * @return
     */
    public long pes(){
        return pes;
    }

    /**
     * Checks if there isn't MIPS capacity allocated to any PE.
     * @return
     */
    public boolean isEmpty(){
        return pes == 0 || mips == 0;
    }

    /**
     * Gets the total MIPS capacity sum across all PEs.
     * @return
     */
    public double totalMips(){
        return pes * mips;
    }

    /**
     * Removes a given number of PEs from the MIPS share.
     * It won't remove more PEs than there is available.
     * @param count number of PEs to remove
     * @return the number of actual removed PEs
     */
    public long remove(final long count) {
        if(count < 0)
            throw new IllegalArgumentException("The number of PEs to remove cannot be negative.");

        final long removedPes = Math.min(count, this.pes);
        this.pes -= removedPes;
        return count;
    }

    @Override
    public String toString() {
        return "MipsShare{" +
            "pes=" + pes +
            ", mips=" + mips +
            '}';
    }
}