1 /* Copyright (c) 2007-2009 Da SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include "xbt/sysdep.h"
13 #include "xbt/config.h"
15 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd,
17 "Logging specific to SimDag (kernel)");
19 SD_global_t sd_global = NULL;
21 XBT_LOG_EXTERNAL_CATEGORY(sd_kernel);
22 XBT_LOG_EXTERNAL_CATEGORY(sd_task);
23 XBT_LOG_EXTERNAL_CATEGORY(sd_workstation);
26 * \brief Initialises SD internal data
28 * This function must be called before any other SD function. Then you
29 * should call SD_create_environment().
31 * \param argc argument number
32 * \param argv argument list
33 * \see SD_create_environment(), SD_exit()
35 void SD_init(int *argc, char **argv)
40 xbt_assert0(!SD_INITIALISED(), "SD_init() already called");
42 /* Connect our log channels: that must be done manually under windows */
43 XBT_LOG_CONNECT(sd_kernel, sd);
44 XBT_LOG_CONNECT(sd_task, sd);
45 XBT_LOG_CONNECT(sd_workstation, sd);
48 sd_global = xbt_new(s_SD_global_t, 1);
49 sd_global->workstations = xbt_dict_new();
50 sd_global->workstation_count = 0;
51 sd_global->workstation_list = NULL;
52 sd_global->links = xbt_dict_new();
53 sd_global->link_count = 0;
54 sd_global->link_list = NULL;
55 sd_global->recyclable_route = NULL;
56 sd_global->watch_point_reached = 0;
58 sd_global->not_scheduled_task_set =
59 xbt_swag_new(xbt_swag_offset(task, state_hookup));
60 sd_global->scheduled_task_set =
61 xbt_swag_new(xbt_swag_offset(task, state_hookup));
62 sd_global->ready_task_set =
63 xbt_swag_new(xbt_swag_offset(task, state_hookup));
64 sd_global->in_fifo_task_set =
65 xbt_swag_new(xbt_swag_offset(task, state_hookup));
66 sd_global->running_task_set =
67 xbt_swag_new(xbt_swag_offset(task, state_hookup));
68 sd_global->done_task_set =
69 xbt_swag_new(xbt_swag_offset(task, state_hookup));
70 sd_global->failed_task_set =
71 xbt_swag_new(xbt_swag_offset(task, state_hookup));
72 sd_global->task_number = 0;
74 surf_init(argc, argv);
75 xbt_cfg_set_string(_surf_cfg_set, "workstation/model", "ptask_L07");
79 * \brief Reinits the application part of the simulation (experimental feature)
81 * This function allows you to run several simulations on the same platform
82 * by resetting the part describing the application.
84 * @warning: this function is still experimental and not perfect. For example,
85 * the simulation clock (and traces usage) is not reset. So, do not use it if
86 * you use traces in your simulation, and do not use absolute timing after using it.
87 * That being said, this function is still precious if you want to compare a bunch of
88 * heuristics on the same platforms.
90 void SD_application_reinit(void)
95 if (SD_INITIALISED()) {
96 DEBUG0("Recreating the swags...");
97 xbt_swag_free(sd_global->not_scheduled_task_set);
98 xbt_swag_free(sd_global->scheduled_task_set);
99 xbt_swag_free(sd_global->ready_task_set);
100 xbt_swag_free(sd_global->in_fifo_task_set);
101 xbt_swag_free(sd_global->running_task_set);
102 xbt_swag_free(sd_global->done_task_set);
103 xbt_swag_free(sd_global->failed_task_set);
105 sd_global->not_scheduled_task_set =
106 xbt_swag_new(xbt_swag_offset(task, state_hookup));
107 sd_global->scheduled_task_set =
108 xbt_swag_new(xbt_swag_offset(task, state_hookup));
109 sd_global->ready_task_set =
110 xbt_swag_new(xbt_swag_offset(task, state_hookup));
111 sd_global->in_fifo_task_set =
112 xbt_swag_new(xbt_swag_offset(task, state_hookup));
113 sd_global->running_task_set =
114 xbt_swag_new(xbt_swag_offset(task, state_hookup));
115 sd_global->done_task_set =
116 xbt_swag_new(xbt_swag_offset(task, state_hookup));
117 sd_global->failed_task_set =
118 xbt_swag_new(xbt_swag_offset(task, state_hookup));
119 sd_global->task_number = 0;
121 WARN0("SD_application_reinit called before initialization of SimDag");
122 /* we cannot use exceptions here because xbt is not running! */
128 * \brief Creates the environment
130 * The environment (i.e. the \ref SD_workstation_management "workstations" and the
131 * \ref SD_link_management "links") is created with the data stored in the given XML
134 * \param platform_file name of an XML file describing the environment to create
135 * \see SD_workstation_management, SD_link_management
137 * The XML file follows this DTD:
139 * \include simgrid.dtd
141 * Here is a small example of such a platform:
143 * \include small_platform.xml
145 void SD_create_environment(const char *platform_file)
147 xbt_dict_cursor_t cursor = NULL;
149 void *surf_workstation = NULL;
150 void *surf_link = NULL;
152 SD_CHECK_INIT_DONE();
154 DEBUG0("SD_create_environment");
156 surf_config_models_setup(platform_file);
158 parse_platform_file(platform_file);
160 /* now let's create the SD wrappers for workstations and links */
161 xbt_dict_foreach(surf_model_resource_set(surf_workstation_model), cursor,
162 name, surf_workstation) {
163 __SD_workstation_create(surf_workstation, NULL);
166 xbt_dict_foreach(surf_model_resource_set(surf_network_model), cursor, name, surf_link) {
167 __SD_link_create(surf_link, NULL);
170 DEBUG2("Workstation number: %d, link number: %d",
171 SD_workstation_get_number(), SD_link_get_number());
175 * \brief Launches the simulation.
177 * The function will execute the \ref SD_READY ready tasks.
178 * The simulation will be stopped when its time reaches \a how_long,
179 * when a watch point is reached, or when no more task can be executed.
180 * Then you can call SD_simulate() again.
182 * \param how_long maximum duration of the simulation (a negative value means no time limit)
183 * \return a NULL-terminated array of \ref SD_task_t whose state has changed.
184 * \see SD_task_schedule(), SD_task_watch()
186 SD_task_t *SD_simulate(double how_long)
188 double total_time = 0.0; /* we stop the simulation when total_time >= how_long */
189 double elapsed_time = 0.0;
190 SD_task_t task, task_safe, dst;
191 SD_dependency_t dependency;
192 surf_action_t action;
193 SD_task_t *res = NULL;
194 xbt_dynar_t changed_tasks = xbt_dynar_new(sizeof(SD_task_t), NULL);
196 static int first_time = 1;
198 SD_CHECK_INIT_DONE();
200 INFO0("Starting simulation...");
203 surf_presolve(); /* Takes traces into account */
208 surf_timer_model->extension.timer.set(surf_get_clock() + how_long,
211 sd_global->watch_point_reached = 0;
213 /* explore the ready tasks */
214 xbt_swag_foreach_safe(task, task_safe, sd_global->ready_task_set) {
215 INFO1("Executing task '%s'", SD_task_get_name(task));
216 if (__SD_task_try_to_run(task) && !xbt_dynar_member(changed_tasks, &task))
217 xbt_dynar_push(changed_tasks, &task);
222 while (elapsed_time >= 0.0 &&
223 (how_long < 0.0 || total_time < how_long) &&
224 !sd_global->watch_point_reached) {
225 surf_model_t model = NULL;
231 DEBUG1("Total time: %f", total_time);
233 elapsed_time = surf_solve();
234 DEBUG1("surf_solve() returns %f", elapsed_time);
235 if (elapsed_time > 0.0)
236 total_time += elapsed_time;
238 /* let's see which tasks are done */
239 xbt_dynar_foreach(model_list, iter, model) {
240 while ((action = xbt_swag_extract(model->states.done_action_set))) {
242 task->start_time = surf_workstation_model->action_get_start_time(task->surf_action);
243 task->finish_time = surf_get_clock();
244 INFO1("Task '%s' done", SD_task_get_name(task));
245 DEBUG0("Calling __SD_task_just_done");
246 __SD_task_just_done(task);
247 DEBUG1("__SD_task_just_done called on task '%s'",
248 SD_task_get_name(task));
250 /* the state has changed */
251 if (!xbt_dynar_member(changed_tasks, &task))
252 xbt_dynar_push(changed_tasks, &task);
254 /* remove the dependencies after this task */
255 while (xbt_dynar_length(task->tasks_after) > 0) {
256 xbt_dynar_get_cpy(task->tasks_after, 0, &dependency);
257 dst = dependency->dst;
258 SD_task_dependency_remove(task, dst);
260 /* is dst ready now? */
261 if (__SD_task_is_ready(dst) && !sd_global->watch_point_reached) {
262 INFO1("Executing task '%s'", SD_task_get_name(dst));
263 if (__SD_task_try_to_run(dst) &&
264 !xbt_dynar_member(changed_tasks, &task))
265 xbt_dynar_push(changed_tasks, &task);
270 /* let's see which tasks have just failed */
271 while ((action = xbt_swag_extract(model->states.failed_action_set))) {
273 task->start_time = surf_workstation_model->action_get_start_time(task->surf_action);
274 task->finish_time = surf_get_clock();
275 INFO1("Task '%s' failed", SD_task_get_name(task));
276 __SD_task_set_state(task, SD_FAILED);
277 surf_workstation_model->action_unref(action);
278 task->surf_action = NULL;
280 if (!xbt_dynar_member(changed_tasks, &task))
281 xbt_dynar_push(changed_tasks, &task);
285 while (surf_timer_model->extension.timer.get(&fun, (void *) &arg)) {
289 res = xbt_new0(SD_task_t, (xbt_dynar_length(changed_tasks) + 1));
291 xbt_dynar_foreach(changed_tasks, iter, task) {
294 xbt_dynar_free(&changed_tasks);
296 INFO0("Simulation finished");
297 DEBUG3("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
298 elapsed_time, total_time, sd_global->watch_point_reached);
299 DEBUG1("current time = %f", surf_get_clock());
305 * \brief Returns the current clock
307 * \return the current clock, in second
309 double SD_get_clock(void)
311 SD_CHECK_INIT_DONE();
313 return surf_get_clock();
317 * \brief Destroys all SD internal data
319 * This function should be called when the simulation is over. Don't forget also to destroy
322 * \see SD_init(), SD_task_destroy()
326 if (SD_INITIALISED()) {
327 DEBUG0("Destroying workstation and link dictionaries...");
328 xbt_dict_free(&sd_global->workstations);
329 xbt_dict_free(&sd_global->links);
331 DEBUG0("Destroying workstation and link arrays if necessary...");
332 if (sd_global->workstation_list != NULL)
333 xbt_free(sd_global->workstation_list);
335 if (sd_global->link_list != NULL)
336 xbt_free(sd_global->link_list);
338 if (sd_global->recyclable_route != NULL)
339 xbt_free(sd_global->recyclable_route);
341 DEBUG0("Destroying the swags...");
342 xbt_swag_free(sd_global->not_scheduled_task_set);
343 xbt_swag_free(sd_global->scheduled_task_set);
344 xbt_swag_free(sd_global->ready_task_set);
345 xbt_swag_free(sd_global->in_fifo_task_set);
346 xbt_swag_free(sd_global->running_task_set);
347 xbt_swag_free(sd_global->done_task_set);
348 xbt_swag_free(sd_global->failed_task_set);
353 DEBUG0("Exiting Surf...");
356 WARN0("SD_exit() called, but SimDag is not running");
357 /* we cannot use exceptions here because xbt is not running! */