SimulatorManager

java.lang.Object
- simulation.SimulatorManager

```
public class SimulatorManager
extends java.lang.Object
```
Created with IntelliJ IDEA. User: alebre Date: 14/01/14 Time: 10:49 To change this template use File | Settings | File Templates.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`iResume`
`static int`	`iSuspend`
`static java.util.HashMap<java.lang.String,XVM>`	`sgVMsToSuspend` The list of XVMs that should be suspend (right now, it is impossible to suspend VMs that are currently migrated) This collection is used to suspend VMs after the completion of the migration process.

Constructor Summary

Constructors
Constructor and Description

SimulatorManager()

Constructors
Constructor and Description
`SimulatorManager()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`cleanLog()` Remove all logs from the previous run
`static double`	`computeCPUDemand()`
`static void`	`configureHostsAndVMs(int nbOfHostingHosts, int nbOfServiceHosts, int nbOfVMs, boolean balance)` Create and assign the VMs on the different hosts.
`static void`	`finalizeSimulation()`
`static double`	`getCPUDemand()`
`static java.lang.String`	`getInjectorNodeName()`
`static int`	`getNbOfUsedHosts()`
`static java.util.Collection<XHost>`	`getSGHostingHosts()`
`static java.util.Collection<XHost>`	`getSGHosts()`
`static XHost[]`	`getSGHostsToArray()`
`static java.util.Collection<XHost>`	`getSGServiceHosts()`
`static java.util.Collection<XHost>`	`getSGTurnOffHostingHosts()`
`static java.util.Collection<XHost>`	`getSGTurnOnHostingHosts()`
`static java.util.Collection<XVM>`	`getSGVMs()`
`static java.util.Collection<XVM>`	`getSGVMsOff()`
`static java.util.Collection<XVM>`	`getSGVMsOn()`
`static XVM[]`	`getSGVMsToArray()`
`static double`	`getSimulationDuration()` Stupid variable to monitor the duration of the simulation
`static XHost`	`getXHostByName(java.lang.String name)` Return the XHost entitled ''name'', if not return null (please note that the search is performed by considering all hosts (i.e.
`static XVM`	`getXVMByName(java.lang.String name)` Return the XVM entitled ''name'', if not return null please note that the search is performed by considering all VMs (i.e.
`static void`	`initHosts(int nbOfHostingHosts, int nbOfServiceHosts)` For each MSG host (but the service node), the function creates an associated XHost.
`static boolean`	`isEndOfInjection()`
`static boolean`	`isSchedulerActive()`
`static boolean`	`isViable()`
`static boolean`	`migrateVM(java.lang.String vmName, java.lang.String sourceName, java.lang.String destName)` Migrate a VM
`static boolean`	`resumeVM(java.lang.String vmName, java.lang.String hostName)`
`static void`	`setBeginTimeOfSimulation(double beginTimeOfSimulation)` Stupid variable to monitor the duration of the simulation
`static void`	`setEndOfInjection()` When the injection is complete, we turn the endOfInjection boolean to true and kill the running daemon inside each VM
`static void`	`setEndTimeOfSimulation(double endTimeOfSimulation)` Stupid variable to monitor the duration of the simulation
`static void`	`setSchedulerActive(boolean val)`
`static boolean`	`suspendVM(java.lang.String vmName, java.lang.String hostName)`
`static void`	`turnOff(XHost host)` Turn off the XHost host
`static void`	`turnOn(XHost host)` Turn on the XHost host
`static void`	`updateVM(XVM sgVM, double load)` Change the load of a VM.
`static boolean`	`willItBeViableWith(XVM sgVM, int load)`
`static void`	`writeCurrentConfiguration()` write the current configuration in the ''logs/simulatorManager/'' directory
`static void`	`writeEnergy(java.lang.String logPath)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - iSuspend
```
public static int iSuspend
```
  - iResume
```
public static int iResume
```
  - sgVMsToSuspend
```
public static java.util.HashMap<java.lang.String,XVM> sgVMsToSuspend
```
    The list of XVMs that should be suspend (right now, it is impossible to suspend VMs that are currently migrated) This collection is used to suspend VMs after the completion of the migration process.
    
    See Also:
    
    XVM
- Constructor Detail
  - SimulatorManager
```
public SimulatorManager()
```
- Method Detail
  - isSchedulerActive
