X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c3226766c8928e0dd0451f3097cd645784233328..a73d204e173f35c0abb92b26e061929066b8b283:/src/msg/msg_task.cpp diff --git a/src/msg/msg_task.cpp b/src/msg/msg_task.cpp index 3bfa850580..b83396b648 100644 --- a/src/msg/msg_task.cpp +++ b/src/msg/msg_task.cpp @@ -4,34 +4,183 @@ * under the terms of the license (GNU LGPL) which comes with this package. */ #include "msg_private.hpp" -#include "src/simix/smx_private.hpp" -#include -#include -#include +#include "src/instr/instr_private.hpp" #include +#include +#include +#include + +#include +#include XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)"); namespace simgrid { namespace msg { -Task::~Task() + +Task::Task(const std::string& name, double flops_amount, double bytes_amount, void* data) + : name_(name), userdata_(data), flops_amount(flops_amount), bytes_amount(bytes_amount) +{ + static std::atomic_ullong counter{0}; + id_ = counter++; + if (MC_is_active()) + MC_ignore_heap(&(id_), sizeof(id_)); +} + +Task::Task(const std::string& name, std::vector&& hosts, std::vector&& flops_amount, + std::vector&& bytes_amount, void* data) + : Task(name, 1.0, 0, data) +{ + parallel_ = true; + hosts_ = std::move(hosts); + flops_parallel_amount = std::move(flops_amount); + bytes_parallel_amount = std::move(bytes_amount); +} + +Task* Task::create(const std::string& name, double flops_amount, double bytes_amount, void* data) +{ + return new Task(name, flops_amount, bytes_amount, data); +} + +Task* Task::create_parallel(const std::string& name, int host_nb, const msg_host_t* host_list, double* flops_amount, + double* bytes_amount, void* data) +{ + std::vector hosts(host_list, host_list + host_nb); + std::vector flops; + std::vector bytes; + if (flops_amount != nullptr) + flops = std::vector(flops_amount, flops_amount + host_nb); + if (bytes_amount != nullptr) + bytes = std::vector(bytes_amount, bytes_amount + host_nb * host_nb); + + return new Task(name, std::move(hosts), std::move(flops), std::move(bytes), data); +} + +msg_error_t Task::execute() +{ + /* checking for infinite values */ + xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!"); + + msg_error_t status = MSG_OK; + if (flops_amount <= 0.0) + return MSG_OK; + + try { + set_used(); + if (parallel_) + compute = s4u::this_actor::exec_init(hosts_, flops_parallel_amount, bytes_parallel_amount); + else + compute = s4u::this_actor::exec_init(flops_amount); + + compute->set_name(name_) + ->set_tracing_category(tracing_category_) + ->set_timeout(timeout_) + ->set_priority(1 / priority_) + ->set_bound(bound_) + ->wait(); + + set_not_used(); + XBT_DEBUG("Execution task '%s' finished", get_cname()); + } catch (const HostFailureException&) { + status = MSG_HOST_FAILURE; + } catch (const TimeoutException&) { + status = MSG_TIMEOUT; + } catch (const CancelException&) { + status = MSG_TASK_CANCELED; + } + + /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */ + flops_amount = 0.0; + comm = nullptr; + compute = nullptr; + + return status; +} + +s4u::CommPtr Task::send_async(const std::string& alias, void_f_pvoid_t cleanup, bool detached) +{ + if (TRACE_actor_is_enabled()) { + container_t process_container = instr::Container::by_name(instr_pid(*MSG_process_self())); + std::string key = std::string("p") + std::to_string(get_id()); + instr::Container::get_root()->get_link("ACTOR_TASK_LINK")->start_event(process_container, "SR", key); + } + + /* Prepare the task to send */ + set_used(); + this->comm = nullptr; + msg_global->sent_msg++; + + s4u::CommPtr s4u_comm = s4u::Mailbox::by_name(alias)->put_init(this, bytes_amount)->set_rate(get_rate()); + if (TRACE_is_enabled() && has_tracing_category()) + s4u_comm->set_tracing_category(tracing_category_); + + comm = s4u_comm; + + if (detached) + comm->detach(cleanup); + else + comm->start(); + + return comm; +} + +msg_error_t Task::send(const std::string& alias, double timeout) +{ + msg_error_t ret = MSG_OK; + /* Try to send it */ + try { + comm = nullptr; // needed, otherwise MC gets confused. + s4u::CommPtr s4u_comm = send_async(alias, nullptr, false); + comm = s4u_comm; + comm->wait_for(timeout); + } catch (const TimeoutException&) { + ret = MSG_TIMEOUT; + } catch (const CancelException&) { + ret = MSG_HOST_FAILURE; + } catch (const NetworkFailureException&) { + ret = MSG_TRANSFER_FAILURE; + /* If the send failed, it is not used anymore */ + set_not_used(); + } + + return ret; +} +void Task::cancel() +{ + if (compute) { + compute->cancel(); + } else if (comm) { + comm->cancel(); + } + set_not_used(); +} + +void Task::set_priority(double priority) +{ + xbt_assert(std::isfinite(1.0 / priority), "priority is not finite!"); + priority_ = 1.0 / priority; +} + +s4u::Actor* Task::get_sender() +{ + return comm ? comm->get_sender() : nullptr; +} + +s4u::Host* Task::get_source() { - /* parallel tasks only */ - delete[] host_list; - delete[] flops_parallel_amount; - delete[] bytes_parallel_amount; + return comm ? comm->get_sender()->get_host() : nullptr; } void Task::set_used() { - if (this->is_used) - this->report_multiple_use(); - this->is_used = true; + if (is_used_) + report_multiple_use(); + is_used_ = true; } void Task::report_multiple_use() const { - if (msg_global->debug_multiple_use){ + if (MSG_Global_t::debug_multiple_use) { XBT_ERROR("This task is already used in there:"); // TODO, backtrace XBT_ERROR(""); @@ -61,14 +210,7 @@ void Task::report_multiple_use() const */ msg_task_t MSG_task_create(const char *name, double flop_amount, double message_size, void *data) { - msg_task_t task = new s_msg_task_t; - /* Simulator Data */ - task->simdata = new simgrid::msg::Task(name ? name : "", flop_amount, message_size, data); - - if (MC_is_active()) - MC_ignore_heap(&(task->simdata->get_counter()), sizeof(long long int)); - - return task; + return simgrid::msg::Task::create(name ? std::string(name) : "", flop_amount, message_size, data); } /** @brief Creates a new parallel task @@ -95,73 +237,435 @@ msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_hos { // Task's flops amount is set to an arbitrary value > 0.0 to be able to distinguish, in // MSG_task_get_remaining_work_ratio(), a finished task and a task that has not started yet. - msg_task_t task = MSG_task_create(name, 1.0, 0, data); - simdata_task_t simdata = task->simdata; - - /* Simulator Data specific to parallel tasks */ - simdata->host_nb = host_nb; - simdata->host_list = new sg_host_t[host_nb]; - std::copy_n(host_list, host_nb, simdata->host_list); - if (flops_amount != nullptr) { - simdata->flops_parallel_amount = new double[host_nb]; - std::copy_n(flops_amount, host_nb, simdata->flops_parallel_amount); - } - if (bytes_amount != nullptr) { - simdata->bytes_parallel_amount = new double[host_nb * host_nb]; - std::copy_n(bytes_amount, host_nb * host_nb, simdata->bytes_parallel_amount); - } - - return task; + return simgrid::msg::Task::create_parallel(name ? name : "", host_nb, host_list, flops_amount, bytes_amount, data); } /** @brief Return the user data of the given task */ void* MSG_task_get_data(msg_task_t task) { - return (task->simdata->get_user_data()); + return task->get_user_data(); } /** @brief Sets the user data of a given task */ void MSG_task_set_data(msg_task_t task, void *data) { - task->simdata->set_user_data(data); -} - -/** @brief Sets a function to be called when a task has just been copied. - * @param callback a callback function - */ -void MSG_task_set_copy_callback(void (*callback) (msg_task_t task, msg_process_t sender, msg_process_t receiver)) { - - msg_global->task_copy_callback = callback; - - if (callback) { - SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX); - } else { - SIMIX_comm_set_copy_data_callback(SIMIX_comm_copy_pointer_callback); - } + task->set_user_data(data); } /** @brief Returns the sender of the given task */ msg_process_t MSG_task_get_sender(msg_task_t task) { - return task->simdata->sender; + return task->get_sender(); } /** @brief Returns the source (the sender's host) of the given task */ msg_host_t MSG_task_get_source(msg_task_t task) { - return task->simdata->sender->get_host(); + return task->get_source(); } /** @brief Returns the name of the given task. */ const char *MSG_task_get_name(msg_task_t task) { - return task->simdata->get_cname(); + return task->get_cname(); } /** @brief Sets the name of the given task. */ void MSG_task_set_name(msg_task_t task, const char *name) { - task->simdata->set_name(name); + task->set_name(name); +} + +/** + * @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 + */ +msg_error_t MSG_task_execute(msg_task_t task) +{ + return task->execute(); +} + +/** + * @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. + * + * @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) +{ + return task->execute(); +} + +msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout) +{ + task->set_timeout(timeout); + return task->execute(); +} + +/** + * @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 + */ +msg_comm_t MSG_task_isend(msg_task_t task, const char* alias) +{ + return new simgrid::msg::Comm(task, nullptr, task->send_async(alias, nullptr, false)); +} + +/** + * @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 (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->set_rate(maxrate); + return new simgrid::msg::Comm(task, nullptr, task->send_async(alias, nullptr, false)); +} + +/** + * @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 + * 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 nullptr, no function will be called) + */ +void MSG_task_dsend(msg_task_t task, const char* alias, void_f_pvoid_t cleanup) +{ + task->send_async(alias, cleanup, true); +} + +/** + * @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 + * 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 (byte/sec) + * + */ +void MSG_task_dsend_bounded(msg_task_t task, const char* alias, void_f_pvoid_t cleanup, double maxrate) +{ + task->set_rate(maxrate); + task->send_async(alias, cleanup, true); +} +/** + * @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 + * + * @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) +{ + XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias); + return task->send(alias, -1); +} + +/** + * @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. + * + * 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, + * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise. + */ +msg_error_t MSG_task_send_bounded(msg_task_t task, const char* alias, double maxrate) +{ + task->set_rate(maxrate); + return task->send(alias, -1); +} + +/** + * @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) + * + * @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) +{ + return task->send(alias, timeout); +} + +/** + * @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. + * + * 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, + * #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) +{ + task->set_rate(maxrate); + return task->send(alias, timeout); +} + +/** + * @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 + * + * @return Returns + * #MSG_OK if the task was successfully received, + * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise. + */ +msg_error_t MSG_task_receive(msg_task_t * task, const char *alias) +{ + return MSG_task_receive_with_timeout(task, alias, -1); +} + +/** + * @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 (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) +{ + return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate); +} + +/** + * @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) + * + * @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(msg_task_t* task, const char* alias, double timeout) +{ + return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, -1); +} + +/** + * @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) + * + * 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) +{ + return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, 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 (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_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); + msg_error_t ret = MSG_OK; + /* We no longer support getting a task from a specific host */ + if (host) + THROW_UNIMPLEMENTED; + + /* 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 { + void* payload; + simgrid::s4u::Mailbox::by_name(alias) + ->get_init() + ->set_dst_data(&payload, sizeof(msg_task_t*)) + ->set_rate(rate) + ->wait_for(timeout); + *task = static_cast(payload); + XBT_DEBUG("Got task %s from %s", (*task)->get_cname(), alias); + (*task)->set_not_used(); + } catch (const simgrid::HostFailureException&) { + ret = MSG_HOST_FAILURE; + } catch (const simgrid::TimeoutException&) { + ret = MSG_TIMEOUT; + } catch (const simgrid::CancelException&) { + ret = MSG_TASK_CANCELED; + } catch (const simgrid::NetworkFailureException&) { + ret = MSG_TRANSFER_FAILURE; + } + + if (TRACE_actor_is_enabled() && ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) { + container_t process_container = simgrid::instr::Container::by_name(instr_pid(*MSG_process_self())); + + std::string key = std::string("p") + std::to_string((*task)->get_id()); + simgrid::instr::Container::get_root()->get_link("ACTOR_TASK_LINK")->end_event(process_container, "SR", key); + } + return ret; +} + +/** + * @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 + */ +msg_comm_t MSG_task_irecv(msg_task_t* task, const char* name) +{ + return MSG_task_irecv_bounded(task, name, -1.0); +} + +/** + * @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 (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) +{ + /* 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."); + + /* Try to receive it by calling SIMIX network layer */ + simgrid::s4u::CommPtr comm = simgrid::s4u::Mailbox::by_name(name) + ->get_init() + ->set_dst_data((void**)task, sizeof(msg_task_t*)) + ->set_rate(rate) + ->start(); + + return new simgrid::msg::Comm(nullptr, task, comm); +} + +/** + * @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 (or -1 if there is no communication in the mailbox) + * + */ +int MSG_task_listen_from(const char* alias) +{ + /* looks inside the rdv directly. Not clean. */ + simgrid::kernel::activity::CommImplPtr comm = simgrid::s4u::Mailbox::by_name(alias)->front(); + + if (comm && comm->src_actor_) + return comm->src_actor_->get_pid(); + else + return -1; } /** @brief Destroys the given task. @@ -176,13 +680,12 @@ void MSG_task_set_name(msg_task_t task, const char *name) */ msg_error_t MSG_task_destroy(msg_task_t task) { - if (task->simdata->is_used) { + if (task->is_used()) { /* the task is being sent or executed: cancel it first */ - MSG_task_cancel(task); + task->cancel(); } /* free main structures */ - delete task->simdata; delete task; return MSG_OK; @@ -195,14 +698,7 @@ msg_error_t MSG_task_destroy(msg_task_t task) msg_error_t MSG_task_cancel(msg_task_t task) { xbt_assert((task != nullptr), "Cannot cancel a nullptr task"); - - simdata_task_t simdata = task->simdata; - if (simdata->compute) { - simgrid::simix::simcall([simdata] { simdata->compute->cancel(); }); - } else if (simdata->comm) { - simdata->comm->cancel(); - } - simdata->set_not_used(); + task->cancel(); return MSG_OK; } @@ -214,12 +710,12 @@ msg_error_t MSG_task_cancel(msg_task_t task) double MSG_task_get_remaining_work_ratio(msg_task_t task) { xbt_assert((task != nullptr), "Cannot get information from a nullptr task"); - if (task->simdata->compute) { + if (task->compute) { // Task in progress - return task->simdata->compute->get_remaining_ratio(); + return task->compute->get_remaining_ratio(); } else { // Task not started (flops_amount is > 0.0) or finished (flops_amount is set to 0.0) - return task->simdata->flops_amount > 0.0 ? 1.0 : 0.0; + return task->flops_amount > 0.0 ? 1.0 : 0.0; } } @@ -231,13 +727,13 @@ double MSG_task_get_remaining_work_ratio(msg_task_t task) { * So you will get an exception if you call this function on parallel tasks. Just don't do it. */ double MSG_task_get_flops_amount(msg_task_t task) { - if (task->simdata->compute != nullptr) { - return task->simdata->compute->get_remaining(); + if (task->compute != nullptr) { + return task->compute->get_remaining(); } else { // Not started or already done. // - Before starting, flops_amount is initially the task cost // - After execution, flops_amount is set to 0 (until someone uses MSG_task_set_flops_amount, if any) - return task->simdata->flops_amount; + return task->flops_amount; } } @@ -249,7 +745,7 @@ double MSG_task_get_flops_amount(msg_task_t task) { */ void MSG_task_set_flops_amount(msg_task_t task, double flops_amount) { - task->simdata->flops_amount = flops_amount; + task->flops_amount = flops_amount; } /** @brief set the amount data attached with the given task. @@ -258,7 +754,7 @@ void MSG_task_set_flops_amount(msg_task_t task, double flops_amount) */ void MSG_task_set_bytes_amount(msg_task_t task, double data_size) { - task->simdata->bytes_amount = data_size; + task->bytes_amount = data_size; } /** @brief Returns the total amount received by the given task @@ -268,15 +764,15 @@ void MSG_task_set_bytes_amount(msg_task_t task, double data_size) */ double MSG_task_get_remaining_communication(msg_task_t task) { - XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->simdata->comm.get()); - return task->simdata->comm->get_remaining(); + XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->comm.get()); + return task->comm->get_remaining(); } /** @brief Returns the size of the data attached to the given task. */ double MSG_task_get_bytes_amount(msg_task_t task) { - xbt_assert((task != nullptr) && (task->simdata != nullptr), "Invalid parameter"); - return task->simdata->bytes_amount; + xbt_assert(task != nullptr, "Invalid parameter"); + return task->bytes_amount; } /** @brief Changes the priority of a computation task. @@ -286,8 +782,7 @@ double MSG_task_get_bytes_amount(msg_task_t task) */ void MSG_task_set_priority(msg_task_t task, double priority) { - task->simdata->priority = 1 / priority; - xbt_assert(std::isfinite(task->simdata->priority), "priority is not finite!"); + task->set_priority(priority); } /** @brief Changes the maximum CPU utilization of a computation task (in flops/s). @@ -298,5 +793,46 @@ void MSG_task_set_bound(msg_task_t task, double bound) { if (bound < 1e-12) /* close enough to 0 without any floating precision surprise */ XBT_INFO("bound == 0 means no capping (i.e., unlimited)."); - task->simdata->bound = bound; + task->set_bound(bound); +} + +/** + * @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. + * + * @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 + */ +void MSG_task_set_category(msg_task_t task, const char* category) +{ + xbt_assert(not task->has_tracing_category(), "Task %p(%s) already has a category (%s).", task, task->get_cname(), + task->get_tracing_category().c_str()); + + // if user provides a nullptr category, task is no longer traced + if (category == nullptr) { + task->set_tracing_category(""); + XBT_DEBUG("MSG task %p(%s), category removed", task, task->get_cname()); + } else { + // set task category + task->set_tracing_category(category); + XBT_DEBUG("MSG task %p(%s), category %s", task, task->get_cname(), task->get_tracing_category().c_str()); + } +} + +/** + * @brief Gets the current tracing category of a task. (@see MSG_task_set_category) + * @param task the task to be considered + * @return Returns the name of the tracing category of the given task, "" otherwise + */ +const char* MSG_task_get_category(msg_task_t task) +{ + return task->get_tracing_category().c_str(); }