Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
a2789bcd8a910188371cd8de643c7539d9c03535
[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   SD_task_t done_task, next_done_task;
118
119    XBT_DEBUG("Recreating the swags...");
120   xbt_swag_free(sd_global->not_scheduled_task_set);
121   xbt_swag_free(sd_global->schedulable_task_set);
122   xbt_swag_free(sd_global->scheduled_task_set);
123   xbt_swag_free(sd_global->runnable_task_set);
124   xbt_swag_free(sd_global->in_fifo_task_set);
125   xbt_swag_free(sd_global->running_task_set);
126   xbt_swag_free(sd_global->failed_task_set);
127
128   sd_global->not_scheduled_task_set =
129       xbt_swag_new(xbt_swag_offset(task, state_hookup));
130   sd_global->schedulable_task_set =
131       xbt_swag_new(xbt_swag_offset(task, state_hookup));
132   xbt_swag_foreach_safe(done_task, next_done_task, sd_global->done_task_set){
133     if (xbt_dynar_is_empty(done_task->tasks_before)){
134       __SD_task_set_state(done_task, SD_SCHEDULABLE);
135    } else{
136       __SD_task_set_state(done_task, SD_NOT_SCHEDULED);
137       done_task->unsatisfied_dependencies =
138         xbt_dynar_length(done_task->tasks_before);
139       done_task->is_not_ready = done_task->unsatisfied_dependencies;
140    }
141   }
142
143   xbt_swag_free(sd_global->done_task_set);
144
145   sd_global->scheduled_task_set =
146       xbt_swag_new(xbt_swag_offset(task, state_hookup));
147   sd_global->runnable_task_set =
148       xbt_swag_new(xbt_swag_offset(task, state_hookup));
149   sd_global->in_fifo_task_set =
150       xbt_swag_new(xbt_swag_offset(task, state_hookup));
151   sd_global->running_task_set =
152       xbt_swag_new(xbt_swag_offset(task, state_hookup));
153   sd_global->done_task_set =
154       xbt_swag_new(xbt_swag_offset(task, state_hookup));
155   sd_global->failed_task_set =
156       xbt_swag_new(xbt_swag_offset(task, state_hookup));
157   sd_global->task_number = 0;
158
159
160 #ifdef HAVE_JEDULE
161   jedule_sd_cleanup();
162   jedule_sd_init();
163 #endif
164 }
165
166 /**
167  * \brief Creates the environment
168  *
169  * The environment (i.e. the \ref SD_workstation_management "workstations"
170  * and the \ref SD_link_management "links") is created with the data stored
171  * in the given XML platform file.
172  *
173  * \param platform_file name of an XML file describing the environment to create
174  * \see SD_workstation_management, SD_link_management
175  *
176  * The XML file follows this DTD:
177  *
178  *     \include simgrid.dtd
179  *
180  * Here is a small example of such a platform:
181  *
182  *     \include small_platform.xml
183  */
184 void SD_create_environment(const char *platform_file)
185 {
186   xbt_lib_cursor_t cursor = NULL;
187   char *name = NULL;
188   void **surf_workstation = NULL;
189   void **surf_link = NULL;
190
191   parse_platform_file(platform_file);
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 non-positive 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 dynar 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   XBT_VERB("Run simulation for %f seconds", how_long);
256   sd_global->watch_point_reached = 0;
257
258   xbt_swag_reset(sd_global->return_set);
259
260   /* explore the runnable tasks */
261   xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
262     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
263     if (__SD_task_try_to_run(task))
264       xbt_swag_insert(task,sd_global->return_set);
265   }
266
267   /* main loop */
268   elapsed_time = 0.0;
269   while (elapsed_time >= 0.0 &&
270          (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
271          !sd_global->watch_point_reached) {
272     surf_model_t model = NULL;
273     /* dumb variables */
274
275
276     XBT_DEBUG("Total time: %f", total_time);
277
278     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
279     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
280     if (elapsed_time > 0.0)
281       total_time += elapsed_time;
282
283     /* let's see which tasks are done */
284     xbt_dynar_foreach(model_list, iter, model) {
285       while ((action = xbt_swag_extract(model->states.done_action_set))) {
286         task = action->data;
287         task->start_time =
288             surf_workstation_model->
289             action_get_start_time(task->surf_action);
290         task->finish_time = surf_get_clock();
291         XBT_VERB("Task '%s' done", SD_task_get_name(task));
292         XBT_DEBUG("Calling __SD_task_just_done");
293         __SD_task_just_done(task);
294         XBT_DEBUG("__SD_task_just_done called on task '%s'",
295                SD_task_get_name(task));
296
297         /* the state has changed */
298         xbt_swag_insert(task,sd_global->return_set);
299
300         /* remove the dependencies after this task */
301         xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
302           dst = dependency->dst;
303           if (dst->unsatisfied_dependencies > 0)
304             dst->unsatisfied_dependencies--;
305           if (dst->is_not_ready > 0)
306             dst->is_not_ready--;
307
308           XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
309              SD_task_get_name(dst), dst->unsatisfied_dependencies,
310              dst->is_not_ready);
311
312           if (!(dst->unsatisfied_dependencies)) {
313             if (__SD_task_is_scheduled(dst))
314               __SD_task_set_state(dst, SD_RUNNABLE);
315             else
316               __SD_task_set_state(dst, SD_SCHEDULABLE);
317           }
318
319           if (__SD_task_is_not_scheduled(dst) && !(dst->is_not_ready)) {
320             __SD_task_set_state(dst, SD_SCHEDULABLE);
321           }
322
323           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
324             SD_dependency_t comm_dep;
325             SD_task_t comm_dst;
326             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
327             comm_dst = comm_dep->dst;
328             if (__SD_task_is_not_scheduled(comm_dst) &&
329                 comm_dst->is_not_ready > 0) {
330               comm_dst->is_not_ready--;
331
332             XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
333                SD_task_get_name(dst), SD_task_get_name(comm_dst),
334                comm_dst->is_not_ready);
335
336               if (!(comm_dst->is_not_ready)) {
337                 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
338               }
339             }
340           }
341
342           /* is dst runnable now? */
343           if (__SD_task_is_runnable(dst)
344               && !sd_global->watch_point_reached) {
345             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
346             if (__SD_task_try_to_run(dst))
347               xbt_swag_insert(dst,sd_global->return_set);
348           }
349         }
350       }
351
352       /* let's see which tasks have just failed */
353       while ((action = xbt_swag_extract(model->states.failed_action_set))) {
354         task = action->data;
355         task->start_time =
356             surf_workstation_model->
357             action_get_start_time(task->surf_action);
358         task->finish_time = surf_get_clock();
359         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
360         __SD_task_set_state(task, SD_FAILED);
361         surf_workstation_model->action_unref(action);
362         task->surf_action = NULL;
363
364         xbt_swag_insert(task,sd_global->return_set);
365       }
366     }
367   }
368
369   if (!sd_global->watch_point_reached && how_long<0){
370     if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
371         XBT_WARN("Simulation is finished but %d tasks are still not done",
372             (sd_global->task_number - xbt_swag_size(sd_global->done_task_set)));
373         xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
374                 XBT_WARN("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
375     }
376       xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
377                 XBT_WARN("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
378   }
379         xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
380                 XBT_WARN("%s is in SD_SCHEDULED state", SD_task_get_name(task));
381          }
382     }
383   }
384
385   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
386          elapsed_time, total_time, sd_global->watch_point_reached);
387   XBT_DEBUG("current time = %f", surf_get_clock());
388
389   return sd_global->return_set;
390 }
391
392 /**
393  * \brief Returns the current clock
394  *
395  * \return the current clock, in second
396  */
397 double SD_get_clock(void) {
398   return surf_get_clock();
399 }
400
401 /**
402  * \brief Destroys all SD internal data
403  *
404  * This function should be called when the simulation is over. Don't forget
405  * to destroy too.
406  *
407  * \see SD_init(), SD_task_destroy()
408  */
409 void SD_exit(void)
410 {
411 #ifdef HAVE_TRACING
412   TRACE_surf_resource_utilization_release();
413 #endif
414
415   xbt_mallocator_free(sd_global->task_mallocator);
416
417   XBT_DEBUG("Destroying workstation and link arrays...");
418   xbt_free(sd_global->workstation_list);
419   xbt_free(sd_global->link_list);
420   xbt_free(sd_global->recyclable_route);
421
422   XBT_DEBUG("Destroying the swags...");
423   xbt_swag_free(sd_global->not_scheduled_task_set);
424   xbt_swag_free(sd_global->schedulable_task_set);
425   xbt_swag_free(sd_global->scheduled_task_set);
426   xbt_swag_free(sd_global->runnable_task_set);
427   xbt_swag_free(sd_global->in_fifo_task_set);
428   xbt_swag_free(sd_global->running_task_set);
429   xbt_swag_free(sd_global->done_task_set);
430   xbt_swag_free(sd_global->failed_task_set);
431   xbt_swag_free(sd_global->return_set);
432
433 #ifdef HAVE_TRACING
434   TRACE_end();
435 #endif
436
437   XBT_DEBUG("Exiting Surf...");
438   surf_exit();
439
440   xbt_free(sd_global);
441   sd_global = NULL;
442
443 #ifdef HAVE_JEDULE
444   jedule_sd_dump();
445   jedule_sd_cleanup();
446 #endif
447 }
448
449 /**
450  * \brief load script file
451  */
452
453 void SD_load_environment_script(const char *script_file)
454 {
455 #ifdef HAVE_LUA
456   lua_State *L = lua_open();
457   luaL_openlibs(L);
458
459   if (luaL_loadfile(L, script_file) || lua_pcall(L, 0, 0, 0)) {
460     printf("error: %s\n", lua_tostring(L, -1));
461     return;
462   }
463 #else
464   xbt_die
465       ("Lua is not available!! to call SD_load_environment_script, lua should be available...");
466 #endif
467   return;
468 }