*.bpr
*.bpf
### Documentation
+docs/source/java
docs/source/_ext/__pycache__/
doc/allclasses-frame.html
doc/allclasses-noframe.html
+++ /dev/null
-class org.simgrid.msg.As
-========================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class As
-
-Constructors
-------------
-As
-^^
-
-.. java:constructor:: protected As()
- :outertype: As
-
-Methods
--------
-getHosts
-^^^^^^^^
-
-.. java:method:: public native Host[] getHosts()
- :outertype: As
-
-getName
-^^^^^^^
-
-.. java:method:: public native String getName()
- :outertype: As
-
-getProperty
-^^^^^^^^^^^
-
-.. java:method:: public native String getProperty(String name)
- :outertype: As
-
-getSons
-^^^^^^^
-
-.. java:method:: public native As[] getSons()
- :outertype: As
-
-nativeInit
-^^^^^^^^^^
-
-.. java:method:: public static native void nativeInit()
- :outertype: As
-
- Class initializer, to initialize various JNI stuff
-
-toString
-^^^^^^^^
-
-.. java:method:: @Override public String toString()
- :outertype: As
-
+++ /dev/null
-class org.simgrid.msg.Comm
-==========================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class Comm
-
- Communication action, representing an ongoing communication between processes.
-
-Fields
-------
-finished
-^^^^^^^^
-
-.. java:field:: protected boolean finished
- :outertype: Comm
-
- Indicates if the communication is finished
-
-receiving
-^^^^^^^^^
-
-.. java:field:: protected boolean receiving
- :outertype: Comm
-
- Indicates if the communication is a receiving communication
-
-task
-^^^^
-
-.. java:field:: protected Task task
- :outertype: Comm
-
- Task associated with the comm. Beware, it can be null
-
-Constructors
-------------
-Comm
-^^^^
-
-.. java:constructor:: protected Comm()
- :outertype: Comm
-
- Protected constructor, used by Comm factories in Task.
-
-Methods
--------
-finalize
-^^^^^^^^
-
-.. java:method:: @Deprecated @Override protected void finalize() throws Throwable
- :outertype: Comm
-
- Destroy the C communication object, when the GC reclaims the java part.
-
-getTask
-^^^^^^^
-
-.. java:method:: public Task getTask()
- :outertype: Comm
-
- Returns the task associated with the communication. if the communication isn't finished yet, will return null.
-
-nativeFinalize
-^^^^^^^^^^^^^^
-
-.. java:method:: protected native void nativeFinalize()
- :outertype: Comm
-
-nativeInit
-^^^^^^^^^^
-
-.. java:method:: public static native void nativeInit()
- :outertype: Comm
-
- Class initializer, to initialize various JNI stuff
-
-test
-^^^^
-
-.. java:method:: public native boolean test() throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Comm
-
- Returns if the communication is finished or not. If the communication has finished and there was an error, raise an exception.
-
-waitAll
-^^^^^^^
-
-.. java:method:: public static native void waitAll(Comm[] comms, double timeout) throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Comm
-
- Wait all of the communications
-
-waitAll
-^^^^^^^
-
-.. java:method:: public static void waitAll(Comm[] comms) throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Comm
-
- Wait all of the communications, with no maximal delay
-
-waitAny
-^^^^^^^
-
-.. java:method:: public static native int waitAny(Comm[] comms) throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Comm
-
- Wait any of the communications, and return the rank of the terminating comm
-
-waitCompletion
-^^^^^^^^^^^^^^
-
-.. java:method:: public void waitCompletion() throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Comm
-
- Wait infinitely for the completion of the communication (infinite timeout)
-
-waitCompletion
-^^^^^^^^^^^^^^
-
-.. java:method:: public native void waitCompletion(double timeout) throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Comm
-
- Wait for the completion of the communication. Throws an exception if there were an error in the communication.
-
- :param timeout: Time before giving up (infinite time if negative)
-
+++ /dev/null
-class org.simgrid.msg.File
-==========================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class File
-
-Fields
-------
-SEEK_CUR
-^^^^^^^^
-
-.. java:field:: public static final int SEEK_CUR
- :outertype: File
-
-SEEK_END
-^^^^^^^^
-
-.. java:field:: public static final int SEEK_END
- :outertype: File
-
-SEEK_SET
-^^^^^^^^
-
-.. java:field:: public static final int SEEK_SET
- :outertype: File
-
-Constructors
-------------
-File
-^^^^
-
-.. java:constructor:: public File(String path)
- :outertype: File
-
- Constructor, opens the file.
-
- :param path: is the file location on the storage
-
-Methods
--------
-close
-^^^^^
-
-.. java:method:: public native void close()
- :outertype: File
-
- Close the file.
-
-nativeInit
-^^^^^^^^^^
-
-.. java:method:: public static native void nativeInit()
- :outertype: File
-
- Class initializer, to initialize various JNI stuff
-
-open
-^^^^
-
-.. java:method:: protected native void open(String path)
- :outertype: File
-
- Opens the file whose name is the string pointed to by path.
-
- :param path: is the file location on the storage
-
-read
-^^^^
-
-.. java:method:: public native long read(long size, long nMemb)
- :outertype: File
-
- Read elements of a file.
-
- :param size: of each element
- :param nMemb: is the number of elements of data to write
- :return: the actually read size
-
-seek
-^^^^
-
-.. java:method:: public native void seek(long offset, long origin)
- :outertype: File
-
- Write elements into a file.
-
- :param offset: : number of bytes to offset from origin
- :param origin: : Position used as reference for the offset. It is specified by one of the following constants defined in <stdio.h> exclusively to be used as arguments for this function (SEEK_SET = beginning of file, SEEK_CUR = current position of the file pointer, SEEK_END = end of file)
-
-write
-^^^^^
-
-.. java:method:: public native long write(long size, long nMemb)
- :outertype: File
-
- Write elements into a file.
-
- :param size: of each element
- :param nMemb: is the number of elements of data to write
- :return: the actually written size
-
+++ /dev/null
-class org.simgrid.msg.Host
-==========================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class Host
-
- A host object represents a location (any possible place) where a process may run. Thus it is represented as a physical resource with computing capabilities, some mailboxes to enable running process to communicate with remote ones, and some private data that can be only accessed by local process. An instance of this class is always bound with the corresponding native host. All the native hosts are automatically created during the call of the method Msg.createEnvironment(). This method take as parameter a platform file which describes all elements of the platform (host, link, root..). You cannot create a host yourself. The best way to get an host instance is to call the static method Host.getByName(). For example to get the instance of the host. If your platform file description contains an host named "Jacquelin" : \verbatim Host jacquelin; try { jacquelin = Host.getByName("Jacquelin"); } catch(HostNotFoundException e) { System.err.println(e.toString()); } ... \endverbatim
-
-Fields
-------
-name
-^^^^
-
-.. java:field:: protected String name
- :outertype: Host
-
-Constructors
-------------
-Host
-^^^^
-
-.. java:constructor:: protected Host()
- :outertype: Host
-
-Methods
--------
-all
-^^^
-
-.. java:method:: public static native Host[] all()
- :outertype: Host
-
- Returns all hosts of the installed platform.
-
-currentHost
-^^^^^^^^^^^
-
-.. java:method:: public static native Host currentHost()
- :outertype: Host
-
- Returns the host of the current process.
-
-getAttachedStorage
-^^^^^^^^^^^^^^^^^^
-
-.. java:method:: public native String[] getAttachedStorage()
- :outertype: Host
-
- This methods returns the list of storages (names) attached to an host
-
-getAvgLoad
-^^^^^^^^^^
-
-.. java:method:: public native double getAvgLoad()
- :outertype: Host
-
- Returns the average load of the host as a ratio since the beginning of the simulation
-
-getByName
-^^^^^^^^^
-
-.. java:method:: public static native Host getByName(String name) throws HostNotFoundException
- :outertype: Host
-
- This static method gets an host instance associated with a native host of your platform. This is the best way to get a java host object.
-
- :param name: The name of the host to get.
- :throws HostNotFoundException: if the name of the host is not valid.
- :return: The host object with the given name.
-
-getComputedFlops
-^^^^^^^^^^^^^^^^
-
-.. java:method:: public native double getComputedFlops()
- :outertype: Host
-
- Returns the number of flops computed of the host since the beginning of the simulation
-
-getConsumedEnergy
-^^^^^^^^^^^^^^^^^
-
-.. java:method:: public native double getConsumedEnergy()
- :outertype: Host
-
- Returns the amount of Joules consumed by that host so far Please note that since the consumption is lazily updated, it may require a simcall to update it. The result is that the actor requesting this value will be interrupted, the value will be updated in kernel mode before returning the control to the requesting actor.
-
-getCoreNumber
-^^^^^^^^^^^^^
-
-.. java:method:: public native double getCoreNumber()
- :outertype: Host
-
-getCount
-^^^^^^^^
-
-.. java:method:: public static native int getCount()
- :outertype: Host
-
- Counts the installed hosts.
-
-getCurrentLoad
-^^^^^^^^^^^^^^
-
-.. java:method:: public native double getCurrentLoad()
- :outertype: Host
-
- Returns the current load of the host, as a ratio = achieved_flops / (core_current_speed * core_amount) See simgrid::plugin::HostLoad::get_current_load() for the full documentation.
-
-getCurrentPowerPeak
-^^^^^^^^^^^^^^^^^^^
-
-.. java:method:: public native double getCurrentPowerPeak()
- :outertype: Host
-
- Returns the speed of the processor (in flop/s) at the current pstate. See also @ref plugin_energy.
-
-getData
-^^^^^^^
-
-.. java:method:: public Object getData()
- :outertype: Host
-
-getLoad
-^^^^^^^
-
-.. java:method:: public native double getLoad()
- :outertype: Host
-
- Returns the current computation load (in flops per second)
-
-getMountedStorage
-^^^^^^^^^^^^^^^^^
-
-.. java:method:: public native Storage[] getMountedStorage()
- :outertype: Host
-
- Returns the list of mount point names on an host
-
-getName
-^^^^^^^
-
-.. java:method:: public String getName()
- :outertype: Host
-
-getPowerPeakAt
-^^^^^^^^^^^^^^
-
-.. java:method:: public native double getPowerPeakAt(int pstate)
- :outertype: Host
-
- Returns the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
-
-getProperty
-^^^^^^^^^^^
-
-.. java:method:: public native String getProperty(String name)
- :outertype: Host
-
-getPstate
-^^^^^^^^^
-
-.. java:method:: public native int getPstate()
- :outertype: Host
-
- Returns the current pstate
-
-getPstatesCount
-^^^^^^^^^^^^^^^
-
-.. java:method:: public native int getPstatesCount()
- :outertype: Host
-
-getSpeed
-^^^^^^^^
-
-.. java:method:: public native double getSpeed()
- :outertype: Host
-
- This method returns the speed of the processor of a host (in flops), regardless of the current load of the machine.
-
-hasData
-^^^^^^^
-
-.. java:method:: public boolean hasData()
- :outertype: Host
-
- Returns true if the host has an associated data object.
-
-isOn
-^^^^
-
-.. java:method:: public native boolean isOn()
- :outertype: Host
-
- Tests if an host is up and running.
-
-off
-^^^
-
-.. java:method:: public native void off() throws ProcessKilledError
- :outertype: Host
-
- Stops the host if it is on
-
-on
-^^
-
-.. java:method:: public native void on()
- :outertype: Host
-
- Starts the host if it is off
-
-setAsyncMailbox
-^^^^^^^^^^^^^^^
-
-.. java:method:: public static native void setAsyncMailbox(String mailboxName)
- :outertype: Host
-
- This static method sets a mailbox to receive in asynchronous mode. All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call. The receive call will still be necessary to use the received data. If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.
-
- :param mailboxName: The name of the mailbox
-
-setData
-^^^^^^^
-
-.. java:method:: public void setData(Object data)
- :outertype: Host
-
-setProperty
-^^^^^^^^^^^
-
-.. java:method:: public native void setProperty(String name, String value)
- :outertype: Host
-
-setPstate
-^^^^^^^^^
-
-.. java:method:: public native void setPstate(int pstate)
- :outertype: Host
-
- Changes the current pstate
-
-toString
-^^^^^^^^
-
-.. java:method:: @Override public String toString()
- :outertype: Host
-
-updateAllEnergyConsumptions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. java:method:: public static native void updateAllEnergyConsumptions()
- :outertype: Host
-
- After this call, sg_host_get_consumed_energy() will not interrupt your process (until after the next clock update).
-
+++ /dev/null
-class org.simgrid.msg.HostFailureException
-==========================================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class HostFailureException extends MsgException
-
- This exception is raised when the host on which you are running has just been rebooted.
-
-Constructors
-------------
-HostFailureException
-^^^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public HostFailureException()
- :outertype: HostFailureException
-
- Constructs an \ ``HostFailureException``\ without a detail message.
-
-HostFailureException
-^^^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public HostFailureException(String s)
- :outertype: HostFailureException
-
- Constructs an \ ``HostFailureException``\ with a detail message.
-
+++ /dev/null
-class org.simgrid.msg.HostNotFoundException
-===========================================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class HostNotFoundException extends MsgException
-
- This exception is raised when looking for a non-existing host.
-
-Constructors
-------------
-HostNotFoundException
-^^^^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public HostNotFoundException()
- :outertype: HostNotFoundException
-
- Constructs an \ ``HostNotFoundException``\ without a detail message.
-
-HostNotFoundException
-^^^^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public HostNotFoundException(String s)
- :outertype: HostNotFoundException
-
- Constructs an \ ``HostNotFoundException``\ with a detail message.
-
+++ /dev/null
-class org.simgrid.msg.JniException
-==================================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class JniException extends RuntimeException
-
- Exception raised when there is a problem within the bindings (in JNI). That's a RuntimeException: I guess nobody wants to survive a JNI error in SimGrid
-
-Constructors
-------------
-JniException
-^^^^^^^^^^^^
-
-.. java:constructor:: public JniException()
- :outertype: JniException
-
- Constructs an \ ``JniException``\ without a detail message.
-
-JniException
-^^^^^^^^^^^^
-
-.. java:constructor:: public JniException(String s)
- :outertype: JniException
-
- Constructs an \ ``JniException``\ with a detail message.
-
-JniException
-^^^^^^^^^^^^
-
-.. java:constructor:: public JniException(String string, Exception e)
- :outertype: JniException
-
+++ /dev/null
-class org.simgrid.msg.Msg
-=========================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public final class Msg
-
-Methods
--------
-createEnvironment
-^^^^^^^^^^^^^^^^^
-
-.. java:method:: public static final native void createEnvironment(String platformFile)
- :outertype: Msg
-
- Create the simulation environment by parsing a platform file.
-
-critical
-^^^^^^^^
-
-.. java:method:: public static final native void critical(String s)
- :outertype: Msg
-
- Issue a critical logging message.
-
-debug
-^^^^^
-
-.. java:method:: public static final native void debug(String msg)
- :outertype: Msg
-
- Issue a debug logging message.
-
-deployApplication
-^^^^^^^^^^^^^^^^^
-
-.. java:method:: public static final native void deployApplication(String deploymentFile)
- :outertype: Msg
-
- Starts your processes by parsing a deployment file.
-
-energyInit
-^^^^^^^^^^
-
-.. java:method:: public static final native void energyInit()
- :outertype: Msg
-
- Tell the kernel that you want to use the energy plugin
-
-environmentGetRoutingRoot
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. java:method:: public static final native As environmentGetRoutingRoot()
- :outertype: Msg
-
-error
-^^^^^
-
-.. java:method:: public static final native void error(String msg)
- :outertype: Msg
-
- Issue an error logging message.
-
-fileSystemInit
-^^^^^^^^^^^^^^
-
-.. java:method:: public static final native void fileSystemInit()
- :outertype: Msg
-
- Tell the kernel that you want to use the filesystem plugin.
-
-getClock
-^^^^^^^^
-
-.. java:method:: public static final native double getClock()
- :outertype: Msg
-
- Retrieves the simulation time
-
-info
-^^^^
-
-.. java:method:: public static final native void info(String msg)
- :outertype: Msg
-
- Issue an information logging message
-
-init
-^^^^
-
-.. java:method:: public static final native void init(String[] args)
- :outertype: Msg
-
- Initialize a MSG simulation.
-
- :param args: The arguments of the command line of the simulation.
-
-loadInit
-^^^^^^^^
-
-.. java:method:: public static final native void loadInit()
- :outertype: Msg
-
- Initializes the HostLoad plugin. The HostLoad plugin provides an API to get the current load of each host.
-
-main
-^^^^
-
-.. java:method:: public static void main(String[] args)
- :outertype: Msg
-
- Example launcher. You can use it or provide your own launcher, as you wish
-
- :param args:
-
-run
-^^^
-
-.. java:method:: public static final native void run()
- :outertype: Msg
-
- Run the MSG simulation. After the simulation, you can freely retrieve the information that you want.. In particular, retrieving the status of a process or the current date is perfectly ok.
-
-verb
-^^^^
-
-.. java:method:: public static final native void verb(String msg)
- :outertype: Msg
-
- Issue a verbose logging message.
-
-warn
-^^^^
-
-.. java:method:: public static final native void warn(String msg)
- :outertype: Msg
-
- Issue a warning logging message.
-
+++ /dev/null
-class org.simgrid.msg.MsgException
-==================================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public abstract class MsgException extends Exception
-
- This exception is an abstract class grouping all MSG-related exceptions
-
-Constructors
-------------
-MsgException
-^^^^^^^^^^^^
-
-.. java:constructor:: public MsgException()
- :outertype: MsgException
-
- Constructs an \ ``MsgException``\ without a detail message.
-
-MsgException
-^^^^^^^^^^^^
-
-.. java:constructor:: public MsgException(String msg)
- :outertype: MsgException
-
- Constructs an \ ``MsgException``\ with a detail message.
-
+++ /dev/null
-class org.simgrid.msg.Mutex
-===========================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class Mutex
-
- A mutex implemented on top of SimGrid synchronization mechanisms. You can use it exactly the same way that you use the mutexes, but to handle the interactions between the processes within the simulation. Don't mix simgrid synchronization with Java native one, or it will deadlock!
-
-Constructors
-------------
-Mutex
-^^^^^
-
-.. java:constructor:: public Mutex()
- :outertype: Mutex
-
-Methods
--------
-acquire
-^^^^^^^
-
-.. java:method:: public native void acquire()
- :outertype: Mutex
-
-finalize
-^^^^^^^^
-
-.. java:method:: @Deprecated @Override protected void finalize() throws Throwable
- :outertype: Mutex
-
-nativeInit
-^^^^^^^^^^
-
-.. java:method:: public static native void nativeInit()
- :outertype: Mutex
-
- Class initializer, to initialize various JNI stuff
-
-release
-^^^^^^^
-
-.. java:method:: public native void release()
- :outertype: Mutex
-
+++ /dev/null
-class org.simgrid.msg... java:import:: java.util ArrayList
-
-.. java:import:: java.util Arrays
-
-Process
-=============================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public abstract class Process implements Runnable
-
- A process may be defined as a code, with some private data, executing in a location (host). All the process used by your simulation must be declared in the deployment file (XML format). To create your own process you must inherit your own process from this class and override the method "main()". For example if you want to use a process named Slave proceed as it : (1) import the class Process of the package simgrid.msg import simgrid.msg.Process; public class Slave extends simgrid.msg.Process { (2) Override the method function \verbatim public void main(String[] args) { System.out.println("Hello MSG"); } \endverbatim } The name of your process must be declared in the deployment file of your simulation. For the example, for the previous process Slave this file must contains a line : <process host="Maxims" function="Slave"/>, where Maxims is the host of the process Slave. All the process of your simulation are automatically launched and managed by Msg. A process use tasks to simulate communications or computations with another process. For more information see Task. For more information on host concept see Host.
-
-Fields
-------
-startTime
-^^^^^^^^^
-
-.. java:field:: protected double startTime
- :outertype: Process
-
- Time at which the process should be created
-
-Constructors
-------------
-Process
-^^^^^^^
-
-.. java:constructor:: public Process(String hostname, String name) throws HostNotFoundException
- :outertype: Process
-
- Constructs a new process from the name of a host and his name. The method function of the process doesn't have argument.
-
- :param hostname: Where to create the process.
- :param name: The name of the process.
- :throws HostNotFoundException: if no host with this name exists.
-
-Process
-^^^^^^^
-
-.. java:constructor:: public Process(String hostname, String name, String[] args) throws HostNotFoundException
- :outertype: Process
-
- Constructs a new process from the name of a host and his name. The arguments of the method function of the process are specified by the parameter args.
-
- :param hostname: Where to create the process.
- :param name: The name of the process.
- :param args: The arguments of the main function of the process.
- :throws HostNotFoundException: if no host with this name exists.
-
-Process
-^^^^^^^
-
-.. java:constructor:: public Process(Host host, String name)
- :outertype: Process
-
- Constructs a new process from a host and his name. The method function of the process doesn't have argument.
-
- :param host: Where to create the process.
- :param name: The name of the process.
-
-Process
-^^^^^^^
-
-.. java:constructor:: public Process(Host host, String name, String[] argsParam)
- :outertype: Process
-
- Constructs a new process from a host and his name, the arguments of here method function are specified by the parameter args.
-
- :param host: Where to create the process.
- :param name: The name of the process.
- :param argsParam: The arguments of main method of the process.
-
-Process
-^^^^^^^
-
-.. java:constructor:: public Process(Host host, String name, String[] args, double startTime, double killTime)
- :outertype: Process
-
- Constructs a new process from a host and his name, the arguments of here method function are specified by the parameter args.
-
- :param host: Where to create the process.
- :param name: The name of the process.
- :param args: The arguments of main method of the process.
- :param startTime: Start time of the process
- :param killTime: Kill time of the process
-
-Methods
--------
-create
-^^^^^^
-
-.. java:method:: protected native void create(Host host)
- :outertype: Process
-
- The native method to create an MSG process.
-
- :param host: where to create the process.
-
-debugAllThreads
-^^^^^^^^^^^^^^^
-
-.. java:method:: public static void debugAllThreads()
- :outertype: Process
-
-exit
-^^^^
-
-.. java:method:: public void exit()
- :outertype: Process
-
- Stops the execution of the current actor
-
-fromPID
-^^^^^^^
-
-.. java:method:: public static native Process fromPID(int pid)
- :outertype: Process
-
- This static method gets a process from a PID.
-
- :param pid: The process identifier of the process to get.
- :return: The process with the specified PID.
-
-getCount
-^^^^^^^^
-
-.. java:method:: public static native int getCount()
- :outertype: Process
-
- This static method returns the current amount of processes running
-
- :return: The count of the running processes
-
-getCurrentProcess
-^^^^^^^^^^^^^^^^^
-
-.. java:method:: public static native Process getCurrentProcess()
- :outertype: Process
-
- This static method returns the currently running process.
-
- :return: The current process.
-
-getHost
-^^^^^^^
-
-.. java:method:: public Host getHost()
- :outertype: Process
-
- Returns the host of the process.
-
- :return: The host instance of the process.
-
-getName
-^^^^^^^
-
-.. java:method:: public String getName()
- :outertype: Process
-
- Returns the name of the process
-
-getPID
-^^^^^^
-
-.. java:method:: public int getPID()
- :outertype: Process
-
- This method returns the PID of the process.
-
- :return: The PID of the process.
-
-getPPID
-^^^^^^^
-
-.. java:method:: public int getPPID()
- :outertype: Process
-
- This method returns the PID of the parent of a process.
-
- :return: The PID of the parent of the process.
-
-getProperty
-^^^^^^^^^^^
-
-.. java:method:: public native String getProperty(String name)
- :outertype: Process
-
- Returns the value of a given process property.
-
-isSuspended
-^^^^^^^^^^^
-
-.. java:method:: public native boolean isSuspended()
- :outertype: Process
-
- Tests if a process is suspended.
-
- **See also:** :java:ref:`.suspend()`, :java:ref:`.resume()`
-
-kill
-^^^^
-
-.. java:method:: public native void kill()
- :outertype: Process
-
- Simply kills the receiving process. SimGrid sometimes have issues when you kill processes that are currently communicating and such. We are working on it to fix the issues.
-
-kill
-^^^^
-
-.. java:method:: public static void kill(Process p)
- :outertype: Process
-
-killAll
-^^^^^^^
-
-.. java:method:: public static native void killAll()
- :outertype: Process
-
- This method kills all running process of the simulation.
-
-main
-^^^^
-
-.. java:method:: public abstract void main(String[] args) throws MsgException
- :outertype: Process
-
- The main function of the process (to implement by the user).
-
- :param args:
- :throws MsgException:
-
-migrate
-^^^^^^^
-
-.. java:method:: public native void migrate(Host host)
- :outertype: Process
-
- Migrates a process to another host.
-
- :param host: The host where to migrate the process.
-
-restart
-^^^^^^^
-
-.. java:method:: public native void restart()
- :outertype: Process
-
- Restarts the process from the beginning
-
-resume
-^^^^^^
-
-.. java:method:: public native void resume()
- :outertype: Process
-
- Resume a process that was suspended by \ :java:ref:`suspend()`\ .
-
-run
-^^^
-
-.. java:method:: @Override public void run()
- :outertype: Process
-
- This method runs the process. It calls the method function that you must overwrite.
-
-setAutoRestart
-^^^^^^^^^^^^^^
-
-.. java:method:: public native void setAutoRestart(boolean autoRestart)
- :outertype: Process
-
- Specify whether the process should restart when its host restarts after a failure A process naturally stops when its host stops. It starts again only if autoRestart is set to true. Otherwise, it just disappears when the host stops.
-
-setKillTime
-^^^^^^^^^^^
-
-.. java:method:: public native void setKillTime(double killTime)
- :outertype: Process
-
- Set the kill time of the process
-
- :param killTime: the time when the process is killed
-
-sleep
-^^^^^
-
-.. java:method:: public static void sleep(long millis) throws HostFailureException
- :outertype: Process
-
- Makes the current process sleep until millis milliseconds have elapsed. You should note that unlike "waitFor" which takes seconds (as usual in SimGrid), this method takes milliseconds (as usual for sleep() in Java).
-
- :param millis: the length of time to sleep in milliseconds.
-
-sleep
-^^^^^
-
-.. java:method:: public static native void sleep(long millis, int nanos) throws HostFailureException
- :outertype: Process
-
- Makes the current process sleep until millis milliseconds and nanos nanoseconds have elapsed. Unlike \ :java:ref:`waitFor(double)`\ which takes seconds, this method takes milliseconds and nanoseconds. Overloads Thread.sleep.
-
- :param millis: the length of time to sleep in milliseconds.
- :param nanos: additional nanoseconds to sleep.
-
-start
-^^^^^
-
-.. java:method:: public final void start()
- :outertype: Process
-
- This method actually creates and run the process. It is a noop if the process is already launched.
-
-suspend
-^^^^^^^
-
-.. java:method:: public native void suspend()
- :outertype: Process
-
- Suspends the process. See \ :java:ref:`resume()`\ to resume it afterward
-
-waitFor
-^^^^^^^
-
-.. java:method:: public native void waitFor(double seconds) throws HostFailureException
- :outertype: Process
-
- Makes the current process sleep until time seconds have elapsed.
-
- :param seconds: The time the current process must sleep.
-
-yield
-^^^^^
-
-.. java:method:: public static native void yield()
- :outertype: Process
-
- Yield the current process. All other processes that are ready at the same timestamp will be executed first
-
+++ /dev/null
-class org.simgrid.msg.ProcessKilledError
-========================================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class ProcessKilledError extends Error
-
- Used internally to interrupt the user code when the process gets killed. \rst You can catch it for cleanups or to debug, but DO NOT BLOCK IT, or your simulation will segfault! .. code-block:: java try { getHost().off(); } catch (ProcessKilledError e) { e.printStackTrace(); throw e; } \endrst
-
-Constructors
-------------
-ProcessKilledError
-^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public ProcessKilledError(String s)
- :outertype: ProcessKilledError
-
+++ /dev/null
-class org.simgrid.msg.ProcessNotFoundException
-==============================================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class ProcessNotFoundException extends MsgException
-
- Exception raised when looking for a non-existing process.
-
-Constructors
-------------
-ProcessNotFoundException
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public ProcessNotFoundException()
- :outertype: ProcessNotFoundException
-
- Constructs an \ ``ProcessNotFoundException``\ without a detail message.
-
-ProcessNotFoundException
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public ProcessNotFoundException(String s)
- :outertype: ProcessNotFoundException
-
- Constructs an \ ``ProcessNotFoundException``\ with a detail message.
-
+++ /dev/null
-class org.simgrid.msg.Semaphore
-===============================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class Semaphore
-
- A semaphore implemented on top of SimGrid synchronization mechanisms. You can use it exactly the same way that you use classical semaphores but to handle the interactions between the processes within the simulation.
-
-Fields
-------
-capacity
-^^^^^^^^
-
-.. java:field:: protected final int capacity
- :outertype: Semaphore
-
- Semaphore capacity, defined when the semaphore is created. At most capacity process can acquire this semaphore at the same time.
-
-Constructors
-------------
-Semaphore
-^^^^^^^^^
-
-.. java:constructor:: public Semaphore(int capacity)
- :outertype: Semaphore
-
- Creates a new semaphore with the given capacity. At most capacity process can acquire this semaphore at the same time.
-
-Methods
--------
-acquire
-^^^^^^^
-
-.. java:method:: public native void acquire(double timeout) throws TimeoutException
- :outertype: Semaphore
-
- Locks on the semaphore object until the provided timeout expires
-
- :param timeout: the duration of the lock
- :throws TimeoutException: if the timeout expired before the semaphore could be acquired.
-
-acquire
-^^^^^^^
-
-.. java:method:: public void acquire()
- :outertype: Semaphore
-
- Locks on the semaphore object with no timeout
-
-finalize
-^^^^^^^^
-
-.. java:method:: @Deprecated @Override protected void finalize() throws Throwable
- :outertype: Semaphore
-
- Deletes this semaphore when the GC reclaims it
-
-getCapacity
-^^^^^^^^^^^
-
-.. java:method:: public int getCapacity()
- :outertype: Semaphore
-
- Returns the semaphore capacity
-
-nativeInit
-^^^^^^^^^^
-
-.. java:method:: public static native void nativeInit()
- :outertype: Semaphore
-
- Class initializer, to initialize various JNI stuff
-
-release
-^^^^^^^
-
-.. java:method:: public native void release()
- :outertype: Semaphore
-
- Releases the semaphore object
-
-wouldBlock
-^^^^^^^^^^
-
-.. java:method:: public native boolean wouldBlock()
- :outertype: Semaphore
-
- returns a boolean indicating it this semaphore would block at this very specific time Note that the returned value may be wrong right after the function call, when you try to use it... But that's a classical semaphore issue, and SimGrid's semaphores are not different to usual ones here.
-
+++ /dev/null
-class org.simgrid.msg.Storage
-=============================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class Storage
-
-Fields
-------
-name
-^^^^
-
-.. java:field:: protected String name
- :outertype: Storage
-
- Storage name
-
-Methods
--------
-all
-^^^
-
-.. java:method:: public static native Storage[] all()
- :outertype: Storage
-
- This static method returns all of the storages of the installed platform.
-
- :return: An array containing all the storages installed.
-
-getByName
-^^^^^^^^^
-
-.. java:method:: public static native Storage getByName(String name) throws HostNotFoundException, StorageNotFoundException
- :outertype: Storage
-
- This static method gets a storage instance associated with a native storage of your platform. This is the best way to get a java storage object.
-
- :param name: The name of the storage to get.
- :throws StorageNotFoundException: if the name of the storage is not valid.
- :return: The storage object with the given name.
-
-getFreeSize
-^^^^^^^^^^^
-
-.. java:method:: public native long getFreeSize()
- :outertype: Storage
-
- This method returns the free size (in bytes) of a storage element.
-
- :return: The free size (in bytes) of the storage element.
-
-getHost
-^^^^^^^
-
-.. java:method:: public native String getHost()
- :outertype: Storage
-
- Returns the host name the storage is attached to
-
- :return: the host name the storage is attached to
-
-getName
-^^^^^^^
-
-.. java:method:: public String getName()
- :outertype: Storage
-
- This method returns the name of a storage.
-
- :return: The name of the storage.
-
-getProperty
-^^^^^^^^^^^
-
-.. java:method:: public native String getProperty(String name)
- :outertype: Storage
-
- Returns the value of a given storage property.
-
-getSize
-^^^^^^^
-
-.. java:method:: public native long getSize()
- :outertype: Storage
-
- This method returns the size (in bytes) of a storage element.
-
- :return: The size (in bytes) of the storage element.
-
-getUsedSize
-^^^^^^^^^^^
-
-.. java:method:: public native long getUsedSize()
- :outertype: Storage
-
- This method returns the used size (in bytes) of a storage element.
-
- :return: The used size (in bytes) of the storage element.
-
-nativeInit
-^^^^^^^^^^
-
-.. java:method:: public static native void nativeInit()
- :outertype: Storage
-
- Class initializer, to initialize various JNI stuff
-
-setProperty
-^^^^^^^^^^^
-
-.. java:method:: public native void setProperty(String name, String value)
- :outertype: Storage
-
- Change the value of a given storage property.
-
-toString
-^^^^^^^^
-
-.. java:method:: @Override public String toString()
- :outertype: Storage
-
+++ /dev/null
-class org.simgrid.msg.StorageNotFoundException
-==============================================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class StorageNotFoundException extends MsgException
-
- Exception raised when looking for a non-existing storage.
-
-Constructors
-------------
-StorageNotFoundException
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public StorageNotFoundException()
- :outertype: StorageNotFoundException
-
- Constructs an \ ``StorageNotFoundException``\ without a detail message.
-
-StorageNotFoundException
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public StorageNotFoundException(String s)
- :outertype: StorageNotFoundException
-
- Constructs an \ ``StorageNotFoundException``\ with a detail message.
-
+++ /dev/null
-class org.simgrid.msg.Task
-==========================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class Task
-
- A task is either something to compute somewhere, or something to exchange between two hosts (or both). It is defined by a computing amount and a message size.
-
-Fields
-------
-name
-^^^^
-
-.. java:field:: protected String name
- :outertype: Task
-
- Task name
-
-Constructors
-------------
-Task
-^^^^
-
-.. java:constructor:: public Task()
- :outertype: Task
-
- Default constructor (all fields to 0 or null)
-
-Task
-^^^^
-
-.. java:constructor:: public Task(String name, double flopsAmount, double bytesAmount)
- :outertype: Task
-
- Construct a new task with the specified processing amount and amount of data needed.
-
- :param name: Task's name
- :param flopsAmount: A value of the processing amount (in flop) needed to process the task. If 0, then it cannot be executed with the execute() method. This value has to be ≥ 0.
- :param bytesAmount: A value of amount of data (in bytes) needed to transfert this task. If 0, then it cannot be transferred with the get() and put() methods. This value has to be ≥ 0.
-
-Task
-^^^^
-
-.. java:constructor:: public Task(String name, Host[] hosts, double[] flopsAmount, double[] bytesAmount)
- :outertype: Task
-
- Construct a new parallel task with the specified processing amount and amount for each host implied.
-
- :param name: The name of the parallel task.
- :param hosts: The list of hosts implied by the parallel task.
- :param flopsAmount: The amount of operations to be performed by each host of hosts. flopsAmount[i] is the total number of operations that have to be performed on hosts[i].
- :param bytesAmount: A matrix describing the amount of data to exchange between hosts. The length of this array must be hosts.length * hosts.length. It is actually used as a matrix with the lines being the source and the columns being the destination of the communications.
-
-Methods
--------
-cancel
-^^^^^^
-
-.. java:method:: public native void cancel()
- :outertype: Task
-
- Cancels a task.
-
-dsend
-^^^^^
-
-.. java:method:: public native void dsend(String mailbox)
- :outertype: Task
-
- Send the task asynchronously on the specified mailbox, with no way to retrieve whether the communication succeeded or not
-
-dsendBounded
-^^^^^^^^^^^^
-
-.. java:method:: public native void dsendBounded(String mailbox, double maxrate)
- :outertype: Task
-
- Send the task asynchronously on the specified mailbox, with no way to retrieve whether the communication succeeded or not
-
-execute
-^^^^^^^
-
-.. java:method:: public native void execute() throws HostFailureException, TaskCancelledException
- :outertype: Task
-
- Executes a task on the location on which the current process is running.
-
- :throws HostFailureException:
- :throws TaskCancelledException:
-
-finalize
-^^^^^^^^
-
-.. java:method:: @Deprecated @Override protected void finalize() throws Throwable
- :outertype: Task
-
- Deletes a task once the garbage collector reclaims it
-
-getFlopsAmount
-^^^^^^^^^^^^^^
-
-.. java:method:: public native double getFlopsAmount()
- :outertype: Task
-
- Gets the remaining amount of flops to execute in this task If it's ongoing, you get the exact amount at the present time. If it's already done, it's 0.
-
-getMessageSize
-^^^^^^^^^^^^^^
-
-.. java:method:: public double getMessageSize()
- :outertype: Task
-
-getName
-^^^^^^^
-
-.. java:method:: public String getName()
- :outertype: Task
-
- Gets the name of the task
-
-getSender
-^^^^^^^^^
-
-.. java:method:: public native Process getSender()
- :outertype: Task
-
- Gets the sender of the task (or null if not sent yet)
-
-getSource
-^^^^^^^^^
-
-.. java:method:: public native Host getSource()
- :outertype: Task
-
- Gets the source of the task (or null if not sent yet).
-
-irecv
-^^^^^
-
-.. java:method:: public static native Comm irecv(String mailbox)
- :outertype: Task
-
- Starts listening for receiving a task from an asynchronous communication
-
- :param mailbox:
- :return: a Comm handler
-
-irecvBounded
-^^^^^^^^^^^^
-
-.. java:method:: public static native Comm irecvBounded(String mailbox, double rate)
- :outertype: Task
-
- Starts listening for receiving a task from an asynchronous communication with a capped rate
-
- :param mailbox:
- :return: a Comm handler
-
-isend
-^^^^^
-
-.. java:method:: public native Comm isend(String mailbox)
- :outertype: Task
-
- Sends the task on the mailbox asynchronously
-
-isendBounded
-^^^^^^^^^^^^
-
-.. java:method:: public native Comm isendBounded(String mailbox, double maxrate)
- :outertype: Task
-
- Sends the task on the mailbox asynchronously (capping the sending rate to \a maxrate)
-
-listen
-^^^^^^
-
-.. java:method:: public static native boolean listen(String mailbox)
- :outertype: Task
-
- Listen whether there is a task waiting (either for a send or a recv) on the mailbox identified by the specified alias
-
-listenFrom
-^^^^^^^^^^
-
-.. java:method:: public static native int listenFrom(String mailbox)
- :outertype: Task
-
- Tests whether there is a pending communication on the mailbox identified by the specified alias, and who sent it
-
-nativeFinalize
-^^^^^^^^^^^^^^
-
-.. java:method:: protected native void nativeFinalize()
- :outertype: Task
-
-nativeInit
-^^^^^^^^^^
-
-.. java:method:: public static native void nativeInit()
- :outertype: Task
-
- Class initializer, to initialize various JNI stuff
-
-receive
-^^^^^^^
-
-.. java:method:: public static Task receive(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Task
-
- Retrieves next task on the mailbox identified by the specified alias
-
- :param mailbox:
- :return: a Task
-
-receive
-^^^^^^^
-
-.. java:method:: public static native Task receive(String mailbox, double timeout) throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Task
-
- Retrieves next task on the mailbox identified by the specified alias (wait at most \a timeout seconds)
-
- :param mailbox:
- :param timeout:
- :return: a Task
-
-receiveBounded
-^^^^^^^^^^^^^^
-
-.. java:method:: public static Task receiveBounded(String mailbox, double rate) throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Task
-
- Retrieves next task from the mailbox identified by the specified name with a capped rate
-
- :param mailbox:
- :return: a Task
-
-receiveBounded
-^^^^^^^^^^^^^^
-
-.. java:method:: public static native Task receiveBounded(String mailbox, double timeout, double rate) throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Task
-
- Retrieves next task on the mailbox identified by the specified name (wait at most \a timeout seconds) with a capped rate
-
- :param mailbox:
- :param timeout:
- :return: a Task
-
-send
-^^^^
-
-.. java:method:: public void send(String mailbox) throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Task
-
- Sends the task on the specified mailbox
-
- :param mailbox: where to send the message
- :throws TimeoutException:
- :throws HostFailureException:
- :throws TransferFailureException:
-
-send
-^^^^
-
-.. java:method:: public void send(String mailbox, double timeout) throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Task
-
- Sends the task on the specified mailbox (wait at most \a timeout seconds)
-
- :param mailbox: where to send the message
- :param timeout:
- :throws TimeoutException:
- :throws HostFailureException:
- :throws TransferFailureException:
-
-sendBounded
-^^^^^^^^^^^
-
-.. java:method:: public void sendBounded(String mailbox, double maxrate) throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Task
-
- Sends the task on the specified mailbox (capping the sending rate to \a maxrate)
-
- :param mailbox: where to send the message
- :param maxrate:
- :throws TransferFailureException:
- :throws HostFailureException:
- :throws TimeoutException:
-
-sendBounded
-^^^^^^^^^^^
-
-.. java:method:: public native void sendBounded(String mailbox, double timeout, double maxrate) throws TransferFailureException, HostFailureException, TimeoutException
- :outertype: Task
-
- Sends the task on the specified mailbox (capping the sending rate to \a maxrate) with a timeout
-
- :param mailbox: where to send the message
- :param timeout:
- :param maxrate:
- :throws TransferFailureException:
- :throws HostFailureException:
- :throws TimeoutException:
-
-setBound
-^^^^^^^^
-
-.. java:method:: public native void setBound(double bound)
- :outertype: Task
-
- Changes the maximum CPU utilization of a computation task. Unit is flops/s.
-
-setBytesAmount
-^^^^^^^^^^^^^^
-
-.. java:method:: public native void setBytesAmount(double bytesAmount)
- :outertype: Task
-
- Set the amount of bytes to exchange the task Warning if the communication is already started and ongoing, this call does nothing.
-
- :param bytesAmount: the size of the task
-
-setFlopsAmount
-^^^^^^^^^^^^^^
-
-.. java:method:: public native void setFlopsAmount(double flopsAmount)
- :outertype: Task
-
- Set the computation amount needed to process the task Warning if the execution is already started and ongoing, this call does nothing.
-
- :param flopsAmount: the amount of computation needed to process the task
-
-setName
-^^^^^^^
-
-.. java:method:: public native void setName(String name)
- :outertype: Task
-
- Sets the name of the task
-
- :param name: the new task name
-
-setPriority
-^^^^^^^^^^^
-
-.. java:method:: public native void setPriority(double priority)
- :outertype: Task
-
- This method sets the priority of the computation of the task. The priority doesn't affect the transfer rate. For example a priority of 2 will make the task receive two times more cpu than the other ones.
-
- :param priority: The new priority of the task.
-
+++ /dev/null
-class org.simgrid.msg.TaskCancelledException
-============================================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class TaskCancelledException extends MsgException
-
- Exception raised when a task is cancelled.
-
-Constructors
-------------
-TaskCancelledException
-^^^^^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public TaskCancelledException()
- :outertype: TaskCancelledException
-
- Constructs an \ ``TaskCancelledException``\ without a detail message.
-
-TaskCancelledException
-^^^^^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public TaskCancelledException(String s)
- :outertype: TaskCancelledException
-
- Constructs an \ ``TaskCancelledException``\ with a detail message.
-
+++ /dev/null
-class org.simgrid.msg.TimeoutException
-======================================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class TimeoutException extends MsgException
-
- Exception raised when sending a task timeouts
-
-Constructors
-------------
-TimeoutException
-^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public TimeoutException()
- :outertype: TimeoutException
-
- Constructs an \ ``TimeoutFailureException``\ without a detail message.
-
-TimeoutException
-^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public TimeoutException(String s)
- :outertype: TimeoutException
-
- Constructs an \ ``TransferFailureException``\ with a detail message.
-
+++ /dev/null
-class org.simgrid.msg.TransferFailureException
-==============================================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class TransferFailureException extends MsgException
-
- Exception raised if sending a task fails
-
-Constructors
-------------
-TransferFailureException
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public TransferFailureException()
- :outertype: TransferFailureException
-
- Constructs an \ ``TransferFailureException``\ without a detail message.
-
-TransferFailureException
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. java:constructor:: public TransferFailureException(String s)
- :outertype: TransferFailureException
-
- Constructs an \ ``TransferFailureException``\ with a detail message.
-
- :param s: the detail message.
-
+++ /dev/null
-class org.simgrid.msg.VM
-========================
-
-.. java:package:: org.simgrid.msg
- :noindex:
-
-.. java:type:: public class VM extends Host
-
-Constructors
-------------
-VM
-^^
-
-.. java:constructor:: public VM(Host host, String name)
- :outertype: VM
-
- Create a `basic` VM : 1 core and 1GB of RAM.
-
- :param host: Host node
- :param name: name of the machine
-
-VM
-^^
-
-.. java:constructor:: public VM(Host host, String name, int coreAmount)
- :outertype: VM
-
- Create a VM without useless values (for humans)
-
- :param host: Host node
- :param name: name of the machine
- :param coreAmount: the amount of cores of the VM
-
-VM
-^^
-
-.. java:constructor:: public VM(Host host, String name, int ramSize, int migNetSpeed, int dpIntensity)
- :outertype: VM
-
- Create a VM with 1 core
-
- :param host: Host node
- :param name: name of the machine
- :param ramSize: size of the RAM that should be allocated (in MBytes)
- :param migNetSpeed: (network bandwidth allocated for migrations in MB/s, if you don't know put zero ;))
- :param dpIntensity: (dirty page percentage according to migNetSpeed, [0-100], if you don't know put zero ;))
-
-VM
-^^
-
-.. java:constructor:: public VM(Host host, String name, int coreAmount, int ramSize, int migNetSpeed, int dpIntensity)
- :outertype: VM
-
- Create a VM
-
- :param host: Host node
- :param name: name of the machine
- :param coreAmount: the amount of cores of the VM
- :param ramSize: size of the RAM that should be allocated (in MBytes)
- :param migNetSpeed: (network bandwidth allocated for migrations in MB/s, if you don't know put zero ;))
- :param dpIntensity: (dirty page percentage according to migNetSpeed, [0-100], if you don't know put zero ;))
-
-Methods
--------
-all
-^^^
-
-.. java:method:: public static native VM[] all()
- :outertype: VM
-
- Retrieve the list of all existing VMs
-
-destroy
-^^^^^^^
-
-.. java:method:: public native void destroy()
- :outertype: VM
-
- Shutdown and unref the VM.
-
-finalize
-^^^^^^^^
-
-.. java:method:: @Deprecated @Override protected void finalize() throws Throwable
- :outertype: VM
-
- Make sure that the GC also destroys the C object
-
-getCoreAmount
-^^^^^^^^^^^^^
-
-.. java:method:: public int getCoreAmount()
- :outertype: VM
-
- Returns the amount of virtual CPUs provided
-
-getVMByName
-^^^^^^^^^^^
-
-.. java:method:: public static native VM getVMByName(String name)
- :outertype: VM
-
- Retrieve a VM from its name
-
-isCreated
-^^^^^^^^^
-
-.. java:method:: public native int isCreated()
- :outertype: VM
-
- Returns whether the given VM is currently suspended
-
-isMigrating
-^^^^^^^^^^^
-
-.. java:method:: public native int isMigrating()
- :outertype: VM
-
- Returns whether the given VM is currently running
-
-isRunning
-^^^^^^^^^
-
-.. java:method:: public native int isRunning()
- :outertype: VM
-
- Returns whether the given VM is currently running
-
-isSuspended
-^^^^^^^^^^^
-
-.. java:method:: public native int isSuspended()
- :outertype: VM
-
- Returns whether the given VM is currently suspended
-
-migrate
-^^^^^^^
-
-.. java:method:: public void migrate(Host destination) throws HostFailureException
- :outertype: VM
-
- Change the host on which all processes are running (pre-copy is implemented)
-
-resume
-^^^^^^
-
-.. java:method:: public native void resume()
- :outertype: VM
-
- Immediately resumes the execution of all processes within the given VM No resume cost occurs. If you want to simulate this too, you want to use a @ref File.read() before or after, depending on the exact semantic of VM resume to you.
-
-setBound
-^^^^^^^^
-
-.. java:method:: public native void setBound(double bound)
- :outertype: VM
-
- Set a CPU bound for a given VM.
-
- :param bound: in flops/s
-
-shutdown
-^^^^^^^^
-
-.. java:method:: public native void shutdown()
- :outertype: VM
-
- Immediately kills all processes within the given VM. No extra delay occurs. If you want to simulate this too, you want to use a MSG_process_sleep()
-
-start
-^^^^^
-
-.. java:method:: public native void start()
- :outertype: VM
-
- start the VM
-
-suspend
-^^^^^^^
-
-.. java:method:: public native void suspend()
- :outertype: VM
-
- Immediately suspend the execution of all processes within the given VM No suspension cost occurs. If you want to simulate this too, you want to use a @ref File.write() before or after, depending on the exact semantic of VM suspend to you.
-
