1 /* Copyright (c) 2006-2016. The SimGrid Team.
2 * All rights reserved. */
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. */
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"
15 #include "simgrid/jedule/jedule_sd_binding.h"
18 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd, "Logging specific to SimDag (kernel)");
21 SD_global_t sd_global = nullptr;
24 * \brief Initializes SD internal data
26 * This function must be called before any other SD function. Then you should call SD_create_environment().
28 * \param argc argument number
29 * \param argv argument list
30 * \see SD_create_environment(), SD_exit()
32 void SD_init(int *argc, char **argv)
34 TRACE_global_init(argc, argv);
36 xbt_assert(sd_global == nullptr, "SD_init() already called");
38 sd_global = xbt_new(s_SD_global_t, 1);
39 sd_global->watch_point_reached = 0;
41 sd_global->task_mallocator=xbt_mallocator_new(65536, SD_task_new_f, SD_task_free_f, SD_task_recycle_f);
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);
48 surf_init(argc, argv);
50 xbt_cfg_setdefault_string("host/model", "ptask_L07");
56 if (_sg_cfg_exit_asap) {
62 /** \brief set a configuration variable
64 * Do --help on any simgrid binary to see the list of currently existing configuration variables, and
65 * see Section @ref options.
67 * Example: SD_config("host/model","default");
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);
75 * \brief Creates the environment
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.
80 * \param platform_file name of an XML file describing the environment to create
81 * \see SD_host_api, SD_link_api
83 * The XML file follows this DTD:
85 * \include simgrid.dtd
87 * Here is a small example of such a platform:
89 * \include small_platform.xml
91 void SD_create_environment(const char *platform_file)
93 simgrid::s4u::Engine::instance()->loadPlatform(platform_file);
95 XBT_DEBUG("Workstation number: %zu, link number: %d", sg_host_count(), sg_link_count());
97 jedule_setup_platform();
99 XBT_VERB("Starting simulation...");
100 surf_presolve(); /* Takes traces into account */
104 * \brief Launches the simulation.
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
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.
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()
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;
122 surf_action_t action;
125 XBT_VERB("Run simulation for %f seconds", how_long);
126 sd_global->watch_point_reached = 0;
128 xbt_dynar_reset(sd_global->return_set);
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()){
135 XBT_VERB("Executing task '%s'", SD_task_get_name(task));
137 xbt_dynar_push(sd_global->return_set, &task);
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;
146 XBT_DEBUG("Total time: %f", total_time);
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;
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();
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;
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);
170 /* remove the dependencies after this task */
171 for (std::set<SD_task_t>::iterator it=task->successors->begin(); it!=task->successors->end(); ++it){
173 dst->predecessors->erase(task);
174 dst->inputs->erase(task);
175 XBT_DEBUG("Released a dependency on %s: %zu remain(s). Became schedulable if %zu=0",
176 SD_task_get_name(dst), dst->predecessors->size()+dst->inputs->size(), dst->predecessors->size());
177 if (dst->predecessors->empty() && dst->inputs->empty()) {
178 if (SD_task_get_state(dst) == SD_SCHEDULED)
179 SD_task_set_state(dst, SD_RUNNABLE);
181 SD_task_set_state(dst, SD_SCHEDULABLE);
184 if (SD_task_get_state(dst) == SD_NOT_SCHEDULED && dst->predecessors->empty()){
185 SD_task_set_state(dst, SD_SCHEDULABLE);
187 if (SD_task_get_state(dst) == SD_RUNNABLE && !sd_global->watch_point_reached) {
188 XBT_VERB("Executing task '%s'", SD_task_get_name(dst));
190 xbt_dynar_push(sd_global->return_set, &dst);
193 task->successors->clear();
195 for (std::set<SD_task_t>::iterator it=task->outputs->begin(); it!=task->outputs->end(); ++it){
197 dst->start_time = task->finish_time;
198 dst->predecessors->erase(task);
199 if (SD_task_get_state(dst) == SD_SCHEDULED)
200 SD_task_set_state(dst, SD_RUNNABLE);
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->predecessors->empty()){
205 XBT_DEBUG("%s is a transfer, %s may be ready now if %zu=0",
206 SD_task_get_name(dst), SD_task_get_name(comm_dst), comm_dst->predecessors->size());
207 SD_task_set_state(comm_dst, SD_SCHEDULABLE);
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));
212 xbt_dynar_push(sd_global->return_set, &dst);
215 task->outputs->clear();
218 /* let's see which tasks have just failed */
219 while ((action = surf_model_extract_failed_action_set(model))) {
220 task = static_cast<SD_task_t>(action->getData());
221 task->start_time = task->surf_action->getStartTime();
222 task->finish_time = surf_get_clock();
223 XBT_VERB("Task '%s' failed", SD_task_get_name(task));
224 SD_task_set_state(task, SD_FAILED);
226 task->surf_action = nullptr;
228 xbt_dynar_push(sd_global->return_set, &task);
233 if (!sd_global->watch_point_reached && how_long<0 && !sd_global->initial_tasks->empty()) {
234 XBT_WARN("Simulation is finished but %zu tasks are still not done", sd_global->initial_tasks->size());
235 static const char* state_names[] =
236 { "SD_NOT_SCHEDULED", "SD_SCHEDULABLE", "SD_SCHEDULED", "SD_RUNNABLE", "SD_RUNNING", "SD_DONE","SD_FAILED" };
237 for (std::set<SD_task_t>::iterator it=sd_global->initial_tasks->begin();
238 it!=sd_global->initial_tasks->end(); ++it){
240 XBT_WARN("%s is in %s state", SD_task_get_name(task), state_names[SD_task_get_state(task)]);
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());
248 return sd_global->return_set;
251 /** @brief Returns the current clock, in seconds */
252 double SD_get_clock() {
253 return surf_get_clock();
257 * \brief Destroys all SD internal data
259 * This function should be called when the simulation is over. Don't forget to destroy too.
261 * \see SD_init(), SD_task_destroy()
265 TRACE_surf_resource_utilization_release();
272 xbt_mallocator_free(sd_global->task_mallocator);
273 delete sd_global->initial_tasks;
274 delete sd_global->executable_tasks;
275 delete sd_global->completed_tasks;
276 xbt_dynar_free_container(&(sd_global->return_set));