src/simdag/sd_task.cpp

   1 /* Copyright (c) 2006-2019. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   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. */
   6
   7 #include "simdag_private.hpp"
   8 #include "src/surf/HostImpl.hpp"
   9 #include "src/surf/surf_interface.hpp"
  10 #include <algorithm>
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_task, sd, "Logging specific to SimDag (task)");
  13
  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)
  16 {
  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)));
  20
  21   xbt_free(task->flops_amount);
  22   xbt_free(task->bytes_amount);
  23   task->bytes_amount = nullptr;
  24   task->flops_amount = nullptr;
  25 }
  26
  27 /**
  28  * @brief Creates a new task.
  29  *
  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()
  35  */
  36 SD_task_t SD_task_create(const char *name, void *data, double amount)
  37 {
  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);
  42
  43   task->marked = 0;
  44   task->start_time = -1.0;
  45   task->finish_time = -1.0;
  46   task->surf_action = nullptr;
  47   task->watch_points = 0;
  48
  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>();
  53
  54   task->data = data;
  55   task->name = xbt_strdup(name);
  56   task->amount = amount;
  57   task->allocation = new std::vector<sg_host_t>();
  58   task->rate = -1;
  59   return task;
  60 }
  61
  62 static inline SD_task_t SD_task_create_sized(const char *name, void *data, double amount, int count)
  63 {
  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);
  67   return task;
  68 }
  69
  70 /** @brief create a end-to-end communication task that can then be auto-scheduled
  71  *
  72  * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows to specify the task costs at
  73  * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
  74  * mandatory power.
  75  *
  76  * A end-to-end communication must be scheduled on 2 hosts, and the amount specified at creation is sent from hosts[0]
  77  * to hosts[1].
  78  */
  79 SD_task_t SD_task_create_comm_e2e(const char *name, void *data, double amount)
  80 {
  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;
  84
  85   return res;
  86 }
  87
  88 /** @brief create a sequential computation task that can then be auto-scheduled
  89  *
  90  * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows to specify the task costs at
  91  * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
  92  * mandatory power.
  93  *
  94  * A sequential computation must be scheduled on 1 host, and the amount specified at creation to be run on hosts[0].
  95  *
  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
 100  */
 101 SD_task_t SD_task_create_comp_seq(const char *name, void *data, double flops_amount)
 102 {
 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;
 106
 107   return res;
 108 }
 109
 110 /** @brief create a parallel computation task that can then be auto-scheduled
 111  *
 112  * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows to specify the task costs at
 113  * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
 114  * mandatory power.
 115  *
 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
 124  */
 125 SD_task_t SD_task_create_comp_par_amdahl(const char *name, void *data, double flops_amount, double alpha)
 126 {
 127   xbt_assert(alpha < 1. && alpha >= 0., "Invalid parameter: alpha must be in [0.;1.[");
 128
 129   SD_task_t res = SD_task_create(name, data, flops_amount);
 130   res->alpha = alpha;
 131   res->kind = SD_TASK_COMP_PAR_AMDAHL;
 132
 133   return res;
 134 }
 135
 136 /** @brief create a complex data redistribution task that can then be  auto-scheduled
 137  *
 138  * Auto-scheduling mean that the task can be used with SD_task_schedulev().
 139  * This allows to specify the task costs at creation, and decouple them from the scheduling process where you just
 140  * specify which resource should communicate.
 141  *
 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
 149  */
 150 SD_task_t SD_task_create_comm_par_mxn_1d_block(const char *name, void *data, double amount)
 151 {
 152   SD_task_t res = SD_task_create(name, data, amount);
 153   res->kind = SD_TASK_COMM_PAR_MXN_1D_BLOCK;
 154
 155   return res;
 156 }
 157
 158 /**
 159  * @brief Destroys a task.
 160  *
 161  * The user data (if any) should have been destroyed first.
 162  *
 163  * @param task the task you want to destroy
 164  * @see SD_task_create()
 165  */
 166 void SD_task_destroy(SD_task_t task)
 167 {
 168   XBT_DEBUG("Destroying task %s...", SD_task_get_name(task));
 169
 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()));
 179
 180   if (task->state == SD_SCHEDULED || task->state == SD_RUNNABLE)
 181     __SD_task_destroy_scheduling_data(task);
 182
 183   xbt_free(task->name);
 184
 185   if (task->surf_action != nullptr)
 186     task->surf_action->unref();
 187
 188   delete task->allocation;
 189   xbt_free(task->bytes_amount);
 190   xbt_free(task->flops_amount);
 191   delete task->inputs;
 192   delete task->outputs;
 193   delete task->predecessors;
 194   delete task->successors;
 195   xbt_free(task);
 196
 197   XBT_DEBUG("Task destroyed.");
 198 }
 199
 200 /**
 201  * @brief Returns the user data of a task
 202  *
 203  * @param task a task
 204  * @return the user data associated with this task (can be @c nullptr)
 205  * @see SD_task_set_data()
 206  */
 207 void *SD_task_get_data(SD_task_t task)
 208 {
 209   return task->data;
 210 }
 211
 212 /**
 213  * @brief Sets the user data of a task
 214  *
 215  * The new data can be @c nullptr. The old data should have been freed first, if it was not @c nullptr.
 216  *
 217  * @param task a task
 218  * @param data the new data you want to associate with this task
 219  * @see SD_task_get_data()
 220  */
 221 void SD_task_set_data(SD_task_t task, void *data)
 222 {
 223   task->data = data;
 224 }
 225
 226 /**
 227  * @brief Sets the rate of a task
 228  *
 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.
 232  *
 233  * To divide the nominal bandwidth by 2, the rate then has to be :
 234  *    rate = bandwidth/(2*amount)
 235  *
 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.
 238  */
 239 void SD_task_set_rate(SD_task_t task, double rate)
 240 {
 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) {
 243     task->rate = rate;
 244   } else {
 245     XBT_WARN("Task %p has started. Changing rate is ineffective.", task);
 246   }
 247 }
 248
 249 /**
 250  * @brief Returns the state of a task
 251  *
 252  * @param task 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
 256  */
 257 e_SD_task_state_t SD_task_get_state(SD_task_t task)
 258 {
 259   return task->state;
 260 }
 261
 262 /* Changes the state of a task. Updates the sd_global->watch_point_reached flag.
 263  */
 264 void SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state)
 265 {
 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);
 271   }
 272
 273   if (new_state == SD_SCHEDULED && task->state == SD_RUNNABLE){
 274     sd_global->initial_tasks.insert(task);
 275     sd_global->runnable_tasks.erase(task);
 276   }
 277
 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);
 283     }
 284   }
 285
 286   if (new_state == SD_RUNNING)
 287     sd_global->runnable_tasks.erase(task);
 288
 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);
 296 #endif
 297     } else
 298       task->finish_time = surf_get_clock();
 299     task->surf_action->unref();
 300     task->surf_action = nullptr;
 301     task->allocation->clear();
 302   }
 303
 304   task->state = new_state;
 305
 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 */
 310   }
 311 }
 312
 313 /**
 314  * @brief Returns the name of a task
 315  *
 316  * @param task a task
 317  * @return the name of this task (can be @c nullptr)
 318  */
 319 const char *SD_task_get_name(SD_task_t task)
 320 {
 321   return task->name;
 322 }
 323
 324 /** @brief Allows to change the name of a task */
 325 void SD_task_set_name(SD_task_t task, const char *name)
 326 {
 327   xbt_free(task->name);
 328   task->name = xbt_strdup(name);
 329 }
 330
 331 /** @brief Returns the dynar of the parents of a task
 332  *
 333  * @param task a task
 334  * @return a newly allocated dynar comprising the parents of this task
 335  */
 336
 337 xbt_dynar_t SD_task_get_parents(SD_task_t task)
 338 {
 339   xbt_dynar_t parents = xbt_dynar_new(sizeof(SD_task_t), nullptr);
 340
 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);
 345
 346   return parents;
 347 }
 348
 349 /** @brief Returns the dynar of the parents of a task
 350  *
 351  * @param task a task
 352  * @return a newly allocated dynar comprising the parents of this task
 353  */
 354 xbt_dynar_t SD_task_get_children(SD_task_t task)
 355 {
 356   xbt_dynar_t children = xbt_dynar_new(sizeof(SD_task_t), nullptr);
 357
 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);
 362
 363   return children;
 364 }
 365
 366 /**
 367  * @brief Returns the number of workstations involved in a task
 368  *
 369  * Only call this on already scheduled tasks!
 370  * @param task a task
 371  */
 372 int SD_task_get_workstation_count(SD_task_t task)
 373 {
 374   return task->allocation->size();
 375 }
 376
 377 /**
 378  * @brief Returns the list of workstations involved in a task
 379  *
 380  * Only call this on already scheduled tasks!
 381  * @param task a task
 382  */
 383 sg_host_t *SD_task_get_workstation_list(SD_task_t task)
 384 {
 385   return task->allocation->data();
 386 }
 387
 388 /**
 389  * @brief Returns the total amount of work contained in a task
 390  *
 391  * @param task a task
 392  * @return the total amount of work (computation or data transfer) for this task
 393  * @see SD_task_get_remaining_amount()
 394  */
 395 double SD_task_get_amount(SD_task_t task)
 396 {
 397   return task->amount;
 398 }
 399
 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.
 404  *
 405  * @param task a task
 406  * @param amount the new amount of work to execute
 407  */
 408 void SD_task_set_amount(SD_task_t task, double amount)
 409 {
 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;
 415 }
 416
 417 /**
 418  * @brief Returns the alpha parameter of a SD_TASK_COMP_PAR_AMDAHL task
 419  *
 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
 422  */
 423 double SD_task_get_alpha(SD_task_t task)
 424 {
 425   xbt_assert(SD_task_get_kind(task) == SD_TASK_COMP_PAR_AMDAHL, "Alpha parameter is not defined for this kind of task");
 426   return task->alpha;
 427 }
 428
 429 /**
 430  * @brief Returns the remaining amount work to do till the completion of a task
 431  *
 432  * @param task a task
 433  * @return the remaining amount of work (computation or data transfer) of this task
 434  * @see SD_task_get_amount()
 435  */
 436 double SD_task_get_remaining_amount(SD_task_t task)
 437 {
 438   if (task->surf_action)
 439     return task->surf_action->get_remains();
 440   else
 441     return (task->state == SD_DONE) ? 0 : task->amount;
 442 }
 443
 444 e_SD_task_kind_t SD_task_get_kind(SD_task_t task)
 445 {
 446   return task->kind;
 447 }
 448
 449 /** @brief Displays debugging information about a task */
 450 void SD_task_dump(SD_task_t task)
 451 {
 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));
 457   else
 458     XBT_INFO("  - state: not runnable %s", __get_state_name(task->state));
 459
 460   if (task->kind != 0) {
 461     switch (task->kind) {
 462     case SD_TASK_COMM_E2E:
 463       XBT_INFO("  - kind: end-to-end communication");
 464       break;
 465     case SD_TASK_COMP_SEQ:
 466       XBT_INFO("  - kind: sequential computation");
 467       break;
 468     case SD_TASK_COMP_PAR_AMDAHL:
 469       XBT_INFO("  - kind: parallel computation following Amdahl's law");
 470       break;
 471     case SD_TASK_COMM_PAR_MXN_1D_BLOCK:
 472       XBT_INFO("  - kind: MxN data redistribution assuming 1D block distribution");
 473       break;
 474     default:
 475       XBT_INFO("  - (unknown kind %d)", task->kind);
 476     }
 477   }
 478
 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);
 487
 488     for (auto const& it : *task->inputs)
 489       XBT_INFO("    %s", it->name);
 490   }
 491   if ((task->outputs->size() + task->successors->size()) > 0) {
 492     XBT_INFO("  - post-dependencies:");
 493
 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);
 498   }
 499 }
 500
 501 /** @brief Dumps the task in dotty formalism into the FILE* passed as second argument */
 502 void SD_task_dotty(SD_task_t task, void *out)
 503 {
 504   FILE *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");
 510     break;
 511   case SD_TASK_COMP_SEQ:
 512   case SD_TASK_COMP_PAR_AMDAHL:
 513     fprintf(fout, ", shape=circle");
 514     break;
 515   default:
 516     xbt_die("Unknown task type!");
 517   }
 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);
 523 }
 524
 525 /**
 526  * @brief Adds a dependency between two tasks
 527  *
 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.
 530  *
 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()
 534  */
 535 void SD_task_dependency_add(SD_task_t src, SD_task_t dst)
 536 {
 537   if (src == 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)));
 540
 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));
 544
 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));
 548
 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));
 553
 554   XBT_DEBUG("SD_task_dependency_add: src = %s, dst = %s", src->name, dst->name);
 555
 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);
 559     else
 560       dst->predecessors->insert(src);
 561     src->successors->insert(dst);
 562   } else {
 563     if (dst->kind == SD_TASK_COMM_E2E|| dst->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK)
 564       src->outputs->insert(dst);
 565     else
 566       src->successors->insert(dst);
 567     dst->predecessors->insert(src);
 568   }
 569
 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);
 574   }
 575 }
 576
 577 /**
 578  * @brief Indicates whether there is a dependency between two tasks.
 579  *
 580  * @param src a task
 581  * @param dst a task depending on @a src
 582  *
 583  * If src is nullptr, checks whether dst has any pre-dependency.
 584  * If dst is nullptr, checks whether src has any post-dependency.
 585  */
 586 int SD_task_dependency_exists(SD_task_t src, SD_task_t dst)
 587 {
 588   xbt_assert(src != nullptr || dst != nullptr, "Invalid parameter: both src and dst are nullptr");
 589
 590   if (src) {
 591     if (dst) {
 592       return (src->successors->find(dst) != src->successors->end() || src->outputs->find(dst) != src->outputs->end());
 593     } else {
 594       return src->successors->size() + src->outputs->size();
 595     }
 596   } else {
 597     return dst->predecessors->size() + dst->inputs->size();
 598   }
 599 }
 600
 601 /**
 602  * @brief Remove a dependency between two tasks
 603  *
 604  * @param src a task
 605  * @param dst a task depending on @a src
 606  * @see SD_task_dependency_add()
 607  */
 608 void SD_task_dependency_remove(SD_task_t src, SD_task_t dst)
 609 {
 610   XBT_DEBUG("SD_task_dependency_remove: src = %s, dst = %s", SD_task_get_name(src), SD_task_get_name(dst));
 611
 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));
 616
 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);
 620     else
 621       dst->predecessors->erase(src);
 622     src->successors->erase(dst);
 623   } else {
 624     if (dst->kind == SD_TASK_COMM_E2E|| dst->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK)
 625       src->outputs->erase(dst);
 626     else
 627       src->successors->erase(dst);
 628     dst->predecessors->erase(src);
 629   }
 630
 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);
 634 }
 635
 636 /**
 637  * @brief Adds a watch point to a task
 638  *
 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.
 641  *
 642  * @param task a task
 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()
 645  */
 646 void SD_task_watch(SD_task_t task, e_SD_task_state_t state)
 647 {
 648   if (state & SD_NOT_SCHEDULED)
 649     throw std::invalid_argument("Cannot add a watch point for state SD_NOT_SCHEDULED");
 650
 651   task->watch_points = task->watch_points | state;
 652 }
 653
 654 /**
 655  * @brief Removes a watch point from a task
 656  *
 657  * @param task a task
 658  * @param state the @ref e_SD_task_state_t "state" you no longer want to watch
 659  * @see SD_task_watch()
 660  */
 661 void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state)
 662 {
 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;
 665 }
 666
 667 /**
 668  * @brief Returns an approximative estimation of the execution time of a task.
 669  *
 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.
 672  *
 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)
 677  * @see SD_schedule()
 678  */
 679 double SD_task_get_execution_time(SD_task_t /*task*/, int host_count, const sg_host_t* host_list,
 680                                   const double* flops_amount, const double* bytes_amount)
 681 {
 682   xbt_assert(host_count > 0, "Invalid parameter");
 683   double max_time = 0.0;
 684
 685   /* the task execution time is the maximum execution time of the parallel tasks */
 686   for (int i = 0; i < host_count; i++) {
 687     double time = 0.0;
 688     if (flops_amount != nullptr)
 689       time = flops_amount[i] / host_list[i]->get_speed();
 690
 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]));
 696
 697     if (time > max_time)
 698       max_time = time;
 699   }
 700   return max_time;
 701 }
 702
 703 static inline void SD_task_do_schedule(SD_task_t task)
 704 {
 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)));
 708
 709   if (task->predecessors->empty() && task->inputs->empty())
 710     SD_task_set_state(task, SD_RUNNABLE);
 711   else
 712     SD_task_set_state(task, SD_SCHEDULED);
 713 }
 714
 715 /**
 716  * @brief Schedules a task
 717  *
 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.
 720  *
 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()
 728  */
 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)
 731 {
 732   xbt_assert(host_count > 0, "host_count must be positive");
 733
 734   task->rate = rate;
 735
 736   if (flops_amount) {
 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);
 739   } else {
 740     xbt_free(task->flops_amount);
 741     task->flops_amount = nullptr;
 742   }
 743
 744   int communication_nb = host_count * host_count;
 745   if (bytes_amount) {
 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);
 748   } else {
 749     xbt_free(task->bytes_amount);
 750     task->bytes_amount = nullptr;
 751   }
 752
 753   for(int i =0; i<host_count; i++)
 754     task->allocation->push_back(host_list[i]);
 755
 756   SD_task_do_schedule(task);
 757 }
 758
 759 /**
 760  * @brief Unschedules a task
 761  *
 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.
 765  *
 766  * @param task the task you want to unschedule
 767  * @see SD_task_schedule()
 768  */
 769 void SD_task_unschedule(SD_task_t task)
 770 {
 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));
 774
 775   if ((task->state == SD_SCHEDULED || task->state == SD_RUNNABLE) /* if the task is scheduled or runnable */
 776       && ((task->kind == SD_TASK_COMP_PAR_AMDAHL) || (task->kind == SD_TASK_COMM_PAR_MXN_1D_BLOCK))) {
 777           /* Don't free scheduling data for typed tasks */
 778     __SD_task_destroy_scheduling_data(task);
 779     task->allocation->clear();
 780   }
 781
 782   if (SD_task_get_state(task) == SD_RUNNING)
 783     /* the task should become SD_FAILED */
 784     task->surf_action->cancel();
 785   else {
 786     if (task->predecessors->empty() && task->inputs->empty())
 787       SD_task_set_state(task, SD_SCHEDULABLE);
 788     else
 789       SD_task_set_state(task, SD_NOT_SCHEDULED);
 790   }
 791   task->start_time = -1.0;
 792 }
 793
 794 /* Runs a task. */
 795 void SD_task_run(SD_task_t task)
 796 {
 797   xbt_assert(task->state == SD_RUNNABLE, "Task '%s' is not runnable! Task state: %d", task->name, (int) task->state);
 798   xbt_assert(task->allocation != nullptr, "Task '%s': host_list is nullptr!", task->name);
 799
 800   XBT_VERB("Executing task '%s'", task->name);
 801
 802   /* Beware! The scheduling data are now used by the surf action directly! no copy was done */
 803   task->surf_action =
 804       surf_host_model->execute_parallel(*task->allocation, task->flops_amount, task->bytes_amount, task->rate);
 805
 806   task->surf_action->set_data(task);
 807
 808   XBT_DEBUG("surf_action = %p", task->surf_action);
 809
 810   SD_task_set_state(task, SD_RUNNING);
 811   sd_global->return_set.insert(task);
 812 }
 813
 814 /**
 815  * @brief Returns the start time of a task
 816  *
 817  * The task state must be SD_RUNNING, SD_DONE or SD_FAILED.
 818  *
 819  * @param task: a task
 820  * @return the start time of this task
 821  */
 822 double SD_task_get_start_time(SD_task_t task)
 823 {
 824   if (task->surf_action)
 825     return task->surf_action->get_start_time();
 826   else
 827     return task->start_time;
 828 }
 829
 830 /**
 831  * @brief Returns the finish time of a task
 832  *
 833  * The task state must be SD_RUNNING, SD_DONE or SD_FAILED.
 834  * If the state is not completed yet, the returned value is an estimation of the task finish time. This value can
 835  * vary until the task is completed.
 836  *
 837  * @param task: a task
 838  * @return the start time of this task
 839  */
 840 double SD_task_get_finish_time(SD_task_t task)
 841 {
 842   if (task->surf_action)        /* should never happen as actions are destroyed right after their completion */
 843     return task->surf_action->get_finish_time();
 844   else
 845     return task->finish_time;
 846 }
 847
 848 void SD_task_distribute_comp_amdahl(SD_task_t task, int count)
 849 {
 850   xbt_assert(task->kind == SD_TASK_COMP_PAR_AMDAHL, "Task %s is not a SD_TASK_COMP_PAR_AMDAHL typed task."
 851               "Cannot use this function.", task->name);
 852   task->flops_amount = xbt_new0(double, count);
 853   task->bytes_amount = xbt_new0(double, count * count);
 854
 855   for (int i=0; i<count; i++){
 856     task->flops_amount[i] = (task->alpha + (1 - task->alpha)/count) * task->amount;
 857   }
 858 }
 859
 860 void SD_task_build_MxN_1D_block_matrix(SD_task_t task, int src_nb, int dst_nb){
 861   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."
 862               "Cannot use this function.", task->name);
 863   xbt_free(task->bytes_amount);
 864   task->bytes_amount = xbt_new0(double,task->allocation->size() * task->allocation->size());
 865
 866   for (int i=0; i<src_nb; i++) {
 867     double src_start = i*task->amount/src_nb;
 868     double src_end = src_start + task->amount/src_nb;
 869     for (int j=0; j<dst_nb; j++) {
 870       double dst_start = j*task->amount/dst_nb;
 871       double dst_end = dst_start + task->amount/dst_nb;
 872       XBT_VERB("(%d->%d): (%.2f, %.2f)-> (%.2f, %.2f)", i, j, src_start, src_end, dst_start, dst_end);
 873       task->bytes_amount[i*(src_nb+dst_nb)+src_nb+j]=0.0;
 874       if ((src_end > dst_start) && (dst_end > src_start)) { /* There is something to send */
 875         task->bytes_amount[i * (src_nb + dst_nb) + src_nb + j] =
 876             std::min(src_end, dst_end) - std::max(src_start, dst_start);
 877         XBT_VERB("==> %.2f", task->bytes_amount[i*(src_nb+dst_nb)+src_nb+j]);
 878       }
 879     }
 880   }
 881 }
 882
 883 /** @brief Auto-schedules a task.
 884  *
 885  * Auto-scheduling mean that the task can be used with SD_task_schedulev(). This allows to specify the task costs at
 886  * creation, and decouple them from the scheduling process where you just specify which resource should deliver the
 887  * mandatory power.
 888  *
 889  * To be auto-schedulable, a task must be a typed computation SD_TASK_COMP_SEQ or SD_TASK_COMP_PAR_AMDAHL.
 890  */
 891 void SD_task_schedulev(SD_task_t task, int count, const sg_host_t * list)
 892 {
 893   xbt_assert(task->kind == SD_TASK_COMP_SEQ || task->kind == SD_TASK_COMP_PAR_AMDAHL,
 894       "Task %s is not typed. Cannot automatically schedule it.", SD_task_get_name(task));
 895
 896   for(int i =0; i<count; i++)
 897     task->allocation->push_back(list[i]);
 898
 899   XBT_VERB("Schedule computation task %s on %zu host(s)", task->name, task->allocation->size());
 900
 901   if (task->kind == SD_TASK_COMP_SEQ) {
 902     if (not task->flops_amount) { /*This task has failed and is rescheduled. Reset the flops_amount*/
 903       task->flops_amount = xbt_new0(double, 1);
 904       task->flops_amount[0] = task->amount;
 905     }
 906     XBT_VERB("It costs %.f flops", task->flops_amount[0]);
 907   }
 908
 909   if (task->kind == SD_TASK_COMP_PAR_AMDAHL) {
 910     SD_task_distribute_comp_amdahl(task, count);
 911     XBT_VERB("%.f flops will be distributed following Amdahl's Law", task->flops_amount[0]);
 912   }
 913
 914   SD_task_do_schedule(task);
 915
 916   /* Iterate over all inputs and outputs to say where I am located (and start them if runnable) */
 917   for (auto const& input : *task->inputs) {
 918     int src_nb = input->allocation->size();
 919     int dst_nb = count;
 920     if (input->allocation->empty())
 921       XBT_VERB("Sender side of '%s' not scheduled. Set receiver side to '%s''s allocation", input->name, task->name);
 922
 923     for (int i=0; i<count;i++)
 924       input->allocation->push_back(task->allocation->at(i));
 925
 926     if (input->allocation->size () > task->allocation->size()) {
 927       if (task->kind == SD_TASK_COMP_PAR_AMDAHL)
 928         SD_task_build_MxN_1D_block_matrix(input, src_nb, dst_nb);
 929
 930       SD_task_do_schedule(input);
 931       XBT_VERB ("Auto-Schedule Communication task '%s'. Send %.f bytes from %d hosts to %d hosts.",
 932           input->name,input->amount, src_nb, dst_nb);
 933     }
 934   }
 935
 936   for (auto const& output : *task->outputs) {
 937     int src_nb = count;
 938     int dst_nb = output->allocation->size();
 939     if (output->allocation->empty())
 940       XBT_VERB("Receiver side of '%s' not scheduled. Set sender side to '%s''s allocation", output->name, task->name);
 941
 942     for (int i=0; i<count;i++)
 943       output->allocation->insert(output->allocation->begin()+i, task->allocation->at(i));
 944
 945     if (output->allocation->size () > task->allocation->size()) {
 946       if (task->kind == SD_TASK_COMP_PAR_AMDAHL)
 947         SD_task_build_MxN_1D_block_matrix(output, src_nb, dst_nb);
 948
 949       SD_task_do_schedule(output);
 950       XBT_VERB ("Auto-Schedule Communication task %s. Send %.f bytes from %d hosts to %d hosts.",
 951                 output->name, output->amount, src_nb, dst_nb);
 952     }
 953   }
 954 }
 955
 956 /** @brief autoschedule a task on a list of hosts
 957  *
 958  * This function is similar to SD_task_schedulev(), but takes the list of hosts to schedule onto as separate parameters.
 959  * It builds a proper vector of hosts and then call SD_task_schedulev()
 960  */
 961 void SD_task_schedulel(SD_task_t task, int count, ...)
 962 {
 963   va_list ap;
 964   sg_host_t* list = new sg_host_t[count];
 965   va_start(ap, count);
 966   for (int i=0; i<count; i++)
 967     list[i] = va_arg(ap, sg_host_t);
 968
 969   va_end(ap);
 970   SD_task_schedulev(task, count, list);
 971   delete[] list;
 972 }