云计算仿真工具中文注释Vm.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 java.util.ArrayList;
import java.util.List;

/**
 * vm类表示一个虚拟机，在主机内运行，与其他虚拟机共享主机，每个vm
 * 有一个owner，owner可以提交cloudlet，vm会处理提交的cloudlet
 * 主要方法是对每个cloudlet进行更新
 * Vm represents a VM: it runs inside a Host, sharing hostList
 * with other VMs. It processes cloudlets. This processing happens according
 * to a policy, defined by the CloudletScheduler. Each VM has a owner, which can
 * submit cloudlets to the VM to be executed
 *
 * @author		Rodrigo N. Calheiros
 * @author		Anton Beloglazov
 * @since		CloudSim Toolkit 1.0
 */
public class Vm {
	/**
	 * 参数：
	 * id, 用户id，硬盘 大小（size），处理能力，pe的个数， 内存， 带宽， vmm, 调度策略
	 * 主机，是否迁移，已分配大小、处理能力、内外存、带宽,是否是最近创建
	 */
	/** The id. */
	private int id;

	/** The user id. */
	private int userId;

	private String uid;

	/** The size. */
	private long size;

	/** The MIPS.处理能力 */
	private double mips;

	/** The PEs number. */
	private int pesNumber;

	/** The ram. */
	private int ram;

	/** The bw. */
	private long bw;

	/** The vmm. */
	private String vmm;

	/** The Cloudlet scheduler. cloudler的调度策略*/
	private CloudletScheduler cloudletScheduler;

	/** The host. */
	private Host host;                 //如果一个vm的要求大于一台host的能力怎么办，应该有个列表啊

	/** In migration flag. */
	private boolean inMigration;

	/** The current allocated size. */
	private long currentAllocatedSize;

	/** The current allocated ram. */
	private int currentAllocatedRam;

	/** The current allocated bw. */
	private long currentAllocatedBw;

	/** The current allocated mips. */
	private List<Double> currentAllocatedMips;

	/** The recently created. */
	private boolean recentlyCreated;

	/**
	 * Creates a new VMCharacteristics object.
	 *
	 * @param id unique ID of the VM
	 * @param userId ID of the VM's owner
	 * @param size amount of storage
	 * @param ram amount of ram
	 * @param bw amount of bandwidth
	 * @param pesNumber amount of CPUs
	 * @param vmm virtual machine monitor
	 * @param cloudletScheduler cloudletScheduler policy for cloudlets
	 * @param priority the priority
	 * @param mips the mips
	 *
	 * @pre id >= 0
	 * @pre userId >= 0
	 * @pre size > 0
	 * @pre ram > 0
	 * @pre bw > 0
	 * @pre cpus > 0
	 * @pre priority >= 0
	 * @pre cloudletScheduler != null
	 * @post $none
	 */
	public Vm(int id, int userId, double mips, int pesNumber, int ram, long bw, long size, String vmm, CloudletScheduler cloudletScheduler) {
		setId(id);
		setUserId(userId);
		setUid(getUid(userId, id));
		setMips(mips);
		setPesNumber(pesNumber);
		setRam(ram);
		setBw(bw);
		setSize(size);
		setVmm(vmm);
		setCloudletScheduler(cloudletScheduler);

		setInMigration(false);
		setRecentlyCreated(true);

		setCurrentAllocatedBw(0);
		setCurrentAllocatedMips(null);
		setCurrentAllocatedRam(0);
		setCurrentAllocatedSize(0);
	}

	/**
	 * Updates the processing of cloudlets running on this VM.
	 *
	 * @param currentTime current simulation time
	 * @param mipsShare array with MIPS share of each Pe available to the scheduler
	 *
	 * @return time predicted completion time of the earliest finishing cloudlet, or 0
	 * if there is no next events
	 *
	 * @pre currentTime >= 0
	 * @post $none
	 */
	public double updateVmProcessing(double currentTime, List<Double> mipsShare) {
		if (mipsShare != null) {
			//对scheduler中的cloudlet更新
			return getCloudletScheduler().updateVmProcessing(currentTime, mipsShare);
		}
		return 0.0;
	}

