X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3ef6ce6e499e5400eea06facd1896d1b5e94fde9..1bf033cc925aa31693ef5163ea056fde5b75ff1e:/src/msg/msg_gos.cpp diff --git a/src/msg/msg_gos.cpp b/src/msg/msg_gos.cpp index e89d7d1e79..dfc6ca9495 100644 --- a/src/msg/msg_gos.cpp +++ b/src/msg/msg_gos.cpp @@ -1,38 +1,27 @@ -/* Copyright (c) 2004-2015. 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 "msg_private.h" -#include "msg_mailbox.h" -#include "mc/mc.h" -#include "xbt/log.h" -#include "xbt/sysdep.h" +#include -XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, - "Logging specific to MSG (gos)"); +#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)"); /** \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. + * 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 + * \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 @@ -45,67 +34,49 @@ msg_error_t MSG_task_execute(msg_task_t task) */ msg_error_t MSG_parallel_task_execute(msg_task_t task) { - xbt_ex_t e; + return MSG_parallel_task_execute_with_timeout(task, -1); +} + +msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout) +{ simdata_task_t simdata = task->simdata; - msg_process_t self = SIMIX_process_self(); - simdata_process_t p_simdata = (simdata_process_t) SIMIX_process_self_get_data(self); e_smx_state_t comp_state; msg_error_t status = MSG_OK; TRACE_msg_task_execute_start(task); - xbt_assert((!simdata->compute) && (task->simdata->isused == 0), - "This task is executed somewhere else. Go fix your code! %d", - task->simdata->isused!=NULL); + xbt_assert((not simdata->compute) && not task->simdata->isused, + "This task is executed somewhere else. Go fix your code!"); XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self())); - if (simdata->flops_amount == 0 && !simdata->host_nb) { + if (simdata->flops_amount <= 0.0 && not simdata->host_nb) { TRACE_msg_task_execute_end(task); return MSG_OK; } - - TRY { - if (msg_global->debug_multiple_use) - MSG_BT(simdata->isused, "Using Backtrace"); - else - simdata->isused = (void*)1; + try { + simdata->setUsed(); if (simdata->host_nb > 0) { - simdata->compute = simcall_execution_parallel_start(task->name, - simdata->host_nb, - simdata->host_list, - simdata->flops_parallel_amount, - simdata->bytes_parallel_amount, - 1.0, -1.0); - 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()); } else { - unsigned long affinity_mask = (unsigned long)(uintptr_t) xbt_dict_get_or_null_ext(simdata->affinity_mask_db, (char *) p_simdata->m_host, sizeof(msg_host_t)); - XBT_DEBUG("execute %s@%s with affinity(0x%04lx)", MSG_task_get_name(task), MSG_host_get_name(p_simdata->m_host), affinity_mask); - - simdata->compute = simcall_execution_start(task->name, - simdata->flops_amount, - simdata->priority, - simdata->bound, - affinity_mask - ); - + simdata->compute = boost::static_pointer_cast( + simcall_execution_start(task->name, simdata->flops_amount, simdata->priority, simdata->bound, + MSG_process_get_host(MSG_process_self()))); } simcall_set_category(simdata->compute, task->category); - p_simdata->waiting_action = simdata->compute; comp_state = simcall_execution_wait(simdata->compute); - p_simdata->waiting_action = NULL; + simdata->setNotUsed(); - if (msg_global->debug_multiple_use && simdata->isused!=0) - xbt_ex_free(*(xbt_ex_t*)simdata->isused); - simdata->isused = 0; - - XBT_DEBUG("Execution task '%s' finished in state %d", - task->name, (int)comp_state); + XBT_DEBUG("Execution task '%s' finished in state %d", task->name, (int)comp_state); } - CATCH(e) { + catch (xbt_ex& e) { switch (e.category) { case cancel_error: status = MSG_TASK_CANCELED; @@ -113,22 +84,23 @@ msg_error_t MSG_parallel_task_execute(msg_task_t task) case host_error: status = MSG_HOST_FAILURE; break; + case timeout_error: + status = MSG_TIMEOUT; + break; default: - RETHROW; + throw; } - xbt_ex_free(e); } - /* action ended, set comm and compute = NULL, the actions is already destroyed - * in the main function */ + + /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */ simdata->flops_amount = 0.0; - simdata->comm = NULL; - simdata->compute = NULL; + simdata->comm = nullptr; + simdata->compute = nullptr; TRACE_msg_task_execute_end(task); - MSG_RETURN(status); + return status; } - /** \ingroup msg_task_usage * \brief Sleep for the specified number of seconds * @@ -138,42 +110,38 @@ msg_error_t MSG_parallel_task_execute(msg_task_t task) */ msg_error_t MSG_process_sleep(double nb_sec) { - xbt_ex_t e; msg_error_t status = MSG_OK; - /*msg_process_t proc = MSG_process_self();*/ - TRACE_msg_process_sleep_in(MSG_process_self()); + if (TRACE_actor_is_enabled()) + simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->push_event("sleep"); - TRY { + try { simcall_process_sleep(nb_sec); } - CATCH(e) { - switch (e.category) { - case cancel_error: - XBT_DEBUG("According to the JAVA API, a sleep call should only deal with HostFailureException, WTF here ?"); + 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."); // 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; - break; - default: - RETHROW; - } - xbt_ex_free(e); + } else + throw; } - TRACE_msg_process_sleep_out(MSG_process_self()); - MSG_RETURN(status); + if (TRACE_actor_is_enabled()) + simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->pop_event(); + + return status; } /** \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 + * 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. @@ -193,14 +161,18 @@ msg_error_t MSG_task_receive(msg_task_t * task, const char *alias) * * \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 rate limit the reception to rate bandwidth (byte/sec) + * + * 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. */ -msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, - double rate) +msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, double rate) { return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate); } @@ -208,9 +180,8 @@ msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, /** \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 + * 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. @@ -221,11 +192,9 @@ msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, * #MSG_OK if the task was successfully received, * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise. */ -msg_error_t -MSG_task_receive_with_timeout(msg_task_t * task, const char *alias, - double timeout) +msg_error_t MSG_task_receive_with_timeout(msg_task_t * task, const char *alias, double timeout) { - return MSG_task_receive_ext(task, alias, timeout, NULL); + return MSG_task_receive_ext(task, alias, timeout, nullptr); } /** \ingroup msg_task_usage @@ -234,25 +203,27 @@ MSG_task_receive_with_timeout(msg_task_t * task, const char *alias, * \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 + * \param rate limit the reception to rate bandwidth (byte/sec) + * + * 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 * #MSG_OK if the task was successfully received, * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise. */ -msg_error_t -MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, - double timeout,double rate) +msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, double timeout,double rate) { - return MSG_task_receive_ext_bounded(task, alias, timeout, NULL, rate); + 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. * - * 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 + * 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. @@ -264,126 +235,117 @@ MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, * #MSG_OK if the task was successfully received, * #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) +msg_error_t MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout, msg_host_t host) { - xbt_ex_t e; - msg_error_t ret = MSG_OK; - XBT_DEBUG - ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", - alias); - TRY { - ret = MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task, - host, timeout); - } - CATCH(e) { - switch (e.category) { - case cancel_error: /* may be thrown by MSG_mailbox_get_by_alias */ - ret = MSG_HOST_FAILURE; - break; - default: - RETHROW; - } - xbt_ex_free(e); - } - return ret; + XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias); + 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. + * \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 + * \param rate limit the reception to rate bandwidth (byte/sec) + * + * 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 * #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_bounded(msg_task_t * task, const char *alias, double timeout, - msg_host_t host, double rate) +msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout, msg_host_t host, + double rate) { - XBT_DEBUG - ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", - alias); - return MSG_mailbox_get_task_ext_bounded(MSG_mailbox_get_by_alias(alias), task, - host, timeout, rate); + XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", 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(); + + /* Sanity check */ + xbt_assert(task, "Null pointer for the task storage"); + + if (*task) + XBT_WARN("Asked to write the received task in a non empty struct -- proceeding."); + + /* Try to receive it by calling SIMIX network layer */ + try { + 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) { + 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(*task); + } + return ret; } -/* Internal function used to factorize code between - * MSG_task_isend_with_matching() and MSG_task_dsend(). - */ -static XBT_INLINE -msg_comm_t MSG_task_isend_internal(msg_task_t task, const char *alias, - int (*match_fun)(void*,void*, smx_synchro_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 = NULL; - msg_process_t process = MSG_process_self(); - msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias); - int call_end = TRACE_msg_task_put_start(task); + simdata_task_t t_simdata = nullptr; + msg_process_t myself = MSG_process_self(); + 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; - t_simdata->sender = process; - t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host; - - if (t_simdata->isused != 0) { - if (msg_global->debug_multiple_use){ - XBT_ERROR("This task is already used in there:"); - xbt_backtrace_display((xbt_ex_t*) t_simdata->isused); - XBT_ERROR("And you try to reuse it from here:"); - xbt_backtrace_display_current(); - } else { - xbt_assert(t_simdata->isused == 0, - "This task is still being used somewhere else. You cannot send it now. Go fix your code! (use --cfg=msg/debug_multiple_use:on to get the backtrace of the other process)"); - } - } - - if (msg_global->debug_multiple_use) - MSG_BT(t_simdata->isused, "Using Backtrace"); - else - t_simdata->isused = (void*)1; - t_simdata->comm = NULL; + t_simdata->sender = myself; + t_simdata->source = MSG_host_self(); + t_simdata->setUsed(); + t_simdata->comm = nullptr; msg_global->sent_msg++; /* Send it by calling SIMIX network layer */ - smx_synchro_t act = simcall_comm_isend(SIMIX_process_self(), mailbox, t_simdata->bytes_amount, - t_simdata->rate, task, sizeof(void *), - match_fun, cleanup, NULL, match_data,detached); - t_simdata->comm = act; /* FIXME: is the field t_simdata->comm still useful? */ - - msg_comm_t comm; - if (detached) { - comm = NULL; - } else { - comm = xbt_new0(s_msg_comm_t, 1); - comm->task_sent = task; - comm->task_received = NULL; - comm->status = MSG_OK; - comm->s_comm = 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 = 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. * - * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() - * to end the communication. + * 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 @@ -391,95 +353,71 @@ msg_comm_t MSG_task_isend_internal(msg_task_t task, const char *alias, */ msg_comm_t MSG_task_isend(msg_task_t task, const char *alias) { - return MSG_task_isend_internal(task, alias, NULL, NULL, NULL, 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 * - * 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. + * 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 . + * \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) +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, NULL, NULL, NULL, 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_synchro_t), - void *match_data) -{ - return MSG_task_isend_internal(task, alias, match_fun, match_data, NULL, 0); + return MSG_task_isend_internal(task, alias, nullptr, 0); } /** \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. If the communication does work, - * it is responsibility of the receiver code to free anything related to - * the task, as usual. More details on this can be obtained on + * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails. + * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as + * usual. More details on this can be obtained on * 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 - * (if NULL, no function will be called) + * \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, NULL, NULL, 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. * * 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. If the communication does work, - * it is responsibility of the receiver code to free anything related to - * the task, as usual. More details on this can be obtained on + * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails. + * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as + * usual. More details on this can be obtained on * this thread * in the SimGrid-user mailing list archive. * + * 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 NULL, no function will be called) - * \param maxrate the maximum communication rate for sending this task + * (if nullptr, no function will be called) + * \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) +void MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate) { task->simdata->rate = maxrate; MSG_task_dsend(task, alias, cleanup); @@ -488,8 +426,7 @@ void MSG_task_dsend_bounded(msg_task_t task, const char *alias, /** \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. + * 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 @@ -501,34 +438,33 @@ msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name) } /** \ingroup msg_task_usage - * \brief Starts listening for receiving a task from an asynchronous communication - * at a given rate. + * \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 + * \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) +msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rate) { - smx_rdv_t rdv = MSG_mailbox_get_by_alias(name); + simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(name); /* FIXME: these functions are not traceable */ - /* Sanity check */ xbt_assert(task, "Null pointer for the task storage"); if (*task) - XBT_CRITICAL - ("MSG_task_irecv() was asked to write in a non empty task struct."); + 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 = NULL; - comm->task_received = task; - comm->status = MSG_OK; - comm->s_comm = simcall_comm_irecv(MSG_process_self(), rdv, task, NULL, NULL, NULL, NULL, 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; } @@ -536,42 +472,35 @@ msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, /** \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 + * \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) { - xbt_ex_t e; - int finished = 0; + bool finished = false; - TRY { + try { finished = simcall_comm_test(comm->s_comm); - - if (finished && comm->task_received != NULL) { + if (finished && comm->task_received != nullptr) { /* I am the receiver */ - if (msg_global->debug_multiple_use && (*comm->task_received)->simdata->isused!=0) - xbt_ex_free(*(xbt_ex_t*)(*comm->task_received)->simdata->isused); - (*comm->task_received)->simdata->isused = 0; + (*comm->task_received)->simdata->setNotUsed(); } } - CATCH(e) { + catch (xbt_ex& e) { switch (e.category) { case network_error: comm->status = MSG_TRANSFER_FAILURE; - finished = 1; + finished = true; break; - case timeout_error: comm->status = MSG_TIMEOUT; - finished = 1; + finished = true; break; - default: - RETHROW; + throw; } - xbt_ex_free(e); } return finished; @@ -586,50 +515,44 @@ int MSG_comm_test(msg_comm_t comm) */ int MSG_comm_testany(xbt_dynar_t comms) { - xbt_ex_t e; int finished_index = -1; - /* create the equivalent dynar with SIMIX objects */ - xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_synchro_t), NULL); + /* Create the equivalent array with SIMIX objects: */ + std::vector s_comms; + s_comms.reserve(xbt_dynar_length(comms)); msg_comm_t comm; unsigned int cursor; xbt_dynar_foreach(comms, cursor, comm) { - xbt_dynar_push(s_comms, &comm->s_comm); + s_comms.push_back(comm->s_comm); } msg_error_t status = MSG_OK; - TRY { - finished_index = simcall_comm_testany(s_comms); + try { + finished_index = simcall_comm_testany(s_comms.data(), s_comms.size()); } - CATCH(e) { + 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: - RETHROW; + throw; } - xbt_ex_free(e); } - xbt_dynar_free(&s_comms); if (finished_index != -1) { comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t); /* the communication is finished */ comm->status = status; - if (status == MSG_OK && comm->task_received != NULL) { + if (status == MSG_OK && comm->task_received != nullptr) { /* I am the receiver */ - if (msg_global->debug_multiple_use && (*comm->task_received)->simdata->isused!=0) - xbt_ex_free(*(xbt_ex_t*)(*comm->task_received)->simdata->isused); - (*comm->task_received)->simdata->isused = 0; + (*comm->task_received)->simdata->setNotUsed(); } } @@ -642,7 +565,7 @@ int MSG_comm_testany(xbt_dynar_t comms) */ void MSG_comm_destroy(msg_comm_t comm) { - xbt_free(comm); + delete comm; } /** \ingroup msg_task_usage @@ -650,26 +573,23 @@ void MSG_comm_destroy(msg_comm_t comm) * * It takes two parameters. * \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. + * \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 */ msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout) { - xbt_ex_t e; - TRY { + try { simcall_comm_wait(comm->s_comm, timeout); - if (comm->task_received != NULL) { + if (comm->task_received != nullptr) { /* I am the receiver */ - if (msg_global->debug_multiple_use && (*comm->task_received)->simdata->isused!=0) - xbt_ex_free(*(xbt_ex_t*)(*comm->task_received)->simdata->isused); - (*comm->task_received)->simdata->isused = 0; + (*comm->task_received)->simdata->setNotUsed(); } /* FIXME: these functions are not traceable */ } - CATCH(e) { + catch (xbt_ex& e) { switch (e.category) { case network_error: comm->status = MSG_TRANSFER_FAILURE; @@ -678,9 +598,8 @@ msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout) comm->status = MSG_TIMEOUT; break; default: - RETHROW; + throw; } - xbt_ex_free(e); } return comm->status; @@ -695,10 +614,8 @@ msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout) */ void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout) { - int i = 0; - for (i = 0; i < nb_elem; i++) { + for (int i = 0; i < nb_elem; i++) MSG_comm_wait(comm[i], timeout); - } } /** \ingroup msg_task_usage @@ -709,37 +626,36 @@ void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout) */ int MSG_comm_waitany(xbt_dynar_t comms) { - xbt_ex_t e; int finished_index = -1; /* create the equivalent dynar with SIMIX objects */ - xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_synchro_t), NULL); + 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); + try { + finished_index = simcall_comm_waitany(s_comms, -1); } - CATCH(e) { + 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: - RETHROW; + throw; } - xbt_ex_free(e); } xbt_assert(finished_index != -1, "WaitAny returned -1"); @@ -749,11 +665,9 @@ int MSG_comm_waitany(xbt_dynar_t comms) /* the communication is finished */ comm->status = status; - if (comm->task_received != NULL) { + if (comm->task_received != nullptr) { /* I am the receiver */ - if (msg_global->debug_multiple_use && (*comm->task_received)->simdata->isused!=0) - xbt_ex_free(*(xbt_ex_t*)(*comm->task_received)->simdata->isused); - (*comm->task_received)->simdata->isused = 0; + (*comm->task_received)->simdata->setNotUsed(); } return finished_index; @@ -761,9 +675,9 @@ int MSG_comm_waitany(xbt_dynar_t comms) /** * \ingroup msg_task_usage - * \brief Returns the error (if any) that occured during a finished communication. + * \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 occured + * \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) { @@ -786,28 +700,29 @@ 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 comm the 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_synchro_t comm, void* buff, size_t buff_size) { +void MSG_comm_copy_data_from_SIMIX(smx_activity_t synchro, void* buff, size_t buff_size) +{ + simgrid::kernel::activity::CommImplPtr comm = + boost::static_pointer_cast(synchro); - // copy the task SIMIX_comm_copy_pointer_callback(comm, buff, buff_size); // notify the user callback if any if (msg_global->task_copy_callback) { - msg_task_t task = (msg_task_t) buff; - msg_global->task_copy_callback(task, - simcall_comm_get_src_proc(comm), simcall_comm_get_dst_proc(comm)); + msg_task_t task = static_cast(buff); + msg_global->task_copy_callback(task, comm->src_proc->ciface(), comm->dst_proc->ciface()); } } /** \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 in the other side if #MSG_task_receive is used). + * 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 @@ -825,19 +740,22 @@ msg_error_t MSG_task_send(msg_task_t task, const char *alias) /** \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. + * 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. + * + * 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 + * \param maxrate the maximum communication rate for sending this task (byte/sec) * * \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) +msg_error_t MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate) { task->simdata->rate = maxrate; return MSG_task_send(task, alias); @@ -846,8 +764,7 @@ MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate) /** \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. + * 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 @@ -856,35 +773,80 @@ MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate) * \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) +msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout) { - return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias), - task, timeout); + 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::by_name(alias); + + TRACE_msg_task_put_start(task); + + /* Prepare the task to send */ + t_simdata = task->simdata; + t_simdata->sender = process; + t_simdata->source = MSG_host_self(); + + t_simdata->setUsed(); + + t_simdata->comm = nullptr; + msg_global->sent_msg++; + + /* 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->get_impl(), t_simdata->bytes_amount, t_simdata->rate, task, + sizeof(void*), nullptr, nullptr, nullptr, nullptr, 0); + if (TRACE_is_enabled()) + simcall_set_category(comm, task->category); + t_simdata->comm = boost::static_pointer_cast(comm); + simcall_comm_wait(comm, timeout); + } + catch (xbt_ex& e) { + switch (e.category) { + 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 the send failed, it is not used anymore */ + t_simdata->setNotUsed(); + } + + 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 * - * This is a blocking function, the execution flow will be blocked - * until the task is sent or the timeout is achieved. + * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved. + * + * 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 + * \param maxrate the maximum communication rate for sending this task (byte/sec) * * \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) +msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate) { task->simdata->rate = maxrate; - return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias), - task, timeout); + return MSG_task_send_with_timeout(task, alias, timeout); } /** \ingroup msg_task_usage @@ -896,29 +858,12 @@ MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, */ int MSG_task_listen(const char *alias) { - return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias)); -} - -/** \ingroup msg_task_usage - * \brief Check the number of communication actions of a given host pending in a mailbox. - * - * \param alias the name of the mailbox to be considered - * \param host the host to check for communication - * - * \return Returns the number of pending communication actions of the host in the - * given mailbox, 0 if there is no pending communication actions. - * - */ -int MSG_task_listen_from_host(const char *alias, msg_host_t host) -{ - return - MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias - (alias), host); + simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(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. + * \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 * @@ -927,28 +872,25 @@ int MSG_task_listen_from_host(const char *alias, msg_host_t host) */ int MSG_task_listen_from(const char *alias) { - msg_task_t task; + simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(alias); + simgrid::kernel::activity::CommImplPtr comm = + boost::static_pointer_cast(mbox->front()); - if (NULL == - (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias)))) + if (not comm) return -1; - return MSG_process_get_PID(task->simdata->sender); + return MSG_process_get_PID(static_cast(comm->src_buff)->simdata->sender); } /** \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 + * 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 tracing 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 @@ -968,46 +910,9 @@ void MSG_task_set_category (msg_task_t task, const char *category) * * \see MSG_task_set_category * - * \return Returns the name of the tracing category of the given task, NULL 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; } - -/** - * \brief Returns the value of a given AS or router property - * - * \param asr the name of a router or AS - * \param name a property name - * \return value of a property (or NULL if property not set) - */ -const char *MSG_as_router_get_property_value(const char* asr, const char *name) -{ - return (char*) xbt_dict_get_or_null( - MSG_as_router_get_properties(asr), name); -} - -/** - * \brief Returns a xbt_dict_t consisting of the list of properties assigned to - * a the AS or router - * - * \param asr the name of a router or AS - * \return a dict containing the properties - */ -xbt_dict_t MSG_as_router_get_properties(const char* asr) -{ - return (simcall_asr_get_properties(asr)); -} - -/** - * \brief Change the value of a given AS or router - * - * \param asr the name of a router or AS - * \param name a property name - * \param value what to change the property to - * \param free_ctn the freeing function to use to kill the value on need - */ -void MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn) { - xbt_dict_set(MSG_as_router_get_properties(asr), name, value,free_ctn); -}