src/simdag/sd_global.c

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