Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use malloc instead of calloc
[simgrid.git] / src / simdag / sd_global.c
index 3314990..21cda51 100644 (file)
@@ -1,33 +1,69 @@
-#include "simdag/simdag.h"
 #include "private.h"
 #include "xbt/sysdep.h"
 #include "xbt/dynar.h"
 #include "surf/surf.h"
 
+XBT_LOG_NEW_CATEGORY(sd,"Logging specific to SimDag");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel,sd,
+                               "Logging specific to SimDag (kernel)");
+
 SD_global_t sd_global = NULL;
 
-/* Initialises SD internal data. This function should be called before any other SD function.
+/**
+ * \brief Initialises SD internal data
+ *
+ * This function must be called before any other SD function. Then you
+ * should call SD_create_environment().
+ *
+ * \param argc argument number
+ * \param argv argument list
+ * \see SD_create_environment(), SD_exit()
  */
 void SD_init(int *argc, char **argv) {
-  xbt_assert0(sd_global == NULL, "SD_init already called");
+  if (SD_INITIALISED()) {
+    xbt_assert0(0, "SD_init() already called");
+  }
 
-  sd_global = xbt_new0(s_SD_global_t, 1);
+  sd_global = xbt_new(s_SD_global_t, 1);
   sd_global->workstations = xbt_dict_new();
   sd_global->workstation_count = 0;
+  sd_global->workstation_list = NULL;
   sd_global->links = xbt_dict_new();
-  sd_global->tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
+  sd_global->link_count = 0;
+  sd_global->link_list = NULL;
+  sd_global->recyclable_route = NULL;
+  sd_global->watch_point_reached = 0;
 
   s_SD_task_t task;
   sd_global->not_scheduled_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
   sd_global->scheduled_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
+  sd_global->ready_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
+  sd_global->in_fifo_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
   sd_global->running_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
   sd_global->done_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
   sd_global->failed_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
+  sd_global->task_number = 0;
 
   surf_init(argc, argv);
 }
 