```
public static boolean isSchedulerActive()
```
  - setSchedulerActive
```
public static void setSchedulerActive(boolean val)
```
  - setEndOfInjection
```
public static void setEndOfInjection()
```
    When the injection is complete, we turn the endOfInjection boolean to true and kill the running daemon inside each VM
  - finalizeSimulation
```
public static void finalizeSimulation()
```
  - isEndOfInjection
```
public static boolean isEndOfInjection()
```
    Returns:
    
    whether the injection is completed or not
  - getSGVMs
```
public static java.util.Collection<XVM> getSGVMs()
```
    Returns:
    
    the collection of XVMs: all VMs, the running and the ones that are considered as dead (i.e. hosted on hosts that have been turned off)
  - getSGVMsOn
```
public static java.util.Collection<XVM> getSGVMsOn()
```
    Returns:
    
    the collection of running XVMs
  - getSGVMsOff
```
public static java.util.Collection<XVM> getSGVMsOff()
```
    Returns:
    
    the collection of the XVMs considered as dead
  - getSGHosts
```
public static java.util.Collection<XHost> getSGHosts()
```
    Returns:
    
    the collection of XHosts (i.e. the hosts that composed the infrastructure). Please note that the returned collection is not sorted. If you need a sorted structure, you should call getSGHostsToArray() that returns an simple array
  - getSGHostsToArray
```
public static XHost[] getSGHostsToArray()
```
    Returns:
    
    the collection of XHosts (i.e. the hosts that composed the infrastructure). Please note that the returned collection is not sorted. If you need a sorted structure, you should call getSGHosts() that returns an simple array
  - getSGVMsToArray
```
public static XVM[] getSGVMsToArray()
```
  - getSGHostingHosts
```
public static java.util.Collection<XHost> getSGHostingHosts()
```
    Returns:
    
    the collection of XHosts that have been declared as hosting nodes (i.e. that can host VMs) Please note that all HostingHosts are returned (without making any distinctions between on and off hosts)
  - getSGTurnOnHostingHosts
```
public static java.util.Collection<XHost> getSGTurnOnHostingHosts()
```
    Returns:
    
    the collection of XHosts that have been declared as hosting nodes (i.e. that can host VMs) and that are turned on.
  - getSGTurnOffHostingHosts
```
public static java.util.Collection<XHost> getSGTurnOffHostingHosts()
```
  - getSGServiceHosts
```
public static java.util.Collection<XHost> getSGServiceHosts()
```
    Returns:
    
    the collection of XHosts that have been declared as services nodes (i.e. that cannot host VMs)
  - getInjectorNodeName
```
public static java.lang.String getInjectorNodeName()
```
    Returns:
    
    the name of the service node (generally node0, if you do not change the first part of the main regarding the generation of the deployment file). If you change it, please note that you should then update the getInjectorNodeName code.
  - initHosts
```
public static void initHosts(int nbOfHostingHosts,
                             int nbOfServiceHosts)
```
    For each MSG host (but the service node), the function creates an associated XHost. As a reminder, the XHost class extends the Host one by aggregation. At the end, all created hosts have been inserted into the sgHosts collection (see getSGHostingHosts function)
    
    Parameters:
    
    nbOfHostingHosts - the number of hosts that will be used to host VMs
    
    nbOfServiceHosts - the number of hosts that will be used to host services
  - configureHostsAndVMs
```
public static void configureHostsAndVMs(int nbOfHostingHosts,
                                        int nbOfServiceHosts,
                                        int nbOfVMs,
                                        boolean balance)
```
    Create and assign the VMs on the different hosts. For the moment, the initial placement follows a simple round robin strategy The algorithm fill the first host with the n first VMs until it reaches either the memory limit, then it switches to the second host and so on. Note that if the ''balance'' mode is enabled then the initial placement will put the same number of VMs on each node. The function can crash if there are two many VMs for the physical resources. At the end the collection SimulatorManager.getSGVMs() is filled.
    
    Parameters:
    
    nbOfHostingHosts - the number of the hosts composing the infrastructure
    
    nbOfServiceHosts - the number of the hosts composing the infrastructure
    
    nbOfVMs - the number of the VMs to instanciate
  - writeCurrentConfiguration
```
public static void writeCurrentConfiguration()
```
    write the current configuration in the ''logs/simulatorManager/'' directory
  - cleanLog
