com.samysadi.acs.virtualization

Interface VirtualMachine

All Superinterfaces:

Cloneable, Entity, Notifier, Probed, RunnableEntity

All Known Subinterfaces:

TemporaryVirtualMachine, ThinClientVirtualMachine

All Known Implementing Classes:

TemporaryVirtualMachineDefault, ThinClientVirtualMachineDefault, VirtualMachineDefault

public interface VirtualMachine
extends Entity, RunnableEntity

A VirtualMachine is a RunnableEntity that can have multiple jobs running inside of it.

Before starting a job inside a VM, ensure that the VM is running or you will get an IllegalStateException.

All the jobs inside the VM will share its allocated resources (computing/networking/storage). Though, you can define specific rules on how resources are provisioned inside the VM. For example, you can set a resource limit for this VM, and/or you can define your own rules on how the resources are shared among jobs inside the VM.
To do so you have to instantiate a provisioner for the type of resource you want, and define this VM as its parent. Just make sure the VM is not running before doing so, or you will get an IllegalStateException.
You can only define one provisioner per resource type (ComputingProvisioner, StorageProvisioner, NetworkProvisioner).

ComputingOperations in this VM will seek a ProcessingUnit using this VM's PuAllocator.

A User may own the VM.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.samysadi.acs.core.entity.RunnableEntity

RunnableEntity.RunnableState

Field Summary

Fields

Modifier and Type	Field and Description
static long	FLAG_IS_MIGRATING Indicates that this VM is being migrated to another host.

Method Summary

Methods

Modifier and Type	Method and Description
VirtualMachine	clone() Creates a clone of current VM, and unsets any assigned resource on that clone (usable processing units, usable storages, usable network interfaces, virtual ram and virtual storage).
List<VmCheckpoint>	getCheckpoints() Returns a list (immutable) containing all VmCheckpoints owned by this VM.
ComputingProvisioner	getComputingProvisioner() Returns the ComputingProvisioner for computing operations at this virtual machine level, or null if none is set.
int	getEpoch() Returns an epoch value characterizing the execution state of the VM.
boolean	getFlag(long flag) Returns true if this flag is set
List<Job>	getJobs() Returns the list of Jobs that are running on top of this VirtualMachine.
NetworkOperationDelayer	getNetworkOperationDelayer() Returns the currently set NetworkOperationDelayer for network operations in this VM.
NetworkProvisioner	getNetworkProvisioner() Returns the NetworkProvisioner for network operations at this virtual machine level, or null if none is set.
Host	getParent() Returns the parent of this entity, or null if no parent is set
VmPlacementPolicy	getPlacementPolicy() Returns the VmPlacementPolicy that was used when placing this VM in the current host or null if this VM has no defined VmPlacementPolicy.
PuAllocator	getPuAllocator() Returns the PuAllocator associated with this VM.
StorageProvisioner	getStorageProvisioner() Returns the StorageProvisioner for storage operations at this virtual machine level, or null if none is set.
List<NetworkInterface>	getUsableNetworkInterfaces() Returns the network interfaces that this virtual machine is allowed to use.
List<ProcessingUnit>	getUsableProcessingUnits() Returns the processing units that this VM can use.
User	getUser() Returns the User that owns this Virtual Machine.
VirtualRam	getVirtualRam() Returns the virtual ram of this VM.
VirtualStorage	getVirtualStorage() Returns the virtual storage associated with this VM.
void	setEpoch(int epoch) Updates the epoch value of this VM.
void	setFlag(long flag) Sets the flag.
void	setNetworkOperationDelayer(NetworkOperationDelayer v) Sets the current NetworkOperationDelayer for network operations in this VM.
void	setParent(Entity parent) Updates the parent of this entity. This method makes sure that the old and the new parent keep their entities list updated, by automatically calling Entity.addEntity(Entity) and Entity.removeEntity(Entity).
void	setPlacementPolicy(VmPlacementPolicy policy) This method is called by VmPlacementPolicy when placing this VM on a host.
void	setUsableNetworkInterfaces(List<NetworkInterface> networkInterfaces) Updates the network interfaces that this virtual machine is allowed to use.
void	setUsableProcessingUnits(List<ProcessingUnit> processingUnits) Same as setUsableProcessingUnits(List, boolean) with the allocatePu parameter set to true.
void	setUsableProcessingUnits(List<ProcessingUnit> processingUnits, boolean allocatePu) Updates the processing units that this VM can use.
void	setUser(User user) Updates the User that owns this Virtual Machine.
void	setVirtualRam(VirtualRam v) Updates the virtual ram associated with this VM.
void	setVirtualStorage(VirtualStorage v) Updates the virtual storage associated with this VirtualMachine.
void	unsetFlag(long flag) Unsets the flag.

