src/simdag/sd_global.cpp

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