src/msg/msg_gos.cpp

   1 /* Copyright (c) 2004-2018. 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 <xbt/ex.hpp>
   7
   8 #include "simgrid/s4u/Mailbox.hpp"
   9 #include "src/instr/instr_private.hpp"
  10 #include "src/kernel/activity/ExecImpl.hpp"
  11 #include "src/msg/msg_private.hpp"
  12 #include "src/simix/smx_private.hpp" /* MSG_task_listen looks inside the rdv directly. Not clean. */
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, "Logging specific to MSG (gos)");
  15
  16 /** \ingroup msg_task_usage
  17  * \brief Executes a task and waits for its termination.
  18  *
  19  * This function is used for describing the behavior of a process. It 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 or #MSG_HOST_FAILURE otherwise
  22  */
  23 msg_error_t MSG_task_execute(msg_task_t task)
  24 {
  25   return MSG_parallel_task_execute(task);
  26 }
  27
  28 /** \ingroup msg_task_usage
  29  * \brief Executes a parallel task and waits for its termination.
  30  *
  31  * \param task a #msg_task_t to execute on the location on which the process is running.
  32  *
  33  * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
  34  * or #MSG_HOST_FAILURE otherwise
  35  */
  36 msg_error_t MSG_parallel_task_execute(msg_task_t task)
  37 {
  38   return MSG_parallel_task_execute_with_timeout(task, -1);
  39 }
  40
  41 msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout)
  42 {
  43   simdata_task_t simdata = task->simdata;
  44   e_smx_state_t comp_state;
  45   msg_error_t status = MSG_OK;
  46
  47   TRACE_msg_task_execute_start(task);
  48
  49   xbt_assert((not simdata->compute) && not task->simdata->isused,
  50              "This task is executed somewhere else. Go fix your code!");
  51
  52   XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
  53
  54   if (simdata->flops_amount <= 0.0 && not simdata->host_nb) {
  55     TRACE_msg_task_execute_end(task);
  56     return MSG_OK;
  57   }
  58
  59   try {
  60     simdata->setUsed();
  61
  62     if (simdata->host_nb > 0) {
  63       simdata->compute =
  64           boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(simcall_execution_parallel_start(
  65               task->name, simdata->host_nb, simdata->host_list, simdata->flops_parallel_amount,
  66               simdata->bytes_parallel_amount, -1.0, timeout));
  67       XBT_DEBUG("Parallel execution action created: %p", simdata->compute.get());
  68     } else {
  69       simdata->compute = boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(
  70           simcall_execution_start(task->name, simdata->flops_amount, simdata->priority, simdata->bound,
  71                                   MSG_process_get_host(MSG_process_self())));
  72     }
  73     simcall_set_category(simdata->compute, task->category);
  74     comp_state = simcall_execution_wait(simdata->compute);
  75
  76     simdata->setNotUsed();
  77
  78     XBT_DEBUG("Execution task '%s' finished in state %d", task->name, (int)comp_state);
  79   }
  80   catch (xbt_ex& e) {
  81     switch (e.category) {
  82     case cancel_error:
  83       status = MSG_TASK_CANCELED;
  84       break;
  85     case host_error:
  86       status = MSG_HOST_FAILURE;
  87       break;
  88     case timeout_error:
  89       status = MSG_TIMEOUT;
  90       break;
  91     default:
  92       throw;
  93     }
  94   }
  95
  96   /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */
  97   simdata->flops_amount = 0.0;
  98   simdata->comm = nullptr;
  99   simdata->compute = nullptr;
 100   TRACE_msg_task_execute_end(task);
 101
 102   return status;
 103 }
 104
 105 /** \ingroup msg_task_usage
 106  * \brief Sleep for the specified number of seconds
 107  *
 108  * Makes the current process sleep until \a time seconds have elapsed.
 109  *
 110  * \param nb_sec a number of second
 111  */
 112 msg_error_t MSG_process_sleep(double nb_sec)
 113 {
 114   msg_error_t status = MSG_OK;
 115
 116   if (TRACE_actor_is_enabled())
 117     simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->push_event("sleep");
 118
 119   try {
 120     simcall_process_sleep(nb_sec);
 121   }
 122   catch(xbt_ex& e) {
 123     if (e.category == cancel_error) {
 124       XBT_DEBUG("According to the JAVA API, a sleep call should only deal with HostFailureException, I'm lost.");
 125       // adsein: MSG_TASK_CANCELED is assigned when someone kills the process that made the sleep, this is not
 126       // correct. For instance, when the node is turned off, the error should be MSG_HOST_FAILURE, which is by the way
 127       // and according to the JAVA document, the only exception that can be triggered by MSG_Process_sleep call.
 128       // To avoid possible impacts in the code, I just raised a host_failure exception for the moment in the JAVA code
 129       // and did not change anythings at the C level.
 130       // See comment in the jmsg_process.c file, function JNIEXPORT void JNICALL Java_org_simgrid_msg_Process_sleep(JNIEnv *env, jclass cls, jlong jmillis, jint jnanos)
 131       status = MSG_TASK_CANCELED;
 132     } else
 133       throw;
 134   }
 135
 136   if (TRACE_actor_is_enabled())
 137     simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->pop_event();
 138
 139   return status;
 140 }
 141
 142 /** \ingroup msg_task_usage
 143  * \brief Receives a task from a mailbox.
 144  *
 145  * This is a blocking function, the execution flow will be blocked until the task is received. See #MSG_task_irecv
 146  * for receiving tasks asynchronously.
 147  *
 148  * \param task a memory location for storing a #msg_task_t.
 149  * \param alias name of the mailbox to receive the task from
 150  *
 151  * \return Returns
 152  * #MSG_OK if the task was successfully received,
 153  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
 154  */
 155 msg_error_t MSG_task_receive(msg_task_t * task, const char *alias)
 156 {
 157   return MSG_task_receive_with_timeout(task, alias, -1);
 158 }
 159
 160 /** \ingroup msg_task_usage
 161  * \brief Receives a task from a mailbox at a given rate.
 162  *
 163  * \param task a memory location for storing a #msg_task_t.
 164  * \param alias name of the mailbox to receive the task from
 165  * \param rate limit the reception to rate bandwidth (byte/sec)
 166  *
 167  * The rate parameter can be used to receive a task with a limited
 168  * bandwidth (smaller than the physical available value). Use
 169  * MSG_task_receive() if you don't limit the rate (or pass -1 as a
 170  * rate value do disable this feature).
 171  *
 172  * \return Returns
 173  * #MSG_OK if the task was successfully received,
 174  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
 175  */
 176 msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, double rate)
 177 {
 178   return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate);
 179 }
 180
 181 /** \ingroup msg_task_usage
 182  * \brief Receives a task from a mailbox with a given timeout.
 183  *
 184  * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
 185  * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously.  You can provide a -1 timeout
 186  * to obtain an infinite timeout.
 187  *
 188  * \param task a memory location for storing a #msg_task_t.
 189  * \param alias name of the mailbox to receive the task from
 190  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
 191  *
 192  * \return Returns
 193  * #MSG_OK if the task was successfully received,
 194  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 195  */
 196 msg_error_t MSG_task_receive_with_timeout(msg_task_t * task, const char *alias, double timeout)
 197 {
 198   return MSG_task_receive_ext(task, alias, timeout, nullptr);
 199 }
 200
 201 /** \ingroup msg_task_usage
 202  * \brief Receives a task from a mailbox with a given timeout and at a given rate.
 203  *
 204  * \param task a memory location for storing a #msg_task_t.
 205  * \param alias name of the mailbox to receive the task from
 206  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
 207  * \param rate limit the reception to rate bandwidth (byte/sec)
 208  *
 209  * The rate parameter can be used to send a task with a limited
 210  * bandwidth (smaller than the physical available value). Use
 211  * MSG_task_receive() if you don't limit the rate (or pass -1 as a
 212  * rate value do disable this feature).
 213  *
 214  * \return Returns
 215  * #MSG_OK if the task was successfully received,
 216  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 217  */
 218 msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, double timeout,double rate)
 219 {
 220   return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, rate);
 221 }
 222
 223 /** \ingroup msg_task_usage
 224  * \brief Receives a task from a mailbox from a specific host with a given timeout.
 225  *
 226  * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
 227  * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
 228  * to obtain an infinite timeout.
 229  *
 230  * \param task a memory location for storing a #msg_task_t.
 231  * \param alias name of the mailbox to receive the task from
 232  * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
 233  * \param host a #msg_host_t host from where the task was sent
 234  *
 235  * \return Returns
 236  * #MSG_OK if the task was successfully received,
 237 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 238  */
 239 msg_error_t MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout, msg_host_t host)
 240 {
 241   XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
 242   return MSG_task_receive_ext_bounded(task, alias, timeout, host, -1.0);
 243 }
 244
 245 /** \ingroup msg_task_usage
 246  * \brief Receives a task from a mailbox from a specific host with a given timeout  and at a given rate.
 247  *
 248  * \param task a memory location for storing a #msg_task_t.
 249  * \param alias name of the mailbox to receive the task from
 250  * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
 251  * \param host a #msg_host_t host from where the task was sent
 252  * \param rate limit the reception to rate bandwidth (byte/sec)
 253  *
 254  * The rate parameter can be used to receive a task with a limited
 255  * bandwidth (smaller than the physical available value). Use
 256  * MSG_task_receive_ext() if you don't limit the rate (or pass -1 as a
 257  * rate value do disable this feature).
 258  *
 259  * \return Returns
 260  * #MSG_OK if the task was successfully received,
 261  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 262  */
 263 msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout, msg_host_t host,
 264                                          double rate)
 265 {
 266   XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
 267   simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias);
 268   msg_error_t ret = MSG_OK;
 269   /* We no longer support getting a task from a specific host */
 270   if (host)
 271     THROW_UNIMPLEMENTED;
 272
 273   TRACE_msg_task_get_start();
 274
 275   /* Sanity check */
 276   xbt_assert(task, "Null pointer for the task storage");
 277
 278   if (*task)
 279     XBT_WARN("Asked to write the received task in a non empty struct -- proceeding.");
 280
 281   /* Try to receive it by calling SIMIX network layer */
 282   try {
 283     simcall_comm_recv(MSG_process_self()->get_impl(), mailbox->get_impl(), task, nullptr, nullptr, nullptr, nullptr,
 284                       timeout, rate);
 285     XBT_DEBUG("Got task %s from %s", (*task)->name, mailbox->get_cname());
 286     (*task)->simdata->setNotUsed();
 287   }
 288   catch (xbt_ex& e) {
 289     switch (e.category) {
 290     case host_error:
 291     case cancel_error:
 292       ret = MSG_HOST_FAILURE;
 293       break;
 294     case network_error:
 295       ret = MSG_TRANSFER_FAILURE;
 296       break;
 297     case timeout_error:
 298       ret = MSG_TIMEOUT;
 299       break;
 300     default:
 301       throw;
 302     }
 303   }
 304
 305   if (ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
 306     TRACE_msg_task_get_end(*task);
 307   }
 308   return ret;
 309 }
 310
 311 /* Internal function used to factorize code between MSG_task_isend(), MSG_task_isend_bounded(), and MSG_task_dsend(). */
 312 static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char* alias,
 313                                                  void_f_pvoid_t cleanup, int detached)
 314 {
 315   simdata_task_t t_simdata = nullptr;
 316   msg_process_t myself = MSG_process_self();
 317   simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias);
 318   TRACE_msg_task_put_start(task);
 319
 320   /* Prepare the task to send */
 321   t_simdata = task->simdata;
 322   t_simdata->sender = myself;
 323   t_simdata->source = MSG_host_self();
 324   t_simdata->setUsed();
 325   t_simdata->comm = nullptr;
 326   msg_global->sent_msg++;
 327
 328   /* Send it by calling SIMIX network layer */
 329   smx_activity_t act =
 330       simcall_comm_isend(myself->get_impl(), mailbox->get_impl(), t_simdata->bytes_amount, t_simdata->rate, task,
 331                          sizeof(void*), nullptr, cleanup, nullptr, nullptr, detached);
 332   t_simdata->comm = boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(act);
 333
 334   msg_comm_t comm = nullptr;
 335   if (not detached) {
 336     comm = new simgrid::msg::Comm(task, nullptr, act);
 337   }
 338
 339   if (TRACE_is_enabled())
 340     simcall_set_category(act, task->category);
 341   TRACE_msg_task_put_end();
 342
 343   return comm;
 344 }
 345
 346 /** \ingroup msg_task_usage
 347  * \brief Sends a task on a mailbox.
 348  *
 349  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
 350  *
 351  * \param task a #msg_task_t to send on another location.
 352  * \param alias name of the mailbox to sent the task to
 353  * \return the msg_comm_t communication created
 354  */
 355 msg_comm_t MSG_task_isend(msg_task_t task, const char *alias)
 356 {
 357   return MSG_task_isend_internal(task, alias, nullptr, 0);
 358 }
 359
 360 /** \ingroup msg_task_usage
 361  * \brief Sends a task on a mailbox with a maximum rate
 362  *
 363  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. The maxrate
 364  * parameter allows the application to limit the bandwidth utilization of network links when sending the task.
 365  *
 366  * \param task a #msg_task_t to send on another location.
 367  * \param alias name of the mailbox to sent the task to
 368  * \param maxrate the maximum communication rate for sending this task (byte/sec).
 369  * \return the msg_comm_t communication created
 370  */
 371 msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate)
 372 {
 373   task->simdata->rate = maxrate;
 374   return MSG_task_isend_internal(task, alias, nullptr, 0);
 375 }
 376
 377 /** \ingroup msg_task_usage
 378  * \brief Sends a task on a mailbox.
 379  *
 380  * This is a non blocking detached send function.
 381  * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
 382  * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
 383  * usual. More details on this can be obtained on
 384  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
 385  * in the SimGrid-user mailing list archive.
 386  *
 387  * \param task a #msg_task_t to send on another location.
 388  * \param alias name of the mailbox to sent the task to
 389  * \param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy
 390  * (if nullptr, no function will be called)
 391  */
 392 void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup)
 393 {
 394   msg_comm_t XBT_ATTRIB_UNUSED comm = MSG_task_isend_internal(task, alias, cleanup, 1);
 395   xbt_assert(comm == nullptr);
 396 }
 397
 398 /** \ingroup msg_task_usage
 399  * \brief Sends a task on a mailbox with a maximal rate.
 400  *
 401  * This is a non blocking detached send function.
 402  * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
 403  * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
 404  * usual. More details on this can be obtained on
 405  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
 406  * in the SimGrid-user mailing list archive.
 407  *
 408  * The rate parameter can be used to send a task with a limited
 409  * bandwidth (smaller than the physical available value). Use
 410  * MSG_task_dsend() if you don't limit the rate (or pass -1 as a rate
 411  * value do disable this feature).
 412  *
 413  * \param task a #msg_task_t to send on another location.
 414  * \param alias name of the mailbox to sent the task to
 415  * \param cleanup a function to destroy the task if the
 416  * communication fails, e.g. MSG_task_destroy
 417  * (if nullptr, no function will be called)
 418  * \param maxrate the maximum communication rate for sending this task (byte/sec)
 419  *
 420  */
 421 void MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate)
 422 {
 423   task->simdata->rate = maxrate;
 424   MSG_task_dsend(task, alias, cleanup);
 425 }
 426
 427 /** \ingroup msg_task_usage
 428  * \brief Starts listening for receiving a task from an asynchronous communication.
 429  *
 430  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
 431  *
 432  * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
 433  * \param name of the mailbox to receive the task on
 434  * \return the msg_comm_t communication created
 435  */
 436 msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name)
 437 {
 438   return MSG_task_irecv_bounded(task, name, -1.0);
 439 }
 440
 441 /** \ingroup msg_task_usage
 442  * \brief Starts listening for receiving a task from an asynchronous communication at a given rate.
 443  *
 444  * The rate parameter can be used to receive a task with a limited
 445  * bandwidth (smaller than the physical available value). Use
 446  * MSG_task_irecv() if you don't limit the rate (or pass -1 as a rate
 447  * value do disable this feature).
 448  *
 449  * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
 450  * \param name of the mailbox to receive the task on
 451  * \param rate limit the bandwidth to the given rate (byte/sec)
 452  * \return the msg_comm_t communication created
 453  */
 454 msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rate)
 455 {
 456   simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(name);
 457
 458   /* FIXME: these functions are not traceable */
 459   /* Sanity check */
 460   xbt_assert(task, "Null pointer for the task storage");
 461
 462   if (*task)
 463     XBT_CRITICAL("MSG_task_irecv() was asked to write in a non empty task struct.");
 464
 465   /* Try to receive it by calling SIMIX network layer */
 466   msg_comm_t comm = new simgrid::msg::Comm(
 467       nullptr, task,
 468       simcall_comm_irecv(SIMIX_process_self(), mbox->get_impl(), task, nullptr, nullptr, nullptr, nullptr, rate));
 469
 470   return comm;
 471 }
 472
 473 /** \ingroup msg_task_usage
 474  * \brief Checks whether a communication is done, and if yes, finalizes it.
 475  * \param comm the communication to test
 476  * \return 'true' if the communication is finished
 477  * (but it may have failed, use MSG_comm_get_status() to know its status)
 478  * or 'false' if the communication is not finished yet
 479  * If the status is 'false', don't forget to use MSG_process_sleep() after the test.
 480  */
 481 int MSG_comm_test(msg_comm_t comm)
 482 {
 483   bool finished = false;
 484
 485   try {
 486     finished = simcall_comm_test(comm->s_comm);
 487     if (finished && comm->task_received != nullptr) {
 488       /* I am the receiver */
 489       (*comm->task_received)->simdata->setNotUsed();
 490     }
 491   }
 492   catch (xbt_ex& e) {
 493     switch (e.category) {
 494       case network_error:
 495         comm->status = MSG_TRANSFER_FAILURE;
 496         finished     = true;
 497         break;
 498       case timeout_error:
 499         comm->status = MSG_TIMEOUT;
 500         finished     = true;
 501         break;
 502       default:
 503         throw;
 504     }
 505   }
 506
 507   return finished;
 508 }
 509
 510 /** \ingroup msg_task_usage
 511  * \brief This function checks if a communication is finished.
 512  * \param comms a vector of communications
 513  * \return the position of the finished communication if any
 514  * (but it may have failed, use MSG_comm_get_status() to know its status),
 515  * or -1 if none is finished
 516  */
 517 int MSG_comm_testany(xbt_dynar_t comms)
 518 {
 519   int finished_index = -1;
 520
 521   /* Create the equivalent array with SIMIX objects: */
 522   std::vector<simgrid::kernel::activity::ActivityImplPtr> s_comms;
 523   s_comms.reserve(xbt_dynar_length(comms));
 524   msg_comm_t comm;
 525   unsigned int cursor;
 526   xbt_dynar_foreach(comms, cursor, comm) {
 527     s_comms.push_back(comm->s_comm);
 528   }
 529
 530   msg_error_t status = MSG_OK;
 531   try {
 532     finished_index = simcall_comm_testany(s_comms.data(), s_comms.size());
 533   }
 534   catch (xbt_ex& e) {
 535     switch (e.category) {
 536       case network_error:
 537         finished_index = e.value;
 538         status = MSG_TRANSFER_FAILURE;
 539         break;
 540       case timeout_error:
 541         finished_index = e.value;
 542         status = MSG_TIMEOUT;
 543         break;
 544       default:
 545         throw;
 546     }
 547   }
 548
 549   if (finished_index != -1) {
 550     comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
 551     /* the communication is finished */
 552     comm->status = status;
 553
 554     if (status == MSG_OK && comm->task_received != nullptr) {
 555       /* I am the receiver */
 556       (*comm->task_received)->simdata->setNotUsed();
 557     }
 558   }
 559
 560   return finished_index;
 561 }
 562
 563 /** \ingroup msg_task_usage
 564  * \brief Destroys a communication.
 565  * \param comm the communication to destroy.
 566  */
 567 void MSG_comm_destroy(msg_comm_t comm)
 568 {
 569   delete comm;
 570 }
 571
 572 /** \ingroup msg_task_usage
 573  * \brief Wait for the completion of a communication.
 574  *
 575  * It takes two parameters.
 576  * \param comm the communication to wait.
 577  * \param timeout Wait until the communication terminates or the timeout occurs.
 578  *                You can provide a -1 timeout to obtain an infinite timeout.
 579  * \return msg_error_t
 580  */
 581 msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
 582 {
 583   try {
 584     simcall_comm_wait(comm->s_comm, timeout);
 585
 586     if (comm->task_received != nullptr) {
 587       /* I am the receiver */
 588       (*comm->task_received)->simdata->setNotUsed();
 589     }
 590
 591     /* FIXME: these functions are not traceable */
 592   }
 593   catch (xbt_ex& e) {
 594     switch (e.category) {
 595     case network_error:
 596       comm->status = MSG_TRANSFER_FAILURE;
 597       break;
 598     case timeout_error:
 599       comm->status = MSG_TIMEOUT;
 600       break;
 601     default:
 602       throw;
 603     }
 604   }
 605
 606   return comm->status;
 607 }
 608
 609 /** \ingroup msg_task_usage
 610 * \brief This function is called by a sender and permit to wait for each communication
 611 *
 612 * \param comm a vector of communication
 613 * \param nb_elem is the size of the comm vector
 614 * \param timeout for each call of MSG_comm_wait
 615 */
 616 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
 617 {
 618   for (int i = 0; i < nb_elem; i++)
 619     MSG_comm_wait(comm[i], timeout);
 620 }
 621
 622 /** \ingroup msg_task_usage
 623  * \brief This function waits for the first communication finished in a list.
 624  * \param comms a vector of communications
 625  * \return the position of the first finished communication
 626  * (but it may have failed, use MSG_comm_get_status() to know its status)
 627  */
 628 int MSG_comm_waitany(xbt_dynar_t comms)
 629 {
 630   int finished_index = -1;
 631
 632   /* create the equivalent dynar with SIMIX objects */
 633   xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_activity_t), [](void*ptr){
 634     intrusive_ptr_release(*(simgrid::kernel::activity::ActivityImpl**)ptr);
 635   });
 636   msg_comm_t comm;
 637   unsigned int cursor;
 638   xbt_dynar_foreach(comms, cursor, comm) {
 639     intrusive_ptr_add_ref(comm->s_comm.get());
 640     xbt_dynar_push_as(s_comms, simgrid::kernel::activity::ActivityImpl*, comm->s_comm.get());
 641   }
 642
 643   msg_error_t status = MSG_OK;
 644   try {
 645     finished_index = simcall_comm_waitany(s_comms, -1);
 646   }
 647   catch(xbt_ex& e) {
 648     switch (e.category) {
 649       case network_error:
 650         finished_index = e.value;
 651         status = MSG_TRANSFER_FAILURE;
 652         break;
 653       case timeout_error:
 654         finished_index = e.value;
 655         status = MSG_TIMEOUT;
 656         break;
 657       default:
 658         throw;
 659     }
 660   }
 661
 662   xbt_assert(finished_index != -1, "WaitAny returned -1");
 663   xbt_dynar_free(&s_comms);
 664
 665   comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
 666   /* the communication is finished */
 667   comm->status = status;
 668
 669   if (comm->task_received != nullptr) {
 670     /* I am the receiver */
 671     (*comm->task_received)->simdata->setNotUsed();
 672   }
 673
 674   return finished_index;
 675 }
 676
 677 /**
 678  * \ingroup msg_task_usage
 679  * \brief Returns the error (if any) that occurred during a finished communication.
 680  * \param comm a finished communication
 681  * \return the status of the communication, or #MSG_OK if no error occurred
 682  * during the communication
 683  */
 684 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
 685
 686   return comm->status;
 687 }
 688
 689 /** \ingroup msg_task_usage
 690  * \brief Get a task (#msg_task_t) from a communication
 691  *
 692  * \param comm the communication where to get the task
 693  * \return the task from the communication
 694  */
 695 msg_task_t MSG_comm_get_task(msg_comm_t comm)
 696 {
 697   xbt_assert(comm, "Invalid parameter");
 698
 699   return comm->task_received ? *comm->task_received : comm->task_sent;
 700 }
 701
 702 /**
 703  * \brief This function is called by SIMIX in kernel mode to copy the data of a comm.
 704  * \param synchro the comm
 705  * \param buff the data copied
 706  * \param buff_size size of the buffer
 707  */
 708 void MSG_comm_copy_data_from_SIMIX(smx_activity_t synchro, void* buff, size_t buff_size)
 709 {
 710   simgrid::kernel::activity::CommImplPtr comm =
 711       boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
 712
 713   SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
 714
 715   // notify the user callback if any
 716   if (msg_global->task_copy_callback) {
 717     msg_task_t task = static_cast<msg_task_t>(buff);
 718     msg_global->task_copy_callback(task, comm->src_proc->ciface(), comm->dst_proc->ciface());
 719   }
 720 }
 721
 722 /** \ingroup msg_task_usage
 723  * \brief Sends a task to a mailbox
 724  *
 725  * This is a blocking function, the execution flow will be blocked until the task is sent (and received on the other
 726  * side if #MSG_task_receive is used).
 727  * See #MSG_task_isend for sending tasks asynchronously.
 728  *
 729  * \param task the task to be sent
 730  * \param alias the mailbox name to where the task is sent
 731  *
 732  * \return Returns #MSG_OK if the task was successfully sent,
 733  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
 734  */
 735 msg_error_t MSG_task_send(msg_task_t task, const char *alias)
 736 {
 737   XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
 738   return MSG_task_send_with_timeout(task, alias, -1);
 739 }
 740
 741 /** \ingroup msg_task_usage
 742  * \brief Sends a task to a mailbox with a maximum rate
 743  *
 744  * This is a blocking function, the execution flow will be blocked until the task is sent. The maxrate parameter allows
 745  * the application to limit the bandwidth utilization of network links when sending the task.
 746  *
 747  * The maxrate parameter can be used to send a task with a limited
 748  * bandwidth (smaller than the physical available value). Use
 749  * MSG_task_send() if you don't limit the rate (or pass -1 as a rate
 750  * value do disable this feature).
 751  *
 752  * \param task the task to be sent
 753  * \param alias the mailbox name to where the task is sent
 754  * \param maxrate the maximum communication rate for sending this task (byte/sec)
 755  *
 756  * \return Returns #MSG_OK if the task was successfully sent,
 757  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
 758  */
 759 msg_error_t MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate)
 760 {
 761   task->simdata->rate = maxrate;
 762   return MSG_task_send(task, alias);
 763 }
 764
 765 /** \ingroup msg_task_usage
 766  * \brief Sends a task to a mailbox with a timeout
 767  *
 768  * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
 769  *
 770  * \param task the task to be sent
 771  * \param alias the mailbox name to where the task is sent
 772  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
 773  *
 774  * \return Returns #MSG_OK if the task was successfully sent,
 775  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 776  */
 777 msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout)
 778 {
 779   msg_error_t ret = MSG_OK;
 780   simdata_task_t t_simdata = nullptr;
 781   msg_process_t process = MSG_process_self();
 782   simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias);
 783
 784   TRACE_msg_task_put_start(task);
 785
 786   /* Prepare the task to send */
 787   t_simdata = task->simdata;
 788   t_simdata->sender = process;
 789   t_simdata->source = MSG_host_self();
 790
 791   t_simdata->setUsed();
 792
 793   t_simdata->comm = nullptr;
 794   msg_global->sent_msg++;
 795
 796   /* Try to send it by calling SIMIX network layer */
 797   try {
 798     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simix call  */
 799     comm = simcall_comm_isend(SIMIX_process_self(), mailbox->get_impl(), t_simdata->bytes_amount, t_simdata->rate, task,
 800                               sizeof(void*), nullptr, nullptr, nullptr, nullptr, 0);
 801     if (TRACE_is_enabled())
 802       simcall_set_category(comm, task->category);
 803     t_simdata->comm = boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(comm);
 804     simcall_comm_wait(comm, timeout);
 805   }
 806   catch (xbt_ex& e) {
 807     switch (e.category) {
 808     case cancel_error:
 809       ret = MSG_HOST_FAILURE;
 810       break;
 811     case network_error:
 812       ret = MSG_TRANSFER_FAILURE;
 813       break;
 814     case timeout_error:
 815       ret = MSG_TIMEOUT;
 816       break;
 817     default:
 818       throw;
 819     }
 820
 821     /* If the send failed, it is not used anymore */
 822     t_simdata->setNotUsed();
 823   }
 824
 825   TRACE_msg_task_put_end();
 826   return ret;
 827 }
 828
 829 /** \ingroup msg_task_usage
 830  * \brief Sends a task to a mailbox with a timeout and with a maximum rate
 831  *
 832  * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
 833  *
 834  * The maxrate parameter can be used to send a task with a limited
 835  * bandwidth (smaller than the physical available value). Use
 836  * MSG_task_send_with_timeout() if you don't limit the rate (or pass -1 as a rate
 837  * value do disable this feature).
 838  *
 839  * \param task the task to be sent
 840  * \param alias the mailbox name to where the task is sent
 841  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
 842  * \param maxrate the maximum communication rate for sending this task (byte/sec)
 843  *
 844  * \return Returns #MSG_OK if the task was successfully sent,
 845  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 846  */
 847 msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate)
 848 {
 849   task->simdata->rate = maxrate;
 850   return MSG_task_send_with_timeout(task, alias, timeout);
 851 }
 852
 853 /** \ingroup msg_task_usage
 854  * \brief Look if there is a communication on a mailbox and return the PID of the sender process.
 855  *
 856  * \param alias the name of the mailbox to be considered
 857  *
 858  * \return Returns the PID of sender process,
 859  * -1 if there is no communication in the mailbox.
 860  */
 861 int MSG_task_listen_from(const char *alias)
 862 {
 863   simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(alias);
 864   simgrid::kernel::activity::CommImplPtr comm =
 865       boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(mbox->front());
 866
 867   if (not comm)
 868     return -1;
 869
 870   return MSG_process_get_PID(static_cast<msg_task_t>(comm->src_buff)->simdata->sender);
 871 }
 872
 873 /** \ingroup msg_task_usage
 874  * \brief Sets the tracing category of a task.
 875  *
 876  * This function should be called after the creation of a MSG task, to define the category of that task. The
 877  * first parameter task must contain a task that was  created with the function #MSG_task_create. The second
 878  * parameter category must contain a category that was previously declared with the function #TRACE_category
 879  * (or with #TRACE_category_with_color).
 880  *
 881  * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
 882  *
 883  * \param task the task that is going to be categorized
 884  * \param category the name of the category to be associated to the task
 885  *
 886  * \see MSG_task_get_category, TRACE_category, TRACE_category_with_color
 887  */
 888 void MSG_task_set_category (msg_task_t task, const char *category)
 889 {
 890   TRACE_msg_set_task_category (task, category);
 891 }
 892
 893 /** \ingroup msg_task_usage
 894  *
 895  * \brief Gets the current tracing category of a task.
 896  *
 897  * \param task the task to be considered
 898  *
 899  * \see MSG_task_set_category
 900  *
 901  * \return Returns the name of the tracing category of the given task, nullptr otherwise
 902  */
 903 const char *MSG_task_get_category (msg_task_t task)
 904 {
 905   return task->category;
 906 }