Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Free cursor when returning from inside a xbt_dict_foreach loop.
[simgrid.git] / src / simix / smx_network.c
1 /* Copyright (c) 2009, 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include "private.h"
8 #include "xbt/log.h"
9 #include "mc/mc.h"
10 #include "xbt/dict.h"
11
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_network, simix,
13                                 "Logging specific to SIMIX (network)");
14
15 /******************************************************************************/
16 /*                           Rendez-Vous Points                               */
17 /******************************************************************************/
18
19 /**
20  *  \brief Creates a new rendez-vous point
21  *  \param name The name of the rendez-vous point
22  *  \return The created rendez-vous point
23  */
24 smx_rdv_t SIMIX_rdv_create(const char *name)
25 {
26   smx_rdv_t rdv = xbt_new0(s_smx_rvpoint_t, 1);
27   rdv->name = name ? xbt_strdup(name) : NULL;
28   rdv->read = SIMIX_mutex_init();
29   rdv->write = SIMIX_mutex_init();
30   rdv->comm_fifo = xbt_fifo_new();
31
32   return rdv;
33 }
34
35 /**
36  *  \brief Destroy a rendez-vous point
37  *  \param name The rendez-vous point to destroy
38  */
39 void SIMIX_rdv_destroy(smx_rdv_t rdv)
40 {
41   if (rdv->name)
42     xbt_free(rdv->name);
43   SIMIX_mutex_destroy(rdv->read);
44   SIMIX_mutex_destroy(rdv->write);
45   xbt_fifo_free(rdv->comm_fifo);
46   xbt_free(rdv);
47 }
48
49 /**
50  *  \brief Push a communication request into a rendez-vous point
51  *  \param rdv The rendez-vous point
52  *  \param comm The communication request
53  */
54 static XBT_INLINE void SIMIX_rdv_push(smx_rdv_t rdv, smx_comm_t comm)
55 {
56   xbt_fifo_push(rdv->comm_fifo, comm);
57   comm->rdv = rdv;
58 }
59
60 /**
61  *  \brief Remove a communication request from a rendez-vous point
62  *  \param rdv The rendez-vous point
63  *  \param comm The communication request
64  */
65 static XBT_INLINE void SIMIX_rdv_remove(smx_rdv_t rdv, smx_comm_t comm)
66 {
67   xbt_fifo_remove(rdv->comm_fifo, comm);
68   comm->rdv = NULL;
69 }
70
71 /**
72  *  \brief Checks if there is a communication request queued in a rendez-vous matching our needs
73  *  \param type The type of communication we are looking for (comm_send, comm_recv)
74  *  \return The communication request if found, NULL otherwise.
75  */
76 smx_comm_t SIMIX_rdv_get_request(smx_rdv_t rdv, smx_comm_type_t type)
77 {
78   smx_comm_t comm = (smx_comm_t)
79       xbt_fifo_get_item_content(xbt_fifo_get_first_item(rdv->comm_fifo));
80
81   if (comm && comm->type == type) {
82     DEBUG0("Communication request found!");
83     xbt_fifo_shift(rdv->comm_fifo);
84     SIMIX_communication_use(comm);
85     comm->rdv = NULL;
86     return comm;
87   }
88
89   DEBUG0("Communication request not found");
90   return NULL;
91 }
92
93 /**
94  *  \brief counts the number of communication requests of a given host pending
95  *         on a rendez-vous point
96  *  \param rdv The rendez-vous point
97  *  \param host The host to be counted
98  *  \return The number of comm request pending in the rdv
99  */
100 int SIMIX_rdv_get_count_waiting_comm(smx_rdv_t rdv, smx_host_t host)
101 {
102   smx_comm_t comm = NULL;
103   xbt_fifo_item_t item = NULL;
104   int count = 0;
105
106   xbt_fifo_foreach(rdv->comm_fifo, item, comm, smx_comm_t) {
107     if (comm->src_proc->smx_host == host)
108       count++;
109   }
110
111   return count;
112 }
113
114 /**
115  *  \brief returns the communication at the head of the rendez-vous
116  *  \param rdv The rendez-vous point
117  *  \return The communication or NULL if empty
118  */
119 XBT_INLINE smx_comm_t SIMIX_rdv_get_head(smx_rdv_t rdv)
120 {
121   return (smx_comm_t)
122       xbt_fifo_get_item_content(xbt_fifo_get_first_item(rdv->comm_fifo));
123 }
124
125 /** @brief adds some API-related data to the rendez-vous point */
126 XBT_INLINE void SIMIX_rdv_set_data(smx_rdv_t rdv, void *data)
127 {
128   rdv->data = data;
129 }
130
131 /** @brief gets API-related data from the rendez-vous point */
132 XBT_INLINE void *SIMIX_rdv_get_data(smx_rdv_t rdv)
133 {
134   return rdv->data;
135 }
136
137 /******************************************************************************/
138 /*                           Communication Requests                           */
139 /******************************************************************************/
140
141 /**
142  *  \brief Creates a new communication request
143  *  \param type The type of communication (comm_send, comm_recv)
144  *  \return The new communication request
145  */
146 smx_comm_t SIMIX_communication_new(smx_comm_type_t type)
147 {
148   /* alloc structures */
149   smx_comm_t comm = xbt_new0(s_smx_comm_t, 1);
150   comm->type = type;
151   comm->sem = SIMIX_sem_init(0);
152   comm->refcount = 1;
153   VERB2("Create communication %p; refcount initially %d", comm,
154          comm->refcount);
155
156   return comm;
157 }
158
159 /**
160  *  \brief Destroy a communication request
161  *  \param comm The request to be destroyed
162  */
163 void SIMIX_communication_destroy(smx_comm_t comm)
164 {
165   VERB2("Destroy communication %p; refcount initially %d", comm,
166         comm->refcount);
167
168   if(!(comm->refcount>0))
169           xbt_die(bprintf("the refcount of comm %p is already 0 before decreasing it. That's a bug!",comm));
170
171 #ifdef HAVE_LATENCY_BOUND_TRACKING
172   //save is latency limited flag to use afterwards
173   if (comm->act) {
174     DEBUG2("adding key %p with latency limited value %d to the dict", comm,
175            SIMIX_action_is_latency_bounded(comm->act));
176     xbt_dicti_set(simix_global->latency_limited_dict, (uintptr_t) comm,
177                   SIMIX_action_is_latency_bounded(comm->act));
178   }
179 #endif
180
181   comm->refcount--;
182   if (comm->refcount > 0)
183     return;
184   VERB2("Really free communication %p; refcount is now %d", comm,
185         comm->refcount);
186
187   if (comm->sem) {
188     SIMIX_sem_destroy(comm->sem);
189     comm->sem = NULL;
190   }
191
192   if (comm->act) {
193     SIMIX_action_destroy(comm->act);
194     comm->act = NULL;
195   }
196
197   if (comm->src_timeout) {
198     SIMIX_action_destroy(comm->src_timeout);
199     comm->src_timeout = NULL;
200   }
201
202   if (comm->dst_timeout) {
203     SIMIX_action_destroy(comm->dst_timeout);
204     comm->dst_timeout = NULL;
205   }
206
207
208
209   xbt_free(comm);
210 }
211
212 /**
213  *  \brief Increase the number of users of the communication.
214  *  \param comm The communication request
215  *  Each communication request can be used by more than one process, so it is
216  *  necessary to know number of them at destroy time, to avoid freeing stuff that
217  *  maybe is in use by others.
218  *  \
219  */
220 static XBT_INLINE void SIMIX_communication_use(smx_comm_t comm)
221 {
222   comm->refcount++;
223
224   VERB2("Use communication %p; refcount is now %d", comm,
225            comm->refcount);
226 }
227
228 /**
229  *  \brief Start the simulation of a communication request
230  *  \param comm The communication request
231  */
232 static XBT_INLINE void SIMIX_communication_start(smx_comm_t comm)
233 {
234   /* If both the sender and the receiver are already there, start the communication */
235   if (comm->src_proc && comm->dst_proc) {
236     DEBUG1("Starting communication %p", comm);
237     comm->act = SIMIX_action_communicate(comm->src_proc->smx_host,
238                                          comm->dst_proc->smx_host, NULL,
239                                          comm->task_size, comm->rate);
240 #ifdef HAVE_TRACING
241     TRACE_smx_action_communicate(comm->act, comm->src_proc);
242     TRACE_surf_action(comm->act->surf_action, comm->act->category);
243 #endif
244
245     /* If any of the process is suspend, create the action but stop its execution,
246        it will be restarted when the sender process resume */
247     if (SIMIX_process_is_suspended(comm->src_proc) ||
248         SIMIX_process_is_suspended(comm->dst_proc)) {
249       SIMIX_action_suspend(comm->act);
250     }
251
252     /* Add the communication as user data of the action */
253     comm->act->data = comm;
254
255     /* The semaphore will only get signaled once, but since the first unlocked guy will
256      * release_forever() the semaphore, that will unlock the second (and any other)
257      * communication partner */
258     SIMIX_register_action_to_semaphore(comm->act, comm->sem);
259   }
260 }
261
262 /**
263  * \brief Performs error checking and cleanup
264  * \param comm The communication
265  */
266 static XBT_INLINE void SIMIX_communication_cleanup(smx_comm_t comm)
267 {
268   DEBUG1("Checking errors and cleaning communication %p", comm);
269
270   /* Make sure that everyone sleeping on that semaphore is awake, and that nobody will ever block on it */
271   SIMIX_sem_release_forever(comm->sem);
272
273   /* Check for errors other than timeouts */
274   if (!SIMIX_host_get_state(SIMIX_host_self())) {
275     if (comm->rdv)
276       SIMIX_rdv_remove(comm->rdv, comm);
277     SIMIX_communication_destroy(comm);
278     THROW0(host_error, 0, "Host failed");
279   } else if (SIMIX_action_get_state(comm->act) == SURF_ACTION_FAILED) {
280     SIMIX_communication_destroy(comm);
281     THROW0(network_error, 0, "Link failure");
282   } else if (!SIMIX_host_get_state(SIMIX_process_get_host(comm->dst_proc))
283              ||
284              !SIMIX_host_get_state(SIMIX_process_get_host(comm->src_proc)))
285   {
286     /* We test both src&dst because we dunno who we are today, and we already tested myself above.
287      *    So, at the end, we test the remote peer only
288      * Moreover, we have to test it because if the remote peer fails, the action comm->act is not done nor failed.
289      *    In that case, we got awaken by the little endless actions created in the SIMIX_sem_acquire(comm->sem)
290      *    at the beginning of this function. */
291     SIMIX_communication_destroy(comm);
292     THROW0(network_error, 0, "Remote peer failed");
293
294   }
295   /* Copy network data */
296   SIMIX_network_copy_data(comm);
297
298   SIMIX_communication_destroy(comm);
299 }
300
301 /**
302  *  \brief Waits for communication completion
303  *  \param comm The communication
304  *  \param timeout The max amount of time to wait for the communication to finish
305  *
306  *  Throws:
307  *   - host_error if local peer failed
308  *   - timeout_error if communication reached the timeout specified (either because of local peer or remote peer)
309  *   - network_error if network failed or remote peer failed
310  */
311 static XBT_INLINE void SIMIX_communication_wait_for_completion(smx_comm_t
312                                                                comm,
313                                                                double
314                                                                timeout)
315 {
316   smx_action_t act_sleep = NULL;
317   int src_timeout = 0;
318   int dst_timeout = 0;
319
320   DEBUG1("Waiting for the completion of communication %p", comm);
321
322   if (timeout >= 0) {
323     act_sleep = SIMIX_action_sleep(SIMIX_host_self(), timeout);
324     if (SIMIX_process_self() == comm->src_proc)
325       comm->src_timeout = act_sleep;
326     else
327       comm->dst_timeout = act_sleep;
328     SIMIX_action_set_name(act_sleep,
329                           bprintf
330                           ("Timeout for comm %p and wait on semaphore %p (max_duration:%f)",
331                            comm, comm->sem, timeout));
332     SIMIX_register_action_to_semaphore(act_sleep, comm->sem);
333     SIMIX_process_self()->waiting_action = act_sleep;
334     SIMIX_sem_block_onto(comm->sem);
335     SIMIX_process_self()->waiting_action = NULL;
336     SIMIX_unregister_action_to_semaphore(act_sleep, comm->sem);
337   } else {
338     SIMIX_sem_acquire(comm->sem);
339   }
340
341   /* Check for timeouts */
342   if ((src_timeout = ((comm->src_timeout)
343                       && (SIMIX_action_get_state(comm->src_timeout) ==
344                           SURF_ACTION_DONE)))
345       || (dst_timeout = ((comm->dst_timeout)
346                          && (SIMIX_action_get_state(comm->dst_timeout) ==
347                              SURF_ACTION_DONE)))) {
348     /* Somebody did a timeout! */
349     if (src_timeout)
350       DEBUG1("Communication timeout from the src! %p", comm);
351     if (dst_timeout)
352       DEBUG1("Communication timeout from the dst! %p", comm);
353
354     if (comm->act
355         && SIMIX_action_get_state(comm->act) == SURF_ACTION_RUNNING)
356       SIMIX_communication_cancel(comm);
357     else if (comm->rdv)
358       SIMIX_rdv_remove(comm->rdv, comm);
359
360     /* Make sure that everyone sleeping on that semaphore is awake, and that nobody will ever block on it */
361     SIMIX_sem_release_forever(comm->sem);
362     SIMIX_communication_destroy(comm);
363
364     THROW1(timeout_error, 0, "Communication timeouted because of %s",
365            src_timeout ? "the source" : "the destination");
366   }
367
368   DEBUG1("Communication %p complete!", comm);
369   SIMIX_communication_cleanup(comm);
370 }
371
372 /**
373  *  \brief Cancels a communication
374  *  \brief comm The communication to cancel
375  */
376 XBT_INLINE void SIMIX_communication_cancel(smx_comm_t comm)
377 {
378   if (comm->act)
379     SIMIX_action_cancel(comm->act);
380 }
381
382 /**
383  *  \brief get the amount remaining from the communication
384  *  \param comm The communication
385  */
386 XBT_INLINE double SIMIX_communication_get_remains(smx_comm_t comm)
387 {
388   DEBUG1("calling SIMIX_action_get_remains(%p)", comm->act);
389   return SIMIX_action_get_remains(comm->act);
390 }
391
392 #ifdef HAVE_LATENCY_BOUND_TRACKING
393 /**
394  *  \brief verify if communication is latency bounded
395  *  \param comm The communication
396  */
397 XBT_INLINE int SIMIX_communication_is_latency_bounded(smx_comm_t comm)
398 {
399   //try to find comm on the list of finished flows
400   uintptr_t key = 0;
401   uintptr_t data = 0;
402   xbt_dict_cursor_t cursor;
403   xbt_dict_foreach(simix_global->latency_limited_dict, cursor, key, data) {
404     DEBUG2("comparing key=%p with comm=%p", (void *) key, (void *) comm);
405     if ((void *) comm == (void *) key) {
406       DEBUG2("key %p found, return value latency limited value %d",
407              (void *) key, (int) data);
408       xbt_dict_cursor_free(&cursor);
409       return (int) data;
410     }
411   }
412
413   DEBUG1("calling SIMIX_action_is_latency_bounded(%p)", comm->act);
414   return SIMIX_action_is_latency_bounded(comm->act);
415 }
416 #endif
417
418 /******************************************************************************/
419 /*                    SIMIX_network_copy_data callbacks                       */
420 /******************************************************************************/
421 static void (*SIMIX_network_copy_data_callback) (smx_comm_t, size_t) =
422     &SIMIX_network_copy_pointer_callback;
423
424 void
425 SIMIX_network_set_copy_data_callback(void (*callback) (smx_comm_t, size_t))
426 {
427   SIMIX_network_copy_data_callback = callback;
428 }
429
430 void SIMIX_network_copy_pointer_callback(smx_comm_t comm, size_t buff_size)
431 {
432   xbt_assert1((buff_size == sizeof(void *)),
433               "Cannot copy %zu bytes: must be sizeof(void*)", buff_size);
434   *(void **) (comm->dst_buff) = comm->src_buff;
435 }
436
437 void SIMIX_network_copy_buffer_callback(smx_comm_t comm, size_t buff_size)
438 {
439   memcpy(comm->dst_buff, comm->src_buff, buff_size);
440 }
441
442 /**
443  *  \brief Copy the communication data from the sender's buffer to the receiver's one
444  *  \param comm The communication
445  */
446 void SIMIX_network_copy_data(smx_comm_t comm)
447 {
448   size_t buff_size = comm->src_buff_size;
449   uintptr_t casted_size = 0;
450   uintptr_t amount = 0;
451   /* If there is no data to be copy then return */
452   if (!comm->src_buff || !comm->dst_buff || comm->copied == 1)
453     return;
454
455   DEBUG6("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)",
456          comm,
457          comm->src_proc->smx_host->name, comm->src_buff,
458          comm->dst_proc->smx_host->name, comm->dst_buff, buff_size);
459
460   /* Copy at most dst_buff_size bytes of the message to receiver's buffer */
461   if (comm->dst_buff_size)
462     buff_size = MIN(buff_size, *(comm->dst_buff_size));
463
464   /* Update the receiver's buffer size to the copied amount */
465   if (comm->dst_buff_size)
466     *comm->dst_buff_size = buff_size;
467
468   if (buff_size == 0)
469     return;
470   (*SIMIX_network_copy_data_callback) (comm, buff_size);
471
472   /* Set the copied flag so we copy data only once */
473   /* (this function might be called from both communication ends) */
474   comm->copied = 1;
475
476   /* pimple to display the message sizes */
477   {
478     casted_size = comm->task_size;
479     amount = xbt_dicti_get(simix_global->msg_sizes, casted_size);
480     amount++;
481
482     xbt_dicti_set(simix_global->msg_sizes, casted_size, amount);
483   }
484 }
485
486 /**
487  *  \brief Return the user data associated to the communication
488  *  \param comm The communication
489  *  \return the user data
490  */
491 XBT_INLINE void *SIMIX_communication_get_data(smx_comm_t comm)
492 {
493   return comm->data;
494 }
495
496 XBT_PUBLIC(void *) SIMIX_communication_get_src_buf(smx_comm_t comm)
497 {
498   return comm->src_buff;
499 }
500
501 XBT_PUBLIC(void *) SIMIX_communication_get_dst_buf(smx_comm_t comm)
502 {
503   return comm->dst_buff;
504 }
505
506 XBT_PUBLIC(size_t) SIMIX_communication_get_src_buf_size(smx_comm_t comm)
507 {
508   return comm->src_buff_size;
509 }
510
511 XBT_PUBLIC(size_t) SIMIX_communication_get_dst_buf_size(smx_comm_t comm)
512 {
513   return *(comm->dst_buff_size);
514 }
515
516 /******************************************************************************/
517 /*                        Synchronous Communication                           */
518 /******************************************************************************/
519 /**
520  *  \brief Put a send communication request in a rendez-vous point and waits for
521  *         its completion (blocking)
522  *  \param rdv The rendez-vous point
523  *  \param task_size The size of the communication action (for surf simulation)
524  *  \param rate The rate of the communication action (for surf)
525  *  \param timeout The timeout used for the waiting the completion 
526  *  \param src_buff The source buffer containing the message to be sent
527  *  \param src_buff_size The size of the source buffer
528  *  \param comm_ref The communication object used for the send  (useful if someone else wants to cancel this communication afterward)
529  *  \param data User data associated to the communication object
530  *  Throws:
531  *   - host_error if peer failed
532  *   - timeout_error if communication reached the timeout specified
533  *   - network_error if network failed or peer issued a timeout
534  */
535 XBT_INLINE void SIMIX_network_send(smx_rdv_t rdv, double task_size,
536                                    double rate, double timeout,
537                                    void *src_buff, size_t src_buff_size,
538                                    smx_comm_t * comm_ref, void *data)
539 {
540   xbt_ex_t e;
541   smx_comm_t comm = *comm_ref =
542               SIMIX_network_isend(rdv, task_size, rate, src_buff, src_buff_size,
543                                   data);
544   TRY {
545     SIMIX_network_wait(comm, timeout);
546   }
547   TRY_CLEANUP {
548     SIMIX_communication_destroy(comm);
549   }
550   CATCH(e) {
551     RETHROW;
552   }
553 }
554
555 /**
556  *  \brief Put a receive communication request in a rendez-vous point and waits
557  *         for its completion (blocking)
558  *  \param rdv The rendez-vous point
559  *  \param timeout The timeout used for the waiting the completion 
560  *  \param dst_buff The destination buffer to copy the received message
561  *  \param src_buff_size The size of the destination buffer
562  *  \param comm_ref The communication object used for the send (useful if someone else wants to cancel this communication afterward)
563  *  Throws:
564  *   - host_error if peer failed
565  *   - timeout_error if communication reached the timeout specified
566  *   - network_error if network failed or peer issued a timeout
567  */
568 XBT_INLINE void SIMIX_network_recv(smx_rdv_t rdv, double timeout,
569                                    void *dst_buff, size_t * dst_buff_size,
570                                    smx_comm_t * comm_ref)
571 {
572   xbt_ex_t e;
573   smx_comm_t comm = *comm_ref =
574       (smx_comm_t) SIMIX_network_irecv(rdv, dst_buff, dst_buff_size);
575   TRY {
576     SIMIX_network_wait(comm, timeout);
577   }
578   TRY_CLEANUP {
579     SIMIX_communication_destroy(comm);
580   }
581   CATCH(e) {
582     RETHROW;
583   }
584 }
585
586 /******************************************************************************/
587 /*                        Asynchronous Communication                          */
588 /******************************************************************************/
589 smx_comm_t SIMIX_network_isend(smx_rdv_t rdv, double task_size,
590                                double rate, void *src_buff,
591                                size_t src_buff_size, void *data)
592 {
593   smx_comm_t comm;
594
595   /*If running in model-checking mode then intercept the communication action */
596 #ifdef HAVE_MC
597   if (_surf_do_model_check)
598     MC_trans_intercept_isend(rdv);
599 #endif
600   /* Look for communication request matching our needs.
601      If it is not found then create it and push it into the rendez-vous point */
602   comm = SIMIX_rdv_get_request(rdv, comm_recv);
603
604   if (!comm) {
605     comm = SIMIX_communication_new(comm_send);
606     SIMIX_rdv_push(rdv, comm);
607   }
608
609   /* Setup the communication request */
610   comm->src_proc = SIMIX_process_self();
611   comm->task_size = task_size;
612   comm->rate = rate;
613   comm->src_buff = src_buff;
614   comm->src_buff_size = src_buff_size;
615   comm->data = data;
616
617   SIMIX_communication_start(comm);
618   return comm;
619 }
620
621 smx_comm_t SIMIX_network_irecv(smx_rdv_t rdv, void *dst_buff,
622                                size_t * dst_buff_size)
623 {
624   smx_comm_t comm;
625
626   /*If running in model-checking mode then intercept the communication action */
627 #ifdef HAVE_MC
628   if (_surf_do_model_check)
629     MC_trans_intercept_irecv(rdv);
630 #endif
631   /* Look for communication request matching our needs.
632    * If it is not found then create it and push it into the rendez-vous point
633    */
634   comm = SIMIX_rdv_get_request(rdv, comm_send);
635
636   if (!comm) {
637     comm = SIMIX_communication_new(comm_recv);
638     SIMIX_rdv_push(rdv, comm);
639   }
640
641   /* Setup communication request */
642   comm->dst_proc = SIMIX_process_self();
643   comm->dst_buff = dst_buff;
644   comm->dst_buff_size = dst_buff_size;
645
646   SIMIX_communication_start(comm);
647   return comm;
648 }
649
650 /** @brief blocks until the communication terminates or the timeout occurs */
651 XBT_INLINE void SIMIX_network_wait(smx_comm_t comm, double timeout)
652 {
653   /*If running in model-checking mode then intercept the communication action */
654 #ifdef HAVE_MC
655   if (_surf_do_model_check)
656     MC_trans_intercept_wait(comm);
657 #endif
658   SIMIX_communication_use(comm);
659   /* Wait for communication completion */
660   SIMIX_communication_wait_for_completion(comm, timeout);
661 }
662
663 /** @Returns whether the (asynchronous) communication is done yet or not */
664 XBT_INLINE int SIMIX_network_test(smx_comm_t comm)
665 {
666   /*If running in model-checking mode then intercept the communication action */
667 #ifdef HAVE_MC
668   if (_surf_do_model_check)
669     MC_trans_intercept_test(comm);
670 #endif
671
672   /* Copy data if the communication is done */
673   if (comm->sem && !SIMIX_sem_would_block(comm->sem)) {
674     /* Copy network data */
675     SIMIX_network_copy_data(comm);
676     return TRUE;
677   }
678   return FALSE;
679 }
680
681 /** @brief wait for the completion of any communication of a set
682  *
683  *  @Returns the rank in the dynar of communication which finished; destroy it after identifying which one it is
684  */
685 unsigned int SIMIX_network_waitany(xbt_dynar_t comms)
686 {
687   xbt_dynar_t sems = xbt_dynar_new(sizeof(smx_sem_t), NULL);
688   unsigned int cursor, found_comm = -1;
689   smx_comm_t comm, comm_finished = NULL;
690
691   /*If running in model-checking mode then intercept the communication action */
692 #ifdef HAVE_MC
693   if (_surf_do_model_check)
694     MC_trans_intercept_waitany(comms);
695 #endif
696   xbt_dynar_foreach(comms, cursor, comm)
697       xbt_dynar_push(sems, &(comm->sem));
698
699   DEBUG1("Waiting for the completion of communication set %p", comms);
700
701   found_comm = SIMIX_sem_acquire_any(sems);
702   xbt_dynar_free_container(&sems);
703   xbt_assert0(found_comm != -1,
704               "Cannot find which communication finished");
705   xbt_dynar_get_cpy(comms, found_comm, &comm_finished);
706
707   DEBUG2("Communication %p of communication set %p finished",
708          comm_finished, comms);
709
710   /* let the regular code deal with the communication end (errors checking and cleanup).
711    * A bit of useless work will be done, but that's good for source factorization */
712   SIMIX_sem_release_forever(comm_finished->sem);
713   SIMIX_communication_use(comm_finished);
714   SIMIX_communication_wait_for_completion(comm_finished, -1);
715   return found_comm;
716 }