Host (CloudSim Plus API 1.2.2 API)

All Superinterfaces:

ChangeableId, Comparable<Host>, Identificable, Machine, Resourceful

All Known Subinterfaces:

HostDynamicWorkload, PowerHost

All Known Implementing Classes:

HostDynamicWorkloadSimple, HostSimple, NetworkHost, PowerHostSimple, PowerHostUtilizationHistory
```
public interface Host
extends Machine, Comparable<Host>
```
An interface to be implemented by each class that provides Physical Machines (Hosts) features. The interface implements the Null Object Design Pattern in order to start avoiding NullPointerException when using the NULL object instead of attributing null to Host variables.

Since:

CloudSim Plus 1.0

Author:

Rodrigo N. Calheiros, Anton Beloglazov, Manoel Campos da Silva Filho

Field Summary

Fields
Modifier and Type Field and Description

static Host NULL
An attribute that implements the Null Object Design Pattern for Host objects.

Fields
Modifier and Type	Field and Description
`static Host`	`NULL` An attribute that implements the Null Object Design Pattern for `Host` objects.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`addMigratingInVm(Vm vm)` Try to add a VM migrating into the current host if there is enough resources for it.
`Host`	`addOnUpdateProcessingListener(EventListener<HostUpdatesVmsProcessingEventInfo> listener)` Adds a listener object that will be notified every time when the host updates the processing of all its `VMs`.
`boolean`	`addVmMigratingOut(Vm vm)` Adds a `Vm` to the list of VMs migrating out from the Host.
`boolean`	`allocatePesForVm(Vm vm, List<Double> mipsShare)` Allocates PEs for a VM.
`boolean`	`createTemporaryVm(Vm vm)` Try to allocate resources to a new temporary VM in the Host.
`boolean`	`createVm(Vm vm)` Try to allocate resources to a new VM in the Host.
`void`	`deallocatePesForVm(Vm vm)` Releases PEs allocated to a VM.
`void`	`destroyAllVms()` Destroys all VMs running in the host and remove them from the `getVmList()`.
`void`	`destroyTemporaryVm(Vm vm)` Destroys a temporary VM created into the Host to book resources.
`void`	`destroyVm(Vm vm)` Destroys a VM running in the host and removes it from the `getVmList()`.
`List<Double>`	`getAllocatedMipsForVm(Vm vm)` Gets the MIPS share of each Pe that is allocated to a given VM.
`double`	`getAvailableMips()` Gets the current amount of available MIPS at the host.
`long`	`getAvailableStorage()` Gets the total free storage available at the host in Megabytes.
`ResourceProvisioner`	`getBwProvisioner()` Gets the bandwidth (BW) provisioner with capacity in Megabits/s.
`Datacenter`	`getDatacenter()` Gets the Datacenter where the host is placed.
`double`	`getMaxAvailableMips()` Returns the maximum available MIPS among all the PEs of the host.
`long`	`getNumberOfFailedPes()` Gets the number of PEs that have failed.
`int`	`getNumberOfFreePes()` Gets the free pes number.
`long`	`getNumberOfWorkingPes()` Gets the number of PEs that are working.
`List<Pe>`	`getPeList()` Gets the list of all Processing Elements (PEs) of the host, including failed PEs.
`ResourceProvisioner`	`getProvisioner(Class<? extends ResourceManageable> resourceClass)` Gets the `ResourceProvisioner`s that manages a Host resource such as `Ram`, `Bandwidth` and `Pe`.
`ResourceProvisioner`	`getRamProvisioner()` Gets the ram provisioner with capacity in Megabytes.
`double`	`getTotalAllocatedMipsForVm(Vm vm)` Gets the total allocated MIPS for a VM along all its PEs.
`double`	`getTotalMipsCapacity()` Gets total MIPS capacity of PEs which are not `Pe.Status.FAILED`.
`long`	`getUtilizationOfBw()` Gets the current utilization of bw (in absolute values).
`double`	`getUtilizationOfCpu()` Gets current utilization of CPU in percentage (between [0 and 1]), considering the usage of all its PEs..
`double`	`getUtilizationOfCpuMips()` Gets the current total utilization of CPU in MIPS, considering the usage of all its PEs.
`long`	`getUtilizationOfRam()` Gets the current utilization of memory (in absolute values).
`Vm`	`getVm(int vmId, int brokerId)` Gets a VM by its id and user.
`<T extends Vm> List<T>`	`getVmList()` Gets a read-only list of VMs assigned to the host.
`VmScheduler`	`getVmScheduler()` Gets the policy for allocation of host PEs to VMs in order to schedule VM execution.
`<T extends Vm> Set<T>`	`getVmsMigratingIn()` Gets the list of VMs migrating into this host.
`Set<Vm>`	`getVmsMigratingOut()` Gets a read-only list of VMs migrating out from the Host.
`List<Pe>`	`getWorkingPeList()` Gets the list of working Processing Elements (PEs) of the host, which excludes failed PEs.
`boolean`	`isActive()` Checks if the Host is powered-on or not.
`boolean`	`isFailed()` Checks if the host is working properly or has failed.
`boolean`	`isSuitableForVm(Vm vm)` Checks if the host active and is suitable for vm.
`void`	`reallocateMigratingInVms()` Reallocate VMs migrating into the host.
`void`	`removeMigratingInVm(Vm vm)` Removes a migrating in vm.
`boolean`	`removeOnUpdateProcessingListener(EventListener<HostUpdatesVmsProcessingEventInfo> listener)` Removes a listener object from the OnUpdateProcessingListener List.
`boolean`	`removeVmMigratingIn(Vm vm)` Adds a `Vm` to the list of VMs migrating into the Host.
`boolean`	`removeVmMigratingOut(Vm vm)` Adds a `Vm` to the list of VMs migrating out from the Host.
`Host`	`setActive(boolean active)` Sets the powered state of the Host, to indicate if it's powered on or off.
`Host`	`setBwProvisioner(ResourceProvisioner bwProvisioner)` Sets the bandwidth (BW) provisioner with capacity in Megabits/s.
`void`	`setDatacenter(Datacenter datacenter)` Sets the Datacenter where the host is placed.
`boolean`	`setFailed(boolean failed)` Sets the Host state to "failed" or "working".
`boolean`	`setPeStatus(int peId, Pe.Status status)` Sets the particular Pe status on the host.
`Host`	`setRamProvisioner(ResourceProvisioner ramProvisioner)` Sets the ram provisioner with capacity in Megabytes.
`Host`	`setSimulation(Simulation simulation)` Sets the CloudSim instance that represents the simulation the Entity is related to.
`Host`	`setVmScheduler(VmScheduler vmScheduler)` Sets the policy for allocation of host PEs to VMs in order to schedule VM execution.
`double`	`updateProcessing(double currentTime)` Updates the processing of VMs running on this Host, that makes the processing of cloudlets inside such VMs to be updated.

