Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Finish SimDag documentation
[simgrid.git] / src / simdag / sd_global.c
index 332e26c..2e5f3f3 100644 (file)
-#include "simdag/simdag.h"
 #include "private.h"
-#include "xbt/asserts.h"
 #include "xbt/sysdep.h"
+#include "xbt/dynar.h"
 #include "surf/surf.h"
 
-static int init_done = 0;
+XBT_LOG_NEW_CATEGORY(sd,"Logging specific to SimDag");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel,sd,
+                               "Logging specific to SimDag (kernel)");
 
-/* Initialises SG internal data. This function should be called before any other SG function.
+SD_global_t sd_global = NULL;
+
+/**
+ * \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 SG_init(int *argc, char **argv) {
-  xbt_assert0(!init_done, "SG_init already called");
+void SD_init(int *argc, char **argv) {
+  xbt_assert0(sd_global == NULL, "SD_init already called");
 
-  sg_global = xbt_new0(s_SG_global_t, 1);
-  sg_global->workstations = xbt_dict_new();
-  sg_global->workstation_count = 0;
+  sd_global = xbt_new0(s_SD_global_t, 1);
+  sd_global->workstations = xbt_dict_new();
+  sd_global->workstation_count = 0;
+  sd_global->links = xbt_dict_new();
+  sd_global->watch_point_reached = 0;
 
-  surf_init(argc, argv);
+  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->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));
 
-  init_done = 1;
+  surf_init(argc, argv);
 }
 
-/* Checks that SG_init has been called.
+/**
+ * \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 check_init_done() {
-  xbt_assert0(init_done, "SG_init not called yet");
+void SD_create_environment(const char *platform_file) {
+  xbt_dict_cursor_t cursor = NULL;
+  char *name = NULL;
+  void *surf_workstation = NULL;
+  void *surf_link = NULL;
+
+  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);*/
+
+  /*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);*/
+
+
+  /* now let's create the SD wrappers for workstations and links */
+  xbt_dict_foreach(workstation_set, cursor, name, surf_workstation) {
+    __SD_workstation_create(surf_workstation, NULL);
+  }
+
+  xbt_dict_foreach(network_link_set, cursor, name, surf_link) {
+    __SD_link_create(surf_link, NULL);
+  }
 }
 
-/* Creates the environnement described in a xml file of a platform descriptions.
+/**
+ * \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
+ * \return a NULL-terminated array of \ref SD_task_t whose state has changed.
+ * \see SD_task_schedule(), SD_task_watch()
  */
-void SG_create_environnement(const char *platform_file) {
-  check_init_done();
-  surf_timer_resource_init(platform_file);
-  surf_workstation_resource_init_KCCFLN05(platform_file); /* tell Surf to create the environnement */
-}
+SD_task_t* SD_simulate(double how_long)
+{
+  double total_time = 0.0; /* we stop the simulation when total_time >= how_long */
+  double elapsed_time = 0.0;
+  SD_task_t task;
+  surf_action_t action;
+  SD_task_t *changed_tasks = NULL;
+  int changed_task_number = 0;
+  int changed_task_capacity = 16; /* will be increased if necessary */
 
+  /* create the array that will be returned */
+  changed_tasks = xbt_new0(SD_task_t, changed_task_capacity);
+  changed_tasks[0] = NULL;
 
-/* Launches the simulation. Returns a NULL-terminated array of SG_task_t whose state has changed.
+  surf_solve(); /* Takes traces into account. Returns 0.0 */
+
+  sd_global->watch_point_reached = 0;
+
+  /* main loop */
+  while (elapsed_time >= 0.0 && total_time < how_long && !sd_global->watch_point_reached) {
+
+    /* explore the ready tasks */
+    xbt_swag_foreach(task, sd_global->ready_task_set) {
+      INFO1("Executing task '%s'", SD_task_get_name(task));
+      task->state_changed = 0;
+      action = __SD_task_run(task);
+      surf_workstation_resource->common_public->action_set_data(action, task);
+      task->state_changed = 1;
+      
+      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;
+    }
+
+    elapsed_time = surf_solve();
+    if (elapsed_time > 0.0)
+      total_time += elapsed_time;
+
+    /* 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));
+      __SD_task_set_state(task, SD_DONE);
+      __SD_task_remove_dependencies(task);
+      if (!task->state_changed) {
+       task->state_changed = 1;
+       changed_tasks[changed_task_number++] = task;
+      }
+    }
+
+    /* 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);
+      if (!task->state_changed) {
+       task->state_changed = 1;
+       changed_tasks[changed_task_number++] = task;
+      }
+    }
+  }
+
+  INFO0("Simulation finished");
+  INFO1("Number of tasks whose state has changed: %d", changed_task_number);
+
+  return changed_tasks;
+}
+
+/**
+ * \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()
  */
-SG_task_t* SG_simulate(double how_long)
-{
-  /* TODO */
-  return NULL;
+void SD_exit(void) {
+  if (sd_global != NULL) {
+    xbt_dict_free(&sd_global->workstations);
+    xbt_dict_free(&sd_global->links);
+    xbt_free(sd_global);
+
+    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->running_task_set);
+    xbt_swag_free(sd_global->done_task_set);
+    xbt_swag_free(sd_global->failed_task_set);
+
+    surf_exit();
+  }
 }