-/*! \page platform Platform Description
+/*! \page platform Step 1: %Model the underlying platform
@tableofcontents
Here is an illustration of these concepts:
-
+
Circles represent processing units and squares represent network routers. Bold
lines represent communication links. AS2 models the core of a national
network interconnecting a small flat cluster (AS4) and a larger
Attribute name | Mandatory | Values | Description
--------------- | --------- | ------ | -----------
id | yes | String | The identifier of an AS; facilitates referring to this AS. ID must be unique.
-routing | yes | Full\| Floyd\| Dijkstra\| DijkstraCache\| none\| Vivaldi\| Cluster | See Section \ref pf_rm for details.
+routing | yes | Full\| Floyd\| Dijkstra\| DijkstraCache\| None\| Vivaldi\| Cluster | See Section \ref pf_rm for details.
<b>Example:</b>
If you want this host to be unavailable, simply substitute ON with OFF.
+\anchor pf_host_churn
### Expressing churn ###
To express the fact that a host can change state over time (as in P2P
bb_sharing_policy | no | string | Sharing policy for the backbone (if any). See <b>link</b> section for syntax/details.
availability_file | no | string | Allows you to use a file as input for availability. Similar to <b>hosts</b> attribute.
state_file | no | string | Allows you to use a file as input for states. Similar to <b>hosts</b> attribute.
-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".
+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".
loopback_lat | no | int | Latency for loopback (if any). See <b>link</b> section for syntax/details. See loopback_bw for more info.
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.
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".
\note
Please note that as of now, it is impossible to change attributes such as,
amount of cores (always set to 1), the initial state of hosts/links
- (always set to ON), the sharing policy of the links (always set to \ref sharing_policy_fullduplex "FULLDUPLEX").
+ (always set to ON), the sharing policy of the links (always set to \ref pf_sharing_policy_fullduplex "FULLDUPLEX").
#### Example ####
latency, and that can be shared according to TCP way to share this
bandwidth.
\remark
- The concept of links in SimGrid may not be intuitive, as links are not limited
- to connecting (exactly) two entities; in fact, you can have more than two equipments
- connected to it. (In graph theoretical terms: A link in SimGrid is not an edge,
- but a hyperedge)
+ The concept of links in SimGrid may not be intuitive, as links are not
+ limited to connecting (exactly) two entities; in fact, you can have more than
+ two equipments connected to it. (In graph theoretical terms: A link in
+ SimGrid is not an edge, but a hyperedge)
2. ``<router/>``: Represents an entity that a message can be routed
to, but that is unable to execute any code. In SimGrid, routers have also
id | yes | string | The identifier of the link to be used when referring to it.
bandwidth | yes | int | Maximum bandwidth for this link, given in bytes/s
latency | no | double (default: 0.0) | Latency for this link.
-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.
+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.
state | no | ON\|OFF (default: ON) | Allows you to to turn this link on or off (working / not working)
bandwidth_file | no | string | Allows you to use a file as input for bandwidth.
latency_file | no | string | Allows you to use a file as input for latency.
through a link, the bandwidth is shared fairly among all data flows. This
is similar to the sharing policy TCP uses.
-\anchor sharing_policy_fatpipe
+\anchor pf_sharing_policy_fatpipe
On the other hand, if a link is defined as a \b FATPIPE,
each flow going through this link will be provided with the complete bandwidth,
i.e., no sharing occurs and the bandwidth is only limiting each flow individually.
Using the FATPIPE mode allows to model backbones that won't affect performance
(except latency).
-\anchor sharing_policy_fullduplex
+\anchor pf_sharing_policy_fullduplex
The last mode available is \b FULLDUPLEX. This means that SimGrid will
automatically generate two links (one carrying the suffix _UP and the other the
suffix _DOWN) for each ``<link>`` tag. This models situations when the direction
#### The ``<prop/>`` tag ####
-Similar to
``\<host\>``, the link may also contain the ``<prop/>`` tag; see the host
+Similar to
the ``<host>`` tag, a link may also contain the ``<prop/>`` tag; see the host
documentation (Section \ref pf_host) for an example.
-TODO
-
\subsubsection pf_backbone <backbone/>
\note
- This tag is <b>only available</b> when the containing AS uses the "Cluster" mode!
+ This tag is <b>only available</b> when the containing AS uses the "Cluster" routing mode!
Using this tag, you can designate an already existing link to be a backbone.
\subsection pf_storage Storage
\note
- This is a prototype version that should evolve quickly, this
- is just some doc valuable only at the time of writing this doc
+ This is a prototype version that should evolve quickly, hence this
+ is just some doc valuable only at the time of writing.
This section describes the storage management under SimGrid ; nowadays
it's only usable with MSG. It relies basically on linux-like concepts.
You also may want to have a look to its corresponding section in \ref
- msg_file_management ; functions access are organized as a POSIX-like
+ msg_file_management ; access functions are organized as a POSIX-like
interface.
-\subsubsection pf_sto_conc Storage Main concepts
-Basically there are 3 different entities available in SimGrid that
-can be used to model storages:
+\subsubsection pf_sto_conc Storage - Main Concepts
+
+The storage facilities implemented in SimGrid help to model (and account for)
+storage devices, such as tapes, hard-drives, CD or DVD devices etc.
+A typical situation is depicted in the figure below:
+
+\image html ./webcruft/storage_sample_scenario.png
+\image latex ./webcruft/storage_sample_scenario.png "storage_sample_scenario" width=\textwidth
+
+In this figure, two hosts called Bob and Alice are interconnected via a network
+and each host is physically attached to a disk; it is not only possible for each host to
+mount the disk they are attached to directly, but they can also mount disks
+that are in a remote location. In this example, Bob mounts Alice's disk remotely
+and accesses the storage via the network.
+
+SimGrid provides 3 different entities that can be used to model setups
+that include storage facilities:
Entity name | Description
--------------- | -----------
-\ref pf_storage_entity_storage_type "storage_type" | Defines a template for a particular kind of storage (such as a hard-drive) and specifies important features of the storage, such as capacity, performance (read/write), content, ... Different models of hard-drives use different storage_types (because the difference between an SSD and an HDD does matter), as they differ in some specifications (e.g., different size or read/write performance).
-\ref pf_storage_entity_storage "storage" | Defines an actual instance of a storage (disk, RAM, ...); uses a ``storage_type`` template (see line above) so that you don't need to re-specify the same details over and over again.
+\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).
+\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.
\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).
### %Storage Content File ###
In order to assess exactly how much time is spent reading from the storage,
-SimGrid needs to know what is stored in the storage device (identified by distinct (file-)name, like in a file system)
+SimGrid needs to know what is stored on the storage device (identified by distinct (file-)name, like in a file system)
and what size this content has.
\note
storage changes, only the internal SimGrid data structures change.
\anchor pf_storage_content_file_structure
-#### Structure of a %Storage File ####
+#### Structure of a %Storage Content File ####
-Here is an excerpt from two storage file; if you want to see the whole file, check
+Here is an excerpt from two storage content file; if you want to see the whole file, check
the file ``examples/platforms/content/storage_content.txt`` that comes with the
SimGrid source code.
try running this command (works only on unix systems):
\verbatim
-find /path/you/want -type f -exec ls -l {} \; 2>/dev/null > ./content.txt
+find . -type f -exec ls -1s --block=1 {} \; 2>/dev/null | awk '{ print $2 " " $1}' > ./content.txt
\endverbatim
\subsubsection pf_storage_entities The Storage Entities
-------------- | --------- | ------ | -----------
id | yes | string | Identifier of this ``storage``; used when referring to it
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.
-attach | yes | string | Name of a host (see Section \ref pf_host) that this storage is <i>physically</i> attached to (e.g., a harddrive in a computer)
+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)
content | no | string | When specified, overwrites the content attribute of \ref pf_storage_entity_storage_type "\<storage_type\>"
content_type | no | string | When specified, overwrites the content_type attribute of \ref pf_storage_entity_storage_type "\<storage_type\>"
to a host called "bob" (the definition of this host is omitted here).
The second storage is called "Disk2", is still of the same type as Disk1 but
-now specifies a new content file (so the content will be different from Disk1)
+now specifies a new content file (so the contents will be different from Disk1)
and the filesystem uses the windows style; finally, it is attached to a second host,
called alice (which is again not defined here).
This example is quite interesting, as the same device, called "Disk2", is mounted by
two hosts at the same time! Note, however, that the host called ``alice`` is actually
attached to this storage, as can be seen in the \ref pf_storage_entity_storage "<storage>"
-tag. This means that ``denise`` must access this storage via network, but SimGrid automatically takes
+tag. This means that ``denise`` must access this storage through the network, but SimGrid automatically takes
care of that for you.
Furthermore, this example shows that ``denise`` has mounted two storages with different
for instance, a USB stick is attached to one and only one machine (where it's plugged-in)
but it can only be mounted on others, as mounted storage can also be a remote location.
+###### Example files #####
+
+\verbinclude example_filelist_xmltag_mount
+
\anchor pf_storage_entity_mstorage
#### <mstorage> ####
\note
\subsubsection pf_storage_examples_modelling Modelling different situations
The storage functionality of SimGrid is type-agnostic, that is, the implementation
-does not presume any type of storagei, such as HDDs/SSDs, RAM,
+does not presume any type of storage, such as HDDs/SSDs, RAM,
CD/DVD devices, USB sticks etc.
This allows the user to apply the simulator for a wide variety of scenarios; one
is not responding.
We also chose to use shortest paths algorithms in order to emulate
-routing. Doing so is consistent with the reality: RIP, OSPF, BGP are
-all calculating shortest paths. They have some convergence time, but
-at the end, so when the platform is stable (and this should be the
-moment you want to simulate something using SimGrid) your packets will
-follow the shortest paths.
+routing. Doing so is consistent with the reality: [RIP](https://en.wikipedia.org/wiki/Routing_Information_Protocol),
+[OSPF](https://en.wikipedia.org/wiki/Open_Shortest_Path_First), [BGP](https://en.wikipedia.org/wiki/Border_Gateway_Protocol)
+are all calculating shortest paths. They do require some time to converge, but
+eventually, when the routing tables have stabilized, your packets will follow
+the shortest paths.
\subsection pf_rm Routing models
-Within each AS, you have to define a routing model to use. You have
-basically 3 main kind of routing models :
-
-\li Shortest-path based models: you let SimGrid calculates shortest
- paths and manage it. Behaves more or less as most real life
- routing.
-\li Manually-entered route models: you'll have to define all routes
- manually by yourself into the platform description file.
- Consistent with some manually managed real life routing.
-\li Simple/fast models: those models offers fast, low memory routing
- algorithms. You should consider to use it if you can make some
- assumptions about your AS. Routing in this case is more or less
- ignored
+For each AS, you must define explicitly which routing model will
+be used. There are 3 different categories for routing models:
+
+1. \ref pf_routing_model_shortest_path "Shortest-path" based models: SimGrid calculates shortest
+ paths and manages them. Behaves more or less like most real life
+ routing mechanisms.
+2. \ref pf_routing_model_manual "Manually-entered" route models: you have to define all routes
+ manually in the platform description file; this can become
+ tedious very quickly, as it is very verbose.
+ Consistent with some manually managed real life routing.
+3. \ref pf_routing_model_simple "Simple/fast models": those models offer fast, low memory routing
+ algorithms. You should consider to use this type of model if
+ you can make some assumptions about your AS.
+ Routing in this case is more or less ignored.
\subsubsection pf_raf The router affair
-Expressing routers becomes mandatory when using shortest-path based
+Using routers becomes mandatory when using shortest-path based
models or when using the bindings to the ns-3 packet-level
simulator instead of the native analytical network model implemented
in SimGrid.
-For graph-based shortest path algorithms, routers are mandatory,
-because both algorithms need a graph, and so we need to have source
-and destination for each edge.
-
-Routers are naturally an important concept in ns-3 since the
-way they run the packet routing algorithms is actually simulated.
-Instead, the SimGrid’s analytical models aggregate the routing time
-with the transfer time. Rebuilding a graph representation only from
-the route information turns to be a very difficult task, because of
-the missing information about how routes intersect. That is why we
-introduced a \<router\> tag, which is simply used to express these
-intersection points. The only attribute accepted by this tag an id. It
-is important to understand that the \<router\> tag is only used to
-provide topological information.
-
-To express those topological information, some <b>route</b> have to be
-defined saying which link is between which routers. Description or the
-route syntax is given below, as well as example for the different
-models.
-
-\subsubsection pf_rm_sh Shortest-path based models
-
-Here is the complete list of such models, that computes routes using
-classic shortest-paths algorithms. How to choose the best suited
-algorithm is discussed later in the section devoted to it.
-
-\li <b>Floyd</b>: Floyd routing data. Pre-calculates all routes once.
-\li <b>Dijkstra</b>: Dijkstra routing data ,calculating routes when
- necessary.
-\li <b>DijkstraCache</b>: Dijkstra routing data. Handle some cache for
- already calculated routes.
-
-All those shortest-path models are instanciated the same way. Here are
-some example of it:
-
-Floyd example :
+For graph-based shortest path algorithms, routers are mandatory, because these
+algorithms require a graph as input and so we need to have source and
+destination for each edge.
+
+Routers are naturally an important concept ns-3 since the
+way routers run the packet routing algorithms is actually simulated.
+SimGrid's analytical models however simply aggregate the routing time
+with the transfer time.
+
+So why did we incorporate routers in SimGrid? Rebuilding a graph representation
+only from the route information turns out to be a very difficult task, because
+of the missing information about how routes intersect. That is why we
+introduced routers, which are simply used to express these intersection points.
+It is important to understand that routers are only used to provide topological
+information.
+
+To express this topological information, a <b>route</b> has to be
+defined in order to declare which link is connected to a router.
+
+
+\subsubsection pf_routing_model_shortest_path Shortest-path based models
+
+The following table shows all the models that compute routes using
+shortest-paths algorithms are currently available in SimGrid. More detail on how
+to choose the best routing model is given in the Section called \"\ref pf_routing_howto_choose_wisely\".
+
+| Name | Description |
+| --------------------------------------------------- | -------------------------------------------------------------------------- |
+| \ref pf_routing_model_floyd "Floyd" | Floyd routing data. Pre-calculates all routes once |
+| \ref pf_routing_model_dijkstra "Dijkstra" | Dijkstra routing data. Calculates routes only when needed |
+| \ref pf_routing_model_dijkstracache "DijkstraCache" | Dijkstra routing data. Handles some cache for already calculated routes. |
+
+All those shortest-path models are instanciated in the same way and are
+completely interchangeable. Here are some examples:
+
+\anchor pf_routing_model_floyd
+### Floyd ###
+
+Floyd example:
\verbatim
<AS id="AS0" routing="Floyd">
<cluster id="my_cluster_1" prefix="c-" suffix=""
- radical="0-1" power="1000000000" bw="125000000" lat="5E-5"
- router_id="router1"/>
+ radical="0-1" power="1000000000" bw="125000000" lat="5E-5"
+ router_id="router1"/>
- <AS id="AS1" routing="none">
+ <AS id="AS1" routing="None">
<host id="host1" power="1000000000"/>
- </AS>
+ </AS>
<link id="link1" bandwidth="100000" latency="0.01"/>
ASroute given at the end gives a topological information: link1 is
between router1 and host1.
+#### Example platform files ####
+
+This is an automatically generated list of example files that use the Floyd
+routing model (the path is given relative to SimGrid's source directory)
+
+\verbinclude example_filelist_routing_floyd
+
+\anchor pf_routing_model_dijkstra
+### Dijkstra ###
+
+#### Example platform files ####
+
+This is an automatically generated list of example files that use the Dijkstra
+routing model (the path is given relative to SimGrid's source directory)
+
+\verbinclude example_filelist_routing_dijkstra
+
Dijsktra example :
\verbatim
<AS id="AS_2" routing="Dijsktra">
</AS>
\endverbatim
-DijsktraCache example :
+\anchor pf_routing_model_dijkstracache
+### DijkstraCache ###
+
+DijsktraCache example:
\verbatim
<AS id="AS_2" routing="DijsktraCache">
<host id="AS_2_host1" power="1000000000"/>
(platform unchanged compared to upper example)
\endverbatim
-\subsubsection pf_rm_me Manually-entered route models
+#### Example platform files ####
-\li <b>Full</b>: You have to enter all necessary routes manually
+This is an automatically generated list of example files that use the DijkstraCache
+routing model (the path is given relative to SimGrid's source directory):
+
+Editor's note: At the time of writing, no platform file used this routing model - so
+if there are no example files listed here, this is likely to be correct.
+
+\verbinclude example_filelist_routing_dijkstra_cache
+
+\subsubsection pf_routing_model_manual Manually-entered route models
+
+| Name | Description |
+| ---------------------------------- | ------------------------------------------------------------------------------ |
+| \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. |
+
+\anchor pf_routing_model_full
+### Full ###
Full example :
\verbatim
</AS>
\endverbatim
-\subsubsection pf_rm_sf Simple/fast models
+#### Example platform files ####
-\li <b>none</b>: No routing (Unless you know what you are doing, avoid
-using this mode in combination with a non Constant network model).
-None Example :
-\verbatim
-<AS id="exitAS" routing="none">
- <router id="exit_gateway"/>
-</AS>\endverbatim
+This is an automatically generated list of example files that use the Full
+routing model (the path is given relative to SimGrid's source directory):
+
+\verbinclude example_filelist_routing_full
+
+\subsubsection pf_routing_model_simple Simple/fast models
+
+| Name | Description |
+| ---------------------------------------- | ------------------------------------------------------------------------------ |
+| \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. |
+| \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. |
+| \ref pf_routing_model_vivaldi "Vivaldi" | Perfect when you want to use coordinates. Also see the corresponding \ref pf_P2P_tags "P2P section" below. |
+
+\anchor pf_routing_model_cluster
+### Cluster ###
+
+\note
+ In this mode, the \ref pf_cabinet "<cabinet/>" tag is available.
+
+#### Example platform files ####
+
+This is an automatically generated list of example files that use the Cluster
+routing model (the path is given relative to SimGrid's source directory):
+
+\verbinclude example_filelist_routing_cluster
+
+\anchor pf_routing_model_none
+### None ###
+
+This model does exactly what it's name advertises: Nothing. There is no routing
+available within this model and if you try to communicate within the AS that
+uses this model, SimGrid will fail unless you have explicitly activated the
+\ref options_model_select_network_constant "Constant Network Model" (this model charges
+the same for every single communication). It should
+be noted, however, that you can still attach an \ref pf_routing_tag_asroute "ASroute",
+as is demonstrated in the example below:
+
+\verbinclude platforms/cluster_and_one_host.xml
+
+#### Example platform files ####
+
+This is an automatically generated list of example files that use the None
+routing model (the path is given relative to SimGrid's source directory):
+
+\verbinclude example_filelist_routing_none
+
+
+\anchor pf_routing_model_vivaldi
+### Vivaldi ###
+
+For more information on how to use the [Vivaldi Coordinates](https://en.wikipedia.org/wiki/Vivaldi_coordinates),
+see also Section \ref pf_P2P_tags "P2P tags".
+
+For documentation on how to activate this model (as some initialization must be done
+in the simulator), see Section \ref options_model_network_coord "Activating Coordinate Based Routing".
+
+Note that it is possible to combine the Vivaldi routing model with other routing models;
+an example can be found in the file \c examples/platforms/cloud.xml. This
+examples models an AS using Vivaldi that contains other ASes that use different
+routing models.
+
+#### Example platform files ####
+
+This is an automatically generated list of example files that use the None
+routing model (the path is given relative to SimGrid's source directory):
+
+\verbinclude example_filelist_routing_vivaldi
-\li <b>Vivaldi</b>: Vivaldi routing, so when you want to use
- coordinates. See the corresponding section P2P below for details.
-\li <b>Cluster</b>: Cluster routing, specific to cluster tag, should
- not be used, except internally.
\subsection ps_dec Defining routes
-The principle of route definition is the same for the 4 available tags
-for doing it. Those for tags are:
+There are currently four different ways to define routes:
-\li <b>route</b>: to define route between host/router
-\li <b>ASroute</b>: to define route between AS
-\li <b>bypassRoute</b>: to bypass normal routes as calculated by the
- network model between host/router
-\li <b>bypassASroute</b>: same as bypassRoute, but for AS
+| Name | Description |
+| ------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| \ref pf_routing_tag_route "route" | Used to define route between host/router |
+| \ref pf_routing_tag_asroute "ASroute" | Used to define route between different AS |
+| \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. |
+| \ref pf_routing_tag_bypassasroute "bypassASroute" | Used in the same way as bypassRoute, but for AS |
Basically all those tags will contain an (ordered) list of references
to link that compose the route you want to define.
<link_ctn id="link1"/>
<link_ctn id="link2"/>
<link_ctn id="link3"/>
- </route>
+</route>
\endverbatim
The route here from host Alice to Bob will be first link1, then link2,
-and finally link3. What about the reverse route ? <b>route</b> and
-<b>ASroute</b> have an optional attribute <b>symmetrical</b>, that can
-be either YES or NO. YES means that the reverse route is the same
-route in the inverse order, and is set to YES by default. Note that
+and finally link3. What about the reverse route? \ref pf_routing_tag_route "Route" and
+\ref pf_routing_tag_asroute "ASroute" have an optional attribute \c symmetrical, that can
+be either \c YES or \c NO. \c YES means that the reverse route is the same
+route in the inverse order, and is set to \c YES by default. Note that
this is not the case for bypass*Route, as it is more probable that you
want to bypass only one default route.
-For an ASroute, things are just slightly more complicated, as you have
-to give the id of the gateway which is inside the AS you're talking
-about you want to access ... So it looks like this :
-
+For an \ref pf_routing_tag_asroute "ASroute", things are just slightly more complicated, as you have
+to give the id of the gateway which is inside the AS you want to access ...
+So it looks like this:
\verbatim
-
<ASroute src="AS1" dst="AS2"
- gw_src="router1" gw_dst="router2">
- <link_ctn id="link1"/>
- </ASroute>
+<ASroute src="AS1" dst="AS2"
+ gw_src="router1" gw_dst="router2">
+ <link_ctn id="link1"/>
+</ASroute>
\endverbatim
gw == gateway, so when any message are trying to go from AS1 to AS2,
pass through link1, and get into AS2 by being received by router2.
router1 must belong to AS1 and router2 must belong to AS2.
-\subsubsection pf_linkctn link_ctn
-
-a <b>link_ctn</b> is the tag that is used in order to reference a
-<b>link</b> in a route. Its id is the link id it refers to.
-
-<b>link_ctn</b> attributes :
-\li <b>id (mandatory)</b>: Id of the link this tag refers to
-\li <b>direction</b>: if the link referenced by <b>id</b> has been
- declared as FULLDUPLEX, this is used to indicate in which
- direction the route you're defining is going through this link.
- Possible values "UP" or "DOWN".
-
-\subsubsection pf_asro ASroute
-
-ASroute tag purpose is to let people write manually their routes
-between AS. It's useful when you're in Full model.
-
-<b>ASroute</b> attributes :
-\li <b>src (mandatory)</b>: the source AS id.
-\li <b>dst (mandatory)</b>: the destination AS id.
-\li <b>gw_src (mandatory)</b>: the gateway to be used within the AS.
- Can be any <b>host</b> or \b router defined into the \b src AS or
- into one of the AS it includes.
-\li <b>gw_dst (mandatory)</b>: the gateway to be used within the AS.
- Can be any <b>host</b> or \b router defined into the \b dst AS or
- into one of the AS it includes.
-\li <b>symmetrical</b>: if the route is symmetric, the reverse route
- will be the opposite of the one defined. Can be either YES or NO,
- default is YES.
-
-<b>Example of ASroute with Full</b>
+\subsubsection pf_linkctn <link_ctn/>
+
+This entity has only one purpose: Refer to an already existing
+\ref pf_link "<link/>" when defining a route, i.e., it
+can only occur as a child of \ref pf_routing_tag_route "<route/>"
+
+| Attribute name | Mandatory | Values | Description |
+| --------------- | --------- | ------ | ----------- |
+| id | yes | String | The identifier of the link that should be added to the route. |
+| 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, this attribute has no effect.
+
+#### Example Files ####
+
+This is an automatically generated list of example files that use the \c <link_ctn/>
+entity (the path is given relative to SimGrid's source directory):
+
+\verbinclude example_filelist_xmltag_linkctn
+
+\subsubsection pf_routing_tag_asroute ASroute
+
+The purpose of this entity is to define a route between two ASes.
+This is mainly useful when you're in the \ref pf_routing_model_full "Full routing model".
+
+#### Attributes ####
+
+| Attribute name | Mandatory | Values | Description |
+| --------------- | --------- | ------ | ----------- |
+| src | yes | String | The identifier of the source AS |
+| dst | yes | String | See the \c src attribute |
+| 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. |
+| gw_dst | yes | String | Same as \c gw_src, but with the dst AS instead. |
+| symmetrical | no | YES\|NO (Default: YES) | If this route is symmetric, the opposite route (from dst to src) will also be declared implicitly. |
+
+#### Example ####
+
\verbatim
<AS id="AS0" routing="Full">
<cluster id="my_cluster_1" prefix="c-" suffix=".me"
</AS>
\endverbatim
-\subsubsection pf_ro route
-The principle is the same as ASroute : <b>route</b> contains list of
-links that are in the path between src and dst, except that it is for
-routes between a src that can be either <b>host</b> or \b router and a
-dst that can be either <b>host</b> or \b router. Useful for Full
-as well as for the shortest-paths based models, where you
-have to give topological information.
+\subsubsection pf_routing_tag_route route
+
+The principle is the same as for
+\ref pf_routing_tag_asroute "ASroute": The route contains a list of links that
+provide a path from \c src to \c dst. Here, \c src and \c dst can both be either a
+\ref pf_host "host" or \ref pf_router "router". This is mostly useful for the
+\ref pf_routing_model_full "Full routing model" as well as for the
+\ref pf_routing_model_shortest_path "shortest-paths" based models (as they require
+topological information).
-<b>route</b> attributes :
-\li <b>src (mandatory)</b>: the source id.
-\li <b>dst (mandatory)</b>: the destination id.
-\li <b>symmetrical</b>: if the route is symmetric, the reverse route
- will be the opposite of the one defined. Can be either YES or NO,
- default is YES.
+| Attribute name | Mandatory | Values | Description |
+| --------------- | --------- | ---------------------- | ----------- |
+| src | yes | String | The value given to the source's "id" attribute |
+| dst | yes | String | The value given to the destination's "id" attribute. |
+| symmetrical | no | YES\| NO (Default: YES) | If this route is symmetric, the opposite route (from dst to src) will also be declared implicitly. |
-<b>route example in Full</b>
+
+#### Examples ####
+
+A route in the \ref pf_routing_model_full "Full routing model" could look like this:
\verbatim
<route src="Tremblay" dst="Bourassa">
<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"/>
- </route>
+ </route>
\endverbatim
-<b>route example in a shortest-path model</b>
+A route in the \ref pf_routing_model_shortest_path "Shortest-Path routing model" could look like this:
\verbatim
- <route src="Tremblay" dst="Bourassa">
- <link_ctn id="3"/>
- </route>
+<route src="Tremblay" dst="Bourassa">
+ <link_ctn id="3"/>
+</route>
\endverbatim
-Note that when using route to give topological information, you have
-to give routes with one link only in it, as SimGrid needs to know
-which host are at the end of the link.
+\note
+ You must only have one link in your routes when you're using them to provide
+ topological information, as the routes here are simply the edges of the
+ (network-)graph and the employed algorithms need to know which edge connects
+ which pair of entities.
-\subsubsection pf_byASro bypassASroute
+\subsubsection pf_routing_tag_bypassasroute bypassASroute
-<b>Note : bypassASroute and bypassRoute are under rewriting to perform
-better ; so you may not use it yet</b> As said before, once you choose
-a model, it (if so) calculates routes for you. But maybe you want to
+%As said before, once you choose
+a model, it (most likely; the constant network model, for example, doesn't) calculates routes for you. But maybe you want to
define some of your routes, which will be specific. You may also want
-to bypass some routes defined in lower level AS at an upper stage :
+to bypass some routes defined in lower level AS at an upper stage:
<b>bypassASroute</b> is the tag you're looking for. It allows to
bypass routes defined between already defined between AS (if you want
to bypass route for a specific host, you should just use byPassRoute).
The principle is the same as ASroute : <b>bypassASroute</b> contains
list of links that are in the path between src and dst.
-<b>bypassASroute</b> attributes :
-\li <b>src (mandatory)</b>: the source AS id.
-\li <b>dst (mandatory)</b>: the destination AS id.
-\li <b>gw_src (mandatory)</b>: the gateway to be used within the AS.
- Can be any <b>host</b> or \b router defined into the \b src AS or
- into one of the AS it includes.
-\li <b>gw_dst (mandatory)</b>: the gateway to be used within the AS.
- Can be any <b>host</b> or \b router defined into the \b dst AS or
- into one of the AS it includes.
-\li <b>symmetrical</b>: if the route is symmetric, the reverse route
- will be the opposite of the one defined. Can be either YES or NO,
- default is YES.
-
-<b>bypassASroute Example</b>
+#### Attributes ####
+
+| Attribute name | Mandatory | Values | Description |
+| --------------- | --------- | ---------------------- | ----------- |
+| src | yes | String | The value given to the source AS's "id" attribute |
+| dst | yes | String | The value given to the destination AS's "id" attribute. |
+| 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 |
+| 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|
+| symmetrical | no | YES\| NO (Default: YES) | If this route is symmetric, the opposite route (from dst to src) will also be declared implicitly. |
+
+#### Example ####
+
\verbatim
- <bypassASRoute src="my_cluster_1" dst="my_cluster_2"
- gw_src="my_cluster_1_router"
- gw_dst="my_cluster_2_router">
- <link_ctn id="link_tmp"/>
- </bypassASroute>
+<bypassASRoute src="my_cluster_1" dst="my_cluster_2"
+ gw_src="my_cluster_1_router"
+ gw_dst="my_cluster_2_router">
+ <link_ctn id="link_tmp"/>
+</bypassASroute>
\endverbatim
-\subsubsection pf_byro bypassRoute
-<b>Note : bypassASRoute and bypassRoute are under rewriting to perform
-better ; so you may not use it yet</b> As said before, once you choose
-a model, it (if so) calculates routes for you. But maybe you want to
+This example shows that link \c link_tmp (definition not displayed here) directly
+connects the router \c my_cluster_1_router in the source cluster to the router
+\c my_cluster_2_router in the destination router. Additionally, as the \c symmetrical
+attribute was not given, this route is presumed to be symmetrical.
+
+\subsubsection pf_routing_tag_bypassroute bypassRoute
+
+%As said before, once you choose
+a model, it (most likely; the constant network model, for example, doesn't) calculates routes for you. But maybe you want to
define some of your routes, which will be specific. You may also want
to bypass some routes defined in lower level AS at an upper stage :
<b>bypassRoute</b> is the tag you're looking for. It allows to bypass
as route : <b>bypassRoute</b> contains list of links references of
links that are in the path between src and dst.
-<b>bypassRoute</b> attributes :
-\li <b>src (mandatory)</b>: the source AS id.
-\li <b>dst (mandatory)</b>: the destination AS id.
-\li <b>symmetrical</b>: if the route is symmetric, the reverse route
- will be the opposite of the one defined. Can be either YES or NO,
- default is YES.
+#### Attributes ####
+
+| Attribute name | Mandatory | Values | Description |
+| --------------- | --------- | ---------------------- | ----------- |
+| src | yes | String | The value given to the source AS's "id" attribute |
+| dst | yes | String | The value given to the destination AS's "id" attribute. |
+| symmetrical | no | YES \| NO (Default: YES) | If this route is symmetric, the opposite route (from dst to src) will also be declared implicitly. |
+
+#### Examples ####
-<b>bypassRoute Example</b>
\verbatim
- <bypassRoute src="host_1" dst="host_2">
- <link_ctn id="link_tmp"/>
- </bypassRoute>
+<bypassRoute src="host_1" dst="host_2">
+ <link_ctn id="link_tmp"/>
+</bypassRoute>
\endverbatim
+This example shows that link \c link_tmp (definition not displayed here) directly
+connects host \c host_1 to host \c host_2. Additionally, as the \c symmetrical
+attribute was not given, this route is presumed to be symmetrical.
\subsection pb_baroex Basic Routing Example
(h2) from AS_2 then you'll have to proceed as follows:
\li First, you have to ensure that a route is defined from h1 to the
AS_1's exit gateway and from h2 to AS_2's exit gateway.
-\li Then, you'll have to define a route between AS_1 to AS_2. As those
+\li Then, you'll have to define a route between AS_1 to AS_2. %As those
AS are both resources belonging to AS_Big, then it has to be done
at AS_big level. To define such a route, you have to give the
source AS (AS_1), the destination AS (AS_2), and their respective
defined inside AS_Big. If you choose some shortest-path model,
this route will be computed automatically.
-As said before, there are mainly 2 tags for routing :
+%As said before, there are mainly 2 tags for routing :
\li <b>ASroute</b>: to define routes between two <b>AS</b>
\li <b>route</b>: to define routes between two <b>host/router</b>
-As we are dealing with routes between AS, it means that those we'll
+%As we are dealing with routes between AS, it means that those we'll
have some definition at AS_Big level. Let consider AS_1 contains 1
host, 1 link and one router and AS_2 3 hosts, 4 links and one router.
There will be a central router, and a cross-like topology. At the end
of the crosses arms, you'll find the 3 hosts and the router that will
act as a gateway. We have to define routes inside those two AS. Let
say that AS_1 contains full routes, and AS_2 contains some Floyd
-routing (as we don't want to bother with defining all routes). As
+routing (as we don't want to bother with defining all routes). %As
we're using some shortest path algorithms to route into AS_2, we'll
then have to define some <b>route</b> to gives some topological
information to SimGrid. Here is a file doing it all :
There are 3 tags, that you can use inside a \<platform\> tag that are
not describing the platform:
-\li random: it allows you to define random generators you want to use
+\li \ref pf_random "random": it allows you to define random generators you want to use
for your simulation.
-\li config: it allows you to pass some configuration stuff like, for
+\li \ref pf_config "config": it allows you to pass some configuration stuff like, for
example, the network model and so on. It follows the
-\li include: simply allows you to include another file into the
- current one.
+\li \ref pf_include "include": allows you to include another file into the current one.
-\subsection pf_conf config
-<b>config</b> attributes :
-\li <b>id (mandatory)</b>: the identifier of the config to be used
- when referring to it.
+\subsection pf_config config
+The only purpose of this tag is to contain the \c prop tags, as described below.
+These tags will then configure the options as described by Section \ref options.
+(See the example)
-<b>config</b> tag only purpose is to include <b>prop</b> tags. Valid
-id are basically the same as the list of possible parameters you can
-use by command line, except that "/" are used for namespace
-definition. See the \ref options config and options page for more
-information.
+#### Attributes ####
+
+| Attribute name | Mandatory | Values | Description |
+| --------------- | --------- | ---------------------- | ----------- |
+| id | yes | String | The identifier of the config tag when referring to id; this is basically useless, though. |
+#### Possible children ####
+
+Tag name | Description | Documentation
+------------ | ----------- | -------------
+\<prop/\> | The prop tag allows you to define different configuration options following the attribute/value schema. See the \ref options page. | N/A
+
+#### Example ####
-<b>config example</b>
\verbatim
<?xml version='1.0'?>
<!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
\endverbatim
-\subsection pf_rand random
-Not yet in use, and possibly subject to huge modifications.
+\subsection pf_random random
+
+<b>This has not yet been implemented.</b>
+
+\subsection pf_include include
-\subsection pf_incl include
-<b>include</b> tag allows to import into a file platform parts located
-in another file. This is done with the intention to help people
+The \c include tag allows you to import other platforms into your
+local file. This is done with the intention to help people
combine their different AS and provide new platforms. Those files
-should contains XML part that contains either
-<b>include,cluster,peer,AS,trace,trace_connect</b> tags.
+should contain XML that consists of
+\ref pf_include "include", \ref pf_cluster "cluster", \ref pf_peer "peer", \ref pf_As "AS", \ref pf_trace "trace", \ref pf_trace "tags".
-<b>include</b> attributes :
-\li <b>file (mandatory)</b>: filename of the file to include. Possible
- values: absolute or relative path, syntax similar to the one in
- use on your system.
+\note
+ Due to some obscure technical reasons, you have to open
+ and close the tag in order to make it work.
+
+#### Attributes ####
+
+| Attribute name | Mandatory | Values | Description |
+| --------------- | --------- | ---------------------- | ----------- |
+| file | yes | String | Filename of the path you want to include with either relative or absolute path. Syntax is defined by your OS |
+
+
+#### Example ####
+
+The following example includes two files, clusterA.xml and clusterB.xml and
+combines them two one platform file; all hosts, routers etc. defined in
+each of them will then be usable.
-<b>Note</b>: due to some obscure technical reasons, you have to open
-and close tag in order to let it work.
-<b>include Example</b>
\verbatim
<?xml version='1.0'?>
<!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
</platform>
\endverbatim
-\subsection pf_tra trace and trace_connect
-Both tags are an alternate way to passe availability, state, and so on
-files to entity. Instead of referring to the file directly in the host,
-link, or cluster tag, you proceed by defining a trace with an id
-corresponding to a file, later a host/link/cluster, and finally using
-trace_connect you say that the file trace must be used by the entity.
-Get it ? Let's have a look at an example :
+\subsection pf_trace trace and trace_connect
+
+Both tags are an alternate way to pass files containing information on
+availability, state etc. to an entity. (See also, for instance, Section \ref
+pf_host_churn "Churn", as described for the host entity.) Instead of referring
+to the file directly in the host, link, or cluster tag, you proceed by defining
+a trace with an id corresponding to a file, later a host/link/cluster, and
+finally using trace_connect you say that the file trace must be used by the
+entity.
+
+
+#### Example ####
\verbatim
<AS id="AS0" routing="Full">
<host id="bob" power="1000000000"/>
</AS>
- <trace id="myTrace" file="bob.trace" periodicity="1.0"/>
- <trace_connect trace="myTrace" element="bob" kind="POWER"/>
+<trace id="myTrace" file="bob.trace" periodicity="1.0"/>
+<trace_connect trace="myTrace" element="bob" kind="POWER"/>
\endverbatim
-All constraints you have is that <b>trace_connect</b> is after
-<b>trace</b> and <b>host</b> definitions.
+\note
+ The order here is important. \c trace_connect must come
+ after the elements \c trace and \c host, as both the host
+ and the trace definition must be known when \c trace_connect
+ is parsed; the order of \c trace and \c host is arbitrary.
-<b>trace</b> attributes :
-\li <b>id (mandatory)</b>: the identifier of the trace to be used when
- referring to it.
-\li <b>file</b>: filename of the file to include. Possible values :
- absolute or relative path, syntax similar to the one in use on
- your system. If omitted, the system expects that you provide the
- trace values inside the trace tags (see below).
-\li <b>trace periodicity (mandatory)</b>: trace periodicity, same
- definition as in hosts (see upper for details).
+#### \c trace attributes ####
+
+
+| Attribute name | Mandatory | Values | Description |
+| --------------- | --------- | ---------------------- | ----------- |
+| id | yes | String | Identifier of this trace; this is the name you pass on to \c trace_connect. |
+| 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. |
+| trace_periodicity | yes | String | This is the same as for \ref pf_host "hosts" (see there for details) |
Here is an example of trace when no file name is provided:
0.0 1.0
11.0 0.5
20.0 0.8
- </trace>
+ </trace>
\endverbatim
-<b>trace_connect</b> attributes :
-\li <b>kind</b>: the type of trace, possible values
- <b>HOST_AVAIL|POWER|LINK_AVAIL|BANDWIDTH|LATENCY,</b> default:
- <b>HOST_AVAIL</b>
-\li <b>trace (mandatory)</b>: the identifier of the trace referenced.
-\li <b>element (mandatory)</b>: the identifier of the entity referenced.
-
+#### \c trace_connect attributes ####
+| Attribute name | Mandatory | Values | Description |
+| --------------- | --------- | ---------------------- | ----------- |
+| kind | no | HOST_AVAIL\|POWER\|<br/>LINK_AVAIL\|BANDWIDTH\|LATENCY (Default: HOST_AVAIL) | Describes the kind of trace. |
+| trace | yes | String | Identifier of the referenced trace (specified of the trace's \c id attribute) |
+| element | yes | String | The identifier of the referenced entity as given by its \c id attribute |
\section pf_hints Hints and tips, or how to write a platform efficiently
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.
-\subsection pf_wisely Choosing wisely the routing model to use
+\subsection pf_routing_howto_choose_wisely Choosing wisely the routing model to use
Choosing wisely the routing model to use can significantly fasten your
fast lookup, small memory requirements, shortest path routing
only). Same as Dijkstra, except it handles a cache for latest used
routes.
-\li <b>none</b>: No routing (usable with Constant network only).
+\li <b>None</b>: No routing (usable with Constant network only).
Defines that there is no routes, so if you try to determine a
route without constant network within this AS, SimGrid will raise
an exception.
