Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid
[simgrid.git] / src / simdag / sd_global.cpp
index 79d0cbf..88656c0 100644 (file)
-/* Copyright (c) 2006-2016. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2006-2017. The SimGrid Team. 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. */
 
-#include "src/surf/surf_interface.hpp"
-#include "src/simdag/simdag_private.h"
-#include "instr/instr_interface.h"
-#include "xbt/sysdep.h"
-#include "xbt/dynar.h"
-#include "surf/surf.h"
+#include "simdag_private.hpp"
+#include "simgrid/s4u/Engine.hpp"
 #include "simgrid/sg_config.h"
-#include "simgrid/host.h"
-#include "xbt/ex.h"
-#include "xbt/log.h"
-#include "xbt/str.h"
-#include "xbt/config.h"
-#include "surf/surfxml_parse.h"
-#ifdef HAVE_LUA
-#include <lua.h>
-#include <lauxlib.h>
-#include <lualib.h>
-#endif
-
-#ifdef HAVE_JEDULE
-#include "simgrid/jedule/jedule_sd_binding.h"
-#endif
+#include "src/include/instr/instr_interface.h"
+#include "src/surf/surf_interface.hpp"
 
 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd,
-                                "Logging specific to SimDag (kernel)");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd, "Logging specific to SimDag (kernel)");
+
+simgrid::sd::Global *sd_global = nullptr;
+
+namespace simgrid{
+namespace sd{
+Global::Global(){
+  watch_point_reached = false;
+  initial_tasks = new std::set<SD_task_t>();
+  runnable_tasks = new std::set<SD_task_t>();
+  completed_tasks = new std::set<SD_task_t>();
+  return_set = new std::set<SD_task_t>();
+}
 
-SD_global_t sd_global = NULL;
+Global::~Global(){
+  delete initial_tasks;
+  delete runnable_tasks;
+  delete completed_tasks;
+  delete return_set;
+}
 
-/**
- * \brief Initializes 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)
-{
-  TRACE_global_init(argc, argv);
+std::set<SD_task_t>* simulate(double how_long){
+  XBT_VERB("Run simulation for %f seconds", how_long);
 
-  xbt_assert(sd_global == NULL, "SD_init() already called");
+  sd_global->watch_point_reached = false;
+  sd_global->return_set->clear();
 
-  sd_global = xbt_new(s_SD_global_t, 1);
-  sd_global->host_list = NULL;
-  sd_global->link_list = NULL;
-  sd_global->recyclable_route = NULL;
-  sd_global->watch_point_reached = 0;
+  /* explore the runnable tasks */
+  while (not sd_global->runnable_tasks->empty())
+    SD_task_run(*(sd_global->runnable_tasks->begin()));
+
+  double elapsed_time = 0.0;
+  double total_time = 0.0;
+  /* main loop */
+  while (elapsed_time >= 0 && (how_long < 0 || 0.00001 < (how_long - total_time)) &&
+         not sd_global->watch_point_reached) {
 
-  sd_global->task_mallocator=xbt_mallocator_new(65536, SD_task_new_f,
-                                                SD_task_free_f,
-                                                SD_task_recycle_f);
+    XBT_DEBUG("Total time: %f", total_time);
 
-  sd_global->initial_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
-  sd_global->executable_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
-  sd_global->completed_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
-  sd_global->return_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
+    elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
+    XBT_DEBUG("surf_solve() returns %f", elapsed_time);
+    if (elapsed_time > 0.0)
+      total_time += elapsed_time;
 
-  sd_global->task_number = 0;
+    /* let's see which tasks are done */
+    for (auto const& model : *all_existing_models) {
+      surf_action_t action = surf_model_extract_done_action_set(model);
+      while (action != nullptr) {
+        SD_task_t task = static_cast<SD_task_t>(action->getData());
+        XBT_VERB("Task '%s' done", SD_task_get_name(task));
+        SD_task_set_state(task, SD_DONE);
 
-  surf_init(argc, argv);
+        /* the state has changed. Add it only if it's the first change */
+        if (sd_global->return_set->find(task) == sd_global->return_set->end())
+          sd_global->return_set->insert(task);
 
-  xbt_cfg_setdefault_string(_sg_cfg_set, "host/model",
-                            "ptask_L07");
+        /* remove the dependencies after this task */
+        for (auto const& succ : *task->successors) {
+          succ->predecessors->erase(task);
+          succ->inputs->erase(task);
+          XBT_DEBUG("Release dependency on %s: %zu remain(s). Becomes schedulable if %zu=0", SD_task_get_name(succ),
+              succ->predecessors->size()+succ->inputs->size(), succ->predecessors->size());
 
-#ifdef HAVE_JEDULE
-  jedule_sd_init();
-#endif
+          if (SD_task_get_state(succ) == SD_NOT_SCHEDULED && succ->predecessors->empty())
+            SD_task_set_state(succ, SD_SCHEDULABLE);
 
-  XBT_DEBUG("ADD SD LEVELS");
-  SD_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,__SD_storage_destroy);
+          if (SD_task_get_state(succ) == SD_SCHEDULED && succ->predecessors->empty() && succ->inputs->empty())
+            SD_task_set_state(succ, SD_RUNNABLE);
 
-  if (_sg_cfg_exit_asap) {
-    SD_exit();
-    exit(0);
+          if (SD_task_get_state(succ) == SD_RUNNABLE && not sd_global->watch_point_reached)
+            SD_task_run(succ);
+        }
+        task->successors->clear();
+
+        for (auto const& output : *task->outputs) {
+          output->start_time = task->finish_time;
+          output->predecessors->erase(task);
+          if (SD_task_get_state(output) == SD_SCHEDULED)
+             SD_task_set_state(output, SD_RUNNABLE);
+          else
+             SD_task_set_state(output, SD_SCHEDULABLE);
+
+          SD_task_t comm_dst = *(output->successors->begin());
+          if (SD_task_get_state(comm_dst) == SD_NOT_SCHEDULED && comm_dst->predecessors->empty()){
+            XBT_DEBUG("%s is a transfer, %s may be ready now if %zu=0",
+                SD_task_get_name(output), SD_task_get_name(comm_dst), comm_dst->predecessors->size());
+            SD_task_set_state(comm_dst, SD_SCHEDULABLE);
+          }
+          if (SD_task_get_state(output) == SD_RUNNABLE && not sd_global->watch_point_reached)
+            SD_task_run(output);
+        }
+        task->outputs->clear();
+        action = surf_model_extract_done_action_set(model);
+      }
+
+      /* let's see which tasks have just failed */
+      action = surf_model_extract_failed_action_set(model);
+      while (action != nullptr) {
+        SD_task_t task = static_cast<SD_task_t>(action->getData());
+        XBT_VERB("Task '%s' failed", SD_task_get_name(task));
+        SD_task_set_state(task, SD_FAILED);
+        sd_global->return_set->insert(task);
+        action = surf_model_extract_failed_action_set(model);
+      }
+    }
   }
+
+  if (not sd_global->watch_point_reached && how_long < 0 && not sd_global->initial_tasks->empty()) {
+    XBT_WARN("Simulation is finished but %zu tasks are still not done", sd_global->initial_tasks->size());
+    for (auto const& t : *sd_global->initial_tasks)
+      XBT_WARN("%s is in %s state", SD_task_get_name(t), __get_state_name(SD_task_get_state(t)));
+  }
+
+  XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
+             elapsed_time, total_time, sd_global->watch_point_reached);
+  XBT_DEBUG("current time = %f", surf_get_clock());
+
+  return sd_global->return_set;
+}
+}
 }
 
