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