1 /* Copyright (c) 2006-2020. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include "simdag_private.hpp"
8 #include "src/surf/HostImpl.hpp"
9 #include "src/surf/surf_interface.hpp"
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_task, sd, "Logging specific to SimDag (task)");
14 /* Destroys the data memorized by SD_task_schedule. Task state must be SD_SCHEDULED or SD_RUNNABLE. */
15 static void __SD_task_destroy_scheduling_data(SD_task_t task)
17 if (task->state != SD_SCHEDULED && task->state != SD_RUNNABLE)
18 throw std::invalid_argument(
19 simgrid::xbt::string_printf("Task '%s' must be SD_SCHEDULED or SD_RUNNABLE", SD_task_get_name(task)));
21 xbt_free(task->flops_amount);
22 xbt_free(task->bytes_amount);
23 task->bytes_amount = nullptr;
24 task->flops_amount = nullptr;
28 * @brief Creates a new task.
30 * @param name the name of the task (can be @c nullptr)
31 * @param data the user data you want to associate with the task (can be @c nullptr)
32 * @param amount amount of the task
33 * @return the new task
34 * @see SD_task_destroy()
36 SD_task_t SD_task_create(const char *name, void *data, double amount)
38 SD_task_t task = xbt_new0(s_SD_task_t, 1);
39 task->kind = SD_TASK_NOT_TYPED;
40 task->state= SD_NOT_SCHEDULED;
41 sd_global->initial_tasks.insert(task);
44 task->start_time = -1.0;
45 task->finish_time = -1.0;
46 task->surf_action = nullptr;
47 task->watch_points = 0;
49 task->inputs = new std::set<SD_task_t>();
50 task->outputs = new std::set<SD_task_t>();
51 task->predecessors = new std::set<SD_task_t>();
52 task->successors = new std::set<SD_task_t>();
55 task->name = xbt_strdup(name);
56 task->amount = amount;
57 task->allocation = new std::vector<sg_host_t>();
62 static inline SD_task_t SD_task_create_sized(const char *name, void *data, double amount, int count)
64 SD_task_t task = SD_task_create(name, data, amount);
65 task->bytes_amount = xbt_new0(double, count * count);
66 task->flops_amount = xbt_new0(double, count);
70 /** @brief create an end-to-end communication task that can then be auto-scheduled
72 * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows one to specify the task costs at
73 * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
76 * A end-to-end communication must be scheduled on 2 hosts, and the amount specified at creation is sent from hosts[0]
79 SD_task_t SD_task_create_comm_e2e(const char *name, void *data, double amount)
81 SD_task_t res = SD_task_create_sized(name, data, amount, 2);
82 res->bytes_amount[2] = amount;
83 res->kind = SD_TASK_COMM_E2E;
88 /** @brief create a sequential computation task that can then be auto-scheduled
90 * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows one to specify the task costs at
91 * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
94 * A sequential computation must be scheduled on 1 host, and the amount specified at creation to be run on hosts[0].
96 * @param name the name of the task (can be @c nullptr)
97 * @param data the user data you want to associate with the task (can be @c nullptr)
98 * @param flops_amount amount of compute work to be done by the task
99 * @return the new SD_TASK_COMP_SEQ typed task
101 SD_task_t SD_task_create_comp_seq(const char *name, void *data, double flops_amount)
103 SD_task_t res = SD_task_create_sized(name, data, flops_amount, 1);
104 res->flops_amount[0] = flops_amount;
105 res->kind = SD_TASK_COMP_SEQ;
110 /** @brief create a parallel computation task that can then be auto-scheduled
112 * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows one to specify the task costs at
113 * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
116 * A parallel computation can be scheduled on any number of host.
117 * The underlying speedup model is Amdahl's law.
118 * To be auto-scheduled, @see SD_task_distribute_comp_amdahl has to be called first.
119 * @param name the name of the task (can be @c nullptr)
120 * @param data the user data you want to associate with the task (can be @c nullptr)
121 * @param flops_amount amount of compute work to be done by the task
122 * @param alpha purely serial fraction of the work to be done (in [0.;1.[)
123 * @return the new task
125 SD_task_t SD_task_create_comp_par_amdahl(const char *name, void *data, double flops_amount, double alpha)
127 xbt_assert(alpha < 1. && alpha >= 0., "Invalid parameter: alpha must be in [0.;1.[");
129 SD_task_t res = SD_task_create(name, data, flops_amount);
131 res->kind = SD_TASK_COMP_PAR_AMDAHL;
136 /** @brief create a complex data redistribution task that can then be auto-scheduled
138 * Auto-scheduling mean that the task can be used with SD_task_schedulev().
139 * This allows one to specify the task costs at creation, and decouple them from the scheduling process where you just
140 * specify which resource should communicate.
142 * A data redistribution can be scheduled on any number of host.
143 * The assumed distribution is a 1D block distribution. Each host owns the same share of the @see amount.
144 * To be auto-scheduled, @see SD_task_distribute_comm_mxn_1d_block has to be called first.
145 * @param name the name of the task (can be @c nullptr)
146 * @param data the user data you want to associate with the task (can be @c nullptr)
147 * @param amount amount of data to redistribute by the task
148 * @return the new task
150 SD_task_t SD_task_create_comm_par_mxn_1d_block(const char *name, void *data, double amount)
152 SD_task_t res = SD_task_create(name, data, amount);
153 res->kind = SD_TASK_COMM_PAR_MXN_1D_BLOCK;
159 * @brief Destroys a task.
161 * The user data (if any) should have been destroyed first.
163 * @param task the task you want to destroy
164 * @see SD_task_create()
166 void SD_task_destroy(SD_task_t task)
168 XBT_DEBUG("Destroying task %s...", SD_task_get_name(task));
170 /* First Remove all dependencies associated with the task. */
171 while (not task->predecessors->empty())
172 SD_task_dependency_remove(*(task->predecessors->begin()), task);
173 while (not task->inputs->empty())
174 SD_task_dependency_remove(*(task->inputs->begin()), task);
175 while (not task->successors->empty())
176 SD_task_dependency_remove(task, *(task->successors->begin()));
177 while (not task->outputs->empty())
178 SD_task_dependency_remove(task, *(task->outputs->begin()));
180 if (task->state == SD_SCHEDULED || task->state == SD_RUNNABLE)
181 __SD_task_destroy_scheduling_data(task);
183 xbt_free(task->name);
185 if (task->surf_action != nullptr)
186 task->surf_action->unref();
188 delete task->allocation;
189 xbt_free(task->bytes_amount);
190 xbt_free(task->flops_amount);
192 delete task->outputs;
193 delete task->predecessors;
194 delete task->successors;
197 XBT_DEBUG("Task destroyed.");
201 * @brief Returns the user data of a task
204 * @return the user data associated with this task (can be @c nullptr)
205 * @see SD_task_set_data()
207 void* SD_task_get_data(const_SD_task_t task)
213 * @brief Sets the user data of a task
215 * The new data can be @c nullptr. The old data should have been freed first, if it was not @c nullptr.
218 * @param data the new data you want to associate with this task
219 * @see SD_task_get_data()
221 void SD_task_set_data(SD_task_t task, void *data)
227 * @brief Sets the rate of a task
229 * This will change the network bandwidth a task can use. This rate cannot be dynamically changed. Once the task has
230 * started, this call is ineffective. This rate depends on both the nominal bandwidth on the route onto which the task
231 * is scheduled (@see SD_task_get_current_bandwidth) and the amount of data to transfer.
233 * To divide the nominal bandwidth by 2, the rate then has to be :
234 * rate = bandwidth/(2*amount)
236 * @param task a @see SD_TASK_COMM_E2E task (end-to-end communication)
237 * @param rate the new rate you want to associate with this task.
239 void SD_task_set_rate(SD_task_t task, double rate)
241 xbt_assert(task->kind == SD_TASK_COMM_E2E, "The rate can be modified for end-to-end communications only.");
242 if(task->state < SD_RUNNING) {
245 XBT_WARN("Task %p has started. Changing rate is ineffective.", task);
250 * @brief Returns the state of a task
253 * @return the current @ref e_SD_task_state_t "state" of this task:
254 * #SD_NOT_SCHEDULED, #SD_SCHEDULED, #SD_RUNNABLE, #SD_RUNNING, #SD_DONE or #SD_FAILED
255 * @see e_SD_task_state_t
257 e_SD_task_state_t SD_task_get_state(const_SD_task_t task)
262 /* Changes the state of a task. Updates the sd_global->watch_point_reached flag.
264 void SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state)
266 std::set<SD_task_t>::iterator idx;
267 XBT_DEBUG("Set state of '%s' to %d", task->name, new_state);
268 if ((new_state == SD_NOT_SCHEDULED || new_state == SD_SCHEDULABLE) && task->state == SD_FAILED){
269 sd_global->completed_tasks.erase(task);
270 sd_global->initial_tasks.insert(task);
273 if (new_state == SD_SCHEDULED && task->state == SD_RUNNABLE){
274 sd_global->initial_tasks.insert(task);
275 sd_global->runnable_tasks.erase(task);
278 if (new_state == SD_RUNNABLE){
279 idx = sd_global->initial_tasks.find(task);
280 if (idx != sd_global->initial_tasks.end()) {
281 sd_global->runnable_tasks.insert(*idx);
282 sd_global->initial_tasks.erase(idx);
286 if (new_state == SD_RUNNING)
287 sd_global->runnable_tasks.erase(task);
289 if (new_state == SD_DONE || new_state == SD_FAILED){
290 sd_global->completed_tasks.insert(task);
291 task->start_time = task->surf_action->get_start_time();
292 if (new_state == SD_DONE){
293 task->finish_time = task->surf_action->get_finish_time();
294 #if SIMGRID_HAVE_JEDULE
295 jedule_log_sd_event(task);
298 task->finish_time = surf_get_clock();
299 task->surf_action->unref();
300 task->surf_action = nullptr;
301 task->allocation->clear();
304 task->state = new_state;
306 if (task->watch_points & new_state) {
307 XBT_VERB("Watch point reached with task '%s'!", task->name);
308 sd_global->watch_point_reached = true;
309 SD_task_unwatch(task, new_state); /* remove the watch point */
314 * @brief Returns the name of a task
317 * @return the name of this task (can be @c nullptr)
319 const char* SD_task_get_name(const_SD_task_t task)
324 /** @brief Allows to change the name of a task */
325 void SD_task_set_name(SD_task_t task, const char *name)
327 xbt_free(task->name);
328 task->name = xbt_strdup(name);
331 /** @brief Returns the dynar of the parents of a task
334 * @return a newly allocated dynar comprising the parents of this task
337 xbt_dynar_t SD_task_get_parents(const_SD_task_t task)
339 xbt_dynar_t parents = xbt_dynar_new(sizeof(SD_task_t), nullptr);
341 for (auto const& it : *task->predecessors)
342 xbt_dynar_push(parents, &it);
343 for (auto const& it : *task->inputs)
344 xbt_dynar_push(parents, &it);
349 /** @brief Returns the dynar of the parents of a task
352 * @return a newly allocated dynar comprising the parents of this task
354 xbt_dynar_t SD_task_get_children(const_SD_task_t task)
356 xbt_dynar_t children = xbt_dynar_new(sizeof(SD_task_t), nullptr);
358 for (auto const& it : *task->successors)
359 xbt_dynar_push(children, &it);
360 for (auto const& it : *task->outputs)
361 xbt_dynar_push(children, &it);
367 * @brief Returns the number of workstations involved in a task
369 * Only call this on already scheduled tasks!
372 int SD_task_get_workstation_count(const_SD_task_t task)
374 return static_cast<int>(task->allocation->size());
378 * @brief Returns the list of workstations involved in a task
380 * Only call this on already scheduled tasks!
383 sg_host_t* SD_task_get_workstation_list(const_SD_task_t task)
385 return task->allocation->data();
389 * @brief Returns the total amount of work contained in a task
392 * @return the total amount of work (computation or data transfer) for this task
393 * @see SD_task_get_remaining_amount()
395 double SD_task_get_amount(const_SD_task_t task)
400 /** @brief Sets the total amount of work of a task
401 * For sequential typed tasks (COMP_SEQ and COMM_E2E), it also sets the appropriate values in the flops_amount and
402 * bytes_amount arrays respectively. Nothing more than modifying task->amount is done for parallel typed tasks
403 * (COMP_PAR_AMDAHL and COMM_PAR_MXN_1D_BLOCK) as the distribution of the amount of work is done at scheduling time.
406 * @param amount the new amount of work to execute
408 void SD_task_set_amount(SD_task_t task, double amount)
410 task->amount = amount;
411 if (task->kind == SD_TASK_COMP_SEQ)
412 task->flops_amount[0] = amount;
413 if (task->kind == SD_TASK_COMM_E2E)
414 task->bytes_amount[2] = amount;
418 * @brief Returns the alpha parameter of a SD_TASK_COMP_PAR_AMDAHL task
420 * @param task a parallel task assuming Amdahl's law as speedup model
421 * @return the alpha parameter (serial part of a task in percent) for this task
423 double SD_task_get_alpha(const_SD_task_t task)
425 xbt_assert(SD_task_get_kind(task) == SD_TASK_COMP_PAR_AMDAHL, "Alpha parameter is not defined for this kind of task");
430 * @brief Returns the remaining amount work to do till the completion of a task
433 * @return the remaining amount of work (computation or data transfer) of this task
434 * @see SD_task_get_amount()
436 double SD_task_get_remaining_amount(const_SD_task_t task)
438 if (task->surf_action)
439 return task->surf_action->get_remains();
441 return (task->state == SD_DONE) ? 0 : task->amount;
444 e_SD_task_kind_t SD_task_get_kind(const_SD_task_t task)
449 /** @brief Displays debugging information about a task */
450 void SD_task_dump(const_SD_task_t task)
452 XBT_INFO("Displaying task %s", SD_task_get_name(task));
453 if (task->state == SD_RUNNABLE)
454 XBT_INFO(" - state: runnable");
455 else if (task->state < SD_RUNNABLE)
456 XBT_INFO(" - state: %s not runnable", __get_state_name(task->state));
458 XBT_INFO(" - state: not runnable %s", __get_state_name(task->state));
460 if (task->kind != 0) {
461 switch (task->kind) {
462 case SD_TASK_COMM_E2E:
463 XBT_INFO(" - kind: end-to-end communication");
465 case SD_TASK_COMP_SEQ:
466 XBT_INFO(" - kind: sequential computation");
468 case SD_TASK_COMP_PAR_AMDAHL:
469 XBT_INFO(" - kind: parallel computation following Amdahl's law");
471 case SD_TASK_COMM_PAR_MXN_1D_BLOCK:
472 XBT_INFO(" - kind: MxN data redistribution assuming 1D block distribution");
475 XBT_INFO(" - (unknown kind %d)", task->kind);
479 XBT_INFO(" - amount: %.0f", SD_task_get_amount(task));
480 if (task->kind == SD_TASK_COMP_PAR_AMDAHL)
481 XBT_INFO(" - alpha: %.2f", task->alpha);
482 XBT_INFO(" - Dependencies to satisfy: %zu", task->inputs->size()+ task->predecessors->size());
483 if ((task->inputs->size()+ task->predecessors->size()) > 0) {
484 XBT_INFO(" - pre-dependencies:");
485 for (auto const& it : *task->predecessors)
486 XBT_INFO(" %s", it->name);
488 for (auto const& it : *task->inputs)
489 XBT_INFO(" %s", it->name);
491 if ((task->outputs->size() + task->successors->size()) > 0) {
492 XBT_INFO(" - post-dependencies:");
494 for (auto const& it : *task->successors)
495 XBT_INFO(" %s", it->name);
496 for (auto const& it : *task->outputs)
497 XBT_INFO(" %s", it->name);
501 /** @brief Dumps the task in dotty formalism into the FILE* passed as second argument */
502 void SD_task_dotty(const_SD_task_t task, void* out)
504 auto* fout = static_cast<FILE*>(out);
505 fprintf(fout, " T%p [label=\"%.20s\"", task, task->name);
506 switch (task->kind) {
507 case SD_TASK_COMM_E2E:
508 case SD_TASK_COMM_PAR_MXN_1D_BLOCK:
509 fprintf(fout, ", shape=box");
511 case SD_TASK_COMP_SEQ:
512 case SD_TASK_COMP_PAR_AMDAHL:
513 fprintf(fout, ", shape=circle");
516 xbt_die("Unknown task type!");
518 fprintf(fout, "];\n");
519 for (auto const& it : *task->predecessors)
520 fprintf(fout, " T%p -> T%p;\n", it, task);
521 for (auto const& it : *task->inputs)
522 fprintf(fout, " T%p -> T%p;\n", it, task);
526 * @brief Adds a dependency between two tasks
528 * @a dst will depend on @a src, ie @a dst will not start before @a src is finished.
529 * Their @ref e_SD_task_state_t "state" must be #SD_NOT_SCHEDULED, #SD_SCHEDULED or #SD_RUNNABLE.
531 * @param src the task which must be executed first
532 * @param dst the task you want to make depend on @a src
533 * @see SD_task_dependency_remove()
535 void SD_task_dependency_add(SD_task_t src, SD_task_t dst)
538 throw std::invalid_argument(
539 simgrid::xbt::string_printf("Cannot add a dependency between task '%s' and itself", SD_task_get_name(src)));
541 if (src->state == SD_DONE || src->state == SD_FAILED)
542 throw std::invalid_argument(simgrid::xbt::string_printf(
543 "Task '%s' must be SD_NOT_SCHEDULED, SD_SCHEDULABLE, SD_SCHEDULED, SD_RUNNABLE, or SD_RUNNING", src->name));
545 if (dst->state == SD_DONE || dst->state == SD_FAILED || dst->state == SD_RUNNING)
546 throw std::invalid_argument(simgrid::xbt::string_printf(
547 "Task '%s' must be SD_NOT_SCHEDULED, SD_SCHEDULABLE, SD_SCHEDULED, or SD_RUNNABLE", dst->name));
549 if (dst->inputs->find(src) != dst->inputs->end() || src->outputs->find(dst) != src->outputs->end() ||
550 src->successors->find(dst) != src->successors->end() || dst->predecessors->find(src) != dst->predecessors->end())
551 throw std::invalid_argument(simgrid::xbt::string_printf(
552 "A dependency already exists between task '%s' and task '%s'", src->name, dst->name));
554 XBT_DEBUG("SD_task_dependency_add: src = %s, dst = %s", src->name, dst->name);
556 if (src->kind == SD_TASK_COMM_E2E || src->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK){
557 if (dst->kind == SD_TASK_COMP_SEQ || dst->kind == SD_TASK_COMP_PAR_AMDAHL)
558 dst->inputs->insert(src);
560 dst->predecessors->insert(src);
561 src->successors->insert(dst);
563 if (dst->kind == SD_TASK_COMM_E2E|| dst->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK)
564 src->outputs->insert(dst);
566 src->successors->insert(dst);
567 dst->predecessors->insert(src);
570 /* if the task was runnable, the task goes back to SD_SCHEDULED because of the new dependency*/
571 if (dst->state == SD_RUNNABLE) {
572 XBT_DEBUG("SD_task_dependency_add: %s was runnable and becomes scheduled!", dst->name);
573 SD_task_set_state(dst, SD_SCHEDULED);
578 * @brief Indicates whether there is a dependency between two tasks.
581 * @param dst a task depending on @a src
583 * If src is nullptr, checks whether dst has any pre-dependency.
584 * If dst is nullptr, checks whether src has any post-dependency.
586 int SD_task_dependency_exists(const_SD_task_t src, SD_task_t dst)
588 xbt_assert(src != nullptr || dst != nullptr, "Invalid parameter: both src and dst are nullptr");
592 return (src->successors->find(dst) != src->successors->end() || src->outputs->find(dst) != src->outputs->end());
594 return static_cast<int>(src->successors->size() + src->outputs->size());
597 return static_cast<int>(dst->predecessors->size() + dst->inputs->size());
602 * @brief Remove a dependency between two tasks
605 * @param dst a task depending on @a src
606 * @see SD_task_dependency_add()
608 void SD_task_dependency_remove(SD_task_t src, SD_task_t dst)
610 XBT_DEBUG("SD_task_dependency_remove: src = %s, dst = %s", SD_task_get_name(src), SD_task_get_name(dst));
612 if (src->successors->find(dst) == src->successors->end() && src->outputs->find(dst) == src->outputs->end())
613 throw std::invalid_argument(simgrid::xbt::string_printf(
614 "No dependency found between task '%s' and '%s': task '%s' is not a successor of task '%s'", src->name,
615 dst->name, dst->name, src->name));
617 if (src->kind == SD_TASK_COMM_E2E || src->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK){
618 if (dst->kind == SD_TASK_COMP_SEQ || dst->kind == SD_TASK_COMP_PAR_AMDAHL)
619 dst->inputs->erase(src);
621 dst->predecessors->erase(src);
622 src->successors->erase(dst);
624 if (dst->kind == SD_TASK_COMM_E2E|| dst->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK)
625 src->outputs->erase(dst);
627 src->successors->erase(dst);
628 dst->predecessors->erase(src);
631 /* if the task was scheduled and dependencies are satisfied, we can make it runnable */
632 if (dst->predecessors->empty() && dst->inputs->empty() && dst->state == SD_SCHEDULED)
633 SD_task_set_state(dst, SD_RUNNABLE);
637 * @brief Adds a watch point to a task
639 * SD_simulate() will stop as soon as the @ref e_SD_task_state_t "state" of this task becomes the one given in argument.
640 * The watch point is then automatically removed.
643 * @param state the @ref e_SD_task_state_t "state" you want to watch (cannot be #SD_NOT_SCHEDULED)
644 * @see SD_task_unwatch()
646 void SD_task_watch(SD_task_t task, e_SD_task_state_t state)
648 if (state & SD_NOT_SCHEDULED)
649 throw std::invalid_argument("Cannot add a watch point for state SD_NOT_SCHEDULED");
651 task->watch_points = task->watch_points | state;
655 * @brief Removes a watch point from a task
658 * @param state the @ref e_SD_task_state_t "state" you no longer want to watch
659 * @see SD_task_watch()
661 void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state)
663 xbt_assert(state != SD_NOT_SCHEDULED, "SimDag error: Cannot have a watch point for state SD_NOT_SCHEDULED");
664 task->watch_points = task->watch_points & ~state;
668 * @brief Returns an approximative estimation of the execution time of a task.
670 * The estimation is very approximative because the value returned is the time the task would take if it was executed
671 * now and if it was the only task.
673 * @param host_count number of hosts on which the task would be executed
674 * @param host_list the hosts on which the task would be executed
675 * @param flops_amount computation amount for each host(i.e., an array of host_count doubles)
676 * @param bytes_amount communication amount between each pair of hosts (i.e., a matrix of host_count*host_count doubles)
679 double SD_task_get_execution_time(const_SD_task_t /*task*/, int host_count, const sg_host_t* host_list,
680 const double* flops_amount, const double* bytes_amount)
682 xbt_assert(host_count > 0, "Invalid parameter");
683 double max_time = 0.0;
685 /* the task execution time is the maximum execution time of the parallel tasks */
686 for (int i = 0; i < host_count; i++) {
688 if (flops_amount != nullptr)
689 time = flops_amount[i] / host_list[i]->get_speed();
691 if (bytes_amount != nullptr)
692 for (int j = 0; j < host_count; j++)
693 if (bytes_amount[i * host_count + j] != 0)
694 time += (sg_host_route_latency(host_list[i], host_list[j]) +
695 bytes_amount[i * host_count + j] / sg_host_route_bandwidth(host_list[i], host_list[j]));
703 static inline void SD_task_do_schedule(SD_task_t task)
705 if (SD_task_get_state(task) > SD_SCHEDULABLE)
706 throw std::invalid_argument(
707 simgrid::xbt::string_printf("Task '%s' has already been scheduled", SD_task_get_name(task)));
709 if (task->predecessors->empty() && task->inputs->empty())
710 SD_task_set_state(task, SD_RUNNABLE);
712 SD_task_set_state(task, SD_SCHEDULED);
716 * @brief Schedules a task
718 * The task state must be #SD_NOT_SCHEDULED.
719 * Once scheduled, a task is executed as soon as possible in @see SD_simulate, i.e. when its dependencies are satisfied.
721 * @param task the task you want to schedule
722 * @param host_count number of hosts on which the task will be executed
723 * @param host_list the hosts on which the task will be executed
724 * @param flops_amount computation amount for each hosts (i.e., an array of host_count doubles)
725 * @param bytes_amount communication amount between each pair of hosts (i.e., a matrix of host_count*host_count doubles)
726 * @param rate task execution speed rate
727 * @see SD_task_unschedule()
729 void SD_task_schedule(SD_task_t task, int host_count, const sg_host_t * host_list,
730 const double *flops_amount, const double *bytes_amount, double rate)
732 xbt_assert(host_count > 0, "host_count must be positive");
737 task->flops_amount = static_cast<double*>(xbt_realloc(task->flops_amount, sizeof(double) * host_count));
738 memcpy(task->flops_amount, flops_amount, sizeof(double) * host_count);
740 xbt_free(task->flops_amount);
741 task->flops_amount = nullptr;
744 int communication_nb = host_count * host_count;
746 task->bytes_amount = static_cast<double*>(xbt_realloc(task->bytes_amount, sizeof(double) * communication_nb));
747 memcpy(task->bytes_amount, bytes_amount, sizeof(double) * communication_nb);
749 xbt_free(task->bytes_amount);
750 task->bytes_amount = nullptr;
753 for(int i =0; i<host_count; i++)
754 task->allocation->push_back(host_list[i]);
756 SD_task_do_schedule(task);
760 * @brief Unschedules a task
762 * The task state must be #SD_SCHEDULED, #SD_RUNNABLE, #SD_RUNNING or #SD_FAILED.
763 * If you call this function, the task state becomes #SD_NOT_SCHEDULED.
764 * Call SD_task_schedule() to schedule it again.
766 * @param task the task you want to unschedule
767 * @see SD_task_schedule()
769 void SD_task_unschedule(SD_task_t task)
771 if (task->state == SD_NOT_SCHEDULED || task->state == SD_SCHEDULABLE)
772 throw std::invalid_argument(simgrid::xbt::string_printf(
773 "Task %s: the state must be SD_SCHEDULED, SD_RUNNABLE, SD_RUNNING or SD_FAILED", task->name));
775 if (task->state == SD_SCHEDULED || task->state == SD_RUNNABLE) /* if the task is scheduled or runnable */ {
776 task->allocation->clear();
777 if (task->kind == SD_TASK_COMP_PAR_AMDAHL || task->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK) {
778 /* Don't free scheduling data for typed tasks */
779 __SD_task_destroy_scheduling_data(task);
783 if (SD_task_get_state(task) == SD_RUNNING)
784 /* the task should become SD_FAILED */
785 task->surf_action->cancel();
787 if (task->predecessors->empty() && task->inputs->empty())
788 SD_task_set_state(task, SD_SCHEDULABLE);
790 SD_task_set_state(task, SD_NOT_SCHEDULED);
792 task->start_time = -1.0;
796 void SD_task_run(SD_task_t task)
798 xbt_assert(task->state == SD_RUNNABLE, "Task '%s' is not runnable! Task state: %d", task->name, (int) task->state);
799 xbt_assert(task->allocation != nullptr, "Task '%s': host_list is nullptr!", task->name);
801 XBT_VERB("Executing task '%s'", task->name);
803 /* Beware! The scheduling data are now used by the surf action directly! no copy was done */
805 surf_host_model->execute_parallel(*task->allocation, task->flops_amount, task->bytes_amount, task->rate);
807 task->surf_action->set_data(task);
809 XBT_DEBUG("surf_action = %p", task->surf_action);
811 SD_task_set_state(task, SD_RUNNING);
812 sd_global->return_set.insert(task);
816 * @brief Returns the start time of a task
818 * The task state must be SD_RUNNING, SD_DONE or SD_FAILED.
820 * @param task: a task
821 * @return the start time of this task
823 double SD_task_get_start_time(const_SD_task_t task)
825 if (task->surf_action)
826 return task->surf_action->get_start_time();
828 return task->start_time;
832 * @brief Returns the finish time of a task
834 * The task state must be SD_RUNNING, SD_DONE or SD_FAILED.
835 * If the state is not completed yet, the returned value is an estimation of the task finish time. This value can
836 * vary until the task is completed.
838 * @param task: a task
839 * @return the start time of this task
841 double SD_task_get_finish_time(const_SD_task_t task)
843 if (task->surf_action) /* should never happen as actions are destroyed right after their completion */
844 return task->surf_action->get_finish_time();
846 return task->finish_time;
849 void SD_task_distribute_comp_amdahl(SD_task_t task, int count)
851 xbt_assert(task->kind == SD_TASK_COMP_PAR_AMDAHL, "Task %s is not a SD_TASK_COMP_PAR_AMDAHL typed task."
852 "Cannot use this function.", task->name);
853 task->flops_amount = xbt_new0(double, count);
854 task->bytes_amount = xbt_new0(double, count * count);
856 for (int i=0; i<count; i++){
857 task->flops_amount[i] = (task->alpha + (1 - task->alpha)/count) * task->amount;
861 void SD_task_build_MxN_1D_block_matrix(SD_task_t task, int src_nb, int dst_nb){
862 xbt_assert(task->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK, "Task %s is not a SD_TASK_COMM_PAR_MXN_1D_BLOCK typed task."
863 "Cannot use this function.", task->name);
864 xbt_free(task->bytes_amount);
865 task->bytes_amount = xbt_new0(double,task->allocation->size() * task->allocation->size());
867 for (int i=0; i<src_nb; i++) {
868 double src_start = i*task->amount/src_nb;
869 double src_end = src_start + task->amount/src_nb;
870 for (int j=0; j<dst_nb; j++) {
871 double dst_start = j*task->amount/dst_nb;
872 double dst_end = dst_start + task->amount/dst_nb;
873 XBT_VERB("(%d->%d): (%.2f, %.2f)-> (%.2f, %.2f)", i, j, src_start, src_end, dst_start, dst_end);
874 task->bytes_amount[i*(src_nb+dst_nb)+src_nb+j]=0.0;
875 if ((src_end > dst_start) && (dst_end > src_start)) { /* There is something to send */
876 task->bytes_amount[i * (src_nb + dst_nb) + src_nb + j] =
877 std::min(src_end, dst_end) - std::max(src_start, dst_start);
878 XBT_VERB("==> %.2f", task->bytes_amount[i*(src_nb+dst_nb)+src_nb+j]);
884 /** @brief Auto-schedules a task.
886 * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows one to specify the task costs at
887 * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
890 * To be auto-schedulable, a task must be a typed computation SD_TASK_COMP_SEQ or SD_TASK_COMP_PAR_AMDAHL.
892 void SD_task_schedulev(SD_task_t task, int count, const sg_host_t * list)
894 xbt_assert(task->kind == SD_TASK_COMP_SEQ || task->kind == SD_TASK_COMP_PAR_AMDAHL,
895 "Task %s is not typed. Cannot automatically schedule it.", SD_task_get_name(task));
897 for(int i =0; i<count; i++)
898 task->allocation->push_back(list[i]);
900 XBT_VERB("Schedule computation task %s on %zu host(s)", task->name, task->allocation->size());
902 if (task->kind == SD_TASK_COMP_SEQ) {
903 if (not task->flops_amount) { /*This task has failed and is rescheduled. Reset the flops_amount*/
904 task->flops_amount = xbt_new0(double, 1);
905 task->flops_amount[0] = task->amount;
907 XBT_VERB("It costs %.f flops", task->flops_amount[0]);
910 if (task->kind == SD_TASK_COMP_PAR_AMDAHL) {
911 SD_task_distribute_comp_amdahl(task, count);
912 XBT_VERB("%.f flops will be distributed following Amdahl's Law", task->flops_amount[0]);
915 SD_task_do_schedule(task);
917 /* Iterate over all inputs and outputs to say where I am located (and start them if runnable) */
918 for (auto const& input : *task->inputs) {
919 int src_nb = static_cast<int>(input->allocation->size());
921 if (input->allocation->empty())
922 XBT_VERB("Sender side of '%s' not scheduled. Set receiver side to '%s''s allocation", input->name, task->name);
924 for (int i=0; i<count;i++)
925 input->allocation->push_back(task->allocation->at(i));
927 if (input->allocation->size () > task->allocation->size()) {
928 if (task->kind == SD_TASK_COMP_PAR_AMDAHL)
929 SD_task_build_MxN_1D_block_matrix(input, src_nb, dst_nb);
931 SD_task_do_schedule(input);
932 XBT_VERB ("Auto-Schedule Communication task '%s'. Send %.f bytes from %d hosts to %d hosts.",
933 input->name,input->amount, src_nb, dst_nb);
937 for (auto const& output : *task->outputs) {
939 int dst_nb = static_cast<int>(output->allocation->size());
940 if (output->allocation->empty())
941 XBT_VERB("Receiver side of '%s' not scheduled. Set sender side to '%s''s allocation", output->name, task->name);
943 for (int i=0; i<count;i++)
944 output->allocation->insert(output->allocation->begin()+i, task->allocation->at(i));
946 if (output->allocation->size () > task->allocation->size()) {
947 if (task->kind == SD_TASK_COMP_PAR_AMDAHL)
948 SD_task_build_MxN_1D_block_matrix(output, src_nb, dst_nb);
950 SD_task_do_schedule(output);
951 XBT_VERB ("Auto-Schedule Communication task %s. Send %.f bytes from %d hosts to %d hosts.",
952 output->name, output->amount, src_nb, dst_nb);
957 /** @brief autoschedule a task on a list of hosts
959 * This function is similar to SD_task_schedulev(), but takes the list of hosts to schedule onto as separate parameters.
960 * It builds a proper vector of hosts and then call SD_task_schedulev()
962 void SD_task_schedulel(SD_task_t task, int count, ...)
965 auto* list = new sg_host_t[count];
967 for (int i=0; i<count; i++)
968 list[i] = va_arg(ap, sg_host_t);
971 SD_task_schedulev(task, count, list);