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_HOST_LEVEL = xbt_lib_add_level(host_lib,__SD_workstation_destroy);
  91   SD_LINK_LEVEL = xbt_lib_add_level(link_lib,__SD_link_destroy);
  92   SD_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,__SD_storage_destroy);
  93
  94   if (_sg_cfg_exit_asap) {
  95     SD_exit();
  96     exit(0);
  97   }
  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("host/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   void **surf_storage = NULL;
 208
 209   parse_platform_file(platform_file);
 210
 211   /* now let's create the SD wrappers for workstations, storages and links */
 212   xbt_lib_foreach(host_lib, cursor, name, surf_workstation){
 213     if(surf_workstation[SURF_HOST_LEVEL])
 214       __SD_workstation_create(surf_workstation[SURF_HOST_LEVEL], NULL);
 215   }
 216
 217   xbt_lib_foreach(link_lib, cursor, name, surf_link) {
 218   if(surf_link[SURF_LINK_LEVEL])
 219     __SD_link_create(surf_link[SURF_LINK_LEVEL], NULL);
 220   }
 221
 222   xbt_lib_foreach(storage_lib, cursor, name, surf_storage) {
 223   if(surf_storage[SURF_STORAGE_LEVEL])
 224     __SD_storage_create(surf_storage[SURF_STORAGE_LEVEL], NULL);
 225   }
 226
 227
 228   XBT_DEBUG("Workstation number: %d, link number: %d",
 229          SD_workstation_get_number(), SD_link_get_number());
 230 #ifdef HAVE_JEDULE
 231   jedule_setup_platform();
 232 #endif
 233 }
 234
 235 /**
 236  * \brief Launches the simulation.
 237  *
 238  * The function will execute the \ref SD_RUNNABLE runnable tasks.
 239  * If \a how_long is positive, then the simulation will be stopped either
 240  * when time reaches \a how_long or when a watch point is reached.
 241  * A non-positive value for \a how_long means no time limit, in which case
 242  * the simulation will be stopped either when a watch point is reached or
 243  * when no more task can be executed.
 244  * Then you can call SD_simulate() again.
 245  *
 246  * \param how_long maximum duration of the simulation (a negative value means no time limit)
 247  * \return a dynar of \ref SD_task_t whose state has changed.
 248  * \see SD_task_schedule(), SD_task_watch()
 249  */
 250
 251 xbt_dynar_t SD_simulate(double how_long) {
 252   xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
 253   SD_task_t task;
 254
 255   SD_simulate_swag(how_long);
 256   while( (task = xbt_swag_extract(sd_global->return_set)) != NULL) {
 257     xbt_dynar_push(changed_tasks, &task);
 258   }
 259
 260   return changed_tasks;
 261 }
 262
 263 xbt_swag_t SD_simulate_swag(double how_long) {
 264   double total_time = 0.0;      /* we stop the simulation when total_time >= how_long */
 265   double elapsed_time = 0.0;
 266   SD_task_t task, task_safe, dst;
 267   SD_dependency_t dependency;
 268   surf_action_t action;
 269   unsigned int iter, depcnt;
 270   static int first_time = 1;
 271
 272   if (first_time) {
 273     XBT_VERB("Starting simulation...");
 274
 275     surf_presolve();            /* Takes traces into account */
 276     first_time = 0;
 277   }
 278
 279   XBT_VERB("Run simulation for %f seconds", how_long);
 280   sd_global->watch_point_reached = 0;
 281
 282   xbt_swag_reset(sd_global->return_set);
 283
 284   /* explore the runnable tasks */
 285   xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
 286     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
 287     if (__SD_task_try_to_run(task))
 288       xbt_swag_insert(task,sd_global->return_set);
 289   }
 290
 291   /* main loop */
 292   elapsed_time = 0.0;
 293   while (elapsed_time >= 0.0 &&
 294          (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
 295          !sd_global->watch_point_reached) {
 296     surf_model_t model = NULL;
 297     /* dumb variables */
 298
 299
 300     XBT_DEBUG("Total time: %f", total_time);
 301
 302     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
 303     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
 304     if (elapsed_time > 0.0)
 305       total_time += elapsed_time;
 306
 307     /* FIXME: shoud look at model_list or model_list_invoke? */
 308     /* let's see which tasks are done */
 309     xbt_dynar_foreach(model_list, iter, model) {
 310       while ((action = surf_model_extract_done_action_set(model))) {
 311         task = surf_action_get_data(action);
 312         task->start_time = surf_action_get_start_time(task->surf_action);
 313
 314         task->finish_time = surf_get_clock();
 315         XBT_VERB("Task '%s' done", SD_task_get_name(task));
 316         XBT_DEBUG("Calling __SD_task_just_done");
 317         __SD_task_just_done(task);
 318         XBT_DEBUG("__SD_task_just_done called on task '%s'",
 319                SD_task_get_name(task));
 320
 321         /* the state has changed */
 322         xbt_swag_insert(task,sd_global->return_set);
 323
 324         /* remove the dependencies after this task */
 325         xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
 326           dst = dependency->dst;
 327           if (dst->unsatisfied_dependencies > 0)
 328             dst->unsatisfied_dependencies--;
 329           if (dst->is_not_ready > 0)
 330             dst->is_not_ready--;
 331
 332           XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
 333              SD_task_get_name(dst), dst->unsatisfied_dependencies,
 334              dst->is_not_ready);
 335
 336           if (!(dst->unsatisfied_dependencies)) {
 337             if (__SD_task_is_scheduled(dst))
 338               __SD_task_set_state(dst, SD_RUNNABLE);
 339             else
 340               __SD_task_set_state(dst, SD_SCHEDULABLE);
 341           }
 342
 343           if (__SD_task_is_not_scheduled(dst) && !(dst->is_not_ready)) {
 344             __SD_task_set_state(dst, SD_SCHEDULABLE);
 345           }
 346
 347           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
 348             SD_dependency_t comm_dep;
 349             SD_task_t comm_dst;
 350             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
 351             comm_dst = comm_dep->dst;
 352             if (__SD_task_is_not_scheduled(comm_dst) &&
 353                 comm_dst->is_not_ready > 0) {
 354               comm_dst->is_not_ready--;
 355
 356             XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
 357                SD_task_get_name(dst), SD_task_get_name(comm_dst),
 358                comm_dst->is_not_ready);
 359
 360               if (!(comm_dst->is_not_ready)) {
 361                 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
 362               }
 363             }
 364           }
 365
 366           /* is dst runnable now? */
 367           if (__SD_task_is_runnable(dst)
 368               && !sd_global->watch_point_reached) {
 369             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
 370             if (__SD_task_try_to_run(dst))
 371               xbt_swag_insert(dst,sd_global->return_set);
 372           }
 373         }
 374       }
 375
 376       /* let's see which tasks have just failed */
 377       while ((action = surf_model_extract_failed_action_set(model))) {
 378         task = surf_action_get_data(action);
 379         task->start_time = surf_action_get_start_time(task->surf_action);
 380         task->finish_time = surf_get_clock();
 381         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
 382         __SD_task_set_state(task, SD_FAILED);
 383         surf_action_unref(action);
 384         task->surf_action = NULL;
 385
 386         xbt_swag_insert(task,sd_global->return_set);
 387       }
 388     }
 389   }
 390
 391   if (!sd_global->watch_point_reached && how_long<0){
 392     if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
 393         XBT_WARN("Simulation is finished but %d tasks are still not done",
 394             (sd_global->task_number - xbt_swag_size(sd_global->done_task_set)));
 395         xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
 396                 XBT_WARN("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
 397     }
 398       xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
 399                 XBT_WARN("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
 400   }
 401         xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
 402                 XBT_WARN("%s is in SD_SCHEDULED state", SD_task_get_name(task));
 403          }
 404     }
 405   }
 406
 407   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
 408          elapsed_time, total_time, sd_global->watch_point_reached);
 409   XBT_DEBUG("current time = %f", surf_get_clock());
 410
 411   return sd_global->return_set;
 412 }
 413
 414 /**
 415  * \brief Returns the current clock
 416  *
 417  * \return the current clock, in second
 418  */
 419 double SD_get_clock(void) {
 420   return surf_get_clock();
 421 }
 422
 423 /**
 424  * \brief Destroys all SD internal data
 425  *
 426  * This function should be called when the simulation is over. Don't forget
 427  * to destroy too.
 428  *
 429  * \see SD_init(), SD_task_destroy()
 430  */
 431 void SD_exit(void)
 432 {
 433   TRACE_surf_resource_utilization_release();
 434
 435   xbt_mallocator_free(sd_global->task_mallocator);
 436
 437   XBT_DEBUG("Destroying workstation and link arrays...");
 438   xbt_free(sd_global->workstation_list);
 439   xbt_free(sd_global->link_list);
 440   xbt_free(sd_global->recyclable_route);
 441
 442   XBT_DEBUG("Destroying the swags...");
 443   xbt_swag_free(sd_global->not_scheduled_task_set);
 444   xbt_swag_free(sd_global->schedulable_task_set);
 445   xbt_swag_free(sd_global->scheduled_task_set);
 446   xbt_swag_free(sd_global->runnable_task_set);
 447   xbt_swag_free(sd_global->in_fifo_task_set);
 448   xbt_swag_free(sd_global->running_task_set);
 449   xbt_swag_free(sd_global->done_task_set);
 450   xbt_swag_free(sd_global->failed_task_set);
 451   xbt_swag_free(sd_global->return_set);
 452
 453   TRACE_end();
 454
 455   xbt_free(sd_global);
 456   sd_global = NULL;
 457
 458 #ifdef HAVE_JEDULE
 459   jedule_sd_dump();
 460   jedule_sd_cleanup();
 461   jedule_sd_exit();
 462 #endif
 463
 464   XBT_DEBUG("Exiting Surf...");
 465   surf_exit();
 466 }