X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/533b09bd161a7a8bef036a14bbcb8793286b9d9f..1bf033cc925aa31693ef5163ea056fde5b75ff1e:/src/msg/msg_gos.cpp diff --git a/src/msg/msg_gos.cpp b/src/msg/msg_gos.cpp index e5dc66070a..dfc6ca9495 100644 --- a/src/msg/msg_gos.cpp +++ b/src/msg/msg_gos.cpp @@ -1,18 +1,17 @@ -/* 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 "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)"); -extern "C" { - /** \ingroup msg_task_usage * \brief Executes a task and waits for its termination. * @@ -22,14 +21,7 @@ extern "C" { */ 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 @@ -120,7 +112,8 @@ msg_error_t MSG_process_sleep(double nb_sec) { msg_error_t status = MSG_OK; - 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 { simcall_process_sleep(nb_sec); @@ -139,7 +132,9 @@ msg_error_t MSG_process_sleep(double nb_sec) throw; } - TRACE_msg_process_sleep_out(MSG_process_self()); + if (TRACE_actor_is_enabled()) + simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->pop_event(); + return status; } @@ -166,7 +161,12 @@ 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, @@ -203,7 +203,12 @@ msg_error_t 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, @@ -243,7 +248,12 @@ msg_error_t MSG_task_receive_ext(msg_task_t * task, const char *alias, double ti * \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, @@ -253,7 +263,7 @@ 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) @@ -269,8 +279,9 @@ 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->getCname()); + 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) { @@ -296,15 +307,14 @@ msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, d return ret; } -/* Internal function used to factorize code between MSG_task_isend_with_matching() and MSG_task_dsend(). */ +/* 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, - int (*match_fun)(void*, void*, void*), void* match_data, 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; @@ -316,8 +326,8 @@ static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char* al /* 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*), (simix_match_func_t)match_fun, cleanup, nullptr, match_data, detached); + 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; @@ -327,8 +337,7 @@ static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char* al 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; } @@ -344,7 +353,7 @@ static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char* al */ 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 @@ -355,33 +364,13 @@ msg_comm_t MSG_task_isend(msg_task_t task, const char *alias) * * \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) { 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*, void*), - 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 @@ -401,7 +390,8 @@ msg_comm_t MSG_task_isend_with_matching(msg_task_t task, const char* alias, int */ 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 @@ -414,12 +404,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. * + * 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) @@ -445,14 +440,19 @@ 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. * + * 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) { - 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 */ @@ -462,9 +462,9 @@ 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 = - new simgrid::msg::Comm(nullptr, task, 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; } @@ -472,14 +472,14 @@ msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rat /** \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) { - int finished = 0; + bool finished = false; try { finished = simcall_comm_test(comm->s_comm); @@ -492,11 +492,11 @@ int MSG_comm_test(msg_comm_t comm) 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: throw; @@ -743,9 +743,14 @@ msg_error_t MSG_task_send(msg_task_t task, const char *alias) * 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. @@ -773,9 +778,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; @@ -790,8 +795,8 @@ 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); + 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); @@ -816,8 +821,7 @@ 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; } @@ -826,10 +830,15 @@ msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, doubl * * 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. @@ -849,7 +858,7 @@ msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alia */ int MSG_task_listen(const char *alias) { - simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::byName(alias); + simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(alias); return mbox->listen() ? 1 : 0; } @@ -863,7 +872,7 @@ int MSG_task_listen(const char *alias) */ int MSG_task_listen_from(const char *alias) { - simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::byName(alias); + simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(alias); simgrid::kernel::activity::CommImplPtr comm = boost::static_pointer_cast(mbox->front()); @@ -907,4 +916,3 @@ const char *MSG_task_get_category (msg_task_t task) { return task->category; } -}