Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add documentation for workstations and fix a few bugs
[simgrid.git] / src / simdag / sd_task.c
index 3a22af5..59530d8 100644 (file)
+#include "private.h"
 #include "simdag/simdag.h"
 #include "xbt/sysdep.h"
+#include "xbt/dynar.h"
 
 /* Creates a task.
  */
-SG_task_t SG_task_create(const char *name, void *data, double amount) {
+SD_task_t SD_task_create(const char *name, void *data, double amount) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(amount > 0, "amount must be positive");
 
-  xbt_assert0(amount >= 0, "Invalid parameter"); /* or amount > 0 ? */
+  SD_task_t task = xbt_new0(s_SD_task_t, 1);
 
-  SG_task_t task = xbt_new0(s_SG_task_t, 1);
-  
-  task->data = data;
-  task->name = xbt_strdup(name);
-  /*task->amount = amount;
-    task->remaining_amount = amount;*/
-  task->state = SG_SCHEDULED; /* not sure... should we add a state SG_NOT_SCHEDULED? */
-  /* TODO: dependencies + watch */
+  /* general information */
+  task->data = data; /* user data */
+  if (name != NULL)
+    task->name = xbt_strdup(name);
+  else
+    task->name = NULL;
+
+  task->state_set = sd_global->not_scheduled_task_set;
+  xbt_swag_insert(task,task->state_set);
+
+  task->amount = amount;
+  task->surf_action = NULL;
+  task->watch_points = 0;
+  task->state_changed = 0;
+
+  /* dependencies */
+  task->tasks_before = xbt_dynar_new(sizeof(SD_dependency_t), NULL);
+  task->tasks_after = xbt_dynar_new(sizeof(SD_dependency_t), NULL);
+
+  /* scheduling parameters */
+  task->workstation_nb = 0;
+  task->workstation_list = NULL;
+  task->computation_amount = NULL;
+  task->communication_amount = NULL;
+  task->rate = 0;
 
   return task;
 }
 
-/* Schedules a task.
+/* Returns the data of a task.
  */
-int SG_task_schedule(SG_task_t task, int workstation_nb,
-                    SG_workstation_t **workstation_list, double *computation_amount,
-                    double *communication_amount, double rate) {
-  xbt_assert0(task, "Invalid parameter");
-  /* TODO */
+void* SD_task_get_data(SD_task_t task) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
+  return task->data;
+}
+
+/* Returns the state of a task: SD_NOT_SCHEDULED, SD_SCHEDULED, SD_READY, SD_RUNNING, SD_DONE or SD_FAILED.
+ */
+e_SD_task_state_t SD_task_get_state(SD_task_t task) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
 
-  return 0;
+  if (task->state_set == sd_global->scheduled_task_set)
+    return SD_SCHEDULED;
+  if (task->state_set == sd_global->done_task_set)
+    return SD_DONE;
+  if (task->state_set == sd_global->running_task_set)
+    return SD_RUNNING;
+  if (task->state_set == sd_global->ready_task_set)
+    return SD_READY;
+  if (task->state_set == sd_global->not_scheduled_task_set)
+    return SD_NOT_SCHEDULED;
+  return SD_FAILED;
 }
 
-/* Returns the data of a task.
+/* Changes the state of a task. Updates the swags and the flag sd_global->watch_point_reached.
  */
-void* SG_task_get_data(SG_task_t task) {
-  xbt_assert0(task, "Invalid parameter");
-  return task->data;
+void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state) {
+  xbt_swag_remove(task, task->state_set);
+  switch (new_state) {
+  case SD_NOT_SCHEDULED:
+    task->state_set = sd_global->not_scheduled_task_set;
+    break;
+  case SD_SCHEDULED:
+    task->state_set = sd_global->scheduled_task_set;
+    break;
+  case SD_READY:
+    task->state_set = sd_global->ready_task_set;
+    break;
+  case SD_RUNNING:
+    task->state_set = sd_global->running_task_set;
+    break;
+  case SD_DONE:
+    task->state_set = sd_global->done_task_set;
+    break;
+  case SD_FAILED:
+    task->state_set = sd_global->failed_task_set;
+    break;
+  default:
+    xbt_assert0(0, "Invalid state");
+  }
+  xbt_swag_insert(task,task->state_set);
+
+  if (task->watch_points & new_state) {
+    printf("Watch point reached with task '%s' in state %d!\n", SD_task_get_name(task), new_state);
+    sd_global->watch_point_reached = 1;
+  }
 }
 
 /* Sets the data of a task.
  */