-/* Creates the environnement described in a xml file of a platform description.
+/**
+ * \brief Creates the environment
+ *
+ * The environment (i.e. the \ref SD_workstation_management "workstations" and the
+ * \ref SD_link_management "links") is created with the data stored in the given XML
+ * platform file.
+ *
+ * \param platform_file name of an XML file describing the environment to create
+ * \see SD_workstation_management, SD_link_management
+ *
+ * The XML file follows this DTD:
+ *
+ *     \include surfxml.dtd
+ *
+ * Here is a small example of such a platform: 
+ *
+ *     \include small_platform.xml
  */
 void SD_create_environment(const char *platform_file) {
   xbt_dict_cursor_t cursor = NULL;
@@ -37,20 +73,16 @@ void SD_create_environment(const char *platform_file) {
 
   SD_CHECK_INIT_DONE();
 
-  surf_timer_resource_init(platform_file);  /* tell Surf to create the environnement */
-
-  
-  /*printf("surf_workstation_resource = %p, workstation_set = %p\n", surf_workstation_resource, workstation_set);
-    printf("surf_network_resource = %p, network_link_set = %p\n", surf_network_resource, network_link_set);*/
+  DEBUG0("SD_create_environment");
 
-  /*surf_workstation_resource_init_KCCFLN05(platform_file);*/
-  surf_workstation_resource_init_CLM03(platform_file);
-
-  /*printf("surf_workstation_resource = %p, workstation_set = %p\n", surf_workstation_resource, workstation_set);
-    printf("surf_network_resource = %p, network_link_set = %p\n", surf_network_resource, network_link_set);*/
+  surf_timer_resource_init(platform_file);  /* tell Surf to create the environnement */
 
+  DEBUG0("Calling surf_workstation_resource_init");
+  surf_workstation_resource_init_KCCFLN05(platform_file);
+  /*  surf_workstation_resource_init_CLM03(platform_file); */
 
   /* now let's create the SD wrappers for workstations and links */
+  DEBUG0("Creating SimDags hosts and links");
   xbt_dict_foreach(workstation_set, cursor, name, surf_workstation) {
     __SD_workstation_create(surf_workstation, NULL);
   }
@@ -58,112 +90,210 @@ void SD_create_environment(const char *platform_file) {
   xbt_dict_foreach(network_link_set, cursor, name, surf_link) {
     __SD_link_create(surf_link, NULL);
   }
+
+  DEBUG2("Workstation number: %d, link number: %d", SD_workstation_get_number(), SD_link_get_number());
 }
 
-/* Launches the simulation. Returns a NULL-terminated array of SD_task_t whose state has changed.
+/**
+ * \brief Launches the simulation.
+ *
+ * The function will execute the \ref SD_READY ready tasks.
+ * The simulation will be stopped when its time reaches \a how_long,
+ * when a watch point is reached, or when no more task can be executed.
+ * Then you can call SD_simulate() again.
+ * 
+ * \param how_long maximum duration of the simulation (a negative value means no time limit)
+ * \return a NULL-terminated array of \ref SD_task_t whose state has changed.
+ * \see SD_task_schedule(), SD_task_watch()
  */
 SD_task_t* SD_simulate(double how_long)
 {
-  /* TODO */
-
   double total_time = 0.0; /* we stop the simulation when total_time >= how_long */
   double elapsed_time = 0.0;
-  int watch_point_reached = 0;
+  SD_task_t task, dst;
+  SD_dependency_t dependency;
+  surf_action_t action;
+  SD_task_t *changed_tasks = NULL;
+  int changed_task_number = 0;
+  int changed_task_capacity = sd_global->task_number + 1;
   int i;
-  SD_task_t task;
-  surf_action_t surf_action;
+  static int first_time = 1;
 
-  surf_solve(); /* Takes traces into account. Returns 0.0 */
+  SD_CHECK_INIT_DONE();
 
-  /* main loop */
-  while (elapsed_time >= 0.0 && total_time < how_long && !watch_point_reached) {
-    for (i = 0 ; i < xbt_dynar_length(sd_global->tasks); i++) {
-      xbt_dynar_get_cpy(sd_global->tasks, i, &task);
-      printf("Examining task '%s'...\n", SD_task_get_name(task));
-
-      /* if the task is scheduled and the dependencies are satisfied,
-        we can execute the task */
-      if (SD_task_get_state(task) == SD_SCHEDULED) {
-       printf("Task '%s' is scheduled.\n", SD_task_get_name(task));
-
-       if (xbt_dynar_length(task->tasks_before) == 0) {
-         printf("The dependencies are satisfied. Executing task '%s'\n", SD_task_get_name(task));
-         surf_action = __SD_task_run(task);
-       }
-       else {
-         printf("Cannot execute task '%s' because some depencies are not satisfied.\n", SD_task_get_name(task));
-       }
-      }
-      else {
-       printf("Task '%s' is not scheduled. Nothing to do.\n", SD_task_get_name(task));
+  INFO0("Starting simulation...");
+
+  /* create the array that will be returned */
+  changed_tasks = xbt_new(SD_task_t, changed_task_capacity);
+  changed_tasks[0] = NULL;
+
+  if (first_time) {
+    surf_solve(); /* Takes traces into account. Returns 0.0 */
+    first_time = 0;
+  }
+
+  sd_global->watch_point_reached = 0;
+
+  /* explore the ready tasks */
+  xbt_swag_foreach(task, sd_global->ready_task_set) {
+    INFO1("Executing task '%s'", SD_task_get_name(task));
+    if ((task->state_changed = __SD_task_try_to_run(task))) {
+      changed_tasks[changed_task_number++] = task; /* replace NULL by the task */
+      /*
+      if (changed_task_number == changed_task_capacity) {
+       changed_task_capacity *= 2;
+       changed_tasks = xbt_realloc(changed_tasks, sizeof(SD_task_t) * changed_task_capacity);
       }
+      */
+      changed_tasks[changed_task_number] = NULL;
     }
+  }
+
+  /* main loop */
+  elapsed_time = 0.0;
+  while (elapsed_time >= 0.0 &&
+        (how_long < 0.0 || total_time < how_long) &&
+        !sd_global->watch_point_reached) {
+
+    DEBUG1("Total time: %f", total_time);
+
     elapsed_time = surf_solve();
+    DEBUG1("surf_solve() returns %f", elapsed_time);
     if (elapsed_time > 0.0)
       total_time += elapsed_time;
-    printf("Total time: %f\n", total_time);
-  }
 
-  return NULL;
-}
+    /* let's see which tasks are done */
+    while ((action = xbt_swag_extract(surf_workstation_resource->common_public->states.done_action_set))) {
+      task = action->data;
+      INFO1("Task '%s' done", SD_task_get_name(task));
+      DEBUG0("Calling __SD_task_just_done");
+      __SD_task_just_done(task);
+      DEBUG1("__SD_task_just_done called on task '%s'", SD_task_get_name(task));
 
-void SD_test() {
-  /* temporary test to explore the workstations and the links */
-  xbt_dict_cursor_t cursor = NULL;
-  char *name = NULL;
-  SD_workstation_t workstation = NULL;
-  double power, available_power, bandwidth, latency;
-  SD_link_t link = NULL;
+      /* the state has changed */
+      if (!task->state_changed) {
+       task->state_changed = 1;
+       changed_tasks[changed_task_number++] = task;
+       /*
+       if (changed_task_number == changed_task_capacity) {
+         changed_task_capacity *= 2;
+         changed_tasks = xbt_realloc(changed_tasks, sizeof(SD_task_t) * changed_task_capacity);
+       }
+       */
+       changed_tasks[changed_task_number] = NULL;
+      }
+
+      /* remove the dependencies after this task */
+      while (xbt_dynar_length(task->tasks_after) > 0) {
+       xbt_dynar_get_cpy(task->tasks_after, 0, &dependency);
+       dst = dependency->dst;
+       SD_task_dependency_remove(task, dst);
+       
+       /* is dst ready now? */
+       if (__SD_task_is_ready(dst) && !sd_global->watch_point_reached) {
+         INFO1("Executing task '%s'", SD_task_get_name(dst));
+         if (__SD_task_try_to_run(dst)) {
+           changed_tasks[changed_task_number++] = dst;
+           /*
+           if (changed_task_number == changed_task_capacity) {
+             changed_task_capacity *= 2;
+             changed_tasks = xbt_realloc(changed_tasks, sizeof(SD_task_t) * changed_task_capacity);
+           }
+           */
+           changed_tasks[changed_task_number] = NULL;
+         }
+       }
+      }
+    }
 
-  surf_solve();
+    /* let's see which tasks have just failed */
+    while ((action = xbt_swag_extract(surf_workstation_resource->common_public->states.failed_action_set))) {
+      task = action->data;
+      INFO1("Task '%s' failed", SD_task_get_name(task));
+      __SD_task_set_state(task, SD_FAILED);
+      surf_workstation_resource->common_public->action_free(action);
+      task->surf_action = NULL;
 
-  xbt_dict_foreach(sd_global->workstations, cursor, name, workstation) {
-    power = SD_workstation_get_power(workstation);
-    available_power = SD_workstation_get_available_power(workstation);
-    printf("Workstation name: %s, power: %f Mflop/s, available power: %f%%\n", name, power, (available_power*100));
+      if (!task->state_changed) {
+       task->state_changed = 1;
+       changed_tasks[changed_task_number++] = task;
+       /*
+       if (changed_task_number == changed_task_capacity) {
+         changed_task_capacity *= 2;
+         changed_tasks = xbt_realloc(changed_tasks, sizeof(SD_task_t) * changed_task_capacity);
+       }
+       */
+       changed_tasks[changed_task_number] = NULL;
+      }
+    }
   }
 
-  xbt_dict_foreach(sd_global->links, cursor, name, link) {
-    bandwidth = SD_link_get_current_bandwidth(link);
-    latency = SD_link_get_current_latency(link);
-    printf("Link name: %s, bandwidth: %f, latency: %f\n", name, bandwidth, latency);
+  /* we must reset every task->state_changed */
+  i = 0;
+  while (changed_tasks[i] != NULL) {
+    changed_tasks[i]->state_changed = 0;
+    i++;
   }
 
-  /* test the route between two workstations */
-  SD_workstation_t src, dst;
-  xbt_dict_cursor_first(sd_global->workstations, &cursor);
-  xbt_dict_cursor_get_or_free(&cursor, &name, (void**) &src);
-  xbt_dict_cursor_step(cursor);
-  xbt_dict_cursor_get_or_free(&cursor, &name, (void**) &dst);
-  xbt_dict_cursor_free(&cursor);
+  INFO0("Simulation finished");
+  DEBUG3("elapsed_time = %f, total_time = %f, watch_point_reached = %d", elapsed_time, total_time, sd_global->watch_point_reached);
+  DEBUG1("current time = %f", surf_get_clock());
+
+  return changed_tasks;
+}
 
-  SD_link_t *route = SD_workstation_route_get_list(src, dst);
-  int route_size = SD_workstation_route_get_size(src, dst);
+/**
+ * \brief Returns the current clock
+ *
+ * \return the current clock, in second
+ */
+double SD_get_clock(void) {
+  SD_CHECK_INIT_DONE();
 
-  printf("Route between %s and %s (%d links) : ", SD_workstation_get_name(src), SD_workstation_get_name(dst), route_size);
-  int i;
-  for (i = 0; i < route_size; i++) {
-    printf("%s ", SD_link_get_name(route[i]));
-  }
-  printf("\n");
+  return surf_get_clock();
 }
 
-/* Destroys all SD internal data. This function should be called when the simulation is over.
- * The tasks should have been destroyed first.
+/**
+ * \brief Destroys all SD internal data
+ *
+ * This function should be called when the simulation is over. Don't forget also to destroy
+ * the tasks.
+ *
+ * \see SD_init(), SD_task_destroy()
  */
-void SD_exit() {
-  if (sd_global != NULL) {
+void SD_exit(void) {
+  if (SD_INITIALISED()) {
+    DEBUG0("Destroying workstation and link dictionaries...");
     xbt_dict_free(&sd_global->workstations);
     xbt_dict_free(&sd_global->links);
-    xbt_dynar_free(&sd_global->tasks);
-    xbt_free(sd_global);
 
+    DEBUG0("Destroying workstation and link arrays if necessary...");
+    if (sd_global->workstation_list != NULL)
+      xbt_free(sd_global->workstation_list);
+
+    if (sd_global->link_list != NULL)
+      xbt_free(sd_global->link_list);
+
+    if (sd_global->recyclable_route != NULL)
+      xbt_free(sd_global->recyclable_route);
+
+    DEBUG0("Destroying the swags...");
     xbt_swag_free(sd_global->not_scheduled_task_set);
     xbt_swag_free(sd_global->scheduled_task_set);
+    xbt_swag_free(sd_global->ready_task_set);
+    xbt_swag_free(sd_global->in_fifo_task_set);
     xbt_swag_free(sd_global->running_task_set);
     xbt_swag_free(sd_global->done_task_set);
     xbt_swag_free(sd_global->failed_task_set);
 
+    xbt_free(sd_global);
+    sd_global = NULL;
+
+    DEBUG0("Exiting Surf...");
     surf_exit();
   }
+  else {
+    fprintf(stderr, "Warning: SD_exit() called while SimDag was not running\n");
+    /* we cannot use exceptions here because xbt is not running! */
+  }
 }