X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/dfa51b83d8cf28e2b6ad4892bc83cf47216243ca..HEAD:/src/msg/msg_task.cpp diff --git a/src/msg/msg_task.cpp b/src/msg/msg_task.cpp deleted file mode 100644 index 07a54232eb..0000000000 --- a/src/msg/msg_task.cpp +++ /dev/null @@ -1,423 +0,0 @@ -/* Copyright (c) 2004-2019. 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 "msg_private.hpp" -#include "src/simix/smx_private.hpp" -#include -#include -#include - -#include -#include - -XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)"); - -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) -{ - 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 hosts, std::vector flops_amount, - std::vector 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 hosts; - std::vector flops; - std::vector 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; - - 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(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; -} - -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 (is_used_) - report_multiple_use(); - is_used_ = true; -} - -void Task::report_multiple_use() const -{ - if (msg_global->debug_multiple_use){ - XBT_ERROR("This task is already used in there:"); - // TODO, backtrace - XBT_ERROR(""); - XBT_ERROR("And you try to reuse it from here:"); - xbt_backtrace_display_current(); - } else { - xbt_die("This task is still being used somewhere else. You cannot send it now. Go fix your code!" - "(use --cfg=msg/debug-multiple-use:on to get the backtrace of the other process)"); - } -} -} // namespace msg -} // namespace simgrid - -/********************************* Task **************************************/ -/** @brief Creates a new task - * - * A constructor for msg_task_t taking four arguments. - * - * @param name a name for the object. It is for user-level information and can be 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. - * @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. - * @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); -} - -/** @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 - * the exact semantic of the parameters. - * \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 host_list an array of @p host_nb msg_host_t. - * @param flops_amount an array of @p host_nb doubles. - * flops_amount[i] is the total number of operations that have to be performed on host_list[i]. - * @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(). - */ -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) -{ - // 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. - 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->get_user_data(); -} - -/** @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 - */ -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); - } -} - -/** @brief Returns the sender of the given task */ -msg_process_t MSG_task_get_sender(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) -{ - return task->get_source(); -} - -/** @brief Returns the name of the given task. */ -const char *MSG_task_get_name(msg_task_t task) -{ - 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->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 Destroys the given task. - * - * You should free user data, if any, @b before calling this destructor. - * - * Only the process that owns the task can destroy it. - * The owner changes after a successful send. - * If a task is successfully sent, the receiver becomes the owner and is supposed to destroy it. The sender should not - * use it anymore. - * If the task failed to be sent, the sender remains the owner of the task. - */ -msg_error_t MSG_task_destroy(msg_task_t task) -{ - if (task->is_used()) { - /* the task is being sent or executed: cancel it first */ - task->cancel(); - } - - /* free main structures */ - delete task; - - return MSG_OK; -} - -/** @brief Cancel the given task - * - * If it was currently executed or transfered, the working process is stopped. - */ -msg_error_t MSG_task_cancel(msg_task_t task) -{ - xbt_assert((task != nullptr), "Cannot cancel a nullptr task"); - task->cancel(); - return MSG_OK; -} - -/** @brief Returns a value in ]0,1[ that represent the task remaining work - * to do: starts at 1 and goes to 0. Returns 0 if not started or finished. - * - * It works for either parallel or sequential tasks. - */ -double MSG_task_get_remaining_work_ratio(msg_task_t task) { - - xbt_assert((task != nullptr), "Cannot get information from a nullptr task"); - if (task->compute) { - // Task in progress - 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->flops_amount > 0.0 ? 1.0 : 0.0; - } -} - -/** @brief Returns the amount of flops that remain to be computed - * - * The returned value is initially the cost that you defined for the task, then it decreases until it reaches 0 - * - * 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) { - 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->flops_amount; - } -} - -/** @brief set the computation amount needed to process the given task. - * - * @warning If the computation is ongoing (already started and not finished), - * it is not modified by this call. Moreover, after its completion, the ongoing execution with set the flops_amount to - * zero, overriding any value set during the execution. - */ -void MSG_task_set_flops_amount(msg_task_t task, double flops_amount) -{ - task->flops_amount = flops_amount; -} - -/** @brief set the amount data attached with the given task. - * - * @warning If the transfer is ongoing (already started and not finished), it is not modified by this call. - */ -void MSG_task_set_bytes_amount(msg_task_t task, double data_size) -{ - task->bytes_amount = data_size; -} - -/** @brief Returns the total amount received by the given task - * - * 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) -{ - 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, "Invalid parameter"); - return task->bytes_amount; -} - -/** @brief Changes the priority of a computation task. - * - * This priority doesn't affect the transfer rate. A priority of 2 - * will make a task receive two times more cpu power than regular tasks. - */ -void MSG_task_set_priority(msg_task_t task, double priority) -{ - task->set_priority(priority); -} - -/** @brief Changes the maximum CPU utilization of a computation task (in flops/s). - * - * For VMs, there is a pitfall. Please see MSG_vm_set_bound(). - */ -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->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(); -}