雲端運算模擬工具中文注釋ResCloudlet.java

/* * 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-2010, The University of Melbourne, Australia */package org.cloudbus.cloudsim;import org.cloudbus.cloudsim.core.CloudSim;/** * 表示cloudlet提交到一個cloudresource，這個類跟蹤這個cloudlet在資源中的所有活動。 * 其中欄位多數和cloudlet是重複的 * CloudSim ResCloudlet represents a Cloudlet submitted to CloudResource for * processing. This class keeps track the time for all activities in the * CloudResource for a specific Cloudlet. Before a Cloudlet exits the * CloudResource, it is RECOMMENDED to call this method * {@link #finalizeCloudlet()}. * <p> * It contains a Cloudlet object along with its arrival time and * the ID of the machine and the Pe (Processing Element) allocated to it. * It acts as a placeholder for maintaining the amount of resource share * allocated at various times for simulating any * scheduling using internal events. * * @authorManzur Murshed * @authorRajkumar Buyya * @sinceCloudSim Toolkit 1.0 */public class ResCloudlet {    /** The cloudlet. */    private final Cloudlet cloudlet;       // a Cloudlet object    /** The arrival time. */    private double arrivalTime;    // Cloudlet arrival time for the first time    /** The finished time. */    private double finishedTime;   // estimation of Cloudlet finished time    /** The cloudlet finished so far. */    private long cloudletFinishedSoFar;  // length of Cloudlet finished so far    // Cloudlet execution start time. This attribute will only hold the latest    // time since a Cloudlet can be cancel, paused or resumed.    /** The start exec time. */    private double startExecTime;    /** The total completion time. */    private double totalCompletionTime;  // total time to complete this Cloudlet    // The below attributes are only be used by the SpaceShared policy    /** The machine id. */    private int machineId;   // machine id this Cloudlet is assigned to    /** The pe id. */    private int peId;        // Pe id this Cloudlet is assigned to    /** The machine array id. */    private int[] machineArrayId = null;   // an array of machine IDs    /** The pe array id. */    private int[] peArrayId = null;        // an array of Pe IDs    /** The index. */    private int index;                     // index of machine and Pe arrays    // NOTE: Below attributes are related to AR stuff    /** The Constant NOT_FOUND. */    private static final int NOT_FOUND = -1;    /** The start time. */    private final long startTime;  // reservation start time    /** The duration. */    private final int duration;    // reservation duration time    /** The reserv id. */    private final int reservId;    // reservation id    /** The pes number. */    private int pesNumber;       // num Pe needed to execute this Cloudlet    /**     * 分配一個rescloudlet類當一個cloudlet提交時，用於記錄cloudlet的活動     * Allocates a new ResCloudlet object upon the arrival of a Cloudlet object.     * The arriving time is determined by {@link gridsim.CloudSim#clock()}.     *     * @param cloudlet a cloudlet object     *     * @see gridsim.CloudSim#clock()     * @pre cloudlet != null     * @post $none     */    public ResCloudlet(Cloudlet cloudlet) {        // when a new ResCloudlet is created, then it will automatically set        // the submission time and other properties, such as remaining length        this.cloudlet = cloudlet;        this.startTime = 0;        this.reservId = NOT_FOUND;        this.duration = 0;        init();    }    /**     * Allocates a new ResCloudlet object upon the arrival of a Cloudlet object.     * Use this constructor to store reserved Cloudlets, i.e. Cloudlets that     * done reservation before.     * The arriving time is determined by {@link gridsim.CloudSim#clock()}.     *     * @param cloudlet   a cloudlet object     * @param startTime   a reservation start time. Can also be interpreted     * as starting time to execute this Cloudlet.     * @param duration    a reservation duration time. Can also be interpreted     * as how long to execute this Cloudlet.     * @param reservID    a reservation ID that owns this Cloudlet     *     * @see gridsim.CloudSim#clock()     * @pre cloudlet != null     * @pre startTime > 0     * @pre duration > 0     * @pre reservID > 0     * @post $none     */    public ResCloudlet(Cloudlet cloudlet,long startTime,int duration,int reservID) {        this.cloudlet = cloudlet;        this.startTime = startTime;        this.reservId = reservID;        this.duration = duration;        init();    }    /**     * Gets the Cloudlet or reservation start time.     *     * @return Cloudlet's starting time     *     * @pre $none     * @post $none     */    public long getStartTime() {        return startTime;    }    /**     * Gets the reservation duration time.     *     * @return reservation duration time     *     * @pre $none     * @post $none     */    public int getDurationTime() {        return duration;    }    /**     * Gets the number of PEs required to execute this Cloudlet.     *     * @return  number of Pe     *     * @pre $none     * @post $none     */    public int getPesNumber() {        return pesNumber;    }    /**     * Gets the reservation ID that owns this Cloudlet.     *     * @return a reservation ID     *     * @pre $none     * @post $none     */    public int getReservationID() {        return reservId;    }    /**     * Checks whether this Cloudlet is submitted by reserving or not.     *     * @return <tt>true</tt> if this Cloudlet has reserved before,     * <tt>false</tt> otherwise     *     * @pre $none     * @post $none     */    public boolean hasReserved() {        if (reservId == NOT_FOUND) {            return false;        }        return true;    }    /**     * 初始化一些欄位     * Initialises all local attributes.     *     * @pre $none     * @post $none     */    private void init() {        // get number of PEs required to run this Cloudlet        this.pesNumber = cloudlet.getPesNumber();        // if more than 1 Pe, then create an array        if (pesNumber > 1)        {            this.machineArrayId = new int[pesNumber];            this.peArrayId = new int[pesNumber];        }        this.arrivalTime = CloudSim.clock();        this.cloudlet.setSubmissionTime(arrivalTime);        // default values        this.finishedTime = NOT_FOUND;  // Cannot finish in this hourly slot.        this.machineId = NOT_FOUND;        this.peId = NOT_FOUND;        this.index = 0;        this.totalCompletionTime = 0.0;        this.startExecTime = 0.0;        // In case a Cloudlet has been executed partially by some other grid        // hostList.        this.cloudletFinishedSoFar = cloudlet.getCloudletFinishedSoFar();    }    /**     * Gets this Cloudlet entity Id.     *     * @return the Cloudlet entity Id     *     * @pre $none     * @post $none     */    public int getCloudletId() {        return cloudlet.getCloudletId();    }    /**     * Gets the user or owner of this Cloudlet.     *     * @return the Cloudlet's user Id     *     * @pre $none     * @post $none     */    public int getUserId() {        return cloudlet.getUserId();    }    /**     * Gets the Cloudlet's length.     *     * @return Cloudlet's length     *     * @pre $none     * @post $none     */    public long getCloudletLength() {    return cloudlet.getCloudletLength();    }    /**     * Gets the total Cloudlet's length (across all PEs).     *     * @return total Cloudlet's length     *     * @pre $none     * @post $none     */    public long getCloudletTotalLength() {        return cloudlet.getCloudletTotalLength();    }    /**     * Gets the Cloudlet's class type.     *     * @return class type of the Cloudlet     *     * @pre $none     * @post $none     */    public int getCloudletClassType() {        return cloudlet.getClassType() ;    }    /**     * 設定cloudlet當前的狀態，一些時間因此變化     * Sets the Cloudlet status.     *     * @param status  the Cloudlet status     *     * @return <tt>true</tt> if the new status has been set, <tt>false</tt>     * otherwise     *     * @pre status >= 0     * @post $none     */    public boolean setCloudletStatus(int status) {        // gets Cloudlet's previous status        int prevStatus = cloudlet.getCloudletStatus();        // if the status of a Cloudlet is the same as last time, then ignore        if (prevStatus == status) {            return false;        }        boolean success = true;        try        {            double clock = CloudSim.clock();   // gets the current clock            // sets Cloudlet's current status            cloudlet.setCloudletStatus(status);            // if a previous Cloudlet status is INEXEC正在執行            if (prevStatus == Cloudlet.INEXEC)            {                // and current status is either CANCELED, PAUSED or SUCCESS                if (status == Cloudlet.CANCELED || status == Cloudlet.PAUSED ||                    status == Cloudlet.SUCCESS)                {                    // then update the Cloudlet completion time                    totalCompletionTime += (clock - startExecTime);                    //??為什麼要修改index(可能因為此時任務不佔用資源了)                    index = 0;                       return true;                }            }            if (prevStatus == Cloudlet.RESUMED && status == Cloudlet.SUCCESS)            {                // then update the Cloudlet completion time                totalCompletionTime += (clock - startExecTime);                return true;            }            // if a Cloudlet is now in execution            if (status == Cloudlet.INEXEC ||                (prevStatus == Cloudlet.PAUSED && status == Cloudlet.RESUMED) )            {                startExecTime = clock;                cloudlet.setExecStartTime(startExecTime);            }                    }        catch(Exception e) {            success = false;        }        return success;    }    /**     * Gets the Cloudlet's execution start time.     *     * @return Cloudlet's execution start time     *     * @pre $none     * @post $none     */    public double getExecStartTime() {        return cloudlet.getExecStartTime();    }    /**     * Sets this Cloudlet's execution parameters. These parameters are set by     * the CloudResource before departure or sending back to the original     * Cloudlet's owner.     *     * @param wallClockTime    the time of this Cloudlet resides in     * a CloudResource (from arrival time until     * departure time).     * @param actualCPUTime    the total execution time of this Cloudlet in a     * CloudResource.     *     * @pre wallClockTime >= 0.0     * @pre actualCPUTime >= 0.0     * @post $none     */    public void setExecParam(double wallClockTime, double actualCPUTime) {        cloudlet.setExecParam(wallClockTime, actualCPUTime);    }    /**     * 設定pe和machine的id     * Sets the machine and Pe (Processing Element) ID.     *     * @param machineId   machine ID     * @param peId        Pe ID     *     * @pre machineID >= 0     * @pre peID >= 0     * @post $none     */    public void setMachineAndPeId(int machineId, int peId) {        // if this job only requires 1 Pe        this.machineId = machineId;        this.peId = peId;        // if this job requires many PEs        if (this.peArrayId != null && this.pesNumber > 1)        {            this.machineArrayId[index] = machineId;            this.peArrayId[index] = peId;            index++;        }    }    /**     * Gets machine ID.     *     * @return machine ID or <tt>-1</tt> if it is not specified before     *     * @pre $none     * @post $result >= -1     */    public int getMachineId() {        return machineId;    }    /**     * Gets Pe ID.     *     * @return Pe ID or <tt>-1</tt> if it is not specified before     *     * @pre $none     * @post $result >= -1     */    public int getPeId() {        return peId;    }    /**     * Gets a list of Pe IDs. <br>     * NOTE: To get the machine IDs corresponding to these Pe IDs, use     * {@link #getMachineIdList()}.     *     * @return an array containing Pe IDs.     *     * @pre $none     * @post $none     */    public int[] getPeIdList() {        return peArrayId;    }    /**     * Gets a list of Machine IDs. <br>     * NOTE: To get the Pe IDs corresponding to these machine IDs, use     * {@link #getPeIdList()}.     *     * @return an array containing Machine IDs.     *     * @pre $none     * @post $none     */    public int[] getMachineIdList() {        return machineArrayId;    }    /**     * Gets the remaining cloudlet length.     *     * @return cloudlet length     *     * @pre $none     * @post $result >= 0     */    public long getRemainingCloudletLength() {        long length = cloudlet.getCloudletTotalLength() - cloudletFinishedSoFar;        // Remaining Cloudlet length can't be negative number. This can be        // happening when this.updateCloudletFinishedSoFar() keep calling.        if (length < 0) {            length = 0;        }        return length;    }    /**     * 設定最後的參數     * Finalizes all relevant information before <tt>exiting</tt> the     * CloudResource entity. This method sets the final data of:     * <ul>     * <li> wall clock time, i.e. the time of this Cloudlet resides in     * a CloudResource (from arrival time until departure time).     * <li> actual CPU time, i.e. the total execution time of this     * Cloudlet in a CloudResource.     * <li> Cloudlet's finished so far     * </ul>     *     * @pre $none     * @post $none     */    public void finalizeCloudlet() {        // Sets the wall clock time and actual CPU time        double wallClockTime = CloudSim.clock() - arrivalTime;        cloudlet.setExecParam(wallClockTime, totalCompletionTime);        long finished = 0;        if (cloudlet.getCloudletTotalLength() < cloudletFinishedSoFar) {            finished = cloudlet.getCloudletLength();        }        else {            finished = cloudletFinishedSoFar;        }        cloudlet.setCloudletFinishedSoFar(finished);    }    /**     * 更新目前已經完成的     * A method that updates the length of cloudlet that has been completed.     *     * @param miLength cloudlet length in Million Instructions (MI)     *     * @pre miLength >= 0.0     * @post $none     */    public void updateCloudletFinishedSoFar(long miLength) {        cloudletFinishedSoFar += miLength;    }    /**     * Gets arrival time of a cloudlet.     *     * @return arrival time     *     * @pre $none     * @post $result >= 0.0     */    public double getCloudletArrivalTime() {        return arrivalTime;    }    /**     * Sets the finish time for this Cloudlet. If time is negative, then it is     * being ignored.     *     * @param time   finish time     *     * @pre time >= 0.0     * @post $none     */    public void setFinishTime(double time) {        if (time < 0.0) {            return;        }        finishedTime = time;    }    /**     * Gets the Cloudlet's finish time.     *     * @return finish time of a cloudlet or <tt>-1.0</tt> if     * it cannot finish in this hourly slot     *     * @pre $none     * @post $result >= -1.0     */    public double getClouddletFinishTime() {        return finishedTime;    }    /**     * Gets this Cloudlet object.     *     * @return cloudlet object     *     * @pre $none     * @post $result != null     */    public Cloudlet getCloudlet() {        return cloudlet;    }    /**     * Gets the Cloudlet status.     *     * @return Cloudlet status     *     * @pre $none     * @post $none     */    public int getCloudletStatus() {        return cloudlet.getCloudletStatus();    }/** * Get unique string identificator of the VM. * * @return string uid */public String getUid() {return getUserId() + "-" + getCloudletId();}}