Logo AND Algorithmique Numérique Distribuée

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