src/simdag/sd_global.cpp

   1 /* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simdag_private.hpp"
   7 #include "simgrid/kernel/resource/Action.hpp"
   8 #include "simgrid/kernel/resource/Model.hpp"
   9 #include "simgrid/s4u/Engine.hpp"
  10 #include "simgrid/sg_config.hpp"
  11 #include "src/kernel/EngineImpl.hpp"
  12 #include "src/surf/surf_interface.hpp"
  13
  14 #include <array>
  15
  16 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd, "Logging specific to SimDag (kernel)");
  18
  19 std::unique_ptr<simgrid::sd::Global> sd_global = nullptr;
  20
  21 namespace simgrid {
  22 namespace sd {
  23
  24 std::set<Task*>* simulate(double how_long)
  25 {
  26   XBT_VERB("Run simulation for %f seconds", how_long);
  27
  28   auto engine = sd_global->engine_->get_impl();
  29   sd_global->watch_point_reached = false;
  30   sd_global->return_set.clear();
  31
  32   /* explore the runnable tasks */
  33   while (not sd_global->runnable_tasks.empty())
  34     (*(sd_global->runnable_tasks.begin()))->run();
  35
  36   double elapsed_time = 0.0;
  37   double total_time   = 0.0;
  38   /* main loop */
  39   while (elapsed_time >= 0 && (how_long < 0 || 0.00001 < (how_long - total_time)) &&
  40          not sd_global->watch_point_reached) {
  41     XBT_DEBUG("Total time: %f", total_time);
  42
  43     elapsed_time = engine->solve(how_long > 0 ? simgrid_get_clock() + how_long - total_time : -1.0);
  44     XBT_DEBUG("solve() returns %f", elapsed_time);
  45     if (elapsed_time > 0.0)
  46       total_time += elapsed_time;
  47
  48     /* let's see which tasks are done */
  49     for (auto const& model : engine->get_all_models()) {
  50       const kernel::resource::Action* action = model->extract_done_action();
  51       while (action != nullptr && action->get_data() != nullptr) {
  52         auto* task = static_cast<Task*>(action->get_data());
  53         XBT_VERB("Task '%s' done", task->get_cname());
  54         task->set_state(SD_DONE);
  55
  56         /* the state has changed. Add it only if it's the first change */
  57         sd_global->return_set.emplace(task);
  58
  59         /* remove the dependencies after this task */
  60         for (auto const& succ : task->get_successors())
  61           succ->released_by(task);
  62
  63         for (auto const& output : task->get_outputs())
  64           output->produced_by(task);
  65         task->clear_successors();
  66         action = model->extract_done_action();
  67       }
  68
  69       /* let's see which tasks have just failed */
  70       action = model->extract_failed_action();
  71       while (action != nullptr) {
  72         auto* task = static_cast<Task*>(action->get_data());
  73         XBT_VERB("Task '%s' failed", task->get_cname());
  74         task->set_state(SD_FAILED);
  75         sd_global->return_set.insert(task);
  76         action = model->extract_failed_action();
  77       }
  78     }
  79   }
  80
  81   if (not sd_global->watch_point_reached && how_long < 0 && not sd_global->initial_tasks.empty()) {
  82     XBT_WARN("Simulation is finished but %zu tasks are still not done", sd_global->initial_tasks.size());
  83     for (auto const& t : sd_global->initial_tasks)
  84       XBT_WARN("%s is in %s state", t->get_cname(), __get_state_name(t->get_state()));
  85   }
  86
  87   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d", elapsed_time, total_time,
  88             sd_global->watch_point_reached);
  89   XBT_DEBUG("current time = %f", simgrid_get_clock());
  90
  91   return &sd_global->return_set;
  92 }
  93 } // namespace sd
  94 } // namespace simgrid
  95
  96 /**
  97  * @brief helper for pretty printing of task state
  98  * @param state the state of a task
  99  * @return the equivalent as a readable string
 100  */
 101 const char* __get_state_name(e_SD_task_state_t state)
 102 {
 103   static constexpr std::array<const char*, 7> state_names{
 104       {"not scheduled", "schedulable", "scheduled", "runnable", "running", "done", "failed"}};
 105   return state_names.at(static_cast<int>(log2(static_cast<double>(state))));
 106 }
 107
 108 /**
 109  * @brief Initializes SD internal data
 110  *
 111  * This function must be called before any other SD function. Then you should call SD_create_environment().
 112  *
 113  * @param argc argument number
 114  * @param argv argument list
 115  * @see SD_create_environment(), SD_exit()
 116  */
 117 void SD_init_nocheck(int* argc, char** argv)
 118 {
 119   xbt_assert(sd_global == nullptr, "SD_init() already called");
 120
 121   sd_global = std::make_unique<simgrid::sd::Global>(argc, argv);
 122
 123   simgrid::config::set_default<std::string>("host/model", "ptask_L07");
 124   if (simgrid::config::get_value<bool>("debug/clean-atexit"))
 125     atexit([]() {
 126 #if SIMGRID_HAVE_JEDULE
 127       jedule_sd_exit();
 128 #endif
 129       sd_global->engine_->shutdown();
 130     });
 131 }
 132
 133 /** @brief set a configuration variable
 134  *
 135  * Do --help on any simgrid binary to see the list of currently existing configuration variables, and
 136  * see Section @ref options.
 137  *
 138  * Example: SD_config("host/model","default")
 139  */
 140 void SD_config(const char* key, const char* value)
 141 {
 142   xbt_assert(sd_global, "ERROR: Please call SD_init() before using SD_config()");
 143   simgrid::config::set_as_string(key, value);
 144 }
 145
 146 /**
 147  * @brief Creates the environment
 148  *
 149  * The environment (i.e. the @ref SD_host_api "hosts" and the @ref SD_link_api "links") is created with
 150  * the data stored in the given XML platform file.
 151  *
 152  * @param platform_file name of an XML file describing the environment to create
 153  * @see SD_host_api, SD_link_api
 154  *
 155  * The XML file follows this DTD:
 156  *
 157  *     @include simgrid.dtd
 158  *
 159  * Here is a small example of such a platform:
 160  *
 161  *     @include small_platform.xml
 162  */
 163 void SD_create_environment(const char* platform_file)
 164 {
 165   sd_global->engine_->load_platform(platform_file);
 166
 167   XBT_DEBUG("Host number: %zu, link number: %zu", sg_host_count(), sg_link_count());
 168 #if SIMGRID_HAVE_JEDULE
 169   jedule_sd_init();
 170 #endif
 171   XBT_VERB("Starting simulation...");
 172   sd_global->engine_->get_impl()->presolve(); /* Takes traces into account */
 173 }
 174
 175 /**
 176  * @brief Launches the simulation.
 177  *
 178  * The function will execute the @ref SD_RUNNABLE runnable tasks.
 179  * If @a how_long is positive, then the simulation will be stopped either when time reaches @a how_long or when a watch
 180  * point is reached.
 181  * A non-positive value for @a how_long means no time limit, in which case the simulation will be stopped either when a
 182  * watch point is reached or when no more task can be executed.
 183  * Then you can call SD_simulate() again.
 184  *
 185  * @param how_long maximum duration of the simulation (a negative value means no time limit)
 186  * @return a dynar of @ref SD_task_t whose state has changed.
 187  * @see SD_task_schedule(), SD_task_watch()
 188  */
 189 void SD_simulate(double how_long)
 190 {
 191   simgrid::sd::simulate(how_long);
 192 }
 193
 194 void SD_simulate_with_update(double how_long, xbt_dynar_t changed_tasks_dynar)
 195 {
 196   const std::set<SD_task_t>* changed_tasks = simgrid::sd::simulate(how_long);
 197   for (auto const& task : *changed_tasks)
 198     xbt_dynar_push(changed_tasks_dynar, &task);
 199 }