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