Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
1928aacd73e2f1da62b207373a43e40c6ddda8b5
[simgrid.git] / doc / doxygen / platform.doc
1 /*! \page platform Describing the virtual platform
2
3 @tableofcontents
4
5 As @ref starting_components "explained in the introduction," any
6 SimGrid study must entail the description of the platform on which you
7 want to simulate your application. You have to describe **each element
8 of your platform**, such as computing hosts, clusters, each disks,
9 links, etc. You must also define the **routing on your platform**, ie
10 which path is taken between two hosts. Finally, you may also describe
11 an **experimental scenario**, with qualitative changes (e.g.,
12 bandwidth changes representing an external load) and qualitative
13 changes (representing how some elements fail and restart over time).
14
15 You should really separate your application from the platform
16 description, as it will ease your experimental campain afterward.
17 Mixing them is seen as a really bad experimental practice. The easiest
18 to enforce this split is to put the platform description in a XML
19 file. Many example platforms are provided in the archive, and this
20 page gives all needed details to write such files, as well as some
21 hints and tricks about describing your platform.
22
23 On the other side, XML is sometimes not expressive enough for some
24 platforms, in particular large platforms exhibiting repetitive
25 patterns that are not simply expressed in XML.  In practice, many
26 users end up generating their XML platform files from some sort of
27 scripts. It is probably preferable to rewrite your XML @ref
28 platform_lua "platform using the lua scripting language" instead.
29 In the future, it should be possible to describe the platform directly
30 in C++, but this is not possible yet.
31
32 As usual, SimGrid is a versatile framework, and you should find the
33 way of describing your platform that best fits your experimental
34 practice. 
35
36 \section pf_overview Describing the platform with XML
37
38 Your platform description should follow the specification presented in
39 the [simgrid.dtd](http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd)
40 DTD file. The same DTD is used for both the platform and deployment
41 files.
42
43 From time to time, this DTD evolves to introduce possibly
44 backward-incompatible changes. That is why each platform desciption is
45 enclosed within a @c platform tag, that have a @c version attribute. 
46 The current version is <b>4.1</b>. The @c simgrid_update_xml program can
47 upgrade most of the past platform files to the recent formalism.
48
49 \section pf_first_example First Platform Example 
50
51 Here is a very simple platform file, containing 3 resources (two hosts
52 and one link), and explicitly giving the route between the hosts.
53
54 \code{.xml}
55 <?xml version='1.0'?>
56 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
57 <platform version="4.1">
58   <zone id="first zone" routing="Full">
59     <!-- the resources -->
60     <host id="host1" speed="1Mf"/>
61     <host id="host2" speed="2Mf"/>
62     <link id="link1" bandwidth="125MBps" latency="100us"/>
63     <!-- the routing: specify how the hosts are interconnected -->
64     <route src="host1" dst="host2">
65       <link_ctn id="link1"/>
66     </route>
67   </zone>
68 </platform>
69 \endcode
70
71 As we said, the englobing @ref pf_overview "&lt;platform&gt;" tag is
72 used to specify the dtd version used for this file.
73
74 Then, every resource (specified with @ref pf_tag_host, @ref
75 pf_tag_link or others) must be located within a given **networking
76 zone**.  Each zone is in charge of the routing between its
77 resources. It means that when an host wants to communicate with
78 another host of the same zone, it is the zone's duty to find the list
79 of links that are involved in the communication. Here, since the @ref
80 pf_tag_zone tag has **Full** as a **routing attribute**, all routes
81 must be explicitely given using the @ref pf_tag_route and @ref
82 pf_tag_linkctn tags (this @ref pf_rm "routing model" is both simple
83 and inefficient :) It is OK to not specify the route between two
84 hosts, as long as the processes located on them never try to
85 communicate together.
86
87 A zone can contain several zones itself, leading to a hierarchical
88 decomposition of the platform. This can be more efficient (as the
89 inter-zone routing gets factorized with @ref pf_tag_zoneroute), and
90 allows to have more than one routing model in your platform. For
91 example, you could have a coordinate-based routing for the WAN parts
92 of your platforms, a full routing within each datacenter, and a highly
93 optimized routing within each cluster of the datacenter.  In this
94 case, determining the route between two given hosts gets @ref
95 routing_basics "somewhat more complex" but SimGrid still computes
96 these routes for you in a time- and space-efficient manner.
97 Here is an illustration of these concepts:
98
99 ![A hierarchy of networking zones.](AS_hierarchy.png)
100
101 Circles represent processing units and squares represent network
102 routers. Bold lines represent communication links. The zone "AS2"
103 models the core of a national network interconnecting a small flat
104 cluster (AS4) and a larger hierarchical cluster (AS5), a subset of a
105 LAN (AS6), and a set of peers scattered around the world (AS7).
106
107 \section pf_res Resource description
108
109 \subsection pf_res_computing Computing Resources
110
111 \subsubsection pf_tag_host &lt;host&gt;
112
113 An host is the computing resource on which an actor can execute.
114
115 Attribute         | Values                                 | Description
116 ----------------- | -------------------------------------- | -----------
117 id                | String (mandatory)                     | The identifier of the host. facilitates referring to this AS.
118 speed             | double (mandatory)                     | Computational power of every core of this host in FLOPS (must be positive)
119 core              | int (defaults to 1)                    | Number of cores (see @ref howto_multicore)
120 state             | optionally "OFF"                       | If set to OFF, the host is initially turned off.
121 availability_file | File name (optional) | (Relative or absolute) filename to use as input; must contain availability traces for this host. The syntax of this file is defined below.
122 state_file        | File name (optional) |  File to use as a state profile (see @ref howto_churn)
123 coordinates       | String (mandatory when using Vivaldi routing) | The coordinates of this host (see @ref pf_P2P_tags).
124 pstate     | Double (Defaults to 0) | FIXME: Not yet documented.
125
126 #### Included tags ####
127
128  - @ref pf_tag_mount Specifies the storages mounted on that host
129  - @ref pf_tag_prop Specifies a user-defined property of that host, that you can retrieve with MSG_host_get_property_value() or simgrid::s4u::Host::property().
130
131 #### Examples ####
132
133 \code{.xml}
134 <host id="host1" speed="1000000000"/>
135 <host id="host2" speed="1000000000">
136    <prop id="color" value="blue"/>
137    <prop id="rendershape" value="square"/>
138 </host>
139 \endcode
140
141 \anchor pf_host_dynamism
142 ### Expressing dynamism ###
143
144 SimGrid provides mechanisms to change a hosts' availability over
145 time, using the ``availability_file`` attribute to the ``\<host\>`` tag
146 and a separate text file whose syntax is exemplified below.
147
148 #### Adding a trace file ####
149
150 \verbatim
151 <platform version="4">
152   <host id="bob" speed="500Gf" availability_file="bob.trace" />
153 </platform>
154 \endverbatim
155
156 #### Example of "bob.trace" file ####
157
158 ~~~~~~~~~~~~~~{.py}
159 PERIODICITY 1.0
160   0.0 1.0
161   11.0 0.5
162   20.0 0.8
163 ~~~~~~~~~~~~~~
164
165 Let us begin to explain this example by looking at line 2. (Line 1 will become clear soon).
166 The first column describes points in time, in this case, time 0. The second column
167 describes the relative amount of power this host is able to deliver (relative
168 to the maximum performance specified in the ``\<host\>`` tag). (Clearly, the
169 second column needs to contain values that are not smaller than 0 and not larger than 1).
170 In this example, our host will deliver 500 Mflop/s at time 0, as 500 Mflop/s is the
171 maximum performance of this host. At time 11.0, it will
172 deliver half of its maximum performance, i.e., 250 Mflop/s until time 20.0 when it will
173 will start delivering 80\% of its power. In this example, this amounts to 400 Mflop/s.
174
175 Since the periodicity in line 1 was set to be 1.0, i.e., 1 timestep, this host will
176 continue to provide 500 Mflop/s from time 21. From time 32 it will provide 250 MFlop/s and so on.
177
178 \subsubsection pf_tag_cluster &lt;cluster&gt;
179
180 ``<cluster />`` represents a machine-cluster. It is most commonly used
181 when one wants to define many hosts and a network quickly. Technically,
182 ``cluster`` is a meta-tag: <b>from the inner SimGrid point of
183 view, a cluster is a network zone where some optimized routing is defined</b>.
184 The default inner organization of the cluster is as follow:
185
186 \verbatim
187                  __________
188                 |          |
189                 |  router  |
190     ____________|__________|_____________ backbone
191       |   |   |              |     |   |
192     l0| l1| l2|           l97| l96 |   | l99
193       |   |   |   ........   |     |   |
194       |                                |
195     c-0.me                             c-99.me
196 \endverbatim
197
198 Here, a set of <b>host</b>s is defined. Each of them has a <b>link</b>
199 to a central backbone (backbone is a link itself, as a link can
200 be used to represent a switch, see the switch / link section
201 below for more details about it). A <b>router</b> allows to connect a
202 <b>cluster</b> to the outside world. Internally,
203 SimGrid treats a cluster as a network zone containing all hosts: the router is the default
204 gateway for the cluster.
205
206 There is an alternative organization, which is as follows:
207 \verbatim
208                  __________
209                 |          |
210                 |  router  |
211                 |__________|
212                     / | \
213                    /  |  \
214                l0 / l1|   \l2
215                  /    |    \
216                 /     |     \
217             host0   host1   host2
218 \endverbatim
219
220 The principle is the same, except that there is no backbone. This representation
221 can be obtained easily: just do not set the bb_* attributes.
222
223
224 Attribute name  | Mandatory | Values | Description
225 --------------- | --------- | ------ | -----------
226 id              | yes       | string | The identifier of the cluster. Facilitates referring to this cluster.
227 prefix          | yes       | string | Each node of the cluster has to have a name. This name will be prefixed with this prefix.
228 suffix          | yes       | string | Each node of the cluster will be suffixed with this suffix
229 radical         | yes       | string | Regexp used to generate cluster nodes name. Syntax: "10-20" will give you 11 machines numbered from 10 to 20, "10-20;2" will give you 12 machines, one with the number 2, others numbered as before. The produced number is concatenated between prefix and suffix to form machine names.
230 speed           | yes       | int    | Same as the ``speed`` attribute of the ``\<host\>`` tag.
231 core            | no        | int (default: 1) | Same as the ``core`` attribute of the ``\<host\>`` tag.
232 bw              | yes       | int    | Bandwidth for the links between nodes and backbone (if any). See the \ref pf_tag_link "link section" for syntax/details.
233 lat             | yes       | int    | Latency for the links between nodes and backbone (if any). See <b>link</b> section for syntax/details.
234 sharing_policy  | no        | string | Sharing policy for the links between nodes and backbone (if any). See <b>link</b> section for syntax/details.
235 bb_bw           | no        | int    | Bandwidth for backbone (if any). See <b>link</b> section for syntax/details. If bb_bw and bb_lat (see below) attributes are omitted, no backbone is created (alternative cluster architecture <b>described before</b>).
236 bb_lat          | no        | int    | Latency for backbone (if any). See <b>link</b> section for syntax/details. If bb_lat and bb_bw (see above) attributes are omitted, no backbone is created (alternative cluster architecture <b>described before</b>).
237 bb_sharing_policy | no      | string | Sharing policy for the backbone (if any). See <b>link</b> section for syntax/details.
238 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 <a href="https://hal.inria.fr/hal-00919507/"> "Toward Better Simulation of MPI Applications on Ethernet/TCP Networks"</a>
239 loopback_bw       | no      | int    | Bandwidth for loopback (if any). See <b>link</b> 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".
240 loopback_lat      | no      | int    | Latency for loopback (if any). See <b>link</b> section for syntax/details. See loopback_bw for more info.
241 topology          | no      | FLAT\|TORUS\|FAT_TREE\|DRAGONFLY (default: FLAT) | Network topology to use. SimGrid currently supports FLAT (with or without backbone, as described before), <a href="http://en.wikipedia.org/wiki/Torus_interconnect">TORUS </a>, FAT_TREE, and DRAGONFLY attributes for this tag.
242 topo_parameters   | no      | string | Specific parameters to pass for the topology defined in the topology tag. For torus networks, comma-separated list of the number of nodes in each dimension of the torus. Please refer to the specific documentation for \ref simgrid::kernel::routing::FatTreeZone "FatTree NetZone", \ref simgrid::kernel::routing::DragonflyZone "Dragonfly NetZone".
243
244
245 the router name is defined as the resulting String in the following
246 java line of code:
247
248 @verbatim
249 router_name = prefix + clusterId + "_router" + suffix;
250 @endverbatim
251
252
253 #### Cluster example ####
254
255 Consider the following two (and independent) uses of the ``cluster`` tag:
256
257 \verbatim
258 <cluster id="my_cluster_1" prefix="" suffix="" radical="0-262144"
259          speed="1e9" bw="125e6" lat="5E-5"/>
260
261 <cluster id="my_cluster_2" prefix="c-" suffix=".me" radical="0-99"
262          speed="1e9" bw="125e6" lat="5E-5"
263          bb_bw="2.25e9" bb_lat="5E-4"/>
264 \endverbatim
265
266 The second example creates one router and 100 machines with the following names:
267 \verbatim
268 c-my_cluster_2_router.me
269 c-0.me
270 c-1.me
271 c-2.me
272 ...
273 c-99.me
274 \endverbatim
275
276 \subsubsection pf_cabinet &lt;cabinet&gt;
277
278 \note
279     This tag is only available when the routing mode of the network zone
280     is set to ``Cluster``.
281
282 The ``&lt;cabinet /&gt;`` tag is, like the \ref pf_tag_cluster "&lt;cluster&gt;" tag,
283 a meta-tag. This means that it is simply a shortcut for creating a set of (homogenous) hosts and links quickly;
284 unsurprisingly, this tag was introduced to setup cabinets in data centers quickly. Unlike
285 &lt;cluster&gt;, however, the &lt;cabinet&gt; assumes that you create the backbone
286 and routers yourself; see our examples below.
287
288 #### Attributes ####
289
290 Attribute name  | Mandatory | Values | Description
291 --------------- | --------- | ------ | -----------
292 id              | yes       | string | The identifier of the cabinet. Facilitates referring to this cluster.
293 prefix          | yes       | string | Each node of the cabinet has to have a name. This name will be prefixed with this prefix.
294 suffix          | yes       | string | Each node of the cabinet will be suffixed with this suffix
295 radical         | yes       | string | Regexp used to generate cabinet nodes name. Syntax: "10-20" will give you 11 machines numbered from 10 to 20, "10-20;2" will give you 12 machines, one with the number 2, others numbered as before. The produced number is concatenated between prefix and suffix to form machine names.
296 speed           | yes       | int    | Same as the ``speed`` attribute of the \ref pf_tag_host "&lt;host&gt;" tag.
297 bw              | yes       | int    | Bandwidth for the links between nodes and backbone (if any). See the \ref pf_tag_link "link section" for syntax/details.
298 lat             | yes       | int    | Latency for the links between nodes and backbone (if any). See the \ref pf_tag_link "link section" for syntax/details.
299
300 \note
301     Please note that as of now, it is impossible to change attributes such as,
302     amount of cores (always set to 1), the initial state of hosts/links
303     (always set to ON), the sharing policy of the links (always set to \ref pf_sharing_policy_fullduplex "FULLDUPLEX").
304
305 #### Example ####
306
307 The following example was taken from ``examples/platforms/meta_cluster.xml`` and
308 shows how to use the cabinet tag.
309
310 \verbatim
311   <zone  id="my_cluster1"  routing="Cluster">
312     <cabinet id="cabinet1" prefix="host-" suffix=".cluster1"
313       speed="1Gf" bw="125MBps" lat="100us" radical="1-10"/>
314     <cabinet id="cabinet2" prefix="host-" suffix=".cluster1"
315       speed="1Gf" bw="125MBps" lat="100us" radical="11-20"/>
316     <cabinet id="cabinet3" prefix="host-" suffix=".cluster1"
317       speed="1Gf" bw="125MBps" lat="100us" radical="21-30"/>
318
319     <backbone id="backbone1" bandwidth="2.25GBps" latency="500us"/>
320   </zone>
321 \endverbatim
322
323 \note
324    Please note that you must specify the \ref pf_backbone "&lt;backbone&gt;"
325    tag by yourself; this is not done automatically and there are no checks
326    that ensure this backbone was defined.
327
328 The hosts generated in the above example are named host-1.cluster, host-2.cluster1
329 etc.
330
331
332 \subsubsection pf_peer \<peer\> (Vivaldi netzones only)
333
334 This tag represents a peer, as in Peer-to-Peer (P2P) networks. This
335 can only be used in Vivaldi NetZones. It creates the following
336 resources to the NetZone:
337
338 \li A host
339 \li Two links: One for download and one for upload. This is
340     convenient to use and simulate stuff under the last mile model (e.g., ADSL peers).
341 \li It connects the two links to the host
342
343 #### Attributes ####
344
345 Attribute name  | Mandatory | Values | Description
346 --------------- | --------- | ------ | -----------
347 id              | yes       | string | The identifier of the peer. Facilitates referring to this peer.
348 speed           | yes       | int    | See the description of the ``host`` tag for this attribute
349 bw_in           | yes       | int    | Bandwidth of the private downstream link
350 bw_out          | yes       | int    | Bandwidth of the private upstream link
351 coordinates     | no        | string | Coordinates of the gateway for this peer. Example value: 12.8 14.4 6.4
352 sharing_policy  | no        | SHARED\|FULLDUPLEX (default: FULLDUPLEX) | Sharing policy for links. See <b>link</b> description for details.
353 availability_file| no       | string | Availability file for the peer. Same as host availability file. See <b>host</b> description for details.
354 state_file      | no        | string | State file for the peer. Same as host state file. See <b>host</b> description for details.
355
356
357 The communication latency between an host A=(xA,yA,zA) and an host
358 B=(xB,yB,zB) is computed as follows:
359  
360  latency = sqrt( (xA-xB)² + (yA-yB)² ) + zA + zB
361
362 See the documentation of simgrid::kernel::routing::VivaldiZone for
363 details on how the latency is computed from the coordinate, and on the
364 the up and down bandwidth are used.
365
366 \subsection pf_ne Network equipments
367
368 There are two tags at all times available to represent network entities and
369 several other tags that are available only in certain contexts.
370 1. ``<link>``: Represents a entity that has a limited bandwidth, a
371     latency, and that can be shared according to TCP way to share this
372     bandwidth.
373 \remark
374   The concept of links in SimGrid may not be intuitive, as links are not
375   limited to connecting (exactly) two entities; in fact, you can have more than
376   two equipments connected to it. (In graph theoretical terms: A link in
377   SimGrid is not an edge, but a hyperedge)
378
379 2. ``<router/>``: Represents an entity that a message can be routed
380     to, but that is unable to execute any code. In SimGrid, routers have also
381     no impact on the performance: Routers do not limit any bandwidth nor
382     do they increase latency. As a matter of fact, routers are (almost) ignored
383     by the simulator when the simulation has begun.
384
385 3. ``<backbone/>``: This tag is only available when the containing network zone is
386                     used as a cluster (i.e., mode="Cluster")
387
388 \remark
389     If you want to represent an entity like a switch, you must use ``<link>`` (see section). Routers are used
390     to run some routing algorithm and determine routes (see Section \ref pf_routing for details).
391
392 \subsubsection pf_router &lt;router/&gt;
393
394 As said before, <b>router</b> is used only to give some information
395 for routing algorithms. So, it does not have any attributes except :
396
397 #### Attributes ####
398
399 Attribute name  | Mandatory | Values | Description
400 --------------- | --------- | ------ | -----------
401 id              | yes       | string | The identifier of the router to be used when referring to it.
402 coordinates     | no        | string | Must be provided when choosing the Vivaldi, coordinate-based routing model for the network zone the router belongs to. More details can be found in the Section \ref pf_P2P_tags.
403
404 #### Example ####
405
406 \verbatim
407  <router id="gw_dc1_horizdist"/>
408 \endverbatim
409
410 \subsubsection pf_tag_link &lt;link&gt;
411
412 Network links can represent one-hop network connections. They are
413 characterized by their id and their bandwidth; links can (but may not) be subject
414 to latency.
415
416 #### Attributes ####
417
418 Attribute name  | Mandatory | Values | Description
419 --------------- | --------- | ------ | -----------
420 id              | yes       | string | The identifier of the link to be used when referring to it.
421 bandwidth       | yes       | int    | Maximum bandwidth for this link, given in bytes/s
422 latency         | no        | double (default: 0.0) | Latency for this link.
423 sharing_policy  | no        | \ref sharing_policy_shared "SHARED"\|\ref pf_sharing_policy_fatpipe "FATPIPE"\|\ref pf_sharing_policy_fullduplex "FULLDUPLEX" (default: SHARED) | Sharing policy for the link.
424 state           | no        | ON\|OFF (default: ON) | Allows you to to turn this link on or off (working / not working)
425 bandwidth_file  | no        | string | Allows you to use a file as input for bandwidth.
426 latency_file    | no        | string | Allows you to use a file as input for latency.
427 state_file      | no        | string | Allows you to use a file as input for states.
428
429
430 #### Possible shortcuts for ``latency`` ####
431
432 When using the latency attribute, you can specify the latency by using the scientific
433 notation or by using common abbreviations. For instance, the following three tags
434 are equivalent:
435
436 \verbatim
437  <link id="LINK1" bandwidth="125000000" latency="5E-6"/>
438  <link id="LINK1" bandwidth="125000000" latency="5us"/>
439  <link id="LINK1" bandwidth="125000000" latency="0.000005"/>
440 \endverbatim
441
442 Here, the second tag uses "us", meaning "microseconds". Other shortcuts are:
443
444 Name | Abbreviation | Time (in seconds)
445 ---- | ------------ | -----------------
446 Week | w | 7 * 24 * 60 * 60
447 Day  | d | 24 * 60 * 60
448 Hour | h | 60 * 60
449 Minute | m | 60
450 Second | s | 1
451 Millisecond | ms | 0.001 = 10^(-3)
452 Microsecond | us | 0.000001 = 10^(-6)
453 Nanosecond  | ns | 0.000000001 = 10^(-9)
454 Picosecond  | ps | 0.000000000001 = 10^(-12)
455
456 #### Sharing policy ####
457
458 \anchor sharing_policy_shared
459 By default a network link is \b SHARED, i.e., if two or more data flows go
460 through a link, the bandwidth is shared fairly among all data flows. This
461 is similar to the sharing policy TCP uses.
462
463 \anchor pf_sharing_policy_fatpipe
464 On the other hand, if a link is defined as a \b FATPIPE,
465 each flow going through this link will be provided with the complete bandwidth,
466 i.e., no sharing occurs and the bandwidth is only limiting each flow individually.
467 Please note that this is really on a per-flow basis, not only on a per-host basis!
468 The complete bandwidth provided by this link in this mode
469 is ``number_of_flows*bandwidth``, with at most ``bandwidth`` being available per flow.
470
471 Using the FATPIPE mode allows to model backbones that won't affect performance
472 (except latency).
473
474 \anchor pf_sharing_policy_fullduplex
475 The last mode available is \b FULLDUPLEX. This means that SimGrid will
476 automatically generate two links (one carrying the suffix _UP and the other the
477 suffix _DOWN) for each ``<link>`` tag. This models situations when the direction
478 of traffic is important.
479
480 \remark
481   Transfers from one side to the other will interact similarly as
482   TCP when ACK returning packets circulate on the other direction. More
483   discussion about it is available in the description of link_ctn description.
484
485 In other words: The SHARED policy defines a physical limit for the bandwidth.
486 The FATPIPE mode defines a limit for each application,
487 with no upper total limit.
488
489 \remark
490   Tip: By using the FATPIPE mode, you can model big backbones that
491   won't affect performance (except latency).
492
493 #### Example ####
494
495 \verbatim
496  <link id="SWITCH" bandwidth="125000000" latency="5E-5" sharing_policy="FATPIPE" />
497 \endverbatim
498
499 #### Expressing dynamism and failures ####
500
501 Similar to hosts, it is possible to declare links whose state, bandwidth
502 or latency changes over time (see Section \ref pf_host_dynamism for details).
503
504 In the case of network links, the ``bandwidth`` and ``latency`` attributes are
505 replaced by the ``bandwidth_file`` and ``latency_file`` attributes.
506 The following XML snippet demonstrates how to use this feature in the platform
507 file. The structure of the files "link1.bw" and "link1.lat" is shown below.
508
509 \verbatim
510 <link id="LINK1" state_file="link1.fail" bandwidth="80000000" latency=".0001" bandwidth_file="link1.bw" latency_file="link1.lat" />
511 \endverbatim
512
513 \note
514   Even if the syntax is the same, the semantic of bandwidth and latency
515   trace files differs from that of host availability files. For bandwidth and
516   latency, the corresponding files do not
517   express availability as a fraction of the available capacity but directly in
518   bytes per seconds for the bandwidth and in seconds for the latency. This is
519   because most tools allowing to capture traces on real platforms (such as NWS)
520   express their results this way.
521
522 ##### Example of "link1.bw" file #####
523
524 ~~~{.py}
525 PERIODICITY 12.0
526 4.0 40000000
527 8.0 60000000
528 ~~~
529
530 In this example, the bandwidth changes repeatedly, with all changes
531 being repeated every 12 seconds.
532
533 At the beginning of the the simulation, the link's bandwidth is 80,000,000
534 B/s (i.e., 80 Mb/s); this value was defined in the XML snippet above.
535 After four seconds, it drops to 40 Mb/s (line 2), and climbs
536 back to 60 Mb/s after another 4 seconds (line 3). The value does not change any
537 more until the end of the period, that is, after 12 seconds have been simulated).
538 At this point, periodicity kicks in and this behavior is repeated: Seconds
539 12-16 will experience 80 Mb/s, 16-20 40 Mb/s etc.).
540
541 ##### Example of "link1.lat" file #####
542
543 ~~~{.py}
544 PERIODICITY 5.0
545 1.0 0.001
546 2.0 0.01
547 3.0 0.001
548 ~~~
549
550 In this example, the latency varies with a period of 5 seconds.
551 In the xml snippet above, the latency is initialized to be 0.0001s (100µs). This
552 value will be kept during the first second, since the latency_file contains
553 changes to this value at second one, two and three.
554 At second one, the value will be 0.001, i.e., 1ms. One second later it will
555 be adjusted to 0.01 (or 10ms) and one second later it will be set again to 1ms. The
556 value will not change until second 5, when the periodicity defined in line 1
557 kicks in. It then loops back, starting at 100µs (the initial value) for one second.
558
559 #### The ``<prop/>`` tag ####
560
561 Similar to the ``<host>`` tag, a link may also contain the ``<prop/>`` tag; see the host
562 documentation (Section \ref pf_tag_host) for an example.
563
564
565 \subsubsection pf_backbone <backbone/>
566
567 \note
568   This tag is <b>only available</b> when the containing network zone uses the "Cluster" routing mode!
569
570 Using this tag, you can designate an already existing link to be a backbone.
571
572 Attribute name  | Mandatory | Values | Description
573 --------------- | --------- | ------ | -----------
574 id              | yes       | string | Name of the link that is supposed to act as a backbone.
575
576 \subsection pf_storage Storage
577
578 \note
579   This is a prototype version that should evolve quickly, hence this
580   is just some doc valuable only at the time of writing.
581   This section describes the storage management under SimGrid ; nowadays
582   it's only usable with MSG. It relies basically on linux-like concepts.
583   You also may want to have a look to its corresponding section in 
584   @ref msg_file ; access functions are organized as a POSIX-like
585   interface.
586
587 \subsubsection pf_sto_conc Storage - Main Concepts
588
589 The storage facilities implemented in SimGrid help to model (and account for) 
590 storage devices, such as tapes, hard-drives, CD or DVD devices etc. 
591 A typical situation is depicted in the figure below:
592
593 \image html ./webcruft/storage_sample_scenario.png
594 \image latex ./webcruft/storage_sample_scenario.png "storage_sample_scenario" width=\textwidth
595
596 In this figure, two hosts called Bob and Alice are interconnected via a network
597 and each host is physically attached to a disk; it is not only possible for each host to
598 mount the disk they are attached to directly, but they can also mount disks
599 that are in a remote location. In this example, Bob mounts Alice's disk remotely
600 and accesses the storage via the network.
601
602 SimGrid provides 3 different entities that can be used to model setups
603 that include storage facilities:
604
605 Entity name     | Description
606 --------------- | -----------
607 \ref pf_storage_entity_storage_type "storage_type"    | Defines a template for a particular kind of storage (such as a hard-drive) and specifies important features of the storage, such as capacity, performance (read/write), contents, ... Different models of hard-drives use different storage_types (because the difference between an SSD and an HDD does matter), as they differ in some specifications (e.g., different sizes or read/write performance).
608 \ref pf_storage_entity_storage "storage"        | Defines an actual instance of a storage type (disk, RAM, ...); uses a ``storage_type`` template (see line above) so that you don't need to re-specify the same details over and over again.
609 \ref pf_tag_mount "mount"          | Must be wrapped by a \ref pf_tag_host tag; declares which storage(s) this host has mounted and where (i.e., the mountpoint).
610
611
612 \anchor pf_storage_content_file
613 ### %Storage Content File ###
614
615 In order to assess exactly how much time is spent reading from the storage,
616 SimGrid needs to know what is stored on the storage device (identified by distinct (file-)name, like in a file system)
617 and what size this content has.
618
619 \note
620     The content file is never changed by the simulation; it is parsed once
621     per simulation and kept in memory afterwards. When the content of the
622     storage changes, only the internal SimGrid data structures change.
623
624 \anchor pf_storage_content_file_structure
625 #### Structure of a %Storage Content File ####
626
627 Here is an excerpt from two storage content file; if you want to see the whole file, check
628 the file ``examples/platforms/content/storage_content.txt`` that comes with the
629 SimGrid source code.
630
631 SimGrid essentially supports two different formats: UNIX-style filepaths should
632 follow the well known format:
633
634 \verbatim
635 /lib/libsimgrid.so.3.6.2  12710497
636 /bin/smpicc  918
637 /bin/smpirun  7292
638 /bin/smpif2c  1990
639 /bin/simgrid_update_xml  5018
640 /bin/graphicator  66986
641 /bin/simgrid-colorizer  2993
642 /bin/smpiff  820
643 /bin/tesh  356434
644 \endverbatim
645
646 Windows filepaths, unsurprisingly, use the windows style:
647
648 \verbatim
649 \Windows\avastSS.scr 41664
650 \Windows\bfsvc.exe 75264
651 \Windows\bootstat.dat 67584
652 \Windows\CoreSingleLanguage.xml 31497
653 \Windows\csup.txt 12
654 \Windows\dchcfg64.exe 335464
655 \Windows\dcmdev64.exe 93288
656 \endverbatim
657
658 \note
659     The different file formats come at a cost; in version 3.12 (and most likely
660     in later versions, too), copying files from windows-style storages to unix-style
661     storages (and vice versa) is not supported.
662
663 \anchor pf_storage_content_file_create
664 #### Generate a %Storage Content File ####
665
666 If you want to generate a storage content file based on your own filesystem (or at least a filesystem you have access to),
667 try running this command (works only on unix systems):
668
669 \verbatim
670 find . -type f -exec ls -1s --block=1 {} \; 2>/dev/null | awk '{ print $2 " " $1}' > ./content.txt
671 \endverbatim
672
673 \subsubsection pf_storage_entities The Storage Entities
674
675 These are the entities that you can use in your platform files to include
676 storage in your model. See also the list of our \ref pf_storage_example_files "example files";
677 these might also help you to get started.
678
679 \anchor pf_storage_entity_storage_type
680 #### \<storage_type\> ####
681
682 Attribute name  | Mandatory | Values | Description
683 --------------- | --------- | ------ | -----------
684 id              | yes       | string | Identifier of this storage_type; used when referring to it
685 model           | no        | string | In the future, this will allow to change the performance model to use
686 size            | yes       | string | Specifies the amount of available storage space; you can specify storage like "500GiB" or "500GB" if you want. (TODO add a link to all the available abbreviations)
687 content         | yes       | string | Path to a \ref pf_storage_content_file "Storage Content File" on your system. This file must exist.
688
689 This tag must contain some predefined model properties, specified via the &lt;model_prop&gt; tag. Here is a list,
690 see below for an example:
691
692 Property id     | Mandatory | Values | Description
693 --------------- | --------- | ------ | -----------
694 Bwrite          | yes       | string | Bandwidth for write access; in B/s (but you can also specify e.g. "30MBps")
695 Bread           | yes       | string | Bandwidth for read access; in B/s (but you can also specify e.g. "30MBps")
696
697 \note
698      A storage_type can also contain the <b>&lt;prop&gt;</b> tag. The &lt;prop&gt; tag allows you
699      to associate additional information to this &lt;storage_type&gt; and follows the
700      attribute/value schema; see the example below. You may want to use it to give information to
701      the tool you use for rendering your simulation, for example.
702
703 Here is a complete example for the ``storage_type`` tag:
704 \verbatim
705 <storage_type id="single_HDD" size="4000">
706   <model_prop id="Bwrite" value="30MBps" />
707   <model_prop id="Bread" value="100MBps" />
708   <prop id="Brand" value="Western Digital" />
709 </storage_type>
710 \endverbatim
711
712 @subsubsection pf_tag_storage &lt;storage&gt; 
713
714 Attributes     | Mandatory | Values | Description
715 -------------- | --------- | ------ | -----------
716 id             | yes       | string | Identifier of this ``storage``; used when referring to it
717 typeId         | yes       | string | Here you need to refer to an already existing \ref pf_storage_entity_storage_type "\<storage_type\>"; the storage entity defined by this tag will then inherit the properties defined there.
718 attach         | yes       | string | Name of a host (see Section \ref pf_tag_host) to which this storage is <i>physically</i> attached to (e.g., a hard drive in a computer)
719 content        | no        | string | When specified, overwrites the content attribute of \ref pf_storage_entity_storage_type "\<storage_type\>"
720
721 Here are two examples:
722
723 \verbatim
724      <storage id="Disk1" typeId="single_HDD" attach="bob" />
725
726      <storage id="Disk2" typeId="single_SSD"
727               content="content/win_storage_content.txt" />
728 \endverbatim
729
730 The first example is straightforward: A disk is defined and called "Disk1"; it is
731 of type "single_HDD" (shown as an example of \ref pf_storage_entity_storage_type "\<storage_type\>" above) and attached
732 to a host called "bob" (the definition of this host is omitted here).
733
734 The second storage is called "Disk2", is still of the same type as Disk1 but
735 now specifies a new content file (so the contents will be different from Disk1)
736 and the filesystem uses the windows style; finally, it is attached to a second host,
737 called alice (which is again not defined here).
738
739 \subsubsection pf_tag_mount &lt;mount&gt;
740
741 | Attribute   | Mandatory   | Values   | Description                                                                                               |
742 | ----------- | ----------- | -------- | -------------                                                                                             |
743 | id          | yes         | string   | Refers to a \ref pf_storage_entity_storage "&lt;storage&gt;" entity that will be mounted on that computer |
744 | name        | yes         | string   | Path/location to/of the logical reference (mount point) of this disk
745
746 This tag must be enclosed by a \ref pf_tag_host tag. It then specifies where the mountpoint of a given storage device (defined by the ``id`` attribute)
747 is; this location is specified by the ``name`` attribute.
748
749 Here is a simple example, taken from the file ``examples/platform/storage.xml``:
750
751 \verbatim
752     <storage_type id="single_SSD" size="500GiB">
753        <model_prop id="Bwrite" value="60MBps" />
754        <model_prop id="Bread" value="200MBps" />
755     </storage_type>
756
757     <storage id="Disk2" typeId="single_SSD"
758               content="content/win_storage_content.txt"
759               attach="alice" />
760     <storage id="Disk4" typeId="single_SSD"
761              content="content/small_content.txt"
762              attach="denise"/>
763
764     <host id="alice" speed="1Gf">
765       <mount storageId="Disk2" name="c:"/>
766     </host>
767
768     <host id="denise" speed="1Gf">
769       <mount storageId="Disk2" name="c:"/>
770       <mount storageId="Disk4" name="/home"/>
771     </host>
772 \endverbatim
773
774 This example is quite interesting, as the same device, called "Disk2", is mounted by
775 two hosts at the same time! Note, however, that the host called ``alice`` is actually
776 attached to this storage, as can be seen in the \ref pf_storage_entity_storage "&lt;storage&gt;"
777 tag. This means that ``denise`` must access this storage through the network, but SimGrid automatically takes
778 care of that for you.
779
780 Furthermore, this example shows that ``denise`` has mounted two storages with different
781 filesystem types (unix and windows). In general, a host can mount as many storage devices as
782 required.
783
784 \note
785     Again, the difference between ``attach`` and ``mount`` is simply that
786     an attached storage is always physically inside (or connected to) that machine;
787     for instance, a USB stick is attached to one and only one machine (where it's plugged-in)
788     but it can only be mounted on others, as mounted storage can also be a remote location.
789
790 ###### Example files #####
791
792 \verbinclude example_filelist_xmltag_mount
793
794 \subsubsection pf_storage_example_files Example files
795
796 Several examples were already discussed above; if you're interested in full examples,
797 check the the following platforms:
798
799 1. ``examples/platforms/storage.xml``
800 2. ``examples/platforms/remote_io.xml``
801
802 If you're looking for some examplary C code, you may find the source code
803 available in the directory ``examples/msg/io/`` useful.
804
805 \subsubsection pf_storage_examples_modelling Modelling different situations
806
807 The storage functionality of SimGrid is type-agnostic, that is, the implementation
808 does not presume any type of storage, such as HDDs/SSDs, RAM,
809 CD/DVD devices, USB sticks etc.
810
811 This allows the user to apply the simulator for a wide variety of scenarios; one
812 common scenario would be the access of remote RAM.
813
814 #### Modelling the access of remote RAM ####
815
816 How can this be achieved in SimGrid? Let's assume we have a setup where three hosts
817 (HostA, HostB, HostC) need to access remote RAM:
818
819 \verbatim
820       Host A
821     /
822 RAM -- Host B
823     \
824       Host C
825 \endverbatim
826
827 An easy way to model this scenario is to setup and define the RAM via the
828 \ref pf_storage_entity_storage "storage" and \ref pf_storage_entity_storage_type "storage type"
829 entities and attach it to a remote dummy host; then, every host can have their own links
830 to this host (modelling for instance certain scenarios, such as PCIe ...)
831
832 \verbatim
833               Host A
834             /
835 RAM - Dummy -- Host B
836             \
837               Host C
838 \endverbatim
839
840 Now, if read from this storage, the host that mounts this storage
841 communicates to the dummy host which reads from RAM and
842 sends the information back.
843
844
845 \section pf_routing Routing
846
847 To achieve high performance, the routing tables used within SimGrid are
848 static. This means that routing between two nodes is calculated once
849 and will not change during execution. The SimGrid team chose to use this
850 approach as it is rare to have a real deficiency of a resource;
851 most of the time, a communication fails because the links experience too much
852 congestion and hence, your connection stops before the timeout or
853 because the computer designated to be the destination of that message
854 is not responding.
855
856 We also chose to use shortest paths algorithms in order to emulate
857 routing. Doing so is consistent with the reality: [RIP](https://en.wikipedia.org/wiki/Routing_Information_Protocol),
858 [OSPF](https://en.wikipedia.org/wiki/Open_Shortest_Path_First), [BGP](https://en.wikipedia.org/wiki/Border_Gateway_Protocol)
859 are all calculating shortest paths. They do require some time to converge, but
860 eventually, when the routing tables have stabilized, your packets will follow
861 the shortest paths.
862
863 \subsection  pf_tag_zone &lt;zone&gt;
864
865 Before SimGrid v3.16, networking zones used to be called Autonomous
866 Systems, but this was misleading as zones may include other zones in a
867 hierarchical manner. If you find any remaining reference to network
868 zones, please report this as a bug.
869
870 Attribute   | Value                                             | Description
871 ----------- | ------------------------------------------------- | ----------------------------------------------
872 id          | String (mandatory)                                | The identifier of this zone (must be unique)
873 routing     | One of the existing routing algorithm (mandatory) | See Section \ref pf_rm for details.
874
875 <b>Example:</b>
876 \code
877 <zone id="zone0" routing="Full">
878    <host id="host1" speed="1000000000"/>
879    <host id="host2" speed="1000000000"/>
880    <link id="link1" bandwidth="125000000" latency="0.000100"/>
881    <route src="host1" dst="host2"><link_ctn id="link1"/></route>
882 </zone>
883 \endcode
884
885 In this example, zone0 contains two hosts (host1 and host2). The route
886 between the hosts goes through link1.
887
888 \subsection pf_rm Routing models
889
890 For each network zone, you must define explicitly which routing model will
891 be used. There are 3 different categories for routing models:
892
893 1. \ref pf_routing_model_shortest_path "Shortest-path" based models: SimGrid calculates shortest
894    paths and manages them. Behaves more or less like most real life
895    routing mechanisms.
896 2. \ref pf_routing_model_manual "Manually-entered" route models: you have to define all routes
897    manually in the platform description file; this can become
898    tedious very quickly, as it is very verbose.
899    Consistent with some manually managed real life routing.
900 3. \ref pf_routing_model_simple "Simple/fast models": those models offer fast, low memory routing
901    algorithms. You should consider to use this type of model if 
902    you can make some assumptions about your network zone.
903    Routing in this case is more or less ignored.
904
905 \subsubsection pf_raf The router affair
906
907 Using routers becomes mandatory when using shortest-path based
908 models or when using the bindings to the ns-3 packet-level
909 simulator instead of the native analytical network model implemented
910 in SimGrid.
911
912 For graph-based shortest path algorithms, routers are mandatory, because these
913 algorithms require a graph as input and so we need to have source and
914 destination for each edge.
915
916 Routers are naturally an important concept ns-3 since the
917 way routers run the packet routing algorithms is actually simulated.
918 SimGrid's analytical models however simply aggregate the routing time
919 with the transfer time. 
920
921 So why did we incorporate routers in SimGrid? Rebuilding a graph representation
922 only from the route information turns out to be a very difficult task, because
923 of the missing information about how routes intersect. That is why we
924 introduced routers, which are simply used to express these intersection points.
925 It is important to understand that routers are only used to provide topological
926 information.
927
928 To express this topological information, a <b>route</b> has to be
929 defined in order to declare which link is connected to a router. 
930
931
932 \subsubsection pf_routing_model_shortest_path Shortest-path based models
933
934 The following table shows all the models that compute routes using
935 shortest-paths algorithms are currently available in SimGrid. More detail on how
936 to choose the best routing model is given in the Section called \"\ref pf_routing_howto_choose_wisely\".
937
938 | Name                                                | Description                                                                |
939 | --------------------------------------------------- | -------------------------------------------------------------------------- |
940 | \ref pf_routing_model_floyd "Floyd"                 | Floyd routing data. Pre-calculates all routes once                         |
941 | \ref pf_routing_model_dijkstra "Dijkstra"           | Dijkstra routing data. Calculates routes only when needed                  |
942 | \ref pf_routing_model_dijkstracache "DijkstraCache" | Dijkstra routing data. Handles some cache for already calculated routes.   |
943
944 All those shortest-path models are instanciated in the same way and are
945 completely interchangeable. Here are some examples:
946
947 \anchor pf_routing_model_floyd
948 ### Floyd ###
949
950 Floyd example:
951 \verbatim
952 <zone  id="zone0"  routing="Floyd">
953
954   <cluster id="my_cluster_1" prefix="c-" suffix=""
955            radical="0-1" speed="1000000000" bw="125000000" lat="5E-5"
956            router_id="router1"/>
957
958   <zone id="zone1" routing="None">
959     <host id="host1" speed="1000000000"/>
960   </zone>
961
962   <link id="link1" bandwidth="100000" latency="0.01"/>
963
964   <zoneroute src="my_cluster_1" dst="zone1"
965     gw_src="router1"
966     gw_dst="host1">
967     <link_ctn id="link1"/>
968   </zoneroute>
969
970 </zone>
971 \endverbatim
972
973 zoneroute given at the end gives a topological information: link1 is
974 between router1 and host1.
975
976 #### Example platform files ####
977
978 This is an automatically generated list of example files that use the Floyd
979 routing model (the path is given relative to SimGrid's source directory)
980
981 \verbinclude example_filelist_routing_floyd
982
983 \anchor pf_routing_model_dijkstra
984 ### Dijkstra ###
985
986 #### Example platform files ####
987
988 This is an automatically generated list of example files that use the Dijkstra
989 routing model (the path is given relative to SimGrid's source directory)
990
991 \verbinclude example_filelist_routing_dijkstra
992
993 Dijkstra example :
994 \verbatim
995  <zone id="zone_2" routing="Dijkstra">
996      <host id="zone_2_host1" speed="1000000000"/>
997      <host id="zone_2_host2" speed="1000000000"/>
998      <host id="zone_2_host3" speed="1000000000"/>
999      <link id="zone_2_link1" bandwidth="1250000000" latency="5E-4"/>
1000      <link id="zone_2_link2" bandwidth="1250000000" latency="5E-4"/>
1001      <link id="zone_2_link3" bandwidth="1250000000" latency="5E-4"/>
1002      <link id="zone_2_link4" bandwidth="1250000000" latency="5E-4"/>
1003      <router id="central_router"/>
1004      <router id="zone_2_gateway"/>
1005      <!-- routes providing topological information -->
1006      <route src="central_router" dst="zone_2_host1"><link_ctn id="zone_2_link1"/></route>
1007      <route src="central_router" dst="zone_2_host2"><link_ctn id="zone_2_link2"/></route>
1008      <route src="central_router" dst="zone_2_host3"><link_ctn id="zone_2_link3"/></route>
1009      <route src="central_router" dst="zone_2_gateway"><link_ctn id="zone_2_link4"/></route>
1010   </zone>
1011 \endverbatim
1012
1013 \anchor pf_routing_model_dijkstracache
1014 ### DijkstraCache ###
1015
1016 DijkstraCache example:
1017 \verbatim
1018 <zone id="zone_2" routing="DijkstraCache">
1019      <host id="zone_2_host1" speed="1000000000"/>
1020      ...
1021 (platform unchanged compared to upper example)
1022 \endverbatim
1023
1024 #### Example platform files ####
1025
1026 This is an automatically generated list of example files that use the DijkstraCache
1027 routing model (the path is given relative to SimGrid's source directory):
1028
1029 Editor's note: At the time of writing, no platform file used this routing model - so
1030 if there are no example files listed here, this is likely to be correct.
1031
1032 \verbinclude example_filelist_routing_dijkstra_cache
1033
1034 \subsubsection pf_routing_model_manual Manually-entered route models
1035
1036 | Name                               | Description                                                                    |
1037 | ---------------------------------- | ------------------------------------------------------------------------------ |
1038 | \ref pf_routing_model_full "Full"  | You have to enter all necessary routers manually; that is, every single route. This may consume a lot of memory when the XML is parsed and might be tedious to write; i.e., this is only recommended (if at all) for small platforms. |
1039
1040 \anchor pf_routing_model_full
1041 ### Full ###
1042
1043 Full example :
1044 \verbatim
1045 <zone  id="zone0"  routing="Full">
1046    <host id="host1" speed="1000000000"/>
1047    <host id="host2" speed="1000000000"/>
1048    <link id="link1" bandwidth="125000000" latency="0.000100"/>
1049    <route src="host1" dst="host2"><link_ctn id="link1"/></route>
1050  </zone>
1051 \endverbatim
1052
1053 #### Example platform files ####
1054
1055 This is an automatically generated list of example files that use the Full
1056 routing model (the path is given relative to SimGrid's source directory):
1057
1058 \verbinclude example_filelist_routing_full
1059
1060 \subsubsection pf_routing_model_simple Simple/fast models
1061
1062 | Name                                     | Description                                                                                                                         |
1063 | ---------------------------------------- | ------------------------------------------------------------------------------                                                      |
1064 | \ref pf_routing_model_cluster "Cluster"  | This is specific to the \ref pf_tag_cluster "&lt;cluster/&gt;" tag and should not be used by the user, as several assumptions are made. |
1065 | \ref pf_routing_model_none    "None"     | No routing at all. Unless you know what you're doing, avoid using this mode in combination with a non-constant network model.       |
1066 | \ref pf_routing_model_vivaldi "Vivaldi"  | Perfect when you want to use coordinates. Also see the corresponding \ref pf_P2P_tags "P2P section" below.                          |
1067
1068 \anchor pf_routing_model_cluster
1069 ### Cluster ###
1070
1071 \note
1072  In this mode, the \ref pf_cabinet "&lt;cabinet/&gt;" tag is available.
1073
1074 #### Example platform files ####
1075
1076 This is an automatically generated list of example files that use the Cluster
1077 routing model (the path is given relative to SimGrid's source directory):
1078
1079 \verbinclude example_filelist_routing_cluster
1080
1081 \anchor pf_routing_model_none
1082
1083 ### None ###
1084
1085 This model does exactly what it's name advertises: Nothing. There is no routing
1086 available within this model and if you try to communicate within the zone that
1087 uses this model, SimGrid will fail unless you have explicitly activated the
1088 \ref options_model_select_network_constant "Constant Network Model" (this model charges
1089 the same for every single communication). It should
1090 be noted, however, that you can still attach an \ref pf_tag_zoneroute "ZoneRoute",
1091 as is demonstrated in the example below:
1092
1093 \verbinclude platforms/cluster_and_one_host.xml
1094
1095 #### Example platform files ####
1096
1097 This is an automatically generated list of example files that use the None
1098 routing model (the path is given relative to SimGrid's source directory):
1099
1100 \verbinclude example_filelist_routing_none
1101
1102
1103 \anchor pf_routing_model_vivaldi
1104 ### Vivaldi ###
1105
1106 For more information on how to use the [Vivaldi Coordinates](https://en.wikipedia.org/wiki/Vivaldi_coordinates),
1107 see also Section \ref pf_P2P_tags "P2P tags".
1108
1109 Note that it is possible to combine the Vivaldi routing model with other routing models;
1110 an example can be found in the file \c examples/platforms/cloud.xml. This
1111 examples models a NetZone using Vivaldi that contains other NetZones that use different
1112 routing models.
1113
1114 #### Example platform files ####
1115
1116 This is an automatically generated list of example files that use the None
1117 routing model (the path is given relative to SimGrid's source directory):
1118
1119 \verbinclude example_filelist_routing_vivaldi
1120
1121
1122 \subsection ps_dec Defining routes
1123
1124 There are currently four different ways to define routes: 
1125
1126 | Name                                              | Description                                                                         |
1127 | ------------------------------------------------- | ----------------------------------------------------------------------------------- |
1128 | \ref pf_tag_route "route"                 | Used to define route between host/router                                            |
1129 | \ref pf_tag_zoneroute "zoneRoute"             | Used to define route between different zones                                           |
1130 | \ref pf_tag_bypassroute "bypassRoute"     | Used to supersede normal routes as calculated by the network model between host/router; e.g., can be used to use a route that is not the shortest path for any of the shortest-path routing models. |
1131 | \ref pf_tag_bypassasroute "bypassZoneRoute"  | Used in the same way as bypassRoute, but for zones                                     |
1132
1133 Basically all those tags will contain an (ordered) list of references
1134 to link that compose the route you want to define.
1135
1136 Consider the example below:
1137
1138 \verbatim
1139 <route src="Alice" dst="Bob">
1140         <link_ctn id="link1"/>
1141         <link_ctn id="link2"/>
1142         <link_ctn id="link3"/>
1143 </route>
1144 \endverbatim
1145
1146 The route here from host Alice to Bob will be first link1, then link2,
1147 and finally link3. What about the reverse route? \ref pf_tag_route "Route" and
1148 \ref pf_tag_zoneroute "zoneroute" have an optional attribute \c symmetrical, that can
1149 be either \c YES or \c NO. \c YES means that the reverse route is the same
1150 route in the inverse order, and is set to \c YES by default. Note that
1151 this is not the case for bypass*Route, as it is more probable that you
1152 want to bypass only one default route.
1153
1154 For an \ref pf_tag_zoneroute "zoneroute", things are just slightly more complicated, as you have
1155 to give the id of the gateway which is inside the zone you want to access ... 
1156 So it looks like this:
1157
1158 \verbatim
1159 <zoneroute src="zone1" dst="zone2"
1160   gw_src="router1" gw_dst="router2">
1161   <link_ctn id="link1"/>
1162 </zoneroute>
1163 \endverbatim
1164
1165 gw == gateway, so when any message are trying to go from zone1 to zone2,
1166 it means that it must pass through router1 to get out of the zone, then
1167 pass through link1, and get into zone2 by being received by router2.
1168 router1 must belong to zone1 and router2 must belong to zone2.
1169
1170 \subsubsection pf_tag_linkctn &lt;link_ctn&gt;
1171
1172 This entity has only one purpose: Refer to an already existing
1173 \ref pf_tag_link "&lt;link/&gt;" when defining a route, i.e., it
1174 can only occur as a child of \ref pf_tag_route "&lt;route/&gt;"
1175
1176 | Attribute name  | Mandatory | Values | Description                                                   |
1177 | --------------- | --------- | ------ | -----------                                                   |
1178 | id              | yes       | String | The identifier of the link that should be added to the route. |
1179 | direction       | maybe     | UP\|DOWN | If the link referenced by \c id has been declared as \ref pf_sharing_policy_fullduplex "FULLDUPLEX", this indicates which direction the route traverses through this link: UP or DOWN. If you don't use FULLDUPLEX, do not use this attribute or SimGrid will not find the right link.
1180
1181 #### Example Files ####
1182
1183 This is an automatically generated list of example files that use the \c &lt;link_ctn/&gt;
1184 entity (the path is given relative to SimGrid's source directory):
1185
1186 \verbinclude example_filelist_xmltag_linkctn
1187
1188 \subsubsection pf_tag_zoneroute &lt;zoneRoute&gt;
1189
1190 The purpose of this entity is to define a route between two
1191 NetZones. Recall that all zones form a tree, so to connect two
1192 sibiling zones, you must give such a zoneRoute specifying the source
1193 and destination zones, along with the gateway in each zone (ie, the
1194 point to reach within that zone to reach the netzone), and the list of
1195 links in the ancestor zone to go from one zone to another.
1196
1197 So, to go from an host \c src_host that is within zone \c src, to an
1198 host \c dst_host that is within \c dst, you need to:
1199
1200  - move within zone \c src, from \c src_host to the specified \c gw_src;
1201  - traverse all links specified by the zoneRoute (they are supposed to be within the common ancestor);
1202  - move within zone \c dst, from \c gw_dst to \c dst_host.
1203
1204 #### Attributes ####
1205
1206 | Attribute name  | Mandatory | Values | Description                                                                                                                                |
1207 | --------------- | --------- | ------ | -----------                                                                                                                                |
1208 | src             | yes       | String | The identifier of the source zone                                                                                                            |
1209 | dst             | yes       | String | See the \c src attribute                                                                                                                   |
1210 | gw_src          | yes       | String | The gateway that will be used within the src zone; this can be any \ref pf_tag_host "Host" or \ref pf_router "Router" defined within the src zone. |
1211 | gw_dst          | yes       | String | Same as \c gw_src, but with the dst zone instead.                                                                                            |
1212 | symmetrical     | no        | YES\|NO (Default: YES) | If this route is symmetric, the opposite route (from dst to src) will also be declared implicitly.               | 
1213
1214 #### Example ####
1215
1216 \verbatim
1217 <zone  id="zone0"  routing="Full">
1218   <cluster id="my_cluster_1" prefix="c-" suffix=".me"
1219                 radical="0-149" speed="1000000000" bw="125000000" lat="5E-5"
1220         bb_bw="2250000000" bb_lat="5E-4"/>
1221
1222   <cluster id="my_cluster_2" prefix="c-" suffix=".me"
1223     radical="150-299" speed="1000000000" bw="125000000" lat="5E-5"
1224     bb_bw="2250000000" bb_lat="5E-4"/>
1225
1226      <link id="backbone" bandwidth="1250000000" latency="5E-4"/>
1227
1228      <zoneroute src="my_cluster_1" dst="my_cluster_2"
1229          gw_src="c-my_cluster_1_router.me"
1230          gw_dst="c-my_cluster_2_router.me">
1231                 <link_ctn id="backbone"/>
1232      </zoneroute>
1233      <zoneroute src="my_cluster_2" dst="my_cluster_1"
1234          gw_src="c-my_cluster_2_router.me"
1235          gw_dst="c-my_cluster_1_router.me">
1236                 <link_ctn id="backbone"/>
1237      </zoneroute>
1238 </zone>
1239 \endverbatim
1240
1241 \subsubsection pf_tag_route &lt;route&gt; 
1242
1243 The principle is the same as for 
1244 \ref pf_tag_zoneroute "ZoneRoute": The route contains a list of links that
1245 provide a path from \c src to \c dst. Here, \c src and \c dst can both be either a 
1246 \ref pf_tag_host "host" or \ref pf_router "router".  This is mostly useful for the 
1247 \ref pf_routing_model_full "Full routing model" as well as for the 
1248 \ref pf_routing_model_shortest_path "shortest-paths" based models (as they require 
1249 topological information).
1250
1251
1252 | Attribute name  | Mandatory | Values                 | Description                                                                                        |
1253 | --------------- | --------- | ---------------------- | -----------                                                                                        |
1254 | src             | yes       | String                 | The value given to the source's "id" attribute                                                     |
1255 | dst             | yes       | String                 | The value given to the destination's "id" attribute.                                               |
1256 | symmetrical     | no        | YES\| NO (Default: YES) | If this route is symmetric, the opposite route (from dst to src) will also be declared implicitly. |
1257
1258
1259 #### Examples ####
1260
1261 A route in the \ref pf_routing_model_full "Full routing model" could look like this:
1262 \verbatim
1263  <route src="Tremblay" dst="Bourassa">
1264      <link_ctn id="4"/><link_ctn id="3"/><link_ctn id="2"/><link_ctn id="0"/><link_ctn id="1"/><link_ctn id="6"/><link_ctn id="7"/>
1265  </route>
1266 \endverbatim
1267
1268 A route in the \ref pf_routing_model_shortest_path "Shortest-Path routing model" could look like this:
1269 \verbatim
1270 <route src="Tremblay" dst="Bourassa">
1271   <link_ctn id="3"/>
1272 </route>
1273 \endverbatim
1274 \note 
1275     You must only have one link in your routes when you're using them to provide
1276     topological information, as the routes here are simply the edges of the
1277     (network-)graph and the employed algorithms need to know which edge connects
1278     which pair of entities.
1279
1280 \subsubsection pf_tag_bypassasroute bypasszoneroute
1281
1282 As said before, once you choose
1283 a model, it (most likely; the constant network model, for example, doesn't) calculates routes for you. But maybe you want to
1284 define some of your routes, which will be specific. You may also want
1285 to bypass some routes defined in lower level zone at an upper stage:
1286 <b>bypasszoneroute</b> is the tag you're looking for. It allows to
1287 bypass routes defined between already defined between zone (if you want
1288 to bypass route for a specific host, you should just use byPassRoute).
1289 The principle is the same as zoneroute : <b>bypasszoneroute</b> contains
1290 list of links that are in the path between src and dst.
1291
1292 #### Attributes ####
1293
1294 | Attribute name  | Mandatory | Values                  | Description                                                                                                  |
1295 | --------------- | --------- | ----------------------  | -----------                                                                                                  |
1296 | src             | yes       | String                  | The value given to the source zone's "id" attribute                                                            |
1297 | dst             | yes       | String                  | The value given to the destination zone's "id" attribute.                                                      |
1298 | gw_src          | yes       | String                  | The value given to the source gateway's "id" attribute; this can be any host or router within the src zone     |
1299 | gw_dst          | yes       | String                  | The value given to the destination gateway's "id" attribute; this can be any host or router within the dst zone|
1300 | symmetrical     | no        | YES\| NO (Default: YES) | If this route is symmetric, the opposite route (from dst to src) will also be declared implicitly. |
1301
1302 #### Example ####
1303
1304 \verbatim
1305 <bypasszoneRoute src="my_cluster_1" dst="my_cluster_2"
1306   gw_src="my_cluster_1_router"
1307   gw_dst="my_cluster_2_router">
1308     <link_ctn id="link_tmp"/>
1309 </bypasszoneroute>
1310 \endverbatim
1311
1312 This example shows that link \c link_tmp (definition not displayed here) directly
1313 connects the router \c my_cluster_1_router in the source cluster to the router
1314 \c my_cluster_2_router in the destination router. Additionally, as the \c symmetrical
1315 attribute was not given, this route is presumed to be symmetrical.
1316
1317 \subsubsection pf_tag_bypassroute bypassRoute
1318
1319 As said before, once you choose
1320 a model, it (most likely; the constant network model, for example, doesn't) calculates routes for you. But maybe you want to
1321 define some of your routes, which will be specific. You may also want
1322 to bypass some routes defined in lower level zone at an upper stage :
1323 <b>bypassRoute</b> is the tag you're looking for. It allows to bypass
1324 routes defined between <b>host/router</b>. The principle is the same
1325 as route : <b>bypassRoute</b> contains list of links references of
1326 links that are in the path between src and dst.
1327
1328 #### Attributes ####
1329
1330 | Attribute name  | Mandatory | Values                  | Description                                                                                                  |
1331 | --------------- | --------- | ----------------------  | -----------                                                                                                  |
1332 | src             | yes       | String                  | The value given to the source zone's "id" attribute                                                            |
1333 | dst             | yes       | String                  | The value given to the destination zone's "id" attribute.                                                      |
1334 | symmetrical     | no        | YES \| NO (Default: YES) | If this route is symmetric, the opposite route (from dst to src) will also be declared implicitly. |
1335
1336 #### Examples ####
1337
1338 \verbatim
1339 <bypassRoute src="host_1" dst="host_2">
1340    <link_ctn id="link_tmp"/>
1341 </bypassRoute>
1342 \endverbatim
1343
1344 This example shows that link \c link_tmp (definition not displayed here) directly
1345 connects host \c host_1 to host \c host_2. Additionally, as the \c symmetrical
1346 attribute was not given, this route is presumed to be symmetrical.
1347
1348 \subsection pb_baroex Basic Routing Example
1349
1350 Let's say you have an zone named zone_Big that contains two other zone, zone_1
1351 and zone_2. If you want to make a host (h1) from zone_1 with another one
1352 (h2) from zone_2 then you'll have to proceed as follows:
1353 \li First, you have to ensure that a route is defined from h1 to the
1354     zone_1's exit gateway and from h2 to zone_2's exit gateway.
1355 \li Then, you'll have to define a route between zone_1 to zone_2. As those
1356     zone are both resources belonging to zone_Big, then it has to be done
1357     at zone_big level. To define such a route, you have to give the
1358     source zone (zone_1), the destination zone (zone_2), and their respective
1359     gateway (as the route is effectively defined between those two
1360     entry/exit points). Elements of this route can only be elements
1361     belonging to zone_Big, so links and routers in this route should be
1362     defined inside zone_Big. If you choose some shortest-path model,
1363     this route will be computed automatically.
1364
1365 As said before, there are mainly 2 tags for routing :
1366 \li <b>zoneroute</b>: to define routes between two  <b>zone</b>
1367 \li <b>route</b>: to define routes between two <b>host/router</b>
1368
1369 As we are dealing with routes between zone, it means that those we'll
1370 have some definition at zone_Big level. Let consider zone_1 contains 1
1371 host, 1 link and one router and zone_2 3 hosts, 4 links and one router.
1372 There will be a central router, and a cross-like topology. At the end
1373 of the crosses arms, you'll find the 3 hosts and the router that will
1374 act as a gateway. We have to define routes inside those two zone. Let
1375 say that zone_1 contains full routes, and zone_2 contains some Floyd
1376 routing (as we don't want to bother with defining all routes). As
1377 we're using some shortest path algorithms to route into zone_2, we'll
1378 then have to define some <b>route</b> to gives some topological
1379 information to SimGrid. Here is a file doing it all :
1380
1381 \verbatim
1382 <zone  id="zone_Big"  routing="Dijkstra">
1383   <zone id="zone_1" routing="Full">
1384      <host id="zone_1_host1" speed="1000000000"/>
1385      <link id="zone_1_link" bandwidth="1250000000" latency="5E-4"/>
1386      <router id="zone_1_gateway"/>
1387      <route src="zone_1_host1" dst="zone_1_gateway">
1388             <link_ctn id="zone_1_link"/>
1389      </route>
1390   </zone>
1391   <zone id="zone_2" routing="Floyd">
1392      <host id="zone_2_host1" speed="1000000000"/>
1393      <host id="zone_2_host2" speed="1000000000"/>
1394      <host id="zone_2_host3" speed="1000000000"/>
1395      <link id="zone_2_link1" bandwidth="1250000000" latency="5E-4"/>
1396      <link id="zone_2_link2" bandwidth="1250000000" latency="5E-4"/>
1397      <link id="zone_2_link3" bandwidth="1250000000" latency="5E-4"/>
1398      <link id="zone_2_link4" bandwidth="1250000000" latency="5E-4"/>
1399      <router id="central_router"/>
1400      <router id="zone_2_gateway"/>
1401      <!-- routes providing topological information -->
1402      <route src="central_router" dst="zone_2_host1"><link_ctn id="zone_2_link1"/></route>
1403      <route src="central_router" dst="zone_2_host2"><link_ctn id="zone_2_link2"/></route>
1404      <route src="central_router" dst="zone_2_host3"><link_ctn id="zone_2_link3"/></route>
1405      <route src="central_router" dst="zone_2_gateway"><link_ctn id="zone_2_link4"/></route>
1406   </zone>
1407     <link id="backbone" bandwidth="1250000000" latency="5E-4"/>
1408
1409      <zoneroute src="zone_1" dst="zone_2"
1410          gw_src="zone_1_gateway"
1411          gw_dst="zone_2_gateway">
1412                 <link_ctn id="backbone"/>
1413      </zoneroute>
1414 </zone>
1415 \endverbatim
1416
1417 \section pf_other Other tags
1418
1419 The following tags can be used inside a \<platform\> tag even if they are not
1420 directly describing the platform:
1421
1422   - @ref pf_tag_config passes configuration options, e.g. to change the network model;
1423   - @ref pf_tag_prop gives user-defined properties to various elements
1424
1425 \subsection pf_tag_config &lt;config&gt;
1426
1427 Adding configuration flags into the platform file is particularly
1428 useful when the described platform is best used with specific
1429 flags. For example, you could finely tune SMPI in your platform file directly.
1430
1431 | Attribute  | Values              | Description                                    |
1432 | ---------- | ------------------- | ---------------------------------------------- |
1433 | id         | String (optional)   | This optional identifier is ignored by SimGrid |
1434
1435 * **Included tags:** @ref pf_tag_prop to specify a given configuration item (see @ref options).
1436
1437 Any such configuration must be given at the very top of the platform file.
1438
1439 * **Example**
1440
1441 \verbatim
1442 <?xml version='1.0'?>
1443 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1444 <platform version="4">
1445 <config>
1446         <prop id="maxmin/precision" value="0.000010" />
1447         <prop id="cpu/optim" value="TI" />
1448         <prop id="network/model" value="SMPI" />
1449         <prop id="smpi/bw-factor" value="65472:0.940694;15424:0.697866;9376:0.58729" />
1450 </config>
1451
1452 <zone  id="zone0"  routing="Full">
1453 ...
1454 \endverbatim
1455
1456 \subsection pf_tag_prop &lt;prop&gt;
1457
1458 Defines a user-defined property, identified with a name and having a
1459 value. You can specify such properties to most kind of resources:
1460 @ref pf_tag_zone, @ref pf_tag_host, @ref pf_tag_storage,
1461 @ref pf_tag_cluster and @ref pf_tag_link. These values can be retrieved
1462 at runtime with MSG_zone_property() or simgrid::s4u::NetZone::property(),
1463 or similar functions.
1464
1465 | Attribute | Values                  | Description                                                                               |
1466 | --------- | ----------------------  | ----------------------------------------------------------------------------------------- |
1467 | id        | String (mandatory)      | Identifier of this property. Must be unique for a given property holder, eg host or link. |
1468 | value     | String (mandatory)      | Value of this property; The semantic is completely up to you.                             |
1469
1470 * **Included tags:** none.
1471
1472 #### Example ####
1473
1474 \code{.xml}
1475 <prop id="Operating System" value="Linux" />
1476 \endcode
1477
1478
1479 \subsection pf_trace trace and trace_connect
1480
1481 Both tags are an alternate way to pass files containing information on
1482 availability, state etc. to an entity. (See also @ref howto_churn).
1483 Instead of referring to the file directly in the host, link, or
1484 cluster tag, you proceed by defining a trace with an id corresponding
1485 to a file, later a host/link/cluster, and finally using trace_connect
1486 you say that the file trace must be used by the entity.
1487
1488
1489 #### Example #### 
1490
1491 \verbatim
1492 <zone  id="zone0"  routing="Full">
1493   <host id="bob" speed="1000000000"/>
1494 </zone>
1495 <trace id="myTrace" file="bob.trace" periodicity="1.0"/>
1496 <trace_connect trace="myTrace" element="bob" kind="POWER"/>
1497 \endverbatim
1498
1499 \note 
1500     The order here is important.  \c trace_connect must come 
1501     after the elements \c trace and \c host, as both the host
1502     and the trace definition must be known when \c trace_connect
1503     is parsed; the order of \c trace and \c host is arbitrary.
1504
1505
1506 #### \c trace attributes ####
1507
1508
1509 | Attribute name  | Mandatory | Values                 | Description                                                                                       |
1510 | --------------- | --------- | ---------------------- | -----------                                                                                       |
1511 | id              | yes       | String                 | Identifier of this trace; this is the name you pass on to \c trace_connect.                       |
1512 | file            | no        | String                 | Filename of the file that contains the information - the path must follow the style of your OS. You can omit this, but then you must specifiy the values inside of &lt;trace&gt; and &lt;/trace&gt; - see the example below. |
1513 | trace_periodicity | yes | String | This is the same as for \ref pf_tag_host "hosts" (see there for details) |
1514
1515 Here is an example  of trace when no file name is provided:
1516
1517 \verbatim
1518  <trace id="myTrace" periodicity="1.0">
1519     0.0 1.0
1520     11.0 0.5
1521     20.0 0.8
1522  </trace>
1523 \endverbatim
1524
1525 #### \c trace_connect attributes ####
1526
1527 | Attribute name  | Mandatory | Values                 | Description                                                                                       |
1528 | --------------- | --------- | ---------------------- | -----------                                                                                       |
1529 | kind            | no        | HOST_AVAIL\|POWER\|<br/>LINK_AVAIL\|BANDWIDTH\|LATENCY (Default: HOST_AVAIL)   | Describes the kind of trace.                   |
1530 | trace           | yes       | String                 | Identifier of the referenced trace (specified of the trace's \c id attribute)                     |
1531 | element         | yes       | String                 | The identifier of the referenced entity as given by its \c id attribute                           |
1532
1533 \section pf_hints Hints, tips and frequently requested features
1534
1535 Now you should know at least the syntax and be able to create a
1536 platform by your own. However, after having ourselves wrote some platforms, there
1537 are some best practices you should pay attention to in order to
1538 produce good platform and some choices you can make in order to have
1539 faster simulations. Here's some hints and tips, then.
1540
1541 @subsection pf_hints_search Finding the platform example that you need
1542
1543 Most platform files that we ship are in the @c examples/platforms
1544 folder. The good old @c grep tool can find the examples you need when
1545 wondering on a specific XML tag. Here is an example session searching
1546 for @ref pf_trace "trace_connect":
1547
1548 @verbatim
1549 % cd examples/platforms
1550 % grep -R -i -n --include="*.xml" "trace_connect" .
1551 ./two_hosts_platform_with_availability_included.xml:26:<trace_connect kind="SPEED" trace="A" element="Cpu A"/>
1552 ./two_hosts_platform_with_availability_included.xml:27:<trace_connect kind="HOST_AVAIL" trace="A_failure" element="Cpu A"/>
1553 ./two_hosts_platform_with_availability_included.xml:28:<trace_connect kind="SPEED" trace="B" element="Cpu B"/>
1554 ./two_hosts.xml:17:  <trace_connect trace="Tremblay_power" element="Tremblay" kind="SPEED"/>
1555 @endverbatim
1556
1557 \subsection pf_hint_generating How to generate different platform files?
1558
1559 This is actually a good idea to search for a better platform file,
1560 that better fit the need of your study. To be honest, the provided
1561 examples are not representative of anything. They exemplify our XML
1562 syntax, but that's all. small_platform.xml for example was generated
1563 without much thought beyond that.
1564
1565 The best thing to do when possible is to write your own platform file,
1566 that model the platform on which you run your code. For that, you
1567 could use <a href="https://gitlab.inria.fr/simgrid/platform-calibration">our
1568 calibration scripts</a>. This leads to very good fits between the
1569 platform, the model and the needs.  The g5k.xml example resulted of
1570 such an effort, which also lead to <a href="https://github.com/lpouillo/topo5k/">an 
1571 ongoing attempt</a> to automatically extract the SimGrid platform from
1572 the <a href="http://grid5000.fr/">Grid'5000</a> experimental platform.
1573 But it's hard to come up with generic models. Don't take these files
1574 too seriously. Actually, you should always challenge our models and
1575 your instanciation if the accuracy really matters to you (see <a
1576 href="https://hal.inria.fr/hal-00907887">this discussion</a>).
1577
1578 But such advices only hold if you have a real platform and a real
1579 application at hand. It's moot for more abstract studies working on
1580 ideas and algorithms instead of technical artefacts. Well, in this
1581 case, there unfortunately is nothing better than this old and rusty
1582 <a href="http://pda.gforge.inria.fr/tools/download.html">simulacrum</a>.
1583 This project is dormant since over 10 years (and you will have to
1584 update the generated platforms with <tt>bin/simgrid_update_xml</tt> to
1585 use them), but that's the best we have for this right now....
1586
1587 \subsection pf_zone_h Zone Hierarchy
1588 The network zone design allows SimGrid to go fast, because computing route is
1589 done only for the set of resources defined in the current zone. If you're using
1590 only a big zone containing all resource with no zone into it and you're
1591 using Full model, then ... you'll loose all interest into it. On the
1592 other hand, designing a binary tree of zone with, at the lower level,
1593 only one host, then you'll also loose all the good zone hierarchy can
1594 give you. Remind you should always be "reasonable" in your platform
1595 definition when choosing the hierarchy. A good choice if you try to
1596 describe a real life platform is to follow the zone described in
1597 reality, since this kind of trade-off works well for real life
1598 platforms.
1599
1600 \subsection pf_exit_zone Exit Zone: why and how
1601 Users that have looked at some of our platforms may have notice a
1602 non-intuitive schema ... Something like that :
1603
1604
1605 \verbatim
1606 <zone id="zone_4"  routing="Full">
1607 <zone id="exitzone_4"  routing="Full">
1608         <router id="router_4"/>
1609 </zone>
1610 <cluster id="cl_4_1" prefix="c_4_1-" suffix="" radical="1-20" speed="1000000000" bw="125000000" lat="5E-5" bb_bw="2250000000" bb_lat="5E-4"/>
1611 <cluster id="cl_4_2" prefix="c_4_2-" suffix="" radical="1-20" speed="1000000000" bw="125000000" lat="5E-5" bb_bw="2250000000" bb_lat="5E-4"/>
1612 <link id="4_1" bandwidth="2250000000" latency="5E-5"/>
1613 <link id="4_2" bandwidth="2250000000" latency="5E-5"/>
1614 <link id="bb_4" bandwidth="2250000000" latency="5E-4"/>
1615 <zoneroute src="cl_4_1"
1616         dst="cl_4_2"
1617         gw_src="c_4_1-cl_4_1_router"
1618         gw_dst="c_4_2-cl_4_2_router">
1619                 <link_ctn id="4_1"/>
1620                 <link_ctn id="bb_4"/>
1621                 <link_ctn id="4_2"/>
1622 </zoneroute>
1623 <zoneroute src="cl_4_1"
1624         dst="exitzone_4"
1625         gw_src="c_4_1-cl_4_1_router"
1626         gw_dst="router_4">
1627                 <link_ctn id="4_1"/>
1628                 <link_ctn id="bb_4"/>
1629 </zoneroute>
1630 <zoneroute src="cl_4_2"
1631         dst="exitzone_4"
1632         gw_src="c_4_2-cl_4_2_router"
1633         gw_dst="router_4">
1634                 <link_ctn id="4_2"/>
1635                 <link_ctn id="bb_4"/>
1636 </zoneroute>
1637 </zone>
1638 \endverbatim
1639
1640 In the zone_4, you have an exitzone_4 defined, containing only one router,
1641 and routes defined to that zone from all other zone (as cluster is only a
1642 shortcut for an zone, see cluster description for details). If there was
1643 an upper zone, it would define routes to and from zone_4 with the gateway
1644 router_4. It's just because, as we did not allowed (for performances
1645 issues) to have routes from an zone to a single host/router, you have to
1646 enclose your gateway, when you have zone included in your zone, within an
1647 zone to define routes to it.
1648
1649 \subsection pf_P2P_tags P2P or how to use coordinates
1650 SimGrid allows you to use some coordinated-based system, like vivaldi,
1651 to describe a platform. The main concept is that you have some peers
1652 that are located somewhere: this is the function of the
1653 <b>coordinates</b> of the \<peer\> or \<host\> tag. There's nothing
1654 complicated in using it, here is an example:
1655
1656 \verbatim
1657 <?xml version='1.0'?>
1658 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1659 <platform version="4">
1660
1661  <zone  id="zone0"  routing="Vivaldi">
1662         <host id="100030591" coordinates="25.5 9.4 1.4" speed="1.5Gf" />
1663         <host id="100036570" coordinates="-12.7 -9.9 2.1" speed="7.3Gf" />
1664         ...
1665         <host id="100429957" coordinates="17.5 6.7 18.8" speed="8.3Gf" />
1666  </zone>
1667 </platform>
1668 \endverbatim
1669
1670 Coordinates are then used to calculate latency (in microseconds)
1671 between two hosts by calculating the distance between the two hosts
1672 coordinates with the following formula: distance( (x1, y1, z1), (x2,
1673 y2, z2) ) = euclidian( (x1,y1), (x2,y2) ) + abs(z1) + abs(z2)
1674
1675 In other words, we take the euclidian distance on the two first
1676 dimensions, and then add the absolute values found on the third
1677 dimension. This may seem strange, but it was found to allow better
1678 approximations of the latency matrices (see the paper describing
1679 Vivaldi).
1680
1681 Note that the previous example defines a routing directly between hosts but it could be also used to define a routing between zone.
1682 That is for example what is commonly done when using peers (see Section \ref pf_peer).
1683 @verbatim
1684 <?xml version='1.0'?>
1685 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1686 <platform version="4">
1687
1688  <zone  id="zone0"  routing="Vivaldi">
1689    <peer id="peer-0" coordinates="173.0 96.8 0.1" speed="730Mf" bw_in="13.38MBps" bw_out="1.024MBps" lat="500us"/>
1690    <peer id="peer-1" coordinates="247.0 57.3 0.6" speed="730Mf" bw_in="13.38MBps" bw_out="1.024MBps" lat="500us" />
1691    <peer id="peer-2" coordinates="243.4 58.8 1.4" speed="730Mf" bw_in="13.38MBps" bw_out="1.024MBps" lat="500us" />
1692 </zone>
1693 </platform>
1694 @endverbatim
1695 In such a case though, we connect the zone created by the <b>peer</b> tag with the Vivaldi routing mechanism.
1696 This means that to route between zone1 and zone2, it will use the coordinates of router_zone1 and router_zone2.
1697 This is currently a convention and we may offer to change this convention in the DTD later if needed.
1698 You may have noted that conveniently, a peer named FOO defines an zone named FOO and a router named router_FOO, which is why it works seamlessly with the <b>peer</b> tag.
1699
1700
1701 \subsection pf_routing_howto_choose_wisely Choosing wisely the routing model to use
1702
1703
1704 Choosing wisely the routing model to use can significantly fasten your
1705 simulation/save your time when writing the platform/save tremendous
1706 disk space. Here is the list of available model and their
1707 characteristics (lookup : time to resolve a route):
1708
1709 \li <b>Full</b>: Full routing data (fast, large memory requirements,
1710     fully expressive)
1711 \li <b>Floyd</b>: Floyd routing data (slow initialization, fast
1712     lookup, lesser memory requirements, shortest path routing only).
1713     Calculates all routes at once at the beginning.
1714 \li <b>Dijkstra</b>: Dijkstra routing data (fast initialization, slow
1715     lookup, small memory requirements, shortest path routing only).
1716     Calculates a route when necessary.
1717 \li <b>DijkstraCache</b>: Dijkstra routing data (fast initialization,
1718     fast lookup, small memory requirements, shortest path routing
1719     only). Same as Dijkstra, except it handles a cache for latest used
1720     routes.
1721 \li <b>None</b>: No routing (usable with Constant network only).
1722     Defines that there is no routes, so if you try to determine a
1723     route without constant network within this zone, SimGrid will raise
1724     an exception.
1725 \li <b>Vivaldi</b>: Vivaldi routing, so when you want to use coordinates
1726 \li <b>Cluster</b>: Cluster routing, specific to cluster tag, should
1727     not be used.
1728
1729 \subsection pf_switch I want to describe a switch but there is no switch tag!
1730
1731 Actually we did not include switch tag. But when you're trying to
1732 simulate a switch, assuming 
1733 fluid bandwidth models are used (which SimGrid uses by default unless 
1734 ns-3 or constant network models are activated), the limiting factor is
1735 switch backplane bandwidth. So, essentially, at least from
1736 the simulation perspective, a switch is similar to a
1737 link: some device that is traversed by flows and with some latency and
1738 so,e maximum bandwidth. Thus, you can simply simulate a switch as a
1739 link. Many links
1740 can be connected to this "switch", which is then included in routes just
1741 as a normal link.
1742
1743
1744 \subsection pf_multicabinets I want to describe multi-cabinets clusters!
1745
1746 You have several possibilities, as usual when modeling things. If your
1747 cabinets are homogeneous and the intercabinet network negligible for
1748 your study, you should just create a larger cluster with all hosts at
1749 the same layer. 
1750
1751 In the rare case where your hosts are not homogeneous between the
1752 cabinets, you can create your cluster completely manually. For that,
1753 create an As using the Cluster routing, and then use one
1754 &lt;cabinet&gt; for each cabinet. This cabinet tag can only be used an
1755 As using the Cluster routing schema, and creating 
1756
1757 Be warned that creating a cluster manually from the XML with
1758 &lt;cabinet&gt;, &lt;backbone&gt; and friends is rather tedious. The
1759 easiest way to retrieve some control of your model without diving into
1760 the &lt;cluster&gt; internals is certainly to create one separate
1761 &lt;cluster&gt; per cabinet and interconnect them together. This is
1762 what we did in the G5K example platform for the Graphen cluster.
1763
1764 \subsection pf_platform_multipath I want to express multipath routing in platform files!
1765
1766 It is unfortunately impossible to express the fact that there is more
1767 than one routing path between two given hosts. Let's consider the
1768 following platform file:
1769
1770 \verbatim
1771 <route src="A" dst="B">
1772    <link_ctn id="1"/>
1773 </route>
1774 <route src="B" dst="C">
1775   <link_ctn id="2"/>
1776 </route>
1777 <route src="A" dst="C">
1778   <link_ctn id="3"/>
1779 </route>
1780 \endverbatim
1781
1782 Although it is perfectly valid, it does not mean that data traveling
1783 from A to C can either go directly (using link 3) or through B (using
1784 links 1 and 2). It simply means that the routing on the graph is not
1785 trivial, and that data do not following the shortest path in number of
1786 hops on this graph. Another way to say it is that there is no implicit
1787 in these routing descriptions. The system will only use the routes you
1788 declare (such as &lt;route src="A" dst="C"&gt;&lt;link_ctn
1789 id="3"/&gt;&lt;/route&gt;), without trying to build new routes by aggregating
1790 the provided ones.
1791
1792 You are also free to declare platform where the routing is not
1793 symmetrical. For example, add the following to the previous file:
1794
1795 \verbatim
1796 <route src="C" dst="A">
1797   <link_ctn id="2"/>
1798   <link_ctn id="1"/>
1799 </route>
1800 \endverbatim
1801
1802 This makes sure that data from C to A go through B where data from A
1803 to C go directly. Don't worry about realism of such settings since
1804 we've seen ways more weird situation in real settings (in fact, that's
1805 the realism of very regular platforms which is questionable, but
1806 that's another story).
1807
1808 */