X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/10420d9401da7efa11b764267dff07a0f24bf978..df078bae24388cc0dd63b2bbafe05897a0dd45f8:/src/msg/msg_task.cpp diff --git a/src/msg/msg_task.cpp b/src/msg/msg_task.cpp index 86ece99590..cee11fc321 100644 --- a/src/msg/msg_task.cpp +++ b/src/msg/msg_task.cpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2018. 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. */ @@ -7,16 +7,6 @@ #include "src/simix/smx_private.hpp" #include -extern "C" { - -/** @addtogroup m_task_management - * - * Since most scheduling algorithms rely on a concept of task that can be either computed locally or - * transferred on another processor, it seems to be the right level of abstraction for our purposes. - * A task may then be defined by a computing amount, a message size and - * some private data. - */ - XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)"); void s_simdata_task_t::reportMultipleUse() const @@ -34,19 +24,18 @@ void s_simdata_task_t::reportMultipleUse() const } /********************************* Task **************************************/ -/** \ingroup m_task_management - * \brief Creates a new #msg_task_t. +/** @brief Creates a new task + * + * A constructor for msg_task_t taking four arguments. * - * A constructor for #msg_task_t taking four arguments and returning the corresponding object. - * \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. + * @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 + * @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. - * \see msg_task_t - * \return The new corresponding object. + * @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) { @@ -67,26 +56,31 @@ msg_task_t MSG_task_create(const char *name, double flop_amount, double message_ return task; } -/** \ingroup m_task_management - * \brief Creates a new #msg_task_t (a parallel one....). +/** @brief Creates a new parallel task * - * A constructor for #msg_task_t taking six arguments and returning the corresponding object. - * \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. + * 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. + * @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. - * \see msg_task_t - * \return The new corresponding object. + * 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) { - msg_task_t task = MSG_task_create(name, 0, 0, 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. + msg_task_t task = MSG_task_create(name, 1.0, 0, data); simdata_task_t simdata = task->simdata; /* Simulator Data specific to parallel tasks */ @@ -105,29 +99,20 @@ msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_hos return task; } -/** \ingroup m_task_management - * \brief Return the user data of a #msg_task_t. - * - * This function checks whether \a task is a valid pointer and return the user data associated to \a task if possible. - */ +/** @brief Return the user data of the given task */ void *MSG_task_get_data(msg_task_t task) { return (task->data); } -/** \ingroup m_task_management - * \brief Sets the user data of a #msg_task_t. - * - * This function allows to associate a new pointer to the user data associated of \a task. - */ +/** @brief Sets the user data of a given task */ void MSG_task_set_data(msg_task_t task, void *data) { task->data = data; } -/** \ingroup m_task_management - * \brief Sets a function to be called when a task has just been copied. - * \param callback a callback function +/** @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)) { @@ -140,50 +125,33 @@ void MSG_task_set_copy_callback(void (*callback) (msg_task_t task, msg_process_t } } -/** \ingroup m_task_management - * \brief Return the sender of a #msg_task_t. - * - * This functions returns the #msg_process_t which sent this task - */ +/** @brief Returns the sender of the given task */ msg_process_t MSG_task_get_sender(msg_task_t task) { return task->simdata->sender; } -/** \ingroup m_task_management - * \brief Return the source of a #msg_task_t. - * - * This functions returns the #msg_host_t from which this task was sent - */ +/** @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->source; } -/** \ingroup m_task_management - * \brief Return the name of a #msg_task_t. - * - * This functions returns the name of a #msg_task_t as specified on creation - */ +/** @brief Returns the name of the given task. */ const char *MSG_task_get_name(msg_task_t task) { return task->name; } -/** \ingroup m_task_management - * \brief Sets the name of a #msg_task_t. - * - * This functions allows to associate a name to a task - */ +/** @brief Sets the name of the given task. */ void MSG_task_set_name(msg_task_t task, const char *name) { task->name = xbt_strdup(name); } -/** \ingroup m_task_management - * \brief Destroy a #msg_task_t. +/** @brief Destroys the given task. * - * Destructor for #msg_task_t. Note that you should free user data, if any, \b before calling this function. + * 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. @@ -208,73 +176,62 @@ msg_error_t MSG_task_destroy(msg_task_t task) return MSG_OK; } -/** \ingroup m_task_usage - * \brief Cancel a #msg_task_t. - * \param task the task to cancel. If it was executed or transfered, it stops the process that were working on it. +/** @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"); - if (task->simdata->compute) { - simcall_execution_cancel(task->simdata->compute); - } - else if (task->simdata->comm) { - simdata_task_t simdata = task->simdata; + simdata_task_t simdata = task->simdata; + if (simdata->compute) { + simcall_execution_cancel(simdata->compute); + } else if (simdata->comm) { simcall_comm_cancel(simdata->comm); - simdata->setNotUsed(); } + simdata->setNotUsed(); return MSG_OK; } -/** \ingroup m_task_management - * \brief Returns a value in ]0,1[ that represent the task remaining work +/** @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. - * TODO: Improve this function by returning 1 if the task has not started */ 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) { // Task in progress - return task->simdata->compute->remains(); - - //} else if ((MSG_task_get_flops_amount(task) == 0 and task->simdata->flops_parallel_amount == nullptr) //this is a sequential task - // or (task->simdata->flops_parallel_amount != nullptr and task->simdata->flops_parallel_amount == 0)) { - // // Task finished - // return 1; + return task->simdata->compute->get_remaining_ratio(); } else { - // Task not started or finished - return 0; + // 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; } } +/** @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->simdata->compute) { - return task->simdata->compute->remains(); + if (task->simdata->compute != nullptr) { + return task->simdata->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; } } -/** \ingroup m_task_management - * \brief Returns the initial amount of flops needed to execute a task #msg_task_t. +/** @brief set the computation amount needed to process the given task. * - * Once a task has been processed, this amount is set to 0. If you want, you can reset this value with - * #MSG_task_set_flops_amount before restarting the task. - * - * Warning: Only work for simple task, not parallel task. - */ -double MSG_task_get_initial_flops_amount(msg_task_t task) { - return task->simdata->flops_amount; -} - -/** \ingroup m_task_management - * \brief set the computation amount needed to process a task #msg_task_t. - * - * \warning If the computation is ongoing (already started and not finished), + * @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. */ @@ -283,20 +240,19 @@ void MSG_task_set_flops_amount(msg_task_t task, double flops_amount) task->simdata->flops_amount = flops_amount; } -/** \ingroup m_task_management - * \brief set the amount data attached with a task #msg_task_t. +/** @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. + * @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->simdata->bytes_amount = data_size; } -/** \ingroup m_task_management - * \brief Returns the total amount received by a task #msg_task_t. - * If the communication does not exist it will return 0. - * So, if the communication has FINISHED or FAILED it returns zero. +/** @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) { @@ -304,18 +260,17 @@ double MSG_task_get_remaining_communication(msg_task_t task) return task->simdata->comm->remains(); } -/** \ingroup m_task_management - * \brief Returns the size of the data attached to a task #msg_task_t. - */ +/** @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; } -/** \ingroup m_task_management - * \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 the other ones. +/** @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) { @@ -324,9 +279,7 @@ void MSG_task_set_priority(msg_task_t task, double priority) simcall_execution_set_priority(task->simdata->compute, task->simdata->priority); } -/** \ingroup m_task_management - * \brief Changes the maximum CPU utilization of a computation task. - * Unit is flops/s. +/** @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(). */ @@ -339,4 +292,3 @@ void MSG_task_set_bound(msg_task_t task, double bound) if (task->simdata->compute) simcall_execution_set_bound(task->simdata->compute, task->simdata->bound); } -}