src/simdag/sd_global.c

   1 /* Copyright (c) 2006-2015. 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_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,__SD_storage_destroy);
  91
  92   if (_sg_cfg_exit_asap) {
  93     SD_exit();
  94     exit(0);
  95   }
  96 }
  97
  98 /** \brief set a configuration variable
  99  *
 100  * Do --help on any simgrid binary to see the list of currently existing configuration variables, and see Section @ref options.
 101  *
 102  * Example:
 103  * SD_config("host/model","default");
 104  */
 105 void SD_config(const char *key, const char *value){
 106   xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
 107   xbt_cfg_set_as_string(_sg_cfg_set, key, value);
 108 }
 109
 110
 111 /**
 112  * \brief Reinits the application part of the simulation (experimental feature)
 113  *
 114  * This function allows you to run several simulations on the same platform
 115  * by resetting the part describing the application.
 116  *
 117  * @warning: this function is still experimental and not perfect. For example,
 118  * the simulation clock (and traces usage) is not reset. So, do not use it if
 119  * you use traces in your simulation, and do not use absolute timing after using it.
 120  * That being said, this function is still precious if you want to compare a bunch of
 121  * heuristics on the same platforms.
 122  */
 123 void SD_application_reinit(void)
 124 {
 125
 126   s_SD_task_t task;
 127
 128   SD_task_t done_task, next_done_task;
 129   xbt_die("This function is not working since the C++ links and others. Please report the problem if you really need that function.");
 130
 131    XBT_DEBUG("Recreating the swags...");
 132   xbt_swag_free(sd_global->not_scheduled_task_set);
 133   xbt_swag_free(sd_global->schedulable_task_set);
 134   xbt_swag_free(sd_global->scheduled_task_set);
 135   xbt_swag_free(sd_global->runnable_task_set);
 136   xbt_swag_free(sd_global->in_fifo_task_set);
 137   xbt_swag_free(sd_global->running_task_set);
 138   xbt_swag_free(sd_global->failed_task_set);
 139
 140   sd_global->not_scheduled_task_set =
 141       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 142   sd_global->schedulable_task_set =
 143       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 144   xbt_swag_foreach_safe(done_task, next_done_task, sd_global->done_task_set){
 145     if (xbt_dynar_is_empty(done_task->tasks_before)){
 146       __SD_task_set_state(done_task, SD_SCHEDULABLE);
 147     } else{
 148       __SD_task_set_state(done_task, SD_NOT_SCHEDULED);
 149       done_task->unsatisfied_dependencies =
 150         xbt_dynar_length(done_task->tasks_before);
 151       done_task->is_not_ready = done_task->unsatisfied_dependencies;
 152     }
 153     free(done_task->workstation_list);
 154     done_task->workstation_list = NULL;
 155     done_task->workstation_nb = 0;
 156   }
 157
 158   xbt_swag_free(sd_global->done_task_set);
 159
 160   sd_global->scheduled_task_set =
 161       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 162   sd_global->runnable_task_set =
 163       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 164   sd_global->in_fifo_task_set =
 165       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 166   sd_global->running_task_set =
 167       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 168   sd_global->done_task_set =
 169       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 170   sd_global->failed_task_set =
 171       xbt_swag_new(xbt_swag_offset(task, state_hookup));
 172   sd_global->task_number = 0;
 173
 174
 175 #ifdef HAVE_JEDULE
 176   jedule_sd_dump();
 177   jedule_sd_cleanup();
 178   jedule_sd_init();
 179 #endif
 180 }
 181
 182 /**
 183  * \brief Creates the environment
 184  *
 185  * The environment (i.e. the \ref SD_workstation_management "workstations"
 186  * and the \ref SD_link_management "links") is created with the data stored
 187  * in the given XML platform file.
 188  *
 189  * \param platform_file name of an XML file describing the environment to create
 190  * \see SD_workstation_management, SD_link_management
 191  *
 192  * The XML file follows this DTD:
 193  *
 194  *     \include simgrid.dtd
 195  *
 196  * Here is a small example of such a platform:
 197  *
 198  *     \include small_platform.xml
 199  */
 200 void SD_create_environment(const char *platform_file)
 201 {
 202   xbt_lib_cursor_t cursor = NULL;
 203   char *name = NULL;
 204   void **surf_workstation = NULL;
 205   void **surf_storage = NULL;
 206
 207   parse_platform_file(platform_file);
 208
 209   /* now let's create the SD wrappers for workstations, storages and links */
 210   xbt_lib_foreach(host_lib, cursor, name, surf_workstation){
 211     if(surf_workstation[SURF_HOST_LEVEL])
 212       __SD_workstation_create(surf_workstation[SURF_HOST_LEVEL], NULL);
 213   }
 214
 215   xbt_lib_foreach(storage_lib, cursor, name, surf_storage) {
 216   if(surf_storage[SURF_STORAGE_LEVEL])
 217     __SD_storage_create(surf_storage[SURF_STORAGE_LEVEL], NULL);
 218   }
 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     /* FIXME: shoud look at model_list or model_list_invoke? */
 301     /* let's see which tasks are done */
 302     xbt_dynar_foreach(model_list, iter, model) {
 303       while ((action = surf_model_extract_done_action_set(model))) {
 304         task = surf_action_get_data(action);
 305         task->start_time = surf_action_get_start_time(task->surf_action);
 306
 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 = surf_model_extract_failed_action_set(model))) {
 371         task = surf_action_get_data(action);
 372         task->start_time = surf_action_get_start_time(task->surf_action);
 373         task->finish_time = surf_get_clock();
 374         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
 375         __SD_task_set_state(task, SD_FAILED);
 376         surf_action_unref(action);
 377         task->surf_action = NULL;
 378
 379         xbt_swag_insert(task,sd_global->return_set);
 380       }
 381     }
 382   }
 383
 384   if (!sd_global->watch_point_reached && how_long<0){
 385     if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
 386         XBT_WARN("Simulation is finished but %d tasks are still not done",
 387             (sd_global->task_number - xbt_swag_size(sd_global->done_task_set)));
 388         xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
 389                 XBT_WARN("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
 390     }
 391       xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
 392                 XBT_WARN("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
 393   }
 394         xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
 395                 XBT_WARN("%s is in SD_SCHEDULED state", SD_task_get_name(task));
 396          }
 397     }
 398   }
 399
 400   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
 401          elapsed_time, total_time, sd_global->watch_point_reached);
 402   XBT_DEBUG("current time = %f", surf_get_clock());
 403
 404   return sd_global->return_set;
 405 }
 406
 407 /**
 408  * \brief Returns the current clock
 409  *
 410  * \return the current clock, in second
 411  */
 412 double SD_get_clock(void) {
 413   return surf_get_clock();
 414 }
 415
 416 /**
 417  * \brief Destroys all SD internal data
 418  *
 419  * This function should be called when the simulation is over. Don't forget
 420  * to destroy too.
 421  *
 422  * \see SD_init(), SD_task_destroy()
 423  */
 424 void SD_exit(void)
 425 {
 426   TRACE_surf_resource_utilization_release();
 427
 428   xbt_mallocator_free(sd_global->task_mallocator);
 429
 430   XBT_DEBUG("Destroying workstation and link arrays...");
 431   xbt_free(sd_global->workstation_list);
 432   xbt_free(sd_global->link_list);
 433   xbt_free(sd_global->recyclable_route);
 434
 435   XBT_DEBUG("Destroying the swags...");
 436   xbt_swag_free(sd_global->not_scheduled_task_set);
 437   xbt_swag_free(sd_global->schedulable_task_set);
 438   xbt_swag_free(sd_global->scheduled_task_set);
 439   xbt_swag_free(sd_global->runnable_task_set);
 440   xbt_swag_free(sd_global->in_fifo_task_set);
 441   xbt_swag_free(sd_global->running_task_set);
 442   xbt_swag_free(sd_global->done_task_set);
 443   xbt_swag_free(sd_global->failed_task_set);
 444   xbt_swag_free(sd_global->return_set);
 445
 446   TRACE_end();
 447
 448   xbt_free(sd_global);
 449   sd_global = NULL;
 450
 451 #ifdef HAVE_JEDULE
 452   jedule_sd_dump();
 453   jedule_sd_cleanup();
 454   jedule_sd_exit();
 455 #endif
 456
 457   XBT_DEBUG("Exiting Surf...");
 458   surf_exit();
 459 }