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