Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cdce92e216ce1556b88fd7a9d9d482cb4192565c
[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_more_processes Increasing the amount of simulated processes
310
311 Here are a few tricks you can apply if you want to increase the amount
312 of processes in your simulations.
313
314  - <b>A few thousands of simulated processes</b> (soft tricks)\n
315    SimGrid can use either pthreads library or the UNIX98 contexts. On
316    most systems, the number of pthreads is limited and then your
317    simulation may be limited for a stupid reason. This is especially
318    true with the current linux pthreads, and I cannot get more than
319    2000 simulated processes with pthreads on my box. The UNIX98
320    contexts allow me to raise the limit to 25,000 simulated processes
321    on my laptop.\n\n
322    The <tt>--with-context</tt> option of the <tt>./configure</tt>
323    script allows you to choose between UNIX98 contexts
324    (<tt>--with-context=ucontext</tt>) and the pthread version
325    (<tt>--with-context=pthread</tt>). The default value is ucontext
326    when the script detect a working UNIX98 context implementation. On
327    Windows boxes, the provided value is discarded and an adapted
328    version is picked up.\n\n
329    We experienced some issues with contexts on some rare systems
330    (solaris 8 and lower or old alpha linuxes comes to mind). The main
331    problem is that the configure script detect the contexts as being
332    functional when it's not true. If you happen to use such a system,
333    switch manually to the pthread version, and provide us with a good
334    patch for the configure script so that it is done automatically ;)
335
336  - <b>Hundred thousands of simulated processes</b> (hard-core tricks)\n
337    As explained above, SimGrid can use UNIX98 contexts to represent
338    and handle the simulated processes. Thanks to this, the main
339    limitation to the number of simulated processes becomes the
340    available memory.\n\n
341    Here are some tricks I had to use in order to run a token ring
342    between 25,000 processes on my laptop (1Gb memory, 1.5Gb swap).\n
343    - First of all, make sure your code runs for a few hundreds
344      processes before trying to push the limit. Make sure it's
345      valgrind-clean, i.e. that valgrind does not report neither memory
346      error nor memory leaks. Indeed, numerous simulated processes
347      result in *fat* simulation hindering debugging.
348    - It was really boring to write 25,000 entries in the deployment
349      file, so I wrote a little script
350      <tt>examples/gras/mutual_exclusion/simple_token/make_deployment.pl</tt>, which you may
351      want to adapt to your case. You could also think about hijacking
352      the SURFXML parser (have look at \ref pf_flexml_bypassing).
353    - The deployment file became quite big, so I had to do what is in
354      the FAQ entry \ref faq_flexml_limit
355    - Each UNIX98 context has its own stack entry. As debugging this is
356      quite hairy, the default value is a bit overestimated so that
357      user doesn't get into trouble about this. You want to tune this
358      size to increase the number of processes. This is the
359      <tt>STACK_SIZE</tt> define in
360      <tt>src/xbt/xbt_context_sysv.c</tt>, which is 128kb by default.
361      Reduce this as much as you can, but be warned that if this value
362      is too low, you'll get a segfault. The token ring example, which
363      is quite simple, runs with 40kb stacks.
364    - You may tweak the logs to reduce the stack size further.  When
365      logging something, we try to build the string to display in a
366      char array on the stack. The size of this array is constant (and
367      equal to XBT_LOG_BUFF_SIZE, defined in include/xbt/log/h). If the
368      string is too large to fit this buffer, we move to a dynamically
369      sized buffer. In which case, we have to traverse one time the log
370      event arguments to compute the size we need for the buffer,
371      malloc it, and traverse the argument list again to do the actual
372      job.\n
373      The idea here is to move XBT_LOG_BUFF_SIZE to 1, forcing the logs
374      to use a dynamic array each time. This allows us to lower further
375      the stack size at the price of some performance loss...\n
376      This allowed me to run the reduce the stack size to ... 4k. Ie,
377      on my 1Gb laptop, I can run more than 250,000 processes!
378
379 \subsubsection faq_MIA_batch_scheduler Is there a native support for batch schedulers in SimGrid?
380
381 No, there is no native support for batch schedulers and none is
382 planned because this is a very specific need (and doing it in a
383 generic way is thus very hard). However some people have implemented
384 their own batch schedulers. Vincent Garonne wrote one during his PhD
385 and put his code in the contrib directory of our SVN so that other can
386 keep working on it. You may find inspiring ideas in it.
387
388 \subsubsection faq_MIA_checkpointing I need a checkpointing thing
389
390 Actually, it depends on whether you want to checkpoint the simulation, or to
391 simulate checkpoints.
392
393 The first one could help if your simulation is a long standing process you
394 want to keep running even on hardware issues. It could also help to
395 <i>rewind</i> the simulation by jumping sometimes on an old checkpoint to
396 cancel recent calculations.\n
397 Unfortunately, such thing will probably never exist in SG. One would have to
398 duplicate all data structures because doing a rewind at the simulator level
399 is very very hard (not talking about the malloc free operations that might
400 have been done in between). Instead, you may be interested in the Libckpt
401 library (http://www.cs.utk.edu/~plank/plank/www/libckpt.html). This is the
402 checkpointing solution used in the condor project, for example. It makes it
403 easy to create checkpoints (at the OS level, creating something like core
404 files), and rerunning them on need.
405
406 If you want to simulate checkpoints instead, it means that you want the
407 state of an executing task (in particular, the progress made towards
408 completion) to be saved somewhere.  So if a host (and the task executing on
409 it) fails (cf. #MSG_HOST_FAILURE), then the task can be restarted
410 from the last checkpoint.\n
411
412 Actually, such a thing does not exist in SimGrid either, but it's just
413 because we don't think it is fundamental and it may be done in the user code
414 at relatively low cost. You could for example use a watcher that
415 periodically get the remaining amount of things to do (using
416 MSG_task_get_remaining_computation()), or fragment the task in smaller
417 subtasks.
418
419 \subsection faq_platform Platform building and Dynamic resources
420
421 \subsubsection faq_platform_example Where can I find SimGrid platform files?
422
423 There are several little examples in the archive, in the examples/msg
424 directory. From time to time, we are asked for other files, but we
425 don't have much at hand right now.
426
427 You should refer to the Platform Description Archive
428 (http://pda.gforge.inria.fr) project to see the other platform file we
429 have available, as well as the Simulacrum simulator, meant to generate
430 SimGrid platforms using all classical generation algorithms.
431
432 \subsubsection faq_platform_alnem How can I automatically map an existing platform?
433
434 We are working on a project called ALNeM (Application-Level Network
435 Mapper) which goal is to automatically discover the topology of an
436 existing network. Its output will be a platform description file
437 following the SimGrid syntax, so everybody will get the ability to map
438 their own lab network (and contribute them to the catalog project).
439 This tool is not ready yet, but it move quite fast forward. Just stay
440 tuned.
441
442 \subsubsection faq_platform_synthetic Generating synthetic but realistic platforms
443
444 The third possibility to get a platform file (after manual or
445 automatic mapping of real platforms) is to generate synthetic
446 platforms. Getting a realistic result is not a trivial task, and
447 moreover, nobody is really able to define what "realistic" means when
448 speaking of topology files. You can find some more thoughts on this
449 topic in these
450 <a href="http://graal.ens-lyon.fr/~alegrand/articles/Simgrid-Introduction.pdf">slides</a>.
451
452 If you are looking for an actual tool, there we have a little tool to
453 annotate Tiers-generated topologies. This perl-script is in
454 <tt>tools/platform_generation/</tt> directory of the SVN. Dinda et Al.
455 released a very comparable tool, and called it GridG.
456
457
458 The specified computing power will be available to up to 6 sequential
459 tasks without sharing. If more tasks are placed on this host, the
460 resource will be shared accordingly. For example, if you schedule 12
461 tasks on the host, each will get half of the computing power. Please
462 note that although sound, this model were never scientifically
463 assessed. Please keep this fact in mind when using it.
464
465
466
467
468 \section faq_troubleshooting Troubleshooting
469
470 \subsection faq_trouble_changelog The feature X stopped to work after my last update 
471
472 I guess that you want to read the ChangeLog file, that always contains
473 all the information that could be important to the users during the
474 upgrade. Actually, you may want to read it (alongside with the NEWS
475 file that highlights the most important changes) even before you
476 upgrade your copy of SimGrid, too.
477
478 Backward compatibility is very important to us, as we want to provide
479 a scientific tool allowing to evaluate the code you write in several
480 years, too. That being said, we sometimes change the interface to make
481 them more usable to the users. When we do so, we always keep the old
482 interface as DEPRECATED. If you still want to use them, you want to
483 define the SIMGRID_DEPRECATED preprocessor symbol before loading the
484 SimGrid files:
485
486 @verbatim
487 #define SIMGRID_DEPRECATED
488 #include <msg/msg.h>
489 @endverbatim
490
491 \subsection faq_trouble_lib_compil SimGrid compilation and installation problems
492
493 \subsubsection faq_trouble_lib_config cmake fails!
494
495 We know only one reason for the configure to fail:
496
497  - <b>You are using a broken build environment</b>\n
498    If symptom is that the configury magic complains about gcc not being able to build
499    executables, you are probably missing the libc6-dev package. Damn Ubuntu.
500
501 If you experience other kind of issue, please get in touch with us. We are
502 always interested in improving our portability to new systems.
503
504 \subsubsection faq_trouble_distcheck Dude! "ctest" fails on my machine!
505
506 Don't assume we never run this target, because we do. Check
507 http://cdash.inria.fr/CDash/index.php?project=Simgrid (click on
508 previous if there is no result for today: results are produced only by
509 11am, French time) and
510 https://buildd.debian.org/status/logs.php?pkg=simgrid if you don't believe us.
511
512 If it's failing on your machine in a way not experienced by the
513 autobuilders above, please drop us a mail on the mailing list so that
514 we can check it out. Make sure to read \ref faq_bugrepport before you
515 do so.
516
517 \subsection faq_trouble_compil User code compilation problems
518
519 \subsubsection faq_trouble_err_logcat "gcc: _simgrid_this_log_category_does_not_exist__??? undeclared (first use in this function)"
520
521 This is because you are using the log mecanism, but you didn't created
522 any default category in this file. You should refer to \ref XBT_log
523 for all the details, but you simply forgot to call one of
524 XBT_LOG_NEW_DEFAULT_CATEGORY() or XBT_LOG_NEW_DEFAULT_SUBCATEGORY().
525
526 \subsubsection faq_trouble_pthreadstatic "gcc: undefined reference to pthread_key_create"
527
528 This indicates that one of the library SimGrid depends on (libpthread
529 here) was missing on the linking command line. Dependencies of
530 libsimgrid are expressed directly in the dynamic library, so it's
531 quite impossible that you see this message when doing dynamic linking.
532
533 If you compile your code statically (and if you use a pthread version
534 of SimGrid -- see \ref faq_more_processes), you must absolutely
535 specify <tt>-lpthread</tt> on the linker command line. As usual, this should
536 come after <tt>-lsimgrid</tt> on this command line.
537
538 \subsubsection faq_trouble_lib_msg_deprecated "gcc: undefined reference to MSG_*"
539
540 Since version 3.7 all the m_channel_t mecanism is deprecated. So functions
541 about this mecanism may get removed in future releases.
542
543 List of functions:
544
545 \li XBT_PUBLIC(int) MSG_get_host_number(void);
546
547 \li XBT_PUBLIC(m_host_t *) MSG_get_host_table(void);
548
549 \li XBT_PUBLIC(MSG_error_t) MSG_get_errno(void);
550
551 \li XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel);
552
553 \li XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel, double max_duration);
554
555 \li XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task, int channel, m_host_t host);
556
557 \li XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel, double max_duration, m_host_t host);
558
559 \li XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel);
560
561 \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);
562
563 \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);
564
565 \li XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
566
567 \li XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
568
569 \li XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, m_host_t host);
570
571 \li XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number);
572
573 \li XBT_PUBLIC(int) MSG_get_channel_number(void);
574
575 If you want them you have to compile Simgrid v3.7 with option "-Denable_msg_deprecated=ON".
576 Using them should print warning to inform what new function you have to use.
577
578 \subsection faq_trouble_errors Runtime error messages
579
580 \subsubsection faq_flexml_limit "surf_parse_lex: Assertion `next limit' failed."
581
582 This is because your platform file is too big for the parser.
583
584 Actually, the message comes directly from FleXML, the technology on top of
585 which the parser is built. FleXML has the bad idea of fetching the whole
586 document in memory before parsing it. And moreover, the memory buffer size
587 must be determined at compilation time.
588
589 We use a value which seems big enough for our need without bloating the
590 simulators footprints. But of course your mileage may vary. In this case,
591 just edit src/surf/surfxml.l modify the definition of
592 FLEXML_BUFFERSTACKSIZE. E.g.
593
594 \verbatim
595 #define FLEXML_BUFFERSTACKSIZE 1000000000
596 \endverbatim
597
598 Then recompile and everything should be fine, provided that your version of
599 Flex is recent enough (>= 2.5.31). If not the compilation process should
600 warn you.
601
602 A while ago, we worked on FleXML to reduce a bit its memory consumption, but
603 these issues remain. There is two things we should do:
604
605   - use a dynamic buffer instead of a static one so that the only limit
606     becomes your memory, not a stupid constant fixed at compilation time
607     (maybe not so difficult).
608   - change the parser so that it does not need to get the whole file in
609     memory before parsing
610     (seems quite difficult, but I'm a complete newbe wrt flex stuff).
611
612 These are changes to FleXML itself, not SimGrid. But since we kinda hijacked
613 the development of FleXML, I can grant you that any patches would be really
614 welcome and quickly integrated.
615
616 <b>Update:</b> A new version of FleXML (1.7) was released. Most of the work
617 was done by William Dowling, who use it in his own work. The good point is
618 that it now use a dynamic buffer, and that the memory usage was greatly
619 improved. The downside is that William also changed some things internally,
620 and it breaks the hack we devised to bypass the parser, as explained in
621 \ref pf_flexml_bypassing. Indeed, this is not a classical usage of the
622 parser, and Will didn't imagine that we may have used (and even documented)
623 such a crude usage of FleXML. So, we now have to repair the bypassing
624 functionality to use the latest FleXML version and fix the memory usage in
625 SimGrid.
626
627 \subsubsection faq_trouble_errors_big_fat_warning I'm told that my XML files are too old.
628
629 The format of the XML platform description files is sometimes
630 improved. For example, we decided to change the units used in SimGrid
631 from MBytes, MFlops and seconds to Bytes, Flops and seconds to ease
632 people exchanging small messages. We also reworked the route
633 descriptions to allow more compact descriptions.
634
635 That is why the XML files are versionned using the 'version' attribute
636 of the root tag. Currently, it should read:
637 \verbatim
638   <platform version="2">
639 \endverbatim
640
641 If your files are too old, you can use the simgrid_update_xml.pl
642 script which can be found in the tools directory of the archive.
643
644 \subsection faq_trouble_valgrind Valgrind-related and other debugger issues
645
646 If you don't, you really should use valgrind to debug your code, it's
647 almost magic.
648
649 \subsubsection faq_trouble_vg_longjmp longjmp madness in valgrind
650
651 This is when valgrind starts complaining about longjmp things, just like:
652
653 \verbatim ==21434== Conditional jump or move depends on uninitialised value(s)
654 ==21434==    at 0x420DBE5: longjmp (longjmp.c:33)
655 ==21434==
656 ==21434== Use of uninitialised value of size 4
657 ==21434==    at 0x420DC3A: __longjmp (__longjmp.S:48)
658 \endverbatim
659
660 This is the sign that you didn't used the exception mecanism well. Most
661 probably, you have a <tt>return;</tt> somewhere within a <tt>TRY{}</tt>
662 block. This is <b>evil</b>, and you must not do this. Did you read the section
663 about \ref XBT_ex??
664
665 \subsubsection faq_trouble_vg_libc Valgrind spits tons of errors about backtraces!
666
667 It may happen that valgrind, the memory debugger beloved by any decent C
668 programmer, spits tons of warnings like the following :
669 \verbatim ==8414== Conditional jump or move depends on uninitialised value(s)
670 ==8414==    at 0x400882D: (within /lib/ld-2.3.6.so)
671 ==8414==    by 0x414EDE9: (within /lib/tls/i686/cmov/libc-2.3.6.so)
672 ==8414==    by 0x400B105: (within /lib/ld-2.3.6.so)
673 ==8414==    by 0x414F937: _dl_open (in /lib/tls/i686/cmov/libc-2.3.6.so)
674 ==8414==    by 0x4150F4C: (within /lib/tls/i686/cmov/libc-2.3.6.so)
675 ==8414==    by 0x400B105: (within /lib/ld-2.3.6.so)
676 ==8414==    by 0x415102D: __libc_dlopen_mode (in /lib/tls/i686/cmov/libc-2.3.6.so)
677 ==8414==    by 0x412D6B9: backtrace (in /lib/tls/i686/cmov/libc-2.3.6.so)
678 ==8414==    by 0x8076446: xbt_dictelm_get_ext (dict_elm.c:714)
679 ==8414==    by 0x80764C1: xbt_dictelm_get (dict_elm.c:732)
680 ==8414==    by 0x8079010: xbt_cfg_register (config.c:208)
681 ==8414==    by 0x806821B: MSG_config (msg_config.c:42)
682 \endverbatim
683
684 This problem is somewhere in the libc when using the backtraces and there is
685 very few things we can do ourselves to fix it. Instead, here is how to tell
686 valgrind to ignore the error. Add the following to your ~/.valgrind.supp (or
687 create this file on need). Make sure to change the obj line according to
688 your personnal mileage (change 2.3.6 to the actual version you are using,
689 which you can retrieve with a simple "ls /lib/ld*.so").
690
691 \verbatim {
692    name: Backtrace madness
693    Memcheck:Cond
694    obj:/lib/ld-2.3.6.so
695    fun:dl_open_worker
696    fun:_dl_open
697    fun:do_dlopen
698    fun:dlerror_run
699    fun:__libc_dlopen_mode
700 }\endverbatim
701
702 Then, you have to specify valgrind to use this suppression file by passing
703 the <tt>--suppressions=$HOME/.valgrind.supp</tt> option on the command line.
704 You can also add the following to your ~/.bashrc so that it gets passed
705 automatically. Actually, it passes a bit more options to valgrind, and this
706 happen to be my personnal settings. Check the valgrind documentation for
707 more information.
708
709 \verbatim export VALGRIND_OPTS="--leak-check=yes --leak-resolution=high --num-callers=40 --tool=memcheck --suppressions=$HOME/.valgrind.supp" \endverbatim
710
711 \subsubsection faq_trouble_backtraces Truncated backtraces
712
713 When debugging SimGrid, it's easier to pass the
714 --disable-compiler-optimization flag to the configure if valgrind or
715 gdb get fooled by the optimization done by the compiler. But you
716 should remove these flag when everything works before going in
717 production (before launching your 1252135 experiments), or everything
718 will run only one half of the true SimGrid potential.
719
720 \subsection faq_deadlock There is a deadlock in my code!!!
721
722 Unfortunately, we cannot debug every code written in SimGrid.  We
723 furthermore believe that the framework provides ways enough
724 information to debug such informations yourself. If the textual output
725 is not enough, Make sure to check the \ref faq_visualization FAQ entry to see
726 how to get a graphical one.
727
728 Now, if you come up with a really simple example that deadlocks and
729 you're absolutely convinced that it should not, you can ask on the
730 list. Just be aware that you'll be severely punished if the mistake is
731 on your side... We have plenty of FAQ entries to redact and new
732 features to implement for the impenitents! ;)
733
734 \subsection faq_surf_network_latency I get weird timings when I play with the latencies.
735
736 OK, first of all, remember that units should be Bytes, Flops and
737 Seconds. If you don't use such units, some SimGrid constants (e.g. the
738 SG_TCP_CTE_GAMMA constant used in most network models) won't have the
739 right unit and you'll end up with weird results.
740
741 Here is what happens with a single transfer of size L on a link
742 (bw,lat) when nothing else happens.
743
744 \verbatim
745 0-----lat--------------------------------------------------t
746 |-----|**** real_bw =min(bw,SG_TCP_CTE_GAMMA/(2*lat)) *****|
747 \endverbatim
748
749 In more complex situations, this min is the solution of a complex
750 max-min linear system.  Have a look
751 <a href="http://lists.gforge.inria.fr/pipermail/simgrid-devel/2006-April/thread.html">here</a>
752 and read the two threads "Bug in SURF?" and "Surf bug not
753 fixed?". You'll have a few other examples of such computations. You
754 can also read "A Network Model for Simulation of Grid Application" by
755 Henri Casanova and Loris Marchal to have all the details. The fact
756 that the real_bw is smaller than bw is easy to understand. The fact
757 that real_bw is smaller than SG_TCP_CTE_GAMMA/(2*lat) is due to the
758 window-based congestion mechanism of TCP. With TCP, you can't exploit
759 your huge network capacity if you don't have a good round-trip-time
760 because of the acks...
761
762 Anyway, what you get is t=lat + L/min(bw,SG_TCP_CTE_GAMMA/(2*lat)).
763
764   * if I you set (bw,lat)=(100 000 000, 0.00001), you get t =  1.00001 (you fully
765 use your link)
766   * if I you set (bw,lat)=(100 000 000, 0.0001),  you get t =  1.0001 (you're on the
767 limit)
768   * if I you set (bw,lat)=(100 000 000, 0.001),   you get t = 10.001  (ouch!)
769
770 This bound on the effective bandwidth of a flow is not the only thing
771 that may make your result be unexpected. For example, two flows
772 competing on a saturated link receive an amount of bandwidth inversely
773 proportional to their round trip time.
774
775 \subsection faq_bugrepport So I've found a bug in SimGrid. How to report it?
776
777 We do our best to make sure to hammer away any bugs of SimGrid, but this is
778 still an academic project so please be patient if/when you find bugs in it.
779 If you do, the best solution is to drop an email either on the simgrid-user
780 or the simgrid-devel mailing list and explain us about the issue.  You can
781 also decide to open a formal bug report using the
782 <a href="https://gforge.inria.fr/tracker/?atid=165&group_id=12&func=browse">relevant
783 interface</a>. You need to login on the server to get the ability to submit
784 bugs.
785
786 We will do our best to solve any problem repported, but you need to help us
787 finding the issue. Just telling "it segfault" isn't enough. Telling "It
788 segfaults when running the attached simulator" doesn't really help either.
789 You may find the following article interesting to see how to repport
790 informative bug repports:
791 http://www.chiark.greenend.org.uk/~sgtatham/bugs.html (it is not SimGrid
792 specific at all, but it's full of good advices).
793
794 \author Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
795
796 */
797
798 ******************************************************************
799 *              OLD CRUFT NOT USED ANYMORE                        *
800 ******************************************************************
801
802
803 subsection faq_crosscompile Cross-compiling a Windows DLL of SimGrid from linux
804
805 At the moment, we do not distribute Windows pre-compiled version of SimGrid
806 because the support for this platform is still experimental. We know that
807 some parts of the GRAS environment do not work, and we think that the others
808 environments (MSG and SD) have good chances to work, but we didn't test
809 ourselves. This section explains how we generate the SimGrid DLL so that you
810 can build it for yourself. First of all, you need to have a version more
811 recent than 3.1 (ie, a SVN version as time of writting).
812
813 In order to cross-compile the package to windows from linux, you need to
814 install mingw32 (minimalist gnu win32). On Debian, you can do so by
815 installing the packages mingw32 (compiler), mingw32-binutils (linker and
816 so), mingw32-runtime.
817
818 You can use the VPATH support of configure to compile at the same time for
819 linux and windows without dupplicating the source nor cleaning the tree
820 between each. Just run bootstrap (if you use the SVN) to run the autotools.
821 Then, create a linux and a win directories. Then, type:
822 \verbatim  cd linux; ../configure --srcdir=.. <usual configure flags>; make; cd ..
823 cd win;  ../configure --srcdir=.. --host=i586-mingw32msvc <flags>; make; cd ..
824 \endverbatim
825 The trick to VPATH builds is to call configure from another directory,
826 passing it an extra --srcdir argument to tell it where all the sources are.
827 It will understand you want to use VPATH. Then, the trick to cross-compile
828 is simply to add a --host argument specifying the target you want to build
829 for. The i586-mingw32msvc string is what you have to pass to use the mingw32
830 environment as distributed in Debian.
831
832 After that, you can run all make targets from both directories, and test
833 easily that what you change for one arch does not break the other one.
834
835 It is possible that this VPATH build thing breaks from time to time in the
836 SVN since it's quite fragile, but it's granted to work in any released
837 version. If you experience problems, drop us a mail.
838
839 Another possible source of issue is that at the moment, building the
840 examples request to use the gras_stub_generator tool, which is a compiled
841 program, not a script. In cross-compilation, you need to cross-execute with
842 wine for example, which is not really pleasant. We are working on this, but
843 in the meanwhile, simply don't build the examples in cross-compilation
844 (<tt>cd src</tt> before running make).
845
846 Program (cross-)compiled with mingw32 do request an extra DLL at run-time to be
847 usable. For example, if you want to test your build with wine, you should do
848 the following to put this library where wine looks for DLLs.
849 \verbatim
850 cp /usr/share/doc/mingw32-runtime/mingwm10.dll.gz ~/.wine/c/windows/system/
851 gunzip ~/.wine/c/windows/system/mingwm10.dll.gz
852 \endverbatim
853
854 The DLL is built in src/.libs, and installed in the <i>prefix</i>/bin directory
855 when you run make install.
856
857 If you want to use it in a native project on windows, you need to use
858 simgrid.dll and mingwm10.dll. For each DLL, you need to build .def file
859 under linux (listing the defined symbols), and convert it into a .lib file
860 under windows (specifying this in a way that windows compilers like). To
861 generate the def files, run (under linux):
862 \verbatim echo "LIBRARY libsimgrid-0.dll" > simgrid.def
863 echo EXPORTS >> simgrid.def
864 nm libsimgrid-0.dll | grep ' T _' | sed 's/.* T _//' >> simgrid.def
865 nm libsimgrid-0.dll | grep ' D _' | sed 's/.* D _//' | sed 's/$/ DATA/' >> simgrid.def
866
867 echo "LIBRARY mingwm10.dll" > mingwm10.def
868 echo EXPORTS >> mingwm10.def
869 nm mingwm10.dll | grep ' T _' | sed 's/.* T _//' >> mingwm10.def
870 nm mingwm10.dll | grep ' D _' | sed 's/.* D _//' | sed 's/$/ DATA/' >> mingwm10.def
871 \endverbatim
872
873 To create the import .lib files, use the <tt>lib</tt> windows tool (from
874 MSVC) the following way to produce simgrid.lib and mingwm10.lib
875 \verbatim lib /def:simgrid.def
876 lib /def:mingwm10.def
877 \endverbatim
878
879 If you happen to use Borland C Builder, the right command line is the
880 following (note that you don't need any file.def to get this working).
881 \verbatim implib simgrid.lib libsimgrid-0.dll
882 implib mingwm10.lib mingwm10.dll
883 \endverbatim
884
885 Then, set the following parameters in Visual C++ 2005:
886 Linker -> Input -> Additional dependencies = simgrid.lib mingwm10.lib
887
888 Just in case you wonder how to generate a DLL from libtool in another
889 project, we added -no-undefined to any lib*_la_LDFLAGS variables so that
890 libtool accepts to generate a dynamic library under windows. Then, to make
891 it true, we pass any dependencies (such as -lws2 under windows or -lpthread
892 on need) on the linking line. Passing such deps is a good idea anyway so
893 that they get noted in the library itself, avoiding the users to know about
894 our dependencies and put them manually on their compilation line. Then we
895 added the AC_LIBTOOL_WIN32_DLL macro just before AC_PROG_LIBTOOL in the
896 configure.ac. It means that we exported any symbols which need to be.
897 Nowadays, functions get automatically exported, so we don't need to load our
898 header files with tons of __declspec(dllexport) cruft. We only need to do so
899 for data, but there is no public data in SimGrid so we are good.