-void SG_task_set_data(SG_task_t task, void *data) {
-  xbt_assert0(task, "Invalid parameter");
+void SD_task_set_data(SD_task_t task, void *data) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
   task->data = data;
 }
 
-/* Returns the name of a task.
+/* Returns the name of a task. The name can be NULL.
  */
-const char* SG_task_get_name(SG_task_t task) {
-  xbt_assert0(task, "Invalid parameter");
+const char* SD_task_get_name(SD_task_t task) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
   return task->name;
 }
 
 /* Returns the computing amount of a task.
  */
-double SG_task_get_amount(SG_task_t task) {
-  xbt_assert0(task, "Invalid parameter");
-
-  /* TODO */
-  return 0;
-  /*return task->amount;*/
+double SD_task_get_amount(SD_task_t task) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
+  return task->amount;
 }
 
 /* Returns the remaining computing amount of a task.
  */
-double SG_task_get_remaining_amount(SG_task_t task) {
-  xbt_assert0(task, "Invalid parameter")
+double SD_task_get_remaining_amount(SD_task_t task) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
+  
+  if (task->surf_action)
+    return task->amount;
+  else
+    return task->surf_action->remains;
+}
+
+/* temporary function for debbuging */
+static void __SD_print_dependencies(SD_task_t task) {
+  printf("The following tasks must be executed before %s:", SD_task_get_name(task));
+  xbt_dynar_t dynar = task->tasks_before;
+  int length = xbt_dynar_length(dynar);
+  int i;
+  SD_dependency_t dependency;
+  for (i = 0; i < length; i++) {
+    xbt_dynar_get_cpy(dynar, i, &dependency);
+    printf(" %s", SD_task_get_name(dependency->src));
+  }
+
+  printf("\nThe following tasks must be executed after %s:", SD_task_get_name(task));
 
-  /* TODO (surf encapsulation) */;
-  return 0;
+  dynar = task->tasks_after;
+  length = xbt_dynar_length(dynar);
+  for (i = 0; i < length; i++) {
+    xbt_dynar_get_cpy(dynar, i, &dependency);
+    printf(" %s", SD_task_get_name(dependency->dst));
+  }
+  printf("\n----------------------------\n");
 }
 
-/* Adds a dependency between two tasks.
+/* Destroys a dependency between two tasks.
  */
-void SG_task_dependency_add(const char *name, void *data, SG_task_t src, SG_task_t dst) {
+static void __SD_task_dependency_destroy(void *dependency) {
+  if (((SD_dependency_t) dependency)->name != NULL)
+    xbt_free(((SD_dependency_t) dependency)->name);
+  xbt_free(dependency);
+}
+
+/* Adds a dependency between two tasks. Their state must be SD_NOT_SCHEDULED, SD_SCHEDULED
+ * or SD_READY.
+ */
+void SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst) {
+  SD_CHECK_INIT_DONE();
   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
-  /* TODO */
+  xbt_assert1(src != dst, "Cannot add a dependency between task '%s' and itself", SD_task_get_name(src));
+  xbt_assert1(__SD_task_is_not_scheduled(src) || __SD_task_is_scheduled_or_ready(src),
+             "Task '%s' must be SD_NOT_SCHEDULED, SD_SCHEDULED or SD_READY", SD_task_get_name(src));
+  xbt_assert1(__SD_task_is_not_scheduled(dst) || __SD_task_is_scheduled_or_ready(dst),
+             "Task '%s' must be SD_NOT_SCHEDULED, SD_SCHEDULED or SD_READY", SD_task_get_name(dst));
+
+  xbt_dynar_t dynar = src->tasks_after;
+  int length = xbt_dynar_length(dynar);
+  int found = 0;
+  int i;
+  SD_dependency_t dependency;
+  for (i = 0; i < length && !found; i++) {
+    xbt_dynar_get_cpy(dynar, i, &dependency);
+    found = (dependency->dst == dst);
+  }
+  xbt_assert2(!found, "A dependency already exists between task '%s' and task '%s'",
+             SD_task_get_name(src), SD_task_get_name(dst));
+
+  dependency = xbt_new0(s_SD_dependency_t, 1);
+
+  if (name != NULL)
+    dependency->name = xbt_strdup(name);
+  dependency->data = data;
+  dependency->src = src;
+  dependency->dst = dst;
+
+  /* src must be executed before dst */
+  xbt_dynar_push(src->tasks_after, &dependency);
+  xbt_dynar_push(dst->tasks_before, &dependency);
+
+  /* if the task was ready, then dst->tasks_before is not empty anymore,
+     so we must go back to state SD_SCHEDULED */
+  if (__SD_task_is_ready(dst)) {
+    printf("SD_task_dependency_add: %s was ready and becomes scheduled!\n", SD_task_get_name(dst));
+    __SD_task_set_state(dst, SD_SCHEDULED);
+  }
+
+  /*  __SD_print_dependencies(src);
+      __SD_print_dependencies(dst); */
 }
 
 /* Removes a dependency between two tasks.
  */
