src/simdag/sd_global.cpp

   1 /* Copyright (c) 2006-2016. 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 "src/surf/surf_interface.hpp"
   8 #include "src/simdag/simdag_private.h"
   9 #include "instr/instr_interface.h"
  10 #include "xbt/sysdep.h"
  11 #include "xbt/dynar.h"
  12 #include "surf/surf.h"
  13 #include "simgrid/sg_config.h"
  14 #include "simgrid/host.h"
  15 #include "xbt/ex.h"
  16 #include "xbt/log.h"
  17 #include "xbt/str.h"
  18 #include "xbt/config.h"
  19 #include "surf/surfxml_parse.h"
  20 #ifdef HAVE_LUA
  21 #include <lua.h>
  22 #include <lauxlib.h>
  23 #include <lualib.h>
  24 #endif
  25
  26 #ifdef HAVE_JEDULE
  27 #include "instr/jedule/jedule_sd_binding.h"
  28 #endif
  29
  30 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
  31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd,
  32                                 "Logging specific to SimDag (kernel)");
  33
  34 SD_global_t sd_global = NULL;
  35
  36 /**
  37  * \brief Initializes SD internal data
  38  *
  39  * This function must be called before any other SD function. Then you
  40  * should call SD_create_environment().
  41  *
  42  * \param argc argument number
  43  * \param argv argument list
  44  * \see SD_create_environment(), SD_exit()
  45  */
  46 void SD_init(int *argc, char **argv)
  47 {
  48   TRACE_global_init(argc, argv);
  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, "host/model",
  85                             "ptask_L07");
  86
  87 #ifdef HAVE_JEDULE
  88   jedule_sd_init();
  89 #endif
  90
  91   XBT_DEBUG("ADD SD LEVELS");
  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   xbt_die("This function is not working since the C++ links and others. Please report the problem if you really need that function.");
 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_storage = NULL;
 207
 208   parse_platform_file(platform_file);
 209
 210   /* now let's create the SD wrappers for workstations, storages and links */
 211   {
 212     xbt_dict_cursor_t cursor = NULL;
 213     simgrid_Host* host = NULL;
 214     xbt_dict_foreach(host_list, cursor, name, host){
 215         __SD_workstation_create((const char*)name);
 216     }
 217   }
 218
 219   xbt_lib_foreach(storage_lib, cursor, name, surf_storage) {
 220   if(surf_storage[SURF_STORAGE_LEVEL])
 221     __SD_storage_create(surf_storage[SURF_STORAGE_LEVEL], NULL);
 222   }
 223
 224
 225   XBT_DEBUG("Workstation number: %d, link number: %d",
 226          SD_workstation_get_number(), SD_link_get_number());
 227 #ifdef HAVE_JEDULE
 228   jedule_setup_platform();
 229 #endif
 230 }
 231
 232 /**
 233  * \brief Launches the simulation.
 234  *
 235  * The function will execute the \ref SD_RUNNABLE runnable tasks.
 236  * If \a how_long is positive, then the simulation will be stopped either
 237  * when time reaches \a how_long or when a watch point is reached.
 238  * A non-positive value for \a how_long means no time limit, in which case
 239  * the simulation will be stopped either when a watch point is reached or
 240  * when no more task can be executed.
 241  * Then you can call SD_simulate() again.
 242  *
 243  * \param how_long maximum duration of the simulation (a negative value means no time limit)
 244  * \return a dynar of \ref SD_task_t whose state has changed.
 245  * \see SD_task_schedule(), SD_task_watch()
 246  */
 247
 248 xbt_dynar_t SD_simulate(double how_long) {
 249   xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
 250   SD_task_t task;
 251
 252   SD_simulate_swag(how_long);
 253   while( (task = (SD_task_t)xbt_swag_extract(sd_global->return_set)) != NULL) {
 254     xbt_dynar_push(changed_tasks, &task);
 255   }
 256
 257   return changed_tasks;
 258 }
 259
 260 xbt_swag_t SD_simulate_swag(double how_long) {
 261   double total_time = 0.0;      /* we stop the simulation when total_time >= how_long */
 262   double elapsed_time = 0.0;
 263   SD_task_t task, task_safe, dst;
 264   SD_dependency_t dependency;
 265   surf_action_t action;
 266   unsigned int iter, depcnt;
 267   static int first_time = 1;
 268
 269   if (first_time) {
 270     XBT_VERB("Starting simulation...");
 271
 272     surf_presolve();            /* Takes traces into account */
 273     first_time = 0;
 274   }
 275
 276   XBT_VERB("Run simulation for %f seconds", how_long);
 277   sd_global->watch_point_reached = 0;
 278
 279   xbt_swag_reset(sd_global->return_set);
 280
 281   /* explore the runnable tasks */
 282   xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
 283     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
 284     if (__SD_task_try_to_run(task))
 285       xbt_swag_insert(task,sd_global->return_set);
 286   }
 287
 288   /* main loop */
 289   elapsed_time = 0.0;
 290   while (elapsed_time >= 0.0 &&
 291          (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
 292          !sd_global->watch_point_reached) {
 293     surf_model_t model = NULL;
 294     /* dumb variables */
 295
 296
 297     XBT_DEBUG("Total time: %f", total_time);
 298
 299     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
 300     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
 301     if (elapsed_time > 0.0)
 302       total_time += elapsed_time;
 303
 304     /* let's see which tasks are done */
 305     xbt_dynar_foreach(all_existing_models, iter, model) {
 306       while ((action = surf_model_extract_done_action_set(model))) {
 307         task = (SD_task_t) action->getData();
 308         task->start_time = task->surf_action->getStartTime();
 309
 310         task->finish_time = surf_get_clock();
 311         XBT_VERB("Task '%s' done", SD_task_get_name(task));
 312         XBT_DEBUG("Calling __SD_task_just_done");
 313         __SD_task_just_done(task);
 314         XBT_DEBUG("__SD_task_just_done called on task '%s'",
 315                SD_task_get_name(task));
 316
 317         /* the state has changed */
 318         xbt_swag_insert(task,sd_global->return_set);
 319
 320         /* remove the dependencies after this task */
 321         xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
 322           dst = dependency->dst;
 323           if (dst->unsatisfied_dependencies > 0)
 324             dst->unsatisfied_dependencies--;
 325           if (dst->is_not_ready > 0)
 326             dst->is_not_ready--;
 327
 328           XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
 329              SD_task_get_name(dst), dst->unsatisfied_dependencies,
 330              dst->is_not_ready);
 331
 332           if (!(dst->unsatisfied_dependencies)) {
 333             if (__SD_task_is_scheduled(dst))
 334               __SD_task_set_state(dst, SD_RUNNABLE);
 335             else
 336               __SD_task_set_state(dst, SD_SCHEDULABLE);
 337           }
 338
 339           if (__SD_task_is_not_scheduled(dst) && !(dst->is_not_ready)) {
 340             __SD_task_set_state(dst, SD_SCHEDULABLE);
 341           }
 342
 343           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
 344             SD_dependency_t comm_dep;
 345             SD_task_t comm_dst;
 346             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
 347             comm_dst = comm_dep->dst;
 348             if (__SD_task_is_not_scheduled(comm_dst) &&
 349                 comm_dst->is_not_ready > 0) {
 350               comm_dst->is_not_ready--;
 351
 352             XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
 353                SD_task_get_name(dst), SD_task_get_name(comm_dst),
 354                comm_dst->is_not_ready);
 355
 356               if (!(comm_dst->is_not_ready)) {
 357                 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
 358               }
 359             }
 360           }
 361
 362           /* is dst runnable now? */
 363           if (__SD_task_is_runnable(dst)
 364               && !sd_global->watch_point_reached) {
 365             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
 366             if (__SD_task_try_to_run(dst))
 367               xbt_swag_insert(dst,sd_global->return_set);
 368           }
 369         }
 370       }
 371
 372       /* let's see which tasks have just failed */
 373       while ((action = surf_model_extract_failed_action_set(model))) {
 374         task = (SD_task_t) action->getData();
 375         task->start_time = surf_action_get_start_time(task->surf_action);
 376         task->finish_time = surf_get_clock();
 377         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
 378         __SD_task_set_state(task, SD_FAILED);
 379         action->unref();
 380         task->surf_action = NULL;
 381
 382         xbt_swag_insert(task,sd_global->return_set);
 383       }
 384     }
 385   }
 386
 387   if (!sd_global->watch_point_reached && how_long<0){
 388     if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
 389         XBT_WARN("Simulation is finished but %d tasks are still not done",
 390             (sd_global->task_number - xbt_swag_size(sd_global->done_task_set)));
 391         xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
 392                 XBT_WARN("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
 393     }
 394       xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
 395                 XBT_WARN("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
 396   }
 397         xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
 398                 XBT_WARN("%s is in SD_SCHEDULED state", SD_task_get_name(task));
 399          }
 400     }
 401   }
 402
 403   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
 404          elapsed_time, total_time, sd_global->watch_point_reached);
 405   XBT_DEBUG("current time = %f", surf_get_clock());
 406
 407   return sd_global->return_set;
 408 }
 409
 410 /**
 411  * \brief Returns the current clock
 412  *
 413  * \return the current clock, in second
 414  */
 415 double SD_get_clock(void) {
 416   return surf_get_clock();
 417 }
 418
 419 /**
 420  * \brief Destroys all SD internal data
 421  *
 422  * This function should be called when the simulation is over. Don't forget
 423  * to destroy too.
 424  *
 425  * \see SD_init(), SD_task_destroy()
 426  */
 427 void SD_exit(void)
 428 {
 429   TRACE_surf_resource_utilization_release();
 430
 431   xbt_mallocator_free(sd_global->task_mallocator);
 432
 433   XBT_DEBUG("Destroying workstation and link arrays...");
 434   xbt_free(sd_global->workstation_list);
 435   xbt_free(sd_global->link_list);
 436   xbt_free(sd_global->recyclable_route);
 437
 438   XBT_DEBUG("Destroying the swags...");
 439   xbt_swag_free(sd_global->not_scheduled_task_set);
 440   xbt_swag_free(sd_global->schedulable_task_set);
 441   xbt_swag_free(sd_global->scheduled_task_set);
 442   xbt_swag_free(sd_global->runnable_task_set);
 443   xbt_swag_free(sd_global->in_fifo_task_set);
 444   xbt_swag_free(sd_global->running_task_set);
 445   xbt_swag_free(sd_global->done_task_set);
 446   xbt_swag_free(sd_global->failed_task_set);
 447   xbt_swag_free(sd_global->return_set);
 448
 449   TRACE_end();
 450
 451   xbt_free(sd_global);
 452   sd_global = NULL;
 453
 454 #ifdef HAVE_JEDULE
 455   jedule_sd_dump();
 456   jedule_sd_cleanup();
 457   jedule_sd_exit();
 458 #endif
 459
 460   XBT_DEBUG("Exiting Surf...");
 461   surf_exit();
 462 }