/*! \page pls Packet level simulation
-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 and since version 3.6.2, ns-3.
+\tableofcontents
+It is possible to use a packet-level network simulator instead of the default flow-based models. You may want to use
+this feature if you have doubts about the validity of the default model or want to perform some validation experiments.
-\section pls_simgrid_configuration_gtnets Using GTNetS
+At the moment, we support the well-known <a href="http://www.nsnam.org/"><b>ns-3</b></a> packet-level simulator. Earlier
+releases of SimGrid did support the <b>GTNetS</b> simulator. Its support could possibly be revived by someone who would
+need it.
+\section pls_simgrid_configuration_ns3 ns-3 as a SimGrid model
-<i>
-To enable GTNetS model inside SimGrid it is needed to patch the GTNetS simulator source code
-and build/install it from scratch
-</i>
+This section explains how to replace the SimGrid network models by those of the well-known
+<a href="http://www.nsnam.org/">ns-3</a> packet-level network simulator.
- - <b>Download and enter the recent downloaded GTNetS directory</b>
-
-\verbatim
-svn checkout svn://scm.gforge.inria.fr/svn/simgrid/contrib/trunk/GTNetS/
-cd GTNetS
-\endverbatim
+\subsection pls_simgrid_configuration_ns3_install Installing ns-3
-
- - <b>Use the following commands to unzip and patch GTNetS package to work within SimGrid.</b>
+The easiest is to install it with the package manager. Under Debian/Ubuntu, simply type as root:
\verbatim
-unzip gtnets-current.zip
-tar zxvf gtnets-current-patch.tgz
-cd gtnets-current
-cat ../00*.patch | patch -p1
+apt-get install libns3-dev ns3
\endverbatim
- - <b>OPTIONALLY</b> you can use a patch for itanium 64bit processor family.
+You can also install it from scratch with the following commands:
\verbatim
-cat ../AMD64-FATAL-Removed-DUL_SIZE_DIFF-Added-fPIC-compillin.patch | patch -p1
-\endverbatim
-
- - <b>Compile GTNetS</b>
-
- 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
-sed -i 's/-fPIC/-fPIC -fpermissive/g' Makefile
-make depend
-make debug
+# Download the source
+wget http://www.nsnam.org/release/ns-allinone-3.25.tar.bz2
+tar -xf ns-allinone-3.25.tar.bz2
+cd ns-allinone-3.25/ns-3.25/
+# Configure, build and install
+./waf configure --prefix="/opt/ns3" # or give another path if you prefer
+./waf
+./waf install
\endverbatim
+For more information, please refer to the ns-3 documentation.
- - <b>NOTE</b> 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.
-
+\subsection pls_simgrid_configuration_ns3_config Enabling SimGrid's support for ns-3
- - <b>To compile optimized version</b>
+Normally, you just have to enable ns-3 in ccmake or cmake as follows. If you installed ns-3 in a regular path, just
+drop the ns3_path configuration item.
\verbatim
-make opt
+cmake . -Denable_ns3=ON -DNS3_HINT=/opt/ns3 # or change the path if needed
\endverbatim
-
- - <b>Installing GTNetS</b>
-
- 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.
+By the end of the configuration, cmake reports whether ns-3 was found. You can also double-check by executing the tests
+after the compilation.
\verbatim
-ln -sf /<absolute_path>/gtnets_current/libgtsim-debug.so /<userhome>/usr/lib/libgtnets.so
-export LD_LIBRARY_PATH=${LD_LIBRARY_PATH:+$LD_LIBRARY_PATH:}/<userhome>/usr/lib/
-mkdir /<userhome>/usr/include/gtnets
-cp -fr SRC/*.h /<userhome>/usr/include/gtnets
+$ ctest -R ns3
+(test(s) should be run)
\endverbatim
+If you have a ns-3 version that is not known to SimGrid (yet), the detection may fail. In that case, edit the
+tools/cmake/Modules/FindNS3.cmake file in your SimGrid tree. The
+required changes are very easy, and documented in the file header.
- - <b>Enable GTNetS support in SimGrid</b>
-
-In order to enable gtnets with simgrid you have to give where is gtnets. (path to \<gtnets_path\>/lib and \<gtnets_path\>/include)
+If the compilation fails when linking the library because of some .a file that cannot be used dynamically, this is
+probably because you only installed the libns3-dev library on your Debian, where you also need libns3-3. This is
+probably a bug of the libns3-dev package that should depend on the dynamic libraries corresponding to its .so files.
-\verbatim
-cmake . -Denable_gtnets=ON -Dgtnets_path=/<userhome>/usr
-\endverbatim
-
- - <b>Once you have followed all the instructions for compiling and
- installing successfully you can activate this feature at
- runntime with the following options:</b>
-
-\verbatim
-cd simgrid
-make
-ctest -R gtnets
-\endverbatim
+\subsection pls_simgrid_configuration_ns3_use Using ns-3 from SimGrid
+A working example of ns-3/SimGrid interactions can be found in examples/msg/network-ns3/. Basically, you just have to
+run your SimGrid simulation with the configuration option "network/model" set to "NS3". The rest remains unchanged.
- - <b>Or try the GTNetS model dogbone example with</b>
+The following should work from the examples/msg/network-ns3 folder (network-ns3 is the name of our example binary).
\verbatim
-gtnets/gtnets gtnets/onelink-p.xml gtnets/onelink-d.xml --cfg=network_model:GTNets
+./network-ns3 ./3hosts_2links_p.xml 3hosts_2links_d.xml --cfg=network/model:NS3 --log=root.threshold:info
\endverbatim
-
- A long version of this <a href="http://gforge.inria.fr/docman/view.php/12/6283/GTNetS HowTo.html">HowTo</a> it is available
-
-
- More about GTNetS simulator at <a href="http://www.ece.gatech.edu/research/labs/MANIACS/GTNetS/index.html">GTNetS Website</a>
-
-
- - <b>DISCLAIMER</b>
- The patches provided by us worked successfully with GTNetS found
- <a href="http://www.ece.gatech.edu/research/labs/MANIACS/GTNetS/software/gtnets-current.zip">here</a>,
- 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 <a href="http://www.nsnam.org/">(ns-3)</a> for Internet systems
-instead of the default one.
-
-A ns-3 platform is created according to the platform file you provide in SimGrid format. However from this configuration, we had to set up some extra parameters :
+A ns-3 platform is automatically created from the provided SimGrid platform file. However, there are some known caveats:
<ul>
-<li>
-First, whenever possible, we let default ns3 values and we don't changed it ; in case you have doubts on values for those parameters (TCP parameters for example), blame ns-3...
-</li>
-
-<li>
-Second, routing used inside ns-3 is a global and static one, relying on a shortest path algorithm. We did so by using ns3::Ipv4GlobalRoutingHelper::PopulateRoutingTables.
-</li>
+ <li>The default values (e.g., TCP parameters) are the ns3 values. Don't blame us for them.</li>
-<li>
-Third, we also choose to restrict the way your platform is built : end hosts cannot have more than one interface card (so, only one <link> in your SimGrid platform should link
-an end host to the platform ; if not, your end host will be considered as a router.
-</li>
+ <li>ns-3 networks are routed using the shortest path algorithm, using
+ ns3::Ipv4GlobalRoutingHelper::PopulateRoutingTables.</li>
+ <li>End hosts cannot have more than one interface card (so, only one <link> in your SimGrid platform should
+ link an end host to the platform ; if not, your end host will be considered as a router. </li>
</ul>
-<i>
-To use ns3 model inside SimGrid you have to install at least the version 3.10 of ns3 simulator.
-</i>
-- <b>Download and enter the lateast release (here the 3.12.1)</b>
-
-\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
-
-- <b>Configure, make and install ns3</b>
-
-\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)
-
-In some cases, include/ns3 does not exist, but there is an /include/ns3.XX . Then, a simple symbolic link is enough. From the /path/to/ns3/installation/include directory, run:
-\verbatim
-ln -s -T ns3.XX/ns3 ns3
-\endverbatim
-
-Make sure to replace 3.XX with your version of NS3, e.g., 3.17, or 3.18.
-Check the correct presence of the symbolic link using
-\verbatim
-ls -al
-\endverbatim
-
-and you should see an ns3 link pointing to ns3.XX. E.g., ns3 -> ns3.17/ns3
-You also need to add to the LD_LIBRARY_PATH : "ns-3_install_directory/lib".
-
-- <b>Enable ns-3 support on SimGrid</b>
-
-Enabling ns-3 integration with Simgrid requires several intermediate steps.
--# Modify "simgrid_path/buildtools/CMake/MakeLib.cmake".\n
-The "-lns3.${NS3_VERSION_MINOR}-[module]" should match the library names in your "ns-3_install_directory/lib". The "module" can be one of the following: core, csma, point-to-oint, internet, applications, bridge, mpi, config-store, stats, network. For this, in the "MakeLib.cmake" file find the "else" branch of "if(HAVE_NS3)" statement. Replace the se of "-lns3.${NS3_VERSION_MINOR}-[module]" with "-lns3[version]-[module]-debug" in "SET(SIMGRID_DEP)". On the same branch, add "-I/path/to/ns-3_install_directory/include" to MAKE_C_FLAGS and "CMAKE_CXX_FLAGS".
--# There might be a need for creating symbolic links of each ns3 library from "ns-3_install_directory/lib" to "/usr/lib".
--# In order to enable ns-3 with simgrid you have to give where is ns-3 to the simgrid configuration command. (path to \<ns3_path\>/lib and \<ns3_path\>/include)
-
-\verbatim
-cmake . -Denable_ns3=ON -Dns3_path=<ns3_path>
-\endverbatim
-
-With the output of the configuration you can see if ns-3 is detected (see CFlags: ; CPPFlags: ; Compile NS-3: , NS-3 path:).
-
-\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
-
- Maintainer mode: OFF
- Supernovae mode: OFF
- Model checking : OFF
- Tracing mode : OFF
- Jedule mode : OFF
- Latency bound : OFF
- Graphviz mode :
-
- Simgrid dependencies: -lm -lpthread -lns3 -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
-
-- <b>Use case</b>
-
-An example of using Simgrid with NS3 can be found in:
-
-\verbatim
-path/to/simgrid/examples/src/surf/ns3/
-\endverbatim
-
-From the example folder above, the command line sintax is
-
-\verbatim
-<simgrid_executable> <platform description file> <deployment file> --cfg=network/model:NS3 --log=surf.threshold:info
-\endverbatim
+More about ns-3 simulator <a href="http://www.nsnam.org/">(Official website)</a>
-This example should work:
-\verbatim
-./ns3 ./3hosts_2links_p.xml 3hosts_2links_d.xml --cfg=network/model:NS3 --log=root.threshold:info
-\endverbatim
+\subsection ns3_examples Examples
-More about ns-3 simulator <a href="http://www.nsnam.org/">(Official website)</a>
+For an example using NS3 as a SimGrid module, please refer to the
+@ref msg_ex_ns3 "relevant section" of the documentation.
*/