Methods inherited from interface org.cloudbus.cloudsim.core.Machine
getBw, getMips, getNumberOfPes, getRam, getSimulation, getStorage

Methods inherited from interface org.cloudbus.cloudsim.core.ChangeableId
setId

Methods inherited from interface org.cloudbus.cloudsim.core.Identificable
getId

Methods inherited from interface org.cloudbus.cloudsim.resources.Resourceful
getResource, getResources

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - NULL
```
static final Host NULL
```
    An attribute that implements the Null Object Design Pattern for Host objects.
- Method Detail
  - getDatacenter
```
Datacenter getDatacenter()
```
    Gets the Datacenter where the host is placed.
    
    Returns:
    
    the data center of the host
  - setDatacenter
```
void setDatacenter(Datacenter datacenter)
```
    Sets the Datacenter where the host is placed.
    
    Parameters:
    
    datacenter - the new data center to move the host
  - isSuitableForVm
```
boolean isSuitableForVm(Vm vm)
```
    Checks if the host active and is suitable for vm. If it has enough resources to attend the VM.
    
    Parameters:
    
    vm - the vm
    
    Returns:
    
    true, if is suitable for vm
  - isActive
```
boolean isActive()
```
    Checks if the Host is powered-on or not.
    
    Returns:
    
    true if the Host is powered-on, false otherwise.
  - setActive
```
Host setActive(boolean active)
```
    Sets the powered state of the Host, to indicate if it's powered on or off. When a Host is powered off, no VMs will be submitted to it.
    If it is set to powered off while VMs are running inside it, it is simulated a scheduled shutdown, so that, all running VMs will finish, but not more VMs will be submitted to this Host.
    
    Parameters:
    
    active - true to set the Host as powered on, false as powered off
    
    Returns:
  - getVmsMigratingIn
```
<T extends Vm> Set<T> getVmsMigratingIn()
```
    Gets the list of VMs migrating into this host.
    
    Type Parameters:
    
    T - the generic type
    
    Returns:
    
    the vms migrating in
  - addMigratingInVm
