* under the terms of the license (GNU LGPL) which comes with this package. */
#include "msg_private.hpp"
-#include "src/simix/smx_private.hpp"
-#include <algorithm>
-#include <cmath>
-#include <simgrid/modelchecker.h>
+#include "src/instr/instr_private.hpp"
#include <simgrid/s4u/Comm.hpp>
+#include <simgrid/s4u/Exec.hpp>
+#include <simgrid/s4u/Host.hpp>
+#include <simgrid/s4u/Mailbox.hpp>
+
+#include <algorithm>
+#include <vector>
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)");
namespace simgrid {
namespace msg {
-Task::~Task()
+
+Task::Task(std::string name, double flops_amount, double bytes_amount, void* data)
+ : name_(std::move(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(std::string name, std::vector<s4u::Host*> hosts, std::vector<double> flops_amount,
+ std::vector<double> bytes_amount, void* data)
+ : Task(std::move(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(std::string name, double flops_amount, double bytes_amount, void* data)
+{
+ return new Task(std::move(name), flops_amount, bytes_amount, data);
+}
+
+Task* Task::create_parallel(std::string name, int host_nb, const msg_host_t* host_list, double* flops_amount,
+ double* bytes_amount, void* data)
+{
+ std::vector<s4u::Host*> hosts;
+ std::vector<double> flops;
+ std::vector<double> bytes;
+
+ for (int i = 0; i < host_nb; i++) {
+ hosts.push_back(host_list[i]);
+ if (flops_amount != nullptr)
+ flops.push_back(flops_amount[i]);
+ if (bytes_amount != nullptr) {
+ for (int j = 0; j < host_nb; j++)
+ bytes.push_back(bytes_amount[host_nb * i + j]);
+ }
+ }
+ return new Task(std::move(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;
+
+ set_used();
+ try {
+ s4u::ExecPtr e = s4u::this_actor::exec_init(flops_amount)
+ ->set_priority(1 / priority_)
+ ->set_bound(bound_)
+ ->set_tracing_category(tracing_category_)
+ ->start();
+ compute = boost::static_pointer_cast<kernel::activity::ExecImpl>(e->get_impl());
+
+ e->wait();
+
+ set_not_used();
+ XBT_DEBUG("Execution task '%s' finished", get_cname());
+ } catch (HostFailureException& e) {
+ status = MSG_HOST_FAILURE;
+ } catch (TimeoutError& e) {
+ status = MSG_TIMEOUT;
+ } catch (CancelException& e) {
+ 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(std::string alias, void_f_pvoid_t cleanup, bool detached)
{
- /* parallel tasks only */
- delete[] host_list;
- delete[] flops_parallel_amount;
- delete[] bytes_parallel_amount;
+ 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);
+ }
+
+ /* Prepare the task to send */
+ set_used();
+ this->comm = nullptr;
+ msg_global->sent_msg++;
+
+ s4u::CommPtr comm = s4u::Mailbox::by_name(alias)->put_init(this, bytes_amount)->set_rate(get_rate());
+ this->comm = comm;
+
+ if (detached)
+ comm->detach(cleanup);
+ else
+ comm->start();
+
+ if (TRACE_is_enabled() && has_tracing_category())
+ simgrid::simix::simcall([comm, this] { comm->get_impl()->set_category(std::move(tracing_category_)); });
+
+ return comm;
+}
+
+void Task::cancel()
+{
+ if (compute) {
+ simgrid::simix::simcall([this] { 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().get() : nullptr;
+}
+
+s4u::Host* Task::get_source()
+{
+ 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
*/
msg_task_t MSG_task_create(const char *name, double flop_amount, double message_size, void *data)
{
- static std::atomic_ullong counter{0};
-
- msg_task_t task = new s_msg_task_t;
- /* Simulator Data */
- task->simdata = new simgrid::msg::Task(name ? name : "", flop_amount, message_size, data);
-
- /* Task structure */
- task->counter = counter++;
-
- if (MC_is_active())
- MC_ignore_heap(&(task->counter), sizeof(task->counter));
-
- return task;
+ return simgrid::msg::Task::create(name ? std::string(name) : "", flop_amount, message_size, data);
}
/** @brief Creates a new parallel task
{
// 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);
+ task->set_user_data(data);
}
/** @brief Sets a function to be called when a task has just been copied.
/** @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->is_parallel() ? MSG_parallel_task_execute(task) : 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
+ * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
+ * 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
+ * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
+ * 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 Destroys the given task.
*/
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;
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;
}
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;
}
}
* 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;
}
}
*/
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.
*/
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
*/
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.
*/
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).
{
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();
}
