From time to time, this DTD evolves to introduce possibly
backward-incompatible changes. That is why each platform desciption is
enclosed within a @c platform tag, that have a @c version attribute.
-The current version is <b>4</b>. The @c simgrid_update_xml program can
+The current version is <b>4.1</b>. The @c simgrid_update_xml program can
upgrade most of the past platform files to the recent formalism.
-\section pf_netzones Defining a NetZone
+\section pf_first_example First Platform Example
-In SimGrid, any resource must be located within a given **NetZone**.
-Each netzone is in charge of the routing between its resources. It
-means that when an host wants to communicate with another host of the
-same NetZone, it is the NetZone's duty to find the list of links that
-are involved in the communication. If the hosts are not in the same
-NetZone, @ref routing_basics "things are slightly more complex" to
-determine the links involved in a time- and space-efficient manner.
+Here is a very simple platform file, containing 3 resources (two hosts
+and one link), and explicitly giving the route between the hosts.
-But only one NetZone is really sufficient to begin with. The following
-chunk describes a simplistic NetZone using the Full routing (we will
-have to specify each and every routes manually).
-
-\verbatim
-<AS id="netzone0" routing="Full">
-\endverbatim
-
-There is also the ``<route>`` tag; this tag takes two attributes,
-``src`` (source) and ``dst`` (destination). Both source and
-destination must be valid identifiers for routers (these will be
-introduced later). Contained by the ``<route>`` are network links;
-these links must be used in order to communicate from the source to
-the destination specified in the tag. Hence, a route merely describes
-how to reach a router from another router.
-
-\remark
- More information and (code-)examples can be found in Section \ref pf_rm.
-
-A netzone can also contain itself one or more netzone; this allows you to model
-the hierarchy of your platform.
-
-### Within each AS, the following types of resources exist:
-
-%Resource | Documented in Section | Description
---------------- | --------------------- | -----------
-AS | | Every Autonomous System (AS) may contain one or more AS.
-host | \ref pf_host | This entity carries out the actual computation. For this reason, it contains processors (with potentially multiple cores).
-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.
-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.
-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.
-
-As it is desirable to interconnect these resources, a routing has to
-be defined. The AS is supposed to be Autonomous, hence this has to be
-done at the AS level. The AS handles two different types of entities
-(<b>host/router</b> and <b>AS</b>). However, the user is responsible
-to define routes between those resources, otherwise entities will be
-unconnected and therefore unreachable from other entities. Although
-several routing algorithms are built into SimGrid (see \ref pf_rm),
-you might encounter a case where you want to define routes manually
-(for instance, due to specific requirements of your platform).
-
-There are three tags to use:
-\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>
-\li <b>bypassRoute</b>: to define routes between two <b>AS</b> that
- will bypass default routing (as specified by the ``routing`` attribute
- supplied to ``<AS>``, see above).
+\code{.xml}
+<?xml version='1.0'?>
+<!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
+<platform version="4.1">
+ <zone id="first zone" routing="Full">
+ <!-- the resources -->
+ <host id="host1" speed="1Mf"/>
+ <host id="host2" speed="2Mf"/>
+ <link id="link1" bandwidth="125MBps" latency="100us"/>
+ <!-- the routing: specify how the hosts are interconnected -->
+ <route src="host1" dst="host2">
+ <link_ctn id="link1"/>
+ </route>
+ </zone>
+</platform>
+\endcode
+As we said, the englobing @ref pf_overview "<platform>" tag is
+used to specify the dtd version used for this file.
+
+Then, every resource (specified with @ref pf_tag_host, @ref
+pf_tag_link or others) must be located within a given **networking
+zone**. Each zone is in charge of the routing between its
+resources. It means that when an host wants to communicate with
+another host of the same zone, it is the zone's duty to find the list
+of links that are involved in the communication. Here, since the @ref
+pf_tag_zone tag has **Full** as a **routing attribute**, all routes
+must be explicitely given using the @ref pf_tag_route and @ref
+pf_tag_linkctn tags (this @ref pf_rm "routing model" is both simple
+and inefficient :) It is OK to not specify the route between two
+hosts, as long as the processes located on them never try to
+communicate together.
+
+A zone can contain several zones itself, leading to a hierarchical
+decomposition of the platform. This can be more efficient (as the
+inter-zone routing gets factorized with @ref pf_tag_zoneroute), and
+allows to have more than one routing model in your platform. For
+example, you could have a coordinate-based routing for the WAN parts
+of your platforms, a full routing within each datacenter, and a highly
+optimized routing within each cluster of the datacenter. In this
+case, determining the route between two given hosts gets @ref
+routing_basics "somewhat more complex" but SimGrid still computes
+these routes for you in a time- and space-efficient manner.
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
- hierarchical cluster (AS5), a subset of a LAN (AS6), and a set of peers
- scattered around the world (AS7).
+
-\section pf_pftags Resource description
+Circles represent processing units and squares represent network
+routers. Bold lines represent communication links. The zone "AS2"
+models the core of a national network interconnecting a small flat
+cluster (AS4) and a larger hierarchical cluster (AS5), a subset of a
+LAN (AS6), and a set of peers scattered around the world (AS7).
-\subsection pf_As Platform: The <AS> tag
+\section pf_res Resource description
-For historical reasons, the XML files use the expression AS for
-NetZones. Netzones are very important because they group other resources (such
-as routers/hosts) together (in fact, any such resource must be
-contained in a NetZone).
+\subsection pf_res_computing Computing Resources
-Available attributes :
+\subsubsection pf_tag_host <host>
-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.
+An host is the computing resource on which an actor can execute.
+Attribute | Values | Description
+----------------- | -------------------------------------- | -----------
+id | String (mandatory) | The identifier of the host. facilitates referring to this AS.
+speed | double (mandatory) | Computational power of every core of this host in FLOPS (must be positive)
+core | int (defaults to 1) | Number of cores (see @ref howto_multicore)
+state | optionally "OFF" | If set to OFF, the host is initially turned off.
+availability_file | File name (optional) | (Relative or absolute) filename to use as input; must contain availability traces for this host. The syntax of this file is defined below.
+state_file | File name (optional) | Same mechanism as availability_file.<br />
+coordinates | String (mandatory when using Vivaldi routing) | The coordinates of this host (see @ref pf_P2P_tags).
+pstate | Double (Defaults to 0) | FIXME: Not yet documented.
-<b>Example:</b>
-\code
-<AS id="AS0" routing="Full">
- <host id="host1" speed="1000000000"/>
- <host id="host2" speed="1000000000"/>
- <link id="link1" bandwidth="125000000" latency="0.000100"/>
- <route src="host1" dst="host2"><link_ctn id="link1"/></route>
-</AS>
-\endcode
-
-In this example, AS0 contains two hosts (host1 and host2). The route
-between the hosts goes through link1.
-
-\subsection pf_Cr Computing resources: hosts, clusters and peers.
-
-\subsubsection pf_host <host>
-
-A <b>host</b> represents a computer/node card. Every host is able to execute
-code and it can send and receive data to/from other hosts. Most importantly,
-a host can contain more than 1 core.
-
-### Attributes: ###
-
-Attribute name | Mandatory | Values | Description
---------------- | --------- | ------ | -----------
-id | yes | String | The identifier of the host. facilitates referring to this AS.
-speed | yes | double (must be > 0.0) | Computational power of every core of this host in FLOPS. Must be larger than 0.0.
-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.
-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.
-state_file | no | string | Same mechanism as availability_file.<br /> <b>Note:</b> The filename must be specified with your system's format.
-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.
-pstate | no | double (Default: 0.0) | FIXME: Not yet documented.
+#### Included tags ####
-### Possible children: ###
+ - @ref pf_tag_mount Specifies the storages mounted on that host
+ - @ref pf_tag_prop Specifies a user-defined property of that host, that you can retrieve with MSG_host_get_property_value() or simgrid::s4u::Host::property().
-Tag name | Description | Documentation
------------- | ----------- | -------------
-\<mount/\> | Defines mounting points between some storage resource and the host. | \ref pf_storage_entity_mount
-\<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
-
-### Example ###
-
-\verbatim
- <host id="host1" speed="1000000000"/>
- <host id="host2" speed="1000000000">
- <prop id="color" value="blue"/>
- <prop id="rendershape" value="square"/>
- </host>
-\endverbatim
+#### Examples ####
+\code{.xml}
+<host id="host1" speed="1000000000"/>
+<host id="host2" speed="1000000000">
+ <prop id="color" value="blue"/>
+ <prop id="rendershape" value="square"/>
+</host>
+\endcode
\anchor pf_host_dynamism
### Expressing dynamism ###
Since the periodicity in line 1 was set to be 1.0, i.e., 1 timestep, this host will
continue to provide 500 Mflop/s from time 21. From time 32 it will provide 250 MFlop/s and so on.
-### Changing initial state ###
-
-It is also possible to specify whether the host is up or down by setting the
-``state`` attribute to either <b>ON</b> (default value) or <b>OFF</b>.
-
-#### Example: Expliciting the default value "ON" ####
-
-\verbatim
-<platform version="4">
- <host id="bob" speed="500Gf" state="ON" />
-</platform>
-\endverbatim
-
-If you want this host to be unavailable, simply substitute ON with OFF.
-
\anchor pf_host_churn
### Expressing churn ###
so on.
-\subsubsection pf_cluster <cluster>
+\subsubsection pf_tag_cluster <cluster>
``<cluster />`` represents a machine-cluster. It is most commonly used
when one wants to define many hosts and a network quickly. Technically,
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.
speed | yes | int | Same as the ``speed`` attribute of the ``\<host\>`` tag.
core | no | int (default: 1) | Same as the ``core`` attribute of the ``\<host\>`` tag.
-bw | yes | int | Bandwidth for the links between nodes and backbone (if any). See the \ref pf_link "link section" for syntax/details.
+bw | yes | int | Bandwidth for the links between nodes and backbone (if any). See the \ref pf_tag_link "link section" for syntax/details.
lat | yes | int | Latency for the links between nodes and backbone (if any). See <b>link</b> section for syntax/details.
sharing_policy | no | string | Sharing policy for the links between nodes and backbone (if any). See <b>link</b> section for syntax/details.
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>).
This tag is only available when the routing mode of the AS
is set to ``Cluster``.
-The ``<cabinet />`` tag is, like the \ref pf_cluster "<cluster>" tag,
+The ``<cabinet />`` tag is, like the \ref pf_tag_cluster "<cluster>" tag,
a meta-tag. This means that it is simply a shortcut for creating a set of (homogenous) hosts and links quickly;
unsurprisingly, this tag was introduced to setup cabinets in data centers quickly. Unlike
<cluster>, however, the <cabinet> assumes that you create the backbone
prefix | yes | string | Each node of the cabinet has to have a name. This name will be prefixed with this prefix.
suffix | yes | string | Each node of the cabinet will be suffixed with this suffix
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.
-speed | yes | int | Same as the ``speed`` attribute of the \ref pf_host "<host>" tag.
-bw | yes | int | Bandwidth for the links between nodes and backbone (if any). See the \ref pf_link "link section" for syntax/details.
-lat | yes | int | Latency for the links between nodes and backbone (if any). See the \ref pf_link "link section" for syntax/details.
+speed | yes | int | Same as the ``speed`` attribute of the \ref pf_tag_host "<host>" tag.
+bw | yes | int | Bandwidth for the links between nodes and backbone (if any). See the \ref pf_tag_link "link section" for syntax/details.
+lat | yes | int | Latency for the links between nodes and backbone (if any). See the \ref pf_tag_link "link section" for syntax/details.
\note
Please note that as of now, it is impossible to change attributes such as,
details on how the latency is computed from the coordinate, and on the
the up and down bandwidth are used.
-\subsection pf_ne Network equipments: links and routers
+\subsection pf_ne Network equipments
There are two tags at all times available to represent network entities and
several other tags that are available only in certain contexts.
<router id="gw_dc1_horizdist"/>
\endverbatim
-\subsubsection pf_link <link/>
+\subsubsection pf_tag_link <link>
Network links can represent one-hop network connections. They are
characterized by their id and their bandwidth; links can (but may not) be subject
value will not change until second 5, when the periodicity defined in line 1
kicks in. It then loops back, starting at 100µs (the initial value) for one second.
-
#### The ``<prop/>`` tag ####
Similar to the ``<host>`` tag, a link may also contain the ``<prop/>`` tag; see the host
--------------- | -----------
\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).
+\ref pf_tag_mount "mount" | Must be wrapped by a \ref pf_tag_host tag; declares which storage(s) this host has mounted and where (i.e., the mountpoint).
\anchor pf_storage_content_file
</storage_type>
\endverbatim
-\anchor pf_storage_entity_storage
-#### <storage> ####
-
-``storage`` attributes:
+@subsubsection pf_tag_storage <storage>
-Attribute name | Mandatory | Values | Description
+Attributes | Mandatory | Values | Description
-------------- | --------- | ------ | -----------
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.
and the filesystem uses the windows style; finally, it is attached to a second host,
called alice (which is again not defined here).
-\anchor pf_storage_entity_mount
-#### <mount> ####
+\subsubsection pf_tag_mount <mount>
-Attributes:
-| Attribute name | Mandatory | Values | Description |
-| ---------------- | ----------- | -------- | ------------- |
-| id | yes | string | Refers to a \ref pf_storage_entity_storage "<storage>" entity that will be mounted on that computer |
-| name | yes | string | Path/location to/of the logical reference (mount point) of this disk
+| Attribute | Mandatory | Values | Description |
+| ----------- | ----------- | -------- | ------------- |
+| id | yes | string | Refers to a \ref pf_storage_entity_storage "<storage>" entity that will be mounted on that computer |
+| name | yes | string | Path/location to/of the logical reference (mount point) of this disk
-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)
+This tag must be enclosed by a \ref pf_tag_host tag. It then specifies where the mountpoint of a given storage device (defined by the ``id`` attribute)
is; this location is specified by the ``name`` attribute.
Here is a simple example, taken from the file ``examples/platform/storage.xml``:
eventually, when the routing tables have stabilized, your packets will follow
the shortest paths.
+\subsection pf_tag_zone <zone>
+
+Before SimGrid v3.16, networking zones used to be called Autonomous
+Systems, but this was misleading as zones may include other zones in a
+hierarchical manner. If you find any remaining reference to ASes,
+please report this as a bug.
+
+Attribute | Value | Description
+----------- | ------------------------------------------------- | ----------------------------------------------
+id | String (mandatory) | The identifier of this zone (must be unique)
+routing | One of the existing routing algorithm (mandatory) | See Section \ref pf_rm for details.
+
+<b>Example:</b>
+\code
+<AS id="AS0" routing="Full">
+ <host id="host1" speed="1000000000"/>
+ <host id="host2" speed="1000000000"/>
+ <link id="link1" bandwidth="125000000" latency="0.000100"/>
+ <route src="host1" dst="host2"><link_ctn id="link1"/></route>
+</AS>
+\endcode
+
+In this example, AS0 contains two hosts (host1 and host2). The route
+between the hosts goes through link1.
+
\subsection pf_rm Routing models
For each AS, you must define explicitly which routing model will
| 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_cluster "Cluster" | This is specific to the \ref pf_tag_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. |
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",
+be noted, however, that you can still attach an \ref pf_tag_asroute "ASroute",
as is demonstrated in the example below:
\verbinclude platforms/cluster_and_one_host.xml
| 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 |
+| \ref pf_tag_route "route" | Used to define route between host/router |
+| \ref pf_tag_zoneroute "zoneRoute" | Used to define route between different zones |
+| \ref pf_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_tag_bypassasroute "bypassZoneRoute" | Used in the same way as bypassRoute, but for zones |
Basically all those tags will contain an (ordered) list of references
to link that compose the route you want to define.
\endverbatim
The route here from host Alice to Bob will be first link1, then link2,
-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
+and finally link3. What about the reverse route? \ref pf_tag_route "Route" and
+\ref pf_tag_zoneroute "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 \ref pf_routing_tag_asroute "ASroute", things are just slightly more complicated, as you have
+For an \ref pf_tag_zoneroute "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:
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/>
+\subsubsection pf_tag_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/>"
+\ref pf_tag_link "<link/>" when defining a route, i.e., it
+can only occur as a child of \ref pf_tag_route "<route/>"
| Attribute name | Mandatory | Values | Description |
| --------------- | --------- | ------ | ----------- |
\verbinclude example_filelist_xmltag_linkctn
-\subsubsection pf_routing_tag_asroute ASroute
+\subsubsection pf_tag_zoneroute <zoneRoute>
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".
| --------------- | --------- | ------ | ----------- |
| 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_src | yes | String | The gateway that will be used within the src AS; this can be any \ref pf_tag_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. |
</AS>
\endverbatim
-\subsubsection pf_routing_tag_route route
+\subsubsection pf_tag_route <route>
The principle is the same as for
-\ref pf_routing_tag_asroute "ASroute": The route contains a list of links that
+\ref pf_tag_zoneroute "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_tag_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).
(network-)graph and the employed algorithms need to know which edge connects
which pair of entities.
-\subsubsection pf_routing_tag_bypassasroute bypassASroute
+\subsubsection pf_tag_bypassasroute bypassASroute
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
\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
+\subsubsection pf_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
</AS>
\endverbatim
-\section pf_other_tags Tags not (directly) describing the platform
+\section pf_other Other tags
The following tags can be used inside a \<platform\> tag even if they are not
directly describing the platform:
-\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 \ref pf_include "include": allows you to include another file into the current one.
-\subsection pf_config config
+ - @ref pf_tag_config passes configuration options, e.g. to change the network model;
+ - @ref pf_tag_prop gives user-defined properties to various elements
-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)
+\subsection pf_tag_config <config>
-#### Attributes ####
+Adding configuration flags into the platform file is particularly
+useful when the described platform is best used with specific
+flags. For example, you could finely tune SMPI in your platform file directly.
-| Attribute name | Mandatory | Values | Description |
-| --------------- | --------- | ---------------------- | ----------- |
-| id | yes | String | The identifier of the config tag when referring to id; this is basically useless, though. |
+| Attribute | Values | Description |
+| ---------- | ------------------- | ---------------------------------------------- |
+| id | String (optional) | This optional identifier is ignored by SimGrid |
-#### Possible children ####
+* **Included tags:** @ref pf_tag_prop to specify a given configuration item (see @ref options).
-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
+Any such configuration must be given at the very top of the platform file.
-#### Example ####
+* **Example**
\verbatim
<?xml version='1.0'?>
<!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
<platform version="4">
-<config id="General">
- <prop id="maxmin/precision" value="0.000010"></prop>
- <prop id="cpu/optim" value="TI"></prop>
- <prop id="host/model" value="compound"></prop>
- <prop id="network/model" value="SMPI"></prop>
- <prop id="path" value="~/"></prop>
- <prop id="smpi/bw-factor" value="65472:0.940694;15424:0.697866;9376:0.58729"></prop>
+<config>
+ <prop id="maxmin/precision" value="0.000010" />
+ <prop id="cpu/optim" value="TI" />
+ <prop id="network/model" value="SMPI" />
+ <prop id="smpi/bw-factor" value="65472:0.940694;15424:0.697866;9376:0.58729" />
</config>
<AS id="AS0" routing="Full">
...
\endverbatim
-\subsection pf_include include
+\subsection pf_tag_prop <prop>
-Even if it can be used in other contexts, this tag was originally created
-to be used with \ref pf_trace. The idea was to have a file describing the
-platform, and another file attaching traces of a given period to the platform.
+Defines a user-defined property, identified with a name and having a
+value. You can specify such properties to most kind of resources:
+@ref pf_tag_zone, @ref pf_tag_host, @ref pf_tag_storage,
+@ref pf_tag_cluster and @ref pf_tag_link. These values can be retrieved
+at runtime with MSG_zone_property() or simgrid::s4u::NetZone::property(),
+or similar functions.
-The drawback is that the file chuncks that will be included do not
-constitute valid XML files. This may explain why this feature was never really
-used in practice (as far as we know). Other mechanisms, such as the ability to load
-several platform files one after the other, could be considered in the future.
-
-In the meanwhile, 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 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".
-
-Do not forget to close the tag to make it work, or you will end up with an invalid XML file.
-
-#### Attributes ####
-
-| Attribute name | Mandatory | Values | Description |
-| --------------- | --------- | ---------------------- | ----------- |
-| file | yes | String | Filename of the path you want to include with either relative or absolute path. |
+| Attribute | Values | Description |
+| --------- | ---------------------- | ----------------------------------------------------------------------------------------- |
+| id | String (mandatory) | Identifier of this property. Must be unique for a given property holder, eg host or link. |
+| value | String (mandatory) | Value of this property; The semantic is completely up to you. |
+* **Included tags:** none.
#### 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.
+\code{.xml}
+<prop id="Operating System" value="Linux" />
+\endcode
-\verbatim
-<?xml version='1.0'?>
-<!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
-<platform version="4">
- <AS id="main" routing="Full">
- <include file="clusterA.xml"></include>
- <include file="clusterB.xml"></include>
- </AS>
-</platform>
-\endverbatim
\subsection pf_trace trace and trace_connect
| --------------- | --------- | ---------------------- | ----------- |
| 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) |
+| trace_periodicity | yes | String | This is the same as for \ref pf_tag_host "hosts" (see there for details) |
Here is an example of trace when no file name is provided:
produce good platform and some choices you can make in order to have
faster simulations. Here's some hints and tips, then.
-@subsection Finding the platform example that you need
+@subsection pf_hints_search Finding the platform example that you need
Most platform files that we ship are in the @c examples/platforms
folder. The good old @c grep tool can find the examples you need when
