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 }
  99
 100 /** \brief set a configuration variable
 101  *
 102  * Do --help on any simgrid binary to see the list of currently existing configuration variables, and see Section @ref options.
 103  *
 104  * Example:
 105  * SD_config("workstation/model","default");
 106  */
 107 void SD_config(const char *key, const char *value){
 108   xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
 109   xbt_cfg_set_as_string(_sg_cfg_set, key, value);
 110 }
 111
 112
 113 /**
 114  * \brief Reinits the application part of the simulation (experimental feature)
 115  *
 116  * This function allows you to run several simulations on the same platform
 117  * by resetting the part describing the application.
 118  *
 119  * @warning: this function is still experimental and not perfect. For example,
 120  * the simulation clock (and traces usage) is not reset. So, do not use it if
 121  * you use traces in your simulation, and do not use absolute timing after using it.
 122  * That being said, this function is still precious if you want to compare a bunch of
 123  * heuristics on the same platforms.
 124  */
 125 void SD_application_reinit(void)
 126 {
 127
 128   s_SD_task_t task;
 129
 130   SD_task_t done_task, next_done_task;
 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_workstation = NULL;
 206   void **surf_link = NULL;
 207
 208   parse_platform_file(platform_file);
 209
 210   /* now let's create the SD wrappers for workstations and links */
 211   xbt_lib_foreach(host_lib, cursor, name, surf_workstation){
 212     if(surf_workstation[SURF_WKS_LEVEL])
 213       __SD_workstation_create(surf_workstation[SURF_WKS_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_DEBUG("Workstation number: %d, link number: %d",
 222          SD_workstation_get_number(), SD_link_get_number());
 223 #ifdef HAVE_JEDULE
 224   jedule_setup_platform();
 225 #endif
 226 }
 227
 228 /**
 229  * \brief Launches the simulation.
 230  *
 231  * The function will execute the \ref SD_RUNNABLE runnable tasks.
 232  * If \a how_long is positive, then the simulation will be stopped either
 233  * when time reaches \a how_long or when a watch point is reached.
 234  * A non-positive value for \a how_long means no time limit, in which case
 235  * the simulation will be stopped either when a watch point is reached or
 236  * when no more task can be executed.
 237  * Then you can call SD_simulate() again.
 238  *
 239  * \param how_long maximum duration of the simulation (a negative value means no time limit)
 240  * \return a dynar of \ref SD_task_t whose state has changed.
 241  * \see SD_task_schedule(), SD_task_watch()
 242  */
 243
 244 xbt_dynar_t SD_simulate(double how_long) {
 245   xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
 246   SD_task_t task;
 247
 248   SD_simulate_swag(how_long);
 249   while( (task = xbt_swag_extract(sd_global->return_set)) != NULL) {
 250     xbt_dynar_push(changed_tasks, &task);
 251   }
 252
 253   return changed_tasks;
 254 }
 255
 256 xbt_swag_t SD_simulate_swag(double how_long) {
 257   double total_time = 0.0;      /* we stop the simulation when total_time >= how_long */
 258   double elapsed_time = 0.0;
 259   SD_task_t task, task_safe, dst;
 260   SD_dependency_t dependency;
 261   surf_action_t action;
 262   unsigned int iter, depcnt;
 263   static int first_time = 1;
 264
 265   if (first_time) {
 266     XBT_VERB("Starting simulation...");
 267
 268     surf_presolve();            /* Takes traces into account */
 269     first_time = 0;
 270   }
 271
 272   XBT_VERB("Run simulation for %f seconds", how_long);
 273   sd_global->watch_point_reached = 0;
 274
 275   xbt_swag_reset(sd_global->return_set);
 276
 277   /* explore the runnable tasks */
 278   xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
 279     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
 280     if (__SD_task_try_to_run(task))
 281       xbt_swag_insert(task,sd_global->return_set);
 282   }
 283
 284   /* main loop */
 285   elapsed_time = 0.0;
 286   while (elapsed_time >= 0.0 &&
 287          (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
 288          !sd_global->watch_point_reached) {
 289     surf_model_t model = NULL;
 290     /* dumb variables */
 291
 292
 293     XBT_DEBUG("Total time: %f", total_time);
 294
 295     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
 296     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
 297     if (elapsed_time > 0.0)
 298       total_time += elapsed_time;
 299
 300     /* let's see which tasks are done */
 301     xbt_dynar_foreach(model_list, iter, model) {
 302       while ((action = xbt_swag_extract(model->states.done_action_set))) {
 303         task = action->data;
 304         task->start_time =
 305             surf_workstation_model->
 306             action_get_start_time(task->surf_action);
 307         task->finish_time = surf_get_clock();
 308         XBT_VERB("Task '%s' done", SD_task_get_name(task));
 309         XBT_DEBUG("Calling __SD_task_just_done");
 310         __SD_task_just_done(task);
 311         XBT_DEBUG("__SD_task_just_done called on task '%s'",
 312                SD_task_get_name(task));
 313
 314         /* the state has changed */
 315         xbt_swag_insert(task,sd_global->return_set);
 316
 317         /* remove the dependencies after this task */
 318         xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
 319           dst = dependency->dst;
 320           if (dst->unsatisfied_dependencies > 0)
 321             dst->unsatisfied_dependencies--;
 322           if (dst->is_not_ready > 0)
 323             dst->is_not_ready--;
 324
 325           XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
 326              SD_task_get_name(dst), dst->unsatisfied_dependencies,
 327              dst->is_not_ready);
 328
 329           if (!(dst->unsatisfied_dependencies)) {
 330             if (__SD_task_is_scheduled(dst))
 331               __SD_task_set_state(dst, SD_RUNNABLE);
 332             else
 333               __SD_task_set_state(dst, SD_SCHEDULABLE);
 334           }
 335
 336           if (__SD_task_is_not_scheduled(dst) && !(dst->is_not_ready)) {
 337             __SD_task_set_state(dst, SD_SCHEDULABLE);
 338           }
 339
 340           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
 341             SD_dependency_t comm_dep;
 342             SD_task_t comm_dst;
 343             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
 344             comm_dst = comm_dep->dst;
 345             if (__SD_task_is_not_scheduled(comm_dst) &&
 346                 comm_dst->is_not_ready > 0) {
 347               comm_dst->is_not_ready--;
 348
 349             XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
 350                SD_task_get_name(dst), SD_task_get_name(comm_dst),
 351                comm_dst->is_not_ready);
 352
 353               if (!(comm_dst->is_not_ready)) {
 354                 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
 355               }
 356             }
 357           }
 358
 359           /* is dst runnable now? */
 360           if (__SD_task_is_runnable(dst)
 361               && !sd_global->watch_point_reached) {
 362             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
 363             if (__SD_task_try_to_run(dst))
 364               xbt_swag_insert(dst,sd_global->return_set);
 365           }
 366         }
 367       }
 368
 369       /* let's see which tasks have just failed */
 370       while ((action = xbt_swag_extract(model->states.failed_action_set))) {
 371         task = action->data;
 372         task->start_time =
 373             surf_workstation_model->
 374             action_get_start_time(task->surf_action);
 375         task->finish_time = surf_get_clock();
 376         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
 377         __SD_task_set_state(task, SD_FAILED);
 378         surf_workstation_model->action_unref(action);
 379         task->surf_action = NULL;
 380
 381         xbt_swag_insert(task,sd_global->return_set);
 382       }
 383     }
 384   }
 385
 386   if (!sd_global->watch_point_reached && how_long<0){
 387     if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
 388         XBT_WARN("Simulation is finished but %d tasks are still not done",
 389             (sd_global->task_number - xbt_swag_size(sd_global->done_task_set)));
 390         xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
 391                 XBT_WARN("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
 392     }
 393       xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
 394                 XBT_WARN("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
 395   }
 396         xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
 397                 XBT_WARN("%s is in SD_SCHEDULED state", SD_task_get_name(task));
 398          }
 399     }
 400   }
 401
 402   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
 403          elapsed_time, total_time, sd_global->watch_point_reached);
 404   XBT_DEBUG("current time = %f", surf_get_clock());
 405
 406   return sd_global->return_set;
 407 }
 408
 409 /**
 410  * \brief Returns the current clock
 411  *
 412  * \return the current clock, in second
 413  */
 414 double SD_get_clock(void) {
 415   return surf_get_clock();
 416 }
 417
 418 /**
 419  * \brief Destroys all SD internal data
 420  *
 421  * This function should be called when the simulation is over. Don't forget
 422  * to destroy too.
 423  *
 424  * \see SD_init(), SD_task_destroy()
 425  */
 426 void SD_exit(void)
 427 {
 428 #ifdef HAVE_TRACING
 429   TRACE_surf_resource_utilization_release();
 430 #endif
 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 #ifdef HAVE_TRACING
 451   TRACE_end();
 452 #endif
 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 }