Methods inherited from interface com.samysadi.acs.core.entity.RunnableEntity

canRestart, canStart, doCancel, doFail, doPause, doRestart, doStart, doTerminate, getRunnableState, isRunning, isTerminated, unplace

Methods inherited from interface com.samysadi.acs.core.entity.Entity

addEntity, getConfig, getConfigRec, getEntities, getId, getLogger, getName, getProperties, getProperty, getProperty, hasParentRec, lockParent, lockParentRec, removeEntity, setConfig, setName, setProperty, unlockParent, unlockParentRec, unsetProperty

Methods inherited from interface com.samysadi.acs.core.notifications.Notifier

addGlobalListener, addListener, cancelNotifications, cleanupListeners, disableNotifications, enableNotifications, getGlobalListeners, getListeners, isNotificationsDisabled, notify, notifyNow, removeAllGlobalListeners, removeAllListeners, removeAllListeners, removeGlobalListener, removeListener

Methods inherited from interface com.samysadi.acs.core.tracing.Probed

addProbe, getProbe, getProbe, getProbes, removeProbe, removeProbe

Field Detail

FLAG_IS_MIGRATING

static final long FLAG_IS_MIGRATING

Indicates that this VM is being migrated to another host.

See Also:

Constant Field Values

Method Detail

clone

VirtualMachine clone()

Creates a clone of current VM, and unsets any assigned resource on that clone (usable processing units, usable storages, usable network interfaces, virtual ram and virtual storage).

The same user owns the cloned VM and it has the same SLA constraints.

Other children entities are cloned just as specified by superclass clone method.

Specified by:

clone in interface Entity

Specified by:

clone in interface Notifier

Specified by:

clone in interface RunnableEntity

getParent

Host getParent()

Description copied from interface: Entity

Returns the parent of this entity, or null if no parent is set

Specified by:

getParent in interface Entity

Returns:

the parent of this entity, or null

setParent

void setParent(Entity parent)

Updates the parent of this entity.
This method makes sure that the old and the new parent keep their entities list updated, by automatically calling Entity.addEntity(Entity) and Entity.removeEntity(Entity).

A CoreNotificationCodes.ENTITY_PARENT_CHANGED notification is thrown.
Additionally, each descendant of this entity (ie: entities who have this entity as their direct or not direct parent) are notified using CoreNotificationCodes.ENTITY_ANCESTOR_CHANGED.

Note If you want to unplace rather than just update this VM's parent, then use RunnableEntity.unplace(). This method will only update current VM's parent without taking any further actions.

Specified by:

setParent in interface Entity

See Also:

RunnableEntity.unplace()

getPlacementPolicy

VmPlacementPolicy getPlacementPolicy()

Returns the VmPlacementPolicy that was used when placing this VM in the current host or null if this VM has no defined VmPlacementPolicy.

Returns:

the VmPlacementPolicy that was used when placing this VM or null

setPlacementPolicy

void setPlacementPolicy(VmPlacementPolicy policy)

This method is called by VmPlacementPolicy when placing this VM on a host.

You should not need to call this method if you are not implementing a placement policy.

Parameters:

policy -

getUser

User getUser()

Returns the User that owns this Virtual Machine.

Returns:

the User that owns this Virtual Machine

setUser

void setUser(User user)

Updates the User that owns this Virtual Machine.

Parameters:

user -

getJobs

List<Job> getJobs()

Returns the list of Jobs that are running on top of this VirtualMachine.

Returns:

the list of Jobs that are running on top of this VirtualMachine

getCheckpoints

List<VmCheckpoint> getCheckpoints()

Returns a list (immutable) containing all VmCheckpoints owned by this VM.

Returns:

a list (immutable) containing all VmCheckpoints owned by this VM

getUsableProcessingUnits

List<ProcessingUnit> getUsableProcessingUnits()

Returns the processing units that this VM can use.

Default is set so that all processing units on the parent host are usable.

Returns:

the processing units that this VM can use

setUsableProcessingUnits

void setUsableProcessingUnits(List<ProcessingUnit> processingUnits)

Same as setUsableProcessingUnits(List, boolean) with the allocatePu parameter set to true.

setUsableProcessingUnits

void setUsableProcessingUnits(List<ProcessingUnit> processingUnits,
                            boolean allocatePu)

Updates the processing units that this VM can use.

If allocatePu parameter is true, then this method will also update the allocated flag for each of the processing units in the given list. And, if one of the given processing units is already allocated then an exception is thrown.

If null is given then this VM is allowed to use any processing unit in the parent host, even if it is allocated for another VM and independently from the allocatePu parameter.

Parameters:

