X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/29d98d1ceb682fbc4c734a92353be4b0bcd5d17b..2b4f2809ce5c54961bcae43131fcab00dd161a3d:/src/msg/msg_gos.cpp diff --git a/src/msg/msg_gos.cpp b/src/msg/msg_gos.cpp index 3e2eda2192..3c8121b2d3 100644 --- a/src/msg/msg_gos.cpp +++ b/src/msg/msg_gos.cpp @@ -1,42 +1,36 @@ -/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ -#include +#include "simgrid/Exception.hpp" -#include "src/msg/msg_private.h" -#include "src/simix/smx_private.h" /* MSG_task_listen looks inside the rdv directly. Not clean. */ +#include "simgrid/s4u/Mailbox.hpp" +#include "src/instr/instr_private.hpp" +#include "src/kernel/activity/ExecImpl.hpp" +#include "src/msg/msg_private.hpp" +#include "src/simix/smx_private.hpp" /* MSG_task_listen looks inside the rdv directly. Not clean. */ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, "Logging specific to MSG (gos)"); -SG_BEGIN_DECL() - -/** \ingroup msg_task_usage - * \brief Executes a task and waits for its termination. +/** @ingroup msg_task_usage + * @brief Executes a task and waits for its termination. * * This function is used for describing the behavior of a process. It takes only one parameter. - * \param task a #msg_task_t to execute on the location on which the process is running. - * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise + * @param task a #msg_task_t to execute on the location on which the process is running. + * @return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise */ msg_error_t MSG_task_execute(msg_task_t task) { - /* TODO: add this to other locations */ - msg_host_t host = MSG_process_get_host(MSG_process_self()); - MSG_host_add_task(host, task); - - msg_error_t ret = MSG_parallel_task_execute(task); - - MSG_host_del_task(host, task); - return ret; + return MSG_parallel_task_execute(task); } -/** \ingroup msg_task_usage - * \brief Executes a parallel task and waits for its termination. +/** @ingroup msg_task_usage + * @brief Executes a parallel task and waits for its termination. * - * \param task a #msg_task_t to execute on the location on which the process is running. + * @param task a #msg_task_t to execute on the location on which the process is running. * - * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED + * @return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED * or #MSG_HOST_FAILURE otherwise */ msg_error_t MSG_parallel_task_execute(msg_task_t task) @@ -66,35 +60,33 @@ msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeo simdata->setUsed(); if (simdata->host_nb > 0) { - simdata->compute = static_cast(simcall_execution_parallel_start( - task->name, simdata->host_nb, simdata->host_list, simdata->flops_parallel_amount, - simdata->bytes_parallel_amount, 1.0, -1.0, timeout)); - XBT_DEBUG("Parallel execution action created: %p", simdata->compute); + simdata->compute = + boost::static_pointer_cast(simcall_execution_parallel_start( + task->name ?: "", simdata->host_nb, simdata->host_list, simdata->flops_parallel_amount, + simdata->bytes_parallel_amount, -1.0, timeout)); + XBT_DEBUG("Parallel execution action created: %p", simdata->compute.get()); + if (task->category != nullptr) + simcall_set_category(simdata->compute, task->category); } else { - simdata->compute = static_cast( - simcall_execution_start(task->name, simdata->flops_amount, simdata->priority, simdata->bound)); + simdata->compute = boost::static_pointer_cast( + simcall_execution_start(task->name ?: "", task->category ?: "", simdata->flops_amount, simdata->priority, + simdata->bound, MSG_process_get_host(MSG_process_self()))); } - simcall_set_category(simdata->compute, task->category); + comp_state = simcall_execution_wait(simdata->compute); simdata->setNotUsed(); XBT_DEBUG("Execution task '%s' finished in state %d", task->name, (int)comp_state); - } - catch (xbt_ex& e) { - switch (e.category) { - case cancel_error: + } catch (simgrid::HostFailureException& e) { + status = MSG_HOST_FAILURE; + } catch (simgrid::TimeoutError& e) { + status = MSG_TIMEOUT; + } catch (xbt_ex& e) { + if (e.category == cancel_error) status = MSG_TASK_CANCELED; - break; - case host_error: - status = MSG_HOST_FAILURE; - break; - case timeout_error: - status = MSG_TIMEOUT; - break; - default: + else throw; - } } /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */ @@ -106,50 +98,48 @@ msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeo return status; } -/** \ingroup msg_task_usage - * \brief Sleep for the specified number of seconds +/** @ingroup msg_task_usage + * @brief Sleep for the specified number of seconds * - * Makes the current process sleep until \a time seconds have elapsed. + * Makes the current process sleep until @a time seconds have elapsed. * - * \param nb_sec a number of second + * @param nb_sec a number of second */ msg_error_t MSG_process_sleep(double nb_sec) { msg_error_t status = MSG_OK; - TRACE_msg_process_sleep_in(MSG_process_self()); - try { - simcall_process_sleep(nb_sec); - } - catch(xbt_ex& e) { + simgrid::s4u::this_actor::sleep_for(nb_sec); + } catch (simgrid::HostFailureException& e) { + status = MSG_HOST_FAILURE; + } catch (xbt_ex& e) { if (e.category == cancel_error) { - XBT_DEBUG("According to the JAVA API, a sleep call should only deal with HostFailureException, I'm lost."); + XBT_DEBUG("According to the JAVA API, a sleep call should only deal with HostFailureException, I'm lost."); // adsein: MSG_TASK_CANCELED is assigned when someone kills the process that made the sleep, this is not // correct. For instance, when the node is turned off, the error should be MSG_HOST_FAILURE, which is by the way // and according to the JAVA document, the only exception that can be triggered by MSG_Process_sleep call. // To avoid possible impacts in the code, I just raised a host_failure exception for the moment in the JAVA code // and did not change anythings at the C level. - // 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) + // 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) status = MSG_TASK_CANCELED; } else throw; } - TRACE_msg_process_sleep_out(MSG_process_self()); return status; } -/** \ingroup msg_task_usage - * \brief Receives a task from a mailbox. +/** @ingroup msg_task_usage + * @brief Receives a task from a mailbox. * * This is a blocking function, the execution flow will be blocked until the task is received. See #MSG_task_irecv * for receiving tasks asynchronously. * - * \param task a memory location for storing a #msg_task_t. - * \param alias name of the mailbox to receive the task from + * @param task a memory location for storing a #msg_task_t. + * @param alias name of the mailbox to receive the task from * - * \return Returns + * @return Returns * #MSG_OK if the task was successfully received, * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise. */ @@ -158,14 +148,19 @@ msg_error_t MSG_task_receive(msg_task_t * task, const char *alias) return MSG_task_receive_with_timeout(task, alias, -1); } -/** \ingroup msg_task_usage - * \brief Receives a task from a mailbox at a given rate. +/** @ingroup msg_task_usage + * @brief Receives a task from a mailbox at a given rate. * - * \param task a memory location for storing a #msg_task_t. - * \param alias name of the mailbox to receive the task from - * \param rate limit the reception to rate bandwidth + * @param task a memory location for storing a #msg_task_t. + * @param alias name of the mailbox to receive the task from + * @param rate limit the reception to rate bandwidth (byte/sec) * - * \return Returns + * The rate parameter can be used to receive a task with a limited + * bandwidth (smaller than the physical available value). Use + * MSG_task_receive() if you don't limit the rate (or pass -1 as a + * rate value do disable this feature). + * + * @return Returns * #MSG_OK if the task was successfully received, * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise. */ @@ -174,18 +169,18 @@ msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, doubl return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate); } -/** \ingroup msg_task_usage - * \brief Receives a task from a mailbox with a given timeout. +/** @ingroup msg_task_usage + * @brief Receives a task from a mailbox with a given timeout. * * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout * to obtain an infinite timeout. * - * \param task a memory location for storing a #msg_task_t. - * \param alias name of the mailbox to receive the task from - * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive) + * @param task a memory location for storing a #msg_task_t. + * @param alias name of the mailbox to receive the task from + * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive) * - * \return Returns + * @return Returns * #MSG_OK if the task was successfully received, * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise. */ @@ -194,15 +189,20 @@ msg_error_t MSG_task_receive_with_timeout(msg_task_t * task, const char *alias, return MSG_task_receive_ext(task, alias, timeout, nullptr); } -/** \ingroup msg_task_usage - * \brief Receives a task from a mailbox with a given timeout and at a given rate. +/** @ingroup msg_task_usage + * @brief Receives a task from a mailbox with a given timeout and at a given rate. + * + * @param task a memory location for storing a #msg_task_t. + * @param alias name of the mailbox to receive the task from + * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive) + * @param rate limit the reception to rate bandwidth (byte/sec) * - * \param task a memory location for storing a #msg_task_t. - * \param alias name of the mailbox to receive the task from - * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive) - * \param rate limit the reception to rate bandwidth + * The rate parameter can be used to send a task with a limited + * bandwidth (smaller than the physical available value). Use + * MSG_task_receive() if you don't limit the rate (or pass -1 as a + * rate value do disable this feature). * - * \return Returns + * @return Returns * #MSG_OK if the task was successfully received, * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise. */ @@ -211,21 +211,21 @@ msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, rate); } -/** \ingroup msg_task_usage - * \brief Receives a task from a mailbox from a specific host with a given timeout. +/** @ingroup msg_task_usage + * @brief Receives a task from a mailbox from a specific host with a given timeout. * * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout * to obtain an infinite timeout. * - * \param task a memory location for storing a #msg_task_t. - * \param alias name of the mailbox to receive the task from - * \param timeout is the maximum wait time for completion (provide -1 for no timeout) - * \param host a #msg_host_t host from where the task was sent + * @param task a memory location for storing a #msg_task_t. + * @param alias name of the mailbox to receive the task from + * @param timeout is the maximum wait time for completion (provide -1 for no timeout) + * @param host a #msg_host_t host from where the task was sent * - * \return Returns + * @return Returns * #MSG_OK if the task was successfully received, -* #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise. + * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise. */ msg_error_t MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout, msg_host_t host) { @@ -233,16 +233,21 @@ msg_error_t MSG_task_receive_ext(msg_task_t * task, const char *alias, double ti return MSG_task_receive_ext_bounded(task, alias, timeout, host, -1.0); } -/** \ingroup msg_task_usage - * \brief Receives a task from a mailbox from a specific host with a given timeout and at a given rate. +/** @ingroup msg_task_usage + * @brief Receives a task from a mailbox from a specific host with a given timeout and at a given rate. + * + * @param task a memory location for storing a #msg_task_t. + * @param alias name of the mailbox to receive the task from + * @param timeout is the maximum wait time for completion (provide -1 for no timeout) + * @param host a #msg_host_t host from where the task was sent + * @param rate limit the reception to rate bandwidth (byte/sec) * - * \param task a memory location for storing a #msg_task_t. - * \param alias name of the mailbox to receive the task from - * \param timeout is the maximum wait time for completion (provide -1 for no timeout) - * \param host a #msg_host_t host from where the task was sent - * \param rate limit the reception to rate bandwidth + * The rate parameter can be used to receive a task with a limited + * bandwidth (smaller than the physical available value). Use + * MSG_task_receive_ext() if you don't limit the rate (or pass -1 as a + * rate value do disable this feature). * - * \return Returns + * @return Returns * #MSG_OK if the task was successfully received, * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise. */ @@ -250,14 +255,13 @@ msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, d double rate) { XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias); - simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::byName(alias); + simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias); msg_error_t ret = MSG_OK; /* We no longer support getting a task from a specific host */ if (host) THROW_UNIMPLEMENTED; TRACE_msg_task_get_start(); - double start_time = MSG_get_clock(); /* Sanity check */ xbt_assert(task, "Null pointer for the task storage"); @@ -267,42 +271,41 @@ msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, d /* Try to receive it by calling SIMIX network layer */ try { - simcall_comm_recv(MSG_process_self()->getImpl(), mailbox->getImpl(), task, nullptr, nullptr, nullptr, nullptr, timeout, rate); - XBT_DEBUG("Got task %s from %s",(*task)->name,mailbox->name()); + simcall_comm_recv(MSG_process_self()->get_impl(), mailbox->get_impl(), task, nullptr, nullptr, nullptr, nullptr, + timeout, rate); + XBT_DEBUG("Got task %s from %s", (*task)->name, mailbox->get_cname()); (*task)->simdata->setNotUsed(); - } - catch (xbt_ex& e) { + } catch (simgrid::HostFailureException& e) { + ret = MSG_HOST_FAILURE; + } catch (simgrid::TimeoutError& e) { + ret = MSG_TIMEOUT; + } catch (xbt_ex& e) { switch (e.category) { - case host_error: case cancel_error: ret = MSG_HOST_FAILURE; break; case network_error: ret = MSG_TRANSFER_FAILURE; break; - case timeout_error: - ret = MSG_TIMEOUT; - break; default: throw; } } if (ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) { - TRACE_msg_task_get_end(start_time, *task); + TRACE_msg_task_get_end(*task); } return ret; } -/* Internal function used to factorize code between MSG_task_isend_with_matching() and MSG_task_dsend(). */ -static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char *alias, - int (*match_fun)(void*,void*, smx_activity_t), - void *match_data, void_f_pvoid_t cleanup, int detached) +/* Internal function used to factorize code between MSG_task_isend(), MSG_task_isend_bounded(), and MSG_task_dsend(). */ +static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char* alias, + void_f_pvoid_t cleanup, int detached) { simdata_task_t t_simdata = nullptr; msg_process_t myself = MSG_process_self(); - simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::byName(alias); - int call_end = TRACE_msg_task_put_start(task); + simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias); + TRACE_msg_task_put_start(task); /* Prepare the task to send */ t_simdata = task->simdata; @@ -313,80 +316,56 @@ static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char *al msg_global->sent_msg++; /* Send it by calling SIMIX network layer */ - smx_activity_t act = simcall_comm_isend(myself->getImpl(), mailbox->getImpl(), t_simdata->bytes_amount, t_simdata->rate, - task, sizeof(void *), match_fun, cleanup, nullptr, match_data,detached); - t_simdata->comm = static_cast(act); + smx_activity_t act = + simcall_comm_isend(myself->get_impl(), mailbox->get_impl(), t_simdata->bytes_amount, t_simdata->rate, task, + sizeof(void*), nullptr, cleanup, nullptr, nullptr, detached); + t_simdata->comm = boost::static_pointer_cast(act); msg_comm_t comm = nullptr; if (not detached) { - comm = xbt_new0(s_msg_comm_t, 1); - comm->task_sent = task; - comm->task_received = nullptr; - comm->status = MSG_OK; - comm->s_comm = act; + comm = new simgrid::msg::Comm(task, nullptr, act); } if (TRACE_is_enabled()) simcall_set_category(act, task->category); - if (call_end) - TRACE_msg_task_put_end(); + TRACE_msg_task_put_end(); return comm; } -/** \ingroup msg_task_usage - * \brief Sends a task on a mailbox. +/** @ingroup msg_task_usage + * @brief Sends a task on a mailbox. * * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. * - * \param task a #msg_task_t to send on another location. - * \param alias name of the mailbox to sent the task to - * \return the msg_comm_t communication created + * @param task a #msg_task_t to send on another location. + * @param alias name of the mailbox to sent the task to + * @return the msg_comm_t communication created */ msg_comm_t MSG_task_isend(msg_task_t task, const char *alias) { - return MSG_task_isend_internal(task, alias, nullptr, nullptr, nullptr, 0); + return MSG_task_isend_internal(task, alias, nullptr, 0); } -/** \ingroup msg_task_usage - * \brief Sends a task on a mailbox with a maximum rate +/** @ingroup msg_task_usage + * @brief Sends a task on a mailbox with a maximum rate * * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. The maxrate * parameter allows the application to limit the bandwidth utilization of network links when sending the task. * - * \param task a #msg_task_t to send on another location. - * \param alias name of the mailbox to sent the task to - * \param maxrate the maximum communication rate for sending this task . - * \return the msg_comm_t communication created + * @param task a #msg_task_t to send on another location. + * @param alias name of the mailbox to sent the task to + * @param maxrate the maximum communication rate for sending this task (byte/sec). + * @return the msg_comm_t communication created */ msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate) { task->simdata->rate = maxrate; - return MSG_task_isend_internal(task, alias, nullptr, nullptr, nullptr, 0); -} - -/** \ingroup msg_task_usage - * \brief Sends a task on a mailbox, with support for matching requests - * - * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. - * - * \param task a #msg_task_t to send on another location. - * \param alias name of the mailbox to sent the task to - * \param match_fun boolean function which parameters are: - * - match_data_provided_here - * - match_data_provided_by_other_side_if_any - * - the_smx_synchro_describing_the_other_side - * \param match_data user provided data passed to match_fun - * \return the msg_comm_t communication created - */ -msg_comm_t MSG_task_isend_with_matching(msg_task_t task, const char *alias, - int (*match_fun)(void*, void*, smx_activity_t), void *match_data) -{ - return MSG_task_isend_internal(task, alias, match_fun, match_data, nullptr, 0); + return MSG_task_isend_internal(task, alias, nullptr, 0); } -/** \ingroup msg_task_usage - * \brief Sends a task on a mailbox. +/** @ingroup msg_task_usage + * @brief Sends a task on a mailbox. * * This is a non blocking detached send function. * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails. @@ -395,18 +374,19 @@ msg_comm_t MSG_task_isend_with_matching(msg_task_t task, const char *alias, * this thread * in the SimGrid-user mailing list archive. * - * \param task a #msg_task_t to send on another location. - * \param alias name of the mailbox to sent the task to - * \param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy + * @param task a #msg_task_t to send on another location. + * @param alias name of the mailbox to sent the task to + * @param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy * (if nullptr, no function will be called) */ void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup) { - MSG_task_isend_internal(task, alias, nullptr, nullptr, cleanup, 1); + msg_comm_t XBT_ATTRIB_UNUSED comm = MSG_task_isend_internal(task, alias, cleanup, 1); + xbt_assert(comm == nullptr); } -/** \ingroup msg_task_usage - * \brief Sends a task on a mailbox with a maximal rate. +/** @ingroup msg_task_usage + * @brief Sends a task on a mailbox with a maximal rate. * * This is a non blocking detached send function. * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails. @@ -415,12 +395,17 @@ void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup) * this thread * in the SimGrid-user mailing list archive. * - * \param task a #msg_task_t to send on another location. - * \param alias name of the mailbox to sent the task to - * \param cleanup a function to destroy the task if the + * The rate parameter can be used to send a task with a limited + * bandwidth (smaller than the physical available value). Use + * MSG_task_dsend() if you don't limit the rate (or pass -1 as a rate + * value do disable this feature). + * + * @param task a #msg_task_t to send on another location. + * @param alias name of the mailbox to sent the task to + * @param cleanup a function to destroy the task if the * communication fails, e.g. MSG_task_destroy * (if nullptr, no function will be called) - * \param maxrate the maximum communication rate for sending this task + * @param maxrate the maximum communication rate for sending this task (byte/sec) * */ void MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate) @@ -429,31 +414,36 @@ void MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t c MSG_task_dsend(task, alias, cleanup); } -/** \ingroup msg_task_usage - * \brief Starts listening for receiving a task from an asynchronous communication. +/** @ingroup msg_task_usage + * @brief Starts listening for receiving a task from an asynchronous communication. * * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. * - * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication. - * \param name of the mailbox to receive the task on - * \return the msg_comm_t communication created + * @param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication. + * @param name of the mailbox to receive the task on + * @return the msg_comm_t communication created */ msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name) { return MSG_task_irecv_bounded(task, name, -1.0); } -/** \ingroup msg_task_usage - * \brief Starts listening for receiving a task from an asynchronous communication at a given rate. +/** @ingroup msg_task_usage + * @brief Starts listening for receiving a task from an asynchronous communication at a given rate. + * + * The rate parameter can be used to receive a task with a limited + * bandwidth (smaller than the physical available value). Use + * MSG_task_irecv() if you don't limit the rate (or pass -1 as a rate + * value do disable this feature). * - * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication. - * \param name of the mailbox to receive the task on - * \param rate limit the bandwidth to the given rate - * \return the msg_comm_t communication created + * @param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication. + * @param name of the mailbox to receive the task on + * @param rate limit the bandwidth to the given rate (byte/sec) + * @return the msg_comm_t communication created */ msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rate) { - simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::byName(name); + simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(name); /* FIXME: these functions are not traceable */ /* Sanity check */ @@ -463,57 +453,51 @@ msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rat XBT_CRITICAL("MSG_task_irecv() was asked to write in a non empty task struct."); /* Try to receive it by calling SIMIX network layer */ - msg_comm_t comm = xbt_new0(s_msg_comm_t, 1); - comm->task_sent = nullptr; - comm->task_received = task; - comm->status = MSG_OK; - comm->s_comm = simcall_comm_irecv(SIMIX_process_self(), mbox->getImpl(), task, nullptr, nullptr, nullptr, nullptr, rate); + msg_comm_t comm = new simgrid::msg::Comm( + nullptr, task, + simcall_comm_irecv(SIMIX_process_self(), mbox->get_impl(), task, nullptr, nullptr, nullptr, nullptr, rate)); return comm; } -/** \ingroup msg_task_usage - * \brief Checks whether a communication is done, and if yes, finalizes it. - * \param comm the communication to test - * \return TRUE if the communication is finished +/** @ingroup msg_task_usage + * @brief Checks whether a communication is done, and if yes, finalizes it. + * @param comm the communication to test + * @return 'true' if the communication is finished * (but it may have failed, use MSG_comm_get_status() to know its status) - * or FALSE if the communication is not finished yet - * If the status is FALSE, don't forget to use MSG_process_sleep() after the test. + * or 'false' if the communication is not finished yet + * If the status is 'false', don't forget to use MSG_process_sleep() after the test. */ int MSG_comm_test(msg_comm_t comm) { - int finished = 0; + bool finished = false; try { finished = simcall_comm_test(comm->s_comm); if (finished && comm->task_received != nullptr) { /* I am the receiver */ (*comm->task_received)->simdata->setNotUsed(); - comm->s_comm->unref(); } + } catch (simgrid::TimeoutError& e) { + comm->status = MSG_TIMEOUT; + finished = true; } catch (xbt_ex& e) { - switch (e.category) { - case network_error: - comm->status = MSG_TRANSFER_FAILURE; - finished = 1; - break; - case timeout_error: - comm->status = MSG_TIMEOUT; - finished = 1; - break; - default: - throw; + if (e.category == network_error) { + comm->status = MSG_TRANSFER_FAILURE; + finished = true; + } else { + throw; } } return finished; } -/** \ingroup msg_task_usage - * \brief This function checks if a communication is finished. - * \param comms a vector of communications - * \return the position of the finished communication if any +/** @ingroup msg_task_usage + * @brief This function checks if a communication is finished. + * @param comms a vector of communications + * @return the position of the finished communication if any * (but it may have failed, use MSG_comm_get_status() to know its status), * or -1 if none is finished */ @@ -522,7 +506,7 @@ int MSG_comm_testany(xbt_dynar_t comms) int finished_index = -1; /* Create the equivalent array with SIMIX objects: */ - std::vector s_comms; + std::vector s_comms; s_comms.reserve(xbt_dynar_length(comms)); msg_comm_t comm; unsigned int cursor; @@ -533,6 +517,9 @@ int MSG_comm_testany(xbt_dynar_t comms) msg_error_t status = MSG_OK; try { finished_index = simcall_comm_testany(s_comms.data(), s_comms.size()); + } catch (simgrid::TimeoutError& e) { + finished_index = e.value; + status = MSG_TIMEOUT; } catch (xbt_ex& e) { switch (e.category) { @@ -540,10 +527,6 @@ int MSG_comm_testany(xbt_dynar_t comms) finished_index = e.value; status = MSG_TRANSFER_FAILURE; break; - case timeout_error: - finished_index = e.value; - status = MSG_TIMEOUT; - break; default: throw; } @@ -557,36 +540,34 @@ int MSG_comm_testany(xbt_dynar_t comms) if (status == MSG_OK && comm->task_received != nullptr) { /* I am the receiver */ (*comm->task_received)->simdata->setNotUsed(); - comm->s_comm->unref(); } } return finished_index; } -/** \ingroup msg_task_usage - * \brief Destroys a communication. - * \param comm the communication to destroy. +/** @ingroup msg_task_usage + * @brief Destroys a communication. + * @param comm the communication to destroy. */ void MSG_comm_destroy(msg_comm_t comm) { - xbt_free(comm); + delete comm; } -/** \ingroup msg_task_usage - * \brief Wait for the completion of a communication. +/** @ingroup msg_task_usage + * @brief Wait for the completion of a communication. * * It takes two parameters. - * \param comm the communication to wait. - * \param timeout Wait until the communication terminates or the timeout occurs. + * @param comm the communication to wait. + * @param timeout Wait until the communication terminates or the timeout occurs. * You can provide a -1 timeout to obtain an infinite timeout. - * \return msg_error_t + * @return msg_error_t */ msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout) { try { simcall_comm_wait(comm->s_comm, timeout); - comm->s_comm->unref(); if (comm->task_received != nullptr) { /* I am the receiver */ @@ -594,40 +575,36 @@ msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout) } /* FIXME: these functions are not traceable */ + } catch (simgrid::TimeoutError& e) { + comm->status = MSG_TIMEOUT; } catch (xbt_ex& e) { - switch (e.category) { - case network_error: + if (e.category == network_error) comm->status = MSG_TRANSFER_FAILURE; - break; - case timeout_error: - comm->status = MSG_TIMEOUT; - break; - default: + else throw; - } } return comm->status; } -/** \ingroup msg_task_usage -* \brief This function is called by a sender and permit to wait for each communication -* -* \param comm a vector of communication -* \param nb_elem is the size of the comm vector -* \param timeout for each call of MSG_comm_wait -*/ +/** @ingroup msg_task_usage + * @brief This function is called by a sender and permit to wait for each communication + * + * @param comm a vector of communication + * @param nb_elem is the size of the comm vector + * @param timeout for each call of MSG_comm_wait + */ void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout) { for (int i = 0; i < nb_elem; i++) MSG_comm_wait(comm[i], timeout); } -/** \ingroup msg_task_usage - * \brief This function waits for the first communication finished in a list. - * \param comms a vector of communications - * \return the position of the first finished communication +/** @ingroup msg_task_usage + * @brief This function waits for the first communication finished in a list. + * @param comms a vector of communications + * @return the position of the first finished communication * (but it may have failed, use MSG_comm_get_status() to know its status) */ int MSG_comm_waitany(xbt_dynar_t comms) @@ -635,29 +612,29 @@ int MSG_comm_waitany(xbt_dynar_t comms) int finished_index = -1; /* create the equivalent dynar with SIMIX objects */ - xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_activity_t), nullptr); + xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_activity_t), [](void*ptr){ + intrusive_ptr_release(*(simgrid::kernel::activity::ActivityImpl**)ptr); + }); msg_comm_t comm; unsigned int cursor; xbt_dynar_foreach(comms, cursor, comm) { - xbt_dynar_push(s_comms, &comm->s_comm); + intrusive_ptr_add_ref(comm->s_comm.get()); + xbt_dynar_push_as(s_comms, simgrid::kernel::activity::ActivityImpl*, comm->s_comm.get()); } msg_error_t status = MSG_OK; try { finished_index = simcall_comm_waitany(s_comms, -1); + } catch (simgrid::TimeoutError& e) { + finished_index = e.value; + status = MSG_TIMEOUT; } catch(xbt_ex& e) { - switch (e.category) { - case network_error: - finished_index = e.value; - status = MSG_TRANSFER_FAILURE; - break; - case timeout_error: - finished_index = e.value; - status = MSG_TIMEOUT; - break; - default: - throw; + if (e.category == network_error) { + finished_index = e.value; + status = MSG_TRANSFER_FAILURE; + } else { + throw; } } @@ -671,17 +648,16 @@ int MSG_comm_waitany(xbt_dynar_t comms) if (comm->task_received != nullptr) { /* I am the receiver */ (*comm->task_received)->simdata->setNotUsed(); - comm->s_comm->unref(); } return finished_index; } /** - * \ingroup msg_task_usage - * \brief Returns the error (if any) that occurred during a finished communication. - * \param comm a finished communication - * \return the status of the communication, or #MSG_OK if no error occurred + * @ingroup msg_task_usage + * @brief Returns the error (if any) that occurred during a finished communication. + * @param comm a finished communication + * @return the status of the communication, or #MSG_OK if no error occurred * during the communication */ msg_error_t MSG_comm_get_status(msg_comm_t comm) { @@ -689,11 +665,11 @@ msg_error_t MSG_comm_get_status(msg_comm_t comm) { return comm->status; } -/** \ingroup msg_task_usage - * \brief Get a task (#msg_task_t) from a communication +/** @ingroup msg_task_usage + * @brief Get a task (#msg_task_t) from a communication * - * \param comm the communication where to get the task - * \return the task from the communication + * @param comm the communication where to get the task + * @return the task from the communication */ msg_task_t MSG_comm_get_task(msg_comm_t comm) { @@ -703,14 +679,15 @@ msg_task_t MSG_comm_get_task(msg_comm_t comm) } /** - * \brief This function is called by SIMIX in kernel mode to copy the data of a comm. - * \param synchro the comm - * \param buff the data copied - * \param buff_size size of the buffer + * @brief This function is called by SIMIX in kernel mode to copy the data of a comm. + * @param synchro the comm + * @param buff the data copied + * @param buff_size size of the buffer */ void MSG_comm_copy_data_from_SIMIX(smx_activity_t synchro, void* buff, size_t buff_size) { - simgrid::kernel::activity::CommImpl* comm = static_cast(synchro); + simgrid::kernel::activity::CommImplPtr comm = + boost::static_pointer_cast(synchro); SIMIX_comm_copy_pointer_callback(comm, buff, buff_size); @@ -721,17 +698,17 @@ void MSG_comm_copy_data_from_SIMIX(smx_activity_t synchro, void* buff, size_t bu } } -/** \ingroup msg_task_usage - * \brief Sends a task to a mailbox +/** @ingroup msg_task_usage + * @brief Sends a task to a mailbox * * This is a blocking function, the execution flow will be blocked until the task is sent (and received on the other * side if #MSG_task_receive is used). * See #MSG_task_isend for sending tasks asynchronously. * - * \param task the task to be sent - * \param alias the mailbox name to where the task is sent + * @param task the task to be sent + * @param alias the mailbox name to where the task is sent * - * \return Returns #MSG_OK if the task was successfully sent, + * @return Returns #MSG_OK if the task was successfully sent, * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise. */ msg_error_t MSG_task_send(msg_task_t task, const char *alias) @@ -740,17 +717,22 @@ msg_error_t MSG_task_send(msg_task_t task, const char *alias) return MSG_task_send_with_timeout(task, alias, -1); } -/** \ingroup msg_task_usage - * \brief Sends a task to a mailbox with a maximum rate +/** @ingroup msg_task_usage + * @brief Sends a task to a mailbox with a maximum rate * * This is a blocking function, the execution flow will be blocked until the task is sent. The maxrate parameter allows * the application to limit the bandwidth utilization of network links when sending the task. * - * \param task the task to be sent - * \param alias the mailbox name to where the task is sent - * \param maxrate the maximum communication rate for sending this task + * The maxrate parameter can be used to send a task with a limited + * bandwidth (smaller than the physical available value). Use + * MSG_task_send() if you don't limit the rate (or pass -1 as a rate + * value do disable this feature). + * + * @param task the task to be sent + * @param alias the mailbox name to where the task is sent + * @param maxrate the maximum communication rate for sending this task (byte/sec) * - * \return Returns #MSG_OK if the task was successfully sent, + * @return Returns #MSG_OK if the task was successfully sent, * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise. */ msg_error_t MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate) @@ -759,16 +741,16 @@ msg_error_t MSG_task_send_bounded(msg_task_t task, const char *alias, double max return MSG_task_send(task, alias); } -/** \ingroup msg_task_usage - * \brief Sends a task to a mailbox with a timeout +/** @ingroup msg_task_usage + * @brief Sends a task to a mailbox with a timeout * * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved. * - * \param task the task to be sent - * \param alias the mailbox name to where the task is sent - * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send) + * @param task the task to be sent + * @param alias the mailbox name to where the task is sent + * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send) * - * \return Returns #MSG_OK if the task was successfully sent, + * @return Returns #MSG_OK if the task was successfully sent, * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise. */ msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout) @@ -776,9 +758,9 @@ msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, doubl msg_error_t ret = MSG_OK; simdata_task_t t_simdata = nullptr; msg_process_t process = MSG_process_self(); - simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::byName(alias); + simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias); - int call_end = TRACE_msg_task_put_start(task); + TRACE_msg_task_put_start(task); /* Prepare the task to send */ t_simdata = task->simdata; @@ -793,13 +775,14 @@ msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, doubl /* Try to send it by calling SIMIX network layer */ try { smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simix call */ - comm = simcall_comm_isend(SIMIX_process_self(), mailbox->getImpl(),t_simdata->bytes_amount, - t_simdata->rate, task, sizeof(void *), nullptr, nullptr, nullptr, task, 0); - if (TRACE_is_enabled()) + comm = simcall_comm_isend(SIMIX_process_self(), mailbox->get_impl(), t_simdata->bytes_amount, t_simdata->rate, task, + sizeof(void*), nullptr, nullptr, nullptr, nullptr, 0); + if (TRACE_is_enabled() && task->category != nullptr) simcall_set_category(comm, task->category); - t_simdata->comm = static_cast(comm); + t_simdata->comm = boost::static_pointer_cast(comm); simcall_comm_wait(comm, timeout); - comm->unref(); + } catch (simgrid::TimeoutError& e) { + ret = MSG_TIMEOUT; } catch (xbt_ex& e) { switch (e.category) { @@ -809,9 +792,6 @@ msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, doubl case network_error: ret = MSG_TRANSFER_FAILURE; break; - case timeout_error: - ret = MSG_TIMEOUT; - break; default: throw; } @@ -820,22 +800,26 @@ msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, doubl t_simdata->setNotUsed(); } - if (call_end) - TRACE_msg_task_put_end(); + TRACE_msg_task_put_end(); return ret; } -/** \ingroup msg_task_usage - * \brief Sends a task to a mailbox with a timeout and with a maximum rate +/** @ingroup msg_task_usage + * @brief Sends a task to a mailbox with a timeout and with a maximum rate * * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved. * - * \param task the task to be sent - * \param alias the mailbox name to where the task is sent - * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send) - * \param maxrate the maximum communication rate for sending this task + * The maxrate parameter can be used to send a task with a limited + * bandwidth (smaller than the physical available value). Use + * MSG_task_send_with_timeout() if you don't limit the rate (or pass -1 as a rate + * value do disable this feature). + * + * @param task the task to be sent + * @param alias the mailbox name to where the task is sent + * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send) + * @param maxrate the maximum communication rate for sending this task (byte/sec) * - * \return Returns #MSG_OK if the task was successfully sent, + * @return Returns #MSG_OK if the task was successfully sent, * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise. */ msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate) @@ -844,31 +828,19 @@ msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alia return MSG_task_send_with_timeout(task, alias, timeout); } -/** \ingroup msg_task_usage - * \brief Check if there is a communication going on in a mailbox. +/** @ingroup msg_task_usage + * @brief Look if there is a communication on a mailbox and return the PID of the sender process. * - * \param alias the name of the mailbox to be considered + * @param alias the name of the mailbox to be considered * - * \return Returns 1 if there is a communication, 0 otherwise - */ -int MSG_task_listen(const char *alias) -{ - simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::byName(alias); - return mbox->listen() ? 1 : 0; -} - -/** \ingroup msg_task_usage - * \brief Look if there is a communication on a mailbox and return the PID of the sender process. - * - * \param alias the name of the mailbox to be considered - * - * \return Returns the PID of sender process, + * @return Returns the PID of sender process, * -1 if there is no communication in the mailbox. */ int MSG_task_listen_from(const char *alias) { - simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::byName(alias); - simgrid::kernel::activity::CommImpl* comm = static_cast(mbox->front()); + simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(alias); + simgrid::kernel::activity::CommImplPtr comm = + boost::static_pointer_cast(mbox->front()); if (not comm) return -1; @@ -876,39 +848,37 @@ int MSG_task_listen_from(const char *alias) return MSG_process_get_PID(static_cast(comm->src_buff)->simdata->sender); } -/** \ingroup msg_task_usage - * \brief Sets the tracing category of a task. +/** @ingroup msg_task_usage + * @brief Sets the tracing category of a task. * * This function should be called after the creation of a MSG task, to define the category of that task. The * first parameter task must contain a task that was created with the function #MSG_task_create. The second * parameter category must contain a category that was previously declared with the function #TRACE_category * (or with #TRACE_category_with_color). * - * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization. + * See @ref outcomes_vizu for details on how to trace the (categorized) resource utilization. * - * \param task the task that is going to be categorized - * \param category the name of the category to be associated to the task + * @param task the task that is going to be categorized + * @param category the name of the category to be associated to the task * - * \see MSG_task_get_category, TRACE_category, TRACE_category_with_color + * @see MSG_task_get_category, TRACE_category, TRACE_category_with_color */ void MSG_task_set_category (msg_task_t task, const char *category) { TRACE_msg_set_task_category (task, category); } -/** \ingroup msg_task_usage +/** @ingroup msg_task_usage * - * \brief Gets the current tracing category of a task. + * @brief Gets the current tracing category of a task. * - * \param task the task to be considered + * @param task the task to be considered * - * \see MSG_task_set_category + * @see MSG_task_set_category * - * \return Returns the name of the tracing category of the given task, nullptr otherwise + * @return Returns the name of the tracing category of the given task, nullptr otherwise */ const char *MSG_task_get_category (msg_task_t task) { return task->category; } - -SG_END_DECL()