namespace simgrid {
namespace msg {
-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)
+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++;
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)
+Task::Task(const std::string& name, std::vector<s4u::Host*>&& hosts, std::vector<double>&& flops_amount,
+ std::vector<double>&& bytes_amount, void* data)
+ : Task(name, 1.0, 0, data)
{
parallel_ = true;
hosts_ = std::move(hosts);
bytes_parallel_amount = std::move(bytes_amount);
}
-Task* Task::create(std::string name, double flops_amount, double bytes_amount, void* data)
+Task* Task::create(const std::string& name, double flops_amount, double bytes_amount, void* data)
{
- return new Task(std::move(name), flops_amount, bytes_amount, data);
+ return new Task(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,
+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<s4u::Host*> hosts;
+ std::vector<simgrid::s4u::Host*> hosts(host_list, host_list + host_nb);
std::vector<double> flops;
std::vector<double> bytes;
+ if (flops_amount != nullptr)
+ flops = std::vector<double>(flops_amount, flops_amount + host_nb);
+ if (bytes_amount != nullptr)
+ bytes = std::vector<double>(bytes_amount, bytes_amount + host_nb * host_nb);
- 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);
+ return new Task(name, std::move(hosts), std::move(flops), std::move(bytes), data);
}
msg_error_t Task::execute()
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_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());
return status;
}
-s4u::CommPtr Task::send_async(std::string alias, void_f_pvoid_t cleanup, bool detached)
+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()));
+ 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);
}
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;
+ s4u::CommPtr s4u_comm = s4u::Mailbox::by_name(alias)->put_init(this, bytes_amount)->set_rate(get_rate());
+ comm = s4u_comm;
if (detached)
comm->detach(cleanup);
comm->start();
if (TRACE_is_enabled() && has_tracing_category())
- simgrid::simix::simcall([comm, this] { comm->get_impl()->set_category(std::move(tracing_category_)); });
+ simgrid::simix::simcall([this] { comm->get_impl()->set_category(std::move(tracing_category_)); });
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 (simgrid::TimeoutError& e) {
+ ret = MSG_TIMEOUT;
+ } catch (simgrid::CancelException& e) {
+ ret = MSG_HOST_FAILURE;
+ } catch (xbt_ex& e) {
+ if (e.category == network_error)
+ ret = MSG_TRANSFER_FAILURE;
+ else
+ throw;
+
+ /* If the send failed, it is not used anymore */
+ set_not_used();
+ }
+
+ return ret;
+}
void Task::cancel()
{
if (compute) {
- simgrid::simix::simcall([this] { compute->cancel(); });
+ compute->cancel();
} else if (comm) {
comm->cancel();
}
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("<missing backtrace>");
/** @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;
{
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.
*
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.
+ *
+ * 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);
+ 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<msg_task_t>(payload);
+ XBT_DEBUG("Got task %s from %s", (*task)->get_cname(), alias);
+ (*task)->set_not_used();
+ } catch (simgrid::HostFailureException& e) {
+ ret = MSG_HOST_FAILURE;
+ } catch (simgrid::TimeoutError& e) {
+ ret = MSG_TIMEOUT;
+ } catch (simgrid::CancelException& e) {
+ ret = MSG_TASK_CANCELED;
+ } catch (xbt_ex& e) {
+ if (e.category == network_error)
+ ret = MSG_TRANSFER_FAILURE;
+ else
+ throw;
+ }
+
+ 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,
+ * -1 if there is no communication in the mailbox.#include <cmath>
+ *
+ */
+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.
*
