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