1 /* Copyright (c) 2006-2016. 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. */
7 #include "src/surf/surf_interface.hpp"
8 #include "src/simdag/simdag_private.h"
9 #include "instr/instr_interface.h"
10 #include "xbt/sysdep.h"
11 #include "xbt/dynar.h"
12 #include "surf/surf.h"
13 #include "simgrid/sg_config.h"
14 #include "simgrid/host.h"
18 #include "xbt/config.h"
19 #include "surf/surfxml_parse.h"
27 #include "simgrid/jedule/jedule_sd_binding.h"
30 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd,
32 "Logging specific to SimDag (kernel)");
34 SD_global_t sd_global = NULL;
37 * \brief Initializes SD internal data
39 * This function must be called before any other SD function. Then you
40 * should call SD_create_environment().
42 * \param argc argument number
43 * \param argv argument list
44 * \see SD_create_environment(), SD_exit()
46 void SD_init(int *argc, char **argv)
48 TRACE_global_init(argc, argv);
50 xbt_assert(sd_global == NULL, "SD_init() already called");
52 sd_global = xbt_new(s_SD_global_t, 1);
53 sd_global->watch_point_reached = 0;
55 sd_global->task_mallocator=xbt_mallocator_new(65536, SD_task_new_f,
59 sd_global->initial_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
60 sd_global->executable_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
61 sd_global->completed_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
62 sd_global->return_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
64 sd_global->task_number = 0;
66 surf_init(argc, argv);
68 xbt_cfg_setdefault_string(_sg_cfg_set, "host/model",
75 XBT_DEBUG("ADD SD LEVELS");
76 SD_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,__SD_storage_destroy);
78 if (_sg_cfg_exit_asap) {
84 /** \brief set a configuration variable
86 * Do --help on any simgrid binary to see the list of currently existing
87 * configuration variables, and see Section @ref options.
90 * SD_config("host/model","default");
92 void SD_config(const char *key, const char *value){
93 xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
94 xbt_cfg_set_as_string(_sg_cfg_set, key, value);
98 * \brief Reinits the application part of the simulation (experimental feature)
100 * This function allows you to run several simulations on the same platform
101 * by resetting the part describing the application.
103 * @warning: this function is still experimental and not perfect. For example,
104 * the simulation clock (and traces usage) is not reset. So, do not use it if
105 * you use traces in your simulation, and do not use absolute timing after
107 * That being said, this function is still precious if you want to compare a
108 * bunch of heuristics on the same platforms.
110 void SD_application_reinit(void)
115 // SD_task_t done_task, next_done_task;
116 xbt_die("This function is not working since the C++ links and others. Please report the problem if you really need that function.");
118 XBT_DEBUG("Recreating the swags...");
120 // xbt_swag_foreach_safe(done_task, next_done_task, sd_global->done_task_set){
121 // if (xbt_dynar_is_empty(done_task->tasks_before)){
122 // __SD_task_set_state(done_task, SD_SCHEDULABLE);
124 // __SD_task_set_state(done_task, SD_NOT_SCHEDULED);
125 // done_task->unsatisfied_dependencies =
126 // xbt_dynar_length(done_task->tasks_before);
127 // done_task->is_not_ready = done_task->unsatisfied_dependencies;
129 // free(done_task->workstation_list);
130 // done_task->workstation_list = NULL;
131 // done_task->workstation_nb = 0;
134 sd_global->task_number = 0;
145 * \brief Creates the environment
147 * The environment (i.e. the \ref sg_host_management "hosts"
148 * and the \ref SD_link_management "links") is created with the data stored
149 * in the given XML platform file.
151 * \param platform_file name of an XML file describing the environment to create
152 * \see sg_host_management, SD_link_management
154 * The XML file follows this DTD:
156 * \include simgrid.dtd
158 * Here is a small example of such a platform:
160 * \include small_platform.xml
162 void SD_create_environment(const char *platform_file)
164 xbt_lib_cursor_t cursor = NULL;
166 void **surf_storage = NULL;
168 parse_platform_file(platform_file);
170 /* now let's create the SD wrappers for storage elements */
171 xbt_lib_foreach(storage_lib, cursor, name, surf_storage) {
172 if(surf_storage[SURF_STORAGE_LEVEL])
173 __SD_storage_create(surf_storage[SURF_STORAGE_LEVEL], NULL);
176 XBT_DEBUG("Workstation number: %zu, link number: %d",
177 sg_host_count(), sg_link_count());
179 jedule_setup_platform();
184 * \brief Launches the simulation.
186 * The function will execute the \ref SD_RUNNABLE runnable tasks.
187 * If \a how_long is positive, then the simulation will be stopped either
188 * when time reaches \a how_long or when a watch point is reached.
189 * A non-positive value for \a how_long means no time limit, in which case
190 * the simulation will be stopped either when a watch point is reached or
191 * when no more task can be executed.
192 * Then you can call SD_simulate() again.
194 * \param how_long maximum duration of the simulation (a negative value means
196 * \return a dynar of \ref SD_task_t whose state has changed.
197 * \see SD_task_schedule(), SD_task_watch()
200 xbt_dynar_t SD_simulate(double how_long) {
201 /* we stop the simulation when total_time >= how_long */
202 double total_time = 0.0;
203 double elapsed_time = 0.0;
205 SD_dependency_t dependency;
206 surf_action_t action;
207 unsigned int iter, depcnt;
208 static int first_time = 1;
211 XBT_VERB("Starting simulation...");
213 surf_presolve(); /* Takes traces into account */
217 XBT_VERB("Run simulation for %f seconds", how_long);
218 sd_global->watch_point_reached = 0;
220 xbt_dynar_reset(sd_global->return_set);
222 /* explore the runnable tasks */
223 xbt_dynar_foreach(sd_global->executable_task_set , iter, task) {
224 XBT_VERB("Executing task '%s'", SD_task_get_name(task));
226 xbt_dynar_push(sd_global->return_set, &task);
232 while (elapsed_time >= 0.0 &&
233 (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
234 !sd_global->watch_point_reached) {
235 surf_model_t model = NULL;
239 XBT_DEBUG("Total time: %f", total_time);
241 elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
242 XBT_DEBUG("surf_solve() returns %f", elapsed_time);
243 if (elapsed_time > 0.0)
244 total_time += elapsed_time;
246 /* let's see which tasks are done */
247 xbt_dynar_foreach(all_existing_models, iter, model) {
248 while ((action = surf_model_extract_done_action_set(model))) {
249 task = (SD_task_t) action->getData();
250 task->start_time = task->surf_action->getStartTime();
252 task->finish_time = surf_get_clock();
253 XBT_VERB("Task '%s' done", SD_task_get_name(task));
254 SD_task_set_state(task, SD_DONE);
255 task->surf_action->unref();
256 task->surf_action = NULL;
258 /* the state has changed. Add it only if it's the first change */
259 if (xbt_dynar_search_or_negative(sd_global->return_set, &task) < 0) {
260 xbt_dynar_push(sd_global->return_set, &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 XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
272 SD_task_get_name(dst), dst->unsatisfied_dependencies,
275 if (!(dst->unsatisfied_dependencies)) {
276 if (SD_task_get_state(dst) == SD_SCHEDULED)
277 SD_task_set_state(dst, SD_RUNNABLE);
279 SD_task_set_state(dst, SD_SCHEDULABLE);
282 if (SD_task_get_state(dst) == SD_NOT_SCHEDULED &&
283 !(dst->is_not_ready)) {
284 SD_task_set_state(dst, SD_SCHEDULABLE);
287 if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
288 SD_dependency_t comm_dep;
290 xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
291 comm_dst = comm_dep->dst;
292 if (SD_task_get_state(comm_dst) == SD_NOT_SCHEDULED &&
293 comm_dst->is_not_ready > 0) {
294 comm_dst->is_not_ready--;
296 XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
297 SD_task_get_name(dst), SD_task_get_name(comm_dst),
298 comm_dst->is_not_ready);
300 if (!(comm_dst->is_not_ready)) {
301 SD_task_set_state(comm_dst, SD_SCHEDULABLE);
306 /* is dst runnable now? */
307 if (SD_task_get_state(dst) == SD_RUNNABLE
308 && !sd_global->watch_point_reached) {
309 XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
311 xbt_dynar_push(sd_global->return_set, &dst);
316 /* let's see which tasks have just failed */
317 while ((action = surf_model_extract_failed_action_set(model))) {
318 task = (SD_task_t) action->getData();
319 task->start_time = surf_action_get_start_time(task->surf_action);
320 task->finish_time = surf_get_clock();
321 XBT_VERB("Task '%s' failed", SD_task_get_name(task));
322 SD_task_set_state(task, SD_FAILED);
324 task->surf_action = NULL;
326 xbt_dynar_push(sd_global->return_set, &task);
331 if (!sd_global->watch_point_reached && how_long<0){
332 if ((int) xbt_dynar_length(sd_global->completed_task_set) <
333 sd_global->task_number){
334 XBT_WARN("Simulation is finished but %d tasks are still not done",
335 (sd_global->task_number -
336 (int) xbt_dynar_length(sd_global->completed_task_set)));
337 static const char* state_names[] =
338 { "SD_NOT_SCHEDULED", "SD_SCHEDULABLE", "SD_SCHEDULED",
339 "SD_RUNNABLE", "SD_RUNNING", "SD_DONE",
341 xbt_dynar_foreach(sd_global->initial_task_set, iter, task){
342 XBT_WARN("%s is in %s state", SD_task_get_name(task),
343 state_names[SD_task_get_state(task)]);
348 XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
349 elapsed_time, total_time, sd_global->watch_point_reached);
350 XBT_DEBUG("current time = %f", surf_get_clock());
352 return sd_global->return_set;
356 * \brief Returns the current clock
358 * \return the current clock, in second
360 double SD_get_clock(void) {
361 return surf_get_clock();
365 * \brief Destroys all SD internal data
367 * This function should be called when the simulation is over. Don't forget
370 * \see SD_init(), SD_task_destroy()
374 TRACE_surf_resource_utilization_release();
376 xbt_mallocator_free(sd_global->task_mallocator);
378 XBT_DEBUG("Destroying the dynars ...");
379 xbt_dynar_free_container(&(sd_global->initial_task_set));
380 xbt_dynar_free_container(&(sd_global->executable_task_set));
381 xbt_dynar_free_container(&(sd_global->completed_task_set));
382 xbt_dynar_free_container(&(sd_global->return_set));
395 XBT_DEBUG("Exiting Surf...");