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