Logo AND Algorithmique Numérique Distribuée

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