Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
kill SIMIX_comm_isend(), use simcall_HANDLER_comm_isend() directly
[simgrid.git] / src / simix / smx_network.c
1 /* Copyright (c) 2009-2015. 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 "smx_private.h"
8 #include "xbt/log.h"
9 #include "mc/mc.h"
10 #include "mc/mc_replay.h"
11 #include "xbt/dict.h"
12 #include "smpi/private.h"
13
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_network, simix,
15                                 "SIMIX network-related synchronization");
16
17 static xbt_dict_t rdv_points = NULL;
18 XBT_EXPORT_NO_IMPORT(unsigned long int) smx_total_comms = 0;
19
20 static void SIMIX_waitany_remove_simcall_from_actions(smx_simcall_t simcall);
21 static void SIMIX_comm_copy_data(smx_synchro_t comm);
22 static smx_synchro_t SIMIX_comm_new(e_smx_comm_type_t type);
23 static XBT_INLINE void SIMIX_rdv_push(smx_rdv_t rdv, smx_synchro_t comm);
24 static smx_synchro_t SIMIX_fifo_probe_comm(xbt_fifo_t fifo, e_smx_comm_type_t type,
25                                         int (*match_fun)(void *, void *,smx_synchro_t),
26                                         void *user_data, smx_synchro_t my_synchro);
27 static smx_synchro_t SIMIX_fifo_get_comm(xbt_fifo_t fifo, e_smx_comm_type_t type,
28                                         int (*match_fun)(void *, void *,smx_synchro_t),
29                                         void *user_data, smx_synchro_t my_synchro);
30 static void SIMIX_rdv_free(void *data);
31 static void SIMIX_comm_start(smx_synchro_t synchro);
32
33 void SIMIX_network_init(void)
34 {
35   rdv_points = xbt_dict_new_homogeneous(SIMIX_rdv_free);
36 }
37
38 void SIMIX_network_exit(void)
39 {
40   xbt_dict_free(&rdv_points);
41 }
42
43 /******************************************************************************/
44 /*                           Rendez-Vous Points                               */
45 /******************************************************************************/
46
47 smx_rdv_t SIMIX_rdv_create(const char *name)
48 {
49   /* two processes may have pushed the same rdv_create simcall at the same time */
50   smx_rdv_t rdv = name ? xbt_dict_get_or_null(rdv_points, name) : NULL;
51
52   if (!rdv) {
53     rdv = xbt_new0(s_smx_rvpoint_t, 1);
54     rdv->name = name ? xbt_strdup(name) : NULL;
55     rdv->comm_fifo = xbt_fifo_new();
56     rdv->done_comm_fifo = xbt_fifo_new();
57     rdv->permanent_receiver=NULL;
58
59     XBT_DEBUG("Creating a mailbox at %p with name %s", rdv, name);
60
61     if (rdv->name)
62       xbt_dict_set(rdv_points, rdv->name, rdv, NULL);
63   }
64   return rdv;
65 }
66
67 void SIMIX_rdv_destroy(smx_rdv_t rdv)
68 {
69   if (rdv->name)
70     xbt_dict_remove(rdv_points, rdv->name);
71 }
72
73 void SIMIX_rdv_free(void *data)
74 {
75   XBT_DEBUG("rdv free %p", data);
76   smx_rdv_t rdv = (smx_rdv_t) data;
77   xbt_free(rdv->name);
78   xbt_fifo_free(rdv->comm_fifo);
79   xbt_fifo_free(rdv->done_comm_fifo);
80
81   xbt_free(rdv);
82 }
83
84 xbt_dict_t SIMIX_get_rdv_points()
85 {
86   return rdv_points;
87 }
88
89 smx_rdv_t SIMIX_rdv_get_by_name(const char *name)
90 {
91   return xbt_dict_get_or_null(rdv_points, name);
92 }
93
94 int SIMIX_rdv_comm_count_by_host(smx_rdv_t rdv, sg_host_t host)
95 {
96   smx_synchro_t comm = NULL;
97   xbt_fifo_item_t item = NULL;
98   int count = 0;
99
100   xbt_fifo_foreach(rdv->comm_fifo, item, comm, smx_synchro_t) {
101     if (comm->comm.src_proc->host == host)
102       count++;
103   }
104
105   return count;
106 }
107
108 smx_synchro_t SIMIX_rdv_get_head(smx_rdv_t rdv)
109 {
110   return xbt_fifo_get_item_content(xbt_fifo_get_first_item(rdv->comm_fifo));
111 }
112
113 /**
114  *  \brief get the receiver (process associated to the mailbox)
115  *  \param rdv The rendez-vous point
116  *  \return process The receiving process (NULL if not set)
117  */
118 smx_process_t SIMIX_rdv_get_receiver(smx_rdv_t rdv)
119 {
120   return rdv->permanent_receiver;
121 }
122
123 /**
124  *  \brief set the receiver of the rendez vous point to allow eager sends
125  *  \param rdv The rendez-vous point
126  *  \param process The receiving process
127  */
128 void SIMIX_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
129 {
130   rdv->permanent_receiver=process;
131 }
132
133 /**
134  *  \brief Pushes a communication synchro into a rendez-vous point
135  *  \param rdv The rendez-vous point
136  *  \param comm The communication synchro
137  */
138 static XBT_INLINE void SIMIX_rdv_push(smx_rdv_t rdv, smx_synchro_t comm)
139 {
140   xbt_fifo_push(rdv->comm_fifo, comm);
141   comm->comm.rdv = rdv;
142 }
143
144 /**
145  *  \brief Removes a communication synchro from a rendez-vous point
146  *  \param rdv The rendez-vous point
147  *  \param comm The communication synchro
148  */
149 XBT_INLINE void SIMIX_rdv_remove(smx_rdv_t rdv, smx_synchro_t comm)
150 {
151   xbt_fifo_remove(rdv->comm_fifo, comm);
152   comm->comm.rdv = NULL;
153 }
154
155 /**
156  *  \brief Checks if there is a communication synchro queued in a fifo matching our needs
157  *  \param type The type of communication we are looking for (comm_send, comm_recv)
158  *  \return The communication synchro if found, NULL otherwise
159  */
160 smx_synchro_t SIMIX_fifo_get_comm(xbt_fifo_t fifo, e_smx_comm_type_t type,
161                                  int (*match_fun)(void *, void *,smx_synchro_t),
162                                  void *this_user_data, smx_synchro_t my_synchro)
163 {
164   smx_synchro_t synchro;
165   xbt_fifo_item_t item;
166   void* other_user_data = NULL;
167
168   xbt_fifo_foreach(fifo, item, synchro, smx_synchro_t) {
169     if (synchro->comm.type == SIMIX_COMM_SEND) {
170       other_user_data = synchro->comm.src_data;
171     } else if (synchro->comm.type == SIMIX_COMM_RECEIVE) {
172       other_user_data = synchro->comm.dst_data;
173     }
174     if (synchro->comm.type == type &&
175         (!match_fun              ||              match_fun(this_user_data,  other_user_data, synchro)) &&
176         (!synchro->comm.match_fun || synchro->comm.match_fun(other_user_data, this_user_data,  my_synchro))) {
177       XBT_DEBUG("Found a matching communication synchro %p", synchro);
178       xbt_fifo_remove_item(fifo, item);
179       xbt_fifo_free_item(item);
180       synchro->comm.refcount++;
181 #ifdef HAVE_MC
182       synchro->comm.rdv_cpy = synchro->comm.rdv;
183 #endif
184       synchro->comm.rdv = NULL;
185       return synchro;
186     }
187     XBT_DEBUG("Sorry, communication synchro %p does not match our needs:"
188               " its type is %d but we are looking for a comm of type %d (or maybe the filtering didn't match)",
189               synchro, (int)synchro->comm.type, (int)type);
190   }
191   XBT_DEBUG("No matching communication synchro found");
192   return NULL;
193 }
194
195
196 /**
197  *  \brief Checks if there is a communication synchro queued in a fifo matching our needs, but leave it there
198  *  \param type The type of communication we are looking for (comm_send, comm_recv)
199  *  \return The communication synchro if found, NULL otherwise
200  */
201 smx_synchro_t SIMIX_fifo_probe_comm(xbt_fifo_t fifo, e_smx_comm_type_t type,
202                                  int (*match_fun)(void *, void *,smx_synchro_t),
203                                  void *this_user_data, smx_synchro_t my_synchro)
204 {
205   smx_synchro_t synchro;
206   xbt_fifo_item_t item;
207   void* other_user_data = NULL;
208
209   xbt_fifo_foreach(fifo, item, synchro, smx_synchro_t) {
210     if (synchro->comm.type == SIMIX_COMM_SEND) {
211       other_user_data = synchro->comm.src_data;
212     } else if (synchro->comm.type == SIMIX_COMM_RECEIVE) {
213       other_user_data = synchro->comm.dst_data;
214     }
215     if (synchro->comm.type == type &&
216         (!match_fun              ||              match_fun(this_user_data,  other_user_data, synchro)) &&
217         (!synchro->comm.match_fun || synchro->comm.match_fun(other_user_data, this_user_data,  my_synchro))) {
218       XBT_DEBUG("Found a matching communication synchro %p", synchro);
219       synchro->comm.refcount++;
220
221       return synchro;
222     }
223     XBT_DEBUG("Sorry, communication synchro %p does not match our needs:"
224               " its type is %d but we are looking for a comm of type %d (or maybe the filtering didn't match)",
225               synchro, (int)synchro->comm.type, (int)type);
226   }
227   XBT_DEBUG("No matching communication synchro found");
228   return NULL;
229 }
230 /******************************************************************************/
231 /*                          Communication synchros                            */
232 /******************************************************************************/
233
234 /**
235  *  \brief Creates a new communicate synchro
236  *  \param type The direction of communication (comm_send, comm_recv)
237  *  \return The new communicate synchro
238  */
239 smx_synchro_t SIMIX_comm_new(e_smx_comm_type_t type)
240 {
241   smx_synchro_t synchro;
242
243   /* alloc structures */
244   synchro = xbt_mallocator_get(simix_global->synchro_mallocator);
245
246   synchro->type = SIMIX_SYNC_COMMUNICATE;
247   synchro->state = SIMIX_WAITING;
248
249   /* set communication */
250   synchro->comm.type = type;
251   synchro->comm.refcount = 1;
252   synchro->comm.src_data=NULL;
253   synchro->comm.dst_data=NULL;
254
255
256 #ifdef HAVE_LATENCY_BOUND_TRACKING
257   //initialize with unknown value
258   synchro->latency_limited = -1;
259 #endif
260
261   synchro->category = NULL;
262
263   XBT_DEBUG("Create communicate synchro %p", synchro);
264   ++smx_total_comms;
265
266   return synchro;
267 }
268
269 /**
270  *  \brief Destroy a communicate synchro
271  *  \param synchro The communicate synchro to be destroyed
272  */
273 void SIMIX_comm_destroy(smx_synchro_t synchro)
274 {
275   XBT_DEBUG("Destroy synchro %p (refcount: %d), state: %d",
276             synchro, synchro->comm.refcount, (int)synchro->state);
277
278   if (synchro->comm.refcount <= 0) {
279     xbt_backtrace_display_current();
280     xbt_die("The refcount of comm %p is already 0 before decreasing it. "
281             "That's a bug! If you didn't test and/or wait the same communication twice in your code, then the bug is SimGrid's...", synchro);
282   }
283   synchro->comm.refcount--;
284   if (synchro->comm.refcount > 0)
285       return;
286   XBT_DEBUG("Really free communication %p; refcount is now %d", synchro,
287       synchro->comm.refcount);
288
289 #ifdef HAVE_LATENCY_BOUND_TRACKING
290   synchro->latency_limited = SIMIX_comm_is_latency_bounded( synchro ) ;
291 #endif
292
293   xbt_free(synchro->name);
294   SIMIX_comm_destroy_internal_actions(synchro);
295
296   if (synchro->comm.detached && synchro->state != SIMIX_DONE) {
297     /* the communication has failed and was detached:
298      * we have to free the buffer */
299     if (synchro->comm.clean_fun) {
300       synchro->comm.clean_fun(synchro->comm.src_buff);
301     }
302     synchro->comm.src_buff = NULL;
303   }
304
305   if(synchro->comm.rdv)
306     SIMIX_rdv_remove(synchro->comm.rdv, synchro);
307
308   xbt_mallocator_release(simix_global->synchro_mallocator, synchro);
309 }
310
311 void SIMIX_comm_destroy_internal_actions(smx_synchro_t synchro)
312 {
313   if (synchro->comm.surf_comm){
314 #ifdef HAVE_LATENCY_BOUND_TRACKING
315     synchro->latency_limited = SIMIX_comm_is_latency_bounded(synchro);
316 #endif
317     surf_action_unref(synchro->comm.surf_comm);
318     synchro->comm.surf_comm = NULL;
319   }
320
321   if (synchro->comm.src_timeout){
322     surf_action_unref(synchro->comm.src_timeout);
323     synchro->comm.src_timeout = NULL;
324   }
325
326   if (synchro->comm.dst_timeout){
327     surf_action_unref(synchro->comm.dst_timeout);
328     synchro->comm.dst_timeout = NULL;
329   }
330 }
331
332 void simcall_HANDLER_comm_send(smx_simcall_t simcall, smx_process_t src, smx_rdv_t rdv,
333                                   double task_size, double rate,
334                                   void *src_buff, size_t src_buff_size,
335                                   int (*match_fun)(void *, void *,smx_synchro_t),
336                                   void (*copy_data_fun)(smx_synchro_t, void*, size_t),
337                                   void *data, double timeout){
338   smx_synchro_t comm = simcall_HANDLER_comm_isend(simcall, src, rdv, task_size, rate,
339                                        src_buff, src_buff_size, match_fun, NULL, copy_data_fun,
340                                        data, 0);
341   SIMCALL_SET_MC_VALUE(simcall, 0);
342   simcall_HANDLER_comm_wait(simcall, comm, timeout);
343 }
344 smx_synchro_t simcall_HANDLER_comm_isend(smx_simcall_t simcall, smx_process_t src_proc, smx_rdv_t rdv,
345                                   double task_size, double rate,
346                                   void *src_buff, size_t src_buff_size,
347                                   int (*match_fun)(void *, void *,smx_synchro_t),
348                                   void (*clean_fun)(void *), // used to free the synchro in case of problem after a detached send
349                                   void (*copy_data_fun)(smx_synchro_t, void*, size_t),// used to copy data if not default one
350                                                   void *data, int detached)
351 {
352   XBT_DEBUG("send from %p", rdv);
353
354   /* Prepare a synchro describing us, so that it gets passed to the user-provided filter of other side */
355   smx_synchro_t this_synchro = SIMIX_comm_new(SIMIX_COMM_SEND);
356
357   /* Look for communication synchro matching our needs. We also provide a description of
358    * ourself so that the other side also gets a chance of choosing if it wants to match with us.
359    *
360    * If it is not found then push our communication into the rendez-vous point */
361   smx_synchro_t other_synchro = SIMIX_fifo_get_comm(rdv->comm_fifo, SIMIX_COMM_RECEIVE, match_fun, data, this_synchro);
362
363   if (!other_synchro) {
364     other_synchro = this_synchro;
365
366     if (rdv->permanent_receiver!=NULL){
367       //this mailbox is for small messages, which have to be sent right now
368       other_synchro->state = SIMIX_READY;
369       other_synchro->comm.dst_proc=rdv->permanent_receiver;
370       other_synchro->comm.refcount++;
371       xbt_fifo_push(rdv->done_comm_fifo,other_synchro);
372       other_synchro->comm.rdv=rdv;
373       XBT_DEBUG("pushing a message into the permanent receive fifo %p, comm %p", rdv, &(other_synchro->comm));
374
375     }else{
376       SIMIX_rdv_push(rdv, this_synchro);
377     }
378   } else {
379     XBT_DEBUG("Receive already pushed");
380
381     SIMIX_comm_destroy(this_synchro);
382     --smx_total_comms; // this creation was a pure waste
383
384     other_synchro->state = SIMIX_READY;
385     other_synchro->comm.type = SIMIX_COMM_READY;
386
387   }
388   xbt_fifo_push(src_proc->comms, other_synchro);
389
390   /* if the communication synchro is detached then decrease the refcount
391    * by one, so it will be eliminated by the receiver's destroy call */
392   if (detached) {
393     other_synchro->comm.detached = 1;
394     other_synchro->comm.refcount--;
395     other_synchro->comm.clean_fun = clean_fun;
396   } else {
397     other_synchro->comm.clean_fun = NULL;
398   }
399
400   /* Setup the communication synchro */
401   other_synchro->comm.src_proc = src_proc;
402   other_synchro->comm.task_size = task_size;
403   other_synchro->comm.rate = rate;
404   other_synchro->comm.src_buff = src_buff;
405   other_synchro->comm.src_buff_size = src_buff_size;
406   other_synchro->comm.src_data = data;
407
408   other_synchro->comm.match_fun = match_fun;
409   other_synchro->comm.copy_data_fun = copy_data_fun;
410
411
412   if (MC_is_active() || MC_record_replay_is_active()) {
413     other_synchro->state = SIMIX_RUNNING;
414     return (detached ? NULL : other_synchro);
415   }
416
417   SIMIX_comm_start(other_synchro);
418   return (detached ? NULL : other_synchro);
419 }
420
421 void simcall_HANDLER_comm_recv(smx_simcall_t simcall, smx_rdv_t rdv,
422                          void *dst_buff, size_t *dst_buff_size,
423                          int (*match_fun)(void *, void *, smx_synchro_t),
424                          void (*copy_data_fun)(smx_synchro_t, void*, size_t),
425                          void *data, double timeout, double rate)
426 {
427   smx_synchro_t comm = SIMIX_comm_irecv(simcall->issuer, rdv, dst_buff,
428                                        dst_buff_size, match_fun, copy_data_fun, data, rate);
429   SIMCALL_SET_MC_VALUE(simcall, 0);
430   simcall_HANDLER_comm_wait(simcall, comm, timeout);
431 }
432
433 smx_synchro_t simcall_HANDLER_comm_irecv(smx_simcall_t simcall, smx_rdv_t rdv,
434                                   void *dst_buff, size_t *dst_buff_size,
435                                   int (*match_fun)(void *, void *, smx_synchro_t),
436                                   void (*copy_data_fun)(smx_synchro_t, void*, size_t),
437                                   void *data, double rate)
438 {
439   return SIMIX_comm_irecv(simcall->issuer, rdv, dst_buff, dst_buff_size,
440                           match_fun, copy_data_fun, data, rate);
441 }
442
443 smx_synchro_t SIMIX_comm_irecv(smx_process_t dst_proc, smx_rdv_t rdv,
444                               void *dst_buff, size_t *dst_buff_size,
445                               int (*match_fun)(void *, void *, smx_synchro_t),
446                               void (*copy_data_fun)(smx_synchro_t, void*, size_t), // used to copy data if not default one
447                               void *data, double rate)
448 {
449   XBT_DEBUG("recv from %p %p", rdv, rdv->comm_fifo);
450   smx_synchro_t this_synchro = SIMIX_comm_new(SIMIX_COMM_RECEIVE);
451
452   smx_synchro_t other_synchro;
453   //communication already done, get it inside the fifo of completed comms
454   //permanent receive v1
455   //int already_received=0;
456   if(rdv->permanent_receiver && xbt_fifo_size(rdv->done_comm_fifo)!=0){
457
458     XBT_DEBUG("We have a comm that has probably already been received, trying to match it, to skip the communication");
459     //find a match in the already received fifo
460     other_synchro = SIMIX_fifo_get_comm(rdv->done_comm_fifo, SIMIX_COMM_SEND, match_fun, data, this_synchro);
461     //if not found, assume the receiver came first, register it to the mailbox in the classical way
462     if (!other_synchro)  {
463       XBT_DEBUG("We have messages in the permanent receive list, but not the one we are looking for, pushing request into fifo");
464       other_synchro = this_synchro;
465       SIMIX_rdv_push(rdv, this_synchro);
466     }else{
467       if(other_synchro->comm.surf_comm &&       SIMIX_comm_get_remains(other_synchro)==0.0)
468       {
469         XBT_DEBUG("comm %p has been already sent, and is finished, destroy it",&(other_synchro->comm));
470         other_synchro->state = SIMIX_DONE;
471         other_synchro->comm.type = SIMIX_COMM_DONE;
472         other_synchro->comm.rdv = NULL;
473       }/*else{
474          XBT_DEBUG("Not yet finished, we have to wait %d", xbt_fifo_size(rdv->comm_fifo));
475          }*/
476       other_synchro->comm.refcount--;
477       SIMIX_comm_destroy(this_synchro);
478       --smx_total_comms; // this creation was a pure waste
479     }
480   }else{
481     /* Prepare a synchro describing us, so that it gets passed to the user-provided filter of other side */
482
483     /* Look for communication synchro matching our needs. We also provide a description of
484      * ourself so that the other side also gets a chance of choosing if it wants to match with us.
485      *
486      * If it is not found then push our communication into the rendez-vous point */
487     other_synchro = SIMIX_fifo_get_comm(rdv->comm_fifo, SIMIX_COMM_SEND, match_fun, data, this_synchro);
488
489     if (!other_synchro) {
490       XBT_DEBUG("Receive pushed first %d", xbt_fifo_size(rdv->comm_fifo));
491       other_synchro = this_synchro;
492       SIMIX_rdv_push(rdv, this_synchro);
493     } else {
494       SIMIX_comm_destroy(this_synchro);
495       --smx_total_comms; // this creation was a pure waste
496       other_synchro->state = SIMIX_READY;
497       other_synchro->comm.type = SIMIX_COMM_READY;
498       //other_synchro->comm.refcount--;
499     }
500     xbt_fifo_push(dst_proc->comms, other_synchro);
501   }
502
503   /* Setup communication synchro */
504   other_synchro->comm.dst_proc = dst_proc;
505   other_synchro->comm.dst_buff = dst_buff;
506   other_synchro->comm.dst_buff_size = dst_buff_size;
507   other_synchro->comm.dst_data = data;
508
509   if (rate != -1.0 &&
510       (other_synchro->comm.rate == -1.0 || rate < other_synchro->comm.rate))
511     other_synchro->comm.rate = rate;
512
513   other_synchro->comm.match_fun = match_fun;
514   other_synchro->comm.copy_data_fun = copy_data_fun;
515
516
517   /*if(already_received)//do the actual copy, because the first one after the comm didn't have all the info
518     SIMIX_comm_copy_data(other_synchro);*/
519
520
521   if (MC_is_active() || MC_record_replay_is_active()) {
522     other_synchro->state = SIMIX_RUNNING;
523     return other_synchro;
524   }
525
526   SIMIX_comm_start(other_synchro);
527   // }
528   return other_synchro;
529 }
530
531 smx_synchro_t simcall_HANDLER_comm_iprobe(smx_simcall_t simcall, smx_rdv_t rdv,
532                                    int type, int src, int tag,
533                                    int (*match_fun)(void *, void *, smx_synchro_t),
534                                    void *data){
535   return SIMIX_comm_iprobe(simcall->issuer, rdv, type, src, tag, match_fun, data);
536 }
537
538 smx_synchro_t SIMIX_comm_iprobe(smx_process_t dst_proc, smx_rdv_t rdv, int type, int src,
539                               int tag, int (*match_fun)(void *, void *, smx_synchro_t), void *data)
540 {
541   XBT_DEBUG("iprobe from %p %p", rdv, rdv->comm_fifo);
542   smx_synchro_t this_synchro;
543   int smx_type;
544   if(type == 1){
545     this_synchro=SIMIX_comm_new(SIMIX_COMM_SEND);
546     smx_type = SIMIX_COMM_RECEIVE;
547   } else{
548     this_synchro=SIMIX_comm_new(SIMIX_COMM_RECEIVE);
549     smx_type = SIMIX_COMM_SEND;
550   } 
551   smx_synchro_t other_synchro=NULL;
552   if(rdv->permanent_receiver && xbt_fifo_size(rdv->done_comm_fifo)!=0){
553     //find a match in the already received fifo
554       XBT_DEBUG("first try in the perm recv mailbox");
555
556     other_synchro = SIMIX_fifo_probe_comm(rdv->done_comm_fifo, smx_type, match_fun, data, this_synchro);
557   }
558  // }else{
559     if(!other_synchro){
560         XBT_DEBUG("try in the normal mailbox");
561         other_synchro = SIMIX_fifo_probe_comm(rdv->comm_fifo, smx_type, match_fun, data, this_synchro);
562     }
563 //  }
564   if(other_synchro)other_synchro->comm.refcount--;
565
566   SIMIX_comm_destroy(this_synchro);
567   --smx_total_comms;
568   return other_synchro;
569 }
570
571 void simcall_HANDLER_comm_wait(smx_simcall_t simcall, smx_synchro_t synchro, double timeout)
572 {
573   /* the simcall may be a wait, a send or a recv */
574   surf_action_t sleep;
575
576   /* Associate this simcall to the wait synchro */
577   XBT_DEBUG("simcall_HANDLER_comm_wait, %p", synchro);
578
579   xbt_fifo_push(synchro->simcalls, simcall);
580   simcall->issuer->waiting_synchro = synchro;
581
582   if (MC_is_active() || MC_record_replay_is_active()) {
583     int idx = SIMCALL_GET_MC_VALUE(simcall);
584     if (idx == 0) {
585       synchro->state = SIMIX_DONE;
586     } else {
587       /* If we reached this point, the wait simcall must have a timeout */
588       /* Otherwise it shouldn't be enabled and executed by the MC */
589       if (timeout == -1)
590         THROW_IMPOSSIBLE;
591
592       if (synchro->comm.src_proc == simcall->issuer)
593         synchro->state = SIMIX_SRC_TIMEOUT;
594       else
595         synchro->state = SIMIX_DST_TIMEOUT;
596     }
597
598     SIMIX_comm_finish(synchro);
599     return;
600   }
601
602   /* If the synchro has already finish perform the error handling, */
603   /* otherwise set up a waiting timeout on the right side          */
604   if (synchro->state != SIMIX_WAITING && synchro->state != SIMIX_RUNNING) {
605     SIMIX_comm_finish(synchro);
606   } else { /* if (timeout >= 0) { we need a surf sleep action even when there is no timeout, otherwise surf won't tell us when the host fails */
607     sleep = surf_host_sleep(simcall->issuer->host, timeout);
608     surf_action_set_data(sleep, synchro);
609
610     if (simcall->issuer == synchro->comm.src_proc)
611       synchro->comm.src_timeout = sleep;
612     else
613       synchro->comm.dst_timeout = sleep;
614   }
615 }
616
617 void simcall_HANDLER_comm_test(smx_simcall_t simcall, smx_synchro_t synchro)
618 {
619   if(MC_is_active() || MC_record_replay_is_active()){
620     simcall_comm_test__set__result(simcall, synchro->comm.src_proc && synchro->comm.dst_proc);
621     if(simcall_comm_test__get__result(simcall)){
622       synchro->state = SIMIX_DONE;
623       xbt_fifo_push(synchro->simcalls, simcall);
624       SIMIX_comm_finish(synchro);
625     }else{
626       SIMIX_simcall_answer(simcall);
627     }
628     return;
629   }
630
631   simcall_comm_test__set__result(simcall, (synchro->state != SIMIX_WAITING && synchro->state != SIMIX_RUNNING));
632   if (simcall_comm_test__get__result(simcall)) {
633     xbt_fifo_push(synchro->simcalls, simcall);
634     SIMIX_comm_finish(synchro);
635   } else {
636     SIMIX_simcall_answer(simcall);
637   }
638 }
639
640 void simcall_HANDLER_comm_testany(smx_simcall_t simcall, xbt_dynar_t synchros)
641 {
642   unsigned int cursor;
643   smx_synchro_t synchro;
644   simcall_comm_testany__set__result(simcall, -1);
645
646   if (MC_is_active() || MC_record_replay_is_active()){
647     int idx = SIMCALL_GET_MC_VALUE(simcall);
648     if(idx == -1){
649       SIMIX_simcall_answer(simcall);
650     }else{
651       synchro = xbt_dynar_get_as(synchros, idx, smx_synchro_t);
652       simcall_comm_testany__set__result(simcall, idx);
653       xbt_fifo_push(synchro->simcalls, simcall);
654       synchro->state = SIMIX_DONE;
655       SIMIX_comm_finish(synchro);
656     }
657     return;
658   }
659
660   xbt_dynar_foreach(simcall_comm_testany__get__comms(simcall), cursor,synchro) {
661     if (synchro->state != SIMIX_WAITING && synchro->state != SIMIX_RUNNING) {
662       simcall_comm_testany__set__result(simcall, cursor);
663       xbt_fifo_push(synchro->simcalls, simcall);
664       SIMIX_comm_finish(synchro);
665       return;
666     }
667   }
668   SIMIX_simcall_answer(simcall);
669 }
670
671 void simcall_HANDLER_comm_waitany(smx_simcall_t simcall, xbt_dynar_t synchros)
672 {
673   smx_synchro_t synchro;
674   unsigned int cursor = 0;
675
676   if (MC_is_active() || MC_record_replay_is_active()){
677     int idx = SIMCALL_GET_MC_VALUE(simcall);
678     synchro = xbt_dynar_get_as(synchros, idx, smx_synchro_t);
679     xbt_fifo_push(synchro->simcalls, simcall);
680     simcall_comm_waitany__set__result(simcall, idx);
681     synchro->state = SIMIX_DONE;
682     SIMIX_comm_finish(synchro);
683     return;
684   }
685
686   xbt_dynar_foreach(synchros, cursor, synchro){
687     /* associate this simcall to the the synchro */
688     xbt_fifo_push(synchro->simcalls, simcall);
689
690     /* see if the synchro is already finished */
691     if (synchro->state != SIMIX_WAITING && synchro->state != SIMIX_RUNNING){
692       SIMIX_comm_finish(synchro);
693       break;
694     }
695   }
696 }
697
698 void SIMIX_waitany_remove_simcall_from_actions(smx_simcall_t simcall)
699 {
700   smx_synchro_t synchro;
701   unsigned int cursor = 0;
702   xbt_dynar_t synchros = simcall_comm_waitany__get__comms(simcall);
703
704   xbt_dynar_foreach(synchros, cursor, synchro) {
705     xbt_fifo_remove(synchro->simcalls, simcall);
706   }
707 }
708
709 /**
710  *  \brief Starts the simulation of a communication synchro.
711  *  \param synchro the communication synchro
712  */
713 static XBT_INLINE void SIMIX_comm_start(smx_synchro_t synchro)
714 {
715   /* If both the sender and the receiver are already there, start the communication */
716   if (synchro->state == SIMIX_READY) {
717
718     sg_host_t sender = synchro->comm.src_proc->host;
719     sg_host_t receiver = synchro->comm.dst_proc->host;
720
721     XBT_DEBUG("Starting communication %p from '%s' to '%s'", synchro,
722               SIMIX_host_get_name(sender), SIMIX_host_get_name(receiver));
723
724     synchro->comm.surf_comm = surf_network_model_communicate(surf_network_model,
725                                                                     sender, receiver,
726                                                                     synchro->comm.task_size, synchro->comm.rate);
727
728     surf_action_set_data(synchro->comm.surf_comm, synchro);
729
730     synchro->state = SIMIX_RUNNING;
731
732     /* If a link is failed, detect it immediately */
733     if (surf_action_get_state(synchro->comm.surf_comm) == SURF_ACTION_FAILED) {
734       XBT_DEBUG("Communication from '%s' to '%s' failed to start because of a link failure",
735                 SIMIX_host_get_name(sender), SIMIX_host_get_name(receiver));
736       synchro->state = SIMIX_LINK_FAILURE;
737       SIMIX_comm_destroy_internal_actions(synchro);
738     }
739
740     /* If any of the process is suspend, create the synchro but stop its execution,
741        it will be restarted when the sender process resume */
742     if (SIMIX_process_is_suspended(synchro->comm.src_proc) ||
743         SIMIX_process_is_suspended(synchro->comm.dst_proc)) {
744       /* FIXME: check what should happen with the synchro state */
745
746       if (SIMIX_process_is_suspended(synchro->comm.src_proc))
747         XBT_DEBUG("The communication is suspended on startup because src (%s:%s) were suspended since it initiated the communication",
748                   SIMIX_host_get_name(synchro->comm.src_proc->host), synchro->comm.src_proc->name);
749       else
750         XBT_DEBUG("The communication is suspended on startup because dst (%s:%s) were suspended since it initiated the communication",
751                   SIMIX_host_get_name(synchro->comm.dst_proc->host), synchro->comm.dst_proc->name);
752
753       surf_action_suspend(synchro->comm.surf_comm);
754
755     }
756   }
757 }
758
759 /**
760  * \brief Answers the SIMIX simcalls associated to a communication synchro.
761  * \param synchro a finished communication synchro
762  */
763 void SIMIX_comm_finish(smx_synchro_t synchro)
764 {
765   unsigned int destroy_count = 0;
766   smx_simcall_t simcall;
767
768   while ((simcall = xbt_fifo_shift(synchro->simcalls))) {
769
770     /* If a waitany simcall is waiting for this synchro to finish, then remove
771        it from the other synchros in the waitany list. Afterwards, get the
772        position of the actual synchro in the waitany dynar and
773        return it as the result of the simcall */
774
775     if (simcall->call == SIMCALL_NONE) //FIXME: maybe a better way to handle this case
776       continue; // if process handling comm is killed
777     if (simcall->call == SIMCALL_COMM_WAITANY) {
778       SIMIX_waitany_remove_simcall_from_actions(simcall);
779       if (!MC_is_active() && !MC_record_replay_is_active())
780         simcall_comm_waitany__set__result(simcall, xbt_dynar_search(simcall_comm_waitany__get__comms(simcall), &synchro));
781     }
782
783     /* If the synchro is still in a rendez-vous point then remove from it */
784     if (synchro->comm.rdv)
785       SIMIX_rdv_remove(synchro->comm.rdv, synchro);
786
787     XBT_DEBUG("SIMIX_comm_finish: synchro state = %d", (int)synchro->state);
788
789     /* Check out for errors */
790
791     if (surf_host_get_state(surf_host_resource_priv(
792           simcall->issuer->host)) != SURF_RESOURCE_ON) {
793       simcall->issuer->context->iwannadie = 1;
794       SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
795     } else
796
797     switch (synchro->state) {
798
799     case SIMIX_DONE:
800       XBT_DEBUG("Communication %p complete!", synchro);
801       SIMIX_comm_copy_data(synchro);
802       break;
803
804     case SIMIX_SRC_TIMEOUT:
805       SMX_EXCEPTION(simcall->issuer, timeout_error, 0,
806                     "Communication timeouted because of sender");
807       break;
808
809     case SIMIX_DST_TIMEOUT:
810       SMX_EXCEPTION(simcall->issuer, timeout_error, 0,
811                     "Communication timeouted because of receiver");
812       break;
813
814     case SIMIX_SRC_HOST_FAILURE:
815       if (simcall->issuer == synchro->comm.src_proc)
816         simcall->issuer->context->iwannadie = 1;
817 //          SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
818       else
819         SMX_EXCEPTION(simcall->issuer, network_error, 0, "Remote peer failed");
820       break;
821
822     case SIMIX_DST_HOST_FAILURE:
823       if (simcall->issuer == synchro->comm.dst_proc)
824         simcall->issuer->context->iwannadie = 1;
825 //          SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
826       else
827         SMX_EXCEPTION(simcall->issuer, network_error, 0, "Remote peer failed");
828       break;
829
830     case SIMIX_LINK_FAILURE:
831
832       XBT_DEBUG("Link failure in synchro %p between '%s' and '%s': posting an exception to the issuer: %s (%p) detached:%d",
833                 synchro,
834                 synchro->comm.src_proc ? sg_host_name(synchro->comm.src_proc->host) : NULL,
835                 synchro->comm.dst_proc ? sg_host_name(synchro->comm.dst_proc->host) : NULL,
836                 simcall->issuer->name, simcall->issuer, synchro->comm.detached);
837       if (synchro->comm.src_proc == simcall->issuer) {
838         XBT_DEBUG("I'm source");
839       } else if (synchro->comm.dst_proc == simcall->issuer) {
840         XBT_DEBUG("I'm dest");
841       } else {
842         XBT_DEBUG("I'm neither source nor dest");
843       }
844       SMX_EXCEPTION(simcall->issuer, network_error, 0, "Link failure");
845       break;
846
847     case SIMIX_CANCELED:
848       if (simcall->issuer == synchro->comm.dst_proc)
849         SMX_EXCEPTION(simcall->issuer, cancel_error, 0,
850                       "Communication canceled by the sender");
851       else
852         SMX_EXCEPTION(simcall->issuer, cancel_error, 0,
853                       "Communication canceled by the receiver");
854       break;
855
856     default:
857       xbt_die("Unexpected synchro state in SIMIX_comm_finish: %d", (int)synchro->state);
858     }
859
860     /* if there is an exception during a waitany or a testany, indicate the position of the failed communication */
861     if (simcall->issuer->doexception) {
862       if (simcall->call == SIMCALL_COMM_WAITANY) {
863         simcall->issuer->running_ctx->exception.value = xbt_dynar_search(simcall_comm_waitany__get__comms(simcall), &synchro);
864       }
865       else if (simcall->call == SIMCALL_COMM_TESTANY) {
866         simcall->issuer->running_ctx->exception.value = xbt_dynar_search(simcall_comm_testany__get__comms(simcall), &synchro);
867       }
868     }
869
870     if (surf_host_get_state(surf_host_resource_priv(simcall->issuer->host)) != SURF_RESOURCE_ON) {
871       simcall->issuer->context->iwannadie = 1;
872     }
873
874     simcall->issuer->waiting_synchro = NULL;
875     xbt_fifo_remove(simcall->issuer->comms, synchro);
876     if(synchro->comm.detached){
877       if(simcall->issuer == synchro->comm.src_proc){
878         if(synchro->comm.dst_proc)
879           xbt_fifo_remove(synchro->comm.dst_proc->comms, synchro);
880       }
881       if(simcall->issuer == synchro->comm.dst_proc){
882         if(synchro->comm.src_proc)
883           xbt_fifo_remove(synchro->comm.src_proc->comms, synchro);
884       }
885     }
886     SIMIX_simcall_answer(simcall);
887     destroy_count++;
888   }
889
890   while (destroy_count-- > 0)
891     SIMIX_comm_destroy(synchro);
892 }
893
894 /**
895  * \brief This function is called when a Surf communication synchro is finished.
896  * \param synchro the corresponding Simix communication
897  */
898 void SIMIX_post_comm(smx_synchro_t synchro)
899 {
900   /* Update synchro state */
901   if (synchro->comm.src_timeout &&
902       surf_action_get_state(synchro->comm.src_timeout) == SURF_ACTION_DONE)
903     synchro->state = SIMIX_SRC_TIMEOUT;
904   else if (synchro->comm.dst_timeout &&
905           surf_action_get_state(synchro->comm.dst_timeout) == SURF_ACTION_DONE)
906     synchro->state = SIMIX_DST_TIMEOUT;
907   else if (synchro->comm.src_timeout &&
908           surf_action_get_state(synchro->comm.src_timeout) == SURF_ACTION_FAILED)
909     synchro->state = SIMIX_SRC_HOST_FAILURE;
910   else if (synchro->comm.dst_timeout &&
911       surf_action_get_state(synchro->comm.dst_timeout) == SURF_ACTION_FAILED)
912     synchro->state = SIMIX_DST_HOST_FAILURE;
913   else if (synchro->comm.surf_comm &&
914           surf_action_get_state(synchro->comm.surf_comm) == SURF_ACTION_FAILED) {
915     XBT_DEBUG("Puta madre. Surf says that the link broke");
916     synchro->state = SIMIX_LINK_FAILURE;
917   } else
918     synchro->state = SIMIX_DONE;
919
920   XBT_DEBUG("SIMIX_post_comm: comm %p, state %d, src_proc %p, dst_proc %p, detached: %d",
921             synchro, (int)synchro->state, synchro->comm.src_proc, synchro->comm.dst_proc, synchro->comm.detached);
922
923   /* destroy the surf actions associated with the Simix communication */
924   SIMIX_comm_destroy_internal_actions(synchro);
925
926   /* if there are simcalls associated with the synchro, then answer them */
927   if (xbt_fifo_size(synchro->simcalls)) {
928     SIMIX_comm_finish(synchro);
929   }
930 }
931
932 void SIMIX_comm_cancel(smx_synchro_t synchro)
933 {
934   /* if the synchro is a waiting state means that it is still in a rdv */
935   /* so remove from it and delete it */
936   if (synchro->state == SIMIX_WAITING) {
937     SIMIX_rdv_remove(synchro->comm.rdv, synchro);
938     synchro->state = SIMIX_CANCELED;
939   }
940   else if (!MC_is_active() /* when running the MC there are no surf actions */
941            && !MC_record_replay_is_active()
942            && (synchro->state == SIMIX_READY || synchro->state == SIMIX_RUNNING)) {
943
944     surf_action_cancel(synchro->comm.surf_comm);
945   }
946 }
947
948 void SIMIX_comm_suspend(smx_synchro_t synchro)
949 {
950   /*FIXME: shall we suspend also the timeout synchro? */
951   if (synchro->comm.surf_comm)
952     surf_action_suspend(synchro->comm.surf_comm);
953   /* in the other case, the action will be suspended on creation, in SIMIX_comm_start() */
954 }
955
956 void SIMIX_comm_resume(smx_synchro_t synchro)
957 {
958   /*FIXME: check what happen with the timeouts */
959   if (synchro->comm.surf_comm)
960     surf_action_resume(synchro->comm.surf_comm);
961   /* in the other case, the synchro were not really suspended yet, see SIMIX_comm_suspend() and SIMIX_comm_start() */
962 }
963
964
965 /************* synchro Getters **************/
966
967 /**
968  *  \brief get the amount remaining from the communication
969  *  \param synchro The communication
970  */
971 double SIMIX_comm_get_remains(smx_synchro_t synchro)
972 {
973   double remains;
974
975   if(!synchro){
976     return 0;
977   }
978
979   switch (synchro->state) {
980
981   case SIMIX_RUNNING:
982     remains = surf_action_get_remains(synchro->comm.surf_comm);
983     break;
984
985   case SIMIX_WAITING:
986   case SIMIX_READY:
987     remains = 0; /*FIXME: check what should be returned */
988     break;
989
990   default:
991     remains = 0; /*FIXME: is this correct? */
992     break;
993   }
994   return remains;
995 }
996
997 e_smx_state_t SIMIX_comm_get_state(smx_synchro_t synchro)
998 {
999   return synchro->state;
1000 }
1001
1002 /**
1003  *  \brief Return the user data associated to the sender of the communication
1004  *  \param synchro The communication
1005  *  \return the user data
1006  */
1007 void* SIMIX_comm_get_src_data(smx_synchro_t synchro)
1008 {
1009   return synchro->comm.src_data;
1010 }
1011
1012 /**
1013  *  \brief Return the user data associated to the receiver of the communication
1014  *  \param synchro The communication
1015  *  \return the user data
1016  */
1017 void* SIMIX_comm_get_dst_data(smx_synchro_t synchro)
1018 {
1019   return synchro->comm.dst_data;
1020 }
1021
1022 smx_process_t SIMIX_comm_get_src_proc(smx_synchro_t synchro)
1023 {
1024   return synchro->comm.src_proc;
1025 }
1026
1027 smx_process_t SIMIX_comm_get_dst_proc(smx_synchro_t synchro)
1028 {
1029   return synchro->comm.dst_proc;
1030 }
1031
1032 #ifdef HAVE_LATENCY_BOUND_TRACKING
1033 /**
1034  *  \brief verify if communication is latency bounded
1035  *  \param comm The communication
1036  */
1037 int SIMIX_comm_is_latency_bounded(smx_synchro_t synchro)
1038 {
1039   if(!synchro){
1040     return 0;
1041   }
1042   if (synchro->comm.surf_comm){
1043     XBT_DEBUG("Getting latency limited for surf_action (%p)", synchro->comm.surf_comm);
1044     synchro->latency_limited = surf_network_action_get_latency_limited(synchro->comm.surf_comm);
1045     XBT_DEBUG("synchro limited is %d", synchro->latency_limited);
1046   }
1047   return synchro->latency_limited;
1048 }
1049 #endif
1050
1051 /******************************************************************************/
1052 /*                    SIMIX_comm_copy_data callbacks                       */
1053 /******************************************************************************/
1054 static void (*SIMIX_comm_copy_data_callback) (smx_synchro_t, void*, size_t) =
1055   &SIMIX_comm_copy_pointer_callback;
1056
1057 void
1058 SIMIX_comm_set_copy_data_callback(void (*callback) (smx_synchro_t, void*, size_t))
1059 {
1060   SIMIX_comm_copy_data_callback = callback;
1061 }
1062
1063 void SIMIX_comm_copy_pointer_callback(smx_synchro_t comm, void* buff, size_t buff_size)
1064 {
1065   xbt_assert((buff_size == sizeof(void *)),
1066              "Cannot copy %zu bytes: must be sizeof(void*)", buff_size);
1067   *(void **) (comm->comm.dst_buff) = buff;
1068 }
1069
1070 void SIMIX_comm_copy_buffer_callback(smx_synchro_t comm, void* buff, size_t buff_size)
1071 {
1072   XBT_DEBUG("Copy the data over");
1073   memcpy(comm->comm.dst_buff, buff, buff_size);
1074   if (comm->comm.detached) { // if this is a detached send, the source buffer was duplicated by SMPI sender to make the original buffer available to the application ASAP
1075     xbt_free(buff);
1076     comm->comm.src_buff = NULL;
1077   }
1078 }
1079
1080
1081 /**
1082  *  \brief Copy the communication data from the sender's buffer to the receiver's one
1083  *  \param comm The communication
1084  */
1085 void SIMIX_comm_copy_data(smx_synchro_t comm)
1086 {
1087   size_t buff_size = comm->comm.src_buff_size;
1088   /* If there is no data to be copy then return */
1089   if (!comm->comm.src_buff || !comm->comm.dst_buff || comm->comm.copied)
1090     return;
1091
1092   XBT_DEBUG("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)",
1093             comm,
1094             comm->comm.src_proc ? sg_host_name(comm->comm.src_proc->host) : "a finished process",
1095             comm->comm.src_buff,
1096             comm->comm.dst_proc ? sg_host_name(comm->comm.dst_proc->host) : "a finished process",
1097             comm->comm.dst_buff, buff_size);
1098
1099   /* Copy at most dst_buff_size bytes of the message to receiver's buffer */
1100   if (comm->comm.dst_buff_size)
1101     buff_size = MIN(buff_size, *(comm->comm.dst_buff_size));
1102
1103   /* Update the receiver's buffer size to the copied amount */
1104   if (comm->comm.dst_buff_size)
1105     *comm->comm.dst_buff_size = buff_size;
1106
1107   if (buff_size > 0){
1108       if(comm->comm.copy_data_fun)
1109         comm->comm.copy_data_fun (comm, comm->comm.src_buff, buff_size);
1110       else
1111         SIMIX_comm_copy_data_callback (comm, comm->comm.src_buff, buff_size);
1112   }
1113
1114
1115   /* Set the copied flag so we copy data only once */
1116   /* (this function might be called from both communication ends) */
1117   comm->comm.copied = 1;
1118 }