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 "xbt/sysdep.h"
   9 #include "xbt/dynar.h"
  10 #include "surf/surf.h"
  11 #include "xbt/ex.h"
  12 #include "xbt/log.h"
  13 #include "xbt/str.h"
  14 #include "xbt/config.h"
  15 #include "instr/instr_private.h"
  16 #include "surf/surfxml_parse.h"
  17 #ifdef HAVE_LUA
  18 #include <lua.h>
  19 #include <lauxlib.h>
  20 #include <lualib.h>
  21 #endif
  22
  23 #ifdef HAVE_JEDULE
  24 #include "instr/jedule/jedule_sd_binding.h"
  25 #endif
  26
  27 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
  28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd,
  29                                 "Logging specific to SimDag (kernel)");
  30
  31 SD_global_t sd_global = NULL;
  32
  33 XBT_LOG_EXTERNAL_CATEGORY(sd_kernel);
  34 XBT_LOG_EXTERNAL_CATEGORY(sd_task);
  35 XBT_LOG_EXTERNAL_CATEGORY(sd_workstation);
  36
  37 /**
  38  * \brief Initialises SD internal data
  39  *
  40  * This function must be called before any other SD function. Then you
  41  * should call SD_create_environment().
  42  *
  43  * \param argc argument number
  44  * \param argv argument list
  45  * \see SD_create_environment(), SD_exit()
  46  */
  47 void SD_init(int *argc, char **argv)
  48 {
  49 #ifdef HAVE_TRACING
  50   TRACE_global_init(argc, argv);
  51 #endif
  52
  53   s_SD_task_t task;
  54
  55   xbt_assert0(!SD_INITIALISED(), "SD_init() already called");
  56
  57   /* Connect our log channels: that must be done manually under windows */
  58   XBT_LOG_CONNECT(sd_kernel, sd);
  59   XBT_LOG_CONNECT(sd_task, sd);
  60   XBT_LOG_CONNECT(sd_workstation, sd);
  61
  62
  63   sd_global = xbt_new(s_SD_global_t, 1);
  64   sd_global->workstations = xbt_dict_new();
  65   sd_global->workstation_count = 0;
  66   sd_global->workstation_list = NULL;
  67   sd_global->links = xbt_dict_new();
  68   sd_global->link_count = 0;
  69   sd_global->link_list = NULL;
  70   sd_global->recyclable_route = NULL;
  71   sd_global->watch_point_reached = 0;
  72
  73   sd_global->not_scheduled_task_set =
  74       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  75   sd_global->schedulable_task_set =
  76       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  77   sd_global->scheduled_task_set =
  78       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  79   sd_global->runnable_task_set =
  80       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  81   sd_global->in_fifo_task_set =
  82       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  83   sd_global->running_task_set =
  84       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  85   sd_global->done_task_set =
  86       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  87   sd_global->failed_task_set =
  88       xbt_swag_new(xbt_swag_offset(task, state_hookup));
  89   sd_global->task_number = 0;
  90
  91   surf_init(argc, argv);
  92
  93   xbt_cfg_setdefault_string(_surf_cfg_set, "workstation/model",
  94                             "ptask_L07");
  95
  96 #ifdef HAVE_TRACING
  97   TRACE_start ();
  98 #endif
  99
 100 #ifdef HAVE_JEDULE
 101   jedule_sd_init();
 102 #endif
 103 }
 104
 105 /**
 106  * \brief Reinits the application part of the simulation (experimental feature)
 107  *
 108  * This function allows you to run several simulations on the same platform
 109  * by resetting the part describing the application.
 110  *
 111  * @warning: this function is still experimental and not perfect. For example,
 112  * the simulation clock (and traces usage) is not reset. So, do not use it if
 113  * you use traces in your simulation, and do not use absolute timing after using it.
 114  * That being said, this function is still precious if you want to compare a bunch of
 115  * heuristics on the same platforms.
 116  */
 117 void SD_application_reinit(void)
 118 {
 119
 120   s_SD_task_t task;
 121
 122   if (SD_INITIALISED()) {
 123     XBT_DEBUG("Recreating the swags...");
 124     xbt_swag_free(sd_global->not_scheduled_task_set);
 125     xbt_swag_free(sd_global->schedulable_task_set);
 126     xbt_swag_free(sd_global->scheduled_task_set);
 127     xbt_swag_free(sd_global->runnable_task_set);
 128     xbt_swag_free(sd_global->in_fifo_task_set);
 129     xbt_swag_free(sd_global->running_task_set);
 130     xbt_swag_free(sd_global->done_task_set);
 131     xbt_swag_free(sd_global->failed_task_set);
 132
 133     sd_global->not_scheduled_task_set =
 134         xbt_swag_new(xbt_swag_offset(task, state_hookup));
 135     sd_global->schedulable_task_set =
 136         xbt_swag_new(xbt_swag_offset(task, state_hookup));
 137     sd_global->scheduled_task_set =
 138         xbt_swag_new(xbt_swag_offset(task, state_hookup));
 139     sd_global->runnable_task_set =
 140         xbt_swag_new(xbt_swag_offset(task, state_hookup));
 141     sd_global->in_fifo_task_set =
 142         xbt_swag_new(xbt_swag_offset(task, state_hookup));
 143     sd_global->running_task_set =
 144         xbt_swag_new(xbt_swag_offset(task, state_hookup));
 145     sd_global->done_task_set =
 146         xbt_swag_new(xbt_swag_offset(task, state_hookup));
 147     sd_global->failed_task_set =
 148         xbt_swag_new(xbt_swag_offset(task, state_hookup));
 149     sd_global->task_number = 0;
 150
 151 #ifdef HAVE_JEDULE
 152     jedule_sd_cleanup();
 153     jedule_sd_init();
 154 #endif
 155
 156   } else {
 157     XBT_WARN("SD_application_reinit called before initialization of SimDag");
 158     /* we cannot use exceptions here because xbt is not running! */
 159   }
 160
 161 }
 162
 163 /**
 164  * \brief Creates the environment
 165  *
 166  * The environment (i.e. the \ref SD_workstation_management "workstations" and the
 167  * \ref SD_link_management "links") is created with the data stored in the given XML
 168  * platform file.
 169  *
 170  * \param platform_file name of an XML file describing the environment to create
 171  * \see SD_workstation_management, SD_link_management
 172  *
 173  * The XML file follows this DTD:
 174  *
 175  *     \include simgrid.dtd
 176  *
 177  * Here is a small example of such a platform:
 178  *
 179  *     \include small_platform.xml
 180  */
 181 void SD_create_environment(const char *platform_file)
 182 {
 183   xbt_dict_cursor_t cursor = NULL;
 184   char *name = NULL;
 185   void *surf_workstation = NULL;
 186   void *surf_link = NULL;
 187
 188   platform_filename = bprintf("%s",platform_file);
 189
 190   // Reset callbacks
 191   surf_parse_reset_callbacks();
 192   // Add config callbacks
 193   surf_parse_add_callback_config();
 194   SD_CHECK_INIT_DONE();
 195   parse_platform_file(platform_file);
 196   surf_config_models_create_elms();
 197
 198   /* now let's create the SD wrappers for workstations and links */
 199   xbt_dict_foreach(surf_model_resource_set(surf_workstation_model), cursor,
 200                    name, surf_workstation) {
 201     __SD_workstation_create(surf_workstation, NULL);
 202   }
 203
 204   xbt_dict_foreach(surf_model_resource_set(surf_network_model), cursor,
 205                    name, surf_link) {
 206     __SD_link_create(surf_link, NULL);
 207   }
 208
 209   XBT_DEBUG("Workstation number: %d, link number: %d",
 210          SD_workstation_get_number(), SD_link_get_number());
 211 #ifdef HAVE_JEDULE
 212   jedule_setup_platform();
 213 #endif
 214 }
 215
 216 /**
 217  * \brief Launches the simulation.
 218  *
 219  * The function will execute the \ref SD_RUNNABLE runnable tasks.
 220  * If \a how_long is positive, then the simulation will be stopped either
 221  * when time reaches \a how_long or when a watch point is reached.
 222  * A nonpositive value for \a how_long means no time limit, in which case
 223  * the simulation will be stopped either when a watch point is reached or
 224  * when no more task can be executed.
 225  * Then you can call SD_simulate() again.
 226  *
 227  * \param how_long maximum duration of the simulation (a negative value means no time limit)
 228  * \return a NULL-terminated array of \ref SD_task_t whose state has changed.
 229  * \see SD_task_schedule(), SD_task_watch()
 230  */
 231 xbt_dynar_t SD_simulate(double how_long)
 232 {
 233   double total_time = 0.0;      /* we stop the simulation when total_time >= how_long */
 234   double elapsed_time = 0.0;
 235   SD_task_t task, task_safe, dst;
 236   SD_dependency_t dependency;
 237   surf_action_t action;
 238   xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
 239   unsigned int iter, depcnt;
 240   static int first_time = 1;
 241
 242   SD_CHECK_INIT_DONE();
 243
 244    if (first_time) {
 245     XBT_VERB("Starting simulation...");
 246
 247     surf_presolve();            /* Takes traces into account */
 248     first_time = 0;
 249   }
 250
 251   sd_global->watch_point_reached = 0;
 252
 253   /* explore the runnable tasks */
 254   xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
 255     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
 256     if (__SD_task_try_to_run(task)
 257         && !xbt_dynar_member(changed_tasks, &task))
 258       xbt_dynar_push(changed_tasks, &task);
 259   }
 260
 261   /* main loop */
 262   elapsed_time = 0.0;
 263   while (elapsed_time >= 0.0 &&
 264          (how_long < 0.0 || total_time < how_long) &&
 265          !sd_global->watch_point_reached) {
 266     surf_model_t model = NULL;
 267     /* dumb variables */
 268
 269
 270     XBT_DEBUG("Total time: %f", total_time);
 271
 272     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long : -1.0);
 273     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
 274     if (elapsed_time > 0.0)
 275       total_time += elapsed_time;
 276
 277     /* let's see which tasks are done */
 278     xbt_dynar_foreach(model_list, iter, model) {
 279       while ((action = xbt_swag_extract(model->states.done_action_set))) {
 280         task = action->data;
 281         task->start_time =
 282             surf_workstation_model->
 283             action_get_start_time(task->surf_action);
 284         task->finish_time = surf_get_clock();
 285         XBT_VERB("Task '%s' done", SD_task_get_name(task));
 286         XBT_DEBUG("Calling __SD_task_just_done");
 287         __SD_task_just_done(task);
 288         XBT_DEBUG("__SD_task_just_done called on task '%s'",
 289                SD_task_get_name(task));
 290
 291         /* the state has changed */
 292         if (!xbt_dynar_member(changed_tasks, &task))
 293           xbt_dynar_push(changed_tasks, &task);
 294
 295         /* remove the dependencies after this task */
 296         xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
 297           dst = dependency->dst;
 298           if (dst->unsatisfied_dependencies > 0)
 299             dst->unsatisfied_dependencies--;
 300           if (dst->is_not_ready > 0)
 301             dst->is_not_ready--;
 302
 303           if (!(dst->unsatisfied_dependencies)) {
 304             if (__SD_task_is_scheduled(dst))
 305               __SD_task_set_state(dst, SD_RUNNABLE);
 306             else
 307               __SD_task_set_state(dst, SD_SCHEDULABLE);
 308           }
 309
 310           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
 311             SD_dependency_t comm_dep;
 312             SD_task_t comm_dst;
 313             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
 314             comm_dst = comm_dep->dst;
 315             if (__SD_task_is_not_scheduled(comm_dst) &&
 316                 comm_dst->is_not_ready > 0) {
 317               comm_dst->is_not_ready--;
 318
 319               if (!(comm_dst->is_not_ready)) {
 320                 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
 321               }
 322             }
 323           }
 324
 325           /* is dst runnable now? */
 326           if (__SD_task_is_runnable(dst)
 327               && !sd_global->watch_point_reached) {
 328             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
 329             if (__SD_task_try_to_run(dst) &&
 330                 !xbt_dynar_member(changed_tasks, &task))
 331               xbt_dynar_push(changed_tasks, &task);
 332           }
 333         }
 334       }
 335
 336       /* let's see which tasks have just failed */
 337       while ((action = xbt_swag_extract(model->states.failed_action_set))) {
 338         task = action->data;
 339         task->start_time =
 340             surf_workstation_model->
 341             action_get_start_time(task->surf_action);
 342         task->finish_time = surf_get_clock();
 343         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
 344         __SD_task_set_state(task, SD_FAILED);
 345         surf_workstation_model->action_unref(action);
 346         task->surf_action = NULL;
 347
 348         if (!xbt_dynar_member(changed_tasks, &task))
 349           xbt_dynar_push(changed_tasks, &task);
 350       }
 351     }
 352   }
 353
 354   if (!sd_global->watch_point_reached && how_long<0){
 355     if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
 356         XBT_WARN("Simulation is finished but some tasks are still not done");
 357         xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
 358                 XBT_WARN("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
 359                 }
 360         xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
 361                 XBT_WARN("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
 362         }
 363         xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
 364                 XBT_WARN("%s is in SD_SCHEDULED state", SD_task_get_name(task));
 365         }
 366     }
 367   }
 368
 369   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
 370          elapsed_time, total_time, sd_global->watch_point_reached);
 371   XBT_DEBUG("current time = %f", surf_get_clock());
 372
 373   return changed_tasks;
 374 }
 375
 376 /**
 377  * \brief Returns the current clock
 378  *
 379  * \return the current clock, in second
 380  */
 381 double SD_get_clock(void)
 382 {
 383   SD_CHECK_INIT_DONE();
 384
 385   return surf_get_clock();
 386 }
 387
 388 /**
 389  * \brief Destroys all SD internal data
 390  *
 391  * This function should be called when the simulation is over. Don't forget also to destroy
 392  * the tasks.
 393  *
 394  * \see SD_init(), SD_task_destroy()
 395  */
 396 void SD_exit(void)
 397 {
 398 #ifdef HAVE_TRACING
 399   TRACE_surf_release();
 400 #endif
 401   if (SD_INITIALISED()) {
 402     XBT_DEBUG("Destroying workstation and link dictionaries...");
 403     xbt_dict_free(&sd_global->workstations);
 404     xbt_dict_free(&sd_global->links);
 405
 406     XBT_DEBUG("Destroying workstation and link arrays if necessary...");
 407     if (sd_global->workstation_list != NULL)
 408       xbt_free(sd_global->workstation_list);
 409
 410     if (sd_global->link_list != NULL)
 411       xbt_free(sd_global->link_list);
 412
 413     if (sd_global->recyclable_route != NULL)
 414       xbt_free(sd_global->recyclable_route);
 415
 416     XBT_DEBUG("Destroying the swags...");
 417     xbt_swag_free(sd_global->not_scheduled_task_set);
 418     xbt_swag_free(sd_global->schedulable_task_set);
 419     xbt_swag_free(sd_global->scheduled_task_set);
 420     xbt_swag_free(sd_global->runnable_task_set);
 421     xbt_swag_free(sd_global->in_fifo_task_set);
 422     xbt_swag_free(sd_global->running_task_set);
 423     xbt_swag_free(sd_global->done_task_set);
 424     xbt_swag_free(sd_global->failed_task_set);
 425
 426     xbt_free(sd_global);
 427     sd_global = NULL;
 428
 429 #ifdef HAVE_TRACING
 430   TRACE_end();
 431 #endif
 432 #ifdef HAVE_JEDULE
 433   jedule_sd_dump();
 434   jedule_sd_cleanup();
 435 #endif
 436
 437     XBT_DEBUG("Exiting Surf...");
 438     surf_exit();
 439   } else {
 440     XBT_WARN("SD_exit() called, but SimDag is not running");
 441     /* we cannot use exceptions here because xbt is not running! */
 442   }
 443 }
 444
 445 /**
 446  * \bried load script file
 447  */
 448
 449 void SD_load_environment_script(const char *script_file)
 450 {
 451 #ifdef HAVE_LUA
 452   lua_State *L = lua_open();
 453   luaL_openlibs(L);
 454
 455   if (luaL_loadfile(L, script_file) || lua_pcall(L, 0, 0, 0)) {
 456     printf("error: %s\n", lua_tostring(L, -1));
 457     return;
 458   }
 459 #else
 460   xbt_die
 461       ("Lua is not available!! to call SD_load_environment_script, lua should be available...");
 462 #endif
 463   return;
 464 }