Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
082c96bb20de3653f980d983211694b39e5b8c31
[simgrid.git] / doc / doxygen / platform.doc
1 /*! \page platform Platform Description
2
3 @tableofcontents
4
5 In order to run any simulation, SimGrid needs 3 things: something to run
6 (so, your code), a description of the platform on which you want to run your
7 application, and finally it needs something to know where to deploy what.
8
9 For the latest 2 entries, you have basically 2 ways to give it as an input :
10 \li You can program it, either using the Lua console (\ref
11     MSG_Lua_funct) or if you're using MSG some of its platform and
12     deployments functions(\ref msg_simulation). If you want to use it,
13     please refer to its doc. (you can also check the section \ref
14     pf_flexml_bypassing but this is strongly deprecated, as there is a
15     new way to do it properly, but not yet documented).
16 \li You can use two XML files: a platform description file and a
17     deployment description one.
18
19 For the deployment stuff, please take a look at \ref deployment
20
21 The platform description may be complicated. This documentation is all
22 about how to write this file: what are the basic concept it relies on,
23 what possibilities are offered, and some hints and tips on how to
24 write a good platform description.
25
26 \section pf_overview Some words about XML and DTD
27
28 We choose to use XML because of some of its possibilities: if you're
29 using an accurate XML editor, or simply using any XML plug-in for
30 eclipse, it will allow you to have cool stuff like auto-completion,
31 validation and checking, so all syntax errors may be avoided this
32 way.
33
34 the XML checking is done based on the dtd which is nowadays online at
35 <a href="http://simgrid.gforge.inria.fr/simgrid.dtd">http://simgrid.gforge.inria.fr/simgrid.dtd</a>
36 while you might be tempted to read it, it will not help you that much.
37
38 If you read it, you should notice two or three important things :
39 \li The platform tags contains a version attributes. At the time of
40     writing this doc the current version is 3.    
41 \li The DTD contains definitions for the 2 files used by SimGrid (platform
42     description and deployment).
43 \li There is a bunch of possibilities ! Let's see what's in it
44
45
46 \section pf_basics Basic concepts
47
48 Nowadays, the Internet is composed of a bunch of independently managed
49 networks. Within each of those networks, there are entry and exit
50 points (most of the time, you can both enter and exit through the same
51 point) that allows to go out of the current network and reach other
52 networks. At the upper level, these networks are known as
53 <b>Autonomous System (AS)</b>, while at the lower level they are named
54 sub-networks, or LAN. Indeed they are autonomous: routing is defined
55 within the limits of his network by the administrator, and so, those
56 networks can continue to operate without the existence of other
57 networks. There are some rules to get out of networks by the entry
58 points (or gateways). Those gateways allow you to go from a network to
59 another one. Inside of each autonomous system, there is a bunch of
60 equipments (cables, routers, switches, computers) that belong to the
61 autonomous system owner.
62
63 SimGrid platform description file relies exactly on the same concepts
64 as real life platform. Every resource (computers, network equipments,
65 and so on) belongs to an AS. Within this AS, you can define the
66 routing you want between its elements (that's done with the routing
67 model attribute and eventually with some \<route\> tag). You define AS
68 by using ... well ... the \<AS\> tag. An AS can also contain some AS :
69 AS allows you to define the hierarchy of your platform.
70
71 Within each AS, you basically have the following type of resources:
72 \li <b>host</b>: an host, with cores in it, and so on
73 \li <b>router</b>: a router or a gateway.
74 \li <b>link</b>: a link, that defines a connection between two (or
75     more) resources (and have a bandwidth and a latency) 
76 \li <b>cluster</b>: like a real cluster, contains many hosts
77     interconnected by some dedicated network. 
78
79 Between those elements, a routing has to be defined. As the AS is
80 supposed to be Autonomous, this has to be done at the AS level. As AS
81 handles two different types of entities (<b>host/router</b> and
82 <b>AS</b>) you will have to define routes between those elements. A
83 network model have to be provided for AS, but you may/will need,
84 depending of the network model, or because you want to bypass the
85 default behavior to defines routes manually. There are 3 tags to use: 
86 \li <b>ASroute</b>: to define routes between two  <b>AS</b>
87 \li <b>route</b>: to define routes between two <b>host/router</b>
88 \li <b>bypassRoute</b>: to define routes between two <b>AS</b> that
89     will bypass default routing. 
90
91 Here is an illustration of the overall concepts:
92
93 \htmlonly
94 <a href="AS_hierarchy.png" border=0><img src="AS_hierarchy.png" width="30%" border=0 align="center"></a>
95 <br/>
96 \endhtmlonly
97  Circles represent processing units and squares represent network routers. Bold
98     lines represent communication links. AS2 models the core of a national
99     network interconnecting a small flat cluster (AS4) and a larger
100     hierarchical cluster (AS5), a subset of a LAN (AS6), and a set of peers
101     scattered around the world (AS7).
102
103
104 This is all for the concepts ! To make a long story short, a SimGrid
105 platform is made of a hierarchy of AS, each of them containing
106 resources, and routing is defined at AS level. Let's have a deeper
107 look in the tags.
108
109
110
111 \section pf_pftags Describing resources and their organization
112
113 \subsection  pf_As Platform organization tag : AS
114
115 AS (or Autonomous System) is an organizational unit that contains
116 resources and defines routing between them, and eventually some other
117 AS. So it allows you to define a hierarchy into your platform.
118 <b>*ANY*</b> resource <b>*MUST*</b> belong to an AS. There are a few
119 attributes.
120
121 <b>AS</b> attributes :
122 \li <b>id (mandatory)</b>: the identifier of AS to be used when
123     referring to it.     
124 \li <b>routing (mandatory)</b>: the routing model used into it. By
125     model we mean the internal way the simulator will manage routing.
126     That also have a big impact on how many information you'll have to
127     provide to help the simulator to route between the AS elements.
128     <b>routing</b> possible values are <b>Full, Floyd, Dijkstra,
129     DijkstraCache, none, Vivaldi, Cluster</b>. For more
130     explanation about what to choose, take a look at the section
131     devoted to it below.  
132
133 Elements into an AS are basically resources (computers, network
134 equipments) and some routing information if necessary (see below for
135 more explanation).
136
137 <b>AS example</b>
138 \verbatim
139 <AS  id="AS0"  routing="Full">
140    <host id="host1" power="1000000000"/>
141    <host id="host2" power="1000000000"/>
142    <link id="link1" bandwidth="125000000" latency="0.000100"/>
143    <route src="host1" dst="host2"><link_ctn id="link1"/></route>
144  </AS>
145 \endverbatim
146
147 In this example, AS0 contains two hosts (host1 and host2). The route
148 between the hosts goes through link1.
149
150
151 \subsection pf_Cr Computing resources: hosts, clusters and peers.
152
153 \subsubsection pf_host host
154
155 A <b>host</b> represents a computer, where you will be able to execute
156 code and from which you can send and receive information. A host can
157 contain more than 1 core. Here are the attributes of a host :
158
159
160 <b>host</b> attributes :
161 \li <b>id (mandatory)</b>: the identifier of the host to be used when
162     referring to it.
163 \li <b>power (mandatory)</b>:the peak number FLOPS the CPU can manage.
164     Expressed in flop/s.
165 \li <b>core</b>: The number of core of this host (by default, 1). If
166     you specify the amount of cores, the 'power' parameter is the power 
167     of each core. 
168     For example, if you specify that your host has 6 cores, it will be
169     available to up to 6 sequential tasks without sharing. If more
170     tasks are placed on this host, the resource will be shared
171     accordingly. For example, if you schedule 12 tasks on that host,
172     each will get half of the specified computing power. Please note
173     that although sound, this model were never scientifically assessed.
174     Please keep this fact in mind when using it.
175 \li <b>availability</b>: specify if the percentage of power available.
176 \li <b>availability_file</b>: Allow you to use a file as input. This
177     file will contain availability traces for this computer. The
178     syntax of this file is defined below. Possible values : absolute
179     or relative path, syntax similar to the one in use on your system.
180 \li <b>state</b>: the computer state, as in : is that computer ON or
181     OFF. Possible values : "ON" or "OFF". 
182 \li <b>state_file</b>: Same mechanism as availability_file, similar
183     syntax for value.     
184 \li <b>coordinates</b>: you'll have to give it if you choose the
185     vivaldi, coordinate-based routing model for the AS the host
186     belongs to. More details about it in the P2P coordinate based
187     section. 
188
189 An host can contain some <b>mount</b> that defines mounting points
190 between some storage resource and the <b>host</b>. Please refer to the
191 storage doc for more information.
192
193 An host can also contain the <b>prop</b> tag. the prop tag allows you
194 to define additional information on this host following the
195 attribute/value schema. You may want to use it to give information to
196 the tool you use for rendering your simulation, for example.
197
198 <b>host example</b>
199 \verbatim
200    <host id="host1" power="1000000000"/>
201    <host id="host2" power="1000000000">
202         <prop id="color" value="blue"/>
203         <prop id="rendershape" value="square"/>
204    </host>
205 \endverbatim
206
207
208 <b>Expressing dynamicity.</b>
209 It is also possible to seamlessly declare a host whose
210 availability changes over time using the availability_file
211 attribute and a separate text file whose syntax is exemplified below.
212
213 <b>Adding a trace file</b>
214 \verbatim
215     <platform version="1">
216       <host id="bob" power="500000000"
217             availability_file="bob.trace" />
218     </platform>
219 \endverbatim
220 <b>Example of "bob.trace" file</b>
221 \verbatim
222 PERIODICITY 1.0
223   0.0 1.0
224   11.0 0.5
225   20.0 0.8
226 \endverbatim
227
228 At time 0, our host will deliver 500~Mflop/s. At time 11.0, it will
229 deliver half, that is 250~Mflop/s until time 20.0 where it will
230 will start delivering 80\% of its power, that is 400~Mflop/s. Last, at
231 time 21.0 (20.0 plus the periodicity 1.0), we loop back to the
232 beginning and the host will deliver again 500~Mflop/s.
233
234 <b>Changing initial state</b>
235
236 It is also possible to specify whether the host
237 is up or down by setting the <b>state</b> attribute to either <b>ON</b>
238 (default value) or <b>OFF</b>.
239
240 <b>Expliciting the default value "ON"</b>
241 \verbatim
242   <platform version="1">
243      <host id="bob"
244            power="500000000"
245           state="ON" />
246   </platform>
247 \endverbatim
248 <b>Host switched off</b>
249 \verbatim
250   <platform version="1">
251      <host id="bob"
252            power="500000000"
253            state="OFF" />
254   </platform>
255 \endverbatim
256 <b>Expressing churn</b>
257 To express the fact that a host can change state over time (as in P2P
258 systems, for instance), it is possible to use a file describing the time
259 at which the host is turned on or off. An example of the content
260 of such a file is presented below.
261 <b>Adding a state file</b>
262   \verbatim
263     <platform version="1">
264       <host id="bob" power="500000000"
265            state_file="bob.fail" />
266     </platform>
267   \endverbatim
268 <b>Example of "bob.fail" file</b>
269 \verbatim
270   PERIODICITY 10.0
271   1.0 -1.0
272   2.0 1.0
273 \endverbatim
274
275 A negative value means <b>down</b> while a positive one means <b>up and
276   running</b>. From time 0.0 to time 1.0, the host is on. At time 1.0, it is
277 turned off and at time 2.0, it is turned on again until time 12 (2.0 plus the
278 periodicity 10.0). It will be turned on again at time 13.0 until time 23.0, and
279 so on.
280
281
282
283 \subsubsection pf_cluster cluster
284
285 A <b>cluster</b> represents a cluster. It is most of the time used
286 when you want to have a bunch of machine defined quickly. It must be
287 noted that cluster is meta-tag : <b>from the inner SimGrid point of
288 view, a cluster is an AS where some optimized routing is defined</b>.
289 The default inner organization of the cluster is as follow:
290
291 \verbatim
292                  _________
293                 |          |
294                 |  router  |
295     ____________|__________|_____________ backbone
296       |   |   |              |     |   |
297     l0| l1| l2|           l97| l96 |   | l99
298       |   |   |   ........   |     |   |
299       |                                |
300     c-0.me                             c-99.me
301 \endverbatim
302
303 You have a set of <b>host</b> defined. Each of them has a <b>link</b>
304 to a central backbone (backbone is a <b>link</b> itself, as a link can
305 be used to represent a switch, see the switch or <b>link</b> section
306 below for more details about it). A <b>router</b> gives a way to the
307 <b>cluster</b> to be connected to the outside world. Internally,
308 cluster is then an AS containing all hosts : the router is the default
309 gateway for the cluster.
310
311 There is an alternative organization, which is as follow :
312 \verbatim
313                  _________
314                 |          |
315                 |  router  |
316                 |__________|
317                     / | \
318                    /  |  \
319                l0 / l1|   \l2
320                  /    |    \
321                 /     |     \
322             host0   host1   host2
323 \endverbatim
324
325 The principle is the same, except we don't have the backbone. The way
326 to obtain it is simple : you just have to let bb_* attributes
327 unset.
328
329
330
331 <b>cluster</b> attributes :
332 \li <b>id (mandatory)</b>: the identifier of the cluster to be used
333     when referring to it. 
334 \li <b>prefix (mandatory)</b>: each node of the cluster has to have a
335     name. This is its prefix. 
336 \li <b>suffix (mandatory)</b>: node suffix name.
337 \li <b>radical (mandatory)</b>: regexp used to generate cluster nodes
338     name. Syntax is quite common, "10-20" will give you 11 machines
339     numbered from 10 to 20, "10-20;2" will give you 12 machines, one
340     with the number 2, others numbered as before. The produced number
341     is concatenated between prefix and suffix to form machine names.
342 \li <b>power (mandatory)</b>: same as <b>host</b> power.
343 \li <b>core</b>: same as <b>host</b> core.
344 \li <b>bw (mandatory)</b>: bandwidth for the links between nodes and
345     backbone (if any). See <b>link</b> section for syntax/details.
346 \li <b>lat (mandatory)</b>: latency for the links between nodes and
347     backbone (if any). See <b>link</b> section for syntax/details. 
348 \li <b>sharing_policy</b>: sharing policy for the links between nodes
349     and backbone (if any). See <b>link</b> section for syntax/details.     
350 \li <b>bb_bw </b>: bandwidth for backbone (if any). See <b>link</b>
351     section for syntax/details. If both bb_* attributes are omitted,
352     no backbone is created (alternative cluster architecture described
353     before). 
354 \li <b>bb_lat </b>: latency for backbone (if any). See <b>link</b>
355     section for syntax/details. If both bb_* attributes are omitted,
356     no backbone is created (alternative cluster architecture described
357     before).
358 \li <b>bb_sharing_policy</b>: sharing policy for the backbone (if
359     any). See <b>link</b> section for syntax/details.
360 \li <b>availability_file</b>: Allow you to use a file as input for
361     availability. Similar to <b>hosts</b> attribute. 
362 \li <b>state_file</b>: Allow you to use a file as input for states.
363     Similar to <b>hosts</b> attribute. 
364 \li <b>loopback_bw </b>: bandwidth for loopback (if any). See <b>link</b>
365     section for syntax/details. If both loopback_* attributes are omitted,
366     no loopback link is created and all intra-node communication will 
367     use the main network link of the node. 
368 \li <b>loopback_lat </b>: latency for loopback (if any). See <b>link</b>
369     section for syntax/details. See bb_bw for more info.
370
371
372 the router name is defined as the resulting String in the following
373 java line of code: 
374
375 @verbatim
376 router_name = prefix + clusterId + _router + suffix;
377 @endverbatim
378
379
380 <b>cluster example</b>
381 \verbatim
382 <cluster id="my_cluster_1" prefix="" suffix="" radical="0-262144"
383          power="1e9" bw="125e6" lat="5E-5"/>
384
385 <cluster id="my_cluster_1" prefix="c-" suffix=".me" radical="0-99"
386          power="1e9" bw="125e6" lat="5E-5"
387          bb_bw="2.25e9" bb_lat="5E-4"/>
388 \endverbatim
389 The second examples creates one router and 100 machines, which names 
390 are the following:
391 \verbatim
392 c-my_cluster_1_router.me
393 c-0.me
394 c-1.me
395 c-2.me
396 ...
397 c-99.me
398 \endverbatim
399
400 \subsubsection pf_peer peer
401 A <b>peer</b> represents a peer, as in Peer-to-Peer (P2P). Basically,
402 as cluster, <b>A PEER IS INTERNALLY INTERPRETED AS AN \<AS\></b>. It's
403 just a kind of shortcut that does the following :
404
405 \li It creates a tiny AS whose routing type is cluster
406 \li It creates an host
407 \li Two links : one for download and one for upload. This is
408     convenient to use and simulate stuff under the last mile model (as
409     ADSL peers). 
410 \li It connects the two links to the host
411 \li It creates a router (a gateway) that serve as entry point for this peer zone.
412     This router has coordinates.
413
414 <b>peer</b> attributes :
415 \li <b>id (mandatory)</b>: the identifier of the peer to be used when
416     referring to it.
417 \li <b>power CDATA (mandatory)</b>: as in host
418 \li <b>bw_in CDATA (mandatory)</b>: bandwidth in.
419 \li <b>bw_out CDATA (mandatory)</b>:bandwidth out.
420 \li <b>lat CDATA (mandatory)</b>: Latency for in and out links.
421 \li <b>coordinates</b>: coordinates of the gateway for this peer.
422 \li <b>sharing_policy</b>: sharing policy for links. Can be SHARED or
423     FULLDUPLEX, FULLDUPLEX is the default. See <b>link</b> description
424     for details.
425 \li <b>availability_file</b>: availability file for the peer. Same as
426     host availability file. See <b>host</b> description for details.   
427 \li <b>state_file </b>: state file for the peer. Same as host state
428     file. See <b>host</b> description for details. 
429
430 In term of XML, the <b>peer</b> construct can be explained as follows: it transforms
431 \verbatim
432   <peer id="FOO"
433         coordinates="12.8 14.4 6.4"
434         power="1.5Gf"
435         bw_in="2.25GBps"
436         bw_out="2.25GBps"
437         lat="500us" />
438 \endverbatim
439 into
440 \verbatim
441    <AS id="as_FOO" routing="Cluster">
442       <host id="peer_FOO" power="1.5Gf"/>
443       <link id="link_FOO_UP" bandwidth="2.25GBps" latency="500us"/>
444       <link id="link_FOO_DOWN" bandwidth="2.25GBps" latency="500us"/>
445       <router id="router_FOO" coordinates="25.5 9.4 1.4"/>
446       <host_link id="peer_FOO" up="link_FOO_UP" down="link_FOO_DOWN"/>
447    </AS>
448 \endverbatim
449
450
451 \subsection pf_ne Network equipments: links and routers
452
453 You have basically two entities available to represent network entities:
454 \li <b>link</b>: represents something that has a limited bandwidth, a
455     latency, and that can be shared according to TCP way to share this
456     bandwidth. <b>LINKS ARE NOT EDGES BUT HYPEREDGES</b>: it means
457     that you can have more than 2 equipments connected to it.
458 \li <b>router</b>: represents something that one message can be routed
459     to, but does not accept any code, nor have any influence on the
460     performances (no bandwidth, no latency, not anything).<b>ROUTERS
461     ARE ENTITIES (ALMOST) IGNORED BY THE SIMULATOR WHEN THE SIMULATION
462     HAS BEGUN</b>. If you want to represent something like a switch,
463     you must use <b>link</b> (see section below). Routers are used in
464     order to run some routing algorithm and determine routes (see
465     routing section for details).
466
467 let's see deeper what those entities hide.
468
469 \subsubsection pf_router router
470 As said before, <b>router</b> is used only to give some information
471 for routing algorithms. So, it does not have any attributes except :
472
473 <b>router</b> attributes :
474 \li <b>id (mandatory)</b>: the identifier of the router to be used
475     when referring to it.
476     \li <b>coordinates</b>: you'll have to give it if you choose the
477     vivaldi, coordinate-based routing model for the AS the host
478     belongs to. More details about it in the P2P coordinates based
479     section.
480
481 <b>router example</b>
482 \verbatim
483  <router id="gw_dc1_horizdist"/>
484 \endverbatim
485
486 \subsubsection pf_link link
487
488 Network links can represent one-hop network connections. They are
489 characterized by their id and their bandwidth. The latency is optional
490 with a default value of 0.0. For instance, we can declare a network
491 link named link1 having bandwidth of 1Gb/s and a latency of 50µs.
492 Example link:
493
494 \verbatim
495  <link id="LINK1" bandwidth="125000000" latency="5E-5"/>
496 \endverbatim
497 <b>Expressing sharing policy</b>
498
499 By default a network link is SHARED, that is if more than one flow go
500 through a link, each gets a share of the available bandwidth similar
501 to the share TCP connections offers.
502
503 Conversely if a link is defined as a FATPIPE, each flow going through
504 this link will get all the available bandwidth, whatever the number of
505 flows. The FATPIPE behavior allows to describe big backbones that
506 won't affect performances (except latency). Finally a link can be
507 considered as FULLDUPLEX, that means that in the simulator, 2 links
508 (one named UP and the other DOWN) will be created for each link, so as
509 the transfers from one side to the other will interact similarly as
510 TCP when ACK returning packets circulate on the other direction. More
511 discussion about it is available in <b>link_ctn</b> description.
512
513 \verbatim
514  <link id="SWITCH" bandwidth="125000000" latency="5E-5" sharing_policy="FATPIPE" />
515 \endverbatim
516
517 <b>Expressing dynamicity and failures</b>
518
519 As for hosts, it is possible to declare links whose state, bandwidth
520 or latency change over the time. In this case, the bandwidth and
521 latency attributes are respectively replaced by the bandwidth file and
522 latency file attributes and the corresponding text files.
523
524 \verbatim
525  <link id="LINK1" state_file="link1.fail" bandwidth="80000000" latency=".0001" bandwidth_file="link1.bw" latency_file="link1.lat" />
526 \endverbatim
527
528 It has to be noted that even if the syntax is the same, the semantic
529 of bandwidth and latency trace files differs from that of host
530 availability files. Those files do not express availability as a
531 fraction of the available capacity but directly in bytes per seconds
532 for the bandwidth and in seconds for the latency. This is because most
533 tools allowing to capture traces on real platforms (such as NWS)
534 express their results this way.
535
536 <b>Example of "link1.bw" file</b>
537 \verbatim
538
539 1 PERIODICITY 12.0
540 2 4.0 40000000
541 3 8.0 60000000
542 \endverbatim
543 <b>Example of "link1.lat" file</b>
544 \verbatim
545  1 PERIODICITY 5.0
546 2 1.0 0.001
547 3 2.0 0.01
548 4 3.0 0.001
549 \endverbatim
550
551 In this example, the bandwidth varies with a period of 12 seconds
552 while the latency varies with a period of 5 seconds. At the beginning
553 of simulation, the link’s bandwidth is of 80,000,000 B/s (i.e., 80
554 Mb/s). After four seconds, it drops at 40 Mb/s, and climbs back to 60
555 Mb/s after eight seconds. It keeps that way until second 12 (ie, until
556 the end of the period), point at which it loops its behavior (seconds
557 12-16 will experience 80 Mb/s, 16-20 40 Mb/s and so on). In the same
558 time, the latency values are 100µs (initial value) on the [0, 1[ time
559 interval, 1ms on [1, 2[, 10ms on [2, 3[, 1ms on [3,5[ (i.e., until the
560 end of period). It then loops back, starting at 100µs for one second.
561
562 <b>link</b> attributes :
563 \li <b>id (mandatory)</b>: the identifier of the link to be used when referring to it.
564 \li <b>bandwidth (mandatory)</b>: bandwidth for the link.
565 \li <b>lat </b>: latency for the link. Default is 0.0.
566 \li <b>sharing_policy</b>: sharing policy for the link.
567 \li <b>state</b>: Allow you to to set link as ON or OFF. Default is ON.
568 \li <b>bandwidth_file</b>: Allow you to use a file as input for bandwidth.
569 \li <b>latency_file</b>: Allow you to use a file as input for latency.
570 \li <b>state_file</b>: Allow you to use a file as input for states.
571
572 As an host, a <b>link</b> tag can also contain the <b>prop</b> tag.
573
574 <b>link example</b>
575 \verbatim
576    <link id="link1" bandwidth="125000000" latency="0.000100"/>
577 \endverbatim
578
579
580 \subsection pf_storage Storage
581
582 <b>Note : This is a prototype version that should evolve quickly, this
583 is just some doc valuable only at the time of writing this doc</b>
584 This section describes the storage management under SimGrid ; nowadays
585 it's only usable with MSG. It relies basically on linux-like concepts.
586 You also may want to have a look to its corresponding section in \ref
587 msg_file_management ; functions access are organized as a POSIX-like
588 interface.
589
590 \subsubsection pf_sto_conc Storage Main concepts
591 Basically there is 3 different entities to know :
592 \li the <b>storage_type</b>: here you define some kind of storage that
593     you will instantiate many type on your platform. Think of it like
594     a definition of throughput of a specific disk. 
595 \li the <b>storage</b>: instance of a <b>storage_type</b>. Defines a
596     new storage of <b>storage_type</b>     
597 \li the <b>mount</b>: says that the storage is located into this
598     specific resource.
599
600 the content of a storage has to be defined in a content file that
601 contains the content. The path to this file has to be passed within
602 the <b>content</b> attribute . Here is a way to generate it:
603
604 \verbatim
605 find /path/you/want -type f -exec ls -l {} \; 2>/dev/null > ./content.txt
606 \endverbatim
607
608 \subsubsection pf_sto_sttp storage_type
609
610
611 <b>storage_type</b> attributes :
612 \li <b>id (mandatory)</b>: the identifier of the storage_type to be
613     used when referring to it. 
614 \li <b>model (mandatory)</b>: Unused for now by the simulator (but
615     mandatory, ok) 
616 \li <b>content</b>: default value 0. The file containing the disk
617     content. (may be moved soon or later to <b>storage</b> tag. 
618
619 The tag must contains some predefined model prop, as may do some other
620 resources tags.
621 <b>storage_type</b> mandatory <b>model_prop</b> :
622 \li <b>Bwrite</b>: value in B/s. Write throughput
623 \li <b>Bread</b>: value in B/s. Read throughput
624 \li <b>Bconnexion</b>: value in B/s. Connection throughput (i.e. the
625     throughput of the storage connector). 
626
627 A storage_type can also contain the <b>prop</b> tag. The prop tag allows you
628 to define additional information on this storage_type following the
629 attribute/value schema. You may want to use it to give information to
630 the tool you use for rendering your simulation, for example.
631
632 \verbatim
633 <storage_type id="single_HDD" model="linear_no_lat" size="4000" content_type="txt_unix">
634   <model_prop id="Bwrite" value="30MBps" />
635   <model_prop id="Bread" value="100MBps" />
636   <model_prop id="Bconnection" value="150MBps" />
637   <b><prop id="Brand" value="Western Digital" /></b>
638 </storage_type>
639 \endverbatim
640
641 \subsubsection pf_sto_st storage
642
643 <b>storage_type</b> attributes :
644 \li <b>id (mandatory)</b>: the identifier of the storage to be used
645     when referring to it. 
646 \li <b>typeId (mandatory)</b>: the identifier of the storage_type that
647     this storage belongs to. 
648 \li <b>attach (mandatory)</b>: the host (name) to which the storage is 
649         attached to.
650
651 \subsubsection pf_sto_mo mount
652
653 <b>mount</b> attributes :
654 \li <b>id (mandatory)</b>: the id of the <b>storage</b> that must be
655     mounted on that computer. 
656 \li <b>name (mandatory)</b>: the name that will be the logical
657     reference to this disk (the mount point). 
658
659 \subsubsection pf_sto_mst mstorage
660 <b>Note : unused for now</b>
661 <b>mstorage</b> attributes :
662 \li <b>typeId (mandatory)</b>: the id of the <b>storage</b> that must
663     be mounted on that computer. 
664 \li <b>name (mandatory)</b>: the name that will be the logical
665     reference to this disk (the mount point). 
666
667 \section pf_routing Routing
668
669 In order to run fast, it has been chosen to use static routing within
670 SimGrid. By static, it means that it is calculated once (or almost),
671 and will not change during execution. We chose to do that because it
672 is rare to have a real deficiency of a resource ; most of the time, a
673 communication fails because the links are too overloaded, and so your
674 connection stops before the time out, or because the computer at the
675 other end is not answering.
676
677 We also chose to use shortest paths algorithms in order to emulate
678 routing. Doing so is consistent with the reality: RIP, OSPF, BGP are
679 all calculating shortest paths. They have some convergence time, but
680 at the end, so when the platform is stable (and this should be the
681 moment you want to simulate something using SimGrid) your packets will
682 follow the shortest paths.
683
684 \subsection pf_rm Routing models
685
686 Within each AS, you have to define a routing model to use. You have
687 basically 3 main kind of routing models :
688
689 \li Shortest-path based models: you let SimGrid calculates shortest
690     paths and manage it. Behaves more or less as most real life
691     routing.
692 \li Manually-entered route models: you'll have to define all routes
693     manually by yourself into the platform description file.
694     Consistent with some manually managed real life routing.
695 \li Simple/fast models: those models offers fast, low memory routing
696     algorithms. You should consider to use it if you can make some
697     assumptions about your AS. Routing in this case is more or less
698     ignored
699
700 \subsubsection pf_raf The router affair
701
702 Expressing routers becomes mandatory when using shortest-path based
703 models or when using ns-3 or the bindings to the GTNetS packet-level
704 simulator instead of the native analytical network model implemented
705 in SimGrid.
706
707 For graph-based shortest path algorithms, routers are mandatory,
708 because both algorithms need a graph, and so we need to have source
709 and destination for each edge.
710
711 Routers are naturally an important concept in GTNetS or ns-3 since the
712 way they run the packet routing algorithms is actually simulated.
713 Instead, the SimGrid’s analytical models aggregate the routing time
714 with the transfer time. Rebuilding a graph representation only from
715 the route information turns to be a very difficult task, because of
716 the missing information about how routes intersect. That is why we
717 introduced a \<router\> tag, which is simply used to express these
718 intersection points. The only attribute accepted by this tag an id. It
719 is important to understand that the \<router\> tag is only used to
720 provide topological information.
721
722 To express those topological information, some <b>route</b> have to be
723 defined saying which link is between which routers. Description or the
724 route syntax is given below, as well as example for the different
725 models.
726
727 \subsubsection pf_rm_sh Shortest-path based models
728
729 Here is the complete list of such models, that computes routes using
730 classic shortest-paths algorithms. How to choose the best suited
731 algorithm is discussed later in the section devoted to it.
732
733 \li <b>Floyd</b>: Floyd routing data. Pre-calculates all routes once. 
734 \li <b>Dijkstra</b>: Dijkstra routing data ,calculating routes when
735     necessary. 
736 \li <b>DijkstraCache</b>: Dijkstra routing data. Handle some cache for
737     already calculated routes. 
738
739 All those shortest-path models are instanciated the same way. Here are
740 some example of it:
741
742 Floyd example :
743 \verbatim
744 <AS  id="AS0"  routing="Floyd">
745
746   <cluster id="my_cluster_1" prefix="c-" suffix=""
747                 radical="0-1"   power="1000000000"    bw="125000000"     lat="5E-5"
748         router_id="router1"/>
749
750  <AS id="AS1" routing="none">
751     <host id="host1" power="1000000000"/>
752  </AS>
753
754   <link id="link1" bandwidth="100000" latency="0.01"/>
755
756   <ASroute src="my_cluster_1" dst="AS1"
757     gw_src="router1"
758     gw_dst="host1">
759     <link_ctn id="link1"/>
760   </ASroute>
761
762 </AS>
763 \endverbatim
764
765 ASroute given at the end gives a topological information: link1 is
766 between router1 and host1.
767
768 Dijsktra example :
769 \verbatim
770  <AS id="AS_2" routing="Dijsktra">
771      <host id="AS_2_host1" power="1000000000"/>
772      <host id="AS_2_host2" power="1000000000"/>
773      <host id="AS_2_host3" power="1000000000"/>
774      <link id="AS_2_link1" bandwidth="1250000000" latency="5E-4"/>
775      <link id="AS_2_link2" bandwidth="1250000000" latency="5E-4"/>
776      <link id="AS_2_link3" bandwidth="1250000000" latency="5E-4"/>
777      <link id="AS_2_link4" bandwidth="1250000000" latency="5E-4"/>
778      <router id="central_router"/>
779      <router id="AS_2_gateway"/>
780      <!-- routes providing topological information -->
781      <route src="central_router" dst="AS_2_host1"><link_ctn id="AS_2_link1"/></route>
782      <route src="central_router" dst="AS_2_host2"><link_ctn id="AS_2_link2"/></route>
783      <route src="central_router" dst="AS_2_host3"><link_ctn id="AS_2_link3"/></route>
784      <route src="central_router" dst="AS_2_gateway"><link_ctn id="AS_2_link4"/></route>
785   </AS>
786 \endverbatim
787
788 DijsktraCache example :
789 \verbatim
790 <AS id="AS_2" routing="DijsktraCache">
791      <host id="AS_2_host1" power="1000000000"/>
792      ...
793 (platform unchanged compared to upper example)
794 \endverbatim
795
796 \subsubsection pf_rm_me Manually-entered route models
797
798 \li <b>Full</b>: You have to enter all necessary routes manually
799
800 Full example :
801 \verbatim
802 <AS  id="AS0"  routing="Full">
803    <host id="host1" power="1000000000"/>
804    <host id="host2" power="1000000000"/>
805    <link id="link1" bandwidth="125000000" latency="0.000100"/>
806    <route src="host1" dst="host2"><link_ctn id="link1"/></route>
807  </AS>
808 \endverbatim
809
810 \subsubsection pf_rm_sf Simple/fast models
811
812 \li <b>none</b>: No routing (Unless you know what you are doing, avoid
813 using this mode in combination with a non Constant network model). 
814 None Example :
815 \verbatim
816 <AS id="exitAS"  routing="none">
817         <router id="exit_gateway"/>
818 </AS>\endverbatim
819
820 \li <b>Vivaldi</b>: Vivaldi routing, so when you want to use
821     coordinates. See the corresponding section P2P below for details. 
822 \li <b>Cluster</b>: Cluster routing, specific to cluster tag, should
823     not be used, except internally. 
824
825 \subsection ps_dec Defining routes
826
827 The principle of route definition is the same for the 4 available tags
828 for doing it. Those for tags are:
829
830 \li <b>route</b>: to define route between host/router
831 \li <b>ASroute</b>: to define route between AS
832 \li <b>bypassRoute</b>: to bypass normal routes as calculated by the
833     network model between host/router 
834 \li <b>bypassASroute</b>: same as bypassRoute, but for AS
835
836 Basically all those tags will contain an (ordered) list of references
837 to link that compose the route you want to define.
838
839 Consider the example below:
840
841 \verbatim
842 <route src="Alice" dst="Bob">
843         <link_ctn id="link1"/>
844         <link_ctn id="link2"/>
845         <link_ctn id="link3"/>
846    </route>
847 \endverbatim
848
849 The route here from host Alice to Bob will be first link1, then link2,
850 and finally link3. What about the reverse route ? <b>route</b> and
851 <b>ASroute</b> have an optional attribute <b>symmetrical</b>, that can
852 be either YES or NO. YES means that the reverse route is the same
853 route in the inverse order, and is set to YES by default. Note that
854 this is not the case for bypass*Route, as it is more probable that you
855 want to bypass only one default route.
856
857 For an ASroute, things are just slightly more complicated, as you have
858 to give the id of the gateway which is inside the AS you're talking
859 about you want to access ... So it looks like this :
860
861
862 \verbatim
863   <ASroute src="AS1" dst="AS2"
864     gw_src="router1" gw_dst="router2">
865     <link_ctn id="link1"/>
866   </ASroute>
867 \endverbatim
868
869 gw == gateway, so when any message are trying to go from AS1 to AS2,
870 it means that it must pass through router1 to get out of the AS, then
871 pass through link1, and get into AS2 by being received by router2.
872 router1 must belong to AS1 and router2 must belong to AS2.
873
874 \subsubsection pf_linkctn link_ctn
875
876 a <b>link_ctn</b> is the tag that is used in order to reference a
877 <b>link</b> in a route. Its id is the link id it refers to.
878
879 <b>link_ctn</b> attributes :
880 \li <b>id (mandatory)</b>: Id of the link this tag refers to
881 \li <b>direction</b>: if the link referenced by <b>id</b> has been
882     declared as FULLDUPLEX, this is used to indicate in which
883     direction the route you're defining is going through this link.
884     Possible values "UP" or "DOWN".
885
886 \subsubsection pf_asro ASroute
887
888 ASroute tag purpose is to let people write manually their routes
889 between AS. It's useful when you're in Full model.
890
891 <b>ASroute</b> attributes :
892 \li <b>src (mandatory)</b>: the source AS id.
893 \li <b>dst (mandatory)</b>: the destination AS id.
894 \li <b>gw_src (mandatory)</b>: the gateway to be used within the AS.
895     Can be any <b>host</b> or \b router defined into the \b src AS or
896     into one of the AS it includes.
897 \li <b>gw_dst (mandatory)</b>: the gateway to be used within the AS.
898     Can be any <b>host</b> or \b router defined into the \b dst AS or
899     into one of the AS it includes.
900 \li <b>symmetrical</b>: if the route is symmetric, the reverse route
901     will be the opposite of the one defined. Can be either YES or NO,
902     default is YES.
903
904 <b>Example of ASroute with Full</b>
905 \verbatim
906 <AS  id="AS0"  routing="Full">
907   <cluster id="my_cluster_1" prefix="c-" suffix=".me"
908                 radical="0-149" power="1000000000"    bw="125000000"     lat="5E-5"
909         bb_bw="2250000000" bb_lat="5E-4"/>
910
911   <cluster id="my_cluster_2" prefix="c-" suffix=".me"
912             radical="150-299" power="1000000000"        bw="125000000"  lat="5E-5"
913             bb_bw="2250000000" bb_lat="5E-4"/>
914
915      <link id="backbone" bandwidth="1250000000" latency="5E-4"/>
916
917      <ASroute src="my_cluster_1" dst="my_cluster_2"
918          gw_src="c-my_cluster_1_router.me"
919          gw_dst="c-my_cluster_2_router.me">
920                 <link_ctn id="backbone"/>
921      </ASroute>
922      <ASroute src="my_cluster_2" dst="my_cluster_1"
923          gw_src="c-my_cluster_2_router.me"
924          gw_dst="c-my_cluster_1_router.me">
925                 <link_ctn id="backbone"/>
926      </ASroute>
927 </AS>
928 \endverbatim
929
930 \subsubsection pf_ro route
931 The principle is the same as ASroute : <b>route</b> contains list of
932 links that are in the path between src and dst, except that it is for
933 routes between a src that can be either <b>host</b> or \b router and a
934 dst that can be either <b>host</b> or \b router. Useful for Full 
935 as well as for the shortest-paths based models, where you
936 have to give topological information.
937
938
939 <b>route</b> attributes :
940 \li <b>src (mandatory)</b>: the source id.
941 \li <b>dst (mandatory)</b>: the destination id.
942 \li <b>symmetrical</b>: if the route is symmetric, the reverse route
943     will be the opposite of the one defined. Can be either YES or NO,
944     default is YES.
945
946 <b>route example in Full</b>
947 \verbatim
948  <route src="Tremblay" dst="Bourassa">
949      <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"/>
950    </route>
951 \endverbatim
952
953 <b>route example in a shortest-path model</b>
954 \verbatim
955  <route src="Tremblay" dst="Bourassa">
956      <link_ctn id="3"/>
957    </route>
958 \endverbatim
959 Note that when using route to give topological information, you have
960 to give routes with one link only in it, as SimGrid needs to know
961 which host are at the end of the link.
962
963 \subsubsection pf_byro bypassASroute
964
965 <b>Note : bypassASroute and bypassRoute are under rewriting to perform
966 better ; so you may not use it yet</b> As said before, once you choose
967 a model, it (if so) calculates routes for you. But maybe you want to
968 define some of your routes, which will be specific. You may also want
969 to bypass some routes defined in lower level AS at an upper stage :
970 <b>bypassASroute</b> is the tag you're looking for. It allows to
971 bypass routes defined between already defined between AS (if you want
972 to bypass route for a specific host, you should just use byPassRoute).
973 The principle is the same as ASroute : <b>bypassASroute</b> contains
974 list of links that are in the path between src and dst.
975
976 <b>bypassASroute</b> attributes :
977 \li <b>src (mandatory)</b>: the source AS id.
978 \li <b>dst (mandatory)</b>: the destination AS id.
979 \li <b>gw_src (mandatory)</b>: the gateway to be used within the AS.
980     Can be any <b>host</b> or \b router defined into the \b src AS or
981     into one of the AS it includes.
982 \li <b>gw_dst (mandatory)</b>: the gateway to be used within the AS.
983     Can be any <b>host</b> or \b router defined into the \b dst AS or
984     into one of the AS it includes.
985 \li <b>symmetrical</b>: if the route is symmetric, the reverse route
986     will be the opposite of the one defined. Can be either YES or NO,
987     default is YES.
988
989 <b>bypassASroute Example</b>
990 \verbatim
991     <bypassASRoute src="my_cluster_1" dst="my_cluster_2"
992      gw_src="my_cluster_1_router"
993      gw_dst="my_cluster_2_router">
994         <link_ctn id="link_tmp"/>
995      </bypassASroute>
996 \endverbatim
997
998 \subsubsection pf_byro bypassRoute
999 <b>Note : bypassASRoute and bypassRoute are under rewriting to perform
1000 better ; so you may not use it yet</b> As said before, once you choose
1001 a model, it (if so) calculates routes for you. But maybe you want to
1002 define some of your routes, which will be specific. You may also want
1003 to bypass some routes defined in lower level AS at an upper stage :
1004 <b>bypassRoute</b> is the tag you're looking for. It allows to bypass
1005 routes defined between <b>host/router</b>. The principle is the same
1006 as route : <b>bypassRoute</b> contains list of links references of
1007 links that are in the path between src and dst.
1008
1009 <b>bypassRoute</b> attributes :
1010 \li <b>src (mandatory)</b>: the source AS id.
1011 \li <b>dst (mandatory)</b>: the destination AS id.
1012 \li <b>symmetrical</b>: if the route is symmetric, the reverse route
1013     will be the opposite of the one defined. Can be either YES or NO,
1014     default is YES.
1015
1016 <b>bypassRoute Example</b>
1017 \verbatim
1018 <b>bypassRoute Example</b>
1019 \verbatim
1020     <bypassRoute src="host_1" dst="host_2">
1021         <link_ctn id="link_tmp"/>
1022      </bypassRoute>
1023 \endverbatim
1024
1025
1026 \subsection pb_baroex Basic Routing Example
1027
1028 Let's say you have an AS named AS_Big that contains two other AS, AS_1
1029 and AS_2. If you want to make an host (h1) from AS_1 with another one
1030 (h2) from AS_2 then you'll have to proceed as follow:
1031 \li First, you have to ensure that a route is defined from h1 to the
1032     AS_1's exit gateway and from h2 to AS_2's exit gateway.
1033 \li Then, you'll have to define a route between AS_1 to AS_2. As those
1034     AS are both resources belonging to AS_Big, then it has to be done
1035     at AS_big level. To define such a route, you have to give the
1036     source AS (AS_1), the destination AS (AS_2), and their respective
1037     gateway (as the route is effectively defined between those two
1038     entry/exit points). Elements of this route can only be elements
1039     belonging to AS_Big, so links and routers in this route should be
1040     defined inside AS_Big. If you choose some shortest-path model,
1041     this route will be computed automatically.
1042
1043 As said before, there are mainly 2 tags for routing :
1044 \li <b>ASroute</b>: to define routes between two  <b>AS</b>
1045 \li <b>route</b>: to define routes between two <b>host/router</b>
1046
1047 As we are dealing with routes between AS, it means that those we'll
1048 have some definition at AS_Big level. Let consider AS_1 contains 1
1049 host, 1 link and one router and AS_2 3 hosts, 4 links and one router.
1050 There will be a central router, and a cross-like topology. At the end
1051 of the crosses arms, you'll find the 3 hosts and the router that will
1052 act as a gateway. We have to define routes inside those two AS. Let
1053 say that AS_1 contains full routes, and AS_2 contains some Floyd
1054 routing (as we don't want to bother with defining all routes). As
1055 we're using some shortest path algorithms to route into AS_2, we'll
1056 then have to define some <b>route</b> to gives some topological
1057 information to SimGrid. Here is a file doing it all :
1058
1059 \verbatim
1060 <AS  id="AS_Big"  routing="Dijsktra">
1061   <AS id="AS_1" routing="Full">
1062      <host id="AS_1_host1" power="1000000000"/>
1063      <link id="AS_1_link" bandwidth="1250000000" latency="5E-4"/>
1064      <router id="AS_1_gateway"/>
1065      <route src="AS_1_host1" dst="AS_1_gateway">
1066             <link_ctn id="AS_1_link"/>
1067      </route>
1068   </AS>
1069   <AS id="AS_2" routing="Floyd">
1070      <host id="AS_2_host1" power="1000000000"/>
1071      <host id="AS_2_host2" power="1000000000"/>
1072      <host id="AS_2_host3" power="1000000000"/>
1073      <link id="AS_2_link1" bandwidth="1250000000" latency="5E-4"/>
1074      <link id="AS_2_link2" bandwidth="1250000000" latency="5E-4"/>
1075      <link id="AS_2_link3" bandwidth="1250000000" latency="5E-4"/>
1076      <link id="AS_2_link4" bandwidth="1250000000" latency="5E-4"/>
1077      <router id="central_router"/>
1078      <router id="AS_2_gateway"/>
1079      <!-- routes providing topological information -->
1080      <route src="central_router" dst="AS_2_host1"><link_ctn id="AS_2_link1"/></route>
1081      <route src="central_router" dst="AS_2_host2"><link_ctn id="AS_2_link2"/></route>
1082      <route src="central_router" dst="AS_2_host3"><link_ctn id="AS_2_link3"/></route>
1083      <route src="central_router" dst="AS_2_gateway"><link_ctn id="AS_2_link4"/></route>
1084   </AS>
1085     <link id="backbone" bandwidth="1250000000" latency="5E-4"/>
1086
1087      <ASroute src="AS_1" dst="AS_2"
1088          gw_src="AS_1_gateway"
1089          gw_dst="AS_2_gateway">
1090                 <link_ctn id="backbone"/>
1091      </ASroute>
1092 </AS>
1093 \endverbatim
1094
1095 \section pf_other_tags Tags not (directly) describing the platform
1096
1097 There are 3 tags, that you can use inside a \<platform\> tag that are
1098 not describing the platform: 
1099 \li random: it allows you to define random generators you want to use
1100     for your simulation. 
1101 \li config: it allows you to pass some configuration stuff like, for
1102     example, the network model and so on. It follows the 
1103 \li include: simply allows you to include another file into the
1104     current one. 
1105
1106 \subsection pf_conf config
1107 <b>config</b> attributes :
1108 \li <b>id (mandatory)</b>: the identifier of the config to be used
1109     when referring to it. 
1110
1111
1112 <b>config</b> tag only purpose is to include <b>prop</b> tags. Valid
1113 id are basically the same as the list of possible parameters you can
1114 use by command line, except that "/" are used for namespace
1115 definition. See the \ref options config and options page for more
1116 information.
1117
1118
1119 <b>config example</b>
1120 \verbatim
1121 <?xml version='1.0'?>
1122 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1123 <platform version="3">
1124 <config id="General">
1125         <prop id="maxmin/precision" value="0.000010"></prop>
1126         <prop id="cpu/optim" value="TI"></prop>
1127         <prop id="workstation/model" value="compound"></prop>
1128         <prop id="network/model" value="SMPI"></prop>
1129         <prop id="path" value="~/"></prop>
1130         <prop id="smpi/bw_factor" value="65472:0.940694;15424:0.697866;9376:0.58729"></prop>
1131 </config>
1132
1133 <AS  id="AS0"  routing="Full">
1134 ...
1135 \endverbatim
1136
1137
1138 \subsection pf_rand random
1139 Not yet in use, and possibly subject to huge modifications.
1140
1141 \subsection pf_incl include
1142 <b>include</b> tag allows to import into a file platform parts located
1143 in another file. This is done with the intention to help people
1144 combine their different AS and provide new platforms. Those files
1145 should contains XML part that contains either
1146 <b>include,cluster,peer,AS,trace,trace_connect</b> tags.  
1147
1148 <b>include</b> attributes :
1149 \li <b>file (mandatory)</b>: filename of the file to include. Possible
1150     values: absolute or relative path, syntax similar to the one in
1151     use on your system. 
1152
1153 <b>Note</b>: due to some obscure technical reasons, you have to open
1154 and close tag in order to let it work. 
1155 <b>include Example</b>
1156 \verbatim
1157 <?xml version='1.0'?>
1158 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1159 <platform version="3">
1160         <AS id="main" routing="Full">
1161                 <include file="clusterA.xml"></include>
1162                 <include file="clusterB.xml"></include>
1163         </AS>
1164 </platform>
1165 \endverbatim
1166
1167 \subsection pf_tra trace and trace_connect
1168 Both tags are an alternate way to passe availability, state, and so on
1169 files to entity. Instead of referring to the file directly in the host,
1170 link, or cluster tag, you proceed by defining a trace with an id
1171 corresponding to a file, later an host/link/cluster, and finally using
1172 trace_connect you say that the file trace must be used by the entity.
1173 Get it ? Let's have a look at an example : 
1174
1175 \verbatim
1176 <AS  id="AS0"  routing="Full">
1177   <host id="bob" power="1000000000"/>
1178 </AS>
1179   <trace id="myTrace" file="bob.trace" periodicity="1.0"/>
1180   <trace_connect trace="myTrace" element="bob" kind="POWER"/>
1181 \endverbatim
1182
1183 All constraints you have is that <b>trace_connect</b> is after
1184 <b>trace</b> and <b>host</b> definitions.
1185
1186
1187 <b>trace</b> attributes :
1188 \li <b>id (mandatory)</b>: the identifier of the trace to be used when
1189     referring to it.
1190 \li <b>file</b>: filename of the file to include. Possible values :
1191     absolute or relative path, syntax similar to the one in use on
1192     your system. If omitted, the system expects that you provide the
1193     trace values inside the trace tags (see below).
1194 \li <b>trace periodicity (mandatory)</b>: trace periodicity, same
1195     definition as in hosts (see upper for details).
1196
1197 Here is an example  of trace when no file name is provided:
1198
1199 \verbatim
1200  <trace id="myTrace" periodicity="1.0">
1201     0.0 1.0
1202     11.0 0.5
1203     20.0 0.8
1204   </trace>
1205 \endverbatim
1206
1207 <b>trace_connect</b> attributes :
1208 \li <b>kind</b>: the type of trace, possible values
1209     <b>HOST_AVAIL|POWER|LINK_AVAIL|BANDWIDTH|LATENCY,</b>  default:
1210     <b>HOST_AVAIL</b>  
1211 \li <b>trace (mandatory)</b>: the identifier of the trace referenced.
1212 \li <b>element (mandatory)</b>: the identifier of the entity referenced.
1213
1214
1215
1216 \section pf_hints Hints and tips, or how to write a platform efficiently
1217
1218 Now you should know at least the syntax and be able to create a
1219 platform by your own. However, after having ourselves wrote some platforms, there
1220 are some best practices you should pay attention to in order to
1221 produce good platform and some choices you can make in order to have
1222 faster simulations. Here's some hints and tips, then.
1223
1224 \subsection pf_as_h AS Hierarchy
1225 The AS design allows SimGrid to go fast, because computing route is
1226 done only for the set of resources defined in this AS. If you're using
1227 only a big AS containing all resource with no AS into it and you're
1228 using Full model, then ... you'll loose all interest into it. On the
1229 other hand, designing a binary tree of AS with, at the lower level,
1230 only one host, then you'll also loose all the good AS hierarchy can
1231 give you. Remind you should always be "reasonable" in your platform
1232 definition when choosing the hierarchy. A good choice if you try to
1233 describe a real life platform is to follow the AS described in
1234 reality, since this kind of trade-off works well for real life
1235 platforms.
1236
1237 \subsection pf_exit_as Exit AS: why and how
1238 Users that have looked at some of our platforms may have notice a
1239 non-intuitive schema ... Something like that :
1240
1241
1242 \verbatim
1243 <AS id="AS_4"  routing="Full">
1244 <AS id="exitAS_4"  routing="Full">
1245         <router id="router_4"/>
1246 </AS>
1247 <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"/>
1248 <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"/>
1249 <link id="4_1" bandwidth="2250000000" latency="5E-5"/>
1250 <link id="4_2" bandwidth="2250000000" latency="5E-5"/>
1251 <link id="bb_4" bandwidth="2250000000" latency="5E-4"/>
1252 <ASroute src="cl_4_1"
1253         dst="cl_4_2"
1254         gw_src="c_4_1-cl_4_1_router"
1255         gw_dst="c_4_2-cl_4_2_router"
1256         symmetrical="YES">
1257                 <link_ctn id="4_1"/>
1258                 <link_ctn id="bb_4"/>
1259                 <link_ctn id="4_2"/>
1260 </ASroute>
1261 <ASroute src="cl_4_1"
1262         dst="exitAS_4"
1263         gw_src="c_4_1-cl_4_1_router"
1264         gw_dst="router_4"
1265         symmetrical="YES">
1266                 <link_ctn id="4_1"/>
1267                 <link_ctn id="bb_4"/>
1268 </ASroute>
1269 <ASroute src="cl_4_2"
1270         dst="exitAS_4"
1271         gw_src="c_4_2-cl_4_2_router"
1272         gw_dst="router_4"
1273         symmetrical="YES">
1274                 <link_ctn id="4_2"/>
1275                 <link_ctn id="bb_4"/>
1276 </ASroute>
1277 </AS>
1278 \endverbatim
1279
1280 In the AS_4, you have an exitAS_4 defined, containing only one router,
1281 and routes defined to that AS from all other AS (as cluster is only a
1282 shortcut for an AS, see cluster description for details). If there was
1283 an upper AS, it would define routes to and from AS_4 with the gateway
1284 router_4. It's just because, as we did not allowed (for performances
1285 issues) to have routes from an AS to a single host/router, you have to
1286 enclose your gateway, when you have AS included in your AS, within an
1287 AS to define routes to it.
1288
1289 \subsection pf_P2P_tags P2P or how to use coordinates
1290 SimGrid allows you to use some coordinated-based system, like vivaldi,
1291 to describe a platform. The main concept is that you have some peers
1292 that are located somewhere: this is the function of the 
1293 <b>coordinates</b> of the \<peer\> or \<host\> tag. There's nothing
1294 complicated in using it, here is an example of it:
1295
1296 \verbatim
1297 <?xml version='1.0'?>
1298 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1299 <platform version="3">
1300
1301 <config id="General">
1302         <prop id="network/coordinates" value="yes"></prop>
1303 </config>
1304  <AS  id="AS0"  routing="Vivaldi">
1305         <host id="100030591" coordinates="25.5 9.4 1.4" power="1500000000.0" />
1306         <host id="100036570" coordinates="-12.7 -9.9 2.1" power="730000000.0" />
1307         ...
1308         <host id="100429957" coordinates="17.5 6.7 18.8" power="830000000.0" />
1309         </AS>
1310 </platform>
1311 \endverbatim
1312
1313 Coordinates are then used to calculate latency between two hosts by
1314 calculating the euclidean distance between the two hosts coordinates.
1315 The results express the latency in ms.
1316
1317 Note that the previous example defines a routing directly between hosts but it could be also used to define a routing between AS.
1318 That is for example what is commonly done when using peers (see Section \ref pf_peer).
1319 \verbatim
1320 <?xml version='1.0'?>
1321 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1322 <platform version="3">
1323
1324 <config id="General">
1325         <prop id="network/coordinates" value="yes"></prop>
1326 </config>
1327  <AS  id="AS0"  routing="Vivaldi">
1328    <peer id="peer-0" coordinates="173.0 96.8 0.1" power="730Mf" bw_in="13.38MBps" bw_out="1.024MBps" lat="500us"/>
1329    <peer id="peer-1" coordinates="247.0 57.3 0.6" power="730Mf" bw_in="13.38MBps" bw_out="1.024MBps" lat="500us" />
1330    <peer id="peer-2" coordinates="243.4 58.8 1.4" power="730Mf" bw_in="13.38MBps" bw_out="1.024MBps" lat="500us" />
1331 </AS>
1332 </platform>
1333 \endverbatim
1334 In such a case though, we connect the AS created by the <b>peer</b> tag with the Vivaldi routing mechanism. 
1335 This means that to route between AS1 and AS2, it will use the coordinates of router_AS1 and router_AS2. 
1336 This is currently a convention and we may offer to change this convention in the DTD later if needed.
1337 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.
1338
1339
1340 \subsection pf_wisely Choosing wisely the routing model to use
1341
1342
1343 Choosing wisely the routing model to use can significantly fasten your
1344 simulation/save your time when writing the platform/save tremendous
1345 disk space. Here is the list of available model and their
1346 characteristics (lookup : time to resolve a route):
1347
1348 \li <b>Full</b>: Full routing data (fast, large memory requirements,
1349     fully expressive)    
1350 \li <b>Floyd</b>: Floyd routing data (slow initialization, fast
1351     lookup, lesser memory requirements, shortest path routing only).
1352     Calculates all routes at once at the beginning.
1353 \li <b>Dijkstra</b>: Dijkstra routing data (fast initialization, slow
1354     lookup, small memory requirements, shortest path routing only).
1355     Calculates a route when necessary.
1356 \li <b>DijkstraCache</b>: Dijkstra routing data (fast initialization,
1357     fast lookup, small memory requirements, shortest path routing
1358     only). Same as Dijkstra, except it handles a cache for latest used
1359     routes.
1360 \li <b>none</b>: No routing (usable with Constant network only).
1361     Defines that there is no routes, so if you try to determine a
1362     route without constant network within this AS, SimGrid will raise
1363     an exception.
1364 \li <b>Vivaldi</b>: Vivaldi routing, so when you want to use coordinates
1365 \li <b>Cluster</b>: Cluster routing, specific to cluster tag, should
1366     not be used. 
1367
1368 \subsection pf_switch Hey, I want to describe a switch but there is no switch tag !
1369
1370 Actually we did not include switch tag, ok. But when you're trying to
1371 simulate a switch, the only major impact it has when you're using
1372 fluid model (and SimGrid uses fluid model unless you activate GTNetS,
1373 ns-3, or constant network mode) is the impact of the upper limit of
1374 the switch motherboard speed that will eventually be reached if you're
1375 using intensively your switch. So, the switch impact is similar to a
1376 link one. That's why we are used to describe a switch using a link tag
1377 (as a link is not an edge by a hyperedge, you can connect more than 2
1378 other links to it).
1379
1380 \subsection pf_platform_multipath How to express multipath routing in platform files?
1381
1382 It is unfortunately impossible to express the fact that there is more
1383 than one routing path between two given hosts. Let's consider the
1384 following platform file:
1385
1386 \verbatim
1387 <route src="A" dst="B">
1388    <link_ctn id="1"/>
1389 </route>
1390 <route src="B" dst="C">
1391   <link_ctn id="2"/>
1392 </route>
1393 <route src="A" dst="C">
1394   <link_ctn id="3"/>
1395 </route>
1396 \endverbatim
1397
1398 Although it is perfectly valid, it does not mean that data traveling
1399 from A to C can either go directly (using link 3) or through B (using
1400 links 1 and 2). It simply means that the routing on the graph is not
1401 trivial, and that data do not following the shortest path in number of
1402 hops on this graph. Another way to say it is that there is no implicit
1403 in these routing descriptions. The system will only use the routes you
1404 declare (such as &lt;route src="A" dst="C"&gt;&lt;link_ctn
1405 id="3"/&gt;&lt;/route&gt;), without trying to build new routes by aggregating
1406 the provided ones.
1407
1408 You are also free to declare platform where the routing is not
1409 symmetric. For example, add the following to the previous file:
1410
1411 \verbatim
1412 <route src="C" dst="A">
1413   <link_ctn id="2"/>
1414   <link_ctn id="1"/>
1415 </route>
1416 \endverbatim
1417
1418 This makes sure that data from C to A go through B where data from A
1419 to C go directly. Don't worry about realism of such settings since
1420 we've seen ways more weird situation in real settings (in fact, that's
1421 the realism of very regular platforms which is questionable, but
1422 that's another story).
1423
1424 \section pf_flexml_bypassing Bypassing the XML parser with your own C functions
1425 <b>NOTE THAT THIS DOCUMENTATION, WHILE STILL WORKING, IS STRONGLY DEPRECATED</b>
1426
1427 So you want to bypass the XML files parser, uh? Maybe doing some parameter
1428 sweep experiments on your simulations or so? This is possible, and
1429 it's not even really difficult (well. Such a brutal idea could be
1430 harder to implement). Here is how it goes.
1431
1432 For this, you have to first remember that the XML parsing in SimGrid is done
1433 using a tool called FleXML. Given a DTD, this gives a flex-based parser. If
1434 you want to bypass the parser, you need to provide some code mimicking what
1435 it does and replacing it in its interactions with the SURF code. So, let's
1436 have a look at these interactions.
1437
1438 FleXML parser are close to classical SAX parsers. It means that a
1439 well-formed SimGrid platform XML file might result in the following
1440 "events":
1441
1442   - start "platform_description" with attribute version="2"
1443   - start "host" with attributes id="host1" power="1.0"
1444   - end "host"
1445   - start "host" with attributes id="host2" power="2.0"
1446   - end "host"
1447   - start "link" with ...
1448   - end "link"
1449   - start "route" with ...
1450   - start "link_ctn" with ...
1451   - end "link_ctn"
1452   - end "route"
1453   - end "platform_description"
1454
1455 The communication from the parser to the SURF code uses two means:
1456 Attributes get copied into some global variables, and a surf-provided
1457 function gets called by the parser for each event. For example, the event
1458   - start "host" with attributes id="host1" power="1.0"
1459
1460 let the parser do something roughly equivalent to:
1461 \verbatim
1462   strcpy(A_host_id,"host1");
1463   A_host_power = 1.0;
1464   STag_host();
1465 \endverbatim
1466
1467 In SURF, we attach callbacks to the different events by initializing the
1468 pointer functions to some the right surf functions. Since there can be
1469 more than one callback attached to the same event (if more than one
1470 model is in use, for example), they are stored in a dynar. Example in
1471 workstation_ptask_L07.c:
1472 \verbatim
1473   /* Adding callback functions */
1474   surf_parse_reset_parser();
1475   surfxml_add_callback(STag_surfxml_host_cb_list, &parse_cpu_init);
1476   surfxml_add_callback(STag_surfxml_prop_cb_list, &parse_properties);
1477   surfxml_add_callback(STag_surfxml_link_cb_list, &parse_link_init);
1478   surfxml_add_callback(STag_surfxml_route_cb_list, &parse_route_set_endpoints);
1479   surfxml_add_callback(ETag_surfxml_link_c_ctn_cb_list, &parse_route_elem);
1480   surfxml_add_callback(ETag_surfxml_route_cb_list, &parse_route_set_route);
1481
1482   /* Parse the file */
1483   surf_parse_open(file);
1484   xbt_assert(!surf_parse(), "Parse error in %s", file);
1485   surf_parse_close();
1486 \endverbatim
1487
1488 So, to bypass the FleXML parser, you need to write your own version of the
1489 surf_parse function, which should do the following:
1490    - Fill the A_<tag>_<attribute> variables with the wanted values
1491    - Call the corresponding STag_<tag>_fun function to simulate tag start
1492    - Call the corresponding ETag_<tag>_fun function to simulate tag end
1493    - (do the same for the next set of values, and loop)
1494
1495 Then, tell SimGrid that you want to use your own "parser" instead of the stock one:
1496 \verbatim
1497   surf_parse = surf_parse_bypass_environment;
1498   MSG_create_environment(NULL);
1499   surf_parse = surf_parse_bypass_application;
1500   MSG_launch_application(NULL);
1501 \endverbatim
1502
1503 A set of macros are provided at the end of
1504 include/surf/surfxml_parse.h to ease the writing of the bypass
1505 functions. An example of this trick is distributed in the file
1506 examples/msg/masterslave/masterslave_bypass.c
1507
1508
1509 */