Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
xbt_swag_foreach_safe is actually needed here.
[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 "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/instr_private.h"
16 #include "surf/surfxml_parse.h"
17 #ifdef HAVE_LUA
18 #include <lua.h>
19 #include <lauxlib.h>
20 #include <lualib.h>
21 #endif
22
23 #ifdef HAVE_JEDULE
24 #include "instr/jedule/jedule_sd_binding.h"
25 #endif
26
27 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd,
29                                 "Logging specific to SimDag (kernel)");
30
31 SD_global_t sd_global = NULL;
32
33 XBT_LOG_EXTERNAL_CATEGORY(sd_kernel);
34 XBT_LOG_EXTERNAL_CATEGORY(sd_task);
35 XBT_LOG_EXTERNAL_CATEGORY(sd_workstation);
36
37 /**
38  * \brief Initialises SD internal data
39  *
40  * This function must be called before any other SD function. Then you
41  * should call SD_create_environment().
42  *
43  * \param argc argument number
44  * \param argv argument list
45  * \see SD_create_environment(), SD_exit()
46  */
47 void SD_init(int *argc, char **argv)
48 {
49 #ifdef HAVE_TRACING
50   TRACE_global_init(argc, argv);
51 #endif
52
53   s_SD_task_t task;
54
55   xbt_assert(sd_global == NULL, "SD_init() already called");
56
57   /* Connect our log channels: that must be done manually under windows */
58   XBT_LOG_CONNECT(sd_kernel, sd);
59   XBT_LOG_CONNECT(sd_task, sd);
60   XBT_LOG_CONNECT(sd_workstation, sd);
61
62
63   sd_global = xbt_new(s_SD_global_t, 1);
64   sd_global->workstation_list = NULL;
65   sd_global->link_list = NULL;
66   sd_global->recyclable_route = NULL;
67   sd_global->watch_point_reached = 0;
68
69   sd_global->task_mallocator=xbt_mallocator_new(65536, SD_task_new_f,SD_task_free_f,SD_task_recycle_f);
70
71   sd_global->not_scheduled_task_set =
72       xbt_swag_new(xbt_swag_offset(task, state_hookup));
73   sd_global->schedulable_task_set =
74       xbt_swag_new(xbt_swag_offset(task, state_hookup));
75   sd_global->scheduled_task_set =
76       xbt_swag_new(xbt_swag_offset(task, state_hookup));
77   sd_global->runnable_task_set =
78       xbt_swag_new(xbt_swag_offset(task, state_hookup));
79   sd_global->in_fifo_task_set =
80       xbt_swag_new(xbt_swag_offset(task, state_hookup));
81   sd_global->running_task_set =
82       xbt_swag_new(xbt_swag_offset(task, state_hookup));
83   sd_global->done_task_set =
84       xbt_swag_new(xbt_swag_offset(task, state_hookup));
85   sd_global->failed_task_set =
86       xbt_swag_new(xbt_swag_offset(task, state_hookup));
87   sd_global->return_set =
88       xbt_swag_new(xbt_swag_offset(task, return_hookup));
89   sd_global->task_number = 0;
90
91   surf_init(argc, argv);
92
93   xbt_cfg_setdefault_string(_surf_cfg_set, "workstation/model",
94                             "ptask_L07");
95
96 #ifdef HAVE_TRACING
97   TRACE_start ();
98 #endif
99
100 #ifdef HAVE_JEDULE
101   jedule_sd_init();
102 #endif
103
104   XBT_DEBUG("ADD SD LEVELS");
105   SD_HOST_LEVEL = xbt_lib_add_level(host_lib,__SD_workstation_destroy);
106   SD_LINK_LEVEL = xbt_lib_add_level(link_lib,__SD_link_destroy);
107 }
108
109 /**
110  * \brief Reinits the application part of the simulation (experimental feature)
111  *
112  * This function allows you to run several simulations on the same platform
113  * by resetting the part describing the application.
114  *
115  * @warning: this function is still experimental and not perfect. For example,
116  * the simulation clock (and traces usage) is not reset. So, do not use it if
117  * you use traces in your simulation, and do not use absolute timing after using it.
118  * That being said, this function is still precious if you want to compare a bunch of
119  * heuristics on the same platforms.
120  */
121 void SD_application_reinit(void)
122 {
123
124   s_SD_task_t task;
125
126   XBT_DEBUG("Recreating the swags...");
127   xbt_swag_free(sd_global->not_scheduled_task_set);
128   xbt_swag_free(sd_global->schedulable_task_set);
129   xbt_swag_free(sd_global->scheduled_task_set);
130   xbt_swag_free(sd_global->runnable_task_set);
131   xbt_swag_free(sd_global->in_fifo_task_set);
132   xbt_swag_free(sd_global->running_task_set);
133   xbt_swag_free(sd_global->done_task_set);
134   xbt_swag_free(sd_global->failed_task_set);
135
136   sd_global->not_scheduled_task_set =
137       xbt_swag_new(xbt_swag_offset(task, state_hookup));
138   sd_global->schedulable_task_set =
139       xbt_swag_new(xbt_swag_offset(task, state_hookup));
140   sd_global->scheduled_task_set =
141       xbt_swag_new(xbt_swag_offset(task, state_hookup));
142   sd_global->runnable_task_set =
143       xbt_swag_new(xbt_swag_offset(task, state_hookup));
144   sd_global->in_fifo_task_set =
145       xbt_swag_new(xbt_swag_offset(task, state_hookup));
146   sd_global->running_task_set =
147       xbt_swag_new(xbt_swag_offset(task, state_hookup));
148   sd_global->done_task_set =
149       xbt_swag_new(xbt_swag_offset(task, state_hookup));
150   sd_global->failed_task_set =
151       xbt_swag_new(xbt_swag_offset(task, state_hookup));
152   sd_global->task_number = 0;
153
154 #ifdef HAVE_JEDULE
155   jedule_sd_cleanup();
156   jedule_sd_init();
157 #endif
158 }
159
160 /**
161  * \brief Creates the environment
162  *
163  * The environment (i.e. the \ref SD_workstation_management "workstations" and the
164  * \ref SD_link_management "links") is created with the data stored in the given XML
165  * platform file.
166  *
167  * \param platform_file name of an XML file describing the environment to create
168  * \see SD_workstation_management, SD_link_management
169  *
170  * The XML file follows this DTD:
171  *
172  *     \include simgrid.dtd
173  *
174  * Here is a small example of such a platform:
175  *
176  *     \include small_platform.xml
177  */
178 void SD_create_environment(const char *platform_file)
179 {
180   xbt_lib_cursor_t cursor = NULL;
181   char *name = NULL;
182   void **surf_workstation = NULL;
183   void **surf_link = NULL;
184
185   // Reset callbacks
186   surf_parse_reset_callbacks();
187   // Add config callbacks
188   surf_parse_add_callback_config();
189
190   parse_platform_file(platform_file);
191   surf_config_models_create_elms();
192
193   /* now let's create the SD wrappers for workstations and links */
194   xbt_lib_foreach(host_lib, cursor, name, surf_workstation){
195           if(surf_workstation[SURF_WKS_LEVEL])
196                   __SD_workstation_create(surf_workstation[SURF_WKS_LEVEL], NULL);
197   }
198
199   xbt_lib_foreach(link_lib, cursor, name, surf_link) {
200         if(surf_link[SURF_LINK_LEVEL])
201     __SD_link_create(surf_link[SURF_LINK_LEVEL], NULL);
202   }
203
204   XBT_DEBUG("Workstation number: %d, link number: %d",
205          SD_workstation_get_number(), SD_link_get_number());
206 #ifdef HAVE_JEDULE
207   jedule_setup_platform();
208 #endif
209 }
210
211 /**
212  * \brief Launches the simulation.
213  *
214  * The function will execute the \ref SD_RUNNABLE runnable tasks.
215  * If \a how_long is positive, then the simulation will be stopped either
216  * when time reaches \a how_long or when a watch point is reached.
217  * A nonpositive value for \a how_long means no time limit, in which case
218  * the simulation will be stopped either when a watch point is reached or
219  * when no more task can be executed.
220  * Then you can call SD_simulate() again.
221  *
222  * \param how_long maximum duration of the simulation (a negative value means no time limit)
223  * \return a NULL-terminated array of \ref SD_task_t whose state has changed.
224  * \see SD_task_schedule(), SD_task_watch()
225  */
226
227 xbt_dynar_t SD_simulate(double how_long) {
228   xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
229   SD_task_t task;
230
231   SD_simulate_swag(how_long);
232   while( (task = xbt_swag_extract(sd_global->return_set)) != NULL) {
233     xbt_dynar_push(changed_tasks, &task);
234   }
235
236   return changed_tasks;
237 }
238
239 xbt_swag_t SD_simulate_swag(double how_long) {
240   double total_time = 0.0;      /* we stop the simulation when total_time >= how_long */
241   double elapsed_time = 0.0;
242   SD_task_t task, task_safe, dst;
243   SD_dependency_t dependency;
244   surf_action_t action;
245   unsigned int iter, depcnt;
246   static int first_time = 1;
247
248    if (first_time) {
249      XBT_VERB("Starting simulation...");
250
251      surf_presolve();            /* Takes traces into account */
252      first_time = 0;
253    }
254
255   sd_global->watch_point_reached = 0;
256
257   while(xbt_swag_extract(sd_global->return_set)) {}
258
259   /* explore the runnable tasks */
260   xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
261     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
262     if (__SD_task_try_to_run(task))
263       xbt_swag_insert(task,sd_global->return_set);
264   }
265
266   /* main loop */
267   elapsed_time = 0.0;
268   while (elapsed_time >= 0.0 &&
269          (how_long < 0.0 || total_time < how_long) &&
270          !sd_global->watch_point_reached) {
271     surf_model_t model = NULL;
272     /* dumb variables */
273
274
275     XBT_DEBUG("Total time: %f", total_time);
276
277     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long : -1.0);
278     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
279     if (elapsed_time > 0.0)
280       total_time += elapsed_time;
281
282     /* let's see which tasks are done */
283     xbt_dynar_foreach(model_list, iter, model) {
284       while ((action = xbt_swag_extract(model->states.done_action_set))) {
285         task = action->data;
286         task->start_time =
287             surf_workstation_model->
288             action_get_start_time(task->surf_action);
289         task->finish_time = surf_get_clock();
290         XBT_VERB("Task '%s' done", SD_task_get_name(task));
291         XBT_DEBUG("Calling __SD_task_just_done");
292         __SD_task_just_done(task);
293         XBT_DEBUG("__SD_task_just_done called on task '%s'",
294                SD_task_get_name(task));
295
296         /* the state has changed */
297         xbt_swag_insert(task,sd_global->return_set);
298
299         /* remove the dependencies after this task */
300         xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
301           dst = dependency->dst;
302           if (dst->unsatisfied_dependencies > 0)
303             dst->unsatisfied_dependencies--;
304           if (dst->is_not_ready > 0)
305             dst->is_not_ready--;
306
307           if (!(dst->unsatisfied_dependencies)) {
308             if (__SD_task_is_scheduled(dst))
309               __SD_task_set_state(dst, SD_RUNNABLE);
310             else
311               __SD_task_set_state(dst, SD_SCHEDULABLE);
312           }
313
314           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
315             SD_dependency_t comm_dep;
316             SD_task_t comm_dst;
317             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
318             comm_dst = comm_dep->dst;
319             if (__SD_task_is_not_scheduled(comm_dst) &&
320                 comm_dst->is_not_ready > 0) {
321               comm_dst->is_not_ready--;
322
323               if (!(comm_dst->is_not_ready)) {
324                 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
325               }
326             }
327           }
328
329           /* is dst runnable now? */
330           if (__SD_task_is_runnable(dst)
331               && !sd_global->watch_point_reached) {
332             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
333             if (__SD_task_try_to_run(dst))
334               xbt_swag_insert(dst,sd_global->return_set);
335           }
336         }
337       }
338
339       /* let's see which tasks have just failed */
340       while ((action = xbt_swag_extract(model->states.failed_action_set))) {
341         task = action->data;
342         task->start_time =
343             surf_workstation_model->
344             action_get_start_time(task->surf_action);
345         task->finish_time = surf_get_clock();
346         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
347         __SD_task_set_state(task, SD_FAILED);
348         surf_workstation_model->action_unref(action);
349         task->surf_action = NULL;
350
351         xbt_swag_insert(task,sd_global->return_set);
352       }
353     }
354   }
355
356   if (!sd_global->watch_point_reached && how_long<0){
357     if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
358         XBT_WARN("Simulation is finished but %d tasks are still not done",
359             (sd_global->task_number - xbt_swag_size(sd_global->done_task_set)));
360         xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
361                 XBT_WARN("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
362                 }
363         xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
364                 XBT_WARN("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
365         }
366         xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
367                 XBT_WARN("%s is in SD_SCHEDULED state", SD_task_get_name(task));
368         }
369     }
370   }
371
372   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
373          elapsed_time, total_time, sd_global->watch_point_reached);
374   XBT_DEBUG("current time = %f", surf_get_clock());
375
376   return sd_global->return_set;
377 }
378
379 /**
380  * \brief Returns the current clock
381  *
382  * \return the current clock, in second
383  */
384 double SD_get_clock(void) {
385   return surf_get_clock();
386 }
387
388 /**
389  * \brief Destroys all SD internal data
390  *
391  * This function should be called when the simulation is over. Don't forget also to destroy
392  * the tasks.
393  *
394  * \see SD_init(), SD_task_destroy()
395  */
396 void SD_exit(void)
397 {
398 #ifdef HAVE_TRACING
399   TRACE_surf_release();
400 #endif
401
402   xbt_mallocator_free(sd_global->task_mallocator);
403
404   XBT_DEBUG("Destroying workstation and link arrays if necessary...");
405   if (sd_global->workstation_list != NULL)
406     xbt_free(sd_global->workstation_list);
407
408   if (sd_global->link_list != NULL)
409     xbt_free(sd_global->link_list);
410
411   if (sd_global->recyclable_route != NULL)
412     xbt_free(sd_global->recyclable_route);
413
414   XBT_DEBUG("Destroying the swags...");
415   xbt_swag_free(sd_global->not_scheduled_task_set);
416   xbt_swag_free(sd_global->schedulable_task_set);
417   xbt_swag_free(sd_global->scheduled_task_set);
418   xbt_swag_free(sd_global->runnable_task_set);
419   xbt_swag_free(sd_global->in_fifo_task_set);
420   xbt_swag_free(sd_global->running_task_set);
421   xbt_swag_free(sd_global->done_task_set);
422   xbt_swag_free(sd_global->failed_task_set);
423   xbt_swag_free(sd_global->return_set);
424
425   XBT_DEBUG("Exiting Surf...");
426   surf_exit();
427
428   xbt_free(sd_global);
429   sd_global = NULL;
430
431 #ifdef HAVE_TRACING
432   TRACE_end();
433 #endif
434 #ifdef HAVE_JEDULE
435   jedule_sd_dump();
436   jedule_sd_cleanup();
437 #endif
438 }
439
440 /**
441  * \brief load script file
442  */
443
444 void SD_load_environment_script(const char *script_file)
445 {
446 #ifdef HAVE_LUA
447   lua_State *L = lua_open();
448   luaL_openlibs(L);
449
450   if (luaL_loadfile(L, script_file) || lua_pcall(L, 0, 0, 0)) {
451     printf("error: %s\n", lua_tostring(L, -1));
452     return;
453   }
454 #else
455   xbt_die
456       ("Lua is not available!! to call SD_load_environment_script, lua should be available...");
457 #endif
458   return;
459 }