X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5937b88aaa18de687b2de15a97ee3ae0dc480f64..4d02714ee138a3bd9b02e0064b7a2aa26407e9e8:/doc/doxygen/platform.doc diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc index 318db98295..21121e1e29 100644 --- a/doc/doxygen/platform.doc +++ b/doc/doxygen/platform.doc @@ -1,62 +1,11 @@ /*! @page platform Describing the virtual platform -@tableofcontents - -@htmlonly -
-@endhtmlonly -@htmlinclude graphical-toc.svg -@htmlonly -
- -@endhtmlonly - -As @ref starting_components "explained in the introduction," any -SimGrid study must entail the description of the platform on which you -want to simulate your application. You have to describe **each element -of your platform**, such as computing hosts, clusters, each disks, -links, etc. You must also define the **routing on your platform**, ie -which path is taken between two hosts. Finally, you may also describe -an **experimental scenario**, with qualitative changes (e.g., -bandwidth changes representing an external load) and qualitative -changes (representing how some elements fail and restart over time). - -You should really separate your application from the platform -description, as it will ease your experimental campain afterward. -Mixing them is seen as a really bad experimental practice. The easiest -to enforce this split is to put the platform description in a XML -file. Many example platforms are provided in the archive, and this -page gives all needed details to write such files, as well as some -hints and tricks about describing your platform. - -On the other side, XML is sometimes not expressive enough for some -platforms, in particular large platforms exhibiting repetitive -patterns that are not simply expressed in XML. In practice, many -users end up generating their XML platform files from some sort of -scripts. It is probably preferable to rewrite your XML @ref -platform_lua "platform using the lua scripting language" instead. -In the future, it should be possible to describe the platform directly -in C++, but this is not possible yet. + As usual, SimGrid is a versatile framework, and you should find the way of describing your platform that best fits your experimental practice. -@section pf_overview Describing the platform with XML - -Your platform description should follow the specification presented in -the [simgrid.dtd](http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd) -DTD file. The same DTD is used for both the platform and deployment -files. - -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 4.1. The @c simgrid_update_xml program can -upgrade most of the past platform files to the recent formalism. - @section pf_first_example First Platform Example Here is a very simple platform file, containing 3 resources (two hosts @@ -64,7 +13,7 @@ and one link), and explicitly giving the route between the hosts. @code{.xml} - + @@ -79,8 +28,6 @@ and one link), and explicitly giving the route between the hosts. @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 @@ -1448,7 +1395,7 @@ Any such configuration must be given at the very top of the platform file. @verbatim - + @@ -1663,7 +1610,7 @@ complicated in using it, here is an example: @verbatim - + @@ -1690,7 +1637,7 @@ Note that the previous example defines a routing directly between hosts but it c That is for example what is commonly done when using peers (see Section @ref pf_peer). @verbatim - +