src/simdag/sd_global.c

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