Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix doxygen
[simgrid.git] / src / simdag / sd_task.c
index 1578ff1..e501281 100644 (file)
@@ -3,20 +3,23 @@
 #include "xbt/sysdep.h"
 #include "xbt/dynar.h"
 
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_task,sd,
+                               "Logging specific to SimDag (task)");
+
 static void __SD_task_remove_dependencies(SD_task_t task);
+static void __SD_task_destroy_scheduling_data(SD_task_t task);
 
 /**
  * \brief Creates a new task.
  *
  * \param name the name of the task (can be \c NULL)
  * \param data the user data you want to associate with the task (can be \c NULL)
- * \param amount the computing amount necessary to do this task
+ * \param amount amount of the task
  * \return the new task
  * \see SD_task_destroy()
  */
 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");
 
   SD_task_t task = xbt_new0(s_SD_task_t, 1);
 
@@ -31,6 +34,9 @@ SD_task_t SD_task_create(const char *name, void *data, double amount) {
   xbt_swag_insert(task,task->state_set);
 
   task->amount = amount;
+  task->remains = amount;
+  task->start_time = -1.0;
+  task->finish_time = -1.0;
   task->surf_action = NULL;
   task->watch_points = 0;
   task->state_changed = 0;
@@ -119,9 +125,14 @@ void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state) {
     break;
   case SD_RUNNING:
     task->state_set = sd_global->running_task_set;
+    task->start_time = surf_workstation_resource->common_public->
+      action_get_start_time(task->surf_action);
     break;
   case SD_DONE:
     task->state_set = sd_global->done_task_set;
+    task->finish_time = surf_workstation_resource->common_public->
+      action_get_finish_time(task->surf_action);
+    task->remains = 0;
     break;
   case SD_FAILED:
     task->state_set = sd_global->failed_task_set;
@@ -132,7 +143,7 @@ void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state) {
   xbt_swag_insert(task, task->state_set);
 
   if (task->watch_points & new_state) {
-    printf("Watch point reached with task '%s'!\n", SD_task_get_name(task));
+    INFO1("Watch point reached with task '%s'!", SD_task_get_name(task));
     sd_global->watch_point_reached = 1;
     SD_task_unwatch(task, new_state); /* remove the watch point */
   }
@@ -151,10 +162,10 @@ const char* SD_task_get_name(SD_task_t task) {
 }
 
 /**
- * \brief Returns the computing amount of a task
+ * \brief Returns the total amount of a task
  *
  * \param task a task
- * \return the total computing amount of this task
+ * \return the total amount of this task
  * \see SD_task_get_remaining_amount()
  */
 double SD_task_get_amount(SD_task_t task) {
@@ -164,43 +175,43 @@ double SD_task_get_amount(SD_task_t task) {
 }
 
 /**
- * \brief Returns the remaining computing amount of a task
+ * \brief Returns the remaining amount of a task
  *
  * \param task a task
- * \return the remaining computing amount of this task
+ * \return the remaining amount of this task
  * \see SD_task_get_amount()
  */
 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;
+  else
+    return task->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));
+  INFO1("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));
+    INFO1(" %s", SD_task_get_name(dependency->src));
   }
 
-  printf("\nThe following tasks must be executed after %s:", SD_task_get_name(task));
+  INFO1("The following tasks must be executed after %s:", SD_task_get_name(task));
 
   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));
+    INFO1(" %s", SD_task_get_name(dependency->dst));
   }
-  printf("\n----------------------------\n");
+  INFO0("----------------------------");
 }
 
 /* Destroys a dependency between two tasks.
@@ -248,6 +259,9 @@ void SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task
 
   if (name != NULL)
     dependency->name = xbt_strdup(name);
+  else
+    dependency->name = NULL;
+
   dependency->data = data;
   dependency->src = src;
   dependency->dst = dst;
@@ -259,7 +273,7 @@ void SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task
   /* 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));
+    DEBUG1("SD_task_dependency_add: %s was ready and becomes scheduled!", SD_task_get_name(dst));
     __SD_task_set_state(dst, SD_SCHEDULED);
   }
 
@@ -348,14 +362,13 @@ 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);
+  INFO2("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]);
+      INFO1("%s ", state_names[i]);
   }
-  printf("\n");
 }
 
 /**
@@ -393,15 +406,42 @@ void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state) {
   /*  __SD_print_watch_points(task);*/
 }
 
-/* Destroys the data memorised by SD_task_schedule. Task state must be SD_SCHEDULED or SD_READY.
+/**
+ * \brief Returns an approximative estimation of the execution time of a task.
+ * 
+ * The estimation is very approximative because the value returned is the time
+ * the task would take if it was executed now and if it was the only task.
+ * 
+ * \param task the task to evaluate
+ * \param workstation_nb number of workstations on which the task would be executed
+ * \param workstation_list the workstations on which the task would be executed
+ * \param computation_amount computation amount for each workstation
+ * \param communication_amount communication amount between each pair of workstations
+ * \param rate task execution speed rate
+ * \see SD_schedule()
  */
