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 "simgrid/sg_config.h"
8 #include "simgrid/host.h"
9 #include "src/simdag/simdag_private.h"
10 #include "src/surf/surf_interface.hpp"
11 #include "simgrid/s4u/engine.hpp"
13 XBT_LOG_NEW_CATEGORY(sd, "Logging specific to SimDag");
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sd_kernel, sd, "Logging specific to SimDag (kernel)");
16 SD_global_t sd_global = nullptr;
19 * \brief Initializes SD internal data
21 * This function must be called before any other SD function. Then you should call SD_create_environment().
23 * \param argc argument number
24 * \param argv argument list
25 * \see SD_create_environment(), SD_exit()
27 void SD_init(int *argc, char **argv)
29 xbt_assert(sd_global == nullptr, "SD_init() already called");
31 sd_global = xbt_new(s_SD_global_t, 1);
32 sd_global->watch_point_reached = false;
34 sd_global->task_mallocator=xbt_mallocator_new(65536, SD_task_new_f, SD_task_free_f, SD_task_recycle_f);
36 sd_global->initial_tasks = new std::set<SD_task_t>();
37 sd_global->runnable_tasks = new std::set<SD_task_t>();
38 sd_global->completed_tasks = new std::set<SD_task_t>();
39 sd_global->return_set = xbt_dynar_new(sizeof(SD_task_t), nullptr);
41 surf_init(argc, argv);
43 xbt_cfg_setdefault_string("host/model", "ptask_L07");
49 if (_sg_cfg_exit_asap) {
55 /** \brief set a configuration variable
57 * Do --help on any simgrid binary to see the list of currently existing configuration variables, and
58 * see Section @ref options.
60 * Example: SD_config("host/model","default");
62 void SD_config(const char *key, const char *value){
63 xbt_assert(sd_global,"ERROR: Please call SD_init() before using SD_config()");
64 xbt_cfg_set_as_string(key, value);
68 * \brief Creates the environment
70 * The environment (i.e. the \ref SD_host_api "hosts" and the \ref SD_link_api "links") is created with
71 * the data stored in the given XML platform file.
73 * \param platform_file name of an XML file describing the environment to create
74 * \see SD_host_api, SD_link_api
76 * The XML file follows this DTD:
78 * \include simgrid.dtd
80 * Here is a small example of such a platform:
82 * \include small_platform.xml
84 void SD_create_environment(const char *platform_file)
86 simgrid::s4u::Engine::instance()->loadPlatform(platform_file);
88 XBT_DEBUG("Workstation number: %zu, link number: %d", sg_host_count(), sg_link_count());
90 jedule_setup_platform();
92 XBT_VERB("Starting simulation...");
93 surf_presolve(); /* Takes traces into account */
97 * \brief Launches the simulation.
99 * The function will execute the \ref SD_RUNNABLE runnable tasks.
100 * If \a how_long is positive, then the simulation will be stopped either when time reaches \a how_long or when a watch
102 * A non-positive value for \a how_long means no time limit, in which case the simulation will be stopped either when a
103 * watch point is reached or when no more task can be executed.
104 * Then you can call SD_simulate() again.
106 * \param how_long maximum duration of the simulation (a negative value means no time limit)
107 * \return a dynar of \ref SD_task_t whose state has changed.
108 * \see SD_task_schedule(), SD_task_watch()
111 xbt_dynar_t SD_simulate(double how_long) {
112 XBT_VERB("Run simulation for %f seconds", how_long);
114 sd_global->watch_point_reached = false;
115 xbt_dynar_reset(sd_global->return_set);
117 /* explore the runnable tasks */
118 while(!sd_global->runnable_tasks->empty())
119 SD_task_run(*(sd_global->runnable_tasks->begin()));
121 double elapsed_time = 0.0;
122 double total_time = 0.0;
124 while (elapsed_time >= 0 && (how_long < 0 || 0.00001 < (how_long -total_time)) && !sd_global->watch_point_reached) {
125 surf_model_t model = nullptr;
127 XBT_DEBUG("Total time: %f", total_time);
129 elapsed_time = surf_solve(how_long > 0 ? surf_get_clock() + how_long - total_time: -1.0);
130 XBT_DEBUG("surf_solve() returns %f", elapsed_time);
131 if (elapsed_time > 0.0)
132 total_time += elapsed_time;
134 /* let's see which tasks are done */
136 xbt_dynar_foreach(all_existing_models, iter, model) {
137 surf_action_t action = surf_model_extract_done_action_set(model);
138 while (action != nullptr) {
139 SD_task_t task = static_cast<SD_task_t>(action->getData());
140 XBT_VERB("Task '%s' done", SD_task_get_name(task));
141 SD_task_set_state(task, SD_DONE);
143 /* the state has changed. Add it only if it's the first change */
144 if (xbt_dynar_member(sd_global->return_set, &task) == 0)
145 xbt_dynar_push(sd_global->return_set, &task);
147 /* remove the dependencies after this task */
148 for (auto succ : *task->successors) {
149 succ->predecessors->erase(task);
150 succ->inputs->erase(task);
151 XBT_DEBUG("Release dependency on %s: %zu remain(s). Becomes schedulable if %zu=0", SD_task_get_name(succ),
152 succ->predecessors->size()+succ->inputs->size(), succ->predecessors->size());
154 if (SD_task_get_state(succ) == SD_NOT_SCHEDULED && succ->predecessors->empty())
155 SD_task_set_state(succ, SD_SCHEDULABLE);
157 if (SD_task_get_state(succ) == SD_SCHEDULED && succ->predecessors->empty() && succ->inputs->empty())
158 SD_task_set_state(succ, SD_RUNNABLE);
160 if (SD_task_get_state(succ) == SD_RUNNABLE && !sd_global->watch_point_reached)
163 task->successors->clear();
165 for (auto output : *task->outputs) {
166 output->start_time = task->finish_time;
167 output->predecessors->erase(task);
168 if (SD_task_get_state(output) == SD_SCHEDULED)
169 SD_task_set_state(output, SD_RUNNABLE);
171 SD_task_set_state(output, SD_SCHEDULABLE);
173 SD_task_t comm_dst = *(output->successors->begin());
174 if (SD_task_get_state(comm_dst) == SD_NOT_SCHEDULED && comm_dst->predecessors->empty()){
175 XBT_DEBUG("%s is a transfer, %s may be ready now if %zu=0",
176 SD_task_get_name(output), SD_task_get_name(comm_dst), comm_dst->predecessors->size());
177 SD_task_set_state(comm_dst, SD_SCHEDULABLE);
179 if (SD_task_get_state(output) == SD_RUNNABLE && !sd_global->watch_point_reached)
182 task->outputs->clear();
183 action = surf_model_extract_done_action_set(model);
186 /* let's see which tasks have just failed */
187 action = surf_model_extract_failed_action_set(model);
188 while (action != nullptr) {
189 SD_task_t task = static_cast<SD_task_t>(action->getData());
190 XBT_VERB("Task '%s' failed", SD_task_get_name(task));
191 SD_task_set_state(task, SD_FAILED);
192 xbt_dynar_push(sd_global->return_set, &task);
193 action = surf_model_extract_failed_action_set(model);
198 if (!sd_global->watch_point_reached && how_long < 0 && !sd_global->initial_tasks->empty()) {
199 XBT_WARN("Simulation is finished but %zu tasks are still not done", sd_global->initial_tasks->size());
200 static const char* state_names[] =
201 { "SD_NOT_SCHEDULED", "SD_SCHEDULABLE", "SD_SCHEDULED", "SD_RUNNABLE", "SD_RUNNING", "SD_DONE","SD_FAILED" };
202 for (auto t : *sd_global->initial_tasks)
203 XBT_WARN("%s is in %s state", SD_task_get_name(t), state_names[SD_task_get_state(t)]);
206 XBT_DEBUG("elapsed_time = %f, total_time = %f, watch_point_reached = %d",
207 elapsed_time, total_time, sd_global->watch_point_reached);
208 XBT_DEBUG("current time = %f", surf_get_clock());
210 return sd_global->return_set;
213 /** @brief Returns the current clock, in seconds */
214 double SD_get_clock() {
215 return surf_get_clock();
219 * \brief Destroys all SD internal data
220 * This function should be called when the simulation is over. Don't forget to destroy too.
221 * \see SD_init(), SD_task_destroy()
230 xbt_mallocator_free(sd_global->task_mallocator);
231 delete sd_global->initial_tasks;
232 delete sd_global->runnable_tasks;
233 delete sd_global->completed_tasks;
234 xbt_dynar_free_container(&(sd_global->return_set));