src/simdag/sd_global.cpp

   1 /* Copyright (c) 2006-2020. 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/surf/surf_interface.hpp"
  12
  13 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd, "Logging specific to SimDag (kernel)");
  15
  16 simgrid::sd::Global *sd_global = nullptr;
  17
  18 namespace simgrid{
  19 namespace sd{
  20
  21 std::set<SD_task_t>* simulate(double how_long){
  22   XBT_VERB("Run simulation for %f seconds", how_long);
  23
  24   sd_global->watch_point_reached = false;
  25   sd_global->return_set.clear();
  26
  27   /* explore the runnable tasks */
  28   while (not sd_global->runnable_tasks.empty())
  29     SD_task_run(*(sd_global->runnable_tasks.begin()));
  30
  31   double elapsed_time = 0.0;
  32   double total_time = 0.0;
  33   /* main loop */
  34   while (elapsed_time >= 0 && (how_long < 0 || 0.00001 < (how_long - total_time)) &&
  35          not sd_global->watch_point_reached) {
  36     XBT_DEBUG("Total time: %f", total_time);
  37
  38     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
  39     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
  40     if (elapsed_time > 0.0)
  41       total_time += elapsed_time;
  42
  43     /* let's see which tasks are done */
  44     for (auto const& model : all_existing_models) {
  45       const simgrid::kernel::resource::Action* action = model->extract_done_action();
  46       while (action != nullptr && action->get_data() != nullptr) {
  47         SD_task_t task = static_cast<SD_task_t>(action->get_data());
  48         XBT_VERB("Task '%s' done", SD_task_get_name(task));
  49         SD_task_set_state(task, SD_DONE);
  50
  51         /* the state has changed. Add it only if it's the first change */
  52         if (sd_global->return_set.find(task) == sd_global->return_set.end())
  53           sd_global->return_set.insert(task);
  54
  55         /* remove the dependencies after this task */
  56         for (auto const& succ : *task->successors) {
  57           succ->predecessors->erase(task);
  58           succ->inputs->erase(task);
  59           XBT_DEBUG("Release dependency on %s: %zu remain(s). Becomes schedulable if %zu=0", SD_task_get_name(succ),
  60               succ->predecessors->size()+succ->inputs->size(), succ->predecessors->size());
  61
  62           if (SD_task_get_state(succ) == SD_NOT_SCHEDULED && succ->predecessors->empty())
  63             SD_task_set_state(succ, SD_SCHEDULABLE);
  64
  65           if (SD_task_get_state(succ) == SD_SCHEDULED && succ->predecessors->empty() && succ->inputs->empty())
  66             SD_task_set_state(succ, SD_RUNNABLE);
  67
  68           if (SD_task_get_state(succ) == SD_RUNNABLE && not sd_global->watch_point_reached)
  69             SD_task_run(succ);
  70         }
  71         task->successors->clear();
  72
  73         for (auto const& output : *task->outputs) {
  74           output->start_time = task->finish_time;
  75           output->predecessors->erase(task);
  76           if (SD_task_get_state(output) == SD_SCHEDULED)
  77              SD_task_set_state(output, SD_RUNNABLE);
  78           else
  79              SD_task_set_state(output, SD_SCHEDULABLE);
  80
  81           SD_task_t comm_dst = *(output->successors->begin());
  82           if (SD_task_get_state(comm_dst) == SD_NOT_SCHEDULED && comm_dst->predecessors->empty()){
  83             XBT_DEBUG("%s is a transfer, %s may be ready now if %zu=0",
  84                 SD_task_get_name(output), SD_task_get_name(comm_dst), comm_dst->predecessors->size());
  85             SD_task_set_state(comm_dst, SD_SCHEDULABLE);
  86           }
  87           if (SD_task_get_state(output) == SD_RUNNABLE && not sd_global->watch_point_reached)
  88             SD_task_run(output);
  89         }
  90         task->outputs->clear();
  91         action = model->extract_done_action();
  92       }
  93
  94       /* let's see which tasks have just failed */
  95       action = model->extract_failed_action();
  96       while (action != nullptr) {
  97         SD_task_t task = static_cast<SD_task_t>(action->get_data());
  98         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
  99         SD_task_set_state(task, SD_FAILED);
 100         sd_global->return_set.insert(task);
 101         action = model->extract_failed_action();
 102       }
 103     }
 104   }
 105
 106   if (not sd_global->watch_point_reached && how_long < 0 && not sd_global->initial_tasks.empty()) {
 107     XBT_WARN("Simulation is finished but %zu tasks are still not done", sd_global->initial_tasks.size());
 108     for (auto const& t : sd_global->initial_tasks)
 109       XBT_WARN("%s is in %s state", SD_task_get_name(t), __get_state_name(SD_task_get_state(t)));
 110   }
 111
 112   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
 113              elapsed_time, total_time, sd_global->watch_point_reached);
 114   XBT_DEBUG("current time = %f", surf_get_clock());
 115
 116   return &sd_global->return_set;
 117 }
 118 }
 119 }
 120
 121 /**
 122  * @brief helper for pretty printing of task state
 123  * @param state the state of a task
 124  * @return the equivalent as a readable string
 125  */
 126 const char *__get_state_name(e_SD_task_state_t state){
 127   static std::string state_names[7] =
 128     { "not scheduled", "schedulable", "scheduled", "runnable","running", "done", "failed" };
 129   return state_names[static_cast<int>(log2(static_cast<double>(state)))].data();
 130 }
 131
 132 /**
 133  * @brief Initializes SD internal data
 134  *
 135  * This function must be called before any other SD function. Then you should call SD_create_environment().
 136  *
 137  * @param argc argument number
 138  * @param argv argument list
 139  * @see SD_create_environment(), SD_exit()
 140  */
 141 void SD_init_nocheck(int *argc, char **argv)
 142 {
 143   xbt_assert(sd_global == nullptr, "SD_init() already called");
 144
 145   surf_init(argc, argv);
 146
 147   sd_global = new simgrid::sd::Global();
 148
 149   simgrid::config::set_default<std::string>("host/model", "ptask_L07");
 150   if (simgrid::config::get_value<bool>("debug/clean-atexit"))
 151     atexit(SD_exit);
 152 }
 153
 154 /** @brief set a configuration variable
 155  *
 156  * Do --help on any simgrid binary to see the list of currently existing configuration variables, and
 157  * see Section @ref options.
 158  *
 159  * Example: SD_config("host/model","default")
 160  */
 161 void SD_config(const char *key, const char *value){
 162   xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
 163   simgrid::config::set_as_string(key, value);
 164 }
 165
 166 /**
 167  * @brief Creates the environment
 168  *
 169  * The environment (i.e. the @ref SD_host_api "hosts" and the @ref SD_link_api "links") is created with
 170  * the data stored in the given XML platform file.
 171  *
 172  * @param platform_file name of an XML file describing the environment to create
 173  * @see SD_host_api, SD_link_api
 174  *
 175  * The XML file follows this DTD:
 176  *
 177  *     @include simgrid.dtd
 178  *
 179  * Here is a small example of such a platform:
 180  *
 181  *     @include small_platform.xml
 182  */
 183 void SD_create_environment(const char *platform_file)
 184 {
 185   simgrid::s4u::Engine::get_instance()->load_platform(platform_file);
 186
 187   XBT_DEBUG("Host number: %zu, link number: %d", sg_host_count(), sg_link_count());
 188 #if SIMGRID_HAVE_JEDULE
 189   jedule_sd_init();
 190 #endif
 191   XBT_VERB("Starting simulation...");
 192   surf_presolve();            /* Takes traces into account */
 193 }
 194
 195 /**
 196  * @brief Launches the simulation.
 197  *
 198  * The function will execute the @ref SD_RUNNABLE runnable tasks.
 199  * If @a how_long is positive, then the simulation will be stopped either when time reaches @a how_long or when a watch
 200  * point is reached.
 201  * A non-positive value for @a how_long means no time limit, in which case the simulation will be stopped either when a
 202  * watch point is reached or when no more task can be executed.
 203  * Then you can call SD_simulate() again.
 204  *
 205  * @param how_long maximum duration of the simulation (a negative value means no time limit)
 206  * @return a dynar of @ref SD_task_t whose state has changed.
 207  * @see SD_task_schedule(), SD_task_watch()
 208  */
 209 void SD_simulate(double how_long)
 210 {
 211   simgrid::sd::simulate(how_long);
 212 }
 213
 214 void SD_simulate_with_update(double how_long, xbt_dynar_t changed_tasks_dynar)
 215 {
 216   const std::set<SD_task_t>* changed_tasks = simgrid::sd::simulate(how_long);
 217   for (auto const& task : *changed_tasks)
 218     xbt_dynar_push(changed_tasks_dynar, &task);
 219 }
 220
 221 /** @brief Returns the current clock, in seconds */
 222 double SD_get_clock() {
 223   return surf_get_clock();
 224 }
 225
 226 /**
 227  * @brief Destroys all SD internal data
 228  * This function should be called when the simulation is over. Don't forget to destroy too.
 229  * @see SD_init(), SD_task_destroy()
 230  */
 231 void SD_exit()
 232 {
 233 #if SIMGRID_HAVE_JEDULE
 234   jedule_sd_exit();
 235 #endif
 236   delete sd_global;
 237 }