X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/07ab66b75202165f5f9fcb66837fd9bf8c372d66..51e5a45d4be05b7c01d28ce109505cd5e7444e46:/docs/source/XML_reference.rst?ds=sidebyside diff --git a/docs/source/XML_reference.rst b/docs/source/XML_reference.rst index 8b0749ef4f..dad879d7bb 100644 --- a/docs/source/XML_reference.rst +++ b/docs/source/XML_reference.rst @@ -26,9 +26,11 @@ Here is the complete list of all existing tags in the DTD: :ref:`pf_tag_bypassRoute`: tweeking the routing (advanced tag). |br| :ref:`pf_tag_bypassZoneRoute`: tweeking the routing (expert-only tag). |br| :ref:`pf_tag_cabinet`: building clusters manually from the XML (deprecated, please use the C++ API). |br| +:ref:`pf_tag_cluster`: building a cluster (aka, a full zone in one tag only). |br| :ref:`pf_tag_config`: pass simulation parameters from the XML file. |br| :ref:`pf_tag_disk`: storage resource. |br| :ref:`pf_tag_host`: computing resource. |br| +:ref:`pf_tag_host_link`: building clusters manually from the XML (deprecated, please use the C++ API). |br| :ref:`pf_tag_link`: communication resource. |br| :ref:`pf_tag_link_ctn`: name of a link to be included in a route. |br| :ref:`pf_tag_peer`: host located in a :ref:`pf_rm_vivaldi` zone. |br| @@ -39,10 +41,6 @@ Here is the complete list of all existing tags in the DTD: :ref:`pf_tag_zone`: area of the network containing elements (:ref:`pf_tag_disk`, :ref:`pf_tag_host`, :ref:`pf_tag_link` and sub-:ref:`pf_tag_zone`). |br| :ref:`pf_tag_zoneRoute`: inter-zone network path. -.. TODO:: - - Missing tags: - ------------------------------------------------------------------------------- .. _pf_tag_cluster: @@ -134,10 +132,10 @@ name of the flag and ``value`` is what it has to be set to. - + - + @@ -195,13 +193,13 @@ We provide an example model of file system as a plugin, (sparsely) documented in A host is the computing resource on which an actor can run. See :cpp:class:`simgrid::s4u::Host`. **Parent tags:** :ref:`pf_tag_zone` (only leaf zones, i.e., zones containing neither inner zones nor clusters) |br| -**Children tags:** :ref:`pf_tag_mount`, :ref:`pf_tag_prop`, :ref:`pf_tag_disk` |br| +**Children tags:** :ref:`pf_tag_prop`, :ref:`pf_tag_disk` |br| **Attributes:** :``id``: Host name. Must be unique over the whole platform. :``speed``: Computational power (per core, in flop/s). - If you use DVFS, provide a comma-separated list of values for each pstate (see :ref:`howto_dvfs`). + If you use DVFS, provide a comma-separated list of values for each pstate (see :ref:`API_s4u_Host_dvfs`). :``core``: Amount of cores (default: 1). See :ref:`howto_multicore`. :``availability_file``: @@ -249,7 +247,7 @@ A host is the computing resource on which an actor can run. See :cpp:class:`simg :``coordinates``: Vivaldi coordinates (meaningful for Vivaldi zones only). See :ref:`pf_tag_peer`. :``pstate``: Initial pstate (default: 0, the first one). - See :ref:`howto_dvfs`. + See :ref:`API_s4u_Host_dvfs`. ------------------------------------------------------------------------------- @@ -327,8 +325,8 @@ hyperlinks in an `hypergraph `_. 8.0 60000000 LOOPAFTER 12.0 - - At time t = 4, the bandwidth is of 40 MBps. - - At time t = 8, it raises to 60MBps. + - At time t = 4, the bandwidth is of 40 Mb/s. + - At time t = 8, it raises to 60 Mb/s. - At time t = 24, it drops at 40 MBps again. If your profile does not contain any LOOPAFTER line, then it will @@ -402,7 +400,7 @@ and a download link. :``id``: Name of the host. Must be unique on the whole platform. :``speed``: Computational power (in flop/s). - If you use DVFS, provide a comma-separated list of values for each pstate (see :ref:`howto_dvfs`). + If you use DVFS, provide a comma-separated list of values for each pstate (see :ref:`API_s4u_Host_dvfs`). :``bw_in``: Bandwidth of the private downstream link, along with its unit. See :ref:`pf_tag_link`. :``bw_out``: Bandwidth of the private upstream link, along with its @@ -459,12 +457,12 @@ 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` +- Actor: :cpp:func:`simgrid::s4u::Actor::get_property` - Cluster: this is a zone, see below. - Disk: :cpp:func:`simgrid::s4u::Disk::get_property` -- Host: :cpp:func:`simgrid::s4u::Host::get_property` or :cpp:func:`MSG_host_get_property_value` +- Host: :cpp:func:`simgrid::s4u::Host::get_property` - Link: :cpp:func:`simgrid::s4u::Link::get_property` -- Zone: :cpp:func:`simgrid::s4u::NetZone::get_property` of :cpp:func:`MSG_zone_get_property_value` +- Zone: :cpp:func:`simgrid::s4u::NetZone::get_property` **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_disk`,:ref:`pf_tag_zone` |br| @@ -557,7 +555,7 @@ More detail can be found in the following sections :ref:`pf_routes` and :ref:`pf :``gw_src``: Netpoint (within src zone) from which this route starts. Must be an existing host/router. :``gw_dst``: Netpoint (within dst zone) to which this route leads. Must be an existing host/router. :``symmetrical``: Whether this route is symmetrical, ie, whether we are defining the route ``dst -> src`` at the same - time. Valid values: ``yes``, ``no``, ``YES``, ``NO``. + time. Valid values: ``yes``, ``no``, ``YES``, ``NO``. ------------------------------------------------------------------------------- @@ -608,12 +606,14 @@ to experts. :``gw_src``: Netpoint (within src zone) from which this route starts. Must be an existing host/router. :``gw_dst``: Netpoint (within dst zone) to which this route leads. Must be an existing host/router. :``symmetrical``: Whether this route is symmetrical, ie, whether we are defining the route ``dst -> src`` at the same - time. Valid values: ``yes``, ``no``, ``YES``, ``NO``. + time. Valid values: ``yes``, ``no``, ``YES``, ``NO``. + +------------------------------------------------------------------------------- .. _pf_tag_backbone: -^^^^^^^^^ +^^^^^^^^^^ Within a manually-built cluster, specify the backbone to use. See the documentation of :ref:`pf_tag_cabinet` for all details, even if you should probably stop using this tag and switch to the C++ interface. @@ -662,7 +662,24 @@ the core amount or link characteristics cannot be changed with this tag. The hosts generated in the above example are named host-1.cluster, host-2.cluster1 etc. +------------------------------------------------------------------------------- + +.. _pf_tag_host_link: + + +^^^^^^^^^^^ + +Specify the up and down private links of a given host, which must be in a Cluster zone. + +**Parent tags:** :ref:`pf_tag_zone` with ``routing="Cluster"`` attribute |br| +**Children tags:** none |br| +**Attributes:** + +:``id``: Identifier of the host to be connected. +:``up``: Link id to be used for the outgoing communications. +:``down``: Link id to be used for the incoming communications. + .. |br| raw:: html - +