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