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