Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove unused type definitions.
[simgrid.git] / src / simdag / sd_global.cpp
index 93d7cb6..bc5f199 100644 (file)
-/* Copyright (c) 2006-2016. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2006-2019. 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 "instr/instr_interface.h"
-#include "simgrid/sg_config.h"
-#include "simgrid/host.h"
-#include "src/simdag/simdag_private.h"
+#include "simdag_private.hpp"
+#include "simgrid/kernel/resource/Action.hpp"
+#include "simgrid/kernel/resource/Model.hpp"
+#include "simgrid/s4u/Engine.hpp"
+#include "simgrid/sg_config.hpp"
 #include "src/surf/surf_interface.hpp"
-#include "simgrid/s4u/engine.hpp"
-
-#if HAVE_JEDULE
-#include "simgrid/jedule/jedule_sd_binding.h"
-#endif
 
 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 = nullptr;
+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>();
+}
+
+Global::~Global(){
+  delete initial_tasks;
+  delete runnable_tasks;
+  delete completed_tasks;
+  delete return_set;
+}
+
+std::set<SD_task_t>* simulate(double how_long){
+  XBT_VERB("Run simulation for %f seconds", how_long);
+
+  sd_global->watch_point_reached = false;
+  sd_global->return_set->clear();
+
+  /* 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) {
+
+    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 */
+    for (auto const& model : all_existing_models) {
+      simgrid::kernel::resource::Action* action = model->extract_done_action();
+      while (action != nullptr && action->get_data() != nullptr) {
+        SD_task_t task = static_cast<SD_task_t>(action->get_data());
+        XBT_VERB("Task '%s' done", SD_task_get_name(task));
+        SD_task_set_state(task, SD_DONE);
+
+        /* 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);
+
+        /* 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());
+
+          if (SD_task_get_state(succ) == SD_NOT_SCHEDULED && succ->predecessors->empty())
+            SD_task_set_state(succ, SD_SCHEDULABLE);
+
+          if (SD_task_get_state(succ) == SD_SCHEDULED && succ->predecessors->empty() && succ->inputs->empty())
+            SD_task_set_state(succ, SD_RUNNABLE);
+
+          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 = model->extract_done_action();
+      }
+
+      /* let's see which tasks have just failed */
+      action = model->extract_failed_action();
+      while (action != nullptr) {
+        SD_task_t task = static_cast<SD_task_t>(action->get_data());
+        XBT_VERB("Task '%s' failed", SD_task_get_name(task));
+        SD_task_set_state(task, SD_FAILED);
+        sd_global->return_set->insert(task);
+        action = model->extract_failed_action();
+      }
+    }
+  }
+
+  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 helper for pretty printing of task state
+ * @param state the state of a task
+ * @return the equivalent as a readable string
+ */
+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 Initializes SD internal data
+ * @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()
+ * @param argc argument number
+ * @param argv argument list
+ * @see SD_create_environment(), SD_exit()
  */
-void SD_init(int *argc, char **argv)
+void SD_init_nocheck(int *argc, char **argv)
 {
-  TRACE_global_init(argc, argv);
-
   xbt_assert(sd_global == nullptr, "SD_init() already called");
 
-  sd_global = xbt_new(s_SD_global_t, 1);
-  sd_global->watch_point_reached = 0;
-
-  sd_global->task_mallocator=xbt_mallocator_new(65536, SD_task_new_f, SD_task_free_f, SD_task_recycle_f);
-
-  sd_global->initial_tasks = new std::set<SD_task_t>();
-  sd_global->executable_tasks = new std::set<SD_task_t>();
-  sd_global->completed_tasks = new std::set<SD_task_t>();
-  sd_global->return_set = xbt_dynar_new(sizeof(SD_task_t), nullptr);
+  sd_global = new simgrid::sd::Global();
 
   surf_init(argc, argv);
 
-  xbt_cfg_setdefault_string("host/model", "ptask_L07");
-
-#if HAVE_JEDULE
-  jedule_sd_init();
-#endif
-
+  simgrid::config::set_default<std::string>("host/model", "ptask_L07");
+  if (simgrid::config::get_value<bool>("clean-atexit"))
+    atexit(SD_exit);
   if (_sg_cfg_exit_asap) {
-    SD_exit();
     exit(0);
   }
 }
 
