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