```
boolean addMigratingInVm(Vm vm)
```
    Try to add a VM migrating into the current host if there is enough resources for it. In this case, the resources are allocated and the VM added to the getVmsMigratingIn() List. Otherwise, the VM is not added.
    
    Parameters:
    
    vm - the vm
    
    Returns:
    
    true if the Vm was migrated in, false if the Host doesn't have enough resources to place the Vm
  - getVmsMigratingOut
```
Set<Vm> getVmsMigratingOut()
```
    Gets a read-only list of VMs migrating out from the Host.
    
    Returns:
  - addVmMigratingOut
```
boolean addVmMigratingOut(Vm vm)
```
    Adds a Vm to the list of VMs migrating out from the Host.
    
    Parameters:
    
    vm - the vm to be added
    
    Returns:
    
    true if the VM wasn't into the list and was added, false otherwise
  - removeVmMigratingIn
```
boolean removeVmMigratingIn(Vm vm)
```
    Adds a Vm to the list of VMs migrating into the Host.
    
    Parameters:
    
    vm - the vm to be added
    
    Returns:
  - removeVmMigratingOut
```
boolean removeVmMigratingOut(Vm vm)
```
    Adds a Vm to the list of VMs migrating out from the Host.
    
    Parameters:
    
    vm - the vm to be added
    
    Returns:
  - reallocateMigratingInVms
```
void reallocateMigratingInVms()
```
    Reallocate VMs migrating into the host. Gets the VM in the migrating in queue and allocate them on the host.
  - getTotalMipsCapacity
```
double getTotalMipsCapacity()
```
    Gets total MIPS capacity of PEs which are not Pe.Status.FAILED.
    
    Specified by:
    
    getTotalMipsCapacity in interface Machine
    
    Returns:
    
    the total MIPS of working PEs
  - removeMigratingInVm
```
void removeMigratingInVm(Vm vm)
```
    Removes a migrating in vm.
    
    Parameters:
    
    vm - the vm
  - allocatePesForVm
```
boolean allocatePesForVm(Vm vm,
                         List<Double> mipsShare)
```
    Allocates PEs for a VM.
    
    Parameters:
    
    vm - the vm
    
    mipsShare - the list of MIPS share to be allocated to the VM
    
    Returns:
    
    $true if this policy allows a new VM in the host, $false otherwise
    
    Precondition:
    
    $none
    
    Postcondition:
    
    $none
  - deallocatePesForVm
```
void deallocatePesForVm(Vm vm)
```
    Releases PEs allocated to a VM.
    
    Parameters:
    
    vm - the vm
    
    Precondition:
    
    $none
    
    Postcondition:
    
    $none
  - getAllocatedMipsForVm
```
List<Double> getAllocatedMipsForVm(Vm vm)
```
    Gets the MIPS share of each Pe that is allocated to a given VM.
    
    Parameters:
    
    vm - the vm
    
    Returns:
    
    an array containing the amount of MIPS of each pe that is available to the VM
    
    Precondition:
    
    $none
    
    Postcondition:
    
    $none
  - getTotalAllocatedMipsForVm
```
double getTotalAllocatedMipsForVm(Vm vm)
```
    Gets the total allocated MIPS for a VM along all its PEs.
    
    Parameters:
    
    vm - the vm
    
    Returns:
    
    the allocated mips for vm
  - getPeList
```
List<Pe> getPeList()
```
    Gets the list of all Processing Elements (PEs) of the host, including failed PEs.
    
    Returns:
    
    the list of all Host PEs
    
    See Also:
    
    getWorkingPeList()
  - getWorkingPeList
```
List<Pe> getWorkingPeList()
```
    Gets the list of working Processing Elements (PEs) of the host, which excludes failed PEs.
    
    Returns:
    
    the list working (non-failed) Host PEs
  - getNumberOfFreePes
```
int getNumberOfFreePes()
```
    Gets the free pes number.
    
    Returns:
    
    the free pes number
  - setPeStatus
```
boolean setPeStatus(int peId,
                    Pe.Status status)
```
    Sets the particular Pe status on the host.
    
    Parameters:
    
    peId - the pe id
    
    status - the new Pe status
    
    Returns:
    
    true if the Pe status has set, false otherwise (Pe id might not be exist)
    
    Precondition:
    
    peID >= 0
    
    Postcondition:
    
    $none
  - getNumberOfWorkingPes
```
long getNumberOfWorkingPes()
```
    Gets the number of PEs that are working. That is, the number of PEs that aren't FAIL.
    
    Returns:
    
    the number of working pes
  - getNumberOfFailedPes
```
long getNumberOfFailedPes()
```
    Gets the number of PEs that have failed.
    
    Returns:
    
    the number of failed pes
  - getAvailableMips
