Package org.cloudbus.cloudsim.hosts

Interface Host

All Superinterfaces:
AbstractMachine, ChangeableId, Comparable<Host>, Identifiable, Machine, PowerAware<PowerModelHost>, Resourceful, ResourceStatsComputer<HostResourceStats>
All Known Implementing Classes:
HostSimple, NetworkHost
public interface Host
extends Machine, Comparable<Host>, PowerAware<PowerModelHost>, ResourceStatsComputer<HostResourceStats>
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 Details

    • LOGGER

      static final org.slf4j.Logger LOGGER

    • DEF_IDLE_SHUTDOWN_DEADLINE

      static final double DEF_IDLE_SHUTDOWN_DEADLINE
      The default value for the getIdleShutdownDeadline(). This value indicates that the Host won't be shutdown when becoming idle.
      See Also:
      Constant Field Values

    • NULL

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

  • Method Details

    • 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 is suitable for a Vm (if it has enough resources to attend the Vm) and the Host is not failed.
      Parameters:
      vm - the Vm to check
      Returns:
      true if is suitable for Vm, false otherwise
      See Also:
      getSuitabilityFor(Vm)

    • getSuitabilityFor

      HostSuitability getSuitabilityFor​(Vm vm)
      Checks if the host is suitable for a Vm (if it has enough resources to attend the Vm) and the Host is not failed, providing fine-grained information about each individual Host's resource suitability.
      Parameters:
      vm - the Vm to check
      Returns:
      a HostSuitability object containing indicating the Host's resources that are suitable or not for the given Vm.
      See Also:
      setLazySuitabilityEvaluation(boolean)

    • isActive

      boolean isActive()
      Checks if the Host is powered-on or not.
      Returns:
      true if the Host is powered-on, false otherwise.

    • hasEverStarted

      boolean hasEverStarted()
      Checks if the Host has ever started sometime, i.e., if it was active sometime in the simulation execution.
      Returns:

    • setActive

      Host setActive​(boolean activate)
      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:
      activate - define the Host activation status: true to power on, false to power off
      Returns:
      this Host instance
      Throws:
      IllegalStateException - when trying to activate a failed host.

    • 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

    • hasMigratingVms

      boolean hasMigratingVms()
      Checks if there is any VMs migrating in or out this host.
      Returns:

    • 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

    • 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 AbstractMachine
      Returns:
      the total MIPS of working PEs

    • getTotalAvailableMips

      double getTotalAvailableMips()
      Gets the current total amount of available MIPS at the host.
      Returns:
      the total available amount of MIPS

    • getTotalAllocatedMips

      double getTotalAllocatedMips()
      Gets the total allocated MIPS at the host.
      Returns:
      the total allocated amount of MIPS

    • 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

    • removeMigratingInVm

      void removeMigratingInVm​(Vm vm)
      Removes a VM migrating into this Host from the migrating-in list, so that the VM can be actually placed into the Host and the migration process finished.
      Parameters:
      vm - the 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. It's the list of all PEs which are not FAILEd.
      Returns:
      the list working (non-failed) Host PEs

    • getBusyPeList

      List<Pe> getBusyPeList()
      Gets the list of working Processing Elements (PEs) of the host, which excludes failed PEs.
      Returns:
      the list working (non-failed) Host PEs

    • getFreePeList

      List<Pe> getFreePeList()
      Gets the list of Free Processing Elements (PEs) of the host, which excludes failed PEs.
      Returns:
      the list free (non-failed) Host PEs

    • getFreePesNumber

      int getFreePesNumber()
      Gets the number of PEs that are free to be used by any VM.
      Returns:
      the free pes number

    • getWorkingPesNumber

      int getWorkingPesNumber()
      Gets the number of PEs that are working. That is, the number of PEs that aren't FAIL.
      Returns:
      the number of working pes

    • getBusyPesNumber

      int getBusyPesNumber()
      Gets the number of PEs that are Pe.Status.BUSY. That is, the number of PEs that aren't FAIL.
      Returns:
      the number of working pes

    • getBusyPesPercent

      double getBusyPesPercent()
      Gets the current percentage (from 0..1) of used (busy) PEs, according to the total number of PEs.
      Returns:
      See Also:
      getBusyPesPercent(boolean)

    • getBusyPesPercent

      double getBusyPesPercent​(boolean hundredScale)
      Gets the current percentage of used (busy) PEs, according to the total number of PEs.
      Parameters:
      hundredScale - if true, result is provided from 0..100 scale; otherwise, it's returned in scale from 0..1.
      Returns:
      the percentage of busy PEs in the defined scale
      See Also:
      getBusyPesPercent()

    • getFailedPesNumber

      int getFailedPesNumber()
      Gets the number of PEs that have failed.
      Returns:
      the number of failed pes

    • 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

    • getVmList

      <T extends Vm> List<T> getVmList()
      Gets a read-only list of VMs currently assigned to the host.
      Type Parameters:
      T - The generic type
      Returns:
      the read-only current vm list

    • getVmCreatedList

      <T extends Vm> List<T> getVmCreatedList()
      Gets a read-only list of all VMs which have been created into the host during the entire simulation. This way, this method returns a historic list of created VMs, including those ones already destroyed.
      Type Parameters:
      T - The generic type
      Returns:
      the read-only vm created historic 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:

    • getStartTime

      double getStartTime()
      Gets the last time the Host was powered-on (in seconds).
      Returns:
      the last Host startup time or -1 if the Host has never been powered on
      See Also:
      getFirstStartTime(), setActive(boolean)

    • getFirstStartTime

      double getFirstStartTime()
      Gets the first time the Host was powered-on (in seconds).
      Returns:
      the first Host startup time or -1 if the Host has never been powered on
      See Also:
      getStartTime(), setActive(boolean)

    • setStartTime

      void setStartTime​(double startTime)
      Sets the Host start up time (the time it's being powered on).
      Parameters:
      startTime - the time to set (in seconds)
      See Also:
      getStartTime()

    • getShutdownTime

      double getShutdownTime()
      Gets the last time the Host was shut down (in seconds).
      Returns:
      the last shut downtime or -1 if the Host is active

    • setShutdownTime

      void setShutdownTime​(double shutdownTime)
      Sets the the Host shut down time.
      Parameters:
      shutdownTime - the time to set (in seconds)
      See Also:
      getShutdownTime()

    • getUpTime

      double getUpTime()
      Gets the elapsed time since the last power on.
      Returns:
      the elapsed time (in seconds)
      See Also:
      getUpTimeHours(), getTotalUpTime(), getTotalUpTimeHours()

    • getUpTimeHours

      double getUpTimeHours()
      Gets the elapsed time in hours since the last power on.
      Returns:
      the elapsed time (in hours)
      See Also:
      getUpTime(), getTotalUpTime(), getTotalUpTimeHours()

    • getTotalUpTime

      double getTotalUpTime()
      Gets the total time the Host stayed active (powered on). Since the Host can be powered on and off according to demand, this method returns the sum of all intervals the Host was active (in seconds).
      Returns:
      the total up time (in seconds)
      See Also:
      setActive(boolean), setIdleShutdownDeadline(double), getTotalUpTimeHours(), getUpTime(), getUpTimeHours()

    • getTotalUpTimeHours

      double getTotalUpTimeHours()
      Gets the total time the Host stayed active (powered on). Since the Host can be powered on and off according to demand, this method returns the sum of all intervals the Host was active (in hours).
      Returns:
      the total up time (in hours)
      See Also:
      setActive(boolean), setIdleShutdownDeadline(double), getTotalUpTime(), getUpTime(), getUpTimeHours()

    • getIdleShutdownDeadline

      double getIdleShutdownDeadline()
      Gets the deadline to shutdown the Host when it become idle. This is the time interval after the Host becoming idle that it will be shutdown.
      Returns:
      the idle shutdown deadline (in seconds)
      See Also:
      DEF_IDLE_SHUTDOWN_DEADLINE

    • setIdleShutdownDeadline

      Host setIdleShutdownDeadline​(double deadline)
      Sets the deadline to shutdown the Host when it become idle. This is the time interval after the Host becoming idle that it will be shutdown.
      Parameters:
      deadline - the deadline to shutdown the Host after it becoming idle (in seconds). A negative value disables idle host shutdown.
      Returns:
      See Also:
      DEF_IDLE_SHUTDOWN_DEADLINE, getIdleShutdownDeadline()

    • 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

    • 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

    • destroyVm

      void destroyVm​(Vm vm)
      Destroys a VM running in the host and removes it from the getVmList(). If the VM was not created yet, this method has no effect.
      Parameters:
      vm - the VM to be destroyed

    • 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
      To do something:
      https://github.com/manoelcampos/cloudsim-plus/issues/94

    • destroyTemporaryVm

      void destroyTemporaryVm​(Vm vm)
      Destroys a temporary VM created into the Host to book resources.
      Parameters:
      vm - the VM
      See Also:
      createTemporaryVm(Vm)
      To do something:
      https://github.com/manoelcampos/cloudsim-plus/issues/94

    • destroyAllVms

      void destroyAllVms()
      Destroys all VMs running in the host and remove them from the getVmList().

    • addOnStartupListener

      Host addOnStartupListener​(EventListener<HostEventInfo> listener)
      Adds a listener object that will be notified every time the host is powered on.
      Parameters:
      listener - the Listener to add
      Returns:

    • removeOnStartupListener

      boolean removeOnStartupListener​(EventListener<HostEventInfo> listener)
      Removes a Listener object from the registered List.
      Parameters:
      listener - the Listener to remove
      Returns:
      true if the Listener was removed, false otherwise

    • addOnShutdownListener

      Host addOnShutdownListener​(EventListener<HostEventInfo> listener)
      Adds a listener object that will be notified every time the host is powered off.
      Parameters:
      listener - the Listener to add
      Returns:

    • removeOnShutdownListener

      boolean removeOnShutdownListener​(EventListener<HostEventInfo> listener)
      Removes a Listener object from the registered List.
      Parameters:
      listener - the Listener to remove
      Returns:
      true if the Listener was removed, false otherwise

    • addOnUpdateProcessingListener

      Host addOnUpdateProcessingListener​(EventListener<HostUpdatesVmsProcessingEventInfo> listener)
      Adds a listener object that will be notified every time 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 registered 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

    • getCpuPercentUtilization

      double getCpuPercentUtilization()
      Gets current utilization of CPU in percentage (between [0 and 1]), considering the usage of all its PEs..
      Returns:

    • getCpuUtilizationStats

      HostResourceStats getCpuUtilizationStats()
      Gets machine's CPU utilization percentage statistics (between [0 and 1]).

      WARNING: You need to enable the data collection and computation of statistics by calling ResourceStatsComputer.enableUtilizationStats().

      The time interval in which utilization is collected is defined by the Datacenter.getSchedulingInterval().

      It uses the utilization statistics from its VMs to provide the overall Host's CPU utilization. However, for this method to return any data, you need to enable the statistics computation for every VM it owns.
      Specified by:
      getCpuUtilizationStats in interface ResourceStatsComputer<HostResourceStats>
      Returns:

    • enableUtilizationStats

      void enableUtilizationStats()
      Enables the data collection and computation of utilization statistics. It iterates over all existing VMs enabling the statistics computation on every one. But keep in mind that when a Host is created, it has no VM. Therefore, you need to call this method for every VM if you are enabling the computation before the simulation starts and VM placement is performed.
      Specified by:
      enableUtilizationStats in interface ResourceStatsComputer<HostResourceStats>
      See Also:
      ResourceStatsComputer.getCpuUtilizationStats()

    • getCpuMipsUtilization

      double getCpuMipsUtilization()
      Gets the current total utilization of CPU in MIPS, considering the usage of all its PEs.
      Returns:

    • getBwUtilization

      long getBwUtilization()
      Gets the current utilization of bw (in Megabits/s).
      Returns:

    • getRamUtilization

      long getRamUtilization()
      Gets the current utilization of memory (in Megabytes).
      Returns:

    • getPowerModel

      PowerModelHost getPowerModel()
      Gets the PowerModelHost used by the host to define how it consumes power. A Host just provides power usage data if a PowerModel is set.
      Specified by:
      getPowerModel in interface PowerAware<PowerModelHost>
      Returns:
      the Host's PowerModelHost

    • setPowerModel

      void setPowerModel​(PowerModelHost powerModel)
      Sets the PowerModelHost used by the host to define how it consumes power. A Host just provides power usage data if a PowerModel is set.
      Specified by:
      setPowerModel in interface PowerAware<PowerModelHost>
      Parameters:
      powerModel - the PowerModelHost to set

    • enableStateHistory

      void enableStateHistory()
      Enables storing Host state history.
      See Also:
      getStateHistory()

    • disableStateHistory

      void disableStateHistory()
      Disable storing Host state history.
      See Also:
      getStateHistory()

    • isStateHistoryEnabled

      boolean isStateHistoryEnabled()
      Checks if Host state history is being collected and stored.
      Returns:

    • getStateHistory

      List<HostStateHistoryEntry> getStateHistory()
      Gets a read-only host state history. This List is just populated if isStateHistoryEnabled()
      Returns:
      the state history
      See Also:
      enableStateHistory()

    • getFinishedVms

      List<Vm> getFinishedVms()
      Gets the List of VMs that have finished executing.
      Returns:

    • getMigratableVms

      List<Vm> getMigratableVms()
      Gets the list of migratable VMs from a given host.
      Returns:
      the list of migratable VMs

    • isLazySuitabilityEvaluation

      boolean isLazySuitabilityEvaluation()
      Checks if the suitability evaluation of this Host for a given Vm is to be performed lazily by methods such as isSuitableForVm(Vm). It means that the method will return as soon as some resource requirement is not met and the suitability for other VM requirements is not evaluated. This laziness improves performance but provides less information when calling getSuitabilityFor(Vm).
      Returns:
      true if the lazy evaluation is enabled, false otherwise

    • setLazySuitabilityEvaluation

      Host setLazySuitabilityEvaluation​(boolean lazySuitabilityEvaluation)
      Defines if the suitability evaluation of this Host for a given Vm is to be performed lazily by methods such as isSuitableForVm(Vm). It means that the method will return as soon as some resource requirement is not met and the suitability for other VM requirements is not evaluated. This laziness improves performance but provides less information when calling getSuitabilityFor(Vm).