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 "instr/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->workstation_list = NULL;
54 sd_global->link_list = NULL;
55 sd_global->recyclable_route = NULL;
56 sd_global->watch_point_reached = 0;
58 sd_global->task_mallocator=xbt_mallocator_new(65536, SD_task_new_f,
62 sd_global->initial_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
63 sd_global->executable_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
64 sd_global->completed_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
65 sd_global->return_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
67 sd_global->task_number = 0;
69 surf_init(argc, argv);
71 xbt_cfg_setdefault_string(_sg_cfg_set, "host/model",
78 XBT_DEBUG("ADD SD LEVELS");
79 SD_STORAGE_LEVEL = xbt_lib_add_level(storage_lib,__SD_storage_destroy);
81 if (_sg_cfg_exit_asap) {
87 /** \brief set a configuration variable
89 * Do --help on any simgrid binary to see the list of currently existing
90 * configuration variables, and see Section @ref options.
93 * SD_config("host/model","default");
95 void SD_config(const char *key, const char *value){
96 xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
97 xbt_cfg_set_as_string(_sg_cfg_set, key, value);
102 * \brief Reinits the application part of the simulation (experimental feature)
104 * This function allows you to run several simulations on the same platform
105 * by resetting the part describing the application.
107 * @warning: this function is still experimental and not perfect. For example,
108 * the simulation clock (and traces usage) is not reset. So, do not use it if
109 * you use traces in your simulation, and do not use absolute timing after
111 * That being said, this function is still precious if you want to compare a
112 * bunch of heuristics on the same platforms.
114 void SD_application_reinit(void)
119 // SD_task_t done_task, next_done_task;
120 xbt_die("This function is not working since the C++ links and others. Please report the problem if you really need that function.");
122 XBT_DEBUG("Recreating the swags...");
124 // xbt_swag_foreach_safe(done_task, next_done_task, sd_global->done_task_set){
125 // if (xbt_dynar_is_empty(done_task->tasks_before)){
126 // __SD_task_set_state(done_task, SD_SCHEDULABLE);
128 // __SD_task_set_state(done_task, SD_NOT_SCHEDULED);
129 // done_task->unsatisfied_dependencies =
130 // xbt_dynar_length(done_task->tasks_before);
131 // done_task->is_not_ready = done_task->unsatisfied_dependencies;
133 // free(done_task->workstation_list);
134 // done_task->workstation_list = NULL;
135 // done_task->workstation_nb = 0;
138 sd_global->task_number = 0;
149 * \brief Creates the environment
151 * The environment (i.e. the \ref SD_workstation_management "workstations"
152 * and the \ref SD_link_management "links") is created with the data stored
153 * in the given XML platform file.
155 * \param platform_file name of an XML file describing the environment to create
156 * \see SD_workstation_management, SD_link_management
158 * The XML file follows this DTD:
160 * \include simgrid.dtd
162 * Here is a small example of such a platform:
164 * \include small_platform.xml
166 void SD_create_environment(const char *platform_file)
168 xbt_lib_cursor_t cursor = NULL;
170 void **surf_storage = NULL;
172 parse_platform_file(platform_file);
174 /* now let's create the SD wrappers for storage elements */
175 xbt_lib_foreach(storage_lib, cursor, name, surf_storage) {
176 if(surf_storage[SURF_STORAGE_LEVEL])
177 __SD_storage_create(surf_storage[SURF_STORAGE_LEVEL], NULL);
180 XBT_DEBUG("Workstation number: %d, link number: %d",
181 SD_workstation_get_count(), sg_link_count());
183 jedule_setup_platform();
188 * \brief Launches the simulation.
190 * The function will execute the \ref SD_RUNNABLE runnable tasks.
191 * If \a how_long is positive, then the simulation will be stopped either
192 * when time reaches \a how_long or when a watch point is reached.
193 * A non-positive value for \a how_long means no time limit, in which case
194 * the simulation will be stopped either when a watch point is reached or
195 * when no more task can be executed.
196 * Then you can call SD_simulate() again.
198 * \param how_long maximum duration of the simulation (a negative value means
200 * \return a dynar of \ref SD_task_t whose state has changed.
201 * \see SD_task_schedule(), SD_task_watch()
204 xbt_dynar_t SD_simulate(double how_long) {
205 /* we stop the simulation when total_time >= how_long */
206 double total_time = 0.0;
207 double elapsed_time = 0.0;
209 SD_dependency_t dependency;
210 surf_action_t action;
211 unsigned int iter, depcnt;
212 static int first_time = 1;
215 XBT_VERB("Starting simulation...");
217 surf_presolve(); /* Takes traces into account */
221 XBT_VERB("Run simulation for %f seconds", how_long);
222 sd_global->watch_point_reached = 0;
224 xbt_dynar_reset(sd_global->return_set);
226 /* explore the runnable tasks */
227 xbt_dynar_foreach(sd_global->executable_task_set , iter, task) {
228 XBT_VERB("Executing task '%s'", SD_task_get_name(task));
230 xbt_dynar_push(sd_global->return_set, &task);
236 while (elapsed_time >= 0.0 &&
237 (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
238 !sd_global->watch_point_reached) {
239 surf_model_t model = NULL;
243 XBT_DEBUG("Total time: %f", total_time);
245 elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
246 XBT_DEBUG("surf_solve() returns %f", elapsed_time);
247 if (elapsed_time > 0.0)
248 total_time += elapsed_time;
250 /* let's see which tasks are done */
251 xbt_dynar_foreach(all_existing_models, iter, model) {
252 while ((action = surf_model_extract_done_action_set(model))) {
253 task = (SD_task_t) action->getData();
254 task->start_time = task->surf_action->getStartTime();
256 task->finish_time = surf_get_clock();
257 XBT_VERB("Task '%s' done", SD_task_get_name(task));
258 SD_task_set_state(task, SD_DONE);
259 task->surf_action->unref();
260 task->surf_action = NULL;
262 /* the state has changed. Add it only if it's the first change */
263 if (xbt_dynar_search_or_negative(sd_global->return_set, &task) < 0) {
264 xbt_dynar_push(sd_global->return_set, &task);
267 /* remove the dependencies after this task */
268 xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
269 dst = dependency->dst;
270 if (dst->unsatisfied_dependencies > 0)
271 dst->unsatisfied_dependencies--;
272 if (dst->is_not_ready > 0)
275 XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
276 SD_task_get_name(dst), dst->unsatisfied_dependencies,
279 if (!(dst->unsatisfied_dependencies)) {
280 if (SD_task_get_state(dst) == SD_SCHEDULED)
281 SD_task_set_state(dst, SD_RUNNABLE);
283 SD_task_set_state(dst, SD_SCHEDULABLE);
286 if (SD_task_get_state(dst) == SD_NOT_SCHEDULED &&
287 !(dst->is_not_ready)) {
288 SD_task_set_state(dst, SD_SCHEDULABLE);
291 if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
292 SD_dependency_t comm_dep;
294 xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
295 comm_dst = comm_dep->dst;
296 if (SD_task_get_state(comm_dst) == SD_NOT_SCHEDULED &&
297 comm_dst->is_not_ready > 0) {
298 comm_dst->is_not_ready--;
300 XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
301 SD_task_get_name(dst), SD_task_get_name(comm_dst),
302 comm_dst->is_not_ready);
304 if (!(comm_dst->is_not_ready)) {
305 SD_task_set_state(comm_dst, SD_SCHEDULABLE);
310 /* is dst runnable now? */
311 if (SD_task_get_state(dst) == SD_RUNNABLE
312 && !sd_global->watch_point_reached) {
313 XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
315 xbt_dynar_push(sd_global->return_set, &dst);
320 /* let's see which tasks have just failed */
321 while ((action = surf_model_extract_failed_action_set(model))) {
322 task = (SD_task_t) action->getData();
323 task->start_time = surf_action_get_start_time(task->surf_action);
324 task->finish_time = surf_get_clock();
325 XBT_VERB("Task '%s' failed", SD_task_get_name(task));
326 SD_task_set_state(task, SD_FAILED);
328 task->surf_action = NULL;
330 xbt_dynar_push(sd_global->return_set, &task);
335 if (!sd_global->watch_point_reached && how_long<0){
336 if ((int) xbt_dynar_length(sd_global->completed_task_set) <
337 sd_global->task_number){
338 XBT_WARN("Simulation is finished but %d tasks are still not done",
339 (sd_global->task_number -
340 (int) xbt_dynar_length(sd_global->completed_task_set)));
341 static const char* state_names[] =
342 { "SD_NOT_SCHEDULED", "SD_SCHEDULABLE", "SD_SCHEDULED",
343 "SD_RUNNABLE", "SD_RUNNING", "SD_DONE",
345 xbt_dynar_foreach(sd_global->initial_task_set, iter, task){
346 XBT_WARN("%s is in %s state", SD_task_get_name(task),
347 state_names[SD_task_get_state(task)]);
352 XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
353 elapsed_time, total_time, sd_global->watch_point_reached);
354 XBT_DEBUG("current time = %f", surf_get_clock());
356 return sd_global->return_set;
360 * \brief Returns the current clock
362 * \return the current clock, in second
364 double SD_get_clock(void) {
365 return surf_get_clock();
369 * \brief Destroys all SD internal data
371 * This function should be called when the simulation is over. Don't forget
374 * \see SD_init(), SD_task_destroy()
378 TRACE_surf_resource_utilization_release();
380 xbt_mallocator_free(sd_global->task_mallocator);
382 XBT_DEBUG("Destroying workstation and link arrays...");
383 xbt_free(sd_global->workstation_list);
384 xbt_free(sd_global->link_list);
385 xbt_free(sd_global->recyclable_route);
387 XBT_DEBUG("Destroying the dynars ...");
388 xbt_dynar_free_container(&(sd_global->initial_task_set));
389 xbt_dynar_free_container(&(sd_global->executable_task_set));
390 xbt_dynar_free_container(&(sd_global->completed_task_set));
391 xbt_dynar_free_container(&(sd_global->return_set));
404 XBT_DEBUG("Exiting Surf...");