src/simdag/sd_task.c

   1 #include "private.h"
   2 #include "simdag/simdag.h"
   3 #include "xbt/sysdep.h"
   4 #include "xbt/dynar.h"
   5
   6 static void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state);
   7
   8 /* Creates a task.
   9  */
  10 SD_task_t SD_task_create(const char *name, void *data, double amount) {
  11   SD_CHECK_INIT_DONE();
  12   xbt_assert0(amount > 0, "amount must be positive");
  13
  14   SD_task_t task = xbt_new0(s_SD_task_t, 1);
  15
  16   /* general information */
  17   task->data = data; /* user data */
  18   if (name != NULL)
  19     task->name = xbt_strdup(name);
  20   else
  21     task->name = NULL;
  22
  23   task->state_set = sd_global->not_scheduled_task_set;
  24   xbt_swag_insert(task,task->state_set);
  25
  26   task->amount = amount;
  27   task->surf_action = NULL;
  28   task->watch_points = 0;
  29
  30   /* dependencies */
  31   task->tasks_before = xbt_dynar_new(sizeof(SD_dependency_t), NULL);
  32   task->tasks_after = xbt_dynar_new(sizeof(SD_dependency_t), NULL);
  33
  34   /* scheduling parameters */
  35   task->workstation_nb = 0;
  36   task->workstation_list = NULL;
  37   task->computation_amount = NULL;
  38   task->communication_amount = NULL;
  39   task->rate = 0;
  40
  41   xbt_dynar_push(sd_global->tasks, &task);
  42
  43   return task;
  44 }
  45
  46 /* Returns the data of a task.
  47  */
  48 void* SD_task_get_data(SD_task_t task) {
  49   SD_CHECK_INIT_DONE();
  50   xbt_assert0(task != NULL, "Invalid parameter");
  51   return task->data;
  52 }
  53
  54 /* Returns the state of a task: SD_NOT_SCHEDULED, SD_SCHEDULED, SD_RUNNING, SD_DONE or SD_FAILED.
  55  */
  56 e_SD_task_state_t SD_task_get_state(SD_task_t task) {
  57   SD_CHECK_INIT_DONE();
  58   xbt_assert0(task != NULL, "Invalid parameter");
  59
  60   if (task->state_set == sd_global->not_scheduled_task_set)
  61     return SD_NOT_SCHEDULED;
  62   if (task->state_set == sd_global->scheduled_task_set)
  63     return SD_SCHEDULED;
  64   if (task->state_set == sd_global->running_task_set)
  65     return SD_RUNNING;
  66   if (task->state_set == sd_global->done_task_set)
  67     return SD_DONE;
  68   return SD_FAILED;
  69 }
  70
  71 /* Changes the state of a task. Update the swags and the flag sd_global->watch_point_reached.
  72  */
  73 static void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state) {
  74   xbt_swag_remove(task, task->state_set);
  75   switch (new_state) {
  76   case SD_NOT_SCHEDULED:
  77     task->state_set = sd_global->not_scheduled_task_set;
  78     break;
  79   case SD_SCHEDULED:
  80     task->state_set = sd_global->scheduled_task_set;
  81     break;
  82   case SD_RUNNING:
  83     task->state_set = sd_global->running_task_set;
  84     break;
  85   case SD_DONE:
  86     task->state_set = sd_global->done_task_set;
  87     break;
  88   default: /* SD_FAILED */
  89     task->state_set = sd_global->failed_task_set;
  90   }
  91   xbt_swag_insert(task,task->state_set);
  92
  93   if (task->watch_points & new_state) {
  94     printf("Watch point reached with task '%s' in state %d!\n", SD_task_get_name(task), new_state);
  95     sd_global->watch_point_reached = 1;
  96   }
  97 }
  98
  99 /* Sets the data of a task.
 100  */
 101 void SD_task_set_data(SD_task_t task, void *data) {
 102   SD_CHECK_INIT_DONE();
 103   xbt_assert0(task != NULL, "Invalid parameter");
 104   task->data = data;
 105 }
 106
 107 /* Returns the name of a task. The name can be NULL.
 108  */
 109 const char* SD_task_get_name(SD_task_t task) {
 110   SD_CHECK_INIT_DONE();
 111   xbt_assert0(task != NULL, "Invalid parameter");
 112   return task->name;
 113 }
 114
 115 /* Returns the computing amount of a task.
 116  */
 117 double SD_task_get_amount(SD_task_t task) {
 118   SD_CHECK_INIT_DONE();
 119   xbt_assert0(task != NULL, "Invalid parameter");
 120   return task->amount;
 121 }
 122
 123 /* Returns the remaining computing amount of a task.
 124  */
 125 double SD_task_get_remaining_amount(SD_task_t task) {
 126   SD_CHECK_INIT_DONE();
 127   xbt_assert0(task != NULL, "Invalid parameter");
 128
 129   if (task->surf_action)
 130     return task->amount;
 131   else
 132     return task->surf_action->remains;
 133 }
 134
 135 /* temporary function for debbuging
 136 void __SD_print_dependencies(SD_task_t task) {
 137   printf("The following tasks must be executed before %s:", SD_task_get_name(task));
 138   xbt_dynar_t dynar = task->tasks_before;
 139   int length = xbt_dynar_length(dynar);
 140   int i;
 141   SD_dependency_t dependency;
 142   for (i = 0; i < length; i++) {
 143     xbt_dynar_get_cpy(dynar, i, &dependency);
 144     printf(" %s", SD_task_get_name(dependency->src));
 145   }
 146
 147   printf("\nThe following tasks must be executed after %s:", SD_task_get_name(task));
 148
 149   dynar = task->tasks_after;
 150   length = xbt_dynar_length(dynar);
 151   for (i = 0; i < length; i++) {
 152     xbt_dynar_get_cpy(dynar, i, &dependency);
 153     printf(" %s", SD_task_get_name(dependency->dst));
 154   }
 155   printf("\n----------------------------\n");
 156 }*/
 157
 158 /* Destroys a dependency between two tasks.
 159  */
 160 void __SD_task_destroy_dependency(void *dependency) {
 161   if (((SD_dependency_t) dependency)->name != NULL)
 162     xbt_free(((SD_dependency_t) dependency)->name);
 163   xbt_free(dependency);
 164 }
 165
 166 /* Adds a dependency between two tasks.
 167  */
 168 void SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst) {
 169   SD_CHECK_INIT_DONE();
 170   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
 171   xbt_assert1(src != dst, "Cannot add a dependency between task '%s' and itself", SD_task_get_name(src));
 172
 173   xbt_dynar_t dynar = src->tasks_after;
 174   int length = xbt_dynar_length(dynar);
 175   int found = 0;
 176   int i;
 177   SD_dependency_t dependency;
 178   for (i = 0; i < length && !found; i++) {
 179     xbt_dynar_get_cpy(dynar, i, &dependency);
 180     found = (dependency->dst == dst);
 181   }
 182   xbt_assert2(!found, "A dependency already exists between task '%s' and task '%s'", SD_task_get_name(src), SD_task_get_name(dst));
 183
 184   dependency = xbt_new0(s_SD_dependency_t, 1);
 185
 186   if (name != NULL)
 187     dependency->name = xbt_strdup(name);
 188   dependency->data = data;
 189   dependency->src = src;
 190   dependency->dst = dst;
 191
 192   /* src must be executed before dst */
 193   xbt_dynar_push(src->tasks_after, &dependency);
 194   xbt_dynar_push(dst->tasks_before, &dependency);
 195
 196   /*  __SD_print_dependencies(src);
 197       __SD_print_dependencies(dst); */
 198 }
 199
 200 /* Removes a dependency between two tasks.
 201  */
 202 void SD_task_dependency_remove(SD_task_t src, SD_task_t dst) {
 203   SD_CHECK_INIT_DONE();
 204   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
 205   xbt_assert1(src != dst, "Cannot remove a dependency between task '%s' and itself", SD_task_get_name(src));
 206
 207   xbt_dynar_t dynar = src->tasks_after;
 208   int length = xbt_dynar_length(dynar);
 209   int found = 0;
 210   int i;
 211   SD_dependency_t dependency;
 212   for (i = 0; i < length && !found; i++) {
 213     xbt_dynar_get_cpy(dynar, i, &dependency);
 214     if (dependency->dst == dst) {
 215       xbt_dynar_remove_at(dynar, i, NULL);
 216       found = 1;
 217     }
 218   }
 219   xbt_assert4(found, "No dependency found between task '%s' and '%s': task '%s' is not a successor of task '%s'",
 220               SD_task_get_name(src), SD_task_get_name(dst), SD_task_get_name(dst), SD_task_get_name(src));
 221
 222   dynar = dst->tasks_before;
 223   length = xbt_dynar_length(dynar);
 224   found = 0;
 225
 226   for (i = 0; i < length && !found; i++) {
 227     xbt_dynar_get_cpy(dynar, i, &dependency);
 228     if (dependency->src == src) {
 229       xbt_dynar_remove_at(dynar, i, NULL);
 230       __SD_task_destroy_dependency(dependency);
 231       found = 1;
 232     }
 233   }
 234   xbt_assert4(found, "SimDag error: task '%s' is a successor of '%s' but task '%s' is not a predecessor of task '%s'",
 235               SD_task_get_name(dst), SD_task_get_name(src), SD_task_get_name(src), SD_task_get_name(dst)); /* should never happen... */
 236
 237   /*   __SD_print_dependencies(src);
 238        __SD_print_dependencies(dst); */
 239 }
 240
 241 /* Returns the data associated to a dependency between two tasks. This data can be NULL.
 242  */
 243 void *SD_task_dependency_get_data(SD_task_t src, SD_task_t dst) {
 244   SD_CHECK_INIT_DONE();
 245   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
 246   xbt_assert1(src != dst, "Cannot have a dependency between task '%s' and itself", SD_task_get_name(src));
 247
 248   xbt_dynar_t dynar = src->tasks_after;
 249   int length = xbt_dynar_length(dynar);
 250   int found = 0;
 251   int i;
 252   SD_dependency_t dependency;
 253   for (i = 0; i < length && !found; i++) {
 254     xbt_dynar_get_cpy(dynar, i, &dependency);
 255     found = (dependency->dst == dst);
 256   }
 257   xbt_assert2(found, "No dependency found between task '%s' and '%s'", SD_task_get_name(src), SD_task_get_name(dst));
 258   return dependency->data;
 259 }
 260
 261 /* temporary function for debugging */
 262 static void __SD_print_watch_points(SD_task_t task) {
 263   static const int state_masks[] = {SD_SCHEDULED, SD_RUNNING, SD_DONE, SD_FAILED};
 264   static const char* state_names[] = {"scheduled", "running", "done", "failed"};
 265
 266   printf("Task '%s' watch points (%x): ", SD_task_get_name(task), task->watch_points);
 267
 268   int i;
 269   for (i = 0; i < 4; i++) {
 270     if (task->watch_points & state_masks[i])
 271       printf("%s ", state_names[i]);
 272   }
 273   printf("\n");
 274 }
 275
 276 /* Adds a watch point to a task.
 277    SD_simulate will stop as soon as the state of this task is the one given in argument.
 278    Watch point is then automatically removed.
 279  */
 280 void SD_task_watch(SD_task_t task, e_SD_task_state_t state) {
 281   SD_CHECK_INIT_DONE();
 282   xbt_assert0(task != NULL, "Invalid parameter");
 283
 284   task->watch_points = task->watch_points | state;
 285   __SD_print_watch_points(task);
 286 }
 287
 288 /* Removes a watch point from a task.
 289  */
 290 void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state) {
 291   SD_CHECK_INIT_DONE();
 292   xbt_assert0(task != NULL, "Invalid parameter");
 293
 294   task->watch_points = task->watch_points & ~state;
 295   __SD_print_watch_points(task);
 296 }
 297
 298 /* Destroys the data memorised by SD_task_schedule. Task state must be SD_SCHEDULED.
 299  */
 300 static void __SD_task_destroy_scheduling_data(SD_task_t task) {
 301   xbt_free(task->workstation_list);
 302   xbt_free(task->computation_amount);
 303   xbt_free(task->communication_amount);
 304 }
 305
 306 /* Schedules a task.
 307  * task: the task to schedule
 308  * workstation_nb: number of workstations where the task will be executed
 309  * workstation_list: workstations where the task will be executed
 310  * computation_amount: computation amount for each workstation
 311  * communication_amount: communication amount between each pair of workstations
 312  * rate: task execution speed rate
 313  */
 314 void SD_task_schedule(SD_task_t task, int workstation_nb,
 315                      const SD_workstation_t *workstation_list, double *computation_amount,
 316                      double *communication_amount, double rate) {
 317   SD_CHECK_INIT_DONE();
 318   xbt_assert0(task, "Invalid parameter");
 319   xbt_assert1(SD_task_get_state(task) == SD_NOT_SCHEDULED, "Task '%s' has already been scheduled.", SD_task_get_name(task));
 320   xbt_assert0(workstation_nb > 0, "workstation_nb must be positive");
 321
 322   task->workstation_nb = workstation_nb;
 323   task->rate = rate;
 324
 325   task->computation_amount = xbt_new0(double, workstation_nb);
 326   memcpy(task->computation_amount, computation_amount, sizeof(double) * workstation_nb);
 327
 328   int communication_nb = workstation_nb * workstation_nb;
 329   task->communication_amount = xbt_new0(double, communication_nb);
 330   memcpy(task->communication_amount, communication_amount, sizeof(double) * communication_nb);
 331
 332   /* we have to create a Surf workstation array instead of the SimDag workstation array */
 333   task->workstation_list = xbt_new0(void*, workstation_nb);
 334   int i;
 335   for (i = 0; i < workstation_nb; i++) {
 336     task->workstation_list[i] = workstation_list[i]->surf_workstation;
 337   }
 338
 339   __SD_task_set_state(task, SD_SCHEDULED);
 340 }
 341
 342 /* Unschedules a task. The state must be SD_SCHEDULED, SD_RUNNING or SD_FAILED.
 343  * The task is reinitialised and its state becomes SD_NOT_SCHEDULED.
 344  * Call SD_task_schedule to schedule it again.
 345  */
 346 void SD_task_unschedule(SD_task_t task) {
 347   SD_CHECK_INIT_DONE();
 348   xbt_assert0(task != NULL, "Invalid parameter");
 349   e_SD_task_state_t state = SD_task_get_state(task);
 350   xbt_assert1(state == SD_SCHEDULED ||
 351               state == SD_RUNNING ||
 352               state == SD_FAILED,
 353               "Task %s: the state must be SD_SCHEDULED, SD_RUNNING or SD_FAILED", SD_task_get_name(task));
 354
 355   if (state == SD_SCHEDULED)
 356     __SD_task_destroy_scheduling_data(task);
 357
 358   __SD_task_set_state(task, SD_NOT_SCHEDULED);
 359 }
 360
 361 /* Runs a task. This function is called by SD_simulate when a scheduled task can start
 362  * (ie when its dependencies are satisfied).
 363  */
 364 surf_action_t __SD_task_run(SD_task_t task) {
 365   SD_CHECK_INIT_DONE();
 366   xbt_assert0(task != NULL, "Invalid parameter");
 367
 368
 369   surf_action_t surf_action = surf_workstation_resource->extension_public->
 370     execute_parallel_task(task->workstation_nb,
 371                           task->workstation_list,
 372                           task->computation_amount,
 373                           task->communication_amount,
 374                           task->amount,
 375                           task->rate);
 376   __SD_task_set_state(task, SD_RUNNING);
 377
 378   __SD_task_destroy_scheduling_data(task); /* now the scheduling data are not useful anymore */
 379   return surf_action;
 380 }
 381
 382
 383 /* Destroys a task. The user data (if any) should have been destroyed first.
 384  */
 385 void SD_task_destroy(SD_task_t task) {
 386   SD_CHECK_INIT_DONE();
 387   xbt_assert0(task != NULL, "Invalid parameter");
 388
 389   /*printf("Destroying task %s...\n", SD_task_get_name(task));*/
 390
 391   /* remove the task from SimDag task list */
 392   int index = xbt_dynar_search(sd_global->tasks, &task);
 393   xbt_dynar_remove_at(sd_global->tasks, index, NULL);
 394
 395   /* we must destroy the dependencies carefuly (with SD_dependency_remove)
 396      because each one is stored twice */
 397   SD_dependency_t dependency;
 398   while (xbt_dynar_length(task->tasks_before) > 0) {
 399     xbt_dynar_get_cpy(task->tasks_before, 0, &dependency);
 400     SD_task_dependency_remove(dependency->src, dependency->dst);
 401   }
 402
 403   while (xbt_dynar_length(task->tasks_after) > 0) {
 404     xbt_dynar_get_cpy(task->tasks_after, 0, &dependency);
 405     SD_task_dependency_remove(dependency->src, dependency->dst);
 406   }
 407
 408   /* if the task was scheduled we have to free the scheduling parameters */
 409   if (SD_task_get_state(task) == SD_SCHEDULED)
 410     __SD_task_destroy_scheduling_data(task);
 411
 412   if (task->name != NULL)
 413     xbt_free(task->name);
 414
 415   xbt_dynar_free(&task->tasks_before);
 416   xbt_dynar_free(&task->tasks_after);
 417   xbt_free(task);
 418
 419   /*printf("Task destroyed.\n");*/
 420
 421 }