X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c821b6aca20de57c0a30c08779a1004d322e746e..029f4e3fda0aaddabf8312586a1a6d73643967fc:/doc/doxygen/platform.doc?ds=sidebyside diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc index 39d75bff1a..1d4a719b3b 100644 --- a/doc/doxygen/platform.doc +++ b/doc/doxygen/platform.doc @@ -9,14 +9,14 @@ process: Which process should be deployed to which processor/core? For the last two items, there are essentially two possible ways you can provide this information as an input: -\li You can program it, either by using the Lua console ( - \ref MSG_Lua_funct) or, if you're using MSG, some of MSG's platform and +\li You can program, if you're using MSG, some of MSG's platform and deployment functions (\ref msg_simulation). If you want to use this, check the particular documentation. (You can also check the section \ref pf_flexml_bypassing, however, this documentation is deprecated; there is a new, but undocumented, way to do it properly). \li You can use two XML files: one contains the platform description while - the other contains the deployment instructions. + the other contains the deployment instructions. The platform description + can also be in Lua format. For more information on SimGrid's deployment features, please refer to the \ref deployment documentation. @@ -344,7 +344,7 @@ state_file | no | string | Allows you to use a file as input for sta loopback_bw | no | int | Bandwidth for loopback (if any). See link 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 link 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), TORUS 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". +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 simgrid::surf::AsClusterFatTree "AsClusterFatTree documentation". TODO @@ -523,7 +523,7 @@ for routing algorithms. So, it does not have any attributes except : Attribute name | Mandatory | Values | Description --------------- | --------- | ------ | ----------- id | yes | string | The identifier of the router to be used when referring to it. -coordinates | yes | string | Must be provided when choosing the Vivaldi, coordinate-based routing model for the AS the router belongs to. More details can be found in the Section \ref pf_P2P_tags. +coordinates | no | string | Must be provided when choosing the Vivaldi, coordinate-based routing model for the AS the router belongs to. More details can be found in the Section \ref pf_P2P_tags. #### Example #### @@ -690,7 +690,7 @@ documentation (Section \ref pf_host) for an example. \subsubsection pf_backbone \note - This tag is only available when the containing AS uses the "Cluster" mode! + This tag is only available when the containing AS uses the "Cluster" routing mode! Using this tag, you can designate an already existing link to be a backbone. @@ -709,9 +709,23 @@ id | yes | string | Name of the link that is supposed to act 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 storage: +\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 --------------- | ----------- @@ -1290,7 +1304,7 @@ can only occur as a child of \ref pf_routing_tag_route "<route/>" #### Example Files #### -This is an automatically generated list of example files that use the \c <link_ctn/gt; +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