Document current problems with tests.

[loba.git] / README

diff --git a/README b/README
index 1cfa637ec3ed18036537b88478fb1d8d8ad58f30..8fcbc7c29716214b8f3ce950f8212df4c720c3fb 100644 (file)
--- a/README
+++ b/README
@@ -46,6 +46,45 @@ Pour changer le niveau de détail des affichages :
 Pour plus de détail sur les options de logging :
     http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_use
 
 Pour plus de détail sur les options de logging :
     http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_use
 

+Sorties
+=======
+
+* pendant la simulation :
+[Bourassa 5.000000] [proc/INFO] (6:1) current load: 5
+ +------- +-------   +--------   + +  -----+---------
+ |        |          |           | |       |
+ |        |          |           | |       \_ charge courante
+ |        |          |           | |
+ |        |          |           | \_ nombre d'itérations de calculs
+ |        |          |           |
+ |        |          |           \_ nombre d'itérations d'équilibrage
+ |        |          |
+ |        |          \_ catégorie de messages
+ |        |
+ |        \_ date courante (en secondes, dans la simulation)
+ |
+ \ nom du nœud
+
+* à la fin de la simulation :
+[Bourassa 108.886866] [proc/INFO] Final load after 107:4 iterations: 1.04113
+ +------- +---------   +--------                   +-- +             +------
+ |        |            |                           |   |             |
+ |        |            |                           |   |             \_ charge
+ |        |            |                           |   |                courante
+ |        |            |                           |   |
+ |        |            |                           |   \_ nombre d'itérations
+ |        |            |                           |      de calculs
+ |        |            |                           |
+ |        |            |                           \_ nombre d'itérations
+ |        |            |                              d'équilibrage
+ |        |            |
+ |        |            \_ catégorie de messages
+ |        |
+ |        \_ date courante (en secondes, dans la simulation)
+ |
+ \ nom du nœud
+
+

 Tracé de courbes
 ================
 
 Tracé de courbes
 ================
 


@@ -53,9 +92,14 @@ Le script extract.pl permet d'extraire les données à partir des traces
 de simulation et de le présenter sous un format acceptable par gnuplot
 ou par graph (plotutils).
 
 de simulation et de le présenter sous un format acceptable par gnuplot
 ou par graph (plotutils).
 

-Exemple:
+Exemples:

         ./loba platform.xml 2>&1 | ./extract.pl | graph -CTX
 
         ./loba platform.xml 2>&1 | ./extract.pl | graph -CTX
 

+        ./loba platform.xml 2>&1 | ./extract.pl | graph -CTX -y 0 250
+
+        ./loba platform.xml 2>&1 | ./extract.pl \
+            | gnuplot -p -e 'plot "-" using 1:2:(column(-2)) with lines lc variable'
+

 Communications
 ==============
 
 Communications
 ==============
 


@@ -98,6 +142,7 @@ Pour ajouter un nouvel algorithme d'équilibrage
            pneigh[i]->get_load() ;
      - définit la charge à envoyer avec
            send(pneigh[i], quantité) ;
            pneigh[i]->get_load() ;
      - définit la charge à envoyer avec
            send(pneigh[i], quantité) ;

+   NB: le script new_loba.sh peut servir à créer les fichiers.

 
 2. Ajouter l'algorithme dans la liste des options.  Dans options.cpp :
    - faire le #include adéquat ;
 
 2. Ajouter l'algorithme dans la liste des options.  Dans options.cpp :
    - faire le #include adéquat ;


@@ -154,9 +199,15 @@ Liste de fichiers
 
     main.cpp                    le programme principal
 
 
     main.cpp                    le programme principal
 

+    message.h                   file de messages reçus
+    message.cpp
+

     misc.h                      divers trucs inclassables
     misc.cpp
 
     misc.h                      divers trucs inclassables
     misc.cpp
 

+    msg_thread.h                creation de threads SG/MSG
+    msg_thread.cpp
+

     named_object_list.h         gestion d'une table de constructeurs
                                 avec des noms et des descriptions
 
     named_object_list.h         gestion d'une table de constructeurs
                                 avec des noms et des descriptions
 


@@ -171,10 +222,16 @@ Liste de fichiers
 
     simgrid_features.h          macros pour détecter la version de SimGrid
 
 
     simgrid_features.h          macros pour détecter la version de SimGrid
 

-    simple_async.cpp            un simple programme de test
+    statistics.h                pour calculer moyenne, variance, etc.
+
+    synchro.h                   mutex, condition, etc.
+
+    sync_queue.h                lock-free synchronized queue

 
     timer.h                     gestion de timer
 
 
     timer.h                     gestion de timer
 

+    tracing.h                   définitions liées au traçage
+

     version.h                   gestion de la version du programme
     version.cpp
 
     version.h                   gestion de la version du programme
     version.cpp
 


@@ -186,11 +243,14 @@ Liste de fichiers
     extract.pl                  outil d'extraction des données à partir des
                                 traces, pour tracer des courbes
 
     extract.pl                  outil d'extraction des données à partir des
                                 traces, pour tracer des courbes
 

+    new_loba.sh                 pour créer le squelette d'un nouvel algo
+                                d'équiblibrage loba_*
+

     setlocalversion             calcule un numéro de version à partir du hash
                                 du dernier commit (git)
 
 * autres fichiers
 
     .gitignore                  liste des fichiers ignorés par git
     setlocalversion             calcule un numéro de version à partir du hash
                                 du dernier commit (git)
 
 * autres fichiers
 
     .gitignore                  liste des fichiers ignorés par git

-    valgrind_suppressions_3.5   liste de quelques suppressions pour valgrind
+    valgrind_suppressions       liste de quelques suppressions pour valgrind

                                 avec SimGrid 3.5
                                 avec SimGrid 3.5