src/msg/gos.c

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 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/sysdep.h"
   9 #include "mc/mc.h"
  10 #include "xbt/log.h"
  11 #include "mailbox.h"
  12
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg,
  15                                 "Logging specific to MSG (gos)");
  16
  17 /** \ingroup msg_gos_functions
  18  *
  19  * \brief Return the last value returned by a MSG function (except
  20  * MSG_get_errno...).
  21  */
  22 MSG_error_t MSG_get_errno(void)
  23 {
  24   return PROCESS_GET_ERRNO();
  25 }
  26
  27 /** \ingroup msg_gos_functions
  28  * \brief Executes a task and waits for its termination.
  29  *
  30  * This function is used for describing the behavior of an agent. It
  31  * takes only one parameter.
  32  * \param task a #m_task_t to execute on the location on which the
  33  agent is running.
  34  * \return #MSG_FATAL if \a task is not properly initialized and
  35  * #MSG_OK otherwise.
  36  */
  37 MSG_error_t MSG_task_execute(m_task_t task)
  38 {
  39   simdata_task_t simdata = NULL;
  40   simdata_process_t p_simdata;
  41   e_smx_state_t comp_state;
  42   CHECK_HOST();
  43
  44   simdata = task->simdata;
  45
  46   xbt_assert0(simdata->host_nb == 0,
  47               "This is a parallel task. Go to hell.");
  48
  49 #ifdef HAVE_TRACING
  50   TRACE_msg_task_execute_start(task);
  51 #endif
  52
  53   xbt_assert1((!simdata->compute) && (task->simdata->isused == 0),
  54               "This task is executed somewhere else. Go fix your code! %d",
  55               task->simdata->isused);
  56
  57   XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
  58
  59   if (simdata->computation_amount == 0) {
  60 #ifdef HAVE_TRACING
  61     TRACE_msg_task_execute_end(task);
  62 #endif
  63     return MSG_OK;
  64   }
  65   simdata->isused=1;
  66   simdata->compute =
  67       SIMIX_req_host_execute(task->name, SIMIX_host_self(),
  68                            simdata->computation_amount,
  69                            simdata->priority);
  70 #ifdef HAVE_TRACING
  71   SIMIX_req_set_category(simdata->compute, task->category);
  72 #endif
  73
  74   p_simdata = SIMIX_process_self_get_data();
  75   p_simdata->waiting_action = simdata->compute;
  76   comp_state = SIMIX_req_host_execution_wait(simdata->compute);
  77   p_simdata->waiting_action = NULL;
  78
  79   simdata->isused=0;
  80
  81   XBT_DEBUG("Execution task '%s' finished in state %d", task->name, comp_state);
  82   if (comp_state == SIMIX_DONE) {
  83     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
  84     simdata->computation_amount = 0.0;
  85     simdata->comm = NULL;
  86     simdata->compute = NULL;
  87 #ifdef HAVE_TRACING
  88     TRACE_msg_task_execute_end(task);
  89 #endif
  90     MSG_RETURN(MSG_OK);
  91   } else if (SIMIX_req_host_get_state(SIMIX_host_self()) == 0) {
  92     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
  93     simdata->comm = NULL;
  94     simdata->compute = NULL;
  95 #ifdef HAVE_TRACING
  96     TRACE_msg_task_execute_end(task);
  97 #endif
  98     MSG_RETURN(MSG_HOST_FAILURE);
  99   } else {
 100     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
 101     simdata->comm = NULL;
 102     simdata->compute = NULL;
 103 #ifdef HAVE_TRACING
 104     TRACE_msg_task_execute_end(task);
 105 #endif
 106     MSG_RETURN(MSG_TASK_CANCELLED);
 107   }
 108 }
 109
 110 /** \ingroup m_task_management
 111  * \brief Creates a new #m_task_t (a parallel one....).
 112  *
 113  * A constructor for #m_task_t taking six arguments and returning the
 114  corresponding object.
 115  * \param name a name for the object. It is for user-level information
 116  and can be NULL.
 117  * \param host_nb the number of hosts implied in the parallel task.
 118  * \param host_list an array of \p host_nb m_host_t.
 119  * \param computation_amount an array of \p host_nb
 120  doubles. computation_amount[i] is the total number of operations
 121  that have to be performed on host_list[i].
 122  * \param communication_amount an array of \p host_nb* \p host_nb doubles.
 123  * \param data a pointer to any data may want to attach to the new
 124  object.  It is for user-level information and can be NULL. It can
 125  be retrieved with the function \ref MSG_task_get_data.
 126  * \see m_task_t
 127  * \return The new corresponding object.
 128  */
 129 m_task_t
 130 MSG_parallel_task_create(const char *name, int host_nb,
 131                          const m_host_t * host_list,
 132                          double *computation_amount,
 133                          double *communication_amount, void *data)
 134 {
 135   int i;
 136   simdata_task_t simdata = xbt_new0(s_simdata_task_t, 1);
 137   m_task_t task = xbt_new0(s_m_task_t, 1);
 138   task->simdata = simdata;
 139
 140   /* Task structure */
 141   task->name = xbt_strdup(name);
 142   task->data = data;
 143
 144   /* Simulator Data */
 145   simdata->computation_amount = 0;
 146   simdata->message_size = 0;
 147   simdata->compute = NULL;
 148   simdata->comm = NULL;
 149   simdata->rate = -1.0;
 150   simdata->isused = 0;
 151   simdata->sender = NULL;
 152   simdata->receiver = NULL;
 153   simdata->source = NULL;
 154
 155   simdata->host_nb = host_nb;
 156   simdata->host_list = xbt_new0(smx_host_t, host_nb);
 157   simdata->comp_amount = computation_amount;
 158   simdata->comm_amount = communication_amount;
 159
 160   for (i = 0; i < host_nb; i++)
 161     simdata->host_list[i] = host_list[i]->simdata->smx_host;
 162
 163   return task;
 164 }
 165
 166 MSG_error_t MSG_parallel_task_execute(m_task_t task)
 167 {
 168   simdata_task_t simdata = NULL;
 169   e_smx_state_t comp_state;
 170   simdata_process_t p_simdata;
 171   CHECK_HOST();
 172
 173   simdata = task->simdata;
 174   p_simdata = SIMIX_process_self_get_data();
 175
 176   xbt_assert0((!simdata->compute)
 177               && (task->simdata->isused == 0),
 178               "This task is executed somewhere else. Go fix your code!");
 179
 180   xbt_assert0(simdata->host_nb,
 181               "This is not a parallel task. Go to hell.");
 182
 183   XBT_DEBUG("Parallel computing on %s", p_simdata->m_host->name);
 184
 185   simdata->isused=1;
 186
 187   simdata->compute =
 188       SIMIX_req_host_parallel_execute(task->name, simdata->host_nb,
 189                                   simdata->host_list,
 190                                   simdata->comp_amount,
 191                                   simdata->comm_amount, 1.0, -1.0);
 192   XBT_DEBUG("Parallel execution action created: %p", simdata->compute);
 193
 194   p_simdata->waiting_action = simdata->compute;
 195   comp_state = SIMIX_req_host_execution_wait(simdata->compute);
 196   p_simdata->waiting_action = NULL;
 197
 198   XBT_DEBUG("Finished waiting for execution of action %p, state = %d", simdata->compute, comp_state);
 199
 200   simdata->isused=0;
 201
 202   if (comp_state == SIMIX_DONE) {
 203     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
 204     simdata->computation_amount = 0.0;
 205     simdata->comm = NULL;
 206     simdata->compute = NULL;
 207     MSG_RETURN(MSG_OK);
 208   } else if (SIMIX_req_host_get_state(SIMIX_host_self()) == 0) {
 209     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
 210     simdata->comm = NULL;
 211     simdata->compute = NULL;
 212     MSG_RETURN(MSG_HOST_FAILURE);
 213   } else {
 214     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
 215     simdata->comm = NULL;
 216     simdata->compute = NULL;
 217     MSG_RETURN(MSG_TASK_CANCELLED);
 218   }
 219 }
 220
 221
 222 /** \ingroup msg_gos_functions
 223  * \brief Sleep for the specified number of seconds
 224  *
 225  * Makes the current process sleep until \a time seconds have elapsed.
 226  *
 227  * \param nb_sec a number of second
 228  */
 229 MSG_error_t MSG_process_sleep(double nb_sec)
 230 {
 231   e_smx_state_t state;
 232   /*m_process_t proc = MSG_process_self();*/
 233
 234 #ifdef HAVE_TRACING
 235   TRACE_msg_process_sleep_in(MSG_process_self());
 236 #endif
 237
 238   /* create action to sleep */
 239   state = SIMIX_req_process_sleep(nb_sec);
 240
 241   /*proc->simdata->waiting_action = act_sleep;
 242
 243   FIXME: check if not setting the waiting_action breaks something on msg
 244
 245   proc->simdata->waiting_action = NULL;*/
 246
 247   if (state == SIMIX_DONE) {
 248 #ifdef HAVE_TRACING
 249   TRACE_msg_process_sleep_out(MSG_process_self());
 250 #endif
 251     MSG_RETURN(MSG_OK);
 252   } else {
 253 #ifdef HAVE_TRACING
 254     TRACE_msg_process_sleep_out(MSG_process_self());
 255 #endif
 256     MSG_RETURN(MSG_HOST_FAILURE);
 257   }
 258 }
 259
 260 /** \ingroup msg_gos_functions
 261  * \brief Listen on \a channel and waits for receiving a task from \a host.
 262  *
 263  * It takes three parameters.
 264  * \param task a memory location for storing a #m_task_t. It will
 265  hold a task when this function will return. Thus \a task should not
 266  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
 267  those two condition does not hold, there will be a warning message.
 268  * \param channel the channel on which the agent should be
 269  listening. This value has to be >=0 and < than the maximal
 270  number of channels fixed with MSG_set_channel_number().
 271  * \param host the host that is to be watched.
 272  * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
 273  if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
 274  */
 275 MSG_error_t
 276 MSG_task_get_from_host(m_task_t * task, m_channel_t channel, m_host_t host)
 277 {
 278   return MSG_task_get_ext(task, channel, -1, host);
 279 }
 280
 281 /** \ingroup msg_gos_functions
 282  * \brief Listen on a channel and wait for receiving a task.
 283  *
 284  * It takes two parameters.
 285  * \param task a memory location for storing a #m_task_t. It will
 286  hold a task when this function will return. Thus \a task should not
 287  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
 288  those two condition does not hold, there will be a warning message.
 289  * \param channel the channel on which the agent should be
 290  listening. This value has to be >=0 and < than the maximal
 291  number of channels fixed with MSG_set_channel_number().
 292  * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
 293  * if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
 294  */
 295 MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel)
 296 {
 297   return MSG_task_get_with_timeout(task, channel, -1);
 298 }
 299
 300 /** \ingroup msg_gos_functions
 301  * \brief Listen on a channel and wait for receiving a task with a timeout.
 302  *
 303  * It takes three parameters.
 304  * \param task a memory location for storing a #m_task_t. It will
 305  hold a task when this function will return. Thus \a task should not
 306  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
 307  those two condition does not hold, there will be a warning message.
 308  * \param channel the channel on which the agent should be
 309  listening. This value has to be >=0 and < than the maximal
 310  number of channels fixed with MSG_set_channel_number().
 311  * \param max_duration the maximum time to wait for a task before giving
 312  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
 313  will not be modified and will still be
 314  equal to \c NULL when returning.
 315  * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
 316  if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
 317  */
 318 MSG_error_t
 319 MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel,
 320                           double max_duration)
 321 {
 322   return MSG_task_get_ext(task, channel, max_duration, NULL);
 323 }
 324
 325 /** \defgroup msg_gos_functions MSG Operating System Functions
 326  *  \brief This section describes the functions that can be used
 327  *  by an agent for handling some task.
 328  */
 329
 330 MSG_error_t
 331 MSG_task_get_ext(m_task_t * task, m_channel_t channel, double timeout,
 332                  m_host_t host)
 333 {
 334   xbt_assert1((channel >= 0)
 335               && (channel < msg_global->max_channel), "Invalid channel %d",
 336               channel);
 337
 338   return
 339       MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
 340                                (MSG_host_self(), channel), task, host,
 341                                timeout);
 342 }
 343
 344 MSG_error_t
 345 MSG_task_receive_from_host(m_task_t * task, const char *alias,
 346                            m_host_t host)
 347 {
 348   return MSG_task_receive_ext(task, alias, -1, host);
 349 }
 350
 351 MSG_error_t MSG_task_receive(m_task_t * task, const char *alias)
 352 {
 353   return MSG_task_receive_with_timeout(task, alias, -1);
 354 }
 355
 356 MSG_error_t
 357 MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
 358                               double timeout)
 359 {
 360   return MSG_task_receive_ext(task, alias, timeout, NULL);
 361 }
 362
 363 MSG_error_t
 364 MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
 365                      m_host_t host)
 366 {
 367   XBT_DEBUG
 368       ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'",
 369        alias);
 370   return MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task,
 371                                   host, timeout);
 372 }
 373
 374 /** \ingroup msg_gos_functions
 375  * \brief Sends a task on a mailbox.
 376  *
 377  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
 378  * to end the communication.
 379  *
 380  * \param task a #m_task_t to send on another location.
 381  * \param alias name of the mailbox to sent the task to
 382  * \return the msg_comm_t communication created
 383  */
 384 msg_comm_t MSG_task_isend(m_task_t task, const char *alias)
 385 {
 386   return MSG_task_isend_with_matching(task,alias,NULL,NULL);
 387 }
 388 /** \ingroup msg_gos_functions
 389  * \brief Sends a task on a mailbox, with support for matching requests
 390  *
 391  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
 392  * to end the communication.
 393  *
 394  * \param task a #m_task_t to send on another location.
 395  * \param alias name of the mailbox to sent the task to
 396  * \param match_fun boolean function taking the #match_data provided by sender (here), and the one of the receiver (if any) and returning whether they match
 397  * \param match_data user provided data passed to match_fun
 398  * \return the msg_comm_t communication created
 399  */
 400 XBT_INLINE msg_comm_t MSG_task_isend_with_matching(m_task_t task, const char *alias,
 401     int (*match_fun)(void*,void*),
 402     void *match_data)
 403 {
 404   simdata_task_t t_simdata = NULL;
 405   m_process_t process = MSG_process_self();
 406   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
 407
 408   CHECK_HOST();
 409
 410   /* FIXME: these functions are not traceable */
 411
 412   /* Prepare the task to send */
 413   t_simdata = task->simdata;
 414   t_simdata->sender = process;
 415   t_simdata->source = MSG_host_self();
 416
 417   xbt_assert0(t_simdata->isused == 0,
 418               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 419
 420   t_simdata->isused = 1;
 421   msg_global->sent_msg++;
 422
 423   /* Send it by calling SIMIX network layer */
 424   msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
 425   comm->task_sent = task;
 426   comm->task_received = NULL;
 427   comm->status = MSG_OK;
 428   comm->s_comm =
 429     SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
 430                          t_simdata->rate, task, sizeof(void *), match_fun, match_data, 0);
 431   t_simdata->comm = comm->s_comm; /* FIXME: is the field t_simdata->comm still useful? */
 432
 433   return comm;
 434 }
 435
 436 /** \ingroup msg_gos_functions
 437  * \brief Sends a task on a mailbox.
 438  *
 439  * This is a non blocking detached send function.
 440  * Think of it as a best effort send. The communication
 441  * object will be destroyed by the receiver (if any).
 442  *
 443  * \param task a #m_task_t to send on another location.
 444  * \param alias name of the mailbox to sent the task to
 445  * \param cleanup a function to destroy the task if the
 446  * communication fails (if NULL, MSG_task_destroy() will
 447  * be used by default)
 448  */
 449 void MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup)
 450 {
 451   simdata_task_t t_simdata = NULL;
 452   m_process_t process = MSG_process_self();
 453   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
 454
 455   CHECK_HOST();
 456
 457   if (cleanup == NULL) {
 458     cleanup = (void_f_pvoid_t) MSG_task_destroy;
 459   }
 460
 461   /* FIXME: these functions are not traceable */
 462
 463   /* Prepare the task to send */
 464   t_simdata = task->simdata;
 465   t_simdata->sender = process;
 466   t_simdata->source = MSG_host_self();
 467
 468   xbt_assert0(t_simdata->isused == 0,
 469               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 470
 471   t_simdata->isused = 1;
 472   msg_global->sent_msg++;
 473
 474   /* Send it by calling SIMIX network layer */
 475   SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
 476                        t_simdata->rate, task, sizeof(void *), NULL, cleanup, 1);
 477 }
 478
 479 /** \ingroup msg_gos_functions
 480  * \brief Starts listening for receiving a task from an asynchronous communication.
 481  *
 482  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
 483  * to end the communication.
 484  *
 485  * \param task a memory location for storing a #m_task_t.
 486  * \param name of the mailbox to receive the task on
 487  * \return the msg_comm_t communication created
 488  */
 489 msg_comm_t MSG_task_irecv(m_task_t *task, const char *alias)
 490 {
 491   smx_rdv_t rdv = MSG_mailbox_get_by_alias(alias);
 492
 493   CHECK_HOST();
 494
 495   /* FIXME: these functions are not tracable */
 496
 497   /* Sanity check */
 498   xbt_assert0(task, "Null pointer for the task storage");
 499
 500   if (*task)
 501     XBT_CRITICAL
 502         ("MSG_task_get() was asked to write in a non empty task struct.");
 503
 504   /* Try to receive it by calling SIMIX network layer */
 505   msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
 506   comm->task_sent = NULL;
 507   comm->task_received = task;
 508   comm->status = MSG_OK;
 509   comm->s_comm = SIMIX_req_comm_irecv(rdv, task, NULL, NULL, NULL);
 510
 511   return comm;
 512 }
 513
 514 /** \ingroup msg_gos_functions
 515  * \brief Checks whether a communication is done, and if yes, finalizes it.
 516  * \param comm the communication to test
 517  * \return TRUE if the communication is finished
 518  * (but it may have failed, use MSG_comm_get_status() to know its status)
 519  * or FALSE if the communication is not finished yet
 520  * If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
 521  */
 522 int MSG_comm_test(msg_comm_t comm)
 523 {
 524   xbt_ex_t e;
 525   int finished = 0;
 526   TRY {
 527     finished = SIMIX_req_comm_test(comm->s_comm);
 528   }
 529   CATCH(e) {
 530     switch (e.category) {
 531
 532       case host_error:
 533         comm->status = MSG_HOST_FAILURE;
 534         finished = 1;
 535         break;
 536
 537       case network_error:
 538         comm->status = MSG_TRANSFER_FAILURE;
 539         finished = 1;
 540         break;
 541
 542       case timeout_error:
 543         comm->status = MSG_TIMEOUT;
 544         finished = 1;
 545         break;
 546
 547       default:
 548         RETHROW;
 549     }
 550     xbt_ex_free(e);
 551   }
 552
 553   return finished;
 554 }
 555
 556 /** \ingroup msg_gos_functions
 557  * \brief This function checks if a communication is finished.
 558  * \param comms a vector of communications
 559  * \return the position of the finished communication if any
 560  * (but it may have failed, use MSG_comm_get_status() to know its status),
 561  * or -1 if none is finished
 562  */
 563 int MSG_comm_testany(xbt_dynar_t comms)
 564 {
 565   xbt_ex_t e;
 566   int finished_index = -1;
 567
 568   /* create the equivalent dynar with SIMIX objects */
 569   xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
 570   msg_comm_t comm;
 571   unsigned int cursor;
 572   xbt_dynar_foreach(comms, cursor, comm) {
 573     xbt_dynar_push(s_comms, &comm->s_comm);
 574   }
 575
 576   MSG_error_t status = MSG_OK;
 577   TRY {
 578     finished_index = SIMIX_req_comm_testany(s_comms);
 579   }
 580   CATCH(e) {
 581     switch (e.category) {
 582
 583       case host_error:
 584         finished_index = e.value;
 585         status = MSG_HOST_FAILURE;
 586         break;
 587
 588       case network_error:
 589         finished_index = e.value;
 590         status = MSG_TRANSFER_FAILURE;
 591         break;
 592
 593       case timeout_error:
 594         finished_index = e.value;
 595         status = MSG_TIMEOUT;
 596         break;
 597
 598       default:
 599         RETHROW;
 600     }
 601     xbt_ex_free(e);
 602   }
 603   xbt_dynar_free(&s_comms);
 604
 605   if (finished_index != -1) {
 606     comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
 607     /* the communication is finished */
 608     comm->status = status;
 609   }
 610
 611   return finished_index;
 612 }
 613
 614 /** \ingroup msg_gos_functions
 615  * \brief Destroys a communication.
 616  * \param comm the communication to destroy.
 617  */
 618 void MSG_comm_destroy(msg_comm_t comm)
 619 {
 620   if (comm->task_received != NULL
 621       && *comm->task_received != NULL
 622       && MSG_comm_get_status(comm) == MSG_OK) {
 623     (*comm->task_received)->simdata->isused = 0;
 624   }
 625
 626   /* FIXME auto-destroy comms from SIMIX to avoid this request */
 627   /*SIMIX_req_comm_destroy(comm->s_comm);*/
 628   free(comm);
 629 }
 630
 631 /** \ingroup msg_gos_functions
 632  * \brief Wait for the completion of a communication.
 633  *
 634  * It takes two parameters.
 635  * \param comm the communication to wait.
 636  * \param timeout Wait until the communication terminates or the timeout occurs
 637  * \return MSG_error_t
 638  */
 639 MSG_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
 640 {
 641   xbt_ex_t e;
 642   TRY {
 643     SIMIX_req_comm_wait(comm->s_comm, timeout);
 644
 645     if (comm->task_received != NULL) {
 646       /* I am the receiver */
 647       (*comm->task_received)->simdata->isused = 0;
 648     }
 649
 650     /* FIXME: these functions are not traceable */
 651   }
 652   CATCH(e) {
 653     switch (e.category) {
 654     case host_error:
 655       comm->status = MSG_HOST_FAILURE;
 656       break;
 657     case network_error:
 658       comm->status = MSG_TRANSFER_FAILURE;
 659       break;
 660     case timeout_error:
 661       comm->status = MSG_TIMEOUT;
 662       break;
 663     default:
 664       RETHROW;
 665     }
 666     xbt_ex_free(e);
 667   }
 668
 669   return comm->status;
 670 }
 671
 672 /** \ingroup msg_gos_functions
 673 * \brief This function is called by a sender and permit to wait for each communication
 674 *
 675 * \param comm a vector of communication
 676 * \param nb_elem is the size of the comm vector
 677 * \param timeout for each call of MSG_comm_wait
 678 */
 679 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
 680 {
 681   int i = 0;
 682   for (i = 0; i < nb_elem; i++) {
 683     MSG_comm_wait(comm[i], timeout);
 684   }
 685 }
 686
 687 /** \ingroup msg_gos_functions
 688  * \brief This function waits for the first communication finished in a list.
 689  * \param comms a vector of communications
 690  * \return the position of the first finished communication
 691  * (but it may have failed, use MSG_comm_get_status() to know its status)
 692  */
 693 int MSG_comm_waitany(xbt_dynar_t comms)
 694 {
 695   xbt_ex_t e;
 696   int finished_index = -1;
 697
 698   /* create the equivalent dynar with SIMIX objects */
 699   xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
 700   msg_comm_t comm;
 701   unsigned int cursor;
 702   xbt_dynar_foreach(comms, cursor, comm) {
 703     xbt_dynar_push(s_comms, &comm->s_comm);
 704   }
 705
 706   MSG_error_t status = MSG_OK;
 707   TRY {
 708     finished_index = SIMIX_req_comm_waitany(s_comms);
 709   }
 710   CATCH(e) {
 711     switch (e.category) {
 712
 713       case host_error:
 714         finished_index = e.value;
 715         status = MSG_HOST_FAILURE;
 716         break;
 717
 718       case network_error:
 719         finished_index = e.value;
 720         status = MSG_TRANSFER_FAILURE;
 721         break;
 722
 723       case timeout_error:
 724         finished_index = e.value;
 725         status = MSG_TIMEOUT;
 726         break;
 727
 728       default:
 729         RETHROW;
 730     }
 731     xbt_ex_free(e);
 732   }
 733
 734   xbt_assert0(finished_index != -1, "WaitAny returned -1");
 735   xbt_dynar_free(&s_comms);
 736
 737   comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
 738   /* the communication is finished */
 739   comm->status = status;
 740
 741   return finished_index;
 742 }
 743
 744 /**
 745  * \ingroup msg_gos_functions
 746  * \brief Returns the error (if any) that occured during a finished communication.
 747  * \param comm a finished communication
 748  * \return the status of the communication, or MSG_OK if no error occured
 749  * during the communication
 750  */
 751 MSG_error_t MSG_comm_get_status(msg_comm_t comm) {
 752
 753   return comm->status;
 754 }
 755
 756 m_task_t MSG_comm_get_task(msg_comm_t comm)
 757 {
 758   xbt_assert0(comm, "Invalid parameter");
 759
 760   return comm->task_received ? *comm->task_received : comm->task_sent;
 761 }
 762
 763 /** \ingroup msg_gos_functions
 764  * \brief Put a task on a channel of an host and waits for the end of the
 765  * transmission.
 766  *
 767  * This function is used for describing the behavior of an agent. It
 768  * takes three parameter.
 769  * \param task a #m_task_t to send on another location. This task
 770  will not be usable anymore when the function will return. There is
 771  no automatic task duplication and you have to save your parameters
 772  before calling this function. Tasks are unique and once it has been
 773  sent to another location, you should not access it anymore. You do
 774  not need to call MSG_task_destroy() but to avoid using, as an
 775  effect of inattention, this task anymore, you definitely should
 776  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
 777  can be transfered iff it has been correctly created with
 778  MSG_task_create().
 779  * \param dest the destination of the message
 780  * \param channel the channel on which the agent should put this
 781  task. This value has to be >=0 and < than the maximal number of
 782  channels fixed with MSG_set_channel_number().
 783  * \return #MSG_FATAL if \a task is not properly initialized and
 784  * #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which
 785  * this function was called was shut down. Returns
 786  * #MSG_TRANSFER_FAILURE if the transfer could not be properly done
 787  * (network failure, dest failure)
 788  */
 789 MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel)
 790 {
 791   return MSG_task_put_with_timeout(task, dest, channel, -1.0);
 792 }
 793
 794 /** \ingroup msg_gos_functions
 795  * \brief Does exactly the same as MSG_task_put but with a bounded transmition
 796  * rate.
 797  *
 798  * \sa MSG_task_put
 799  */
 800 MSG_error_t
 801 MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel,
 802                      double maxrate)
 803 {
 804   task->simdata->rate = maxrate;
 805   return MSG_task_put(task, dest, channel);
 806 }
 807
 808 /** \ingroup msg_gos_functions \brief Put a task on a channel of an
 809  * host (with a timeout on the waiting of the destination host) and
 810  * waits for the end of the transmission.
 811  *
 812  * This function is used for describing the behavior of an agent. It
 813  * takes four parameter.
 814  * \param task a #m_task_t to send on another location. This task
 815  will not be usable anymore when the function will return. There is
 816  no automatic task duplication and you have to save your parameters
 817  before calling this function. Tasks are unique and once it has been
 818  sent to another location, you should not access it anymore. You do
 819  not need to call MSG_task_destroy() but to avoid using, as an
 820  effect of inattention, this task anymore, you definitely should
 821  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
 822  can be transfered iff it has been correctly created with
 823  MSG_task_create().
 824  * \param dest the destination of the message
 825  * \param channel the channel on which the agent should put this
 826  task. This value has to be >=0 and < than the maximal number of
 827  channels fixed with MSG_set_channel_number().
 828  * \param timeout the maximum time to wait for a task before giving
 829  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
 830  will not be modified
 831  * \return #MSG_FATAL if \a task is not properly initialized and
 832 #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which
 833 this function was called was shut down. Returns
 834 #MSG_TRANSFER_FAILURE if the transfer could not be properly done
 835 (network failure, dest failure, timeout...)
 836  */
 837 MSG_error_t
 838 MSG_task_put_with_timeout(m_task_t task, m_host_t dest,
 839                           m_channel_t channel, double timeout)
 840 {
 841   xbt_assert1((channel >= 0)
 842               && (channel < msg_global->max_channel), "Invalid channel %d",
 843               channel);
 844
 845   XBT_DEBUG("MSG_task_put_with_timout: Trying to send a task to '%s'", dest->name);
 846   return
 847       MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel
 848                                    (dest, channel), task, timeout);
 849 }
 850
 851 MSG_error_t MSG_task_send(m_task_t task, const char *alias)
 852 {
 853   XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
 854   return MSG_task_send_with_timeout(task, alias, -1);
 855 }
 856
 857
 858 MSG_error_t
 859 MSG_task_send_bounded(m_task_t task, const char *alias, double maxrate)
 860 {
 861   task->simdata->rate = maxrate;
 862   return MSG_task_send(task, alias);
 863 }
 864
 865
 866 MSG_error_t
 867 MSG_task_send_with_timeout(m_task_t task, const char *alias,
 868                            double timeout)
 869 {
 870   return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
 871                                       task, timeout);
 872 }
 873
 874 int MSG_task_listen(const char *alias)
 875 {
 876   CHECK_HOST();
 877
 878   return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
 879 }
 880
 881 /** \ingroup msg_gos_functions
 882  * \brief Test whether there is a pending communication on a channel.
 883  *
 884  * It takes one parameter.
 885  * \param channel the channel on which the agent should be
 886  listening. This value has to be >=0 and < than the maximal
 887  number of channels fixed with MSG_set_channel_number().
 888  * \return 1 if there is a pending communication and 0 otherwise
 889  */
 890 int MSG_task_Iprobe(m_channel_t channel)
 891 {
 892   xbt_assert1((channel >= 0)
 893               && (channel < msg_global->max_channel), "Invalid channel %d",
 894               channel);
 895
 896   CHECK_HOST();
 897
 898   return
 899       !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
 900                             (MSG_host_self(), channel));
 901 }
 902
 903 /** \ingroup msg_gos_functions
 904
 905  * \brief Return the number of tasks waiting to be received on a \a
 906  channel and sent by \a host.
 907  *
 908  * It takes two parameters.
 909  * \param channel the channel on which the agent should be
 910  listening. This value has to be >=0 and < than the maximal
 911  number of channels fixed with MSG_set_channel_number().
 912  * \param host the host that is to be watched.
 913  * \return the number of tasks waiting to be received on \a channel
 914  and sent by \a host.
 915  */
 916 int MSG_task_probe_from_host(int channel, m_host_t host)
 917 {
 918   xbt_assert1((channel >= 0)
 919               && (channel < msg_global->max_channel), "Invalid channel %d",
 920               channel);
 921
 922   CHECK_HOST();
 923
 924   return
 925       MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
 926                                                (MSG_host_self(), channel),
 927                                                host);
 928
 929 }
 930
 931 int MSG_task_listen_from_host(const char *alias, m_host_t host)
 932 {
 933   CHECK_HOST();
 934
 935   return
 936       MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
 937                                                (alias), host);
 938 }
 939
 940 /** \ingroup msg_gos_functions
 941  * \brief Test whether there is a pending communication on a channel, and who sent it.
 942  *
 943  * It takes one parameter.
 944  * \param channel the channel on which the agent should be
 945  listening. This value has to be >=0 and < than the maximal
 946  number of channels fixed with MSG_set_channel_number().
 947  * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
 948  */
 949 int MSG_task_probe_from(m_channel_t channel)
 950 {
 951   m_task_t task;
 952
 953   CHECK_HOST();
 954
 955   xbt_assert1((channel >= 0)
 956               && (channel < msg_global->max_channel), "Invalid channel %d",
 957               channel);
 958
 959   if (NULL ==
 960       (task =
 961        MSG_mailbox_get_head(MSG_mailbox_get_by_channel
 962                             (MSG_host_self(), channel))))
 963     return -1;
 964
 965   return MSG_process_get_PID(task->simdata->sender);
 966 }
 967
 968 int MSG_task_listen_from(const char *alias)
 969 {
 970   m_task_t task;
 971
 972   CHECK_HOST();
 973
 974   if (NULL ==
 975       (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
 976     return -1;
 977
 978   return MSG_process_get_PID(task->simdata->sender);
 979 }