-/** \brief set a configuration variable
- *
- * Do --help on any simgrid binary to see the list of currently existing
- * configuration variables, and see Section @ref options.
- *
- * Example:
- * SD_config("host/model","default");
+/**
+ * \brief helper for pretty printing of task state
+ * \param state the state of a task
+ * \return the equivalent as a readable string
  */
-void SD_config(const char *key, const char *value){
-  xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
-  xbt_cfg_set_as_string(_sg_cfg_set, key, value);
+const char *__get_state_name(e_SD_task_state_t state){
+  static std::string state_names[7] =
+    { "not scheduled", "schedulable", "scheduled", "runnable","running", "done", "failed" };
+  return state_names[static_cast<int>(log2(static_cast<double>(state)))].data();
 }
 
-
 /**
- * \brief Reinits the application part of the simulation (experimental feature)
+ * \brief Initializes SD internal data
  *
- * This function allows you to run several simulations on the same platform
- * by resetting the part describing the application.
+ * This function must be called before any other SD function. Then you should call SD_create_environment().
  *
- * @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.
+ * \param argc argument number
+ * \param argv argument list
+ * \see SD_create_environment(), SD_exit()
  */
-void SD_application_reinit(void)
+void SD_init_nocheck(int *argc, char **argv)
 {
+  xbt_assert(sd_global == nullptr, "SD_init() already called");
 
-//  s_SD_task_t task;
-
-//  SD_task_t done_task, next_done_task;
-  xbt_die("This function is not working since the C++ links and others. Please report the problem if you really need that function.");
-
-   XBT_DEBUG("Recreating the swags...");
-
-//  xbt_swag_foreach_safe(done_task, next_done_task, sd_global->done_task_set){
-//    if (xbt_dynar_is_empty(done_task->tasks_before)){
-//      __SD_task_set_state(done_task, SD_SCHEDULABLE);
-//    } else{
-//      __SD_task_set_state(done_task, SD_NOT_SCHEDULED);
-//      done_task->unsatisfied_dependencies =
-//        xbt_dynar_length(done_task->tasks_before);
-//      done_task->is_not_ready = done_task->unsatisfied_dependencies;
-//    }
-//    free(done_task->workstation_list);
-//    done_task->workstation_list = NULL;
-//    done_task->workstation_nb = 0;
-//  }
+  sd_global = new simgrid::sd::Global();
 
-  sd_global->task_number = 0;
+  surf_init(argc, argv);
 
+  xbt_cfg_setdefault_string("host/model", "ptask_L07");
+  if(xbt_cfg_get_boolean("clean-atexit"))
+    atexit(SD_exit);
+  if (_sg_cfg_exit_asap) {
+    exit(0);
+  }
+}
 
-#ifdef HAVE_JEDULE
-  jedule_sd_dump();
-  jedule_sd_cleanup();
-  jedule_sd_init();
-#endif
+/** \brief set a configuration variable
+ *
+ * Do --help on any simgrid binary to see the list of currently existing configuration variables, and
+ * see Section @ref options.
+ *
+ * Example: SD_config("host/model","default")
+ */
+void SD_config(const char *key, const char *value){
+  xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
+  xbt_cfg_set_as_string(key, value);
 }
 
 /**
  * \brief Creates the environment
  *
- * The environment (i.e. the \ref sg_host_management "hosts"
- * and the \ref SD_link_management "links") is created with the data stored
- * in the given XML platform file.
+ * The environment (i.e. the \ref SD_host_api "hosts" and the \ref SD_link_api "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 sg_host_management, SD_link_management
+ * \see SD_host_api, SD_link_api
  *
  * The XML file follows this DTD:
  *
@@ -165,242 +199,57 @@ void SD_application_reinit(void)
  */
 void SD_create_environment(const char *platform_file)
 {
-  xbt_lib_cursor_t cursor = NULL;
-  char *name = NULL;
-  void **surf_storage = NULL;
-
-  parse_platform_file(platform_file);
-
-  /* now let's create the SD wrappers for storage elements */
-  xbt_lib_foreach(storage_lib, cursor, name, surf_storage) {
-    if(surf_storage[SURF_STORAGE_LEVEL])
-      __SD_storage_create(surf_storage[SURF_STORAGE_LEVEL], NULL);
-  }
+  simgrid::s4u::Engine::getInstance()->loadPlatform(platform_file);
 
-  XBT_DEBUG("Workstation number: %zu, link number: %d",
-         sg_host_count(), sg_link_count());
-#ifdef HAVE_JEDULE
-  jedule_setup_platform();
+  XBT_DEBUG("Host number: %zu, link number: %d", sg_host_count(), sg_link_count());
+#if SIMGRID_HAVE_JEDULE
+  jedule_sd_init();
 #endif
+  XBT_VERB("Starting simulation...");
+  surf_presolve();            /* Takes traces into account */
 }
 
 /**
  * \brief Launches the simulation.
  *
  * The function will execute the \ref SD_RUNNABLE runnable tasks.
- * If \a how_long is positive, then the simulation will be stopped either
- * when time reaches \a how_long or when a watch point is reached.
- * A non-positive value for \a how_long means no time limit, in which case
- * the simulation will be stopped either when a watch point is reached or
- * when no more task can be executed.
+ * If \a how_long is positive, then the simulation will be stopped either when time reaches \a how_long or when a watch
+ * point is reached.
+ * A non-positive value for \a how_long means no time limit, in which case the simulation will be stopped either 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)
+ * \param how_long maximum duration of the simulation (a negative value means no time limit)
  * \return a dynar of \ref SD_task_t whose state has changed.
  * \see SD_task_schedule(), SD_task_watch()
  */
+void SD_simulate(double how_long)
+{
+  simgrid::sd::simulate(how_long);
+}
 
-xbt_dynar_t SD_simulate(double how_long) {
-  /* we stop the simulation when total_time >= how_long */
-  double total_time = 0.0;
-  double elapsed_time = 0.0;
-  SD_task_t task, dst;
-  SD_dependency_t dependency;
-  surf_action_t action;
-  unsigned int iter, depcnt;
-  static int first_time = 1;
-
-  if (first_time) {
-    XBT_VERB("Starting simulation...");
-
-    surf_presolve();            /* Takes traces into account */
-    first_time = 0;
-  }
-
-  XBT_VERB("Run simulation for %f seconds", how_long);
-  sd_global->watch_point_reached = 0;
-
-  xbt_dynar_reset(sd_global->return_set);
-
-  /* explore the runnable tasks */
-  xbt_dynar_foreach(sd_global->executable_task_set , iter, task) {
-    XBT_VERB("Executing task '%s'", SD_task_get_name(task));
-    SD_task_run(task);
-    xbt_dynar_push(sd_global->return_set, &task);
-    iter--;
-  }
-
-  /* main loop */
-  elapsed_time = 0.0;
-  while (elapsed_time >= 0.0 &&
-         (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
-         !sd_global->watch_point_reached) {
-    surf_model_t model = NULL;
-    /* dumb variables */
-
-
-    XBT_DEBUG("Total time: %f", total_time);
-
-    elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
-    XBT_DEBUG("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(all_existing_models, iter, model) {
-      while ((action = surf_model_extract_done_action_set(model))) {
-        task = (SD_task_t) action->getData();
-        task->start_time = task->surf_action->getStartTime();
-
-        task->finish_time = surf_get_clock();
-        XBT_VERB("Task '%s' done", SD_task_get_name(task));
-        SD_task_set_state(task, SD_DONE);
-        task->surf_action->unref();
-        task->surf_action = NULL;
-
-        /* the state has changed. Add it only if it's the first change */
-        if (xbt_dynar_search_or_negative(sd_global->return_set, &task) < 0) {
-          xbt_dynar_push(sd_global->return_set, &task);
-        }
-
-        /* remove the dependencies after this task */
-        xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
-          dst = dependency->dst;
-          if (dst->unsatisfied_dependencies > 0)
-            dst->unsatisfied_dependencies--;
-          if (dst->is_not_ready > 0)
-            dst->is_not_ready--;
-
-          XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
-             SD_task_get_name(dst), dst->unsatisfied_dependencies,
-             dst->is_not_ready);
-
-          if (!(dst->unsatisfied_dependencies)) {
-            if (SD_task_get_state(dst) == SD_SCHEDULED)
-              SD_task_set_state(dst, SD_RUNNABLE);
-            else
-              SD_task_set_state(dst, SD_SCHEDULABLE);
-          }
-
-          if (SD_task_get_state(dst) == SD_NOT_SCHEDULED &&
-              !(dst->is_not_ready)) {
-            SD_task_set_state(dst, SD_SCHEDULABLE);
-          }
-
-          if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
-            SD_dependency_t comm_dep;
-            SD_task_t comm_dst;
-            xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
-            comm_dst = comm_dep->dst;
-            if (SD_task_get_state(comm_dst) == SD_NOT_SCHEDULED &&
-                comm_dst->is_not_ready > 0) {
-              comm_dst->is_not_ready--;
-
-            XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
-               SD_task_get_name(dst), SD_task_get_name(comm_dst),
-               comm_dst->is_not_ready);
-
-              if (!(comm_dst->is_not_ready)) {
-                SD_task_set_state(comm_dst, SD_SCHEDULABLE);
-              }
-            }
-          }
-
-          /* is dst runnable now? */
-          if (SD_task_get_state(dst) == SD_RUNNABLE
-              && !sd_global->watch_point_reached) {
-            XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
-            SD_task_run(dst);
-            xbt_dynar_push(sd_global->return_set, &dst);
-          }
-        }
-      }
-
-      /* let's see which tasks have just failed */
-      while ((action = surf_model_extract_failed_action_set(model))) {
-        task = (SD_task_t) action->getData();
-        task->start_time = surf_action_get_start_time(task->surf_action);
-        task->finish_time = surf_get_clock();
-        XBT_VERB("Task '%s' failed", SD_task_get_name(task));
-        SD_task_set_state(task, SD_FAILED);
-        action->unref();
-        task->surf_action = NULL;
-
-        xbt_dynar_push(sd_global->return_set, &task);
-      }
-    }
-  }
-
-  if (!sd_global->watch_point_reached && how_long<0){
-    if ((int) xbt_dynar_length(sd_global->completed_task_set) <
-         sd_global->task_number){
-        XBT_WARN("Simulation is finished but %d tasks are still not done",
-            (sd_global->task_number -
-             (int) xbt_dynar_length(sd_global->completed_task_set)));
-        static const char* state_names[] =
-              { "SD_NOT_SCHEDULED", "SD_SCHEDULABLE", "SD_SCHEDULED",
-                "SD_RUNNABLE", "SD_RUNNING", "SD_DONE",
-                "SD_FAILED" };
-        xbt_dynar_foreach(sd_global->initial_task_set, iter, task){
-          XBT_WARN("%s is in %s state", SD_task_get_name(task),
-                   state_names[SD_task_get_state(task)]);
-        }
-    }
-  }
-
-  XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
-         elapsed_time, total_time, sd_global->watch_point_reached);
-  XBT_DEBUG("current time = %f", surf_get_clock());
-
-  return sd_global->return_set;
+void SD_simulate_with_update(double how_long, xbt_dynar_t changed_tasks_dynar)
+{
+  std::set<SD_task_t> *changed_tasks = simgrid::sd::simulate(how_long);
+  for (auto const& task : *changed_tasks)
+    xbt_dynar_push(changed_tasks_dynar, &task);
 }
 
