1 /* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "msg_private.hpp"
7 #include "src/simix/smx_private.hpp"
8 #include <simgrid/s4u/Comm.hpp>
9 #include <simgrid/s4u/Host.hpp>
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)");
19 Task::Task(std::string name, double flops_amount, double bytes_amount, void* data)
20 : name_(std::move(name)), userdata_(data), flops_amount(flops_amount), bytes_amount(bytes_amount)
22 static std::atomic_ullong counter{0};
25 MC_ignore_heap(&(id_), sizeof(id_));
28 Task::Task(std::string name, std::vector<s4u::Host*> hosts, std::vector<double> flops_amount,
29 std::vector<double> bytes_amount, void* data)
30 : Task(std::move(name), 1.0, 0, data)
33 hosts_ = std::move(hosts);
34 flops_parallel_amount = std::move(flops_amount);
35 bytes_parallel_amount = std::move(bytes_amount);
38 Task* Task::create(std::string name, double flops_amount, double bytes_amount, void* data)
40 return new Task(std::move(name), flops_amount, bytes_amount, data);
43 Task* Task::create_parallel(std::string name, int host_nb, const msg_host_t* host_list, double* flops_amount,
44 double* bytes_amount, void* data)
46 std::vector<s4u::Host*> hosts;
47 std::vector<double> flops;
48 std::vector<double> bytes;
50 for (int i = 0; i < host_nb; i++) {
51 hosts.push_back(host_list[i]);
52 if (flops_amount != nullptr)
53 flops.push_back(flops_amount[i]);
54 if (bytes_amount != nullptr) {
55 for (int j = 0; j < host_nb; j++)
56 bytes.push_back(bytes_amount[host_nb * i + j]);
59 return new Task(std::move(name), std::move(hosts), std::move(flops), std::move(bytes), data);
62 msg_error_t Task::execute()
64 /* checking for infinite values */
65 xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
67 msg_error_t status = MSG_OK;
68 s4u::Host* host = SIMIX_process_self()->get_host();
72 compute = simix::simcall([this, host] {
73 return kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl(name_, tracing_category_, host));
77 compute->start(flops_amount, priority_, bound_);
78 e_smx_state_t comp_state = simcall_execution_wait(compute);
81 XBT_DEBUG("Execution task '%s' finished in state %d", get_cname(), (int)comp_state);
82 } catch (HostFailureException& e) {
83 status = MSG_HOST_FAILURE;
84 } catch (TimeoutError& e) {
86 } catch (CancelException& e) {
87 status = MSG_TASK_CANCELED;
90 /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */
101 simgrid::simix::simcall([this] { compute->cancel(); });
108 void Task::set_priority(double priority)
110 xbt_assert(std::isfinite(1.0 / priority), "priority is not finite!");
111 priority_ = 1.0 / priority;
114 s4u::Actor* Task::get_sender()
116 return comm ? comm->get_sender().get() : nullptr;
119 s4u::Host* Task::get_source()
121 return comm ? comm->get_sender()->get_host() : nullptr;
124 void Task::set_used()
127 report_multiple_use();
131 void Task::report_multiple_use() const
133 if (msg_global->debug_multiple_use){
134 XBT_ERROR("This task is already used in there:");
136 XBT_ERROR("<missing backtrace>");
137 XBT_ERROR("And you try to reuse it from here:");
138 xbt_backtrace_display_current();
140 xbt_die("This task is still being used somewhere else. You cannot send it now. Go fix your code!"
141 "(use --cfg=msg/debug-multiple-use:on to get the backtrace of the other process)");
145 } // namespace simgrid
147 /********************************* Task **************************************/
148 /** @brief Creates a new task
150 * A constructor for msg_task_t taking four arguments.
152 * @param name a name for the object. It is for user-level information and can be nullptr.
153 * @param flop_amount a value of the processing amount (in flop) needed to process this new task.
154 * If 0, then it cannot be executed with MSG_task_execute(). This value has to be >=0.
155 * @param message_size a value of the amount of data (in bytes) needed to transfer this new task. If 0, then it cannot
156 * be transfered with MSG_task_send() and MSG_task_recv(). This value has to be >=0.
157 * @param data a pointer to any data may want to attach to the new object. It is for user-level information and can
158 * be nullptr. It can be retrieved with the function @ref MSG_task_get_data.
159 * @return The new corresponding object.
161 msg_task_t MSG_task_create(const char *name, double flop_amount, double message_size, void *data)
163 return simgrid::msg::Task::create(name ? std::string(name) : "", flop_amount, message_size, data);
166 /** @brief Creates a new parallel task
168 * A constructor for #msg_task_t taking six arguments.
171 * See :cpp:func:`void simgrid::s4u::this_actor::parallel_execute(int, s4u::Host**, double*, double*)` for
172 * the exact semantic of the parameters.
175 * @param name a name for the object. It is for user-level information and can be nullptr.
176 * @param host_nb the number of hosts implied in the parallel task.
177 * @param host_list an array of @p host_nb msg_host_t.
178 * @param flops_amount an array of @p host_nb doubles.
179 * flops_amount[i] is the total number of operations that have to be performed on host_list[i].
180 * @param bytes_amount an array of @p host_nb* @p host_nb doubles.
181 * @param data a pointer to any data may want to attach to the new object.
182 * It is for user-level information and can be nullptr.
183 * It can be retrieved with the function @ref MSG_task_get_data().
185 msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_host_t * host_list,
186 double *flops_amount, double *bytes_amount, void *data)
188 // Task's flops amount is set to an arbitrary value > 0.0 to be able to distinguish, in
189 // MSG_task_get_remaining_work_ratio(), a finished task and a task that has not started yet.
190 return simgrid::msg::Task::create_parallel(name ? name : "", host_nb, host_list, flops_amount, bytes_amount, data);
193 /** @brief Return the user data of the given task */
194 void* MSG_task_get_data(msg_task_t task)
196 return task->get_user_data();
199 /** @brief Sets the user data of a given task */
200 void MSG_task_set_data(msg_task_t task, void *data)
202 task->set_user_data(data);
205 /** @brief Sets a function to be called when a task has just been copied.
206 * @param callback a callback function
208 void MSG_task_set_copy_callback(void (*callback) (msg_task_t task, msg_process_t sender, msg_process_t receiver)) {
210 msg_global->task_copy_callback = callback;
213 SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX);
215 SIMIX_comm_set_copy_data_callback(SIMIX_comm_copy_pointer_callback);
219 /** @brief Returns the sender of the given task */
220 msg_process_t MSG_task_get_sender(msg_task_t task)
222 return task->get_sender();
225 /** @brief Returns the source (the sender's host) of the given task */
226 msg_host_t MSG_task_get_source(msg_task_t task)
228 return task->get_source();
231 /** @brief Returns the name of the given task. */
232 const char *MSG_task_get_name(msg_task_t task)
234 return task->get_cname();
237 /** @brief Sets the name of the given task. */
238 void MSG_task_set_name(msg_task_t task, const char *name)
240 task->set_name(name);
244 * @brief Executes a task and waits for its termination.
246 * This function is used for describing the behavior of a process. It takes only one parameter.
247 * @param task a #msg_task_t to execute on the location on which the process is running.
248 * @return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise
250 msg_error_t MSG_task_execute(msg_task_t task)
252 return task->execute();
255 /** @brief Destroys the given task.
257 * You should free user data, if any, @b before calling this destructor.
259 * Only the process that owns the task can destroy it.
260 * The owner changes after a successful send.
261 * If a task is successfully sent, the receiver becomes the owner and is supposed to destroy it. The sender should not
263 * If the task failed to be sent, the sender remains the owner of the task.
265 msg_error_t MSG_task_destroy(msg_task_t task)
267 if (task->is_used()) {
268 /* the task is being sent or executed: cancel it first */
272 /* free main structures */
278 /** @brief Cancel the given task
280 * If it was currently executed or transfered, the working process is stopped.
282 msg_error_t MSG_task_cancel(msg_task_t task)
284 xbt_assert((task != nullptr), "Cannot cancel a nullptr task");
289 /** @brief Returns a value in ]0,1[ that represent the task remaining work
290 * to do: starts at 1 and goes to 0. Returns 0 if not started or finished.
292 * It works for either parallel or sequential tasks.
294 double MSG_task_get_remaining_work_ratio(msg_task_t task) {
296 xbt_assert((task != nullptr), "Cannot get information from a nullptr task");
299 return task->compute->get_remaining_ratio();
301 // Task not started (flops_amount is > 0.0) or finished (flops_amount is set to 0.0)
302 return task->flops_amount > 0.0 ? 1.0 : 0.0;
306 /** @brief Returns the amount of flops that remain to be computed
308 * The returned value is initially the cost that you defined for the task, then it decreases until it reaches 0
310 * It works for sequential tasks, but the remaining amount of work is not a scalar value for parallel tasks.
311 * So you will get an exception if you call this function on parallel tasks. Just don't do it.
313 double MSG_task_get_flops_amount(msg_task_t task) {
314 if (task->compute != nullptr) {
315 return task->compute->get_remaining();
317 // Not started or already done.
318 // - Before starting, flops_amount is initially the task cost
319 // - After execution, flops_amount is set to 0 (until someone uses MSG_task_set_flops_amount, if any)
320 return task->flops_amount;
324 /** @brief set the computation amount needed to process the given task.
326 * @warning If the computation is ongoing (already started and not finished),
327 * it is not modified by this call. Moreover, after its completion, the ongoing execution with set the flops_amount to
328 * zero, overriding any value set during the execution.
330 void MSG_task_set_flops_amount(msg_task_t task, double flops_amount)
332 task->flops_amount = flops_amount;
335 /** @brief set the amount data attached with the given task.
337 * @warning If the transfer is ongoing (already started and not finished), it is not modified by this call.
339 void MSG_task_set_bytes_amount(msg_task_t task, double data_size)
341 task->bytes_amount = data_size;
344 /** @brief Returns the total amount received by the given task
346 * If the communication does not exist it will return 0.
347 * So, if the communication has FINISHED or FAILED it returns zero.
349 double MSG_task_get_remaining_communication(msg_task_t task)
351 XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->comm.get());
352 return task->comm->get_remaining();
355 /** @brief Returns the size of the data attached to the given task. */
356 double MSG_task_get_bytes_amount(msg_task_t task)
358 xbt_assert(task != nullptr, "Invalid parameter");
359 return task->bytes_amount;
362 /** @brief Changes the priority of a computation task.
364 * This priority doesn't affect the transfer rate. A priority of 2
365 * will make a task receive two times more cpu power than regular tasks.
367 void MSG_task_set_priority(msg_task_t task, double priority)
369 task->set_priority(priority);
372 /** @brief Changes the maximum CPU utilization of a computation task (in flops/s).
374 * For VMs, there is a pitfall. Please see MSG_vm_set_bound().
376 void MSG_task_set_bound(msg_task_t task, double bound)
378 if (bound < 1e-12) /* close enough to 0 without any floating precision surprise */
379 XBT_INFO("bound == 0 means no capping (i.e., unlimited).");
380 task->set_bound(bound);
384 * @brief Sets the tracing category of a task.
386 * This function should be called after the creation of a MSG task, to define the category of that task. The
387 * first parameter task must contain a task that was =created with the function #MSG_task_create. The second
388 * parameter category must contain a category that was previously declared with the function #TRACE_category
389 * (or with #TRACE_category_with_color).
391 * See @ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
393 * @param task the task that is going to be categorized
394 * @param category the name of the category to be associated to the task
396 * @see MSG_task_get_category, TRACE_category, TRACE_category_with_color
398 void MSG_task_set_category(msg_task_t task, const char* category)
400 xbt_assert(not task->has_tracing_category(), "Task %p(%s) already has a category (%s).", task, task->get_cname(),
401 task->get_tracing_category().c_str());
403 // if user provides a nullptr category, task is no longer traced
404 if (category == nullptr) {
405 task->set_tracing_category("");
406 XBT_DEBUG("MSG task %p(%s), category removed", task, task->get_cname());
409 task->set_tracing_category(category);
410 XBT_DEBUG("MSG task %p(%s), category %s", task, task->get_cname(), task->get_tracing_category().c_str());
415 * @brief Gets the current tracing category of a task. (@see MSG_task_set_category)
416 * @param task the task to be considered
417 * @return Returns the name of the tracing category of the given task, "" otherwise
419 const char* MSG_task_get_category(msg_task_t task)
421 return task->get_tracing_category().c_str();