	/**
	 * 不是新建的vm直接返回currentrequestedmips，否则新建返回
	 * Gets the current requested mips.
	 *
	 * @return the current requested mips
	 */
	public List<Double> getCurrentRequestedMips() {
		List<Double> currentRequestedMips = getCloudletScheduler().getCurrentRequestedMips();

		if (isRecentlyCreated()) {
			boolean mipsIsNull = true;
			for (double mips : currentRequestedMips) {
				if (mips > 0.0) {
					mipsIsNull = false;
					setRecentlyCreated(false);
					break;
				}
			}

			//if (mipsIsNull && isRecentlyCreated()) {
			if (mipsIsNull) {
				currentRequestedMips = new ArrayList<Double>();
				for (int i = 0; i < getPesNumber(); i++) {
					currentRequestedMips.add(getMips());
				}
			}
		}

		return currentRequestedMips;
	}

	/**
	 * 总处理能力
	 * Gets the current requested total mips.
	 *
	 * @return the current requested total mips
	 */
	public double getCurrentRequestedTotalMips() {
		double totalRequestedMips = 0;
		for (double mips : getCurrentRequestedMips()) {
			totalRequestedMips += mips;
		}
		return totalRequestedMips;
	}

	/**
	 * Gets the current requested bw.
	 *
	 * @return the current requested bw
	 */
	public long getCurrentRequestedBw() {
		return getBw();
	}

	/**
	 * Gets the current requested ram.
	 *
	 * @return the current requested ram
	 */
	public int getCurrentRequestedRam() {
		return getRam();
	}

	/**
	 * 此刻cpu总的利用率
	 * Get utilization created by all clouddlets running on this VM.
	 *
	 * @param time the time
	 *
	 * @return total utilization
	 */
	public double getTotalUtilizationOfCpu(double time) {
		return getCloudletScheduler().getTotalUtilizationOfCpu(time);
	}

	/**
	 * Get utilization created by all cloudlets running on this VM in MIPS.
	 *
	 * @param time the time
	 *
	 * @return total utilization
	 */
	public double getTotalUtilizationOfCpuMips(double time) {
		return getTotalUtilizationOfCpu(time) * getMips();
	}

	public void setUid(String uid) {
		this.uid = uid;
	}

	/**
	 * Get unique string identificator of the VM.
	 *
	 * @return string uid
	 */
	public String getUid() {
		return uid;
	}

	/**
	 * Generate unique string identificator of the VM.
	 *
	 * @param userId the user id
	 * @param vmId the vm id
	 *
	 * @return string uid
	 */
	public static String getUid(int userId, int vmId) {
		return userId + "-" + vmId;
	}

	/**
	 * Gets the id.
	 *
	 * @return the id
	 */
	public int getId() {
		return id;
	}

	/**
	 * Sets the id.
	 *
	 * @param id the new id
	 */
	protected void setId(int id) {
		this.id = id;
	}

	/**
	 * Sets the user id.
	 *
	 * @param userId the new user id
	 */
	protected void setUserId(int userId) {
		this.userId = userId;
	}

	/**
	 * Gets the ID of the owner of the VM.
	 *
	 * @return VM's owner ID
	 *
	 * @pre $none
	 * @post $none
	 */
	public int getUserId() {
		return userId;
	}

	/**
	 * Gets the mips.
	 *
	 * @return the mips
	 */
	public double getMips() {
		return mips;
	}

	/**
	 * Sets the mips.
	 *
	 * @param mips the new mips
	 */
	protected void setMips(double mips) {
		this.mips = mips;
	}

	/**
	 * Gets the pes number.
	 *
	 * @return the pes number
	 */
	public int getPesNumber() {
		return pesNumber;
	}

	/**
	 * Sets the pes number.
	 *
	 * @param pesNumber the new pes number
	 */
	protected void setPesNumber(int pesNumber) {
		this.pesNumber = pesNumber;
	}

	/**
	 * Gets the amount of ram.
	 *
	 * @return amount of ram
	 *
	 * @pre $none
	 * @post $none
	 */
	public int getRam() {
		return ram;
	}

	/**
	 * Sets the amount of ram.
	 *
	 * @param ram new amount of ram
	 *
	 * @pre ram > 0
	 * @post $none
	 */
	public void setRam(int ram) {
		this.ram = ram;
	}

	/**
	 * Gets the amount of bandwidth.
	 *
	 * @return amount of bandwidth
	 *
	 * @pre $none
	 * @post $none
	 */
	public long getBw() {
		return bw;
	}

	/**
	 * Sets the amount of bandwidth.
	 *
	 * @param bw new amount of bandwidth
	 *
	 * @pre bw > 0
	 * @post $none
	 */
	public void setBw(long bw) {
		this.bw = bw;
	}

