Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
915cb502543da6319445cd0ab02a3aa8703e0387
[simgrid.git] / 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 "instr/instr_interface.h"
9 #include "xbt/sysdep.h"
10 #include "xbt/dynar.h"
11 #include "surf/surf.h"
12 #include "simgrid/sg_config.h"
13 #include "xbt/ex.h"
14 #include "xbt/log.h"
15 #include "xbt/str.h"
16 #include "xbt/config.h"
17 #include "surf/surfxml_parse.h"
18 #ifdef HAVE_LUA
19 #include <lua.h>
20 #include <lauxlib.h>
21 #include <lualib.h>
22 #endif
23
24 #ifdef HAVE_JEDULE
25 #include "instr/jedule/jedule_sd_binding.h"
26 #endif
27
28 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd,
30                                 "Logging specific to SimDag (kernel)");
31
32 SD_global_t sd_global = NULL;
33
34 /**
35  * \brief Initializes SD internal data
36  *
37  * This function must be called before any other SD function. Then you
38  * should call SD_create_environment().
39  *
40  * \param argc argument number
41  * \param argv argument list
42  * \see SD_create_environment(), SD_exit()
43  */
44 void SD_init(int *argc, char **argv)
45 {
46 #ifdef HAVE_TRACING
47   TRACE_global_init(argc, argv);
48 #endif
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->not_scheduled_task_set =
63       xbt_swag_new(xbt_swag_offset(task, state_hookup));
64   sd_global->schedulable_task_set =
65       xbt_swag_new(xbt_swag_offset(task, state_hookup));
66   sd_global->scheduled_task_set =
67       xbt_swag_new(xbt_swag_offset(task, state_hookup));
68   sd_global->runnable_task_set =
69       xbt_swag_new(xbt_swag_offset(task, state_hookup));
70   sd_global->in_fifo_task_set =
71       xbt_swag_new(xbt_swag_offset(task, state_hookup));
72   sd_global->running_task_set =
73       xbt_swag_new(xbt_swag_offset(task, state_hookup));
74   sd_global->done_task_set =
75       xbt_swag_new(xbt_swag_offset(task, state_hookup));
76   sd_global->failed_task_set =
77       xbt_swag_new(xbt_swag_offset(task, state_hookup));
78   sd_global->return_set =
79       xbt_swag_new(xbt_swag_offset(task, return_hookup));
80   sd_global->task_number = 0;
81
82   surf_init(argc, argv);
83
84   xbt_cfg_setdefault_string(_sg_cfg_set, "workstation/model",
85                             "ptask_L07");
86
87 #ifdef HAVE_TRACING
88   TRACE_start ();
89 #endif
90
91 #ifdef HAVE_JEDULE
92   jedule_sd_init();
93 #endif
94
95   XBT_DEBUG("ADD SD LEVELS");
96   SD_HOST_LEVEL = xbt_lib_add_level(host_lib,__SD_workstation_destroy);
97   SD_LINK_LEVEL = xbt_lib_add_level(link_lib,__SD_link_destroy);
98 }
99
100 /**
101  * \brief Reinits the application part of the simulation (experimental feature)
102  *
103  * This function allows you to run several simulations on the same platform
104  * by resetting the part describing the application.
105  *
106  * @warning: this function is still experimental and not perfect. For example,
107  * the simulation clock (and traces usage) is not reset. So, do not use it if
108  * you use traces in your simulation, and do not use absolute timing after using it.
109  * That being said, this function is still precious if you want to compare a bunch of
110  * heuristics on the same platforms.
111  */
112 void SD_application_reinit(void)
113 {
114
115   s_SD_task_t task;
116
117   XBT_DEBUG("Recreating the swags...");
118   xbt_swag_free(sd_global->not_scheduled_task_set);
119   xbt_swag_free(sd_global->schedulable_task_set);
120   xbt_swag_free(sd_global->scheduled_task_set);
121   xbt_swag_free(sd_global->runnable_task_set);
122   xbt_swag_free(sd_global->in_fifo_task_set);
123   xbt_swag_free(sd_global->running_task_set);
124   xbt_swag_free(sd_global->done_task_set);
125   xbt_swag_free(sd_global->failed_task_set);
126
127   sd_global->not_scheduled_task_set =
128       xbt_swag_new(xbt_swag_offset(task, state_hookup));
129   sd_global->schedulable_task_set =
130       xbt_swag_new(xbt_swag_offset(task, state_hookup));
131   sd_global->scheduled_task_set =
132       xbt_swag_new(xbt_swag_offset(task, state_hookup));
133   sd_global->runnable_task_set =
134       xbt_swag_new(xbt_swag_offset(task, state_hookup));
135   sd_global->in_fifo_task_set =
136       xbt_swag_new(xbt_swag_offset(task, state_hookup));
137   sd_global->running_task_set =
138       xbt_swag_new(xbt_swag_offset(task, state_hookup));
139   sd_global->done_task_set =
140       xbt_swag_new(xbt_swag_offset(task, state_hookup));
141   sd_global->failed_task_set =
142       xbt_swag_new(xbt_swag_offset(task, state_hookup));
143   sd_global->task_number = 0;
144
145 #ifdef HAVE_JEDULE
146   jedule_sd_cleanup();
147   jedule_sd_init();
148 #endif
149 }
150
151 /**
152  * \brief Creates the environment
153  *
154  * The environment (i.e. the \ref SD_workstation_management "workstations"
155  * and the \ref SD_link_management "links") is created with the data stored
156  * in the given XML platform file.
157  *
158  * \param platform_file name of an XML file describing the environment to create
159  * \see SD_workstation_management, SD_link_management
160  *
161  * The XML file follows this DTD:
162  *
163  *     \include simgrid.dtd
164  *
165  * Here is a small example of such a platform:
166  *
167  *     \include small_platform.xml
168  */
169 void SD_create_environment(const char *platform_file)
170 {
171   xbt_lib_cursor_t cursor = NULL;
172   char *name = NULL;
173   void **surf_workstation = NULL;
174   void **surf_link = NULL;
175
176   parse_platform_file(platform_file);
177
178   /* now let's create the SD wrappers for workstations and links */
179   xbt_lib_foreach(host_lib, cursor, name, surf_workstation){
180     if(surf_workstation[SURF_WKS_LEVEL])
181       __SD_workstation_create(surf_workstation[SURF_WKS_LEVEL], NULL);
182   }
183
184   xbt_lib_foreach(link_lib, cursor, name, surf_link) {
185   if(surf_link[SURF_LINK_LEVEL])
186     __SD_link_create(surf_link[SURF_LINK_LEVEL], NULL);
187   }
188
189   XBT_DEBUG("Workstation number: %d, link number: %d",
190          SD_workstation_get_number(), SD_link_get_number());
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 no time limit)
208  * \return a dynar of \ref SD_task_t whose state has changed.
209  * \see SD_task_schedule(), SD_task_watch()
210  */
211
212 xbt_dynar_t SD_simulate(double how_long) {
213   xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
214   SD_task_t task;
215
216   SD_simulate_swag(how_long);
217   while( (task = xbt_swag_extract(sd_global->return_set)) != NULL) {
218     xbt_dynar_push(changed_tasks, &task);
219   }
220
221   return changed_tasks;
222 }
223
224 xbt_swag_t SD_simulate_swag(double how_long) {
225   double total_time = 0.0;      /* we stop the simulation when total_time >= how_long */
226   double elapsed_time = 0.0;
227   SD_task_t task, task_safe, dst;
228   SD_dependency_t dependency;
229   surf_action_t action;
230   unsigned int iter, depcnt;
231   static int first_time = 1;
232
233   if (first_time) {
234     XBT_VERB("Starting simulation...");
235
236     surf_presolve();            /* Takes traces into account */
237     first_time = 0;
238   }
239
240   XBT_VERB("Run simulation for %f seconds", how_long);
241   sd_global->watch_point_reached = 0;
242
243   xbt_swag_reset(sd_global->return_set);
244
245   /* explore the runnable tasks */
246   xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
247     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
248     if (__SD_task_try_to_run(task))
249       xbt_swag_insert(task,sd_global->return_set);
250   }
251
252   /* main loop */
253   elapsed_time = 0.0;
254   while (elapsed_time >= 0.0 &&
255          (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
256          !sd_global->watch_point_reached) {
257     surf_model_t model = NULL;
258     /* dumb variables */
259
260
261     XBT_DEBUG("Total time: %f", total_time);
262
263     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
264     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
265     if (elapsed_time > 0.0)
266       total_time += elapsed_time;
267
268     /* let's see which tasks are done */
269     xbt_dynar_foreach(model_list, iter, model) {
270       while ((action = xbt_swag_extract(model->states.done_action_set))) {
271         task = action->data;
272         task->start_time =
273             surf_workstation_model->
274             action_get_start_time(task->surf_action);
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_is_scheduled(dst))
299               __SD_task_set_state(dst, SD_RUNNABLE);
300             else
301               __SD_task_set_state(dst, SD_SCHEDULABLE);
302           }
303
304           if (__SD_task_is_not_scheduled(dst) && !(dst->is_not_ready)) {
305             __SD_task_set_state(dst, SD_SCHEDULABLE);
306           }
307
308           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
309             SD_dependency_t comm_dep;
310             SD_task_t comm_dst;
311             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
312             comm_dst = comm_dep->dst;
313             if (__SD_task_is_not_scheduled(comm_dst) &&
314                 comm_dst->is_not_ready > 0) {
315               comm_dst->is_not_ready--;
316
317             XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
318                SD_task_get_name(dst), SD_task_get_name(comm_dst),
319                comm_dst->is_not_ready);
320
321               if (!(comm_dst->is_not_ready)) {
322                 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
323               }
324             }
325           }
326
327           /* is dst runnable now? */
328           if (__SD_task_is_runnable(dst)
329               && !sd_global->watch_point_reached) {
330             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
331             if (__SD_task_try_to_run(dst))
332               xbt_swag_insert(dst,sd_global->return_set);
333           }
334         }
335       }
336
337       /* let's see which tasks have just failed */
338       while ((action = xbt_swag_extract(model->states.failed_action_set))) {
339         task = action->data;
340         task->start_time =
341             surf_workstation_model->
342             action_get_start_time(task->surf_action);
343         task->finish_time = surf_get_clock();
344         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
345         __SD_task_set_state(task, SD_FAILED);
346         surf_workstation_model->action_unref(action);
347         task->surf_action = NULL;
348
349         xbt_swag_insert(task,sd_global->return_set);
350       }
351     }
352   }
353
354   if (!sd_global->watch_point_reached && how_long<0){
355     if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
356         XBT_WARN("Simulation is finished but %d tasks are still not done",
357             (sd_global->task_number - xbt_swag_size(sd_global->done_task_set)));
358         xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
359                 XBT_WARN("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
360     }
361       xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
362                 XBT_WARN("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
363   }
364         xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
365                 XBT_WARN("%s is in SD_SCHEDULED state", SD_task_get_name(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 #ifdef HAVE_TRACING
397   TRACE_surf_resource_utilization_release();
398 #endif
399
400   xbt_mallocator_free(sd_global->task_mallocator);
401
402   XBT_DEBUG("Destroying workstation and link arrays...");
403   xbt_free(sd_global->workstation_list);
404   xbt_free(sd_global->link_list);
405   xbt_free(sd_global->recyclable_route);
406
407   XBT_DEBUG("Destroying the swags...");
408   xbt_swag_free(sd_global->not_scheduled_task_set);
409   xbt_swag_free(sd_global->schedulable_task_set);
410   xbt_swag_free(sd_global->scheduled_task_set);
411   xbt_swag_free(sd_global->runnable_task_set);
412   xbt_swag_free(sd_global->in_fifo_task_set);
413   xbt_swag_free(sd_global->running_task_set);
414   xbt_swag_free(sd_global->done_task_set);
415   xbt_swag_free(sd_global->failed_task_set);
416   xbt_swag_free(sd_global->return_set);
417
418 #ifdef HAVE_TRACING
419   TRACE_end();
420 #endif
421
422   XBT_DEBUG("Exiting Surf...");
423   surf_exit();
424
425   xbt_free(sd_global);
426   sd_global = NULL;
427
428 #ifdef HAVE_JEDULE
429   jedule_sd_dump();
430   jedule_sd_cleanup();
431 #endif
432 }
433
434 /**
435  * \brief load script file
436  */
437
438 void SD_load_environment_script(const char *script_file)
439 {
440 #ifdef HAVE_LUA
441   lua_State *L = lua_open();
442   luaL_openlibs(L);
443
444   if (luaL_loadfile(L, script_file) || lua_pcall(L, 0, 0, 0)) {
445     printf("error: %s\n", lua_tostring(L, -1));
446     return;
447   }
448 #else
449   xbt_die
450       ("Lua is not available!! to call SD_load_environment_script, lua should be available...");
451 #endif
452   return;
453 }