Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Replace xbt_die(bprintf(...)) with xbt_die(...).
[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 static xbt_dict_t rdv_points = NULL;
16 unsigned long int smx_total_comms = 0;
17
18 static XBT_INLINE void SIMIX_comm_start(smx_action_t action);
19 static void SIMIX_comm_finish(smx_action_t action);
20 static void SIMIX_waitany_req_remove_from_actions(smx_req_t req);
21 static void SIMIX_comm_copy_data(smx_action_t comm);
22 static smx_action_t SIMIX_comm_new(e_smx_comm_type_t type);
23 static XBT_INLINE void SIMIX_rdv_push(smx_rdv_t rdv, smx_action_t comm);
24 static XBT_INLINE void SIMIX_rdv_remove(smx_rdv_t rdv, smx_action_t comm);
25 static smx_action_t SIMIX_rdv_get_request(smx_rdv_t rdv, e_smx_comm_type_t type,
26                                           int (*match_fun)(void *, void *), void *);
27 static void SIMIX_rdv_free(void *data);
28
29 void SIMIX_network_init(void)
30 {
31   rdv_points = xbt_dict_new();
32 }
33
34 void SIMIX_network_exit(void)
35 {
36   xbt_dict_free(&rdv_points);
37 }
38
39 /******************************************************************************/
40 /*                           Rendez-Vous Points                               */
41 /******************************************************************************/
42
43 smx_rdv_t SIMIX_rdv_create(const char *name)
44 {
45   /* two processes may have pushed the same rdv_create request at the same time */
46   smx_rdv_t rdv = name ? xbt_dict_get_or_null(rdv_points, name) : NULL;
47
48   if (!rdv) {
49     rdv = xbt_new0(s_smx_rvpoint_t, 1);
50     rdv->name = name ? xbt_strdup(name) : NULL;
51     rdv->comm_fifo = xbt_fifo_new();
52
53     if (rdv->name)
54       xbt_dict_set(rdv_points, rdv->name, rdv, SIMIX_rdv_free);
55   }
56   return rdv;
57 }
58
59 void SIMIX_rdv_destroy(smx_rdv_t rdv)
60 {
61   if (rdv->name)
62     xbt_dict_remove(rdv_points, rdv->name);
63 }
64
65 void SIMIX_rdv_free(void *data)
66 {
67   smx_rdv_t rdv = (smx_rdv_t) data;
68   if (rdv->name)
69     xbt_free(rdv->name);
70   xbt_fifo_free(rdv->comm_fifo);
71   xbt_free(rdv);  
72 }
73
74 smx_rdv_t SIMIX_rdv_get_by_name(const char *name)
75 {
76   return xbt_dict_get_or_null(rdv_points, name);
77 }
78
79 int SIMIX_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host)
80 {
81   smx_action_t comm = NULL;
82   xbt_fifo_item_t item = NULL;
83   int count = 0;
84
85   xbt_fifo_foreach(rdv->comm_fifo, item, comm, smx_action_t) {
86     if (comm->comm.src_proc->smx_host == host)
87       count++;
88   }
89
90   return count;
91 }
92
93 smx_action_t SIMIX_rdv_get_head(smx_rdv_t rdv)
94 {
95   return xbt_fifo_get_item_content(xbt_fifo_get_first_item(rdv->comm_fifo));
96 }
97
98 /**
99  *  \brief Push a communication request into a rendez-vous point
100  *  \param rdv The rendez-vous point
101  *  \param comm The communication request
102  */
103 static XBT_INLINE void SIMIX_rdv_push(smx_rdv_t rdv, smx_action_t comm)
104 {
105   xbt_fifo_push(rdv->comm_fifo, comm);
106   comm->comm.rdv = rdv;
107 }
108
109 /**
110  *  \brief Remove a communication request from a rendez-vous point
111  *  \param rdv The rendez-vous point
112  *  \param comm The communication request
113  */
114 static XBT_INLINE void SIMIX_rdv_remove(smx_rdv_t rdv, smx_action_t comm)
115 {
116   xbt_fifo_remove(rdv->comm_fifo, comm);
117   comm->comm.rdv = NULL;
118 }
119
120 /**
121  *  \brief Checks if there is a communication action queued in a rendez-vous matching our needs
122  *  \param type The type of communication we are looking for (comm_send, comm_recv)
123  *  \return The communication action if found, NULL otherwise
124  */
125 smx_action_t SIMIX_rdv_get_request(smx_rdv_t rdv, e_smx_comm_type_t type,
126                                    int (*match_fun)(void *, void *), void *data)
127 {
128   smx_action_t action;
129   xbt_fifo_item_t item;
130   void* req_data = NULL;
131
132   xbt_fifo_foreach(rdv->comm_fifo, item, action, smx_action_t){
133     if (action->comm.type == SIMIX_COMM_SEND) {
134       req_data = action->comm.src_data;
135     } else if (action->comm.type == SIMIX_COMM_RECEIVE) {
136       req_data = action->comm.dst_data;
137     }
138     if (action->comm.type == type && (!match_fun || match_fun(data, req_data))) {
139       XBT_DEBUG("Found a matching communication action %p", action);
140       xbt_fifo_remove_item(rdv->comm_fifo, item);
141       xbt_fifo_free_item(item);
142       action->comm.refcount++;
143       action->comm.rdv = NULL;
144       return action;
145     }
146     XBT_DEBUG("Sorry, communication action %p does not match our needs:"
147            " its type is %d but we are looking for a comm of type %d",
148            action, action->comm.type, type);
149   }
150   XBT_DEBUG("No matching communication action found");
151   return NULL;
152 }
153
154 /******************************************************************************/
155 /*                            Comunication Actions                            */
156 /******************************************************************************/
157
158 /**
159  *  \brief Creates a new comunicate action
160  *  \param type The type of request (comm_send, comm_recv)
161  *  \return The new comunicate action
162  */
163 smx_action_t SIMIX_comm_new(e_smx_comm_type_t type)
164 {
165   smx_action_t act;
166
167   /* alloc structures */
168   act = xbt_mallocator_get(simix_global->action_mallocator);
169   act->type = SIMIX_ACTION_COMMUNICATE;
170   act->state = SIMIX_WAITING;
171
172   /* set communication */
173   act->comm.type = type;
174   act->comm.refcount = 1;
175
176 #ifdef HAVE_LATENCY_BOUND_TRACKING
177   //initialize with unknown value
178   act->latency_limited = -1;
179 #endif
180
181 #ifdef HAVE_TRACING
182   act->category = NULL;
183 #endif
184
185   XBT_DEBUG("Create communicate action %p", act);
186   ++smx_total_comms;
187
188   return act;
189 }
190
191 /**
192  *  \brief Destroy a communicate action
193  *  \param action The communicate action to be destroyed
194  */
195 void SIMIX_comm_destroy(smx_action_t action)
196 {
197   XBT_DEBUG("Destroy action %p (refcount:%d)", action, action->comm.refcount);
198
199   if (action->comm.refcount <= 0)
200     xbt_die("the refcount of comm %p is already 0 before decreasing it. "
201             "That's a bug!", action);
202
203   action->comm.refcount--;
204   if (action->comm.refcount > 0)
205     return;
206   XBT_DEBUG("Really free communication %p; refcount is now %d", action,
207         action->comm.refcount);
208
209 #ifdef HAVE_LATENCY_BOUND_TRACKING
210     action->latency_limited = SIMIX_comm_is_latency_bounded( action ) ;
211 #endif
212
213 #ifdef HAVE_TRACING
214   TRACE_smx_action_destroy(action);
215 #endif
216
217   xbt_free(action->name);
218   SIMIX_comm_destroy_internal_actions(action);
219
220   if (action->comm.detached && action->state != SIMIX_DONE) {
221     /* the communication has failed and was detached:
222      * we have to free the buffer */
223     ((void_f_pvoid_t) action->comm.src_data)(action->comm.src_buff);
224   }
225
226   xbt_mallocator_release(simix_global->action_mallocator, action);
227 }
228
229 void SIMIX_comm_destroy_internal_actions(smx_action_t action)
230 {
231   if (action->comm.surf_comm){
232 #ifdef HAVE_LATENCY_BOUND_TRACKING
233     action->latency_limited = SIMIX_comm_is_latency_bounded(action);
234 #endif
235     action->comm.surf_comm->model_type->action_unref(action->comm.surf_comm);
236     action->comm.surf_comm = NULL;
237   }
238
239   if (action->comm.src_timeout){
240     action->comm.src_timeout->model_type->action_unref(action->comm.src_timeout);
241     action->comm.src_timeout = NULL;
242   }
243
244   if (action->comm.dst_timeout){
245     action->comm.dst_timeout->model_type->action_unref(action->comm.dst_timeout);
246     action->comm.dst_timeout = NULL;
247   }
248 }
249
250 smx_action_t SIMIX_comm_isend(smx_process_t src_proc, smx_rdv_t rdv,
251                               double task_size, double rate,
252                               void *src_buff, size_t src_buff_size,
253                               int (*match_fun)(void *, void *), void *data,
254                               int detached)
255 {
256   smx_action_t action;
257
258   /* Look for communication request matching our needs.
259      If it is not found then create it and push it into the rendez-vous point */
260   action = SIMIX_rdv_get_request(rdv, SIMIX_COMM_RECEIVE, match_fun, data);
261
262   if (!action) {
263     action = SIMIX_comm_new(SIMIX_COMM_SEND);
264     SIMIX_rdv_push(rdv, action);
265   } else {
266     action->state = SIMIX_READY;
267     action->comm.type = SIMIX_COMM_READY;
268   }
269
270   /* If the communication action is detached then decrease the refcount
271    * by one, so it will be eliminated by the receivers destroy call */
272   if (detached) {
273     action->comm.detached = 1;
274     action->comm.refcount--;
275   }
276
277   /* Setup the communication request */
278   action->comm.src_proc = src_proc;
279   action->comm.task_size = task_size;
280   action->comm.rate = rate;
281   action->comm.src_buff = src_buff;
282   action->comm.src_buff_size = src_buff_size;
283   action->comm.src_data = data;
284
285   if (MC_IS_ENABLED) {
286     action->state = SIMIX_RUNNING;
287     return action;
288   }
289
290   SIMIX_comm_start(action);
291   return action;
292 }
293
294 smx_action_t SIMIX_comm_irecv(smx_process_t dst_proc, smx_rdv_t rdv,
295                       void *dst_buff, size_t *dst_buff_size,
296                       int (*match_fun)(void *, void *), void *data)
297 {
298   smx_action_t action;
299
300   /* Look for communication request matching our needs.
301    * If it is not found then create it and push it into the rendez-vous point
302    */
303   action = SIMIX_rdv_get_request(rdv, SIMIX_COMM_SEND, match_fun, data);
304
305   if (!action) {
306     action = SIMIX_comm_new(SIMIX_COMM_RECEIVE);
307     SIMIX_rdv_push(rdv, action);
308   } else {
309     action->state = SIMIX_READY;
310     action->comm.type = SIMIX_COMM_READY;
311   }
312
313   /* Setup communication request */
314   action->comm.dst_proc = dst_proc;
315   action->comm.dst_buff = dst_buff;
316   action->comm.dst_buff_size = dst_buff_size;
317   action->comm.dst_data = data;
318
319   if (MC_IS_ENABLED) {
320     action->state = SIMIX_RUNNING;
321     return action;
322   }
323
324   SIMIX_comm_start(action);
325   return action;
326 }
327
328 void SIMIX_pre_comm_wait(smx_req_t req, smx_action_t action, double timeout, int idx)
329 {
330   /* the request may be a wait, a send or a recv */
331   surf_action_t sleep;
332
333   /* Associate this request to the action */
334   xbt_fifo_push(action->request_list, req);
335   req->issuer->waiting_action = action;
336
337   if (MC_IS_ENABLED) {
338     if (idx == 0) {
339       action->state = SIMIX_DONE;
340     } else {
341       /* If we reached this point, the wait request must have a timeout */
342       /* Otherwise it shouldn't be enabled and executed by the MC */
343       if (timeout == -1)
344         THROW_IMPOSSIBLE;
345
346       if (action->comm.src_proc == req->issuer)
347         action->state = SIMIX_SRC_TIMEOUT;
348       else
349         action->state = SIMIX_DST_TIMEOUT;
350     }
351
352     SIMIX_comm_finish(action);
353     return;
354   }
355
356   /* If the action has already finish perform the error handling, */
357   /* otherwise set up a waiting timeout on the right side         */
358   if (action->state != SIMIX_WAITING && action->state != SIMIX_RUNNING) {
359     SIMIX_comm_finish(action);
360   } 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 */
361     sleep = surf_workstation_model->extension.workstation.sleep(req->issuer->smx_host->host, timeout);
362     surf_workstation_model->action_data_set(sleep, action);
363
364     if (req->issuer == action->comm.src_proc)
365       action->comm.src_timeout = sleep;
366     else
367       action->comm.dst_timeout = sleep;
368   }
369 }
370
371 void SIMIX_pre_comm_test(smx_req_t req)
372 {
373   smx_action_t action = req->comm_test.comm;
374
375   if(MC_IS_ENABLED){
376     req->comm_test.result = action->comm.src_proc && action->comm.dst_proc;
377     if(req->comm_test.result){
378       action->state = SIMIX_DONE;
379       xbt_fifo_push(action->request_list, req);
380       SIMIX_comm_finish(action);
381     }else{
382       SIMIX_request_answer(req);
383     }
384     return;
385   }
386
387   req->comm_test.result = (action->state != SIMIX_WAITING && action->state != SIMIX_RUNNING);
388   if (req->comm_test.result) {
389     xbt_fifo_push(action->request_list, req);
390     SIMIX_comm_finish(action);
391   } else {
392     SIMIX_request_answer(req);
393   }
394 }
395
396 void SIMIX_pre_comm_testany(smx_req_t req, int idx)
397 {
398   unsigned int cursor;
399   smx_action_t action;
400   xbt_dynar_t actions = req->comm_testany.comms;
401   req->comm_testany.result = -1;
402
403   if (MC_IS_ENABLED){
404     if(idx == -1){
405       SIMIX_request_answer(req);
406     }else{
407       action = xbt_dynar_get_as(actions, idx, smx_action_t);
408       req->comm_testany.result = idx;
409       xbt_fifo_push(action->request_list, req);
410       action->state = SIMIX_DONE;
411       SIMIX_comm_finish(action);
412     }
413     return;
414   }
415
416   xbt_dynar_foreach(req->comm_testany.comms,cursor,action) {
417     if (action->state != SIMIX_WAITING && action->state != SIMIX_RUNNING) {
418       req->comm_testany.result = cursor;
419       xbt_fifo_push(action->request_list, req);
420       SIMIX_comm_finish(action);
421       return;
422     }
423   }
424   SIMIX_request_answer(req);
425 }
426
427 void SIMIX_pre_comm_waitany(smx_req_t req, int idx)
428 {
429   smx_action_t action;
430   unsigned int cursor = 0;
431   xbt_dynar_t actions = req->comm_waitany.comms;
432
433   if (MC_IS_ENABLED){
434     action = xbt_dynar_get_as(actions, idx, smx_action_t);
435     xbt_fifo_push(action->request_list, req);
436     req->comm_waitany.result = idx;
437     action->state = SIMIX_DONE;
438     SIMIX_comm_finish(action);
439     return;
440   }
441
442   xbt_dynar_foreach(actions, cursor, action){
443     /* Associate this request to the action */
444     xbt_fifo_push(action->request_list, req);
445     if (action->state != SIMIX_WAITING && action->state != SIMIX_RUNNING){
446       SIMIX_comm_finish(action);
447       break;
448     }
449   }
450 }
451
452 void SIMIX_waitany_req_remove_from_actions(smx_req_t req)
453 {
454   smx_action_t action;
455   unsigned int cursor = 0;
456   xbt_dynar_t actions = req->comm_waitany.comms;
457
458   xbt_dynar_foreach(actions, cursor, action){
459     xbt_fifo_remove(action->request_list, req);
460   }
461 }
462
463 /**
464  *  \brief Start the simulation of a communication request
465  *  \param action The communication action
466  */
467 static XBT_INLINE void SIMIX_comm_start(smx_action_t action)
468 {
469   /* If both the sender and the receiver are already there, start the communication */
470   if (action->state == SIMIX_READY) {
471     smx_host_t sender = action->comm.src_proc->smx_host;
472     smx_host_t receiver = action->comm.dst_proc->smx_host;
473
474     XBT_DEBUG("Starting communication %p from '%s' to '%s'", action,
475            SIMIX_host_get_name(sender), SIMIX_host_get_name(receiver));
476
477     action->comm.surf_comm = surf_workstation_model->extension.workstation.
478         communicate(sender->host, receiver->host, action->comm.task_size, action->comm.rate);
479
480     surf_workstation_model->action_data_set(action->comm.surf_comm, action);
481
482     action->state = SIMIX_RUNNING;
483
484 #ifdef HAVE_TRACING
485     TRACE_smx_action_communicate(action, action->comm.src_proc);
486 #endif
487
488     /* If a link is failed, detect it immediately */
489     if (surf_workstation_model->action_state_get(action->comm.surf_comm) == SURF_ACTION_FAILED) {
490       XBT_DEBUG("Communication from '%s' to '%s' failed to start because of a link failure",
491           SIMIX_host_get_name(sender), SIMIX_host_get_name(receiver));
492       action->state = SIMIX_LINK_FAILURE;
493       SIMIX_comm_destroy_internal_actions(action);
494     }
495
496     /* If any of the process is suspend, create the action but stop its execution,
497        it will be restarted when the sender process resume */
498     if (SIMIX_process_is_suspended(action->comm.src_proc) ||
499         SIMIX_process_is_suspended(action->comm.dst_proc)) {
500       /* FIXME: check what should happen with the action state */
501       surf_workstation_model->suspend(action->comm.surf_comm);
502     }
503   }
504 }
505
506 void SIMIX_comm_finish(smx_action_t action)
507 {
508   unsigned int destroy_count = 0;
509   smx_req_t req;
510
511   while ((req = xbt_fifo_shift(action->request_list))) {
512
513     /* If a waitany request is waiting for this action to finish, then remove
514        it from the other actions in the waitany list. Afterwards, get the
515        position of the actual action in the waitany request's actions dynar and
516        return it as the result of the call */
517     if (req->call == REQ_COMM_WAITANY) {
518       SIMIX_waitany_req_remove_from_actions(req);
519       if (!MC_IS_ENABLED)
520         req->comm_waitany.result = xbt_dynar_search(req->comm_waitany.comms, &action);
521     }
522
523     /* If the action is still in a rendez-vous point then remove from it */
524     if (action->comm.rdv)
525       SIMIX_rdv_remove(action->comm.rdv, action);
526
527     XBT_DEBUG("SIMIX_comm_finish: action state = %d", action->state);
528
529     /* Check out for errors */
530     switch (action->state) {
531
532       case SIMIX_DONE:
533         XBT_DEBUG("Communication %p complete!", action);
534         SIMIX_comm_copy_data(action);
535         break;
536
537       case SIMIX_SRC_TIMEOUT:
538         TRY {
539           THROW0(timeout_error, 0, "Communication timeouted because of sender");
540         }
541         CATCH(req->issuer->running_ctx->exception) {
542           req->issuer->doexception = 1;
543         }
544         break;
545
546       case SIMIX_DST_TIMEOUT:
547         TRY {
548           THROW0(timeout_error, 0, "Communication timeouted because of receiver");
549         }
550         CATCH(req->issuer->running_ctx->exception) {
551           req->issuer->doexception = 1;
552         }
553         break;
554
555       case SIMIX_SRC_HOST_FAILURE:
556         TRY {
557           if (req->issuer == action->comm.src_proc)
558             THROW0(host_error, 0, "Host failed");
559           else
560             THROW0(network_error, 0, "Remote peer failed");
561         }
562         CATCH(req->issuer->running_ctx->exception) {
563           req->issuer->doexception = 1;
564         }
565         break;
566
567       case SIMIX_DST_HOST_FAILURE:
568         TRY {
569           if (req->issuer == action->comm.dst_proc)
570             THROW0(host_error, 0, "Host failed");
571           else
572             THROW0(network_error, 0, "Remote peer failed");
573         }
574         CATCH(req->issuer->running_ctx->exception) {
575           req->issuer->doexception = 1;
576         }
577         break;
578
579       case SIMIX_LINK_FAILURE:
580         TRY {
581           XBT_DEBUG("Link failure in action %p between '%s' and '%s': posting an exception to the issuer: %s (%p)",
582               action, action->comm.src_proc->smx_host->name, action->comm.dst_proc->smx_host->name,
583               req->issuer->name, req->issuer);
584           THROW0(network_error, 0, "Link failure");
585         }
586         CATCH(req->issuer->running_ctx->exception) {
587           req->issuer->doexception = 1;
588         }
589         break;
590
591       default:
592         THROW_IMPOSSIBLE;
593     }
594
595     /* if there is an exception during a waitany or a testany, indicate the position of the failed communication */
596     if (req->issuer->doexception) {
597       if (req->call == REQ_COMM_WAITANY) {
598         req->issuer->running_ctx->exception.value = xbt_dynar_search(req->comm_waitany.comms, &action);
599       }
600       else if (req->call == REQ_COMM_TESTANY) {
601         req->issuer->running_ctx->exception.value = xbt_dynar_search(req->comm_testany.comms, &action);
602       }
603     }
604
605     req->issuer->waiting_action = NULL;
606     SIMIX_request_answer(req);
607     destroy_count++;
608   }
609
610   while (destroy_count-- > 0)
611     SIMIX_comm_destroy(action);
612 }
613
614 void SIMIX_post_comm(smx_action_t action)
615 {
616   /* Update action state */
617   if (action->comm.src_timeout &&
618      surf_workstation_model->action_state_get(action->comm.src_timeout) == SURF_ACTION_DONE)
619      action->state = SIMIX_SRC_TIMEOUT;
620   else if (action->comm.dst_timeout &&
621           surf_workstation_model->action_state_get(action->comm.dst_timeout) == SURF_ACTION_DONE)
622      action->state = SIMIX_DST_TIMEOUT;
623   else if (action->comm.src_timeout &&
624           surf_workstation_model->action_state_get(action->comm.src_timeout) == SURF_ACTION_FAILED)
625      action->state = SIMIX_SRC_HOST_FAILURE;
626   else if (action->comm.dst_timeout &&
627           surf_workstation_model->action_state_get(action->comm.dst_timeout) == SURF_ACTION_FAILED)
628      action->state = SIMIX_DST_HOST_FAILURE;
629   else if (action->comm.surf_comm &&
630           surf_workstation_model->action_state_get(action->comm.surf_comm) == SURF_ACTION_FAILED)
631      action->state = SIMIX_LINK_FAILURE;
632   else
633     action->state = SIMIX_DONE;
634
635   XBT_DEBUG("SIMIX_post_comm: action state = %d", action->state);
636
637   /* After this point the surf actions associated with the simix communicate
638      action are no longer needed, thus we delete them. */
639   SIMIX_comm_destroy_internal_actions(action);
640
641   /* If there are requests associated with the action, then answer them */
642   if (xbt_fifo_size(action->request_list))
643     SIMIX_comm_finish(action);
644 }
645
646 void SIMIX_comm_cancel(smx_action_t action)
647 {
648   /* If the action is a waiting state means that it is still in a rdv */
649   /* so remove from it and delete it */
650   if (action->state == SIMIX_WAITING) {
651     SIMIX_rdv_remove(action->comm.rdv, action);
652     action->state = SIMIX_FAILED;
653   } else {
654     /* When running the MC there are no surf actions */
655     if(!MC_IS_ENABLED)
656       surf_workstation_model->action_cancel(action->comm.surf_comm);
657   }
658 }
659
660 void SIMIX_comm_suspend(smx_action_t action)
661 {
662   /*FIXME: shall we suspend also the timeout actions? */
663   surf_workstation_model->suspend(action->comm.surf_comm);
664 }
665
666 void SIMIX_comm_resume(smx_action_t action)
667 {
668   /*FIXME: check what happen with the timeouts */
669   surf_workstation_model->resume(action->comm.surf_comm);
670 }
671
672
673 /************* Action Getters **************/
674
675 /**
676  *  \brief get the amount remaining from the communication
677  *  \param action The communication
678  */
679 double SIMIX_comm_get_remains(smx_action_t action)
680 {
681   double remains;
682
683   switch (action->state) {
684
685     case SIMIX_RUNNING:
686       remains = surf_workstation_model->get_remains(action->comm.surf_comm);
687       break;
688
689     case SIMIX_WAITING:
690     case SIMIX_READY:
691       remains = 0; /*FIXME: check what should be returned */
692       break;
693
694     default:
695       remains = 0; /*FIXME: is this correct? */
696       break;
697   }
698   return remains;
699 }
700
701 e_smx_state_t SIMIX_comm_get_state(smx_action_t action)
702 {
703   return action->state;
704 }
705
706 /**
707  *  \brief Return the user data associated to the sender of the communication
708  *  \param action The communication
709  *  \return the user data
710  */
711 void* SIMIX_comm_get_src_data(smx_action_t action)
712 {
713   return action->comm.src_data;
714 }
715
716 /**
717  *  \brief Return the user data associated to the receiver of the communication
718  *  \param action The communication
719  *  \return the user data
720  */
721 void* SIMIX_comm_get_dst_data(smx_action_t action)
722 {
723   return action->comm.dst_data;
724 }
725
726 smx_process_t SIMIX_comm_get_src_proc(smx_action_t action)
727 {
728   return action->comm.src_proc;
729 }
730
731 smx_process_t SIMIX_comm_get_dst_proc(smx_action_t action)
732 {
733   return action->comm.dst_proc;
734 }
735
736 #ifdef HAVE_LATENCY_BOUND_TRACKING
737 /**
738  *  \brief verify if communication is latency bounded
739  *  \param comm The communication
740  */
741 XBT_INLINE int SIMIX_comm_is_latency_bounded(smx_action_t action)
742 {
743   if (action->comm.surf_comm){
744       XBT_DEBUG("Getting latency limited for surf_action (%p)", action->comm.surf_comm);
745       action->latency_limited = surf_workstation_model->get_latency_limited(action->comm.surf_comm);
746       XBT_DEBUG("Action limited is %d", action->latency_limited);
747   }
748   return action->latency_limited;
749 }
750 #endif
751
752 /******************************************************************************/
753 /*                    SIMIX_comm_copy_data callbacks                       */
754 /******************************************************************************/
755 static void (*SIMIX_comm_copy_data_callback) (smx_action_t, size_t) =
756     &SIMIX_comm_copy_pointer_callback;
757
758 void
759 SIMIX_comm_set_copy_data_callback(void (*callback) (smx_action_t, size_t))
760 {
761   SIMIX_comm_copy_data_callback = callback;
762 }
763
764 void SIMIX_comm_copy_pointer_callback(smx_action_t comm, size_t buff_size)
765 {
766   xbt_assert1((buff_size == sizeof(void *)),
767               "Cannot copy %zu bytes: must be sizeof(void*)", buff_size);
768   *(void **) (comm->comm.dst_buff) = comm->comm.src_buff;
769 }
770
771 void SIMIX_comm_copy_buffer_callback(smx_action_t comm, size_t buff_size)
772 {
773   memcpy(comm->comm.dst_buff, comm->comm.src_buff, buff_size);
774 }
775
776 /**
777  *  \brief Copy the communication data from the sender's buffer to the receiver's one
778  *  \param comm The communication
779  */
780 void SIMIX_comm_copy_data(smx_action_t comm)
781 {
782   size_t buff_size = comm->comm.src_buff_size;
783   /* If there is no data to be copy then return */
784   if (!comm->comm.src_buff || !comm->comm.dst_buff || comm->comm.copied == 1)
785     return;
786
787   XBT_DEBUG("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)",
788          comm,
789          comm->comm.src_proc->smx_host->name, comm->comm.src_buff,
790          comm->comm.dst_proc->smx_host->name, comm->comm.dst_buff, buff_size);
791
792   /* Copy at most dst_buff_size bytes of the message to receiver's buffer */
793   if (comm->comm.dst_buff_size)
794     buff_size = MIN(buff_size, *(comm->comm.dst_buff_size));
795
796   /* Update the receiver's buffer size to the copied amount */
797   if (comm->comm.dst_buff_size)
798     *comm->comm.dst_buff_size = buff_size;
799
800   if (buff_size == 0)
801     return;
802
803   (*SIMIX_comm_copy_data_callback) (comm, buff_size);
804
805   /* Set the copied flag so we copy data only once */
806   /* (this function might be called from both communication ends) */
807   comm->comm.copied = 1;
808 }