Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
start to clean up the bib file. Too many badly formatted entries for
[simgrid.git] / doc / FAQ.doc
index 09bf01b..a95cada 100644 (file)
@@ -1563,6 +1563,29 @@ A number of options can be given at runtime to change the default
 SimGrid behavior. In particular, you can change the default cpu and
 network models...
 
+\subsubsection faq_simgrid_configuration_fullduplex Using Fullduplex
+
+Experimental fullduplex support is now available on the svn branch. In order to fullduple to work your platform must have two links for each pair
+of interconnected hosts, see an example here:
+\verbatim
+       simgrid_svn_sources/exemples/msg/gtnets/fullduplex-p.xml
+\endverbatim
+
+Using fullduplex support ongoing and incoming communication flows are
+treated independently for most models. The exception is the LV08 model which 
+adds 0.05 of usage on the opposite direction for each new created flow. This 
+can be useful to simulate some important TCP phenomena such as ack compression. 
+
+Running a fullduplex example:
+\verbatim
+       cd simgrid_svn_sources/exemples/msg/gtnets
+       ./gtnets fullduplex-p.xml fullduplex-d.xml --cfg=fullduplex:1
+\endverbatim
+
+
+
+
+
 \subsubsection faq_simgrid_configuration_gtnets Using GTNetS
 
 It is possible to use a packet-level network simulator
@@ -1638,8 +1661,14 @@ and build/install it from scratch
 
 
  - <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)
 
    \verbatim
+   Since v3.4 (with cmake)
+   cmake . -Dgtnets_path=/<userhome>/usr
+   
+   Until v3.4 (with autotools)
    ./configure --with-gtnets=/<userhome>/usr
    \endverbatim
 
@@ -1648,6 +1677,12 @@ and build/install it from scratch
    runntime with the following options:</b>
 
    \verbatim
+   Since v3.4 (with cmake)
+   cd simgrid
+   make
+   ctest -R gtnets
+   
+   Until v3.4 (with autotools)
    cd simgrid/example/msg/
    make
    make check
@@ -1761,11 +1796,9 @@ $ make
 
 \subsubsubsection Mandatory Functions
 
-\li <b>\c TRACE_start (const char *filename)</b>: This is the first function to
-be called. It receives a single argument as parameter that contains the name of
-the file that will hold the trace in the end of the simulation. It returns 0 if
-everything was properly initialized, 1 otherwise. All trace functions called
-before TRACE_start do nothing.
+\li <b>\c TRACE_start ()</b>: This is the first function to
+be called. It returns 0 if everything was properly initialized, 1 otherwise. 
+All trace functions called before TRACE_start do nothing.
 
 \li <b>\c TRACE_category (const char *category)</b>: This function should be used
 to define a user category. The category can be used to differentiate the tasks
@@ -1802,6 +1835,27 @@ the value of this variable is always associated to the host. The host
 that will be used when these functions are called is the one returned by
 the function \c MSG_host_self().
 
+\subsubsection faq_tracing_options Tracing configuration Options
+
+These are the options accepted by the tracing system of SimGrid:
+
+\li <b>\c tracing/filename</b>: use this to specify the name of the trace file
+that will be created during the simulation. For example, after the binary
+of your simulator, you can pass as parameter this: 
+\verbatim
+--cfg=tracing/filename:mytracefile.trace
+\endverbatim
+in order to trace the behavior of the simulation in a file with the name
+mytracefile.trace.
+
+\li <b>\c tracing/platform</b>: use this to activate the tracing of the
+platform. For example, you can pass as parameter to your simulator:
+\verbatim
+--cfg=tracing/platform:1
+\endverbatim
+to trace the platform utilization by the categories you declared in your
+simulator. By default, this options is set to 0.
+
 \subsubsection faq_tracing_example Example of Instrumentation
 
 A simplified example using the tracing mandatory functions.
@@ -1809,12 +1863,13 @@ A simplified example using the tracing mandatory functions.
 \verbatim
 int main (int argc, char **argv)
 {
-  TRACE_start ("traced_simulation.trace");
+  MSG_global_init (&argc, &argv);
+
+  //note that TRACE_start must be called after MSG_global_init
+  TRACE_start ();
   TRACE_category ("request");
   TRACE_category ("computation");
   TRACE_category ("finalize");
-  
-  MSG_global_init (&argc, &argv);
 
   //(... after deployment ...)
 
@@ -2249,21 +2304,21 @@ so  you can exchange any kind of data ( tables, matrix, strings … ) between pr
 
 \li set Hosts
 \verbatim
-  simgrid.Host.new("Tremblay",98095000);
-  simgrid.Host.new("Jupiter",76296000);
-  simgrid.Host.new("Fafard",76296000);
-  simgrid.Host.new("Ginette",48492000);
-  simgrid.Host.new("Bourassa",48492000);
+  simgrid.Host.new{id="Tremblay",power=98095000};
+  simgrid.Host.new{id="Jupiter",power=76296000};
+  simgrid.Host.new{id="Fafard",power=76296000};
+  simgrid.Host.new{id="Ginette",power=48492000};
+  simgrid.Host.new{id="Bourassa",power=48492000};
 \endverbatim
-  we use simgrid.Host.new(host_id,power) to instanciate our hosts.
+  we use simgrid.Host.new{id=id_host,power=power_host} to instanciate our hosts.
 
 \li set Links
 \verbatim
   for i=0,11 do
-    simgrid.Link.new(i,252750+ i*768,0.000270544+i*0.087);    --  some crazy values ;)
+    simgrid.Link.new{id=i,bandwidth=252750+ i*768,latency=0.000270544+i*0.087};    --  some crazy values ;)
   end
 \endverbatim
-  we used simgrid.Link.new(link_id,bandwidth,latency) with a simple for loop to create all links we need  ( much easier than XML hein ? )
+  we used simgrid.Link.new{id=link_id,bandwidth=bw,latency=lat} with a simple for loop to create all links we need (much easier than XML hein ?)
 
 \li set Routes
 \verbatim
@@ -2820,3 +2875,4 @@ Nowadays, functions get automatically exported, so we don't need to load our
 header files with tons of __declspec(dllexport) cruft. We only need to do so
 for data, but there is no public data in SimGrid so we are good.
 
+