-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);
+double SD_task_get_execution_time(SD_task_t task,
+                                 int workstation_nb,
+                                 const SD_workstation_t *workstation_list,
+                                 const double *computation_amount,
+                                 const double *communication_amount,
+                                 double rate) {
+  /* the task execution time is the maximum execution time of the parallel tasks */
+  double time, max_time = 0.0;
+  int i, j;
+  for (i = 0; i < workstation_nb; i++) {
+    time = SD_workstation_get_computation_time(workstation_list[i], computation_amount[i]);
+    
+    for (j = 0; j < workstation_nb; j++) {
+      time += SD_route_get_communication_time(workstation_list[i], workstation_list[j],
+                                             communication_amount[i * workstation_nb + j]);
+    }
+
+    if (time > max_time) {
+      max_time = time;
+    }
+  }
+  return max_time * SD_task_get_amount(task);
 }
 
 /**
@@ -420,8 +460,8 @@ static void __SD_task_destroy_scheduling_data(SD_task_t task) {
  * \see SD_task_unschedule()
  */
 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) {
+                    const SD_workstation_t *workstation_list, const double *computation_amount,
+                    const double *communication_amount, double rate) {
   SD_CHECK_INIT_DONE();
   xbt_assert0(task, "Invalid parameter");
   xbt_assert1(__SD_task_is_not_scheduled(task), "Task '%s' has already been scheduled.", SD_task_get_name(task));
@@ -478,9 +518,22 @@ void SD_task_unschedule(SD_task_t task) {
     surf_workstation_resource->common_public->action_cancel(task->surf_action);
   else
     __SD_task_set_state(task, SD_NOT_SCHEDULED);
+  task->remains = task->amount;
+  task->start_time = -1.0;
+}
+
+/* Destroys the data memorised by SD_task_schedule. Task state must be SD_SCHEDULED or SD_READY.
+ */
+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);
 }
 
-/* Runs a task. This function is called by SD_simulate when a scheduled task can start
+/* 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) {
@@ -489,7 +542,7 @@ surf_action_t __SD_task_run(SD_task_t task) {
   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->
+  task->surf_action = surf_workstation_resource->extension_public->
     execute_parallel_task(task->workstation_nb,
                          task->workstation_list,
                          task->computation_amount,
@@ -497,10 +550,12 @@ surf_action_t __SD_task_run(SD_task_t task) {
                          task->amount,
                          task->rate);
 
+  DEBUG1("surf_action = %p",  task->surf_action);
+
   __SD_task_destroy_scheduling_data(task); /* now the scheduling data are not useful anymore */
   __SD_task_set_state(task, SD_RUNNING);
 
-  return surf_action;
+  return task->surf_action;
 }
 /* Remove all dependencies associated with a task. This function is called when the task is destroyed.
  */
@@ -519,6 +574,44 @@ static void __SD_task_remove_dependencies(SD_task_t task) {
   }
 }
 
+/**
+ * \brief Returns the start time of a task
+ *
+ * The task state must be SD_RUNNING, SD_DONE or SD_FAILED.
+ *
+ * \param task: a task
+ * \return the start time of this task
+ */
+double SD_task_get_start_time(SD_task_t task) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
+  if(task->surf_action)
+    return surf_workstation_resource->common_public->action_get_start_time(task->surf_action);
+  else 
+    return task->start_time;
+}
+
+/**
+ * \brief Returns the finish time of a task
+ *
+ * The task state must be SD_RUNNING, SD_DONE or SD_FAILED.
+ * If the state is not completed yet, the returned value is an
+ * estimation of the task finish time. This value can fluctuate 
+ * until the task is completed.
+ *
+ * \param task: a task
+ * \return the start time of this task
+ */
+double SD_task_get_finish_time(SD_task_t task) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(task != NULL, "Invalid parameter");
+
+  if(task->surf_action)
+    return surf_workstation_resource->common_public->action_get_finish_time(task->surf_action); /* should never happen as actions are destroyed right after their completion */
+  else 
+    return task->finish_time;
+}
+
 /**
  * \brief Destroys a task.
  *
@@ -531,7 +624,7 @@ 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));*/
+  DEBUG1("Destroying task %s...", SD_task_get_name(task));
 
   __SD_task_remove_dependencies(task);
 
@@ -542,9 +635,12 @@ void SD_task_destroy(SD_task_t task) {
   if (task->name != NULL)
     xbt_free(task->name);
 
+  if (task->surf_action != NULL)
+    surf_workstation_resource->common_public->action_free(task->surf_action);
+
   xbt_dynar_free(&task->tasks_before);
   xbt_dynar_free(&task->tasks_after);
   xbt_free(task);
 
-  /*printf("Task destroyed.\n");*/
+  DEBUG0("Task destroyed.");
 }