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