Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix missing proto for PID functions
[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     free(done_task->workstation_list);
142     done_task->workstation_list = NULL;
143     done_task->workstation_nb = 0;
144   }
145
146   xbt_swag_free(sd_global->done_task_set);
147
148   sd_global->scheduled_task_set =
149       xbt_swag_new(xbt_swag_offset(task, state_hookup));
150   sd_global->runnable_task_set =
151       xbt_swag_new(xbt_swag_offset(task, state_hookup));
152   sd_global->in_fifo_task_set =
153       xbt_swag_new(xbt_swag_offset(task, state_hookup));
154   sd_global->running_task_set =
155       xbt_swag_new(xbt_swag_offset(task, state_hookup));
156   sd_global->done_task_set =
157       xbt_swag_new(xbt_swag_offset(task, state_hookup));
158   sd_global->failed_task_set =
159       xbt_swag_new(xbt_swag_offset(task, state_hookup));
160   sd_global->task_number = 0;
161
162
163 #ifdef HAVE_JEDULE
164   jedule_sd_dump();
165   jedule_sd_cleanup();
166   jedule_sd_init();
167 #endif
168 }
169
170 /**
171  * \brief Creates the environment
172  *
173  * The environment (i.e. the \ref SD_workstation_management "workstations"
174  * and the \ref SD_link_management "links") is created with the data stored
175  * in the given XML platform file.
176  *
177  * \param platform_file name of an XML file describing the environment to create
178  * \see SD_workstation_management, SD_link_management
179  *
180  * The XML file follows this DTD:
181  *
182  *     \include simgrid.dtd
183  *
184  * Here is a small example of such a platform:
185  *
186  *     \include small_platform.xml
187  */
188 void SD_create_environment(const char *platform_file)
189 {
190   xbt_lib_cursor_t cursor = NULL;
191   char *name = NULL;
192   void **surf_workstation = NULL;
193   void **surf_link = NULL;
194
195   parse_platform_file(platform_file);
196
197   /* now let's create the SD wrappers for workstations and links */
198   xbt_lib_foreach(host_lib, cursor, name, surf_workstation){
199     if(surf_workstation[SURF_WKS_LEVEL])
200       __SD_workstation_create(surf_workstation[SURF_WKS_LEVEL], NULL);
201   }
202
203   xbt_lib_foreach(link_lib, cursor, name, surf_link) {
204   if(surf_link[SURF_LINK_LEVEL])
205     __SD_link_create(surf_link[SURF_LINK_LEVEL], NULL);
206   }
207
208   XBT_DEBUG("Workstation number: %d, link number: %d",
209          SD_workstation_get_number(), SD_link_get_number());
210 #ifdef HAVE_JEDULE
211   jedule_setup_platform();
212 #endif
213 }
214
215 /**
216  * \brief Launches the simulation.
217  *
218  * The function will execute the \ref SD_RUNNABLE runnable tasks.
219  * If \a how_long is positive, then the simulation will be stopped either
220  * when time reaches \a how_long or when a watch point is reached.
221  * A non-positive value for \a how_long means no time limit, in which case
222  * the simulation will be stopped either when a watch point is reached or
223  * when no more task can be executed.
224  * Then you can call SD_simulate() again.
225  *
226  * \param how_long maximum duration of the simulation (a negative value means no time limit)
227  * \return a dynar of \ref SD_task_t whose state has changed.
228  * \see SD_task_schedule(), SD_task_watch()
229  */
230
231 xbt_dynar_t SD_simulate(double how_long) {
232   xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
233   SD_task_t task;
234
235   SD_simulate_swag(how_long);
236   while( (task = xbt_swag_extract(sd_global->return_set)) != NULL) {
237     xbt_dynar_push(changed_tasks, &task);
238   }
239
240   return changed_tasks;
241 }
242
243 xbt_swag_t SD_simulate_swag(double how_long) {
244   double total_time = 0.0;      /* we stop the simulation when total_time >= how_long */
245   double elapsed_time = 0.0;
246   SD_task_t task, task_safe, dst;
247   SD_dependency_t dependency;
248   surf_action_t action;
249   unsigned int iter, depcnt;
250   static int first_time = 1;
251
252   if (first_time) {
253     XBT_VERB("Starting simulation...");
254
255     surf_presolve();            /* Takes traces into account */
256     first_time = 0;
257   }
258
259   XBT_VERB("Run simulation for %f seconds", how_long);
260   sd_global->watch_point_reached = 0;
261
262   xbt_swag_reset(sd_global->return_set);
263
264   /* explore the runnable tasks */
265   xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
266     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
267     if (__SD_task_try_to_run(task))
268       xbt_swag_insert(task,sd_global->return_set);
269   }
270
271   /* main loop */
272   elapsed_time = 0.0;
273   while (elapsed_time >= 0.0 &&
274          (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
275          !sd_global->watch_point_reached) {
276     surf_model_t model = NULL;
277     /* dumb variables */
278
279
280     XBT_DEBUG("Total time: %f", total_time);
281
282     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
283     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
284     if (elapsed_time > 0.0)
285       total_time += elapsed_time;
286
287     /* let's see which tasks are done */
288     xbt_dynar_foreach(model_list, iter, model) {
289       while ((action = xbt_swag_extract(model->states.done_action_set))) {
290         task = action->data;
291         task->start_time =
292             surf_workstation_model->
293             action_get_start_time(task->surf_action);
294         task->finish_time = surf_get_clock();
295         XBT_VERB("Task '%s' done", SD_task_get_name(task));
296         XBT_DEBUG("Calling __SD_task_just_done");
297         __SD_task_just_done(task);
298         XBT_DEBUG("__SD_task_just_done called on task '%s'",
299                SD_task_get_name(task));
300
301         /* the state has changed */
302         xbt_swag_insert(task,sd_global->return_set);
303
304         /* remove the dependencies after this task */
305         xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
306           dst = dependency->dst;
307           if (dst->unsatisfied_dependencies > 0)
308             dst->unsatisfied_dependencies--;
309           if (dst->is_not_ready > 0)
310             dst->is_not_ready--;
311
312           XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
313              SD_task_get_name(dst), dst->unsatisfied_dependencies,
314              dst->is_not_ready);
315
316           if (!(dst->unsatisfied_dependencies)) {
317             if (__SD_task_is_scheduled(dst))
318               __SD_task_set_state(dst, SD_RUNNABLE);
319             else
320               __SD_task_set_state(dst, SD_SCHEDULABLE);
321           }
322
323           if (__SD_task_is_not_scheduled(dst) && !(dst->is_not_ready)) {
324             __SD_task_set_state(dst, SD_SCHEDULABLE);
325           }
326
327           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
328             SD_dependency_t comm_dep;
329             SD_task_t comm_dst;
330             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
331             comm_dst = comm_dep->dst;
332             if (__SD_task_is_not_scheduled(comm_dst) &&
333                 comm_dst->is_not_ready > 0) {
334               comm_dst->is_not_ready--;
335
336             XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
337                SD_task_get_name(dst), SD_task_get_name(comm_dst),
338                comm_dst->is_not_ready);
339
340               if (!(comm_dst->is_not_ready)) {
341                 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
342               }
343             }
344           }
345
346           /* is dst runnable now? */
347           if (__SD_task_is_runnable(dst)
348               && !sd_global->watch_point_reached) {
349             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
350             if (__SD_task_try_to_run(dst))
351               xbt_swag_insert(dst,sd_global->return_set);
352           }
353         }
354       }
355
356       /* let's see which tasks have just failed */
357       while ((action = xbt_swag_extract(model->states.failed_action_set))) {
358         task = action->data;
359         task->start_time =
360             surf_workstation_model->
361             action_get_start_time(task->surf_action);
362         task->finish_time = surf_get_clock();
363         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
364         __SD_task_set_state(task, SD_FAILED);
365         surf_workstation_model->action_unref(action);
366         task->surf_action = NULL;
367
368         xbt_swag_insert(task,sd_global->return_set);
369       }
370     }
371   }
372
373   if (!sd_global->watch_point_reached && how_long<0){
374     if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
375         XBT_WARN("Simulation is finished but %d tasks are still not done",
376             (sd_global->task_number - xbt_swag_size(sd_global->done_task_set)));
377         xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
378                 XBT_WARN("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
379     }
380       xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
381                 XBT_WARN("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
382   }
383         xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
384                 XBT_WARN("%s is in SD_SCHEDULED state", SD_task_get_name(task));
385          }
386     }
387   }
388
389   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
390          elapsed_time, total_time, sd_global->watch_point_reached);
391   XBT_DEBUG("current time = %f", surf_get_clock());
392
393   return sd_global->return_set;
394 }
395
396 /**
397  * \brief Returns the current clock
398  *
399  * \return the current clock, in second
400  */
401 double SD_get_clock(void) {
402   return surf_get_clock();
403 }
404
405 /**
406  * \brief Destroys all SD internal data
407  *
408  * This function should be called when the simulation is over. Don't forget
409  * to destroy too.
410  *
411  * \see SD_init(), SD_task_destroy()
412  */
413 void SD_exit(void)
414 {
415 #ifdef HAVE_TRACING
416   TRACE_surf_resource_utilization_release();
417 #endif
418
419   xbt_mallocator_free(sd_global->task_mallocator);
420
421   XBT_DEBUG("Destroying workstation and link arrays...");
422   xbt_free(sd_global->workstation_list);
423   xbt_free(sd_global->link_list);
424   xbt_free(sd_global->recyclable_route);
425
426   XBT_DEBUG("Destroying the swags...");
427   xbt_swag_free(sd_global->not_scheduled_task_set);
428   xbt_swag_free(sd_global->schedulable_task_set);
429   xbt_swag_free(sd_global->scheduled_task_set);
430   xbt_swag_free(sd_global->runnable_task_set);
431   xbt_swag_free(sd_global->in_fifo_task_set);
432   xbt_swag_free(sd_global->running_task_set);
433   xbt_swag_free(sd_global->done_task_set);
434   xbt_swag_free(sd_global->failed_task_set);
435   xbt_swag_free(sd_global->return_set);
436
437 #ifdef HAVE_TRACING
438   TRACE_end();
439 #endif
440
441   XBT_DEBUG("Exiting Surf...");
442   surf_exit();
443
444   xbt_free(sd_global);
445   sd_global = NULL;
446
447 #ifdef HAVE_JEDULE
448   jedule_sd_dump();
449   jedule_sd_cleanup();
450 #endif
451 }