Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
6f99989b477a905ff3b248f3e36241e7991b31e6
[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://graal.ens-lyon.fr/~alegrand/articles/slides_g5k_simul.pdf">slides</a>
9 (or to these
10 <a href="http://graal.ens-lyon.fr/~alegrand/articles/Simgrid-Introduction.pdf">"obsolete" slides</a>)
11 may give you some insights on what SimGrid can help you to do and what
12 are its limitations. Then you definitely should read the \ref
13 MSG_examples. There is also a mailing list: <simgrid-user@lists.gforge.inria.fr>.
14
15 \subsection faq_interfaces What is the difference between MSG, SimDag, and GRAS? Do they serve the same purpose?
16
17 It depend on how you define "purpose", I guess ;)
18
19 They all allow you to build a prototype of application which you can run
20 within the simulator afterward. They all share the same simulation kernel,
21 which is the core of the SimGrid project. They differ by the way you express
22 your application.
23
24 With SimDag, you express your code as a collection of interdependent
25 parallel tasks. So, in this model, applications can be seen as a DAG of
26 tasks. 
27
28 With both GRAS and MSG, your application is seen as a set of communicating
29 processes, exchanging data by the way of messages and performing computation
30 on their own.
31
32 The difference between both is that MSG is somehow easier to use, but GRAS
33 is not limitated to the simulator. Once you're done writing your GRAS code,
34 you can run your code both in the simulator or on a real platform. For this,
35 there is two implementations of the GRAS interface, one for simulation, one
36 for real execution. So, you just have to relink your code to chose one of
37 both world. 
38
39 \subsection faq_generic First steps with SimGrid
40
41 If you decide to go for the MSG interface, please read carefully the
42 \ref MSG_examples. You'll find in \ref MSG_ex_master_slave a very
43 simple consisting of a master (that owns a bunch of tasks and
44 distributes them) , some slaves (that process tasks whenever they
45 receive one) and some forwarder agents (that simply pass the tasks
46 they receive to some slaves).
47
48 If you decide to go for the GRAS interface, you should definitively
49 read the \ref GRAS_tut. The first section constitutes an introduction
50 to the tool and presents the model we use. The second section
51 constitutes a complete step-by-step tutorial building a distributed
52 application from the begining and exemplifying most of the GRAS
53 features in the process. The last section groups some HOWTOS
54 highlighting a given feature of the framework in a more concise way.
55
56 If you decide to go for another interface, I'm afraid your only sources
57 of information will be the source code and the mailing lists...
58
59 \subsection faq_visualization Visualizing and analyzing the results
60
61 It is sometime convenient to "see" how the agents are behaving. If you
62 like colors, you can use <tt>tools/MSG_visualization/colorize.pl </tt>
63 as a filter to your MSG outputs. It works directly with INFO. Beware,
64 INFO() prints on stderr. Do not forget to redirect if you want to
65 filter (e.g. with bash): 
66 \verbatim 
67 ./msg_test small_platform.xml small_deployment.xml 2>&1 | ../../tools/MSG_visualization/colorize.pl
68 \endverbatim
69
70 We also have a more graphical output. Have a look at MSG_paje_output(). It 
71 generates an input to <a href="http://www-id.imag.fr/Logiciels/paje/">Paje</a>.
72 <center>
73 \htmlonly
74  <a href="Paje_MSG_screenshot.jpg"><img src="Paje_MSG_screenshot_thn.jpg"></a>
75 \endhtmlonly
76 </center>
77
78 Vizualization with Paje can be seen as a kind of postmortem
79 analysis. However, as soon as you start playing with big simulations,
80 you'll realize that processing such output is kind of tricky. There is
81 so much generic informations that it is hard to find the information
82 you are looking for.
83
84 As a matter of fact, loging really depends on simulations (e.g. what
85 kind of events is important...). That is why we do not propose a big
86 dump of your whole simulation (it would slow everything down) but give
87 you neat tools to structure you logs. Have a look at \ref XBT_log. In
88 fact, rather than a post-mortem analysis, you may want to do it on the
89 fly. The process you are running can do whatever you want. Have you
90 thought about adding a global structure where you directly compute the
91 informations that are really important rather than writing everything
92 down and then processing huge files?
93
94 \subsection faq_C Argh! Do I really have to code in C?
95
96 Up until now, there is no binding for other languages. If you use C++,
97 you should be able to use the SimGrid library as a standard C library
98 and everything should work fine (simply <i>link</i> against this
99 library; recompiling SimGrid with a C++ compiler won't work and it
100 wouldn't help if you could).
101
102 In fact, we are currently working on Java bindings of MSG to allow
103 all the undergrad students of the world to use this tool. This is a
104 little more tricky than I would have expected, but the work is moving
105 fast forward [2006/05/13]. More languages are evaluated, but for now,
106 we do not feel a real demand for any other language. Please speak up!
107
108 \section faq_installation Installing the SimGrid library
109
110 Many people have been asking me questions on how to use SimGrid. Quite
111 often, the questions were not really about SimGrid but on the
112 installation process. This section is intended to help people that are
113 not familiar with compiling C files under UNIX. If you follow these
114 instructions and still have some troubles, drop an e-mail to
115 <simgrid-user@lists.gforge.inria.fr>.
116
117 \subsection faq_compiling Compiling SimGrid from an archive
118
119 First of all, you need to download the latest version of SimGrid from 
120 <a href="http://gforge.inria.fr/frs/?group_id=12">here</a>.
121 Suppose you have uncompressed SimGrid in some temporary location of
122 your home directory (say <tt>/home/joe/tmp/simgrid-3.0.1 </tt>). The
123 simplest way to use SimGrid is to install it in your home
124 directory. Change your directory to
125 <tt>/home/joe/tmp/simgrid-3.0.1</tt> and type
126
127 \verbatim./configure --prefix=$HOME
128 make
129 make install
130 \endverbatim
131
132 If at some point, something fails, check the section "\ref
133 faq_trouble_compil". If it does not help, you can report this problem to the
134 list but, please, avoid sending a laconic mail like "There is a problem. Is it
135 okay?". Send the config.log file which is automatically generated by
136 configure. Try to capture both the standard output and the error output of the
137 <tt>make</tt> command with <tt>script</tt>. There is no way for us to help you
138 without the relevant bits of information.
139
140 Now, the following directory should have been created : 
141
142       \li <tt>/home/joe/doc/simgrid/html/</tt>
143       \li <tt>/home/joe/lib/</tt>
144       \li <tt>/home/joe/include/</tt>
145
146 SimGrid is not a binary, it is a library. Both a static and a dynamic
147 version are available. Here is what you can find if you try a <tt>ls
148 /home/joe/lib</tt>:
149
150 \verbatim libsimgrid.a libsimgrid.la libsimgrid.so libsimgrid.so.0 libsimgrid.so.0.0.1
151 \endverbatim
152
153 Thus, there is two ways to link your program with SimGrid:
154       \li Either you use the static version, e.g 
155 \verbatim gcc libsimgrid.a -o MainProgram MainProgram.c
156 \endverbatim
157           In this case, all the SimGrid functions are directly
158           included in <tt>MainProgram</tt> (hence a bigger binary).
159       \li Either you use the dynamic version (the preferred method)
160 \verbatim gcc -lsimgrid -o MainProgram MainProgram.c
161 \endverbatim
162           In this case, the SimGrid functions are not included in
163           <tt>MainProgram</tt> and you need to set your environment
164           variable in such a way that <tt>libsimgrid.so</tt> will be
165           found at runtime. This can be done by adding the following
166           line in your .bashrc (if you use bash and if you have
167           installed the SimGrid libraries in your home directory):
168 \verbatim export LD_LIBRARY_PATH=$HOME/lib/:$LD_LIBRARY_PATH
169 \endverbatim
170
171
172 \subsection faq_compiling_svn Compiling SimGrid from the SVN
173
174 The project development takes place in the svn, where all changes are
175 commited when they happen. Then every once in a while, we make sure that the
176 code quality meets our standard and release an archive from the code in the
177 SVN. We afterward go back to the development in the SVN. So, if you need a
178 recently added feature and can afford some little problem with the stability
179 of the lastest features, you may want to use the SVN version instead of a
180 released one.
181
182 For that, you first need to get the "simgrid" module from
183 <a href="http://gforge.inria.fr/scm/?group_id=12">here</a>. 
184
185 You won't find any <tt>configure</tt> and a few other things
186 (<tt>Makefile.in</tt>'s, documentation, ...) will be missing as well. The
187 reason for that is that all these files have to be regenerated using the
188 latest versions of <tt>autoconf</tt>, <tt>libtool</tt>, <tt>automake</tt>
189 (>1.9) and <tt>doxygen</tt> (>1.4). To generate the <tt>configure</tt> and
190 the <tt>Makefile.in</tt>'s, you just have to launch the <tt>bootstrap</tt>
191 command that resides in the top of the source tree. Then just follow the
192 instructions of Section \ref faq_compiling.
193
194 We insist on the fact that you really need the latest versions of
195 autoconf, automake and libtool. Doing this step on exotic architectures/systems
196 (i.e. anything different from a recent linux distribution) may be
197 ... uncertain. If you need to compile the SVN version on a machine where all these
198 dependencies are not met, the easiest is to do <tt>make dist</tt> in the SVN
199 dir of another machine where all dependencies are met. It will create an
200 archive you may deploy on other sites just as a regular stable release.
201
202 In summary, the following commands will checkout the SVN, regenerate the
203 configure script and friends, configure SimGrid and build it.
204
205 \verbatim svn checkout svn://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk
206 mv trunk simgrid
207 cd simgrid
208 ./bootstrap
209 ./configure --enable-maintainer-mode --prefix=<where to install SimGrid>
210 make \endverbatim
211
212 Then, if you want to install SimGrid on the current box, just do:
213 \verbatim make install \endverbatim
214
215 If you want to build an snapshot of the SVN to deploy it on another box (for
216 example because the other machine don't have the autotools), do:
217 \verbatim make dist \endverbatim
218
219 Moreover, you should never call the autotools manually since you must run
220 them in a specific order with specific arguments. Most of the times, the
221 makefiles will automatically call the tools for you. When it's not possible
222 (such as the first time you checkout the SVN), use the ./bootstrap command
223 to call them explicitely.
224
225
226 \subsection faq_setting_MSG Setting up your own MSG code
227
228 Do not build your simulator by modifying the SimGrid examples.  Go
229 outside the SimGrid source tree and create your own working directory
230 (say <tt>/home/joe/SimGrid/MyFirstScheduler/</tt>).
231
232 Suppose your simulation has the following structure (remember it is
233 just an example to illustrate a possible way to compile everything;
234 feel free to organize it as you want).
235
236       \li <tt>sched.h</tt>: a description of the core of the
237           scheduler (i.e. which functions are can be used by the
238           agents). For example we could find the following functions
239           (master, forwarder, slave).
240
241       \li <tt>sched.c</tt>: a C file including <tt>sched.h</tt> and
242           implementing the core of the scheduler. Most of these
243           functions use the MSG functions defined in section \ref
244           msg_gos_functions.
245
246       \li <tt>masterslave.c</tt>: a C file with the main function, i.e.
247           the MSG initialization (MSG_global_init()), the platform
248           creation (e.g. with MSG_create_environment()), the
249           deployment phase (e.g. with MSG_function_register() and
250           MSG_launch_application()) and the call to
251           MSG_main()).
252
253 To compile such a program, we suggest to use the following
254 Makefile. It is a generic Makefile that we have used many times with
255 our students when we teach the C language.
256
257 \verbatim
258 all: masterslave 
259 masterslave: masterslave.o sched.o
260
261 INSTALL_PATH = $$HOME
262 CC = gcc
263 PEDANTIC_PARANOID_FREAK =       -O0 -Wshadow -Wcast-align \
264                                 -Waggregate-return -Wmissing-prototypes -Wmissing-declarations \
265                                 -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations \
266                                 -Wmissing-noreturn -Wredundant-decls -Wnested-externs \
267                                 -Wpointer-arith -Wwrite-strings -finline-functions
268 REASONABLY_CAREFUL_DUDE =       -Wall
269 NO_PRAYER_FOR_THE_WICKED =      -w -O2 
270 WARNINGS =                      $(REASONABLY_CAREFUL_DUDE)
271 CFLAGS = -g $(WARNINGS)
272
273 INCLUDES = -I$(INSTALL_PATH)/include
274 DEFS = -L$(INSTALL_PATH)/lib/
275 LDADD = -lm -lsimgrid 
276 LIBS = 
277
278 %: %.o
279         $(CC) $(INCLUDES) $(DEFS) $(CFLAGS) $^ $(LIBS) $(LDADD) -o $@ 
280
281 %.o: %.c
282         $(CC) $(INCLUDES) $(DEFS) $(CFLAGS) -c -o $@ $<
283
284 clean:
285         rm -f $(BIN_FILES) *.o *~
286 .SUFFIXES:
287 .PHONY : clean
288
289 \endverbatim
290
291 The first two lines indicates what should be build when typing make
292 (<tt>masterslave</tt>) and of which files it is to be made of
293 (<tt>masterslave.o</tt> and <tt>sched.o</tt>). This makefile assumes
294 that you have set up correctly your <tt>LD_LIBRARY_PATH</tt> variable
295 (look, there is a <tt>LDADD = -lm -lsimgrid</tt>). If you prefer using
296 the static version, remove the <tt>-lsimgrid</tt> and add a
297 <tt>$(INSTALL_PATH)/lib/libsimgrid.a</tt> on the next line, right
298 after the <tt>LIBS = </tt>.
299
300 More generally, if you have never written a Makefile by yourself, type
301 in a terminal : <tt>info make</tt> and read the introduction. The
302 previous example should be enough for a first try but you may want to
303 perform some more complex compilations...
304
305 \subsection faq_setting_GRAS Setting up your own GRAS code
306
307 If you use the GRAS interface instead of the MSG one, then previous section
308 is not the better source of information. Instead, you should check the GRAS
309 tutorial in general, and the \ref GRAS_tut_tour_setup in particular.
310
311 \subsection faq_crosscompile Cross-compiling a Windows DLL of SimGrid from linux
312
313 At the moment, we do not distribute Windows pre-compiled version of SimGrid
314 because the support for this platform is still experimental. We know that
315 some parts of the GRAS environment do not work, and we think that the others
316 environments (MSG and SD) have good chances to work, but we didn't test
317 ourselves. This section explains how we generate the SimGrid DLL so that you
318 can build it for yourself. First of all, you need to have a version more
319 recent than 3.1 (ie, a SVN version as time of writting).
320
321 In order to cross-compile the package to windows from linux, you need to
322 install mingw32 (minimalist gnu win32). On Debian, you can do so by
323 installing the packages mingw32 (compiler), mingw32-binutils (linker and
324 so), mingw32-runtime.
325
326 You can use the VPATH support of configure to compile at the same time for
327 linux and windows without dupplicating the source nor cleaning the tree
328 between each. Just run bootstrap (if you use the SVN) to run the autotools.
329 Then, create a linux and a win directories. Then, type:
330 \verbatim  cd linux; ../configure --srcdir=.. <usual configure flags>; make; cd ..
331 cd win;  ../configure --srcdir=.. --host=i586-mingw32msvc <flags>; make; cd ..
332 \endverbatim
333 The trick to VPATH builds is to call configure from another directory,
334 passing it an extra --srcdir argument to tell it where all the sources are.
335 It will understand you want to use VPATH. Then, the trick to cross-compile
336 is simply to add a --host argument specifying the target you want to build
337 for. The i586-mingw32msvc string is what you have to pass to use the mingw32
338 environment as distributed in Debian.
339
340 After that, you can run all make targets from both directories, and test
341 easily that what you change for one arch does not break the other one. 
342
343 It is possible that this VPATH build thing breaks from time to time in the
344 SVN since it's quite fragile, but it's granted to work in any released
345 version. If you experience problems, drop us a mail. 
346
347 Another possible source of issue is that at the moment, building the
348 examples request to use the gras_stub_generator tool, which is a compiled
349 program, not a script. In cross-compilation, you need to cross-execute with
350 wine for example, which is not really pleasant. We are working on this, but
351 in the meanwhile, simply don't build the examples in cross-compilation
352 (<tt>cd src</tt> before running make).
353     
354 Program (cross-)compiled with mingw32 do request an extra DLL at run-time to be
355 usable. For example, if you want to test your build with wine, you should do
356 the following to put this library where wine looks for DLLs.
357 \verbatim 
358 cp /usr/share/doc/mingw32-runtime/mingwm10.dll.gz ~/.wine/c/windows/system/
359 gunzip ~/.wine/c/windows/system/mingwm10.dll.gz
360 \endverbatim
361
362 The DLL is builded in src/.libs, and installed in the <i>prefix</i>/bin directory
363 when you run make install. 
364
365 If you want to use it in a native project on windows, you need to use 
366 simgrid.dll and mingwm10.dll. For each DLL, you need to build .def file
367 under linux (listing the defined symbols), and convert it into a .lib file
368 under windows (specifying this in a way that windows compilers like). To
369 generate the def files, run (under linux):
370 \verbatim echo "LIBRARY libsimgrid-0.dll" > simgrid.def
371 echo EXPORTS >> simgrid.def
372 nm libsimgrid-0.dll | grep ' T _' | sed 's/.* T _//' >> simgrid.def
373 nm libsimgrid-0.dll | grep ' D _' | sed 's/.* D _//' | sed 's/$/ DATA/' >> simgrid.def
374
375 echo "LIBRARY mingwm10.dll" > mingwm10.def
376 echo EXPORTS >> mingwm10.def
377 nm mingwm10.dll | grep ' T _' | sed 's/.* T _//' >> mingwm10.def
378 nm mingwm10.dll | grep ' D _' | sed 's/.* D _//' | sed 's/$/ DATA/' >> mingwm10.def
379 \endverbatim
380
381 To create the import .lib files, use the <tt>lib</tt> windows tool (from
382 MSVC) the following way to produce simgrid.lib and mingwm10.lib
383 \verbatim lib /def:simgrid.def
384 lib /def:mingwm10.def
385 \endverbatim
386
387 If you happen to use Borland C Builder, the right command line is the
388 following (note that you don't need any file.def to get this working).
389 \verbatim implib simgrid.lib libsimgrid-0.dll
390 implib mingwm10.lib mingwm10.dll
391 \endverbatim
392
393 Then, set the following parameters in Visual C++ 2005:
394 Linker -> Input -> Additional dependencies = simgrid.lib mingwm10.lib
395
396 Just in case you wonder how to generate a DLL from libtool in another
397 project, we added -no-undefined to any lib*_la_LDFLAGS variables so that
398 libtool accepts to generate a dynamic library under windows. Then, to make
399 it true, we pass any dependencies (such as -lws2 under windows or -lpthread
400 on need) on the linking line. Passing such deps is a good idea anyway so
401 that they get noted in the library itself, avoiding the users to know about
402 our dependencies and put them manually on their compilation line. Then we
403 added the AC_LIBTOOL_WIN32_DLL macro just before AC_PROG_LIBTOOL in the
404 configure.ac. It means that we exported any symbols which need to be.
405 Nowadays, functions get automatically exported, so we don't need to load our
406 header files with tons of __declspec(dllexport) cruft. We only need to do so
407 for data, but there is no public data in SimGrid so we are good.
408
409 \section faq_howto Feature related questions
410
411 \subsection faq_MIA "Could you please add (your favorite feature here) to SimGrid?"
412
413 Here is the deal. The whole SimGrid project (MSG, SURF, GRAS, ...) is
414 meant to be kept as simple and generic as possible. We cannot add
415 functions for everybody's need when these functions can easily be
416 built from the ones already in the API. Most of the time, it is
417 possible and when it was not possible we always have upgraded the API
418 accordingly. When somebody asks us a question like "How to do that?
419 Is there a function in the API to simply do this?", we're always glad
420 to answer and help. However if we don't need this code for our own
421 need, there is no chance we're going to write it... it's your job! :)
422 The counterpart to our answers is that once you come up with a neat
423 implementation of this feature (task duplication, RPC, thread
424 synchronization, ...), you should send it to us and we will be glad to
425 add it to the distribution. Thus, other people will take advantage of
426 it (and we don't have to answer this question again and again ;).
427
428 You'll find in this section a few "Missing In Action" features. Many
429 people have asked about it and we have given hints on how to simply do
430 it with MSG. Feel free to contribute...
431
432 \subsection faq_MIA_MSG MSG features
433
434 \subsubsection faq_MIA_examples I want some more complex MSG examples!
435
436 Many people have come to ask me a more complex example and each time,
437 they have realized afterward that the basics were in the previous three
438 examples. 
439
440 Of course they have often been needing more complex functions like
441 MSG_process_suspend(), MSG_process_resume() and
442 MSG_process_isSuspended() (to perform synchronization), or
443 MSG_task_Iprobe() and MSG_process_sleep() (to avoid blocking
444 receptions), or even MSG_process_create() (to design asynchronous
445 communications or computations). But the examples are sufficient to
446 start.
447
448 We know. We should add some more examples, but not really some more
449 complex ones... We should add some examples that illustrate some other
450 functionalities (like how to simply encode asynchronous
451 communications, RPC, process migrations, thread synchronization, ...)
452 and we will do it when we will have a little bit more time. We have
453 tried to document the examples so that they are understandable. Tell
454 us if something is not clear and once again feel free to participate!
455 :)
456
457 \subsubsection faq_MIA_taskdup Missing in action: MSG Task duplication/replication
458
459 There is no task duplication in MSG. When you create a task, you can
460 process it or send it somewhere else. As soon as a process has sent
461 this task, he doesn't have this task anymore. It's gone. The receiver
462 process has got the task. However, you could decide upon receiving to
463 create a "copy" of a task but you have to handle by yourself the
464 semantic associated to this "duplication".
465
466 As we already told, we prefer keeping the API as simple as
467 possible. This kind of feature is rather easy to implement by users
468 and the semantic you associate really depends on people. Having a
469 *generic* task duplication mechanism is not that trivial (in
470 particular because of the data field). That is why I would recommand
471 that you write it by yourself even if I can give you advice on how to
472 do it.
473
474 You have the following functions to get informations about a task:
475 MSG_task_get_name(), MSG_task_get_compute_duration(),
476 MSG_task_get_remaining_computation(), MSG_task_get_data_size(),
477 and MSG_task_get_data().
478
479 You could use a dictionnary (#xbt_dict_t) of dynars (#xbt_dynar_t). If
480 you still don't see how to do it, please come back to us...
481
482 \subsubsection faq_MIA_asynchronous I want to do asynchronous communications in MSG
483
484 Up until now, there is no asynchronous communications in MSG. However,
485 you can create as many process as you want so you should be able to do
486 whatever you want... I've written a queue module to help implementing
487 some asynchronous communications at low cost (creating thousands of
488 process only to handle communications may be problematic in term of
489 performance at some point). I'll add it in the distribution asap.
490
491 \subsubsection faq_MIA_thread_synchronization I need to synchronize my MSG processes
492
493 You obviously cannot use pthread_mutexes of pthread_conds. The best
494 thing would be to propose similar structures. Unfortunately, we
495 haven't found time to do it yet. However you can try to play with
496 MSG_process_suspend() and MSG_process_resume(). You can even do some
497 synchronization with fake communications (using MSG_task_get(),
498 MSG_task_put() and MSG_task_Iprobe()).
499
500 \subsubsection faq_MIA_host_load Where is the get_host_load function hidden in MSG?
501
502 There is no such thing because its semantic wouldn't be really
503 clear. Of course, it is something about the amount of host throughput,
504 but there is as many definition of "host load" as people asking for
505 this function. First, you have to remember that resource availability
506 may vary over time, which make any load notion harder to define.
507
508 It may be instantaneous value or an average one. Moreover it may be only the
509 power of the computer, or may take the background load into account, or may
510 even take the currently running tasks into account. In some SURF models,
511 communications have an influence on computational power. Should it be taken
512 into account too?
513
514 First of all, it's near to impossible to predict the load beforehands in the
515 simulator since it depends on too much parameters (background load
516 variation, bandwidth sharing algorithmic complexity) some of them even being
517 not known beforehands (other task starting at the same time). So, getting
518 this information is really hard (just like in real life). It's not just that
519 we want MSG to be as painful as real life. But as it is in some way
520 realistic, we face some of the same problems as we would face in real life.
521
522 How would you do it for real? The most common option is to use something
523 like NWS that performs active probes. The best solution is probably to do
524 the same within MSG, as in next code snippet. It is very close from what you
525 would have to do out of the simulator, and thus gives you information that
526 you could also get in real settings to not hinder the realism of your
527 simulation. 
528
529 \verbatim
530 double get_host_load() {
531    m_task_t task = MSG_task_create("test", 0.001, 0, NULL);
532    double date = MSG_get_clock();
533
534    MSG_task_execute(task);
535    date = MSG_get_clock() - date;
536    MSG_task_destroy(task);
537    return (0.001/date);
538 }
539 \endverbatim
540
541 Of course, it may not match your personal definition of "host load". In this
542 case, please detail what you mean on the mailing list, and we will extend
543 this FAQ section to fit your taste if possible.
544
545 \subsubsection faq_MIA_communication_time How can I get the *real* communication time?  
546
547 Communications are synchronous and thus if you simply get the time
548 before and after a communication, you'll only get the transmission
549 time and the time spent to really communicate (it will also take into
550 account the time spent waiting for the other party to be
551 ready). However, getting the *real* communication time is not really
552 hard either. The following solution is a good starting point.
553
554 \verbatim
555 int sender()
556 {
557   m_task_t task = MSG_task_create("Task", task_comp_size, task_comm_size, 
558                                   calloc(1,sizeof(double)));
559   *((double*) task->data) = MSG_get_clock();
560   MSG_task_put(task, slaves[i % slaves_count], PORT_22);
561   INFO0("Send completed");
562   return 0;
563 }
564 int receiver()
565 {
566   m_task_t task = NULL;
567   double time1,time2;
568
569   time1 = MSG_get_clock();
570   a = MSG_task_get(&(task), PORT_22);
571   time2 = MSG_get_clock();
572   if(time1<*((double *)task->data))
573      time1 = *((double *) task->data);
574   INFO1("Communication time :  \"%f\" ", time2-time1);
575   free(task->data);
576   MSG_task_destroy(task);
577   return 0;
578 }
579 \endverbatim
580
581 \subsection faq_MIA_SimDag SimDag related questions
582
583 \subsubsection faq_SG_comm Implementing communication delays between tasks.
584
585 A classic question of SimDag newcommers is about how to express a
586 communication delay between tasks. The thing is that in SimDag, both
587 computation and communication are seen as tasks.  So, if you want to
588 model a data dependency between two DAG tasks t1 and t2, you have to
589 create 3 SD_tasks: t1, t2 and c and add dependencies in the following
590 way:
591
592 \verbatim
593 SD_task_dependency_add(NULL, NULL, t1, c);
594 SD_task_dependency_add(NULL, NULL, c, t2);
595 \endverbatim
596
597 This way task t2 cannot start before the termination of communication c
598 which in turn cannot start before t1 ends.
599
600 When creating task c, you have to associate an amount of data (in bytes)
601 corresponding to what has to be sent by t1 to t2.
602
603 Finally to schedule the communication task c, you have to build a list
604 comprising the workstations on which t1 and t2 are scheduled (w1 and w2
605 for example) and build a communication matrix that should look like
606 [0;amount ; 0; 0].
607
608 \subsubsection faq_SG_DAG How to implement a distributed dynamic scheduler of DAGs.
609
610 Distributed is somehow "contagious". If you start making distributed
611 decisions, there is no way to handle DAGs directly anymore (unless I
612 am missing something). You have to encode your DAGs in term of
613 communicating process to make the whole scheduling process
614 distributed. Here is an example of how you could do that. Assume T1
615 has to be done before T2.
616
617 \verbatim
618  int your_agent(int argc, char *argv[] {
619    ...
620    T1 = MSG_task_create(...);
621    T2 = MSG_task_create(...);
622    ...
623    while(1) {
624      ...
625      if(cond) MSG_task_execute(T1);
626      ...
627      if((MSG_task_get_remaining_computation(T1)=0.0) && (you_re_in_a_good_mood))
628         MSG_task_execute(T2)
629      else {
630         /* do something else */
631      }
632    }
633  }
634 \endverbatim
635  
636 If you decide that the distributed part is not that much important and that
637 DAG is really the level of abstraction you want to work with, then you should
638 give a try to \ref SD_API.
639
640 \subsubsection faq_SG Where has SG disappeared?
641
642 OK, it's time to explain what's happening to the SimGrid project. Let's
643 start with a little bit of history.
644
645 * Historically, SimGrid was a low-level toolkit for scheduling with
646 classical models such as DAGs. That was SimGrid v.1.* aka SG, written
647 by Henri Casanova. I (Arnaud) had been using it in its earliest
648 versions during an internship at UCSD.
649
650 Then we have realized that encoding distributed algorithm in SG was a
651 real pain.
652
653 * So we have built MSG on top of SG and have released SimGrid v.2.*. MSG
654 offered a very basic API to encode a distributed application easily.
655 However encoding MSG on top of SG was not really convenient and did not
656 use the DAG part since the control of the task synchronization was done
657 on top of MSG and no more in SG. We have been playing a little bit with
658 MSG. We have realized that:
659
660    \li 1) the platform modeling was quite flexible and could be "almost"
661        automated (e.g. using random generator and post-annotations);
662
663    \li 2) SG was the bottleneck because of the way we were using
664        it. We needed to simulate concurrent transfers, complex load
665        sharing mechanisms. Many optimizations (e.g. trace integration)
666        were totally inefficient when combined with MSG and made extending SG
667        to implement new sharing policies, parallel tasks models, or failures
668        (many people were asking for these kind of features) a real pain;
669
670    \li 3) the application modeling was not really easy. Even though the
671        application modeling depends on people's applications, we thought
672        we could improve things here. One of our target here was realistic
673 distributed applications ranging from computer sensor networks like
674 the NWS to peer-to-peer applications;
675
676 * So we have been planning mainly two things for SimGrid 3:
677
678    \li 1) I have proposed to get rid of SG and to re-implement a new kernel
679        that would be faster and more flexible. That is what I did in the
680 end of 2004: SURF. SURF is based on a fast max-min linear solver
681 using O(1) data-structures. I have quickly replaced SG by SURF in
682 MSG and the result has been that on the MSG example, the new
683 version was more than 10 times faster while we had gain a lot of
684 flexibility. I think I could still easily make MSG faster but I
685 have to work on MSG now (e.g. using some of the O(1)
686 data-structures I've been using to build SURF) since it has become
687 the bottleneck. Some MSG functions have been removed from the API
688 but they were mainly intended to build the platform by hand (they
689 had appeared in the earliest versions of MSG) and were therefore
690 not useful anymore since we are providing a complete mechanism to
691 automatically build the platform and deploy the agents on it.;
692
693    \li 2) GRAS is a new project Martin and I have come up with. The idea is
694 to have a programming environment that let you program real
695 distributed applications while letting you the ability to run it in
696 the simulator without having to change the slightest line of your
697 code. From the simulation point of view, GRAS performs the
698 application modeling automatically... Up until now, GRAS works on
699 top MSG for historical reasons but I'm going to make it work
700 directly on top of SURF so that it can use all the flex and the
701 speed provided by SURF.
702
703 Those two things are working, but we want to make everything as clean as
704 possible before releasing SimGrid v.3.
705
706 So what about those nice DAGs we used to have in SimGrid v.1.? They're
707 not anymore in SimGrid v.3. At least not in their original form... Let
708 me recall you the way SimGrid 3 is organized:
709
710 \verbatim
711 ________________
712 |   User code  |
713 |______________|
714 | | MSG | GRAS |
715 | -------------|
716 | |   SURF     |
717 | -------------|
718 |     XBT      |
719 ----------------
720 \endverbatim
721
722 XBT is our tool box and now, you should have an idea of what the other
723 ones are. As you can see, the primitive SG is not here
724 anymore. However we have written a brand new and cleaner API for this
725 purpose: \ref SD_API. It is built directly on top of SURF and provides
726 an API rather close to the old SG:
727
728 \verbatim
729 _________________________
730 |       User code        |
731 |________________________|
732 | | MSG | GRAS | SimDag  |
733 | -----------------------|
734 | |        SURF          |
735 | -----------------------|
736 |          XBT           |
737 --------------------------
738 \endverbatim
739
740 The nice thing is that, as it is writen on top of SURF, it seamlessly
741 support DAG of parallel tasks as well as complex communications
742 patterns. Some old codes using SG are currently under rewrite using
743 \ref SD_API to check that all needful functions are provided.
744
745 \subsection faq_MIA_generic Generic features
746
747 \subsubsection faq_more_processes Increasing the amount of simulated processes
748
749 Here are a few tricks you can apply if you want to increase the amount
750 of processes in your simulations.
751
752  - <b>A few thousands of simulated processes</b> (soft tricks)\n
753    SimGrid can use either pthreads library or the UNIX98 contextes. On
754    most systems, the number of pthreads is limited and then your
755    simulation may be limited for a stupid reason. This is especially
756    true with the current linux pthreads, and I cannot get more than
757    2000 simulated processes with pthreads on my box. The UNIX98
758    contexts allow me to raise the limit to 25,000 simulated processes
759    on my laptop.\n\n
760    The <tt>--with-context</tt> option of the <tt>./configure</tt>
761    script allows you to choose between UNIX98 contextes
762    (<tt>--with-context=ucontext</tt>) and the pthread version
763    (<tt>--with-context=pthread</tt>). The default value is ucontext
764    when the script detect a working UNIX98 context implementation. On
765    Windows boxes, the provided value is discarded and an adapted
766    version is picked up.\n\n
767    We experienced some issues with contextes on some rare systems
768    (solaris 8 and lower or old alpha linuxes comes to mind). The main
769    problem is that the configure script detect the contextes as being
770    functional when it's not true. If you happen to use such a system,
771    switch manually to the pthread version, and provide us with a good
772    patch for the configure script so that it is done automatically ;)
773
774  - <b>Hundred thousands of simulated processes</b> (hard-core tricks)\n 
775    As explained above, SimGrid can use UNIX98 contextes to represent
776    and handle the simulated processes. Thanks to this, the main
777    limitation to the number of simulated processes becomes the
778    available memory.\n\n
779    Here are some tricks I had to use in order to run a token ring
780    between 25,000 processes on my laptop (1Gb memory, 1.5Gb swap).\n
781    - First of all, make sure your code runs for a few hundreds
782      processes before trying to push the limit. Make sure it's
783      valgrind-clean, ie that valgrind does not report neither memory
784      error nor memory leaks. Indeed, numerous simulated processes
785      result in *fat* simulation hindering debugging.
786    - It was really boring to write 25,000 entries in the deployment
787      file, so I wrote a little script
788      <tt>examples/gras/tokenS/make_deployment.pl</tt>, which you may
789      want to adapt to your case. You could also think about hijacking
790      the SURFXML parser (have look at \ref faq_flexml_bypassing).
791    - The deployment file became quite big, so I had to do what is in
792      the FAQ entry \ref faq_flexml_limit
793    - Each UNIX98 context has its own stack entry. As debugging this is
794      quite hairly, the default value is a bit overestimated so that
795      user don't get into trouble about this. You want to tune this
796      size to increse the number of processes. This is the
797      <tt>STACK_SIZE</tt> define in 
798      <tt>src/xbt/context_private.h</tt>, which is 128kb by default.
799      Reduce this as much as you can, but be warned that if this value
800      is too low, you'll get a segfault. The token ring example, which
801      is quite simple, runs with 40kb stacks.
802
803 \subsubsection faq_MIA_batch_scheduler Is there a native support for batch schedulers in SimGrid?
804
805 No, there is no native support for batch schedulers and none is
806 planned because this is a very specific need (and doing it in a
807 generic way is thus very hard). However some people have implemented
808 their own batch schedulers. Vincent Garonne wrote one during his PhD
809 and put his code in the contrib directory of our SVN so that other can
810 keep working on it. You may find inspinring ideas in it.
811
812 \subsubsection faq_MIA_checkpointing I need a checkpointing thing
813
814 Actually, it depends on whether you want to checkpoint the simulation, or to
815 simulate checkpoints. 
816
817 The first one could help if your simulation is a long standing process you
818 want to keep running even on hardware issues. It could also help to
819 <i>rewind</i> the simulation by jumping sometimes on an old checkpoint to
820 cancel recent calculations.\n 
821 Unfortunately, such thing will probably never exist in SG. One would have to
822 duplicate all data structures because doing a rewind at the simulator level
823 is very very hard (not talking about the malloc free operations that might
824 have been done in between). Instead, you may be interested in the Libckpt
825 library (http://www.cs.utk.edu/~plank/plank/www/libckpt.html). This is the
826 checkpointing solution used in the condor project, for example. It makes it
827 easy to create checkpoints (at the OS level, creating something like core
828 files), and rerunning them on need.
829
830 If you want to simulate checkpoints instead, it means that you want the
831 state of an executing task (in particular, the progress made towards
832 completion) to be saved somewhere.  So if a host (and the task executing on
833 it) fails (cf. #MSG_HOST_FAILURE), then the task can be restarted
834 from the last checkpoint.\n
835
836 Actually, such a thing does not exists in SimGrid either, but it's just
837 because we don't think it is fundamental and it may be done in the user code
838 at relatively low cost. You could for example use a watcher that
839 periodically get the remaining amount of things to do (using
840 MSG_task_get_remaining_computation()), or fragment the task in smaller
841 subtasks.
842
843 \subsection faq_platform Platform building and Dynamic resources
844
845 \subsubsection faq_platform Building a realistic platform
846
847 We can speak more than an hour on this subject and we still do not have
848 the right answer, just some ideas. You can read the following
849 <a href="http://graal.ens-lyon.fr/~alegrand/articles/Simgrid-Introduction.pdf">slides</a>.
850 It may give you some hints. You can also have a look at the
851 <tt>tools/platform_generation/</tt> directory. There is a perl-script
852 we use to annotate a Tiers generated platform.
853
854 \subsubsection faq_SURF_dynamic Building a dynamic platform, with resource availability
855
856 A nice feature of SimGrid is that it enables you to seamlessly have
857 resources whose availability change over time. When you build a
858 platform, you generally declare CPUs like that:
859
860 \verbatim
861   <cpu name="Cpu A" power="100.00"/>
862 \endverbatim 
863
864 If you want the availability of "CPU A" to change over time, the only
865 thing you have to do is change this definition like that:
866
867 \verbatim
868   <cpu name="Cpu A" power="100.00" availability_file="trace_A.txt" state_file="trace_A_failure.txt"/>
869 \endverbatim
870
871 For CPUs, availability files are expressed in fraction of available
872 power. Let's have a look at what "trace_A.txt" may look like:
873
874 \verbatim
875 PERIODICITY 1.0
876 0.0 1.0
877 11.0 0.5
878 20.0 0.9
879 \endverbatim
880
881 At time 0, our CPU will deliver 100 flop/s. At time 11.0, it will
882 deliver only 50 flop/s until time 20.0 where it will will start
883 delivering 90 flop/s. Last at time 21.0 (20.0 plus the periodicity
884 1.0), we'll be back to the beginning and it will deliver 100 flop/s.
885
886 Now let's look at the state file:
887 \verbatim
888 PERIODICITY 10.0
889 1.0 -1.0
890 2.0 1.0
891 \endverbatim
892
893 A negative value means "off" while a positive one means "on". At time
894 1.0, the CPU is on. At time 1.0, it is turned off and at time 2.0, it
895 is turned on again until time 12 (2.0 plus the periodicity 10.0). It
896 will be turned on again at time 13.0 until time 23.0, and so on.
897
898 Now, let's look how the same kind of thing can be done for network
899 links. A usual declaration looks like:
900
901 \verbatim
902   <network_link name="LinkA" bandwidth="10.0" latency="0.2"/>
903 \endverbatim
904
905 You have at your disposal the following options: bandwidth_file,
906 latency_file and state_file. The only difference with CPUs is that
907 bandwidth_file and latency_file do not express fraction of available
908 power but are expressed directly in bytes per seconds and seconds.
909
910 \subsubsection faq_platform_multipath Is it possible to have several paths between two given hosts?
911
912 The answer is no, unfortunately. Let's consider the following platform
913 file:
914
915 \verbatim
916 <route src="A" dst="B">
917    <route_element name="1"/>
918 </route>
919 <route src="B" dst="C">
920   <route_element name="2"/>
921 </route>
922 <route src="A" dst="C">
923   <route_element name="3"/>
924 </route>
925 \endverbatim
926
927 Althrough it is perfectly valid, it does not mean that data traveling
928 from A to C can either go directly (using link 3) or through B (using
929 links 1 and 2). It simply means that the routing on the graph is not
930 trivial, and that data do not following the shortest path in number of
931 hops on this graph. Another way to say it is that there is no implicit
932 in these routing descriptions. The system will only use the routes you
933 declare (such as &lt;route src="A" dst="C"&gt;&lt;route_element
934 name="3"/&gt;&lt;/route&gt;), without trying to build new routes by aggregating
935 the provided ones.
936   
937 You are also free to declare platform where the routing is not
938 symetric. For example, add the following to the previous file:
939
940 \verbatim
941 <route src="C" dst="A">
942   <route_element name="2"/>
943   <route_element name="1"/>
944 </route>
945 \endverbatim
946
947 This makes sure that data from C to A go through B where data from A
948 to C go directly. Do not worry about realism of such settings since
949 we've seen ways more weird situation in real settings.
950
951 \subsubsection faq_flexml_bypassing Bypassing the XML parser with your own C functions
952
953 So you want to bypass the XML files parser, uh? Maybe doin some parameter
954 sweep experiments on your simulations or so? This is possible, but it's not
955 really easy. Here is how it goes.
956
957 For this, you have to first remember that the XML parsing in SimGrid is done
958 using a tool called FleXML. Given a DTD, this gives a flex-based parser. If
959 you want to bypass the parser, you need to provide some code mimicking what
960 it does and replacing it in its interactions with the SURF code. So, let's
961 have a look at these interactions.
962
963 FleXML parser are close to classical SAX parsers. It means that a
964 well-formed SimGrid platform XML file might result in the following
965 "events":
966
967   - start "platform_description"
968   - start "cpu" with attributes name="host1" power="1.0"
969   - end "cpu"
970   - start "cpu" with attributes name="host2" power="2.0"
971   - end "cpu"
972   - start "network_link" with ...
973   - end "network_link"
974   - start "route" with ...
975   - end "route"
976   - start "route" with ...
977   - end "route"
978   - end "platform_description"
979
980 The communication from the parser to the SURF code uses two means:
981 Attributes get copied into some global variables, and a surf-provided
982 function gets called by the parser for each event. For example, the event
983   - start "cpu" with attributes name="host1" power="1.0"
984
985 let the parser do the equivalent of:
986 \verbatim
987   strcpy("host1",A_cpu_name);
988   A_cpu_power = 1.0;
989   (*STag_cpu_fun)();
990 \endverbatim
991
992 In SURF, we attach callbacks to the different events by initializing the
993 pointer functions to some the right surf functions. Example in
994 workstation_KCCFLN05.c (surf_parse_open() ends up calling surf_parse()):
995 \verbatim
996   // Building the routes
997   surf_parse_reset_parser();
998   STag_route_fun=parse_route_set_endpoints;
999   ETag_route_element_fun=parse_route_elem;
1000   ETag_route_fun=parse_route_set_route;
1001   surf_parse_open(file);
1002   xbt_assert1((!surf_parse()),"Parse error in %s",file);
1003   surf_parse_close();
1004 \endverbatim
1005     
1006 So, to bypass the FleXML parser, you need to write your own version of the
1007 surf_parse function, which should do the following:
1008    - Call the corresponding STag_<tag>_fun function to simulate tag start
1009    - Fill the A_<tag>_<attribute> variables with the wanted values
1010    - Call the corresponding ETag_<tag>_fun function to simulate tag end
1011    - (do the same for the next set of values, and loop)
1012
1013 Then, tell SimGrid that you want to use your own "parser" instead of the stock one:
1014 \verbatim
1015   surf_parse = surf_parse_bypass;
1016   MSG_create_environment(NULL);
1017 \endverbatim
1018
1019 An example of this trick is distributed in the file examples/msg/msg_test_surfxml_bypassed.c
1020
1021 \section faq_troubleshooting Troubleshooting
1022
1023 \subsection faq_trouble_lib_compil SimGrid compilation and installation problems
1024
1025 \subsubsection faq_trouble_lib_config ./configure fails!
1026
1027 We now only one reason for the configure to fail:
1028
1029  - <b>You are using a borken build environment</b>\n
1030    If symptom is that configure complains about gcc not being able to build
1031    executables, you are probably missing the libc6-dev package. Damn Ubuntu.
1032
1033 If you experience other kind of issue, please get in touch with us. We are
1034 always interested in improving our portability to new systems.
1035
1036 \subsubsection faq_trouble_distcheck Dude! "make check" fails on my machine!
1037
1038 Don't assume we never run this target, because we do. Check
1039 http://bob.loria.fr:8010 if you don't believe us.
1040
1041 There is several reasons which may cause the make check to fail on your
1042 machine:
1043
1044  - <b>You are using a borken libc (probably concerning the contextes)</b>.\n
1045    The symptom is that the "make check" fails within the examples/msg directory.\n
1046    By default, SimGrid uses something called ucontexts. This is part of the
1047    libc, but it's quite undertested. For example, some (old) versions of the
1048    glibc on alpha do not implement these functions, but provide the stubs
1049    (which return ENOSYS: not implemented). It fools our detection mecanism
1050    and leads to segfaults. There is not much we can do to fix the bug.
1051    A workaround is to compile with --with-context=pthread to avoid
1052    ucontext completely. You'll be a bit more limitated in the number
1053    of simulated processes you can start concurently, but 5000
1054    processes is still enough for most purposes, isn't it?\n
1055    This limitation is the reason why we insist on using this piece of ...
1056    software even if it's so troublesome.\n
1057    <b>=> use --with-pthread on AMD64 architecture that do not have an 
1058    ultra-recent libc.</b>
1059    
1060  - <b>There is a bug in SimGrid we aren't aware of</b>.\n
1061    If none of the above apply, please drop us a mail on the mailing list so
1062    that we can check it out. Make sure to read \ref faq_bugrepport
1063    before you do so.
1064
1065 \subsection faq_trouble_compil User code compilation problems
1066
1067 \subsubsection faq_trouble_err_logcat "gcc: _simgrid_this_log_category_does_not_exist__??? undeclared (first use in this function)"
1068
1069 This is because you are using the log mecanism, but you didn't created
1070 any default category in this file. You should refer to \ref XBT_log
1071 for all the details, but you simply forgot to call one of
1072 XBT_LOG_NEW_DEFAULT_CATEGORY() or XBT_LOG_NEW_DEFAULT_SUBCATEGORY().
1073
1074 \subsubsection faq_trouble_pthreadstatic "gcc: undefinded reference to pthread_key_create"
1075
1076 This indicates that one of the library SimGrid depends on (libpthread
1077 here) was missing on the linking command line. Dependencies of
1078 libsimgrid are expressed directly in the dynamic library, so it's
1079 quite impossible that you see this message when doing dynamic linking. 
1080
1081 If you compile your code statically (and if you use a pthread version
1082 of SimGrid -- see \ref faq_more_processes), you must absolutely
1083 specify <tt>-lpthread</tt> on the linker command line. As usual, this should
1084 come after <tt>-lsimgrid</tt> on this command line.
1085
1086 \subsection faq_trouble_errors Runtime error messages
1087
1088 \subsubsection faq_flexml_limit "surf_parse_lex: Assertion `next limit' failed."
1089
1090 This is because your platform file is too big for the parser. 
1091
1092 Actually, the message comes directly from FleXML, the technology on top of
1093 which the parser is built. FleXML has the bad idea of fetching the whole
1094 document in memory before parsing it. And moreover, the memory buffer size
1095 must be determinded at compilation time.
1096
1097 We use a value which seems big enough for our need without bloating the
1098 simulators footprints. But of course your mileage may vary. In this case,
1099 just edit src/surf/surfxml.l modify the definition of
1100 FLEXML_BUFFERSTACKSIZE. E.g.
1101
1102 \verbatim
1103 #define FLEXML_BUFFERSTACKSIZE 1000000000
1104 \endverbatim
1105
1106 Then recompile and everything should be fine, provided that your version of
1107 Flex is recent enough (>= 2.5.31). If not the compilation process should
1108 warn you.
1109
1110 A while ago, we worked on FleXML to reduce a bit its memory consumtion, but
1111 these issues remain. There is two things we should do:
1112
1113   - use a dynamic buffer instead of a static one so that the only limit
1114     becomes your memory, not a stupid constant fixed at compilation time
1115     (maybe not so difficult).
1116   - change the parser so that it does not need to get the whole file in
1117     memory before parsing
1118     (seems quite difficult, but I'm a complete newbe wrt flex stuff).
1119
1120 These are changes to FleXML itself, not SimGrid. But since we kinda hijacked
1121 the development of FleXML, I can grant you that any patches would be really
1122 welcome and quickly integrated.
1123
1124 <b>Update:</b> A new version of FleXML (1.7) was released. Most of the work
1125 was done by William Dowling, who use it in his own work. The good point is
1126 that it now use a dynamic buffer, and that the memory usage was greatly
1127 improved. The downside is that William also changed some things internally,
1128 and it breaks the hack we devised to bypass the parser, as explained in 
1129 \ref faq_flexml_bypassing. Indeed, this is not a classical usage of the
1130 parser, and Will didn't imagine that we may have used (and even documented)
1131 such a crude usage of FleXML. So, we now have to repare the bypassing
1132 functionnality to use the lastest FleXML version and fix the memory usage in
1133 SimGrid.
1134
1135 \subsubsection faq_trouble_gras_transport GRAS spits networking error messages
1136
1137 Gras, on real platforms, naturally use regular sockets to communicate. They
1138 are deeply hiden in the gras abstraction, but when things go wrong, you may
1139 get some weird error messages. Here are some example, with the probable
1140 reason:
1141
1142  - <b>Transport endpoint is not connected</b>: several processes try to open
1143    a server socket on the same port number of the same machine. This is
1144    naturally bad and each process should pick its own port number for this.\n
1145    Maybe, you just have some processes remaining from a previous experiment 
1146    on your machine.\n
1147    Killing them may help, but again if you kill -KILL them, you'll have to
1148    wait for a while: they didn't close there sockets properly and the system
1149    needs a while to notice that this port is free again.
1150
1151  - <b>Socket closed by remote side</b>: if the remote process is not
1152    supposed to close the socket at this point, it may be dead.
1153    
1154  - <b>Connection reset by peer</b>: I found this on internet about this
1155    error. I think it's what's happening here, too:\n   
1156    <i>This basically means that a network error occurred while the client was
1157    receiving data from the server. But what is really happening is that the
1158    server actually accepts the connection, processes the request, and sends
1159    a reply to the client. However, when the server closes the socket, the
1160    client believes that the connection has been terminated abnormally
1161    because the socket implementation sends a TCP reset segment telling the
1162    client to throw away the data and report an error.\n
1163    Sometimes, this problem is caused by not properly closing the
1164    input/output streams and the socket connection. Make sure you close the
1165    input/output streams and socket connection properly. If everything is
1166    closed properly, however, and the problem persists, you can work around
1167    it by adding a one-second sleep before closing the streams and the
1168    socket. This technique, however, is not reliable and may not work on all
1169    systems.</i>\n
1170    Since GRAS sockets are closed properly (repeat after me: there is no bug
1171    in GRAS), it is either that you are closing your sockets on server side
1172    before the client get a chance to read them (use gras_os_sleep() to delay
1173    the server), or the server died awfully before the client got the data.
1174
1175 \subsubsection faq_trouble_errors_big_fat_warning I'm told that my XML files are too old.
1176
1177 We have decided to change the units in SimGrid. Now we use Bytes, Flops and
1178 seconds instead of MBytes, MFlops and seconds... Units should be updated
1179 accordingly and the version of platform_description should be set to a
1180 valuer greater than 1:
1181 \verbatim
1182   <platform_description version="1">
1183 \endverbatim
1184 You should try to use the surfxml_update.pl script that can be found
1185 <a href="https://gforge.inria.fr/plugins/scmsvn/viewcvs.php/contrib/trunk/platform_generation/?rev=4721&root=simgrid"">here</a>.
1186
1187 \subsection faq_trouble_valgrind Valgrind-related issues
1188
1189 If you don't, you really should use valgrind to debug your code, it's
1190 almost magic.
1191
1192 \subsubsection faq_trouble_vg_context Stack switching problems and truncated backtraces
1193
1194 With the default version of simgrid, valgrind will probably spit tons
1195 of warnings about stack switching like the following, and produce
1196 truncated bactraces where only one call appears instead of the whole
1197 stack.
1198
1199 \verbatim
1200 ==14908== Warning: client switching stacks?  SP change: 0xBEA2A48C --> 0x476F350
1201 ==14908==          to suppress, use: --max-stackframe=1171541700 or greater
1202 ==14908== Warning: client switching stacks?  SP change: 0x476E1E4 --> 0xBEA2A48C
1203 ==14908==          to suppress, use: --max-stackframe=1171537240 or greater
1204 ==14908== Warning: client switching stacks?  SP change: 0xBEA2A48C --> 0x4792420
1205 ==14908==          to suppress, use: --max-stackframe=1171685268 or greater
1206 ==14908==          further instances of this message will not be shown.
1207 \endverbatim
1208
1209 This is because valgrind don't like too much the UNIX98 contextes we
1210 use by default in simgrid for efficiency reasons. Simply add the
1211 --with-pthread flag to your configure when debugging your code. You
1212 may also find --disable-compiler-optimization usefull if valgrind or
1213 gdb get fooled by the optimization done by the compiler. But you
1214 should remove these flages when everything works before going in
1215 production (before launching your 1252135 experiments), or everything
1216 will run only one third of the true SimGrid potential.
1217
1218 \subsubsection faq_trouble_vg_longjmp longjmp madness in valgrind
1219
1220 This is when valgrind starts complaining about longjmp things, just like:
1221
1222 \verbatim ==21434== Conditional jump or move depends on uninitialised value(s)
1223 ==21434==    at 0x420DBE5: longjmp (longjmp.c:33)
1224 ==21434==
1225 ==21434== Use of uninitialised value of size 4
1226 ==21434==    at 0x420DC3A: __longjmp (__longjmp.S:48)
1227 \endverbatim
1228
1229 or even when it reports scary things like:
1230
1231 \verbatim ==24023== Warning: client switching stacks?  SP change: 0xBE3FF618 --> 0xBE7FF710
1232 x86->IR: unhandled instruction bytes: 0xF4 0xC7 0x83 0xD0
1233 ==24023==          to suppress, use: --max-stackframe=4194552 or greater
1234 ==24023== Your program just tried to execute an instruction that Valgrind
1235 ==24023== did not recognise.  There are two possible reasons for this.
1236 ==24023== 1. Your program has a bug and erroneously jumped to a non-code
1237 ==24023==    location.  If you are running Memcheck and you just saw a
1238 ==24023==    warning about a bad jump, it's probably your program's fault.
1239 ==24023== 2. The instruction is legitimate but Valgrind doesn't handle it,
1240 ==24023==    i.e. it's Valgrind's fault.  If you think this is the case or
1241 ==24023==    you are not sure, please let us know.
1242 ==24023== Either way, Valgrind will now raise a SIGILL signal which will
1243 ==24023== probably kill your program.
1244 ==24023==
1245 ==24023== Process terminating with default action of signal 4 (SIGILL)
1246 ==24023==  Illegal opcode at address 0x420D234
1247 ==24023==    at 0x420D234: abort (abort.c:124)
1248 \endverbatim
1249
1250 This is the sign that you didn't used the exception mecanism well. Most
1251 probably, you have a <tt>return;</tt> somewhere within a <tt>TRY{}</tt>
1252 block. This is <b>evil</b>, and you must not do this. Did you read the section
1253 about \ref XBT_ex??
1254
1255 \subsubsection faq_trouble_vg_libc Valgrind spits tons of errors about backtraces!
1256
1257 It may happen that valgrind, the memory debugger beloved by any decent C
1258 programmer, spits tons of warnings like the following :
1259 \verbatim ==8414== Conditional jump or move depends on uninitialised value(s)
1260 ==8414==    at 0x400882D: (within /lib/ld-2.3.6.so)
1261 ==8414==    by 0x414EDE9: (within /lib/tls/i686/cmov/libc-2.3.6.so)
1262 ==8414==    by 0x400B105: (within /lib/ld-2.3.6.so)
1263 ==8414==    by 0x414F937: _dl_open (in /lib/tls/i686/cmov/libc-2.3.6.so)
1264 ==8414==    by 0x4150F4C: (within /lib/tls/i686/cmov/libc-2.3.6.so)
1265 ==8414==    by 0x400B105: (within /lib/ld-2.3.6.so)
1266 ==8414==    by 0x415102D: __libc_dlopen_mode (in /lib/tls/i686/cmov/libc-2.3.6.so)
1267 ==8414==    by 0x412D6B9: backtrace (in /lib/tls/i686/cmov/libc-2.3.6.so)
1268 ==8414==    by 0x8076446: xbt_dictelm_get_ext (dict_elm.c:714)
1269 ==8414==    by 0x80764C1: xbt_dictelm_get (dict_elm.c:732)
1270 ==8414==    by 0x8079010: xbt_cfg_register (config.c:208)
1271 ==8414==    by 0x806821B: MSG_config (msg_config.c:42)
1272 \endverbatim
1273
1274 This problem is somewhere in the libc when using the backtraces and there is
1275 very few things we can do ourselves to fix it. Instead, here is how to tell
1276 valgrind to ignore the error. Add the following to your ~/.valgrind.supp (or
1277 create this file on need). Make sure to change the obj line according to
1278 your personnal mileage (change 2.3.6 to the actual version you are using,
1279 which you can retrieve with a simple "ls /lib/ld*.so").
1280
1281 \verbatim {
1282    name: Backtrace madness
1283    Memcheck:Cond
1284    obj:/lib/ld-2.3.6.so
1285    fun:dl_open_worker
1286    fun:_dl_open
1287    fun:do_dlopen
1288    fun:dlerror_run
1289    fun:__libc_dlopen_mode
1290 }\endverbatim
1291
1292 Then, you have to specify valgrind to use this suppression file by passing
1293 the <tt>--suppressions=$HOME/.valgrind.supp</tt> option on the command line.
1294 You can also add the following to your ~/.bashrc so that it gets passed
1295 automatically. Actually, it passes a bit more options to valgrind, and this
1296 happen to be my personnal settings. Check the valgrind documentation for
1297 more information.
1298
1299 \verbatim export VALGRIND_OPTS="--leak-check=yes --leak-resolution=high --num-callers=40 --tool=memcheck --suppressions=$HOME/.valgrind.supp" \endverbatim
1300
1301 \subsection faq_deadlock There is a deadlock in my code!!!
1302
1303 Unfortunately, we cannot debug every code written in SimGrid.  We
1304 furthermore believe that the framework provides ways enough
1305 information to debug such informations yourself. If the textual output
1306 is not enough, Make sure to check the \ref faq_visualization FAQ entry to see
1307 how to get a graphical one.
1308
1309 Now, if you come up with a really simple example that deadlocks and
1310 you're absolutely convinced that it should not, you can ask on the
1311 list. Just be aware that you'll be severely punished if the mistake is
1312 on your side... We have plenty of FAQ entries to redact and new
1313 features to implement for the impenitents! ;)
1314
1315 \subsection faq_surf_network_latency I get weird timings when I play with the latencies.
1316
1317 OK, first of all, remember that units should be Bytes, Flops and
1318 Seconds. If you don't use such units, some SimGrid constants (e.g. the
1319 SG_TCP_CTE_GAMMA constant used in most network models) won't have the
1320 right unit and you'll end up with weird results.
1321
1322 Here is what happens with a single transfer of size L on a link
1323 (bw,lat) when nothing else happens.
1324
1325 \verbatim
1326 0-----lat--------------------------------------------------t
1327 |-----|**** real_bw =min(bw,SG_TCP_CTE_GAMMA/(2*lat)) *****|
1328 \endverbatim
1329
1330 In more complex situations, this min is the solution of a complex
1331 max-min linear system.  Have a look 
1332 <a href="http://lists.gforge.inria.fr/pipermail/simgrid-devel/2006-April/thread.html">here</a>
1333 and read the two threads "Bug in SURF?" and "Surf bug not
1334 fixed?". You'll have a few other examples of such computations. You
1335 can also read "A Network Model for Simulation of Grid Application" by
1336 Henri Casanova and Loris Marchal to have all the details. The fact
1337 that the real_bw is smaller than bw is easy to understand. The fact
1338 that real_bw is smaller than SG_TCP_CTE_GAMMA/(2*lat) is due to the
1339 window-based congestion mechanism of TCP. With TCP, you can't exploit
1340 your huge network capacity if you don't have a good round-trip-time
1341 because of the acks...
1342
1343 Anyway, what you get is t=lat + L/min(bw,SG_TCP_CTE_GAMMA/(2*lat)).
1344
1345   * if I you set (bw,lat)=(100 000 000, 0.00001), you get t =  1.00001 (you fully
1346 use your link)
1347   * if I you set (bw,lat)=(100 000 000, 0.0001),  you get t =  1.0001 (you're on the
1348 limit)
1349   * if I you set (bw,lat)=(100 000 000, 0.001),   you get t = 10.001  (ouch!)
1350
1351 This bound on the effective bandwidth of a flow is not the only thing
1352 that may make your result be unexpected. For example, two flows
1353 competing on a saturated link receive an amount of bandwidth inversely
1354 proportional to their round trip time.
1355
1356 \subsection faq_bugrepport So I've found a bug in SimGrid. How to report it?
1357
1358 We do our best to make sure to hammer away any bugs of SimGrid, but this is
1359 still an academic project so please be patient if/when you find bugs in it.
1360 If you do, the best solution is to drop an email either on the simgrid-user
1361 or the simgrid-devel mailing list and explain us about the issue.  You can
1362 also decide to open a formal bug report using the
1363 <a href="https://gforge.inria.fr/tracker/?atid=165&group_id=12&func=browse">relevant
1364 interface</a>. You need to login on the server to get the ability to submit
1365 bugs. 
1366
1367 We will do our best to solve any problem repported, but you need to help us
1368 finding the issue. Just telling "it segfault" isn't enough. Telling "It
1369 segfaults when running the attached simulator" doesn't really help either.
1370 You may find the following article interesting to see how to repport
1371 informative bug repports:
1372 http://www.chiark.greenend.org.uk/~sgtatham/bugs.html (it is not SimGrid
1373 specific at all, but it's full of good advices).
1374
1375 \author Arnaud Legrand (arnaud.legrand::imag.fr)
1376 \author Martin Quinson (martin.quinson::loria.fr)
1377
1378
1379 */
1380