src/msg/msg_task.cpp

   1 /* Copyright (c) 2004-2019. 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.hpp"
   7 #include "src/instr/instr_private.hpp"
   8 #include <simgrid/s4u/Comm.hpp>
   9 #include <simgrid/s4u/Exec.hpp>
  10 #include <simgrid/s4u/Host.hpp>
  11 #include <simgrid/s4u/Mailbox.hpp>
  12
  13 #include <algorithm>
  14 #include <vector>
  15
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)");
  17
  18 namespace simgrid {
  19 namespace msg {
  20
  21 Task::Task(const std::string& name, double flops_amount, double bytes_amount, void* data)
  22     : name_(name), userdata_(data), flops_amount(flops_amount), bytes_amount(bytes_amount)
  23 {
  24   static std::atomic_ullong counter{0};
  25   id_ = counter++;
  26   if (MC_is_active())
  27     MC_ignore_heap(&(id_), sizeof(id_));
  28 }
  29
  30 Task::Task(const std::string& name, std::vector<s4u::Host*>&& hosts, std::vector<double>&& flops_amount,
  31            std::vector<double>&& bytes_amount, void* data)
  32     : Task(name, 1.0, 0, data)
  33 {
  34   parallel_             = true;
  35   hosts_                = std::move(hosts);
  36   flops_parallel_amount = std::move(flops_amount);
  37   bytes_parallel_amount = std::move(bytes_amount);
  38 }
  39
  40 Task* Task::create(const std::string& name, double flops_amount, double bytes_amount, void* data)
  41 {
  42   return new Task(name, flops_amount, bytes_amount, data);
  43 }
  44
  45 Task* Task::create_parallel(const std::string& name, int host_nb, const msg_host_t* host_list, double* flops_amount,
  46                             double* bytes_amount, void* data)
  47 {
  48   std::vector<simgrid::s4u::Host*> hosts(host_list, host_list + host_nb);
  49   std::vector<double> flops;
  50   std::vector<double> bytes;
  51   if (flops_amount != nullptr)
  52     flops = std::vector<double>(flops_amount, flops_amount + host_nb);
  53   if (bytes_amount != nullptr)
  54     bytes = std::vector<double>(bytes_amount, bytes_amount + host_nb * host_nb);
  55
  56   return new Task(name, std::move(hosts), std::move(flops), std::move(bytes), data);
  57 }
  58
  59 msg_error_t Task::execute()
  60 {
  61   /* checking for infinite values */
  62   xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
  63
  64   msg_error_t status = MSG_OK;
  65   if (flops_amount <= 0.0)
  66     return MSG_OK;
  67
  68   try {
  69     set_used();
  70     if (parallel_)
  71       compute = s4u::this_actor::exec_init(hosts_, flops_parallel_amount, bytes_parallel_amount);
  72     else
  73       compute = s4u::this_actor::exec_init(flops_amount);
  74
  75     compute->set_name(name_)
  76         ->set_tracing_category(tracing_category_)
  77         ->set_timeout(timeout_)
  78         ->set_priority(1 / priority_)
  79         ->set_bound(bound_)
  80         ->wait();
  81
  82     set_not_used();
  83     XBT_DEBUG("Execution task '%s' finished", get_cname());
  84   } catch (const HostFailureException&) {
  85     status = MSG_HOST_FAILURE;
  86   } catch (const TimeoutError&) {
  87     status = MSG_TIMEOUT;
  88   } catch (const CancelException&) {
  89     status = MSG_TASK_CANCELED;
  90   }
  91
  92   /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */
  93   flops_amount = 0.0;
  94   comm         = nullptr;
  95   compute      = nullptr;
  96
  97   return status;
  98 }
  99
 100 s4u::CommPtr Task::send_async(const std::string& alias, void_f_pvoid_t cleanup, bool detached)
 101 {
 102   if (TRACE_actor_is_enabled()) {
 103     container_t process_container = simgrid::instr::Container::by_name(instr_pid(*MSG_process_self()));
 104     std::string key               = std::string("p") + std::to_string(get_id());
 105     simgrid::instr::Container::get_root()->get_link("ACTOR_TASK_LINK")->start_event(process_container, "SR", key);
 106   }
 107
 108   /* Prepare the task to send */
 109   set_used();
 110   this->comm = nullptr;
 111   msg_global->sent_msg++;
 112
 113   s4u::CommPtr s4u_comm = s4u::Mailbox::by_name(alias)->put_init(this, bytes_amount)->set_rate(get_rate());
 114   if (TRACE_is_enabled() && has_tracing_category())
 115     s4u_comm->set_tracing_category(tracing_category_);
 116
 117   comm                  = s4u_comm;
 118
 119   if (detached)
 120     comm->detach(cleanup);
 121   else
 122     comm->start();
 123
 124   return comm;
 125 }
 126
 127 msg_error_t Task::send(const std::string& alias, double timeout)
 128 {
 129   msg_error_t ret = MSG_OK;
 130   /* Try to send it */
 131   try {
 132     comm = nullptr; // needed, otherwise MC gets confused.
 133     s4u::CommPtr s4u_comm = send_async(alias, nullptr, false);
 134     comm                  = s4u_comm;
 135     comm->wait_for(timeout);
 136   } catch (const simgrid::TimeoutError&) {
 137     ret = MSG_TIMEOUT;
 138   } catch (const simgrid::CancelException&) {
 139     ret = MSG_HOST_FAILURE;
 140   } catch (const simgrid::NetworkFailureException&) {
 141     ret = MSG_TRANSFER_FAILURE;
 142     /* If the send failed, it is not used anymore */
 143     set_not_used();
 144   }
 145
 146   return ret;
 147 }
 148 void Task::cancel()
 149 {
 150   if (compute) {
 151     compute->cancel();
 152   } else if (comm) {
 153     comm->cancel();
 154   }
 155   set_not_used();
 156 }
 157
 158 void Task::set_priority(double priority)
 159 {
 160   xbt_assert(std::isfinite(1.0 / priority), "priority is not finite!");
 161   priority_ = 1.0 / priority;
 162 }
 163
 164 s4u::Actor* Task::get_sender()
 165 {
 166   return comm ? comm->get_sender() : nullptr;
 167 }
 168
 169 s4u::Host* Task::get_source()
 170 {
 171   return comm ? comm->get_sender()->get_host() : nullptr;
 172 }
 173
 174 void Task::set_used()
 175 {
 176   if (is_used_)
 177     report_multiple_use();
 178   is_used_ = true;
 179 }
 180
 181 void Task::report_multiple_use() const
 182 {
 183   if (MSG_Global_t::debug_multiple_use) {
 184     XBT_ERROR("This task is already used in there:");
 185     // TODO, backtrace
 186     XBT_ERROR("<missing backtrace>");
 187     XBT_ERROR("And you try to reuse it from here:");
 188     xbt_backtrace_display_current();
 189   } else {
 190     xbt_die("This task is still being used somewhere else. You cannot send it now. Go fix your code!"
 191              "(use --cfg=msg/debug-multiple-use:on to get the backtrace of the other process)");
 192   }
 193 }
 194 } // namespace msg
 195 } // namespace simgrid
 196
 197 /********************************* Task **************************************/
 198 /** @brief Creates a new task
 199  *
 200  * A constructor for msg_task_t taking four arguments.
 201  *
 202  * @param name a name for the object. It is for user-level information and can be nullptr.
 203  * @param flop_amount a value of the processing amount (in flop) needed to process this new task.
 204  * If 0, then it cannot be executed with MSG_task_execute(). This value has to be >=0.
 205  * @param message_size a value of the amount of data (in bytes) needed to transfer this new task. If 0, then it cannot
 206  * be transfered with MSG_task_send() and MSG_task_recv(). This value has to be >=0.
 207  * @param data a pointer to any data may want to attach to the new object.  It is for user-level information and can
 208  * be nullptr. It can be retrieved with the function @ref MSG_task_get_data.
 209  * @return The new corresponding object.
 210  */
 211 msg_task_t MSG_task_create(const char *name, double flop_amount, double message_size, void *data)
 212 {
 213   return simgrid::msg::Task::create(name ? std::string(name) : "", flop_amount, message_size, data);
 214 }
 215
 216 /** @brief Creates a new parallel task
 217  *
 218  * A constructor for #msg_task_t taking six arguments.
 219  *
 220  * \rst
 221  * See :cpp:func:`void simgrid::s4u::this_actor::parallel_execute(int, s4u::Host**, double*, double*)` for
 222  * the exact semantic of the parameters.
 223  * \endrst
 224  *
 225  * @param name a name for the object. It is for user-level information and can be nullptr.
 226  * @param host_nb the number of hosts implied in the parallel task.
 227  * @param host_list an array of @p host_nb msg_host_t.
 228  * @param flops_amount an array of @p host_nb doubles.
 229  *        flops_amount[i] is the total number of operations that have to be performed on host_list[i].
 230  * @param bytes_amount an array of @p host_nb* @p host_nb doubles.
 231  * @param data a pointer to any data may want to attach to the new object.
 232  *             It is for user-level information and can be nullptr.
 233  *             It can be retrieved with the function @ref MSG_task_get_data().
 234  */
 235 msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_host_t * host_list,
 236                                     double *flops_amount, double *bytes_amount, void *data)
 237 {
 238   // Task's flops amount is set to an arbitrary value > 0.0 to be able to distinguish, in
 239   // MSG_task_get_remaining_work_ratio(), a finished task and a task that has not started yet.
 240   return simgrid::msg::Task::create_parallel(name ? name : "", host_nb, host_list, flops_amount, bytes_amount, data);
 241 }
 242
 243 /** @brief Return the user data of the given task */
 244 void* MSG_task_get_data(msg_task_t task)
 245 {
 246   return task->get_user_data();
 247 }
 248
 249 /** @brief Sets the user data of a given task */
 250 void MSG_task_set_data(msg_task_t task, void *data)
 251 {
 252   task->set_user_data(data);
 253 }
 254
 255 /** @brief Sets a function to be called when a task has just been copied.
 256  * @param callback a callback function
 257  */
 258 // deprecated
 259 void MSG_task_set_copy_callback(void (*callback) (msg_task_t task, msg_process_t sender, msg_process_t receiver)) {
 260
 261   msg_global->task_copy_callback = callback;
 262
 263   if (callback) {
 264     SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX);
 265   } else {
 266     SIMIX_comm_set_copy_data_callback(SIMIX_comm_copy_pointer_callback);
 267   }
 268 }
 269
 270 /** @brief Returns the sender of the given task */
 271 msg_process_t MSG_task_get_sender(msg_task_t task)
 272 {
 273   return task->get_sender();
 274 }
 275
 276 /** @brief Returns the source (the sender's host) of the given task */
 277 msg_host_t MSG_task_get_source(msg_task_t task)
 278 {
 279   return task->get_source();
 280 }
 281
 282 /** @brief Returns the name of the given task. */
 283 const char *MSG_task_get_name(msg_task_t task)
 284 {
 285   return task->get_cname();
 286 }
 287
 288 /** @brief Sets the name of the given task. */
 289 void MSG_task_set_name(msg_task_t task, const char *name)
 290 {
 291   task->set_name(name);
 292 }
 293
 294 /**
 295  * @brief Executes a task and waits for its termination.
 296  *
 297  * This function is used for describing the behavior of a process. It takes only one parameter.
 298  * @param task a #msg_task_t to execute on the location on which the process is running.
 299  * @return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise
 300  */
 301 msg_error_t MSG_task_execute(msg_task_t task)
 302 {
 303   return task->execute();
 304 }
 305
 306 /**
 307  * @brief Executes a parallel task and waits for its termination.
 308  *
 309  * @param task a #msg_task_t to execute on the location on which the process is running.
 310  *
 311  * @return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise
 312  */
 313 msg_error_t MSG_parallel_task_execute(msg_task_t task)
 314 {
 315   return task->execute();
 316 }
 317
 318 msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout)
 319 {
 320   task->set_timeout(timeout);
 321   return task->execute();
 322 }
 323
 324 /**
 325  * @brief Sends a task on a mailbox.
 326  *
 327  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
 328  *
 329  * @param task a #msg_task_t to send on another location.
 330  * @param alias name of the mailbox to sent the task to
 331  * @return the msg_comm_t communication created
 332  */
 333 msg_comm_t MSG_task_isend(msg_task_t task, const char* alias)
 334 {
 335   return new simgrid::msg::Comm(task, nullptr, task->send_async(alias, nullptr, false));
 336 }
 337
 338 /**
 339  * @brief Sends a task on a mailbox with a maximum rate
 340  *
 341  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. The maxrate
 342  * parameter allows the application to limit the bandwidth utilization of network links when sending the task.
 343  *
 344  * @param task a #msg_task_t to send on another location.
 345  * @param alias name of the mailbox to sent the task to
 346  * @param maxrate the maximum communication rate for sending this task (byte/sec).
 347  * @return the msg_comm_t communication created
 348  */
 349 msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char* alias, double maxrate)
 350 {
 351   task->set_rate(maxrate);
 352   return new simgrid::msg::Comm(task, nullptr, task->send_async(alias, nullptr, false));
 353 }
 354
 355 /**
 356  * @brief Sends a task on a mailbox.
 357  *
 358  * This is a non blocking detached send function.
 359  * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
 360  * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
 361  * usual. More details on this can be obtained on
 362  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
 363  * in the SimGrid-user mailing list archive.
 364  *
 365  * @param task a #msg_task_t to send on another location.
 366  * @param alias name of the mailbox to sent the task to
 367  * @param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy
 368  * (if nullptr, no function will be called)
 369  */
 370 void MSG_task_dsend(msg_task_t task, const char* alias, void_f_pvoid_t cleanup)
 371 {
 372   task->send_async(alias, cleanup, true);
 373 }
 374
 375 /**
 376  * @brief Sends a task on a mailbox with a maximal rate.
 377  *
 378  * This is a non blocking detached send function.
 379  * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
 380  * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
 381  * usual. More details on this can be obtained on
 382  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
 383  * in the SimGrid-user mailing list archive.
 384  *
 385  * The rate parameter can be used to send a task with a limited bandwidth (smaller than the physical available value).
 386  * Use MSG_task_dsend() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
 387  *
 388  * @param task a #msg_task_t to send on another location.
 389  * @param alias name of the mailbox to sent the task to
 390  * @param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy (if nullptr, no
 391  *        function will be called)
 392  * @param maxrate the maximum communication rate for sending this task (byte/sec)
 393  *
 394  */
 395 void MSG_task_dsend_bounded(msg_task_t task, const char* alias, void_f_pvoid_t cleanup, double maxrate)
 396 {
 397   task->set_rate(maxrate);
 398   task->send_async(alias, cleanup, true);
 399 }
 400 /**
 401  * @brief Sends a task to a mailbox
 402  *
 403  * This is a blocking function, the execution flow will be blocked until the task is sent (and received on the other
 404  * side if #MSG_task_receive is used).
 405  * See #MSG_task_isend for sending tasks asynchronously.
 406  *
 407  * @param task the task to be sent
 408  * @param alias the mailbox name to where the task is sent
 409  *
 410  * @return Returns #MSG_OK if the task was successfully sent,
 411  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
 412  */
 413 msg_error_t MSG_task_send(msg_task_t task, const char* alias)
 414 {
 415   XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
 416   return task->send(alias, -1);
 417 }
 418
 419 /**
 420  * @brief Sends a task to a mailbox with a maximum rate
 421  *
 422  * This is a blocking function, the execution flow will be blocked until the task is sent. The maxrate parameter allows
 423  * the application to limit the bandwidth utilization of network links when sending the task.
 424  *
 425  * The maxrate parameter can be used to send a task with a limited bandwidth (smaller than the physical available
 426  * value). Use MSG_task_send() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
 427  *
 428  * @param task the task to be sent
 429  * @param alias the mailbox name to where the task is sent
 430  * @param maxrate the maximum communication rate for sending this task (byte/sec)
 431  *
 432  * @return Returns #MSG_OK if the task was successfully sent,
 433  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
 434  */
 435 msg_error_t MSG_task_send_bounded(msg_task_t task, const char* alias, double maxrate)
 436 {
 437   task->set_rate(maxrate);
 438   return task->send(alias, -1);
 439 }
 440
 441 /**
 442  * @brief Sends a task to a mailbox with a timeout
 443  *
 444  * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
 445  *
 446  * @param task the task to be sent
 447  * @param alias the mailbox name to where the task is sent
 448  * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
 449  *
 450  * @return Returns #MSG_OK if the task was successfully sent,
 451  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 452  */
 453 msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char* alias, double timeout)
 454 {
 455   return task->send(alias, timeout);
 456 }
 457
 458 /**
 459  * @brief Sends a task to a mailbox with a timeout and with a maximum rate
 460  *
 461  * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
 462  *
 463  * The maxrate parameter can be used to send a task with a limited bandwidth (smaller than the physical available
 464  * value). Use MSG_task_send_with_timeout() if you don't limit the rate (or pass -1 as a rate value do disable this
 465  * feature).
 466  *
 467  * @param task the task to be sent
 468  * @param alias the mailbox name to where the task is sent
 469  * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
 470  * @param maxrate the maximum communication rate for sending this task (byte/sec)
 471  *
 472  * @return Returns #MSG_OK if the task was successfully sent,
 473  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 474  */
 475 msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char* alias, double timeout, double maxrate)
 476 {
 477   task->set_rate(maxrate);
 478   return task->send(alias, timeout);
 479 }
 480
 481 /**
 482  * @brief Receives a task from a mailbox.
 483  *
 484  * This is a blocking function, the execution flow will be blocked until the task is received. See #MSG_task_irecv
 485  * for receiving tasks asynchronously.
 486  *
 487  * @param task a memory location for storing a #msg_task_t.
 488  * @param alias name of the mailbox to receive the task from
 489  *
 490  * @return Returns
 491  * #MSG_OK if the task was successfully received,
 492  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
 493  */
 494 msg_error_t MSG_task_receive(msg_task_t * task, const char *alias)
 495 {
 496   return MSG_task_receive_with_timeout(task, alias, -1);
 497 }
 498
 499 /**
 500  * @brief Receives a task from a mailbox at a given rate.
 501  *
 502  * @param task a memory location for storing a #msg_task_t.
 503  * @param alias name of the mailbox to receive the task from
 504  * @param rate limit the reception to rate bandwidth (byte/sec)
 505  *
 506  * The rate parameter can be used to receive a task with a limited bandwidth (smaller than the physical available
 507  * value). Use MSG_task_receive() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
 508  *
 509  * @return Returns
 510  * #MSG_OK if the task was successfully received,
 511  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
 512  */
 513 msg_error_t MSG_task_receive_bounded(msg_task_t* task, const char* alias, double rate)
 514 {
 515   return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate);
 516 }
 517
 518 /**
 519  * @brief Receives a task from a mailbox with a given timeout.
 520  *
 521  * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
 522  * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously.  You can provide a -1 timeout
 523  * to obtain an infinite timeout.
 524  *
 525  * @param task a memory location for storing a #msg_task_t.
 526  * @param alias name of the mailbox to receive the task from
 527  * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
 528  *
 529  * @return Returns
 530  * #MSG_OK if the task was successfully received,
 531  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 532  */
 533 msg_error_t MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, double timeout)
 534 {
 535   return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, -1);
 536 }
 537
 538 /**
 539  * @brief Receives a task from a mailbox with a given timeout and at a given rate.
 540  *
 541  * @param task a memory location for storing a #msg_task_t.
 542  * @param alias name of the mailbox to receive the task from
 543  * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
 544  * @param rate limit the reception to rate bandwidth (byte/sec)
 545  *
 546  * The rate parameter can be used to send a task with a limited
 547  * bandwidth (smaller than the physical available value). Use
 548  * MSG_task_receive() if you don't limit the rate (or pass -1 as a
 549  * rate value do disable this feature).
 550  *
 551  * @return Returns
 552  * #MSG_OK if the task was successfully received,
 553  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 554  */
 555 msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t* task, const char* alias, double timeout, double rate)
 556 {
 557   return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, rate);
 558 }
 559
 560 /**
 561  * @brief Receives a task from a mailbox from a specific host with a given timeout.
 562  *
 563  * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
 564  * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
 565  * to obtain an infinite timeout.
 566  *
 567  * @param task a memory location for storing a #msg_task_t.
 568  * @param alias name of the mailbox to receive the task from
 569  * @param timeout is the maximum wait time for completion (provide -1 for no timeout)
 570  * @param host a #msg_host_t host from where the task was sent
 571  *
 572  * @return Returns
 573  * #MSG_OK if the task was successfully received,
 574  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 575  */
 576 msg_error_t MSG_task_receive_ext(msg_task_t* task, const char* alias, double timeout, msg_host_t host)
 577 {
 578   XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
 579   return MSG_task_receive_ext_bounded(task, alias, timeout, host, -1.0);
 580 }
 581
 582 /**
 583  * @brief Receives a task from a mailbox from a specific host with a given timeout  and at a given rate.
 584  *
 585  * @param task a memory location for storing a #msg_task_t.
 586  * @param alias name of the mailbox to receive the task from
 587  * @param timeout is the maximum wait time for completion (provide -1 for no timeout)
 588  * @param host a #msg_host_t host from where the task was sent
 589  * @param rate limit the reception to rate bandwidth (byte/sec)
 590  *
 591  * The rate parameter can be used to receive a task with a limited bandwidth (smaller than the physical available
 592  * value). Use MSG_task_receive_ext() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
 593  *
 594  * @return Returns
 595  * #MSG_OK if the task was successfully received,
 596  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
 597  */
 598 msg_error_t MSG_task_receive_ext_bounded(msg_task_t* task, const char* alias, double timeout, msg_host_t host,
 599                                          double rate)
 600 {
 601   XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
 602   msg_error_t ret = MSG_OK;
 603   /* We no longer support getting a task from a specific host */
 604   if (host)
 605     THROW_UNIMPLEMENTED;
 606
 607   /* Sanity check */
 608   xbt_assert(task, "Null pointer for the task storage");
 609
 610   if (*task)
 611     XBT_WARN("Asked to write the received task in a non empty struct -- proceeding.");
 612
 613   /* Try to receive it by calling SIMIX network layer */
 614   try {
 615     void* payload;
 616     simgrid::s4u::Mailbox::by_name(alias)
 617         ->get_init()
 618         ->set_dst_data(&payload, sizeof(msg_task_t*))
 619         ->set_rate(rate)
 620         ->wait_for(timeout);
 621     *task = static_cast<msg_task_t>(payload);
 622     XBT_DEBUG("Got task %s from %s", (*task)->get_cname(), alias);
 623     (*task)->set_not_used();
 624   } catch (const simgrid::HostFailureException&) {
 625     ret = MSG_HOST_FAILURE;
 626   } catch (const simgrid::TimeoutError&) {
 627     ret = MSG_TIMEOUT;
 628   } catch (const simgrid::CancelException&) {
 629     ret = MSG_TASK_CANCELED;
 630   } catch (const simgrid::NetworkFailureException&) {
 631     ret = MSG_TRANSFER_FAILURE;
 632   }
 633
 634   if (TRACE_actor_is_enabled() && ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
 635     container_t process_container = simgrid::instr::Container::by_name(instr_pid(*MSG_process_self()));
 636
 637     std::string key = std::string("p") + std::to_string((*task)->get_id());
 638     simgrid::instr::Container::get_root()->get_link("ACTOR_TASK_LINK")->end_event(process_container, "SR", key);
 639   }
 640   return ret;
 641 }
 642
 643 /**
 644  * @brief Starts listening for receiving a task from an asynchronous communication.
 645  *
 646  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
 647  *
 648  * @param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
 649  * @param name of the mailbox to receive the task on
 650  * @return the msg_comm_t communication created
 651  */
 652 msg_comm_t MSG_task_irecv(msg_task_t* task, const char* name)
 653 {
 654   return MSG_task_irecv_bounded(task, name, -1.0);
 655 }
 656
 657 /**
 658  * @brief Starts listening for receiving a task from an asynchronous communication at a given rate.
 659  *
 660  * The rate parameter can be used to receive a task with a limited
 661  * bandwidth (smaller than the physical available value). Use
 662  * MSG_task_irecv() if you don't limit the rate (or pass -1 as a rate
 663  * value do disable this feature).
 664  *
 665  * @param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
 666  * @param name of the mailbox to receive the task on
 667  * @param rate limit the bandwidth to the given rate (byte/sec)
 668  * @return the msg_comm_t communication created
 669  */
 670 msg_comm_t MSG_task_irecv_bounded(msg_task_t* task, const char* name, double rate)
 671 {
 672   /* FIXME: these functions are not traceable */
 673   /* Sanity check */
 674   xbt_assert(task, "Null pointer for the task storage");
 675
 676   if (*task)
 677     XBT_CRITICAL("MSG_task_irecv() was asked to write in a non empty task struct.");
 678
 679   /* Try to receive it by calling SIMIX network layer */
 680   simgrid::s4u::CommPtr comm = simgrid::s4u::Mailbox::by_name(name)
 681                                    ->get_init()
 682                                    ->set_dst_data((void**)task, sizeof(msg_task_t*))
 683                                    ->set_rate(rate)
 684                                    ->start();
 685
 686   return new simgrid::msg::Comm(nullptr, task, comm);
 687 }
 688
 689 /**
 690  * @brief Look if there is a communication on a mailbox and return the PID of the sender process.
 691  *
 692  * @param alias the name of the mailbox to be considered
 693  *
 694  * @return Returns the PID of sender process,
 695  * -1 if there is no communication in the mailbox.#include <cmath>
 696  *
 697  */
 698 int MSG_task_listen_from(const char* alias)
 699 {
 700   /* looks inside the rdv directly. Not clean. */
 701   simgrid::kernel::activity::CommImplPtr comm = simgrid::s4u::Mailbox::by_name(alias)->front();
 702
 703   if (comm && comm->src_actor_)
 704     return comm->src_actor_->get_pid();
 705   else
 706     return -1;
 707 }
 708
 709 /** @brief Destroys the given task.
 710  *
 711  * You should free user data, if any, @b before calling this destructor.
 712  *
 713  * Only the process that owns the task can destroy it.
 714  * The owner changes after a successful send.
 715  * If a task is successfully sent, the receiver becomes the owner and is supposed to destroy it. The sender should not
 716  * use it anymore.
 717  * If the task failed to be sent, the sender remains the owner of the task.
 718  */
 719 msg_error_t MSG_task_destroy(msg_task_t task)
 720 {
 721   if (task->is_used()) {
 722     /* the task is being sent or executed: cancel it first */
 723     task->cancel();
 724   }
 725
 726   /* free main structures */
 727   delete task;
 728
 729   return MSG_OK;
 730 }
 731
 732 /** @brief Cancel the given task
 733  *
 734  * If it was currently executed or transfered, the working process is stopped.
 735  */
 736 msg_error_t MSG_task_cancel(msg_task_t task)
 737 {
 738   xbt_assert((task != nullptr), "Cannot cancel a nullptr task");
 739   task->cancel();
 740   return MSG_OK;
 741 }
 742
 743 /** @brief Returns a value in ]0,1[ that represent the task remaining work
 744  *    to do: starts at 1 and goes to 0. Returns 0 if not started or finished.
 745  *
 746  * It works for either parallel or sequential tasks.
 747  */
 748 double MSG_task_get_remaining_work_ratio(msg_task_t task) {
 749
 750   xbt_assert((task != nullptr), "Cannot get information from a nullptr task");
 751   if (task->compute) {
 752     // Task in progress
 753     return task->compute->get_remaining_ratio();
 754   } else {
 755     // Task not started (flops_amount is > 0.0) or finished (flops_amount is set to 0.0)
 756     return task->flops_amount > 0.0 ? 1.0 : 0.0;
 757   }
 758 }
 759
 760 /** @brief Returns the amount of flops that remain to be computed
 761  *
 762  * The returned value is initially the cost that you defined for the task, then it decreases until it reaches 0
 763  *
 764  * It works for sequential tasks, but the remaining amount of work is not a scalar value for parallel tasks.
 765  * So you will get an exception if you call this function on parallel tasks. Just don't do it.
 766  */
 767 double MSG_task_get_flops_amount(msg_task_t task) {
 768   if (task->compute != nullptr) {
 769     return task->compute->get_remaining();
 770   } else {
 771     // Not started or already done.
 772     // - Before starting, flops_amount is initially the task cost
 773     // - After execution, flops_amount is set to 0 (until someone uses MSG_task_set_flops_amount, if any)
 774     return task->flops_amount;
 775   }
 776 }
 777
 778 /** @brief set the computation amount needed to process the given task.
 779  *
 780  * @warning If the computation is ongoing (already started and not finished),
 781  * it is not modified by this call. Moreover, after its completion, the ongoing execution with set the flops_amount to
 782  * zero, overriding any value set during the execution.
 783  */
 784 void MSG_task_set_flops_amount(msg_task_t task, double flops_amount)
 785 {
 786   task->flops_amount = flops_amount;
 787 }
 788
 789 /** @brief set the amount data attached with the given task.
 790  *
 791  * @warning If the transfer is ongoing (already started and not finished), it is not modified by this call.
 792  */
 793 void MSG_task_set_bytes_amount(msg_task_t task, double data_size)
 794 {
 795   task->bytes_amount = data_size;
 796 }
 797
 798 /** @brief Returns the total amount received by the given task
 799  *
 800  *  If the communication does not exist it will return 0.
 801  *  So, if the communication has FINISHED or FAILED it returns zero.
 802  */
 803 double MSG_task_get_remaining_communication(msg_task_t task)
 804 {
 805   XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->comm.get());
 806   return task->comm->get_remaining();
 807 }
 808
 809 /** @brief Returns the size of the data attached to the given task. */
 810 double MSG_task_get_bytes_amount(msg_task_t task)
 811 {
 812   xbt_assert(task != nullptr, "Invalid parameter");
 813   return task->bytes_amount;
 814 }
 815
 816 /** @brief Changes the priority of a computation task.
 817  *
 818  * This priority doesn't affect the transfer rate. A priority of 2
 819  * will make a task receive two times more cpu power than regular tasks.
 820  */
 821 void MSG_task_set_priority(msg_task_t task, double priority)
 822 {
 823   task->set_priority(priority);
 824 }
 825
 826 /** @brief Changes the maximum CPU utilization of a computation task (in flops/s).
 827  *
 828  * For VMs, there is a pitfall. Please see MSG_vm_set_bound().
 829  */
 830 void MSG_task_set_bound(msg_task_t task, double bound)
 831 {
 832   if (bound < 1e-12) /* close enough to 0 without any floating precision surprise */
 833     XBT_INFO("bound == 0 means no capping (i.e., unlimited).");
 834   task->set_bound(bound);
 835 }
 836
 837 /**
 838  * @brief Sets the tracing category of a task.
 839  *
 840  * This function should be called after the creation of a MSG task, to define the category of that task. The
 841  * first parameter task must contain a task that was  =created with the function #MSG_task_create. The second
 842  * parameter category must contain a category that was previously declared with the function #TRACE_category
 843  * (or with #TRACE_category_with_color).
 844  *
 845  * See @ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
 846  *
 847  * @param task the task that is going to be categorized
 848  * @param category the name of the category to be associated to the task
 849  *
 850  * @see MSG_task_get_category, TRACE_category, TRACE_category_with_color
 851  */
 852 void MSG_task_set_category(msg_task_t task, const char* category)
 853 {
 854   xbt_assert(not task->has_tracing_category(), "Task %p(%s) already has a category (%s).", task, task->get_cname(),
 855              task->get_tracing_category().c_str());
 856
 857   // if user provides a nullptr category, task is no longer traced
 858   if (category == nullptr) {
 859     task->set_tracing_category("");
 860     XBT_DEBUG("MSG task %p(%s), category removed", task, task->get_cname());
 861   } else {
 862     // set task category
 863     task->set_tracing_category(category);
 864     XBT_DEBUG("MSG task %p(%s), category %s", task, task->get_cname(), task->get_tracing_category().c_str());
 865   }
 866 }
 867
 868 /**
 869  * @brief Gets the current tracing category of a task. (@see MSG_task_set_category)
 870  * @param task the task to be considered
 871  * @return Returns the name of the tracing category of the given task, "" otherwise
 872  */
 873 const char* MSG_task_get_category(msg_task_t task)
 874 {
 875   return task->get_tracing_category().c_str();
 876 }