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->initial_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
  63   sd_global->executable_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
  64   sd_global->completed_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
  65
  66   sd_global->return_set =
  67       xbt_swag_new(xbt_swag_offset(task, return_hookup));
  68   sd_global->task_number = 0;
  69
  70   surf_init(argc, argv);
  71
  72   xbt_cfg_setdefault_string(_sg_cfg_set, "host/model",
  73                             "ptask_L07");
  74
  75 #ifdef HAVE_JEDULE
  76   jedule_sd_init();
  77 #endif
  78
  79   XBT_DEBUG("ADD SD LEVELS");
  80   SD_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,__SD_storage_destroy);
  81
  82   if (_sg_cfg_exit_asap) {
  83     SD_exit();
  84     exit(0);
  85   }
  86 }
  87
  88 /** \brief set a configuration variable
  89  *
  90  * Do --help on any simgrid binary to see the list of currently existing configuration variables, and see Section @ref options.
  91  *
  92  * Example:
  93  * SD_config("host/model","default");
  94  */
  95 void SD_config(const char *key, const char *value){
  96   xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
  97   xbt_cfg_set_as_string(_sg_cfg_set, key, value);
  98 }
  99
 100
 101 /**
 102  * \brief Reinits the application part of the simulation (experimental feature)
 103  *
 104  * This function allows you to run several simulations on the same platform
 105  * by resetting the part describing the application.
 106  *
 107  * @warning: this function is still experimental and not perfect. For example,
 108  * the simulation clock (and traces usage) is not reset. So, do not use it if
 109  * you use traces in your simulation, and do not use absolute timing after using it.
 110  * That being said, this function is still precious if you want to compare a bunch of
 111  * heuristics on the same platforms.
 112  */
 113 void SD_application_reinit(void)
 114 {
 115
 116 //  s_SD_task_t task;
 117
 118 //  SD_task_t done_task, next_done_task;
 119   xbt_die("This function is not working since the C++ links and others. Please report the problem if you really need that function.");
 120
 121    XBT_DEBUG("Recreating the swags...");
 122
 123 //  xbt_swag_foreach_safe(done_task, next_done_task, sd_global->done_task_set){
 124 //    if (xbt_dynar_is_empty(done_task->tasks_before)){
 125 //      __SD_task_set_state(done_task, SD_SCHEDULABLE);
 126 //    } else{
 127 //      __SD_task_set_state(done_task, SD_NOT_SCHEDULED);
 128 //      done_task->unsatisfied_dependencies =
 129 //        xbt_dynar_length(done_task->tasks_before);
 130 //      done_task->is_not_ready = done_task->unsatisfied_dependencies;
 131 //    }
 132 //    free(done_task->workstation_list);
 133 //    done_task->workstation_list = NULL;
 134 //    done_task->workstation_nb = 0;
 135 //  }
 136
 137   sd_global->task_number = 0;
 138
 139
 140 #ifdef HAVE_JEDULE
 141   jedule_sd_dump();
 142   jedule_sd_cleanup();
 143   jedule_sd_init();
 144 #endif
 145 }
 146
 147 /**
 148  * \brief Creates the environment
 149  *
 150  * The environment (i.e. the \ref SD_workstation_management "workstations"
 151  * and the \ref SD_link_management "links") is created with the data stored
 152  * in the given XML platform file.
 153  *
 154  * \param platform_file name of an XML file describing the environment to create
 155  * \see SD_workstation_management, SD_link_management
 156  *
 157  * The XML file follows this DTD:
 158  *
 159  *     \include simgrid.dtd
 160  *
 161  * Here is a small example of such a platform:
 162  *
 163  *     \include small_platform.xml
 164  */
 165 void SD_create_environment(const char *platform_file)
 166 {
 167   xbt_lib_cursor_t cursor = NULL;
 168   char *name = NULL;
 169   void **surf_storage = NULL;
 170
 171   parse_platform_file(platform_file);
 172
 173   /* now let's create the SD wrappers for workstations, storages and links */
 174   {
 175     xbt_dict_cursor_t cursor = NULL;
 176     simgrid_Host* host = NULL;
 177     xbt_dict_foreach(host_list, cursor, name, host){
 178         __SD_workstation_create((const char*)name);
 179     }
 180   }
 181
 182   xbt_lib_foreach(storage_lib, cursor, name, surf_storage) {
 183   if(surf_storage[SURF_STORAGE_LEVEL])
 184     __SD_storage_create(surf_storage[SURF_STORAGE_LEVEL], NULL);
 185   }
 186
 187
 188   XBT_DEBUG("Workstation number: %d, link number: %d",
 189          SD_workstation_get_number(), SD_link_get_number());
 190 #ifdef HAVE_JEDULE
 191   jedule_setup_platform();
 192 #endif
 193 }
 194
 195 /**
 196  * \brief Launches the simulation.
 197  *
 198  * The function will execute the \ref SD_RUNNABLE runnable tasks.
 199  * If \a how_long is positive, then the simulation will be stopped either
 200  * when time reaches \a how_long or when a watch point is reached.
 201  * A non-positive value for \a how_long means no time limit, in which case
 202  * the simulation will be stopped either when a watch point is reached or
 203  * when no more task can be executed.
 204  * Then you can call SD_simulate() again.
 205  *
 206  * \param how_long maximum duration of the simulation (a negative value means no time limit)
 207  * \return a dynar of \ref SD_task_t whose state has changed.
 208  * \see SD_task_schedule(), SD_task_watch()
 209  */
 210
 211 xbt_dynar_t SD_simulate(double how_long) {
 212   xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
 213   SD_task_t task;
 214
 215   SD_simulate_swag(how_long);
 216   while( (task = (SD_task_t)xbt_swag_extract(sd_global->return_set)) != NULL) {
 217     xbt_dynar_push(changed_tasks, &task);
 218   }
 219
 220   return changed_tasks;
 221 }
 222
 223 xbt_swag_t SD_simulate_swag(double how_long) {
 224   double total_time = 0.0;      /* we stop the simulation when total_time >= how_long */
 225   double elapsed_time = 0.0;
 226   SD_task_t task, dst;
 227   SD_dependency_t dependency;
 228   surf_action_t action;
 229   unsigned int iter, depcnt;
 230   static int first_time = 1;
 231
 232   if (first_time) {
 233     XBT_VERB("Starting simulation...");
 234
 235     surf_presolve();            /* Takes traces into account */
 236     first_time = 0;
 237   }
 238
 239   XBT_VERB("Run simulation for %f seconds", how_long);
 240   sd_global->watch_point_reached = 0;
 241
 242   xbt_swag_reset(sd_global->return_set);
 243
 244   /* explore the runnable tasks */
 245   xbt_dynar_foreach(sd_global->executable_task_set , iter, task) {
 246     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
 247     if (__SD_task_try_to_run(task)){
 248       xbt_swag_insert(task,sd_global->return_set);
 249       iter--;
 250     }
 251   }
 252
 253   /* main loop */
 254   elapsed_time = 0.0;
 255   while (elapsed_time >= 0.0 &&
 256          (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
 257          !sd_global->watch_point_reached) {
 258     surf_model_t model = NULL;
 259     /* dumb variables */
 260
 261
 262     XBT_DEBUG("Total time: %f", total_time);
 263
 264     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
 265     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
 266     if (elapsed_time > 0.0)
 267       total_time += elapsed_time;
 268
 269     /* let's see which tasks are done */
 270     xbt_dynar_foreach(all_existing_models, iter, model) {
 271       while ((action = surf_model_extract_done_action_set(model))) {
 272         task = (SD_task_t) action->getData();
 273         task->start_time = task->surf_action->getStartTime();
 274
 275         task->finish_time = surf_get_clock();
 276         XBT_VERB("Task '%s' done", SD_task_get_name(task));
 277         XBT_DEBUG("Calling __SD_task_just_done");
 278         __SD_task_just_done(task);
 279         XBT_DEBUG("__SD_task_just_done called on task '%s'",
 280                SD_task_get_name(task));
 281
 282         /* the state has changed */
 283         xbt_swag_insert(task,sd_global->return_set);
 284
 285         /* remove the dependencies after this task */
 286         xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
 287           dst = dependency->dst;
 288           if (dst->unsatisfied_dependencies > 0)
 289             dst->unsatisfied_dependencies--;
 290           if (dst->is_not_ready > 0)
 291             dst->is_not_ready--;
 292
 293           XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
 294              SD_task_get_name(dst), dst->unsatisfied_dependencies,
 295              dst->is_not_ready);
 296
 297           if (!(dst->unsatisfied_dependencies)) {
 298             if (SD_task_get_state(dst) == SD_SCHEDULED)
 299               SD_task_set_state(dst, SD_RUNNABLE);
 300             else
 301               SD_task_set_state(dst, SD_SCHEDULABLE);
 302           }
 303
 304           if (SD_task_get_state(dst) == SD_NOT_SCHEDULED &&
 305               !(dst->is_not_ready)) {
 306             SD_task_set_state(dst, SD_SCHEDULABLE);
 307           }
 308
 309           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
 310             SD_dependency_t comm_dep;
 311             SD_task_t comm_dst;
 312             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
 313             comm_dst = comm_dep->dst;
 314             if (SD_task_get_state(comm_dst) == SD_NOT_SCHEDULED &&
 315                 comm_dst->is_not_ready > 0) {
 316               comm_dst->is_not_ready--;
 317
 318             XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
 319                SD_task_get_name(dst), SD_task_get_name(comm_dst),
 320                comm_dst->is_not_ready);
 321
 322               if (!(comm_dst->is_not_ready)) {
 323                 SD_task_set_state(comm_dst, SD_SCHEDULABLE);
 324               }
 325             }
 326           }
 327
 328           /* is dst runnable now? */
 329           if (SD_task_get_state(dst) == SD_RUNNABLE
 330               && !sd_global->watch_point_reached) {
 331             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
 332             if (__SD_task_try_to_run(dst))
 333               xbt_swag_insert(dst,sd_global->return_set);
 334           }
 335         }
 336       }
 337
 338       /* let's see which tasks have just failed */
 339       while ((action = surf_model_extract_failed_action_set(model))) {
 340         task = (SD_task_t) action->getData();
 341         task->start_time = surf_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         action->unref();
 346         task->surf_action = NULL;
 347
 348         xbt_swag_insert(task,sd_global->return_set);
 349       }
 350     }
 351   }
 352
 353   if (!sd_global->watch_point_reached && how_long<0){
 354     if ((int) xbt_dynar_length(sd_global->completed_task_set) <
 355          sd_global->task_number){
 356         XBT_WARN("Simulation is finished but %d tasks are still not done",
 357             (sd_global->task_number -
 358              (int) xbt_dynar_length(sd_global->completed_task_set)));
 359         static const char* state_names[] =
 360               { "SD_NOT_SCHEDULED", "SD_SCHEDULABLE", "SD_SCHEDULED",
 361                 "SD_RUNNABLE", "SD_IN_INFO", "SD_RUNNING", "SD_DONE",
 362                 "SD_FAILED" };
 363         xbt_dynar_foreach(sd_global->initial_task_set, iter, task){
 364           XBT_WARN("%s is in %s state", SD_task_get_name(task),
 365                    state_names[SD_task_get_state(task)]);
 366         }
 367     }
 368   }
 369
 370   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
 371          elapsed_time, total_time, sd_global->watch_point_reached);
 372   XBT_DEBUG("current time = %f", surf_get_clock());
 373
 374   return sd_global->return_set;
 375 }
 376
 377 /**
 378  * \brief Returns the current clock
 379  *
 380  * \return the current clock, in second
 381  */
 382 double SD_get_clock(void) {
 383   return surf_get_clock();
 384 }
 385
 386 /**
 387  * \brief Destroys all SD internal data
 388  *
 389  * This function should be called when the simulation is over. Don't forget
 390  * to destroy too.
 391  *
 392  * \see SD_init(), SD_task_destroy()
 393  */
 394 void SD_exit(void)
 395 {
 396   TRACE_surf_resource_utilization_release();
 397
 398   xbt_mallocator_free(sd_global->task_mallocator);
 399
 400   XBT_DEBUG("Destroying workstation and link arrays...");
 401   xbt_free(sd_global->workstation_list);
 402   xbt_free(sd_global->link_list);
 403   xbt_free(sd_global->recyclable_route);
 404
 405   XBT_DEBUG("Destroying the swags...");
 406   xbt_dynar_free_container(&(sd_global->initial_task_set));
 407   xbt_dynar_free_container(&(sd_global->executable_task_set));
 408   xbt_dynar_free_container(&(sd_global->completed_task_set));
 409   xbt_swag_free(sd_global->return_set);
 410
 411   TRACE_end();
 412
 413   xbt_free(sd_global);
 414   sd_global = NULL;
 415
 416 #ifdef HAVE_JEDULE
 417   jedule_sd_dump();
 418   jedule_sd_cleanup();
 419   jedule_sd_exit();
 420 #endif
 421
 422   XBT_DEBUG("Exiting Surf...");
 423   surf_exit();
 424 }