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/HostImpl.hpp"
8 #include "src/surf/surf_interface.hpp"
9 #include "src/simdag/simdag_private.h"
10 #include "simgrid/simdag.h"
11 #include "src/instr/instr_private.h"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_task, sd, "Logging specific to SimDag (task)");
15 /* Destroys the data memorized by SD_task_schedule. Task state must be SD_SCHEDULED or SD_RUNNABLE. */
16 static void __SD_task_destroy_scheduling_data(SD_task_t task)
18 if (task->state != SD_SCHEDULED && task->state != SD_RUNNABLE)
19 THROWF(arg_error, 0, "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->flops_amount = nullptr;
24 task->bytes_amount = nullptr;
29 SD_task_t task = xbt_new0(s_SD_task_t, 1);
31 task->inputs = new std::set<SD_task_t>();
32 task->outputs = new std::set<SD_task_t>();
33 task->predecessors = new std::set<SD_task_t>();
34 task->successors = new std::set<SD_task_t>();
38 void SD_task_recycle_f(void *t)
40 SD_task_t task = static_cast<SD_task_t>(t);
42 /* Reset the content */
43 task->kind = SD_TASK_NOT_TYPED;
44 task->state= SD_NOT_SCHEDULED;
45 sd_global->initial_tasks->insert(task);
49 task->start_time = -1.0;
50 task->finish_time = -1.0;
51 task->surf_action = nullptr;
52 task->watch_points = 0;
55 task->inputs->clear();
56 task->outputs->clear();
57 task->predecessors->clear();
58 task->successors->clear();
60 /* scheduling parameters */
62 task->host_list = nullptr;
63 task->flops_amount = nullptr;
64 task->bytes_amount = nullptr;
68 void SD_task_free_f(void *t)
70 SD_task_t task = static_cast<SD_task_t>(t);
74 delete task->predecessors;
75 delete task->successors;
81 * \brief Creates a new task.
83 * \param name the name of the task (can be \c nullptr)
84 * \param data the user data you want to associate with the task (can be \c nullptr)
85 * \param amount amount of the task
86 * \return the new task
87 * \see SD_task_destroy()
89 SD_task_t SD_task_create(const char *name, void *data, double amount)
91 SD_task_t task = static_cast<SD_task_t>(xbt_mallocator_get(sd_global->task_mallocator));
93 /* general information */
94 task->data = data; /* user data */
95 task->name = xbt_strdup(name);
96 task->amount = amount;
97 task->remains = amount;
102 static inline SD_task_t SD_task_create_sized(const char *name, void *data, double amount, int ws_count)
104 SD_task_t task = SD_task_create(name, data, amount);
105 task->bytes_amount = xbt_new0(double, ws_count * ws_count);
106 task->flops_amount = xbt_new0(double, ws_count);
107 task->host_count = ws_count;
108 task->host_list = xbt_new0(sg_host_t, ws_count);
112 /** @brief create a end-to-end communication task that can then be auto-scheduled
114 * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows to specify the task costs at
115 * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
118 * A end-to-end communication must be scheduled on 2 hosts, and the amount specified at creation is sent from hosts[0]
121 SD_task_t SD_task_create_comm_e2e(const char *name, void *data, double amount)
123 SD_task_t res = SD_task_create_sized(name, data, amount, 2);
124 res->bytes_amount[2] = amount;
125 res->kind = SD_TASK_COMM_E2E;
130 /** @brief create a sequential computation task that can then be auto-scheduled
132 * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows to specify the task costs at
133 * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
136 * A sequential computation must be scheduled on 1 host, and the amount specified at creation to be run on hosts[0].
138 * \param name the name of the task (can be \c nullptr)
139 * \param data the user data you want to associate with the task (can be \c nullptr)
140 * \param flops_amount amount of compute work to be done by the task
141 * \return the new SD_TASK_COMP_SEQ typed task
143 SD_task_t SD_task_create_comp_seq(const char *name, void *data, double flops_amount)
145 SD_task_t res = SD_task_create_sized(name, data, flops_amount, 1);
146 res->flops_amount[0] = flops_amount;
147 res->kind = SD_TASK_COMP_SEQ;
152 /** @brief create a parallel computation task that can then be auto-scheduled
154 * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows to specify the task costs at
155 * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
158 * A parallel computation can be scheduled on any number of host.
159 * The underlying speedup model is Amdahl's law.
160 * To be auto-scheduled, \see SD_task_distribute_comp_amdahl has to be called first.
161 * \param name the name of the task (can be \c nullptr)
162 * \param data the user data you want to associate with the task (can be \c nullptr)
163 * \param flops_amount amount of compute work to be done by the task
164 * \param alpha purely serial fraction of the work to be done (in [0.;1.[)
165 * \return the new task
167 SD_task_t SD_task_create_comp_par_amdahl(const char *name, void *data, double flops_amount, double alpha)
169 xbt_assert(alpha < 1. && alpha >= 0., "Invalid parameter: alpha must be in [0.;1.[");
171 SD_task_t res = SD_task_create(name, data, flops_amount);
173 res->kind = SD_TASK_COMP_PAR_AMDAHL;
178 /** @brief create a complex data redistribution task that can then be auto-scheduled
180 * Auto-scheduling mean that the task can be used with SD_task_schedulev().
181 * This allows to specify the task costs at creation, and decouple them from the scheduling process where you just
182 * specify which resource should communicate.
184 * A data redistribution can be scheduled on any number of host.
185 * The assumed distribution is a 1D block distribution. Each host owns the same share of the \see amount.
186 * To be auto-scheduled, \see SD_task_distribute_comm_mxn_1d_block has to be called first.
187 * \param name the name of the task (can be \c nullptr)
188 * \param data the user data you want to associate with the task (can be \c nullptr)
189 * \param amount amount of data to redistribute by the task
190 * \return the new task
192 SD_task_t SD_task_create_comm_par_mxn_1d_block(const char *name, void *data, double amount)
194 SD_task_t res = SD_task_create(name, data, amount);
195 res->host_list=nullptr;
196 res->kind = SD_TASK_COMM_PAR_MXN_1D_BLOCK;
202 * \brief Destroys a task.
204 * The user data (if any) should have been destroyed first.
206 * \param task the task you want to destroy
207 * \see SD_task_create()
209 void SD_task_destroy(SD_task_t task)
211 XBT_DEBUG("Destroying task %s...", SD_task_get_name(task));
213 /* First Remove all dependencies associated with the task. */
214 while (!task->predecessors->empty())
215 SD_task_dependency_remove(*(task->predecessors->begin()), task);
216 while (!task->inputs->empty())
217 SD_task_dependency_remove(*(task->inputs->begin()), task);
218 while (!task->successors->empty())
219 SD_task_dependency_remove(task, *(task->successors->begin()));
220 while (!task->outputs->empty())
221 SD_task_dependency_remove(task, *(task->outputs->begin()));
223 if (task->state == SD_SCHEDULED || task->state == SD_RUNNABLE)
224 __SD_task_destroy_scheduling_data(task);
226 int idx = xbt_dynar_search_or_negative(sd_global->return_set, &task);
228 xbt_dynar_remove_at(sd_global->return_set, idx, nullptr);
231 xbt_free(task->name);
233 if (task->surf_action != nullptr)
234 task->surf_action->unref();
236 xbt_free(task->host_list);
237 xbt_free(task->bytes_amount);
238 xbt_free(task->flops_amount);
240 xbt_mallocator_release(sd_global->task_mallocator,task);
242 XBT_DEBUG("Task destroyed.");
246 * \brief Returns the user data of a task
249 * \return the user data associated with this task (can be \c nullptr)
250 * \see SD_task_set_data()
252 void *SD_task_get_data(SD_task_t task)
258 * \brief Sets the user data of a task
260 * The new data can be \c nullptr. The old data should have been freed first
261 * if it was not \c nullptr.
264 * \param data the new data you want to associate with this task
265 * \see SD_task_get_data()
267 void SD_task_set_data(SD_task_t task, void *data)
273 * \brief Sets the rate of a task
275 * This will change the network bandwidth a task can use. This rate cannot be dynamically changed. Once the task has
276 * started, this call is ineffective. This rate depends on both the nominal bandwidth on the route onto which the task
277 * is scheduled (\see SD_task_get_current_bandwidth) and the amount of data to transfer.
279 * To divide the nominal bandwidth by 2, the rate then has to be :
280 * rate = bandwidth/(2*amount)
282 * \param task a \see SD_TASK_COMM_E2E task (end-to-end communication)
283 * \param rate the new rate you want to associate with this task.
285 void SD_task_set_rate(SD_task_t task, double rate)
287 xbt_assert(task->kind == SD_TASK_COMM_E2E, "The rate can be modified for end-to-end communications only.");
288 if(task->state < SD_RUNNING) {
291 XBT_WARN("Task %p has started. Changing rate is ineffective.", task);
296 * \brief Returns the state of a task
299 * \return the current \ref e_SD_task_state_t "state" of this task:
300 * #SD_NOT_SCHEDULED, #SD_SCHEDULED, #SD_RUNNABLE, #SD_RUNNING, #SD_DONE or #SD_FAILED
301 * \see e_SD_task_state_t
303 e_SD_task_state_t SD_task_get_state(SD_task_t task)
308 /* Changes the state of a task. Updates the sd_global->watch_point_reached flag.
310 void SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state)
312 std::set<SD_task_t>::iterator idx;
313 XBT_DEBUG("Set state of '%s' to %d", task->name, new_state);
315 case SD_NOT_SCHEDULED:
317 if (SD_task_get_state(task) == SD_FAILED){
318 sd_global->completed_tasks->erase(task);
319 sd_global->initial_tasks->insert(task);
323 if (SD_task_get_state(task) == SD_RUNNABLE){
324 sd_global->initial_tasks->insert(task);
325 sd_global->runnable_tasks->erase(task);
329 idx = sd_global->initial_tasks->find(task);
330 if (idx != sd_global->initial_tasks->end()) {
331 sd_global->runnable_tasks->insert(*idx);
332 sd_global->initial_tasks->erase(idx);
336 sd_global->runnable_tasks->erase(task);
339 sd_global->completed_tasks->insert(task);
340 task->start_time = task->surf_action->getStartTime();
341 task->finish_time = task->surf_action->getFinishTime();
342 task->surf_action->unref();
343 task->surf_action = nullptr;
346 jedule_log_sd_event(task);
350 sd_global->completed_tasks->insert(task);
351 task->start_time = task->surf_action->getStartTime();
352 task->finish_time = surf_get_clock();
353 task->surf_action->unref();
354 task->surf_action = nullptr;
357 xbt_die( "Invalid state");
360 task->state = new_state;
362 if (task->watch_points & new_state) {
363 XBT_VERB("Watch point reached with task '%s'!", SD_task_get_name(task));
364 sd_global->watch_point_reached = true;
365 SD_task_unwatch(task, new_state); /* remove the watch point */
370 * \brief Returns the name of a task
373 * \return the name of this task (can be \c nullptr)
375 const char *SD_task_get_name(SD_task_t task)
380 /** @brief Allows to change the name of a task */
381 void SD_task_set_name(SD_task_t task, const char *name)
383 xbt_free(task->name);
384 task->name = xbt_strdup(name);
387 /** @brief Returns the dynar of the parents of a task
390 * \return a newly allocated dynar comprising the parents of this task
393 xbt_dynar_t SD_task_get_parents(SD_task_t task)
395 xbt_dynar_t parents = xbt_dynar_new(sizeof(SD_task_t), nullptr);
397 for (std::set<SD_task_t>::iterator it=task->predecessors->begin(); it!=task->predecessors->end(); ++it)
398 xbt_dynar_push(parents, &(*it));
399 for (std::set<SD_task_t>::iterator it=task->inputs->begin(); it!=task->inputs->end(); ++it)
400 xbt_dynar_push(parents, &(*it));
405 /** @brief Returns the dynar of the parents of a task
408 * \return a newly allocated dynar comprising the parents of this task
410 xbt_dynar_t SD_task_get_children(SD_task_t task)
412 xbt_dynar_t children = xbt_dynar_new(sizeof(SD_task_t), nullptr);
414 for (std::set<SD_task_t>::iterator it=task->successors->begin(); it!=task->successors->end(); ++it)
415 xbt_dynar_push(children, &(*it));
416 for (std::set<SD_task_t>::iterator it=task->outputs->begin(); it!=task->outputs->end(); ++it)
417 xbt_dynar_push(children, &(*it));
423 * \brief Returns the number of workstations involved in a task
425 * Only call this on already scheduled tasks!
428 int SD_task_get_workstation_count(SD_task_t task)
430 return task->host_count;
434 * \brief Returns the list of workstations involved in a task
436 * Only call this on already scheduled tasks!
439 sg_host_t *SD_task_get_workstation_list(SD_task_t task)
441 return task->host_list;
445 * \brief Returns the total amount of work contained in a task
448 * \return the total amount of work (computation or data transfer) for this task
449 * \see SD_task_get_remaining_amount()
451 double SD_task_get_amount(SD_task_t task)
456 /** @brief Sets the total amount of work of a task
457 * For sequential typed tasks (COMP_SEQ and COMM_E2E), it also sets the appropriate values in the flops_amount and
458 * bytes_amount arrays respectively. Nothing more than modifying task->amount is done for parallel typed tasks
459 * (COMP_PAR_AMDAHL and COMM_PAR_MXN_1D_BLOCK) as the distribution of the amount of work is done at scheduling time.
462 * \param amount the new amount of work to execute
464 void SD_task_set_amount(SD_task_t task, double amount)
466 task->amount = amount;
467 if (task->kind == SD_TASK_COMP_SEQ)
468 task->flops_amount[0] = amount;
469 if (task->kind == SD_TASK_COMM_E2E)
470 task->bytes_amount[2] = amount;
474 * \brief Returns the alpha parameter of a SD_TASK_COMP_PAR_AMDAHL task
476 * \param task a parallel task assuming Amdahl's law as speedup model
477 * \return the alpha parameter (serial part of a task in percent) for this task
479 double SD_task_get_alpha(SD_task_t task)
481 xbt_assert(SD_task_get_kind(task) == SD_TASK_COMP_PAR_AMDAHL, "Alpha parameter is not defined for this kind of task");
486 * \brief Returns the remaining amount work to do till the completion of a task
489 * \return the remaining amount of work (computation or data transfer) of this task
490 * \see SD_task_get_amount()
492 double SD_task_get_remaining_amount(SD_task_t task)
494 if (task->surf_action)
495 return task->surf_action->getRemains();
497 return task->remains;
500 e_SD_task_kind_t SD_task_get_kind(SD_task_t task)
505 /** @brief Displays debugging information about a task */
506 void SD_task_dump(SD_task_t task)
508 XBT_INFO("Displaying task %s", SD_task_get_name(task));
509 char *statename = bprintf("%s%s%s%s%s%s%s",
510 (task->state == SD_NOT_SCHEDULED ? " not scheduled" : ""),
511 (task->state == SD_SCHEDULABLE ? " schedulable" : ""),
512 (task->state == SD_SCHEDULED ? " scheduled" : ""),
513 (task->state == SD_RUNNABLE ? " runnable" : " not runnable"),
514 (task->state == SD_RUNNING ? " running" : ""),
515 (task->state == SD_DONE ? " done" : ""),
516 (task->state == SD_FAILED ? " failed" : ""));
517 XBT_INFO(" - state:%s", statename);
520 if (task->kind != 0) {
521 switch (task->kind) {
522 case SD_TASK_COMM_E2E:
523 XBT_INFO(" - kind: end-to-end communication");
525 case SD_TASK_COMP_SEQ:
526 XBT_INFO(" - kind: sequential computation");
528 case SD_TASK_COMP_PAR_AMDAHL:
529 XBT_INFO(" - kind: parallel computation following Amdahl's law");
531 case SD_TASK_COMM_PAR_MXN_1D_BLOCK:
532 XBT_INFO(" - kind: MxN data redistribution assuming 1D block distribution");
535 XBT_INFO(" - (unknown kind %d)", task->kind);
539 XBT_INFO(" - amount: %.0f", SD_task_get_amount(task));
540 if (task->kind == SD_TASK_COMP_PAR_AMDAHL)
541 XBT_INFO(" - alpha: %.2f", task->alpha);
542 XBT_INFO(" - Dependencies to satisfy: %zu", task->inputs->size()+ task->predecessors->size());
543 if ((task->inputs->size()+ task->predecessors->size()) > 0) {
544 XBT_INFO(" - pre-dependencies:");
545 for (std::set<SD_task_t>::iterator it=task->predecessors->begin(); it!=task->predecessors->end(); ++it)
546 XBT_INFO(" %s", SD_task_get_name(*it));
548 for (std::set<SD_task_t>::iterator it=task->inputs->begin(); it!=task->inputs->end(); ++it)
549 XBT_INFO(" %s", SD_task_get_name(*it));
551 if ((task->outputs->size() + task->successors->size()) > 0) {
552 XBT_INFO(" - post-dependencies:");
554 for (std::set<SD_task_t>::iterator it=task->successors->begin(); it!=task->successors->end(); ++it)
555 XBT_INFO(" %s", SD_task_get_name(*it));
556 for (std::set<SD_task_t>::iterator it=task->outputs->begin(); it!=task->outputs->end(); ++it)
557 XBT_INFO(" %s", SD_task_get_name(*it));
561 /** @brief Dumps the task in dotty formalism into the FILE* passed as second argument */
562 void SD_task_dotty(SD_task_t task, void *out)
564 FILE *fout = static_cast<FILE*>(out);
565 fprintf(fout, " T%p [label=\"%.20s\"", task, task->name);
566 switch (task->kind) {
567 case SD_TASK_COMM_E2E:
568 case SD_TASK_COMM_PAR_MXN_1D_BLOCK:
569 fprintf(fout, ", shape=box");
571 case SD_TASK_COMP_SEQ:
572 case SD_TASK_COMP_PAR_AMDAHL:
573 fprintf(fout, ", shape=circle");
576 xbt_die("Unknown task type!");
578 fprintf(fout, "];\n");
579 for (std::set<SD_task_t>::iterator it=task->predecessors->begin(); it!=task->predecessors->end(); ++it)
580 fprintf(fout, " T%p -> T%p;\n", (*it), task);
581 for (std::set<SD_task_t>::iterator it=task->inputs->begin(); it!=task->inputs->end(); ++it)
582 fprintf(fout, " T%p -> T%p;\n", (*it), task);
586 * \brief Adds a dependency between two tasks
588 * \a dst will depend on \a src, ie \a dst will not start before \a src is finished.
589 * Their \ref e_SD_task_state_t "state" must be #SD_NOT_SCHEDULED, #SD_SCHEDULED or #SD_RUNNABLE.
591 * \param name the name of the new dependency (can be \c nullptr)
592 * \param data the user data you want to associate with this dependency (can be \c nullptr)
593 * \param src the task which must be executed first
594 * \param dst the task you want to make depend on \a src
595 * \see SD_task_dependency_remove()
597 void SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst)
601 THROWF(arg_error, 0, "Cannot add a dependency between task '%s' and itself", SD_task_get_name(src));
603 e_SD_task_state_t state = SD_task_get_state(src);
604 if (state == SD_DONE || state == SD_FAILED)
605 THROWF(arg_error, 0, "Task '%s' must be SD_NOT_SCHEDULED, SD_SCHEDULABLE, SD_SCHEDULED, SD_RUNNABLE, or SD_RUNNING",
606 SD_task_get_name(src));
608 state = SD_task_get_state(dst);
609 if (state == SD_DONE || state == SD_FAILED || state == SD_RUNNING)
610 THROWF(arg_error, 0, "Task '%s' must be SD_NOT_SCHEDULED, SD_SCHEDULABLE, SD_SCHEDULED, or SD_RUNNABLE",
611 SD_task_get_name(dst));
613 if (src->successors->find(dst) != src->successors->end() ||
614 dst->predecessors->find(src) != dst->predecessors->end() ||
615 dst->inputs->find(src) != dst->inputs->end() ||
616 src->outputs->find(dst) != src->outputs->end())
617 THROWF(arg_error, 0, "A dependency already exists between task '%s' and task '%s'",
618 SD_task_get_name(src), SD_task_get_name(dst));
620 XBT_DEBUG("SD_task_dependency_add: src = %s, dst = %s", SD_task_get_name(src), SD_task_get_name(dst));
622 e_SD_task_kind_t src_kind = SD_task_get_kind(src);
623 e_SD_task_kind_t dst_kind = SD_task_get_kind(dst);
625 if (src_kind == SD_TASK_COMM_E2E || src_kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK){
626 if (dst_kind == SD_TASK_COMP_SEQ || dst_kind == SD_TASK_COMP_PAR_AMDAHL){
627 dst->inputs->insert(src);
629 dst->predecessors->insert(src);
631 src->successors->insert(dst);
633 if (dst_kind == SD_TASK_COMM_E2E|| dst_kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK){
634 src->outputs->insert(dst);
636 src->successors->insert(dst);
638 dst->predecessors->insert(src);
641 /* if the task was runnable, the task goes back to SD_SCHEDULED because of the new dependency*/
642 if (SD_task_get_state(dst) == SD_RUNNABLE) {
643 XBT_DEBUG("SD_task_dependency_add: %s was runnable and becomes scheduled!", SD_task_get_name(dst));
644 SD_task_set_state(dst, SD_SCHEDULED);
649 * \brief Indicates whether there is a dependency between two tasks.
652 * \param dst a task depending on \a src
654 * If src is nullptr, checks whether dst has any pre-dependency.
655 * If dst is nullptr, checks whether src has any post-dependency.
657 int SD_task_dependency_exists(SD_task_t src, SD_task_t dst)
659 xbt_assert(src != nullptr || dst != nullptr, "Invalid parameter: both src and dst are nullptr");
663 return (src->successors->find(dst) != src->successors->end() || src->outputs->find(dst) != src->outputs->end());
665 return src->successors->size() + src->outputs->size();
668 return dst->predecessors->size() + dst->inputs->size();
674 * \brief Remove a dependency between two tasks
677 * \param dst a task depending on \a src
678 * \see SD_task_dependency_add()
680 void SD_task_dependency_remove(SD_task_t src, SD_task_t dst)
682 XBT_DEBUG("SD_task_dependency_remove: src = %s, dst = %s", SD_task_get_name(src), SD_task_get_name(dst));
684 if (src->successors->find(dst) == src->successors->end() &&
685 src->outputs->find(dst) == src->outputs->end())
686 THROWF(arg_error, 0, "No dependency found between task '%s' and '%s': task '%s' is not a successor of task '%s'",
687 SD_task_get_name(src), SD_task_get_name(dst), SD_task_get_name(dst), SD_task_get_name(src));
689 e_SD_task_kind_t src_kind = SD_task_get_kind(src);
690 e_SD_task_kind_t dst_kind = SD_task_get_kind(dst);
691 if (src_kind == SD_TASK_COMM_E2E || src_kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK){
692 if (dst_kind == SD_TASK_COMP_SEQ || dst_kind == SD_TASK_COMP_PAR_AMDAHL){
693 dst->inputs->erase(src);
695 dst->predecessors->erase(src);
697 src->successors->erase(dst);
699 if (dst_kind == SD_TASK_COMM_E2E|| dst_kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK){
700 src->outputs->erase(dst);
702 src->successors->erase(dst);
704 dst->predecessors->erase(src);
707 /* if the task was scheduled and dependencies are satisfied, we can make it runnable */
708 if (dst->predecessors->empty() && dst->inputs->empty() && SD_task_get_state(dst) == SD_SCHEDULED)
709 SD_task_set_state(dst, SD_RUNNABLE);
713 * \brief Adds a watch point to a task
715 * SD_simulate() will stop as soon as the \ref e_SD_task_state_t "state" of this task becomes the one given in argument.
716 * The watch point is then automatically removed.
719 * \param state the \ref e_SD_task_state_t "state" you want to watch (cannot be #SD_NOT_SCHEDULED)
720 * \see SD_task_unwatch()
722 void SD_task_watch(SD_task_t task, e_SD_task_state_t state)
724 if (state & SD_NOT_SCHEDULED)
725 THROWF(arg_error, 0, "Cannot add a watch point for state SD_NOT_SCHEDULED");
727 task->watch_points = task->watch_points | state;
731 * \brief Removes a watch point from a task
734 * \param state the \ref e_SD_task_state_t "state" you no longer want to watch
735 * \see SD_task_watch()
737 void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state)
739 xbt_assert(state != SD_NOT_SCHEDULED, "SimDag error: Cannot have a watch point for state SD_NOT_SCHEDULED");
740 task->watch_points = task->watch_points & ~state;
744 * \brief Returns an approximative estimation of the execution time of a task.
746 * The estimation is very approximative because the value returned is the time the task would take if it was executed
747 * now and if it was the only task.
749 * \param task the task to evaluate
750 * \param workstation_nb number of workstations on which the task would be executed
751 * \param workstation_list the workstations on which the task would be executed
752 * \param flops_amount computation amount for each workstation (i.e., an array of workstation_nb doubles)
753 * \param bytes_amount communication amount between each pair of workstations (i.e., a matrix of
754 * workstation_nb*workstation_nb doubles)
757 double SD_task_get_execution_time(SD_task_t task, int workstation_nb, const sg_host_t *workstation_list,
758 const double *flops_amount, const double *bytes_amount)
760 xbt_assert(workstation_nb > 0, "Invalid parameter");
761 double max_time = 0.0;
763 /* the task execution time is the maximum execution time of the parallel tasks */
764 for (int i = 0; i < workstation_nb; i++) {
766 if (flops_amount != nullptr)
767 time = flops_amount[i] / workstation_list[i]->speed();
769 if (bytes_amount != nullptr)
770 for (int j = 0; j < workstation_nb; j++) {
771 if (bytes_amount[i * workstation_nb + j] !=0 ) {
772 time += (SD_route_get_latency(workstation_list[i], workstation_list[j]) +
773 bytes_amount[i * workstation_nb + j] /
774 SD_route_get_bandwidth(workstation_list[i], workstation_list[j]));
778 if (time > max_time) {
785 static inline void SD_task_do_schedule(SD_task_t task)
787 if (SD_task_get_state(task) > SD_SCHEDULABLE)
788 THROWF(arg_error, 0, "Task '%s' has already been scheduled", SD_task_get_name(task));
790 if (task->predecessors->empty() && task->inputs->empty())
791 SD_task_set_state(task, SD_RUNNABLE);
793 SD_task_set_state(task, SD_SCHEDULED);
797 * \brief Schedules a task
799 * The task state must be #SD_NOT_SCHEDULED.
800 * Once scheduled, a task is executed as soon as possible in \see SD_simulate, i.e. when its dependencies are satisfied.
802 * \param task the task you want to schedule
803 * \param host_count number of hosts on which the task will be executed
804 * \param workstation_list the hosts on which the task will be executed
805 * \param flops_amount computation amount for each hosts (i.e., an array of host_count doubles)
806 * \param bytes_amount communication amount between each pair of hosts (i.e., a matrix of host_count*host_count doubles)
807 * \param rate task execution speed rate
808 * \see SD_task_unschedule()
810 void SD_task_schedule(SD_task_t task, int host_count, const sg_host_t * workstation_list,
811 const double *flops_amount, const double *bytes_amount, double rate)
813 xbt_assert(host_count > 0, "workstation_nb must be positive");
815 task->host_count = host_count;
819 task->flops_amount = static_cast<double*>(xbt_realloc(task->flops_amount, sizeof(double) * host_count));
820 memcpy(task->flops_amount, flops_amount, sizeof(double) * host_count);
822 xbt_free(task->flops_amount);
823 task->flops_amount = nullptr;
826 int communication_nb = host_count * host_count;
828 task->bytes_amount = static_cast<double*>(xbt_realloc(task->bytes_amount, sizeof(double) * communication_nb));
829 memcpy(task->bytes_amount, bytes_amount, sizeof(double) * communication_nb);
831 xbt_free(task->bytes_amount);
832 task->bytes_amount = nullptr;
835 task->host_list = static_cast<sg_host_t*>(xbt_realloc(task->host_list, sizeof(sg_host_t) * host_count));
836 memcpy(task->host_list, workstation_list, sizeof(sg_host_t) * host_count);
838 SD_task_do_schedule(task);
842 * \brief Unschedules a task
844 * The task state must be #SD_SCHEDULED, #SD_RUNNABLE, #SD_RUNNING or #SD_FAILED.
845 * If you call this function, the task state becomes #SD_NOT_SCHEDULED.
846 * Call SD_task_schedule() to schedule it again.
848 * \param task the task you want to unschedule
849 * \see SD_task_schedule()
851 void SD_task_unschedule(SD_task_t task)
853 if (task->state != SD_SCHEDULED && task->state != SD_RUNNABLE && task->state != SD_RUNNING &&
854 task->state != SD_FAILED)
855 THROWF(arg_error, 0, "Task %s: the state must be SD_SCHEDULED, SD_RUNNABLE, SD_RUNNING or SD_FAILED",
856 SD_task_get_name(task));
858 if ((task->state == SD_SCHEDULED || task->state == SD_RUNNABLE)
859 /* if the task is scheduled or runnable */
860 && ((task->kind == SD_TASK_COMP_PAR_AMDAHL) || (task->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK))) {
861 /* Don't free scheduling data for typed tasks */
862 __SD_task_destroy_scheduling_data(task);
863 xbt_free(task->host_list);
864 task->host_list=nullptr;
865 task->host_count = 0;
868 if (SD_task_get_state(task) == SD_RUNNING)
869 /* the task should become SD_FAILED */
870 task->surf_action->cancel();
872 if (task->predecessors->empty() && task->inputs->empty())
873 SD_task_set_state(task, SD_SCHEDULABLE);
875 SD_task_set_state(task, SD_NOT_SCHEDULED);
877 task->remains = task->amount;
878 task->start_time = -1.0;
882 void SD_task_run(SD_task_t task)
884 xbt_assert(SD_task_get_state(task) == SD_RUNNABLE, "Task '%s' is not runnable! Task state: %d",
885 SD_task_get_name(task), (int)SD_task_get_state(task));
886 xbt_assert(task->host_list != nullptr, "Task '%s': workstation_list is nullptr!", SD_task_get_name(task));
888 XBT_DEBUG("Running task '%s'", SD_task_get_name(task));
890 /* Copy the elements of the task into the action */
891 int host_nb = task->host_count;
892 sg_host_t *hosts = xbt_new(sg_host_t, host_nb);
894 for (int i = 0; i < host_nb; i++)
895 hosts[i] = task->host_list[i];
897 double *flops_amount = xbt_new0(double, host_nb);
898 double *bytes_amount = xbt_new0(double, host_nb * host_nb);
900 if(task->flops_amount)
901 memcpy(flops_amount, task->flops_amount, sizeof(double) * host_nb);
902 if(task->bytes_amount)
903 memcpy(bytes_amount, task->bytes_amount, sizeof(double) * host_nb * host_nb);
905 task->surf_action = surf_host_model->executeParallelTask(host_nb, hosts, flops_amount, bytes_amount, task->rate);
907 task->surf_action->setData(task);
909 XBT_DEBUG("surf_action = %p", task->surf_action);
911 __SD_task_destroy_scheduling_data(task); /* now the scheduling data are not useful anymore */
912 SD_task_set_state(task, SD_RUNNING);
913 xbt_dynar_push(sd_global->return_set, &task);
917 * \brief Returns the start time of a task
919 * The task state must be SD_RUNNING, SD_DONE or SD_FAILED.
921 * \param task: a task
922 * \return the start time of this task
924 double SD_task_get_start_time(SD_task_t task)
926 if (task->surf_action)
927 return task->surf_action->getStartTime();
929 return task->start_time;
933 * \brief Returns the finish time of a task
935 * The task state must be SD_RUNNING, SD_DONE or SD_FAILED.
936 * If the state is not completed yet, the returned value is an estimation of the task finish time. This value can
937 * vary until the task is completed.
939 * \param task: a task
940 * \return the start time of this task
942 double SD_task_get_finish_time(SD_task_t task)
944 if (task->surf_action) /* should never happen as actions are destroyed right after their completion */
945 return task->surf_action->getFinishTime();
947 return task->finish_time;
950 void SD_task_distribute_comp_amdahl(SD_task_t task, int ws_count)
952 xbt_assert(task->kind == SD_TASK_COMP_PAR_AMDAHL, "Task %s is not a SD_TASK_COMP_PAR_AMDAHL typed task."
953 "Cannot use this function.", SD_task_get_name(task));
954 task->flops_amount = xbt_new0(double, ws_count);
955 task->bytes_amount = xbt_new0(double, ws_count * ws_count);
956 xbt_free(task->host_list);
957 task->host_count = ws_count;
958 task->host_list = xbt_new0(sg_host_t, ws_count);
960 for(int i=0;i<ws_count;i++){
961 task->flops_amount[i] = (task->alpha + (1 - task->alpha)/ws_count) * task->amount;
966 /** @brief Auto-schedules a task.
968 * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows to specify the task costs at
969 * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
972 * To be auto-schedulable, a task must be type and created with one of the specialized creation functions.
975 * We should create tasks kind for the following categories:
976 * - Point to point communication (done)
977 * - Sequential computation (done)
978 * - group communication (redistribution, several kinds)
979 * - parallel tasks with no internal communication (one kind per speedup model such as Amdahl)
980 * - idem+ internal communication. Task type not enough since we cannot store comm cost alongside to comp one)
982 void SD_task_schedulev(SD_task_t task, int count, const sg_host_t * list)
986 xbt_assert(task->kind != 0, "Task %s is not typed. Cannot automatically schedule it.", SD_task_get_name(task));
987 switch (task->kind) {
988 case SD_TASK_COMP_PAR_AMDAHL:
989 SD_task_distribute_comp_amdahl(task, count);
991 case SD_TASK_COMM_E2E:
992 case SD_TASK_COMP_SEQ:
993 xbt_assert(task->host_count == count, "Got %d locations, but were expecting %d locations", count,task->host_count);
994 for (i = 0; i < count; i++)
995 task->host_list[i] = list[i];
996 if (SD_task_get_kind(task)== SD_TASK_COMP_SEQ && !task->flops_amount){
997 /*This task has failed and is rescheduled. Reset the flops_amount*/
998 task->flops_amount = xbt_new0(double, 1);
999 task->flops_amount[0] = task->remains;
1001 SD_task_do_schedule(task);
1004 xbt_die("Kind of task %s not supported by SD_task_schedulev()", SD_task_get_name(task));
1007 if (task->kind == SD_TASK_COMM_E2E) {
1008 XBT_VERB("Schedule comm task %s between %s -> %s. It costs %.f bytes", SD_task_get_name(task),
1009 sg_host_get_name(task->host_list[0]), sg_host_get_name(task->host_list[1]), task->bytes_amount[2]);
1012 /* Iterate over all inputs and outputs to say where I am located (and start them if runnable) */
1013 if (task->kind == SD_TASK_COMP_SEQ) {
1014 XBT_VERB("Schedule computation task %s on %s. It costs %.f flops", SD_task_get_name(task),
1015 sg_host_get_name(task->host_list[0]), task->flops_amount[0]);
1017 for (std::set<SD_task_t>::iterator it=task->inputs->begin(); it!=task->inputs->end(); ++it){
1018 SD_task_t input = *it;
1019 input->host_list[1] = task->host_list[0];
1020 if (input->host_list[0] && (SD_task_get_state(input) < SD_SCHEDULED)) {
1021 SD_task_do_schedule(input);
1022 XBT_VERB ("Auto-Schedule comm task %s between %s -> %s. It costs %.f bytes", SD_task_get_name(input),
1023 sg_host_get_name(input->host_list[0]), sg_host_get_name(input->host_list[1]), input->bytes_amount[2]);
1027 for (std::set<SD_task_t>::iterator it=task->outputs->begin(); it!=task->outputs->end(); ++it){
1028 SD_task_t output = *it;
1029 output->host_list[0] = task->host_list[0];
1030 if (output->host_list[1] && (SD_task_get_state(output) < SD_SCHEDULED)) {
1031 SD_task_do_schedule(output);
1032 XBT_VERB ("Auto-Schedule comm task %s between %s -> %s. It costs %.f bytes", SD_task_get_name(output),
1033 sg_host_get_name(output->host_list[0]), sg_host_get_name(output->host_list[1]),
1034 output->bytes_amount[2]);
1039 /* Iterate over all children and parents being MXN_1D_BLOCK to say where I am located (and start them if runnable) */
1040 if (task->kind == SD_TASK_COMP_PAR_AMDAHL) {
1041 XBT_VERB("Schedule computation task %s on %d workstations. %.f flops will be distributed following Amdahl's Law",
1042 SD_task_get_name(task), task->host_count, task->flops_amount[0]);
1043 for (std::set<SD_task_t>::iterator it=task->inputs->begin(); it!=task->inputs->end(); ++it){
1044 SD_task_t input = *it;
1045 if (!input->host_list){
1046 XBT_VERB("Sender side of Task %s is not scheduled yet", SD_task_get_name(input));
1047 input->host_list = xbt_new0(sg_host_t, count);
1048 input->host_count = count;
1049 XBT_VERB("Fill the workstation list with list of Task '%s'", SD_task_get_name(task));
1050 for (i=0;i<count;i++)
1051 input->host_list[i] = task->host_list[i];
1053 XBT_VERB("Build communication matrix for task '%s'", SD_task_get_name(input));
1055 double src_start, src_end, dst_start, dst_end;
1056 src_nb = input->host_count;
1058 input->host_list = static_cast<sg_host_t*>(xbt_realloc(input->host_list, (input->host_count+count)*sizeof(sg_host_t)));
1059 for(i=0; i<count; i++)
1060 input->host_list[input->host_count+i] = task->host_list[i];
1062 input->host_count += count;
1063 xbt_free(input->flops_amount);
1064 xbt_free(input->bytes_amount);
1065 input->flops_amount = xbt_new0(double, input->host_count);
1066 input->bytes_amount = xbt_new0(double, input->host_count* input->host_count);
1068 for(i=0;i<src_nb;i++){
1069 src_start = i*input->amount/src_nb;
1070 src_end = src_start + input->amount/src_nb;
1071 for(j=0; j<dst_nb; j++){
1072 dst_start = j*input->amount/dst_nb;
1073 dst_end = dst_start + input->amount/dst_nb;
1074 XBT_VERB("(%s->%s): (%.2f, %.2f)-> (%.2f, %.2f)", sg_host_get_name(input->host_list[i]),
1075 sg_host_get_name(input->host_list[src_nb+j]), src_start, src_end, dst_start, dst_end);
1076 if ((src_end <= dst_start) || (dst_end <= src_start)) {
1077 input->bytes_amount[i*(src_nb+dst_nb)+src_nb+j]=0.0;
1079 input->bytes_amount[i*(src_nb+dst_nb)+src_nb+j] = MIN(src_end, dst_end) - MAX(src_start, dst_start);
1081 XBT_VERB("==> %.2f", input->bytes_amount[i*(src_nb+dst_nb)+src_nb+j]);
1085 if (SD_task_get_state(input)< SD_SCHEDULED) {
1086 SD_task_do_schedule(input);
1087 XBT_VERB ("Auto-Schedule redistribution task %s. Send %.f bytes from %d hosts to %d hosts.",
1088 SD_task_get_name(input),input->amount, src_nb, dst_nb);
1093 for (std::set<SD_task_t>::iterator it=task->outputs->begin(); it!=task->outputs->end(); ++it){
1094 SD_task_t output = *it;
1095 if (!output->host_list){
1096 XBT_VERB("Receiver side of Task '%s' is not scheduled yet", SD_task_get_name(output));
1097 output->host_list = xbt_new0(sg_host_t, count);
1098 output->host_count = count;
1099 XBT_VERB("Fill the workstation list with list of Task '%s'", SD_task_get_name(task));
1100 for (i=0;i<count;i++)
1101 output->host_list[i] = task->host_list[i];
1104 double src_start, src_end, dst_start, dst_end;
1106 dst_nb = output->host_count;
1107 output->host_list = static_cast<sg_host_t*>(xbt_realloc(output->host_list, (output->host_count+count)*sizeof(sg_host_t)));
1108 for(i=output->host_count - 1; i>=0; i--)
1109 output->host_list[count+i] = output->host_list[i];
1110 for(i=0; i<count; i++)
1111 output->host_list[i] = task->host_list[i];
1113 output->host_count += count;
1115 xbt_free(output->flops_amount);
1116 xbt_free(output->bytes_amount);
1118 output->flops_amount = xbt_new0(double, output->host_count);
1119 output->bytes_amount = xbt_new0(double, output->host_count* output->host_count);
1121 for(i=0;i<src_nb;i++){
1122 src_start = i*output->amount/src_nb;
1123 src_end = src_start + output->amount/src_nb;
1124 for(j=0; j<dst_nb; j++){
1125 dst_start = j*output->amount/dst_nb;
1126 dst_end = dst_start + output->amount/dst_nb;
1127 XBT_VERB("(%d->%d): (%.2f, %.2f)-> (%.2f, %.2f)", i, j, src_start, src_end, dst_start, dst_end);
1128 if ((src_end <= dst_start) || (dst_end <= src_start)) {
1129 output->bytes_amount[i*(src_nb+dst_nb)+src_nb+j]=0.0;
1131 output->bytes_amount[i*(src_nb+dst_nb)+src_nb+j] = MIN(src_end, dst_end)- MAX(src_start, dst_start);
1133 XBT_VERB("==> %.2f", output->bytes_amount[i*(src_nb+dst_nb)+src_nb+j]);
1137 if (SD_task_get_state(output)< SD_SCHEDULED) {
1138 SD_task_do_schedule(output);
1139 XBT_VERB ("Auto-Schedule redistribution task %s. Send %.f bytes from %d hosts to %d hosts.",
1140 SD_task_get_name(output),output->amount, src_nb, dst_nb);
1147 /** @brief autoschedule a task on a list of workstations
1149 * This function is very similar to SD_task_schedulev(), but takes the list of workstations to schedule onto as
1150 * separate parameters.
1151 * It builds a proper vector of workstations and then call SD_task_schedulev()
1153 void SD_task_schedulel(SD_task_t task, int count, ...)
1156 sg_host_t *list = xbt_new(sg_host_t, count);
1157 va_start(ap, count);
1158 for (int i = 0; i < count; i++) {
1159 list[i] = va_arg(ap, sg_host_t);
1162 SD_task_schedulev(task, count, list);