-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2023. 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. */
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)");
namespace simgrid {
+
+template class xbt::Extendable<msg::Task>;
+
namespace msg {
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)
+ : name_(name), 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_));
+ set_data(data);
+ MC_ignore_heap(&id_, sizeof id_);
}
Task::Task(const std::string& name, std::vector<s4u::Host*>&& hosts, std::vector<double>&& flops_amount,
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<simgrid::s4u::Host*> hosts(host_list, host_list + host_nb);
+ std::vector<s4u::Host*> hosts(host_list, host_list + host_nb);
std::vector<double> flops;
std::vector<double> bytes;
if (flops_amount != nullptr)
compute->set_name(name_)
->set_tracing_category(tracing_category_)
- ->set_timeout(timeout_)
->set_priority(1 / priority_)
->set_bound(bound_)
- ->wait();
+ ->wait_for(timeout_);
set_not_used();
XBT_DEBUG("Execution task '%s' finished", get_cname());
- } catch (HostFailureException& e) {
+ } catch (const HostFailureException&) {
status = MSG_HOST_FAILURE;
- } catch (TimeoutError& e) {
+ } catch (const TimeoutException&) {
status = MSG_TIMEOUT;
- } catch (CancelException& e) {
+ } catch (const CancelException&) {
status = MSG_TASK_CANCELED;
}
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 = simgrid::instr::Container::by_name(instr_pid(*MSG_process_self()));
- std::string key = std::string("p") + std::to_string(get_id());
- simgrid::instr::Container::get_root()->get_link("ACTOR_TASK_LINK")->start_event(process_container, "SR", key);
+ auto* process_container = instr::Container::by_name(instr_pid(*MSG_process_self()));
+ std::string key = "p" + std::to_string(get_id());
+ instr::Container::get_root()->get_link("ACTOR_LINK")->start_event(process_container, "SR", key);
}
/* Prepare the task to send */
s4u::CommPtr s4u_comm = send_async(alias, nullptr, false);
comm = s4u_comm;
comm->wait_for(timeout);
- } catch (simgrid::TimeoutError& e) {
+ } catch (const TimeoutException&) {
ret = MSG_TIMEOUT;
- } catch (simgrid::CancelException& e) {
+ } catch (const CancelException&) {
ret = MSG_HOST_FAILURE;
- } catch (xbt_ex& e) {
- if (e.category == network_error)
- ret = MSG_TRANSFER_FAILURE;
- else
- throw;
-
+ } catch (const NetworkFailureException&) {
+ ret = MSG_TRANSFER_FAILURE;
/* If the send failed, it is not used anymore */
set_not_used();
}
priority_ = 1.0 / priority;
}
-s4u::Actor* Task::get_sender()
+s4u::Actor* Task::get_sender() const
{
return comm ? comm->get_sender() : nullptr;
}
-s4u::Host* Task::get_source()
+s4u::Host* Task::get_source() const
{
return comm ? comm->get_sender()->get_host() : nullptr;
}
* @param flop_amount a value of the processing amount (in flop) needed to process this new task.
* If 0, then it cannot be executed with MSG_task_execute(). This value has to be >=0.
* @param message_size a value of the amount of data (in bytes) needed to transfer this new task. If 0, then it cannot
- * be transfered with MSG_task_send() and MSG_task_recv(). This value has to be >=0.
+ * be transferred with MSG_task_send() and MSG_task_recv(). This value has to be >=0.
* @param data a pointer to any data may want to attach to the new object. It is for user-level information and can
- * be nullptr. It can be retrieved with the function @ref MSG_task_get_data.
+ * be nullptr. It can be retrieved with the function MSG_task_get_data().
* @return The new corresponding object.
*/
msg_task_t MSG_task_create(const char *name, double flop_amount, double message_size, void *data)
{
- return simgrid::msg::Task::create(name ? std::string(name) : "", flop_amount, message_size, data);
+ return simgrid::msg::Task::create(name ? name : "", flop_amount, message_size, data);
}
/** @brief Creates a new parallel task
*
* A constructor for #msg_task_t taking six arguments.
*
- * \rst
- * See :cpp:func:`void simgrid::s4u::this_actor::parallel_execute(int, s4u::Host**, double*, double*)` for
+ * @beginrst
+ * See :ref:`simgrid::s4u::this_actor::parallel_execute() <API_s4u_parallel_execute>` for
* the exact semantic of the parameters.
- * \endrst
+ * @endrst
*
* @param name a name for the object. It is for user-level information and can be nullptr.
* @param host_nb the number of hosts implied in the parallel task.
* @param bytes_amount an array of @p host_nb* @p host_nb doubles.
* @param data a pointer to any data may want to attach to the new object.
* It is for user-level information and can be nullptr.
- * It can be retrieved with the function @ref MSG_task_get_data().
+ * It can be retrieved with the function MSG_task_get_data().
*/
msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_host_t * host_list,
double *flops_amount, double *bytes_amount, void *data)
}
/** @brief Return the user data of the given task */
-void* MSG_task_get_data(msg_task_t task)
+void* MSG_task_get_data(const_msg_task_t task)
{
- return task->get_user_data();
+ return task->get_data<void>();
}
/** @brief Sets the user data of a given task */
void MSG_task_set_data(msg_task_t task, void *data)
{
- task->set_user_data(data);
-}
-
-/** @brief Sets a function to be called when a task has just been copied.
- * @param callback a callback function
- */
-// deprecated
-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_data(data);
}
/** @brief Returns the sender of the given task */
-msg_process_t MSG_task_get_sender(msg_task_t task)
+msg_process_t MSG_task_get_sender(const_msg_task_t task)
{
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)
+msg_host_t MSG_task_get_source(const_msg_task_t task)
{
return task->get_source();
}
/** @brief Returns the name of the given task. */
-const char *MSG_task_get_name(msg_task_t task)
+const char* MSG_task_get_name(const_msg_task_t task)
{
return task->get_cname();
}
*/
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);
+ return MSG_task_receive_with_timeout_bounded(task, alias, timeout, -1);
}
/**
*/
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.
- *
- * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
- * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
- * to obtain an infinite timeout.
- *
- * @param task a memory location for storing a #msg_task_t.
- * @param alias name of the mailbox to receive the task from
- * @param timeout is the maximum wait time for completion (provide -1 for no timeout)
- * @param host a #msg_host_t host from where the task was sent
- *
- * @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(msg_task_t* task, const char* alias, double timeout, msg_host_t host)
-{
- 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);
-}
-
-/**
- * @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);
+ XBT_DEBUG("MSG_task_receive_with_timeout_bounded: 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");
*task = static_cast<msg_task_t>(payload);
XBT_DEBUG("Got task %s from %s", (*task)->get_cname(), alias);
(*task)->set_not_used();
- } catch (simgrid::HostFailureException& e) {
+ } catch (const simgrid::HostFailureException&) {
ret = MSG_HOST_FAILURE;
- } catch (simgrid::TimeoutError& e) {
+ } catch (const simgrid::TimeoutException&) {
ret = MSG_TIMEOUT;
- } catch (simgrid::CancelException& e) {
+ } catch (const simgrid::CancelException&) {
ret = MSG_TASK_CANCELED;
- } catch (xbt_ex& e) {
- if (e.category == network_error)
- ret = MSG_TRANSFER_FAILURE;
- else
- throw;
+ } 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()));
+ auto* 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);
+ std::string key = "p" + std::to_string((*task)->get_id());
+ simgrid::instr::Container::get_root()->get_link("ACTOR_LINK")->end_event(process_container, "SR", key);
}
return ret;
}
*
* @param alias the name of the mailbox to be considered
*
- * @return Returns the PID of sender process,
- * -1 if there is no communication in the mailbox.#include <cmath>
+ * @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;
+ return simgrid::s4u::Mailbox::by_name(alias)->listen_from();
}
/** @brief Destroys the given task.
/** @brief Cancel the given task
*
- * If it was currently executed or transfered, the working process is stopped.
+ * If it was currently executed or transferred, the working process is stopped.
*/
msg_error_t MSG_task_cancel(msg_task_t task)
{
*
* It works for either parallel or sequential tasks.
*/
-double MSG_task_get_remaining_work_ratio(msg_task_t task) {
-
+double MSG_task_get_remaining_work_ratio(const_msg_task_t task)
+{
xbt_assert((task != nullptr), "Cannot get information from a nullptr task");
if (task->compute) {
// Task in progress
* It works for sequential tasks, but the remaining amount of work is not a scalar value for parallel tasks.
* 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->compute != nullptr) {
+double MSG_task_get_flops_amount(const_msg_task_t task)
+{
+ if (task->compute != nullptr && task->compute->get_state() == simgrid::s4u::Activity::State::STARTED) {
return task->compute->get_remaining();
} else {
// Not started or already done.
* If the communication does not exist it will return 0.
* So, if the communication has FINISHED or FAILED it returns zero.
*/
-double MSG_task_get_remaining_communication(msg_task_t task)
+double MSG_task_get_remaining_communication(const_msg_task_t task)
{
- XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->comm.get());
+ XBT_DEBUG("calling s4u::Comm::get_remaining (%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)
+double MSG_task_get_bytes_amount(const_msg_task_t task)
{
xbt_assert(task != nullptr, "Invalid parameter");
return task->bytes_amount;
* @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
+ * 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.
+ * @beginrst
+ * See :ref:`outcome_vizu` for details on how to trace the (categorized) resource utilization.
+ * @endrst
*
* @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)
{
* @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)
+const char* MSG_task_get_category(const_msg_task_t task)
{
return task->get_tracing_category().c_str();
}
