src/msg/msg_gos.c

   1 /* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "msg_private.h"
   7 #include "msg_mailbox.h"
   8 #include "mc/mc.h"
   9 #include "xbt/log.h"
  10 #include "xbt/sysdep.h"
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg,
  13                                 "Logging specific to MSG (gos)");
  14
  15 /** \ingroup msg_task_usage
  16  * \brief Executes a task and waits for its termination.
  17  *
  18  * This function is used for describing the behavior of a process. It
  19  * takes only one parameter.
  20  * \param task a #msg_task_t to execute on the location on which the process is running.
  21  * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
  22  * or #MSG_HOST_FAILURE otherwise
  23  */
  24 msg_error_t MSG_task_execute(msg_task_t task)
  25 {
  26   return MSG_parallel_task_execute(task);
  27 }
  28
  29 /** \ingroup msg_task_usage
  30  * \brief Executes a parallel task and waits for its termination.
  31  *
  32  * \param task a #msg_task_t to execute on the location on which the process is running.
  33  *
  34  * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
  35  * or #MSG_HOST_FAILURE otherwise
  36  */
  37 msg_error_t MSG_parallel_task_execute(msg_task_t task)
  38 {
  39   xbt_ex_t e;
  40   simdata_task_t simdata = task->simdata;
  41   msg_process_t self = SIMIX_process_self();
  42   simdata_process_t p_simdata = SIMIX_process_self_get_data(self);
  43   e_smx_state_t comp_state;
  44   msg_error_t status = MSG_OK;
  45
  46 #ifdef HAVE_TRACING
  47   TRACE_msg_task_execute_start(task);
  48 #endif
  49
  50   xbt_assert((!simdata->compute) && (task->simdata->isused == 0),
  51              "This task is executed somewhere else. Go fix your code! %d",
  52              task->simdata->isused);
  53
  54   XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
  55
  56   if (simdata->computation_amount == 0 && !simdata->host_nb) {
  57 #ifdef HAVE_TRACING
  58     TRACE_msg_task_execute_end(task);
  59 #endif
  60     return MSG_OK;
  61   }
  62
  63
  64   TRY {
  65
  66     simdata->isused=1;
  67
  68     if (simdata->host_nb > 0) {
  69       simdata->compute = simcall_host_parallel_execute(task->name,
  70                                                        simdata->host_nb,
  71                                                        simdata->host_list,
  72                                                        simdata->comp_amount,
  73                                                        simdata->comm_amount,
  74                                                        1.0, -1.0);
  75       XBT_DEBUG("Parallel execution action created: %p", simdata->compute);
  76     } else {
  77       simdata->compute = simcall_host_execute(task->name,
  78                                               p_simdata->m_host->smx_host,
  79                                               simdata->computation_amount,
  80                                               simdata->priority);
  81
  82     }
  83 #ifdef HAVE_TRACING
  84     simcall_set_category(simdata->compute, task->category);
  85 #endif
  86     p_simdata->waiting_action = simdata->compute;
  87     comp_state = simcall_host_execution_wait(simdata->compute);
  88
  89     p_simdata->waiting_action = NULL;
  90
  91     simdata->isused=0;
  92
  93     XBT_DEBUG("Execution task '%s' finished in state %d",
  94               task->name, (int)comp_state);
  95   }
  96   CATCH(e) {
  97     switch (e.category) {
  98     case cancel_error:
  99       status = MSG_TASK_CANCELED;
 100       break;
 101     default:
 102       RETHROW;
 103     }
 104     xbt_ex_free(e);
 105   }
 106   /* action ended, set comm and compute = NULL, the actions is already destroyed
 107    * in the main function */
 108   simdata->computation_amount = 0.0;
 109   simdata->comm = NULL;
 110   simdata->compute = NULL;
 111 #ifdef HAVE_TRACING
 112   TRACE_msg_task_execute_end(task);
 113 #endif
 114
 115   MSG_RETURN(status);
 116 }
 117
 118
 119 /** \ingroup msg_task_usage
 120  * \brief Sleep for the specified number of seconds
 121  *
 122  * Makes the current process sleep until \a time seconds have elapsed.
 123  *
 124  * \param nb_sec a number of second
 125  */
 126 msg_error_t MSG_process_sleep(double nb_sec)
 127 {
 128   msg_error_t status = MSG_OK;
 129   /*msg_process_t proc = MSG_process_self();*/
 130
 131 #ifdef HAVE_TRACING
 132   TRACE_msg_process_sleep_in(MSG_process_self());
 133 #endif
 134
 135   /* create action to sleep */
 136
 137   /*proc->simdata->waiting_action = act_sleep;
 138
 139   FIXME: check if not setting the waiting_action breaks something on msg
 140
 141   proc->simdata->waiting_action = NULL;*/
 142
 143   simcall_process_sleep(nb_sec);
 144
 145   #ifdef HAVE_TRACING
 146     TRACE_msg_process_sleep_out(MSG_process_self());
 147   #endif
 148   MSG_RETURN(status);
 149 }
 150
 151 /** \ingroup msg_task_usage
 152  * \brief Deprecated function that used to receive a task from a mailbox from a specific host.
 153  *
 154  * Sorry, this function is not supported anymore. That wouldn't be
 155  * impossible to reimplement it, but we are lacking the time to do so ourselves.
 156  * If you need this functionality, you can either:
 157  *
 158  *  - implement the buffering mechanism on the user-level by queuing all messages
 159  *    received in the mailbox that do not match your expectation
 160  *  - change your application logic to leverage the mailboxes features. For example,
 161  *    if you have A receiving messages from B and C, you could have A waiting on
 162  *    mailbox "A" most of the time, but on "A#B" when it's waiting for specific
 163  *    messages from B and "A#C" when waiting for messages from C. You could even get A
 164  *    sometime waiting on all these mailboxes using @ref MSG_comm_waitany. You can find
 165  *    an example of use of this function in the @ref MSG_examples section.
 166  *  - Provide a proper patch to implement this functionality back in MSG. That wouldn't be
 167  *    very difficult actually. Check the function @ref MSG_mailbox_get_task_ext. During its call to
 168  *    simcall_comm_recv(), the 5th argument, match_fun, is NULL. Create a function that filters
 169  *    messages according to the host (that you will pass as sixth argument to simcall_comm_recv()
 170  *    and that your filtering function will receive as first parameter, and then, the filter could
 171  *    simply compare the host names, for example. After sufficient testing, provide an example that
 172  *    we could add to the distribution, and your first contribution to SimGrid is ready. Thanks in advance.
 173  *
 174  * \param task a memory location for storing a #msg_task_t.
 175  * \param alias name of the mailbox to receive the task from
 176  * \param host a #msg_host_t host from where the task was sent
 177  *
 178  * \return Returns
 179  * #MSG_OK if the task was successfully received,
 180  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
 181  */
 182 msg_error_t
 183 MSG_task_receive_from_host(msg_task_t * task, const char *alias,
 184                            msg_host_t host)
 185 {
 186   return MSG_task_receive_ext(task, alias, -1, host);
 187 }
 188
 189 /** \ingroup msg_task_usage
 190  * \brief Receives a task from a mailbox.
 191  *
 192  * This is a blocking function, the execution flow will be blocked
 193  * until the task is received. See #MSG_task_irecv
 194  * for receiving tasks asynchronously.
 195  *
 196  * \param task a memory location for storing a #msg_task_t.
 197  * \param alias name of the mailbox to receive the task from
 198  *
 199  * \return Returns
 200  * #MSG_OK if the task was successfully received,
 201  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
 202  */
 203 msg_error_t MSG_task_receive(msg_task_t * task, const char *alias)
 204 {
 205   return MSG_task_receive_with_timeout(task, alias, -1);
 206 }
 207
 208 /** \ingroup msg_task_usage
 209  * \brief Receives a task from a mailbox with a given timeout.
 210  *
 211  * This is a blocking function with a timeout, the execution flow will be blocked
 212  * until the task is received or the timeout is achieved. See #MSG_task_irecv
 213  * for receiving tasks asynchronously.  You can provide a -1 timeout
 214  * to obtain an infinite timeout.
 215  *
 216  * \param task a memory location for storing a #msg_task_t.
 217  * \param alias name of the mailbox to receive the task from
 218  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
 219  *
 220  * \return Returns
 221  * #MSG_OK if the task was successfully received,
 222  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 223  */
 224 msg_error_t
 225 MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
 226                               double timeout)
 227 {
 228   return MSG_task_receive_ext(task, alias, timeout, NULL);
 229 }
 230
 231 /** \ingroup msg_task_usage
 232  * \brief Receives a task from a mailbox from a specific host with a given timeout.
 233  *
 234  * This is a blocking function with a timeout, the execution flow will be blocked
 235  * until the task is received or the timeout is achieved. See #MSG_task_irecv
 236  * for receiving tasks asynchronously. You can provide a -1 timeout
 237  * to obtain an infinite timeout.
 238  *
 239  * \param task a memory location for storing a #msg_task_t.
 240  * \param alias name of the mailbox to receive the task from
 241  * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
 242  * \param host a #msg_host_t host from where the task was sent
 243  *
 244  * \return Returns
 245  * #MSG_OK if the task was successfully received,
 246 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 247  */
 248 msg_error_t
 249 MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
 250                      msg_host_t host)
 251 {
 252   XBT_DEBUG
 253       ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'",
 254        alias);
 255   return MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task,
 256                                   host, timeout);
 257 }
 258
 259 /** \ingroup msg_task_usage
 260  * \brief Sends a task on a mailbox.
 261  *
 262  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
 263  * to end the communication.
 264  *
 265  * \param task a #msg_task_t to send on another location.
 266  * \param alias name of the mailbox to sent the task to
 267  * \return the msg_comm_t communication created
 268  */
 269 msg_comm_t MSG_task_isend(msg_task_t task, const char *alias)
 270 {
 271   return MSG_task_isend_with_matching(task,alias,NULL,NULL);
 272 }
 273
 274 /** \ingroup msg_task_usage
 275  * \brief Sends a task on a mailbox, with support for matching requests
 276  *
 277  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
 278  * to end the communication.
 279  *
 280  * \param task a #msg_task_t to send on another location.
 281  * \param alias name of the mailbox to sent the task to
 282  * \param match_fun boolean function which parameters are:
 283  *        - match_data_provided_here
 284  *        - match_data_provided_by_other_side_if_any
 285  *        - the_smx_action_describing_the_other_side
 286  * \param match_data user provided data passed to match_fun
 287  * \return the msg_comm_t communication created
 288  */
 289 XBT_INLINE msg_comm_t MSG_task_isend_with_matching(msg_task_t task, const char *alias,
 290     int (*match_fun)(void*,void*, smx_action_t),
 291     void *match_data)
 292 {
 293   simdata_task_t t_simdata = NULL;
 294   msg_process_t process = MSG_process_self();
 295   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
 296
 297 #ifdef HAVE_TRACING
 298   int call_end = TRACE_msg_task_put_start(task);
 299 #endif
 300
 301   /* Prepare the task to send */
 302   t_simdata = task->simdata;
 303   t_simdata->sender = process;
 304   t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
 305
 306   xbt_assert(t_simdata->isused == 0,
 307               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 308
 309   t_simdata->isused = 1;
 310   t_simdata->comm = NULL;
 311   msg_global->sent_msg++;
 312
 313   /* Send it by calling SIMIX network layer */
 314   msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
 315   comm->task_sent = task;
 316   comm->task_received = NULL;
 317   comm->status = MSG_OK;
 318   comm->s_comm =
 319     simcall_comm_isend(mailbox, t_simdata->message_size,
 320                          t_simdata->rate, task, sizeof(void *), match_fun, NULL, match_data, 0);
 321   t_simdata->comm = comm->s_comm; /* FIXME: is the field t_simdata->comm still useful? */
 322 #ifdef HAVE_TRACING
 323     if (TRACE_is_enabled()) {
 324       simcall_set_category(comm->s_comm, task->category);
 325     }
 326 #endif
 327
 328 #ifdef HAVE_TRACING
 329   if (call_end)
 330     TRACE_msg_task_put_end();
 331 #endif
 332
 333   return comm;
 334 }
 335
 336 /** \ingroup msg_task_usage
 337  * \brief Sends a task on a mailbox.
 338  *
 339  * This is a non blocking detached send function.
 340  * Think of it as a best effort send. Keep in mind that the third parameter
 341  * is only called if the communication fails. If the communication does work,
 342  * it is responsibility of the receiver code to free anything related to
 343  * the task, as usual. More details on this can be obtained on
 344  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
 345  * in the SimGrid-user mailing list archive.
 346  *
 347  * \param task a #msg_task_t to send on another location.
 348  * \param alias name of the mailbox to sent the task to
 349  * \param cleanup a function to destroy the task if the
 350  * communication fails, e.g. MSG_task_destroy
 351  * (if NULL, no function will be called)
 352  */
 353 void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup)
 354 {
 355   simdata_task_t t_simdata = NULL;
 356   msg_process_t process = MSG_process_self();
 357   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
 358
 359   /* Prepare the task to send */
 360   t_simdata = task->simdata;
 361   t_simdata->sender = process;
 362   t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
 363
 364   xbt_assert(t_simdata->isused == 0,
 365               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 366
 367   t_simdata->isused = 1;
 368   t_simdata->comm = NULL;
 369   msg_global->sent_msg++;
 370
 371 #ifdef HAVE_TRACING
 372   int call_end = TRACE_msg_task_put_start(task);
 373 #endif
 374
 375   /* Send it by calling SIMIX network layer */
 376   smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
 377                        t_simdata->rate, task, sizeof(void *), NULL, cleanup, NULL, 1);
 378   t_simdata->comm = comm;
 379 #ifdef HAVE_TRACING
 380     if (TRACE_is_enabled()) {
 381       simcall_set_category(comm, task->category);
 382     }
 383 #endif
 384
 385 #ifdef HAVE_TRACING
 386   if (call_end)
 387     TRACE_msg_task_put_end();
 388 #endif
 389 }
 390
 391 /** \ingroup msg_task_usage
 392  * \brief Starts listening for receiving a task from an asynchronous communication.
 393  *
 394  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
 395  * to end the communication.
 396  *
 397  * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
 398  * \param name of the mailbox to receive the task on
 399  * \return the msg_comm_t communication created
 400  */
 401 msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name)
 402 {
 403   smx_rdv_t rdv = MSG_mailbox_get_by_alias(name);
 404
 405   /* FIXME: these functions are not traceable */
 406
 407   /* Sanity check */
 408   xbt_assert(task, "Null pointer for the task storage");
 409
 410   if (*task)
 411     XBT_CRITICAL
 412         ("MSG_task_irecv() was asked to write in a non empty task struct.");
 413
 414   /* Try to receive it by calling SIMIX network layer */
 415   msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
 416   comm->task_sent = NULL;
 417   comm->task_received = task;
 418   comm->status = MSG_OK;
 419   comm->s_comm = simcall_comm_irecv(rdv, task, NULL, NULL, NULL);
 420
 421   return comm;
 422 }
 423
 424 /** \ingroup msg_task_usage
 425  * \brief Checks whether a communication is done, and if yes, finalizes it.
 426  * \param comm the communication to test
 427  * \return TRUE if the communication is finished
 428  * (but it may have failed, use MSG_comm_get_status() to know its status)
 429  * or FALSE if the communication is not finished yet
 430  * If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
 431  */
 432 int MSG_comm_test(msg_comm_t comm)
 433 {
 434   xbt_ex_t e;
 435   int finished = 0;
 436
 437   /* Ignore some variables from xbt/ex.h used by exception e for stacks comparison */
 438   if (MC_is_active()){
 439     MC_ignore_stack("e", "MSG_comm_test");
 440     MC_ignore_stack("__ex_cleanup", "MSG_comm_test");
 441     MC_ignore_stack("__ex_mctx_me", "MSG_comm_test");
 442   }
 443
 444   TRY {
 445     finished = simcall_comm_test(comm->s_comm);
 446
 447     if (finished && comm->task_received != NULL) {
 448       /* I am the receiver */
 449       (*comm->task_received)->simdata->isused = 0;
 450     }
 451   }
 452   CATCH(e) {
 453     switch (e.category) {
 454       case network_error:
 455         comm->status = MSG_TRANSFER_FAILURE;
 456         finished = 1;
 457         break;
 458
 459       case timeout_error:
 460         comm->status = MSG_TIMEOUT;
 461         finished = 1;
 462         break;
 463
 464       default:
 465         RETHROW;
 466     }
 467     xbt_ex_free(e);
 468   }
 469
 470   return finished;
 471 }
 472
 473 /** \ingroup msg_task_usage
 474  * \brief This function checks if a communication is finished.
 475  * \param comms a vector of communications
 476  * \return the position of the finished communication if any
 477  * (but it may have failed, use MSG_comm_get_status() to know its status),
 478  * or -1 if none is finished
 479  */
 480 int MSG_comm_testany(xbt_dynar_t comms)
 481 {
 482   xbt_ex_t e;
 483   int finished_index = -1;
 484
 485   /* create the equivalent dynar with SIMIX objects */
 486   xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
 487   msg_comm_t comm;
 488   unsigned int cursor;
 489   xbt_dynar_foreach(comms, cursor, comm) {
 490     xbt_dynar_push(s_comms, &comm->s_comm);
 491   }
 492
 493   msg_error_t status = MSG_OK;
 494   TRY {
 495     finished_index = simcall_comm_testany(s_comms);
 496   }
 497   CATCH(e) {
 498     switch (e.category) {
 499       case network_error:
 500         finished_index = e.value;
 501         status = MSG_TRANSFER_FAILURE;
 502         break;
 503
 504       case timeout_error:
 505         finished_index = e.value;
 506         status = MSG_TIMEOUT;
 507         break;
 508
 509       default:
 510         RETHROW;
 511     }
 512     xbt_ex_free(e);
 513   }
 514   xbt_dynar_free(&s_comms);
 515
 516   if (finished_index != -1) {
 517     comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
 518     /* the communication is finished */
 519     comm->status = status;
 520
 521     if (status == MSG_OK && comm->task_received != NULL) {
 522       /* I am the receiver */
 523       (*comm->task_received)->simdata->isused = 0;
 524     }
 525   }
 526
 527   return finished_index;
 528 }
 529
 530 /** \ingroup msg_task_usage
 531  * \brief Destroys a communication.
 532  * \param comm the communication to destroy.
 533  */
 534 void MSG_comm_destroy(msg_comm_t comm)
 535 {
 536   xbt_free(comm);
 537 }
 538
 539 /** \ingroup msg_task_usage
 540  * \brief Wait for the completion of a communication.
 541  *
 542  * It takes two parameters.
 543  * \param comm the communication to wait.
 544  * \param timeout Wait until the communication terminates or the timeout
 545  * occurs. You can provide a -1 timeout to obtain an infinite timeout.
 546  * \return msg_error_t
 547  */
 548 msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
 549 {
 550   xbt_ex_t e;
 551   TRY {
 552     simcall_comm_wait(comm->s_comm, timeout);
 553
 554     if (comm->task_received != NULL) {
 555       /* I am the receiver */
 556       (*comm->task_received)->simdata->isused = 0;
 557     }
 558
 559     /* FIXME: these functions are not traceable */
 560   }
 561   CATCH(e) {
 562     switch (e.category) {
 563     case network_error:
 564       comm->status = MSG_TRANSFER_FAILURE;
 565       break;
 566     case timeout_error:
 567       comm->status = MSG_TIMEOUT;
 568       break;
 569     default:
 570       RETHROW;
 571     }
 572     xbt_ex_free(e);
 573   }
 574
 575   return comm->status;
 576 }
 577
 578 /** \ingroup msg_task_usage
 579 * \brief This function is called by a sender and permit to wait for each communication
 580 *
 581 * \param comm a vector of communication
 582 * \param nb_elem is the size of the comm vector
 583 * \param timeout for each call of MSG_comm_wait
 584 */
 585 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
 586 {
 587   int i = 0;
 588   for (i = 0; i < nb_elem; i++) {
 589     MSG_comm_wait(comm[i], timeout);
 590   }
 591 }
 592
 593 /** \ingroup msg_task_usage
 594  * \brief This function waits for the first communication finished in a list.
 595  * \param comms a vector of communications
 596  * \return the position of the first finished communication
 597  * (but it may have failed, use MSG_comm_get_status() to know its status)
 598  */
 599 int MSG_comm_waitany(xbt_dynar_t comms)
 600 {
 601   xbt_ex_t e;
 602   int finished_index = -1;
 603
 604   /* create the equivalent dynar with SIMIX objects */
 605   xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
 606   msg_comm_t comm;
 607   unsigned int cursor;
 608   xbt_dynar_foreach(comms, cursor, comm) {
 609     xbt_dynar_push(s_comms, &comm->s_comm);
 610   }
 611
 612   msg_error_t status = MSG_OK;
 613   TRY {
 614     finished_index = simcall_comm_waitany(s_comms);
 615   }
 616   CATCH(e) {
 617     switch (e.category) {
 618       case network_error:
 619         finished_index = e.value;
 620         status = MSG_TRANSFER_FAILURE;
 621         break;
 622
 623       case timeout_error:
 624         finished_index = e.value;
 625         status = MSG_TIMEOUT;
 626         break;
 627
 628       default:
 629         RETHROW;
 630     }
 631     xbt_ex_free(e);
 632   }
 633
 634   xbt_assert(finished_index != -1, "WaitAny returned -1");
 635   xbt_dynar_free(&s_comms);
 636
 637   comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
 638   /* the communication is finished */
 639   comm->status = status;
 640
 641   if (comm->task_received != NULL) {
 642     /* I am the receiver */
 643     (*comm->task_received)->simdata->isused = 0;
 644   }
 645
 646   return finished_index;
 647 }
 648
 649 /**
 650  * \ingroup msg_task_usage
 651  * \brief Returns the error (if any) that occured during a finished communication.
 652  * \param comm a finished communication
 653  * \return the status of the communication, or #MSG_OK if no error occured
 654  * during the communication
 655  */
 656 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
 657
 658   return comm->status;
 659 }
 660
 661 /** \ingroup msg_task_usage
 662  * \brief Get a task (#msg_task_t) from a communication
 663  *
 664  * \param comm the communication where to get the task
 665  * \return the task from the communication
 666  */
 667 msg_task_t MSG_comm_get_task(msg_comm_t comm)
 668 {
 669   xbt_assert(comm, "Invalid parameter");
 670
 671   return comm->task_received ? *comm->task_received : comm->task_sent;
 672 }
 673
 674 /**
 675  * \brief This function is called by SIMIX in kernel mode to copy the data of a comm.
 676  * \param comm the comm
 677  * \param buff the data copied
 678  * \param buff_size size of the buffer
 679  */
 680 void MSG_comm_copy_data_from_SIMIX(smx_action_t comm, void* buff, size_t buff_size) {
 681
 682   // copy the task
 683   SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
 684
 685   // notify the user callback if any
 686   if (msg_global->task_copy_callback) {
 687     msg_task_t task = buff;
 688     msg_global->task_copy_callback(task,
 689         simcall_comm_get_src_proc(comm), simcall_comm_get_dst_proc(comm));
 690   }
 691 }
 692
 693 /** \ingroup msg_task_usage
 694  * \brief Sends a task to a mailbox
 695  *
 696  * This is a blocking function, the execution flow will be blocked
 697  * until the task is sent (and received in the other side if #MSG_task_receive is used).
 698  * See #MSG_task_isend for sending tasks asynchronously.
 699  *
 700  * \param task the task to be sent
 701  * \param alias the mailbox name to where the task is sent
 702  *
 703  * \return Returns #MSG_OK if the task was successfully sent,
 704  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
 705  */
 706 msg_error_t MSG_task_send(msg_task_t task, const char *alias)
 707 {
 708   XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
 709   return MSG_task_send_with_timeout(task, alias, -1);
 710 }
 711
 712 /** \ingroup msg_task_usage
 713  * \brief Sends a task to a mailbox with a maximum rate
 714  *
 715  * This is a blocking function, the execution flow will be blocked
 716  * until the task is sent. The maxrate parameter allows the application
 717  * to limit the bandwidth utilization of network links when sending the task.
 718  *
 719  * \param task the task to be sent
 720  * \param alias the mailbox name to where the task is sent
 721  * \param maxrate the maximum communication rate for sending this task
 722  *
 723  * \return Returns #MSG_OK if the task was successfully sent,
 724  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
 725  */
 726 msg_error_t
 727 MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate)
 728 {
 729   task->simdata->rate = maxrate;
 730   return MSG_task_send(task, alias);
 731 }
 732
 733 /** \ingroup msg_task_usage
 734  * \brief Sends a task to a mailbox with a timeout
 735  *
 736  * This is a blocking function, the execution flow will be blocked
 737  * until the task is sent or the timeout is achieved.
 738  *
 739  * \param task the task to be sent
 740  * \param alias the mailbox name to where the task is sent
 741  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
 742  *
 743  * \return Returns #MSG_OK if the task was successfully sent,
 744  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 745  */
 746 msg_error_t
 747 MSG_task_send_with_timeout(msg_task_t task, const char *alias,
 748                            double timeout)
 749 {
 750   return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
 751                                       task, timeout);
 752 }
 753
 754 /** \ingroup msg_task_usage
 755  * \brief Check if there is a communication going on in a mailbox.
 756  *
 757  * \param alias the name of the mailbox to be considered
 758  *
 759  * \return Returns 1 if there is a communication, 0 otherwise
 760  */
 761 int MSG_task_listen(const char *alias)
 762 {
 763   return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
 764 }
 765
 766 /** \ingroup msg_task_usage
 767  * \brief Check the number of communication actions of a given host pending in a mailbox.
 768  *
 769  * \param alias the name of the mailbox to be considered
 770  * \param host the host to check for communication
 771  *
 772  * \return Returns the number of pending communication actions of the host in the
 773  * given mailbox, 0 if there is no pending communication actions.
 774  *
 775  */
 776 int MSG_task_listen_from_host(const char *alias, msg_host_t host)
 777 {
 778   return
 779       MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
 780                                                (alias), host);
 781 }
 782
 783 /** \ingroup msg_task_usage
 784  * \brief Look if there is a communication on a mailbox and return the
 785  * PID of the sender process.
 786  *
 787  * \param alias the name of the mailbox to be considered
 788  *
 789  * \return Returns the PID of sender process,
 790  * -1 if there is no communication in the mailbox.
 791  */
 792 int MSG_task_listen_from(const char *alias)
 793 {
 794   msg_task_t task;
 795
 796   if (NULL ==
 797       (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
 798     return -1;
 799
 800   return MSG_process_get_PID(task->simdata->sender);
 801 }
 802
 803 /** \ingroup msg_task_usage
 804  * \brief Sets the tracing category of a task.
 805  *
 806  * This function should be called after the creation of
 807  * a MSG task, to define the category of that task. The
 808  * first parameter task must contain a task that was
 809  * created with the function #MSG_task_create. The second
 810  * parameter category must contain a category that was
 811  * previously declared with the function #TRACE_category
 812  * (or with #TRACE_category_with_color).
 813  *
 814  * See \ref tracing for details on how to trace
 815  * the (categorized) resource utilization.
 816  *
 817  * \param task the task that is going to be categorized
 818  * \param category the name of the category to be associated to the task
 819  *
 820  * \see MSG_task_get_category, TRACE_category, TRACE_category_with_color
 821  */
 822 void MSG_task_set_category (msg_task_t task, const char *category)
 823 {
 824 #ifdef HAVE_TRACING
 825   TRACE_msg_set_task_category (task, category);
 826 #endif
 827 }
 828
 829 /** \ingroup msg_task_usage
 830  *
 831  * \brief Gets the current tracing category of a task.
 832  *
 833  * \param task the task to be considered
 834  *
 835  * \see MSG_task_set_category
 836  *
 837  * \return Returns the name of the tracing category of the given task, NULL otherwise
 838  */
 839 const char *MSG_task_get_category (msg_task_t task)
 840 {
 841 #ifdef HAVE_TRACING
 842   return task->category;
 843 #else
 844   return NULL;
 845 #endif
 846 }
 847
 848 /**
 849  * \brief Returns the value of a given AS or router property
 850  *
 851  * \param asr the name of a router or AS
 852  * \param name a property name
 853  * \return value of a property (or NULL if property not set)
 854  */
 855 const char *MSG_as_router_get_property_value(const char* asr, const char *name)
 856 {
 857   return xbt_dict_get_or_null(MSG_as_router_get_properties(asr), name);
 858 }
 859
 860 /**
 861  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to
 862  * a the AS or router
 863  *
 864  * \param asr the name of a router or AS
 865  * \return a dict containing the properties
 866  */
 867 xbt_dict_t MSG_as_router_get_properties(const char* asr)
 868 {
 869   return (simcall_asr_get_properties(asr));
 870 }
 871
 872 /**
 873  * \brief Change the value of a given AS or router
 874  *
 875  * \param asr the name of a router or AS
 876  * \param name a property name
 877  * \param value what to change the property to
 878  * \param free_ctn the freeing function to use to kill the value on need
 879  */
 880 void MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn) {
 881   xbt_dict_set(MSG_as_router_get_properties(asr), name, value,free_ctn);
 882 }
 883
 884 #ifdef MSG_USE_DEPRECATED
 885 /** \ingroup msg_deprecated_functions
 886  *
 887  * \brief Return the last value returned by a MSG function (except
 888  * MSG_get_errno...).
 889  */
 890 msg_error_t MSG_get_errno(void)
 891 {
 892   return PROCESS_GET_ERRNO();
 893 }
 894
 895 /** \ingroup msg_deprecated_functions
 896  * \brief Put a task on a channel of an host and waits for the end of the
 897  * transmission.
 898  *
 899  * This function is used for describing the behavior of a process. It
 900  * takes three parameter.
 901  * \param task a #msg_task_t to send on another location. This task
 902  will not be usable anymore when the function will return. There is
 903  no automatic task duplication and you have to save your parameters
 904  before calling this function. Tasks are unique and once it has been
 905  sent to another location, you should not access it anymore. You do
 906  not need to call MSG_task_destroy() but to avoid using, as an
 907  effect of inattention, this task anymore, you definitely should
 908  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
 909  can be transfered iff it has been correctly created with
 910  MSG_task_create().
 911  * \param dest the destination of the message
 912  * \param channel the channel on which the process should put this
 913  task. This value has to be >=0 and < than the maximal number of
 914  channels fixed with MSG_set_channel_number().
 915  * \return #MSG_HOST_FAILURE if the host on which
 916  * this function was called was shut down,
 917  * #MSG_TRANSFER_FAILURE if the transfer could not be properly done
 918  * (network failure, dest failure) or #MSG_OK if it succeeded.
 919  */
 920 msg_error_t MSG_task_put(msg_task_t task, msg_host_t dest, m_channel_t channel)
 921 {
 922   XBT_WARN("DEPRECATED! Now use MSG_task_send");
 923   return MSG_task_put_with_timeout(task, dest, channel, -1.0);
 924 }
 925
 926 /** \ingroup msg_deprecated_functions
 927  * \brief Does exactly the same as MSG_task_put but with a bounded transmition
 928  * rate.
 929  *
 930  * \sa MSG_task_put
 931  */
 932 msg_error_t
 933 MSG_task_put_bounded(msg_task_t task, msg_host_t dest, m_channel_t channel,
 934                      double maxrate)
 935 {
 936   XBT_WARN("DEPRECATED! Now use MSG_task_send_bounded");
 937   task->simdata->rate = maxrate;
 938   return MSG_task_put(task, dest, channel);
 939 }
 940
 941 /** \ingroup msg_deprecated_functions
 942  *
 943  * \brief Put a task on a channel of an
 944  * host (with a timeout on the waiting of the destination host) and
 945  * waits for the end of the transmission.
 946  *
 947  * This function is used for describing the behavior of a process. It
 948  * takes four parameter.
 949  * \param task a #msg_task_t to send on another location. This task
 950  will not be usable anymore when the function will return. There is
 951  no automatic task duplication and you have to save your parameters
 952  before calling this function. Tasks are unique and once it has been
 953  sent to another location, you should not access it anymore. You do
 954  not need to call MSG_task_destroy() but to avoid using, as an
 955  effect of inattention, this task anymore, you definitely should
 956  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
 957  can be transfered iff it has been correctly created with
 958  MSG_task_create().
 959  * \param dest the destination of the message
 960  * \param channel the channel on which the process should put this
 961  task. This value has to be >=0 and < than the maximal number of
 962  channels fixed with MSG_set_channel_number().
 963  * \param timeout the maximum time to wait for a task before giving
 964  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
 965  will not be modified
 966  * \return #MSG_HOST_FAILURE if the host on which
 967 this function was called was shut down,
 968 #MSG_TRANSFER_FAILURE if the transfer could not be properly done
 969 (network failure, dest failure, timeout...) or #MSG_OK if the communication succeeded.
 970  */
 971 msg_error_t
 972 MSG_task_put_with_timeout(msg_task_t task, msg_host_t dest,
 973                           m_channel_t channel, double timeout)
 974 {
 975   XBT_WARN("DEPRECATED! Now use MSG_task_send_with_timeout");
 976   xbt_assert((channel >= 0)
 977               && (channel < msg_global->max_channel), "Invalid channel %d",
 978               channel);
 979
 980   XBT_DEBUG("MSG_task_put_with_timout: Trying to send a task to '%s'", SIMIX_host_get_name(dest->smx_host));
 981   return
 982       MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel
 983                                    (dest, channel), task, timeout);
 984 }
 985
 986 /** \ingroup msg_deprecated_functions
 987  * \brief Test whether there is a pending communication on a channel, and who sent it.
 988  *
 989  * It takes one parameter.
 990  * \param channel the channel on which the process should be
 991  listening. This value has to be >=0 and < than the maximal
 992  number of channels fixed with MSG_set_channel_number().
 993  * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
 994  */
 995 int MSG_task_probe_from(m_channel_t channel)
 996 {
 997   XBT_WARN("DEPRECATED! Now use MSG_task_listen_from");
 998   msg_task_t task;
 999
1000   xbt_assert((channel >= 0)
1001               && (channel < msg_global->max_channel), "Invalid channel %d",
1002               channel);
1003
1004   if (NULL ==
1005       (task =
1006        MSG_mailbox_get_head(MSG_mailbox_get_by_channel
1007                             (MSG_host_self(), channel))))
1008     return -1;
1009
1010   return MSG_process_get_PID(task->simdata->sender);
1011 }
1012
1013 /** \ingroup msg_deprecated_functions
1014  * \brief Test whether there is a pending communication on a channel.
1015  *
1016  * It takes one parameter.
1017  * \param channel the channel on which the process should be
1018  listening. This value has to be >=0 and < than the maximal
1019  number of channels fixed with MSG_set_channel_number().
1020  * \return 1 if there is a pending communication and 0 otherwise
1021  */
1022 int MSG_task_Iprobe(m_channel_t channel)
1023 {
1024   XBT_WARN("DEPRECATED!");
1025   xbt_assert((channel >= 0)
1026               && (channel < msg_global->max_channel), "Invalid channel %d",
1027               channel);
1028
1029   return
1030       !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
1031                             (MSG_host_self(), channel));
1032 }
1033
1034 /** \ingroup msg_deprecated_functions
1035
1036  * \brief Return the number of tasks waiting to be received on a \a
1037  channel and sent by \a host.
1038  *
1039  * It takes two parameters.
1040  * \param channel the channel on which the process should be
1041  listening. This value has to be >=0 and < than the maximal
1042  number of channels fixed with MSG_set_channel_number().
1043  * \param host the host that is to be watched.
1044  * \return the number of tasks waiting to be received on \a channel
1045  and sent by \a host.
1046  */
1047 int MSG_task_probe_from_host(int channel, msg_host_t host)
1048 {
1049   XBT_WARN("DEPRECATED! Now use MSG_task_listen_from_host");
1050   xbt_assert((channel >= 0)
1051               && (channel < msg_global->max_channel), "Invalid channel %d",
1052               channel);
1053
1054   return
1055       MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
1056                                                (MSG_host_self(), channel),
1057                                                host);
1058
1059 }
1060
1061 /** \ingroup msg_deprecated_functions
1062  * \brief Listen on \a channel and waits for receiving a task from \a host.
1063  *
1064  * It takes three parameters.
1065  * \param task a memory location for storing a #msg_task_t. It will
1066  hold a task when this function will return. Thus \a task should not
1067  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1068  those two condition does not hold, there will be a warning message.
1069  * \param channel the channel on which the process should be
1070  listening. This value has to be >=0 and < than the maximal
1071  number of channels fixed with MSG_set_channel_number().
1072  * \param host the host that is to be watched.
1073  * \return a #msg_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1074  */
1075 msg_error_t
1076 MSG_task_get_from_host(msg_task_t * task, m_channel_t channel, msg_host_t host)
1077 {
1078   XBT_WARN("DEPRECATED! Now use MSG_task_receive_from_host");
1079   return MSG_task_get_ext(task, channel, -1, host);
1080 }
1081
1082 /** \ingroup msg_deprecated_functions
1083  * \brief Listen on a channel and wait for receiving a task.
1084  *
1085  * It takes two parameters.
1086  * \param task a memory location for storing a #msg_task_t. It will
1087  hold a task when this function will return. Thus \a task should not
1088  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1089  those two condition does not hold, there will be a warning message.
1090  * \param channel the channel on which the process should be
1091  listening. This value has to be >=0 and < than the maximal
1092  number of channels fixed with MSG_set_channel_number().
1093  * \return a #msg_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1094  */
1095 msg_error_t MSG_task_get(msg_task_t * task, m_channel_t channel)
1096 {
1097   XBT_WARN("DEPRECATED! Now use MSG_task_receive");
1098   return MSG_task_get_with_timeout(task, channel, -1);
1099 }
1100
1101 /** \ingroup msg_deprecated_functions
1102  * \brief Listen on a channel and wait for receiving a task with a timeout.
1103  *
1104  * It takes three parameters.
1105  * \param task a memory location for storing a #msg_task_t. It will
1106  hold a task when this function will return. Thus \a task should not
1107  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1108  those two condition does not hold, there will be a warning message.
1109  * \param channel the channel on which the process should be
1110  listening. This value has to be >=0 and < than the maximal
1111  number of channels fixed with MSG_set_channel_number().
1112  * \param max_duration the maximum time to wait for a task before giving
1113  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
1114  will not be modified and will still be
1115  equal to \c NULL when returning.
1116  * \return a #msg_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1117  */
1118 msg_error_t
1119 MSG_task_get_with_timeout(msg_task_t * task, m_channel_t channel,
1120                           double max_duration)
1121 {
1122   XBT_WARN("DEPRECATED! Now use MSG_task_receive_with_timeout");
1123   return MSG_task_get_ext(task, channel, max_duration, NULL);
1124 }
1125
1126 msg_error_t
1127 MSG_task_get_ext(msg_task_t * task, m_channel_t channel, double timeout,
1128                  msg_host_t host)
1129 {
1130   XBT_WARN("DEPRECATED! Now use MSG_task_receive_ext");
1131   xbt_assert((channel >= 0)
1132               && (channel < msg_global->max_channel), "Invalid channel %d",
1133               channel);
1134
1135   return
1136       MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
1137                                (MSG_host_self(), channel), task, host,
1138                                timeout);
1139 }
1140
1141 #endif