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-2017. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include "simdag_private.hpp"
7 #include "simgrid/s4u/Engine.hpp"
8 #include "simgrid/sg_config.h"
9 #include "src/include/instr/instr_interface.h"
10 #include "src/surf/surf_interface.hpp"
11
12 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd, "Logging specific to SimDag (kernel)");
14
15 simgrid::sd::Global *sd_global = nullptr;
16
17 namespace simgrid{
18 namespace sd{
19 Global::Global(){
20   watch_point_reached = false;
21   initial_tasks = new std::set<SD_task_t>();
22   runnable_tasks = new std::set<SD_task_t>();
23   completed_tasks = new std::set<SD_task_t>();
24   return_set = new std::set<SD_task_t>();
25 }
26
27 Global::~Global(){
28   delete initial_tasks;
29   delete runnable_tasks;
30   delete completed_tasks;
31   delete return_set;
32 }
33
34 std::set<SD_task_t>* simulate(double how_long){
35   XBT_VERB("Run simulation for %f seconds", how_long);
36
37   sd_global->watch_point_reached = false;
38   sd_global->return_set->clear();
39
40   /* explore the runnable tasks */
41   while (not sd_global->runnable_tasks->empty())
42     SD_task_run(*(sd_global->runnable_tasks->begin()));
43
44   double elapsed_time = 0.0;
45   double total_time = 0.0;
46   /* main loop */
47   while (elapsed_time >= 0 && (how_long < 0 || 0.00001 < (how_long - total_time)) &&
48          not sd_global->watch_point_reached) {
49
50     XBT_DEBUG("Total time: %f", total_time);
51
52     elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
53     XBT_DEBUG("surf_solve() returns %f", elapsed_time);
54     if (elapsed_time > 0.0)
55       total_time += elapsed_time;
56
57     /* let's see which tasks are done */
58     for (auto const& model : *all_existing_models) {
59       surf_action_t action = surf_model_extract_done_action_set(model);
60       while (action != nullptr) {
61         SD_task_t task = static_cast<SD_task_t>(action->getData());
62         XBT_VERB("Task '%s' done", SD_task_get_name(task));
63         SD_task_set_state(task, SD_DONE);
64
65         /* the state has changed. Add it only if it's the first change */
66         if (sd_global->return_set->find(task) == sd_global->return_set->end())
67           sd_global->return_set->insert(task);
68
69         /* remove the dependencies after this task */
70         for (auto const& succ : *task->successors) {
71           succ->predecessors->erase(task);
72           succ->inputs->erase(task);
73           XBT_DEBUG("Release dependency on %s: %zu remain(s). Becomes schedulable if %zu=0", SD_task_get_name(succ),
74               succ->predecessors->size()+succ->inputs->size(), succ->predecessors->size());
75
76           if (SD_task_get_state(succ) == SD_NOT_SCHEDULED && succ->predecessors->empty())
77             SD_task_set_state(succ, SD_SCHEDULABLE);
78
79           if (SD_task_get_state(succ) == SD_SCHEDULED && succ->predecessors->empty() && succ->inputs->empty())
80             SD_task_set_state(succ, SD_RUNNABLE);
81
82           if (SD_task_get_state(succ) == SD_RUNNABLE && not sd_global->watch_point_reached)
83             SD_task_run(succ);
84         }
85         task->successors->clear();
86
87         for (auto const& output : *task->outputs) {
88           output->start_time = task->finish_time;
89           output->predecessors->erase(task);
90           if (SD_task_get_state(output) == SD_SCHEDULED)
91              SD_task_set_state(output, SD_RUNNABLE);
92           else
93              SD_task_set_state(output, SD_SCHEDULABLE);
94
95           SD_task_t comm_dst = *(output->successors->begin());
96           if (SD_task_get_state(comm_dst) == SD_NOT_SCHEDULED && comm_dst->predecessors->empty()){
97             XBT_DEBUG("%s is a transfer, %s may be ready now if %zu=0",
98                 SD_task_get_name(output), SD_task_get_name(comm_dst), comm_dst->predecessors->size());
99             SD_task_set_state(comm_dst, SD_SCHEDULABLE);
100           }
101           if (SD_task_get_state(output) == SD_RUNNABLE && not sd_global->watch_point_reached)
102             SD_task_run(output);
103         }
104         task->outputs->clear();
105         action = surf_model_extract_done_action_set(model);
106       }
107
108       /* let's see which tasks have just failed */
109       action = surf_model_extract_failed_action_set(model);
110       while (action != nullptr) {
111         SD_task_t task = static_cast<SD_task_t>(action->getData());
112         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
113         SD_task_set_state(task, SD_FAILED);
114         sd_global->return_set->insert(task);
115         action = surf_model_extract_failed_action_set(model);
116       }
117     }
118   }
119
120   if (not sd_global->watch_point_reached && how_long < 0 && not sd_global->initial_tasks->empty()) {
121     XBT_WARN("Simulation is finished but %zu tasks are still not done", sd_global->initial_tasks->size());
122     for (auto const& t : *sd_global->initial_tasks)
123       XBT_WARN("%s is in %s state", SD_task_get_name(t), __get_state_name(SD_task_get_state(t)));
124   }
125
126   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
127              elapsed_time, total_time, sd_global->watch_point_reached);
128   XBT_DEBUG("current time = %f", surf_get_clock());
129
130   return sd_global->return_set;
131 }
132 }
133 }
134
135 /**
136  * \brief helper for pretty printing of task state
137  * \param state the state of a task
138  * \return the equivalent as a readable string
139  */
140 const char *__get_state_name(e_SD_task_state_t state){
141   static std::string state_names[7] =
142     { "not scheduled", "schedulable", "scheduled", "runnable","running", "done", "failed" };
143   return state_names[static_cast<int>(log2(static_cast<double>(state)))].data();
144 }
145
146 /**
147  * \brief Initializes SD internal data
148  *
149  * This function must be called before any other SD function. Then you should call SD_create_environment().
150  *
151  * \param argc argument number
152  * \param argv argument list
153  * \see SD_create_environment(), SD_exit()
154  */
155 void SD_init_nocheck(int *argc, char **argv)
156 {
157   xbt_assert(sd_global == nullptr, "SD_init() already called");
158
159   sd_global = new simgrid::sd::Global();
160
161   surf_init(argc, argv);
162
163   xbt_cfg_setdefault_string("host/model", "ptask_L07");
164   if(xbt_cfg_get_boolean("clean-atexit"))
165     atexit(SD_exit);
166   if (_sg_cfg_exit_asap) {
167     exit(0);
168   }
169 }
170
171 /** \brief set a configuration variable
172  *
173  * Do --help on any simgrid binary to see the list of currently existing configuration variables, and
174  * see Section @ref options.
175  *
176  * Example: SD_config("host/model","default")
177  */
178 void SD_config(const char *key, const char *value){
179   xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
180   xbt_cfg_set_as_string(key, value);
181 }
182
183 /**
184  * \brief Creates the environment
185  *
186  * The environment (i.e. the \ref SD_host_api "hosts" and the \ref SD_link_api "links") is created with
187  * the data stored in the given XML platform file.
188  *
189  * \param platform_file name of an XML file describing the environment to create
190  * \see SD_host_api, SD_link_api
191  *
192  * The XML file follows this DTD:
193  *
194  *     \include simgrid.dtd
195  *
196  * Here is a small example of such a platform:
197  *
198  *     \include small_platform.xml
199  */
200 void SD_create_environment(const char *platform_file)
201 {
202   simgrid::s4u::Engine::getInstance()->loadPlatform(platform_file);
203
204   XBT_DEBUG("Host number: %zu, link number: %d", sg_host_count(), sg_link_count());
205 #if SIMGRID_HAVE_JEDULE
206   jedule_sd_init();
207 #endif
208   XBT_VERB("Starting simulation...");
209   surf_presolve();            /* Takes traces into account */
210 }
211
212 /**
213  * \brief Launches the simulation.
214  *
215  * The function will execute the \ref SD_RUNNABLE runnable tasks.
216  * If \a how_long is positive, then the simulation will be stopped either when time reaches \a how_long or when a watch
217  * point is reached.
218  * A non-positive value for \a how_long means no time limit, in which case the simulation will be stopped either when a
219  * watch point is reached or when no more task can be executed.
220  * Then you can call SD_simulate() again.
221  *
222  * \param how_long maximum duration of the simulation (a negative value means no time limit)
223  * \return a dynar of \ref SD_task_t whose state has changed.
224  * \see SD_task_schedule(), SD_task_watch()
225  */
226 void SD_simulate(double how_long)
227 {
228   simgrid::sd::simulate(how_long);
229 }
230
231 void SD_simulate_with_update(double how_long, xbt_dynar_t changed_tasks_dynar)
232 {
233   std::set<SD_task_t> *changed_tasks = simgrid::sd::simulate(how_long);
234   for (auto const& task : *changed_tasks)
235     xbt_dynar_push(changed_tasks_dynar, &task);
236 }
237
238 /** @brief Returns the current clock, in seconds */
239 double SD_get_clock() {
240   return surf_get_clock();
241 }
242
243 /**
244  * \brief Destroys all SD internal data
245  * This function should be called when the simulation is over. Don't forget to destroy too.
246  * \see SD_init(), SD_task_destroy()
247  */
248 void SD_exit()
249 {
250   TRACE_end();
251 #if SIMGRID_HAVE_JEDULE
252   jedule_sd_exit();
253 #endif
254   delete sd_global;
255 }