2 #include "xbt/sysdep.h"
6 XBT_LOG_NEW_CATEGORY(sd,"Logging specific to SimDag");
7 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel,sd,
8 "Logging specific to SimDag (kernel)");
10 SD_global_t sd_global = NULL;
13 * \brief Initialises SD internal data
15 * This function must be called before any other SD function. Then you
16 * should call SD_create_environment().
18 * \param argc argument number
19 * \param argv argument list
20 * \see SD_create_environment(), SD_exit()
22 void SD_init(int *argc, char **argv) {
26 xbt_assert0( !SD_INITIALISED() , "SD_init() already called");
28 sd_global = xbt_new(s_SD_global_t, 1);
29 sd_global->workstations = xbt_dict_new();
30 sd_global->workstation_count = 0;
31 sd_global->workstation_list = NULL;
32 sd_global->links = xbt_dict_new();
33 sd_global->link_count = 0;
34 sd_global->link_list = NULL;
35 sd_global->recyclable_route = NULL;
36 sd_global->watch_point_reached = 0;
38 sd_global->not_scheduled_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
39 sd_global->scheduled_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
40 sd_global->ready_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
41 sd_global->in_fifo_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
42 sd_global->running_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
43 sd_global->done_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
44 sd_global->failed_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
45 sd_global->task_number = 0;
47 surf_init(argc, argv);
51 * \brief Reinits the application part of the simulation (experimental feature)
53 * This function allows you to run several simulations on the same platform
54 * by resetting the part describing the application.
56 * @warning: this function is still experimental and not perfect. For example,
57 * the simulation clock (and traces usage) is not reset. So, do not use it if
58 * you use traces in your simulation, and do not use absolute timing after using it.
59 * That being said, this function is still precious if you want to compare a bunch of
60 * heuristics on the same platforms.
62 void SD_application_reinit(void) {
66 if (SD_INITIALISED()) {
67 DEBUG0("Recreating the swags...");
68 xbt_swag_free(sd_global->not_scheduled_task_set);
69 xbt_swag_free(sd_global->scheduled_task_set);
70 xbt_swag_free(sd_global->ready_task_set);
71 xbt_swag_free(sd_global->in_fifo_task_set);
72 xbt_swag_free(sd_global->running_task_set);
73 xbt_swag_free(sd_global->done_task_set);
74 xbt_swag_free(sd_global->failed_task_set);
76 sd_global->not_scheduled_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
77 sd_global->scheduled_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
78 sd_global->ready_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
79 sd_global->in_fifo_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
80 sd_global->running_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
81 sd_global->done_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
82 sd_global->failed_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
83 sd_global->task_number = 0;
85 WARN0("SD_application_reinit called before initialization of SimDag");
86 /* we cannot use exceptions here because xbt is not running! */
94 * \brief Creates the environment
96 * The environment (i.e. the \ref SD_workstation_management "workstations" and the
97 * \ref SD_link_management "links") is created with the data stored in the given XML
100 * \param platform_file name of an XML file describing the environment to create
101 * \see SD_workstation_management, SD_link_management
103 * The XML file follows this DTD:
105 * \include surfxml.dtd
107 * Here is a small example of such a platform:
109 * \include small_platform.xml
111 void SD_create_environment(const char *platform_file) {
112 xbt_dict_cursor_t cursor = NULL;
114 void *surf_workstation = NULL;
115 void *surf_link = NULL;
117 SD_CHECK_INIT_DONE();
119 DEBUG0("SD_create_environment");
121 surf_timer_resource_init(platform_file); /* tell Surf to create the environnement */
123 DEBUG0("Calling surf_workstation_resource_init");
124 surf_workstation_resource_init_KCCFLN05(platform_file);
125 /* surf_workstation_resource_init_CLM03(platform_file); */
127 /* now let's create the SD wrappers for workstations and links */
128 DEBUG0("Creating SimDags hosts and links");
129 xbt_dict_foreach(workstation_set, cursor, name, surf_workstation) {
130 __SD_workstation_create(surf_workstation, NULL);
133 xbt_dict_foreach(network_link_set, cursor, name, surf_link) {
134 __SD_link_create(surf_link, NULL);
137 DEBUG2("Workstation number: %d, link number: %d", SD_workstation_get_number(), SD_link_get_number());
141 * \brief Launches the simulation.
143 * The function will execute the \ref SD_READY ready tasks.
144 * The simulation will be stopped when its time reaches \a how_long,
145 * when a watch point is reached, or when no more task can be executed.
146 * Then you can call SD_simulate() again.
148 * \param how_long maximum duration of the simulation (a negative value means no time limit)
149 * \return a NULL-terminated array of \ref SD_task_t whose state has changed.
150 * \see SD_task_schedule(), SD_task_watch()
152 SD_task_t* SD_simulate(double how_long)
154 double total_time = 0.0; /* we stop the simulation when total_time >= how_long */
155 double elapsed_time = 0.0;
157 SD_dependency_t dependency;
158 surf_action_t action;
159 SD_task_t *changed_tasks = NULL;
160 int changed_task_number = 0;
161 int changed_task_capacity = sd_global->task_number + 1;
163 static int first_time = 1;
165 SD_CHECK_INIT_DONE();
167 INFO0("Starting simulation...");
169 /* create the array that will be returned */
170 changed_tasks = xbt_new(SD_task_t, changed_task_capacity);
171 changed_tasks[0] = NULL;
174 surf_solve(); /* Takes traces into account. Returns 0.0 */
178 sd_global->watch_point_reached = 0;
180 /* explore the ready tasks */
181 xbt_swag_foreach(task, sd_global->ready_task_set) {
182 INFO1("Executing task '%s'", SD_task_get_name(task));
183 if ((task->state_changed = __SD_task_try_to_run(task))) {
184 changed_tasks[changed_task_number++] = task; /* replace NULL by the task */
186 if (changed_task_number == changed_task_capacity) {
187 changed_task_capacity *= 2;
188 changed_tasks = xbt_realloc(changed_tasks, sizeof(SD_task_t) * changed_task_capacity);
191 changed_tasks[changed_task_number] = NULL;
197 while (elapsed_time >= 0.0 &&
198 (how_long < 0.0 || total_time < how_long) &&
199 !sd_global->watch_point_reached) {
201 DEBUG1("Total time: %f", total_time);
203 elapsed_time = surf_solve();
204 DEBUG1("surf_solve() returns %f", elapsed_time);
205 if (elapsed_time > 0.0)
206 total_time += elapsed_time;
208 /* let's see which tasks are done */
209 while ((action = xbt_swag_extract(surf_workstation_resource->common_public->states.done_action_set))) {
211 INFO1("Task '%s' done", SD_task_get_name(task));
212 DEBUG0("Calling __SD_task_just_done");
213 __SD_task_just_done(task);
214 DEBUG1("__SD_task_just_done called on task '%s'", SD_task_get_name(task));
216 /* the state has changed */
217 if (!task->state_changed) {
218 task->state_changed = 1;
219 changed_tasks[changed_task_number++] = task;
221 if (changed_task_number == changed_task_capacity) {
222 changed_task_capacity *= 2;
223 changed_tasks = xbt_realloc(changed_tasks, sizeof(SD_task_t) * changed_task_capacity);
226 changed_tasks[changed_task_number] = NULL;
229 /* remove the dependencies after this task */
230 while (xbt_dynar_length(task->tasks_after) > 0) {
231 xbt_dynar_get_cpy(task->tasks_after, 0, &dependency);
232 dst = dependency->dst;
233 SD_task_dependency_remove(task, dst);
235 /* is dst ready now? */
236 if (__SD_task_is_ready(dst) && !sd_global->watch_point_reached) {
237 INFO1("Executing task '%s'", SD_task_get_name(dst));
238 if (__SD_task_try_to_run(dst)) {
239 changed_tasks[changed_task_number++] = dst;
241 if (changed_task_number == changed_task_capacity) {
242 changed_task_capacity *= 2;
243 changed_tasks = xbt_realloc(changed_tasks, sizeof(SD_task_t) * changed_task_capacity);
246 changed_tasks[changed_task_number] = NULL;
252 /* let's see which tasks have just failed */
253 while ((action = xbt_swag_extract(surf_workstation_resource->common_public->states.failed_action_set))) {
255 INFO1("Task '%s' failed", SD_task_get_name(task));
256 __SD_task_set_state(task, SD_FAILED);
257 surf_workstation_resource->common_public->action_free(action);
258 task->surf_action = NULL;
260 if (!task->state_changed) {
261 task->state_changed = 1;
262 changed_tasks[changed_task_number++] = task;
264 if (changed_task_number == changed_task_capacity) {
265 changed_task_capacity *= 2;
266 changed_tasks = xbt_realloc(changed_tasks, sizeof(SD_task_t) * changed_task_capacity);
269 changed_tasks[changed_task_number] = NULL;
274 /* we must reset every task->state_changed */
276 while (changed_tasks[i] != NULL) {
277 changed_tasks[i]->state_changed = 0;
281 INFO0("Simulation finished");
282 DEBUG3("elapsed_time = %f, total_time = %f, watch_point_reached = %d", elapsed_time, total_time, sd_global->watch_point_reached);
283 DEBUG1("current time = %f", surf_get_clock());
285 return changed_tasks;
289 * \brief Returns the current clock
291 * \return the current clock, in second
293 double SD_get_clock(void) {
294 SD_CHECK_INIT_DONE();
296 return surf_get_clock();
300 * \brief Destroys all SD internal data
302 * This function should be called when the simulation is over. Don't forget also to destroy
305 * \see SD_init(), SD_task_destroy()
308 if (SD_INITIALISED()) {
309 DEBUG0("Destroying workstation and link dictionaries...");
310 xbt_dict_free(&sd_global->workstations);
311 xbt_dict_free(&sd_global->links);
313 DEBUG0("Destroying workstation and link arrays if necessary...");
314 if (sd_global->workstation_list != NULL)
315 xbt_free(sd_global->workstation_list);
317 if (sd_global->link_list != NULL)
318 xbt_free(sd_global->link_list);
320 if (sd_global->recyclable_route != NULL)
321 xbt_free(sd_global->recyclable_route);
323 DEBUG0("Destroying the swags...");
324 xbt_swag_free(sd_global->not_scheduled_task_set);
325 xbt_swag_free(sd_global->scheduled_task_set);
326 xbt_swag_free(sd_global->ready_task_set);
327 xbt_swag_free(sd_global->in_fifo_task_set);
328 xbt_swag_free(sd_global->running_task_set);
329 xbt_swag_free(sd_global->done_task_set);
330 xbt_swag_free(sd_global->failed_task_set);
335 DEBUG0("Exiting Surf...");
339 WARN0("SD_exit() called, but SimDag is not running");
340 /* we cannot use exceptions here because xbt is not running! */