Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
ad27aa9877204958fb55fa1cab54dac5506c1df1
[simgrid.git] / doc / doxygen / platform.doc
1 /*! \page platform Platform Description
2
3 @tableofcontents
4
5 In order to run any simulation, SimGrid must be provided with three things:
6 something to run (i.e., your code), a description of the platform on which you
7 want to simulate your application and lastly information about the deployment
8 process: Which process should be deployed to which processor/core?
9
10 For the last two items, there are essentially two possible ways you can provide
11 this information as an input:
12 \li You can program it, either by using the Lua console (
13     \ref MSG_Lua_funct) or, if you're using MSG, some of MSG's platform and
14     deployment functions (\ref msg_simulation). If you want to use this,
15     check the particular documentation. (You can also check the section
16     \ref pf_flexml_bypassing, however, this documentation is deprecated;
17     there is a new, but undocumented, way to do it properly).
18 \li You can use two XML files: one contains the platform description while
19     the other contains the deployment instructions.
20
21 For more information on SimGrid's deployment features, please refer to
22 the \ref deployment documentation.
23
24 The platform description may be intricate. This documentation is all
25 about how to write this file: The basic concepts are introduced. Furthermore,
26 advanced options are explained. Additionally, some hints and tips on how to
27 write a good platform description are given.
28
29 \section pf_overview Some words about XML and DTD
30
31 We chose to use XML not only because it's extensible but also because many
32 tools (and plugins for existing tools) are available that facilitate editing and
33 validating XML files. Furthermore, libraries that parse XML are often already
34 available and very well tested.
35
36 The XML checking is done based on the Document Type Definition (DTD) file,
37 available at
38 <a href="http://simgrid.gforge.inria.fr/simgrid.dtd">http://simgrid.gforge.inria.fr/simgrid.dtd</a>.
39
40 If you read the DTD, you should notice the following:
41 \li The platform tags contain a version attribute; the current version is 3.
42     This property might be used in the future to provide backwards
43     compatibility.
44 \li The DTD contains definitions for the two files used by SimGrid (i.e.,
45     platform description and deployment).
46
47 \section pf_basics Basic concepts
48
49 Nowadays, the Internet is composed of a bunch of independently managed
50 networks. Within each of those networks, there are entry and exit
51 points (most of the time, you can both enter and exit through the same
52 point); this allows to leave the current network and reach other
53 networks, possibly even in other locations.
54 At the upper level, such a network is called
55 <b>Autonomous System (AS)</b>, while at the lower level it is named
56 sub-network, or LAN (local area network).
57 They are indeed autonomous: routing is defined
58 (within the limits of his network) by the administrator, and so, those
59 networks can operate without a connection to other
60 networks. So-called gateways allow you to go from one network to
61 another, if such a (physical) connection exists. Every node in one network
62 that can be directly reached (i.e., without traversing other nodes) from
63 another network is called a gateway.
64 Each autonomous system consists of equipment such as cables (network links),
65 routers and switches as well as computers.
66
67 The structure of the SimGrid platform description relies exactly on the same
68 concept as a real-life platform (see above).  Every resource (computers,
69 network equipment etc.) belongs to an AS, which can be defined by using the
70 \<AS\> tag. Within an AS, the routing between its elements can be defined
71 abitrarily. There are several modes for routing, and exactly one mode must be
72 selected by specifying the routing attribute in the AS tag:
73
74 \verbatim
75 <AS id="AS0" routing="Full">
76 \endverbatim
77
78 \remark
79   Other supported values for the routing attribute can be found below, Section
80   \ref pf_raf.
81
82 There is also the ``<route>`` tag; this tag takes two attributes, ``src`` (source)
83 and ``dst`` (destination). Both source and destination must be valid identifiers
84 for routers (these will be introduced later). Contained by the ``<route>`` are
85 network links; these links must be used in order to communicate from the source
86 to the destination specified in the tag. Hence, a route merely describes
87 how to reach a router from another router.
88
89 \remark
90   More information and (code-)examples can be found in Section \ref pf_rm.
91
92 An AS can also contain itself one or more AS; this allows you to
93 model the hierarchy of your platform.
94
95 ### Within each AS, the following types of resources exist:
96
97 %Resource        | Documented in Section | Description
98 --------------- | --------------------- | -----------
99 AS              |                       | Every Autonomous System (AS) may contain one or more AS.
100 host            | \ref pf_host          | This entity carries out the actual computation. For this reason, it contains processors (with potentially multiple cores).
101 router          | \ref pf_router        | In SimGrid, routers are used to provide helpful information to routing algorithms.  Routers may also act as gateways, connecting several autonomous systems with each other.
102 link            | \ref pf_link          | In SimGrid, (network)links define a connection between two or potentially even more resources. Every link has a bandwidth and a latency and may potentially experience congestion.
103 cluster         | \ref pf_cluster       | In SimGrid, clusters were introduced to model large and homogenous environments. They are not really a resource by themselves - technically, they are only a shortcut, as they will internally set up all the hosts, network and routing for you, i.e., using this resource, one can easily setup thousands of hosts and links in a few lines of code. Each cluster is itself an AS.
104
105 %As it is desirable to interconnect these resources, a routing has to be
106 defined. The AS is supposed to be Autonomous, hence this has to be done at the
107 AS level. The AS handles two different types of entities (<b>host/router</b>
108 and <b>AS</b>). However, the user is responsible to define routes between those resources,
109 otherwise entities will be unconnected and therefore unreachable from other
110 entities. Although several routing algorithms are built into SimGrid (see
111 \ref pf_rm), you might encounter a case where you want to define routes
112 manually (for instance, due to specific requirements of your platform).
113
114 There are three tags to use:
115 \li <b>ASroute</b>: to define routes between two  <b>AS</b>
116 \li <b>route</b>: to define routes between two <b>host/router</b>
117 \li <b>bypassRoute</b>: to define routes between two <b>AS</b> that
118     will bypass default routing (as specified by the ``routing`` attribute
119     supplied to ``<AS>``, see above).
120
121 Here is an illustration of these concepts:
122
123 ![An illustration of an AS hierarchy. Here, AS1 contains 5 other AS' who in turn may contain other AS' as well.](AS_hierarchy.png)
124  Circles represent processing units and squares represent network routers. Bold
125     lines represent communication links. AS2 models the core of a national
126     network interconnecting a small flat cluster (AS4) and a larger
127     hierarchical cluster (AS5), a subset of a LAN (AS6), and a set of peers
128     scattered around the world (AS7).
129
130 \section pf_pftags Resource description
131
132 \subsection  pf_As Platform: The &lt;AS&gt; tag
133
134 The concept of an AS was already outlined above (Section \ref pf_basics);
135 recall that the AS is so important because it groups other resources (such
136 as routers/hosts) together (in fact, these resources must be contained by
137 an AS).
138
139 Available attributes :
140
141 Attribute name  | Mandatory | Values | Description
142 --------------- | --------- | ------ | -----------
143 id              | yes       | String | The identifier of an AS; facilitates referring to this AS. ID must be unique.
144 routing         | yes       | Full\| Floyd\| Dijkstra\| DijkstraCache\| None\| Vivaldi\| Cluster | See Section \ref pf_rm for details.
145
146
147 <b>Example:</b>
148 \verbatim
149 <AS id="AS0" routing="Full">
150    <host id="host1" power="1000000000"/>
151    <host id="host2" power="1000000000"/>
152    <link id="link1" bandwidth="125000000" latency="0.000100"/>
153    <route src="host1" dst="host2"><link_ctn id="link1"/></route>
154 </AS>
155 \endverbatim
156
157 In this example, AS0 contains two hosts (host1 and host2). The route
158 between the hosts goes through link1.
159
160 \subsection pf_Cr Computing resources: hosts, clusters and peers.
161
162 \subsubsection pf_host &lt;host/&gt;
163
164 A <b>host</b> represents a computer/node card. Every host is able to execute
165 code and it can send and receive data to/from other hosts. Most importantly,
166 a host can contain more than 1 core.
167
168 ### Attributes: ###
169
170 Attribute name  | Mandatory | Values | Description
171 --------------- | --------- | ------ | -----------
172 id              | yes       | String | The identifier of the host. facilitates referring to this AS.
173 power           | yes       | double (must be > 0.0) | Computational power of every core of this host in FLOPS. Must be larger than 0.0.
174 core            | no        | int (Default: 1) | The number of cores of this host. If more than one core is specified, the "power" parameter refers to every core, i.e., the total computational power is no_of_cores*power.<br /> If 6 cores are specified, up to 6 tasks can be executed without sharing the computational power; if more than 6 tasks are executed, computational power will be shared among these tasks. <br /> <b>Warning:</b> Although functional, this model was never scientifically assessed.
175 availability    | no        | int    | <b>Specify if the percentage of power available.</b> (What? TODO)
176 availability_file| no       | string | (Relative or absolute) filename to use as input; must contain availability traces for this host. The syntax of this file is defined below. <br /> <b>Note:</b> The filename must be specified with your system's format.
177 state           | no        | ON\|OFF<br/> (Default: ON) | Is this host running or not?
178 state_file      | no        | string |  Same mechanism as availability_file.<br /> <b>Note:</b> The filename must be specified with your system's format.
179 coordinates     | no        | string | Must be provided when choosing the Vivaldi, coordinate-based routing model for the AS the host belongs to. More details can be found in the Section \ref pf_P2P_tags.
180
181 ### Possible children: ###
182
183 Tag name        | Description | Documentation
184 ------------    | ----------- | -------------
185 \<mount/\>        | Defines mounting points between some storage resource and the host. | \ref pf_storage_entity_mount
186 \<prop/\>         | The prop tag allows you to define additional information on this host following the attribute/value schema. You may want to use it to give information to the tool you use for rendering your simulation, for example. | N/A
187
188 ### Example ###
189
190 \verbatim
191    <host id="host1" power="1000000000"/>
192    <host id="host2" power="1000000000">
193         <prop id="color" value="blue"/>
194         <prop id="rendershape" value="square"/>
195    </host>
196 \endverbatim
197
198
199 \anchor pf_host_dynamism
200 ### Expressing dynamism ###
201
202 SimGrid provides mechanisms to change a hosts' availability over
203 time, using the ``availability_file`` attribute to the ``\<host\>`` tag
204 and a separate text file whose syntax is exemplified below.
205
206 #### Adding a trace file ####
207
208 \verbatim
209 <platform version="1">
210   <host id="bob" power="500000000" availability_file="bob.trace" />
211 </platform>
212 \endverbatim
213
214 #### Example of "bob.trace" file ####
215
216 ~~~~~~~~~~~~~~{.py}
217 PERIODICITY 1.0
218   0.0 1.0
219   11.0 0.5
220   20.0 0.8
221 ~~~~~~~~~~~~~~
222
223 Let us begin to explain this example by looking at line 2. (Line 1 will become clear soon).
224 The first column describes points in time, in this case, time 0. The second column
225 describes the relative amount of power this host is able to deliver (relative
226 to the maximum performance specified in the ``\<host\>`` tag). (Clearly, the
227 second column needs to contain values that are not smaller than 0 and not larger than 1).
228 In this example, our host will deliver 500 Mflop/s at time 0, as 500 Mflop/s is the
229 maximum performance of this host. At time 11.0, it will
230 deliver half of its maximum performance, i.e., 250 Mflop/s until time 20.0 when it will
231 will start delivering 80\% of its power. In this example, this amounts to 400 Mflop/s.
232
233 Since the periodicity in line 1 was set to be 1.0, i.e., 1 timestep, this host will
234 continue to provide 500 Mflop/s from time 21. From time 32 it will provide 250 MFlop/s and so on.
235
236 ### Changing initial state ###
237
238 It is also possible to specify whether the host is up or down by setting the
239 ``state`` attribute to either <b>ON</b> (default value) or <b>OFF</b>.
240
241 #### Example: Expliciting the default value "ON" ####
242
243 \verbatim
244 <platform version="1">
245    <host id="bob" power="500000000" state="ON" />
246 </platform>
247 \endverbatim
248
249 If you want this host to be unavailable, simply substitute ON with OFF.
250
251 ### Expressing churn ###
252
253 To express the fact that a host can change state over time (as in P2P
254 systems, for instance), it is possible to use a file describing the time
255 at which the host is turned on or off. An example of the content
256 of such a file is presented below.
257
258 #### Adding a state file ####
259
260 \verbatim
261 <platform version="1">
262   <host id="bob" power="500000000" state_file="bob.fail" />
263 </platform>
264 \endverbatim
265
266 #### Example of "bob.fail" file ####
267
268 ~~~{.py}
269   PERIODICITY 10.0
270   1.0 -1.0
271   2.0 1.0
272 ~~~
273
274 A negative value means <b>down</b> (i.e., OFF) while a positive one means <b>up and
275   running</b> (i.e., ON). From time 0.0 to time 1.0, the host is on. At time 1.0, it is
276 turned off and at time 2.0, it is turned on again until time 12 (2.0 plus the
277 periodicity 10.0). It will be turned on again at time 13.0 until time 23.0, and
278 so on.
279
280
281 \subsubsection pf_cluster &lt;cluster&gt;
282
283 ``<cluster />`` represents a machine-cluster. It is most commonly used
284 when one wants to define many hosts and a network quickly. Technically,
285 ``cluster`` is a meta-tag: <b>from the inner SimGrid point of
286 view, a cluster is an AS where some optimized routing is defined</b>.
287 The default inner organization of the cluster is as follow:
288
289 \verbatim
290                  __________
291                 |          |
292                 |  router  |
293     ____________|__________|_____________ backbone
294       |   |   |              |     |   |
295     l0| l1| l2|           l97| l96 |   | l99
296       |   |   |   ........   |     |   |
297       |                                |
298     c-0.me                             c-99.me
299 \endverbatim
300
301 Here, a set of <b>host</b>s is defined. Each of them has a <b>link</b>
302 to a central backbone (backbone is a link itself, as a link can
303 be used to represent a switch, see the switch / link section
304 below for more details about it). A <b>router</b> allows to connect a
305 <b>cluster</b> to the outside world. Internally,
306 SimGrid treats a cluster as an AS containing all hosts: the router is the default
307 gateway for the cluster.
308
309 There is an alternative organization, which is as follows:
310 \verbatim
311                  __________
312                 |          |
313                 |  router  |
314                 |__________|
315                     / | \
316                    /  |  \
317                l0 / l1|   \l2
318                  /    |    \
319                 /     |     \
320             host0   host1   host2
321 \endverbatim
322
323 The principle is the same, except that there is no backbone. This representation
324 can be obtained easily: just do not set the bb_* attributes.
325
326
327 Attribute name  | Mandatory | Values | Description
328 --------------- | --------- | ------ | -----------
329 id              | yes       | string | The identifier of the cluster. Facilitates referring to this cluster.
330 prefix          | yes       | string | Each node of the cluster has to have a name. This name will be prefixed with this prefix.
331 suffix          | yes       | string | Each node of the cluster will be suffixed with this suffix
332 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.
333 power           | yes       | int    | Same as the ``power`` attribute of the ``\<host\>`` tag.
334 core            | no        | int (default: 1) | Same as the ``core`` attribute of the ``\<host\>`` tag.
335 bw              | yes       | int    | Bandwidth for the links between nodes and backbone (if any). See the \ref pf_link "link section" for syntax/details.
336 lat             | yes       | int    | Latency for the links between nodes and backbone (if any). See <b>link</b> section for syntax/details.
337 sharing_policy  | no        | string | Sharing policy for the links between nodes and backbone (if any). See <b>link</b> section for syntax/details.
338 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>).
339 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>).
340 bb_sharing_policy | no      | string | Sharing policy for the backbone (if any). See <b>link</b> section for syntax/details.
341 availability_file | no      | string | Allows you to use a file as input for availability. Similar to <b>hosts</b> attribute.
342 state_file        | no      | string | Allows you to use a file as input for states.  Similar to <b>hosts</b> attribute.
343 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 sharing_policy_fatpipe "\b FATPIPE".
344 loopback_lat      | no      | int    | Latency for loopback (if any). See <b>link</b> section for syntax/details. See loopback_bw for more info.
345 topology          | no      | FLAT\|TORUS\|FAT_TREE (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> and FAT_TREE attributes for this tag.
346 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. For fat trees, refer to \ref AsClusterFatTree "AsClusterFatTree documentation".
347
348 TODO
349
350 the router name is defined as the resulting String in the following
351 java line of code:
352
353 @verbatim
354 router_name = prefix + clusterId + _router + suffix;
355 @endverbatim
356
357
358 #### Cluster example ####
359
360 Consider the following two (and independent) uses of the ``cluster`` tag:
361
362 \verbatim
363 <cluster id="my_cluster_1" prefix="" suffix="" radical="0-262144"
364          power="1e9" bw="125e6" lat="5E-5"/>
365
366 <cluster id="my_cluster_2" prefix="c-" suffix=".me" radical="0-99"
367          power="1e9" bw="125e6" lat="5E-5"
368          bb_bw="2.25e9" bb_lat="5E-4"/>
369 \endverbatim
370
371 The second example creates one router and 100 machines with the following names:
372 \verbatim
373 c-my_cluster_2_router.me
374 c-0.me
375 c-1.me
376 c-2.me
377 ...
378 c-99.me
379 \endverbatim
380
381 \subsubsection pf_cabinet &lt;cabinet&gt;
382
383 \note
384     This tag is only available when the routing mode of the AS
385     is set to ``Cluster``.
386
387 The ``&lt;cabinet /&gt;`` tag is, like the \ref pf_cluster "&lt;cluster&gt;" tag,
388 a meta-tag. This means that it is simply a shortcut for creating a set of (homogenous) hosts and links quickly;
389 unsurprisingly, this tag was introduced to setup cabinets in data centers quickly. Unlike
390 &lt;cluster&gt;, however, the &lt;cabinet&gt; assumes that you create the backbone
391 and routers yourself; see our examples below.
392
393 #### Attributes ####
394
395 Attribute name  | Mandatory | Values | Description
396 --------------- | --------- | ------ | -----------
397 id              | yes       | string | The identifier of the cabinet. Facilitates referring to this cluster.
398 prefix          | yes       | string | Each node of the cabinet has to have a name. This name will be prefixed with this prefix.
399 suffix          | yes       | string | Each node of the cabinet will be suffixed with this suffix
400 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.
401 power           | yes       | int    | Same as the ``power`` attribute of the \ref pf_host "&lt;host&gt;" tag.
402 bw              | yes       | int    | Bandwidth for the links between nodes and backbone (if any). See the \ref pf_link "link section" for syntax/details.
403 lat             | yes       | int    | Latency for the links between nodes and backbone (if any). See the \ref pf_link "link section" for syntax/details.
404
405 \note
406     Please note that as of now, it is impossible to change attributes such as,
407     amount of cores (always set to 1), the initial state of hosts/links
408     (always set to ON), the sharing policy of the links (always set to \ref sharing_policy_fullduplex "FULLDUPLEX").
409
410 #### Example ####
411
412 The following example was taken from ``examples/platforms/meta_cluster.xml`` and
413 shows how to use the cabinet tag.
414
415 \verbatim
416   <AS  id="my_cluster1"  routing="Cluster">
417     <cabinet id="cabinet1" prefix="host-" suffix=".cluster1"
418       power="1Gf" bw="125MBps" lat="100us" radical="1-10"/>
419     <cabinet id="cabinet2" prefix="host-" suffix=".cluster1"
420       power="1Gf" bw="125MBps" lat="100us" radical="11-20"/>
421     <cabinet id="cabinet3" prefix="host-" suffix=".cluster1"
422       power="1Gf" bw="125MBps" lat="100us" radical="21-30"/>
423
424     <backbone id="backbone1" bandwidth="2.25GBps" latency="500us"/>
425   </AS>
426 \endverbatim
427
428 \note
429    Please note that you must specify the \ref pf_backbone "&lt;backbone&gt;"
430    tag by yourself; this is not done automatically and there are no checks
431    that ensure this backbone was defined.
432
433 The hosts generated in the above example are named host-1.cluster, host-2.cluster1
434 etc.
435
436
437 \subsubsection pf_peer The &lt;peer&gt; tag
438
439 This tag represents a peer, as in Peer-to-Peer (P2P) networks. However, internally,
440 SimGrid transforms a peer into an AS (similar to Cluster). Hence, this tag
441 is virtually only a shortcut that comes with some pre-defined resources
442 and values. These are:
443
444 \li A tiny AS whose routing type is cluster is created
445 \li A host
446 \li Two links: One for download and one for upload. This is
447     convenient to use and simulate stuff under the last mile model (e.g., ADSL peers).
448 \li It connects the two links to the host
449 \li It creates a router (a gateway) that serves as an entry point for this peer zone.
450     This router has coordinates.
451
452 #### Attributes ####
453
454 Attribute name  | Mandatory | Values | Description
455 --------------- | --------- | ------ | -----------
456 id              | yes       | string | The identifier of the peer. Facilitates referring to this peer.
457 power           | yes       | int    | See the description of the ``host`` tag for this attribute
458 bw_in           | yes       | int    | Bandwidth downstream
459 bw_out          | yes       | int    | Bandwidth upstream
460 lat             | yes       | double | Latency for both up- and downstream, in seconds.
461 coordinates     | no        | string | Coordinates of the gateway for this peer. Example value: 12.8 14.4 6.4
462 sharing_policy  | no        | SHARED\|FULLDUPLEX (default: FULLDUPLEX) | Sharing policy for links. See <b>link</b> description for details.
463 availability_file| no       | string | Availability file for the peer. Same as host availability file. See <b>host</b> description for details.
464 state_file      | no        | string | State file for the peer. Same as host state file. See <b>host</b> description for details.
465
466 Internally, SimGrid transforms any ``\<peer/\>`` construct such as
467 \verbatim
468 <peer id="FOO"
469   coordinates="12.8 14.4 6.4"
470   power="1.5Gf"
471   bw_in="2.25GBps"
472   bw_out="2.25GBps"
473   lat="500us" />
474 \endverbatim
475 into an ``\<AS\>`` (see Sections \ref pf_basics and \ref pf_As). In fact, this example of the ``\<peer/\>`` tag
476 is completely equivalent to the following declaration:
477
478 \verbatim
479 <AS id="as_FOO" routing="Cluster">
480    <host id="peer_FOO" power="1.5Gf"/>
481    <link id="link_FOO_UP" bandwidth="2.25GBps" latency="500us"/>
482    <link id="link_FOO_DOWN" bandwidth="2.25GBps" latency="500us"/>
483    <router id="router_FOO" coordinates="25.5 9.4 1.4"/>
484    <host_link id="peer_FOO" up="link_FOO_UP" down="link_FOO_DOWN"/>
485 </AS>
486 \endverbatim
487
488
489 \subsection pf_ne Network equipments: links and routers
490
491 There are two tags at all times available to represent network entities and
492 several other tags that are available only in certain contexts.
493 1. ``<link>``: Represents a entity that has a limited bandwidth, a
494     latency, and that can be shared according to TCP way to share this
495     bandwidth.
496 \remark
497   The concept of links in SimGrid may not be intuitive, as links are not limited
498   to connecting (exactly) two entities; in fact, you can have more than two equipments
499   connected to it. (In graph theoretical terms: A link in SimGrid is not an edge,
500   but a hyperedge)
501
502 2. ``<router/>``: Represents an entity that a message can be routed
503     to, but that is unable to execute any code. In SimGrid, routers have also
504     no impact on the performance: Routers do not limit any bandwidth nor
505     do they increase latency. As a matter of fact, routers are (almost) ignored
506     by the simulator when the simulation has begun.
507
508 3. ``<backbone/>``: This tag is only available when the containing AS is
509                     used as a cluster (i.e., mode="Cluster")
510
511 \remark
512     If you want to represent an entity like a switch, you must use ``<link>`` (see section). Routers are used
513     to run some routing algorithm and determine routes (see Section \ref pf_routing for details).
514
515 \subsubsection pf_router &lt;router/&gt;
516
517 %As said before, <b>router</b> is used only to give some information
518 for routing algorithms. So, it does not have any attributes except :
519
520 #### Attributes ####
521
522 Attribute name  | Mandatory | Values | Description
523 --------------- | --------- | ------ | -----------
524 id              | yes       | string | The identifier of the router to be used when referring to it.
525 coordinates     | yes       | string | Must be provided when choosing the Vivaldi, coordinate-based routing model for the AS the router belongs to. More details can be found in the Section \ref pf_P2P_tags.
526
527 #### Example ####
528
529 \verbatim
530  <router id="gw_dc1_horizdist"/>
531 \endverbatim
532
533 \subsubsection pf_link &lt;link/&gt;
534
535 Network links can represent one-hop network connections. They are
536 characterized by their id and their bandwidth; links can (but may not) be subject
537 to latency.
538
539 #### Attributes ####
540
541 Attribute name  | Mandatory | Values | Description
542 --------------- | --------- | ------ | -----------
543 id              | yes       | string | The identifier of the link to be used when referring to it.
544 bandwidth       | yes       | int    | Maximum bandwidth for this link, given in bytes/s
545 latency         | no        | double (default: 0.0) | Latency for this link.
546 sharing_policy  | no        | \ref sharing_policy_shared "SHARED"\|\ref sharing_policy_fatpipe "FATPIPE"\|\ref sharing_policy_fullduplex "FULLDUPLEX" (default: SHARED) | Sharing policy for the link.
547 state           | no        | ON\|OFF (default: ON) | Allows you to to turn this link on or off (working / not working)
548 bandwidth_file  | no        | string | Allows you to use a file as input for bandwidth.
549 latency_file    | no        | string | Allows you to use a file as input for latency.
550 state_file      | no        | string | Allows you to use a file as input for states.
551
552
553 #### Possible shortcuts for ``latency`` ####
554
555 When using the latency attribute, you can specify the latency by using the scientific
556 notation or by using common abbreviations. For instance, the following three tags
557 are equivalent:
558
559 \verbatim
560  <link id="LINK1" bandwidth="125000000" latency="5E-6"/>
561  <link id="LINK1" bandwidth="125000000" latency="5us"/>
562  <link id="LINK1" bandwidth="125000000" latency="0.000005"/>
563 \endverbatim
564
565 Here, the second tag uses "us", meaning "microseconds". Other shortcuts are:
566
567 Name | Abbreviation | Time (in seconds)
568 ---- | ------------ | -----------------
569 Week | w | 7 * 24 * 60 * 60
570 Day  | d | 24 * 60 * 60
571 Hour | h | 60 * 60
572 Minute | m | 60
573 Second | s | 1
574 Millisecond | ms | 0.001 = 10^(-3)
575 Microsecond | us | 0.000001 = 10^(-6)
576 Nanosecond  | ns | 0.000000001 = 10^(-9)
577 Picosecond  | ps | 0.000000000001 = 10^(-12)
578
579 #### Sharing policy ####
580
581 \anchor sharing_policy_shared
582 By default a network link is \b SHARED, i.e., if two or more data flows go
583 through a link, the bandwidth is shared fairly among all data flows. This
584 is similar to the sharing policy TCP uses.
585
586 \anchor sharing_policy_fatpipe
587 On the other hand, if a link is defined as a \b FATPIPE,
588 each flow going through this link will be provided with the complete bandwidth,
589 i.e., no sharing occurs and the bandwidth is only limiting each flow individually.
590 Please note that this is really on a per-flow basis, not only on a per-host basis!
591 The complete bandwidth provided by this link in this mode
592 is ``number_of_flows*bandwidth``, with at most ``bandwidth`` being available per flow.
593
594 Using the FATPIPE mode allows to model backbones that won't affect performance
595 (except latency).
596
597 \anchor sharing_policy_fullduplex
598 The last mode available is \b FULLDUPLEX. This means that SimGrid will
599 automatically generate two links (one carrying the suffix _UP and the other the
600 suffix _DOWN) for each ``<link>`` tag. This models situations when the direction
601 of traffic is important.
602
603 \remark
604   Transfers from one side to the other will interact similarly as
605   TCP when ACK returning packets circulate on the other direction. More
606   discussion about it is available in the description of link_ctn description.
607
608 In other words: The SHARED policy defines a physical limit for the bandwidth.
609 The FATPIPE mode defines a limit for each application,
610 with no upper total limit.
611
612 \remark
613   Tip: By using the FATPIPE mode, you can model big backbones that
614   won't affect performance (except latency).
615
616 #### Example ####
617
618 \verbatim
619  <link id="SWITCH" bandwidth="125000000" latency="5E-5" sharing_policy="FATPIPE" />
620 \endverbatim
621
622 #### Expressing dynamism and failures ####
623
624 Similar to hosts, it is possible to declare links whose state, bandwidth
625 or latency changes over time (see Section \ref pf_host_dynamism for details).
626
627 In the case of network links, the ``bandwidth`` and ``latency`` attributes are
628 replaced by the ``bandwidth_file`` and ``latency_file`` attributes.
629 The following XML snippet demonstrates how to use this feature in the platform
630 file. The structure of the files "link1.bw" and "link1.lat" is shown below.
631
632 \verbatim
633 <link id="LINK1" state_file="link1.fail" bandwidth="80000000" latency=".0001" bandwidth_file="link1.bw" latency_file="link1.lat" />
634 \endverbatim
635
636 \note
637   Even if the syntax is the same, the semantic of bandwidth and latency
638   trace files differs from that of host availability files. For bandwidth and
639   latency, the corresponding files do not
640   express availability as a fraction of the available capacity but directly in
641   bytes per seconds for the bandwidth and in seconds for the latency. This is
642   because most tools allowing to capture traces on real platforms (such as NWS)
643   express their results this way.
644
645 ##### Example of "link1.bw" file #####
646
647 ~~~{.py}
648 PERIODICITY 12.0
649 4.0 40000000
650 8.0 60000000
651 ~~~
652
653 In this example, the bandwidth changes repeatedly, with all changes
654 being repeated every 12 seconds.
655
656 At the beginning of the the simulation, the link's bandwidth is 80,000,000
657 B/s (i.e., 80 Mb/s); this value was defined in the XML snippet above.
658 After four seconds, it drops to 40 Mb/s (line 2), and climbs
659 back to 60 Mb/s after another 4 seconds (line 3). The value does not change any
660 more until the end of the period, that is, after 12 seconds have been simulated).
661 At this point, periodicity kicks in and this behavior is repeated: Seconds
662 12-16 will experience 80 Mb/s, 16-20 40 Mb/s etc.).
663
664 ##### Example of "link1.lat" file #####
665
666 ~~~{.py}
667 PERIODICITY 5.0
668 1.0 0.001
669 2.0 0.01
670 3.0 0.001
671 ~~~
672
673 In this example, the latency varies with a period of 5 seconds.
674 In the xml snippet above, the latency is initialized to be 0.0001s (100µs). This
675 value will be kept during the first second, since the latency_file contains
676 changes to this value at second one, two and three.
677 At second one, the value will be 0.001, i.e., 1ms. One second later it will
678 be adjusted to 0.01 (or 10ms) and one second later it will be set again to 1ms. The
679 value will not change until second 5, when the periodicity defined in line 1
680 kicks in. It then loops back, starting at 100µs (the initial value) for one second.
681
682
683 #### The ``<prop/>`` tag ####
684
685 Similar to ``\<host\>``, the link may also contain the ``<prop/>`` tag; see the host
686 documentation (Section \ref pf_host) for an example.
687
688
689 TODO
690
691 \subsubsection pf_backbone <backbone/>
692
693 \note
694   This tag is <b>only available</b> when the containing AS uses the "Cluster" mode!
695
696 Using this tag, you can designate an already existing link to be a backbone.
697
698 Attribute name  | Mandatory | Values | Description
699 --------------- | --------- | ------ | -----------
700 id              | yes       | string | Name of the link that is supposed to act as a backbone.
701
702 \subsection pf_storage Storage
703
704 \note
705   This is a prototype version that should evolve quickly, this
706   is just some doc valuable only at the time of writing this doc
707   This section describes the storage management under SimGrid ; nowadays
708   it's only usable with MSG. It relies basically on linux-like concepts.
709   You also may want to have a look to its corresponding section in \ref
710   msg_file_management ; functions access are organized as a POSIX-like
711   interface.
712
713 \subsubsection pf_sto_conc Storage Main concepts
714 Basically there are 3 different entities available in SimGrid that
715 can be used to model storages:
716
717 Entity name     | Description
718 --------------- | -----------
719 \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), content, ... 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 size or read/write performance).
720 \ref pf_storage_entity_storage "storage"        | Defines an actual instance of a storage (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.
721 \ref pf_storage_entity_mount "mount"          | Must be wrapped by a \ref pf_host tag; declares which storage(s) this host has mounted and where (i.e., the mountpoint).
722
723
724 \anchor pf_storage_content_file
725 ### %Storage Content File ###
726
727 In order to assess exactly how much time is spent reading from the storage,
728 SimGrid needs to know what is stored in the storage device (identified by distinct (file-)name, like in a file system)
729 and what size this content has.
730
731 \note
732     The content file is never changed by the simulation; it is parsed once
733     per simulation and kept in memory afterwards. When the content of the
734     storage changes, only the internal SimGrid data structures change.
735
736 \anchor pf_storage_content_file_structure
737 #### Structure of a %Storage File ####
738
739 Here is an excerpt from two storage file; if you want to see the whole file, check
740 the file ``examples/platforms/content/storage_content.txt`` that comes with the
741 SimGrid source code.
742
743 SimGrid essentially supports two different formats: UNIX-style filepaths should
744 follow the well known format:
745
746 \verbatim
747 /lib/libsimgrid.so.3.6.2  12710497
748 /bin/smpicc  918
749 /bin/smpirun  7292
750 /bin/smpif2c  1990
751 /bin/simgrid_update_xml  5018
752 /bin/graphicator  66986
753 /bin/simgrid-colorizer  2993
754 /bin/smpiff  820
755 /bin/tesh  356434
756 \endverbatim
757
758 Windows filepaths, unsurprisingly, use the windows style:
759
760 \verbatim
761 \Windows\avastSS.scr 41664
762 \Windows\bfsvc.exe 75264
763 \Windows\bootstat.dat 67584
764 \Windows\CoreSingleLanguage.xml 31497
765 \Windows\csup.txt 12
766 \Windows\dchcfg64.exe 335464
767 \Windows\dcmdev64.exe 93288
768 \endverbatim
769
770 \note
771     The different file formats come at a cost; in version 3.12 (and most likely
772     in later versions, too), copying files from windows-style storages to unix-style
773     storages (and vice versa) is not supported.
774
775 \anchor pf_storage_content_file_create
776 #### Generate a %Storage Content File ####
777
778 If you want to generate a storage content file based on your own filesystem (or at least a filesystem you have access to),
779 try running this command (works only on unix systems):
780
781 \verbatim
782 find /path/you/want -type f -exec ls -l {} \; 2>/dev/null > ./content.txt
783 \endverbatim
784
785 \subsubsection pf_storage_entities The Storage Entities
786
787 These are the entities that you can use in your platform files to include
788 storage in your model. See also the list of our \ref pf_storage_example_files "example files";
789 these might also help you to get started.
790
791 \anchor pf_storage_entity_storage_type
792 #### \<storage_type\> ####
793
794 Attribute name  | Mandatory | Values | Description
795 --------------- | --------- | ------ | -----------
796 id              | yes       | string | Identifier of this storage_type; used when referring to it
797 model           | yes       | string | For reasons of future backwards compatibility only; specifies the name of the model for the storage that should be used
798 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)
799 content         | yes       | string | Path to a \ref pf_storage_content_file "Storage Content File" on your system. This file must exist.
800 content_type    | no        | ("txt_unix"\|"txt_win") | Determines which kind of filesystem you're using; make sure the filenames (stored in that file, see \ref pf_storage_content_file_structure "Storage Content File Structure"!)
801
802 This tag must contain some predefined model properties, specified via the &lt;model_prop&gt; tag. Here is a list,
803 see below for an example:
804
805 Property id     | Mandatory | Values | Description
806 --------------- | --------- | ------ | -----------
807 Bwrite          | yes       | string | Bandwidth for write access; in B/s (but you can also specify e.g. "30MBps")
808 Bread           | yes       | string | Bandwidth for read access; in B/s (but you can also specify e.g. "30MBps")
809 Bconnexion      | yes       | string | Throughput (of the storage connector) in B/s.
810
811 \note
812      A storage_type can also contain the <b>&lt;prop&gt;</b> tag. The &lt;prop&gt; tag allows you
813      to associate additional information to this &lt;storage_type&gt; and follows the
814      attribute/value schema; see the example below. You may want to use it to give information to
815      the tool you use for rendering your simulation, for example.
816
817 Here is a complete example for the ``storage_type`` tag:
818 \verbatim
819 <storage_type id="single_HDD" model="linear_no_lat" size="4000" content_type="txt_unix">
820   <model_prop id="Bwrite" value="30MBps" />
821   <model_prop id="Bread" value="100MBps" />
822   <model_prop id="Bconnection" value="150MBps" />
823   <prop id="Brand" value="Western Digital" />
824 </storage_type>
825 \endverbatim
826
827 \anchor pf_storage_entity_storage
828 #### &lt;storage&gt; ####
829
830 ``storage`` attributes:
831
832 Attribute name | Mandatory | Values | Description
833 -------------- | --------- | ------ | -----------
834 id             | yes       | string | Identifier of this ``storage``; used when referring to it
835 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.
836 attach         | yes       | string | Name of a host (see Section \ref pf_host) that this storage is <i>physically</i> attached to (e.g., a harddrive in a computer)
837 content        | no        | string | When specified, overwrites the content attribute of \ref pf_storage_entity_storage_type "\<storage_type\>"
838 content_type   | no        | string | When specified, overwrites the content_type attribute of \ref pf_storage_entity_storage_type "\<storage_type\>"
839
840 Here are two examples:
841
842 \verbatim
843      <storage id="Disk1" typeId="single_HDD" attach="bob" />
844
845      <storage id="Disk2" typeId="single_SSD"
846               content="content/win_storage_content.txt"
847               content_type="txt_windows" attach="alice" />
848 \endverbatim
849
850 The first example is straightforward: A disk is defined and called "Disk1"; it is
851 of type "single_HDD" (shown as an example of \ref pf_storage_entity_storage_type "\<storage_type\>" above) and attached
852 to a host called "bob" (the definition of this host is omitted here).
853
854 The second storage is called "Disk2", is still of the same type as Disk1 but
855 now specifies a new content file (so the content will be different from Disk1)
856 and the filesystem uses the windows style; finally, it is attached to a second host,
857 called alice (which is again not defined here).
858
859 \anchor pf_storage_entity_mount
860 #### &lt;mount&gt; ####
861
862 Attributes:
863 | Attribute name   | Mandatory   | Values   | Description                                                                                               |
864 | ---------------- | ----------- | -------- | -------------                                                                                             |
865 | id               | yes         | string   | Refers to a \ref pf_storage_entity_storage "&lt;storage&gt;" entity that will be mounted on that computer |
866 | name             | yes         | string   | Path/location to/of the logical reference (mount point) of this disk
867
868 This tag must be enclosed by a \ref pf_host tag. It then specifies where the mountpoint of a given storage device (defined by the ``id`` attribute)
869 is; this location is specified by the ``name`` attribute.
870
871 Here is a simple example, taken from the file ``examples/platform/storage.xml``:
872
873 \verbatim
874     <storage_type id="single_SSD" model="linear_no_lat" size="500GiB">
875        <model_prop id="Bwrite" value="60MBps" />
876        <model_prop id="Bread" value="200MBps" />
877        <model_prop id="Bconnection" value="220MBps" />
878     </storage_type>
879
880     <storage id="Disk2" typeId="single_SSD"
881               content="content/win_storage_content.txt"
882               content_type="txt_windows" attach="alice" />
883     <storage id="Disk4" typeId="single_SSD"
884              content="content/small_content.txt"
885              content_type="txt_unix" attach="denise"/>
886
887     <host id="alice" power="1Gf">
888       <mount storageId="Disk2" name="c:"/>
889     </host>
890
891     <host id="denise" power="1Gf">
892       <mount storageId="Disk2" name="c:"/>
893       <mount storageId="Disk4" name="/home"/>
894     </host>
895 \endverbatim
896
897 This example is quite interesting, as the same device, called "Disk2", is mounted by
898 two hosts at the same time! Note, however, that the host called ``alice`` is actually
899 attached to this storage, as can be seen in the \ref pf_storage_entity_storage "&lt;storage&gt;"
900 tag. This means that ``denise`` must access this storage via network, but SimGrid automatically takes
901 care of that for you.
902
903 Furthermore, this example shows that ``denise`` has mounted two storages with different
904 filesystem types (unix and windows). In general, a host can mount as many storage devices as
905 required.
906
907 \note
908     Again, the difference between ``attach`` and ``mount`` is simply that
909     an attached storage is always physically inside (or connected to) that machine;
910     for instance, a USB stick is attached to one and only one machine (where it's plugged-in)
911     but it can only be mounted on others, as mounted storage can also be a remote location.
912
913 \anchor pf_storage_entity_mstorage
914 #### &lt;mstorage&gt; ####
915 \note
916     This is currently unused.
917
918 <b>mstorage</b> attributes :
919 \li <b>typeId (mandatory)</b>: the id of the <b>storage</b> that must
920     be mounted on that computer.
921 \li <b>name (mandatory)</b>: the name that will be the logical
922     reference to this disk (the mount point).
923
924 \subsubsection pf_storage_example_files Example files
925
926 Several examples were already discussed above; if you're interested in full examples,
927 check the the following platforms:
928
929 1. ``examples/platforms/storage.xml``
930 2. ``examples/platforms/remote_io.xml``
931
932 If you're looking for some examplary C code, you may find the source code
933 available in the directory ``examples/msg/io/`` useful.
934
935 \subsubsection pf_storage_examples_modelling Modelling different situations
936
937 The storage functionality of SimGrid is type-agnostic, that is, the implementation
938 does not presume any type of storagei, such as HDDs/SSDs, RAM,
939 CD/DVD devices, USB sticks etc.
940
941 This allows the user to apply the simulator for a wide variety of scenarios; one
942 common scenario would be the access of remote RAM.
943
944 #### Modelling the access of remote RAM ####
945
946 How can this be achieved in SimGrid? Let's assume we have a setup where three hosts
947 (HostA, HostB, HostC) need to access remote RAM:
948
949 \verbatim
950       Host A
951     /
952 RAM -- Host B
953     \
954       Host C
955 \endverbatim
956
957 An easy way to model this scenario is to setup and define the RAM via the
958 \ref pf_storage_entity_storage "storage" and \ref pf_storage_entity_storage_type "storage type"
959 entities and attach it to a remote dummy host; then, every host can have their own links
960 to this host (modelling for instance certain scenarios, such as PCIe ...)
961
962 \verbatim
963               Host A
964             /
965 RAM - Dummy -- Host B
966             \
967               Host C
968 \endverbatim
969
970 Now, if read from this storage, the host that mounts this storage
971 communicates to the dummy host which reads from RAM and
972 sends the information back.
973
974
975 \section pf_routing Routing
976
977 To achieve high performance, the routing tables used within SimGrid are
978 static. This means that routing between two nodes is calculated once
979 and will not change during execution. The SimGrid team chose to use this
980 approach as it is rare to have a real deficiency of a resource;
981 most of the time, a communication fails because the links experience too much
982 congestion and hence, your connection stops before the timeout or
983 because the computer designated to be the destination of that message
984 is not responding.
985
986 We also chose to use shortest paths algorithms in order to emulate
987 routing. Doing so is consistent with the reality: RIP, OSPF, BGP are
988 all calculating shortest paths. They have some convergence time, but
989 at the end, so when the platform is stable (and this should be the
990 moment you want to simulate something using SimGrid) your packets will
991 follow the shortest paths.
992
993 \subsection pf_rm Routing models
994
995 Within each AS, you have to define a routing model to use. You have
996 basically 3 main kind of routing models :
997
998 \li Shortest-path based models: you let SimGrid calculates shortest
999     paths and manage it. Behaves more or less as most real life
1000     routing.
1001 \li Manually-entered route models: you'll have to define all routes
1002     manually by yourself into the platform description file.
1003     Consistent with some manually managed real life routing.
1004 \li Simple/fast models: those models offers fast, low memory routing
1005     algorithms. You should consider to use it if you can make some
1006     assumptions about your AS. Routing in this case is more or less
1007     ignored
1008
1009 \subsubsection pf_raf The router affair
1010
1011 Expressing routers becomes mandatory when using shortest-path based
1012 models or when using the bindings to the ns-3 packet-level
1013 simulator instead of the native analytical network model implemented
1014 in SimGrid.
1015
1016 For graph-based shortest path algorithms, routers are mandatory,
1017 because both algorithms need a graph, and so we need to have source
1018 and destination for each edge.
1019
1020 Routers are naturally an important concept in ns-3 since the
1021 way they run the packet routing algorithms is actually simulated.
1022 Instead, the SimGrid’s analytical models aggregate the routing time
1023 with the transfer time. Rebuilding a graph representation only from
1024 the route information turns to be a very difficult task, because of
1025 the missing information about how routes intersect. That is why we
1026 introduced a \<router\> tag, which is simply used to express these
1027 intersection points. The only attribute accepted by this tag an id. It
1028 is important to understand that the \<router\> tag is only used to
1029 provide topological information.
1030
1031 To express those topological information, some <b>route</b> have to be
1032 defined saying which link is between which routers. Description or the
1033 route syntax is given below, as well as example for the different
1034 models.
1035
1036 \subsubsection pf_rm_sh Shortest-path based models
1037
1038 Here is the complete list of such models, that computes routes using
1039 classic shortest-paths algorithms. How to choose the best suited
1040 algorithm is discussed later in the section devoted to it.
1041
1042 \li <b>Floyd</b>: Floyd routing data. Pre-calculates all routes once.
1043 \li <b>Dijkstra</b>: Dijkstra routing data ,calculating routes when
1044     necessary.
1045 \li <b>DijkstraCache</b>: Dijkstra routing data. Handle some cache for
1046     already calculated routes.
1047
1048 All those shortest-path models are instanciated the same way. Here are
1049 some example of it:
1050
1051 Floyd example :
1052 \verbatim
1053 <AS  id="AS0"  routing="Floyd">
1054
1055   <cluster id="my_cluster_1" prefix="c-" suffix=""
1056                 radical="0-1"   power="1000000000"    bw="125000000"     lat="5E-5"
1057         router_id="router1"/>
1058
1059  <AS id="AS1" routing="None">
1060     <host id="host1" power="1000000000"/>
1061  </AS>
1062
1063   <link id="link1" bandwidth="100000" latency="0.01"/>
1064
1065   <ASroute src="my_cluster_1" dst="AS1"
1066     gw_src="router1"
1067     gw_dst="host1">
1068     <link_ctn id="link1"/>
1069   </ASroute>
1070
1071 </AS>
1072 \endverbatim
1073
1074 ASroute given at the end gives a topological information: link1 is
1075 between router1 and host1.
1076
1077 Dijsktra example :
1078 \verbatim
1079  <AS id="AS_2" routing="Dijsktra">
1080      <host id="AS_2_host1" power="1000000000"/>
1081      <host id="AS_2_host2" power="1000000000"/>
1082      <host id="AS_2_host3" power="1000000000"/>
1083      <link id="AS_2_link1" bandwidth="1250000000" latency="5E-4"/>
1084      <link id="AS_2_link2" bandwidth="1250000000" latency="5E-4"/>
1085      <link id="AS_2_link3" bandwidth="1250000000" latency="5E-4"/>
1086      <link id="AS_2_link4" bandwidth="1250000000" latency="5E-4"/>
1087      <router id="central_router"/>
1088      <router id="AS_2_gateway"/>
1089      <!-- routes providing topological information -->
1090      <route src="central_router" dst="AS_2_host1"><link_ctn id="AS_2_link1"/></route>
1091      <route src="central_router" dst="AS_2_host2"><link_ctn id="AS_2_link2"/></route>
1092      <route src="central_router" dst="AS_2_host3"><link_ctn id="AS_2_link3"/></route>
1093      <route src="central_router" dst="AS_2_gateway"><link_ctn id="AS_2_link4"/></route>
1094   </AS>
1095 \endverbatim
1096
1097 DijsktraCache example :
1098 \verbatim
1099 <AS id="AS_2" routing="DijsktraCache">
1100      <host id="AS_2_host1" power="1000000000"/>
1101      ...
1102 (platform unchanged compared to upper example)
1103 \endverbatim
1104
1105 \subsubsection pf_rm_me Manually-entered route models
1106
1107 \li <b>Full</b>: You have to enter all necessary routes manually
1108
1109 Full example :
1110 \verbatim
1111 <AS  id="AS0"  routing="Full">
1112    <host id="host1" power="1000000000"/>
1113    <host id="host2" power="1000000000"/>
1114    <link id="link1" bandwidth="125000000" latency="0.000100"/>
1115    <route src="host1" dst="host2"><link_ctn id="link1"/></route>
1116  </AS>
1117 \endverbatim
1118
1119 \subsubsection pf_rm_sf Simple/fast models
1120
1121 \li <b>None</b>: No routing (Unless you know what you are doing, avoid
1122 using this mode in combination with a non Constant network model).
1123 None Example :
1124 \verbatim
1125 <AS id="exitAS"  routing="None">
1126         <router id="exit_gateway"/>
1127 </AS>\endverbatim
1128
1129 \li <b>Vivaldi</b>: Vivaldi routing, so when you want to use
1130     coordinates. See the corresponding section P2P below for details.
1131 \li <b>Cluster</b>: Cluster routing, specific to cluster tag, should
1132     not be used, except internally.
1133
1134 \subsection ps_dec Defining routes
1135
1136 The principle of route definition is the same for the 4 available tags
1137 for doing it. Those for tags are:
1138
1139 \li <b>route</b>: to define route between host/router
1140 \li <b>ASroute</b>: to define route between AS
1141 \li <b>bypassRoute</b>: to bypass normal routes as calculated by the
1142     network model between host/router
1143 \li <b>bypassASroute</b>: same as bypassRoute, but for AS
1144
1145 Basically all those tags will contain an (ordered) list of references
1146 to link that compose the route you want to define.
1147
1148 Consider the example below:
1149
1150 \verbatim
1151 <route src="Alice" dst="Bob">
1152         <link_ctn id="link1"/>
1153         <link_ctn id="link2"/>
1154         <link_ctn id="link3"/>
1155    </route>
1156 \endverbatim
1157
1158 The route here from host Alice to Bob will be first link1, then link2,
1159 and finally link3. What about the reverse route ? <b>route</b> and
1160 <b>ASroute</b> have an optional attribute <b>symmetrical</b>, that can
1161 be either YES or NO. YES means that the reverse route is the same
1162 route in the inverse order, and is set to YES by default. Note that
1163 this is not the case for bypass*Route, as it is more probable that you
1164 want to bypass only one default route.
1165
1166 For an ASroute, things are just slightly more complicated, as you have
1167 to give the id of the gateway which is inside the AS you're talking
1168 about you want to access ... So it looks like this :
1169
1170
1171 \verbatim
1172   <ASroute src="AS1" dst="AS2"
1173     gw_src="router1" gw_dst="router2">
1174     <link_ctn id="link1"/>
1175   </ASroute>
1176 \endverbatim
1177
1178 gw == gateway, so when any message are trying to go from AS1 to AS2,
1179 it means that it must pass through router1 to get out of the AS, then
1180 pass through link1, and get into AS2 by being received by router2.
1181 router1 must belong to AS1 and router2 must belong to AS2.
1182
1183 \subsubsection pf_linkctn link_ctn
1184
1185 a <b>link_ctn</b> is the tag that is used in order to reference a
1186 <b>link</b> in a route. Its id is the link id it refers to.
1187
1188 <b>link_ctn</b> attributes :
1189 \li <b>id (mandatory)</b>: Id of the link this tag refers to
1190 \li <b>direction</b>: if the link referenced by <b>id</b> has been
1191     declared as FULLDUPLEX, this is used to indicate in which
1192     direction the route you're defining is going through this link.
1193     Possible values "UP" or "DOWN".
1194
1195 \subsubsection pf_asro ASroute
1196
1197 ASroute tag purpose is to let people write manually their routes
1198 between AS. It's useful when you're in Full model.
1199
1200 <b>ASroute</b> attributes :
1201 \li <b>src (mandatory)</b>: the source AS id.
1202 \li <b>dst (mandatory)</b>: the destination AS id.
1203 \li <b>gw_src (mandatory)</b>: the gateway to be used within the AS.
1204     Can be any <b>host</b> or \b router defined into the \b src AS or
1205     into one of the AS it includes.
1206 \li <b>gw_dst (mandatory)</b>: the gateway to be used within the AS.
1207     Can be any <b>host</b> or \b router defined into the \b dst AS or
1208     into one of the AS it includes.
1209 \li <b>symmetrical</b>: if the route is symmetric, the reverse route
1210     will be the opposite of the one defined. Can be either YES or NO,
1211     default is YES.
1212
1213 <b>Example of ASroute with Full</b>
1214 \verbatim
1215 <AS  id="AS0"  routing="Full">
1216   <cluster id="my_cluster_1" prefix="c-" suffix=".me"
1217                 radical="0-149" power="1000000000"    bw="125000000"     lat="5E-5"
1218         bb_bw="2250000000" bb_lat="5E-4"/>
1219
1220   <cluster id="my_cluster_2" prefix="c-" suffix=".me"
1221             radical="150-299" power="1000000000"        bw="125000000"  lat="5E-5"
1222             bb_bw="2250000000" bb_lat="5E-4"/>
1223
1224      <link id="backbone" bandwidth="1250000000" latency="5E-4"/>
1225
1226      <ASroute src="my_cluster_1" dst="my_cluster_2"
1227          gw_src="c-my_cluster_1_router.me"
1228          gw_dst="c-my_cluster_2_router.me">
1229                 <link_ctn id="backbone"/>
1230      </ASroute>
1231      <ASroute src="my_cluster_2" dst="my_cluster_1"
1232          gw_src="c-my_cluster_2_router.me"
1233          gw_dst="c-my_cluster_1_router.me">
1234                 <link_ctn id="backbone"/>
1235      </ASroute>
1236 </AS>
1237 \endverbatim
1238
1239 \subsubsection pf_ro route
1240 The principle is the same as ASroute : <b>route</b> contains list of
1241 links that are in the path between src and dst, except that it is for
1242 routes between a src that can be either <b>host</b> or \b router and a
1243 dst that can be either <b>host</b> or \b router. Useful for Full
1244 as well as for the shortest-paths based models, where you
1245 have to give topological information.
1246
1247
1248 <b>route</b> attributes :
1249 \li <b>src (mandatory)</b>: the source id.
1250 \li <b>dst (mandatory)</b>: the destination id.
1251 \li <b>symmetrical</b>: if the route is symmetric, the reverse route
1252     will be the opposite of the one defined. Can be either YES or NO,
1253     default is YES.
1254
1255 <b>route example in Full</b>
1256 \verbatim
1257  <route src="Tremblay" dst="Bourassa">
1258      <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"/>
1259    </route>
1260 \endverbatim
1261
1262 <b>route example in a shortest-path model</b>
1263 \verbatim
1264  <route src="Tremblay" dst="Bourassa">
1265      <link_ctn id="3"/>
1266    </route>
1267 \endverbatim
1268 Note that when using route to give topological information, you have
1269 to give routes with one link only in it, as SimGrid needs to know
1270 which host are at the end of the link.
1271
1272 \subsubsection pf_byASro bypassASroute
1273
1274 <b>Note : bypassASroute and bypassRoute are under rewriting to perform
1275 better ; so you may not use it yet</b> As said before, once you choose
1276 a model, it (if so) calculates routes for you. But maybe you want to
1277 define some of your routes, which will be specific. You may also want
1278 to bypass some routes defined in lower level AS at an upper stage :
1279 <b>bypassASroute</b> is the tag you're looking for. It allows to
1280 bypass routes defined between already defined between AS (if you want
1281 to bypass route for a specific host, you should just use byPassRoute).
1282 The principle is the same as ASroute : <b>bypassASroute</b> contains
1283 list of links that are in the path between src and dst.
1284
1285 <b>bypassASroute</b> attributes :
1286 \li <b>src (mandatory)</b>: the source AS id.
1287 \li <b>dst (mandatory)</b>: the destination AS id.
1288 \li <b>gw_src (mandatory)</b>: the gateway to be used within the AS.
1289     Can be any <b>host</b> or \b router defined into the \b src AS or
1290     into one of the AS it includes.
1291 \li <b>gw_dst (mandatory)</b>: the gateway to be used within the AS.
1292     Can be any <b>host</b> or \b router defined into the \b dst AS or
1293     into one of the AS it includes.
1294 \li <b>symmetrical</b>: if the route is symmetric, the reverse route
1295     will be the opposite of the one defined. Can be either YES or NO,
1296     default is YES.
1297
1298 <b>bypassASroute Example</b>
1299 \verbatim
1300     <bypassASRoute src="my_cluster_1" dst="my_cluster_2"
1301      gw_src="my_cluster_1_router"
1302      gw_dst="my_cluster_2_router">
1303         <link_ctn id="link_tmp"/>
1304      </bypassASroute>
1305 \endverbatim
1306
1307 \subsubsection pf_byro bypassRoute
1308 <b>Note : bypassASRoute and bypassRoute are under rewriting to perform
1309 better ; so you may not use it yet</b> As said before, once you choose
1310 a model, it (if so) calculates routes for you. But maybe you want to
1311 define some of your routes, which will be specific. You may also want
1312 to bypass some routes defined in lower level AS at an upper stage :
1313 <b>bypassRoute</b> is the tag you're looking for. It allows to bypass
1314 routes defined between <b>host/router</b>. The principle is the same
1315 as route : <b>bypassRoute</b> contains list of links references of
1316 links that are in the path between src and dst.
1317
1318 <b>bypassRoute</b> attributes :
1319 \li <b>src (mandatory)</b>: the source AS id.
1320 \li <b>dst (mandatory)</b>: the destination AS id.
1321 \li <b>symmetrical</b>: if the route is symmetric, the reverse route
1322     will be the opposite of the one defined. Can be either YES or NO,
1323     default is YES.
1324
1325 <b>bypassRoute Example</b>
1326 \verbatim
1327     <bypassRoute src="host_1" dst="host_2">
1328         <link_ctn id="link_tmp"/>
1329      </bypassRoute>
1330 \endverbatim
1331
1332
1333 \subsection pb_baroex Basic Routing Example
1334
1335 Let's say you have an AS named AS_Big that contains two other AS, AS_1
1336 and AS_2. If you want to make a host (h1) from AS_1 with another one
1337 (h2) from AS_2 then you'll have to proceed as follows:
1338 \li First, you have to ensure that a route is defined from h1 to the
1339     AS_1's exit gateway and from h2 to AS_2's exit gateway.
1340 \li Then, you'll have to define a route between AS_1 to AS_2. As those
1341     AS are both resources belonging to AS_Big, then it has to be done
1342     at AS_big level. To define such a route, you have to give the
1343     source AS (AS_1), the destination AS (AS_2), and their respective
1344     gateway (as the route is effectively defined between those two
1345     entry/exit points). Elements of this route can only be elements
1346     belonging to AS_Big, so links and routers in this route should be
1347     defined inside AS_Big. If you choose some shortest-path model,
1348     this route will be computed automatically.
1349
1350 As said before, there are mainly 2 tags for routing :
1351 \li <b>ASroute</b>: to define routes between two  <b>AS</b>
1352 \li <b>route</b>: to define routes between two <b>host/router</b>
1353
1354 As we are dealing with routes between AS, it means that those we'll
1355 have some definition at AS_Big level. Let consider AS_1 contains 1
1356 host, 1 link and one router and AS_2 3 hosts, 4 links and one router.
1357 There will be a central router, and a cross-like topology. At the end
1358 of the crosses arms, you'll find the 3 hosts and the router that will
1359 act as a gateway. We have to define routes inside those two AS. Let
1360 say that AS_1 contains full routes, and AS_2 contains some Floyd
1361 routing (as we don't want to bother with defining all routes). As
1362 we're using some shortest path algorithms to route into AS_2, we'll
1363 then have to define some <b>route</b> to gives some topological
1364 information to SimGrid. Here is a file doing it all :
1365
1366 \verbatim
1367 <AS  id="AS_Big"  routing="Dijsktra">
1368   <AS id="AS_1" routing="Full">
1369      <host id="AS_1_host1" power="1000000000"/>
1370      <link id="AS_1_link" bandwidth="1250000000" latency="5E-4"/>
1371      <router id="AS_1_gateway"/>
1372      <route src="AS_1_host1" dst="AS_1_gateway">
1373             <link_ctn id="AS_1_link"/>
1374      </route>
1375   </AS>
1376   <AS id="AS_2" routing="Floyd">
1377      <host id="AS_2_host1" power="1000000000"/>
1378      <host id="AS_2_host2" power="1000000000"/>
1379      <host id="AS_2_host3" power="1000000000"/>
1380      <link id="AS_2_link1" bandwidth="1250000000" latency="5E-4"/>
1381      <link id="AS_2_link2" bandwidth="1250000000" latency="5E-4"/>
1382      <link id="AS_2_link3" bandwidth="1250000000" latency="5E-4"/>
1383      <link id="AS_2_link4" bandwidth="1250000000" latency="5E-4"/>
1384      <router id="central_router"/>
1385      <router id="AS_2_gateway"/>
1386      <!-- routes providing topological information -->
1387      <route src="central_router" dst="AS_2_host1"><link_ctn id="AS_2_link1"/></route>
1388      <route src="central_router" dst="AS_2_host2"><link_ctn id="AS_2_link2"/></route>
1389      <route src="central_router" dst="AS_2_host3"><link_ctn id="AS_2_link3"/></route>
1390      <route src="central_router" dst="AS_2_gateway"><link_ctn id="AS_2_link4"/></route>
1391   </AS>
1392     <link id="backbone" bandwidth="1250000000" latency="5E-4"/>
1393
1394      <ASroute src="AS_1" dst="AS_2"
1395          gw_src="AS_1_gateway"
1396          gw_dst="AS_2_gateway">
1397                 <link_ctn id="backbone"/>
1398      </ASroute>
1399 </AS>
1400 \endverbatim
1401
1402 \section pf_other_tags Tags not (directly) describing the platform
1403
1404 There are 3 tags, that you can use inside a \<platform\> tag that are
1405 not describing the platform:
1406 \li random: it allows you to define random generators you want to use
1407     for your simulation.
1408 \li config: it allows you to pass some configuration stuff like, for
1409     example, the network model and so on. It follows the
1410 \li include: simply allows you to include another file into the
1411     current one.
1412
1413 \subsection pf_conf config
1414 <b>config</b> attributes :
1415 \li <b>id (mandatory)</b>: the identifier of the config to be used
1416     when referring to it.
1417
1418
1419 <b>config</b> tag only purpose is to include <b>prop</b> tags. Valid
1420 id are basically the same as the list of possible parameters you can
1421 use by command line, except that "/" are used for namespace
1422 definition. See the \ref options config and options page for more
1423 information.
1424
1425
1426 <b>config example</b>
1427 \verbatim
1428 <?xml version='1.0'?>
1429 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1430 <platform version="3">
1431 <config id="General">
1432         <prop id="maxmin/precision" value="0.000010"></prop>
1433         <prop id="cpu/optim" value="TI"></prop>
1434         <prop id="host/model" value="compound"></prop>
1435         <prop id="network/model" value="SMPI"></prop>
1436         <prop id="path" value="~/"></prop>
1437         <prop id="smpi/bw_factor" value="65472:0.940694;15424:0.697866;9376:0.58729"></prop>
1438 </config>
1439
1440 <AS  id="AS0"  routing="Full">
1441 ...
1442 \endverbatim
1443
1444
1445 \subsection pf_rand random
1446 Not yet in use, and possibly subject to huge modifications.
1447
1448 \subsection pf_incl include
1449 <b>include</b> tag allows to import into a file platform parts located
1450 in another file. This is done with the intention to help people
1451 combine their different AS and provide new platforms. Those files
1452 should contains XML part that contains either
1453 <b>include,cluster,peer,AS,trace,trace_connect</b> tags.
1454
1455 <b>include</b> attributes :
1456 \li <b>file (mandatory)</b>: filename of the file to include. Possible
1457     values: absolute or relative path, syntax similar to the one in
1458     use on your system.
1459
1460 <b>Note</b>: due to some obscure technical reasons, you have to open
1461 and close tag in order to let it work.
1462 <b>include Example</b>
1463 \verbatim
1464 <?xml version='1.0'?>
1465 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1466 <platform version="3">
1467         <AS id="main" routing="Full">
1468                 <include file="clusterA.xml"></include>
1469                 <include file="clusterB.xml"></include>
1470         </AS>
1471 </platform>
1472 \endverbatim
1473
1474 \subsection pf_tra trace and trace_connect
1475 Both tags are an alternate way to passe availability, state, and so on
1476 files to entity. Instead of referring to the file directly in the host,
1477 link, or cluster tag, you proceed by defining a trace with an id
1478 corresponding to a file, later a host/link/cluster, and finally using
1479 trace_connect you say that the file trace must be used by the entity.
1480 Get it ? Let's have a look at an example :
1481
1482 \verbatim
1483 <AS  id="AS0"  routing="Full">
1484   <host id="bob" power="1000000000"/>
1485 </AS>
1486   <trace id="myTrace" file="bob.trace" periodicity="1.0"/>
1487   <trace_connect trace="myTrace" element="bob" kind="POWER"/>
1488 \endverbatim
1489
1490 All constraints you have is that <b>trace_connect</b> is after
1491 <b>trace</b> and <b>host</b> definitions.
1492
1493
1494 <b>trace</b> attributes :
1495 \li <b>id (mandatory)</b>: the identifier of the trace to be used when
1496     referring to it.
1497 \li <b>file</b>: filename of the file to include. Possible values :
1498     absolute or relative path, syntax similar to the one in use on
1499     your system. If omitted, the system expects that you provide the
1500     trace values inside the trace tags (see below).
1501 \li <b>trace periodicity (mandatory)</b>: trace periodicity, same
1502     definition as in hosts (see upper for details).
1503
1504 Here is an example  of trace when no file name is provided:
1505
1506 \verbatim
1507  <trace id="myTrace" periodicity="1.0">
1508     0.0 1.0
1509     11.0 0.5
1510     20.0 0.8
1511   </trace>
1512 \endverbatim
1513
1514 <b>trace_connect</b> attributes :
1515 \li <b>kind</b>: the type of trace, possible values
1516     <b>HOST_AVAIL|POWER|LINK_AVAIL|BANDWIDTH|LATENCY,</b>  default:
1517     <b>HOST_AVAIL</b>
1518 \li <b>trace (mandatory)</b>: the identifier of the trace referenced.
1519 \li <b>element (mandatory)</b>: the identifier of the entity referenced.
1520
1521
1522
1523 \section pf_hints Hints and tips, or how to write a platform efficiently
1524
1525 Now you should know at least the syntax and be able to create a
1526 platform by your own. However, after having ourselves wrote some platforms, there
1527 are some best practices you should pay attention to in order to
1528 produce good platform and some choices you can make in order to have
1529 faster simulations. Here's some hints and tips, then.
1530
1531 \subsection pf_as_h AS Hierarchy
1532 The AS design allows SimGrid to go fast, because computing route is
1533 done only for the set of resources defined in this AS. If you're using
1534 only a big AS containing all resource with no AS into it and you're
1535 using Full model, then ... you'll loose all interest into it. On the
1536 other hand, designing a binary tree of AS with, at the lower level,
1537 only one host, then you'll also loose all the good AS hierarchy can
1538 give you. Remind you should always be "reasonable" in your platform
1539 definition when choosing the hierarchy. A good choice if you try to
1540 describe a real life platform is to follow the AS described in
1541 reality, since this kind of trade-off works well for real life
1542 platforms.
1543
1544 \subsection pf_exit_as Exit AS: why and how
1545 Users that have looked at some of our platforms may have notice a
1546 non-intuitive schema ... Something like that :
1547
1548
1549 \verbatim
1550 <AS id="AS_4"  routing="Full">
1551 <AS id="exitAS_4"  routing="Full">
1552         <router id="router_4"/>
1553 </AS>
1554 <cluster id="cl_4_1" prefix="c_4_1-" suffix="" radical="1-20" power="1000000000" bw="125000000" lat="5E-5" bb_bw="2250000000" bb_lat="5E-4"/>
1555 <cluster id="cl_4_2" prefix="c_4_2-" suffix="" radical="1-20" power="1000000000" bw="125000000" lat="5E-5" bb_bw="2250000000" bb_lat="5E-4"/>
1556 <link id="4_1" bandwidth="2250000000" latency="5E-5"/>
1557 <link id="4_2" bandwidth="2250000000" latency="5E-5"/>
1558 <link id="bb_4" bandwidth="2250000000" latency="5E-4"/>
1559 <ASroute src="cl_4_1"
1560         dst="cl_4_2"
1561         gw_src="c_4_1-cl_4_1_router"
1562         gw_dst="c_4_2-cl_4_2_router"
1563         symmetrical="YES">
1564                 <link_ctn id="4_1"/>
1565                 <link_ctn id="bb_4"/>
1566                 <link_ctn id="4_2"/>
1567 </ASroute>
1568 <ASroute src="cl_4_1"
1569         dst="exitAS_4"
1570         gw_src="c_4_1-cl_4_1_router"
1571         gw_dst="router_4"
1572         symmetrical="YES">
1573                 <link_ctn id="4_1"/>
1574                 <link_ctn id="bb_4"/>
1575 </ASroute>
1576 <ASroute src="cl_4_2"
1577         dst="exitAS_4"
1578         gw_src="c_4_2-cl_4_2_router"
1579         gw_dst="router_4"
1580         symmetrical="YES">
1581                 <link_ctn id="4_2"/>
1582                 <link_ctn id="bb_4"/>
1583 </ASroute>
1584 </AS>
1585 \endverbatim
1586
1587 In the AS_4, you have an exitAS_4 defined, containing only one router,
1588 and routes defined to that AS from all other AS (as cluster is only a
1589 shortcut for an AS, see cluster description for details). If there was
1590 an upper AS, it would define routes to and from AS_4 with the gateway
1591 router_4. It's just because, as we did not allowed (for performances
1592 issues) to have routes from an AS to a single host/router, you have to
1593 enclose your gateway, when you have AS included in your AS, within an
1594 AS to define routes to it.
1595
1596 \subsection pf_P2P_tags P2P or how to use coordinates
1597 SimGrid allows you to use some coordinated-based system, like vivaldi,
1598 to describe a platform. The main concept is that you have some peers
1599 that are located somewhere: this is the function of the
1600 <b>coordinates</b> of the \<peer\> or \<host\> tag. There's nothing
1601 complicated in using it, here is an example of it:
1602
1603 \verbatim
1604 <?xml version='1.0'?>
1605 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1606 <platform version="3">
1607
1608 <config id="General">
1609         <prop id="network/coordinates" value="yes"></prop>
1610 </config>
1611  <AS  id="AS0"  routing="Vivaldi">
1612         <host id="100030591" coordinates="25.5 9.4 1.4" power="1500000000.0" />
1613         <host id="100036570" coordinates="-12.7 -9.9 2.1" power="730000000.0" />
1614         ...
1615         <host id="100429957" coordinates="17.5 6.7 18.8" power="830000000.0" />
1616         </AS>
1617 </platform>
1618 \endverbatim
1619
1620 Coordinates are then used to calculate latency between two hosts by
1621 calculating the euclidean distance between the two hosts coordinates.
1622 The results express the latency in ms.
1623
1624 Note that the previous example defines a routing directly between hosts but it could be also used to define a routing between AS.
1625 That is for example what is commonly done when using peers (see Section \ref pf_peer).
1626 \verbatim
1627 <?xml version='1.0'?>
1628 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1629 <platform version="3">
1630
1631 <config id="General">
1632         <prop id="network/coordinates" value="yes"></prop>
1633 </config>
1634  <AS  id="AS0"  routing="Vivaldi">
1635    <peer id="peer-0" coordinates="173.0 96.8 0.1" power="730Mf" bw_in="13.38MBps" bw_out="1.024MBps" lat="500us"/>
1636    <peer id="peer-1" coordinates="247.0 57.3 0.6" power="730Mf" bw_in="13.38MBps" bw_out="1.024MBps" lat="500us" />
1637    <peer id="peer-2" coordinates="243.4 58.8 1.4" power="730Mf" bw_in="13.38MBps" bw_out="1.024MBps" lat="500us" />
1638 </AS>
1639 </platform>
1640 \endverbatim
1641 In such a case though, we connect the AS created by the <b>peer</b> tag with the Vivaldi routing mechanism.
1642 This means that to route between AS1 and AS2, it will use the coordinates of router_AS1 and router_AS2.
1643 This is currently a convention and we may offer to change this convention in the DTD later if needed.
1644 You may have noted that conveniently, a peer named FOO defines an AS named FOO and a router named router_FOO, which is why it works seamlessly with the <b>peer</b> tag.
1645
1646
1647 \subsection pf_wisely Choosing wisely the routing model to use
1648
1649
1650 Choosing wisely the routing model to use can significantly fasten your
1651 simulation/save your time when writing the platform/save tremendous
1652 disk space. Here is the list of available model and their
1653 characteristics (lookup : time to resolve a route):
1654
1655 \li <b>Full</b>: Full routing data (fast, large memory requirements,
1656     fully expressive)
1657 \li <b>Floyd</b>: Floyd routing data (slow initialization, fast
1658     lookup, lesser memory requirements, shortest path routing only).
1659     Calculates all routes at once at the beginning.
1660 \li <b>Dijkstra</b>: Dijkstra routing data (fast initialization, slow
1661     lookup, small memory requirements, shortest path routing only).
1662     Calculates a route when necessary.
1663 \li <b>DijkstraCache</b>: Dijkstra routing data (fast initialization,
1664     fast lookup, small memory requirements, shortest path routing
1665     only). Same as Dijkstra, except it handles a cache for latest used
1666     routes.
1667 \li <b>None</b>: No routing (usable with Constant network only).
1668     Defines that there is no routes, so if you try to determine a
1669     route without constant network within this AS, SimGrid will raise
1670     an exception.
1671 \li <b>Vivaldi</b>: Vivaldi routing, so when you want to use coordinates
1672 \li <b>Cluster</b>: Cluster routing, specific to cluster tag, should
1673     not be used.
1674
1675 \subsection pf_switch Hey, I want to describe a switch but there is no switch tag !
1676
1677 Actually we did not include switch tag, ok. But when you're trying to
1678 simulate a switch, the only major impact it has when you're using
1679 fluid model (and SimGrid uses fluid model unless you activate 
1680 ns-3 or constant network mode) is the impact of the upper limit of
1681 the switch motherboard speed that will eventually be reached if you're
1682 using intensively your switch. So, the switch impact is similar to a
1683 link one. That's why we are used to describe a switch using a link tag
1684 (as a link is not an edge by a hyperedge, you can connect more than 2
1685 other links to it).
1686
1687 \subsection pf_platform_multipath How to express multipath routing in platform files?
1688
1689 It is unfortunately impossible to express the fact that there is more
1690 than one routing path between two given hosts. Let's consider the
1691 following platform file:
1692
1693 \verbatim
1694 <route src="A" dst="B">
1695    <link_ctn id="1"/>
1696 </route>
1697 <route src="B" dst="C">
1698   <link_ctn id="2"/>
1699 </route>
1700 <route src="A" dst="C">
1701   <link_ctn id="3"/>
1702 </route>
1703 \endverbatim
1704
1705 Although it is perfectly valid, it does not mean that data traveling
1706 from A to C can either go directly (using link 3) or through B (using
1707 links 1 and 2). It simply means that the routing on the graph is not
1708 trivial, and that data do not following the shortest path in number of
1709 hops on this graph. Another way to say it is that there is no implicit
1710 in these routing descriptions. The system will only use the routes you
1711 declare (such as &lt;route src="A" dst="C"&gt;&lt;link_ctn
1712 id="3"/&gt;&lt;/route&gt;), without trying to build new routes by aggregating
1713 the provided ones.
1714
1715 You are also free to declare platform where the routing is not
1716 symmetric. For example, add the following to the previous file:
1717
1718 \verbatim
1719 <route src="C" dst="A">
1720   <link_ctn id="2"/>
1721   <link_ctn id="1"/>
1722 </route>
1723 \endverbatim
1724
1725 This makes sure that data from C to A go through B where data from A
1726 to C go directly. Don't worry about realism of such settings since
1727 we've seen ways more weird situation in real settings (in fact, that's
1728 the realism of very regular platforms which is questionable, but
1729 that's another story).
1730
1731 \section pf_flexml_bypassing Bypassing the XML parser with your own C functions
1732 <b>NOTE THAT THIS DOCUMENTATION, WHILE STILL WORKING, IS STRONGLY DEPRECATED</b>
1733
1734 So you want to bypass the XML files parser, uh? Maybe doing some parameter
1735 sweep experiments on your simulations or so? This is possible, and
1736 it's not even really difficult (well. Such a brutal idea could be
1737 harder to implement). Here is how it goes.
1738
1739 For this, you have to first remember that the XML parsing in SimGrid is done
1740 using a tool called FleXML. Given a DTD, this gives a flex-based parser. If
1741 you want to bypass the parser, you need to provide some code mimicking what
1742 it does and replacing it in its interactions with the SURF code. So, let's
1743 have a look at these interactions.
1744
1745 FleXML parser are close to classical SAX parsers. It means that a
1746 well-formed SimGrid platform XML file might result in the following
1747 "events":
1748
1749   - start "platform_description" with attribute version="2"
1750   - start "host" with attributes id="host1" power="1.0"
1751   - end "host"
1752   - start "host" with attributes id="host2" power="2.0"
1753   - end "host"
1754   - start "link" with ...
1755   - end "link"
1756   - start "route" with ...
1757   - start "link_ctn" with ...
1758   - end "link_ctn"
1759   - end "route"
1760   - end "platform_description"
1761
1762 The communication from the parser to the SURF code uses two means:
1763 Attributes get copied into some global variables, and a surf-provided
1764 function gets called by the parser for each event. For example, the event
1765   - start "host" with attributes id="host1" power="1.0"
1766
1767 let the parser do something roughly equivalent to:
1768 \verbatim
1769   strcpy(A_host_id,"host1");
1770   A_host_power = 1.0;
1771   STag_host();
1772 \endverbatim
1773
1774 In SURF, we attach callbacks to the different events by initializing the
1775 pointer functions to some the right surf functions. Since there can be
1776 more than one callback attached to the same event (if more than one
1777 model is in use, for example), they are stored in a dynar. Example in
1778 host_ptask_L07.c:
1779 \verbatim
1780   /* Adding callback functions */
1781   surf_parse_reset_parser();
1782   surfxml_add_callback(STag_surfxml_host_cb_list, &parse_cpu_init);
1783   surfxml_add_callback(STag_surfxml_prop_cb_list, &parse_properties);
1784   surfxml_add_callback(STag_surfxml_link_cb_list, &parse_link_init);
1785   surfxml_add_callback(STag_surfxml_route_cb_list, &parse_route_set_endpoints);
1786   surfxml_add_callback(ETag_surfxml_link_c_ctn_cb_list, &parse_route_elem);
1787   surfxml_add_callback(ETag_surfxml_route_cb_list, &parse_route_set_route);
1788
1789   /* Parse the file */
1790   surf_parse_open(file);
1791   xbt_assert(!surf_parse(), "Parse error in %s", file);
1792   surf_parse_close();
1793 \endverbatim
1794
1795 So, to bypass the FleXML parser, you need to write your own version of the
1796 surf_parse function, which should do the following:
1797    - Fill the A_<tag>_<attribute> variables with the wanted values
1798    - Call the corresponding STag_<tag>_fun function to simulate tag start
1799    - Call the corresponding ETag_<tag>_fun function to simulate tag end
1800    - (do the same for the next set of values, and loop)
1801
1802 Then, tell SimGrid that you want to use your own "parser" instead of the stock one:
1803 \verbatim
1804   surf_parse = surf_parse_bypass_environment;
1805   MSG_create_environment(NULL);
1806   surf_parse = surf_parse_bypass_application;
1807   MSG_launch_application(NULL);
1808 \endverbatim
1809
1810 A set of macros are provided at the end of
1811 include/surf/surfxml_parse.h to ease the writing of the bypass
1812 functions. An example of this trick is distributed in the file
1813 examples/msg/masterslave/masterslave_bypass.c
1814
1815
1816 */