X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0774c24b97deac8ee62c86f10302c91132803cfb..742090271ef61483a14939c03c5578578da9090b:/doc/doxygen/platform.doc?ds=sidebyside
diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc
index a43c273649..a113880439 100644
--- a/doc/doxygen/platform.doc
+++ b/doc/doxygen/platform.doc
@@ -1,4 +1,4 @@
-/*! \page platform Step 1: %Model the underlying platform
+/*! \page platform %Model the underlying platform
@tableofcontents
@@ -35,10 +35,10 @@ available and very well tested.
The XML checking is done based on the Document Type Definition (DTD) file,
available at
-http://simgrid.gforge.inria.fr/simgrid.dtd.
+http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd.
If you read the DTD, you should notice the following:
-\li The platform tags contain a version attribute; the current version is 3.
+\li The platform tags contain a version attribute; the current version is 4.
This property might be used in the future to provide backwards
compatibility.
\li The DTD contains definitions for the two files used by SimGrid (i.e.,
@@ -206,8 +206,8 @@ and a separate text file whose syntax is exemplified below.
#### Adding a trace file ####
\verbatim
-
-
+
+
\endverbatim
@@ -241,8 +241,8 @@ It is also possible to specify whether the host is up or down by setting the
#### Example: Expliciting the default value "ON" ####
\verbatim
-
-
+
+
\endverbatim
@@ -259,8 +259,8 @@ of such a file is presented below.
#### Adding a state file ####
\verbatim
-
-
+
+
\endverbatim
@@ -339,6 +339,7 @@ sharing_policy | no | string | Sharing policy for the links between node
bb_bw | no | int | Bandwidth for backbone (if any). See link section for syntax/details. If bb_bw and bb_lat (see below) attributes are omitted, no backbone is created (alternative cluster architecture described before).
bb_lat | no | int | Latency for backbone (if any). See link section for syntax/details. If bb_lat and bb_bw (see above) attributes are omitted, no backbone is created (alternative cluster architecture described before).
bb_sharing_policy | no | string | Sharing policy for the backbone (if any). See link section for syntax/details.
+limiter_link | no | int | Bandwidth for limiter link (if any). This adds a specific link for each node, to set the maximum bandwidth reached when communicating in both directions at the same time. In theory this value should be 2*bw for fullduplex links, but in reality this might be less. This value will depend heavily on the communication model, and on the cluster's hardware, so no default value can be set, this has to be measured. More details can be obtained in "Toward Better Simulation of MPI Applications on Ethernet/TCP Networks"
availability_file | no | string | Allows you to use a file as input for availability. Similar to hosts attribute.
state_file | no | string | Allows you to use a file as input for states. Similar to hosts attribute.
loopback_bw | no | int | Bandwidth for loopback (if any). See link section for syntax/details. If loopback_bw and loopback_lat (see below) attributes are omitted, no loopback link is created and all intra-node communication will use the main network link of the node. Loopback link is a \ref pf_sharing_policy_fatpipe "\b FATPIPE".
@@ -1560,7 +1561,7 @@ Tag name | Description | Documentation
\verbatim
-
+
@@ -1607,7 +1608,7 @@ each of them will then be usable.
\verbatim
-
+
@@ -1709,8 +1710,7 @@ non-intuitive schema ... Something like that :
+ gw_dst="c_4_2-cl_4_2_router">
@@ -1718,16 +1718,14 @@ non-intuitive schema ... Something like that :
+ gw_dst="router_4">
+ gw_dst="router_4">
@@ -1753,16 +1751,16 @@ complicated in using it, here is an example of it:
\verbatim
-
+
-
-
+
+
...
-
+
\endverbatim
@@ -1776,7 +1774,7 @@ That is for example what is commonly done when using peers (see Section \ref pf_
\verbatim
-
+
@@ -1863,7 +1861,7 @@ id="3"/></route>), without trying to build new routes by aggregating
the provided ones.
You are also free to declare platform where the routing is not
-symmetric. For example, add the following to the previous file:
+symmetrical. For example, add the following to the previous file:
\verbatim
@@ -1896,7 +1894,7 @@ FleXML parser are close to classical SAX parsers. It means that a
well-formed SimGrid platform XML file might result in the following
"events":
- - start "platform_description" with attribute version="2"
+ - start "platform_description" with attribute version="4"
- start "host" with attributes id="host1" power="1.0"
- end "host"
- start "host" with attributes id="host2" power="2.0"