-/** \brief set a configuration variable
+/** @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");
+ * 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);
+  simgrid::config::set_as_string(key, value);
 }
 
 /**
- * \brief Creates the environment
+ * @brief Creates the environment
  *
- * The environment (i.e. the \ref SD_host_api "hosts" and the \ref SD_link_api "links") is created with
+ * 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 SD_host_api, SD_link_api
+ * @param platform_file name of an XML file describing the environment to create
+ * @see SD_host_api, SD_link_api
  *
  * The XML file follows this DTD:
  *
- *     \include simgrid.dtd
+ *     @include simgrid.dtd
  *
  * Here is a small example of such a platform:
  *
- *     \include small_platform.xml
+ *     @include small_platform.xml
  */
 void SD_create_environment(const char *platform_file)
 {
-  simgrid::s4u::Engine::instance()->loadPlatform(platform_file);
+  simgrid::s4u::Engine::get_instance()->load_platform(platform_file);
 
-  XBT_DEBUG("Workstation number: %zu, link number: %d", sg_host_count(), sg_link_count());
-#if 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.
+ * @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
+ * 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
+ * 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)
- * \return a dynar of \ref SD_task_t whose state has changed.
- * \see SD_task_schedule(), SD_task_watch()
+ * @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;
-  SD_task_t task, dst;
-  surf_action_t action;
-  unsigned int iter;
-
-  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 */
-  std::set<SD_task_t>::iterator it=sd_global->executable_tasks->begin();
-  while(it != sd_global->executable_tasks->end()){
-    task = *it;
-    it++;
-    XBT_VERB("Executing task '%s'", SD_task_get_name(task));
-    SD_task_run(task);
-    xbt_dynar_push(sd_global->return_set, &task);
-  }
-
-  /* main loop */
-  double 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 = nullptr;
-
-    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 = static_cast<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 = nullptr;
-
-        /* the state has changed. Add it only if it's the first change */
-        if (xbt_dynar_member(sd_global->return_set, &task) == 0) {
-          xbt_dynar_push(sd_global->return_set, &task);
-        }
-
-        /* remove the dependencies after this task */
-        for (std::set<SD_task_t>::iterator it=task->successors->begin(); it!=task->successors->end(); ++it){
-          dst=*it;
-          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 == 0) {
-            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 == 0) {
-            SD_task_set_state(dst, SD_SCHEDULABLE);
-          }
-          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);
-          }
-        }
-
-        for (std::set<SD_task_t>::iterator it=task->outputs->begin(); it!=task->outputs->end(); ++it){
-          dst=*it;
-          dst->unsatisfied_dependencies = 0;
-          dst->is_not_ready = 0;
-          if (SD_task_get_state(dst) == SD_SCHEDULED)
-             SD_task_set_state(dst, SD_RUNNABLE);
-          else
-             SD_task_set_state(dst, SD_SCHEDULABLE);
-          SD_task_t comm_dst = *(dst->successors->begin());
-          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 == 0) {
-              SD_task_set_state(comm_dst, SD_SCHEDULABLE);
-            }
-          }
-          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 = static_cast<SD_task_t>(action->getData());
-        task->start_time = task->surf_action->getStartTime();
-        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 = nullptr;
-
-        xbt_dynar_push(sd_global->return_set, &task);
-      }
-    }
-  }
-
-  if (!sd_global->watch_point_reached && how_long<0 && !sd_global->initial_tasks->empty()) {
-    XBT_WARN("Simulation is finished but %zu tasks are still not done", sd_global->initial_tasks->size());
-    static const char* state_names[] =
-      { "SD_NOT_SCHEDULED", "SD_SCHEDULABLE", "SD_SCHEDULED", "SD_RUNNABLE", "SD_RUNNING", "SD_DONE","SD_FAILED" };
-    for (std::set<SD_task_t>::iterator it=sd_global->initial_tasks->begin();
-         it!=sd_global->initial_tasks->end(); ++it){
-      task = *it;
-      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, in seconds */
@@ -258,26 +242,14 @@ double SD_get_clock() {
 }
 
 /**
- * \brief Destroys all SD internal data
- *
+ * @brief Destroys all SD internal data
  * This function should be called when the simulation is over. Don't forget to destroy too.
- *
- * \see SD_init(), SD_task_destroy()
+ * @see SD_init(), SD_task_destroy()
  */
 void SD_exit()
 {
-  TRACE_surf_resource_utilization_release();
-
-#if HAVE_JEDULE
-  jedule_sd_cleanup();
+#if SIMGRID_HAVE_JEDULE
   jedule_sd_exit();
 #endif
-
-  xbt_mallocator_free(sd_global->task_mallocator);
-  delete sd_global->initial_tasks;
-  delete sd_global->executable_tasks;
-  delete sd_global->completed_tasks;
-  xbt_dynar_free_container(&(sd_global->return_set));
-  xbt_free(sd_global);
-  sd_global = nullptr;
+  delete sd_global;
 }