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