@tableofcontents
+\htmlonly
+<div align="center">
+\endhtmlonly
+\htmlinclude graphical-toc.svg
+\htmlonly
+</div>
+<script>
+document.getElementById("Deployment").style="opacity:0.93999999;fill:#ff0000;fill-opacity:0.1;stroke:#000000;stroke-width:0.35277778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1";
+</script>
+\endhtmlonly
+
Once you've specified your @ref platform "virtual platform" and the
@ref application "application" you want to study, you must describe
the mapping of the application onto the platform. This page says how
There is two ways to specify the mapping of your program onto virtual
hosts: either directly from your program (with @ref MSG_process_create
-or as in @ref s4u_ex_basics "this S4U example"), or using an external
+or as in @ref s4u_ex_actors_start "this S4U example"), or using an external
XML file. You should really logically separate your application from
the deployment, as it will ease your experimental campain afterward.
How exactly you organize your work remains up to you.
@section deploy_s4u Deployment with S4U
The following example shows the several ways of doing so in the S4U
-interface: @ref examples/s4u/actor-create/s4u_actor-create.cpp.
-Associated XML file: @ref examples/s4u/actor-create/s4u_actor-create_d.xml
+interface: @ref examples/s4u/actor-create/s4u-actor-create.cpp.
+Associated XML file: @ref examples/s4u/actor-create/s4u-actor-create_d.xml
@section deploy_msg Deployment with MSG
@section deploy_xml Deployment with XML
-Deploying processes from XML is easy. This section presents a complete
+Deploying actors from XML is easy. This section presents a complete
example and the reference guide of the involved tags.
The deployment file looks just like a @ref platform "platform" file,
with only 3 tags used:
- - @c <process> starts a new actor on a given host;
+ - @c <actor> starts a new actor on a given host;
- @c <argument> passes a given argument in the argv of an actor
(the list of arguments is ordered);
- @c <prop> adds a property to the actor.
<!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
<platform version="4">
<!-- Alice, which runs on the machine named 'host1', does not take any parameter -->
- <process host="host1" function="alice" />
+ <actor host="host1" function="alice" />
<!-- Bob, which runs on 'host2', has 2 parameters "3" and "3000" in its argv -->
- <process host="host2" function="bob" />
+ <actor host="host2" function="bob" />
<argument value="3"/>
<argument value="3000"/>
- </process>
+ </actor>
<!-- Carole runs on 'host3', has 1 parameter "42" in its argv and one property -->
<!-- See MSG_process_get_property_value() to retrieve this property -->
- <process host="host3" function="carole">
+ <actor host="host3" function="carole">
<argument value="42"/>
<prop id="SomeProp" value="SomeValue"/>
- </process>
+ </actor>
</platform>
@endverbatim
-@subsection deploy_xml_process The process tag
+@subsection deploy_xml_actor The actor tag
-<process> starts a new actor on a given host. It specifies which
+<actor> starts a new actor on a given host. It specifies which
function (from your application) gets executed on the host. Hence, the
@c host and @c function attributes are mandatory, but this tag accepts
some optional attributes too.
| function | yes | String | Name of the function (from your own code) that will be executed. See @ref deploy_xml_functions. |
| start_time | no | int | The simulated time when this actor will be started (Default: ASAP). |
| kill_time | no | int | The simulated time when this actor will be forcefully stopped (Default: never). |
-| on_failure | no | DIE\|RESTART | What should be done when the process fails (Default: die). |
+| on_failure | no | DIE\|RESTART | What should be done when the actor fails (Default: die). |
@subsection deploy_xml_argument The argument tag
-This tag (which must be enclosed in a @c <process> tag) adds a
+This tag (which must be enclosed in a @c <actor> tag) adds a
new string to the parameter list received by your actor (either its @c
argv array in MSG or its @c args vector in S4U). Naturally, the
semantic of these parameters completely depend on your program.
@subsection deploy_xml_prop The prop tag
-This tag (which must be enclosed in a @c <process> tag) adds a
-new property to your actor.
-
-(either its @c
-argv array in MSG or its @c args vector in S4U). Naturally, the
-semantic of these parameters completely depend on your program.
+This tag (which must be enclosed in a @c <actor> tag) adds a new
+property to your actor. You can retrieve these properties with
+MSG_process_get_property_value() or simgrid::s4u::Actor::property().
+Naturally, the semantic of these parameters completely depend on your
+program.
| Attribute name | Mandatory | Values | Description |
| --------------- | --------- | ---------------------- | ----------- |
@subsection deploy_xml_functions Declaring startable functions
You need to connect your code to the names that you use in the XML
-deployment file. Depends on the interface you use, this is done with
+deployment file. Depending on the interface you use, this is done with
MSG_process_create() or simgrid::s4u::Engine::registerFunction().
There is nothing to do in your **Java code** since SimGrid uses
the Java introspection abilities to retrieve the classes from their
