1 /*! \page platform Describing the virtual platform
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 want to simulate your application, and
7 information about the deployment of the application: Which process should be executed onto which processor/core?
9 For the last two items, there are essentially three possible ways you can provide
10 this information as an input:
11 \li You can program, if you're using MSG, some of the platform and
12 deployment functions. If you choose to follow this approach, check the dedicated documentation
13 (\ref msg_simulation).
14 \li You can use two XML files: one for the platform description and the other for the deployment.
15 \li You can program the description of your platform in Lua format.
17 For more information on SimGrid's deployment features, please refer to the \ref deployment section.
19 The platform description may be intricate. This documentation is all
20 about how to write this file. You should read about the
21 @ref routing_basics "routing basic concepts" before proceeding. This page
22 first contain a reference guide of the XML. Finally, it gives some hints and tips on how to write a better
25 \section pf_overview Some words about XML and DTD
27 We opted for XML not only because it is extensible but also because many tools (and plugins for existing tools) are
28 available that facilitate editing and validating XML files. Furthermore, libraries that parse XML are often already
29 available and very well tested.
31 The XML checking is done based on the [simgrid.dtd](http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd) Document Type
32 Definition (DTD) file.
34 If you read the DTD, you should notice the following:
35 \li The platform tag has a version attribute. The current version is <b>4</b>. This attribute might be used in the
36 provide backward compatibility.
37 \li The DTD contains definitions for both the platform description and deployment files used by SimGrid.
39 \section pf_netzones Defining a netzone
41 Here is a simplistic example, describing a netzone using the Full
42 routing. Other supported values for the routing attribute can be
43 found below, Section \ref pf_raf.
47 <AS id="netzone0" routing="Full">
50 There is also the ``<route>`` tag; this tag takes two attributes,
51 ``src`` (source) and ``dst`` (destination). Both source and
52 destination must be valid identifiers for routers (these will be
53 introduced later). Contained by the ``<route>`` are network links;
54 these links must be used in order to communicate from the source to
55 the destination specified in the tag. Hence, a route merely describes
56 how to reach a router from another router.
59 More information and (code-)examples can be found in Section \ref pf_rm.
61 A netzone can also contain itself one or more netzone; this allows you to model
62 the hierarchy of your platform.
64 ### Within each AS, the following types of resources exist:
66 %Resource | Documented in Section | Description
67 --------------- | --------------------- | -----------
68 AS | | Every Autonomous System (AS) may contain one or more AS.
69 host | \ref pf_host | This entity carries out the actual computation. For this reason, it contains processors (with potentially multiple cores).
70 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.
71 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.
72 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.
74 As it is desirable to interconnect these resources, a routing has to
75 be defined. The AS is supposed to be Autonomous, hence this has to be
76 done at the AS level. The AS handles two different types of entities
77 (<b>host/router</b> and <b>AS</b>). However, the user is responsible
78 to define routes between those resources, otherwise entities will be
79 unconnected and therefore unreachable from other entities. Although
80 several routing algorithms are built into SimGrid (see \ref pf_rm),
81 you might encounter a case where you want to define routes manually
82 (for instance, due to specific requirements of your platform).
84 There are three tags to use:
85 \li <b>ASroute</b>: to define routes between two <b>AS</b>
86 \li <b>route</b>: to define routes between two <b>host/router</b>
87 \li <b>bypassRoute</b>: to define routes between two <b>AS</b> that
88 will bypass default routing (as specified by the ``routing`` attribute
89 supplied to ``<AS>``, see above).
91 Here is an illustration of these concepts:
93 
94 Circles represent processing units and squares represent network routers. Bold
95 lines represent communication links. AS2 models the core of a national
96 network interconnecting a small flat cluster (AS4) and a larger
97 hierarchical cluster (AS5), a subset of a LAN (AS6), and a set of peers
98 scattered around the world (AS7).
100 \section pf_pftags Resource description
102 \subsection pf_As Platform: The <AS> tag
104 The concept of an AS was already outlined above (Section \ref pf_basics);
105 recall that the AS is so important because it groups other resources (such
106 as routers/hosts) together (in fact, these resources must be contained by
109 Available attributes :
111 Attribute name | Mandatory | Values | Description
112 --------------- | --------- | ------ | -----------
113 id | yes | String | The identifier of an AS; facilitates referring to this AS. ID must be unique.
114 routing | yes | Full\| Floyd\| Dijkstra\| DijkstraCache\| None\| Vivaldi\| Cluster | See Section \ref pf_rm for details.
119 <AS id="AS0" routing="Full">
120 <host id="host1" speed="1000000000"/>
121 <host id="host2" speed="1000000000"/>
122 <link id="link1" bandwidth="125000000" latency="0.000100"/>
123 <route src="host1" dst="host2"><link_ctn id="link1"/></route>
127 In this example, AS0 contains two hosts (host1 and host2). The route
128 between the hosts goes through link1.
130 \subsection pf_Cr Computing resources: hosts, clusters and peers.
132 \subsubsection pf_host <host/>
134 A <b>host</b> represents a computer/node card. Every host is able to execute
135 code and it can send and receive data to/from other hosts. Most importantly,
136 a host can contain more than 1 core.
140 Attribute name | Mandatory | Values | Description
141 --------------- | --------- | ------ | -----------
142 id | yes | String | The identifier of the host. facilitates referring to this AS.
143 speed | yes | double (must be > 0.0) | Computational power of every core of this host in FLOPS. Must be larger than 0.0.
144 core | no | int (Default: 1) | The number of cores of this host. If more than one core is specified, the "speed" parameter refers to every core, i.e., the total computational power is no_of_cores*speed.<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.
145 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.
146 state_file | no | string | Same mechanism as availability_file.<br /> <b>Note:</b> The filename must be specified with your system's format.
147 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.
148 pstate | no | double (Default: 0.0) | FIXME: Not yet documented.
150 ### Possible children: ###
152 Tag name | Description | Documentation
153 ------------ | ----------- | -------------
154 \<mount/\> | Defines mounting points between some storage resource and the host. | \ref pf_storage_entity_mount
155 \<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
160 <host id="host1" speed="1000000000"/>
161 <host id="host2" speed="1000000000">
162 <prop id="color" value="blue"/>
163 <prop id="rendershape" value="square"/>
168 \anchor pf_host_dynamism
169 ### Expressing dynamism ###
171 SimGrid provides mechanisms to change a hosts' availability over
172 time, using the ``availability_file`` attribute to the ``\<host\>`` tag
173 and a separate text file whose syntax is exemplified below.
175 #### Adding a trace file ####
178 <platform version="4">
179 <host id="bob" speed="500Gf" availability_file="bob.trace" />
183 #### Example of "bob.trace" file ####
192 Let us begin to explain this example by looking at line 2. (Line 1 will become clear soon).
193 The first column describes points in time, in this case, time 0. The second column
194 describes the relative amount of power this host is able to deliver (relative
195 to the maximum performance specified in the ``\<host\>`` tag). (Clearly, the
196 second column needs to contain values that are not smaller than 0 and not larger than 1).
197 In this example, our host will deliver 500 Mflop/s at time 0, as 500 Mflop/s is the
198 maximum performance of this host. At time 11.0, it will
199 deliver half of its maximum performance, i.e., 250 Mflop/s until time 20.0 when it will
200 will start delivering 80\% of its power. In this example, this amounts to 400 Mflop/s.
202 Since the periodicity in line 1 was set to be 1.0, i.e., 1 timestep, this host will
203 continue to provide 500 Mflop/s from time 21. From time 32 it will provide 250 MFlop/s and so on.
205 ### Changing initial state ###
207 It is also possible to specify whether the host is up or down by setting the
208 ``state`` attribute to either <b>ON</b> (default value) or <b>OFF</b>.
210 #### Example: Expliciting the default value "ON" ####
213 <platform version="4">
214 <host id="bob" speed="500Gf" state="ON" />
218 If you want this host to be unavailable, simply substitute ON with OFF.
220 \anchor pf_host_churn
221 ### Expressing churn ###
223 To express the fact that a host can change state over time (as in P2P
224 systems, for instance), it is possible to use a file describing the time
225 at which the host is turned on or off. An example of the content
226 of such a file is presented below.
228 #### Adding a state file ####
231 <platform version="4">
232 <host id="bob" power="500Gf" state_file="bob.fail" />
236 #### Example of "bob.fail" file ####
244 A zero value means <b>down</b> (i.e., OFF) while a positive one means <b>up and
245 running</b> (i.e., ON). From time 0.0 to time 1.0, the host is on as usual. At time 1.0, it is
246 turned off and at time 2.0, it is turned on again until time 12 (2 plus the
247 periodicity 10). It will be turned off again at time 13.0 until time 23.0, and
251 \subsubsection pf_cluster <cluster>
253 ``<cluster />`` represents a machine-cluster. It is most commonly used
254 when one wants to define many hosts and a network quickly. Technically,
255 ``cluster`` is a meta-tag: <b>from the inner SimGrid point of
256 view, a cluster is an AS where some optimized routing is defined</b>.
257 The default inner organization of the cluster is as follow:
263 ____________|__________|_____________ backbone
265 l0| l1| l2| l97| l96 | | l99
271 Here, a set of <b>host</b>s is defined. Each of them has a <b>link</b>
272 to a central backbone (backbone is a link itself, as a link can
273 be used to represent a switch, see the switch / link section
274 below for more details about it). A <b>router</b> allows to connect a
275 <b>cluster</b> to the outside world. Internally,
276 SimGrid treats a cluster as an AS containing all hosts: the router is the default
277 gateway for the cluster.
279 There is an alternative organization, which is as follows:
293 The principle is the same, except that there is no backbone. This representation
294 can be obtained easily: just do not set the bb_* attributes.
297 Attribute name | Mandatory | Values | Description
298 --------------- | --------- | ------ | -----------
299 id | yes | string | The identifier of the cluster. Facilitates referring to this cluster.
300 prefix | yes | string | Each node of the cluster has to have a name. This name will be prefixed with this prefix.
301 suffix | yes | string | Each node of the cluster will be suffixed with this suffix
302 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.
303 speed | yes | int | Same as the ``speed`` attribute of the ``\<host\>`` tag.
304 core | no | int (default: 1) | Same as the ``core`` attribute of the ``\<host\>`` tag.
305 bw | yes | int | Bandwidth for the links between nodes and backbone (if any). See the \ref pf_link "link section" for syntax/details.
306 lat | yes | int | Latency for the links between nodes and backbone (if any). See <b>link</b> section for syntax/details.
307 sharing_policy | no | string | Sharing policy for the links between nodes and backbone (if any). See <b>link</b> section for syntax/details.
308 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>).
309 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>).
310 bb_sharing_policy | no | string | Sharing policy for the backbone (if any). See <b>link</b> section for syntax/details.
311 limiter_link | no | int | Bandwidth for limiter link (if any). This adds a specific link for each node, to set the maximum bandwidth reached when communicating in both directions at the same time. In theory this value should be 2*bw for fullduplex links, but in reality this might be less. This value will depend heavily on the communication model, and on the cluster's hardware, so no default value can be set, this has to be measured. More details can be obtained in <a href="https://hal.inria.fr/hal-00919507/"> "Toward Better Simulation of MPI Applications on Ethernet/TCP Networks"</a>
312 loopback_bw | no | int | Bandwidth for loopback (if any). See <b>link</b> section for syntax/details. If loopback_bw and loopback_lat (see below) attributes are omitted, no loopback link is created and all intra-node communication will use the main network link of the node. Loopback link is a \ref pf_sharing_policy_fatpipe "\b FATPIPE".
313 loopback_lat | no | int | Latency for loopback (if any). See <b>link</b> section for syntax/details. See loopback_bw for more info.
314 topology | no | FLAT\|TORUS\|FAT_TREE\|DRAGONFLY (default: FLAT) | Network topology to use. SimGrid currently supports FLAT (with or without backbone, as described before), <a href="http://en.wikipedia.org/wiki/Torus_interconnect">TORUS </a>, FAT_TREE, and DRAGONFLY attributes for this tag.
315 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 simgrid::kernel::routing::AsClusterFatTree "AsClusterFatTree documentation". For dragonfly, refer to \ref simgrid::kernel::routing::AsClusterDragonfly "AsClusterDragonfly documentation".
318 the router name is defined as the resulting String in the following
322 router_name = prefix + clusterId + "_router" + suffix;
326 #### Cluster example ####
328 Consider the following two (and independent) uses of the ``cluster`` tag:
331 <cluster id="my_cluster_1" prefix="" suffix="" radical="0-262144"
332 speed="1e9" bw="125e6" lat="5E-5"/>
334 <cluster id="my_cluster_2" prefix="c-" suffix=".me" radical="0-99"
335 speed="1e9" bw="125e6" lat="5E-5"
336 bb_bw="2.25e9" bb_lat="5E-4"/>
339 The second example creates one router and 100 machines with the following names:
341 c-my_cluster_2_router.me
349 \subsubsection pf_cabinet <cabinet>
352 This tag is only available when the routing mode of the AS
353 is set to ``Cluster``.
355 The ``<cabinet />`` tag is, like the \ref pf_cluster "<cluster>" tag,
356 a meta-tag. This means that it is simply a shortcut for creating a set of (homogenous) hosts and links quickly;
357 unsurprisingly, this tag was introduced to setup cabinets in data centers quickly. Unlike
358 <cluster>, however, the <cabinet> assumes that you create the backbone
359 and routers yourself; see our examples below.
363 Attribute name | Mandatory | Values | Description
364 --------------- | --------- | ------ | -----------
365 id | yes | string | The identifier of the cabinet. Facilitates referring to this cluster.
366 prefix | yes | string | Each node of the cabinet has to have a name. This name will be prefixed with this prefix.
367 suffix | yes | string | Each node of the cabinet will be suffixed with this suffix
368 radical | yes | string | Regexp used to generate cabinet nodes name. Syntax: "10-20" will give you 11 machines numbered from 10 to 20, "10-20;2" will give you 12 machines, one with the number 2, others numbered as before. The produced number is concatenated between prefix and suffix to form machine names.
369 speed | yes | int | Same as the ``speed`` attribute of the \ref pf_host "<host>" tag.
370 bw | yes | int | Bandwidth for the links between nodes and backbone (if any). See the \ref pf_link "link section" for syntax/details.
371 lat | yes | int | Latency for the links between nodes and backbone (if any). See the \ref pf_link "link section" for syntax/details.
374 Please note that as of now, it is impossible to change attributes such as,
375 amount of cores (always set to 1), the initial state of hosts/links
376 (always set to ON), the sharing policy of the links (always set to \ref pf_sharing_policy_fullduplex "FULLDUPLEX").
380 The following example was taken from ``examples/platforms/meta_cluster.xml`` and
381 shows how to use the cabinet tag.
384 <AS id="my_cluster1" routing="Cluster">
385 <cabinet id="cabinet1" prefix="host-" suffix=".cluster1"
386 speed="1Gf" bw="125MBps" lat="100us" radical="1-10"/>
387 <cabinet id="cabinet2" prefix="host-" suffix=".cluster1"
388 speed="1Gf" bw="125MBps" lat="100us" radical="11-20"/>
389 <cabinet id="cabinet3" prefix="host-" suffix=".cluster1"
390 speed="1Gf" bw="125MBps" lat="100us" radical="21-30"/>
392 <backbone id="backbone1" bandwidth="2.25GBps" latency="500us"/>
397 Please note that you must specify the \ref pf_backbone "<backbone>"
398 tag by yourself; this is not done automatically and there are no checks
399 that ensure this backbone was defined.
401 The hosts generated in the above example are named host-1.cluster, host-2.cluster1
405 \subsubsection pf_peer The <peer> tag
407 This tag represents a peer, as in Peer-to-Peer (P2P) networks. However, internally,
408 SimGrid transforms a peer into an AS (similar to Cluster). Hence, this tag
409 is virtually only a shortcut that comes with some pre-defined resources
410 and values. These are:
412 \li A tiny AS whose routing type is cluster is created
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 (e.g., ADSL peers).
416 \li It connects the two links to the host
417 \li It creates a router (a gateway) that serves as an entry point for this peer zone.
418 This router has coordinates.
422 Attribute name | Mandatory | Values | Description
423 --------------- | --------- | ------ | -----------
424 id | yes | string | The identifier of the peer. Facilitates referring to this peer.
425 speed | yes | int | See the description of the ``host`` tag for this attribute
426 bw_in | yes | int | Bandwidth downstream
427 bw_out | yes | int | Bandwidth upstream
428 lat | yes | double | Latency for both up- and downstream, in seconds.
429 coordinates | no | string | Coordinates of the gateway for this peer. Example value: 12.8 14.4 6.4
430 sharing_policy | no | SHARED\|FULLDUPLEX (default: FULLDUPLEX) | Sharing policy for links. See <b>link</b> description for details.
431 availability_file| no | string | Availability file for the peer. Same as host availability file. See <b>host</b> description for details.
432 state_file | no | string | State file for the peer. Same as host state file. See <b>host</b> description for details.
434 Internally, SimGrid transforms any ``\<peer/\>`` construct such as
437 coordinates="12.8 14.4 6.4"
443 into an ``\<AS\>`` (see Sections \ref pf_basics and \ref pf_As). In fact, this example of the ``\<peer/\>`` tag
444 is completely equivalent to the following declaration:
447 <AS id="as_FOO" routing="Cluster">
448 <host id="peer_FOO" speed="1.5Gf"/>
449 <link id="link_FOO_UP" bandwidth="2.25GBps" latency="500us"/>
450 <link id="link_FOO_DOWN" bandwidth="2.25GBps" latency="500us"/>
451 <router id="router_FOO" coordinates="25.5 9.4 1.4"/>
452 <host_link id="peer_FOO" up="link_FOO_UP" down="link_FOO_DOWN"/>
457 \subsection pf_ne Network equipments: links and routers
459 There are two tags at all times available to represent network entities and
460 several other tags that are available only in certain contexts.
461 1. ``<link>``: Represents a entity that has a limited bandwidth, a
462 latency, and that can be shared according to TCP way to share this
465 The concept of links in SimGrid may not be intuitive, as links are not
466 limited to connecting (exactly) two entities; in fact, you can have more than
467 two equipments connected to it. (In graph theoretical terms: A link in
468 SimGrid is not an edge, but a hyperedge)
470 2. ``<router/>``: Represents an entity that a message can be routed
471 to, but that is unable to execute any code. In SimGrid, routers have also
472 no impact on the performance: Routers do not limit any bandwidth nor
473 do they increase latency. As a matter of fact, routers are (almost) ignored
474 by the simulator when the simulation has begun.
476 3. ``<backbone/>``: This tag is only available when the containing AS is
477 used as a cluster (i.e., mode="Cluster")
480 If you want to represent an entity like a switch, you must use ``<link>`` (see section). Routers are used
481 to run some routing algorithm and determine routes (see Section \ref pf_routing for details).
483 \subsubsection pf_router <router/>
485 As said before, <b>router</b> is used only to give some information
486 for routing algorithms. So, it does not have any attributes except :
490 Attribute name | Mandatory | Values | Description
491 --------------- | --------- | ------ | -----------
492 id | yes | string | The identifier of the router to be used when referring to it.
493 coordinates | no | 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.
498 <router id="gw_dc1_horizdist"/>
501 \subsubsection pf_link <link/>
503 Network links can represent one-hop network connections. They are
504 characterized by their id and their bandwidth; links can (but may not) be subject
509 Attribute name | Mandatory | Values | Description
510 --------------- | --------- | ------ | -----------
511 id | yes | string | The identifier of the link to be used when referring to it.
512 bandwidth | yes | int | Maximum bandwidth for this link, given in bytes/s
513 latency | no | double (default: 0.0) | Latency for this link.
514 sharing_policy | no | \ref sharing_policy_shared "SHARED"\|\ref pf_sharing_policy_fatpipe "FATPIPE"\|\ref pf_sharing_policy_fullduplex "FULLDUPLEX" (default: SHARED) | Sharing policy for the link.
515 state | no | ON\|OFF (default: ON) | Allows you to to turn this link on or off (working / not working)
516 bandwidth_file | no | string | Allows you to use a file as input for bandwidth.
517 latency_file | no | string | Allows you to use a file as input for latency.
518 state_file | no | string | Allows you to use a file as input for states.
521 #### Possible shortcuts for ``latency`` ####
523 When using the latency attribute, you can specify the latency by using the scientific
524 notation or by using common abbreviations. For instance, the following three tags
528 <link id="LINK1" bandwidth="125000000" latency="5E-6"/>
529 <link id="LINK1" bandwidth="125000000" latency="5us"/>
530 <link id="LINK1" bandwidth="125000000" latency="0.000005"/>
533 Here, the second tag uses "us", meaning "microseconds". Other shortcuts are:
535 Name | Abbreviation | Time (in seconds)
536 ---- | ------------ | -----------------
537 Week | w | 7 * 24 * 60 * 60
538 Day | d | 24 * 60 * 60
542 Millisecond | ms | 0.001 = 10^(-3)
543 Microsecond | us | 0.000001 = 10^(-6)
544 Nanosecond | ns | 0.000000001 = 10^(-9)
545 Picosecond | ps | 0.000000000001 = 10^(-12)
547 #### Sharing policy ####
549 \anchor sharing_policy_shared
550 By default a network link is \b SHARED, i.e., if two or more data flows go
551 through a link, the bandwidth is shared fairly among all data flows. This
552 is similar to the sharing policy TCP uses.
554 \anchor pf_sharing_policy_fatpipe
555 On the other hand, if a link is defined as a \b FATPIPE,
556 each flow going through this link will be provided with the complete bandwidth,
557 i.e., no sharing occurs and the bandwidth is only limiting each flow individually.
558 Please note that this is really on a per-flow basis, not only on a per-host basis!
559 The complete bandwidth provided by this link in this mode
560 is ``number_of_flows*bandwidth``, with at most ``bandwidth`` being available per flow.
562 Using the FATPIPE mode allows to model backbones that won't affect performance
565 \anchor pf_sharing_policy_fullduplex
566 The last mode available is \b FULLDUPLEX. This means that SimGrid will
567 automatically generate two links (one carrying the suffix _UP and the other the
568 suffix _DOWN) for each ``<link>`` tag. This models situations when the direction
569 of traffic is important.
572 Transfers from one side to the other will interact similarly as
573 TCP when ACK returning packets circulate on the other direction. More
574 discussion about it is available in the description of link_ctn description.
576 In other words: The SHARED policy defines a physical limit for the bandwidth.
577 The FATPIPE mode defines a limit for each application,
578 with no upper total limit.
581 Tip: By using the FATPIPE mode, you can model big backbones that
582 won't affect performance (except latency).
587 <link id="SWITCH" bandwidth="125000000" latency="5E-5" sharing_policy="FATPIPE" />
590 #### Expressing dynamism and failures ####
592 Similar to hosts, it is possible to declare links whose state, bandwidth
593 or latency changes over time (see Section \ref pf_host_dynamism for details).
595 In the case of network links, the ``bandwidth`` and ``latency`` attributes are
596 replaced by the ``bandwidth_file`` and ``latency_file`` attributes.
597 The following XML snippet demonstrates how to use this feature in the platform
598 file. The structure of the files "link1.bw" and "link1.lat" is shown below.
601 <link id="LINK1" state_file="link1.fail" bandwidth="80000000" latency=".0001" bandwidth_file="link1.bw" latency_file="link1.lat" />
605 Even if the syntax is the same, the semantic of bandwidth and latency
606 trace files differs from that of host availability files. For bandwidth and
607 latency, the corresponding files do not
608 express availability as a fraction of the available capacity but directly in
609 bytes per seconds for the bandwidth and in seconds for the latency. This is
610 because most tools allowing to capture traces on real platforms (such as NWS)
611 express their results this way.
613 ##### Example of "link1.bw" file #####
621 In this example, the bandwidth changes repeatedly, with all changes
622 being repeated every 12 seconds.
624 At the beginning of the the simulation, the link's bandwidth is 80,000,000
625 B/s (i.e., 80 Mb/s); this value was defined in the XML snippet above.
626 After four seconds, it drops to 40 Mb/s (line 2), and climbs
627 back to 60 Mb/s after another 4 seconds (line 3). The value does not change any
628 more until the end of the period, that is, after 12 seconds have been simulated).
629 At this point, periodicity kicks in and this behavior is repeated: Seconds
630 12-16 will experience 80 Mb/s, 16-20 40 Mb/s etc.).
632 ##### Example of "link1.lat" file #####
641 In this example, the latency varies with a period of 5 seconds.
642 In the xml snippet above, the latency is initialized to be 0.0001s (100µs). This
643 value will be kept during the first second, since the latency_file contains
644 changes to this value at second one, two and three.
645 At second one, the value will be 0.001, i.e., 1ms. One second later it will
646 be adjusted to 0.01 (or 10ms) and one second later it will be set again to 1ms. The
647 value will not change until second 5, when the periodicity defined in line 1
648 kicks in. It then loops back, starting at 100µs (the initial value) for one second.
651 #### The ``<prop/>`` tag ####
653 Similar to the ``<host>`` tag, a link may also contain the ``<prop/>`` tag; see the host
654 documentation (Section \ref pf_host) for an example.
657 \subsubsection pf_backbone <backbone/>
660 This tag is <b>only available</b> when the containing AS uses the "Cluster" routing mode!
662 Using this tag, you can designate an already existing link to be a backbone.
664 Attribute name | Mandatory | Values | Description
665 --------------- | --------- | ------ | -----------
666 id | yes | string | Name of the link that is supposed to act as a backbone.
668 \subsection pf_storage Storage
671 This is a prototype version that should evolve quickly, hence this
672 is just some doc valuable only at the time of writing.
673 This section describes the storage management under SimGrid ; nowadays
674 it's only usable with MSG. It relies basically on linux-like concepts.
675 You also may want to have a look to its corresponding section in
676 @ref msg_file ; access functions are organized as a POSIX-like
679 \subsubsection pf_sto_conc Storage - Main Concepts
681 The storage facilities implemented in SimGrid help to model (and account for)
682 storage devices, such as tapes, hard-drives, CD or DVD devices etc.
683 A typical situation is depicted in the figure below:
685 \image html ./webcruft/storage_sample_scenario.png
686 \image latex ./webcruft/storage_sample_scenario.png "storage_sample_scenario" width=\textwidth
688 In this figure, two hosts called Bob and Alice are interconnected via a network
689 and each host is physically attached to a disk; it is not only possible for each host to
690 mount the disk they are attached to directly, but they can also mount disks
691 that are in a remote location. In this example, Bob mounts Alice's disk remotely
692 and accesses the storage via the network.
694 SimGrid provides 3 different entities that can be used to model setups
695 that include storage facilities:
697 Entity name | Description
698 --------------- | -----------
699 \ref pf_storage_entity_storage_type "storage_type" | Defines a template for a particular kind of storage (such as a hard-drive) and specifies important features of the storage, such as capacity, performance (read/write), contents, ... Different models of hard-drives use different storage_types (because the difference between an SSD and an HDD does matter), as they differ in some specifications (e.g., different sizes or read/write performance).
700 \ref pf_storage_entity_storage "storage" | Defines an actual instance of a storage type (disk, RAM, ...); uses a ``storage_type`` template (see line above) so that you don't need to re-specify the same details over and over again.
701 \ref pf_storage_entity_mount "mount" | Must be wrapped by a \ref pf_host tag; declares which storage(s) this host has mounted and where (i.e., the mountpoint).
704 \anchor pf_storage_content_file
705 ### %Storage Content File ###
707 In order to assess exactly how much time is spent reading from the storage,
708 SimGrid needs to know what is stored on the storage device (identified by distinct (file-)name, like in a file system)
709 and what size this content has.
712 The content file is never changed by the simulation; it is parsed once
713 per simulation and kept in memory afterwards. When the content of the
714 storage changes, only the internal SimGrid data structures change.
716 \anchor pf_storage_content_file_structure
717 #### Structure of a %Storage Content File ####
719 Here is an excerpt from two storage content file; if you want to see the whole file, check
720 the file ``examples/platforms/content/storage_content.txt`` that comes with the
723 SimGrid essentially supports two different formats: UNIX-style filepaths should
724 follow the well known format:
727 /lib/libsimgrid.so.3.6.2 12710497
731 /bin/simgrid_update_xml 5018
732 /bin/graphicator 66986
733 /bin/simgrid-colorizer 2993
738 Windows filepaths, unsurprisingly, use the windows style:
741 \Windows\avastSS.scr 41664
742 \Windows\bfsvc.exe 75264
743 \Windows\bootstat.dat 67584
744 \Windows\CoreSingleLanguage.xml 31497
746 \Windows\dchcfg64.exe 335464
747 \Windows\dcmdev64.exe 93288
751 The different file formats come at a cost; in version 3.12 (and most likely
752 in later versions, too), copying files from windows-style storages to unix-style
753 storages (and vice versa) is not supported.
755 \anchor pf_storage_content_file_create
756 #### Generate a %Storage Content File ####
758 If you want to generate a storage content file based on your own filesystem (or at least a filesystem you have access to),
759 try running this command (works only on unix systems):
762 find . -type f -exec ls -1s --block=1 {} \; 2>/dev/null | awk '{ print $2 " " $1}' > ./content.txt
765 \subsubsection pf_storage_entities The Storage Entities
767 These are the entities that you can use in your platform files to include
768 storage in your model. See also the list of our \ref pf_storage_example_files "example files";
769 these might also help you to get started.
771 \anchor pf_storage_entity_storage_type
772 #### \<storage_type\> ####
774 Attribute name | Mandatory | Values | Description
775 --------------- | --------- | ------ | -----------
776 id | yes | string | Identifier of this storage_type; used when referring to it
777 model | yes | string | For reasons of future backwards compatibility only; specifies the name of the model for the storage that should be used
778 size | yes | string | Specifies the amount of available storage space; you can specify storage like "500GiB" or "500GB" if you want. (TODO add a link to all the available abbreviations)
779 content | yes | string | Path to a \ref pf_storage_content_file "Storage Content File" on your system. This file must exist.
780 content_type | no | ("txt_unix"\|"txt_win") | Determines which kind of filesystem you're using; make sure the filenames (stored in that file, see \ref pf_storage_content_file_structure "Storage Content File Structure"!)
782 This tag must contain some predefined model properties, specified via the <model_prop> tag. Here is a list,
783 see below for an example:
785 Property id | Mandatory | Values | Description
786 --------------- | --------- | ------ | -----------
787 Bwrite | yes | string | Bandwidth for write access; in B/s (but you can also specify e.g. "30MBps")
788 Bread | yes | string | Bandwidth for read access; in B/s (but you can also specify e.g. "30MBps")
789 Bconnexion | yes | string | Throughput (of the storage connector) in B/s.
792 A storage_type can also contain the <b><prop></b> tag. The <prop> tag allows you
793 to associate additional information to this <storage_type> and follows the
794 attribute/value schema; see the example below. You may want to use it to give information to
795 the tool you use for rendering your simulation, for example.
797 Here is a complete example for the ``storage_type`` tag:
799 <storage_type id="single_HDD" model="linear_no_lat" size="4000" content_type="txt_unix">
800 <model_prop id="Bwrite" value="30MBps" />
801 <model_prop id="Bread" value="100MBps" />
802 <model_prop id="Bconnection" value="150MBps" />
803 <prop id="Brand" value="Western Digital" />
807 \anchor pf_storage_entity_storage
808 #### <storage> ####
810 ``storage`` attributes:
812 Attribute name | Mandatory | Values | Description
813 -------------- | --------- | ------ | -----------
814 id | yes | string | Identifier of this ``storage``; used when referring to it
815 typeId | yes | string | Here you need to refer to an already existing \ref pf_storage_entity_storage_type "\<storage_type\>"; the storage entity defined by this tag will then inherit the properties defined there.
816 attach | yes | string | Name of a host (see Section \ref pf_host) to which this storage is <i>physically</i> attached to (e.g., a hard drive in a computer)
817 content | no | string | When specified, overwrites the content attribute of \ref pf_storage_entity_storage_type "\<storage_type\>"
818 content_type | no | string | When specified, overwrites the content_type attribute of \ref pf_storage_entity_storage_type "\<storage_type\>"
820 Here are two examples:
823 <storage id="Disk1" typeId="single_HDD" attach="bob" />
825 <storage id="Disk2" typeId="single_SSD"
826 content="content/win_storage_content.txt"
827 content_type="txt_windows" attach="alice" />
830 The first example is straightforward: A disk is defined and called "Disk1"; it is
831 of type "single_HDD" (shown as an example of \ref pf_storage_entity_storage_type "\<storage_type\>" above) and attached
832 to a host called "bob" (the definition of this host is omitted here).
834 The second storage is called "Disk2", is still of the same type as Disk1 but
835 now specifies a new content file (so the contents will be different from Disk1)
836 and the filesystem uses the windows style; finally, it is attached to a second host,
837 called alice (which is again not defined here).
839 \anchor pf_storage_entity_mount
840 #### <mount> ####
843 | Attribute name | Mandatory | Values | Description |
844 | ---------------- | ----------- | -------- | ------------- |
845 | id | yes | string | Refers to a \ref pf_storage_entity_storage "<storage>" entity that will be mounted on that computer |
846 | name | yes | string | Path/location to/of the logical reference (mount point) of this disk
848 This tag must be enclosed by a \ref pf_host tag. It then specifies where the mountpoint of a given storage device (defined by the ``id`` attribute)
849 is; this location is specified by the ``name`` attribute.
851 Here is a simple example, taken from the file ``examples/platform/storage.xml``:
854 <storage_type id="single_SSD" model="linear_no_lat" size="500GiB">
855 <model_prop id="Bwrite" value="60MBps" />
856 <model_prop id="Bread" value="200MBps" />
857 <model_prop id="Bconnection" value="220MBps" />
860 <storage id="Disk2" typeId="single_SSD"
861 content="content/win_storage_content.txt"
862 content_type="txt_windows" attach="alice" />
863 <storage id="Disk4" typeId="single_SSD"
864 content="content/small_content.txt"
865 content_type="txt_unix" attach="denise"/>
867 <host id="alice" speed="1Gf">
868 <mount storageId="Disk2" name="c:"/>
871 <host id="denise" speed="1Gf">
872 <mount storageId="Disk2" name="c:"/>
873 <mount storageId="Disk4" name="/home"/>
877 This example is quite interesting, as the same device, called "Disk2", is mounted by
878 two hosts at the same time! Note, however, that the host called ``alice`` is actually
879 attached to this storage, as can be seen in the \ref pf_storage_entity_storage "<storage>"
880 tag. This means that ``denise`` must access this storage through the network, but SimGrid automatically takes
881 care of that for you.
883 Furthermore, this example shows that ``denise`` has mounted two storages with different
884 filesystem types (unix and windows). In general, a host can mount as many storage devices as
888 Again, the difference between ``attach`` and ``mount`` is simply that
889 an attached storage is always physically inside (or connected to) that machine;
890 for instance, a USB stick is attached to one and only one machine (where it's plugged-in)
891 but it can only be mounted on others, as mounted storage can also be a remote location.
893 ###### Example files #####
895 \verbinclude example_filelist_xmltag_mount
897 \subsubsection pf_storage_example_files Example files
899 Several examples were already discussed above; if you're interested in full examples,
900 check the the following platforms:
902 1. ``examples/platforms/storage.xml``
903 2. ``examples/platforms/remote_io.xml``
905 If you're looking for some examplary C code, you may find the source code
906 available in the directory ``examples/msg/io/`` useful.
908 \subsubsection pf_storage_examples_modelling Modelling different situations
910 The storage functionality of SimGrid is type-agnostic, that is, the implementation
911 does not presume any type of storage, such as HDDs/SSDs, RAM,
912 CD/DVD devices, USB sticks etc.
914 This allows the user to apply the simulator for a wide variety of scenarios; one
915 common scenario would be the access of remote RAM.
917 #### Modelling the access of remote RAM ####
919 How can this be achieved in SimGrid? Let's assume we have a setup where three hosts
920 (HostA, HostB, HostC) need to access remote RAM:
930 An easy way to model this scenario is to setup and define the RAM via the
931 \ref pf_storage_entity_storage "storage" and \ref pf_storage_entity_storage_type "storage type"
932 entities and attach it to a remote dummy host; then, every host can have their own links
933 to this host (modelling for instance certain scenarios, such as PCIe ...)
938 RAM - Dummy -- Host B
943 Now, if read from this storage, the host that mounts this storage
944 communicates to the dummy host which reads from RAM and
945 sends the information back.
948 \section pf_routing Routing
950 To achieve high performance, the routing tables used within SimGrid are
951 static. This means that routing between two nodes is calculated once
952 and will not change during execution. The SimGrid team chose to use this
953 approach as it is rare to have a real deficiency of a resource;
954 most of the time, a communication fails because the links experience too much
955 congestion and hence, your connection stops before the timeout or
956 because the computer designated to be the destination of that message
959 We also chose to use shortest paths algorithms in order to emulate
960 routing. Doing so is consistent with the reality: [RIP](https://en.wikipedia.org/wiki/Routing_Information_Protocol),
961 [OSPF](https://en.wikipedia.org/wiki/Open_Shortest_Path_First), [BGP](https://en.wikipedia.org/wiki/Border_Gateway_Protocol)
962 are all calculating shortest paths. They do require some time to converge, but
963 eventually, when the routing tables have stabilized, your packets will follow
966 \subsection pf_rm Routing models
968 For each AS, you must define explicitly which routing model will
969 be used. There are 3 different categories for routing models:
971 1. \ref pf_routing_model_shortest_path "Shortest-path" based models: SimGrid calculates shortest
972 paths and manages them. Behaves more or less like most real life
974 2. \ref pf_routing_model_manual "Manually-entered" route models: you have to define all routes
975 manually in the platform description file; this can become
976 tedious very quickly, as it is very verbose.
977 Consistent with some manually managed real life routing.
978 3. \ref pf_routing_model_simple "Simple/fast models": those models offer fast, low memory routing
979 algorithms. You should consider to use this type of model if
980 you can make some assumptions about your AS.
981 Routing in this case is more or less ignored.
983 \subsubsection pf_raf The router affair
985 Using routers becomes mandatory when using shortest-path based
986 models or when using the bindings to the ns-3 packet-level
987 simulator instead of the native analytical network model implemented
990 For graph-based shortest path algorithms, routers are mandatory, because these
991 algorithms require a graph as input and so we need to have source and
992 destination for each edge.
994 Routers are naturally an important concept ns-3 since the
995 way routers run the packet routing algorithms is actually simulated.
996 SimGrid's analytical models however simply aggregate the routing time
997 with the transfer time.
999 So why did we incorporate routers in SimGrid? Rebuilding a graph representation
1000 only from the route information turns out to be a very difficult task, because
1001 of the missing information about how routes intersect. That is why we
1002 introduced routers, which are simply used to express these intersection points.
1003 It is important to understand that routers are only used to provide topological
1006 To express this topological information, a <b>route</b> has to be
1007 defined in order to declare which link is connected to a router.
1010 \subsubsection pf_routing_model_shortest_path Shortest-path based models
1012 The following table shows all the models that compute routes using
1013 shortest-paths algorithms are currently available in SimGrid. More detail on how
1014 to choose the best routing model is given in the Section called \"\ref pf_routing_howto_choose_wisely\".
1016 | Name | Description |
1017 | --------------------------------------------------- | -------------------------------------------------------------------------- |
1018 | \ref pf_routing_model_floyd "Floyd" | Floyd routing data. Pre-calculates all routes once |
1019 | \ref pf_routing_model_dijkstra "Dijkstra" | Dijkstra routing data. Calculates routes only when needed |
1020 | \ref pf_routing_model_dijkstracache "DijkstraCache" | Dijkstra routing data. Handles some cache for already calculated routes. |
1022 All those shortest-path models are instanciated in the same way and are
1023 completely interchangeable. Here are some examples:
1025 \anchor pf_routing_model_floyd
1030 <AS id="AS0" routing="Floyd">
1032 <cluster id="my_cluster_1" prefix="c-" suffix=""
1033 radical="0-1" speed="1000000000" bw="125000000" lat="5E-5"
1034 router_id="router1"/>
1036 <AS id="AS1" routing="None">
1037 <host id="host1" speed="1000000000"/>
1040 <link id="link1" bandwidth="100000" latency="0.01"/>
1042 <ASroute src="my_cluster_1" dst="AS1"
1045 <link_ctn id="link1"/>
1051 ASroute given at the end gives a topological information: link1 is
1052 between router1 and host1.
1054 #### Example platform files ####
1056 This is an automatically generated list of example files that use the Floyd
1057 routing model (the path is given relative to SimGrid's source directory)
1059 \verbinclude example_filelist_routing_floyd
1061 \anchor pf_routing_model_dijkstra
1064 #### Example platform files ####
1066 This is an automatically generated list of example files that use the Dijkstra
1067 routing model (the path is given relative to SimGrid's source directory)
1069 \verbinclude example_filelist_routing_dijkstra
1073 <AS id="AS_2" routing="Dijkstra">
1074 <host id="AS_2_host1" speed="1000000000"/>
1075 <host id="AS_2_host2" speed="1000000000"/>
1076 <host id="AS_2_host3" speed="1000000000"/>
1077 <link id="AS_2_link1" bandwidth="1250000000" latency="5E-4"/>
1078 <link id="AS_2_link2" bandwidth="1250000000" latency="5E-4"/>
1079 <link id="AS_2_link3" bandwidth="1250000000" latency="5E-4"/>
1080 <link id="AS_2_link4" bandwidth="1250000000" latency="5E-4"/>
1081 <router id="central_router"/>
1082 <router id="AS_2_gateway"/>
1083 <!-- routes providing topological information -->
1084 <route src="central_router" dst="AS_2_host1"><link_ctn id="AS_2_link1"/></route>
1085 <route src="central_router" dst="AS_2_host2"><link_ctn id="AS_2_link2"/></route>
1086 <route src="central_router" dst="AS_2_host3"><link_ctn id="AS_2_link3"/></route>
1087 <route src="central_router" dst="AS_2_gateway"><link_ctn id="AS_2_link4"/></route>
1091 \anchor pf_routing_model_dijkstracache
1092 ### DijkstraCache ###
1094 DijkstraCache example:
1096 <AS id="AS_2" routing="DijkstraCache">
1097 <host id="AS_2_host1" speed="1000000000"/>
1099 (platform unchanged compared to upper example)
1102 #### Example platform files ####
1104 This is an automatically generated list of example files that use the DijkstraCache
1105 routing model (the path is given relative to SimGrid's source directory):
1107 Editor's note: At the time of writing, no platform file used this routing model - so
1108 if there are no example files listed here, this is likely to be correct.
1110 \verbinclude example_filelist_routing_dijkstra_cache
1112 \subsubsection pf_routing_model_manual Manually-entered route models
1114 | Name | Description |
1115 | ---------------------------------- | ------------------------------------------------------------------------------ |
1116 | \ref pf_routing_model_full "Full" | You have to enter all necessary routers manually; that is, every single route. This may consume a lot of memory when the XML is parsed and might be tedious to write; i.e., this is only recommended (if at all) for small platforms. |
1118 \anchor pf_routing_model_full
1123 <AS id="AS0" routing="Full">
1124 <host id="host1" speed="1000000000"/>
1125 <host id="host2" speed="1000000000"/>
1126 <link id="link1" bandwidth="125000000" latency="0.000100"/>
1127 <route src="host1" dst="host2"><link_ctn id="link1"/></route>
1131 #### Example platform files ####
1133 This is an automatically generated list of example files that use the Full
1134 routing model (the path is given relative to SimGrid's source directory):
1136 \verbinclude example_filelist_routing_full
1138 \subsubsection pf_routing_model_simple Simple/fast models
1140 | Name | Description |
1141 | ---------------------------------------- | ------------------------------------------------------------------------------ |
1142 | \ref pf_routing_model_cluster "Cluster" | This is specific to the \ref pf_cluster "<cluster/>" tag and should not be used by the user, as several assumptions are made. |
1143 | \ref pf_routing_model_none "None" | No routing at all. Unless you know what you're doing, avoid using this mode in combination with a non-constant network model. |
1144 | \ref pf_routing_model_vivaldi "Vivaldi" | Perfect when you want to use coordinates. Also see the corresponding \ref pf_P2P_tags "P2P section" below. |
1146 \anchor pf_routing_model_cluster
1150 In this mode, the \ref pf_cabinet "<cabinet/>" tag is available.
1152 #### Example platform files ####
1154 This is an automatically generated list of example files that use the Cluster
1155 routing model (the path is given relative to SimGrid's source directory):
1157 \verbinclude example_filelist_routing_cluster
1159 \anchor pf_routing_model_none
1162 This model does exactly what it's name advertises: Nothing. There is no routing
1163 available within this model and if you try to communicate within the AS that
1164 uses this model, SimGrid will fail unless you have explicitly activated the
1165 \ref options_model_select_network_constant "Constant Network Model" (this model charges
1166 the same for every single communication). It should
1167 be noted, however, that you can still attach an \ref pf_routing_tag_asroute "ASroute",
1168 as is demonstrated in the example below:
1170 \verbinclude platforms/cluster_and_one_host.xml
1172 #### Example platform files ####
1174 This is an automatically generated list of example files that use the None
1175 routing model (the path is given relative to SimGrid's source directory):
1177 \verbinclude example_filelist_routing_none
1180 \anchor pf_routing_model_vivaldi
1183 For more information on how to use the [Vivaldi Coordinates](https://en.wikipedia.org/wiki/Vivaldi_coordinates),
1184 see also Section \ref pf_P2P_tags "P2P tags".
1186 For documentation on how to activate this model (as some initialization must be done
1187 in the simulator), see Section \ref options_model_network_coord "Activating Coordinate Based Routing".
1189 Note that it is possible to combine the Vivaldi routing model with other routing models;
1190 an example can be found in the file \c examples/platforms/cloud.xml. This
1191 examples models an AS using Vivaldi that contains other ASes that use different
1194 #### Example platform files ####
1196 This is an automatically generated list of example files that use the None
1197 routing model (the path is given relative to SimGrid's source directory):
1199 \verbinclude example_filelist_routing_vivaldi
1202 \subsection ps_dec Defining routes
1204 There are currently four different ways to define routes:
1206 | Name | Description |
1207 | ------------------------------------------------- | ----------------------------------------------------------------------------------- |
1208 | \ref pf_routing_tag_route "route" | Used to define route between host/router |
1209 | \ref pf_routing_tag_asroute "ASroute" | Used to define route between different AS |
1210 | \ref pf_routing_tag_bypassroute "bypassRoute" | Used to supersede normal routes as calculated by the network model between host/router; e.g., can be used to use a route that is not the shortest path for any of the shortest-path routing models. |
1211 | \ref pf_routing_tag_bypassasroute "bypassASroute" | Used in the same way as bypassRoute, but for AS |
1213 Basically all those tags will contain an (ordered) list of references
1214 to link that compose the route you want to define.
1216 Consider the example below:
1219 <route src="Alice" dst="Bob">
1220 <link_ctn id="link1"/>
1221 <link_ctn id="link2"/>
1222 <link_ctn id="link3"/>
1226 The route here from host Alice to Bob will be first link1, then link2,
1227 and finally link3. What about the reverse route? \ref pf_routing_tag_route "Route" and
1228 \ref pf_routing_tag_asroute "ASroute" have an optional attribute \c symmetrical, that can
1229 be either \c YES or \c NO. \c YES means that the reverse route is the same
1230 route in the inverse order, and is set to \c YES by default. Note that
1231 this is not the case for bypass*Route, as it is more probable that you
1232 want to bypass only one default route.
1234 For an \ref pf_routing_tag_asroute "ASroute", things are just slightly more complicated, as you have
1235 to give the id of the gateway which is inside the AS you want to access ...
1236 So it looks like this:
1239 <ASroute src="AS1" dst="AS2"
1240 gw_src="router1" gw_dst="router2">
1241 <link_ctn id="link1"/>
1245 gw == gateway, so when any message are trying to go from AS1 to AS2,
1246 it means that it must pass through router1 to get out of the AS, then
1247 pass through link1, and get into AS2 by being received by router2.
1248 router1 must belong to AS1 and router2 must belong to AS2.
1250 \subsubsection pf_linkctn <link_ctn/>
1252 This entity has only one purpose: Refer to an already existing
1253 \ref pf_link "<link/>" when defining a route, i.e., it
1254 can only occur as a child of \ref pf_routing_tag_route "<route/>"
1256 | Attribute name | Mandatory | Values | Description |
1257 | --------------- | --------- | ------ | ----------- |
1258 | id | yes | String | The identifier of the link that should be added to the route. |
1259 | direction | maybe | UP\|DOWN | If the link referenced by \c id has been declared as \ref pf_sharing_policy_fullduplex "FULLDUPLEX", this indicates which direction the route traverses through this link: UP or DOWN. If you don't use FULLDUPLEX, do not use this attribute or SimGrid will not find the right link.
1261 #### Example Files ####
1263 This is an automatically generated list of example files that use the \c <link_ctn/>
1264 entity (the path is given relative to SimGrid's source directory):
1266 \verbinclude example_filelist_xmltag_linkctn
1268 \subsubsection pf_routing_tag_asroute ASroute
1270 The purpose of this entity is to define a route between two ASes.
1271 This is mainly useful when you're in the \ref pf_routing_model_full "Full routing model".
1273 #### Attributes ####
1275 | Attribute name | Mandatory | Values | Description |
1276 | --------------- | --------- | ------ | ----------- |
1277 | src | yes | String | The identifier of the source AS |
1278 | dst | yes | String | See the \c src attribute |
1279 | gw_src | yes | String | The gateway that will be used within the src AS; this can be any \ref pf_host "Host" or \ref pf_router "Router" defined within the src AS. |
1280 | gw_dst | yes | String | Same as \c gw_src, but with the dst AS instead. |
1281 | symmetrical | no | YES\|NO (Default: YES) | If this route is symmetric, the opposite route (from dst to src) will also be declared implicitly. |
1286 <AS id="AS0" routing="Full">
1287 <cluster id="my_cluster_1" prefix="c-" suffix=".me"
1288 radical="0-149" speed="1000000000" bw="125000000" lat="5E-5"
1289 bb_bw="2250000000" bb_lat="5E-4"/>
1291 <cluster id="my_cluster_2" prefix="c-" suffix=".me"
1292 radical="150-299" speed="1000000000" bw="125000000" lat="5E-5"
1293 bb_bw="2250000000" bb_lat="5E-4"/>
1295 <link id="backbone" bandwidth="1250000000" latency="5E-4"/>
1297 <ASroute src="my_cluster_1" dst="my_cluster_2"
1298 gw_src="c-my_cluster_1_router.me"
1299 gw_dst="c-my_cluster_2_router.me">
1300 <link_ctn id="backbone"/>
1302 <ASroute src="my_cluster_2" dst="my_cluster_1"
1303 gw_src="c-my_cluster_2_router.me"
1304 gw_dst="c-my_cluster_1_router.me">
1305 <link_ctn id="backbone"/>
1310 \subsubsection pf_routing_tag_route route
1312 The principle is the same as for
1313 \ref pf_routing_tag_asroute "ASroute": The route contains a list of links that
1314 provide a path from \c src to \c dst. Here, \c src and \c dst can both be either a
1315 \ref pf_host "host" or \ref pf_router "router". This is mostly useful for the
1316 \ref pf_routing_model_full "Full routing model" as well as for the
1317 \ref pf_routing_model_shortest_path "shortest-paths" based models (as they require
1318 topological information).
1321 | Attribute name | Mandatory | Values | Description |
1322 | --------------- | --------- | ---------------------- | ----------- |
1323 | src | yes | String | The value given to the source's "id" attribute |
1324 | dst | yes | String | The value given to the destination's "id" attribute. |
1325 | symmetrical | no | YES\| NO (Default: YES) | If this route is symmetric, the opposite route (from dst to src) will also be declared implicitly. |
1330 A route in the \ref pf_routing_model_full "Full routing model" could look like this:
1332 <route src="Tremblay" dst="Bourassa">
1333 <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"/>
1337 A route in the \ref pf_routing_model_shortest_path "Shortest-Path routing model" could look like this:
1339 <route src="Tremblay" dst="Bourassa">
1344 You must only have one link in your routes when you're using them to provide
1345 topological information, as the routes here are simply the edges of the
1346 (network-)graph and the employed algorithms need to know which edge connects
1347 which pair of entities.
1349 \subsubsection pf_routing_tag_bypassasroute bypassASroute
1351 As said before, once you choose
1352 a model, it (most likely; the constant network model, for example, doesn't) calculates routes for you. But maybe you want to
1353 define some of your routes, which will be specific. You may also want
1354 to bypass some routes defined in lower level AS at an upper stage:
1355 <b>bypassASroute</b> is the tag you're looking for. It allows to
1356 bypass routes defined between already defined between AS (if you want
1357 to bypass route for a specific host, you should just use byPassRoute).
1358 The principle is the same as ASroute : <b>bypassASroute</b> contains
1359 list of links that are in the path between src and dst.
1361 #### Attributes ####
1363 | Attribute name | Mandatory | Values | Description |
1364 | --------------- | --------- | ---------------------- | ----------- |
1365 | src | yes | String | The value given to the source AS's "id" attribute |
1366 | dst | yes | String | The value given to the destination AS's "id" attribute. |
1367 | gw_src | yes | String | The value given to the source gateway's "id" attribute; this can be any host or router within the src AS |
1368 | gw_dst | yes | String | The value given to the destination gateway's "id" attribute; this can be any host or router within the dst AS|
1369 | symmetrical | no | YES\| NO (Default: YES) | If this route is symmetric, the opposite route (from dst to src) will also be declared implicitly. |
1374 <bypassASRoute src="my_cluster_1" dst="my_cluster_2"
1375 gw_src="my_cluster_1_router"
1376 gw_dst="my_cluster_2_router">
1377 <link_ctn id="link_tmp"/>
1381 This example shows that link \c link_tmp (definition not displayed here) directly
1382 connects the router \c my_cluster_1_router in the source cluster to the router
1383 \c my_cluster_2_router in the destination router. Additionally, as the \c symmetrical
1384 attribute was not given, this route is presumed to be symmetrical.
1386 \subsubsection pf_routing_tag_bypassroute bypassRoute
1388 As said before, once you choose
1389 a model, it (most likely; the constant network model, for example, doesn't) calculates routes for you. But maybe you want to
1390 define some of your routes, which will be specific. You may also want
1391 to bypass some routes defined in lower level AS at an upper stage :
1392 <b>bypassRoute</b> is the tag you're looking for. It allows to bypass
1393 routes defined between <b>host/router</b>. The principle is the same
1394 as route : <b>bypassRoute</b> contains list of links references of
1395 links that are in the path between src and dst.
1397 #### Attributes ####
1399 | Attribute name | Mandatory | Values | Description |
1400 | --------------- | --------- | ---------------------- | ----------- |
1401 | src | yes | String | The value given to the source AS's "id" attribute |
1402 | dst | yes | String | The value given to the destination AS's "id" attribute. |
1403 | symmetrical | no | YES \| NO (Default: YES) | If this route is symmetric, the opposite route (from dst to src) will also be declared implicitly. |
1408 <bypassRoute src="host_1" dst="host_2">
1409 <link_ctn id="link_tmp"/>
1413 This example shows that link \c link_tmp (definition not displayed here) directly
1414 connects host \c host_1 to host \c host_2. Additionally, as the \c symmetrical
1415 attribute was not given, this route is presumed to be symmetrical.
1417 \subsection pb_baroex Basic Routing Example
1419 Let's say you have an AS named AS_Big that contains two other AS, AS_1
1420 and AS_2. If you want to make a host (h1) from AS_1 with another one
1421 (h2) from AS_2 then you'll have to proceed as follows:
1422 \li First, you have to ensure that a route is defined from h1 to the
1423 AS_1's exit gateway and from h2 to AS_2's exit gateway.
1424 \li Then, you'll have to define a route between AS_1 to AS_2. As those
1425 AS are both resources belonging to AS_Big, then it has to be done
1426 at AS_big level. To define such a route, you have to give the
1427 source AS (AS_1), the destination AS (AS_2), and their respective
1428 gateway (as the route is effectively defined between those two
1429 entry/exit points). Elements of this route can only be elements
1430 belonging to AS_Big, so links and routers in this route should be
1431 defined inside AS_Big. If you choose some shortest-path model,
1432 this route will be computed automatically.
1434 As said before, there are mainly 2 tags for routing :
1435 \li <b>ASroute</b>: to define routes between two <b>AS</b>
1436 \li <b>route</b>: to define routes between two <b>host/router</b>
1438 As we are dealing with routes between AS, it means that those we'll
1439 have some definition at AS_Big level. Let consider AS_1 contains 1
1440 host, 1 link and one router and AS_2 3 hosts, 4 links and one router.
1441 There will be a central router, and a cross-like topology. At the end
1442 of the crosses arms, you'll find the 3 hosts and the router that will
1443 act as a gateway. We have to define routes inside those two AS. Let
1444 say that AS_1 contains full routes, and AS_2 contains some Floyd
1445 routing (as we don't want to bother with defining all routes). As
1446 we're using some shortest path algorithms to route into AS_2, we'll
1447 then have to define some <b>route</b> to gives some topological
1448 information to SimGrid. Here is a file doing it all :
1451 <AS id="AS_Big" routing="Dijkstra">
1452 <AS id="AS_1" routing="Full">
1453 <host id="AS_1_host1" speed="1000000000"/>
1454 <link id="AS_1_link" bandwidth="1250000000" latency="5E-4"/>
1455 <router id="AS_1_gateway"/>
1456 <route src="AS_1_host1" dst="AS_1_gateway">
1457 <link_ctn id="AS_1_link"/>
1460 <AS id="AS_2" routing="Floyd">
1461 <host id="AS_2_host1" speed="1000000000"/>
1462 <host id="AS_2_host2" speed="1000000000"/>
1463 <host id="AS_2_host3" speed="1000000000"/>
1464 <link id="AS_2_link1" bandwidth="1250000000" latency="5E-4"/>
1465 <link id="AS_2_link2" bandwidth="1250000000" latency="5E-4"/>
1466 <link id="AS_2_link3" bandwidth="1250000000" latency="5E-4"/>
1467 <link id="AS_2_link4" bandwidth="1250000000" latency="5E-4"/>
1468 <router id="central_router"/>
1469 <router id="AS_2_gateway"/>
1470 <!-- routes providing topological information -->
1471 <route src="central_router" dst="AS_2_host1"><link_ctn id="AS_2_link1"/></route>
1472 <route src="central_router" dst="AS_2_host2"><link_ctn id="AS_2_link2"/></route>
1473 <route src="central_router" dst="AS_2_host3"><link_ctn id="AS_2_link3"/></route>
1474 <route src="central_router" dst="AS_2_gateway"><link_ctn id="AS_2_link4"/></route>
1476 <link id="backbone" bandwidth="1250000000" latency="5E-4"/>
1478 <ASroute src="AS_1" dst="AS_2"
1479 gw_src="AS_1_gateway"
1480 gw_dst="AS_2_gateway">
1481 <link_ctn id="backbone"/>
1486 \section pf_other_tags Tags not (directly) describing the platform
1488 The following tags can be used inside a \<platform\> tag even if they are not
1489 directly describing the platform:
1490 \li \ref pf_config "config": it allows you to pass some configuration stuff like, for
1491 example, the network model and so on. It follows the
1492 \li \ref pf_include "include": allows you to include another file into the current one.
1494 \subsection pf_config config
1496 The only purpose of this tag is to contain the \c prop tags, as described below.
1497 These tags will then configure the options as described by Section \ref options.
1500 #### Attributes ####
1502 | Attribute name | Mandatory | Values | Description |
1503 | --------------- | --------- | ---------------------- | ----------- |
1504 | id | yes | String | The identifier of the config tag when referring to id; this is basically useless, though. |
1506 #### Possible children ####
1508 Tag name | Description | Documentation
1509 ------------ | ----------- | -------------
1510 \<prop/\> | The prop tag allows you to define different configuration options following the attribute/value schema. See the \ref options page. | N/A
1515 <?xml version='1.0'?>
1516 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1517 <platform version="4">
1518 <config id="General">
1519 <prop id="maxmin/precision" value="0.000010"></prop>
1520 <prop id="cpu/optim" value="TI"></prop>
1521 <prop id="host/model" value="compound"></prop>
1522 <prop id="network/model" value="SMPI"></prop>
1523 <prop id="path" value="~/"></prop>
1524 <prop id="smpi/bw-factor" value="65472:0.940694;15424:0.697866;9376:0.58729"></prop>
1527 <AS id="AS0" routing="Full">
1531 \subsection pf_include include
1533 Even if it can be used in other contexts, this tag was originally created
1534 to be used with \ref pf_trace. The idea was to have a file describing the
1535 platform, and another file attaching traces of a given period to the platform.
1537 The drawback is that the file chuncks that will be included do not
1538 constitute valid XML files. This may explain why this feature was never really
1539 used in practice (as far as we know). Other mechanisms, such as the ability to load
1540 several platform files one after the other, could be considered in the future.
1542 In the meanwhile, the \c include tag allows you to import other platforms into your
1543 local file. This is done with the intention to help people
1544 combine their different AS and provide new platforms. Those files
1545 should contain XML that consists of
1546 \ref pf_include "include", \ref pf_cluster "cluster", \ref pf_peer "peer", \ref pf_As "AS", \ref pf_trace "trace", \ref pf_trace "tags".
1548 Do not forget to close the tag to make it work, or you will end up with an invalid XML file.
1550 #### Attributes ####
1552 | Attribute name | Mandatory | Values | Description |
1553 | --------------- | --------- | ---------------------- | ----------- |
1554 | file | yes | String | Filename of the path you want to include with either relative or absolute path. |
1559 The following example includes two files, clusterA.xml and clusterB.xml and
1560 combines them two one platform file; all hosts, routers etc. defined in
1561 each of them will then be usable.
1564 <?xml version='1.0'?>
1565 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
1566 <platform version="4">
1567 <AS id="main" routing="Full">
1568 <include file="clusterA.xml"></include>
1569 <include file="clusterB.xml"></include>
1574 \subsection pf_trace trace and trace_connect
1576 Both tags are an alternate way to pass files containing information on
1577 availability, state etc. to an entity. (See also, for instance, Section \ref
1578 pf_host_churn "Churn", as described for the host entity.) Instead of referring
1579 to the file directly in the host, link, or cluster tag, you proceed by defining
1580 a trace with an id corresponding to a file, later a host/link/cluster, and
1581 finally using trace_connect you say that the file trace must be used by the
1588 <AS id="AS0" routing="Full">
1589 <host id="bob" speed="1000000000"/>
1591 <trace id="myTrace" file="bob.trace" periodicity="1.0"/>
1592 <trace_connect trace="myTrace" element="bob" kind="POWER"/>
1596 The order here is important. \c trace_connect must come
1597 after the elements \c trace and \c host, as both the host
1598 and the trace definition must be known when \c trace_connect
1599 is parsed; the order of \c trace and \c host is arbitrary.
1602 #### \c trace attributes ####
1605 | Attribute name | Mandatory | Values | Description |
1606 | --------------- | --------- | ---------------------- | ----------- |
1607 | id | yes | String | Identifier of this trace; this is the name you pass on to \c trace_connect. |
1608 | file | no | String | Filename of the file that contains the information - the path must follow the style of your OS. You can omit this, but then you must specifiy the values inside of <trace> and </trace> - see the example below. |
1609 | trace_periodicity | yes | String | This is the same as for \ref pf_host "hosts" (see there for details) |
1611 Here is an example of trace when no file name is provided:
1614 <trace id="myTrace" periodicity="1.0">
1621 #### \c trace_connect attributes ####
1623 | Attribute name | Mandatory | Values | Description |
1624 | --------------- | --------- | ---------------------- | ----------- |
1625 | kind | no | HOST_AVAIL\|POWER\|<br/>LINK_AVAIL\|BANDWIDTH\|LATENCY (Default: HOST_AVAIL) | Describes the kind of trace. |
1626 | trace | yes | String | Identifier of the referenced trace (specified of the trace's \c id attribute) |
1627 | element | yes | String | The identifier of the referenced entity as given by its \c id attribute |
1629 \section pf_hints Hints, tips and frequently requested features
1631 Now you should know at least the syntax and be able to create a
1632 platform by your own. However, after having ourselves wrote some platforms, there
1633 are some best practices you should pay attention to in order to
1634 produce good platform and some choices you can make in order to have
1635 faster simulations. Here's some hints and tips, then.
1637 @subsection Finding the platform example that you need
1639 Most platform files that we ship are in the @c examples/platforms
1640 folder. The good old @c grep tool can find the examples you need when
1641 wondering on a specific XML tag. Here is an example session searching
1642 for @ref pf_trace "trace_connect":
1645 % cd examples/platforms
1646 % grep -R -i -n --include="*.xml" "trace_connect" .
1647 ./two_hosts_platform_with_availability_included.xml:26:<trace_connect kind="SPEED" trace="A" element="Cpu A"/>
1648 ./two_hosts_platform_with_availability_included.xml:27:<trace_connect kind="HOST_AVAIL" trace="A_failure" element="Cpu A"/>
1649 ./two_hosts_platform_with_availability_included.xml:28:<trace_connect kind="SPEED" trace="B" element="Cpu B"/>
1650 ./two_hosts.xml:17: <trace_connect trace="Tremblay_power" element="Tremblay" kind="SPEED"/>
1653 \subsection pf_as_h AS Hierarchy
1654 The AS design allows SimGrid to go fast, because computing route is
1655 done only for the set of resources defined in this AS. If you're using
1656 only a big AS containing all resource with no AS into it and you're
1657 using Full model, then ... you'll loose all interest into it. On the
1658 other hand, designing a binary tree of AS with, at the lower level,
1659 only one host, then you'll also loose all the good AS hierarchy can
1660 give you. Remind you should always be "reasonable" in your platform
1661 definition when choosing the hierarchy. A good choice if you try to
1662 describe a real life platform is to follow the AS described in
1663 reality, since this kind of trade-off works well for real life
1666 \subsection pf_exit_as Exit AS: why and how
1667 Users that have looked at some of our platforms may have notice a
1668 non-intuitive schema ... Something like that :
1672 <AS id="AS_4" routing="Full">
1673 <AS id="exitAS_4" routing="Full">
1674 <router id="router_4"/>
1676 <cluster id="cl_4_1" prefix="c_4_1-" suffix="" radical="1-20" speed="1000000000" bw="125000000" lat="5E-5" bb_bw="2250000000" bb_lat="5E-4"/>
1677 <cluster id="cl_4_2" prefix="c_4_2-" suffix="" radical="1-20" speed="1000000000" bw="125000000" lat="5E-5" bb_bw="2250000000" bb_lat="5E-4"/>
1678 <link id="4_1" bandwidth="2250000000" latency="5E-5"/>
1679 <link id="4_2" bandwidth="2250000000" latency="5E-5"/>
1680 <link id="bb_4" bandwidth="2250000000" latency="5E-4"/>
1681 <ASroute src="cl_4_1"
1683 gw_src="c_4_1-cl_4_1_router"
1684 gw_dst="c_4_2-cl_4_2_router">
1685 <link_ctn id="4_1"/>
1686 <link_ctn id="bb_4"/>
1687 <link_ctn id="4_2"/>
1689 <ASroute src="cl_4_1"
1691 gw_src="c_4_1-cl_4_1_router"
1693 <link_ctn id="4_1"/>
1694 <link_ctn id="bb_4"/>
1696 <ASroute src="cl_4_2"
1698 gw_src="c_4_2-cl_4_2_router"
1700 <link_ctn id="4_2"/>
1701 <link_ctn id="bb_4"/>
1706 In the AS_4, you have an exitAS_4 defined, containing only one router,
1707 and routes defined to that AS from all other AS (as cluster is only a
1708 shortcut for an AS, see cluster description for details). If there was
1709 an upper AS, it would define routes to and from AS_4 with the gateway
1710 router_4. It's just because, as we did not allowed (for performances
1711 issues) to have routes from an AS to a single host/router, you have to
1712 enclose your gateway, when you have AS included in your AS, within an
1713 AS to define routes to it.
1715 \subsection pf_P2P_tags P2P or how to use coordinates
1716 SimGrid allows you to use some coordinated-based system, like vivaldi,
1717 to describe a platform. The main concept is that you have some peers
1718 that are located somewhere: this is the function of the
1719 <b>coordinates</b> of the \<peer\> or \<host\> tag. There's nothing
1720 complicated in using it, here is an example:
1723 <?xml version='1.0'?>
1724 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1725 <platform version="4">
1727 <AS id="AS0" routing="Vivaldi">
1728 <host id="100030591" coordinates="25.5 9.4 1.4" speed="1.5Gf" />
1729 <host id="100036570" coordinates="-12.7 -9.9 2.1" speed="7.3Gf" />
1731 <host id="100429957" coordinates="17.5 6.7 18.8" speed="8.3Gf" />
1736 Coordinates are then used to calculate latency (in microseconds)
1737 between two hosts by calculating the distance between the two hosts
1738 coordinates with the following formula: distance( (x1, y1, z1), (x2,
1739 y2, z2) ) = euclidian( (x1,y1), (x2,y2) ) + abs(z1) + abs(z2)
1741 In other words, we take the euclidian distance on the two first
1742 dimensions, and then add the absolute values found on the third
1743 dimension. This may seem strange, but it was found to allow better
1744 approximations of the latency matrices (see the paper describing
1747 Note that the previous example defines a routing directly between hosts but it could be also used to define a routing between AS.
1748 That is for example what is commonly done when using peers (see Section \ref pf_peer).
1750 <?xml version='1.0'?>
1751 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
1752 <platform version="4">
1754 <AS id="AS0" routing="Vivaldi">
1755 <peer id="peer-0" coordinates="173.0 96.8 0.1" speed="730Mf" bw_in="13.38MBps" bw_out="1.024MBps" lat="500us"/>
1756 <peer id="peer-1" coordinates="247.0 57.3 0.6" speed="730Mf" bw_in="13.38MBps" bw_out="1.024MBps" lat="500us" />
1757 <peer id="peer-2" coordinates="243.4 58.8 1.4" speed="730Mf" bw_in="13.38MBps" bw_out="1.024MBps" lat="500us" />
1761 In such a case though, we connect the AS created by the <b>peer</b> tag with the Vivaldi routing mechanism.
1762 This means that to route between AS1 and AS2, it will use the coordinates of router_AS1 and router_AS2.
1763 This is currently a convention and we may offer to change this convention in the DTD later if needed.
1764 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.
1767 \subsection pf_routing_howto_choose_wisely Choosing wisely the routing model to use
1770 Choosing wisely the routing model to use can significantly fasten your
1771 simulation/save your time when writing the platform/save tremendous
1772 disk space. Here is the list of available model and their
1773 characteristics (lookup : time to resolve a route):
1775 \li <b>Full</b>: Full routing data (fast, large memory requirements,
1777 \li <b>Floyd</b>: Floyd routing data (slow initialization, fast
1778 lookup, lesser memory requirements, shortest path routing only).
1779 Calculates all routes at once at the beginning.
1780 \li <b>Dijkstra</b>: Dijkstra routing data (fast initialization, slow
1781 lookup, small memory requirements, shortest path routing only).
1782 Calculates a route when necessary.
1783 \li <b>DijkstraCache</b>: Dijkstra routing data (fast initialization,
1784 fast lookup, small memory requirements, shortest path routing
1785 only). Same as Dijkstra, except it handles a cache for latest used
1787 \li <b>None</b>: No routing (usable with Constant network only).
1788 Defines that there is no routes, so if you try to determine a
1789 route without constant network within this AS, SimGrid will raise
1791 \li <b>Vivaldi</b>: Vivaldi routing, so when you want to use coordinates
1792 \li <b>Cluster</b>: Cluster routing, specific to cluster tag, should
1795 \subsection pf_switch I want to describe a switch but there is no switch tag!
1797 Actually we did not include switch tag. But when you're trying to
1798 simulate a switch, assuming
1799 fluid bandwidth models are used (which SimGrid uses by default unless
1800 ns-3 or constant network models are activated), the limiting factor is
1801 switch backplane bandwidth. So, essentially, at least from
1802 the simulation perspective, a switch is similar to a
1803 link: some device that is traversed by flows and with some latency and
1804 so,e maximum bandwidth. Thus, you can simply simulate a switch as a
1806 can be connected to this "switch", which is then included in routes just
1810 \subsection pf_multicabinets I want to describe multi-cabinets clusters!
1812 You have several possibilities, as usual when modeling things. If your
1813 cabinets are homogeneous and the intercabinet network negligible for
1814 your study, you should just create a larger cluster with all hosts at
1817 In the rare case where your hosts are not homogeneous between the
1818 cabinets, you can create your cluster completely manually. For that,
1819 create an As using the Cluster routing, and then use one
1820 <cabinet> for each cabinet. This cabinet tag can only be used an
1821 As using the Cluster routing schema, and creating
1823 Be warned that creating a cluster manually from the XML with
1824 <cabinet>, <backbone> and friends is rather tedious. The
1825 easiest way to retrieve some control of your model without diving into
1826 the <cluster> internals is certainly to create one separate
1827 <cluster> per cabinet and interconnect them together. This is
1828 what we did in the G5K example platform for the Graphen cluster.
1830 \subsection pf_platform_multipath I want to express multipath routing in platform files!
1832 It is unfortunately impossible to express the fact that there is more
1833 than one routing path between two given hosts. Let's consider the
1834 following platform file:
1837 <route src="A" dst="B">
1840 <route src="B" dst="C">
1843 <route src="A" dst="C">
1848 Although it is perfectly valid, it does not mean that data traveling
1849 from A to C can either go directly (using link 3) or through B (using
1850 links 1 and 2). It simply means that the routing on the graph is not
1851 trivial, and that data do not following the shortest path in number of
1852 hops on this graph. Another way to say it is that there is no implicit
1853 in these routing descriptions. The system will only use the routes you
1854 declare (such as <route src="A" dst="C"><link_ctn
1855 id="3"/></route>), without trying to build new routes by aggregating
1858 You are also free to declare platform where the routing is not
1859 symmetrical. For example, add the following to the previous file:
1862 <route src="C" dst="A">
1868 This makes sure that data from C to A go through B where data from A
1869 to C go directly. Don't worry about realism of such settings since
1870 we've seen ways more weird situation in real settings (in fact, that's
1871 the realism of very regular platforms which is questionable, but
1872 that's another story).
