src/simdag/sd_global.c

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