```
public static void cleanLog()
```
    Remove all logs from the previous run
  - isViable
```
public static boolean isViable()
```
    Returns:
    
    whether the current placement is viable or not (i.e. if every VM gets its expectations). Please note that we are considering only the hosts that are running. Complexity O(n)
  - computeCPUDemand
```
public static double computeCPUDemand()
```
    Returns:
    
    the average expected load at a particular moment (i.e. average load of each node) Please note that we are considering only the hosts hosting VMs and that are up.
  - getCPUDemand
```
public static double getCPUDemand()
```
  - getNbOfUsedHosts
```
public static int getNbOfUsedHosts()
```
    Returns:
    
    the number of hosts that are active (i.e. that host at least one VM) Complexity O(n)
  - getXHostByName
```
public static XHost getXHostByName(java.lang.String name)
```
    Return the XHost entitled ''name'', if not return null (please note that the search is performed by considering all hosts (i.e. On/Off and Hosting/Service ones)
    
    Parameters:
    
    name - the name of the host requested
    
    Returns:
    
    the corresponding XHost instance (null if there is no corresponding host in the sgHosts collection)
  - getXVMByName
```
public static XVM getXVMByName(java.lang.String name)
```
    Return the XVM entitled ''name'', if not return null please note that the search is performed by considering all VMs (i.e. event the off ones)
    
    Parameters:
    
    name - the name of the vm requested
    
    Returns:
    
    the corresponding XVM instance (null if there is no corresponding vm in the sgVMs collection)
  - updateVM
```
public static void updateVM(XVM sgVM,
                            double load)
```
    Change the load of a VM. Please note that we do not detect violations on off hosts (i.e. if the nodes that hosts the VM is off, we change the load of the vm for consistency reasons but we do not consider the violation that may state from this change).
    
    Parameters:
    
    sgVM - the VM that should be updated
    
    load - the new expected load
  - willItBeViableWith
```
public static boolean willItBeViableWith(XVM sgVM,
                                         int load)
```
  - turnOn
```
public static void turnOn(XHost host)
```
    Turn on the XHost host
    
    Parameters:
    
    host - the host to turn on
  - turnOff
```
public static void turnOff(XHost host)
```
    Turn off the XHost host
    
    Parameters:
    
    host - the host to turn off
  - setBeginTimeOfSimulation
```
public static void setBeginTimeOfSimulation(double beginTimeOfSimulation)
```
    Stupid variable to monitor the duration of the simulation
  - setEndTimeOfSimulation
```
public static void setEndTimeOfSimulation(double endTimeOfSimulation)
```
    Stupid variable to monitor the duration of the simulation
  - getSimulationDuration
```
public static double getSimulationDuration()
```
    Stupid variable to monitor the duration of the simulation
  - writeEnergy
```
public static void writeEnergy(java.lang.String logPath)
```
  - suspendVM
```
public static boolean suspendVM(java.lang.String vmName,
                                java.lang.String hostName)
```
  - resumeVM
```
public static boolean resumeVM(java.lang.String vmName,
                               java.lang.String hostName)
```
  - migrateVM
```
public static boolean migrateVM(java.lang.String vmName,
                                java.lang.String sourceName,
                                java.lang.String destName)
```
    Migrate a VM
    
    Parameters:
    
    vmName -
    
    sourceName -
    
    destName -
    
    Returns:
    
    true migration has been correctly performed, false migration cannot complete.

Class SimulatorManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

iSuspend

iResume

sgVMsToSuspend

Constructor Detail

SimulatorManager

Method Detail

isSchedulerActive

setSchedulerActive

setEndOfInjection

finalizeSimulation

isEndOfInjection

getSGVMs

getSGVMsOn

getSGVMsOff

getSGHosts

getSGHostsToArray

getSGVMsToArray

getSGHostingHosts

getSGTurnOnHostingHosts

getSGTurnOffHostingHosts

getSGServiceHosts

getInjectorNodeName

initHosts

configureHostsAndVMs

writeCurrentConfiguration

cleanLog

isViable

computeCPUDemand

getCPUDemand

getNbOfUsedHosts

getXHostByName

getXVMByName

updateVM

willItBeViableWith

turnOn

turnOff

setBeginTimeOfSimulation

setEndTimeOfSimulation

getSimulationDuration

writeEnergy

suspendVM

resumeVM

migrateVM