```
double getAvailableMips()
```
    Gets the current amount of available MIPS at the host.
    
    Returns:
    
    the available amount of MIPS
  - getMaxAvailableMips
```
double getMaxAvailableMips()
```
    Returns the maximum available MIPS among all the PEs of the host.
    
    Returns:
    
    max mips
  - getAvailableStorage
```
long getAvailableStorage()
```
    Gets the total free storage available at the host in Megabytes.
    
    Returns:
    
    the free storage
  - getBwProvisioner
```
ResourceProvisioner getBwProvisioner()
```
    Gets the bandwidth (BW) provisioner with capacity in Megabits/s.
    
    Returns:
    
    the bw provisioner
  - setBwProvisioner
```
Host setBwProvisioner(ResourceProvisioner bwProvisioner)
```
    Sets the bandwidth (BW) provisioner with capacity in Megabits/s.
    
    Parameters:
    
    bwProvisioner - the new bw provisioner
  - getRamProvisioner
```
ResourceProvisioner getRamProvisioner()
```
    Gets the ram provisioner with capacity in Megabytes.
    
    Returns:
    
    the ram provisioner
  - setRamProvisioner
```
Host setRamProvisioner(ResourceProvisioner ramProvisioner)
```
    Sets the ram provisioner with capacity in Megabytes.
    
    Parameters:
    
    ramProvisioner - the new ram provisioner
  - getVm
```
Vm getVm(int vmId,
         int brokerId)
```
    Gets a VM by its id and user.
    
    Parameters:
    
    vmId - the vm id
    
    brokerId - ID of VM's owner
    
    Returns:
    
    the virtual machine object, $null if not found
    
    Precondition:
    
    $none
    
    Postcondition:
    
    $none
  - getVmList
```
<T extends Vm> List<T> getVmList()
```
    Gets a read-only list of VMs assigned to the host.
    
    Type Parameters:
    
    T - The generic type
    
    Returns:
    
    the read-only vm list
  - getVmScheduler
```
VmScheduler getVmScheduler()
```
    Gets the policy for allocation of host PEs to VMs in order to schedule VM execution.
    
    Returns:
    
    the VmScheduler
  - setVmScheduler
```
Host setVmScheduler(VmScheduler vmScheduler)
```
    Sets the policy for allocation of host PEs to VMs in order to schedule VM execution. The host also sets itself to the given scheduler. It also sets the Host itself to the given scheduler.
    
    Parameters:
    
    vmScheduler - the vm scheduler to set
    
    Returns:
  - isFailed
```
boolean isFailed()
```
    Checks if the host is working properly or has failed.
    
    Returns:
    
    true, if the host PEs have failed; false otherwise
  - setFailed
```
boolean setFailed(boolean failed)
```
    Sets the Host state to "failed" or "working".
    
    Parameters:
    
    failed - true to set the Host to "failed", false to set to "working"
    
    Returns:
    
    true if the Host status was changed, false otherwise
  - updateProcessing
```
double updateProcessing(double currentTime)
```
    Updates the processing of VMs running on this Host, that makes the processing of cloudlets inside such VMs to be updated.
    
    Parameters:
    
    currentTime - the current time
    
    Returns:
    
    the predicted completion time of the earliest finishing cloudlet (which is a relative delay from the current simulation time), or Double.MAX_VALUE if there is no next Cloudlet to execute
    
    Precondition:
    
    currentTime >= 0.0
    
    Postcondition:
    
    $none
  - createVm
```
boolean createVm(Vm vm)
```
    Try to allocate resources to a new VM in the Host.
    
    Parameters:
    
    vm - Vm being started
    
    Returns:
    
    $true if the VM could be started in the host; $false otherwise
    
    Precondition:
    
    $none
    
    Postcondition:
    
    $none
  - destroyVm
```
void destroyVm(Vm vm)
```
    Destroys a VM running in the host and removes it from the getVmList().
    
    Parameters:
    
    vm - the VM
    
    Precondition:
    
    $none
    
    Postcondition:
    
    $none
  - createTemporaryVm
```
boolean createTemporaryVm(Vm vm)
```
    Try to allocate resources to a new temporary VM in the Host. The method is used only to book resources for a given VM. For instance, if is being chosen Hosts to migrate a set of VMs, when a Host is selected for a given VM, using this method, the resources are reserved and then, when the next VM is selected for the same Host, the reserved resources already were reduced from the available amount. This way, it it was possible to place just one Vm into that Host, with the booking, no other VM will be selected to that Host.
    
    Parameters:
    
    vm - Vm being started
    
    Returns:
    
    $true if the VM could be started in the host; $false otherwise
    
    Precondition:
    
    $none
    
    Postcondition:
    
    $none
  - destroyTemporaryVm
