Logo AND Algorithmique Numérique Distribuée

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