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"
16 #include "surf/surfxml_parse.h"
24 #include "instr/jedule/jedule_sd_binding.h"
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)");
31 SD_global_t sd_global = NULL;
33 XBT_LOG_EXTERNAL_CATEGORY(sd_kernel);
34 XBT_LOG_EXTERNAL_CATEGORY(sd_task);
35 XBT_LOG_EXTERNAL_CATEGORY(sd_workstation);
38 * \brief Initialises SD internal data
40 * This function must be called before any other SD function. Then you
41 * should call SD_create_environment().
43 * \param argc argument number
44 * \param argv argument list
45 * \see SD_create_environment(), SD_exit()
47 void SD_init(int *argc, char **argv)
50 TRACE_global_init(argc, argv);
55 xbt_assert(sd_global == NULL, "SD_init() already called");
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);
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;
69 sd_global->task_mallocator=xbt_mallocator_new(65536, SD_task_new_f,SD_task_free_f,SD_task_recycle_f);
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;
91 surf_init(argc, argv);
93 xbt_cfg_setdefault_string(_surf_cfg_set, "workstation/model",
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);
110 * \brief Reinits the application part of the simulation (experimental feature)
112 * This function allows you to run several simulations on the same platform
113 * by resetting the part describing the application.
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.
121 void SD_application_reinit(void)
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);
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;
161 * \brief Creates the environment
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
167 * \param platform_file name of an XML file describing the environment to create
168 * \see SD_workstation_management, SD_link_management
170 * The XML file follows this DTD:
172 * \include simgrid.dtd
174 * Here is a small example of such a platform:
176 * \include small_platform.xml
178 void SD_create_environment(const char *platform_file)
180 xbt_lib_cursor_t cursor = NULL;
182 void **surf_workstation = NULL;
183 void **surf_link = NULL;
185 parse_platform_file(platform_file);
187 /* now let's create the SD wrappers for workstations and links */
188 xbt_lib_foreach(host_lib, cursor, name, surf_workstation){
189 if(surf_workstation[SURF_WKS_LEVEL])
190 __SD_workstation_create(surf_workstation[SURF_WKS_LEVEL], NULL);
193 xbt_lib_foreach(link_lib, cursor, name, surf_link) {
194 if(surf_link[SURF_LINK_LEVEL])
195 __SD_link_create(surf_link[SURF_LINK_LEVEL], NULL);
198 XBT_DEBUG("Workstation number: %d, link number: %d",
199 SD_workstation_get_number(), SD_link_get_number());
201 jedule_setup_platform();
206 * \brief Launches the simulation.
208 * The function will execute the \ref SD_RUNNABLE runnable tasks.
209 * If \a how_long is positive, then the simulation will be stopped either
210 * when time reaches \a how_long or when a watch point is reached.
211 * A nonpositive value for \a how_long means no time limit, in which case
212 * the simulation will be stopped either when a watch point is reached or
213 * when no more task can be executed.
214 * Then you can call SD_simulate() again.
216 * \param how_long maximum duration of the simulation (a negative value means no time limit)
217 * \return a NULL-terminated array of \ref SD_task_t whose state has changed.
218 * \see SD_task_schedule(), SD_task_watch()
221 xbt_dynar_t SD_simulate(double how_long) {
222 xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
225 SD_simulate_swag(how_long);
226 while( (task = xbt_swag_extract(sd_global->return_set)) != NULL) {
227 xbt_dynar_push(changed_tasks, &task);
230 return changed_tasks;
233 xbt_swag_t SD_simulate_swag(double how_long) {
234 double total_time = 0.0; /* we stop the simulation when total_time >= how_long */
235 double elapsed_time = 0.0;
236 SD_task_t task, task_safe, dst;
237 SD_dependency_t dependency;
238 surf_action_t action;
239 unsigned int iter, depcnt;
240 static int first_time = 1;
243 XBT_VERB("Starting simulation...");
245 surf_presolve(); /* Takes traces into account */
249 sd_global->watch_point_reached = 0;
251 xbt_swag_reset(sd_global->return_set);
253 /* explore the runnable tasks */
254 xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
255 XBT_VERB("Executing task '%s'", SD_task_get_name(task));
256 if (__SD_task_try_to_run(task))
257 xbt_swag_insert(task,sd_global->return_set);
262 while (elapsed_time >= 0.0 &&
263 (how_long < 0.0 || total_time < how_long) &&
264 !sd_global->watch_point_reached) {
265 surf_model_t model = NULL;
269 XBT_DEBUG("Total time: %f", total_time);
271 elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long : -1.0);
272 XBT_DEBUG("surf_solve() returns %f", elapsed_time);
273 if (elapsed_time > 0.0)
274 total_time += elapsed_time;
276 /* let's see which tasks are done */
277 xbt_dynar_foreach(model_list, iter, model) {
278 while ((action = xbt_swag_extract(model->states.done_action_set))) {
281 surf_workstation_model->
282 action_get_start_time(task->surf_action);
283 task->finish_time = surf_get_clock();
284 XBT_VERB("Task '%s' done", SD_task_get_name(task));
285 XBT_DEBUG("Calling __SD_task_just_done");
286 __SD_task_just_done(task);
287 XBT_DEBUG("__SD_task_just_done called on task '%s'",
288 SD_task_get_name(task));
290 /* the state has changed */
291 xbt_swag_insert(task,sd_global->return_set);
293 /* remove the dependencies after this task */
294 xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
295 dst = dependency->dst;
296 if (dst->unsatisfied_dependencies > 0)
297 dst->unsatisfied_dependencies--;
298 if (dst->is_not_ready > 0)
301 if (!(dst->unsatisfied_dependencies)) {
302 if (__SD_task_is_scheduled(dst))
303 __SD_task_set_state(dst, SD_RUNNABLE);
305 __SD_task_set_state(dst, SD_SCHEDULABLE);
308 if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
309 SD_dependency_t comm_dep;
311 xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
312 comm_dst = comm_dep->dst;
313 if (__SD_task_is_not_scheduled(comm_dst) &&
314 comm_dst->is_not_ready > 0) {
315 comm_dst->is_not_ready--;
317 if (!(comm_dst->is_not_ready)) {
318 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
323 /* is dst runnable now? */
324 if (__SD_task_is_runnable(dst)
325 && !sd_global->watch_point_reached) {
326 XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
327 if (__SD_task_try_to_run(dst))
328 xbt_swag_insert(dst,sd_global->return_set);
333 /* let's see which tasks have just failed */
334 while ((action = xbt_swag_extract(model->states.failed_action_set))) {
337 surf_workstation_model->
338 action_get_start_time(task->surf_action);
339 task->finish_time = surf_get_clock();
340 XBT_VERB("Task '%s' failed", SD_task_get_name(task));
341 __SD_task_set_state(task, SD_FAILED);
342 surf_workstation_model->action_unref(action);
343 task->surf_action = NULL;
345 xbt_swag_insert(task,sd_global->return_set);
350 if (!sd_global->watch_point_reached && how_long<0){
351 if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
352 XBT_WARN("Simulation is finished but %d tasks are still not done",
353 (sd_global->task_number - xbt_swag_size(sd_global->done_task_set)));
354 xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
355 XBT_WARN("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
357 xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
358 XBT_WARN("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
360 xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
361 XBT_WARN("%s is in SD_SCHEDULED state", SD_task_get_name(task));
366 XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
367 elapsed_time, total_time, sd_global->watch_point_reached);
368 XBT_DEBUG("current time = %f", surf_get_clock());
370 return sd_global->return_set;
374 * \brief Returns the current clock
376 * \return the current clock, in second
378 double SD_get_clock(void) {
379 return surf_get_clock();
383 * \brief Destroys all SD internal data
385 * This function should be called when the simulation is over. Don't forget also to destroy
388 * \see SD_init(), SD_task_destroy()
393 TRACE_surf_release();
396 xbt_mallocator_free(sd_global->task_mallocator);
398 XBT_DEBUG("Destroying workstation and link arrays...");
399 xbt_free(sd_global->workstation_list);
400 xbt_free(sd_global->link_list);
401 xbt_free(sd_global->recyclable_route);
403 XBT_DEBUG("Destroying the swags...");
404 xbt_swag_free(sd_global->not_scheduled_task_set);
405 xbt_swag_free(sd_global->schedulable_task_set);
406 xbt_swag_free(sd_global->scheduled_task_set);
407 xbt_swag_free(sd_global->runnable_task_set);
408 xbt_swag_free(sd_global->in_fifo_task_set);
409 xbt_swag_free(sd_global->running_task_set);
410 xbt_swag_free(sd_global->done_task_set);
411 xbt_swag_free(sd_global->failed_task_set);
412 xbt_swag_free(sd_global->return_set);
414 XBT_DEBUG("Exiting Surf...");
430 * \brief load script file
433 void SD_load_environment_script(const char *script_file)
436 lua_State *L = lua_open();
439 if (luaL_loadfile(L, script_file) || lua_pcall(L, 0, 0, 0)) {
440 printf("error: %s\n", lua_tostring(L, -1));
445 ("Lua is not available!! to call SD_load_environment_script, lua should be available...");