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