processingUnits - usable processing units, or to null to let this vm use any processing unit on the parent host

Throws:

IllegalStateException - if this VM is running

IllegalArgumentException - if allocatePu parameter is true and one of the PUs in the given processingUnits list is already allocated for another VM

getPuAllocator

PuAllocator getPuAllocator()

Returns the PuAllocator associated with this VM.

Returns:

the PuAllocator associated with this VM

getVirtualRam

VirtualRam getVirtualRam()

Returns the virtual ram of this VM.

Returns:

the virtual ram of this VM

setVirtualRam

void setVirtualRam(VirtualRam v)

Updates the virtual ram associated with this VM.

Parameters:

v -

Throws:

IllegalStateException - if this VM is running

IllegalArgumentException - if the given virtual ram is already allocated for another VM

getVirtualStorage

VirtualStorage getVirtualStorage()

Returns the virtual storage associated with this VM.

Returns:

the virtual storage associated with this VM

setVirtualStorage

void setVirtualStorage(VirtualStorage v)

Updates the virtual storage associated with this VirtualMachine.

Parameters:

v -

Throws:

IllegalStateException - if this VM is running

IllegalArgumentException - if the given virtual storage is already allocated for another VM

getUsableNetworkInterfaces

List<NetworkInterface> getUsableNetworkInterfaces()

Returns the network interfaces that this virtual machine is allowed to use.

Default is set so that all interfaces on the parent host are usable.

Returns:

the network interfaces that this virtual machine is allowed to use

setUsableNetworkInterfaces

void setUsableNetworkInterfaces(List<NetworkInterface> networkInterfaces)

Updates the network interfaces that this virtual machine is allowed to use.

If null is given then this VM is allowed to use any network interface in the parent host.

Parameters:

networkInterfaces - usable network interfaces, set to null to let this vm use any network interface on the parent host.

Throws:

IllegalStateException - if this VM is running

getComputingProvisioner

ComputingProvisioner getComputingProvisioner()

Returns the ComputingProvisioner for computing operations at this virtual machine level, or null if none is set.

A ComputingProvisioner is not mandatory for VMs. It should be used only if you want to set specific MIPS limits for this particular VM. So, for example, you can set a maximum allowable MIPS for all operations inside this VM. You can also allow specific Jobs to have more MIPS than others.

null can be returned if there is no need for special strategy at this VM level.

Returns:

this virtual machine's computing provisioner or null if no computing provisioner was set

getStorageProvisioner

StorageProvisioner getStorageProvisioner()

Returns the StorageProvisioner for storage operations at this virtual machine level, or null if none is set.

A StorageProvisioner is not mandatory for VMs. It should be used only if you want to set specific transfer rate limits for this particular VM. So, for example, you can set a maximum allowable transfer rate for all operations inside this VM. You can also allow specific Jobs to have more transfer rate than others.

null can be returned if there is no need for special strategy at this VM level.

Returns:

this virtual machine's storage provisioner or null if no storage provisioner was set

getNetworkProvisioner

NetworkProvisioner getNetworkProvisioner()

Returns the NetworkProvisioner for network operations at this virtual machine level, or null if none is set.

A NetworkProvisioner is not mandatory for VMs. It should be used only if you want to set specific BW limits for this particular VM. So, for example, you can set a maximum allowable BW for all operations inside this VM. You can also allow specific Jobs to have more BW than others.

null can be returned if there is no need for special strategy at this VM level.

Returns:

this virtual machine's network provisioner or null if no network provisioner was set

getNetworkOperationDelayer

NetworkOperationDelayer getNetworkOperationDelayer()

Returns the currently set NetworkOperationDelayer for network operations in this VM.

Returns:

the currently set NetworkOperationDelayer for network operations in this VM.

setNetworkOperationDelayer

void setNetworkOperationDelayer(NetworkOperationDelayer v)

Sets the current NetworkOperationDelayer for network operations in this VM.

If the VM is running, then the VM is first paused, then the NetworkOperationDelayer is set, and finally the VM is resumed.

getEpoch

int getEpoch()

Returns an epoch value characterizing the execution state of the VM.

Returns:

an epoch value characterizing the execution state of the VM

Since:

1.2

setEpoch

void setEpoch(int epoch)

Updates the epoch value of this VM.

Parameters:

epoch -

Since:

1.2

getFlag

boolean getFlag(long flag)

Returns true if this flag is set

Parameters:

flag - the flag id

Returns:

true if this flag is set

See Also:

setFlag(long)

setFlag

void setFlag(long flag)

Sets the flag. And a NotificationCodes.VM_FLAG_CHANGED notification is thrown.

Parameters:

flag -

unsetFlag

void unsetFlag(long flag)

Unsets the flag.

Parameters:

flag -