Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
further rework the config handling. Still much to do
[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 = NULL;
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 == NULL, "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_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
44   sd_global->executable_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
45   sd_global->completed_task_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
46   sd_global->return_set = xbt_dynar_new(sizeof(SD_task_t), NULL);
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:
68  * SD_config("host/model","default");
69  */
70 void SD_config(const char *key, const char *value){
71   xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
72   xbt_cfg_set_as_string(key, value);
73 }
74
75 /**
76  * \brief Creates the environment
77  *
78  * The environment (i.e. the \ref sg_host_management "hosts" and the \ref SD_link_management "links") is created with
79  * the data stored in the given XML platform file.
80  *
81  * \param platform_file name of an XML file describing the environment to create
82  * \see sg_host_management, SD_link_management
83  *
84  * The XML file follows this DTD:
85  *
86  *     \include simgrid.dtd
87  *
88  * Here is a small example of such a platform:
89  *
90  *     \include small_platform.xml
91  */
92 void SD_create_environment(const char *platform_file)
93 {
94   simgrid::s4u::Engine::instance()->loadPlatform(platform_file);
95
96   XBT_DEBUG("Workstation number: %zu, link number: %d", sg_host_count(), sg_link_count());
97 #if HAVE_JEDULE
98   jedule_setup_platform();
99 #endif
100   XBT_VERB("Starting simulation...");
101   surf_presolve();            /* Takes traces into account */
102 }
103
104 /**
105  * \brief Launches the simulation.
106  *
107  * The function will execute the \ref SD_RUNNABLE runnable tasks.
108  * If \a how_long is positive, then the simulation will be stopped either when time reaches \a how_long or when a watch
109  * point is reached.
110  * A non-positive value for \a how_long means no time limit, in which case the simulation will be stopped either when a
111  * watch point is reached or when no more task can be executed.
112  * Then you can call SD_simulate() again.
113  *
114  * \param how_long maximum duration of the simulation (a negative value means no time limit)
115  * \return a dynar of \ref SD_task_t whose state has changed.
116  * \see SD_task_schedule(), SD_task_watch()
117  */
118
119 xbt_dynar_t SD_simulate(double how_long) {
120   /* we stop the simulation when total_time >= how_long */
121   double total_time = 0.0;
122   SD_task_t task, dst;
123   SD_dependency_t dependency;
124   surf_action_t action;
125   unsigned int iter, depcnt;
126
127   XBT_VERB("Run simulation for %f seconds", how_long);
128   sd_global->watch_point_reached = 0;
129
130   xbt_dynar_reset(sd_global->return_set);
131
132   /* explore the runnable tasks */
133   xbt_dynar_foreach(sd_global->executable_task_set , iter, task) {
134     XBT_VERB("Executing task '%s'", SD_task_get_name(task));
135     SD_task_run(task);
136     xbt_dynar_push(sd_global->return_set, &task);
137     iter--;
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 = NULL;
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 = (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 = NULL;
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)) {
167           xbt_dynar_push(sd_global->return_set, &task);
168         }
169
170         /* remove the dependencies after this task */
171         xbt_dynar_foreach(task->tasks_after, depcnt, dependency) {
172           dst = dependency->dst;
173           dst->unsatisfied_dependencies--;
174           if (dst->is_not_ready > 0)
175             dst->is_not_ready--;
176
177           XBT_DEBUG("Released a dependency on %s: %d remain(s). Became schedulable if %d=0",
178              SD_task_get_name(dst), dst->unsatisfied_dependencies, dst->is_not_ready);
179
180           if (!(dst->unsatisfied_dependencies)) {
181             if (SD_task_get_state(dst) == SD_SCHEDULED)
182               SD_task_set_state(dst, SD_RUNNABLE);
183             else
184               SD_task_set_state(dst, SD_SCHEDULABLE);
185           }
186
187           if (SD_task_get_state(dst) == SD_NOT_SCHEDULED && !(dst->is_not_ready)) {
188             SD_task_set_state(dst, SD_SCHEDULABLE);
189           }
190
191           if (SD_task_get_kind(dst) == SD_TASK_COMM_E2E) {
192             SD_dependency_t comm_dep;
193             SD_task_t comm_dst;
194             xbt_dynar_get_cpy(dst->tasks_after, 0, &comm_dep);
195             comm_dst = comm_dep->dst;
196             if (SD_task_get_state(comm_dst) == SD_NOT_SCHEDULED && comm_dst->is_not_ready > 0) {
197               comm_dst->is_not_ready--;
198
199             XBT_DEBUG("%s is a transfer, %s may be ready now if %d=0",
200                SD_task_get_name(dst), SD_task_get_name(comm_dst), comm_dst->is_not_ready);
201
202               if (!(comm_dst->is_not_ready)) {
203                 SD_task_set_state(comm_dst, SD_SCHEDULABLE);
204               }
205             }
206           }
207
208           /* is dst runnable now? */
209           if (SD_task_get_state(dst) == SD_RUNNABLE && !sd_global->watch_point_reached) {
210             XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
211             SD_task_run(dst);
212             xbt_dynar_push(sd_global->return_set, &dst);
213           }
214         }
215       }
216
217       /* let's see which tasks have just failed */
218       while ((action = surf_model_extract_failed_action_set(model))) {
219         task = (SD_task_t) action->getData();
220         task->start_time = task->surf_action->getStartTime();
221         task->finish_time = surf_get_clock();
222         XBT_VERB("Task '%s' failed", SD_task_get_name(task));
223         SD_task_set_state(task, SD_FAILED);
224         action->unref();
225         task->surf_action = NULL;
226
227         xbt_dynar_push(sd_global->return_set, &task);
228       }
229     }
230   }
231
232   if (!sd_global->watch_point_reached && how_long<0){
233     if (!xbt_dynar_is_empty(sd_global->initial_task_set)) {
234         XBT_WARN("Simulation is finished but %lu tasks are still not done",
235             xbt_dynar_length(sd_global->initial_task_set));
236         static const char* state_names[] =
237           { "SD_NOT_SCHEDULED", "SD_SCHEDULABLE", "SD_SCHEDULED", "SD_RUNNABLE", "SD_RUNNING", "SD_DONE","SD_FAILED" };
238         xbt_dynar_foreach(sd_global->initial_task_set, iter, task){
239           XBT_WARN("%s is in %s state", SD_task_get_name(task), state_names[SD_task_get_state(task)]);
240         }
241     }
242   }
243
244   XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
245          elapsed_time, total_time, sd_global->watch_point_reached);
246   XBT_DEBUG("current time = %f", surf_get_clock());
247
248   return sd_global->return_set;
249 }
250
251 /** @brief Returns the current clock, in seconds */
252 double SD_get_clock(void) {
253   return surf_get_clock();
254 }
255
256 /**
257  * \brief Destroys all SD internal data
258  *
259  * This function should be called when the simulation is over. Don't forget to destroy too.
260  *
261  * \see SD_init(), SD_task_destroy()
262  */
263 void SD_exit(void)
264 {
265   TRACE_surf_resource_utilization_release();
266
267 #if HAVE_JEDULE
268   jedule_sd_cleanup();
269   jedule_sd_exit();
270 #endif
271
272   xbt_mallocator_free(sd_global->task_mallocator);
273   xbt_dynar_free_container(&(sd_global->initial_task_set));
274   xbt_dynar_free_container(&(sd_global->executable_task_set));
275   xbt_dynar_free_container(&(sd_global->completed_task_set));
276   xbt_dynar_free_container(&(sd_global->return_set));
277   xbt_free(sd_global);
278   sd_global = NULL;
279 }