SD_global_t sd_global = NULL;
-/* Initialises SD internal data. This function should be called before any other SD function.
+/**
+ * \brief Initialises SD internal data
+ *
+ * This function must be called before any other SD function. Then you
+ * should call SD_create_environment().
+ *
+ * \param argc argument number
+ * \param argv argument list
+ * \see SD_create_environment(), SD_exit()
*/
void SD_init(int *argc, char **argv) {
xbt_assert0(sd_global == NULL, "SD_init already called");
s_SD_task_t task;
sd_global->not_scheduled_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
sd_global->scheduled_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
+ sd_global->ready_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
sd_global->running_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
sd_global->done_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
sd_global->failed_task_set = xbt_swag_new(xbt_swag_offset(task, state_hookup));
surf_init(argc, argv);
}
-/* Creates the environnement described in a xml file of a platform description.
+/**
+ * \brief Creates the environment
+ *
+ * The environment (i.e. the \ref SD_workstation_management "workstations" and the
+ * \ref SD_link_management "links") is created with the data stored in the given XML
+ * platform file.
+ *
+ * \param platform_file name of an XML file describing the environment to create
+ * \see SD_workstation_management, SD_link_management
+ *
+ * The XML file follows this DTD:
+ *
+ * \include surfxml.dtd
+ *
+ * Here is a small example of such a platform:
+ *
+ * \include small_platform.xml
*/
void SD_create_environment(const char *platform_file) {
xbt_dict_cursor_t cursor = NULL;
}
}
-/* Launches the simulation. Returns a NULL-terminated array of SD_task_t whose state has changed.
+/**
+ * \brief Launches the simulation.
+ *
+ * The function will execute the \ref SD_READY ready tasks.
+ * The simulation will be stopped when its time reaches \a how_long,
+ * when a watch point is reached, or when no more task can be executed.
+ * Then you can call SD_simulate() again.
+ *
+ * \param how_long maximum duration of the simulation
+ * \return a NULL-terminated array of \ref SD_task_t whose state has changed.
+ * \see SD_task_schedule(), SD_task_watch()
*/
SD_task_t* SD_simulate(double how_long)
{
- /* TODO */
-
double total_time = 0.0; /* we stop the simulation when total_time >= how_long */
double elapsed_time = 0.0;
SD_task_t task;
surf_action_t action;
SD_task_t *changed_tasks = NULL;
int changed_task_number = 0;
- int changed_task_capacity = 16;
+ int changed_task_capacity = 16; /* will be increased if necessary */
/* create the array that will be returned */
- changed_tasks = xbt_new0(SD_task_t, changed_task_capacity); /* changed_task_capacity will be increased if necessary */
+ changed_tasks = xbt_new0(SD_task_t, changed_task_capacity);
changed_tasks[0] = NULL;
surf_solve(); /* Takes traces into account. Returns 0.0 */
/* main loop */
while (elapsed_time >= 0.0 && total_time < how_long && !sd_global->watch_point_reached) {
- /* explore the scheduled tasks */
- xbt_swag_foreach(task, sd_global->scheduled_task_set) {
- INFO1("Examining task '%s'...", SD_task_get_name(task));
+ /* explore the ready tasks */
+ xbt_swag_foreach(task, sd_global->ready_task_set) {
+ INFO1("Executing task '%s'", SD_task_get_name(task));
task->state_changed = 0;
- if (xbt_dynar_length(task->tasks_before) == 0) {
- INFO1("The dependencies are satisfied. Executing task '%s'", SD_task_get_name(task));
- action = __SD_task_run(task);
- surf_workstation_resource->common_public->action_set_data(action, task);
- task->state_changed = 1;
-
- changed_tasks[changed_task_number++] = task; /* replace NULL by the task */
- if (changed_task_number == changed_task_capacity) {
- changed_task_capacity *= 2;
- changed_tasks = xbt_realloc(changed_tasks, sizeof(SD_task_t) * changed_task_capacity);
- }
- changed_tasks[changed_task_number] = NULL;
- }
- else {
- INFO1("Cannot execute task '%s' now because some depencies are not satisfied.", SD_task_get_name(task));
+ action = __SD_task_run(task);
+ surf_workstation_resource->common_public->action_set_data(action, task);
+ task->state_changed = 1;
+
+ changed_tasks[changed_task_number++] = task; /* replace NULL by the task */
+ if (changed_task_number == changed_task_capacity) {
+ changed_task_capacity *= 2;
+ changed_tasks = xbt_realloc(changed_tasks, sizeof(SD_task_t) * changed_task_capacity);
}
+ changed_tasks[changed_task_number] = NULL;
}
elapsed_time = surf_solve();
if (elapsed_time > 0.0)
total_time += elapsed_time;
- /* INFO1("Total time: %f", total_time);*/
+ /* let's see which tasks are done */
while ((action = xbt_swag_extract(surf_workstation_resource->common_public->states.done_action_set))) {
task = action->data;
INFO1("Task '%s' done", SD_task_get_name(task));
}
}
+ /* let's see which tasks have just failed */
while ((action = xbt_swag_extract(surf_workstation_resource->common_public->states.failed_action_set))) {
task = action->data;
INFO1("Task '%s' failed", SD_task_get_name(task));
}
INFO0("Simulation finished");
-
INFO1("Number of tasks whose state has changed: %d", changed_task_number);
+
return changed_tasks;
}
-/* Destroys all SD internal data. This function should be called when the simulation is over.
- * The tasks should have been destroyed first.
+/**
+ * \brief Destroys all SD internal data.
+ *
+ * This function should be called when the simulation is over. Don't forget also to destroy
+ * the tasks.
+ *
+ * \see SD_init(), SD_task_destroy()
*/
void SD_exit(void) {
if (sd_global != NULL) {
xbt_swag_free(sd_global->not_scheduled_task_set);
xbt_swag_free(sd_global->scheduled_task_set);
+ xbt_swag_free(sd_global->ready_task_set);
xbt_swag_free(sd_global->running_task_set);
xbt_swag_free(sd_global->done_task_set);
xbt_swag_free(sd_global->failed_task_set);
