Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Documentation fixups: Marc was a bit quick at copy/pasting (+ DTD renamed)
[simgrid.git] / src / simdag / sd_global.c
index 89edfed..ce76515 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"
+#include "xbt/ex.h"
+#include "xbt/log.h"
+#include "xbt/str.h"
+#include "xbt/config.h"
 
-#define CHECK_INIT_DONE() xbt_assert0(init_done, "SG_init not called yet")
+XBT_LOG_NEW_CATEGORY(sd,"Logging specific to SimDag");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel,sd,
+                               "Logging specific to SimDag (kernel)");
 
-SG_global_t sg_global = NULL;
+SD_global_t sd_global = NULL;
 
-static int init_done = 0;
+/* $Id$ */
 
-/* Initialises SG internal data. This function should be called before any other SG function.
+/* Copyright (c) 2007 Arnaud Legrand.
+   All rights reserved.                                          */
+
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
+static int _sd_init_status = 0;        /* 0: beginning of time; 
+                                  1: pre-inited (cfg_set created); 
+                                  2: inited (running) */
+static xbt_cfg_t _sd_cfg_set = NULL;
+
+/* callback of the workstation_model variable */
+static void _sd_cfg_cb__workstation_model(const char *name, int pos)
+{
+  char *val;
+
+  xbt_assert0(_sd_init_status < 2,
+             "Cannot change the model after the initialization");
+
+  val = xbt_cfg_get_string(_sd_cfg_set, name);
+  find_model_description(surf_workstation_model_description,
+                           surf_workstation_model_description_size,
+                           val);
+}
+
+/* callback of the cpu_model variable */
+static void _sd_cfg_cb__cpu_model(const char *name, int pos)
+{
+  char *val;
+
+  xbt_assert0(_sd_init_status < 2,
+             "Cannot change the model after the initialization");
+
+  val = xbt_cfg_get_string(_sd_cfg_set, name);
+  find_model_description(surf_cpu_model_description,
+                           surf_cpu_model_description_size, val);
+}
+
+/* callback of the workstation_model variable */
+static void _sd_cfg_cb__network_model(const char *name, int pos)
+{
+  char *val;
+
+  xbt_assert0(_sd_init_status < 2,
+             "Cannot change the model after the initialization");
+
+  val = xbt_cfg_get_string(_sd_cfg_set, name);
+  find_model_description(surf_network_model_description,
+                           surf_network_model_description_size, val);
+}
+
+XBT_LOG_EXTERNAL_CATEGORY(sd_kernel);
+XBT_LOG_EXTERNAL_CATEGORY(sd_task);
+XBT_LOG_EXTERNAL_CATEGORY(sd_workstation);
+
+/* create the config set and register what should be */
+static void sd_config_init(void)
+{
+
+  if (_sd_init_status)
+    return;                    /* Already inited, nothing to do */
+
+  /* Connect our log channels: that must be done manually under windows */
+  XBT_LOG_CONNECT(sd_kernel, sd);
+  XBT_LOG_CONNECT(sd_task, sd);
+  XBT_LOG_CONNECT(sd_workstation, sd);
+   
+  _sd_init_status = 1;
+  _sd_cfg_set = xbt_cfg_new();
+
+  xbt_cfg_register(_sd_cfg_set,
+                  "workstation_model", xbt_cfgelm_string, 1, 1,
+                  &_sd_cfg_cb__workstation_model, NULL);
+
+  xbt_cfg_register(_sd_cfg_set,
+                  "cpu_model", xbt_cfgelm_string, 1, 1,
+                  &_sd_cfg_cb__cpu_model, NULL);
+  xbt_cfg_register(_sd_cfg_set,
+                  "network_model", xbt_cfgelm_string, 1, 1,
+                  &_sd_cfg_cb__network_model, NULL);
+
+  xbt_cfg_set_string(_sd_cfg_set, "workstation_model", "ptask_L07");
+}
+
+static void sd_config_finalize(void)
+{
+
+  if (!_sd_init_status)
+    return;                    /* Not initialized yet. Nothing to do */
+
+  xbt_cfg_free(&_sd_cfg_set);
+  _sd_init_status = 0;
+}
+
+static void sd_config(const char *name, va_list pa)
+{
+  if (!_sd_init_status) {
+    sd_config_init();
+  }
+  xbt_cfg_set_vargs(_sd_cfg_set, name, pa);
+}
+
+
+static void __sd_config_helper(const char *name, ...)
+{
+  va_list pa;
+  va_start(pa, name);
+
+  sd_config(name, pa);
+
+  va_end(pa);
+}
+
+static void sd_cfg_control_set(const char *control_string)
+{
+  /* To split the string in commands, and the cursors */
+  xbt_dynar_t set_strings;
+  char *str;
+  unsigned int cpt;
+
+  if (!control_string)
+    return;
+  DEBUG1("Parse log settings '%s'", control_string);
+
+  /* split the string, and remove empty entries */
+  set_strings = xbt_str_split_quoted(control_string);
+
+  if (xbt_dynar_length(set_strings) == 0) {    /* vicious user! */
+    xbt_dynar_free(&set_strings);
+    return;
+  }
+  /* Parse each entry and either use it right now (if the category was already
+     created), or store it for further use */
+  xbt_dynar_foreach(set_strings, cpt, str) {
+    char *control_string, *control_string_sav, *name, *value;
+
+
+    control_string = control_string_sav = strdup(str);
+    control_string += strspn(control_string, " ");
+    name = control_string;
+    control_string += strcspn(str, ":=");
+    value = control_string;
+    *value = 0;
+    value++;
+
+    xbt_assert1(strlen(name) != 0, "Invalid name for configuration: '%s'",
+               name);
+    xbt_assert1(strlen(value) != 0,
+               "Invalid value for configuration: '%s'", value);
+    INFO2("setting '%s' to '%s'", name, value);
+
+    __sd_config_helper(name, value);
+
+    free(control_string_sav);
+  }
+  xbt_dynar_free(&set_strings);
+}
+
+static void sd_cfg_init(int *argc, char **argv)
+{
+  int i, j;
+  char *opt;
+
+  for (i = 1; i < *argc; i++) {
+    if (!strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
+      opt = strchr(argv[i], '=');
+      opt++;
+
+      sd_cfg_control_set(opt);
+      DEBUG1("Did apply '%s' as config setting", opt);
+      /*remove this from argv */
+
+      for (j = i + 1; j < *argc; j++) {
+       argv[j - 1] = argv[j];
+      }
+
+      argv[j - 1] = NULL;
+      (*argc)--;
+      i--;                     /* compensate effect of next loop incrementation */
+    }
+  }
+}
+
+/**
+ * \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) {
 
-  sg_global = xbt_new0(s_SG_global_t, 1);
-  sg_global->workstations = xbt_dict_new();
-  sg_global->workstation_count = 0;
+  s_SD_task_t task;
+  
+  xbt_assert0( !SD_INITIALISED() , "SD_init() already called");
+
+  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->link_count = 0;
+  sd_global->link_list = NULL;
+  sd_global->recyclable_route = NULL;
+  sd_global->watch_point_reached = 0;
+
+  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);
+  sd_cfg_init(argc, argv);
+}
+
+/**
+ * \brief Reinits the application part of the simulation (experimental feature)
+ * 
+ * This function allows you to run several simulations on the same platform 
+ * by resetting the part describing the application. 
+ * 
+ * @warning: this function is still experimental and not perfect. For example,
+ * the simulation clock (and traces usage) is not reset. So, do not use it if
+ * you use traces in your simulation, and do not use absolute timing after using it.
+ * That being said, this function is still precious if you want to compare a bunch of
+ * heuristics on the same platforms.
+ */
+void SD_application_reinit(void) {
+   
+  s_SD_task_t task;
+   
+  if (SD_INITIALISED()) {
+    DEBUG0("Recreating 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);
+
+    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;
+  } else {
+    WARN0("SD_application_reinit called before initialization of SimDag");
+    /* we cannot use exceptions here because xbt is not running! */
+  }
 
-  init_done = 1;
 }
 
-/* Creates the environnement described in a xml file of a platform descriptions.
+/**
+ * \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 simgrid.dtd
+ *
+ * Here is a small example of such a platform: 
+ *
+ *     \include small_platform.xml
  */
-void SG_create_environment(const char *platform_file) {
+void SD_create_environment(const char *platform_file) {
   xbt_dict_cursor_t cursor = NULL;
   char *name = NULL;
-  void *workstation = NULL;
+  void *surf_workstation = NULL;
+  void *surf_link = NULL;
+  char *workstation_model_name;
+  int workstation_id = -1;
+
+  SD_CHECK_INIT_DONE();
+
+  DEBUG0("SD_create_environment");
+
+  sd_config_init();
+  surf_timer_model_init(platform_file);
+
+  workstation_model_name =
+      xbt_cfg_get_string(_sd_cfg_set, "workstation_model");
 
-  CHECK_INIT_DONE();
-  surf_timer_resource_init(platform_file);
-  surf_workstation_resource_init_KCCFLN05(platform_file); /* tell Surf to create the environnement */
+  DEBUG1("Model : %s", workstation_model_name);
+  workstation_id =
+      find_model_description(surf_workstation_model_description,
+                               surf_workstation_model_description_size,
+                               workstation_model_name);
+  if (!strcmp(workstation_model_name, "compound")) {
+    xbt_ex_t e;
+    char *network_model_name = NULL;
+    char *cpu_model_name = NULL;
+    int network_id = -1;
+    int cpu_id = -1;
 
-  /* now let's create the SG wrappers */
-  xbt_dict_foreach(workstation_set, cursor, name, workstation) {
-    __SG_workstation_create(name, workstation, NULL);
+    TRY {
+      cpu_model_name = xbt_cfg_get_string(_sd_cfg_set, "cpu_model");
+    } CATCH(e) {
+      if (e.category == bound_error) {
+       xbt_assert0(0,
+                   "Set a cpu model to use with the 'compound' workstation model");
+       xbt_ex_free(e);
+      } else {
+       RETHROW;
+      }
+    }
+
+    TRY {
+      network_model_name =
+         xbt_cfg_get_string(_sd_cfg_set, "network_model");
+    }
+    CATCH(e) {
+      if (e.category == bound_error) {
+       xbt_assert0(0,
+                   "Set a network model to use with the 'compound' workstation model");
+       xbt_ex_free(e);
+      } else {
+       RETHROW;
+      }
+    }
+
+    network_id =
+       find_model_description(surf_network_model_description,
+                                 surf_network_model_description_size,
+                                 network_model_name);
+    cpu_id =
+       find_model_description(surf_cpu_model_description,
+                                 surf_cpu_model_description_size,
+                                 cpu_model_name);
+
+    surf_cpu_model_description[cpu_id].model_init(platform_file);
+    surf_network_model_description[network_id].model_init(platform_file);
+  }
+
+  DEBUG0("Call workstation_model_init");
+  surf_workstation_model_description[workstation_id].
+      model_init(platform_file);
+
+  parse_platform_file(platform_file);
+
+  _sd_init_status = 2;
+
+  /* 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(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 SG_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()
  */
-SG_task_t* SG_simulate(double how_long)
+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;
+  SD_task_t task, task_safe, 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;
+  unsigned int iter;
+  static int first_time = 1;
 
-  /* temporary test to access to the surf workstation structure */
-  xbt_dict_cursor_t cursor = NULL;
-  char *name = NULL;
-  void *workstation = NULL;
-  const char *surf_name;
-  int speed;
-
-  xbt_dict_foreach(workstation_set, cursor, name, workstation) {
-    surf_name = surf_workstation_resource->common_public->get_resource_name(workstation);
-    speed = surf_workstation_resource->extension_public->get_speed(workstation, 1.0);
-    printf("Workstation name: %s, Surf name: %s, speed: %d\n", name, surf_name, speed);
+  SD_CHECK_INIT_DONE();
+
+  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;
+  }
+
+  if(how_long>0) {
+    surf_timer_model->extension_public->set(surf_get_clock()+how_long,
+                                              NULL,NULL);
+  }
+  sd_global->watch_point_reached = 0;
+
+  /* explore the ready tasks */
+  xbt_swag_foreach_safe(task, task_safe, 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) {
+    surf_model_t model = NULL;
+    /* dumb variables */
+    void *fun = NULL;
+    void *arg = NULL;
+
+
+    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;
+
+    /* let's see which tasks are done */
+    xbt_dynar_foreach(model_list, iter, model) {
+      while ((action = xbt_swag_extract(model->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));
+       
+       /* 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;
+           }
+         }
+       }
+      }
+
+      /* let's see which tasks have just failed */
+      while ((action = xbt_swag_extract(model->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_model->common_public->action_free(action);
+       task->surf_action = NULL;
+       
+       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;
+       }
+      }
+    }
+
+    while (surf_timer_model->extension_public->get(&fun,(void*)&arg)) {
+    }
   }
 
-  return NULL;
+  /* we must reset every task->state_changed */
+  iter = 0;
+  while (changed_tasks[iter] != NULL) {
+    changed_tasks[iter]->state_changed = 0;
+    iter++;
+  }
+
+  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;
+}
+
+/**
+ * \brief Returns the current clock
+ *
+ * \return the current clock, in second
+ */
+double SD_get_clock(void) {
+  SD_CHECK_INIT_DONE();
+
+  return surf_get_clock();
 }
 
-/* Destroys all SG data. This function should be called when the simulation is over.
+/**
+ * \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 SG_clean() {
-  if (init_done) {
-    xbt_dict_free(&sg_global->workstations);
-    xbt_free(sg_global);
+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);
+
+    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();
-    /* TODO: destroy the workstations, the links and the tasks */
+  }
+  else {
+    WARN0("SD_exit() called, but SimDag is not running");
+    /* we cannot use exceptions here because xbt is not running! */
   }
 }