src/simdag/sd_global.cpp

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