Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
FAQ: kill a painfully outdated Q&A
[simgrid.git] / doc / doxygen / FAQ.doc
1 /*! \page FAQ Frequently Asked Questions
2
3 @tableofcontents
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/blog/2010/06/28/Tutorial_at_HPCS/">the slides of the HPCS'10 tutorial</a>
9 (or to these <a href="http://graal.ens-lyon.fr/~alegrand/articles/slides_g5k_simul.pdf">ancient
10 slides</a>, 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. 
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 and SimDag? 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 MSG, your application is seen as a set of communicating
34 processes, exchanging data by the way of messages and performing
35 computation on their own.
36
37 \subsection faq_visualization Visualizing and analyzing the results
38
39 It is sometime convenient to "see" how the agents are behaving. If you
40 like colors, you can use <tt>tools/MSG_visualization/colorize.pl </tt>
41 as a filter to your MSG outputs. It works directly with INFO. Beware,
42 INFO() prints on stderr. Do not forget to redirect if you want to
43 filter (e.g. with bash):
44 \verbatim
45 ./msg_test small_platform.xml small_deployment.xml 2>&1 | ../../tools/MSG_visualization/colorize.pl
46 \endverbatim
47
48 We also have a more graphical output. Have a look at section \ref options_tracing.
49
50 \subsection faq_C Argh! Do I really have to code in C?
51
52 We provide Java bindings of the MSG interface, which is the main
53 SimGrid user API.
54
55 Moreover If you use C++, you should be able to use the SimGrid library
56 as a standard C library and everything should work fine (simply
57 <i>link</i> against this library; recompiling SimGrid with a C++
58 compiler won't work and it wouldn't help if you could).
59
60 For now, we do not feel a real demand for any other language. But if
61 you think there is one, please speak up!
62
63 \section faq_howto Feature related questions
64
65 \subsection faq_MIA "Could you please add (your favorite feature here) to SimGrid?"
66
67 Here is the deal. The whole SimGrid project (MSG, SURF, ...) is
68 meant to be kept as simple and generic as possible. We cannot add
69 functions for everybody's needs when these functions can easily be
70 built from the ones already in the API. Most of the time, it is
71 possible and when it was not possible we always have upgraded the API
72 accordingly. When somebody asks us a question like "How to do that?
73 Is there a function in the API to simply do this?", we're always glad
74 to answer and help. However if we don't need this code for our own
75 need, there is no chance we're going to write it... it's your job! :)
76 The counterpart to our answers is that once you come up with a neat
77 implementation of this feature (task duplication, RPC, thread
78 synchronization, ...), you should send it to us and we will be glad to
79 add it to the distribution. Thus, other people will take advantage of
80 it (and we don't have to answer this question again and again ;).
81
82 You'll find in this section a few "Missing In Action" features. Many
83 people have asked about it and we have given hints on how to simply do
84 it with MSG. Feel free to contribute...
85
86 \subsection faq_MIA_MSG MSG features
87
88 \subsubsection faq_MIA_examples I want some more complex MSG examples!
89
90 Many people have come to ask me a more complex example and each time,
91 they have realized afterward that the basics were in the previous three
92 examples.
93
94 Of course they have often been needing more complex functions like
95 MSG_process_suspend(), MSG_process_resume() and
96 MSG_process_isSuspended() (to perform synchronization), or
97 MSG_task_Iprobe() and MSG_process_sleep() (to avoid blocking
98 receptions), or even MSG_process_create() (to design asynchronous
99 communications or computations). But the examples are sufficient to
100 start.
101
102 We know. We should add some more examples, but not really some more
103 complex ones... We should add some examples that illustrate some other
104 functionalists (like how to simply encode asynchronous
105 communications, RPC, process migrations, thread synchronization, ...)
106 and we will do it when we will have a little bit more time. We have
107 tried to document the examples so that they are understandable. Tell
108 us if something is not clear and once again feel free to participate!
109 :)
110
111 \subsubsection faq_MIA_taskdup Missing in action: MSG Task duplication/replication
112
113 There is no task duplication in MSG. When you create a task, you can
114 process it or send it somewhere else. As soon as a process has sent
115 this task, he doesn't have this task anymore. It's gone. The receiver
116 process has got the task. However, you could decide upon receiving to
117 create a "copy" of a task but you have to handle by yourself the
118 semantic associated to this "duplication".
119
120 As we already told, we prefer keeping the API as simple as
121 possible. This kind of feature is rather easy to implement by users
122 and the semantic you associate really depends on people. Having a
123 *generic* task duplication mechanism is not that trivial (in
124 particular because of the data field). That is why I would recommend
125 that you write it by yourself even if I can give you advice on how to
126 do it.
127
128 You have the following functions to get information about a task:
129 MSG_task_get_name(), MSG_task_get_compute_duration(),
130 MSG_task_get_remaining_computation(), MSG_task_get_data_size(),
131 and MSG_task_get_data().
132
133 You could use a dictionary (#xbt_dict_t) of dynars (#xbt_dynar_t). If
134 you still don't see how to do it, please come back to us...
135
136 \subsubsection faq_MIA_asynchronous I want to do asynchronous communications in MSG
137
138 In the past (version <= 3.4), there was no function to perform asynchronous communications.
139 It could easily be implemented by creating new process when needed though. Since version 3.5,
140 we have introduced the following functions:
141  - MSG_task_isend()
142  - MSG_task_irecv()
143  - MSG_comm_test()
144  - MSG_comm_wait()
145  - MSG_comm_waitall()
146  - MSG_comm_waitany()
147  - MSG_comm_destroy()
148
149 We refer you to the description of these functions for more details on their usage as well
150 as to the example section on \ref MSG_ex_asynchronous_communications.
151
152 \subsubsection faq_MIA_thread_synchronization I need to synchronize my MSG processes
153
154 You obviously cannot use pthread_mutexes of pthread_conds since we handle every
155 scheduling related decision within SimGrid.
156
157 In the past (version <=3.3.4) you could do it by playing with
158 MSG_process_suspend() and MSG_process_resume() or with fake communications (using MSG_task_get(),
159 MSG_task_put() and MSG_task_Iprobe()).
160
161 Since version 3.4, you can use classical synchronization structures. See page \ref XBT_synchro or simply check in
162 include/xbt/synchro_core.h.
163
164 \subsubsection faq_MIA_host_load Where is the get_host_load function hidden in MSG?
165
166 There is no such thing because its semantic wouldn't be really
167 clear. Of course, it is something about the amount of host throughput,
168 but there is as many definition of "host load" as people asking for
169 this function. First, you have to remember that resource availability
170 may vary over time, which make any load notion harder to define.
171
172 It may be instantaneous value or an average one. Moreover it may be only the
173 power of the computer, or may take the background load into account, or may
174 even take the currently running tasks into account. In some SURF models,
175 communications have an influence on computational power. Should it be taken
176 into account too?
177
178 First of all, it's near to impossible to predict the load beforehand in the
179 simulator since it depends on too much parameters (background load
180 variation, bandwidth sharing algorithmic complexity) some of them even being
181 not known beforehand (other task starting at the same time). So, getting
182 this information is really hard (just like in real life). It's not just that
183 we want MSG to be as painful as real life. But as it is in some way
184 realistic, we face some of the same problems as we would face in real life.
185
186 How would you do it for real? The most common option is to use something
187 like NWS that performs active probes. The best solution is probably to do
188 the same within MSG, as in next code snippet. It is very close from what you
189 would have to do out of the simulator, and thus gives you information that
190 you could also get in real settings to not hinder the realism of your
191 simulation.
192
193 \code
194 double get_host_load() {
195    m_task_t task = MSG_task_create("test", 0.001, 0, NULL);
196    double date = MSG_get_clock();
197
198    MSG_task_execute(task);
199    date = MSG_get_clock() - date;
200    MSG_task_destroy(task);
201    return (0.001/date);
202 }
203 \endcode
204
205 Of course, it may not match your personal definition of "host load". In this
206 case, please detail what you mean on the mailing list, and we will extend
207 this FAQ section to fit your taste if possible.
208
209 \subsubsection faq_MIA_communication_time How can I get the *real* communication time?
210
211 Communications are synchronous and thus if you simply get the time
212 before and after a communication, you'll only get the transmission
213 time and the time spent to really communicate (it will also take into
214 account the time spent waiting for the other party to be
215 ready). However, getting the *real* communication time is not really
216 hard either. The following solution is a good starting point.
217
218 \code
219 int sender()
220 {
221   m_task_t task = MSG_task_create("Task", task_comp_size, task_comm_size,
222                                   calloc(1,sizeof(double)));
223   *((double*) task->data) = MSG_get_clock();
224   MSG_task_put(task, slaves[i % slaves_count], PORT_22);
225   XBT_INFO("Send completed");
226   return 0;
227 }
228 int receiver()
229 {
230   m_task_t task = NULL;
231   double time1,time2;
232
233   time1 = MSG_get_clock();
234   a = MSG_task_get(&(task), PORT_22);
235   time2 = MSG_get_clock();
236   if(time1<*((double *)task->data))
237      time1 = *((double *) task->data);
238   XBT_INFO("Communication time :  \"%f\" ", time2-time1);
239   free(task->data);
240   MSG_task_destroy(task);
241   return 0;
242 }
243 \endcode
244
245 \subsection faq_MIA_SimDag SimDag related questions
246
247 \subsubsection faq_SG_comm Implementing communication delays between tasks.
248
249 A classic question of SimDag newcomers is about how to express a
250 communication delay between tasks. The thing is that in SimDag, both
251 computation and communication are seen as tasks.  So, if you want to
252 model a data dependency between two DAG tasks t1 and t2, you have to
253 create 3 SD_tasks: t1, t2 and c and add dependencies in the following
254 way:
255
256 \code
257 SD_task_dependency_add(NULL, NULL, t1, c);
258 SD_task_dependency_add(NULL, NULL, c, t2);
259 \endcode
260
261 This way task t2 cannot start before the termination of communication c
262 which in turn cannot start before t1 ends.
263
264 When creating task c, you have to associate an amount of data (in bytes)
265 corresponding to what has to be sent by t1 to t2.
266
267 Finally to schedule the communication task c, you have to build a list
268 comprising the workstations on which t1 and t2 are scheduled (w1 and w2
269 for example) and build a communication matrix that should look like
270 [0;amount ; 0; 0].
271
272 \subsubsection faq_SG_DAG How to implement a distributed dynamic scheduler of DAGs.
273
274 Distributed is somehow "contagious". If you start making distributed
275 decisions, there is no way to handle DAGs directly anymore (unless I
276 am missing something). You have to encode your DAGs in term of
277 communicating process to make the whole scheduling process
278 distributed. Here is an example of how you could do that. Assume T1
279 has to be done before T2.
280
281 \code
282  int your_agent(int argc, char *argv[] {
283    ...
284    T1 = MSG_task_create(...);
285    T2 = MSG_task_create(...);
286    ...
287    while(1) {
288      ...
289      if(cond) MSG_task_execute(T1);
290      ...
291      if((MSG_task_get_remaining_computation(T1)=0.0) && (you_re_in_a_good_mood))
292         MSG_task_execute(T2)
293      else {
294         /* do something else */
295      }
296    }
297  }
298 \endcode
299
300 If you decide that the distributed part is not that much important and that
301 DAG is really the level of abstraction you want to work with, then you should
302 give a try to \ref SD_API.
303
304 \subsection faq_MIA_generic Generic features
305
306 \subsubsection faq_MIA_batch_scheduler Is there a native support for batch schedulers in SimGrid?
307
308 No, there is no native support for batch schedulers and none is
309 planned because this is a very specific need (and doing it in a
310 generic way is thus very hard). However some people have implemented
311 their own batch schedulers. Vincent Garonne wrote one during his PhD
312 and put his code in the contrib directory of our SVN so that other can
313 keep working on it. You may find inspiring ideas in it.
314
315 \subsubsection faq_MIA_checkpointing I need a checkpointing thing
316
317 Actually, it depends on whether you want to checkpoint the simulation, or to
318 simulate checkpoints.
319
320 The first one could help if your simulation is a long standing process you
321 want to keep running even on hardware issues. It could also help to
322 <i>rewind</i> the simulation by jumping sometimes on an old checkpoint to
323 cancel recent calculations.\n
324 Unfortunately, such thing will probably never exist in SG. One would have to
325 duplicate all data structures because doing a rewind at the simulator level
326 is very very hard (not talking about the malloc free operations that might
327 have been done in between). Instead, you may be interested in the Libckpt
328 library (http://www.cs.utk.edu/~plank/plank/www/libckpt.html). This is the
329 checkpointing solution used in the condor project, for example. It makes it
330 easy to create checkpoints (at the OS level, creating something like core
331 files), and rerunning them on need.
332
333 If you want to simulate checkpoints instead, it means that you want the
334 state of an executing task (in particular, the progress made towards
335 completion) to be saved somewhere.  So if a host (and the task executing on
336 it) fails (cf. #MSG_HOST_FAILURE), then the task can be restarted
337 from the last checkpoint.\n
338
339 Actually, such a thing does not exist in SimGrid either, but it's just
340 because we don't think it is fundamental and it may be done in the user code
341 at relatively low cost. You could for example use a watcher that
342 periodically get the remaining amount of things to do (using
343 MSG_task_get_remaining_computation()), or fragment the task in smaller
344 subtasks.
345
346 \subsection faq_platform Platform building and Dynamic resources
347
348 \subsubsection faq_platform_example Where can I find SimGrid platform files?
349
350 There are several little examples in the archive, in the examples/msg
351 directory. From time to time, we are asked for other files, but we
352 don't have much at hand right now.
353
354 You should refer to the Platform Description Archive
355 (http://pda.gforge.inria.fr) project to see the other platform file we
356 have available, as well as the Simulacrum simulator, meant to generate
357 SimGrid platforms using all classical generation algorithms.
358
359 \subsubsection faq_platform_alnem How can I automatically map an existing platform?
360
361 We are working on a project called ALNeM (Application-Level Network
362 Mapper) which goal is to automatically discover the topology of an
363 existing network. Its output will be a platform description file
364 following the SimGrid syntax, so everybody will get the ability to map
365 their own lab network (and contribute them to the catalog project).
366 This tool is not ready yet, but it move quite fast forward. Just stay
367 tuned.
368
369 \subsubsection faq_platform_synthetic Generating synthetic but realistic platforms
370
371 The third possibility to get a platform file (after manual or
372 automatic mapping of real platforms) is to generate synthetic
373 platforms. Getting a realistic result is not a trivial task, and
374 moreover, nobody is really able to define what "realistic" means when
375 speaking of topology files. You can find some more thoughts on this
376 topic in these
377 <a href="http://graal.ens-lyon.fr/~alegrand/articles/Simgrid-Introduction.pdf">slides</a>.
378
379 If you are looking for an actual tool, there we have a little tool to
380 annotate Tiers-generated topologies. This perl-script is in
381 <tt>tools/platform_generation/</tt> directory of the SVN. Dinda et Al.
382 released a very comparable tool, and called it GridG.
383
384
385 The specified computing power will be available to up to 6 sequential
386 tasks without sharing. If more tasks are placed on this host, the
387 resource will be shared accordingly. For example, if you schedule 12
388 tasks on the host, each will get half of the computing power. Please
389 note that although sound, this model were never scientifically
390 assessed. Please keep this fact in mind when using it.
391
392
393 \subsubsection faq_platform_random Using random variable for the resource power or availability
394
395 The best way to model the resouce power using a random variable is to
396 use an availability trace that is directed by a probability
397 distribution. This can be done using the function
398 tmgr_trace_generator_value() below. The date and value generators is
399 created with one of tmgr_event_generator_new_uniform(),
400 tmgr_event_generator_new_exponential() or
401 tmgr_event_generator_new_weibull() (if you need other generators,
402 adding them to src/surf/trace_mgr.c should be quite trivial and your
403 patch will be welcomed). Once your trace is created, you have to
404 connect it to the resource with the function
405 sg_platf_new_trace_connect().
406
407 That the process is very similar if you want to model the
408 resource availability with a random variable (deciding whether it's
409 on/off instead of deciding its speed) using the function
410 tmgr_trace_generator_state() or tmgr_trace_generator_avail_unavail()
411 instead of tmgr_trace_generator_value().
412
413 Unfortunately, all this is currently lacking a proper documentation,
414 and there is even no proper example of use. You'll thus have to check
415 the header file include/simgrid/platf.h and experiment a bit by
416 yourself. The following code should be a good starting point, and
417 contributing a little clean example would be a good way to help the
418 SimGrid project.
419
420 @code
421 tmgr_trace_generator_value("mytrace",tmgr_event_generator_new_exponential(.5)
422                                      tmgr_event_generator_new_uniform(100000,9999999));
423                                      
424 sg_platf_trace_connect_cbarg_t myconnect = SG_PLATF_TRACE_CONNECT_INITIALIZER;
425 myconnect.kind = SURF_TRACE_CONNECT_KIND_BANDWIDTH;
426 myconnect.trace = "mytrace";
427 myconnect.element = "mylink";
428
429 sg_platf_trace_connect(myconnect);
430 @endcode
431
432 \section faq_troubleshooting Troubleshooting
433
434 \subsection faq_trouble_changelog The feature X stopped to work after my last update 
435
436 I guess that you want to read the ChangeLog file, that always contains
437 all the information that could be important to the users during the
438 upgrade. Actually, you may want to read it (alongside with the NEWS
439 file that highlights the most important changes) even before you
440 upgrade your copy of SimGrid, too.
441
442 We do our best to maintain the backward compatibility, but we
443 sometimes have to fix the things that are too broken. If we happen to
444 kill a feature that you were using, we are sorry. We think that you
445 should update to the new way of doing things, but if you can't afford
446 it, that's ok. Just stick to the last version that were working for
447 you, and have a pleasant day.
448
449 \subsection faq_trouble_lib_compil SimGrid compilation and installation problems
450
451 \subsubsection faq_trouble_lib_config cmake fails!
452
453 We know only one reason for the configure to fail:
454
455  - <b>You are using a broken build environment</b>\n
456    Try updating your cmake version. If symptom is that the configury
457    magic complains about gcc not being able to build executables, you
458    are probably missing the libc6-dev package. Damn Ubuntu. 
459
460 If you experience other kind of issue, please get in touch with us. We are
461 always interested in improving our portability to new systems.
462
463 \subsubsection faq_trouble_distcheck Dude! "ctest" fails on my machine!
464
465 Don't assume we never run this target, because we do. Check
466 http://cdash.inria.fr/CDash/index.php?project=Simgrid (click on
467 previous if there is no result for today: results are produced only by
468 11am, French time) and
469 https://buildd.debian.org/status/logs.php?pkg=simgrid if you don't believe us.
470
471 If it's failing on your machine in a way not experienced by the
472 autobuilders above, please drop us a mail on the mailing list so that
473 we can check it out. Make sure to read \ref faq_bugrepport before you
474 do so.
475
476 \subsection faq_trouble_compil User code compilation problems
477
478 \subsubsection faq_trouble_err_logcat "gcc: _simgrid_this_log_category_does_not_exist__??? undeclared (first use in this function)"
479
480 This is because you are using the log mechanism, but you didn't created
481 any default category in this file. You should refer to \ref XBT_log
482 for all the details, but you simply forgot to call one of
483 XBT_LOG_NEW_DEFAULT_CATEGORY() or XBT_LOG_NEW_DEFAULT_SUBCATEGORY().
484
485 \subsubsection faq_trouble_pthreadstatic "gcc: undefined reference to pthread_key_create"
486
487 This indicates that one of the library SimGrid depends on (libpthread
488 here) was missing on the linking command line. Dependencies of
489 libsimgrid are expressed directly in the dynamic library, so it's
490 quite impossible that you see this message when doing dynamic linking.
491
492 If you compile your code statically (and if you use a pthread version
493 of SimGrid), you must absolutely
494 specify <tt>-lpthread</tt> on the linker command line. As usual, this should
495 come after <tt>-lsimgrid</tt> on this command line.
496
497 \subsection faq_trouble_errors Runtime error messages
498
499 \subsubsection faq_trouble_errors_big_fat_warning I'm told that my XML files are too old.
500
501 The format of the XML platform description files is sometimes
502 improved. For example, we decided to change the units used in SimGrid
503 from MBytes, MFlops and seconds to Bytes, Flops and seconds to ease
504 people exchanging small messages. We also reworked the route
505 descriptions to allow more compact descriptions.
506
507 That is why the XML files are versionned using the 'version' attribute
508 of the root tag. Currently, it should read:
509 @verbatim
510   <platform version="4">
511 @endverbatim
512
513 If your files are too old, you can use the simgrid_update_xml.pl
514 script which can be found in the tools directory of the archive.
515
516 \subsection faq_trouble_debug Debugging SMPI applications
517
518 In order to debug SMPI programs, you can use the following options:
519
520 - <b>-wrapper 'gdb --args'</b>: this option is used to use a wrapper
521   in order to call the SMPI process. Good candidates for this options
522   are "gdb --args", "valgrind", "rr record", "strace", etc;
523
524 - <b>-foreground</b>: this options gives the debugger access to the terminal
525   which is needed in order to use an interactive debugger.
526
527 Both options are needed in order to run the SMPI process under GDB.
528
529 \subsection faq_trouble_valgrind Valgrind-related and other debugger issues
530
531 If you don't, you really should use valgrind to debug your code, it's
532 almost magic.
533
534 \subsubsection faq_trouble_vg_longjmp longjmp madness in valgrind
535
536 This is when valgrind starts complaining about longjmp things, just like:
537
538 \verbatim ==21434== Conditional jump or move depends on uninitialised value(s)
539 ==21434==    at 0x420DBE5: longjmp (longjmp.c:33)
540 ==21434==
541 ==21434== Use of uninitialised value of size 4
542 ==21434==    at 0x420DC3A: __longjmp (__longjmp.S:48)
543 \endverbatim
544
545 This is the sign that you didn't used the exception mechanism well. Most
546 probably, you have a <tt>return;</tt> somewhere within a <tt>TRY{}</tt>
547 block. This is <b>evil</b>, and you must not do this. Did you read the section
548 about \ref XBT_ex??
549
550 \subsubsection faq_trouble_vg_libc Valgrind spits tons of errors about backtraces!
551
552 It may happen that valgrind, the memory debugger beloved by any decent C
553 programmer, spits tons of warnings like the following :
554 \verbatim ==8414== Conditional jump or move depends on uninitialised value(s)
555 ==8414==    at 0x400882D: (within /lib/ld-2.3.6.so)
556 ==8414==    by 0x414EDE9: (within /lib/tls/i686/cmov/libc-2.3.6.so)
557 ==8414==    by 0x400B105: (within /lib/ld-2.3.6.so)
558 ==8414==    by 0x414F937: _dl_open (in /lib/tls/i686/cmov/libc-2.3.6.so)
559 ==8414==    by 0x4150F4C: (within /lib/tls/i686/cmov/libc-2.3.6.so)
560 ==8414==    by 0x400B105: (within /lib/ld-2.3.6.so)
561 ==8414==    by 0x415102D: __libc_dlopen_mode (in /lib/tls/i686/cmov/libc-2.3.6.so)
562 ==8414==    by 0x412D6B9: backtrace (in /lib/tls/i686/cmov/libc-2.3.6.so)
563 ==8414==    by 0x8076446: xbt_dictelm_get_ext (dict_elm.c:714)
564 ==8414==    by 0x80764C1: xbt_dictelm_get (dict_elm.c:732)
565 ==8414==    by 0x8079010: xbt_cfg_register (config.c:208)
566 ==8414==    by 0x806821B: MSG_config (msg_config.c:42)
567 \endverbatim
568
569 This problem is somewhere in the libc when using the backtraces and there is
570 very few things we can do ourselves to fix it. Instead, here is how to tell
571 valgrind to ignore the error. Add the following to your ~/.valgrind.supp (or
572 create this file on need). Make sure to change the obj line according to
573 your personnal mileage (change 2.3.6 to the actual version you are using,
574 which you can retrieve with a simple "ls /lib/ld*.so").
575
576 \verbatim {
577    name: Backtrace madness
578    Memcheck:Cond
579    obj:/lib/ld-2.3.6.so
580    fun:dl_open_worker
581    fun:_dl_open
582    fun:do_dlopen
583    fun:dlerror_run
584    fun:__libc_dlopen_mode
585 }\endverbatim
586
587 Then, you have to specify valgrind to use this suppression file by passing
588 the <tt>--suppressions=$HOME/.valgrind.supp</tt> option on the command line.
589 You can also add the following to your ~/.bashrc so that it gets passed
590 automatically. Actually, it passes a bit more options to valgrind, and this
591 happen to be my personnal settings. Check the valgrind documentation for
592 more information.
593
594 \verbatim export VALGRIND_OPTS="--leak-check=yes --leak-resolution=high --num-callers=40 --tool=memcheck --suppressions=$HOME/.valgrind.supp" \endverbatim
595
596 \subsubsection faq_trouble_backtraces Truncated backtraces
597
598 When debugging SimGrid, it's easier to pass the
599 --disable-compiler-optimization flag to the configure if valgrind or
600 gdb get fooled by the optimization done by the compiler. But you
601 should remove these flag when everything works before going in
602 production (before launching your 1252135 experiments), or everything
603 will run only one half of the true SimGrid potential.
604
605 \subsection faq_deadlock There is a deadlock in my code!!!
606
607 Unfortunately, we cannot debug every code written in SimGrid.  We
608 furthermore believe that the framework provides ways enough
609 information to debug such information yourself. If the textual output
610 is not enough, Make sure to check the \ref faq_visualization FAQ entry to see
611 how to get a graphical one.
612
613 Now, if you come up with a really simple example that deadlocks and
614 you're absolutely convinced that it should not, you can ask on the
615 list. Just be aware that you'll be severely punished if the mistake is
616 on your side... We have plenty of FAQ entries to redact and new
617 features to implement for the impenitents! ;)
618
619 Using 
620
621 \subsection faq_surf_network_latency I get weird timings when I play with the latencies.
622
623 OK, first of all, remember that units should be Bytes, Flops and
624 Seconds. If you don't use such units, some SimGrid constants (e.g. the
625 SG_TCP_CTE_GAMMA constant used in most network models) won't have the
626 right unit and you'll end up with weird results.
627
628 Here is what happens with a single transfer of size L on a link
629 (bw,lat) when nothing else happens.
630
631 \verbatim
632 0-----lat--------------------------------------------------t
633 |-----|**** real_bw =min(bw,SG_TCP_CTE_GAMMA/(2*lat)) *****|
634 \endverbatim
635
636 In more complex situations, this min is the solution of a complex
637 max-min linear system.  Have a look
638 <a href="http://lists.gforge.inria.fr/pipermail/simgrid-devel/2006-April/thread.html">here</a>
639 and read the two threads "Bug in SURF?" and "Surf bug not
640 fixed?". You'll have a few other examples of such computations. You
641 can also read "A Network Model for Simulation of Grid Application" by
642 Henri Casanova and Loris Marchal to have all the details. The fact
643 that the real_bw is smaller than bw is easy to understand. The fact
644 that real_bw is smaller than SG_TCP_CTE_GAMMA/(2*lat) is due to the
645 window-based congestion mechanism of TCP. With TCP, you can't exploit
646 your huge network capacity if you don't have a good round-trip-time
647 because of the acks...
648
649 Anyway, what you get is t=lat + L/min(bw,SG_TCP_CTE_GAMMA/(2*lat)).
650
651   * if I you set (bw,lat)=(100 000 000, 0.00001), you get t =  1.00001 (you fully
652 use your link)
653   * if I you set (bw,lat)=(100 000 000, 0.0001),  you get t =  1.0001 (you're on the
654 limit)
655   * if I you set (bw,lat)=(100 000 000, 0.001),   you get t = 10.001  (ouch!)
656
657 This bound on the effective bandwidth of a flow is not the only thing
658 that may make your result be unexpected. For example, two flows
659 competing on a saturated link receive an amount of bandwidth inversely
660 proportional to their round trip time.
661
662 \subsection faq_bugrepport So I've found a bug in SimGrid. How to report it?
663
664 We do our best to make sure to hammer away any bugs of SimGrid, but this is
665 still an academic project so please be patient if/when you find bugs in it.
666 If you do, the best solution is to drop an email either on the simgrid-user
667 or the simgrid-devel mailing list and explain us about the issue.  You can
668 also decide to open a formal bug report using the
669 <a href="https://gforge.inria.fr/tracker/?atid=165&group_id=12&func=browse">relevant
670 interface</a>. You need to login on the server to get the ability to submit
671 bugs.
672
673 We will do our best to solve any problem repported, but you need to help us
674 finding the issue. Just telling "it segfault" isn't enough. Telling "It
675 segfaults when running the attached simulator" doesn't really help either.
676 You may find the following article interesting to see how to repport
677 informative bug repports:
678 http://www.chiark.greenend.org.uk/~sgtatham/bugs.html (it is not SimGrid
679 specific at all, but it's full of good advices).
680
681 \author Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
682
683 */