From 2cc20f1526f80e1c731e986a50c5b77fa7e223d8 Mon Sep 17 00:00:00 2001 From: Navarrop Date: Thu, 1 Sep 2011 12:54:15 +0200 Subject: [PATCH] Add pages for ns3 and gtnets. --- buildtools/Cmake/DefinePackages.cmake | 2 + doc/Doxyfile.in | 12 ++- doc/gtnets.doc | 125 ++++++++++++++++++++++++ doc/index.php.in | 3 +- doc/ns3.doc | 7 ++ doc/options.doc | 126 ------------------------- doc/use.doc | 2 +- src/gras/gras.c | 8 ++ tools/doxygen/doxygen_postprocesser.pl | 35 +++++-- 9 files changed, 177 insertions(+), 143 deletions(-) create mode 100644 doc/gtnets.doc create mode 100644 doc/ns3.doc diff --git a/buildtools/Cmake/DefinePackages.cmake b/buildtools/Cmake/DefinePackages.cmake index b9cb817a4d..544ddcebca 100644 --- a/buildtools/Cmake/DefinePackages.cmake +++ b/buildtools/Cmake/DefinePackages.cmake @@ -555,6 +555,8 @@ set(DOC_SOURCES doc/bindings.doc doc/options.doc doc/use.doc + doc/gtnets.doc + doc/ns3.doc doc/gtut-howto-design.doc doc/gtut-howto.doc doc/gtut-introduction.doc diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 434c9211bc..980ef7646d 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -34,13 +34,13 @@ PROJECT_NAME = SimGrid # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = +PROJECT_NUMBER = @release_version@ # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer # a quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = +PROJECT_BRIEF = "Scalable simulation of distributed systems" # With the PROJECT_LOGO tag one can specify an logo or icon that is # included in the documentation. The maximum height of the logo should not @@ -284,7 +284,7 @@ SUBGROUPING = YES # @ingroup) instead of on a separate page (for HTML and Man pages) or # section (for LaTeX and RTF). -INLINE_GROUPED_CLASSES = NO +#INLINE_GROUPED_CLASSES = NO # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # is documented as struct, union, or enum with the name of the typedef. So @@ -619,6 +619,8 @@ INPUT = index.doc \ FAQ.doc \ options.doc \ use.doc \ + gtnets.doc \ + ns3.doc \ contrib.doc \ publis.doc \ people.doc \ @@ -927,7 +929,7 @@ HTML_STYLESHEET = # files. In the HTML_STYLESHEET file, use the file name only. Also note that # the files will be copied as-is; there are no commands or markers available. -HTML_EXTRA_FILES = +#HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. # Doxygen will adjust the colors in the stylesheet and background images @@ -1278,7 +1280,7 @@ LATEX_HEADER = # the last chapter. If it is left blank doxygen will generate a # standard footer. Notice: only use this tag if you know what you are doing! -LATEX_FOOTER = +#LATEX_FOOTER = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # is prepared for conversion to pdf (using ps2pdf). The pdf file will diff --git a/doc/gtnets.doc b/doc/gtnets.doc new file mode 100644 index 0000000000..fbe6b0e73b --- /dev/null +++ b/doc/gtnets.doc @@ -0,0 +1,125 @@ +/*! \page gtnets SimGrid and GTNets + +\section gtnets_simgrid_configuration_gtnets Using GTNetS + +It is possible to use a packet-level network simulator +instead of the default flow-based simulation. You may want to use such +an approach if you have doubts about the validity of the default model +or if you want to perform some validation experiments. At the moment, +we support the GTNetS simulator (it is still rather experimental +though, so leave us a message if you play with it). + + +To enable GTNetS model inside SimGrid it is needed to patch the GTNetS simulator source code +and build/install it from scratch + + + - Download and enter the recent downloaded GTNetS directory + + \verbatim + svn checkout svn://scm.gforge.inria.fr/svn/simgrid/contrib/trunk/GTNetS/ + cd GTNetS + \endverbatim + + + - Use the following commands to unzip and patch GTNetS package to work within SimGrid. + + \verbatim + unzip gtnets-current.zip + tar zxvf gtnets-current-patch.tgz + cd gtnets-current + cat ../00*.patch | patch -p1 + \endverbatim + + - OPTIONALLY you can use a patch for itanium 64bit processor family. + + \verbatim + cat ../AMD64-FATAL-Removed-DUL_SIZE_DIFF-Added-fPIC-compillin.patch | patch -p1 + \endverbatim + + - Compile GTNetS + + Due to portability issues it is possible that GTNetS does not compile in your architecture. The patches furnished in SimGrid SVN repository are intended for use in Linux architecture only. Unfortunately, we do not have the time, the money, neither the manpower to guarantee GTNetS portability. We advice you to use one of GTNetS communication channel to get more help in compiling GTNetS. + + + \verbatim + ln -sf Makefile.linux Makefile + make depend + make debug + \endverbatim + + + - NOTE A lot of warnings are expected but the application should compile + just fine. If the makefile insists in compiling some QT libraries + please try a make clean before asking for help. + + + - To compile optimized version + + \verbatim + make opt + \endverbatim + + + - Installing GTNetS + + It is important to put the full path of your libgtsim-xxxx.so file when creating the symbolic link. Replace < userhome > by some path you have write access to. + + \verbatim + ln -sf //gtnets_current/libgtsim-debug.so //usr/lib/libgtnets.so + export LD_LIBRARY_PATH=$LD_LIBRARY_PATH://usr/lib/libgtnets.so + mkdir //usr/include/gtnets + cp -fr SRC/*.h //usr/include/gtnets + \endverbatim + + + - Enable GTNetS support in SimGrid + +In order to enable gtnets with simgrid you have to give where is gtnets. (path to \/lib and \/include) + + \verbatim + Since v3.4 (with cmake) + cmake . -Dgtnets_path=//usr + + Until v3.4 (with autotools) + ./configure --with-gtnets=//usr + \endverbatim + + - Once you have followed all the instructions for compiling and + installing successfully you can activate this feature at + runntime with the following options: + + \verbatim + Since v3.4 (with cmake) + cd simgrid + make + ctest -R gtnets + + Until v3.4 (with autotools) + cd simgrid/example/msg/ + make + make check + \endverbatim + + + - Or try the GTNetS model dogbone example with + + \verbatim + gtnets/gtnets gtnets/onelink-p.xml gtnets/onelink-d.xml --cfg=network_model:GTNets + \endverbatim + + + A long version of this HowTo it is available + + + More about GTNetS simulator at GTNetS Website + + + - DISCLAIMER + The patches provided by us worked successfully with GTNetS found + here, + dated from 12th June 2008. Due to the discontinuing development of + GTNetS it is impossible to precise a version number. We STRONGLY recommend you + to download and install the GTNetS version found in SimGrid repository as explained above. + +*/ \ No newline at end of file diff --git a/doc/index.php.in b/doc/index.php.in index a12483c548..1763ca7f55 100644 --- a/doc/index.php.in +++ b/doc/index.php.in @@ -15,7 +15,8 @@ echo ''; - <?php echo $project_name; ?> + SimGrid - Scalable simulation of distributed systems, ranging from grids to peer-to-peer systems +