Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Correction of compilation flags
[simgrid.git] / doc / FAQ.doc
1 /*! \page faq Frequently Asked Questions
2
3 \htmlinclude .FAQ.doc.toc
4
5 \section faq_simgrid I'm new to SimGrid. I have some questions. Where should I start?
6
7 You are at the right place... Having a look to these
8 <a href="http://www.loria.fr/~quinson/articles/simgrid-tutorial.pdf">the tutorial slides</a> 
9 (or to these <a href="http://graal.ens-lyon.fr/~alegrand/articles/slides_g5k_simul.pdf">old slides</a>,
10 or to these
11 <a href="http://graal.ens-lyon.fr/~alegrand/articles/Simgrid-Introduction.pdf">"obsolete" slides</a>)
12 may give you some insights on what SimGrid can help you to do and what
13 are its limitations. Then you definitely should read the \ref
14 MSG_examples. The \ref GRAS_tut can also help you.
15
16 If you are stuck at any point and if this FAQ cannot help you, please drop us a
17 mail to the user mailing list: <simgrid-user@lists.gforge.inria.fr>.
18
19 \subsection faq_interfaces What is the difference between MSG, SimDag, and GRAS? Do they serve the same purpose?
20
21 It depend on how you define "purpose", I guess ;)
22
23 They all allow you to build a prototype of application which you can run
24 within the simulator afterward. They all share the same simulation kernel,
25 which is the core of the SimGrid project. They differ by the way you express
26 your application.
27
28 With SimDag, you express your code as a collection of interdependent
29 parallel tasks. So, in this model, applications can be seen as a DAG of
30 tasks. This is the interface of choice for people wanting to port old
31 code designed for SimGrid v1 or v2 to the framework current version.
32
33 With both GRAS and MSG, your application is seen as a set of communicating
34 processes, exchanging data by the way of messages and performing computation
35 on their own.
36
37 The difference between both is that MSG is somehow easier to use, but GRAS
38 is not limited to the simulator. Once you're done writing your GRAS code,
39 you can run your code both in the simulator or on a real platform. For this,
40 there is two implementations of the GRAS interface, one for simulation, one
41 for real execution. So, you just have to relink your code to chose one of
42 both world. 
43
44 \subsection faq_generic First steps with SimGrid
45
46 If you decide to go for the MSG interface, please read carefully the
47 \ref MSG_examples. You'll find in \ref MSG_ex_master_slave a very
48 simple consisting of a master (that owns a bunch of tasks and
49 distributes them) , some slaves (that process tasks whenever they
50 receive one) and some forwarder agents (that simply pass the tasks
51 they receive to some slaves).
52
53 If you decide to go for the GRAS interface, you should definitively
54 read the \ref GRAS_tut. The first section constitutes an introduction
55 to the tool and presents the model we use. The second section
56 constitutes a complete step-by-step tutorial building a distributed
57 application from the beginning and exemplifying most of the GRAS
58 features in the process. The last section groups some HOWTOS
59 highlighting a given feature of the framework in a more concise way.
60
61 If you decide to go for another interface, I'm afraid your only sources
62 of information will be the source code and the mailing lists...
63
64 \subsection faq_visualization Visualizing and analyzing the results
65
66 It is sometime convenient to "see" how the agents are behaving. If you
67 like colors, you can use <tt>tools/MSG_visualization/colorize.pl </tt>
68 as a filter to your MSG outputs. It works directly with INFO. Beware,
69 INFO() prints on stderr. Do not forget to redirect if you want to
70 filter (e.g. with bash): 
71 \verbatim 
72 ./msg_test small_platform.xml small_deployment.xml 2>&1 | ../../tools/MSG_visualization/colorize.pl
73 \endverbatim
74
75 We also have a more graphical output. Have a look at section \ref faq_tracing.
76
77 \subsection faq_C Argh! Do I really have to code in C?
78
79 Up until now, there is no binding for other languages. If you use C++,
80 you should be able to use the SimGrid library as a standard C library
81 and everything should work fine (simply <i>link</i> against this
82 library; recompiling SimGrid with a C++ compiler won't work and it
83 wouldn't help if you could).
84
85 In fact, we are currently working on Java bindings of MSG to allow
86 all the undergrad students of the world to use this tool. This is a
87 little more tricky than I would have expected, but the work is moving
88 fast forward [2006/05/13]. More languages are evaluated, but for now,
89 we do not feel a real demand for any other language. Please speak up!
90
91 \section faq_installation Installing the SimGrid library
92
93 Many people have been asking me questions on how to use SimGrid. Quite
94 often, the questions were not really about SimGrid but on the
95 installation process. This section is intended to help people that are
96 not familiar with compiling C files under UNIX. If you follow these
97 instructions and still have some troubles, drop an e-mail to
98 <simgrid-user@lists.gforge.inria.fr>.
99
100 \subsection faq_compiling Compiling SimGrid from a stable archive
101
102 First of all, you need to download the latest version of SimGrid from 
103 <a href="http://gforge.inria.fr/frs/?group_id=12">here</a>.
104 Suppose you have uncompressed SimGrid in some temporary location of
105 your home directory (say <tt>/home/joe/tmp/simgrid-3.0.1 </tt>). The
106 simplest way to use SimGrid is to install it in your home
107 directory. Change your directory to
108 <tt>/home/joe/tmp/simgrid-3.0.1</tt> and type
109
110 \verbatim
111 ./configure --prefix=$HOME
112 make
113 make install
114 \endverbatim
115
116 If at some point, something fails, check the section \ref faq_trouble_compil .
117 If it does not help, you can report this problem to the
118 list but, please, avoid sending a laconic mail like "There is a problem. Is it
119 okay?". Send the config.log file which is automatically generated by
120 configure. Try to capture both the standard output and the error output of the
121 <tt>make</tt> command with <tt>script</tt>. There is no way for us to help you
122 without the relevant bits of information.
123
124 Now, the following directory should have been created : 
125
126       \li <tt>/home/joe/doc/simgrid/html/</tt>
127       \li <tt>/home/joe/lib/</tt>
128       \li <tt>/home/joe/include/</tt>
129
130 SimGrid is not a binary, it is a library. Both a static and a dynamic
131 version are available. Here is what you can find if you try a <tt>ls
132 /home/joe/lib</tt>:
133
134 \verbatim libsimgrid.a libsimgrid.la libsimgrid.so libsimgrid.so.0 libsimgrid.so.0.0.1
135 \endverbatim
136
137 Thus, there is two ways to link your program with SimGrid:
138       \li Either you use the static version, e.g 
139 \verbatim gcc libsimgrid.a -o MainProgram MainProgram.c
140 \endverbatim
141           In this case, all the SimGrid functions are directly
142           included in <tt>MainProgram</tt> (hence a bigger binary).
143       \li Either you use the dynamic version (the preferred method)
144 \verbatim gcc -lsimgrid -o MainProgram MainProgram.c
145 \endverbatim
146           In this case, the SimGrid functions are not included in
147           <tt>MainProgram</tt> and you need to set your environment
148           variable in such a way that <tt>libsimgrid.so</tt> will be
149           found at runtime. This can be done by adding the following
150           line in your .bashrc (if you use bash and if you have
151           installed the SimGrid libraries in your home directory):
152 \verbatim export LD_LIBRARY_PATH=$HOME/lib/:$LD_LIBRARY_PATH
153 \endverbatim
154
155 \subsection faq_compiling_java Java bindings don't get compiled
156
157 The configure script detects automatically whether you have the
158 softwares needed to use the Java bindings or not. At the end of the
159 configure, you can see the configuration picked by the script, which
160 should look similar to 
161 \verbatim Configuration of package simgrid' (version 3.3.4-svn) on
162 little64 (=4):
163
164          Compiler:       gcc (version: )
165          
166          CFlags:          -O3 -finline-functions -funroll-loops -fno-strict-aliasing -Wall -Wunused -Wmissing-prototypes -Wmissing-declarations -Wpointer-arith -Wchar-subscripts -Wcomment -Wformat -Wwrite-strings -Wno-unused-function -Wno-unused-parameter -Wno-strict-aliasing -Wno-format-nonliteral -Werror -g3
167          CPPFlags:   
168          LDFlags:        
169                                    
170          Context backend: ucontext
171          Compile Java: no
172                                                          
173          Maintainer mode: no
174          Supernovae mode: yes
175 \endverbatim       
176
177 In this example, Java backends won't be compiled. 
178
179 On Debian-like systems (which includes ubuntu), you need the following
180 packages: sun-java6-jdk libgcj10-dev. If you cannot find the
181 libgcj10-dev, try another version, like libgcj9-dev (on Ubuntu before
182 9.10) or libgcj11-dev (not released yet, but certainly one day).
183 Please note that you need to activate the contrib and non-free
184 repositories in Debian, and the universe ones in Ubuntu. Java comes at
185 this price...
186
187 \subsection faq_compiling_snapshoot SimGrid development snapshots
188
189 We have very high standards on software quality, and we are reluctant releasing
190 a stable release as long as there is still some known bug in the code base. In
191 addition, we added quite an extensive test base, making sure that we correctly
192 test the most important parts of the tool. 
193
194 As an unfortunate conclusion, there may be some time between the stable
195 releases. If you want to benefit from the most recent features we introduced,
196 but don't want to take the risk of an untested version from the SVN, then
197 development snapshots are done for you. 
198
199 These are pre-releases of SimGrid that still fail some tests about features
200 that almost nobody use, or on platforms not being in our core target (which is
201 Linux, Mac, other Unixes and Windows, from the most important to the less
202 one). That means that using this development releases should be safe for most
203 users. 
204
205 These archives can be found on 
206 <a href="http://www.loria.fr/~quinson/simgrid.html">this web page</a>. Once you 
207 got the lastest archive, you can compile it just like any archive (see above).
208
209 \subsection faq_compiling_svn Compiling SimGrid from the SVN
210
211 The project development takes place in the SVN, where all changes are
212 committed when they happen. Then every once in a while, we make sure that the
213 code quality meets our standard and release an archive from the code in the
214 SVN. We afterward go back to the development in the SVN. So, if you need a
215 recently added feature and can afford some little problem with the stability
216 of the lastest features, you may want to use the SVN version instead of a
217 released one.
218
219 For that, you first need to get the "simgrid" module from
220 <a href="http://gforge.inria.fr/scm/?group_id=12">here</a>. 
221
222 You won't find any <tt>configure</tt> and a few other things
223 (<tt>Makefile.in</tt>'s, documentation, ...) will be missing as well. The
224 reason for that is that all these files have to be regenerated using the
225 latest versions of <tt>autoconf</tt>, <tt>libtool</tt>, <tt>automake</tt>
226 (>1.9) and <tt>doxygen</tt> (>1.4). To generate the <tt>configure</tt> and
227 the <tt>Makefile.in</tt>'s, you just have to launch the <tt>bootstrap</tt>
228 command that resides in the top of the source tree. Then just follow the
229 instructions of Section \ref faq_compiling.
230
231 We insist on the fact that you really need the latest versions of
232 autoconf, automake and libtool. Doing this step on exotic architectures/systems
233 (i.e. anything different from a recent linux distribution) may be
234 ... uncertain. If you need to compile the SVN version on a machine where all these
235 dependencies are not met, the easiest is to do <tt>make dist</tt> in the SVN
236 directory of another machine where all dependencies are met. It will create an
237 archive you may deploy on other sites just as a regular stable release.
238
239 In summary, the following commands will checkout the SVN, regenerate the
240 configure script and friends, configure SimGrid and build it.
241
242 \verbatim svn checkout svn://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk simgrid
243 cd simgrid
244 ./bootstrap
245 ./configure --enable-maintainer-mode --prefix=<where to install SimGrid>
246 make \endverbatim
247
248 Then, if you want to install SimGrid on the current box, just do:
249 \verbatim make install \endverbatim
250
251 If you want to build an snapshot of the SVN to deploy it on another box (for
252 example because the other machine don't have the autotools), do:
253 \verbatim make dist \endverbatim
254
255 Moreover, you should never call the autotools manually since you must run
256 them in a specific order with specific arguments. Most of the times, the
257 makefiles will automatically call the tools for you. When it's not possible
258 (such as the first time you checkout the SVN), use the ./bootstrap command
259 to call them explicitly.
260
261
262 \subsection faq_setting_MSG Setting up your own MSG code
263
264 Do not build your simulator by modifying the SimGrid examples.  Go
265 outside the SimGrid source tree and create your own working directory
266 (say <tt>/home/joe/SimGrid/MyFirstScheduler/</tt>).
267
268 Suppose your simulation has the following structure (remember it is
269 just an example to illustrate a possible way to compile everything;
270 feel free to organize it as you want).
271
272       \li <tt>sched.h</tt>: a description of the core of the
273           scheduler (i.e. which functions are can be used by the
274           agents). For example we could find the following functions
275           (master, forwarder, slave).
276
277       \li <tt>sched.c</tt>: a C file including <tt>sched.h</tt> and
278           implementing the core of the scheduler. Most of these
279           functions use the MSG functions defined in section \ref
280           msg_gos_functions.
281
282       \li <tt>masterslave.c</tt>: a C file with the main function, i.e.
283           the MSG initialization (MSG_global_init()), the platform
284           creation (e.g. with MSG_create_environment()), the
285           deployment phase (e.g. with MSG_function_register() and
286           MSG_launch_application()) and the call to
287           MSG_main()).
288
289 To compile such a program, we suggest to use the following
290 Makefile. It is a generic Makefile that we have used many times with
291 our students when we teach the C language.
292
293 \verbatim
294 all: masterslave 
295 masterslave: masterslave.o sched.o
296
297 INSTALL_PATH = $$HOME
298 CC = gcc
299 PEDANTIC_PARANOID_FREAK =       -O0 -Wshadow -Wcast-align \
300                                 -Waggregate-return -Wmissing-prototypes -Wmissing-declarations \
301                                 -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations \
302                                 -Wmissing-noreturn -Wredundant-decls -Wnested-externs \
303                                 -Wpointer-arith -Wwrite-strings -finline-functions
304 REASONABLY_CAREFUL_DUDE =       -Wall
305 NO_PRAYER_FOR_THE_WICKED =      -w -O2 
306 WARNINGS =                      $(REASONABLY_CAREFUL_DUDE)
307 CFLAGS = -g $(WARNINGS)
308
309 INCLUDES = -I$(INSTALL_PATH)/include
310 DEFS = -L$(INSTALL_PATH)/lib/
311 LDADD = -lm -lsimgrid 
312 LIBS = 
313
314 %: %.o
315         $(CC) $(INCLUDES) $(DEFS) $(CFLAGS) $^ $(LIBS) $(LDADD) -o $@ 
316
317 %.o: %.c
318         $(CC) $(INCLUDES) $(DEFS) $(CFLAGS) -c -o $@ $<
319
320 clean:
321         rm -f $(BIN_FILES) *.o *~
322 .SUFFIXES:
323 .PHONY : clean
324
325 \endverbatim
326
327 The first two lines indicates what should be build when typing make
328 (<tt>masterslave</tt>) and of which files it is to be made of
329 (<tt>masterslave.o</tt> and <tt>sched.o</tt>). This makefile assumes
330 that you have set up correctly your <tt>LD_LIBRARY_PATH</tt> variable
331 (look, there is a <tt>LDADD = -lm -lsimgrid</tt>). If you prefer using
332 the static version, remove the <tt>-lsimgrid</tt> and add a
333 <tt>$(INSTALL_PATH)/lib/libsimgrid.a</tt> on the next line, right
334 after the <tt>LIBS = </tt>.
335
336 More generally, if you have never written a Makefile by yourself, type
337 in a terminal : <tt>info make</tt> and read the introduction. The
338 previous example should be enough for a first try but you may want to
339 perform some more complex compilations...
340
341 \subsection faq_setting_GRAS Setting up your own GRAS code
342
343 If you use the GRAS interface instead of the MSG one, then previous section
344 is not the better source of information. Instead, you should check the GRAS
345 tutorial in general, and the \ref GRAS_tut_tour_setup in particular.
346
347 \section faq_cmake CMAKE
348
349 \subsection faq_intro Some generalitty
350
351 \subsubsection faq_intro1 What is Cmake?
352
353 CMake is a family of tools designed to build, test and package software. CMake is used to control the software compilation process using simple platform and compiler independent configuration files. CMake generates native makefiles and workspaces that can be used in the compiler environment of your choice. For more information see official web site <a href="http://www.cmake.org/">here</a>.
354
355 \subsubsection faq_intro2 Why cmake?
356
357 CMake permits to developers to compil projects on different plateform. Then many tools are embedded like ctest for making test, a link to cdash for vizualise results but also test coverage and bug reports. 
358
359 \subsubsection faq_intro3 What cmake need?
360
361 CMake needs some prerequists like :
362   \li make
363   \li c, c++ and java compiler regards to developers
364   \li ccmake for graphical used of CMake
365   \li cmake <a href="http://www.cmake.org/cmake/resources/software.html">(download page)</a>
366
367 \subsubsection faq_intro4 Cmake vs Autotools...
368
369 TODO
370
371 \subsection faq_cmakeoption Cmake options
372
373 \subsubsection faq_cmakeoption1 Liste of options
374
375 \verbatim
376 "cmake -D[name]=[value] ... ./"
377  
378 [name]          enable_gtnets                   [value] ON/OFF or TRUE/FALSE or 1/0
379                 enable_java                             ON/OFF or TRUE/FALSE or 1/0
380                 enable_lua                              ON/OFF or TRUE/FALSE or 1/0
381                 enable_ruby                             ON/OFF or TRUE/FALSE or 1/0
382                 enable_compile_optimizations            ON/OFF or TRUE/FALSE or 1/0
383                 enable_compile_warnings                 ON/OFF or TRUE/FALSE or 1/0
384                 enable_smpi                             ON/OFF or TRUE/FALSE or 1/0
385                 enable_maintainer_mode                  ON/OFF or TRUE/FALSE or 1/0
386                 enable_supernovae                       ON/OFF or TRUE/FALSE or 1/0
387                 enable_tracing                          ON/OFF or TRUE/FALSE or 1/0
388                 enable_coverage                         ON/OFF or TRUE/FALSE or 1/0
389                 enable_memcheck                         ON/OFF or TRUE/FALSE or 1/0 
390                 enable_print_message                    ON/OFF or TRUE/FALSE or 1/0
391
392                 gtnets_path                             <path_to_gtnets_directory>
393                 prefix                                  <path_to_install_directory>
394                 BIBTEX2HTML                             <path_to_bibtex2html>
395                 with_context                            auto/ucontext/pthread/window     
396 \endverbatim
397                                                                                                                                                           
398 \subsubsection faq_cmakeoption2 Options explaination
399
400   \li enable_gtnets : set to true implie that user wants to use gtnets.
401
402   \li enable_java : set to true implie that user wants to add java langage into simgrid compilation.
403
404   \li enable_lua : set to true implie that user wants to add lua langage into simgrid compilation.
405
406   \li enable_ruby : set to true implie that user wants to add ruby langage into simgrid compilation.
407
408   \li enable_compile_optimizations : add flags "-O3 -finline-functions -funroll-loops -fno-strict-aliasing"
409
410   \li enable_compile_warnings : add flags "-Wall -Wunused -Wmissing-prototypes -Wmissing-declarations -Wpointer-arith -Wchar-subscripts -Wcomment -Wformat -Wwrite-strings -Wno-unused-function -Wno-unused-parameter -Wno-strict-aliasing -Wno-format-nonliteral -Werror"
411
412   \li enable_smpi : Set to true if you want to use smpi lib. Actually on simgrid v3.4.1 Mac doesn't support lib smpi.
413
414   \li enable_maintainer_mode : set to true it remakes some files.
415 \verbatim
416 include/surf/simgrid_dtd.h
417 include/xbt/graphxml.h
418
419 src/cunit_unit.c
420 src/ex_unit.c
421 src/dynar_unit.c
422 src/dict_unit.c
423 src/set_unit.c
424 src/swag_unit.c
425 src/xbt_str_unit.c
426 src/xbt_strbuff_unit.c
427 src/xbt_sha_unit.c
428 src/config_unit.c
429 src/xbt_synchro_unit.c
430 src/simgrid_units_main.c
431
432 src/simdag/dax_dtd.c
433 src/simdag/dax_dtd.h
434 src/simdag/dax_dtd.l
435
436 src/surf/simgrid_dtd.c
437 src/surf/simgrid_dtd.l
438
439 src/xbt/graphxml.c
440 src/xbt/graphxml.l
441
442 src/gras/DataDesc/ddt_parse.yy.c
443 \endverbatim
444   \li enable_supernovae : set to true make one file for each lib and compile with those generated files.
445 \verbatim
446 /src/supernovae_sg.c
447 /src/supernovae_gras.c                  
448 /src/supernovae_smpi.c
449 \endverbatim
450
451   \li enable_tracing : To enable the generation of simulation traces for visualization
452
453   \li enable_coverage : When set to true this option enable code coverage by setting -fprofile-arcs -ftest-coverage flags.
454
455   \li enable_memcheck : When set to true this option enable tests for memcheck.
456
457   \li enable_print_message : This option when enable permits to see variables from gras_config.h
458
459   \li gtnets_path : Path to gtnets install directory (ex /usr)
460
461   \li prefix : Path where are installed lib/ doc/ and include/ directories (ex /usr/local)
462
463   \li BIBTEX2HTML : Path where is installed bibtex2html.
464
465   \li with context : specify which context the user wants to use.
466
467 \subsubsection faq_cmakeoption3 Initialisation
468
469 Those options are initialized the first time you launch \"cmake ./\" whithout specified option.
470
471 \verbatim
472 enable_gtnets                   on
473 enable_lua                      on
474 enable_ruby                     on
475 enable_java                     off
476 enable_compile_optimizations    off
477 enable_compile_warnings         off
478 enable_smpi                     on
479 enable_maintainer_mode          off
480 enable_supernovae               off
481 enable_tracing                  off
482 enable_coverage                 off
483 enable_memcheck                 off
484 enable_print_message            off
485
486 gtnets_path                     null
487 prefix                          null
488 BIBTEX2HTML                     null
489 with_context                    auto
490 \endverbatim
491
492 \subsubsection faq_cmakeoption4 Option's cache and how to reset?
493
494 When options have been set they are keep into a cache file named \"CMakeCache.txt\". So if you want 
495 reset values you just delete this file located to the project directory.
496
497 \subsection faq_cmakecompilation Cmake compilation
498
499 \subsubsection faq_cmakecompilation1 With command line.
500
501 \verbatim
502 cmake -D[name]=[value] ... ./
503 make
504 \endverbatim
505
506 \subsubsection faq_cmakecompilation2 With ccmake tool.
507
508 \verbatim
509 "ccmake ./"
510 \endverbatim
511 Then follow instructions.
512
513 \subsubsection faq_cmakecompilation3 Resume of command line
514
515  \li CMake
516 \verbatim
517 cmake ./                configure the project
518 make                    build all targets
519 make VERBOSE=1          build all targets and print build command lines
520 make check              execute command make test
521 make test               test all targets and summarize
522 make dist               make the distrib
523 make distcheck          check the dist (make + make dist + make test) 
524 make install-simgrid    install the project (doc/ lib/ include/)
525 make uninstall          uninstall the project (doc/ lib/ include/)
526 make clean              clean all targets
527 make java-clean         clean files created by java option
528 make doc-clean          clean files created for making doc
529 make supernovae-clean   clean supernovae files
530 make maintainer-clean   clean maintainer files
531 make all-clean          execute the 5 upper clean command
532 make html               Create simgrid documentation
533 make maintainer-clean   Remove all files generated by mainainer mode
534 \endverbatim
535
536 When the project have been succesfully compiling and build you can make tests.
537
538  \li CTest
539 \verbatim
540 ctest                   launch only tests
541 ctest -D Continuous
542 ctest -D Continuous(Start|Update|Configure|Build)
543 ctest -D Continuous(Test|Coverage|MemCheck|Submit)
544 ctest -D Experimental
545 ctest -D Experimental(Start|Update|Configure|Build)
546 ctest -D Experimental(Test|Coverage|MemCheck|Submit)
547 ctest -D Nightly                                
548 ctest -D Nightly(Start|Update|Configure|Build)
549 ctest -D Nightly(Test|Coverage|MemCheck|Submit)
550 ctest -D NightlyMemoryCheck
551 \endverbatim
552
553 If you want to test before make a commit you can simply make "ctest -D Experimental" and then you can visualize results submitted into Cdash. <a href="http://cdash.inria.fr/CDash/index.php?project=Simgrid">(Go to Cdash site)</a>.
554
555 \subsubsection faq_cmakecompilation4 Examples for different mode.
556
557 \li Mode maintainer
558
559 cmake -Denable_maintainer_mode=on ./
560 \verbatim 
561 -- lookign for config.h
562 with_context auto change to ucontext
563 GIT_DATE        : 2010-05-04~09-59-15
564 GIT_VERSION     : 53ec816
565 GIT_SVN_VERSION : 7669
566
567 Configuration of package `simgrid' (revision 7669) on arch (=4):
568              BUILDNAME :        UCONTEXT
569              SITE      :        Linux_2.6.31-21-generic_x86_64
570              Release   :        simgrid-3.4~rev7669
571
572          Compiler: c++ :        /usr/bin/c++
573                 version:        c++ (Ubuntu 4.4.1-4ubuntu9) 4.4.1
574          Compiler: c   :        /usr/bin/gcc
575                 version:        gcc (Ubuntu 4.4.1-4ubuntu9) 4.4.1
576
577                CFlags  :        -I/usr/lib/ruby/1.8/x86_64-linux -I/usr/include/lua5.1 -g3
578                CPPFlags:        
579                LDFlags :        -L/usr/lib/
580
581         Context backend:        ucontext
582         Compile Gtnets :        0
583         Gtnets path    :        
584         Compile Java   :        0
585         Compile Lua    :        1
586         Compile Ruby   :        1
587
588         Compile Smpi   :        ON
589         Maintainer mode:        ON
590         Supernovae mode:        OFF
591         Tracing mode   :        OFF
592
593         Simgrid dependencies:   -lm -lruby1.8 -module -ldl -llua5.1 -lrt
594         Gras dependencies   :   -lm -lpthread -lrt
595         Smpi dependencies   :   
596
597         INSTALL_PREFIX:         /usr/local
598
599 -- Configuring done
600 -- Generating done
601 -- Build files have been written to: /home/navarrop/Developments/simgrid
602 \endverbatim
603
604 \li Mode supernovae
605
606 cmake -Dsupernovae=on ./
607 \verbatim 
608 -- lookign for config.h
609 with_context auto change to ucontext
610 GIT_DATE        : 2010-05-04~09-59-15
611 GIT_VERSION     : 53ec816
612 GIT_SVN_VERSION : 7669
613
614 Configuration of package `simgrid' (revision 7669) on arch (=4):
615              BUILDNAME :        SUPERNOVAE
616              SITE      :        Linux_2.6.31-21-generic_x86_64
617              Release   :        simgrid-3.4~rev7669
618
619          Compiler: c++ :        /usr/bin/c++
620                 version:        c++ (Ubuntu 4.4.1-4ubuntu9) 4.4.1
621          Compiler: c   :        /usr/bin/gcc
622                 version:        gcc (Ubuntu 4.4.1-4ubuntu9) 4.4.1
623
624                CFlags  :        -O3 -finline-functions -funroll-loops -fno-strict-aliasing -Wall -Wunused -Wmissing-prototypes -Wmissing-declarations -Wpointer-arith -Wchar-subscripts -Wcomment -Wformat -Wwrite-strings -Wno-unused-function -Wno-unused-parameter -Wno-strict-aliasing -Wno-format-nonliteral -Werror -I/usr/lib/ruby/1.8/x86_64-linux -I/usr/include/lua5.1 -g3
625                CPPFlags:        
626                LDFlags :        -L/usr/lib/
627
628         Context backend:        ucontext
629         Compile Gtnets :        0
630         Gtnets path    :        
631         Compile Java   :        0
632         Compile Lua    :        1
633         Compile Ruby   :        1
634
635         Compile Smpi   :        ON
636         Maintainer mode:        OFF
637         Supernovae mode:        OFF
638         Tracing mode   :        OFF
639
640         Simgrid dependencies:   -lm -lruby1.8 -module -ldl -llua5.1 -lrt
641         Gras dependencies   :   -lm -lpthread -lrt
642         Smpi dependencies   :   
643
644         INSTALL_PREFIX:         /usr/local
645
646 -- Configuring done
647 -- Generating done
648 -- Build files have been written to: /home/navarrop/Developments/simgrid
649
650 \endverbatim
651
652 \li Mode GTnetS
653
654 cmake -Dgtnets_path=/home/navarrop/Bureau/usr/ ./
655 \verbatim 
656 -- lookign for config.h
657 with_context auto change to ucontext
658 GIT_DATE        : 2010-05-04~09-59-15
659 GIT_VERSION     : 53ec816
660 GIT_SVN_VERSION : 7669
661
662 Configuration of package `simgrid' (revision 7669) on arch (=4):
663              BUILDNAME :        GTNETS
664              SITE      :        Linux_2.6.31-21-generic_x86_64
665              Release   :        simgrid-3.4~rev7669
666
667          Compiler: c++ :        /usr/bin/c++
668                 version:        c++ (Ubuntu 4.4.1-4ubuntu9) 4.4.1
669          Compiler: c   :        /usr/bin/gcc
670                 version:        gcc (Ubuntu 4.4.1-4ubuntu9) 4.4.1
671
672                CFlags  :        -O3 -finline-functions -funroll-loops -fno-strict-aliasing -Wall -Wunused -Wmissing-prototypes -Wmissing-declarations -Wpointer-arith -Wchar-subscripts -Wcomment -Wformat -Wwrite-strings -Wno-unused-function -Wno-unused-parameter -Wno-strict-aliasing -Wno-format-nonliteral -Werror -I/usr/lib/ruby/1.8/x86_64-linux -L/usr/lib -I/usr/include/gtnets -I/usr/include/lua5.1 -g3
673                CPPFlags:        -L/usr/lib -I/usr/include/gtnets 
674                LDFlags :        -L/usr/lib/
675
676         Context backend:        ucontext
677         Compile Gtnets :        1
678         Gtnets path    :        /usr
679         Compile Java   :        0
680         Compile Lua    :        1
681         Compile Ruby   :        1
682
683         Compile Smpi   :        ON
684         Maintainer mode:        OFF
685         Supernovae mode:        OFF
686         Tracing mode   :        OFF
687
688         Simgrid dependencies:   -lm -lruby1.8 -module -ldl -llua5.1 -lgtnets -lrt
689         Gras dependencies   :   -lm -lpthread -lrt
690         Smpi dependencies   :   
691
692         INSTALL_PREFIX:         /usr/local
693
694 -- Configuring done
695 -- Generating done
696 -- Build files have been written to: /home/navarrop/Developments/simgrid
697
698 \endverbatim
699
700 \subsection faq_cmakeinstall How to install with cmake?
701
702 \subsubsection faq_cmakeinstall1 From svn. 
703
704 \verbatim
705 cmake -Denable_maintainer_mode=on -Dprefix=/home/navarrop/Bureau/install_simgrid ./
706 make 
707 make install-simgrid
708 \endverbatim
709
710 \subsubsection faq_cmakeinstall2 From a distrib
711
712 \verbatim
713 cmake -Dprefix=/home/navarrop/Bureau/install_simgrid ./
714 make
715 make install-simgrid
716 \endverbatim
717
718 \subsection faq_cmakehowto How to modified sources files for developers
719
720 \subsubsection faq_cmakehowto1 Add an executable or examples.
721
722 If you want make an executable you have to create a CMakeList.txt to the src directory. 
723 You must specified where to create the executable, source list, dependencies and the name of the binary.
724
725 \verbatim
726 cmake_minimum_required(VERSION 2.6)
727
728 set(EXECUTABLE_OUTPUT_PATH "./")                        
729 set(LIBRARY_OUTPUT_PATH "${PROJECT_DIRECTORY}/lib")
730
731 add_executable(get_sender get_sender.c)                                 #add_executable(<name_of_target> <src list>)
732
733 ### Add definitions for compile
734 target_link_libraries(get_sender simgrid m pthread -fprofile-arcs)      #target_link_libraries(<name_of_targe> <dependencies>)
735 \endverbatim
736
737 Then you have to modified <project/directory>/buildtools/Cmake/src/CMakeMakeExeLib.txt and add 
738 this line :
739 \verbatim
740 add_subdirectory(${PROJECT_DIRECTORY}/<path_where_is_CMakeList.txt>)
741 \endverbatim
742
743 \subsubsection faq_cmakehowto2 Delete/add sources to lib.
744
745 If you want modified, add or delete source files from a library you have to edit <project/directory>/buildtools/Cmake/src/CMakeDefinePackages.txt
746
747 \verbatim
748 set(JMSG_JAVA_SRC
749         ${PROJECT_DIRECTORY}/src/java/simgrid/msg/MsgException.java
750         ${PROJECT_DIRECTORY}/src/java/simgrid/msg/JniException.java
751         ${PROJECT_DIRECTORY}/src/java/simgrid/msg/NativeException.java
752         ${PROJECT_DIRECTORY}/src/java/simgrid/msg/HostNotFoundException.java
753         ${PROJECT_DIRECTORY}/src/java/simgrid/msg/ProcessNotFoundException.java
754         ${PROJECT_DIRECTORY}/src/java/simgrid/msg/Msg.java
755         ${PROJECT_DIRECTORY}/src/java/simgrid/msg/Process.java
756         ${PROJECT_DIRECTORY}/src/java/simgrid/msg/Host.java
757         ${PROJECT_DIRECTORY}/src/java/simgrid/msg/Task.java
758         ${PROJECT_DIRECTORY}/src/java/simgrid/msg/MsgNative.java
759         ${PROJECT_DIRECTORY}/src/java/simgrid/msg/ApplicationHandler.java
760         ${PROJECT_DIRECTORY}/src/java/simgrid/msg/Sem.java
761 )
762 \endverbatim
763
764 \subsubsection faq_cmakehowto3 Add test
765
766 If you want modified, add or delete tests you have to edit <project/directory>/buildtools/Cmake/src/CMakeTest.txt 
767 with this function : ADD_TEST(<name> <bin> <ARGS>)
768
769 \verbatim
770 add_test(test-simdag-1 ${PROJECT_DIRECTORY}/testsuite/simdag/sd_test --cfg=path:${PROJECT_DIRECTORY}/testsuite/simdag small_platform_variable.xml)
771 \endverbatim
772
773 \subsection faq_cmakeExplain Explaination of sources files for cmake
774
775 \li CMakeLists.txt
776
777 Those files are the "main parts". One located at the project directory call all the cmake sources files. The others
778 are little projects called by the first for make examples.
779
780 \li CMakeCompleteInFiles.txt
781
782 Complete all .in files and define Variables for h files
783
784 \li CMakeDocs.txt
785
786 This file make the html documentation.
787
788 \li CMakeMakeExeLib.txt
789
790 Here are callled all "CMakeLists.txt" for make executables and libraries.
791
792 \li CMakePrintArgs.txt
793
794 This file is called at the end of the build for summarize environment variables.
795
796 \li CMakeDefinePackages.txt
797
798 Here is defined sources packages for compiling libs.
799
800 \li CMakeFlags.txt
801
802 Defined flags which are used for compiling sources.
803
804 \li CMakeSupernovae.txt
805
806 Here are made files for the supernovae mode.
807
808 \li CMakeDistrib.txt
809
810 Here is defined packages for install simgrid and make a distribution.
811
812 \li CMakeMaintainerMode.txt
813
814 Part where are generated source files for maintainer mode.
815
816 \li CMakeOption.txt
817
818 Here are defined options and initialized values.
819
820 \li CMakeTest.txt
821
822 All tests are listed.
823
824 \li CTestConfig.cmake
825
826 Properties which link tests with dashboard.
827
828 \subsection faq_cmakeList List of files added for cmake
829
830 Here is a list of files involved into cmake build (relative to project directory path) :
831 \verbatim
832
833 Cmake sources:
834         ./doc/CMakeLists.txt
835         ./buildtools/Cmake/src/CMakeCompleteInFiles.txt
836         ./buildtools/Cmake/src/CMakeDocs.txt
837         ./buildtools/Cmake/src/CMakeMakeExeLib.txt
838         ./buildtools/Cmake/src/CMakePrintArgs.txt
839         ./buildtools/Cmake/src/CMakeDefinePackages.txt
840         ./buildtools/Cmake/src/CMakeFlags.txt
841         ./buildtools/Cmake/src/CMakeSupernovae.txt
842         ./buildtools/Cmake/src/CMakeDistrib.txt
843         ./buildtools/Cmake/src/CMakeMaintainerMode.txt
844         ./buildtools/Cmake/src/CMakeOption.txt
845         ./buildtools/Cmake/src/CMakeTest.txt
846         ./buildtools/Cmake/src/CTestConfig.cmake
847
848 Test files for define properties :
849         ./buildtools/Cmake/prog_test/prog_GRAS_ARCH.c
850         ./buildtools/Cmake/prog_test/prog_max_size.c
851         ./buildtools/Cmake/prog_test/prog_sem_init.c
852         ./buildtools/Cmake/prog_test/prog_stackgrowth.c
853         ./buildtools/Cmake/prog_test/prog_vsnprintf.c
854         ./buildtools/Cmake/prog_test/prog_AC_CHECK_MCSC.c
855         ./buildtools/Cmake/prog_test/prog_GRAS_CHECK_STRUCT_COMPACTION.c
856         ./buildtools/Cmake/prog_test/prog_mutex_timedlock.c
857         ./buildtools/Cmake/prog_test/prog_sem_timedwait.c
858         ./buildtools/Cmake/prog_test/prog_stacksetup.c
859         ./buildtools/Cmake/prog_test/prog_getline.c
860         ./buildtools/Cmake/prog_test/prog_gtnets.cpp
861         ./buildtools/Cmake/prog_test/prog_printf_null.c
862         ./buildtools/Cmake/prog_test/prog_snprintf.c
863         ./buildtools/Cmake/prog_test/prog_va_copy.c
864
865 CMakeLists for each binaries or examples:
866         ./CMakeLists.txt
867         ./src/CMakeLists.txt
868         ./teshsuite/gras/empty_main/CMakeLists.txt
869         ./teshsuite/gras/small_sleep/CMakeLists.txt
870         ./teshsuite/gras/datadesc/CMakeLists.txt
871         ./teshsuite/gras/msg_handle/CMakeLists.txt
872         ./teshsuite/simdag/CMakeLists.txt
873         ./teshsuite/simdag/partask/CMakeLists.txt
874         ./teshsuite/simdag/platforms/CMakeLists.txt
875         ./teshsuite/simdag/network/CMakeLists.txt
876         ./teshsuite/simdag/network/mxn/CMakeLists.txt
877         ./teshsuite/simdag/network/p2p/CMakeLists.txt
878         ./teshsuite/xbt/CMakeLists.txt
879         ./teshsuite/msg/CMakeLists.txt
880         ./tools/gras/CMakeLists.txt
881         ./tools/tesh/CMakeLists.txt
882         ./testsuite/simdag/CMakeLists.txt
883         ./testsuite/xbt/CMakeLists.txt
884         ./testsuite/surf/CMakeLists.txt
885         ./examples/gras/properties/CMakeLists.txt
886         ./examples/gras/ping/CMakeLists.txt
887         ./examples/gras/pmm/CMakeLists.txt
888         ./examples/gras/mmrpc/CMakeLists.txt
889         ./examples/gras/synchro/CMakeLists.txt
890         ./examples/gras/timer/CMakeLists.txt
891         ./examples/gras/mutual_exclusion/simple_token/CMakeLists.txt
892         ./examples/gras/spawn/CMakeLists.txt
893         ./examples/gras/chrono/CMakeLists.txt
894         ./examples/gras/rpc/CMakeLists.txt
895         ./examples/gras/all2all/CMakeLists.txt
896         ./examples/simdag/properties/CMakeLists.txt
897         ./examples/simdag/CMakeLists.txt
898         ./examples/simdag/metaxml/CMakeLists.txt
899         ./examples/simdag/dax/CMakeLists.txt
900         ./examples/smpi/CMakeLists.txt
901         ./examples/amok/bandwidth/CMakeLists.txt
902         ./examples/amok/saturate/CMakeLists.txt
903         ./examples/msg/priority/CMakeLists.txt
904         ./examples/msg/properties/CMakeLists.txt
905         ./examples/msg/migration/CMakeLists.txt
906         ./examples/msg/gtnets/CMakeLists.txt
907         ./examples/msg/parallel_task/CMakeLists.txt
908         ./examples/msg/trace/CMakeLists.txt
909         ./examples/msg/suspend/CMakeLists.txt
910         ./examples/msg/masterslave/CMakeLists.txt
911         ./examples/msg/actions/CMakeLists.txt
912         ./examples/msg/sendrecv/CMakeLists.txt
913 \endverbatim
914
915 \section faq_howto Feature related questions
916
917 \subsection faq_MIA "Could you please add (your favorite feature here) to SimGrid?"
918
919 Here is the deal. The whole SimGrid project (MSG, SURF, GRAS, ...) is
920 meant to be kept as simple and generic as possible. We cannot add
921 functions for everybody's needs when these functions can easily be
922 built from the ones already in the API. Most of the time, it is
923 possible and when it was not possible we always have upgraded the API
924 accordingly. When somebody asks us a question like "How to do that?
925 Is there a function in the API to simply do this?", we're always glad
926 to answer and help. However if we don't need this code for our own
927 need, there is no chance we're going to write it... it's your job! :)
928 The counterpart to our answers is that once you come up with a neat
929 implementation of this feature (task duplication, RPC, thread
930 synchronization, ...), you should send it to us and we will be glad to
931 add it to the distribution. Thus, other people will take advantage of
932 it (and we don't have to answer this question again and again ;).
933
934 You'll find in this section a few "Missing In Action" features. Many
935 people have asked about it and we have given hints on how to simply do
936 it with MSG. Feel free to contribute...
937
938 \subsection faq_MIA_MSG MSG features
939
940 \subsubsection faq_MIA_examples I want some more complex MSG examples!
941
942 Many people have come to ask me a more complex example and each time,
943 they have realized afterward that the basics were in the previous three
944 examples. 
945
946 Of course they have often been needing more complex functions like
947 MSG_process_suspend(), MSG_process_resume() and
948 MSG_process_isSuspended() (to perform synchronization), or
949 MSG_task_Iprobe() and MSG_process_sleep() (to avoid blocking
950 receptions), or even MSG_process_create() (to design asynchronous
951 communications or computations). But the examples are sufficient to
952 start.
953
954 We know. We should add some more examples, but not really some more
955 complex ones... We should add some examples that illustrate some other
956 functionalists (like how to simply encode asynchronous
957 communications, RPC, process migrations, thread synchronization, ...)
958 and we will do it when we will have a little bit more time. We have
959 tried to document the examples so that they are understandable. Tell
960 us if something is not clear and once again feel free to participate!
961 :)
962
963 \subsubsection faq_MIA_taskdup Missing in action: MSG Task duplication/replication
964
965 There is no task duplication in MSG. When you create a task, you can
966 process it or send it somewhere else. As soon as a process has sent
967 this task, he doesn't have this task anymore. It's gone. The receiver
968 process has got the task. However, you could decide upon receiving to
969 create a "copy" of a task but you have to handle by yourself the
970 semantic associated to this "duplication".
971
972 As we already told, we prefer keeping the API as simple as
973 possible. This kind of feature is rather easy to implement by users
974 and the semantic you associate really depends on people. Having a
975 *generic* task duplication mechanism is not that trivial (in
976 particular because of the data field). That is why I would recommand
977 that you write it by yourself even if I can give you advice on how to
978 do it.
979
980 You have the following functions to get informations about a task:
981 MSG_task_get_name(), MSG_task_get_compute_duration(),
982 MSG_task_get_remaining_computation(), MSG_task_get_data_size(),
983 and MSG_task_get_data().
984
985 You could use a dictionary (#xbt_dict_t) of dynars (#xbt_dynar_t). If
986 you still don't see how to do it, please come back to us...
987
988 \subsubsection faq_MIA_asynchronous I want to do asynchronous communications in MSG
989
990 Up until now, there is no asynchronous communications in MSG. However,
991 you can create as many process as you want so you should be able to do
992 whatever you want... I've written a queue module to help implementing
993 some asynchronous communications at low cost (creating thousands of
994 process only to handle communications may be problematic in term of
995 performance at some point). I'll add it in the distribution asap.
996
997 \subsubsection faq_MIA_thread_synchronization I need to synchronize my MSG processes
998
999 You obviously cannot use pthread_mutexes of pthread_conds. The best
1000 thing would be to propose similar structures. Unfortunately, we
1001 haven't found time to do it yet. However you can try to play with
1002 MSG_process_suspend() and MSG_process_resume(). You can even do some
1003 synchronization with fake communications (using MSG_task_get(),
1004 MSG_task_put() and MSG_task_Iprobe()).
1005
1006 \subsubsection faq_MIA_host_load Where is the get_host_load function hidden in MSG?
1007
1008 There is no such thing because its semantic wouldn't be really
1009 clear. Of course, it is something about the amount of host throughput,
1010 but there is as many definition of "host load" as people asking for
1011 this function. First, you have to remember that resource availability
1012 may vary over time, which make any load notion harder to define.
1013
1014 It may be instantaneous value or an average one. Moreover it may be only the
1015 power of the computer, or may take the background load into account, or may
1016 even take the currently running tasks into account. In some SURF models,
1017 communications have an influence on computational power. Should it be taken
1018 into account too?
1019
1020 First of all, it's near to impossible to predict the load beforehands in the
1021 simulator since it depends on too much parameters (background load
1022 variation, bandwidth sharing algorithmic complexity) some of them even being
1023 not known beforehands (other task starting at the same time). So, getting
1024 this information is really hard (just like in real life). It's not just that
1025 we want MSG to be as painful as real life. But as it is in some way
1026 realistic, we face some of the same problems as we would face in real life.
1027
1028 How would you do it for real? The most common option is to use something
1029 like NWS that performs active probes. The best solution is probably to do
1030 the same within MSG, as in next code snippet. It is very close from what you
1031 would have to do out of the simulator, and thus gives you information that
1032 you could also get in real settings to not hinder the realism of your
1033 simulation. 
1034
1035 \verbatim
1036 double get_host_load() {
1037    m_task_t task = MSG_task_create("test", 0.001, 0, NULL);
1038    double date = MSG_get_clock();
1039
1040    MSG_task_execute(task);
1041    date = MSG_get_clock() - date;
1042    MSG_task_destroy(task);
1043    return (0.001/date);
1044 }
1045 \endverbatim
1046
1047 Of course, it may not match your personal definition of "host load". In this
1048 case, please detail what you mean on the mailing list, and we will extend
1049 this FAQ section to fit your taste if possible.
1050
1051 \subsubsection faq_MIA_communication_time How can I get the *real* communication time?  
1052
1053 Communications are synchronous and thus if you simply get the time
1054 before and after a communication, you'll only get the transmission
1055 time and the time spent to really communicate (it will also take into
1056 account the time spent waiting for the other party to be
1057 ready). However, getting the *real* communication time is not really
1058 hard either. The following solution is a good starting point.
1059
1060 \verbatim
1061 int sender()
1062 {
1063   m_task_t task = MSG_task_create("Task", task_comp_size, task_comm_size, 
1064                                   calloc(1,sizeof(double)));
1065   *((double*) task->data) = MSG_get_clock();
1066   MSG_task_put(task, slaves[i % slaves_count], PORT_22);
1067   INFO0("Send completed");
1068   return 0;
1069 }
1070 int receiver()
1071 {
1072   m_task_t task = NULL;
1073   double time1,time2;
1074
1075   time1 = MSG_get_clock();
1076   a = MSG_task_get(&(task), PORT_22);
1077   time2 = MSG_get_clock();
1078   if(time1<*((double *)task->data))
1079      time1 = *((double *) task->data);
1080   INFO1("Communication time :  \"%f\" ", time2-time1);
1081   free(task->data);
1082   MSG_task_destroy(task);
1083   return 0;
1084 }
1085 \endverbatim
1086
1087 \subsection faq_MIA_SimDag SimDag related questions
1088
1089 \subsubsection faq_SG_comm Implementing communication delays between tasks.
1090
1091 A classic question of SimDag newcomers is about how to express a
1092 communication delay between tasks. The thing is that in SimDag, both
1093 computation and communication are seen as tasks.  So, if you want to
1094 model a data dependency between two DAG tasks t1 and t2, you have to
1095 create 3 SD_tasks: t1, t2 and c and add dependencies in the following
1096 way:
1097
1098 \verbatim
1099 SD_task_dependency_add(NULL, NULL, t1, c);
1100 SD_task_dependency_add(NULL, NULL, c, t2);
1101 \endverbatim
1102
1103 This way task t2 cannot start before the termination of communication c
1104 which in turn cannot start before t1 ends.
1105
1106 When creating task c, you have to associate an amount of data (in bytes)
1107 corresponding to what has to be sent by t1 to t2.
1108
1109 Finally to schedule the communication task c, you have to build a list
1110 comprising the workstations on which t1 and t2 are scheduled (w1 and w2
1111 for example) and build a communication matrix that should look like
1112 [0;amount ; 0; 0].
1113
1114 \subsubsection faq_SG_DAG How to implement a distributed dynamic scheduler of DAGs.
1115
1116 Distributed is somehow "contagious". If you start making distributed
1117 decisions, there is no way to handle DAGs directly anymore (unless I
1118 am missing something). You have to encode your DAGs in term of
1119 communicating process to make the whole scheduling process
1120 distributed. Here is an example of how you could do that. Assume T1
1121 has to be done before T2.
1122
1123 \verbatim
1124  int your_agent(int argc, char *argv[] {
1125    ...
1126    T1 = MSG_task_create(...);
1127    T2 = MSG_task_create(...);
1128    ...
1129    while(1) {
1130      ...
1131      if(cond) MSG_task_execute(T1);
1132      ...
1133      if((MSG_task_get_remaining_computation(T1)=0.0) && (you_re_in_a_good_mood))
1134         MSG_task_execute(T2)
1135      else {
1136         /* do something else */
1137      }
1138    }
1139  }
1140 \endverbatim
1141  
1142 If you decide that the distributed part is not that much important and that
1143 DAG is really the level of abstraction you want to work with, then you should
1144 give a try to \ref SD_API.
1145
1146 \subsection faq_MIA_generic Generic features
1147
1148 \subsubsection faq_more_processes Increasing the amount of simulated processes
1149
1150 Here are a few tricks you can apply if you want to increase the amount
1151 of processes in your simulations.
1152
1153  - <b>A few thousands of simulated processes</b> (soft tricks)\n
1154    SimGrid can use either pthreads library or the UNIX98 contextes. On
1155    most systems, the number of pthreads is limited and then your
1156    simulation may be limited for a stupid reason. This is especially
1157    true with the current linux pthreads, and I cannot get more than
1158    2000 simulated processes with pthreads on my box. The UNIX98
1159    contexts allow me to raise the limit to 25,000 simulated processes
1160    on my laptop.\n\n
1161    The <tt>--with-context</tt> option of the <tt>./configure</tt>
1162    script allows you to choose between UNIX98 contextes
1163    (<tt>--with-context=ucontext</tt>) and the pthread version
1164    (<tt>--with-context=pthread</tt>). The default value is ucontext
1165    when the script detect a working UNIX98 context implementation. On
1166    Windows boxes, the provided value is discarded and an adapted
1167    version is picked up.\n\n
1168    We experienced some issues with contextes on some rare systems
1169    (solaris 8 and lower or old alpha linuxes comes to mind). The main
1170    problem is that the configure script detect the contextes as being
1171    functional when it's not true. If you happen to use such a system,
1172    switch manually to the pthread version, and provide us with a good
1173    patch for the configure script so that it is done automatically ;)
1174
1175  - <b>Hundred thousands of simulated processes</b> (hard-core tricks)\n 
1176    As explained above, SimGrid can use UNIX98 contextes to represent
1177    and handle the simulated processes. Thanks to this, the main
1178    limitation to the number of simulated processes becomes the
1179    available memory.\n\n
1180    Here are some tricks I had to use in order to run a token ring
1181    between 25,000 processes on my laptop (1Gb memory, 1.5Gb swap).\n
1182    - First of all, make sure your code runs for a few hundreds
1183      processes before trying to push the limit. Make sure it's
1184      valgrind-clean, ie that valgrind does not report neither memory
1185      error nor memory leaks. Indeed, numerous simulated processes
1186      result in *fat* simulation hindering debugging.
1187    - It was really boring to write 25,000 entries in the deployment
1188      file, so I wrote a little script
1189      <tt>examples/gras/mutual_exclusion/simple_token/make_deployment.pl</tt>, which you may
1190      want to adapt to your case. You could also think about hijacking
1191      the SURFXML parser (have look at \ref faq_flexml_bypassing).
1192    - The deployment file became quite big, so I had to do what is in
1193      the FAQ entry \ref faq_flexml_limit
1194    - Each UNIX98 context has its own stack entry. As debugging this is
1195      quite hairly, the default value is a bit overestimated so that
1196      user don't get into trouble about this. You want to tune this
1197      size to increse the number of processes. This is the
1198      <tt>STACK_SIZE</tt> define in 
1199      <tt>src/xbt/xbt_context_sysv.c</tt>, which is 128kb by default.
1200      Reduce this as much as you can, but be warned that if this value
1201      is too low, you'll get a segfault. The token ring example, which
1202      is quite simple, runs with 40kb stacks.     
1203    - You may tweak the logs to reduce the stack size further.  When
1204      logging something, we try to build the string to display in a
1205      char array on the stack. The size of this array is constant (and
1206      equal to XBT_LOG_BUFF_SIZE, defined in include/xbt/log/h). If the
1207      string is too large to fit this buffer, we move to a dynamically
1208      sized buffer. In which case, we have to traverse one time the log
1209      event arguments to compute the size we need for the buffer,
1210      malloc it, and traverse the argument list again to do the actual
1211      job.\n     
1212      The idea here is to move XBT_LOG_BUFF_SIZE to 1, forcing the logs
1213      to use a dynamic array each time. This allows us to lower further
1214      the stack size at the price of some performance loss...\n
1215      This allowed me to run the reduce the stack size to ... 4k. Ie,
1216      on my 1Gb laptop, I can run more than 250,000 processes!
1217
1218 \subsubsection faq_MIA_batch_scheduler Is there a native support for batch schedulers in SimGrid?
1219
1220 No, there is no native support for batch schedulers and none is
1221 planned because this is a very specific need (and doing it in a
1222 generic way is thus very hard). However some people have implemented
1223 their own batch schedulers. Vincent Garonne wrote one during his PhD
1224 and put his code in the contrib directory of our SVN so that other can
1225 keep working on it. You may find inspiring ideas in it.
1226
1227 \subsubsection faq_MIA_checkpointing I need a checkpointing thing
1228
1229 Actually, it depends on whether you want to checkpoint the simulation, or to
1230 simulate checkpoints. 
1231
1232 The first one could help if your simulation is a long standing process you
1233 want to keep running even on hardware issues. It could also help to
1234 <i>rewind</i> the simulation by jumping sometimes on an old checkpoint to
1235 cancel recent calculations.\n 
1236 Unfortunately, such thing will probably never exist in SG. One would have to
1237 duplicate all data structures because doing a rewind at the simulator level
1238 is very very hard (not talking about the malloc free operations that might
1239 have been done in between). Instead, you may be interested in the Libckpt
1240 library (http://www.cs.utk.edu/~plank/plank/www/libckpt.html). This is the
1241 checkpointing solution used in the condor project, for example. It makes it
1242 easy to create checkpoints (at the OS level, creating something like core
1243 files), and rerunning them on need.
1244
1245 If you want to simulate checkpoints instead, it means that you want the
1246 state of an executing task (in particular, the progress made towards
1247 completion) to be saved somewhere.  So if a host (and the task executing on
1248 it) fails (cf. #MSG_HOST_FAILURE), then the task can be restarted
1249 from the last checkpoint.\n
1250
1251 Actually, such a thing does not exists in SimGrid either, but it's just
1252 because we don't think it is fundamental and it may be done in the user code
1253 at relatively low cost. You could for example use a watcher that
1254 periodically get the remaining amount of things to do (using
1255 MSG_task_get_remaining_computation()), or fragment the task in smaller
1256 subtasks.
1257
1258 \subsection faq_platform Platform building and Dynamic resources
1259
1260 \subsubsection faq_platform_example Where can I find SimGrid platform files?
1261
1262 There is several little examples in the archive, in the examples/msg
1263 directory. From time to time, we are asked for other files, but we
1264 don't have much at hand right now. 
1265
1266 You should refer to the Platform Description Archive
1267 (http://pda.gforge.inria.fr) project to see the other platform file we
1268 have available, as well as the Simulacrum simulator, meant to generate
1269 SimGrid platforms using all classical generation algorithms.
1270
1271 \subsubsection faq_platform_alnem How can I automatically map an existing platform?
1272
1273 We are working on a project called ALNeM (Application-Level Network
1274 Mapper) which goal is to automatically discover the topology of an
1275 existing network. Its output will be a platform description file
1276 following the SimGrid syntax, so everybody will get the ability to map
1277 their own lab network (and contribute them to the catalog project).
1278 This tool is not ready yet, but it move quite fast forward. Just stay
1279 tuned.
1280
1281 \subsubsection faq_platform_synthetic Generating synthetic but realistic platforms
1282
1283 The third possibility to get a platform file (after manual or
1284 automatic mapping of real platforms) is to generate synthetic
1285 platforms. Getting a realistic result is not a trivial task, and
1286 moreover, nobody is really able to define what "realistic" means when
1287 speaking of topology files. You can find some more thoughts on this
1288 topic in these
1289 <a href="http://graal.ens-lyon.fr/~alegrand/articles/Simgrid-Introduction.pdf">slides</a>.
1290
1291 If you are looking for an actual tool, there we have a little tool to
1292 annotate Tiers-generated topologies. This perl-script is in
1293 <tt>tools/platform_generation/</tt> directory of the SVN. Dinda et Al.
1294 released a very comparable tool, and called it GridG.
1295
1296 \subsubsection faq_SURF_dynamic Expressing dynamic resource availability in platform files
1297
1298 A nice feature of SimGrid is that it enables you to seamlessly have
1299 resources whose availability change over time. When you build a
1300 platform, you generally declare hosts like that:
1301
1302 \verbatim
1303   <host id="host A" power="100.00"/>
1304 \endverbatim 
1305
1306 If you want the availability of "host A" to change over time, the only
1307 thing you have to do is change this definition like that:
1308
1309 \verbatim
1310   <host id="host A" power="100.00" availability_file="trace_A.txt" state_file="trace_A_failure.txt"/>
1311 \endverbatim
1312
1313 For hosts, availability files are expressed in fraction of available
1314 power. Let's have a look at what "trace_A.txt" may look like:
1315
1316 \verbatim
1317 PERIODICITY 1.0
1318 0.0 1.0
1319 11.0 0.5
1320 20.0 0.9
1321 \endverbatim
1322
1323 At time 0, our host will deliver 100 flop/s. At time 11.0, it will
1324 deliver only 50 flop/s until time 20.0 where it will will start
1325 delivering 90 flop/s. Last at time 21.0 (20.0 plus the periodicity
1326 1.0), we'll be back to the beginning and it will deliver 100 flop/s.
1327
1328 Now let's look at the state file:
1329 \verbatim
1330 PERIODICITY 10.0
1331 1.0 -1.0
1332 2.0 1.0
1333 \endverbatim
1334
1335 A negative value means "off" while a positive one means "on". At time
1336 1.0, the host is on. At time 1.0, it is turned off and at time 2.0, it
1337 is turned on again until time 12 (2.0 plus the periodicity 10.0). It
1338 will be turned on again at time 13.0 until time 23.0, and so on.
1339
1340 Now, let's look how the same kind of thing can be done for network
1341 links. A usual declaration looks like:
1342
1343 \verbatim
1344   <link id="LinkA" bandwidth="10.0" latency="0.2"/>
1345 \endverbatim
1346
1347 You have at your disposal the following options: bandwidth_file,
1348 latency_file and state_file. The only difference with hosts is that
1349 bandwidth_file and latency_file do not express fraction of available
1350 power but are expressed directly in bytes per seconds and seconds.
1351
1352 \subsubsection faq_platform_multipath How to express multipath routing in platform files?
1353
1354 It is unfortunately impossible to express the fact that there is more
1355 than one routing path between two given hosts. Let's consider the
1356 following platform file:
1357
1358 \verbatim
1359 <route src="A" dst="B">
1360    <link:ctn id="1"/>
1361 </route>
1362 <route src="B" dst="C">
1363   <link:ctn id="2"/>
1364 </route>
1365 <route src="A" dst="C">
1366   <link:ctn id="3"/>
1367 </route>
1368 \endverbatim
1369
1370 Although it is perfectly valid, it does not mean that data traveling
1371 from A to C can either go directly (using link 3) or through B (using
1372 links 1 and 2). It simply means that the routing on the graph is not
1373 trivial, and that data do not following the shortest path in number of
1374 hops on this graph. Another way to say it is that there is no implicit
1375 in these routing descriptions. The system will only use the routes you
1376 declare (such as &lt;route src="A" dst="C"&gt;&lt;link:ctn
1377 id="3"/&gt;&lt;/route&gt;), without trying to build new routes by aggregating
1378 the provided ones.
1379   
1380 You are also free to declare platform where the routing is not
1381 symmetric. For example, add the following to the previous file:
1382
1383 \verbatim
1384 <route src="C" dst="A">
1385   <link:ctn id="2"/>
1386   <link:ctn id="1"/>
1387 </route>
1388 \endverbatim
1389
1390 This makes sure that data from C to A go through B where data from A
1391 to C go directly. Don't worry about realism of such settings since
1392 we've seen ways more weird situation in real settings (in fact, that's
1393 the realism of very regular platforms which is questionable, but
1394 that's another story).
1395
1396 \subsubsection faq_flexml_bypassing Bypassing the XML parser with your own C functions
1397
1398 So you want to bypass the XML files parser, uh? Maybe doing some parameter
1399 sweep experiments on your simulations or so? This is possible, and
1400 it's not even really difficult (well. Such a brutal idea could be
1401 harder to implement). Here is how it goes.
1402
1403 For this, you have to first remember that the XML parsing in SimGrid is done
1404 using a tool called FleXML. Given a DTD, this gives a flex-based parser. If
1405 you want to bypass the parser, you need to provide some code mimicking what
1406 it does and replacing it in its interactions with the SURF code. So, let's
1407 have a look at these interactions.
1408
1409 FleXML parser are close to classical SAX parsers. It means that a
1410 well-formed SimGrid platform XML file might result in the following
1411 "events":
1412
1413   - start "platform_description" with attribute version="2"
1414   - start "host" with attributes id="host1" power="1.0"
1415   - end "host"
1416   - start "host" with attributes id="host2" power="2.0"
1417   - end "host"
1418   - start "link" with ...
1419   - end "link"
1420   - start "route" with ...
1421   - start "link:ctn" with ...
1422   - end "link:ctn"
1423   - end "route"
1424   - end "platform_description"
1425
1426 The communication from the parser to the SURF code uses two means:
1427 Attributes get copied into some global variables, and a surf-provided
1428 function gets called by the parser for each event. For example, the event
1429   - start "host" with attributes id="host1" power="1.0"
1430
1431 let the parser do something roughly equivalent to:
1432 \verbatim
1433   strcpy(A_host_id,"host1");
1434   A_host_power = 1.0;
1435   STag_host();
1436 \endverbatim
1437
1438 In SURF, we attach callbacks to the different events by initializing the
1439 pointer functions to some the right surf functions. Since there can be
1440 more than one callback attached to the same event (if more than one
1441 model is in use, for example), they are stored in a dynar. Example in
1442 workstation_ptask_L07.c:
1443 \verbatim
1444   /* Adding callback functions */
1445   surf_parse_reset_parser();
1446   surfxml_add_callback(STag_surfxml_host_cb_list, &parse_cpu_init);
1447   surfxml_add_callback(STag_surfxml_prop_cb_list, &parse_properties);
1448   surfxml_add_callback(STag_surfxml_link_cb_list, &parse_link_init);
1449   surfxml_add_callback(STag_surfxml_route_cb_list, &parse_route_set_endpoints);
1450   surfxml_add_callback(ETag_surfxml_link_c_ctn_cb_list, &parse_route_elem);
1451   surfxml_add_callback(ETag_surfxml_route_cb_list, &parse_route_set_route);
1452                 
1453   /* Parse the file */
1454   surf_parse_open(file);
1455   xbt_assert1((!surf_parse()), "Parse error in %s", file);
1456   surf_parse_close();
1457 \endverbatim
1458     
1459 So, to bypass the FleXML parser, you need to write your own version of the
1460 surf_parse function, which should do the following:
1461    - Fill the A_<tag>_<attribute> variables with the wanted values
1462    - Call the corresponding STag_<tag>_fun function to simulate tag start
1463    - Call the corresponding ETag_<tag>_fun function to simulate tag end
1464    - (do the same for the next set of values, and loop)
1465
1466 Then, tell SimGrid that you want to use your own "parser" instead of the stock one:
1467 \verbatim
1468   surf_parse = surf_parse_bypass_environment;
1469   MSG_create_environment(NULL);
1470   surf_parse = surf_parse_bypass_application;
1471   MSG_launch_application(NULL);
1472 \endverbatim
1473
1474 A set of macros are provided at the end of
1475 include/surf/surfxml_parse.h to ease the writing of the bypass
1476 functions. An example of this trick is distributed in the file
1477 examples/msg/masterslave/masterslave_bypass.c
1478
1479 \subsection faq_simgrid_configuration Changing SimGrid's behavior
1480
1481 A number of options can be given at runtime to change the default
1482 SimGrid behavior. In particular, you can change the default cpu and
1483 network models...
1484
1485 \subsubsection faq_simgrid_configuration_gtnets Using GTNetS
1486
1487 It is possible to use a packet-level network simulator
1488 instead of the default flow-based simulation. You may want to use such
1489 an approach if you have doubts about the validity of the default model
1490 or if you want to perform some validation experiments. At the moment,
1491 we support the GTNetS simulator (it is still rather experimental
1492 though, so leave us a message if you play with it). 
1493
1494
1495 <i>
1496 To enable GTNetS model inside SimGrid it is needed to patch the GTNetS simulator source code 
1497 and build/install it from scratch
1498 </i>
1499
1500  - <b>Download and enter the recent downloaded GTNetS directory</b>
1501
1502  \verbatim
1503  svn checkout svn://scm.gforge.inria.fr/svn/simgrid/contrib/trunk/GTNetS/
1504  cd GTNetS
1505  \endverbatim
1506
1507
1508  - <b>Use the following commands to unzip and patch GTNetS package to work within SimGrid.</b>
1509
1510  \verbatim
1511  unzip gtnets-current.zip
1512  tar zxvf gtnets-current-patch.tgz 
1513  cd gtnets-current
1514  cat ../00*.patch | patch -p1
1515  \endverbatim
1516
1517   - <b>OPTIONALLY</b> you can use a patch for itanium 64bit processor family.
1518
1519   \verbatim
1520   cat ../AMD64-FATAL-Removed-DUL_SIZE_DIFF-Added-fPIC-compillin.patch | patch -p1
1521   \endverbatim
1522
1523  - <b>Compile GTNetS</b>
1524
1525    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. 
1526
1527
1528  \verbatim
1529  ln -sf Makefile.linux Makefile
1530  make depend
1531  make debug
1532  \endverbatim
1533
1534
1535  - <b>NOTE</b> A lot of warnings are expected but the application should compile
1536  just fine. If the makefile insists in compiling some QT libraries
1537  please try a make clean before asking for help.
1538
1539
1540  - <b>To compile optimized version</b>
1541
1542  \verbatim
1543  make opt
1544  \endverbatim
1545
1546
1547  - <b>Installing GTNetS</b>
1548
1549  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.
1550
1551  \verbatim
1552  ln -sf /<absolute_path>/gtnets_current/libgtsim-debug.so /<userhome>/usr/lib/libgtnets.so
1553  export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/<userhome>/usr/lib/libgtnets.so
1554  mkdir /<userhome>/usr/include/gtnets
1555  cp -fr SRC/*.h /<userhome>/usr/include/gtnets
1556  \endverbatim
1557
1558
1559  - <b>Enable GTNetS support in SimGrid</b>
1560
1561    \verbatim
1562    ./configure --with-gtnets=/<userhome>/usr
1563    \endverbatim
1564
1565  - <b>Once you have followed all the instructions for compiling and
1566    installing successfully you can activate this feature at 
1567    runntime with the following options:</b>
1568
1569    \verbatim
1570    cd simgrid/example/msg/
1571    make
1572    make check
1573    \endverbatim
1574
1575
1576  - <b>Or try the GTNetS model dogbone example with</b>
1577
1578  \verbatim
1579  gtnets/gtnets gtnets/onelink-p.xml gtnets/onelink-d.xml --cfg=network_model:GTNets
1580  \endverbatim
1581
1582  
1583  A long version of this <a href="http://gforge.inria.fr/docman/view.php/12/6283/GTNetS HowTo.html">HowTo</a>  it is available 
1584
1585
1586  More about GTNetS simulator at <a href="http://www.ece.gatech.edu/research/labs/MANIACS/GTNetS/index.html">GTNetS Website</a>
1587
1588
1589  - <b>DISCLAIMER</b>
1590  The patches provided by us worked successfully with GTNetS found 
1591  <a href="http://www.ece.gatech.edu/research/labs/MANIACS/GTNetS/software/gtnets-current.zip">here</a>, 
1592  dated from 12th June 2008. Due to the discontinuing development of
1593  GTNetS it is impossible to precise a version number. We STRONGLY recommend you
1594  to download and install the GTNetS version found in SimGrid repository as explained above.
1595  
1596
1597
1598
1599 \subsubsection faq_simgrid_configuration_alternate_network Using alternative flow models
1600
1601 The default simgrid network model uses a max-min based approach as
1602 explained in the research report
1603 <a href="ftp://ftp.ens-lyon.fr/pub/LIP/Rapports/RR/RR2002/RR2002-40.ps.gz">A Network Model for Simulation of Grid Application</a>.
1604 Other models have been proposed and implemented since then (see for example 
1605 <a href="http://mescal.imag.fr/membres/arnaud.legrand/articles/simutools09.pdf">Accuracy Study and Improvement of Network Simulation in the SimGrid Framework</a>)
1606 and can be activated at runtime. For example:
1607 \verbatim
1608 ./mycode platform.xml deployment.xml --cfg=workstation/model:compound --cfg=network/model:LV08 -cfg=cpu/model:Cas01
1609 \endverbatim
1610
1611 Possible models for the network are currently "Constant", "CM02",
1612 "LegrandVelho", "GTNets", Reno", "Reno2", "Vegas". Others will
1613 probably be added in the future and many of the previous ones are
1614 experimental and are likely to disappear without notice... To know the
1615 list of the currently  implemented models, you should use the
1616 --help-models command line option.
1617
1618 \verbatim
1619 ./masterslave_forwarder ../small_platform.xml deployment_masterslave.xml  --help-models
1620 Long description of the workstation models accepted by this simulator:
1621   CLM03: Default workstation model, using LV08 and CM02 as network and CPU
1622   compound: Workstation model allowing you to use other network and CPU models
1623   ptask_L07: Workstation model with better parallel task modeling
1624 Long description of the CPU models accepted by this simulator:
1625   Cas01_fullupdate: CPU classical model time=size/power
1626   Cas01: Variation of Cas01_fullupdate with partial invalidation optimization of lmm system. Should produce the same values, only faster
1627   CpuTI: Variation of Cas01 with also trace integration. Should produce the same values, only faster if you use availability traces
1628 Long description of the network models accepted by this simulator:
1629   Constant: Simplistic network model where all communication take a constant time (one second)
1630   CM02: Realistic network model with lmm_solve and no correction factors
1631   LV08: Realistic network model with lmm_solve and these correction factors: latency*=10.4, bandwidth*=.92, S=8775
1632   Reno: Model using lagrange_solve instead of lmm_solve (experts only)
1633   Reno2: Model using lagrange_solve instead of lmm_solve (experts only)
1634   Vegas: Model using lagrange_solve instead of lmm_solve (experts only)
1635 \endverbatim
1636
1637 \subsection faq_tracing Tracing Simulations for Visualization
1638
1639 The trace visualization is widely used to observe and understand the behavior
1640 of parallel applications and distributed algorithms. Usually, this is done in a
1641 two-step fashion: the user instruments the application and the traces are
1642 analyzed after the end of the execution. The visualization itself can highlights
1643 unexpected behaviors, bottlenecks and sometimes can be used to correct
1644 distributed algorithms. The SimGrid team is currently instrumenting the library
1645 in order to let users trace their simulations and analyze them. This part of the
1646 user manual explains how the tracing-related features can be enabled and used
1647 during the development of simulators using the SimGrid library.
1648
1649 \subsubsection faq_tracing_howitworks How it works
1650
1651 For now, the SimGrid library is instrumented so users can trace the <b>platform
1652 utilization</b> using the MSG interface. This means that the tracing will
1653 register how much power is used for each host and how much bandwidth is used for
1654 each link of the platform. The idea with this type of tracing is to observe the
1655 overall view of resources utilization in the first place, especially the
1656 identification of bottlenecks, load-balancing among hosts, and so on.
1657
1658 The idea of the instrumentation is to classify the MSG tasks by category,
1659 and trace
1660 the platform utilization (hosts and links) for each of the categories. For that,
1661 the tracing interface enables the declaration of categories and a function to
1662 mark a task with a previously declared category. <em>The tasks that are not
1663 classified according to a category are not traced</em>.
1664
1665 \subsubsection faq_tracing_enabling Enabling using CMake
1666
1667 With the sources of SimGrid, it is possible to enable the tracing 
1668 using the parameter <b>-Dtracing=on</b> when the cmake is executed.
1669 The section \ref faq_tracing_functions describes all the functions available
1670 when this Cmake options is activated. These functions will have no effect
1671 if SimGrid is configured without this option (they are wiped-out by the
1672 C-preprocessor).
1673
1674 \verbatim
1675 $ cmake -Dtracing=on .
1676 $ make
1677 \endverbatim
1678
1679 \subsubsection faq_tracing_functions Tracing Functions
1680
1681 \subsubsubsection Mandatory Functions
1682
1683 \li <b>\c TRACE_start (const char *filename)</b>: This is the first function to
1684 be called. It receives a single argument as parameter that contains the name of
1685 the file that will hold the trace in the end of the simulation. It returns 0 if
1686 everything was properly initialized, 1 otherwise. All trace functions called
1687 before TRACE_start do nothing.
1688
1689 \li <b>\c TRACE_category (const char *category)</b>: This function should be used
1690 to define a user category. The category can be used to differentiate the tasks
1691 that are created during the simulation (for example, tasks from server1,
1692 server2, or request tasks, computation tasks, communication tasks).
1693 All resource utilization (host power and link bandwidth) will be
1694 classified according to the task category. Tasks that do not belong to a
1695 category are not traced.
1696
1697 \li <b>\c TRACE_msg_set_task_category (m_task_t task, const char *category)</b>:
1698 This function should be called after the creation of a task, to define the
1699 category of that task. The first parameter \c task must contain a task that was
1700 created with the function \c MSG_task_create. The second parameter
1701 \c category must contain a category that was previously defined by the function
1702 \c TRACE_category.
1703
1704 \li <b>\c TRACE_end ()</b>: This is the last function to be called. It closes
1705 the trace file and stops the tracing of the simulation. All tracing will be
1706 completely disabled after the calling this function. Although we recommend
1707 the use of this function somewhere in the end of program, it can be used
1708 anywhere in the code. This function returns 0 if everything is ok, 1 otherwise.
1709
1710 \subsubsubsection Optional Functions
1711
1712 \li <b>\c TRACE_host_variable_declare (const char *variable)</b>:
1713 Declare a user variable that will be associated to hosts. A variable can
1714 be used to trace user variables such as the number of tasks in a server,
1715 the number of clients in an application, and so on.
1716
1717 \li <b>\c TRACE_host_variable_[set|add|sub] (const char *variable, double
1718 value)</b>:
1719 Set the value of a given user variable. It is important to remind that
1720 the value of this variable is always associated to the host. The host
1721 that will be used when these functions are called is the one returned by
1722 the function \c MSG_host_self().
1723
1724 \subsubsection faq_tracing_example Example of Instrumentation
1725
1726 A simplified example using the tracing mandatory functions.
1727
1728 \verbatim
1729 int main (int argc, char **argv)
1730 {
1731   TRACE_start ("traced_simulation.trace");
1732   TRACE_category ("request");
1733   TRACE_category ("computation");
1734   TRACE_category ("finalize");
1735   
1736   MSG_global_init (&argc, &argv);
1737
1738   //(... after deployment ...)
1739
1740   m_task_t req1 = MSG_task_create("1st_request_task", 10, 10, NULL);
1741   m_task_t req2 = MSG_task_create("2nd_request_task", 10, 10, NULL);
1742   m_task_t req3 = MSG_task_create("3rd_request_task", 10, 10, NULL);
1743   m_task_t req4 = MSG_task_create("4th_request_task", 10, 10, NULL);
1744   TRACE_msg_set_task_category (req1, "request");
1745   TRACE_msg_set_task_category (req2, "request");
1746   TRACE_msg_set_task_category (req3, "request");
1747   TRACE_msg_set_task_category (req4, "request");
1748
1749   m_task_t comp = MSG_task_create ("comp_task", 100, 100, NULL);
1750   TRACE_msg_set_task_category (comp, "computation");
1751
1752   m_task_t finalize = MSG_task_create ("finalize", 0, 0, NULL);
1753   TRACE_msg_set_task_category (finalize, "finalize");
1754
1755   //(...)
1756
1757   MSG_clean();
1758  
1759   TRACE_end();
1760   return 0;
1761 }
1762 \endverbatim
1763
1764 \subsubsection faq_tracing_analyzing Analyzing the SimGrid Traces
1765
1766 The SimGrid library, during an instrumented simulation, creates a trace file in
1767 the Paje file format that contains the platform utilization for the simulation
1768 that was executed. The visualization analysis of this file is performed with the
1769 visualization tool <a href="http://triva.gforge.inria.fr">Triva</a>, with
1770 special configurations tunned to SimGrid needs. This part of the documentation
1771 explains how to configure and use Triva to analyse a SimGrid trace file.
1772
1773 - <b>Installing Triva</b>: the tool is available in the INRIAGforge, 
1774 at <a href="http://triva.gforge.inria.fr">http://triva.gforge.inria.fr</a>.
1775 Use the following command to get the sources, and then check the file
1776 <i>INSTALL.simplified</i>. This file contains instructions to install
1777 the tool's dependencies in a Ubuntu/Debian Linux.
1778 \verbatim
1779 $ svn checkout svn://scm.gforge.inria.fr/svn/triva
1780 $ cd triva
1781 $ cat INSTALL.simplified
1782 \endverbatim
1783
1784 - <b>Executing Triva</b>: a binary called <i>Triva</i> is available after the
1785   installation (you can execute it passing <em>--help</em> to check its
1786 options). If the triva binary is not available after following the
1787 installation instructions, you may want to execute the following command to
1788 initialize the GNUstep environment variables (note that the location of the
1789 <i>GNUstep.sh</i> file may vary depending on your GNUstep installation - the
1790 command is known to work in Ubuntu and Debian Linux):
1791 \verbatim
1792 $ source /usr/share/GNUstep/Makefiles/GNUstep.sh
1793 \endverbatim
1794 You should be able to see this output after the installation of triva:
1795 \verbatim
1796 $ ./Triva.app/Triva --help
1797 Usage: Triva [OPTION...] TRACEFILE
1798 Trace Analysis through Visualization
1799
1800  You need to use one of the following options:
1801   -g, --graph                Graph Analysis
1802   -t, --treemap              Treemap Analysis
1803
1804  Other auxiliary options to check the trace file:
1805   -c, --check                Check the integrity of trace file
1806   -h, --hierarchy            Export the trace type hierarchy
1807   -l, --list                 List entity types
1808
1809   -?, --help                 Give this help list
1810       --usage                Give a short usage message
1811 \endverbatim
1812 Triva expects that the user choose one of the available options 
1813 (currently <em>--graph</em> or <em>--treemap</em> for a visualization analysis)
1814 and the trace file from the simulation.
1815
1816 - <b>Understanding Triva - time-slice</b>: the analysis of a trace file using
1817   the tool always takes into account the concept of the <em>time-slice</em>.
1818 This concept means that what is being visualized in the screen is always
1819 calculated considering a specific time frame, with its beggining and end
1820 timestamp. The time-slice is configured by the user and can be changed
1821 dynamically through the window called <em>Time Interval</em> that is opened
1822 whenever a trace file is being analyzed. The next figure depicts the time-slice
1823 configuration window.
1824 In the top of the window, in the space named <i>Trace Time</i>,
1825 the two fields show the beggining of the trace (which usually starts in 0) and
1826 the end (that depends on the time simulated by SimGrid). The middle of the
1827 window, in the square named <i>Time Slice Configuration</i>, contains the
1828 aspects related to the time-slice, including its <i>start</i> and its
1829 <i>size</i>. The gray rectangle in the bottom of this part indicates the 
1830 <i>current time-slice</i> that is considered for the drawings. If the checkbox 
1831 <i>Update Drawings on Sliders Change</i> is not selected, the button
1832 <i>Apply</i> must be clicked in order to inform triva that the
1833 new time-slice must be considered. The bottom part of the window, in the space
1834 indicated by the square <i>Time Slice Animation</i> can be used to advance
1835 the time-frame automatically. The user configures the amount of time that the
1836 time-frame will forward and how frequent this update will happen. Once this is
1837 configured, the user clicks the <i>Play</i> button in order to see the dynamic
1838 changes on the drawings.
1839 <center>
1840 \htmlonly
1841 <a href="triva-time_interval.png" border=0><img src="triva-time_interval.png" width="50%" border=0></a>
1842 \endhtmlonly
1843 </center>
1844 <b>Remarks:</b> when the trace has too many hosts or links, the computation to
1845 take into account a new time-slice can be expensive. When this happens, the
1846 <i>Frequency</i> parameter, but also updates caused by change on configurations
1847 when the checkbox <i>Update Drawings on Sliders
1848 Change</i> is selected will not be followed.
1849
1850 - <b>Understanding Triva - graph</b>: this part of the documention explains how
1851   to analyze the traces using the graph view of Triva, when the user executes
1852 the tool passing <em>--graph</em> as parameter. Triva opens three windows when
1853 this parameter is used: the <i>Time Interval</i> window (previously described),
1854 the <i>Graph Representation</i> window, and the <em>Graph Configuration</em>
1855 window. The Graph Representation is the window where drawings take place.
1856 Initially, it is completely white waiting for a proper graph configuration input
1857 by the user. We start the description of this type of analysis by describing the
1858 <i>Graph Configuration</i> window (depicted below). By using a particular
1859 configuration, triva
1860 can be used to customize the graph drawing according to
1861 the SimGrid trace that was created with user-specific categories. Before delving
1862 into the details of this customization, let us first explain the major parts of
1863 the graph configuration window. The buttons located in the top-right corner can
1864 be used to delete, copy and create a new configuration. The checkbox in the
1865 top-middle part of the window indicates if the configuration typed in the
1866 textfield is syntactically correct (we are using the non-XML 
1867 <a href="http://en.wikipedia.org/wiki/Property_list">Property List Format</a> to
1868 describe the configuration). The pop-up button located on the top-left corner 
1869 indicates the selected configuration (the user can have multiple graph
1870 configurations). The bottom-left text field contains the name of the current
1871 configuration (updates on this field must be followed by typing enter on the
1872 keyboard to take into account the name change). The bottom-right <em>Apply</em>
1873 button activates the current configuration, resulting on an update on the graph
1874 drawings.
1875 <center>
1876 \htmlonly
1877 <a href="triva-graph_configuration.png" border=0><img src="triva-graph_configuration.png" width="50%" border=0></a>
1878 \endhtmlonly
1879 </center>
1880 <b>Basic SimGrid Configuration</b>: The figure shows in the big textfield the
1881 basic configuration that should be used during the analysis of a SimGrid trace
1882 file. The basic logic of the configuration is as follows:
1883 \verbatim
1884 {
1885   node = (HOST);
1886   edge = (LINK);
1887 \endverbatim
1888 The nodes of the graph will be created based on the <i>node</i> parameter, which
1889 in this case is the different <em>"HOST"</em>s of the platform 
1890 used to simulate. The <i>edge</i> parameter indicates that the edges of the
1891 graph will be created based on the <em>"LINK"</em>s of the platform. After the
1892 definition of these two parameters, the configuration must detail how
1893 <em>HOST</em>s and <em>LINK</em>s should be drawn. For that, the configuration
1894 must have an entry for each of the types used. For <em>HOST</em>, as basic
1895 configuration, we have:
1896 \verbatim
1897   HOST = {
1898     size = power;
1899     scale = global;
1900   };
1901 \endverbatim
1902 The parameter <em>size</em> indicates which variable from the trace file will be
1903 used to define the size of the node HOST in the visualization. If the simulation
1904 was executed with availability traces, the size of the nodes will be changed
1905 according to these traces. The parameter <em>scale</em> indicates if the value
1906 of the variable is <em>global</em> or <em>local</em>. If it is global, the value
1907 will be relative to the power of all other hosts, if it is local, the value will
1908 be relative locally.
1909 For <em>LINK</em> we have:
1910 \verbatim
1911   LINK = {
1912     src = SrcHost;
1913     dst = DstHost;
1914     
1915     size = bandwidth;
1916     scale = global;
1917   };
1918 \endverbatim
1919 For the types specified in the <em>edge</em> parameter (such as <em>LINK</em>),
1920 the configuration must contain two additional parameters: <em>src</em> and
1921 <em>dst</em> that are used to properly identify which nodes this edge is
1922 connecting. The values <em>SrcHost</em> and <em>DstHost</em> are always present
1923 in the SimGrid trace file and should not be changed in the configuration. The
1924 parameter <em>size</em> for the LINK, in this case, is configured as the
1925 variable <em>bandwidth</em>, with a <em>global</em> scale. The scale meaning
1926 here is exactly the same used for nodes. The last parameter is the GraphViz
1927 algorithm used to calculate the position of the nodes in the graph
1928 representation.
1929 \verbatim
1930   graphviz-algorithm = neato;
1931 }
1932 \endverbatim
1933 <b>Customizing the Graph Representation</b>: triva is capable to handle
1934 a customized graph representation based on the variables present in the trace
1935 file. In the case of SimGrid, every time a category is created for tasks, two
1936 variables in the trace file are defined: one to indicate node utilization (how
1937 much power was used by that task category), and another to indicate link
1938 utilization (how much bandwidth was used by that category). For instance, if the
1939 user declares a category named <i>request</i>, there will be variables named
1940 <b>p</b><i>request</i> and a <b>b</b><i>request</i> (<b>p</b> for power and
1941 <b>b</b> for bandwidth). It is important to notice that the variable
1942 <i>prequest</i> in this case is only available for HOST, and
1943 <i>brequest</i> is only available for LINK. <b>Example</b>: suppose there are
1944 two categories for tasks: request and compute. To create a customized graph
1945 representation with a proportional separation of host and link utilization, use
1946 as configuration for HOST and LINK this:
1947 \verbatim
1948   HOST = {
1949     size = power;
1950     scale = global;
1951   
1952     sep_host = {
1953       type = separation;
1954       size = power;
1955       values = (prequest, pcomputation);
1956     };
1957   };
1958
1959   LINK = {
1960     src = SrcHost;
1961     dst = DstHost;
1962     size = bandwidth;
1963     scale = global;
1964
1965     sep_link = {
1966       type = separation;
1967       size = bandwidth;
1968       values = (brequest, bcomputation);
1969     };
1970   };
1971 \endverbatim
1972 Where <i>sep_host</i> contains a composition of type <i>separation</i> where
1973 its max size is the <i>power</i> of the host and the variables <i>prequest</i>
1974 and <i>pcomputation</i> are drawn proportionally to the size of the HOST. And
1975 <i>sep_link</i> is also a separation where max is defined as the
1976 <i>bandwidth</i> of the link, and the variables <i>brequest</i> and
1977 <i>bcomputation</i> are drawn proportionally within a LINK.
1978 <i>This configuration enables the analysis of resource utilization by MSG tasks,
1979 and the identification of load-balancing issues, network bottlenecks, for
1980 instance.</i> \n
1981 <b>Other compositions</b>: besides <i>separation</i>, it is possible to use
1982 other types of compositions, such as gradients, and colors, like this:
1983 \verbatim
1984     gra_host = {
1985       type = gradient;
1986       scale = global;
1987       values = (numberOfTasks);
1988     };
1989     color_host = {
1990       type = color;
1991       values = (is_server);
1992     };
1993 \endverbatim
1994 Where <i>gra_host</i> creates a gradient within a node of the graph, using a
1995 global scale and using as value a variable called <i>numberOfTasks</i>, that
1996 could be declared by the user using the optional tracing functions of SimGrid.
1997 If scale is global, the max and min value for the gradient will be equal to the
1998 max and min numberOfTasks among all hosts, and if scale is local, the max and
1999 min value based on the value of numberOfTasks locally in each host.
2000 And <i>color_host</i> composition draws a square based on a positive value of
2001 the variable <i>is_server</i>, that could also be defined by the user using the
2002 SimGrid tracing functions. \n
2003 <b>The Graph Visualization</b>: The next figure shows a graph visualization of a
2004 given time-slice of the masterslave_forwarder example (present in the SimGrid
2005 sources). The red color indicates tasks from the <i>compute</i> category. This
2006 visualization was generated with the following configuration:
2007 \verbatim
2008 {
2009   node = (HOST);
2010   edge = (LINK);
2011
2012   HOST = {
2013     size = power;
2014     scale = global;
2015   
2016     sep_host = {
2017       type = separation;
2018       size = power;
2019       values = (pcompute, pfinalize);
2020     };
2021   };
2022   LINK = {
2023     src = SrcHost;
2024     dst = DstHost;
2025     size = bandwidth;
2026     scale = global;
2027
2028     sep_link = {
2029       type = separation;
2030       size = bandwidth;
2031       values = (bcompute, bfinalize);
2032     };
2033   };
2034   graphviz-algorithm = neato;
2035 }
2036 \endverbatim
2037 <center>
2038 \htmlonly
2039 <a href="triva-graph_visualization.png" border=0><img src="triva-graph_visualization.png" width="50%" border=0></a>
2040 \endhtmlonly
2041 </center>
2042
2043 - <b>Understading Triva - colors</b>: An important issue when using Triva is how
2044   to define colors. To do that, we have to know which variables are defined in
2045 the trace file generated by the SimGrid library. The parameter <em>--list</em> 
2046 lists the variables for a given trace file:
2047 \verbatim
2048 $ Triva -l masterslave_forwarder.trace
2049 iFile
2050 c  platform
2051 c    HOST
2052 v     power
2053 v     is_slave
2054 v     is_master
2055 v     task_creation
2056 v     task_computation
2057 v     pcompute
2058 v     pfinalize
2059 c    LINK
2060 v     bandwidth
2061 v     latency
2062 v     bcompute
2063 v     bfinalize
2064 c  user_type
2065 \endverbatim
2066 We can see that HOST has seven variables (from power to pfinalize) and LINK has
2067 four (from bandwidth to bfinalize). To define a red color for the
2068 <i>pcompute</i> and <i>bcompute</i> (which are defined based on user category
2069 <i>compute</i>), execute:
2070 \verbatim
2071 $ defaults write Triva 'pcompute Color' '1 0 0'
2072 $ defaults write Triva 'bcompute Color' '1 0 0'
2073 \endverbatim
2074 Where the three numbers in each line are the RGB color with values from 0 to 1.
2075
2076 \section faq_troubleshooting Troubleshooting
2077
2078 \subsection faq_trouble_lib_compil SimGrid compilation and installation problems
2079
2080 \subsubsection faq_trouble_lib_config ./configure fails!
2081
2082 We know only one reason for the configure to fail:
2083
2084  - <b>You are using a broken build environment</b>\n
2085    If symptom is that configure complains about gcc not being able to build
2086    executables, you are probably missing the libc6-dev package. Damn Ubuntu.
2087
2088 If you experience other kind of issue, please get in touch with us. We are
2089 always interested in improving our portability to new systems.
2090
2091 \subsubsection faq_trouble_distcheck Dude! "make check" fails on my machine!
2092
2093 Don't assume we never run this target, because we do. Check
2094 http://bob.loria.fr:8010 if you don't believe us.
2095
2096 There is several reasons which may cause the make check to fail on your
2097 machine:
2098
2099  - <b>You are using a broken libc (probably concerning the contextes)</b>.\n
2100    The symptom is that the "make check" fails within the examples/msg directory.\n
2101    By default, SimGrid uses something called ucontexts. This is part of the
2102    libc, but it's quite undertested. For example, some (old) versions of the
2103    glibc on alpha do not implement these functions, but provide the stubs
2104    (which return ENOSYS: not implemented). It may fool our detection mechanism
2105    and leads to segfaults. There is not much we can do to fix the bug.
2106    A workaround is to compile with --with-context=pthread to avoid
2107    ucontext completely. You'll be a bit more limited in the number
2108    of simulated processes you can start concurrently, but 5000
2109    processes is still enough for most purposes, isn't it?\n
2110    This limitation is the reason why we insist on using this piece of ...
2111    software even if it's so troublesome.\n
2112    <b>=> use --with-pthread on AMD64 architecture that do not have an 
2113    ultra-recent libc.</b>
2114    
2115  - <b>There is a bug in SimGrid we aren't aware of</b>.\n
2116    If none of the above apply, please drop us a mail on the mailing list so
2117    that we can check it out. Make sure to read \ref faq_bugrepport
2118    before you do so.
2119
2120 \subsection faq_trouble_compil User code compilation problems
2121
2122 \subsubsection faq_trouble_err_logcat "gcc: _simgrid_this_log_category_does_not_exist__??? undeclared (first use in this function)"
2123
2124 This is because you are using the log mecanism, but you didn't created
2125 any default category in this file. You should refer to \ref XBT_log
2126 for all the details, but you simply forgot to call one of
2127 XBT_LOG_NEW_DEFAULT_CATEGORY() or XBT_LOG_NEW_DEFAULT_SUBCATEGORY().
2128
2129 \subsubsection faq_trouble_pthreadstatic "gcc: undefined reference to pthread_key_create"
2130
2131 This indicates that one of the library SimGrid depends on (libpthread
2132 here) was missing on the linking command line. Dependencies of
2133 libsimgrid are expressed directly in the dynamic library, so it's
2134 quite impossible that you see this message when doing dynamic linking. 
2135
2136 If you compile your code statically (and if you use a pthread version
2137 of SimGrid -- see \ref faq_more_processes), you must absolutely
2138 specify <tt>-lpthread</tt> on the linker command line. As usual, this should
2139 come after <tt>-lsimgrid</tt> on this command line.
2140
2141 \subsection faq_trouble_errors Runtime error messages
2142
2143 \subsubsection faq_flexml_limit "surf_parse_lex: Assertion `next limit' failed."
2144
2145 This is because your platform file is too big for the parser. 
2146
2147 Actually, the message comes directly from FleXML, the technology on top of
2148 which the parser is built. FleXML has the bad idea of fetching the whole
2149 document in memory before parsing it. And moreover, the memory buffer size
2150 must be determined at compilation time.
2151
2152 We use a value which seems big enough for our need without bloating the
2153 simulators footprints. But of course your mileage may vary. In this case,
2154 just edit src/surf/surfxml.l modify the definition of
2155 FLEXML_BUFFERSTACKSIZE. E.g.
2156
2157 \verbatim
2158 #define FLEXML_BUFFERSTACKSIZE 1000000000
2159 \endverbatim
2160
2161 Then recompile and everything should be fine, provided that your version of
2162 Flex is recent enough (>= 2.5.31). If not the compilation process should
2163 warn you.
2164
2165 A while ago, we worked on FleXML to reduce a bit its memory consumption, but
2166 these issues remain. There is two things we should do:
2167
2168   - use a dynamic buffer instead of a static one so that the only limit
2169     becomes your memory, not a stupid constant fixed at compilation time
2170     (maybe not so difficult).
2171   - change the parser so that it does not need to get the whole file in
2172     memory before parsing
2173     (seems quite difficult, but I'm a complete newbe wrt flex stuff).
2174
2175 These are changes to FleXML itself, not SimGrid. But since we kinda hijacked
2176 the development of FleXML, I can grant you that any patches would be really
2177 welcome and quickly integrated.
2178
2179 <b>Update:</b> A new version of FleXML (1.7) was released. Most of the work
2180 was done by William Dowling, who use it in his own work. The good point is
2181 that it now use a dynamic buffer, and that the memory usage was greatly
2182 improved. The downside is that William also changed some things internally,
2183 and it breaks the hack we devised to bypass the parser, as explained in 
2184 \ref faq_flexml_bypassing. Indeed, this is not a classical usage of the
2185 parser, and Will didn't imagine that we may have used (and even documented)
2186 such a crude usage of FleXML. So, we now have to repair the bypassing
2187 functionality to use the lastest FleXML version and fix the memory usage in
2188 SimGrid.
2189
2190 \subsubsection faq_trouble_gras_transport GRAS spits networking error messages
2191
2192 Gras, on real platforms, naturally use regular sockets to communicate. They
2193 are deeply hidden in the gras abstraction, but when things go wrong, you may
2194 get some weird error messages. Here are some example, with the probable
2195 reason:
2196
2197  - <b>Transport endpoint is not connected</b>: several processes try to open
2198    a server socket on the same port number of the same machine. This is
2199    naturally bad and each process should pick its own port number for this.\n
2200    Maybe, you just have some processes remaining from a previous experiment 
2201    on your machine.\n
2202    Killing them may help, but again if you kill -KILL them, you'll have to
2203    wait for a while: they didn't close there sockets properly and the system
2204    needs a while to notice that this port is free again.
2205
2206  - <b>Socket closed by remote side</b>: if the remote process is not
2207    supposed to close the socket at this point, it may be dead.
2208    
2209  - <b>Connection reset by peer</b>: I found this on Internet about this
2210    error. I think it's what's happening here, too:\n   
2211    <i>This basically means that a network error occurred while the client was
2212    receiving data from the server. But what is really happening is that the
2213    server actually accepts the connection, processes the request, and sends
2214    a reply to the client. However, when the server closes the socket, the
2215    client believes that the connection has been terminated abnormally
2216    because the socket implementation sends a TCP reset segment telling the
2217    client to throw away the data and report an error.\n
2218    Sometimes, this problem is caused by not properly closing the
2219    input/output streams and the socket connection. Make sure you close the
2220    input/output streams and socket connection properly. If everything is
2221    closed properly, however, and the problem persists, you can work around
2222    it by adding a one-second sleep before closing the streams and the
2223    socket. This technique, however, is not reliable and may not work on all
2224    systems.</i>\n
2225    Since GRAS sockets are closed properly (repeat after me: there is no bug
2226    in GRAS), it is either that you are closing your sockets on server side
2227    before the client get a chance to read them (use gras_os_sleep() to delay
2228    the server), or the server died awfully before the client got the data.
2229
2230 \subsubsection faq_trouble_errors_big_fat_warning I'm told that my XML files are too old.
2231
2232 The format of the XML platform description files is sometimes
2233 improved. For example, we decided to change the units used in SimGrid
2234 from MBytes, MFlops and seconds to Bytes, Flops and seconds to ease
2235 people exchanging small messages. We also reworked the route
2236 descriptions to allow more compact descriptions.
2237
2238 That is why the XML files are versionned using the 'version' attribute
2239 of the root tag. Currently, it should read:
2240 \verbatim
2241   <platform version="2">
2242 \endverbatim
2243
2244 If your files are too old, you can use the simgrid_update_xml.pl
2245 script which can be found in the tools directory of the archive.
2246
2247 \subsection faq_trouble_valgrind Valgrind-related and other debugger issues
2248
2249 If you don't, you really should use valgrind to debug your code, it's
2250 almost magic.
2251
2252 \subsubsection faq_trouble_vg_longjmp longjmp madness in valgrind
2253
2254 This is when valgrind starts complaining about longjmp things, just like:
2255
2256 \verbatim ==21434== Conditional jump or move depends on uninitialised value(s)
2257 ==21434==    at 0x420DBE5: longjmp (longjmp.c:33)
2258 ==21434==
2259 ==21434== Use of uninitialised value of size 4
2260 ==21434==    at 0x420DC3A: __longjmp (__longjmp.S:48)
2261 \endverbatim
2262
2263 This is the sign that you didn't used the exception mecanism well. Most
2264 probably, you have a <tt>return;</tt> somewhere within a <tt>TRY{}</tt>
2265 block. This is <b>evil</b>, and you must not do this. Did you read the section
2266 about \ref XBT_ex??
2267
2268 \subsubsection faq_trouble_vg_libc Valgrind spits tons of errors about backtraces!
2269
2270 It may happen that valgrind, the memory debugger beloved by any decent C
2271 programmer, spits tons of warnings like the following :
2272 \verbatim ==8414== Conditional jump or move depends on uninitialised value(s)
2273 ==8414==    at 0x400882D: (within /lib/ld-2.3.6.so)
2274 ==8414==    by 0x414EDE9: (within /lib/tls/i686/cmov/libc-2.3.6.so)
2275 ==8414==    by 0x400B105: (within /lib/ld-2.3.6.so)
2276 ==8414==    by 0x414F937: _dl_open (in /lib/tls/i686/cmov/libc-2.3.6.so)
2277 ==8414==    by 0x4150F4C: (within /lib/tls/i686/cmov/libc-2.3.6.so)
2278 ==8414==    by 0x400B105: (within /lib/ld-2.3.6.so)
2279 ==8414==    by 0x415102D: __libc_dlopen_mode (in /lib/tls/i686/cmov/libc-2.3.6.so)
2280 ==8414==    by 0x412D6B9: backtrace (in /lib/tls/i686/cmov/libc-2.3.6.so)
2281 ==8414==    by 0x8076446: xbt_dictelm_get_ext (dict_elm.c:714)
2282 ==8414==    by 0x80764C1: xbt_dictelm_get (dict_elm.c:732)
2283 ==8414==    by 0x8079010: xbt_cfg_register (config.c:208)
2284 ==8414==    by 0x806821B: MSG_config (msg_config.c:42)
2285 \endverbatim
2286
2287 This problem is somewhere in the libc when using the backtraces and there is
2288 very few things we can do ourselves to fix it. Instead, here is how to tell
2289 valgrind to ignore the error. Add the following to your ~/.valgrind.supp (or
2290 create this file on need). Make sure to change the obj line according to
2291 your personnal mileage (change 2.3.6 to the actual version you are using,
2292 which you can retrieve with a simple "ls /lib/ld*.so").
2293
2294 \verbatim {
2295    name: Backtrace madness
2296    Memcheck:Cond
2297    obj:/lib/ld-2.3.6.so
2298    fun:dl_open_worker
2299    fun:_dl_open
2300    fun:do_dlopen
2301    fun:dlerror_run
2302    fun:__libc_dlopen_mode
2303 }\endverbatim
2304
2305 Then, you have to specify valgrind to use this suppression file by passing
2306 the <tt>--suppressions=$HOME/.valgrind.supp</tt> option on the command line.
2307 You can also add the following to your ~/.bashrc so that it gets passed
2308 automatically. Actually, it passes a bit more options to valgrind, and this
2309 happen to be my personnal settings. Check the valgrind documentation for
2310 more information.
2311
2312 \verbatim export VALGRIND_OPTS="--leak-check=yes --leak-resolution=high --num-callers=40 --tool=memcheck --suppressions=$HOME/.valgrind.supp" \endverbatim
2313
2314 \subsubsection faq_trouble_backtraces Truncated backtraces
2315
2316 When debugging SimGrid, it's easier to pass the
2317 --disable-compiler-optimization flag to the configure if valgrind or
2318 gdb get fooled by the optimization done by the compiler. But you
2319 should remove these flag when everything works before going in
2320 production (before launching your 1252135 experiments), or everything
2321 will run only one half of the true SimGrid potential.
2322
2323 \subsection faq_deadlock There is a deadlock in my code!!!
2324
2325 Unfortunately, we cannot debug every code written in SimGrid.  We
2326 furthermore believe that the framework provides ways enough
2327 information to debug such informations yourself. If the textual output
2328 is not enough, Make sure to check the \ref faq_visualization FAQ entry to see
2329 how to get a graphical one.
2330
2331 Now, if you come up with a really simple example that deadlocks and
2332 you're absolutely convinced that it should not, you can ask on the
2333 list. Just be aware that you'll be severely punished if the mistake is
2334 on your side... We have plenty of FAQ entries to redact and new
2335 features to implement for the impenitents! ;)
2336
2337 \subsection faq_surf_network_latency I get weird timings when I play with the latencies.
2338
2339 OK, first of all, remember that units should be Bytes, Flops and
2340 Seconds. If you don't use such units, some SimGrid constants (e.g. the
2341 SG_TCP_CTE_GAMMA constant used in most network models) won't have the
2342 right unit and you'll end up with weird results.
2343
2344 Here is what happens with a single transfer of size L on a link
2345 (bw,lat) when nothing else happens.
2346
2347 \verbatim
2348 0-----lat--------------------------------------------------t
2349 |-----|**** real_bw =min(bw,SG_TCP_CTE_GAMMA/(2*lat)) *****|
2350 \endverbatim
2351
2352 In more complex situations, this min is the solution of a complex
2353 max-min linear system.  Have a look 
2354 <a href="http://lists.gforge.inria.fr/pipermail/simgrid-devel/2006-April/thread.html">here</a>
2355 and read the two threads "Bug in SURF?" and "Surf bug not
2356 fixed?". You'll have a few other examples of such computations. You
2357 can also read "A Network Model for Simulation of Grid Application" by
2358 Henri Casanova and Loris Marchal to have all the details. The fact
2359 that the real_bw is smaller than bw is easy to understand. The fact
2360 that real_bw is smaller than SG_TCP_CTE_GAMMA/(2*lat) is due to the
2361 window-based congestion mechanism of TCP. With TCP, you can't exploit
2362 your huge network capacity if you don't have a good round-trip-time
2363 because of the acks...
2364
2365 Anyway, what you get is t=lat + L/min(bw,SG_TCP_CTE_GAMMA/(2*lat)).
2366
2367   * if I you set (bw,lat)=(100 000 000, 0.00001), you get t =  1.00001 (you fully
2368 use your link)
2369   * if I you set (bw,lat)=(100 000 000, 0.0001),  you get t =  1.0001 (you're on the
2370 limit)
2371   * if I you set (bw,lat)=(100 000 000, 0.001),   you get t = 10.001  (ouch!)
2372
2373 This bound on the effective bandwidth of a flow is not the only thing
2374 that may make your result be unexpected. For example, two flows
2375 competing on a saturated link receive an amount of bandwidth inversely
2376 proportional to their round trip time.
2377
2378 \subsection faq_bugrepport So I've found a bug in SimGrid. How to report it?
2379
2380 We do our best to make sure to hammer away any bugs of SimGrid, but this is
2381 still an academic project so please be patient if/when you find bugs in it.
2382 If you do, the best solution is to drop an email either on the simgrid-user
2383 or the simgrid-devel mailing list and explain us about the issue.  You can
2384 also decide to open a formal bug report using the
2385 <a href="https://gforge.inria.fr/tracker/?atid=165&group_id=12&func=browse">relevant
2386 interface</a>. You need to login on the server to get the ability to submit
2387 bugs. 
2388
2389 We will do our best to solve any problem repported, but you need to help us
2390 finding the issue. Just telling "it segfault" isn't enough. Telling "It
2391 segfaults when running the attached simulator" doesn't really help either.
2392 You may find the following article interesting to see how to repport
2393 informative bug repports:
2394 http://www.chiark.greenend.org.uk/~sgtatham/bugs.html (it is not SimGrid
2395 specific at all, but it's full of good advices).
2396
2397 \author Arnaud Legrand (arnaud.legrand::imag.fr)
2398 \author Martin Quinson (martin.quinson::loria.fr)
2399
2400
2401 */
2402
2403 ******************************************************************
2404 *              OLD CRUFT NOT USED ANYMORE                        *
2405 ******************************************************************
2406
2407
2408 \subsection faq_crosscompile Cross-compiling a Windows DLL of SimGrid from linux
2409
2410 At the moment, we do not distribute Windows pre-compiled version of SimGrid
2411 because the support for this platform is still experimental. We know that
2412 some parts of the GRAS environment do not work, and we think that the others
2413 environments (MSG and SD) have good chances to work, but we didn't test
2414 ourselves. This section explains how we generate the SimGrid DLL so that you
2415 can build it for yourself. First of all, you need to have a version more
2416 recent than 3.1 (ie, a SVN version as time of writting).
2417
2418 In order to cross-compile the package to windows from linux, you need to
2419 install mingw32 (minimalist gnu win32). On Debian, you can do so by
2420 installing the packages mingw32 (compiler), mingw32-binutils (linker and
2421 so), mingw32-runtime.
2422
2423 You can use the VPATH support of configure to compile at the same time for
2424 linux and windows without dupplicating the source nor cleaning the tree
2425 between each. Just run bootstrap (if you use the SVN) to run the autotools.
2426 Then, create a linux and a win directories. Then, type:
2427 \verbatim  cd linux; ../configure --srcdir=.. <usual configure flags>; make; cd ..
2428 cd win;  ../configure --srcdir=.. --host=i586-mingw32msvc <flags>; make; cd ..
2429 \endverbatim
2430 The trick to VPATH builds is to call configure from another directory,
2431 passing it an extra --srcdir argument to tell it where all the sources are.
2432 It will understand you want to use VPATH. Then, the trick to cross-compile
2433 is simply to add a --host argument specifying the target you want to build
2434 for. The i586-mingw32msvc string is what you have to pass to use the mingw32
2435 environment as distributed in Debian.
2436
2437 After that, you can run all make targets from both directories, and test
2438 easily that what you change for one arch does not break the other one. 
2439
2440 It is possible that this VPATH build thing breaks from time to time in the
2441 SVN since it's quite fragile, but it's granted to work in any released
2442 version. If you experience problems, drop us a mail. 
2443
2444 Another possible source of issue is that at the moment, building the
2445 examples request to use the gras_stub_generator tool, which is a compiled
2446 program, not a script. In cross-compilation, you need to cross-execute with
2447 wine for example, which is not really pleasant. We are working on this, but
2448 in the meanwhile, simply don't build the examples in cross-compilation
2449 (<tt>cd src</tt> before running make).
2450     
2451 Program (cross-)compiled with mingw32 do request an extra DLL at run-time to be
2452 usable. For example, if you want to test your build with wine, you should do
2453 the following to put this library where wine looks for DLLs.
2454 \verbatim 
2455 cp /usr/share/doc/mingw32-runtime/mingwm10.dll.gz ~/.wine/c/windows/system/
2456 gunzip ~/.wine/c/windows/system/mingwm10.dll.gz
2457 \endverbatim
2458
2459 The DLL is built in src/.libs, and installed in the <i>prefix</i>/bin directory
2460 when you run make install. 
2461
2462 If you want to use it in a native project on windows, you need to use 
2463 simgrid.dll and mingwm10.dll. For each DLL, you need to build .def file
2464 under linux (listing the defined symbols), and convert it into a .lib file
2465 under windows (specifying this in a way that windows compilers like). To
2466 generate the def files, run (under linux):
2467 \verbatim echo "LIBRARY libsimgrid-0.dll" > simgrid.def
2468 echo EXPORTS >> simgrid.def
2469 nm libsimgrid-0.dll | grep ' T _' | sed 's/.* T _//' >> simgrid.def
2470 nm libsimgrid-0.dll | grep ' D _' | sed 's/.* D _//' | sed 's/$/ DATA/' >> simgrid.def
2471
2472 echo "LIBRARY mingwm10.dll" > mingwm10.def
2473 echo EXPORTS >> mingwm10.def
2474 nm mingwm10.dll | grep ' T _' | sed 's/.* T _//' >> mingwm10.def
2475 nm mingwm10.dll | grep ' D _' | sed 's/.* D _//' | sed 's/$/ DATA/' >> mingwm10.def
2476 \endverbatim
2477
2478 To create the import .lib files, use the <tt>lib</tt> windows tool (from
2479 MSVC) the following way to produce simgrid.lib and mingwm10.lib
2480 \verbatim lib /def:simgrid.def
2481 lib /def:mingwm10.def
2482 \endverbatim
2483
2484 If you happen to use Borland C Builder, the right command line is the
2485 following (note that you don't need any file.def to get this working).
2486 \verbatim implib simgrid.lib libsimgrid-0.dll
2487 implib mingwm10.lib mingwm10.dll
2488 \endverbatim
2489
2490 Then, set the following parameters in Visual C++ 2005:
2491 Linker -> Input -> Additional dependencies = simgrid.lib mingwm10.lib
2492
2493 Just in case you wonder how to generate a DLL from libtool in another
2494 project, we added -no-undefined to any lib*_la_LDFLAGS variables so that
2495 libtool accepts to generate a dynamic library under windows. Then, to make
2496 it true, we pass any dependencies (such as -lws2 under windows or -lpthread
2497 on need) on the linking line. Passing such deps is a good idea anyway so
2498 that they get noted in the library itself, avoiding the users to know about
2499 our dependencies and put them manually on their compilation line. Then we
2500 added the AC_LIBTOOL_WIN32_DLL macro just before AC_PROG_LIBTOOL in the
2501 configure.ac. It means that we exported any symbols which need to be.
2502 Nowadays, functions get automatically exported, so we don't need to load our
2503 header files with tons of __declspec(dllexport) cruft. We only need to do so
2504 for data, but there is no public data in SimGrid so we are good.
2505