+.. _platform_reference:
+
DTD Reference
*************
@@ -18,6 +20,39 @@ the `simgrid.dtd `_
DTD file. The same DTD is used for both the platform and deployment
files.
+.. _pf_tag_config:
+
+------------------------------------------------------------------
+
+------------------------------------------------------------------
+
+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. Almost all :ref:`command-line configuration items `
+can be configured this way.
+
+**Parent tags:** :ref:`pf_tag_platform` (must appear before any other tags) |br|
+**Children tags:** :ref:`pf_tag_prop` |br|
+**Attributes:** none
+
+.. code-block:: xml
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|hr|
+
.. _pf_tag_host:
------------------------------------------------------------------
@@ -27,7 +62,7 @@ files.
An host is the computing resource on which an actor can execute. See :cpp:class:`simgrid::s4u::Host`.
**Parent tags:** :ref:`pf_tag_zone` (only leaf zones, i.e. zones containing no inner zones nor clusters) |br|
-**Children tags:** :ref:`pf_tag_prop`, :ref:`pf_tag_storage` |br|
+**Children tags:** :ref:`pf_tag_mount`, :ref:`pf_tag_prop`, :ref:`pf_tag_storage` |br|
**Attributes:**
:``id``: Host name.
@@ -85,13 +120,19 @@ An host is the computing resource on which an actor can execute. See :cpp:class:
:``pstate``: Initial pstate (default: 0, the first one).
See :ref:`howto_dvfs`.
+|hr|
+
.. _pf_tag_link:
------------------------------------------------------------------
------------------------------------------------------------------
-Network links can represent one-hop network connections. See :cpp:class:`simgrid::s4u::Link`.
+Network links can represent one-hop network connections (see
+:cpp:class:`simgrid::s4u::Link`). SimGrid links can be used to
+represent either a single wire, or to abstract a larger network
+interconnect in a single element. A single link can for example be
+used to model the transcontinental network.
**Parent tags:** :ref:`pf_tag_zone` (both leaf zones and inner zones) |br|
**Children tags:** :ref:`pf_tag_prop` |br|
@@ -159,7 +200,7 @@ Network links can represent one-hop network connections. See :cpp:class:`simgrid
4.0 40000000
8.0 60000000
- PERIODICITY 12.0
+ LOOPAFTER 12.0
- At time t=4, the bandwidth is of 40 MBps.
- At time t=8, it raises to 60MBps.
@@ -191,7 +232,9 @@ Network links can represent one-hop network connections. See :cpp:class:`simgrid
:ref:`pf_tag_link` are absolute values, but Availability
profiles of :ref:`pf_tag_host` are ratio.
:``state_file``: File containing the state profile. See :ref:`pf_tag_host`.
-
+
+|hr|
+
.. _pf_tag_peer:
------------------------------------------------------------------
@@ -233,8 +276,29 @@ and a download link.
:``state_file``: File containing the state profile.
See the full description in :ref:`pf_tag_host`
+|hr|
-
+.. _pf_tag_platform:
+
+------------------------------------------------------------------
+
+------------------------------------------------------------------
+
+**Parent tags:** none (this is the root tag of every file) |br|
+**Children tags:** :ref:`pf_tag_config` (must come first),
+:ref:`pf_tag_cluster`, :ref:`pf_tag_cabinet`, :ref:`pf_tag_peer`,
+:ref:`pf_tag_zone`, :ref:`pf_tag_trace`, :ref:`pf_tag_trace_connect` |br|
+**Attributes:**
+
+:``version``: Version of the DTD, describing the whole XML format.
+ This versionning allow future evolutions, even if we
+ avoid backward-incompatible changes. The current version
+ is **4.1**. The ``simgrid_update_xml`` program can
+ upgrade most of the past platform files to the recent
+ formalism.
+
+|hr|
+
.. _pf_tag_prop:
------------------------------------------------------------------
@@ -248,7 +312,13 @@ the plugins.
From your code, you can interact with these properties using the
following functions:
+
+- Actor: :cpp:func:`simgrid::s4u::Actor::get_property` or :cpp:func:`MSG_process_get_property_value`
+- Cluster: this is a zone, see below.
- Host: :cpp:func:`simgrid::s4u::Host::get_property` or :cpp:func:`MSG_host_get_property_value`
+- Link: :cpp:func:`simgrid::s4u::Link::get_property`
+- Storage: :cpp:func:`simgrid::s4u::Storage::get_property` or :cpp:func:`MSG_storage_get_property_value`
+- Zone: :cpp:func:`simgrid::s4u::Zone::get_property` of :cpp:func:`MSG_zone_get_property_value`
**Parent tags:** :ref:`pf_tag_actor`, :ref:`pf_tag_config`, :ref:`pf_tag_cluster`, :ref:`pf_tag_host`,
:ref:`pf_tag_link`, :ref:`pf_tag_storage`, :ref:`pf_tag_zone` |br|
@@ -258,6 +328,8 @@ following functions:
:``id``: Name of the defined property.
:``value``: Value of the defined property.
+|hr|
+
.. _pf_tag_router:
------------------------------------------------------------------
@@ -280,3 +352,7 @@ break the routes that are longer than 1 hop.
.. |br| raw:: html
+
+.. |hr| raw:: html
+
+