-/**
- * \brief Returns the current clock
- *
- * \return the current clock, in second
- */
-double SD_get_clock(void) {
+/** @brief Returns the current clock, in seconds */
+double SD_get_clock() {
   return surf_get_clock();
 }
 
 /**
  * \brief Destroys all SD internal data
- *
- * This function should be called when the simulation is over. Don't forget
- * to destroy too.
- *
+ * This function should be called when the simulation is over. Don't forget to destroy too.
  * \see SD_init(), SD_task_destroy()
  */
-void SD_exit(void)
+void SD_exit()
 {
-  TRACE_surf_resource_utilization_release();
-
-  xbt_mallocator_free(sd_global->task_mallocator);
-
-  XBT_DEBUG("Destroying workstation and link arrays...");
-  xbt_free(sd_global->host_list);
-  xbt_free(sd_global->link_list);
-  xbt_free(sd_global->recyclable_route);
-
-  XBT_DEBUG("Destroying the dynars ...");
-  xbt_dynar_free_container(&(sd_global->initial_task_set));
-  xbt_dynar_free_container(&(sd_global->executable_task_set));
-  xbt_dynar_free_container(&(sd_global->completed_task_set));
-  xbt_dynar_free_container(&(sd_global->return_set));
-
   TRACE_end();
-
-  xbt_free(sd_global);
-  sd_global = NULL;
-
-#ifdef HAVE_JEDULE
-  jedule_sd_dump();
-  jedule_sd_cleanup();
+#if SIMGRID_HAVE_JEDULE
   jedule_sd_exit();
 #endif
-
-  XBT_DEBUG("Exiting Surf...");
-  surf_exit();
+  delete sd_global;
 }