src/simdag/sd_global.c

   1 /* Copyright (c) 2006-2015. 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 "private.h"
   8 #include "instr/instr_interface.h"
   9 #include "xbt/sysdep.h"
  10 #include "xbt/dynar.h"
  11 #include "surf/surf.h"
  12 #include "simgrid/sg_config.h"
  13 #include "simgrid/host.h"
  14 #include "xbt/ex.h"
  15 #include "xbt/log.h"
  16 #include "xbt/str.h"
  17 #include "xbt/config.h"
  18 #include "surf/surfxml_parse.h"
  19 #ifdef HAVE_LUA
  20 #include <lua.h>
  21 #include <lauxlib.h>
  22 #include <lualib.h>
  23 #endif
  24
  25 #ifdef HAVE_JEDULE
  26 #include "instr/jedule/jedule_sd_binding.h"
  27 #endif
  28
  29 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
  30 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd,
  31                                 "Logging specific to SimDag (kernel)");
  32
  33 SD_global_t sd_global = NULL;
  34
  35 /**
  36  * \brief Initializes SD internal data
  37  *
  38  * This function must be called before any other SD function. Then you
  39  * should call SD_create_environment().
  40  *
  41  * \param argc argument number
  42  * \param argv argument list
  43  * \see SD_create_environment(), SD_exit()
  44  */
  45 void SD_init(int *argc, char **argv)
  46 {
  47   TRACE_global_init(argc, argv);
  48
  49   s_SD_task_t task;
  50
  51   xbt_assert(sd_global == NULL, "SD_init() already called");
  52
  53   sd_global = xbt_new(s_SD_global_t, 1);
  54   sd_global->workstation_list = NULL;
  55   sd_global->link_list = NULL;
  56   sd_global->recyclable_route = NULL;
  57   sd_global->watch_point_reached = 0;
  58
  59   sd_global->task_mallocator=xbt_mallocator_new(65536, SD_task_new_f,SD_task_free_f,SD_task_recycle_f);
  60
  61   sd_global->not_scheduled_task_set =
  62       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  63   sd_global->schedulable_task_set =
  64       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  65   sd_global->scheduled_task_set =
  66       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  67   sd_global->runnable_task_set =
  68       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  69   sd_global->in_fifo_task_set =
  70       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  71   sd_global->running_task_set =
  72       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  73   sd_global->done_task_set =
  74       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  75   sd_global->failed_task_set =
  76       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  77   sd_global->return_set =
  78       xbt_swag_new(xbt_swag_offset(task, return_hookup));
  79   sd_global->task_number = 0;
  80
  81   surf_init(argc, argv);
  82
  83   xbt_cfg_setdefault_string(_sg_cfg_set, "host/model",
  84                             "ptask_L07");
  85
  86 #ifdef HAVE_JEDULE
  87   jedule_sd_init();
  88 #endif
  89
  90   XBT_DEBUG("ADD SD LEVELS");
  91   SD_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,__SD_storage_destroy);
  92
  93   if (_sg_cfg_exit_asap) {
  94     SD_exit();
  95     exit(0);
  96   }
  97 }
  98
  99 /** \brief set a configuration variable
 100  *
 101  * Do --help on any simgrid binary to see the list of currently existing configuration variables, and see Section @ref options.
 102  *
 103  * Example:
 104  * SD_config("host/model","default");
 105  */
 106 void SD_config(const char *key, const char *value){
 107   xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
 108   xbt_cfg_set_as_string(_sg_cfg_set, key, value);
 109 }
 110
 111
 112 /**
 113  * \brief Reinits the application part of the simulation (experimental feature)
 114  *
 115  * This function allows you to run several simulations on the same platform
 116  * by resetting the part describing the application.
 117  *
 118  * @warning: this function is still experimental and not perfect. For example,
 119  * the simulation clock (and traces usage) is not reset. So, do not use it if
 120  * you use traces in your simulation, and do not use absolute timing after using it.
 121  * That being said, this function is still precious if you want to compare a bunch of
 122  * heuristics on the same platforms.
 123  */
 124 void SD_application_reinit(void)
 125 {
 126
 127   s_SD_task_t task;
 128
 129   SD_task_t done_task, next_done_task;
 130   xbt_die("This function is not working since the C++ links and others. Please report the problem if you really need that function.");
 131
 132    XBT_DEBUG("Recreating the swags...");
 133   xbt_swag_free(sd_global->not_scheduled_task_set);
 134   xbt_swag_free(sd_global->schedulable_task_set);
 135   xbt_swag_free(sd_global->scheduled_task_set);
 136   xbt_swag_free(sd_global->runnable_task_set);
 137   xbt_swag_free(sd_global->in_fifo_task_set);
 138   xbt_swag_free(sd_global->running_task_set);
 139   xbt_swag_free(sd_global->failed_task_set);
 140
 141   sd_global->not_scheduled_task_set =
 142       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 143   sd_global->schedulable_task_set =
 144       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 145   xbt_swag_foreach_safe(done_task, next_done_task, sd_global->done_task_set){
 146     if (xbt_dynar_is_empty(done_task->tasks_before)){
 147       __SD_task_set_state(done_task, SD_SCHEDULABLE);
 148     } else{
 149       __SD_task_set_state(done_task, SD_NOT_SCHEDULED);
 150       done_task->unsatisfied_dependencies =
 151         xbt_dynar_length(done_task->tasks_before);
 152       done_task->is_not_ready = done_task->unsatisfied_dependencies;
 153     }
 154     free(done_task->workstation_list);
 155     done_task->workstation_list = NULL;
 156     done_task->workstation_nb = 0;
 157   }
 158
 159   xbt_swag_free(sd_global->done_task_set);
 160
 161   sd_global->scheduled_task_set =
 162       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 163   sd_global->runnable_task_set =
 164       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 165   sd_global->in_fifo_task_set =
 166       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 167   sd_global->running_task_set =
 168       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 169   sd_global->done_task_set =
 170       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 171   sd_global->failed_task_set =
 172       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 173   sd_global->task_number = 0;
 174
 175
 176 #ifdef HAVE_JEDULE
 177   jedule_sd_dump();
 178   jedule_sd_cleanup();
 179   jedule_sd_init();
 180 #endif
 181 }
 182
 183 /**
 184  * \brief Creates the environment
 185  *
 186  * The environment (i.e. the \ref SD_workstation_management "workstations"
 187  * and the \ref SD_link_management "links") is created with the data stored
 188  * in the given XML platform file.
 189  *
 190  * \param platform_file name of an XML file describing the environment to create
 191  * \see SD_workstation_management, SD_link_management
 192  *
 193  * The XML file follows this DTD:
 194  *
 195  *     \include simgrid.dtd
 196  *
 197  * Here is a small example of such a platform:
 198  *
 199  *     \include small_platform.xml
 200  */
 201 void SD_create_environment(const char *platform_file)
 202 {
 203   xbt_lib_cursor_t cursor = NULL;
 204   char *name = NULL;
 205   void **surf_storage = NULL;
 206
 207   parse_platform_file(platform_file);
 208
 209   /* now let's create the SD wrappers for workstations, storages and links */
 210   {
 211     xbt_dict_cursor_t cursor = NULL;
 212     simgrid_Host* host = NULL;
 213     xbt_dict_foreach(host_list, cursor, name, host){
 214       surf_Host* surf_host = (surf_Host*) surf_host_resource_priv(host);
 215       if (surf_host != NULL)
 216         __SD_workstation_create(surf_host, NULL);
 217     }
 218   }
 219
 220   xbt_lib_foreach(storage_lib, cursor, name, surf_storage) {
 221   if(surf_storage[SURF_STORAGE_LEVEL])
 222     __SD_storage_create(surf_storage[SURF_STORAGE_LEVEL], NULL);
 223   }
 224
 225
 226   XBT_DEBUG("Workstation number: %d, link number: %d",
 227          SD_workstation_get_number(), SD_link_get_number());
 228 #ifdef HAVE_JEDULE
 229   jedule_setup_platform();
 230 #endif
 231 }
 232
 233 /**
 234  * \brief Launches the simulation.
 235  *
 236  * The function will execute the \ref SD_RUNNABLE runnable tasks.
 237  * If \a how_long is positive, then the simulation will be stopped either
 238  * when time reaches \a how_long or when a watch point is reached.
 239  * A non-positive value for \a how_long means no time limit, in which case
 240  * the simulation will be stopped either when a watch point is reached or
 241  * when no more task can be executed.
 242  * Then you can call SD_simulate() again.
 243  *
 244  * \param how_long maximum duration of the simulation (a negative value means no time limit)
 245  * \return a dynar of \ref SD_task_t whose state has changed.
 246  * \see SD_task_schedule(), SD_task_watch()
 247  */
 248
 249 xbt_dynar_t SD_simulate(double how_long) {
 250   xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
 251   SD_task_t task;
 252
 253   SD_simulate_swag(how_long);
 254   while( (task = xbt_swag_extract(sd_global->return_set)) != NULL) {
 255     xbt_dynar_push(changed_tasks, &task);
 256   }
 257
 258   return changed_tasks;
 259 }
 260
 261 xbt_swag_t SD_simulate_swag(double how_long) {
 262   double total_time = 0.0;      /* we stop the simulation when total_time >= how_long */
 263   double elapsed_time = 0.0;
 264   SD_task_t task, task_safe, dst;
 265   SD_dependency_t dependency;
 266   surf_action_t action;
 267   unsigned int iter, depcnt;
 268   static int first_time = 1;
 269
 270   if (first_time) {
 271     XBT_VERB("Starting simulation...");
 272
 273     surf_presolve();            /* Takes traces into account */
 274     first_time = 0;
 275   }
 276
 277   XBT_VERB("Run simulation for %f seconds", how_long);
 278   sd_global->watch_point_reached = 0;
 279
 280   xbt_swag_reset(sd_global->return_set);
 281
 282   /* explore the runnable tasks */
 283   xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
 284     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
 285     if (__SD_task_try_to_run(task))
 286       xbt_swag_insert(task,sd_global->return_set);
 287   }
 288
 289   /* main loop */
 290   elapsed_time = 0.0;
 291   while (elapsed_time >= 0.0 &&
 292          (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
 293          !sd_global->watch_point_reached) {
 294     surf_model_t model = NULL;
 295     /* dumb variables */
 296
 297
 298     XBT_DEBUG("Total time: %f", total_time);
 299
 300     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
 301     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
 302     if (elapsed_time > 0.0)
 303       total_time += elapsed_time;
 304
 305     /* let's see which tasks are done */
 306     xbt_dynar_foreach(all_existing_models, iter, model) {
 307       while ((action = surf_model_extract_done_action_set(model))) {
 308         task = surf_action_get_data(action);
 309         task->start_time = surf_action_get_start_time(task->surf_action);
 310
 311         task->finish_time = surf_get_clock();
 312         XBT_VERB("Task '%s' done", SD_task_get_name(task));
 313         XBT_DEBUG("Calling __SD_task_just_done");
 314         __SD_task_just_done(task);
 315         XBT_DEBUG("__SD_task_just_done called on task '%s'",
 316                SD_task_get_name(task));
 317
 318         /* the state has changed */
 319         xbt_swag_insert(task,sd_global->return_set);
 320
 321         /* remove the dependencies after this task */
 322         xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
 323           dst = dependency->dst;
 324           if (dst->unsatisfied_dependencies > 0)
 325             dst->unsatisfied_dependencies--;
 326           if (dst->is_not_ready > 0)
 327             dst->is_not_ready--;
 328
 329           XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
 330              SD_task_get_name(dst), dst->unsatisfied_dependencies,
 331              dst->is_not_ready);
 332
 333           if (!(dst->unsatisfied_dependencies)) {
 334             if (__SD_task_is_scheduled(dst))
 335               __SD_task_set_state(dst, SD_RUNNABLE);
 336             else
 337               __SD_task_set_state(dst, SD_SCHEDULABLE);
 338           }
 339
 340           if (__SD_task_is_not_scheduled(dst) && !(dst->is_not_ready)) {
 341             __SD_task_set_state(dst, SD_SCHEDULABLE);
 342           }
 343
 344           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
 345             SD_dependency_t comm_dep;
 346             SD_task_t comm_dst;
 347             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
 348             comm_dst = comm_dep->dst;
 349             if (__SD_task_is_not_scheduled(comm_dst) &&
 350                 comm_dst->is_not_ready > 0) {
 351               comm_dst->is_not_ready--;
 352
 353             XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
 354                SD_task_get_name(dst), SD_task_get_name(comm_dst),
 355                comm_dst->is_not_ready);
 356
 357               if (!(comm_dst->is_not_ready)) {
 358                 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
 359               }
 360             }
 361           }
 362
 363           /* is dst runnable now? */
 364           if (__SD_task_is_runnable(dst)
 365               && !sd_global->watch_point_reached) {
 366             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
 367             if (__SD_task_try_to_run(dst))
 368               xbt_swag_insert(dst,sd_global->return_set);
 369           }
 370         }
 371       }
 372
 373       /* let's see which tasks have just failed */
 374       while ((action = surf_model_extract_failed_action_set(model))) {
 375         task = surf_action_get_data(action);
 376         task->start_time = surf_action_get_start_time(task->surf_action);
 377         task->finish_time = surf_get_clock();
 378         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
 379         __SD_task_set_state(task, SD_FAILED);
 380         surf_action_unref(action);
 381         task->surf_action = NULL;
 382
 383         xbt_swag_insert(task,sd_global->return_set);
 384       }
 385     }
 386   }
 387
 388   if (!sd_global->watch_point_reached && how_long<0){
 389     if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
 390         XBT_WARN("Simulation is finished but %d tasks are still not done",
 391             (sd_global->task_number - xbt_swag_size(sd_global->done_task_set)));
 392         xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
 393                 XBT_WARN("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
 394     }
 395       xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
 396                 XBT_WARN("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
 397   }
 398         xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
 399                 XBT_WARN("%s is in SD_SCHEDULED state", SD_task_get_name(task));
 400          }
 401     }
 402   }
 403
 404   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
 405          elapsed_time, total_time, sd_global->watch_point_reached);
 406   XBT_DEBUG("current time = %f", surf_get_clock());
 407
 408   return sd_global->return_set;
 409 }
 410
 411 /**
 412  * \brief Returns the current clock
 413  *
 414  * \return the current clock, in second
 415  */
 416 double SD_get_clock(void) {
 417   return surf_get_clock();
 418 }
 419
 420 /**
 421  * \brief Destroys all SD internal data
 422  *
 423  * This function should be called when the simulation is over. Don't forget
 424  * to destroy too.
 425  *
 426  * \see SD_init(), SD_task_destroy()
 427  */
 428 void SD_exit(void)
 429 {
 430   TRACE_surf_resource_utilization_release();
 431
 432   xbt_mallocator_free(sd_global->task_mallocator);
 433
 434   XBT_DEBUG("Destroying workstation and link arrays...");
 435   xbt_free(sd_global->workstation_list);
 436   xbt_free(sd_global->link_list);
 437   xbt_free(sd_global->recyclable_route);
 438
 439   XBT_DEBUG("Destroying the swags...");
 440   xbt_swag_free(sd_global->not_scheduled_task_set);
 441   xbt_swag_free(sd_global->schedulable_task_set);
 442   xbt_swag_free(sd_global->scheduled_task_set);
 443   xbt_swag_free(sd_global->runnable_task_set);
 444   xbt_swag_free(sd_global->in_fifo_task_set);
 445   xbt_swag_free(sd_global->running_task_set);
 446   xbt_swag_free(sd_global->done_task_set);
 447   xbt_swag_free(sd_global->failed_task_set);
 448   xbt_swag_free(sd_global->return_set);
 449
 450   TRACE_end();
 451
 452   xbt_free(sd_global);
 453   sd_global = NULL;
 454
 455 #ifdef HAVE_JEDULE
 456   jedule_sd_dump();
 457   jedule_sd_cleanup();
 458   jedule_sd_exit();
 459 #endif
 460
 461   XBT_DEBUG("Exiting Surf...");
 462   surf_exit();
 463 }