Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
some small optimizations
[simgrid.git] / src / simdag / sd_global.cpp
1 /* Copyright (c) 2006-2016. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
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"
15 #include "xbt/ex.h"
16 #include "xbt/log.h"
17 #include "xbt/str.h"
18 #include "xbt/config.h"
19 #include "surf/surfxml_parse.h"
20
21 #ifdef HAVE_JEDULE
22 #include "simgrid/jedule/jedule_sd_binding.h"
23 #endif
24
25 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
26 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd, "Logging specific to SimDag (kernel)");
27
28 SD_global_t sd_global = NULL;
29
30 /**
31  * \brief Initializes SD internal data
32  *
33  * This function must be called before any other SD function. Then you should call SD_create_environment().
34  *
35  * \param argc argument number
36  * \param argv argument list
37  * \see SD_create_environment(), SD_exit()
38  */
39 void SD_init(int *argc, char **argv)
40 {
41   TRACE_global_init(argc, argv);
42
43   xbt_assert(sd_global == NULL, "SD_init() already called");
44
45   sd_global = xbt_new(s_SD_global_t, 1);
46   sd_global->watch_point_reached = 0;
47
48   sd_global->task_mallocator=xbt_mallocator_new(65536, SD_task_new_f, SD_task_free_f, SD_task_recycle_f);
49
50   sd_global->initial_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
51   sd_global->executable_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
52   sd_global->completed_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
53   sd_global->return_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
54
55   surf_init(argc, argv);
56
57   xbt_cfg_setdefault_string(_sg_cfg_set, "host/model",
58                             "ptask_L07");
59
60 #ifdef HAVE_JEDULE
61   jedule_sd_init();
62 #endif
63
64   if (_sg_cfg_exit_asap) {
65     SD_exit();
66     exit(0);
67   }
68 }
69
70 /** \brief set a configuration variable
71  *
72  * Do --help on any simgrid binary to see the list of currently existing
73  * configuration variables, and see Section @ref options.
74  *
75  * Example:
76  * SD_config("host/model","default");
77  */
78 void SD_config(const char *key, const char *value){
79   xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
80   xbt_cfg_set_as_string(_sg_cfg_set, key, value);
81 }
82
83 /**
84  * \brief Reinits the application part of the simulation (experimental feature)
85  *
86  * This function allows you to run several simulations on the same platform
87  * by resetting the part describing the application.
88  *
89  * @warning: this function is still experimental and not perfect. For example,
90  * the simulation clock (and traces usage) is not reset. So, do not use it if
91  * you use traces in your simulation, and do not use absolute timing after
92  * using it.
93  * That being said, this function is still precious if you want to compare a
94  * bunch of heuristics on the same platforms.
95  */
96 void SD_application_reinit(void)
97 {
98   xbt_die("This function is not working since the C++ links and others. Please report the problem if you really need that function.");
99
100 #ifdef HAVE_JEDULE
101   jedule_sd_cleanup();
102   jedule_sd_init();
103 #endif
104 }
105
106 /**
107  * \brief Creates the environment
108  *
109  * The environment (i.e. the \ref sg_host_management "hosts" and the \ref SD_link_management "links") is created with
110  * the data stored in the given XML platform file.
111  *
112  * \param platform_file name of an XML file describing the environment to create
113  * \see sg_host_management, SD_link_management
114  *
115  * The XML file follows this DTD:
116  *
117  *     \include simgrid.dtd
118  *
119  * Here is a small example of such a platform:
120  *
121  *     \include small_platform.xml
122  */
123 void SD_create_environment(const char *platform_file)
124 {
125   parse_platform_file(platform_file);
126
127   XBT_DEBUG("Workstation number: %zu, link number: %d", sg_host_count(), sg_link_count());
128 #ifdef HAVE_JEDULE
129   jedule_setup_platform();
130 #endif
131   XBT_VERB("Starting simulation...");
132   surf_presolve();            /* Takes traces into account */
133 }
134
135 /**
136  * \brief Launches the simulation.
137  *
138  * The function will execute the \ref SD_RUNNABLE runnable tasks.
139  * If \a how_long is positive, then the simulation will be stopped either when time reaches \a how_long or when a watch
140  * point is reached.
141  * A non-positive value for \a how_long means no time limit, in which case the simulation will be stopped either when a
142  * watch point is reached or when no more task can be executed.
143  * Then you can call SD_simulate() again.
144  *
145  * \param how_long maximum duration of the simulation (a negative value means no time limit)
146  * \return a dynar of \ref SD_task_t whose state has changed.
147  * \see SD_task_schedule(), SD_task_watch()
148  */
149
150 xbt_dynar_t SD_simulate(double how_long) {
151   /* we stop the simulation when total_time >= how_long */
152   double total_time = 0.0;
153   double elapsed_time = 0.0;
154   SD_task_t task, dst;
155   SD_dependency_t dependency;
156   surf_action_t action;
157   unsigned int iter, depcnt;
158
159   XBT_VERB("Run simulation for %f seconds", how_long);
160   sd_global->watch_point_reached = 0;
161
162   xbt_dynar_reset(sd_global->return_set);
163
164   /* explore the runnable tasks */
165   xbt_dynar_foreach(sd_global->executable_task_set , iter, task) {
166     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
167     SD_task_run(task);
168     xbt_dynar_push(sd_global->return_set, &task);
169     iter--;
170   }
171
172   /* main loop */
173   elapsed_time = 0.0;
174   while (elapsed_time >= 0.0 && (how_long < 0.0 || 0.00001 < (how_long -total_time)) &&
175          !sd_global->watch_point_reached) {
176     surf_model_t model = NULL;
177
178     XBT_DEBUG("Total time: %f", total_time);
179
180     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
181     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
182     if (elapsed_time > 0.0)
183       total_time += elapsed_time;
184
185     /* let's see which tasks are done */
186     xbt_dynar_foreach(all_existing_models, iter, model) {
187       while ((action = surf_model_extract_done_action_set(model))) {
188         task = (SD_task_t) action->getData();
189         task->start_time = task->surf_action->getStartTime();
190
191         task->finish_time = surf_get_clock();
192         XBT_VERB("Task '%s' done", SD_task_get_name(task));
193         SD_task_set_state(task, SD_DONE);
194         task->surf_action->unref();
195         task->surf_action = NULL;
196
197         /* the state has changed. Add it only if it's the first change */
198         if (!xbt_dynar_member(sd_global->return_set, &task)) {
199           xbt_dynar_push(sd_global->return_set, &task);
200         }
201
202         /* remove the dependencies after this task */
203         xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
204           dst = dependency->dst;
205           if (dst->unsatisfied_dependencies > 0)
206             dst->unsatisfied_dependencies--;
207           if (dst->is_not_ready > 0)
208             dst->is_not_ready--;
209
210           XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
211              SD_task_get_name(dst), dst->unsatisfied_dependencies, dst->is_not_ready);
212
213           if (!(dst->unsatisfied_dependencies)) {
214             if (SD_task_get_state(dst) == SD_SCHEDULED)
215               SD_task_set_state(dst, SD_RUNNABLE);
216             else
217               SD_task_set_state(dst, SD_SCHEDULABLE);
218           }
219
220           if (SD_task_get_state(dst) == SD_NOT_SCHEDULED && !(dst->is_not_ready)) {
221             SD_task_set_state(dst, SD_SCHEDULABLE);
222           }
223
224           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
225             SD_dependency_t comm_dep;
226             SD_task_t comm_dst;
227             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
228             comm_dst = comm_dep->dst;
229             if (SD_task_get_state(comm_dst) == SD_NOT_SCHEDULED && comm_dst->is_not_ready > 0) {
230               comm_dst->is_not_ready--;
231
232             XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
233                SD_task_get_name(dst), SD_task_get_name(comm_dst), comm_dst->is_not_ready);
234
235               if (!(comm_dst->is_not_ready)) {
236                 SD_task_set_state(comm_dst, SD_SCHEDULABLE);
237               }
238             }
239           }
240
241           /* is dst runnable now? */
242           if (SD_task_get_state(dst) == SD_RUNNABLE && !sd_global->watch_point_reached) {
243             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
244             SD_task_run(dst);
245             xbt_dynar_push(sd_global->return_set, &dst);
246           }
247         }
248       }
249
250       /* let's see which tasks have just failed */
251       while ((action = surf_model_extract_failed_action_set(model))) {
252         task = (SD_task_t) action->getData();
253         task->start_time = surf_action_get_start_time(task->surf_action);
254         task->finish_time = surf_get_clock();
255         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
256         SD_task_set_state(task, SD_FAILED);
257         action->unref();
258         task->surf_action = NULL;
259
260         xbt_dynar_push(sd_global->return_set, &task);
261       }
262     }
263   }
264
265   if (!sd_global->watch_point_reached && how_long<0){
266     if (!xbt_dynar_is_empty(sd_global->initial_task_set)) {
267         XBT_WARN("Simulation is finished but %lu tasks are still not done",
268             xbt_dynar_length(sd_global->initial_task_set));
269         static const char* state_names[] =
270           { "SD_NOT_SCHEDULED", "SD_SCHEDULABLE", "SD_SCHEDULED", "SD_RUNNABLE", "SD_RUNNING", "SD_DONE","SD_FAILED" };
271         xbt_dynar_foreach(sd_global->initial_task_set, iter, task){
272           XBT_WARN("%s is in %s state", SD_task_get_name(task), state_names[SD_task_get_state(task)]);
273         }
274     }
275   }
276
277   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
278          elapsed_time, total_time, sd_global->watch_point_reached);
279   XBT_DEBUG("current time = %f", surf_get_clock());
280
281   return sd_global->return_set;
282 }
283
284 /**
285  * \brief Returns the current clock
286  *
287  * \return the current clock, in second
288  */
289 double SD_get_clock(void) {
290   return surf_get_clock();
291 }
292
293 /**
294  * \brief Destroys all SD internal data
295  *
296  * This function should be called when the simulation is over. Don't forget
297  * to destroy too.
298  *
299  * \see SD_init(), SD_task_destroy()
300  */
301 void SD_exit(void)
302 {
303   TRACE_surf_resource_utilization_release();
304
305   xbt_mallocator_free(sd_global->task_mallocator);
306
307   XBT_DEBUG("Destroying the dynars ...");
308   xbt_dynar_free_container(&(sd_global->initial_task_set));
309   xbt_dynar_free_container(&(sd_global->executable_task_set));
310   xbt_dynar_free_container(&(sd_global->completed_task_set));
311   xbt_dynar_free_container(&(sd_global->return_set));
312
313   TRACE_end();
314
315   xbt_free(sd_global);
316   sd_global = NULL;
317
318 #ifdef HAVE_JEDULE
319   jedule_sd_cleanup();
320   jedule_sd_exit();
321 #endif
322
323   XBT_DEBUG("Exiting Surf...");
324   surf_exit();
325 }