Logo AND Algorithmique Numérique Distribuée

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