From ab58b73b7285977eed3f26385041ee5405c6e4e5 Mon Sep 17 00:00:00 2001 From: Navarrop Date: Wed, 21 Sep 2011 16:45:46 +0200 Subject: [PATCH] Remove gtnets and ns3 pages for one: Packet level simulation. --- buildtools/Cmake/DefinePackages.cmake | 3 +- buildtools/Cmake/GenerateDoc.cmake | 2 +- doc/Doxyfile.in | 3 +- doc/gtnets.doc | 125 -------------- doc/ns3.doc | 109 ------------ doc/pls.doc | 223 +++++++++++++++++++++++++ tools/doxygen/doxygen_postprocesser.pl | 10 +- 7 files changed, 230 insertions(+), 245 deletions(-) delete mode 100644 doc/gtnets.doc delete mode 100644 doc/ns3.doc create mode 100644 doc/pls.doc diff --git a/buildtools/Cmake/DefinePackages.cmake b/buildtools/Cmake/DefinePackages.cmake index 62b7b4ea34..ea1f093367 100644 --- a/buildtools/Cmake/DefinePackages.cmake +++ b/buildtools/Cmake/DefinePackages.cmake @@ -585,8 +585,7 @@ set(DOC_SOURCES doc/options.doc doc/use.doc doc/tracing.doc - doc/gtnets.doc - doc/ns3.doc + doc/pls.doc doc/gtut-howto-design.doc doc/gtut-howto.doc doc/gtut-introduction.doc diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index e26ccec600..2a5eed6836 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -92,7 +92,7 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV 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 index.doc gtut-introduction.doc installSimgrid.doc bindings.doc options.doc tracing.doc + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl pls.doc index.doc gtut-introduction.doc installSimgrid.doc bindings.doc options.doc tracing.doc COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass" COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 4932bb5aa1..c1dd9e6f7f 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -619,8 +619,7 @@ INPUT = index.doc \ options.doc \ tracing.doc \ use.doc \ - gtnets.doc \ - ns3.doc \ + pls.doc \ ./index-API.doc \ modules.doc \ module-xbt.doc \ diff --git a/doc/gtnets.doc b/doc/gtnets.doc deleted file mode 100644 index fbe6b0e73b..0000000000 --- a/doc/gtnets.doc +++ /dev/null @@ -1,125 +0,0 @@ -/*! \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/ns3.doc b/doc/ns3.doc deleted file mode 100644 index d37e74c708..0000000000 --- a/doc/ns3.doc +++ /dev/null @@ -1,109 +0,0 @@ -/*! \page ns3 SimGrid and NS3 - -\section ns3_simgrid_configuration_ns3 Using NS3 - -It is possible to use discrete-event network simulator (ns-3) for Internet systems -instead of the default one. - - -To use ns3 model inside SimGrid you have to install at least the version 3.10 of ns3 simulator. - - -- Download and enter the lateast release (here the 3.12.1) - -\verbatim -http://www.nsnam.org/release/ns-allinone-3.12.1.tar.bz2 -tar -xf ns-allinone-3.12.1.tar.bz2 -cd ns-allinone-3.12.1/ns-3.12.1/ -\endverbatim - -- Configure, make and install ns3 - -\verbatim -./waf configure --prefix="ns-3_install_directory" -./waf -./waf install -\endverbatim - -After install ns-3 you should have directories into your "ns-3_install_directory": - \li include/ns3/ - \li lib/ - \li bin/ (with 3.12) - -You also need to add to the LD_LIBRARY_PATH : "ns-3_install_directory/lib". - -- Enable ns-3 support on SimGrid - -In order to enable ns-3 with simgrid you have to give where is ns-3 to the simgrid configuration command. (path to \/lib and \/include) - -\verbatim -navarrop@caraja:~/workspace/simgrid/build$cmake . -Dns3_path= -\endverbatim - -With the output of the configuration you can see if ns-3 is detected by included the directory to flags. - -\verbatim -Configuration of package `simgrid' on arch (=4): - BUILDNAME : UNIX - SITE : Linux_2.6.38-11-generic_x86_64 - Release : simgrid-3.6.1 - - Compiler: c++ : /usr/bin/c++ - version: 4.6.1 - Compiler: c : /usr/bin/gcc - version: 4.6.1 - - CFlags : -O3 -finline-functions -funroll-loops -fno-strict-aliasing -L/usr/lib/x86_64-linux-gnu -I/usr/include - -L/home/navarrop/Install/ns3-3.10/lib -I/home/navarrop/Install/ns3-3.10/include -g3 -D_NS3_3_10 - CPPFlags: -I/home/navarrop/Install/ns3-3.10/include -L/home/navarrop/Install/ns3-3.10/lib - - Compile Gtnets : 0 - Compile NS-3 : 1 ---------------------> Be sure this option is "1" otherwise ns-3 is not activated - Gtnets path : - NS-3 path : /home/navarrop/Install/ns3-3.10 - Compile Lua : - Compile Smpi : OFF - Compile Static : OFF - Compile pcre : AUTO - - Maintainer mode: OFF - Supernovae mode: OFF - Model checking : OFF - Tracing mode : OFF - Jedule mode : OFF - Latency bound : OFF - Graphviz mode : - - Simgrid dependencies: -lm -lpcre -lpthread -lns3 -lrt - Gras dependencies : -lm -lpthread -lrt - Smpi dependencies : - - INSTALL_PREFIX: /usr/local --- Configuring done --- Generating done --- Build files have been written to: /home/navarrop/workspace/simgrid/build -\endverbatim - -Now you can compile SimGrid -\verbatim -navarrop@caraja:~/workspace/simgrid/build$make -\endverbatim - -Then you can see if ns-3 is well activated by testing -\verbatim -navarrop@caraja:~/workspace/simgrid/build$ctest -R ns3 -\endverbatim - -You should see -\verbatim - Start 182: msg-ns3-thread -1/3 Test #182: msg-ns3-thread ................... Passed 0.35 sec - Start 183: msg-ns3-ucontext -2/3 Test #183: msg-ns3-ucontext ................. Passed 0.22 sec - Start 184: msg-ns3-raw -3/3 Test #184: msg-ns3-raw ...................... Passed 0.23 sec -\endverbatim - -More about ns-3 simulator (Official website) - -*/ \ No newline at end of file diff --git a/doc/pls.doc b/doc/pls.doc new file mode 100644 index 0000000000..a6deac563c --- /dev/null +++ b/doc/pls.doc @@ -0,0 +1,223 @@ +/*! \page pls Packet level simulation + +\htmlinclude .pls.doc.toc + +\section pls_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 +cmake . -Denable_gtnets=ON -Dgtnets_path=//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 +cd simgrid +make +ctest -R gtnets +\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. + +\section pls_simgrid_configuration_ns3 Using NS3 + +It is possible to use discrete-event network simulator (ns-3) for Internet systems +instead of the default one. + + +To use ns3 model inside SimGrid you have to install at least the version 3.10 of ns3 simulator. + + +- Download and enter the lateast release (here the 3.12.1) + +\verbatim +http://www.nsnam.org/release/ns-allinone-3.12.1.tar.bz2 +tar -xf ns-allinone-3.12.1.tar.bz2 +cd ns-allinone-3.12.1/ns-3.12.1/ +\endverbatim + +- Configure, make and install ns3 + +\verbatim +./waf configure --prefix="ns-3_install_directory" +./waf +./waf install +\endverbatim + +After install ns-3 you should have directories into your "ns-3_install_directory": + \li include/ns3/ + \li lib/ + \li bin/ (with 3.12) + +You also need to add to the LD_LIBRARY_PATH : "ns-3_install_directory/lib". + +- Enable ns-3 support on SimGrid + +In order to enable ns-3 with simgrid you have to give where is ns-3 to the simgrid configuration command. (path to \/lib and \/include) + +\verbatim +cmake . -Denable_ns3=ON -Dns3_path= +\endverbatim + +With the output of the configuration you can see if ns-3 is detected by included the directory to flags. + +\verbatim +Configuration of package `simgrid' on arch (=4): + BUILDNAME : UNIX + SITE : Linux_2.6.38-11-generic_x86_64 + Release : simgrid-3.6.1 + + Compiler: c++ : /usr/bin/c++ + version: 4.6.1 + Compiler: c : /usr/bin/gcc + version: 4.6.1 + + CFlags : -O3 -finline-functions -funroll-loops -fno-strict-aliasing -L/usr/lib/x86_64-linux-gnu -I/usr/include + -L/home/navarrop/Install/ns3-3.10/lib -I/home/navarrop/Install/ns3-3.10/include -g3 -D_NS3_3_10 + CPPFlags: -I/home/navarrop/Install/ns3-3.10/include -L/home/navarrop/Install/ns3-3.10/lib + + Compile Gtnets : 0 + Compile NS-3 : 1 ---------------------> Be sure this option is "1" otherwise ns-3 is not activated + Gtnets path : + NS-3 path : /home/navarrop/Install/ns3-3.10 + Compile Lua : + Compile Smpi : OFF + Compile Static : OFF + Compile pcre : AUTO + + Maintainer mode: OFF + Supernovae mode: OFF + Model checking : OFF + Tracing mode : OFF + Jedule mode : OFF + Latency bound : OFF + Graphviz mode : + + Simgrid dependencies: -lm -lpcre -lpthread -lns3 -lrt + Gras dependencies : -lm -lpthread -lrt + Smpi dependencies : + + INSTALL_PREFIX: /usr/local +-- Configuring done +-- Generating done +-- Build files have been written to: /home/navarrop/workspace/simgrid/build +\endverbatim + +Now you can compile SimGrid +\verbatim +make +\endverbatim + +Then you can see if ns-3 is well activated by testing +\verbatim +ctest -R ns3 +\endverbatim + +You should see +\verbatim + Start 182: msg-ns3-thread +1/3 Test #182: msg-ns3-thread ................... Passed 0.35 sec + Start 183: msg-ns3-ucontext +2/3 Test #183: msg-ns3-ucontext ................. Passed 0.22 sec + Start 184: msg-ns3-raw +3/3 Test #184: msg-ns3-raw ...................... Passed 0.23 sec +\endverbatim + +More about ns-3 simulator (Official website) + +*/ \ No newline at end of file diff --git a/tools/doxygen/doxygen_postprocesser.pl b/tools/doxygen/doxygen_postprocesser.pl index 94720fb2a5..bd15975168 100755 --- a/tools/doxygen/doxygen_postprocesser.pl +++ b/tools/doxygen/doxygen_postprocesser.pl @@ -5,8 +5,8 @@ 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/installSimgrid.html html/bindings.html html/options.html html/use.html html/gtnets.html - html/ns3.html); + html/GRAS_tut.html html/tracing.html html/installSimgrid.html html/bindings.html + html/options.html html/use.html html/pls.html); # GRAS tutorial map {push @extra_files, "html/GRAS_tut_$_.html"} qw (intro @@ -395,8 +395,7 @@ foreach my $file (@allfiles) { || $file =~ /^html\/options.*/ || $file =~ /^html\/tracing.*/ || $file =~ /^html\/bindings.*/ - || $file =~ /^html\/gtnets.*/ - || $file =~ /^html\/ns3.*/ + || $file =~ /^html\/pls.*/ || $file =~ /^html\/modules.*/ || $file =~ /^html\/annotated.*/ || $file =~ /^html\/group__.*/ @@ -410,8 +409,7 @@ foreach my $file (@allfiles) { $tmp_buff .= '
  • Options & configurations
    • '."\n"; $tmp_buff .= '
  • Tracing Simulations
    • '."\n"; $tmp_buff .= '
  • Bindings
    • '."\n"; - $tmp_buff .= '
  • GTNets
    • '."\n"; - $tmp_buff .= '
  • NS3
    • '."\n"; + $tmp_buff .= '
  • Packet level simulation
    • '."\n"; $tmp_buff .= ' '."\n"; $tmp_buff .= ' '."\n"; -- 2.20.1