Logo AND Algorithmique Numérique Distribuée

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