1 /* Copyright (c) 2004-2016. The SimGrid Team. All rights reserved. */
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. */
8 #include "src/simix/smx_private.h" /* MSG_task_listen looks inside the rdv directly. Not clean. */
9 #include "msg_private.h"
12 #include "xbt/sysdep.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg,
15 "Logging specific to MSG (gos)");
17 /** \ingroup msg_task_usage
18 * \brief Executes a task and waits for its termination.
20 * This function is used for describing the behavior of a process. It takes only one parameter.
21 * \param task a #msg_task_t to execute on the location on which the process is running.
22 * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise
24 msg_error_t MSG_task_execute(msg_task_t task)
26 /* TODO: add this to other locations */
27 msg_host_t host = MSG_process_get_host(MSG_process_self());
28 MSG_host_add_task(host, task);
30 msg_error_t ret = MSG_parallel_task_execute(task);
32 MSG_host_del_task(host, task);
37 /** \ingroup msg_task_usage
38 * \brief Executes a parallel task and waits for its termination.
40 * \param task a #msg_task_t to execute on the location on which the process is running.
42 * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
43 * or #MSG_HOST_FAILURE otherwise
45 msg_error_t MSG_parallel_task_execute(msg_task_t task)
47 simdata_task_t simdata = task->simdata;
48 simdata_process_t p_simdata = (simdata_process_t) SIMIX_process_self_get_data();
49 e_smx_state_t comp_state;
50 msg_error_t status = MSG_OK;
52 TRACE_msg_task_execute_start(task);
54 xbt_assert((!simdata->compute) && !task->simdata->isused,
55 "This task is executed somewhere else. Go fix your code!");
57 XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
59 if (simdata->flops_amount == 0 && !simdata->host_nb) {
60 TRACE_msg_task_execute_end(task);
67 if (simdata->host_nb > 0) {
68 simdata->compute = static_cast<simgrid::simix::Exec*>(
69 simcall_execution_parallel_start(task->name, simdata->host_nb,simdata->host_list,
70 simdata->flops_parallel_amount, simdata->bytes_parallel_amount,
72 XBT_DEBUG("Parallel execution action created: %p", simdata->compute);
74 unsigned long affinity_mask =
75 (unsigned long)(uintptr_t) xbt_dict_get_or_null_ext(simdata->affinity_mask_db, (char *) p_simdata->m_host,
77 XBT_DEBUG("execute %s@%s with affinity(0x%04lx)",
78 MSG_task_get_name(task), MSG_host_get_name(p_simdata->m_host), affinity_mask);
80 simdata->compute = static_cast<simgrid::simix::Exec*>(
81 simcall_execution_start(task->name, simdata->flops_amount, simdata->priority,
82 simdata->bound, affinity_mask));
84 simcall_set_category(simdata->compute, task->category);
85 p_simdata->waiting_action = simdata->compute;
86 comp_state = simcall_execution_wait(simdata->compute);
88 p_simdata->waiting_action = nullptr;
89 simdata->setNotUsed();
91 XBT_DEBUG("Execution task '%s' finished in state %d", task->name, (int)comp_state);
96 status = MSG_TASK_CANCELED;
99 status = MSG_HOST_FAILURE;
106 /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */
107 simdata->flops_amount = 0.0;
108 simdata->comm = nullptr;
109 simdata->compute = nullptr;
110 TRACE_msg_task_execute_end(task);
115 /** \ingroup msg_task_usage
116 * \brief Sleep for the specified number of seconds
118 * Makes the current process sleep until \a time seconds have elapsed.
120 * \param nb_sec a number of second
122 msg_error_t MSG_process_sleep(double nb_sec)
124 msg_error_t status = MSG_OK;
125 /*msg_process_t proc = MSG_process_self();*/
127 TRACE_msg_process_sleep_in(MSG_process_self());
130 simcall_process_sleep(nb_sec);
133 switch (e.category) {
135 XBT_DEBUG("According to the JAVA API, a sleep call should only deal with HostFailureException, WTF here ?");
136 // adsein: MSG_TASK_CANCELED is assigned when someone kills the process that made the sleep, this is not
137 // correct. For instance, when the node is turned off, the error should be MSG_HOST_FAILURE, which is by the way
138 // and according to the JAVA document, the only exception that can be triggered by MSG_Process_sleep call.
139 // To avoid possible impacts in the code, I just raised a host_failure exception for the moment in the JAVA code
140 // and did not change anythings at the C level.
141 // 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)
142 status = MSG_TASK_CANCELED;
149 TRACE_msg_process_sleep_out(MSG_process_self());
153 /** \ingroup msg_task_usage
154 * \brief Receives a task from a mailbox.
156 * This is a blocking function, the execution flow will be blocked until the task is received. See #MSG_task_irecv
157 * for receiving tasks asynchronously.
159 * \param task a memory location for storing a #msg_task_t.
160 * \param alias name of the mailbox to receive the task from
163 * #MSG_OK if the task was successfully received,
164 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
166 msg_error_t MSG_task_receive(msg_task_t * task, const char *alias)
168 return MSG_task_receive_with_timeout(task, alias, -1);
171 /** \ingroup msg_task_usage
172 * \brief Receives a task from a mailbox at a given rate.
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 rate limit the reception to rate bandwidth
179 * #MSG_OK if the task was successfully received,
180 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
182 msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, double rate)
184 return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate);
187 /** \ingroup msg_task_usage
188 * \brief Receives a task from a mailbox with a given timeout.
190 * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
191 * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
192 * to obtain an infinite timeout.
194 * \param task a memory location for storing a #msg_task_t.
195 * \param alias name of the mailbox to receive the task from
196 * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
199 * #MSG_OK if the task was successfully received,
200 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
202 msg_error_t MSG_task_receive_with_timeout(msg_task_t * task, const char *alias, double timeout)
204 return MSG_task_receive_ext(task, alias, timeout, nullptr);
207 /** \ingroup msg_task_usage
208 * \brief Receives a task from a mailbox with a given timeout and at a given rate.
210 * \param task a memory location for storing a #msg_task_t.
211 * \param alias name of the mailbox to receive the task from
212 * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
213 * \param rate limit the reception to rate bandwidth
216 * #MSG_OK if the task was successfully received,
217 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
219 msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, double timeout,double rate)
221 return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, rate);
224 /** \ingroup msg_task_usage
225 * \brief Receives a task from a mailbox from a specific host with a given timeout.
227 * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
228 * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
229 * to obtain an infinite timeout.
231 * \param task a memory location for storing a #msg_task_t.
232 * \param alias name of the mailbox to receive the task from
233 * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
234 * \param host a #msg_host_t host from where the task was sent
237 * #MSG_OK if the task was successfully received,
238 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
240 msg_error_t MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout, msg_host_t host)
242 msg_error_t ret = MSG_OK;
243 XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
245 ret = MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task, host, timeout);
248 switch (e.category) {
249 case cancel_error: /* may be thrown by MSG_mailbox_get_by_alias */
250 ret = MSG_HOST_FAILURE;
259 /** \ingroup msg_task_usage
260 * \brief Receives a task from a mailbox from a specific host with a given timeout and at a given rate.
262 * \param task a memory location for storing a #msg_task_t.
263 * \param alias name of the mailbox to receive the task from
264 * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
265 * \param host a #msg_host_t host from where the task was sent
266 * \param rate limit the reception to rate bandwidth
269 * #MSG_OK if the task was successfully received,
270 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
272 msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout, msg_host_t host,
275 XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
276 return MSG_mailbox_get_task_ext_bounded(MSG_mailbox_get_by_alias(alias), task, host, timeout, rate);
279 /* Internal function used to factorize code between MSG_task_isend_with_matching() and MSG_task_dsend(). */
280 static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char *alias,
281 int (*match_fun)(void*,void*, smx_synchro_t),
282 void *match_data, void_f_pvoid_t cleanup, int detached)
284 simdata_task_t t_simdata = nullptr;
285 msg_process_t process = MSG_process_self();
286 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
287 int call_end = TRACE_msg_task_put_start(task);
289 /* Prepare the task to send */
290 t_simdata = task->simdata;
291 t_simdata->sender = process;
292 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data())->m_host;
293 t_simdata->setUsed();
294 t_simdata->comm = nullptr;
295 msg_global->sent_msg++;
297 /* Send it by calling SIMIX network layer */
298 smx_synchro_t act = simcall_comm_isend(SIMIX_process_self(), mailbox, t_simdata->bytes_amount, t_simdata->rate,
299 task, sizeof(void *), match_fun, cleanup, nullptr, match_data,detached);
300 t_simdata->comm = static_cast<simgrid::simix::Comm*>(act); /* FIXME: is the field t_simdata->comm still useful? */
306 comm = xbt_new0(s_msg_comm_t, 1);
307 comm->task_sent = task;
308 comm->task_received = nullptr;
309 comm->status = MSG_OK;
313 if (TRACE_is_enabled())
314 simcall_set_category(act, task->category);
316 TRACE_msg_task_put_end();
321 /** \ingroup msg_task_usage
322 * \brief Sends a task on a mailbox.
324 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
326 * \param task a #msg_task_t to send on another location.
327 * \param alias name of the mailbox to sent the task to
328 * \return the msg_comm_t communication created
330 msg_comm_t MSG_task_isend(msg_task_t task, const char *alias)
332 return MSG_task_isend_internal(task, alias, nullptr, nullptr, nullptr, 0);
335 /** \ingroup msg_task_usage
336 * \brief Sends a task on a mailbox with a maximum rate
338 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. The maxrate
339 * parameter allows the application to limit the bandwidth utilization of network links when sending the task.
341 * \param task a #msg_task_t to send on another location.
342 * \param alias name of the mailbox to sent the task to
343 * \param maxrate the maximum communication rate for sending this task .
344 * \return the msg_comm_t communication created
346 msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate)
348 task->simdata->rate = maxrate;
349 return MSG_task_isend_internal(task, alias, nullptr, nullptr, nullptr, 0);
352 /** \ingroup msg_task_usage
353 * \brief Sends a task on a mailbox, with support for matching requests
355 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
357 * \param task a #msg_task_t to send on another location.
358 * \param alias name of the mailbox to sent the task to
359 * \param match_fun boolean function which parameters are:
360 * - match_data_provided_here
361 * - match_data_provided_by_other_side_if_any
362 * - the_smx_synchro_describing_the_other_side
363 * \param match_data user provided data passed to match_fun
364 * \return the msg_comm_t communication created
366 msg_comm_t MSG_task_isend_with_matching(msg_task_t task, const char *alias,
367 int (*match_fun)(void*, void*, smx_synchro_t), void *match_data)
369 return MSG_task_isend_internal(task, alias, match_fun, match_data, nullptr, 0);
372 /** \ingroup msg_task_usage
373 * \brief Sends a task on a mailbox.
375 * This is a non blocking detached send function.
376 * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
377 * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
378 * usual. More details on this can be obtained on
379 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
380 * in the SimGrid-user mailing list archive.
382 * \param task a #msg_task_t to send on another location.
383 * \param alias name of the mailbox to sent the task to
384 * \param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy
385 * (if nullptr, no function will be called)
387 void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup)
389 MSG_task_isend_internal(task, alias, nullptr, nullptr, cleanup, 1);
392 /** \ingroup msg_task_usage
393 * \brief Sends a task on a mailbox with a maximal rate.
395 * This is a non blocking detached send function.
396 * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
397 * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
398 * usual. More details on this can be obtained on
399 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
400 * in the SimGrid-user mailing list archive.
402 * \param task a #msg_task_t to send on another location.
403 * \param alias name of the mailbox to sent the task to
404 * \param cleanup a function to destroy the task if the
405 * communication fails, e.g. MSG_task_destroy
406 * (if nullptr, no function will be called)
407 * \param maxrate the maximum communication rate for sending this task
410 void MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate)
412 task->simdata->rate = maxrate;
413 MSG_task_dsend(task, alias, cleanup);
416 /** \ingroup msg_task_usage
417 * \brief Starts listening for receiving a task from an asynchronous communication.
419 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
421 * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
422 * \param name of the mailbox to receive the task on
423 * \return the msg_comm_t communication created
425 msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name)
427 return MSG_task_irecv_bounded(task, name, -1.0);
430 /** \ingroup msg_task_usage
431 * \brief Starts listening for receiving a task from an asynchronous communication at a given rate.
433 * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
434 * \param name of the mailbox to receive the task on
435 * \param rate limit the bandwidth to the given rate
436 * \return the msg_comm_t communication created
438 msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rate)
440 smx_mailbox_t rdv = MSG_mailbox_get_by_alias(name);
442 /* FIXME: these functions are not traceable */
444 xbt_assert(task, "Null pointer for the task storage");
447 XBT_CRITICAL("MSG_task_irecv() was asked to write in a non empty task struct.");
449 /* Try to receive it by calling SIMIX network layer */
450 msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
451 comm->task_sent = nullptr;
452 comm->task_received = task;
453 comm->status = MSG_OK;
454 comm->s_comm = simcall_comm_irecv(MSG_process_self(), rdv, task, nullptr, nullptr, nullptr, nullptr, rate);
459 /** \ingroup msg_task_usage
460 * \brief Checks whether a communication is done, and if yes, finalizes it.
461 * \param comm the communication to test
462 * \return TRUE if the communication is finished
463 * (but it may have failed, use MSG_comm_get_status() to know its status)
464 * or FALSE if the communication is not finished yet
465 * If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
467 int MSG_comm_test(msg_comm_t comm)
472 finished = simcall_comm_test(comm->s_comm);
473 if (finished && comm->task_received != nullptr) {
474 /* I am the receiver */
475 (*comm->task_received)->simdata->setNotUsed();
479 switch (e.category) {
481 comm->status = MSG_TRANSFER_FAILURE;
485 comm->status = MSG_TIMEOUT;
496 /** \ingroup msg_task_usage
497 * \brief This function checks if a communication is finished.
498 * \param comms a vector of communications
499 * \return the position of the finished communication if any
500 * (but it may have failed, use MSG_comm_get_status() to know its status),
501 * or -1 if none is finished
503 int MSG_comm_testany(xbt_dynar_t comms)
505 int finished_index = -1;
507 /* Create the equivalent array with SIMIX objects: */
508 std::vector<simgrid::simix::Synchro*> s_comms;
509 s_comms.reserve(xbt_dynar_length(comms));
512 xbt_dynar_foreach(comms, cursor, comm) {
513 s_comms.push_back(comm->s_comm);
516 msg_error_t status = MSG_OK;
518 finished_index = simcall_comm_testany(s_comms.data(), s_comms.size());
521 switch (e.category) {
523 finished_index = e.value;
524 status = MSG_TRANSFER_FAILURE;
527 finished_index = e.value;
528 status = MSG_TIMEOUT;
535 if (finished_index != -1) {
536 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
537 /* the communication is finished */
538 comm->status = status;
540 if (status == MSG_OK && comm->task_received != nullptr) {
541 /* I am the receiver */
542 (*comm->task_received)->simdata->setNotUsed();
546 return finished_index;
549 /** \ingroup msg_task_usage
550 * \brief Destroys a communication.
551 * \param comm the communication to destroy.
553 void MSG_comm_destroy(msg_comm_t comm)
558 /** \ingroup msg_task_usage
559 * \brief Wait for the completion of a communication.
561 * It takes two parameters.
562 * \param comm the communication to wait.
563 * \param timeout Wait until the communication terminates or the timeout occurs.
564 * You can provide a -1 timeout to obtain an infinite timeout.
565 * \return msg_error_t
567 msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
570 simcall_comm_wait(comm->s_comm, timeout);
572 if (comm->task_received != nullptr) {
573 /* I am the receiver */
574 (*comm->task_received)->simdata->setNotUsed();
577 /* FIXME: these functions are not traceable */
580 switch (e.category) {
582 comm->status = MSG_TRANSFER_FAILURE;
585 comm->status = MSG_TIMEOUT;
595 /** \ingroup msg_task_usage
596 * \brief This function is called by a sender and permit to wait for each communication
598 * \param comm a vector of communication
599 * \param nb_elem is the size of the comm vector
600 * \param timeout for each call of MSG_comm_wait
602 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
605 for (i = 0; i < nb_elem; i++) {
606 MSG_comm_wait(comm[i], timeout);
610 /** \ingroup msg_task_usage
611 * \brief This function waits for the first communication finished in a list.
612 * \param comms a vector of communications
613 * \return the position of the first finished communication
614 * (but it may have failed, use MSG_comm_get_status() to know its status)
616 int MSG_comm_waitany(xbt_dynar_t comms)
618 int finished_index = -1;
620 /* create the equivalent dynar with SIMIX objects */
621 xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_synchro_t), nullptr);
624 xbt_dynar_foreach(comms, cursor, comm) {
625 xbt_dynar_push(s_comms, &comm->s_comm);
628 msg_error_t status = MSG_OK;
630 finished_index = simcall_comm_waitany(s_comms);
633 switch (e.category) {
635 finished_index = e.value;
636 status = MSG_TRANSFER_FAILURE;
639 finished_index = e.value;
640 status = MSG_TIMEOUT;
647 xbt_assert(finished_index != -1, "WaitAny returned -1");
648 xbt_dynar_free(&s_comms);
650 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
651 /* the communication is finished */
652 comm->status = status;
654 if (comm->task_received != nullptr) {
655 /* I am the receiver */
656 (*comm->task_received)->simdata->setNotUsed();
659 return finished_index;
663 * \ingroup msg_task_usage
664 * \brief Returns the error (if any) that occurred during a finished communication.
665 * \param comm a finished communication
666 * \return the status of the communication, or #MSG_OK if no error occurred
667 * during the communication
669 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
674 /** \ingroup msg_task_usage
675 * \brief Get a task (#msg_task_t) from a communication
677 * \param comm the communication where to get the task
678 * \return the task from the communication
680 msg_task_t MSG_comm_get_task(msg_comm_t comm)
682 xbt_assert(comm, "Invalid parameter");
684 return comm->task_received ? *comm->task_received : comm->task_sent;
688 * \brief This function is called by SIMIX in kernel mode to copy the data of a comm.
689 * \param comm the comm
690 * \param buff the data copied
691 * \param buff_size size of the buffer
693 void MSG_comm_copy_data_from_SIMIX(smx_synchro_t synchro, void* buff, size_t buff_size)
695 simgrid::simix::Comm *comm = static_cast<simgrid::simix::Comm*>(synchro);
697 SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
699 // notify the user callback if any
700 if (msg_global->task_copy_callback) {
701 msg_task_t task = (msg_task_t) buff;
702 msg_global->task_copy_callback(task, comm->src_proc, comm->dst_proc);
706 /** \ingroup msg_task_usage
707 * \brief Sends a task to a mailbox
709 * This is a blocking function, the execution flow will be blocked until the task is sent (and received on the other
710 * side if #MSG_task_receive is used).
711 * See #MSG_task_isend for sending tasks asynchronously.
713 * \param task the task to be sent
714 * \param alias the mailbox name to where the task is sent
716 * \return Returns #MSG_OK if the task was successfully sent,
717 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
719 msg_error_t MSG_task_send(msg_task_t task, const char *alias)
721 XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
722 return MSG_task_send_with_timeout(task, alias, -1);
725 /** \ingroup msg_task_usage
726 * \brief Sends a task to a mailbox with a maximum rate
728 * This is a blocking function, the execution flow will be blocked until the task is sent. The maxrate parameter allows
729 * the application to limit the bandwidth utilization of network links when sending the task.
731 * \param task the task to be sent
732 * \param alias the mailbox name to where the task is sent
733 * \param maxrate the maximum communication rate for sending this task
735 * \return Returns #MSG_OK if the task was successfully sent,
736 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
738 msg_error_t MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate)
740 task->simdata->rate = maxrate;
741 return MSG_task_send(task, alias);
744 /** \ingroup msg_task_usage
745 * \brief Sends a task to a mailbox with a timeout
747 * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
749 * \param task the task to be sent
750 * \param alias the mailbox name to where the task is sent
751 * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
753 * \return Returns #MSG_OK if the task was successfully sent,
754 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
756 msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout)
758 msg_error_t ret = MSG_OK;
759 simdata_task_t t_simdata = nullptr;
760 msg_process_t process = MSG_process_self();
761 simdata_process_t p_simdata = (simdata_process_t) SIMIX_process_self_get_data();
762 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
764 int call_end = TRACE_msg_task_put_start(task); //must be after CHECK_HOST()
766 /* Prepare the task to send */
767 t_simdata = task->simdata;
768 t_simdata->sender = process;
769 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data())->m_host;
771 t_simdata->setUsed();
773 t_simdata->comm = nullptr;
774 msg_global->sent_msg++;
776 p_simdata->waiting_task = task;
778 /* Try to send it by calling SIMIX network layer */
780 smx_synchro_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simix call */
781 comm = simcall_comm_isend(SIMIX_process_self(), mailbox,t_simdata->bytes_amount,
782 t_simdata->rate, task, sizeof(void *), nullptr, nullptr, nullptr, task, 0);
783 if (TRACE_is_enabled())
784 simcall_set_category(comm, task->category);
785 t_simdata->comm = static_cast<simgrid::simix::Comm*>(comm);
786 simcall_comm_wait(comm, timeout);
789 switch (e.category) {
791 ret = MSG_HOST_FAILURE;
794 ret = MSG_TRANSFER_FAILURE;
803 /* If the send failed, it is not used anymore */
804 t_simdata->setNotUsed();
807 p_simdata->waiting_task = nullptr;
809 TRACE_msg_task_put_end();
813 /** \ingroup msg_task_usage
814 * \brief Sends a task to a mailbox with a timeout and with a maximum rate
816 * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
818 * \param task the task to be sent
819 * \param alias the mailbox name to where the task is sent
820 * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
821 * \param maxrate the maximum communication rate for sending this task
823 * \return Returns #MSG_OK if the task was successfully sent,
824 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
826 msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate)
828 task->simdata->rate = maxrate;
829 return MSG_task_send_with_timeout(task, alias, timeout);
832 /** \ingroup msg_task_usage
833 * \brief Check if there is a communication going on in a mailbox.
835 * \param alias the name of the mailbox to be considered
837 * \return Returns 1 if there is a communication, 0 otherwise
839 int MSG_task_listen(const char *alias)
841 smx_mailbox_t mbox = MSG_mailbox_get_by_alias(alias);
842 return !MSG_mailbox_is_empty(mbox) ||
843 (mbox->permanent_receiver && !mbox->done_comm_queue.empty());
846 /** \ingroup msg_task_usage
847 * \brief Look if there is a communication on a mailbox and return the PID of the sender process.
849 * \param alias the name of the mailbox to be considered
851 * \return Returns the PID of sender process,
852 * -1 if there is no communication in the mailbox.
854 int MSG_task_listen_from(const char *alias)
858 if (nullptr == (task = MSG_mailbox_front(MSG_mailbox_get_by_alias(alias))))
861 return MSG_process_get_PID(task->simdata->sender);
864 /** \ingroup msg_task_usage
865 * \brief Sets the tracing category of a task.
867 * This function should be called after the creation of a MSG task, to define the category of that task. The
868 * first parameter task must contain a task that was created with the function #MSG_task_create. The second
869 * parameter category must contain a category that was previously declared with the function #TRACE_category
870 * (or with #TRACE_category_with_color).
872 * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
874 * \param task the task that is going to be categorized
875 * \param category the name of the category to be associated to the task
877 * \see MSG_task_get_category, TRACE_category, TRACE_category_with_color
879 void MSG_task_set_category (msg_task_t task, const char *category)
881 TRACE_msg_set_task_category (task, category);
884 /** \ingroup msg_task_usage
886 * \brief Gets the current tracing category of a task.
888 * \param task the task to be considered
890 * \see MSG_task_set_category
892 * \return Returns the name of the tracing category of the given task, nullptr otherwise
894 const char *MSG_task_get_category (msg_task_t task)
896 return task->category;
900 * \brief Returns the value of a given AS or router property
902 * \param asr the name of a router or AS
903 * \param name a property name
904 * \return value of a property (or nullptr if property not set)
906 const char *MSG_as_router_get_property_value(const char* asr, const char *name)
908 return (char*) xbt_dict_get_or_null(MSG_as_router_get_properties(asr), name);
912 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to
915 * \param asr the name of a router or AS
916 * \return a dict containing the properties
918 xbt_dict_t MSG_as_router_get_properties(const char* asr)
920 return (simcall_asr_get_properties(asr));
924 * \brief Change the value of a given AS or router
926 * \param asr the name of a router or AS
927 * \param name a property name
928 * \param value what to change the property to
929 * \param free_ctn the freeing function to use to kill the value on need
931 void MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn) {
932 xbt_dict_set(MSG_as_router_get_properties(asr), name, value,free_ctn);