From 5a25b8089e4305ec691c460487a77e5c1d07aeb8 Mon Sep 17 00:00:00 2001 From: Laurent Bobelin Date: Thu, 29 Mar 2012 10:10:58 +0200 Subject: [PATCH] Added a platform desc doc. Some infos are still missing, but I have to check them with some qualified guys ... --- buildtools/Cmake/GenerateDoc.cmake | 3 +- doc/AS_hierarchy.png | Bin 0 -> 8560 bytes doc/Doxyfile.in | 3 +- doc/platform.doc | 774 +++++++++++++++++++++++++ tools/doxygen/doxygen_postprocesser.pl | 4 +- 5 files changed, 781 insertions(+), 3 deletions(-) create mode 100644 doc/AS_hierarchy.png create mode 100644 doc/platform.doc diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index df02d6223d..59132b5b84 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -84,6 +84,7 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSI COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/ COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/html/ COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png ${CMAKE_HOME_DIRECTORY}/doc/html/ COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/ ) @@ -91,7 +92,7 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSI COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass" COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl pls.doc index.doc FAQ.doc gtut-introduction.doc install.doc bindings.doc options.doc tracing.doc + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl pls.doc index.doc FAQ.doc gtut-introduction.doc install.doc bindings.doc options.doc tracing.doc platform.doc COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass" COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile diff --git a/doc/AS_hierarchy.png b/doc/AS_hierarchy.png new file mode 100644 index 0000000000000000000000000000000000000000..a618a86ca746349fb171105768c231cc8abf3d96 GIT binary patch literal 8560 zcmeHtTXDa9cHid(P( zMT&EI=idAK5AMwU@P62{=d8VF?K98pv)1#hb>a>6!DPhD!~g(*39tI~N z_Jd_Q^+MxeBJzfqzX1S9_5L%kCPxwa4@NfMCuY7+y_|dlUivr!z=pbC19zHjV( zT)llc>R&T()v!m&d86_cTg(6_UzkT^|m%nNXiUj~jbzR&z z-j`%xPJSvA0sy&Xcmt*t>6h!iit6zIKtWK*g=vY+m1-Onz?QJcCV+z&|GBLmKuhWz=7$;c<#bJUH_?jvIbM9@gp1RP`U|kC=`nN_j z;SUFPE{+^lEl*aI7gjCvgJVdYI%bojO2_%}rvjRx777ezy}n@>qmiSA^;v(FN~sSU z;i&YNV&YQ)+2g@P z;1%nhLCs|kvFqaJ=;8RnKW_QW81dB zkA3LR0{!^(>tXTPKe{ZfoTrf zJlcKu%%#28?M&XzK{!Fox+|+>_tV=cK`Mt;Fg!v{`*cwEXLAPd(m3rbOpYmk)y%TS z6d{=)iT;b8#X@z`=eRS?BAvNDfg4ufs)MtIU9GN54kax;pY*wTFpQAKRp2c_T(sp8~=?`0VJ2IKn^UkCzE(2nBJo zAYjx0&bNtYjpip@pFKtoiE_|7C7kd2j!ZWpgs!-3#(J;_h+Ww-?~FnCxsPQ`;su>gxq4Y^b3}2z7U3{_3rSmy2S1TuX1di;>Vq}nN`yR`sS2h zDsW)j&5vu{K%qdNO;uQa3gTUs?ySo8W&#vJ;Kx{`? z^ZPhh$p-5jefCwn)51;LNPWq1X|#=wns?+U-bTP8$?S-g60?)wm>A{-jX8)aNh02X z8`E@muesoK4SUy(M=vepcaKf_lNwhjGash8MakOPaSedxEPMf(+W_yZv%p^I)s`1$ z&Rip=UW(1SxVVgZSE*8smkDLFmYO~?b$m1z%QwR(>2R_=wtQZ6e>v8@r5#RR4Bn?@ z1S4EZK`fsr81d#&uUzf88_va>74i#rj%)!JYS$KANPXY0C7G?%-Wa?dPVCZ%ZrQ?^ zLgopxXmwl%Y-OSCUzYv|mEJ}gVLCEN-@%s=mzP#&=BCtixP>o8kRZ@ zpI$|i?Bh^{;!qDpgKh);>n!3q^Zwa!J}+?syfkFig^FGIO8v~#<4*|JwGWYYai2n;#XUK7tFp&uHc2ZCa4woY5ch@h%o_3Ld1&QqoEYl!B1qE}Sj@aQI zq>Ob~#EhjVWk;Bs@+-+b!&$RSO(_;dI%IP=YFcZ!`Sa6k$nB1)$n~yKpC8$+=j^B& zS!r8}pL*2eqVA&UO)E!EUFApn#&-@u0|$dL+{5%O6JjOLhZfV zQxaL{ar~I~NGcPQC#7|m7#9=#RMr8(F;_gx~wj~xGQ-i9^o4V}G0 zrQ?xua9xBQQ$pvTrF=lK8BIHsA=xu@$IA}Q|9D6|1hK>1@-1Rplz26NM?Je>j1ipd zW$q8)zulO(g40~VdY{O){-uu1!lX%*d54%7_idhgNn2FQm6Gd}8TYbve_#JZDR*wryB1p+z0<`qe3HdZFAep7a@IebjM|k4JHQJb(86MXBh9l z5i&sNP|XvMe#rC{w`7iJU#v(4Se=)6mhutw>K}}vMQTe}xtdY1R*XC5$!T02=*~Ja zUE+xYNx|jr0*` zPmm=_WDm?}+%^>6tCr~BXKsUBUQkf2k=(oD#wepH2Zi6oJgpw3>#2KbY#M%fQqIPLdAgNVIC4n6-OoP#X&eD{BGz*YVLI?Rrssql~j6>eiI@f zw5hMQR?o~Q6po|JJxa4te@GsL-G7<|WV_9{sq?f`aB8ccxORD8&_{V%F5=`BK6xSZ z(oWlSg)<-&zG5Mrtlm6=qc1XS;h&O6=o{LdO5W7St`gU$!|+&p_y9@oYrd5JYpSfT ze=%dbW5z+BaB;&viPHFl{Z-jUp7G_IDgtg|?OGo)czGcXe$zo2(%9-w@n^$&FAPX; zh{;dqqpS&?Jyr7+gpM3e45XVx=g*NU6N~<-=N zdIaVBC7VMc@qj}t-pl9Rj>tgny*L zQu;4BZnBe0pOAK2TBu&l(*+^;s(0xEwq@nP{u4KVvJiN0^reCC_UHHr(#X-lnKE0v zOd83@`{xQR6ePUZnyEG5SAS_e{fr*@HsM}NF{La#e)C@?c4$d(DYW0cd-R27dKO(+s0uPkXeQl#7|`>COv% zIB9-xl1J0j-6aSbrH(7BZWunuEJ&p!=J!iPA2UqoubIluB*ZdWezqW**H6@^)Dr_a zM(rY4xU5+Qrkmp^BlS{C!7;xY61N+}P@u7LzjK!t%1sF8d~2F9igN zV9z*dVlSY|wi8D=8jXMITOf zV32BHc&_(XYdN{(X_a&M$xMqM0W*-`-W(T4t0DSwd@J#`>P^py!h)HS?iaiMzbPntF`jej4@)u707Sbrx=E1sWfDE^>?VDetjLN&VtZZQ# zj-v*R{0+_}o$j||o=@$6=|=jy3$W_eGO0Eu-LE9rk@vVszaOi=Uhks_7)fo7R(vdp zi1sL`{w@7)`U}>%(byoBBi!=O;|OSp8FXx$=7l^a6IEzeZrYMUz9UNp$fo6w`h%9y zGWA(zz3wNGoy_1}NPo~ZT{-;t7;biR*J^pRHRL>-(Q;>Zw2l+xJVqc2G-)58)0E!LF--1sLxQq+*b6#}a?< zclxn0uOfAG0f5d4gKg+)_LxC5uF8{C9`S+C7R=EZXt&Hv7tR~vo z5Mg9WZhA{D-t9^)p!KAgc>X6QGnbVq*NvDwj*6;GJJ#S0`Ud>zT|Cm6m96#NCNn5Q zp?NdDPVcmZZXnG&$ic}>JuxsM^uw>CmL36>+$LW;@n(l`#_2D_MRjN=6k0b5X1$bR z-#A|OP3#Cnj_2sn@0s9_EVg74JLJ{DkNnCgtLi|Lg>c%n?8bNE9L@u!Egbv9s+4uomZ}hZ@Iv=N&7tWQN6Z>4N{TKd%h+YSE)1RuYSO^1 zEhldLlWl4#oi@(=?K6NjtnoR5Dh&~W2Rty)SF@OG{4BqouVU9@W*}EW^(=lyE{jH{ z1hXN(Nc0cL?BPzfamut&@C~2-T-rvmq9>Z5v#R>yZ&>$5VR9AEDE+m;@Zl+)0^t%~ z0sN%lwe%lM%ThFI^4{VF;UK8v{;Ej%QTruIN=oeTPri-*3z^{CKr)(hIySllN10HD z^QEhf>=~8!tEYgs0EAwj3P#ts0zrMUFjw)R{pNJg3~D1$FoPBi_PTvRI?Ge}@q9}X zbO@C3(#$J?a`;XueJG=xY-tX!jh(!fc0;XNE7r_`Uj<7{?i&))oT(FloMy^`7P{4P zYxyn52^J+PFGjfYw!bK)qj?`mvHh|8#!mN*_+mJND&Gr4d&5tz`%dG5Ka+rNr8V!c0*j=dX7!aEr>J0Rj7z}=v%{#2bHvo; zFN0JxvG7Y@0SrEv!}ntbZsWD){QqXi+0C4bO%ku^!A|rz6}S$Q@?oHmiM)Z&1*2as zX8XkpNq|IzAlPFiHw|t`T8yM~-6DC0JYGbh!`=fSZZHb6zcyQMqUf3afCiHd#2x#& z{r(NYw$&oOZQ(O1&=gx~!HT3!Az6>GPqnD&U{qKpq`_On0|2N~*~dh2B7ursbVMDE z3QDz!lSq)o)0AfpeCew?RY|;+6TKCteyho4&hW5UrukH9zDPuuv*KB1`+NbO z=({ZD;H`u4ank_V3H=8=>n*)svkA>;RBo%F%-`2w<;5VtNZ;@sGr(4Kwk?GfNbvcg z4x`c?i1>=0cEq!kM>{J+C>_Lh=m0gKNO+<4G^3rk5uWr7hN&Gpr)R$jCw$m?BN2TQ#@bh`vHL=HPi9Kqp z>Lv1S`pzF?MA>Bu5yFY4yyKaLcEGAoy#SN5WqaJuN>5o;*BF8MsIHi?i+w^b8_lUZ z(1k{(O2l{TgIhp^m7RZTL-}b6-*Q^#Jc^w|-&_%;AB8oto#-Sd}eK5 zHU(+ckj?qGY-fbl3wDF>@~nV10?o+oS*gbx&SJ75NCiok%^4C*GRy&o#+59;I4~UQ zqg8a3TPnBPN6z0TOW>Uc=~7}M4O0l9W$kwI5*axiSGENc|7XCI6$p+*>8#xUK)%DoTL7o^wp3th5XRYn-jW^BNeoE=F+@qn-4} zdDacbLeE?@X`s&*XgFk&Jo_8-l1t<@JBiZ{px(u`6Q;}YBzFQGr(Lk}@$+s`{kPYt zzn8LQ8`_MoilvBUU!Yf4ybl?0*C%>9@ zNrkHGBf%=I?0DOpAtCY}9vsz=I$J{t{k6uFc|*m4@r3>I#(CFn}$(X{0WiA+?LVg!LkoL-b`2Ba5P4; zGlm_JSk2BjZu@j4q~aaX=Ds}xZD;;!{iCSE`j=KST;`fJQ5cI@AAK4tGse4lEww}e z47bpq(j*POzkkE{=^xTSiI@SiN)zoFE+kq2Y6W|{Rj8S*NRQhuAaMqxoXyb58~5i$ zW77y4je4M}94odH)ZsvS7tZ;qA|*l;4rWG5BX z9EP`v%-7)x%Rc`tJoQ6V`n+E)_+GBJ&XZQK$}`8b*?Syf~(o~7-=gaQ};SpUAL*`_h=G!wUTsp z1-}eWU&sk8WZ#m+$=H3A&8|o({A{AZ*woF{eHC+;cYYFYMn$t1Lvv0@yY=60PX(!FzP48xtuwyiCBNdkPURr-nx_0BC zq}0{zkEX?J4}7(`_TTT@$JynG6b$km6^;I4TY~@2Dn`&@XC3trm3WM?^%DEw%U6H} zJL*6N0L1nidydeqB_&K}Oflb)Wk7nmivePQg>5g;H&?C;!x)KtTigFD=U+GSHS0|> z#gfh@uSGBOZ@Nh_q7CjN#6>@x4ge4Uz;FSn8WiD4E!7=CYc(c;pgXcInRXql>O!ZLVFoY)WF_Mk+Q(KSlpg{n{$nzGy@& zQ57gDf#kZy5$Wq`v%9&tTghBOI^lOjQ@itW?>yHwH;S;`n7ngWjExL}pPQ0S@mK~- zF0t+x!|c+TjAbXs@ZNA8As(c|AcrsutJ6zazAylQ-q!4~>Vuh3wky=l9_hl5zz(n*5!L4ShiIJK!49xC#I;4g#(P zCOQ-skJ~Rma<2--}+F~#OAgGoC02udNw6H->%k%;o z9;v`_jB=nnLN#ecD*OMltH)*`8JQNgGjsReU_0{nZH!Hb*(>`Nl&BP zdSC2xn)CalezChBA>Do`#+8^n>WGnV;cZPYs}@D=`Ob`qwXM83qRZ92x^&Zj5!$&( zo$iAUZqncQF{GQ@V15=9)NNDu{G{r3VcG6E#XS@hp9{Y5%i@LI07c8}qvW9v;@sm{fy^td_j4+7&cY<0{A+J?o zu{6D*ArN|(o+EAFMBL+>|G~J(=GX4XdSB#X!g-7BtFx3I(V$XcEa|VKxmcU|?_P}d z2HYL5PA}MKIuDYMm$BH!X4LYk(S}kT^Nh1XsNdQBgp`q(6OlY8dTTwJbSv}3doDtc z##wJY>)XdAd~DaV($f5?i+abSg76UeTfgpQgDNKz>^N+W7?tAu9Uu}D*4_3GrPBQ; zg@WY#w`=mLX!JZT0N_C+GF4M0 z(D4L7pXh_?G;E{d|6lh^ar*yH&vaS>3&2U*Bi_@!eY_IM9v@}BDAfeO9z6s^45UO5 qt6~e?5Pm%3DgOT7hyP;m-+S=?*S8=lMT4j8#NYm(e=GhccKk2sYU@S- literal 0 HcmV?d00001 diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 5833484ee4..9fcc61a4b0 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -619,7 +619,8 @@ INPUT = index.doc \ bindings.doc \ options.doc \ tracing.doc \ - use.doc \ + platform.doc \ + use.doc \ pls.doc \ ./index-API.doc \ modules.doc \ diff --git a/doc/platform.doc b/doc/platform.doc new file mode 100644 index 0000000000..5a327ef918 --- /dev/null +++ b/doc/platform.doc @@ -0,0 +1,774 @@ +/*! \page platform Platform description + +\htmlinclude .platform.doc.toc + +In order to run any simulation, SimGrid needs 3 things: something to run +(so, your code), a description of the platform on which you want to run your +application, and finally it needs something to know where to deploy what. + +For the latest 2 entries, you have basically 2 ways to give it as an input : +\li You can program it, either using the Lua console or if you're using MSG some +of its platform and deployments functions. If you want to use it, please refer +to its doc. +\li You can use two XML files: a platform description file and a deployment +description one. + +As the second one (deployment description) just consists of saying which +process runs where and which arguments it should take as input, the easier way to +understand how to write it is just to take a look at the examples. Here is an example of it: + +\verbatim + + + + + + + + + + + + + + + + + + + + + +\endverbatim + +The platform description is slightly more complicated. This documentation is all about how to write this file: what are the basic concept it relies on, what possibilities are offered, and some hints and tips on how to write a good platform description. + +\section pf_overview Some words about XML and DTD + +We choose to use XML because of some of its possibilities: if you're +using an accurate XML editor, or simply using any XML plug-in for eclipse, it +will allow you to have cool stuff like auto-completion, validation and checking, +so all syntaxic errors may be avoided this way. + +the XML checking is done based on the dtd which is nowaday online at +http://simgrid.gforge.inria.fr/simgrid.dtd +while you might be tempted to read it, it will not help you that much. + +If you read it, you should notice two or three important things : +\li The platform tags contains a version attributes. At the time of writing this doc +the current version is 3. +\li The DTD contains definitions for the 2 files used by SimGrid (platform +description and deployment). +\li There is a bunch of possibilities ! Let's see what's in it + + +\section pf_basics Basic concepts + +Nowadays, the Internet is composed of a bunch of independently managed networks. Within each of those networks, there are entry and exit points (most of the time, you can both enter and exit through the same point) that allows to go out of the current network and reach other networks. At the upper level, these networks are known as Autonomous System (AS), while at the lower level they are named sub-networks, or LAN. Indeed they are autonomous: routing is defined within the limits of his network by the administrator, and so, those networks can continue to operate without the existence of other networks. There are some rules to get out of networks by the entry points (or gateways). Those gateways allow you to go from a network to another one. Inside of each autonomous system, there is a bunch of equipments (cables, routers, switches, computers) that belong to the autonomous system owner. + +SimGrid platform description file relies exactly on the same concepts as real life platform. Every resource (computers, network equipments, and so on) belongs to an AS. Within this AS, you can define the routing you want between its elements (that's done with the routing model attribute and eventually with some \ tag). You define AS by using ... well ... the \ tag. An AS can also contain some AS : AS allows you to define the hierarchy of your platform. + +Within each AS, you basically have the following type of resources: +\li host: an host, with cores in it, and so on +\li router: a router or a gateway. +\li link: a link, that defines a connection between two (or more) resources (and have a bandwidth and a latency) +\li cluster: like a real cluster, contains many hosts interconnected by some dedicated network. + +Between those elements, a routing has to be defined. As the AS is supposed to be Autonomous, this has to be done at the AS level. As AS handles two different types of entities (host/router and AS) you will have to define routes between those elements. A network model have to be provided for AS, but you may/will need, depending of the network model, or because you want to bypass the default beahviour to defines routes manually. There are 3 tags to use : +\li ASroute: to define routes between two AS +\li route: to define routes between two host/router +\li bypassRoute: to define routes between two AS that will bypass default routing. + +Here is an illustration of the overall concepts: + +\htmlonly + +
+\endhtmlonly + Circles represent processing units and squares represent network routers. Bold + lines represent communication links. AS2 models the core of a national + network interconnecting a small flat cluster (AS4) and a larger + hierarchical cluster (AS5), a subset of a LAN (AS6), and a set of peers + scattered around the world (AS7). + + +This is all for the concepts ! To make a long story short, a SimGrid platform is made of a hierarchy of AS, each of them containing resources, and routing is defined at AS level. Let's have a deeper look in the tags. + + + +\section pf_pftags Describing resources and their organization + +\subsection pf_As Platform organization tag : AS + +AS (or Autonomous System) is an organizational unit that contains resources and defines routing between them, and eventually some other AS. So it allows you to define a hierarchy into your platform. *ANY* resource *MUST* belong to an AS. There are a few attributes. + +AS attributes : +\li name (mandatory): the identifier of AS to be used when referring to it. +\li routing (mandatory): the routing model used into it. By model we mean the internal way the simulator will manage routing. That also have a big impact on how many information you'll have to provide to help the simulator to route between the AS elements. routing possible values are Full, Floyd, Dijkstra, DijkstraCache, none, RuleBased, Vivaldi, Cluster. For more explanation about what to choose, take a look at the section devoted to it below. + +Elements into an AS are basically resources (computers, network equipments) and some routing informations if necessary (see below for more explanation). + +AS example +\verbatim + + + + + + +\endverbatim + + +In this example, AS0 contains two hosts (host1 and host2). The route between the hosts goes through link1. +\subsection pf_Cr Computing resources: hosts, clusters and peers. + +\subsubsection pf_host host +A host represents a computer, where you will be able to execute code and from which you can send and receive information. A host can contain more than 1 core. Here are the attributes of a host : + + +host attributes : +\li id (mandatory): the identifier of the host to be used when referring to it. +\li power (mandatory):the peak number FLOPS the CPU can manage. Expressed in flop/s. +\li core: The number of core of this host. If setted, the power gives the power of one core. +\li availability: specify if the percentage of power available. +\li availability_file: Allow you to use a file as input. This file will contain availability traces for this computer. The syntax of this file is defined below. Possible values : absolute or relative path, syntax similar to the one in use on your system. +\li state: the computer state, as in : is that computer ON or OFF. Possible values : "ON" or "OFF". +\li state_file: Same mechanism as availability_file, similar syntax for value. +\li coordinates: you'll have to give it if you choose the vivaldi, coordinate-based routing model for the AS the host belongs to. More details about it in the P2P coordinate based section. + +An host can also contain the prop tag. the prop tag allows you to define additional informations 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. + +host example +\verbatim + + + + + +\endverbatim + + +Expressing dynamicity. +It is also possible to seamlessly declare a host whose +availability changes over time using the availability_file +attribute and a separate text file whose syntax is exemplified below. + +Adding a trace file +\verbatim + + + +\endverbatim +Example of "bob.trace" file +\verbatim +PERIODICITY 1.0 + 0.0 1.0 + 11.0 0.5 + 20.0 0.8 +\endverbatim + +At time 0, our host will deliver 500~Mflop/s. At time 11.0, it will +deliver half, that is 250~Mflop/s until time 20.0 where it will +will start delivering 80\% of its power, that is 400~Mflop/s. Last, at +time 21.0 (20.0 plus the periodicity 1.0), we loop back to the +beginning and the host will deliver again 500~Mflop/s. + +Changing initial state + +It is also possible to specify whether the host +is up or down by setting the state attribute to either ON +(default value) or OFF. + +Expliciting the default value "ON" +\verbatim + + + +\endverbatim +Host switched off +\verbatim + + + +\endverbatim +Expressing churn +To express the fact that a host can change state over time (as in P2P +systems, for instance), it is possible to use a file describing the time +at which the host is turned on or off. An example of the content +of such a file is presented below. +Adding a state file + \verbatim + + + + \endverbatim +Example of "bob.fail" file +\verbatim + PERIODICITY 10.0 + 1.0 -1.0 + 2.0 1.0 +\endverbatim + +A negative value means down while a positive one means up and + running. From time 0.0 to time 1.0, the host is on. At time 1.0, it is +turned off and at time 2.0, it is turned on again until time 12 (2.0 plus the +periodicity 10.0). It will be turned on again at time 13.0 until time 23.0, and +so on. + + + +\subsubsection pf_cluster cluster +A cluster represents a cluster. It is most of the time used when you want to have a bunch of machine defined quickly. It must be noted that cluster is meta-tag : from the inner SimGrid point of view, a cluster is an AS where some optimized routing is defined . The default inner organisation of the cluster is as follow : +\verbatim + _________ + | | + | router | + ____________|__________|_____________ backbone + | | | | | | + l0| l1| l2| l97| l96 | | l99 + | | | ........ | | | + | | + c-0.me c-99.me +\endverbatim + +You have a set of host defined. Each of them has a link to a central backbone (backbone is a link itsef, as a link can be used to represent a switch, see the switch or link section below for more details about it). A router gives a way to the cluster to be connected to the outside world. Internally, cluster is then an AS containing all hosts : the router is the default gateway for the cluster. + +There is an alternative organization, which is as follow : +\verbatim + _________ + | | + | router | + |__________| + / | \ + / | \ + l0 / l1| \l2 + / | \ + / | \ + host0 host1 host2 +\endverbatim + +The principle is the same, except we don't have the backbone. The way to obtain it is simple : you just have to let bb_* attributes unsetted. + + + +cluster attributes : +\li id (mandatory): the identifier of the cluster to be used when referring to it. +\li prefix (mandatory): each node of the cluster has to have a name. This is its prefix. +\li suffix (mandatory): node suffix name. +\li radical (mandatory): regexp used to generate cluster nodes name. Syntax is quite common, "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. +\li power (mandatory): same as host power. +\li core: same as host core. +\li bw (mandatory): bandwidth for the links between nodes and backbone (if any). See link section for syntax/details. +\li lat (mandatory): latency for the links between nodes and backbone (if any). See link section for syntax/details. +\li sharing_policy: sharing policy for the links between nodes and backbone (if any). See link section for syntax/details. +\li bb_bw : bandwidth for backbone (if any). See link section for syntax/details. If both bb_* attributes are ommited, no backbone is create (alternative cluster architecture described before). +\li bb_lat : latency for backbone (if any). See link section for syntax/details. If both bb_* attributes are ommited, no backbone is create (alternative cluster architecture described before). +\li bb_sharing_policy: sharing policy for the backbone (if any). See link section for syntax/details. +\li availability_file: Allow you to use a file as input for availability. Similar to hosts attribute. +\li state_file: Allow you to use a file as input for states. Similar to hosts attribute. + +the router name is defined as the resulting String in the following java line of code: router_name = prefix + "router_ + suffix ; + + +cluster example +\verbatim + + +\endverbatim + +\subsubsection pf_peer peer +A peer represents a peer, as in Peer-to-Peer (P2P). Basically, as cluster, A PEER IS INTERNALLY INTERPRETED AS AN \. It's just a kind of shortcut that does the following : +\li It creates an host that has coordinates +\li Two links : one for download and one for upload. This is convenient to use and simulate stuff under the last mile model (as ADSL peers). + +peer attributes : +\li id (mandatory): the identifier of the peer to be used when referring to it. +\li power CDATA (mandatory): +\li bw_in CDATA (mandatory): +\li bw_out CDATA (mandatory): +\li lat CDATA (mandatory): +\li coordinates: +\li sharing_policy: sharing policy for links. Can be SHARED or FULLDUPLEX, FULLDUPLEX is the default. See link description for details. +\li availability_file: availability file for the peer. Same as host availability file. See host description for details. +\li state_file : state file for the peer. Same as host state file. See host description for details. + +\subsection pf_ne Network equipments: links and routers + +You have basically two entities available to represent network entities : +\li link: represents something that has a limited bandwidth, a latency, and that can be shared according to TCP way to share this bandwidth. LINKS ARE NOT EDGES BUT HYPEREDGES: it means that you can have more than 2 equipments connected to it. +\li router: represents something that one message can be routed to, but does not accept any code, nor have any influence on the performances (no bandwidth, no latency, not anything).ROUTERS ARE ENTITIES (ALMOST) IGNORED BY THE SIMULATOR WHEN THE SIMULATION HAS BEGUN. If you want to represent something like a switch, you must use link (see section below). Routers are used in order to run some routing algorithm and determine routes (see routing section for details). + +let's see deeper what those entities hide. + +\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 : + +router attributes : +\li id (mandatory): the identifier of the router to be used when referring to it. +\li coordinates: you'll have to give it if you choose the vivaldi, coordinate-based routing model for the AS the host belongs to. More details about it in the P2P coordinates based section. + + +router example +\verbatim + +\endverbatim + +\subsubsection pf_link link +Network links can represent one-hop network connections. They are characterized by their id and their bandwidth. +The latency is optional with a default value of 0.0. For instance, we can declare a network link named link1 +having bandwidth of 1Gb/s and a latency of 50µs. +Example link: +\verbatim + +\endverbatim +Expressing sharing policy + +By default a network link is SHARED, that is if more than one flow go through +a link, each gets a share of the available bandwidth similar to the share TCP connections offers. + +Conversely if a link is defined as a FATPIPE, each flow going through this link will get all the available bandwidth, whatever the number of flows. The FATPIPE +behavior allows to describe big backbones that won't affect performances (except latency). Finally a link can be considered as FULLDUPLEX, XXX? + +\verbatim + +\endverbatim + +Expressing dynamicity and failures + + As for hosts, it is possible to declare links whose state, bandwidth or latency change over the time. In this case, the bandwidth and latency attributes are respectively replaced by the bandwidth file and latency file attributes and the corresponding text files. + +\verbatim + +\endverbatim + +It has to be noted that even if the syntax is the same, the semantic of bandwidth and latency trace files +differs from that of host availability files. Those files do not express availability as a fraction of the available +capacity but directly in bytes per seconds for the bandwidth and in seconds for the latency. This is because +most tools allowing to capture traces on real platforms (such as NWS ) express their results this way. + +Example of "link1.bw" file +\verbatim + +1 PERIODICITY 12.0 +2 4.0 40000000 +3 8.0 60000000 +\endverbatim +Example of "link1.lat" file +\verbatim + 1 PERIODICITY 5.0 +2 1.0 0.001 +3 2.0 0.01 +4 3.0 0.001 +\endverbatim +In this example, the bandwidth varies with a period of 12 seconds while the latency varies with a period of +5 seconds. At the beginning of simulation, the link’s bandwidth is of 80,000,000 B/s (i.e., 80 Mb/s). After four +seconds, it drops at 40 Mb/s, and climbs back to 60 Mb/s after eight seconds. It keeps that way until second +12 (ie, until the end of the period), point at which it loops its behavior (seconds 12-16 will experience 80 Mb/s, +16-20 40 Mb/s and so on). In the same time, the latency values are 100µs (initial value) on the [0, 1[ time +interval, 1ms on [1, 2[, 10ms on [2, 3[, 1ms on [3,5[ (i.e., until the end of period). It then loops back, starting +at 100µs for one second. + +link attributes : +\li id (mandatory): the identifier of the cluster to be used when referring to it. +\li bandwidth (mandatory): bandwidth for the link. +\li lat (mandatory): latency for the link. +\li sharing_policy: sharing policy for the link. +\li state: Allow you to to set link as ON or OFF. Default is ON. +\li bandwidth_file: Allow you to use a file as input for bandwidth. +\li latency_file: Allow you to use a file as input for latency. +\li state_file: Allow you to use a file as input for states. + +As an host, a link tag can also contain the prop tag. + +link example +\verbatim + +\endverbatim + + +\subsection pf_storage Storage + +At the time of writing this doc, a storage protoype has been implemented. While it is not stable, no doc for it, sorry. + +\section pf_routing Routing + +In order to run fast, it has been chosen to use static routing within SimGrid. By static, it means that it is calculated once, and will not change during execution. We chose to do that because it is rare to have a real deficience of a resource ; most of the time, a communication fails because the links are too overloaded, and so your connection stops before the time out, or because the computer at the other end is not answering. + +We also chose to use shortests paths algorithms in order to emulate routing. Doing so is consistent with the reality: RIP, OSPF, BGP are all calculating shortest paths. They have some convergence time, but at the end, so when the platform is stable (and this should be the moment you want to simulate something using SimGrid) your packets will follow the shortest paths. + +\subsection pf_rm Routing models + +Within each AS, you have to define a routing model to use. You have basically 3 main kind of routing models : +\li Shortest-path based models: you let SimGrid calculates shortest paths and manage it. Behaves more or less as most real life routing. +\li Manually-entered route models: you'll have to define all routes manually by yourself into the platform description file. Consistent with some manually managed real life routing. +\li Simple/fast models: those models offers fast, low memory routing algorithms. You should consider to use it if you can make some assumptions about your AS. Routing in this case is more or less ignored + +\subsubsection pf_raf The router affair + +Expressing routers becomes mandatory when using shortest-path based models or when using ns-3 or the bindings to the GTNetS packet-level simulator instead of the native analytical network model implemented in SimGrid. + +For graph-based shortest path algorithms, routers are mandatory, because both algorithms need a graph, and so we need to have source and destination for each edge. + +Routers are naturally an important concept in GTNetS or ns-3 since the way they run the packet routing algorithms is actually simulated. Instead, the +SimGrid’s analytical models aggregate the routing time with the transfer time. +Rebuilding a graph representation only from the route information turns to be a very difficult task, because +of the missing information about how routes intersect. That is why we introduced a \ tag, which is +simply used to express these intersection points. The only attribute accepted by this tag an id. +It is important to understand that the \ tag is only used to provide topological information. + +To express those topological information, some route have to be defined saying which link is between which routers. Description or the route syntax is given below, as well as example for the different models. + +\subsubsection pf_rm_sh Shortest-path based models + +Here is the complete list of such models, that computes routes using classic shortest-paths algorithms. How to choose the best suited algorithm is discussed later in the section devoted to it. +\li Floyd: Floyd routing data +\li Dijkstra: Dijkstra routing data +\li DijkstraCache: Dijkstra routing data + +Floyd example : +\verbatim + + + + + + + + + + + + + + + +\endverbatim +ASroute given at the end gives a topological information : link1 is between router1 and host1. + + +Dijsktra example : +\verbatim +XXX? +\endverbatim + +DijsktraCache example : +\verbatim +XXX? +\endverbatim + +\subsubsection pf_rm_sh Manually-entered route models + +\li Full: You have to enter all necessary routes manually +\li RuleBased: Rule-Based routing data; same as Full except you can use regexp to express route. As SimGrid has to evaluate the regexp, it's slower than Full, but requires less memory. Regexp syntax is similar as pcre ones, as this is the lib SimGrid use to do so. + +Full example : +\verbatim + + + + + + +\endverbatim + +RuleBased example : +\verbatim + + + + + + + + + + + + + + + + + + + + + + + + + + +\endverbatim + +The example upper contains $1. Those $1 are evaluated as follow XXX? + +\subsubsection pf_rm_sh Simple/fast models + +\li none: No routing (usable with Constant network only) +None Example : +\verbatim +XXX? +\endverbatim + +\li Vivaldi: Vivaldi routing, so when you want to use coordinates. See the corresponding section P2P below for details. +\li Cluster: Cluster routing, specific to cluster tag, should not be used, except internally. + +\subsection pf_asro ASroute + +ASroute tag purpose is to let people write manually their routes between AS. It's usefull when you're in Full or Rule-based model. + +ASroute attributes : +\li src (mandatory): the source AS id. +\li dst (mandatory): the destination AS id. +\li gw_src (mandatory): the gateway to be used within the AS. Can be any host or \b router defined into the \b src AS or into one of the AS it includes. +\li gw_dst (mandatory): the gateway to be used within the AS. Can be any host or \b router defined into the \b dst AS or into one of the AS it includes. +\li symmetrical: if the route is symmetric, the reverse route will be the opposite of the one defined. Can be either YES or NO, default is YES. + +Example of ASroute with RuleBased +\verbatim + + + +\endverbatim +Example of ASroute with Full +\verbatim + + + + + + + + + + + + + + +\endverbatim + +\subsection pf_ro route +The principle is the same as ASroute : route contains list of links that are in the path between src and dst, except that it is for routes between a src that can be either host or \b router and a dst that can be either host or \b router. Usefull for Full and RuleBased, as well as for the shortest-paths based models, where you have to give topological informations. + + +route attributes : +\li src (mandatory): the source id. +\li dst (mandatory): the destination id. +\li symmetrical: if the route is symmetric, the reverse route will be the opposite of the one defined. Can be either YES or NO, default is YES. + +route example in Full +\verbatim + + + +\endverbatim + +route example in a shortest-path model +\verbatim + + + +\endverbatim +Note that when using route to give topological information, you have to give routes with one link only in it, as SimGrid needs to know which host are at the end of the link. + +\subsection pf_byro bypassRoute + +As said before, once you choose a model, it (if so) calculates routes for you. But maybe you want to define some of your routes, which will be specific. You may also want to bypass some routes defined in lower level AS at an upper stage : bypassRoute is the tag you're looking for. It allows to bypass routes defined between already defined between AS (if you want to bypass route for a specific host, you should just XXX?). The principle is the same as ASroute : bypassRoute contains list of links that are in the path between src and dst. + +bypassRoute attributes : +\li src (mandatory): the source AS id. +\li dst (mandatory): the destination AS id. +\li gw_src (mandatory): the gateway to be used within the AS. Can be any host or \b router defined into the \b src AS or into one of the AS it includes. +\li gw_dst (mandatory): the gateway to be used within the AS. Can be any host or \b router defined into the \b dst AS or into one of the AS it includes. +\li symmetrical: if the route is symmetric, the reverse route will be the opposite of the one defined. Can be either YES or NO, default is YES. + +bypassRoute Example +\verbatim + +\endverbatim + +\subsection pb_baroex Basic Routing Example + +Let's say you have an AS named AS_Big that contains two other AS, AS_1 and AS_2. If you want to make an host (h1) from AS_1 with another one (h2) from AS_2 and you did not have choosen to use some routing model that compute routes automatically, then you'll have to proceed as follow: +\li First, you have to ensure that a route is defined from h1 to the AS_1's exit gateway and from h2 to AS_2's exit gateway. +\li Then, you'll have to define a route between AS_1 to AS_2. As those AS are both resources belonging to AS_Big, then it has to be done at AS_big level. To define such a route, you have to give the source AS (AS_1), the destination AS (AS_2), and their respective gateway (as the route is effectively defined between those two entry/exit points). Elements of this route can only be elements belonging to AS_Big, so links and routers in this route should be defined inside AS_Big. + +As said before, there are mainly 2 tags for routing : +\li ASroute: to define routes between two AS +\li router: to define routes between two host/router + +As we are dealing with routes between AS, it means that those we'll have some definition at AS_Big level. Let consider AS_1 and AS_2 contains 1 host, 1 link and one router. + +\section pf_other_tags Tags not (directly) describing the platform + +There are 3 tags, that you can use inside a \ tag that are not describing the platform: +\li random: it allows you to define random generators you want to use for your simulation. +\li config: it allows you to pass some configuration stuff like, for example, the network model and so on. It follows the +\li include: simply allows you to include another file into the current one. + +\subsection pf_conf config +config attributes : +\li id (mandatory): the identifier of the config to be used when referring to it. + + +config tag only purpose is to include prop tags. Valid id are basically the same as the list of possible parameters you can use by command line, except that "/" are used for namespace definition. + + +config example +\verbatim + + + + + + + + + + + + + +... +\endverbatim + + +\subsection pf_rand random +Not yet in use XXX? + +\subsection pf_incl include +Not yet in use XXX? + +\section pf_hints Hints and tips, or how to write a platform efficiently + +Now you should know at least the syntax dans be able to create a platform. However, after having ourselves wrote some platforms, there are some best practices you should pay attention to in order to produce good platform and some choices you can make in order to have faster simulations. Here's some hints and tips, then. + +\subsection pf_as_h AS Hierarchy +The AS design allows SimGrid to go fast, because computing route is done only for the set of resources defined in this AS. If you're using only a big AS containing all resource with no AS into it and you're using Full model, then ... you'll loose all interest into it. On the other hand, designing a binary tree of AS with, at the lower level, only one host, then you'll also loose all the good AS hierarchy can give you. Remind you should always be "reasonable" in your platform definition when choosing the hierarchy. A good choice if you try to describe a real life platform is to follow the AS described in reality, since this kind og trade-off works well for real life platforms. + +\subsection pf_exit_as Exit AS: why and how +Users that have looked at some of our platforms may have notice a non-intuitive schema ... Something like that : + + +\verbatim + + + + + + + + + + + + + + + + + + + + + + + +\endverbatim + +In the AS_4, you have an exitAS_4 defined, containing only one router, and routes defined to that AS from all other AS (as cluster is only a shortcut for an AS, see cluster description for details). If there was an upper AS, it would define routes to and from AS_4 with the gateway router_4. It's just because, as we did not allowed (for performances issues) to have routes from an AS to a single host/router, you have to enclose your gateway, when you have AS included in your AS, within an AS to define routes to it. + + +\subsection pf_P2P_tags P2P or how to use coordinates +SimGrid allows you to use some coordinated-based system, like vivaldi, to describe a platform. The main concept is that you have some peers that are located somewhere: this is the function of the coordinates of the \ or \ tag. There's nothing complicated in using it, here is an example of it: + +\verbatim + + + + + + + + + + + ... + + + +\endverbatim + + +\subsection pf_wisely Choosing wisely the routing model to use + + +Choosing wisely the routing model to use can significantly fasten your simulation/save your time when writing the platform/save tremendeous disk space. Here is the list of available model and their characteristics (lookup : time to resolve a route): + +\li Full: Full routing data (fast, large memory requirements, fully expressive) +\li Floyd: Floyd routing data (slow initialization, fast lookup, lesser memory requirements, shortest path routing only) +\li Dijkstra: Dijkstra routing data (fast initialization, slow lookup, small memory requirements, shortest path routing only) +\li DijkstraCache: Dijkstra routing data (fast initialization, fast lookup, small memory requirements, shortest path routing only) +\li none: No routing (usable with Constant network only) +\li RuleBased: Rule-Based routing data (...) +\li Vivaldi: Vivaldi routing, so when you want to use coordinates +\li Cluster: Cluster routing, specific to cluster tag, should not be used. + + + +\subsection pf_switch Hey, I want to describe a switch but there is no switch tag ! + +Actually we did not include swith tag, ok. But when you're trying to simulate a switch, the only major impact it has when you're using fluid model (and SimGrid uses fluid model unless you activate GTNetS or ns-3 mode) is the impact of the upper limit of the switch motherboard speed that will eventually be reached if you're using intensively your switch. So, the switch impact is similar to a link one. That's why we are used to describe a switch using a link tag (as a link is not an edge by a hyperedge, you can connect more than 2 other links to it). + +*/ diff --git a/tools/doxygen/doxygen_postprocesser.pl b/tools/doxygen/doxygen_postprocesser.pl index 80e8fc93f4..fe7fc395f5 100755 --- a/tools/doxygen/doxygen_postprocesser.pl +++ b/tools/doxygen/doxygen_postprocesser.pl @@ -5,7 +5,7 @@ use strict; # Add here the pages of the documentation generated by a @page doxygen macro my @extra_files = qw(html/index.html html/pages.html html/modules.html html/annotated.html html/functions.html html/functions_vars.html index.php - html/GRAS_tut.html html/tracing.html html/install.html html/bindings.html + html/GRAS_tut.html html/tracing.html html/platform.html html/install.html html/bindings.html html/options.html html/use.html html/pls.html html/FAQ.html); # GRAS tutorial @@ -395,6 +395,7 @@ foreach my $file (@allfiles) { || $file =~ /^html\/install.*/ || $file =~ /^html\/options.*/ || $file =~ /^html\/tracing.*/ + || $file =~ /^html\/platform.*/ || $file =~ /^html\/bindings.*/ || $file =~ /^html\/pls.*/ || $file =~ /^html\/modules.*/ @@ -408,6 +409,7 @@ foreach my $file (@allfiles) { $tmp_buff .= '
  • Modules API
    • '."\n"; $tmp_buff .= '
  • Data Structures
    • '."\n"; $tmp_buff .= '
  • Options & configurations
    • '."\n"; + $tmp_buff .= '
  • Platform description
    • '."\n"; $tmp_buff .= '
  • Tracing Simulations
    • '."\n"; $tmp_buff .= '
  • Bindings
    • '."\n"; $tmp_buff .= '
  • Packet level simulation
    • '."\n"; -- 2.20.1