	/**
	 * Gets the amount of storage.
	 *
	 * @return amount of storage
	 *
	 * @pre $none
	 * @post $none
	 */
	public long getSize() {
		return size;
	}

	/**
	 * Sets the amount of storage.
	 *
	 * @param size new amount of storage
	 *
	 * @pre size > 0
	 * @post $none
	 */
	public void setSize(long size) {
		this.size = size;
	}

	/**
	 * Gets the VMM.
	 *
	 * @return VMM
	 *
	 * @pre $none
	 * @post $none
	 */
	public String getVmm(){
		return vmm;
	}

	/**
	 * Sets the VMM.
	 *
	 * @param vmm the new VMM
	 */
	protected void setVmm(String vmm) {
		this.vmm = vmm;
	}

	/**
	 * Sets the host that runs this VM.
	 *
	 * @param host Host running the VM
	 *
	 * @pre host != $null
	 * @post $none
	 */
	public void setHost(Host host){
		this.host = host;
	}

	/**
	 * Gets the host.
	 *
	 * @return the host
	 */
	public Host getHost() {
		return host;
	}

	/**
	 * Gets the vm scheduler.
	 *scheduler主要为一些cloudlet的队列
	 * @return the vm scheduler
	 */
	public CloudletScheduler getCloudletScheduler() {
		return cloudletScheduler;
	}

	/**
	 * Sets the vm scheduler.
	 *
	 * @param cloudletScheduler the new vm scheduler
	 */
	protected void setCloudletScheduler(CloudletScheduler cloudletScheduler) {
		this.cloudletScheduler = cloudletScheduler;
	}

	/**
	 * Checks if is in migration.
	 *
	 * @return true, if is in migration
	 */
	public boolean isInMigration() {
		return inMigration;
	}

	/**
	 * Sets the in migration.
	 *
	 * @param inMigration the new in migration
	 */
	public void setInMigration(boolean inMigration) {
		this.inMigration = inMigration;
	}

	/**
	 * Gets the current allocated size.
	 *
	 * @return the current allocated size
	 */
	public long getCurrentAllocatedSize() {
		return currentAllocatedSize;
	}

	/**
	 * Sets the current allocated size.
	 *
	 * @param currentAllocatedSize the new current allocated size
	 */
	protected void setCurrentAllocatedSize(long currentAllocatedSize) {
		this.currentAllocatedSize = currentAllocatedSize;
	}

	/**
	 * Gets the current allocated ram.
	 *
	 * @return the current allocated ram
	 */
	public int getCurrentAllocatedRam() {
		return currentAllocatedRam;
	}

	/**
	 * Sets the current allocated ram.
	 *
	 * @param currentAllocatedRam the new current allocated ram
	 */
	public void setCurrentAllocatedRam(int currentAllocatedRam) {
		this.currentAllocatedRam = currentAllocatedRam;
	}

	/**
	 * Gets the current allocated bw.
	 *
	 * @return the current allocated bw
	 */
	public long getCurrentAllocatedBw() {
		return currentAllocatedBw;
	}

	/**
	 * Sets the current allocated bw.
	 *
	 * @param currentAllocatedBw the new current allocated bw
	 */
	public void setCurrentAllocatedBw(long currentAllocatedBw) {
		this.currentAllocatedBw = currentAllocatedBw;
	}

	/**
	 * Gets the current allocated mips.
	 *
	 * @return the current allocated mips
	 * @TODO replace returning the field by a call to getCloudletScheduler().getCurrentMipsShare()
	 */
	public List<Double> getCurrentAllocatedMips() {
		return currentAllocatedMips;
	}

	/**
	 * Sets the current allocated mips.
	 *
	 * @param currentAllocatedMips the new current allocated mips
	 */
	public void setCurrentAllocatedMips(List<Double> currentAllocatedMips) {
		this.currentAllocatedMips = currentAllocatedMips;
	}

	/**
	 * Checks if is recently created.
	 *
	 * @return true, if is recently created
	 */
	public boolean isRecentlyCreated() {
		return recentlyCreated;
	}

	/**
	 * Sets the recently created.
	 *
	 * @param recentlyCreated the new recently created
	 */
	public void setRecentlyCreated(boolean recentlyCreated) {
		this.recentlyCreated = recentlyCreated;
	}

}