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;
34 * \brief Initialises SD internal data
36 * This function must be called before any other SD function. Then you
37 * should call SD_create_environment().
39 * \param argc argument number
40 * \param argv argument list
41 * \see SD_create_environment(), SD_exit()
43 void SD_init(int *argc, char **argv)
46 TRACE_global_init(argc, argv);
51 xbt_assert(sd_global == NULL, "SD_init() already called");
53 sd_global = xbt_new(s_SD_global_t, 1);
54 sd_global->workstation_list = NULL;
55 sd_global->link_list = NULL;
56 sd_global->recyclable_route = NULL;
57 sd_global->watch_point_reached = 0;
59 sd_global->task_mallocator=xbt_mallocator_new(65536, SD_task_new_f,SD_task_free_f,SD_task_recycle_f);
61 sd_global->not_scheduled_task_set =
62 xbt_swag_new(xbt_swag_offset(task, state_hookup));
63 sd_global->schedulable_task_set =
64 xbt_swag_new(xbt_swag_offset(task, state_hookup));
65 sd_global->scheduled_task_set =
66 xbt_swag_new(xbt_swag_offset(task, state_hookup));
67 sd_global->runnable_task_set =
68 xbt_swag_new(xbt_swag_offset(task, state_hookup));
69 sd_global->in_fifo_task_set =
70 xbt_swag_new(xbt_swag_offset(task, state_hookup));
71 sd_global->running_task_set =
72 xbt_swag_new(xbt_swag_offset(task, state_hookup));
73 sd_global->done_task_set =
74 xbt_swag_new(xbt_swag_offset(task, state_hookup));
75 sd_global->failed_task_set =
76 xbt_swag_new(xbt_swag_offset(task, state_hookup));
77 sd_global->return_set =
78 xbt_swag_new(xbt_swag_offset(task, return_hookup));
79 sd_global->task_number = 0;
81 surf_init(argc, argv);
83 xbt_cfg_setdefault_string(_surf_cfg_set, "workstation/model",
94 XBT_DEBUG("ADD SD LEVELS");
95 SD_HOST_LEVEL = xbt_lib_add_level(host_lib,__SD_workstation_destroy);
96 SD_LINK_LEVEL = xbt_lib_add_level(link_lib,__SD_link_destroy);
100 * \brief Reinits the application part of the simulation (experimental feature)
102 * This function allows you to run several simulations on the same platform
103 * by resetting the part describing the application.
105 * @warning: this function is still experimental and not perfect. For example,
106 * the simulation clock (and traces usage) is not reset. So, do not use it if
107 * you use traces in your simulation, and do not use absolute timing after using it.
108 * That being said, this function is still precious if you want to compare a bunch of
109 * heuristics on the same platforms.
111 void SD_application_reinit(void)
116 XBT_DEBUG("Recreating the swags...");
117 xbt_swag_free(sd_global->not_scheduled_task_set);
118 xbt_swag_free(sd_global->schedulable_task_set);
119 xbt_swag_free(sd_global->scheduled_task_set);
120 xbt_swag_free(sd_global->runnable_task_set);
121 xbt_swag_free(sd_global->in_fifo_task_set);
122 xbt_swag_free(sd_global->running_task_set);
123 xbt_swag_free(sd_global->done_task_set);
124 xbt_swag_free(sd_global->failed_task_set);
126 sd_global->not_scheduled_task_set =
127 xbt_swag_new(xbt_swag_offset(task, state_hookup));
128 sd_global->schedulable_task_set =
129 xbt_swag_new(xbt_swag_offset(task, state_hookup));
130 sd_global->scheduled_task_set =
131 xbt_swag_new(xbt_swag_offset(task, state_hookup));
132 sd_global->runnable_task_set =
133 xbt_swag_new(xbt_swag_offset(task, state_hookup));
134 sd_global->in_fifo_task_set =
135 xbt_swag_new(xbt_swag_offset(task, state_hookup));
136 sd_global->running_task_set =
137 xbt_swag_new(xbt_swag_offset(task, state_hookup));
138 sd_global->done_task_set =
139 xbt_swag_new(xbt_swag_offset(task, state_hookup));
140 sd_global->failed_task_set =
141 xbt_swag_new(xbt_swag_offset(task, state_hookup));
142 sd_global->task_number = 0;
151 * \brief Creates the environment
153 * The environment (i.e. the \ref SD_workstation_management "workstations" and the
154 * \ref SD_link_management "links") is created with the data stored in the given XML
157 * \param platform_file name of an XML file describing the environment to create
158 * \see SD_workstation_management, SD_link_management
160 * The XML file follows this DTD:
162 * \include simgrid.dtd
164 * Here is a small example of such a platform:
166 * \include small_platform.xml
168 void SD_create_environment(const char *platform_file)
170 xbt_lib_cursor_t cursor = NULL;
172 void **surf_workstation = NULL;
173 void **surf_link = NULL;
175 parse_platform_file(platform_file);
177 /* now let's create the SD wrappers for workstations and links */
178 xbt_lib_foreach(host_lib, cursor, name, surf_workstation){
179 if(surf_workstation[SURF_WKS_LEVEL])
180 __SD_workstation_create(surf_workstation[SURF_WKS_LEVEL], NULL);
183 xbt_lib_foreach(link_lib, cursor, name, surf_link) {
184 if(surf_link[SURF_LINK_LEVEL])
185 __SD_link_create(surf_link[SURF_LINK_LEVEL], NULL);
188 XBT_DEBUG("Workstation number: %d, link number: %d",
189 SD_workstation_get_number(), SD_link_get_number());
191 jedule_setup_platform();
196 * \brief Launches the simulation.
198 * The function will execute the \ref SD_RUNNABLE runnable tasks.
199 * If \a how_long is positive, then the simulation will be stopped either
200 * when time reaches \a how_long or when a watch point is reached.
201 * A nonpositive value for \a how_long means no time limit, in which case
202 * the simulation will be stopped either when a watch point is reached or
203 * when no more task can be executed.
204 * Then you can call SD_simulate() again.
206 * \param how_long maximum duration of the simulation (a negative value means no time limit)
207 * \return a dynar of \ref SD_task_t whose state has changed.
208 * \see SD_task_schedule(), SD_task_watch()
211 xbt_dynar_t SD_simulate(double how_long) {
212 xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
215 SD_simulate_swag(how_long);
216 while( (task = xbt_swag_extract(sd_global->return_set)) != NULL) {
217 xbt_dynar_push(changed_tasks, &task);
220 return changed_tasks;
223 xbt_swag_t SD_simulate_swag(double how_long) {
224 double total_time = 0.0; /* we stop the simulation when total_time >= how_long */
225 double elapsed_time = 0.0;
226 SD_task_t task, task_safe, dst;
227 SD_dependency_t dependency;
228 surf_action_t action;
229 unsigned int iter, depcnt;
230 static int first_time = 1;
233 XBT_VERB("Starting simulation...");
235 surf_presolve(); /* Takes traces into account */
239 sd_global->watch_point_reached = 0;
241 xbt_swag_reset(sd_global->return_set);
243 /* explore the runnable tasks */
244 xbt_swag_foreach_safe(task, task_safe, sd_global->runnable_task_set) {
245 XBT_VERB("Executing task '%s'", SD_task_get_name(task));
246 if (__SD_task_try_to_run(task))
247 xbt_swag_insert(task,sd_global->return_set);
252 while (elapsed_time >= 0.0 &&
253 (how_long < 0.0 || total_time < how_long) &&
254 !sd_global->watch_point_reached) {
255 surf_model_t model = NULL;
259 XBT_DEBUG("Total time: %f", total_time);
261 elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long : -1.0);
262 XBT_DEBUG("surf_solve() returns %f", elapsed_time);
263 if (elapsed_time > 0.0)
264 total_time += elapsed_time;
266 /* let's see which tasks are done */
267 xbt_dynar_foreach(model_list, iter, model) {
268 while ((action = xbt_swag_extract(model->states.done_action_set))) {
271 surf_workstation_model->
272 action_get_start_time(task->surf_action);
273 task->finish_time = surf_get_clock();
274 XBT_VERB("Task '%s' done", SD_task_get_name(task));
275 XBT_DEBUG("Calling __SD_task_just_done");
276 __SD_task_just_done(task);
277 XBT_DEBUG("__SD_task_just_done called on task '%s'",
278 SD_task_get_name(task));
280 /* the state has changed */
281 xbt_swag_insert(task,sd_global->return_set);
283 /* remove the dependencies after this task */
284 xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
285 dst = dependency->dst;
286 if (dst->unsatisfied_dependencies > 0)
287 dst->unsatisfied_dependencies--;
288 if (dst->is_not_ready > 0)
291 if (!(dst->unsatisfied_dependencies)) {
292 if (__SD_task_is_scheduled(dst))
293 __SD_task_set_state(dst, SD_RUNNABLE);
295 __SD_task_set_state(dst, SD_SCHEDULABLE);
298 if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
299 SD_dependency_t comm_dep;
301 xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
302 comm_dst = comm_dep->dst;
303 if (__SD_task_is_not_scheduled(comm_dst) &&
304 comm_dst->is_not_ready > 0) {
305 comm_dst->is_not_ready--;
307 if (!(comm_dst->is_not_ready)) {
308 __SD_task_set_state(comm_dst, SD_SCHEDULABLE);
313 /* is dst runnable now? */
314 if (__SD_task_is_runnable(dst)
315 && !sd_global->watch_point_reached) {
316 XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
317 if (__SD_task_try_to_run(dst))
318 xbt_swag_insert(dst,sd_global->return_set);
323 /* let's see which tasks have just failed */
324 while ((action = xbt_swag_extract(model->states.failed_action_set))) {
327 surf_workstation_model->
328 action_get_start_time(task->surf_action);
329 task->finish_time = surf_get_clock();
330 XBT_VERB("Task '%s' failed", SD_task_get_name(task));
331 __SD_task_set_state(task, SD_FAILED);
332 surf_workstation_model->action_unref(action);
333 task->surf_action = NULL;
335 xbt_swag_insert(task,sd_global->return_set);
340 if (!sd_global->watch_point_reached && how_long<0){
341 if (xbt_swag_size(sd_global->done_task_set) < sd_global->task_number){
342 XBT_WARN("Simulation is finished but %d tasks are still not done",
343 (sd_global->task_number - xbt_swag_size(sd_global->done_task_set)));
344 xbt_swag_foreach_safe (task, task_safe,sd_global->not_scheduled_task_set){
345 XBT_WARN("%s is in SD_NOT_SCHEDULED state", SD_task_get_name(task));
347 xbt_swag_foreach_safe (task, task_safe,sd_global->schedulable_task_set){
348 XBT_WARN("%s is in SD_SCHEDULABLE state", SD_task_get_name(task));
350 xbt_swag_foreach_safe (task, task_safe,sd_global->scheduled_task_set){
351 XBT_WARN("%s is in SD_SCHEDULED state", SD_task_get_name(task));
356 XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
357 elapsed_time, total_time, sd_global->watch_point_reached);
358 XBT_DEBUG("current time = %f", surf_get_clock());
360 return sd_global->return_set;
364 * \brief Returns the current clock
366 * \return the current clock, in second
368 double SD_get_clock(void) {
369 return surf_get_clock();
373 * \brief Destroys all SD internal data
375 * This function should be called when the simulation is over. Don't forget also to destroy
378 * \see SD_init(), SD_task_destroy()
383 TRACE_surf_release();
386 xbt_mallocator_free(sd_global->task_mallocator);
388 XBT_DEBUG("Destroying workstation and link arrays...");
389 xbt_free(sd_global->workstation_list);
390 xbt_free(sd_global->link_list);
391 xbt_free(sd_global->recyclable_route);
393 XBT_DEBUG("Destroying the swags...");
394 xbt_swag_free(sd_global->not_scheduled_task_set);
395 xbt_swag_free(sd_global->schedulable_task_set);
396 xbt_swag_free(sd_global->scheduled_task_set);
397 xbt_swag_free(sd_global->runnable_task_set);
398 xbt_swag_free(sd_global->in_fifo_task_set);
399 xbt_swag_free(sd_global->running_task_set);
400 xbt_swag_free(sd_global->done_task_set);
401 xbt_swag_free(sd_global->failed_task_set);
402 xbt_swag_free(sd_global->return_set);
408 XBT_DEBUG("Exiting Surf...");
421 * \brief load script file
424 void SD_load_environment_script(const char *script_file)
427 lua_State *L = lua_open();
430 if (luaL_loadfile(L, script_file) || lua_pcall(L, 0, 0, 0)) {
431 printf("error: %s\n", lua_tostring(L, -1));
436 ("Lua is not available!! to call SD_load_environment_script, lua should be available...");