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 "instr/instr_interface.h"
   8 #include "simgrid/sg_config.h"
   9 #include "simgrid/host.h"
  10 #include "src/simdag/simdag_private.h"
  11 #include "src/surf/surf_interface.hpp"
  12
  13 #include "xbt/dynar.h"
  14 #include "xbt/log.h"
  15 #include "xbt/sysdep.h"
  16
  17 #ifdef HAVE_JEDULE
  18 #include "simgrid/jedule/jedule_sd_binding.h"
  19 #endif
  20
  21 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd, "Logging specific to SimDag (kernel)");
  23
  24 SD_global_t sd_global = NULL;
  25
  26 /**
  27  * \brief Initializes SD internal data
  28  *
  29  * This function must be called before any other SD function. Then you should call SD_create_environment().
  30  *
  31  * \param argc argument number
  32  * \param argv argument list
  33  * \see SD_create_environment(), SD_exit()
  34  */
  35 void SD_init(int *argc, char **argv)
  36 {
  37   TRACE_global_init(argc, argv);
  38
  39   xbt_assert(sd_global == NULL, "SD_init() already called");
  40
  41   sd_global = xbt_new(s_SD_global_t, 1);
  42   sd_global->watch_point_reached = 0;
  43
  44   sd_global->task_mallocator=xbt_mallocator_new(65536, SD_task_new_f, SD_task_free_f, SD_task_recycle_f);
  45
  46   sd_global->initial_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
  47   sd_global->executable_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
  48   sd_global->completed_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
  49   sd_global->return_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
  50
  51   surf_init(argc, argv);
  52
  53   xbt_cfg_setdefault_string(_sg_cfg_set, "host/model",
  54                             "ptask_L07");
  55
  56 #ifdef HAVE_JEDULE
  57   jedule_sd_init();
  58 #endif
  59
  60   if (_sg_cfg_exit_asap) {
  61     SD_exit();
  62     exit(0);
  63   }
  64 }
  65
  66 /** \brief set a configuration variable
  67  *
  68  * Do --help on any simgrid binary to see the list of currently existing configuration variables, and
  69  * see Section @ref options.
  70  *
  71  * Example:
  72  * SD_config("host/model","default");
  73  */
  74 void SD_config(const char *key, const char *value){
  75   xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
  76   xbt_cfg_set_as_string(_sg_cfg_set, key, value);
  77 }
  78
  79 /**
  80  * \brief Reinits the application part of the simulation (experimental feature)
  81  *
  82  * This function allows you to run several simulations on the same platform
  83  * by resetting the part describing the application.
  84  *
  85  * @warning: this function is still experimental and not perfect. For example,
  86  * the simulation clock (and traces usage) is not reset. So, do not use it if
  87  * you use traces in your simulation, and do not use absolute timing after
  88  * using it.
  89  * That being said, this function is still precious if you want to compare a
  90  * bunch of heuristics on the same platforms.
  91  */
  92 void SD_application_reinit(void)
  93 {
  94   xbt_die("This function is not working since the C++ links and others. Please report the problem if you really need that function.");
  95 }
  96
  97 /**
  98  * \brief Creates the environment
  99  *
 100  * The environment (i.e. the \ref sg_host_management "hosts" and the \ref SD_link_management "links") is created with
 101  * the data stored in the given XML platform file.
 102  *
 103  * \param platform_file name of an XML file describing the environment to create
 104  * \see sg_host_management, SD_link_management
 105  *
 106  * The XML file follows this DTD:
 107  *
 108  *     \include simgrid.dtd
 109  *
 110  * Here is a small example of such a platform:
 111  *
 112  *     \include small_platform.xml
 113  */
 114 void SD_create_environment(const char *platform_file)
 115 {
 116   parse_platform_file(platform_file);
 117
 118   XBT_DEBUG("Workstation number: %zu, link number: %d", sg_host_count(), sg_link_count());
 119 #ifdef HAVE_JEDULE
 120   jedule_setup_platform();
 121 #endif
 122   XBT_VERB("Starting simulation...");
 123   surf_presolve();            /* Takes traces into account */
 124 }
 125
 126 /**
 127  * \brief Launches the simulation.
 128  *
 129  * The function will execute the \ref SD_RUNNABLE runnable tasks.
 130  * If \a how_long is positive, then the simulation will be stopped either when time reaches \a how_long or when a watch
 131  * point is reached.
 132  * A non-positive value for \a how_long means no time limit, in which case the simulation will be stopped either when a
 133  * watch point is reached or when no more task can be executed.
 134  * Then you can call SD_simulate() again.
 135  *
 136  * \param how_long maximum duration of the simulation (a negative value means no time limit)
 137  * \return a dynar of \ref SD_task_t whose state has changed.
 138  * \see SD_task_schedule(), SD_task_watch()
 139  */
 140
 141 xbt_dynar_t SD_simulate(double how_long) {
 142   /* we stop the simulation when total_time >= how_long */
 143   double total_time = 0.0;
 144   double elapsed_time = 0.0;
 145   SD_task_t task, dst;
 146   SD_dependency_t dependency;
 147   surf_action_t action;
 148   unsigned int iter, depcnt;
 149
 150   XBT_VERB("Run simulation for %f seconds", how_long);
 151   sd_global->watch_point_reached = 0;
 152
 153   xbt_dynar_reset(sd_global->return_set);
 154
 155   /* explore the runnable tasks */
 156   xbt_dynar_foreach(sd_global->executable_task_set , iter, task) {
 157     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
 158     SD_task_run(task);
 159     xbt_dynar_push(sd_global->return_set, &task);
 160     iter--;
 161   }
 162
 163   /* main loop */
 164   elapsed_time = 0.0;
 165   while (elapsed_time >= 0.0 && (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
 166          !sd_global->watch_point_reached) {
 167     surf_model_t model = NULL;
 168
 169     XBT_DEBUG("Total time: %f", total_time);
 170
 171     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
 172     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
 173     if (elapsed_time > 0.0)
 174       total_time += elapsed_time;
 175
 176     /* let's see which tasks are done */
 177     xbt_dynar_foreach(all_existing_models, iter, model) {
 178       while ((action = surf_model_extract_done_action_set(model))) {
 179         task = (SD_task_t) action->getData();
 180         task->start_time = task->surf_action->getStartTime();
 181
 182         task->finish_time = surf_get_clock();
 183         XBT_VERB("Task '%s' done", SD_task_get_name(task));
 184         SD_task_set_state(task, SD_DONE);
 185         task->surf_action->unref();
 186         task->surf_action = NULL;
 187
 188         /* the state has changed. Add it only if it's the first change */
 189         if (!xbt_dynar_member(sd_global->return_set, &task)) {
 190           xbt_dynar_push(sd_global->return_set, &task);
 191         }
 192
 193         /* remove the dependencies after this task */
 194         xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
 195           dst = dependency->dst;
 196           dst->unsatisfied_dependencies--;
 197           if (dst->is_not_ready > 0)
 198             dst->is_not_ready--;
 199
 200           XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
 201              SD_task_get_name(dst), dst->unsatisfied_dependencies, dst->is_not_ready);
 202
 203           if (!(dst->unsatisfied_dependencies)) {
 204             if (SD_task_get_state(dst) == SD_SCHEDULED)
 205               SD_task_set_state(dst, SD_RUNNABLE);
 206             else
 207               SD_task_set_state(dst, SD_SCHEDULABLE);
 208           }
 209
 210           if (SD_task_get_state(dst) == SD_NOT_SCHEDULED && !(dst->is_not_ready)) {
 211             SD_task_set_state(dst, SD_SCHEDULABLE);
 212           }
 213
 214           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
 215             SD_dependency_t comm_dep;
 216             SD_task_t comm_dst;
 217             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
 218             comm_dst = comm_dep->dst;
 219             if (SD_task_get_state(comm_dst) == SD_NOT_SCHEDULED && comm_dst->is_not_ready > 0) {
 220               comm_dst->is_not_ready--;
 221
 222             XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
 223                SD_task_get_name(dst), SD_task_get_name(comm_dst), comm_dst->is_not_ready);
 224
 225               if (!(comm_dst->is_not_ready)) {
 226                 SD_task_set_state(comm_dst, SD_SCHEDULABLE);
 227               }
 228             }
 229           }
 230
 231           /* is dst runnable now? */
 232           if (SD_task_get_state(dst) == SD_RUNNABLE && !sd_global->watch_point_reached) {
 233             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
 234             SD_task_run(dst);
 235             xbt_dynar_push(sd_global->return_set, &dst);
 236           }
 237         }
 238       }
 239
 240       /* let's see which tasks have just failed */
 241       while ((action = surf_model_extract_failed_action_set(model))) {
 242         task = (SD_task_t) action->getData();
 243         task->start_time = surf_action_get_start_time(task->surf_action);
 244         task->finish_time = surf_get_clock();
 245         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
 246         SD_task_set_state(task, SD_FAILED);
 247         action->unref();
 248         task->surf_action = NULL;
 249
 250         xbt_dynar_push(sd_global->return_set, &task);
 251       }
 252     }
 253   }
 254
 255   if (!sd_global->watch_point_reached && how_long<0){
 256     if (!xbt_dynar_is_empty(sd_global->initial_task_set)) {
 257         XBT_WARN("Simulation is finished but %lu tasks are still not done",
 258             xbt_dynar_length(sd_global->initial_task_set));
 259         static const char* state_names[] =
 260           { "SD_NOT_SCHEDULED", "SD_SCHEDULABLE", "SD_SCHEDULED", "SD_RUNNABLE", "SD_RUNNING", "SD_DONE","SD_FAILED" };
 261         xbt_dynar_foreach(sd_global->initial_task_set, iter, task){
 262           XBT_WARN("%s is in %s state", SD_task_get_name(task), state_names[SD_task_get_state(task)]);
 263         }
 264     }
 265   }
 266
 267   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
 268          elapsed_time, total_time, sd_global->watch_point_reached);
 269   XBT_DEBUG("current time = %f", surf_get_clock());
 270
 271   return sd_global->return_set;
 272 }
 273
 274 /** @brief Returns the current clock, in seconds */
 275 double SD_get_clock(void) {
 276   return surf_get_clock();
 277 }
 278
 279 /**
 280  * \brief Destroys all SD internal data
 281  *
 282  * This function should be called when the simulation is over. Don't forget to destroy too.
 283  *
 284  * \see SD_init(), SD_task_destroy()
 285  */
 286 void SD_exit(void)
 287 {
 288   TRACE_surf_resource_utilization_release();
 289   TRACE_end();
 290
 291 #ifdef HAVE_JEDULE
 292   jedule_sd_cleanup();
 293   jedule_sd_exit();
 294 #endif
 295
 296   xbt_mallocator_free(sd_global->task_mallocator);
 297   xbt_dynar_free_container(&(sd_global->initial_task_set));
 298   xbt_dynar_free_container(&(sd_global->executable_task_set));
 299   xbt_dynar_free_container(&(sd_global->completed_task_set));
 300   xbt_dynar_free_container(&(sd_global->return_set));
 301   xbt_free(sd_global);
 302   sd_global = NULL;
 303
 304   surf_exit();
 305 }