Logo AND Algorithmique Numérique Distribuée

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