```
void destroyTemporaryVm(Vm vm)
```
    Destroys a temporary VM created into the Host to book resources.
    
    Parameters:
    
    vm - the VM
    
    See Also:
    
    createTemporaryVm(Vm)
    
    Precondition:
    
    $none
    
    Postcondition:
    
    $none
  - destroyAllVms
```
void destroyAllVms()
```
    Destroys all VMs running in the host and remove them from the getVmList().
    
    Precondition:
    
    $none
    
    Postcondition:
    
    $none
  - addOnUpdateProcessingListener
```
Host addOnUpdateProcessingListener(EventListener<HostUpdatesVmsProcessingEventInfo> listener)
```
    Adds a listener object that will be notified every time when the host updates the processing of all its VMs.
    
    Parameters:
    
    listener - the OnUpdateProcessingListener to add
    
    Returns:
    
    See Also:
    
    updateProcessing(double)
  - removeOnUpdateProcessingListener
```
boolean removeOnUpdateProcessingListener(EventListener<HostUpdatesVmsProcessingEventInfo> listener)
```
    Removes a listener object from the OnUpdateProcessingListener List.
    
    Parameters:
    
    listener - the listener to remove
    
    Returns:
    
    true if the listener was found and removed, false otherwise
    
    See Also:
    
    updateProcessing(double)
  - setSimulation
```
Host setSimulation(Simulation simulation)
```
    Sets the CloudSim instance that represents the simulation the Entity is related to. Such attribute has to be set by the Datacenter that the host belongs to.
    
    Parameters:
    
    simulation - The CloudSim instance that represents the simulation the Entity is related to
    
    Returns:
  - getProvisioner
```
ResourceProvisioner getProvisioner(Class<? extends ResourceManageable> resourceClass)
```
    Gets the ResourceProvisioners that manages a Host resource such as Ram, Bandwidth and Pe.
    
    Parameters:
    
    resourceClass - the class of the resource to get its provisioner
    
    Returns:
    
    the ResourceProvisioner for the given resource class
  - getUtilizationOfCpu
```
double getUtilizationOfCpu()
```
    Gets current utilization of CPU in percentage (between [0 and 1]), considering the usage of all its PEs..
    
    Returns:
  - getUtilizationOfCpuMips
```
double getUtilizationOfCpuMips()
```
    Gets the current total utilization of CPU in MIPS, considering the usage of all its PEs.
    
    Returns:
  - getUtilizationOfBw
```
long getUtilizationOfBw()
```
    Gets the current utilization of bw (in absolute values).
    
    Returns:
  - getUtilizationOfRam
```
long getUtilizationOfRam()
```
    Gets the current utilization of memory (in absolute values).
    
    Returns:

Interface Host

Field Summary

Method Summary

Methods inherited from interface org.cloudbus.cloudsim.core.Machine

Methods inherited from interface org.cloudbus.cloudsim.core.ChangeableId

Methods inherited from interface org.cloudbus.cloudsim.core.Identificable

Methods inherited from interface org.cloudbus.cloudsim.resources.Resourceful

Methods inherited from interface java.lang.Comparable

Field Detail

NULL

Method Detail

getDatacenter

setDatacenter

isSuitableForVm

isActive

setActive

getVmsMigratingIn

addMigratingInVm

getVmsMigratingOut

addVmMigratingOut

removeVmMigratingIn

removeVmMigratingOut

reallocateMigratingInVms

getTotalMipsCapacity

removeMigratingInVm

allocatePesForVm

deallocatePesForVm

getAllocatedMipsForVm

getTotalAllocatedMipsForVm

getPeList

getWorkingPeList

getNumberOfFreePes

setPeStatus

getNumberOfWorkingPes

getNumberOfFailedPes

getAvailableMips

getMaxAvailableMips

getAvailableStorage

getBwProvisioner

setBwProvisioner

getRamProvisioner

setRamProvisioner

getVm

getVmList

getVmScheduler

setVmScheduler

isFailed

setFailed

updateProcessing

createVm

destroyVm

createTemporaryVm

destroyTemporaryVm

destroyAllVms

addOnUpdateProcessingListener

removeOnUpdateProcessingListener

setSimulation

getProvisioner

getUtilizationOfCpu

getUtilizationOfCpuMips

getUtilizationOfBw

getUtilizationOfRam