1 /* Copyright (c) 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
8 #include "xbt/sysdep.h"
10 #include "surf/surf.h"
14 #include "xbt/config.h"
15 #include "instr/instr_private.h"
22 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd,
24 "Logging specific to SimDag (kernel)");
26 SD_global_t sd_global = NULL;
28 XBT_LOG_EXTERNAL_CATEGORY(sd_kernel);
29 XBT_LOG_EXTERNAL_CATEGORY(sd_task);
30 XBT_LOG_EXTERNAL_CATEGORY(sd_workstation);
33 * \brief Initialises SD internal data
35 * This function must be called before any other SD function. Then you
36 * should call SD_create_environment().
38 * \param argc argument number
39 * \param argv argument list
40 * \see SD_create_environment(), SD_exit()
42 void SD_init(int *argc, char **argv)
45 TRACE_global_init(argc, argv);
50 xbt_assert0(!SD_INITIALISED(), "SD_init() already called");
52 /* Connect our log channels: that must be done manually under windows */
53 XBT_LOG_CONNECT(sd_kernel, sd);
54 XBT_LOG_CONNECT(sd_task, sd);
55 XBT_LOG_CONNECT(sd_workstation, sd);
58 sd_global = xbt_new(s_SD_global_t, 1);
59 sd_global->workstations = xbt_dict_new();
60 sd_global->workstation_count = 0;
61 sd_global->workstation_list = NULL;
62 sd_global->links = xbt_dict_new();
63 sd_global->link_count = 0;
64 sd_global->link_list = NULL;
65 sd_global->recyclable_route = NULL;
66 sd_global->watch_point_reached = 0;
68 sd_global->not_scheduled_task_set =
69 xbt_swag_new(xbt_swag_offset(task, state_hookup));
70 sd_global->schedulable_task_set =
71 xbt_swag_new(xbt_swag_offset(task, state_hookup));
72 sd_global->scheduled_task_set =
73 xbt_swag_new(xbt_swag_offset(task, state_hookup));
74 sd_global->runnable_task_set =
75 xbt_swag_new(xbt_swag_offset(task, state_hookup));
76 sd_global->in_fifo_task_set =
77 xbt_swag_new(xbt_swag_offset(task, state_hookup));
78 sd_global->running_task_set =
79 xbt_swag_new(xbt_swag_offset(task, state_hookup));
80 sd_global->done_task_set =
81 xbt_swag_new(xbt_swag_offset(task, state_hookup));
82 sd_global->failed_task_set =
83 xbt_swag_new(xbt_swag_offset(task, state_hookup));
84 sd_global->task_number = 0;
86 surf_init(argc, argv);
88 xbt_cfg_setdefault_string(_surf_cfg_set, "workstation/model",
97 * \brief Reinits the application part of the simulation (experimental feature)
99 * This function allows you to run several simulations on the same platform
100 * by resetting the part describing the application.
102 * @warning: this function is still experimental and not perfect. For example,
103 * the simulation clock (and traces usage) is not reset. So, do not use it if
104 * you use traces in your simulation, and do not use absolute timing after using it.
105 * That being said, this function is still precious if you want to compare a bunch of
106 * heuristics on the same platforms.
108 void SD_application_reinit(void)
113 if (SD_INITIALISED()) {
114 DEBUG0("Recreating the swags...");
115 xbt_swag_free(sd_global->not_scheduled_task_set);
116 xbt_swag_free(sd_global->schedulable_task_set);
117 xbt_swag_free(sd_global->scheduled_task_set);
118 xbt_swag_free(sd_global->runnable_task_set);
119 xbt_swag_free(sd_global->in_fifo_task_set);
120 xbt_swag_free(sd_global->running_task_set);
121 xbt_swag_free(sd_global->done_task_set);
122 xbt_swag_free(sd_global->failed_task_set);
124 sd_global->not_scheduled_task_set =
125 xbt_swag_new(xbt_swag_offset(task, state_hookup));
126 sd_global->schedulable_task_set =
127 xbt_swag_new(xbt_swag_offset(task, state_hookup));
128 sd_global->scheduled_task_set =
129 xbt_swag_new(xbt_swag_offset(task, state_hookup));
130 sd_global->runnable_task_set =
131 xbt_swag_new(xbt_swag_offset(task, state_hookup));
132 sd_global->in_fifo_task_set =
133 xbt_swag_new(xbt_swag_offset(task, state_hookup));
134 sd_global->running_task_set =
135 xbt_swag_new(xbt_swag_offset(task, state_hookup));
136 sd_global->done_task_set =
137 xbt_swag_new(xbt_swag_offset(task, state_hookup));
138 sd_global->failed_task_set =
139 xbt_swag_new(xbt_swag_offset(task, state_hookup));
140 sd_global->task_number = 0;
142 WARN0("SD_application_reinit called before initialization of SimDag");
143 /* we cannot use exceptions here because xbt is not running! */
149 * \brief Creates the environment
151 * The environment (i.e. the \ref SD_workstation_management "workstations" and the
152 * \ref SD_link_management "links") is created with the data stored in the given XML
155 * \param platform_file name of an XML file describing the environment to create
156 * \see SD_workstation_management, SD_link_management
158 * The XML file follows this DTD:
160 * \include simgrid.dtd
162 * Here is a small example of such a platform:
164 * \include small_platform.xml
166 void SD_create_environment(const char *platform_file)
168 xbt_dict_cursor_t cursor = NULL;
170 void *surf_workstation = NULL;
171 void *surf_link = NULL;
173 //First pass of platform file
174 surf_config_add_callback();
175 parse_platform_file(platform_file);
177 SD_CHECK_INIT_DONE();
178 DEBUG0("SD_create_environment");
179 surf_config_models_setup(platform_file);
180 parse_platform_file(platform_file);
181 surf_config_models_create_elms();
183 /* now let's create the SD wrappers for workstations and links */
184 xbt_dict_foreach(surf_model_resource_set(surf_workstation_model), cursor,
185 name, surf_workstation) {
186 __SD_workstation_create(surf_workstation, NULL);
189 xbt_dict_foreach(surf_model_resource_set(surf_network_model), cursor,
191 __SD_link_create(surf_link, NULL);
194 DEBUG2("Workstation number: %d, link number: %d",
195 SD_workstation_get_number(), SD_link_get_number());
199 * \brief Launches the simulation.
201 * The function will execute the \ref SD_RUNNABLE runnable tasks.
202 * If \a how_long is positive, then the simulation will be stopped either
203 * when time reaches \a how_long or when a watch point is reached.
204 * A nonpositive value for \a how_long means no time limit, in which case
205 * the simulation will be stopped either when a watch point is reached or
206 * when no more task can be executed.
207 * Then you can call SD_simulate() again.
209 * \param how_long maximum duration of the simulation (a negative value means no time limit)
210 * \return a NULL-terminated array of \ref SD_task_t whose state has changed.
211 * \see SD_task_schedule(), SD_task_watch()
213 xbt_dynar_t SD_simulate(double how_long)
215 double total_time = 0.0; /* we stop the simulation when total_time >= how_long */
216 double elapsed_time = 0.0;
217 SD_task_t task, task_safe, dst;
218 SD_dependency_t dependency;
219 surf_action_t action;
220 xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
221 unsigned int iter, depcnt;
222 static int first_time = 1;
224 SD_CHECK_INIT_DONE();
227 VERB0("Starting simulation...");
229 surf_presolve(); /* Takes traces into account */
233 sd_global->watch_point_reached = 0;
235 /* explore the runnable tasks */
236 xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
237 VERB1("Executing task '%s'", SD_task_get_name(task));
238 if (__SD_task_try_to_run(task)
239 && !xbt_dynar_member(changed_tasks, &task))
240 xbt_dynar_push(changed_tasks, &task);
245 while (elapsed_time >= 0.0 &&
246 (how_long < 0.0 || total_time < how_long) &&
247 !sd_global->watch_point_reached) {
248 surf_model_t model = NULL;
252 DEBUG1("Total time: %f", total_time);
254 elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long : -1.0);
255 DEBUG1("surf_solve() returns %f", elapsed_time);
256 if (elapsed_time > 0.0)
257 total_time += elapsed_time;
259 /* let's see which tasks are done */
260 xbt_dynar_foreach(model_list, iter, model) {
261 while ((action = xbt_swag_extract(model->states.done_action_set))) {
264 surf_workstation_model->
265 action_get_start_time(task->surf_action);
266 task->finish_time = surf_get_clock();
267 VERB1("Task '%s' done", SD_task_get_name(task));
268 DEBUG0("Calling __SD_task_just_done");
269 __SD_task_just_done(task);
270 DEBUG1("__SD_task_just_done called on task '%s'",
271 SD_task_get_name(task));
273 /* the state has changed */
274 if (!xbt_dynar_member(changed_tasks, &task))
275 xbt_dynar_push(changed_tasks, &task);
277 /* remove the dependencies after this task */
278 xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
279 dst = dependency->dst;
280 if (dst->unsatisfied_dependencies > 0)
281 dst->unsatisfied_dependencies--;
282 if (dst->is_not_ready > 0)
285 if (!(dst->unsatisfied_dependencies)) {
286 if (__SD_task_is_scheduled(dst))
287 __SD_task_set_state(dst, SD_RUNNABLE);
289 __SD_task_set_state(dst, SD_SCHEDULABLE);
292 if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
293 SD_dependency_t comm_dep;
295 xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
296 comm_dst = comm_dep->dst;
297 if (__SD_task_is_not_scheduled(comm_dst) &&
298 comm_dst->is_not_ready > 0) {
299 comm_dst->is_not_ready--;
301 if (!(comm_dst->is_not_ready)) {
302 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
307 /* is dst runnable now? */
308 if (__SD_task_is_runnable(dst)
309 && !sd_global->watch_point_reached) {
310 VERB1("Executing task '%s'", SD_task_get_name(dst));
311 if (__SD_task_try_to_run(dst) &&
312 !xbt_dynar_member(changed_tasks, &task))
313 xbt_dynar_push(changed_tasks, &task);
318 /* let's see which tasks have just failed */
319 while ((action = xbt_swag_extract(model->states.failed_action_set))) {
322 surf_workstation_model->
323 action_get_start_time(task->surf_action);
324 task->finish_time = surf_get_clock();
325 VERB1("Task '%s' failed", SD_task_get_name(task));
326 __SD_task_set_state(task, SD_FAILED);
327 surf_workstation_model->action_unref(action);
328 task->surf_action = NULL;
330 if (!xbt_dynar_member(changed_tasks, &task))
331 xbt_dynar_push(changed_tasks, &task);
336 if (!sd_global->watch_point_reached && how_long<0){
337 if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
338 WARN0("Simulation is finished but some tasks are still not done");
339 xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
340 WARN1("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
342 xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
343 WARN1("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
345 xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
346 WARN1("%s is in SD_SCHEDULED state", SD_task_get_name(task));
351 DEBUG3("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
352 elapsed_time, total_time, sd_global->watch_point_reached);
353 DEBUG1("current time = %f", surf_get_clock());
355 return changed_tasks;
359 * \brief Returns the current clock
361 * \return the current clock, in second
363 double SD_get_clock(void)
365 SD_CHECK_INIT_DONE();
367 return surf_get_clock();
371 * \brief Destroys all SD internal data
373 * This function should be called when the simulation is over. Don't forget also to destroy
376 * \see SD_init(), SD_task_destroy()
381 TRACE_surf_release();
383 if (SD_INITIALISED()) {
384 DEBUG0("Destroying workstation and link dictionaries...");
385 xbt_dict_free(&sd_global->workstations);
386 xbt_dict_free(&sd_global->links);
388 DEBUG0("Destroying workstation and link arrays if necessary...");
389 if (sd_global->workstation_list != NULL)
390 xbt_free(sd_global->workstation_list);
392 if (sd_global->link_list != NULL)
393 xbt_free(sd_global->link_list);
395 if (sd_global->recyclable_route != NULL)
396 xbt_free(sd_global->recyclable_route);
398 DEBUG0("Destroying the swags...");
399 xbt_swag_free(sd_global->not_scheduled_task_set);
400 xbt_swag_free(sd_global->schedulable_task_set);
401 xbt_swag_free(sd_global->scheduled_task_set);
402 xbt_swag_free(sd_global->runnable_task_set);
403 xbt_swag_free(sd_global->in_fifo_task_set);
404 xbt_swag_free(sd_global->running_task_set);
405 xbt_swag_free(sd_global->done_task_set);
406 xbt_swag_free(sd_global->failed_task_set);
415 DEBUG0("Exiting Surf...");
418 WARN0("SD_exit() called, but SimDag is not running");
419 /* we cannot use exceptions here because xbt is not running! */
424 * \bried load script file
427 void SD_load_environment_script(const char *script_file)
430 lua_State *L = lua_open();
433 if (luaL_loadfile(L, script_file) || lua_pcall(L, 0, 0, 0)) {
434 printf("error: %s\n", lua_tostring(L, -1));
439 ("Lua is not available!! to call SD_load_environment_script, lua should be available...");