X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/478e0a8f646095dcdf8869d6f5dbfb23964eb134..34dd010877669cba8804b45bcd6a5e415f8984aa:/doc/doxygen/platform.doc diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc index 7f7d0123c4..6d99c901d6 100644 --- a/doc/doxygen/platform.doc +++ b/doc/doxygen/platform.doc @@ -129,7 +129,7 @@ Here is an illustration of these concepts: \section pf_pftags Resource description -\subsection pf_As Platform: The \ tag +\subsection pf_As Platform: The <AS> tag The concept of an AS was already outlined above (Section \ref pf_basics); recall that the AS is so important because it groups other resources (such @@ -159,7 +159,7 @@ between the hosts goes through link1. \subsection pf_Cr Computing resources: hosts, clusters and peers. -\subsubsection pf_host The tag +\subsubsection pf_host <host/> A host 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, @@ -171,7 +171,7 @@ Attribute name | Mandatory | Values | Description --------------- | --------- | ------ | ----------- id | yes | String | The identifier of the host. facilitates referring to this AS. power | 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 "power" parameter refers to every core, i.e., the total computational power is #cores*power.
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.
Warning: Although functional, this model was never scientifically assessed. +core | no | int (Default: 1) | The number of cores of this host. If more than one core is specified, the "power" parameter refers to every core, i.e., the total computational power is no_of_cores*power.
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.
Warning: Although functional, this model was never scientifically assessed. availability | no | int | Specify if the percentage of power available. (What? TODO) 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.
Note: The filename must be specified with your system's format. state | no | ON\|OFF
(Default: ON) | Is this host running or not? @@ -182,8 +182,8 @@ coordinates | no | string | Must be provided when choosing the Vivald Tag name | Description | Documentation ------------ | ----------- | ------------- - | Defines mounting points between some storage resource and the host. | \ref pf_sto_mo - | 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 +\ | Defines mounting points between some storage resource and the host. | \ref pf_sto_mo +\ | 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 ### @@ -200,7 +200,7 @@ Tag name | Description | Documentation ### Expressing dynamism ### SimGrid provides mechanisms to change a hosts' availability over -time, using the ``availability_file`` attribute to the ```` tag +time, using the ``availability_file`` attribute to the ``\`` tag and a separate text file whose syntax is exemplified below. #### Adding a trace file #### @@ -223,7 +223,7 @@ PERIODICITY 1.0 Let us begin to explain this example by looking at line 2. (Line 1 will become clear soon). The first column describes points in time, in this case, time 0. The second column describes the relative amount of power this host is able to deliver (relative -to the maximum performance specified in the ```` tag). (Clearly, the +to the maximum performance specified in the ``\`` tag). (Clearly, the second column needs to contain values that are not smaller than 0 and not larger than 1). In this example, our host will deliver 500 Mflop/s at time 0, as 500 Mflop/s is the maximum performance of this host. At time 11.0, it will @@ -279,7 +279,7 @@ so on. -\subsubsection pf_cluster +\subsubsection pf_cluster <cluster> ```` represents a machine-cluster. It is most commonly used when one wants to define many hosts and a network quickly. Technically, @@ -331,8 +331,8 @@ id | yes | string | The identifier of the cluster. Facilitate prefix | yes | string | Each node of the cluster has to have a name. This name will be prefixed with this prefix. suffix | yes | string | Each node of the cluster will be suffixed with this suffix 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. -power | yes | int | Same as the ``power`` attribute of the ```` tag. -core | no | int (default: 1) | Same as the ``core`` attribute of the ```` tag. +power | yes | int | Same as the ``power`` attribute of the ``\`` tag. +core | no | int (default: 1) | Same as the ``core`` attribute of the ``\`` tag. bw | yes | int | Bandwidth for the links between nodes and backbone (if any). See link section for syntax/details. lat | yes | int | Latency for the links between nodes and backbone (if any). See link section for syntax/details. sharing_policy | no | string | Sharing policy for the links between nodes and backbone (if any). See link section for syntax/details. @@ -379,7 +379,7 @@ c-2.me c-99.me \endverbatim -\subsubsection pf_peer +\subsubsection pf_peer The <peer> tag This tag represents a peer, as in Peer-to-Peer (P2P) networks. However, internally, SimGrid transforms a peer into an AS (similar to Cluster). Hence, this tag @@ -408,7 +408,7 @@ sharing_policy | no | SHARED\|FULLDUPLEX (default: FULLDUPLEX) | Sharing availability_file| no | string | Availability file for the peer. Same as host availability file. See host description for details. state_file | no | string | State file for the peer. Same as host state file. See host description for details. -Internally, SimGrid transforms any ```` construct such as +Internally, SimGrid transforms any ``\`` construct such as \verbatim `` construct such as bw_out="2.25GBps" lat="500us" /> \endverbatim -into an ```` (see Sections \ref pf_basics and \ref pf_As). In fact, this example of the ```` tag +into an ``\`` (see Sections \ref pf_basics and \ref pf_As). In fact, this example of the ``\`` tag is completely equivalent to the following declaration: \verbatim @@ -457,7 +457,7 @@ several other tags that are available only in certain contexts. If you want to represent an entity like a switch, you must use ```` (see section). Routers are used to run some routing algorithm and determine routes (see Section \ref pf_routing for details). -\subsubsection pf_router +\subsubsection pf_router <router/> %As said before, router is used only to give some information for routing algorithms. So, it does not have any attributes except : @@ -475,7 +475,7 @@ coordinates | yes | string | Must be provided when choosing the Vivald \endverbatim -\subsubsection pf_link +\subsubsection pf_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 @@ -534,7 +534,7 @@ 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. Please note that this is really on a per-flow basis, not only on a per-host basis! The complete bandwidth provided by this link in this mode -is ``#flows*bandwidth``, with at most ``bandwidth`` being available per flow. +is ``number_of_flows*bandwidth``, with at most ``bandwidth`` being available per flow. Using the FATPIPE mode allows to model backbones that won't affect performance (except latency). @@ -567,7 +567,7 @@ with no upper total limit. #### Expressing dynamism and failures #### Similar to hosts, it is possible to declare links whose state, bandwidth -or latency changes over time (see Section \ref pf_hosts_dynamism for details). +or latency changes over time (see Section \ref pf_host_dynamism for details). In the case of network links, the ``bandwidth`` and ``latency`` attributes are replaced by the ``bandwidth_file`` and ``latency_file`` attributes. @@ -627,7 +627,7 @@ kicks in. It then loops back, starting at 100µs (the initial value) for one sec #### The ```` tag #### -Similar to ````, the link may also contain the ```` tag; see the host +Similar to ``\``, the link may also contain the ```` tag; see the host documentation (Section \ref pf_host) for an example. @@ -638,14 +638,11 @@ TODO \note This tag is only available when the containing AS uses the "Cluster" mode! -TODO: Is default=shared correct? +Using this tag, you can designate an already existing link to be a backbone. Attribute name | Mandatory | Values | Description --------------- | --------- | ------ | ----------- -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 | SHARED\|FATPIPE\|FULLDUPLEX (default: SHARED) | Sharing policy for the link. +id | yes | string | Name of the link that is supposed to act as a backbone. \subsection pf_storage Storage