Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
8b41d42af0e2bd531b117e1464cd48771e5ecc2e
[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 Currently bindings on top of MSG are supported for Java, Ruby and Lua. You can find a few
53 documentation about them on the doc page. Note that bindings are released separately from the main dist
54 and so have their own version numbers.
55
56 Moreover If you use C++,
57 you should be able to use the SimGrid library as a standard C library
58 and everything should work fine (simply <i>link</i> against this
59 library; recompiling SimGrid with a C++ compiler won't work and it
60 wouldn't help if you could).
61
62 For now,
63 we do not feel a real demand for any other language. But if you think there is one,
64  please speak up!
65
66 \section faq_howto Feature related questions
67
68 \subsection faq_MIA "Could you please add (your favorite feature here) to SimGrid?"
69
70 Here is the deal. The whole SimGrid project (MSG, SURF, ...) is
71 meant to be kept as simple and generic as possible. We cannot add
72 functions for everybody's needs when these functions can easily be
73 built from the ones already in the API. Most of the time, it is
74 possible and when it was not possible we always have upgraded the API
75 accordingly. When somebody asks us a question like "How to do that?
76 Is there a function in the API to simply do this?", we're always glad
77 to answer and help. However if we don't need this code for our own
78 need, there is no chance we're going to write it... it's your job! :)
79 The counterpart to our answers is that once you come up with a neat
80 implementation of this feature (task duplication, RPC, thread
81 synchronization, ...), you should send it to us and we will be glad to
82 add it to the distribution. Thus, other people will take advantage of
83 it (and we don't have to answer this question again and again ;).
84
85 You'll find in this section a few "Missing In Action" features. Many
86 people have asked about it and we have given hints on how to simply do
87 it with MSG. Feel free to contribute...
88
89 \subsection faq_MIA_MSG MSG features
90
91 \subsubsection faq_MIA_examples I want some more complex MSG examples!
92
93 Many people have come to ask me a more complex example and each time,
94 they have realized afterward that the basics were in the previous three
95 examples.
96
97 Of course they have often been needing more complex functions like
98 MSG_process_suspend(), MSG_process_resume() and
99 MSG_process_isSuspended() (to perform synchronization), or
100 MSG_task_Iprobe() and MSG_process_sleep() (to avoid blocking
101 receptions), or even MSG_process_create() (to design asynchronous
102 communications or computations). But the examples are sufficient to
103 start.
104
105 We know. We should add some more examples, but not really some more
106 complex ones... We should add some examples that illustrate some other
107 functionalists (like how to simply encode asynchronous
108 communications, RPC, process migrations, thread synchronization, ...)
109 and we will do it when we will have a little bit more time. We have
110 tried to document the examples so that they are understandable. Tell
111 us if something is not clear and once again feel free to participate!
112 :)
113
114 \subsubsection faq_MIA_taskdup Missing in action: MSG Task duplication/replication
115
116 There is no task duplication in MSG. When you create a task, you can
117 process it or send it somewhere else. As soon as a process has sent
118 this task, he doesn't have this task anymore. It's gone. The receiver
119 process has got the task. However, you could decide upon receiving to
120 create a "copy" of a task but you have to handle by yourself the
121 semantic associated to this "duplication".
122
123 As we already told, we prefer keeping the API as simple as
124 possible. This kind of feature is rather easy to implement by users
125 and the semantic you associate really depends on people. Having a
126 *generic* task duplication mechanism is not that trivial (in
127 particular because of the data field). That is why I would recommend
128 that you write it by yourself even if I can give you advice on how to
129 do it.
130
131 You have the following functions to get information about a task:
132 MSG_task_get_name(), MSG_task_get_compute_duration(),
133 MSG_task_get_remaining_computation(), MSG_task_get_data_size(),
134 and MSG_task_get_data().
135
136 You could use a dictionary (#xbt_dict_t) of dynars (#xbt_dynar_t). If
137 you still don't see how to do it, please come back to us...
138
139 \subsubsection faq_MIA_asynchronous I want to do asynchronous communications in MSG
140
141 In the past (version <= 3.4), there was no function to perform asynchronous communications.
142 It could easily be implemented by creating new process when needed though. Since version 3.5,
143 we have introduced the following functions:
144  - MSG_task_isend()
145  - MSG_task_irecv()
146  - MSG_comm_test()
147  - MSG_comm_wait()
148  - MSG_comm_waitall()
149  - MSG_comm_waitany()
150  - MSG_comm_destroy()
151
152 We refer you to the description of these functions for more details on their usage as well
153 as to the example section on \ref MSG_ex_asynchronous_communications.
154
155 \subsubsection faq_MIA_thread_synchronization I need to synchronize my MSG processes
156
157 You obviously cannot use pthread_mutexes of pthread_conds since we handle every
158 scheduling related decision within SimGrid.
159
160 In the past (version <=3.3.4) you could do it by playing with
161 MSG_process_suspend() and MSG_process_resume() or with fake communications (using MSG_task_get(),
162 MSG_task_put() and MSG_task_Iprobe()).
163
164 Since version 3.4, you can use classical synchronization structures. See page \ref XBT_synchro or simply check in
165 include/xbt/synchro_core.h.
166
167 \subsubsection faq_MIA_host_load Where is the get_host_load function hidden in MSG?
168
169 There is no such thing because its semantic wouldn't be really
170 clear. Of course, it is something about the amount of host throughput,
171 but there is as many definition of "host load" as people asking for
172 this function. First, you have to remember that resource availability
173 may vary over time, which make any load notion harder to define.
174
175 It may be instantaneous value or an average one. Moreover it may be only the
176 power of the computer, or may take the background load into account, or may
177 even take the currently running tasks into account. In some SURF models,
178 communications have an influence on computational power. Should it be taken
179 into account too?
180
181 First of all, it's near to impossible to predict the load beforehand in the
182 simulator since it depends on too much parameters (background load
183 variation, bandwidth sharing algorithmic complexity) some of them even being
184 not known beforehand (other task starting at the same time). So, getting
185 this information is really hard (just like in real life). It's not just that
186 we want MSG to be as painful as real life. But as it is in some way
187 realistic, we face some of the same problems as we would face in real life.
188
189 How would you do it for real? The most common option is to use something
190 like NWS that performs active probes. The best solution is probably to do
191 the same within MSG, as in next code snippet. It is very close from what you
192 would have to do out of the simulator, and thus gives you information that
193 you could also get in real settings to not hinder the realism of your
194 simulation.
195
196 \verbatim
197 double get_host_load() {
198    m_task_t task = MSG_task_create("test", 0.001, 0, NULL);
199    double date = MSG_get_clock();
200
201    MSG_task_execute(task);
202    date = MSG_get_clock() - date;
203    MSG_task_destroy(task);
204    return (0.001/date);
205 }
206 \endverbatim
207
208 Of course, it may not match your personal definition of "host load". In this
209 case, please detail what you mean on the mailing list, and we will extend
210 this FAQ section to fit your taste if possible.
211
212 \subsubsection faq_MIA_communication_time How can I get the *real* communication time?
213
214 Communications are synchronous and thus if you simply get the time
215 before and after a communication, you'll only get the transmission
216 time and the time spent to really communicate (it will also take into
217 account the time spent waiting for the other party to be
218 ready). However, getting the *real* communication time is not really
219 hard either. The following solution is a good starting point.
220
221 \verbatim
222 int sender()
223 {
224   m_task_t task = MSG_task_create("Task", task_comp_size, task_comm_size,
225                                   calloc(1,sizeof(double)));
226   *((double*) task->data) = MSG_get_clock();
227   MSG_task_put(task, slaves[i % slaves_count], PORT_22);
228   XBT_INFO("Send completed");
229   return 0;
230 }
231 int receiver()
232 {
233   m_task_t task = NULL;
234   double time1,time2;
235
236   time1 = MSG_get_clock();
237   a = MSG_task_get(&(task), PORT_22);
238   time2 = MSG_get_clock();
239   if(time1<*((double *)task->data))
240      time1 = *((double *) task->data);
241   XBT_INFO("Communication time :  \"%f\" ", time2-time1);
242   free(task->data);
243   MSG_task_destroy(task);
244   return 0;
245 }
246 \endverbatim
247
248 \subsection faq_MIA_SimDag SimDag related questions
249
250 \subsubsection faq_SG_comm Implementing communication delays between tasks.
251
252 A classic question of SimDag newcomers is about how to express a
253 communication delay between tasks. The thing is that in SimDag, both
254 computation and communication are seen as tasks.  So, if you want to
255 model a data dependency between two DAG tasks t1 and t2, you have to
256 create 3 SD_tasks: t1, t2 and c and add dependencies in the following
257 way:
258
259 \verbatim
260 SD_task_dependency_add(NULL, NULL, t1, c);
261 SD_task_dependency_add(NULL, NULL, c, t2);
262 \endverbatim
263
264 This way task t2 cannot start before the termination of communication c
265 which in turn cannot start before t1 ends.
266
267 When creating task c, you have to associate an amount of data (in bytes)
268 corresponding to what has to be sent by t1 to t2.
269
270 Finally to schedule the communication task c, you have to build a list
271 comprising the workstations on which t1 and t2 are scheduled (w1 and w2
272 for example) and build a communication matrix that should look like
273 [0;amount ; 0; 0].
274
275 \subsubsection faq_SG_DAG How to implement a distributed dynamic scheduler of DAGs.
276
277 Distributed is somehow "contagious". If you start making distributed
278 decisions, there is no way to handle DAGs directly anymore (unless I
279 am missing something). You have to encode your DAGs in term of
280 communicating process to make the whole scheduling process
281 distributed. Here is an example of how you could do that. Assume T1
282 has to be done before T2.
283
284 \verbatim
285  int your_agent(int argc, char *argv[] {
286    ...
287    T1 = MSG_task_create(...);
288    T2 = MSG_task_create(...);
289    ...
290    while(1) {
291      ...
292      if(cond) MSG_task_execute(T1);
293      ...
294      if((MSG_task_get_remaining_computation(T1)=0.0) && (you_re_in_a_good_mood))
295         MSG_task_execute(T2)
296      else {
297         /* do something else */
298      }
299    }
300  }
301 \endverbatim
302
303 If you decide that the distributed part is not that much important and that
304 DAG is really the level of abstraction you want to work with, then you should
305 give a try to \ref SD_API.
306
307 \subsection faq_MIA_generic Generic features
308
309 \subsubsection faq_MIA_batch_scheduler Is there a native support for batch schedulers in SimGrid?
310
311 No, there is no native support for batch schedulers and none is
312 planned because this is a very specific need (and doing it in a
313 generic way is thus very hard). However some people have implemented
314 their own batch schedulers. Vincent Garonne wrote one during his PhD
315 and put his code in the contrib directory of our SVN so that other can
316 keep working on it. You may find inspiring ideas in it.
317
318 \subsubsection faq_MIA_checkpointing I need a checkpointing thing
319
320 Actually, it depends on whether you want to checkpoint the simulation, or to
321 simulate checkpoints.
322
323 The first one could help if your simulation is a long standing process you
324 want to keep running even on hardware issues. It could also help to
325 <i>rewind</i> the simulation by jumping sometimes on an old checkpoint to
326 cancel recent calculations.\n
327 Unfortunately, such thing will probably never exist in SG. One would have to
328 duplicate all data structures because doing a rewind at the simulator level
329 is very very hard (not talking about the malloc free operations that might
330 have been done in between). Instead, you may be interested in the Libckpt
331 library (http://www.cs.utk.edu/~plank/plank/www/libckpt.html). This is the
332 checkpointing solution used in the condor project, for example. It makes it
333 easy to create checkpoints (at the OS level, creating something like core
334 files), and rerunning them on need.
335
336 If you want to simulate checkpoints instead, it means that you want the
337 state of an executing task (in particular, the progress made towards
338 completion) to be saved somewhere.  So if a host (and the task executing on
339 it) fails (cf. #MSG_HOST_FAILURE), then the task can be restarted
340 from the last checkpoint.\n
341
342 Actually, such a thing does not exist in SimGrid either, but it's just
343 because we don't think it is fundamental and it may be done in the user code
344 at relatively low cost. You could for example use a watcher that
345 periodically get the remaining amount of things to do (using
346 MSG_task_get_remaining_computation()), or fragment the task in smaller
347 subtasks.
348
349 \subsection faq_platform Platform building and Dynamic resources
350
351 \subsubsection faq_platform_example Where can I find SimGrid platform files?
352
353 There are several little examples in the archive, in the examples/msg
354 directory. From time to time, we are asked for other files, but we
355 don't have much at hand right now.
356
357 You should refer to the Platform Description Archive
358 (http://pda.gforge.inria.fr) project to see the other platform file we
359 have available, as well as the Simulacrum simulator, meant to generate
360 SimGrid platforms using all classical generation algorithms.
361
362 \subsubsection faq_platform_alnem How can I automatically map an existing platform?
363
364 We are working on a project called ALNeM (Application-Level Network
365 Mapper) which goal is to automatically discover the topology of an
366 existing network. Its output will be a platform description file
367 following the SimGrid syntax, so everybody will get the ability to map
368 their own lab network (and contribute them to the catalog project).
369 This tool is not ready yet, but it move quite fast forward. Just stay
370 tuned.
371
372 \subsubsection faq_platform_synthetic Generating synthetic but realistic platforms
373
374 The third possibility to get a platform file (after manual or
375 automatic mapping of real platforms) is to generate synthetic
376 platforms. Getting a realistic result is not a trivial task, and
377 moreover, nobody is really able to define what "realistic" means when
378 speaking of topology files. You can find some more thoughts on this
379 topic in these
380 <a href="http://graal.ens-lyon.fr/~alegrand/articles/Simgrid-Introduction.pdf">slides</a>.
381
382 If you are looking for an actual tool, there we have a little tool to
383 annotate Tiers-generated topologies. This perl-script is in
384 <tt>tools/platform_generation/</tt> directory of the SVN. Dinda et Al.
385 released a very comparable tool, and called it GridG.
386
387
388 The specified computing power will be available to up to 6 sequential
389 tasks without sharing. If more tasks are placed on this host, the
390 resource will be shared accordingly. For example, if you schedule 12
391 tasks on the host, each will get half of the computing power. Please
392 note that although sound, this model were never scientifically
393 assessed. Please keep this fact in mind when using it.
394
395
396 \subsubsection faq_platform_random Using random variable for the resource power or availability
397
398 The best way to model the resouce power using a random variable is to
399 use an availability trace that is directed by a probability
400 distribution. This can be done using the function
401 tmgr_trace_generator_value() below. The date and value generators is
402 created with one of tmgr_event_generator_new_uniform(),
403 tmgr_event_generator_new_exponential() or
404 tmgr_event_generator_new_weibull() (if you need other generators,
405 adding them to src/surf/trace_mgr.c should be quite trivial and your
406 patch will be welcomed). Once your trace is created, you have to
407 connect it to the resource with the function
408 sg_platf_new_trace_connect().
409
410 That the process is very similar if you want to model the
411 resource availability with a random variable (deciding whether it's
412 on/off instead of deciding its speed) using the function
413 tmgr_trace_generator_state() or tmgr_trace_generator_avail_unavail()
414 instead of tmgr_trace_generator_value().
415
416 Unfortunately, all this is currently lacking a proper documentation,
417 and there is even no proper example of use. You'll thus have to check
418 the header file include/simgrid/platf.h and experiment a bit by
419 yourself. The following code should be a good starting point, and
420 contributing a little clean example would be a good way to help the
421 SimGrid project.
422
423 @code
424 tmgr_trace_generator_value("mytrace",tmgr_event_generator_new_exponential(.5)
425                                      tmgr_event_generator_new_uniform(100000,9999999));
426                                      
427 sg_platf_trace_connect_cbarg_t myconnect = SG_PLATF_TRACE_CONNECT_INITIALIZER;
428 myconnect.kind = SURF_TRACE_CONNECT_KIND_BANDWIDTH;
429 myconnect.trace = "mytrace";
430 myconnect.element = "mylink";
431
432 sg_platf_trace_connect(myconnect);
433 @endcode
434
435 \section faq_troubleshooting Troubleshooting
436
437 \subsection faq_trouble_changelog The feature X stopped to work after my last update 
438
439 I guess that you want to read the ChangeLog file, that always contains
440 all the information that could be important to the users during the
441 upgrade. Actually, you may want to read it (alongside with the NEWS
442 file that highlights the most important changes) even before you
443 upgrade your copy of SimGrid, too.
444
445 Backward compatibility is very important to us, as we want to provide
446 a scientific tool allowing to evaluate the code you write in several
447 years, too. That being said, we sometimes change the interface to make
448 them more usable to the users. When we do so, we always keep the old
449 interface as DEPRECATED. If you still want to use them, you want to
450 define the SIMGRID_DEPRECATED preprocessor symbol before loading the
451 SimGrid files:
452
453 @verbatim
454 #define SIMGRID_DEPRECATED
455 #include <msg/msg.h>
456 @endverbatim
457
458 \subsection faq_trouble_lib_compil SimGrid compilation and installation problems
459
460 \subsubsection faq_trouble_lib_config cmake fails!
461
462 We know only one reason for the configure to fail:
463
464  - <b>You are using a broken build environment</b>\n
465    If symptom is that the configury magic complains about gcc not being able to build
466    executables, you are probably missing the libc6-dev package. Damn Ubuntu.
467
468 If you experience other kind of issue, please get in touch with us. We are
469 always interested in improving our portability to new systems.
470
471 \subsubsection faq_trouble_distcheck Dude! "ctest" fails on my machine!
472
473 Don't assume we never run this target, because we do. Check
474 http://cdash.inria.fr/CDash/index.php?project=Simgrid (click on
475 previous if there is no result for today: results are produced only by
476 11am, French time) and
477 https://buildd.debian.org/status/logs.php?pkg=simgrid if you don't believe us.
478
479 If it's failing on your machine in a way not experienced by the
480 autobuilders above, please drop us a mail on the mailing list so that
481 we can check it out. Make sure to read \ref faq_bugrepport before you
482 do so.
483
484 \subsection faq_trouble_compil User code compilation problems
485
486 \subsubsection faq_trouble_err_logcat "gcc: _simgrid_this_log_category_does_not_exist__??? undeclared (first use in this function)"
487
488 This is because you are using the log mecanism, but you didn't created
489 any default category in this file. You should refer to \ref XBT_log
490 for all the details, but you simply forgot to call one of
491 XBT_LOG_NEW_DEFAULT_CATEGORY() or XBT_LOG_NEW_DEFAULT_SUBCATEGORY().
492
493 \subsubsection faq_trouble_pthreadstatic "gcc: undefined reference to pthread_key_create"
494
495 This indicates that one of the library SimGrid depends on (libpthread
496 here) was missing on the linking command line. Dependencies of
497 libsimgrid are expressed directly in the dynamic library, so it's
498 quite impossible that you see this message when doing dynamic linking.
499
500 If you compile your code statically (and if you use a pthread version
501 of SimGrid -- see \ref faq_more_processes), you must absolutely
502 specify <tt>-lpthread</tt> on the linker command line. As usual, this should
503 come after <tt>-lsimgrid</tt> on this command line.
504
505 \subsubsection faq_trouble_lib_msg_deprecated "gcc: undefined reference to MSG_*"
506
507 Since version 3.7 all the m_channel_t mecanism is deprecated. So functions
508 about this mecanism may get removed in future releases.
509
510 List of functions:
511
512 \li XBT_PUBLIC(int) MSG_get_host_number(void);
513
514 \li XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
515
516 \li XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
517
518 \li XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
519
520 \li XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel, double max_duration);
521
522 \li XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task, int channel, m_host_t host);
523
524 \li XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel, double max_duration, m_host_t host);
525
526 \li XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel);
527
528 \li XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel, double max_rate);
529
530 \li XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task, m_host_t dest, m_channel_t channel, double max_duration);
531
532 \li XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
533
534 \li XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
535
536 \li XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
537
538 \li XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
539
540 \li XBT_PUBLIC(int) MSG_get_channel_number(void);
541
542 If you want them you have to compile Simgrid v3.7 with option "-Denable_msg_deprecated=ON".
543 Using them should print warning to inform what new function you have to use.
544
545 \subsection faq_trouble_errors Runtime error messages
546
547 \subsubsection faq_flexml_limit "surf_parse_lex: Assertion `next limit' failed."
548
549 This is because your platform file is too big for the parser.
550
551 Actually, the message comes directly from FleXML, the technology on top of
552 which the parser is built. FleXML has the bad idea of fetching the whole
553 document in memory before parsing it. And moreover, the memory buffer size
554 must be determined at compilation time.
555
556 We use a value which seems big enough for our need without bloating the
557 simulators footprints. But of course your mileage may vary. In this case,
558 just edit src/surf/surfxml.l modify the definition of
559 FLEXML_BUFFERSTACKSIZE. E.g.
560
561 \verbatim
562 #define FLEXML_BUFFERSTACKSIZE 1000000000
563 \endverbatim
564
565 Then recompile and everything should be fine, provided that your version of
566 Flex is recent enough (>= 2.5.31). If not the compilation process should
567 warn you.
568
569 A while ago, we worked on FleXML to reduce a bit its memory consumption, but
570 these issues remain. There is two things we should do:
571
572   - use a dynamic buffer instead of a static one so that the only limit
573     becomes your memory, not a stupid constant fixed at compilation time
574     (maybe not so difficult).
575   - change the parser so that it does not need to get the whole file in
576     memory before parsing
577     (seems quite difficult, but I'm a complete newbe wrt flex stuff).
578
579 These are changes to FleXML itself, not SimGrid. But since we kinda hijacked
580 the development of FleXML, I can grant you that any patches would be really
581 welcome and quickly integrated.
582
583 <b>Update:</b> A new version of FleXML (1.7) was released. Most of the work
584 was done by William Dowling, who use it in his own work. The good point is
585 that it now use a dynamic buffer, and that the memory usage was greatly
586 improved. The downside is that William also changed some things internally,
587 and it breaks the hack we devised to bypass the parser, as explained in
588 \ref pf_flexml_bypassing. Indeed, this is not a classical usage of the
589 parser, and Will didn't imagine that we may have used (and even documented)
590 such a crude usage of FleXML. So, we now have to repair the bypassing
591 functionality to use the latest FleXML version and fix the memory usage in
592 SimGrid.
593
594 \subsubsection faq_trouble_errors_big_fat_warning I'm told that my XML files are too old.
595
596 The format of the XML platform description files is sometimes
597 improved. For example, we decided to change the units used in SimGrid
598 from MBytes, MFlops and seconds to Bytes, Flops and seconds to ease
599 people exchanging small messages. We also reworked the route
600 descriptions to allow more compact descriptions.
601
602 That is why the XML files are versionned using the 'version' attribute
603 of the root tag. Currently, it should read:
604 \verbatim
605   <platform version="2">
606 \endverbatim
607
608 If your files are too old, you can use the simgrid_update_xml.pl
609 script which can be found in the tools directory of the archive.
610
611 \subsection faq_trouble_valgrind Valgrind-related and other debugger issues
612
613 If you don't, you really should use valgrind to debug your code, it's
614 almost magic.
615
616 \subsubsection faq_trouble_vg_longjmp longjmp madness in valgrind
617
618 This is when valgrind starts complaining about longjmp things, just like:
619
620 \verbatim ==21434== Conditional jump or move depends on uninitialised value(s)
621 ==21434==    at 0x420DBE5: longjmp (longjmp.c:33)
622 ==21434==
623 ==21434== Use of uninitialised value of size 4
624 ==21434==    at 0x420DC3A: __longjmp (__longjmp.S:48)
625 \endverbatim
626
627 This is the sign that you didn't used the exception mecanism well. Most
628 probably, you have a <tt>return;</tt> somewhere within a <tt>TRY{}</tt>
629 block. This is <b>evil</b>, and you must not do this. Did you read the section
630 about \ref XBT_ex??
631
632 \subsubsection faq_trouble_vg_libc Valgrind spits tons of errors about backtraces!
633
634 It may happen that valgrind, the memory debugger beloved by any decent C
635 programmer, spits tons of warnings like the following :
636 \verbatim ==8414== Conditional jump or move depends on uninitialised value(s)
637 ==8414==    at 0x400882D: (within /lib/ld-2.3.6.so)
638 ==8414==    by 0x414EDE9: (within /lib/tls/i686/cmov/libc-2.3.6.so)
639 ==8414==    by 0x400B105: (within /lib/ld-2.3.6.so)
640 ==8414==    by 0x414F937: _dl_open (in /lib/tls/i686/cmov/libc-2.3.6.so)
641 ==8414==    by 0x4150F4C: (within /lib/tls/i686/cmov/libc-2.3.6.so)
642 ==8414==    by 0x400B105: (within /lib/ld-2.3.6.so)
643 ==8414==    by 0x415102D: __libc_dlopen_mode (in /lib/tls/i686/cmov/libc-2.3.6.so)
644 ==8414==    by 0x412D6B9: backtrace (in /lib/tls/i686/cmov/libc-2.3.6.so)
645 ==8414==    by 0x8076446: xbt_dictelm_get_ext (dict_elm.c:714)
646 ==8414==    by 0x80764C1: xbt_dictelm_get (dict_elm.c:732)
647 ==8414==    by 0x8079010: xbt_cfg_register (config.c:208)
648 ==8414==    by 0x806821B: MSG_config (msg_config.c:42)
649 \endverbatim
650
651 This problem is somewhere in the libc when using the backtraces and there is
652 very few things we can do ourselves to fix it. Instead, here is how to tell
653 valgrind to ignore the error. Add the following to your ~/.valgrind.supp (or
654 create this file on need). Make sure to change the obj line according to
655 your personnal mileage (change 2.3.6 to the actual version you are using,
656 which you can retrieve with a simple "ls /lib/ld*.so").
657
658 \verbatim {
659    name: Backtrace madness
660    Memcheck:Cond
661    obj:/lib/ld-2.3.6.so
662    fun:dl_open_worker
663    fun:_dl_open
664    fun:do_dlopen
665    fun:dlerror_run
666    fun:__libc_dlopen_mode
667 }\endverbatim
668
669 Then, you have to specify valgrind to use this suppression file by passing
670 the <tt>--suppressions=$HOME/.valgrind.supp</tt> option on the command line.
671 You can also add the following to your ~/.bashrc so that it gets passed
672 automatically. Actually, it passes a bit more options to valgrind, and this
673 happen to be my personnal settings. Check the valgrind documentation for
674 more information.
675
676 \verbatim export VALGRIND_OPTS="--leak-check=yes --leak-resolution=high --num-callers=40 --tool=memcheck --suppressions=$HOME/.valgrind.supp" \endverbatim
677
678 \subsubsection faq_trouble_backtraces Truncated backtraces
679
680 When debugging SimGrid, it's easier to pass the
681 --disable-compiler-optimization flag to the configure if valgrind or
682 gdb get fooled by the optimization done by the compiler. But you
683 should remove these flag when everything works before going in
684 production (before launching your 1252135 experiments), or everything
685 will run only one half of the true SimGrid potential.
686
687 \subsection faq_deadlock There is a deadlock in my code!!!
688
689 Unfortunately, we cannot debug every code written in SimGrid.  We
690 furthermore believe that the framework provides ways enough
691 information to debug such informations yourself. If the textual output
692 is not enough, Make sure to check the \ref faq_visualization FAQ entry to see
693 how to get a graphical one.
694
695 Now, if you come up with a really simple example that deadlocks and
696 you're absolutely convinced that it should not, you can ask on the
697 list. Just be aware that you'll be severely punished if the mistake is
698 on your side... We have plenty of FAQ entries to redact and new
699 features to implement for the impenitents! ;)
700
701 Using 
702
703 \subsection faq_surf_network_latency I get weird timings when I play with the latencies.
704
705 OK, first of all, remember that units should be Bytes, Flops and
706 Seconds. If you don't use such units, some SimGrid constants (e.g. the
707 SG_TCP_CTE_GAMMA constant used in most network models) won't have the
708 right unit and you'll end up with weird results.
709
710 Here is what happens with a single transfer of size L on a link
711 (bw,lat) when nothing else happens.
712
713 \verbatim
714 0-----lat--------------------------------------------------t
715 |-----|**** real_bw =min(bw,SG_TCP_CTE_GAMMA/(2*lat)) *****|
716 \endverbatim
717
718 In more complex situations, this min is the solution of a complex
719 max-min linear system.  Have a look
720 <a href="http://lists.gforge.inria.fr/pipermail/simgrid-devel/2006-April/thread.html">here</a>
721 and read the two threads "Bug in SURF?" and "Surf bug not
722 fixed?". You'll have a few other examples of such computations. You
723 can also read "A Network Model for Simulation of Grid Application" by
724 Henri Casanova and Loris Marchal to have all the details. The fact
725 that the real_bw is smaller than bw is easy to understand. The fact
726 that real_bw is smaller than SG_TCP_CTE_GAMMA/(2*lat) is due to the
727 window-based congestion mechanism of TCP. With TCP, you can't exploit
728 your huge network capacity if you don't have a good round-trip-time
729 because of the acks...
730
731 Anyway, what you get is t=lat + L/min(bw,SG_TCP_CTE_GAMMA/(2*lat)).
732
733   * if I you set (bw,lat)=(100 000 000, 0.00001), you get t =  1.00001 (you fully
734 use your link)
735   * if I you set (bw,lat)=(100 000 000, 0.0001),  you get t =  1.0001 (you're on the
736 limit)
737   * if I you set (bw,lat)=(100 000 000, 0.001),   you get t = 10.001  (ouch!)
738
739 This bound on the effective bandwidth of a flow is not the only thing
740 that may make your result be unexpected. For example, two flows
741 competing on a saturated link receive an amount of bandwidth inversely
742 proportional to their round trip time.
743
744 \subsection faq_bugrepport So I've found a bug in SimGrid. How to report it?
745
746 We do our best to make sure to hammer away any bugs of SimGrid, but this is
747 still an academic project so please be patient if/when you find bugs in it.
748 If you do, the best solution is to drop an email either on the simgrid-user
749 or the simgrid-devel mailing list and explain us about the issue.  You can
750 also decide to open a formal bug report using the
751 <a href="https://gforge.inria.fr/tracker/?atid=165&group_id=12&func=browse">relevant
752 interface</a>. You need to login on the server to get the ability to submit
753 bugs.
754
755 We will do our best to solve any problem repported, but you need to help us
756 finding the issue. Just telling "it segfault" isn't enough. Telling "It
757 segfaults when running the attached simulator" doesn't really help either.
758 You may find the following article interesting to see how to repport
759 informative bug repports:
760 http://www.chiark.greenend.org.uk/~sgtatham/bugs.html (it is not SimGrid
761 specific at all, but it's full of good advices).
762
763 \author Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
764
765 */
766
767 ******************************************************************
768 *              OLD CRUFT NOT USED ANYMORE                        *
769 ******************************************************************
770
771
772 subsection faq_crosscompile Cross-compiling a Windows DLL of SimGrid from linux
773
774 At the moment, we do not distribute Windows pre-compiled version of SimGrid
775 because the support for this platform is still experimental. We know that
776 some parts of the GRAS environment do not work, and we think that the others
777 environments (MSG and SD) have good chances to work, but we didn't test
778 ourselves. This section explains how we generate the SimGrid DLL so that you
779 can build it for yourself. First of all, you need to have a version more
780 recent than 3.1 (ie, a SVN version as time of writting).
781
782 In order to cross-compile the package to windows from linux, you need to
783 install mingw32 (minimalist gnu win32). On Debian, you can do so by
784 installing the packages mingw32 (compiler), mingw32-binutils (linker and
785 so), mingw32-runtime.
786
787 You can use the VPATH support of configure to compile at the same time for
788 linux and windows without dupplicating the source nor cleaning the tree
789 between each. Just run bootstrap (if you use the SVN) to run the autotools.
790 Then, create a linux and a win directories. Then, type:
791 \verbatim  cd linux; ../configure --srcdir=.. <usual configure flags>; make; cd ..
792 cd win;  ../configure --srcdir=.. --host=i586-mingw32msvc <flags>; make; cd ..
793 \endverbatim
794 The trick to VPATH builds is to call configure from another directory,
795 passing it an extra --srcdir argument to tell it where all the sources are.
796 It will understand you want to use VPATH. Then, the trick to cross-compile
797 is simply to add a --host argument specifying the target you want to build
798 for. The i586-mingw32msvc string is what you have to pass to use the mingw32
799 environment as distributed in Debian.
800
801 After that, you can run all make targets from both directories, and test
802 easily that what you change for one arch does not break the other one.
803
804 It is possible that this VPATH build thing breaks from time to time in the
805 SVN since it's quite fragile, but it's granted to work in any released
806 version. If you experience problems, drop us a mail.
807
808 Another possible source of issue is that at the moment, building the
809 examples request to use the gras_stub_generator tool, which is a compiled
810 program, not a script. In cross-compilation, you need to cross-execute with
811 wine for example, which is not really pleasant. We are working on this, but
812 in the meanwhile, simply don't build the examples in cross-compilation
813 (<tt>cd src</tt> before running make).
814
815 Program (cross-)compiled with mingw32 do request an extra DLL at run-time to be
816 usable. For example, if you want to test your build with wine, you should do
817 the following to put this library where wine looks for DLLs.
818 \verbatim
819 cp /usr/share/doc/mingw32-runtime/mingwm10.dll.gz ~/.wine/c/windows/system/
820 gunzip ~/.wine/c/windows/system/mingwm10.dll.gz
821 \endverbatim
822
823 The DLL is built in src/.libs, and installed in the <i>prefix</i>/bin directory
824 when you run make install.
825
826 If you want to use it in a native project on windows, you need to use
827 simgrid.dll and mingwm10.dll. For each DLL, you need to build .def file
828 under linux (listing the defined symbols), and convert it into a .lib file
829 under windows (specifying this in a way that windows compilers like). To
830 generate the def files, run (under linux):
831 \verbatim echo "LIBRARY libsimgrid-0.dll" > simgrid.def
832 echo EXPORTS >> simgrid.def
833 nm libsimgrid-0.dll | grep ' T _' | sed 's/.* T _//' >> simgrid.def
834 nm libsimgrid-0.dll | grep ' D _' | sed 's/.* D _//' | sed 's/$/ DATA/' >> simgrid.def
835
836 echo "LIBRARY mingwm10.dll" > mingwm10.def
837 echo EXPORTS >> mingwm10.def
838 nm mingwm10.dll | grep ' T _' | sed 's/.* T _//' >> mingwm10.def
839 nm mingwm10.dll | grep ' D _' | sed 's/.* D _//' | sed 's/$/ DATA/' >> mingwm10.def
840 \endverbatim
841
842 To create the import .lib files, use the <tt>lib</tt> windows tool (from
843 MSVC) the following way to produce simgrid.lib and mingwm10.lib
844 \verbatim lib /def:simgrid.def
845 lib /def:mingwm10.def
846 \endverbatim
847
848 If you happen to use Borland C Builder, the right command line is the
849 following (note that you don't need any file.def to get this working).
850 \verbatim implib simgrid.lib libsimgrid-0.dll
851 implib mingwm10.lib mingwm10.dll
852 \endverbatim
853
854 Then, set the following parameters in Visual C++ 2005:
855 Linker -> Input -> Additional dependencies = simgrid.lib mingwm10.lib
856
857 Just in case you wonder how to generate a DLL from libtool in another
858 project, we added -no-undefined to any lib*_la_LDFLAGS variables so that
859 libtool accepts to generate a dynamic library under windows. Then, to make
860 it true, we pass any dependencies (such as -lws2 under windows or -lpthread
861 on need) on the linking line. Passing such deps is a good idea anyway so
862 that they get noted in the library itself, avoiding the users to know about
863 our dependencies and put them manually on their compilation line. Then we
864 added the AC_LIBTOOL_WIN32_DLL macro just before AC_PROG_LIBTOOL in the
865 configure.ac. It means that we exported any symbols which need to be.
866 Nowadays, functions get automatically exported, so we don't need to load our
867 header files with tons of __declspec(dllexport) cruft. We only need to do so
868 for data, but there is no public data in SimGrid so we are good.