X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f4ed74ca6d4a744d2956a4f2906c897e1886cefd..bb0a82c6a53abd8c2c09cc556781fca5928bb6b9:/doc/doxygen/pls.doc diff --git a/doc/doxygen/pls.doc b/doc/doxygen/pls.doc index e8a223f51d..76b528ad8a 100644 --- a/doc/doxygen/pls.doc +++ b/doc/doxygen/pls.doc @@ -1,103 +1,17 @@ /*! \page pls Packet level simulation +\tableofcontents + 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 NS3 and GTNetS simulators. - - -\section pls_simgrid_configuration_gtnets GTNetS as a SimGrid model - -\subsection pls_simgrid_configuration_gtnets_compile Compiling a patched version of GTNetS - -GTNetS needs to be patched to work with SimGrid, so the easiest -solution is to run the following commands: - -\verbatim -# Get the files that we prepared for you -svn checkout svn://scm.gforge.inria.fr/svn/simgrid/contrib/trunk/GTNetS/ -cd GTNetS - -# Unpack and patch the sources -unzip gtnets-current.zip -tar zxvf gtnets-current-patch.tgz -cd gtnets-current -cat ../*.patch | patch -p1 - -# Compile GTNetS -ln -sf Makefile.linux Makefile -sed -i 's/-fPIC/-fPIC -fpermissive/g' Makefile -make depend -make opt # compile an optimized version (required) -make debug # compile a debug version (optional) - -# Install under /opt -mkdir -p /opt/gtnets/include /opt/gtnets/lib -cp -fr SRC/*.h /opt/gtnets/include -cp libgtsim-opt.so /opt/gtnets/lib/libgtsim.so -\endverbatim - -Some remarks: - - - -Add the following to your .bashrc so that it gets defined each time: - -\verbatim -export LD_LIBRARY_PATH=${LD_LIBRARY_PATH:+$LD_LIBRARY_PATH:}/opt/gtnets/lib/ -\endverbatim - -\subsection pls_simgrid_configuration_gtnets_config Enabling SimGrid's support for GTNetS - -You just have to enable GTNetS in ccmake or cmake as follows, and -recompile SimGrid. - -\verbatim -cmake . -Denable_gtnets=ON -Dgtnets_path=/opt/gtnets -\endverbatim +we support the NS3 simulator; see Section \ref pls_examples "Examples" for +some additional information. -By the end of the configuration, cmake reports whether GTNetS was found. -You can also double-check by executing the tests after the compilation. - -\verbatim -$ ctest -R gtnets -(several tests should be run) -\endverbatim - -\subsection pls_simgrid_configuration_gtnets_use Using GTNetS from SimGrid - -A working example can be found in the folder examples/msg/gtnets. - -\verbatim -gtnets/gtnets gtnets/onelink-p.xml gtnets/onelink-d.xml --cfg=network/model:GTNets -\endverbatim - -For more information, please refer to the GTNetS -Website or to this -possibly outdated longer HowTo +At the moment, we only support the NS3 simulator. Previous versions of +SimGrid did support the GTNetS simulator and that support could +possibly be revived by someone who would need it. \section pls_simgrid_configuration_ns3 NS3 as a SimGrid model @@ -149,7 +63,7 @@ $ ctest -R ns3 If you have a NS3 version that is not known (yet) to SimGrid, the detection may fail. In that case, edit the file -buildtools/Cmake/Modules/FindNS3.cmake in your SimGrid tree. The +tools/cmake/Modules/FindNS3.cmake in your SimGrid tree. The required changes are very easy, and documented at the beginning of this file. @@ -192,4 +106,9 @@ file that you will provide. There is some caveats to know: More about ns-3 simulator (Official website) +\subsection pls_examples Examples + +There are some examples in the \c examples/ folder, that show how to use +the bindings; see also the \ref MSG_ex_PLS "documentation for these examples". + */