-void SG_task_dependency_remove(SG_task_t src, SG_task_t dst) {
+void SD_task_dependency_remove(SD_task_t src, SD_task_t dst) {
+  SD_CHECK_INIT_DONE();
   xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
-  /* TODO */
+
+  /* remove the dependency from src->tasks_after */
+  xbt_dynar_t dynar = src->tasks_after;
+  int length = xbt_dynar_length(dynar);
+  int found = 0;
+  int i;
+  SD_dependency_t dependency;
+  for (i = 0; i < length && !found; i++) {
+    xbt_dynar_get_cpy(dynar, i, &dependency);
+    if (dependency->dst == dst) {
+      xbt_dynar_remove_at(dynar, i, NULL);
+      found = 1;
+    }
+  }
+  xbt_assert4(found, "No dependency found between task '%s' and '%s': task '%s' is not a successor of task '%s'",
+             SD_task_get_name(src), SD_task_get_name(dst), SD_task_get_name(dst), SD_task_get_name(src));
+
+  /* remove the dependency from dst->tasks_before */
+  dynar = dst->tasks_before;
+  length = xbt_dynar_length(dynar);
+  found = 0;
+  
+  for (i = 0; i < length && !found; i++) {
+    xbt_dynar_get_cpy(dynar, i, &dependency);
+    if (dependency->src == src) {
+      xbt_dynar_remove_at(dynar, i, NULL);
+      __SD_task_dependency_destroy(dependency);
+      found = 1;
+    }
+  }
+  xbt_assert4(found, "SimDag error: task '%s' is a successor of '%s' but task '%s' is not a predecessor of task '%s'",
+             SD_task_get_name(dst), SD_task_get_name(src), SD_task_get_name(src), SD_task_get_name(dst)); /* should never happen... */
+
+  /* if the task was scheduled and dst->tasks_before is empty now, we can make it ready */
+  if (xbt_dynar_length(dst->tasks_before) == 0 && __SD_task_is_scheduled(dst))
+    __SD_task_set_state(dst, SD_READY);
+
+  /*  __SD_print_dependencies(src); 
+      __SD_print_dependencies(dst);*/
 }
 
-/* Returns the state of a task: SG_SCHEDULED, SG_RUNNING, SG_DONE or SG_FAILED.
+/* Returns the data associated to a dependency between two tasks. This data can be NULL.
  */
-SG_task_state_t SG_task_get_state(SG_task_t task) {
-  xbt_assert0(task, "Invalid parameter");
-  return task->state;
+void *SD_task_dependency_get_data(SD_task_t src, SD_task_t dst) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(src != NULL && dst != NULL, "Invalid parameter");
+
+  xbt_dynar_t dynar = src->tasks_after;
+  int length = xbt_dynar_length(dynar);
+  int found = 0;
+  int i;
+  SD_dependency_t dependency;
+  for (i = 0; i < length && !found; i++) {
+    xbt_dynar_get_cpy(dynar, i, &dependency);
+    found = (dependency->dst == dst);
+  }
+  xbt_assert2(found, "No dependency found between task '%s' and '%s'", SD_task_get_name(src), SD_task_get_name(dst));
+  return dependency->data;
+}
+
+/* temporary function for debugging */
+static void __SD_print_watch_points(SD_task_t task) {
+  static const int state_masks[] = {SD_SCHEDULED, SD_RUNNING, SD_READY, SD_DONE, SD_FAILED};
+  static const char* state_names[] = {"scheduled", "running", "ready", "done", "failed"};
+
+  printf("Task '%s' watch points (%x): ", SD_task_get_name(task), task->watch_points);
+
+  int i;
+  for (i = 0; i < 5; i++) {
+    if (task->watch_points & state_masks[i])
+      printf("%s ", state_names[i]);
+  }
+  printf("\n");
 }
 
 /* Adds a watch point to a task.
-   SG_simulate will stop as soon as the state of this task is the one given in argument.
+   SD_simulate will stop as soon as the state of this task is the one given in argument.
    Watch point is then automatically removed.
+   The given state must be SD_SCHEDULED, SD_READY, SD_RUNNING, SD_DONE or SD_FAILED.
  */
-void  SG_task_watch(SG_task_t task, SG_task_state_t state) {
-  xbt_assert0(task, "Invalid parameter");
-  /* TODO */
+void SD_task_watch(SD_task_t task, e_SD_task_state_t state) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
+  xbt_assert0(state != SD_NOT_SCHEDULED, "Cannot add a watch point for state SD_NOT_SCHEDULED");
+
+  task->watch_points = task->watch_points | state;
+  __SD_print_watch_points(task);
 }
 
 /* Removes a watch point from a task.
+   The given state must be SD_SCHEDULED, SD_READY, SD_RUNNING, SD_DONE or SD_FAILED.
  */
-void SG_task_unwatch(SG_task_t task, SG_task_state_t state) {
-  xbt_assert0(task, "Invalid parameter");
-  /* TODO */
+void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
+  xbt_assert0(state != SD_NOT_SCHEDULED, "Cannot have a watch point for state SD_NOT_SCHEDULED");
+  
+  task->watch_points = task->watch_points & ~state;
+  __SD_print_watch_points(task);
 }
 
-/* Unschedules a task.
-   Change state and rerun
+/* Destroys the data memorised by SD_task_schedule. Task state must be SD_SCHEDULED or SD_READY.
  */
-void SG_task_unschedule(SG_task_t task) {
+static void __SD_task_destroy_scheduling_data(SD_task_t task) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert1(__SD_task_is_scheduled_or_ready(task),
+             "Task '%s' must be SD_SCHEDULED or SD_READY", SD_task_get_name(task));
+  xbt_free(task->workstation_list);
+  xbt_free(task->computation_amount);
+  xbt_free(task->communication_amount);
+}
+
+/* Schedules a task.
+ * task: the task to schedule
+ * workstation_nb: number of workstations where the task will be executed
+ * workstation_list: workstations where the task will be executed
+ * computation_amount: computation amount for each workstation
+ * communication_amount: communication amount between each pair of workstations
+ * rate: task execution speed rate
+ */
+void SD_task_schedule(SD_task_t task, int workstation_nb,
+                    const SD_workstation_t *workstation_list, double *computation_amount,
+                    double *communication_amount, double rate) {
+  SD_CHECK_INIT_DONE();
   xbt_assert0(task, "Invalid parameter");
-  /* TODO */
+  xbt_assert1(__SD_task_is_not_scheduled(task), "Task '%s' has already been scheduled.", SD_task_get_name(task));
+  xbt_assert0(workstation_nb > 0, "workstation_nb must be positive");
+
+  task->workstation_nb = workstation_nb;
+  task->rate = rate;
+
+  task->computation_amount = xbt_new0(double, workstation_nb);
+  memcpy(task->computation_amount, computation_amount, sizeof(double) * workstation_nb);
+
+  int communication_nb = workstation_nb * workstation_nb;
+  task->communication_amount = xbt_new0(double, communication_nb);
+  memcpy(task->communication_amount, communication_amount, sizeof(double) * communication_nb);
+
+  /* we have to create a Surf workstation array instead of the SimDag workstation array */
+  task->workstation_list = xbt_new0(void*, workstation_nb);
+  int i;
+  for (i = 0; i < workstation_nb; i++) {
+    task->workstation_list[i] = workstation_list[i]->surf_workstation;
+  }
+
+  /* update the task state */
+  if (xbt_dynar_length(task->tasks_before) == 0)
+    __SD_task_set_state(task, SD_READY);
+  else
+    __SD_task_set_state(task, SD_SCHEDULED);
+}
+
+/* Unschedules a task. The state must be SD_SCHEDULED, SD_READY, SD_RUNNING or SD_FAILED.
+ * The task is reinitialised and its state becomes SD_NOT_SCHEDULED.
+ * Call SD_task_schedule to schedule it again.
+ */
+void SD_task_unschedule(SD_task_t task) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
+  xbt_assert1(task->state_set == sd_global->scheduled_task_set ||
+             task->state_set == sd_global->ready_task_set ||
+             task->state_set == sd_global->running_task_set ||
+             task->state_set == sd_global->failed_task_set,
+             "Task %s: the state must be SD_SCHEDULED, SD_READY, SD_RUNNING or SD_FAILED",
+             SD_task_get_name(task));
+
+  if (__SD_task_is_scheduled_or_ready(task)) /* if the task is scheduled or ready */
+    __SD_task_destroy_scheduling_data(task);
+
+  if (__SD_task_is_running(task)) /* the task should become SD_FAILED */
+    surf_workstation_resource->common_public->action_cancel(task->surf_action);
+  else
+    __SD_task_set_state(task, SD_NOT_SCHEDULED);
+}
+
+/* Runs a task. This function is called by SD_simulate when a scheduled task can start
+ * (ie when its dependencies are satisfied).
+ */
+surf_action_t __SD_task_run(SD_task_t task) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
+  xbt_assert2(__SD_task_is_ready(task), "Task '%s' is not ready! Task state: %d",
+             SD_task_get_name(task), SD_task_get_state(task));
+
+  surf_action_t surf_action = surf_workstation_resource->extension_public->
+    execute_parallel_task(task->workstation_nb,
+                         task->workstation_list,
+                         task->computation_amount,
+                         task->communication_amount,
+                         task->amount,
+                         task->rate);
+
+  __SD_task_destroy_scheduling_data(task); /* now the scheduling data are not useful anymore */
+  __SD_task_set_state(task, SD_RUNNING);
+
+  return surf_action;
+}
+
+/* Remove all dependencies associated with a task. This function is called when the task is done.
+ */
+void __SD_task_remove_dependencies(SD_task_t task) {
+  /* we must destroy the dependencies carefuly (with SD_dependency_remove)
+     because each one is stored twice */
+  SD_dependency_t dependency;
+  while (xbt_dynar_length(task->tasks_before) > 0) {
+    xbt_dynar_get_cpy(task->tasks_before, 0, &dependency);
+    SD_task_dependency_remove(dependency->src, dependency->dst);
+  }
+
+  while (xbt_dynar_length(task->tasks_after) > 0) {
+    xbt_dynar_get_cpy(task->tasks_after, 0, &dependency);
+    SD_task_dependency_remove(dependency->src, dependency->dst);
+  }
 }
 
 /* Destroys a task. The user data (if any) should have been destroyed first.
  */
-void SG_task_destroy(SG_task_t task) {
-  if (task->name)
+void SD_task_destroy(SD_task_t task) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
+
+  /*printf("Destroying task %s...\n", SD_task_get_name(task));*/
+
+  __SD_task_remove_dependencies(task);
+
+  /* if the task was scheduled or ready we have to free the scheduling parameters */
+  if (__SD_task_is_scheduled_or_ready(task))
+    __SD_task_destroy_scheduling_data(task);
+
+  if (task->name != NULL)
     xbt_free(task->name);
 
-  /* TODO: dependencies + watch */
+  xbt_dynar_free(&task->tasks_before);
+  xbt_dynar_free(&task->tasks_after);
   xbt_free(task);
+
+  /*printf("Task destroyed.\n");*/
 }