From e37929cd4f8349d37d59645a95be3ca7a01ed353 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Tue, 24 May 2016 22:10:05 +0200 Subject: [PATCH] We only have one packet-level simulator underneath --- doc/Doxyfile.in | 2 +- doc/doxygen/index.doc | 2 +- doc/doxygen/{pls.doc => ns3.doc} | 35 +++++++++++++++++--------------- doc/doxygen/options.doc | 5 ++--- examples/msg/README.doc | 4 ++-- tools/cmake/DefinePackages.cmake | 4 +++- 6 files changed, 28 insertions(+), 24 deletions(-) rename doc/doxygen/{pls.doc => ns3.doc} (66%) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 7835adcc63..a6c08e03b0 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -649,7 +649,7 @@ INPUT = doxygen/index.doc \ doxygen/bindings.doc \ doxygen/platform.doc \ doxygen/models.doc \ - doxygen/pls.doc \ + doxygen/ns3.doc \ doxygen/scenario.doc \ doxygen/deployment.doc \ doxygen/options.doc \ diff --git a/doc/doxygen/index.doc b/doc/doxygen/index.doc index 2f98047d60..cc54313e2a 100644 --- a/doc/doxygen/index.doc +++ b/doc/doxygen/index.doc @@ -19,7 +19,7 @@ - @subpage bindings - @subpage platform - @subpage models - - @subpage pls + - @subpage pls_ns3 - @subpage scenario - @subpage deployment - @subpage options diff --git a/doc/doxygen/pls.doc b/doc/doxygen/ns3.doc similarity index 66% rename from doc/doxygen/pls.doc rename to doc/doxygen/ns3.doc index b4ca1a0369..c34f7831ae 100644 --- a/doc/doxygen/pls.doc +++ b/doc/doxygen/ns3.doc @@ -1,20 +1,22 @@ -/*! \page pls Packet level simulation +/*! \page pls_ns3 ns-3 as a SimGrid model \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. +You can use the well-known +ns-3 packet-level network +simulator as a SimGrid model, for example to investigate the validity +of your simulation. -At the moment, we support the well-known ns-3 packet-level simulator. Earlier -releases of SimGrid did support the GTNetS simulator. Its support could possibly be revived by someone who would -need it. +This binding is still somehow limited: you can only express what is at +the intersection between ns-3 and SimGrid. For example, ns-3 wireless +models are not available, while no route longuer than 1 must appear in +your SimGrid platform (add routers on need). -\section pls_simgrid_configuration_ns3 ns-3 as a SimGrid model +But if you stick to what is possible in both systems, there should be +very little things to change in your SimGrid settings (platform and +experimental scenario) to use ns-3 -This section explains how to replace the SimGrid network models by those of the well-known -ns-3 packet-level network simulator. - -\subsection pls_simgrid_configuration_ns3_install Installing ns-3 +\section pls_ns3_install Installing ns-3 The easiest is to install it with the package manager. Under Debian/Ubuntu, simply type as root: @@ -37,7 +39,7 @@ cd ns-allinone-3.25/ns-3.25/ For more information, please refer to the ns-3 documentation. -\subsection pls_simgrid_configuration_ns3_config Enabling SimGrid's support for ns-3 +\section pls_ns3_config Enabling SimGrid's support for ns-3 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. @@ -62,10 +64,11 @@ If the compilation fails when linking the library because of some .a file that c 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. -\subsection pls_simgrid_configuration_ns3_use Using ns-3 from SimGrid +\section pls_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. +Basically, you just have to run your SimGrid simulation with the +configuration option "network/model" set to "NS3". The rest remains +unchanged. The following should work from the examples/msg/network-ns3 folder (network-ns3 is the name of our example binary). @@ -76,7 +79,7 @@ The following should work from the examples/msg/network-ns3 folder (network-ns3 A ns-3 platform is automatically created from the provided SimGrid platform file. However, there are some known caveats: