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"
21 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd,
23 "Logging specific to SimDag (kernel)");
25 SD_global_t sd_global = NULL;
27 XBT_LOG_EXTERNAL_CATEGORY(sd_kernel);
28 XBT_LOG_EXTERNAL_CATEGORY(sd_task);
29 XBT_LOG_EXTERNAL_CATEGORY(sd_workstation);
32 * \brief Initialises SD internal data
34 * This function must be called before any other SD function. Then you
35 * should call SD_create_environment().
37 * \param argc argument number
38 * \param argv argument list
39 * \see SD_create_environment(), SD_exit()
41 void SD_init(int *argc, char **argv)
46 xbt_assert0(!SD_INITIALISED(), "SD_init() already called");
48 /* Connect our log channels: that must be done manually under windows */
49 XBT_LOG_CONNECT(sd_kernel, sd);
50 XBT_LOG_CONNECT(sd_task, sd);
51 XBT_LOG_CONNECT(sd_workstation, sd);
54 sd_global = xbt_new(s_SD_global_t, 1);
55 sd_global->workstations = xbt_dict_new();
56 sd_global->workstation_count = 0;
57 sd_global->workstation_list = NULL;
58 sd_global->links = xbt_dict_new();
59 sd_global->link_count = 0;
60 sd_global->link_list = NULL;
61 sd_global->recyclable_route = NULL;
62 sd_global->watch_point_reached = 0;
64 sd_global->not_scheduled_task_set =
65 xbt_swag_new(xbt_swag_offset(task, state_hookup));
66 sd_global->schedulable_task_set =
67 xbt_swag_new(xbt_swag_offset(task, state_hookup));
68 sd_global->scheduled_task_set =
69 xbt_swag_new(xbt_swag_offset(task, state_hookup));
70 sd_global->runnable_task_set =
71 xbt_swag_new(xbt_swag_offset(task, state_hookup));
72 sd_global->in_fifo_task_set =
73 xbt_swag_new(xbt_swag_offset(task, state_hookup));
74 sd_global->running_task_set =
75 xbt_swag_new(xbt_swag_offset(task, state_hookup));
76 sd_global->done_task_set =
77 xbt_swag_new(xbt_swag_offset(task, state_hookup));
78 sd_global->failed_task_set =
79 xbt_swag_new(xbt_swag_offset(task, state_hookup));
80 sd_global->task_number = 0;
82 surf_init(argc, argv);
83 xbt_cfg_set_string(_surf_cfg_set, "workstation/model", "ptask_L07");
87 * \brief Reinits the application part of the simulation (experimental feature)
89 * This function allows you to run several simulations on the same platform
90 * by resetting the part describing the application.
92 * @warning: this function is still experimental and not perfect. For example,
93 * the simulation clock (and traces usage) is not reset. So, do not use it if
94 * you use traces in your simulation, and do not use absolute timing after using it.
95 * That being said, this function is still precious if you want to compare a bunch of
96 * heuristics on the same platforms.
98 void SD_application_reinit(void)
103 if (SD_INITIALISED()) {
104 DEBUG0("Recreating the swags...");
105 xbt_swag_free(sd_global->not_scheduled_task_set);
106 xbt_swag_free(sd_global->schedulable_task_set);
107 xbt_swag_free(sd_global->scheduled_task_set);
108 xbt_swag_free(sd_global->runnable_task_set);
109 xbt_swag_free(sd_global->in_fifo_task_set);
110 xbt_swag_free(sd_global->running_task_set);
111 xbt_swag_free(sd_global->done_task_set);
112 xbt_swag_free(sd_global->failed_task_set);
114 sd_global->not_scheduled_task_set =
115 xbt_swag_new(xbt_swag_offset(task, state_hookup));
116 sd_global->schedulable_task_set =
117 xbt_swag_new(xbt_swag_offset(task, state_hookup));
118 sd_global->scheduled_task_set =
119 xbt_swag_new(xbt_swag_offset(task, state_hookup));
120 sd_global->runnable_task_set =
121 xbt_swag_new(xbt_swag_offset(task, state_hookup));
122 sd_global->in_fifo_task_set =
123 xbt_swag_new(xbt_swag_offset(task, state_hookup));
124 sd_global->running_task_set =
125 xbt_swag_new(xbt_swag_offset(task, state_hookup));
126 sd_global->done_task_set =
127 xbt_swag_new(xbt_swag_offset(task, state_hookup));
128 sd_global->failed_task_set =
129 xbt_swag_new(xbt_swag_offset(task, state_hookup));
130 sd_global->task_number = 0;
132 WARN0("SD_application_reinit called before initialization of SimDag");
133 /* we cannot use exceptions here because xbt is not running! */
139 * \brief Creates the environment
141 * The environment (i.e. the \ref SD_workstation_management "workstations" and the
142 * \ref SD_link_management "links") is created with the data stored in the given XML
145 * \param platform_file name of an XML file describing the environment to create
146 * \see SD_workstation_management, SD_link_management
148 * The XML file follows this DTD:
150 * \include simgrid.dtd
152 * Here is a small example of such a platform:
154 * \include small_platform.xml
156 void SD_create_environment(const char *platform_file)
158 xbt_dict_cursor_t cursor = NULL;
160 void *surf_workstation = NULL;
161 void *surf_link = NULL;
163 SD_CHECK_INIT_DONE();
165 DEBUG0("SD_create_environment");
167 surf_config_models_setup(platform_file);
169 parse_platform_file(platform_file);
170 /* now let's create the SD wrappers for workstations and links */
171 xbt_dict_foreach(surf_model_resource_set(surf_workstation_model), cursor,
172 name, surf_workstation) {
173 __SD_workstation_create(surf_workstation, NULL);
176 xbt_dict_foreach(surf_model_resource_set(surf_network_model), cursor, name, surf_link) {
177 __SD_link_create(surf_link, NULL);
180 DEBUG2("Workstation number: %d, link number: %d",
181 SD_workstation_get_number(), SD_link_get_number());
185 * \brief Launches the simulation.
187 * The function will execute the \ref SD_RUNNABLE runnable tasks.
188 * The simulation will be stopped when its time reaches \a how_long,
189 * when a watch point is reached, or when no more task can be executed.
190 * Then you can call SD_simulate() again.
192 * \param how_long maximum duration of the simulation (a negative value means no time limit)
193 * \return a NULL-terminated array of \ref SD_task_t whose state has changed.
194 * \see SD_task_schedule(), SD_task_watch()
196 xbt_dynar_t SD_simulate(double how_long)
198 double total_time = 0.0; /* we stop the simulation when total_time >= how_long */
199 double elapsed_time = 0.0;
200 SD_task_t task, task_safe, dst;
201 SD_dependency_t dependency;
202 surf_action_t action;
203 xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
204 unsigned int iter, depcnt;
205 static int first_time = 1;
207 SD_CHECK_INIT_DONE();
209 VERB0("Starting simulation...");
212 surf_presolve(); /* Takes traces into account */
217 surf_timer_model->extension.timer.set(surf_get_clock() + how_long,
220 sd_global->watch_point_reached = 0;
222 /* explore the runnable tasks */
223 xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
224 VERB1("Executing task '%s'", SD_task_get_name(task));
225 if (__SD_task_try_to_run(task) && !xbt_dynar_member(changed_tasks, &task))
226 xbt_dynar_push(changed_tasks, &task);
231 while (elapsed_time >= 0.0 &&
232 (how_long < 0.0 || total_time < how_long) &&
233 !sd_global->watch_point_reached) {
234 surf_model_t model = NULL;
240 DEBUG1("Total time: %f", total_time);
242 elapsed_time = surf_solve();
243 DEBUG1("surf_solve() returns %f", elapsed_time);
244 if (elapsed_time > 0.0)
245 total_time += elapsed_time;
247 /* let's see which tasks are done */
248 xbt_dynar_foreach(model_list, iter, model) {
249 while ((action = xbt_swag_extract(model->states.done_action_set))) {
251 task->start_time = surf_workstation_model->action_get_start_time(task->surf_action);
252 task->finish_time = surf_get_clock();
253 VERB1("Task '%s' done", SD_task_get_name(task));
254 DEBUG0("Calling __SD_task_just_done");
255 __SD_task_just_done(task);
256 DEBUG1("__SD_task_just_done called on task '%s'",
257 SD_task_get_name(task));
259 /* the state has changed */
260 if (!xbt_dynar_member(changed_tasks, &task))
261 xbt_dynar_push(changed_tasks, &task);
263 /* remove the dependencies after this task */
264 xbt_dynar_foreach(task->tasks_after, depcnt, dependency){
265 dst = dependency->dst;
266 if (dst->unsatisfied_dependencies>0)
267 dst->unsatisfied_dependencies--;
268 if (dst->is_not_ready>0)
271 if (!(dst->unsatisfied_dependencies)){
272 if (__SD_task_is_scheduled(dst))
273 __SD_task_set_state(dst, SD_RUNNABLE);
275 __SD_task_set_state(dst, SD_SCHEDULABLE);
278 if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E){
279 SD_dependency_t comm_dep;
281 xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
282 comm_dst = comm_dep->dst;
283 if (__SD_task_is_not_scheduled(comm_dst) &&
284 comm_dst->is_not_ready>0){
285 comm_dst->is_not_ready--;
287 if (!(comm_dst->is_not_ready)){
288 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
293 /* is dst runnable now? */
294 if (__SD_task_is_runnable(dst) && !sd_global->watch_point_reached) {
295 VERB1("Executing task '%s'", SD_task_get_name(dst));
296 if (__SD_task_try_to_run(dst) &&
297 !xbt_dynar_member(changed_tasks, &task))
298 xbt_dynar_push(changed_tasks, &task);
303 /* let's see which tasks have just failed */
304 while ((action = xbt_swag_extract(model->states.failed_action_set))) {
306 task->start_time = surf_workstation_model->action_get_start_time(task->surf_action);
307 task->finish_time = surf_get_clock();
308 VERB1("Task '%s' failed", SD_task_get_name(task));
309 __SD_task_set_state(task, SD_FAILED);
310 surf_workstation_model->action_unref(action);
311 task->surf_action = NULL;
313 if (!xbt_dynar_member(changed_tasks, &task))
314 xbt_dynar_push(changed_tasks, &task);
318 while (surf_timer_model->extension.timer.get(&fun, (void *) &arg)) {
322 VERB0("Simulation finished");
323 DEBUG3("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
324 elapsed_time, total_time, sd_global->watch_point_reached);
325 DEBUG1("current time = %f", surf_get_clock());
327 return changed_tasks;
331 * \brief Returns the current clock
333 * \return the current clock, in second
335 double SD_get_clock(void)
337 SD_CHECK_INIT_DONE();
339 return surf_get_clock();
343 * \brief Destroys all SD internal data
345 * This function should be called when the simulation is over. Don't forget also to destroy
348 * \see SD_init(), SD_task_destroy()
352 if (SD_INITIALISED()) {
353 DEBUG0("Destroying workstation and link dictionaries...");
354 xbt_dict_free(&sd_global->workstations);
355 xbt_dict_free(&sd_global->links);
357 DEBUG0("Destroying workstation and link arrays if necessary...");
358 if (sd_global->workstation_list != NULL)
359 xbt_free(sd_global->workstation_list);
361 if (sd_global->link_list != NULL)
362 xbt_free(sd_global->link_list);
364 if (sd_global->recyclable_route != NULL)
365 xbt_free(sd_global->recyclable_route);
367 DEBUG0("Destroying the swags...");
368 xbt_swag_free(sd_global->not_scheduled_task_set);
369 xbt_swag_free(sd_global->schedulable_task_set);
370 xbt_swag_free(sd_global->scheduled_task_set);
371 xbt_swag_free(sd_global->runnable_task_set);
372 xbt_swag_free(sd_global->in_fifo_task_set);
373 xbt_swag_free(sd_global->running_task_set);
374 xbt_swag_free(sd_global->done_task_set);
375 xbt_swag_free(sd_global->failed_task_set);
380 DEBUG0("Exiting Surf...");
383 WARN0("SD_exit() called, but SimDag is not running");
384 /* we cannot use exceptions here because xbt is not running! */
389 * \bried load script file
392 void SD_load_environment_script(const char* script_file)
395 lua_State *L = lua_open();
398 if (luaL_loadfile(L, script_file) || lua_pcall(L, 0, 0, 0)) {
399 printf("error: %s\n", lua_tostring(L, -1));
403 xbt_die("Lua is not available!! to call SD_load_environment_script, lua should be available...");