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