1 /* Copyright (c) 2006-2016. 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 "src/surf/surf_interface.hpp"
8 #include "src/surf/host_interface.hpp"
9 #include "src/simdag/simdag_private.h"
10 #include "simgrid/simdag.h"
11 #include "xbt/sysdep.h"
12 #include "xbt/dynar.h"
13 #include "src/instr/instr_private.h"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_task, sd, "Logging specific to SimDag (task)");
17 static void __SD_task_remove_dependencies(SD_task_t task);
18 static void __SD_task_destroy_scheduling_data(SD_task_t task);
20 void* SD_task_new_f(void)
22 SD_task_t task = xbt_new0(s_SD_task_t, 1);
23 task->tasks_before = xbt_dynar_new(sizeof(SD_dependency_t), NULL);
24 task->tasks_after = xbt_dynar_new(sizeof(SD_dependency_t), NULL);
29 void SD_task_recycle_f(void *t)
31 SD_task_t task = (SD_task_t) t;
33 /* Reset the content */
34 task->kind = SD_TASK_NOT_TYPED;
35 task->state= SD_NOT_SCHEDULED;
36 xbt_dynar_push(sd_global->initial_task_set,&task);
41 task->start_time = -1.0;
42 task->finish_time = -1.0;
43 task->surf_action = NULL;
44 task->watch_points = 0;
47 xbt_dynar_reset(task->tasks_before);
48 xbt_dynar_reset(task->tasks_after);
49 task->unsatisfied_dependencies = 0;
50 task->is_not_ready = 0;
52 /* scheduling parameters */
54 task->host_list = NULL;
55 task->flops_amount = NULL;
56 task->bytes_amount = NULL;
60 void SD_task_free_f(void *t)
62 SD_task_t task = (SD_task_t)t;
64 xbt_dynar_free(&task->tasks_before);
65 xbt_dynar_free(&task->tasks_after);
70 * \brief Creates a new task.
72 * \param name the name of the task (can be \c NULL)
73 * \param data the user data you want to associate with the task (can be \c NULL)
74 * \param amount amount of the task
75 * \return the new task
76 * \see SD_task_destroy()
78 SD_task_t SD_task_create(const char *name, void *data, double amount)
80 SD_task_t task = (SD_task_t)xbt_mallocator_get(sd_global->task_mallocator);
82 /* general information */
83 task->data = data; /* user data */
84 task->name = xbt_strdup(name);
85 task->amount = amount;
86 task->remains = amount;
91 static XBT_INLINE SD_task_t SD_task_create_sized(const char *name, void *data, double amount, int ws_count)
93 SD_task_t task = SD_task_create(name, data, amount);
94 task->bytes_amount = xbt_new0(double, ws_count * ws_count);
95 task->flops_amount = xbt_new0(double, ws_count);
96 task->host_count = ws_count;
97 task->host_list = xbt_new0(sg_host_t, ws_count);
101 /** @brief create a end-to-end communication task that can then be auto-scheduled
103 * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows to specify the task costs at
104 * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
107 * A end-to-end communication must be scheduled on 2 hosts, and the amount specified at creation is sent from hosts[0]
110 SD_task_t SD_task_create_comm_e2e(const char *name, void *data, double amount)
112 SD_task_t res = SD_task_create_sized(name, data, amount, 2);
113 res->bytes_amount[2] = amount;
114 res->kind = SD_TASK_COMM_E2E;
119 /** @brief create a sequential computation task that can then be auto-scheduled
121 * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows to specify the task costs at
122 * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
125 * A sequential computation must be scheduled on 1 host, and the amount specified at creation to be run on hosts[0].
127 * \param name the name of the task (can be \c NULL)
128 * \param data the user data you want to associate with the task (can be \c NULL)
129 * \param flops_amount amount of compute work to be done by the task
130 * \return the new SD_TASK_COMP_SEQ typed task
132 SD_task_t SD_task_create_comp_seq(const char *name, void *data, double flops_amount)
134 SD_task_t res = SD_task_create_sized(name, data, flops_amount, 1);
135 res->flops_amount[0] = flops_amount;
136 res->kind = SD_TASK_COMP_SEQ;
141 /** @brief create a parallel computation task that can then be auto-scheduled
143 * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows to specify the task costs at
144 * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
147 * A parallel computation can be scheduled on any number of host.
148 * The underlying speedup model is Amdahl's law.
149 * To be auto-scheduled, \see SD_task_distribute_comp_amdahl has to be called first.
150 * \param name the name of the task (can be \c NULL)
151 * \param data the user data you want to associate with the task (can be \c NULL)
152 * \param flops_amount amount of compute work to be done by the task
153 * \param alpha purely serial fraction of the work to be done (in [0.;1.[)
154 * \return the new task
156 SD_task_t SD_task_create_comp_par_amdahl(const char *name, void *data, double flops_amount, double alpha)
158 xbt_assert(alpha < 1. && alpha >= 0., "Invalid parameter: alpha must be in [0.;1.[");
160 SD_task_t res = SD_task_create(name, data, flops_amount);
162 res->kind = SD_TASK_COMP_PAR_AMDAHL;
167 /** @brief create a complex data redistribution task that can then be auto-scheduled
169 * Auto-scheduling mean that the task can be used with SD_task_schedulev().
170 * This allows to specify the task costs at creation, and decouple them from the scheduling process where you just
171 * specify which resource should communicate.
173 * A data redistribution can be scheduled on any number of host.
174 * The assumed distribution is a 1D block distribution. Each host owns the same share of the \see amount.
175 * To be auto-scheduled, \see SD_task_distribute_comm_mxn_1d_block has to be called first.
176 * \param name the name of the task (can be \c NULL)
177 * \param data the user data you want to associate with the task (can be \c NULL)
178 * \param amount amount of data to redistribute by the task
179 * \return the new task
181 SD_task_t SD_task_create_comm_par_mxn_1d_block(const char *name, void *data, double amount)
183 SD_task_t res = SD_task_create(name, data, amount);
185 res->kind = SD_TASK_COMM_PAR_MXN_1D_BLOCK;
191 * \brief Destroys a task.
193 * The user data (if any) should have been destroyed first.
195 * \param task the task you want to destroy
196 * \see SD_task_create()
198 void SD_task_destroy(SD_task_t task)
201 XBT_DEBUG("Destroying task %s...", SD_task_get_name(task));
203 __SD_task_remove_dependencies(task);
205 if (task->state == SD_SCHEDULED || task->state == SD_RUNNABLE)
206 __SD_task_destroy_scheduling_data(task);
208 idx = xbt_dynar_search_or_negative(sd_global->return_set, &task);
210 xbt_dynar_remove_at(sd_global->return_set, idx, NULL);
213 xbt_free(task->name);
215 if (task->surf_action != NULL)
216 task->surf_action->unref();
218 xbt_free(task->host_list);
219 xbt_free(task->bytes_amount);
220 xbt_free(task->flops_amount);
222 xbt_mallocator_release(sd_global->task_mallocator,task);
224 XBT_DEBUG("Task destroyed.");
228 * \brief Returns the user data of a task
231 * \return the user data associated with this task (can be \c NULL)
232 * \see SD_task_set_data()
234 void *SD_task_get_data(SD_task_t task)
240 * \brief Sets the user data of a task
242 * The new data can be \c NULL. The old data should have been freed first
243 * if it was not \c NULL.
246 * \param data the new data you want to associate with this task
247 * \see SD_task_get_data()
249 void SD_task_set_data(SD_task_t task, void *data)
255 * \brief Sets the rate of a task
257 * This will change the network bandwidth a task can use. This rate cannot be dynamically changed. Once the task has
258 * started, this call is ineffective. This rate depends on both the nominal bandwidth on the route onto which the task
259 * is scheduled (\see SD_task_get_current_bandwidth) and the amount of data to transfer.
261 * To divide the nominal bandwidth by 2, the rate then has to be :
262 * rate = bandwidth/(2*amount)
264 * \param task a \see SD_TASK_COMM_E2E task (end-to-end communication)
265 * \param rate the new rate you want to associate with this task.
267 void SD_task_set_rate(SD_task_t task, double rate)
269 xbt_assert(task->kind == SD_TASK_COMM_E2E, "The rate can be modified for end-to-end communications only.");
270 if(task->start_time<0) {
273 XBT_WARN("Task %p has started. Changing rate is ineffective.", task);
278 * \brief Returns the state of a task
281 * \return the current \ref e_SD_task_state_t "state" of this task:
282 * #SD_NOT_SCHEDULED, #SD_SCHEDULED, #SD_RUNNABLE, #SD_RUNNING, #SD_DONE or #SD_FAILED
283 * \see e_SD_task_state_t
285 e_SD_task_state_t SD_task_get_state(SD_task_t task)
290 /* Changes the state of a task. Updates the sd_global->watch_point_reached flag.
292 void SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state)
296 case SD_NOT_SCHEDULED:
298 if (SD_task_get_state(task) == SD_FAILED){
299 xbt_dynar_remove_at(sd_global->completed_task_set,
300 xbt_dynar_search(sd_global->completed_task_set, &task), NULL);
301 xbt_dynar_push(sd_global->initial_task_set,&task);
305 if (SD_task_get_state(task) == SD_RUNNABLE){
306 xbt_dynar_remove_at(sd_global->executable_task_set,
307 xbt_dynar_search(sd_global->executable_task_set, &task), NULL);
308 xbt_dynar_push(sd_global->initial_task_set,&task);
312 idx = xbt_dynar_search_or_negative(sd_global->initial_task_set, &task);
314 xbt_dynar_remove_at(sd_global->initial_task_set, idx, NULL);
315 xbt_dynar_push(sd_global->executable_task_set,&task);
319 xbt_dynar_remove_at(sd_global->executable_task_set,
320 xbt_dynar_search(sd_global->executable_task_set, &task), NULL);
323 xbt_dynar_push(sd_global->completed_task_set,&task);
324 task->finish_time = task->surf_action->getFinishTime();
327 jedule_log_sd_event(task);
331 xbt_dynar_push(sd_global->completed_task_set,&task);
334 xbt_die( "Invalid state");
337 task->state = new_state;
339 if (task->watch_points & new_state) {
340 XBT_VERB("Watch point reached with task '%s'!", SD_task_get_name(task));
341 sd_global->watch_point_reached = 1;
342 SD_task_unwatch(task, new_state); /* remove the watch point */
347 * \brief Returns the name of a task
350 * \return the name of this task (can be \c NULL)
352 const char *SD_task_get_name(SD_task_t task)
357 /** @brief Allows to change the name of a task */
358 void SD_task_set_name(SD_task_t task, const char *name)
360 xbt_free(task->name);
361 task->name = xbt_strdup(name);
364 /** @brief Returns the dynar of the parents of a task
367 * \return a newly allocated dynar comprising the parents of this task
370 xbt_dynar_t SD_task_get_parents(SD_task_t task)
376 parents = xbt_dynar_new(sizeof(SD_task_t), NULL);
377 xbt_dynar_foreach(task->tasks_before, i, dep) {
378 xbt_dynar_push(parents, &(dep->src));
383 /** @brief Returns the dynar of the parents of a task
386 * \return a newly allocated dynar comprising the parents of this task
388 xbt_dynar_t SD_task_get_children(SD_task_t task)
391 xbt_dynar_t children;
394 children = xbt_dynar_new(sizeof(SD_task_t), NULL);
395 xbt_dynar_foreach(task->tasks_after, i, dep) {
396 xbt_dynar_push(children, &(dep->dst));
402 * \brief Returns the amount of workstations involved in a task
404 * Only call this on already scheduled tasks!
407 int SD_task_get_workstation_count(SD_task_t task)
409 return task->host_count;
413 * \brief Returns the list of workstations involved in a task
415 * Only call this on already scheduled tasks!
418 sg_host_t *SD_task_get_workstation_list(SD_task_t task)
420 return task->host_list;
424 * \brief Returns the total amount of work contained in a task
427 * \return the total amount of work (computation or data transfer) for this task
428 * \see SD_task_get_remaining_amount()
430 double SD_task_get_amount(SD_task_t task)
435 /** @brief Sets the total amount of work of a task
436 * For sequential typed tasks (COMP_SEQ and COMM_E2E), it also sets the appropriate values in the flops_amount and
437 * bytes_amount arrays respectively. Nothing more than modifying task->amount is done for parallel typed tasks
438 * (COMP_PAR_AMDAHL and COMM_PAR_MXN_1D_BLOCK) as the distribution of the amount of work is done at scheduling time.
441 * \param amount the new amount of work to execute
443 void SD_task_set_amount(SD_task_t task, double amount)
445 task->amount = amount;
446 if (task->kind == SD_TASK_COMP_SEQ)
447 task->flops_amount[0] = amount;
448 if (task->kind == SD_TASK_COMM_E2E)
449 task->bytes_amount[2] = amount;
453 * \brief Returns the alpha parameter of a SD_TASK_COMP_PAR_AMDAHL task
455 * \param task a parallel task assuming Amdahl's law as speedup model
456 * \return the alpha parameter (serial part of a task in percent) for this task
458 double SD_task_get_alpha(SD_task_t task)
460 xbt_assert(SD_task_get_kind(task) == SD_TASK_COMP_PAR_AMDAHL, "Alpha parameter is not defined for this kind of task");
466 * \brief Returns the remaining amount work to do till the completion of a task
469 * \return the remaining amount of work (computation or data transfer) of this task
470 * \see SD_task_get_amount()
472 double SD_task_get_remaining_amount(SD_task_t task)
474 if (task->surf_action)
475 return task->surf_action->getRemains();
477 return task->remains;
480 e_SD_task_kind_t SD_task_get_kind(SD_task_t task)
485 /** @brief Displays debugging informations about a task */
486 void SD_task_dump(SD_task_t task)
488 unsigned int counter;
489 SD_dependency_t dependency;
492 XBT_INFO("Displaying task %s", SD_task_get_name(task));
493 statename = bprintf("%s%s%s%s%s%s%s",
494 (task->state == SD_NOT_SCHEDULED ? " not scheduled" : ""),
495 (task->state == SD_SCHEDULABLE ? " schedulable" : ""),
496 (task->state == SD_SCHEDULED ? " scheduled" : ""),
497 (task->state == SD_RUNNABLE ? " runnable" : " not runnable"),
498 (task->state == SD_RUNNING ? " running" : ""),
499 (task->state == SD_DONE ? " done" : ""),
500 (task->state == SD_FAILED ? " failed" : ""));
501 XBT_INFO(" - state:%s", statename);
504 if (task->kind != 0) {
505 switch (task->kind) {
506 case SD_TASK_COMM_E2E:
507 XBT_INFO(" - kind: end-to-end communication");
509 case SD_TASK_COMP_SEQ:
510 XBT_INFO(" - kind: sequential computation");
512 case SD_TASK_COMP_PAR_AMDAHL:
513 XBT_INFO(" - kind: parallel computation following Amdahl's law");
515 case SD_TASK_COMM_PAR_MXN_1D_BLOCK:
516 XBT_INFO(" - kind: MxN data redistribution assuming 1D block distribution");
519 XBT_INFO(" - (unknown kind %d)", task->kind);
524 XBT_INFO(" - tracing category: %s", task->category);
526 XBT_INFO(" - amount: %.0f", SD_task_get_amount(task));
527 if (task->kind == SD_TASK_COMP_PAR_AMDAHL)
528 XBT_INFO(" - alpha: %.2f", task->alpha);
529 XBT_INFO(" - Dependencies to satisfy: %d", task->unsatisfied_dependencies);
530 if (!xbt_dynar_is_empty(task->tasks_before)) {
531 XBT_INFO(" - pre-dependencies:");
532 xbt_dynar_foreach(task->tasks_before, counter, dependency) {
533 XBT_INFO(" %s", SD_task_get_name(dependency->src));
536 if (!xbt_dynar_is_empty(task->tasks_after)) {
537 XBT_INFO(" - post-dependencies:");
538 xbt_dynar_foreach(task->tasks_after, counter, dependency) {
539 XBT_INFO(" %s", SD_task_get_name(dependency->dst));
544 /** @brief Dumps the task in dotty formalism into the FILE* passed as second argument */
545 void SD_task_dotty(SD_task_t task, void *out)
547 unsigned int counter;
548 SD_dependency_t dependency;
549 FILE *fout = (FILE*)out;
550 fprintf(fout, " T%p [label=\"%.20s\"", task, task->name);
551 switch (task->kind) {
552 case SD_TASK_COMM_E2E:
553 case SD_TASK_COMM_PAR_MXN_1D_BLOCK:
554 fprintf(fout, ", shape=box");
556 case SD_TASK_COMP_SEQ:
557 case SD_TASK_COMP_PAR_AMDAHL:
558 fprintf(fout, ", shape=circle");
561 xbt_die("Unknown task type!");
563 fprintf(fout, "];\n");
564 xbt_dynar_foreach(task->tasks_before, counter, dependency) {
565 fprintf(fout, " T%p -> T%p;\n", dependency->src, dependency->dst);
569 /* Destroys a dependency between two tasks.
571 static void __SD_task_dependency_destroy(void *dependency)
573 xbt_free(((SD_dependency_t)dependency)->name);
574 xbt_free(dependency);
578 * \brief Adds a dependency between two tasks
580 * \a dst will depend on \a src, ie \a dst will not start before \a src is finished.
581 * Their \ref e_SD_task_state_t "state" must be #SD_NOT_SCHEDULED, #SD_SCHEDULED or #SD_RUNNABLE.
583 * \param name the name of the new dependency (can be \c NULL)
584 * \param data the user data you want to associate with this dependency (can be \c NULL)
585 * \param src the task which must be executed first
586 * \param dst the task you want to make depend on \a src
587 * \see SD_task_dependency_remove()
589 void SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst)
592 unsigned long length;
595 SD_dependency_t dependency;
596 e_SD_task_state_t state;
598 dynar = src->tasks_after;
599 length = xbt_dynar_length(dynar);
602 THROWF(arg_error, 0, "Cannot add a dependency between task '%s' and itself", SD_task_get_name(src));
604 state = SD_task_get_state(src);
605 if (state != SD_NOT_SCHEDULED && state != SD_SCHEDULABLE && state != SD_RUNNING && state != SD_SCHEDULED &&
606 state != SD_RUNNABLE)
607 THROWF(arg_error, 0, "Task '%s' must be SD_NOT_SCHEDULED, SD_SCHEDULABLE, SD_SCHEDULED, SD_RUNNABLE, or SD_RUNNING",
608 SD_task_get_name(src));
610 state = SD_task_get_state(dst);
611 if (state != SD_NOT_SCHEDULED && state != SD_SCHEDULABLE && state != SD_SCHEDULED && state != SD_RUNNABLE)
612 THROWF(arg_error, 0, "Task '%s' must be SD_NOT_SCHEDULED, SD_SCHEDULABLE, SD_SCHEDULED, or SD_RUNNABLE",
613 SD_task_get_name(dst));
615 XBT_DEBUG("SD_task_dependency_add: src = %s, dst = %s", SD_task_get_name(src), SD_task_get_name(dst));
616 for (i = 0; i < length && !found; i++) {
617 xbt_dynar_get_cpy(dynar, i, &dependency);
618 found = (dependency->dst == dst);
619 XBT_DEBUG("Dependency %lu: dependency->dst = %s", i, SD_task_get_name(dependency->dst));
623 THROWF(arg_error, 0, "A dependency already exists between task '%s' and task '%s'",
624 SD_task_get_name(src), SD_task_get_name(dst));
626 dependency = xbt_new(s_SD_dependency_t, 1);
628 dependency->name = xbt_strdup(name); /* xbt_strdup is cleaver enough to deal with NULL args itself */
629 dependency->data = data;
630 dependency->src = src;
631 dependency->dst = dst;
633 /* src must be executed before dst */
634 xbt_dynar_push(src->tasks_after, &dependency);
635 xbt_dynar_push(dst->tasks_before, &dependency);
637 dst->unsatisfied_dependencies++;
640 /* if the task was runnable, then dst->tasks_before is not empty anymore, so we must go back to state SD_SCHEDULED */
641 if (SD_task_get_state(dst) == SD_RUNNABLE) {
642 XBT_DEBUG("SD_task_dependency_add: %s was runnable and becomes scheduled!", SD_task_get_name(dst));
643 SD_task_set_state(dst, SD_SCHEDULED);
647 * \brief Returns the name given as input when dependency has been created..
650 * \param dst a task depending on \a src
653 const char *SD_task_dependency_get_name(SD_task_t src, SD_task_t dst){
655 SD_dependency_t dependency;
657 xbt_dynar_foreach(src->tasks_after, i, dependency){
658 if (dependency->dst == dst)
659 return dependency->name;
665 * \brief Indicates whether there is a dependency between two tasks.
668 * \param dst a task depending on \a src
670 * If src is NULL, checks whether dst has any pre-dependency.
671 * If dst is NULL, checks whether src has any post-dependency.
673 int SD_task_dependency_exists(SD_task_t src, SD_task_t dst)
675 unsigned int counter;
676 SD_dependency_t dependency;
678 xbt_assert(src != NULL || dst != NULL, "Invalid parameter: both src and dst are NULL");
682 xbt_dynar_foreach(src->tasks_after, counter, dependency) {
683 if (dependency->dst == dst)
687 return xbt_dynar_length(src->tasks_after);
690 return xbt_dynar_length(dst->tasks_before);
696 * \brief Remove a dependency between two tasks
699 * \param dst a task depending on \a src
700 * \see SD_task_dependency_add()
702 void SD_task_dependency_remove(SD_task_t src, SD_task_t dst)
705 unsigned long length;
708 SD_dependency_t dependency;
710 /* remove the dependency from src->tasks_after */
711 dynar = src->tasks_after;
712 length = xbt_dynar_length(dynar);
714 for (i = 0; i < length && !found; i++) {
715 xbt_dynar_get_cpy(dynar, i, &dependency);
716 if (dependency->dst == dst) {
717 xbt_dynar_remove_at(dynar, i, NULL);
722 THROWF(arg_error, 0, "No dependency found between task '%s' and '%s': task '%s' is not a successor of task '%s'",
723 SD_task_get_name(src), SD_task_get_name(dst), SD_task_get_name(dst), SD_task_get_name(src));
725 /* remove the dependency from dst->tasks_before */
726 dynar = dst->tasks_before;
727 length = xbt_dynar_length(dynar);
730 for (i = 0; i < length && !found; i++) {
731 xbt_dynar_get_cpy(dynar, i, &dependency);
732 if (dependency->src == src) {
733 xbt_dynar_remove_at(dynar, i, NULL);
734 __SD_task_dependency_destroy(dependency);
735 dst->unsatisfied_dependencies--;
740 /* should never happen... */
741 xbt_assert(found, "SimDag error: task '%s' is a successor of '%s' but task '%s' is not a predecessor of task '%s'",
742 SD_task_get_name(dst), SD_task_get_name(src), SD_task_get_name(src), SD_task_get_name(dst));
744 /* if the task was scheduled and dst->tasks_before is empty now, we can make it runnable */
746 if (dst->unsatisfied_dependencies == 0) {
747 if (SD_task_get_state(dst) == SD_SCHEDULED)
748 SD_task_set_state(dst, SD_RUNNABLE);
750 SD_task_set_state(dst, SD_SCHEDULABLE);
753 if (dst->is_not_ready == 0)
754 SD_task_set_state(dst, SD_SCHEDULABLE);
758 * \brief Returns the user data associated with a dependency between two tasks
761 * \param dst a task depending on \a src
762 * \return the user data associated with this dependency (can be \c NULL)
763 * \see SD_task_dependency_add()
765 void *SD_task_dependency_get_data(SD_task_t src, SD_task_t dst)
768 unsigned long length;
771 SD_dependency_t dependency;
773 dynar = src->tasks_after;
774 length = xbt_dynar_length(dynar);
776 for (i = 0; i < length && !found; i++) {
777 xbt_dynar_get_cpy(dynar, i, &dependency);
778 found = (dependency->dst == dst);
781 THROWF(arg_error, 0, "No dependency found between task '%s' and '%s'",
782 SD_task_get_name(src), SD_task_get_name(dst));
783 return dependency->data;
787 * \brief Adds a watch point to a task
789 * SD_simulate() will stop as soon as the \ref e_SD_task_state_t "state" of this task becomes the one given in argument.
790 * The watch point is then automatically removed.
793 * \param state the \ref e_SD_task_state_t "state" you want to watch
794 * (cannot be #SD_NOT_SCHEDULED)
795 * \see SD_task_unwatch()
797 void SD_task_watch(SD_task_t task, e_SD_task_state_t state)
799 if (state & SD_NOT_SCHEDULED)
800 THROWF(arg_error, 0, "Cannot add a watch point for state SD_NOT_SCHEDULED");
802 task->watch_points = task->watch_points | state;
806 * \brief Removes a watch point from a task
809 * \param state the \ref e_SD_task_state_t "state" you no longer want to watch
810 * \see SD_task_watch()
812 void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state)
814 xbt_assert(state != SD_NOT_SCHEDULED, "SimDag error: Cannot have a watch point for state SD_NOT_SCHEDULED");
816 task->watch_points = task->watch_points & ~state;
820 * \brief Returns an approximative estimation of the execution time of a task.
822 * The estimation is very approximative because the value returned is the time the task would take if it was executed
823 * now and if it was the only task.
825 * \param task the task to evaluate
826 * \param workstation_nb number of workstations on which the task would be executed
827 * \param workstation_list the workstations on which the task would be executed
828 * \param flops_amount computation amount for each workstation
829 * \param bytes_amount communication amount between each pair of workstations
832 double SD_task_get_execution_time(SD_task_t task, int workstation_nb, const sg_host_t *workstation_list,
833 const double *flops_amount, const double *bytes_amount)
835 double time, max_time = 0.0;
837 xbt_assert(workstation_nb > 0, "Invalid parameter");
839 /* the task execution time is the maximum execution time of the parallel tasks */
841 for (i = 0; i < workstation_nb; i++) {
843 if (flops_amount != NULL)
844 time = flops_amount[i] / sg_host_speed(workstation_list[i]);
846 if (bytes_amount != NULL)
847 for (j = 0; j < workstation_nb; j++) {
848 if (bytes_amount[i * workstation_nb + j] !=0 ) {
849 time += (SD_route_get_latency(workstation_list[i], workstation_list[j]) +
850 bytes_amount[i * workstation_nb + j] /
851 SD_route_get_bandwidth(workstation_list[i], workstation_list[j]));
855 if (time > max_time) {
862 static XBT_INLINE void SD_task_do_schedule(SD_task_t task)
864 if (SD_task_get_state(task) > SD_SCHEDULABLE)
865 THROWF(arg_error, 0, "Task '%s' has already been scheduled", SD_task_get_name(task));
867 /* update the task state */
868 if (task->unsatisfied_dependencies == 0)
869 SD_task_set_state(task, SD_RUNNABLE);
871 SD_task_set_state(task, SD_SCHEDULED);
875 * \brief Schedules a task
877 * The task state must be #SD_NOT_SCHEDULED.
878 * Once scheduled, a task is executed as soon as possible in \see SD_simulate, i.e. when its dependencies are satisfied.
880 * \param task the task you want to schedule
881 * \param workstation_count number of workstations on which the task will be executed
882 * \param workstation_list the workstations on which the task will be executed
883 * \param flops_amount computation amount for each workstation
884 * \param bytes_amount communication amount between each pair of workstations
885 * \param rate task execution speed rate
886 * \see SD_task_unschedule()
888 void SD_task_schedule(SD_task_t task, int workstation_count, const sg_host_t * workstation_list,
889 const double *flops_amount, const double *bytes_amount, double rate)
891 xbt_assert(workstation_count > 0, "workstation_nb must be positive");
893 task->host_count = workstation_count;
897 task->flops_amount = (double*)xbt_realloc(task->flops_amount, sizeof(double) * workstation_count);
898 memcpy(task->flops_amount, flops_amount, sizeof(double) * workstation_count);
900 xbt_free(task->flops_amount);
901 task->flops_amount = NULL;
904 int communication_nb = workstation_count * workstation_count;
906 task->bytes_amount = (double*)xbt_realloc(task->bytes_amount, sizeof(double) * communication_nb);
907 memcpy(task->bytes_amount, bytes_amount, sizeof(double) * communication_nb);
909 xbt_free(task->bytes_amount);
910 task->bytes_amount = NULL;
913 task->host_list = (sg_host_t*) xbt_realloc(task->host_list, sizeof(sg_host_t) * workstation_count);
914 memcpy(task->host_list, workstation_list, sizeof(sg_host_t) * workstation_count);
916 SD_task_do_schedule(task);
920 * \brief Unschedules a task
922 * The task state must be #SD_SCHEDULED, #SD_RUNNABLE, #SD_RUNNING or #SD_FAILED.
923 * If you call this function, the task state becomes #SD_NOT_SCHEDULED.
924 * Call SD_task_schedule() to schedule it again.
926 * \param task the task you want to unschedule
927 * \see SD_task_schedule()
929 void SD_task_unschedule(SD_task_t task)
931 if (task->state != SD_SCHEDULED && task->state != SD_RUNNABLE && task->state != SD_RUNNING &&
932 task->state != SD_FAILED)
933 THROWF(arg_error, 0, "Task %s: the state must be SD_SCHEDULED, SD_RUNNABLE, SD_RUNNING or SD_FAILED",
934 SD_task_get_name(task));
936 if ((task->state == SD_SCHEDULED || task->state == SD_RUNNABLE)
937 /* if the task is scheduled or runnable */
938 && ((task->kind == SD_TASK_COMP_PAR_AMDAHL) || (task->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK))) {
939 /* Don't free scheduling data for typed tasks */
940 __SD_task_destroy_scheduling_data(task);
941 xbt_free(task->host_list);
942 task->host_list=NULL;
943 task->host_count = 0;
946 if (SD_task_get_state(task) == SD_RUNNING)
947 /* the task should become SD_FAILED */
948 task->surf_action->cancel();
950 if (task->unsatisfied_dependencies == 0)
951 SD_task_set_state(task, SD_SCHEDULABLE);
953 SD_task_set_state(task, SD_NOT_SCHEDULED);
955 task->remains = task->amount;
956 task->start_time = -1.0;
959 /* Destroys the data memorized by SD_task_schedule. Task state must be SD_SCHEDULED or SD_RUNNABLE.
961 static void __SD_task_destroy_scheduling_data(SD_task_t task)
963 if (task->state != SD_SCHEDULED && task->state != SD_RUNNABLE)
964 THROWF(arg_error, 0, "Task '%s' must be SD_SCHEDULED or SD_RUNNABLE", SD_task_get_name(task));
966 xbt_free(task->flops_amount);
967 xbt_free(task->bytes_amount);
968 task->flops_amount = task->bytes_amount = NULL;
972 void SD_task_run(SD_task_t task)
977 xbt_assert(SD_task_get_state(task) == SD_RUNNABLE, "Task '%s' is not runnable! Task state: %d",
978 SD_task_get_name(task), (int)SD_task_get_state(task));
979 xbt_assert(task->host_list != NULL, "Task '%s': workstation_list is NULL!", SD_task_get_name(task));
981 XBT_DEBUG("Running task '%s'", SD_task_get_name(task));
983 /* Copy the elements of the task into the action */
984 int host_nb = task->host_count;
985 hosts = xbt_new(sg_host_t, host_nb);
987 for (i = 0; i < host_nb; i++)
988 hosts[i] = task->host_list[i];
990 double *flops_amount = xbt_new0(double, host_nb);
991 double *bytes_amount = xbt_new0(double, host_nb * host_nb);
993 if(task->flops_amount)
994 memcpy(flops_amount, task->flops_amount, sizeof(double) * host_nb);
995 if(task->bytes_amount)
996 memcpy(bytes_amount, task->bytes_amount, sizeof(double) * host_nb * host_nb);
998 task->surf_action = surf_host_model->executeParallelTask(host_nb, hosts, flops_amount, bytes_amount, task->rate);
1000 task->surf_action->setData(task);
1002 XBT_DEBUG("surf_action = %p", task->surf_action);
1005 TRACE_surf_action(task->surf_action, task->category);
1007 __SD_task_destroy_scheduling_data(task); /* now the scheduling data are not useful anymore */
1008 SD_task_set_state(task, SD_RUNNING);
1009 xbt_assert(SD_task_get_state(task) == SD_RUNNING, "Bad state of task '%s': %d",
1010 SD_task_get_name(task), (int)SD_task_get_state(task));
1015 * Remove all dependencies associated with a task. This function is called when the task is destroyed.
1017 static void __SD_task_remove_dependencies(SD_task_t task)
1019 /* we must destroy the dependencies carefuly (with SD_dependency_remove) because each one is stored twice */
1020 SD_dependency_t dependency;
1021 while (!xbt_dynar_is_empty(task->tasks_before)) {
1022 xbt_dynar_get_cpy(task->tasks_before, 0, &dependency);
1023 SD_task_dependency_remove(dependency->src, dependency->dst);
1026 while (!xbt_dynar_is_empty(task->tasks_after)) {
1027 xbt_dynar_get_cpy(task->tasks_after, 0, &dependency);
1028 SD_task_dependency_remove(dependency->src, dependency->dst);
1033 * \brief Returns the start time of a task
1035 * The task state must be SD_RUNNING, SD_DONE or SD_FAILED.
1037 * \param task: a task
1038 * \return the start time of this task
1040 double SD_task_get_start_time(SD_task_t task)
1042 if (task->surf_action)
1043 return task->surf_action->getStartTime();
1045 return task->start_time;
1049 * \brief Returns the finish time of a task
1051 * The task state must be SD_RUNNING, SD_DONE or SD_FAILED.
1052 * If the state is not completed yet, the returned value is an estimation of the task finish time. This value can
1053 * vary until the task is completed.
1055 * \param task: a task
1056 * \return the start time of this task
1058 double SD_task_get_finish_time(SD_task_t task)
1060 if (task->surf_action) /* should never happen as actions are destroyed right after their completion */
1061 return task->surf_action->getFinishTime();
1063 return task->finish_time;
1066 void SD_task_distribute_comp_amdahl(SD_task_t task, int ws_count)
1069 xbt_assert(task->kind == SD_TASK_COMP_PAR_AMDAHL, "Task %s is not a SD_TASK_COMP_PAR_AMDAHL typed task."
1070 "Cannot use this function.", SD_task_get_name(task));
1071 task->flops_amount = xbt_new0(double, ws_count);
1072 task->bytes_amount = xbt_new0(double, ws_count * ws_count);
1073 xbt_free(task->host_list);
1074 task->host_count = ws_count;
1075 task->host_list = xbt_new0(sg_host_t, ws_count);
1077 for(i=0;i<ws_count;i++){
1078 task->flops_amount[i] = (task->alpha + (1 - task->alpha)/ws_count) * task->amount;
1083 /** @brief Auto-schedules a task.
1085 * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows to specify the task costs at
1086 * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
1089 * To be auto-schedulable, a task must be type and created with one of the specialized creation functions.
1092 * We should create tasks kind for the following categories:
1093 * - Point to point communication (done)
1094 * - Sequential computation (done)
1095 * - group communication (redistribution, several kinds)
1096 * - parallel tasks with no internal communication (one kind per speedup model such as Amdahl)
1097 * - idem+ internal communication. Task type not enough since we cannot store comm cost alongside to comp one)
1099 void SD_task_schedulev(SD_task_t task, int count, const sg_host_t * list)
1102 SD_dependency_t dep;
1104 xbt_assert(task->kind != 0, "Task %s is not typed. Cannot automatically schedule it.", SD_task_get_name(task));
1105 switch (task->kind) {
1106 case SD_TASK_COMP_PAR_AMDAHL:
1107 SD_task_distribute_comp_amdahl(task, count);
1108 case SD_TASK_COMM_E2E:
1109 case SD_TASK_COMP_SEQ:
1110 xbt_assert(task->host_count == count, "Got %d locations, but were expecting %d locations", count,task->host_count);
1111 for (i = 0; i < count; i++)
1112 task->host_list[i] = list[i];
1113 if (SD_task_get_kind(task)== SD_TASK_COMP_SEQ && !task->flops_amount){
1114 /*This task has failed and is rescheduled. Reset the flops_amount*/
1115 task->flops_amount = xbt_new0(double, 1);
1116 task->flops_amount[0] = task->remains;
1118 SD_task_do_schedule(task);
1121 xbt_die("Kind of task %s not supported by SD_task_schedulev()", SD_task_get_name(task));
1123 if (task->kind == SD_TASK_COMM_E2E) {
1124 XBT_VERB("Schedule comm task %s between %s -> %s. It costs %.f bytes", SD_task_get_name(task),
1125 sg_host_get_name(task->host_list[0]), sg_host_get_name(task->host_list[1]), task->bytes_amount[2]);
1129 /* Iterate over all children and parents being COMM_E2E to say where I am located (and start them if runnable) */
1130 if (task->kind == SD_TASK_COMP_SEQ) {
1131 XBT_VERB("Schedule computation task %s on %s. It costs %.f flops", SD_task_get_name(task),
1132 sg_host_get_name(task->host_list[0]), task->flops_amount[0]);
1134 xbt_dynar_foreach(task->tasks_before, cpt, dep) {
1135 SD_task_t before = dep->src;
1136 if (before->kind == SD_TASK_COMM_E2E) {
1137 before->host_list[1] = task->host_list[0];
1139 if (before->host_list[0] && (SD_task_get_state(before) < SD_SCHEDULED)) {
1140 SD_task_do_schedule(before);
1141 XBT_VERB ("Auto-Schedule comm task %s between %s -> %s. It costs %.f bytes", SD_task_get_name(before),
1142 sg_host_get_name(before->host_list[0]), sg_host_get_name(before->host_list[1]), before->bytes_amount[2]);
1146 xbt_dynar_foreach(task->tasks_after, cpt, dep) {
1147 SD_task_t after = dep->dst;
1148 if (after->kind == SD_TASK_COMM_E2E) {
1149 after->host_list[0] = task->host_list[0];
1150 if (after->host_list[1] && (SD_task_get_state(after) < SD_SCHEDULED)) {
1151 SD_task_do_schedule(after);
1152 XBT_VERB ("Auto-Schedule comm task %s between %s -> %s. It costs %.f bytes", SD_task_get_name(after),
1153 sg_host_get_name(after->host_list[0]), sg_host_get_name(after->host_list[1]), after->bytes_amount[2]);
1158 /* Iterate over all children and parents being MXN_1D_BLOCK to say where I am located (and start them if runnable) */
1159 if (task->kind == SD_TASK_COMP_PAR_AMDAHL) {
1160 XBT_VERB("Schedule computation task %s on %d workstations. %.f flops will be distributed following Amdahl's Law",
1161 SD_task_get_name(task), task->host_count, task->flops_amount[0]);
1162 xbt_dynar_foreach(task->tasks_before, cpt, dep) {
1163 SD_task_t before = dep->src;
1164 if (before->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK){
1165 if (!before->host_list){
1166 XBT_VERB("Sender side of Task %s is not scheduled yet", SD_task_get_name(before));
1167 before->host_list = xbt_new0(sg_host_t, count);
1168 before->host_count = count;
1169 XBT_VERB("Fill the workstation list with list of Task '%s'", SD_task_get_name(task));
1170 for (i=0;i<count;i++)
1171 before->host_list[i] = task->host_list[i];
1173 XBT_VERB("Build communication matrix for task '%s'", SD_task_get_name(before));
1175 double src_start, src_end, dst_start, dst_end;
1176 src_nb = before->host_count;
1178 before->host_list = (sg_host_t*) xbt_realloc(before->host_list, (before->host_count+count)*sizeof(sg_host_t));
1179 for(i=0; i<count; i++)
1180 before->host_list[before->host_count+i] = task->host_list[i];
1182 before->host_count += count;
1183 xbt_free(before->flops_amount);
1184 xbt_free(before->bytes_amount);
1185 before->flops_amount = xbt_new0(double, before->host_count);
1186 before->bytes_amount = xbt_new0(double, before->host_count* before->host_count);
1188 for(i=0;i<src_nb;i++){
1189 src_start = i*before->amount/src_nb;
1190 src_end = src_start + before->amount/src_nb;
1191 for(j=0; j<dst_nb; j++){
1192 dst_start = j*before->amount/dst_nb;
1193 dst_end = dst_start + before->amount/dst_nb;
1194 XBT_VERB("(%s->%s): (%.2f, %.2f)-> (%.2f, %.2f)", sg_host_get_name(before->host_list[i]),
1195 sg_host_get_name(before->host_list[src_nb+j]), src_start, src_end, dst_start, dst_end);
1196 if ((src_end <= dst_start) || (dst_end <= src_start)) {
1197 before->bytes_amount[i*(src_nb+dst_nb)+src_nb+j]=0.0;
1199 before->bytes_amount[i*(src_nb+dst_nb)+src_nb+j] = MIN(src_end, dst_end) - MAX(src_start, dst_start);
1201 XBT_VERB("==> %.2f", before->bytes_amount[i*(src_nb+dst_nb)+src_nb+j]);
1205 if (SD_task_get_state(before)< SD_SCHEDULED) {
1206 SD_task_do_schedule(before);
1208 ("Auto-Schedule redistribution task %s. Send %.f bytes from %d hosts to %d hosts.",
1209 SD_task_get_name(before),before->amount, src_nb, dst_nb);
1214 xbt_dynar_foreach(task->tasks_after, cpt, dep) {
1215 SD_task_t after = dep->dst;
1216 if (after->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK){
1217 if (!after->host_list){
1218 XBT_VERB("Receiver side of Task '%s' is not scheduled yet", SD_task_get_name(after));
1219 after->host_list = xbt_new0(sg_host_t, count);
1220 after->host_count = count;
1221 XBT_VERB("Fill the workstation list with list of Task '%s'", SD_task_get_name(task));
1222 for (i=0;i<count;i++)
1223 after->host_list[i] = task->host_list[i];
1226 double src_start, src_end, dst_start, dst_end;
1228 dst_nb = after->host_count;
1229 after->host_list = (sg_host_t*) xbt_realloc(after->host_list, (after->host_count+count)*sizeof(sg_host_t));
1230 for(i=after->host_count - 1; i>=0; i--)
1231 after->host_list[count+i] = after->host_list[i];
1232 for(i=0; i<count; i++)
1233 after->host_list[i] = task->host_list[i];
1235 after->host_count += count;
1237 xbt_free(after->flops_amount);
1238 xbt_free(after->bytes_amount);
1240 after->flops_amount = xbt_new0(double, after->host_count);
1241 after->bytes_amount = xbt_new0(double, after->host_count* after->host_count);
1243 for(i=0;i<src_nb;i++){
1244 src_start = i*after->amount/src_nb;
1245 src_end = src_start + after->amount/src_nb;
1246 for(j=0; j<dst_nb; j++){
1247 dst_start = j*after->amount/dst_nb;
1248 dst_end = dst_start + after->amount/dst_nb;
1249 XBT_VERB("(%d->%d): (%.2f, %.2f)-> (%.2f, %.2f)", i, j, src_start, src_end, dst_start, dst_end);
1250 if ((src_end <= dst_start) || (dst_end <= src_start)) {
1251 after->bytes_amount[i*(src_nb+dst_nb)+src_nb+j]=0.0;
1253 after->bytes_amount[i*(src_nb+dst_nb)+src_nb+j] = MIN(src_end, dst_end)- MAX(src_start, dst_start);
1255 XBT_VERB("==> %.2f", after->bytes_amount[i*(src_nb+dst_nb)+src_nb+j]);
1259 if (SD_task_get_state(after)< SD_SCHEDULED) {
1260 SD_task_do_schedule(after);
1261 XBT_VERB ("Auto-Schedule redistribution task %s. Send %.f bytes from %d hosts to %d hosts.",
1262 SD_task_get_name(after),after->amount, src_nb, dst_nb);
1270 /** @brief autoschedule a task on a list of workstations
1272 * This function is very similar to SD_task_schedulev(), but takes the list of workstations to schedule onto as
1273 * separate parameters.
1274 * It builds a proper vector of workstations and then call SD_task_schedulev()
1276 void SD_task_schedulel(SD_task_t task, int count, ...)
1279 sg_host_t *list = xbt_new(sg_host_t, count);
1281 va_start(ap, count);
1282 for (i = 0; i < count; i++) {
1283 list[i] = va_arg(ap, sg_host_t);
1286 SD_task_schedulev(task, count, list);