src/simix/smx_network.c

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2009 Cristian Rosa.
   4    All rights reserved.                                          */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #include "private.h"
  10 #include "xbt/log.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 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 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   smx_comm_t comm = (smx_comm_t)xbt_fifo_get_item_content(
  78                                   xbt_fifo_get_first_item(rdv->comm_fifo));
  79
  80   if(comm && comm->type == type){
  81     DEBUG0("Communication request found!");
  82     xbt_fifo_shift(rdv->comm_fifo);
  83     SIMIX_communication_use(comm);
  84     comm->rdv = NULL;
  85     return comm;
  86   }
  87
  88   DEBUG0("Communication request not found");
  89   return NULL;
  90 }
  91
  92 /**
  93  *  \brief counts the number of communication requests of a given host pending
  94  *         on a rendez-vous point
  95  *  \param rdv The rendez-vous point
  96  *  \param host The host to be counted
  97  *  \return The number of comm request pending in the rdv
  98  */
  99 int
 100 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)xbt_fifo_get_item_content(xbt_fifo_get_first_item(rdv->comm_fifo));
 122 }
 123
 124 /** @brief adds some API-related data to the rendez-vous point */
 125 XBT_INLINE void SIMIX_rdv_set_data(smx_rdv_t rdv,void *data) {
 126   rdv->data=data;
 127 }
 128 /** @brief gets API-related data from the rendez-vous point */
 129 XBT_INLINE void *SIMIX_rdv_get_data(smx_rdv_t rdv) {
 130   return rdv->data;
 131 }
 132
 133 /******************************************************************************/
 134 /*                           Communication Requests                           */
 135 /******************************************************************************/
 136
 137 /**
 138  *  \brief Creates a new communication request
 139  *  \param type The type of communication (comm_send, comm_recv)
 140  *  \return The new communication request
 141  */
 142 smx_comm_t SIMIX_communication_new(smx_comm_type_t type)
 143 {
 144   /* alloc structures */
 145   smx_comm_t comm = xbt_new0(s_smx_comm_t, 1);
 146   comm->type = type;
 147   comm->sem = SIMIX_sem_init(0);
 148   comm->refcount = 1;
 149
 150   return comm;
 151 }
 152
 153 /**
 154  *  \brief Destroy a communication request
 155  *  \param comm The request to be destroyed
 156  */
 157 void SIMIX_communication_destroy(smx_comm_t comm)
 158 {
 159   comm->refcount--;
 160   if(comm->refcount > 0)
 161     return;
 162
 163   if(comm->sem){
 164     SIMIX_sem_destroy(comm->sem);
 165     comm->sem = NULL;
 166   }
 167
 168   if(comm->act){
 169     SIMIX_action_destroy(comm->act);
 170     comm->act = NULL;
 171   }
 172
 173   if(comm->src_timeout){
 174     SIMIX_action_destroy(comm->src_timeout);
 175     comm->src_timeout = NULL;
 176   }
 177
 178   if(comm->dst_timeout){
 179       SIMIX_action_destroy(comm->dst_timeout);
 180       comm->dst_timeout = NULL;
 181     }
 182
 183   xbt_free(comm);
 184 }
 185
 186 /**
 187  *  \brief Increase the number of users of the communication.
 188  *  \param comm The communication request
 189  *  Each communication request can be used by more than one process, so it is
 190  *  necessary to know number of them at destroy time, to avoid freeing stuff that
 191  *  maybe is in use by others.
 192  *  \
 193  */
 194 static inline void SIMIX_communication_use(smx_comm_t comm)
 195 {
 196   comm->refcount++;
 197 }
 198
 199 /**
 200  *  \brief Start the simulation of a communication request
 201  *  \param comm The   comm->rdv = NULL;communication request
 202  */
 203 static inline void SIMIX_communication_start(smx_comm_t comm)
 204 {
 205   /* If both the sender and the receiver are already there, start the communication */
 206   if(comm->src_proc && comm->dst_proc){
 207     DEBUG1("Starting communication %p", comm);
 208     comm->act = SIMIX_action_communicate(comm->src_proc->smx_host,
 209                                          comm->dst_proc->smx_host, NULL,
 210                                          comm->task_size, comm->rate);
 211
 212     /* If any of the process is suspend, create the action but stop its execution,
 213        it will be restarted when the sender process resume */
 214     if(SIMIX_process_is_suspended(comm->src_proc) ||
 215        SIMIX_process_is_suspended(comm->dst_proc)) {
 216       SIMIX_action_set_priority(comm->act, 0);
 217     }
 218
 219     /* Add the communication as user data of the action */
 220     comm->act->data = comm;
 221
 222     /* The semaphore will only get signaled once, but since the first unlocked guy will
 223      * release_forever() the semaphore, that will unlock the second (and any other)
 224      * communication partner */
 225     SIMIX_register_action_to_semaphore(comm->act, comm->sem);
 226   }
 227 }
 228
 229 /**
 230  *  \brief Waits for communication completion and performs error checking
 231  *  \param comm The communication
 232  *  \param timeout The max amount of time to wait for the communication to finish
 233  *
 234  *  Throws:
 235  *   - host_error if peer failed
 236  *   - timeout_error if communication reached the timeout specified
 237  *   - network_error if network failed or peer issued a timeout
 238  */
 239 static inline void SIMIX_communication_wait_for_completion(smx_comm_t comm, double timeout)
 240 {
 241   smx_action_t act_sleep = NULL;
 242   int src_timeout = 0;
 243   int dst_timeout = 0;
 244
 245   DEBUG1("Waiting for the completion of communication %p", comm);
 246
 247   if (timeout >= 0) {
 248     act_sleep = SIMIX_action_sleep(SIMIX_host_self(), timeout);
 249                 if(SIMIX_process_self()==comm->src_proc)
 250                         comm->src_timeout = act_sleep;
 251                 else
 252                         comm->dst_timeout = act_sleep;
 253     SIMIX_action_set_name(act_sleep,bprintf("Timeout for comm %p and wait on semaphore %p (max_duration:%f)", comm, comm->sem,timeout));
 254     SIMIX_register_action_to_semaphore(act_sleep, comm->sem);
 255     SIMIX_process_self()->waiting_action = act_sleep;
 256     SIMIX_sem_block_onto(comm->sem);
 257     SIMIX_process_self()->waiting_action = NULL;
 258     SIMIX_unregister_action_to_semaphore(act_sleep, comm->sem);
 259   } else {
 260     SIMIX_sem_acquire(comm->sem);
 261   }
 262
 263   /* Check for timeouts */
 264   if ((src_timeout = ((comm->src_timeout) && (SIMIX_action_get_state(comm->src_timeout) == SURF_ACTION_DONE))) ||
 265       (dst_timeout = ((comm->dst_timeout) && (SIMIX_action_get_state(comm->dst_timeout) == SURF_ACTION_DONE))) ) {
 266                         /* Somebody did a timeout! */
 267     if (src_timeout) DEBUG1("Communication timeout from the src! %p", comm);
 268     if (dst_timeout) DEBUG1("Communication timeout from the dst! %p", comm);
 269
 270     if(comm->act && SIMIX_action_get_state(comm->act) == SURF_ACTION_RUNNING)
 271       SIMIX_communication_cancel(comm);
 272     else if (comm->rdv)
 273       SIMIX_rdv_remove(comm->rdv, comm);
 274
 275     /* Make sure that everyone sleeping on that semaphore is awake, and that nobody will ever block on it */
 276     SIMIX_sem_release_forever(comm->sem);
 277     SIMIX_communication_destroy(comm);
 278
 279     THROW1(timeout_error, 0, "Communication timeouted because of %s",src_timeout?"the source":"the destination");
 280   }
 281
 282   DEBUG1("Communication %p complete! Let's check for errors", comm);
 283
 284   /* Make sure that everyone sleeping on that semaphore is awake, and that nobody will ever block on it */
 285   SIMIX_sem_release_forever(comm->sem);
 286
 287   /* Check for errors other than timeouts (they are catched above) */
 288   if(!SIMIX_host_get_state(SIMIX_host_self())){
 289     if(comm->rdv)
 290       SIMIX_rdv_remove(comm->rdv, comm);
 291     SIMIX_communication_destroy(comm);
 292     THROW0(host_error, 0, "Host failed");
 293   } else if (SIMIX_action_get_state(comm->act) == SURF_ACTION_FAILED){
 294     SIMIX_communication_destroy(comm);
 295     THROW0(network_error, 0, "Link failure");
 296   }
 297   SIMIX_communication_destroy(comm);
 298 }
 299
 300 /**
 301  *  \brief Cancels a communication
 302  *  \brief comm The communication to cancel
 303  */
 304 XBT_INLINE void SIMIX_communication_cancel(smx_comm_t comm)
 305 {
 306   if (comm->act)
 307     SIMIX_action_cancel(comm->act);
 308 }
 309
 310 /**
 311  *  \brief get the amount remaining from the communication
 312  *  \param comm The communication
 313  */
 314 XBT_INLINE double SIMIX_communication_get_remains(smx_comm_t comm)
 315 {
 316   return SIMIX_action_get_remains(comm->act);
 317 }
 318
 319 /******************************************************************************/
 320 /*                    SIMIX_network_copy_data callbacks                       */
 321 /******************************************************************************/
 322 static void (*SIMIX_network_copy_data_callback)(smx_comm_t, size_t) = &SIMIX_network_copy_pointer_callback;
 323
 324 void SIMIX_network_set_copy_data_callback(void (*callback)(smx_comm_t, size_t)) {
 325   SIMIX_network_copy_data_callback = callback;
 326 }
 327
 328 void SIMIX_network_copy_pointer_callback(smx_comm_t comm, size_t buff_size) {
 329   xbt_assert1((buff_size == sizeof(void*)), "Cannot copy %zu bytes: must be sizeof(void*)",buff_size);
 330   *(void**)(comm->dst_buff) = comm->src_buff;
 331 }
 332
 333 void SIMIX_network_copy_buffer_callback(smx_comm_t comm, size_t buff_size) {
 334   memcpy(comm->dst_buff, comm->src_buff, buff_size);
 335 }
 336
 337 /**
 338  *  \brief Copy the communication data from the sender's buffer to the receiver's one
 339  *  \param comm The communication
 340  */
 341 void SIMIX_network_copy_data(smx_comm_t comm)
 342 {
 343   /* If there is no data to be copy then return */
 344   if(!comm->src_buff || !comm->dst_buff)
 345     return;
 346
 347   /* Copy at most dst_buff_size bytes of the message to receiver's buffer */
 348   size_t buff_size = comm->src_buff_size;
 349   if (comm->dst_buff_size)
 350     buff_size = MIN(buff_size,*(comm->dst_buff_size));
 351
 352   /* Update the receiver's buffer size to the copied amount */
 353   if (comm->dst_buff_size)
 354     *comm->dst_buff_size = buff_size;
 355
 356   if(buff_size == 0)
 357     return;
 358   DEBUG6("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)",
 359       comm,
 360       comm->src_proc->smx_host->name, comm->src_buff,
 361       comm->dst_proc->smx_host->name, comm->dst_buff,
 362       buff_size);
 363   (*SIMIX_network_copy_data_callback)(comm, buff_size);
 364 }
 365
 366 /**
 367  *  \brief Return the user data associated to the communication
 368  *  \param comm The communication
 369  *  \return the user data
 370  */
 371 XBT_INLINE void *SIMIX_communication_get_data(smx_comm_t comm)
 372 {
 373   return comm->data;
 374 }
 375
 376 /******************************************************************************/
 377 /*                        Synchronous Communication                           */
 378 /******************************************************************************/
 379 /**
 380  *  \brief Put a send communication request in a rendez-vous point and waits for
 381  *         its completion (blocking)
 382  *  \param rdv The rendez-vous point
 383  *  \param task_size The size of the communication action (for surf simulation)
 384  *  \param rate The rate of the communication action (for surf)
 385  *  \param timeout The timeout used for the waiting the completion
 386  *  \param src_buff The source buffer containing the message to be sent
 387  *  \param src_buff_size The size of the source buffer
 388  *  \param comm_ref The communication object used for the send  (useful if someone else wants to cancel this communication afterward)
 389  *  \param data User data associated to the communication object
 390  *  Throws:
 391  *   - host_error if peer failed
 392  *   - timeout_error if communication reached the timeout specified
 393  *   - network_error if network failed or peer issued a timeout
 394  */
 395 XBT_INLINE void SIMIX_network_send(smx_rdv_t rdv, double task_size, double rate,
 396                         double timeout, void *src_buff, size_t src_buff_size,
 397                         smx_comm_t *comm_ref, void *data)
 398 {
 399   *comm_ref = SIMIX_network_isend(rdv,task_size,rate,src_buff,src_buff_size,data);
 400   SIMIX_network_wait(*comm_ref,timeout);
 401 }
 402
 403 /**
 404  *  \brief Put a receive communication request in a rendez-vous point and waits
 405  *         for its completion (blocking)
 406  *  \param rdv The rendez-vous point
 407  *  \param timeout The timeout used for the waiting the completion
 408  *  \param dst_buff The destination buffer to copy the received message
 409  *  \param src_buff_size The size of the destination buffer
 410  *  \param comm_ref The communication object used for the send (useful if someone else wants to cancel this communication afterward)
 411  *  Throws:
 412  *   - host_error if peer failed
 413  *   - timeout_error if communication reached the timeout specified
 414  *   - network_error if network failed or peer issued a timeout
 415  */
 416 XBT_INLINE void SIMIX_network_recv(smx_rdv_t rdv, double timeout, void *dst_buff,
 417                         size_t *dst_buff_size, smx_comm_t *comm_ref)
 418 {
 419   *comm_ref = SIMIX_network_irecv(rdv,dst_buff,dst_buff_size);
 420   SIMIX_network_wait(*comm_ref,timeout);
 421 }
 422
 423 /******************************************************************************/
 424 /*                        Asynchronous Communication                          */
 425 /******************************************************************************/
 426 smx_comm_t SIMIX_network_isend(smx_rdv_t rdv, double task_size, double rate,
 427     void *src_buff, size_t src_buff_size, void *data)
 428 {
 429   smx_comm_t comm;
 430
 431   /* Look for communication request matching our needs.
 432      If it is not found then create it and push it into the rendez-vous point */
 433   comm = SIMIX_rdv_get_request(rdv, comm_recv);
 434
 435   if(!comm){
 436     comm = SIMIX_communication_new(comm_send);
 437     SIMIX_rdv_push(rdv, comm);
 438   }
 439
 440   /* Setup the communication request */
 441   comm->src_proc = SIMIX_process_self();
 442   comm->task_size = task_size;
 443   comm->rate = rate;
 444   comm->src_buff = src_buff;
 445   comm->src_buff_size = src_buff_size;
 446   comm->data = data;
 447
 448   SIMIX_communication_start(comm);
 449   return comm;
 450 }
 451
 452 smx_comm_t SIMIX_network_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size) {
 453   smx_comm_t comm;
 454
 455   /* Look for communication request matching our needs.
 456      If it is not found then create it and push it into the rendez-vous point */
 457   comm = SIMIX_rdv_get_request(rdv, comm_send);
 458
 459   if(!comm){
 460     comm = SIMIX_communication_new(comm_recv);
 461     SIMIX_rdv_push(rdv, comm);
 462   }
 463
 464   /* Setup communication request */
 465   comm->dst_proc = SIMIX_process_self();
 466   comm->dst_buff = dst_buff;
 467   comm->dst_buff_size = dst_buff_size;
 468
 469   SIMIX_communication_start(comm);
 470   return comm;
 471 }
 472
 473 /** @brief blocks until the communication terminates or the timeout occurs */
 474 XBT_INLINE void SIMIX_network_wait(smx_comm_t comm, double timeout) {
 475   /* Wait for communication completion */
 476   SIMIX_communication_wait_for_completion(comm, timeout);
 477 }
 478
 479 /** @Returns whether the (asynchronous) communication is done yet or not */
 480 XBT_INLINE int SIMIX_network_test(smx_comm_t comm) {
 481   return comm->sem?SIMIX_sem_would_block(comm->sem):0;
 482 }
 483
 484 /** @brief wait for the completion of any communication of a set
 485  *
 486  *  @Returns the rank in the dynar of communication which finished; destroy it after identifying which one it is
 487  */
 488 unsigned int SIMIX_network_waitany(xbt_dynar_t comms) {
 489   xbt_dynar_t sems = xbt_dynar_new(sizeof(smx_sem_t),NULL);
 490   unsigned int cursor, found_comm=-1;
 491   smx_comm_t comm,comm_finished=NULL;
 492
 493   xbt_dynar_foreach(comms,cursor,comm){
 494     xbt_dynar_push(sems,&(comm->sem));
 495   }
 496
 497   DEBUG1("Waiting for the completion of communication set %p", comms);
 498
 499   found_comm = SIMIX_sem_acquire_any(sems);
 500   xbt_assert0(found_comm!=-1,"Cannot find which communication finished");
 501   xbt_dynar_get_cpy(comms,found_comm,&comm_finished);
 502
 503   DEBUG1("Communication %p complete! Let's check for errors", comm_finished);
 504
 505   /* Make sure that everyone sleeping on that semaphore is awake,
 506    * and that nobody will ever block on it */
 507   SIMIX_sem_release_forever(comm_finished->sem);
 508
 509   /* Check for errors */
 510   if(!SIMIX_host_get_state(SIMIX_host_self())){
 511     if(comm_finished->rdv)
 512       SIMIX_rdv_remove(comm_finished->rdv, comm_finished);
 513     SIMIX_communication_destroy(comm_finished);
 514     THROW0(host_error, 0, "Host failed");
 515   } else if (SIMIX_action_get_state(comm_finished->act) == SURF_ACTION_FAILED){
 516     SIMIX_communication_destroy(comm_finished);
 517     THROW0(network_error, 0, "Link failure");
 518   }
 519   SIMIX_communication_destroy(comm_finished);
 520
 521   return found_comm;
 522 }