X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6604439f3437486f84c0e239f28b162662631127..3f17e7a2d9e727cf8ba2da354280f3afd329c8a6:/include/simdag/simdag.h
diff --git a/include/simdag/simdag.h b/include/simdag/simdag.h
index f32f330285..9690a03be4 100644
--- a/include/simdag/simdag.h
+++ b/include/simdag/simdag.h
@@ -8,24 +8,41 @@ SG_BEGIN_DECL()
/************************** Link handling ***********************************/
-/* private (called by SD_environment_create)
-SD_link_t SD_link_create(void *data, const char *name,
-double bandwidth, double latency);*/
+/** @defgroup SD_link_management Links
+ * @brief Functions for managing the network links
+ *
+ * This section describes the functions for managing the network links.
+ *
+ * A link is a network node represented as a name, a current
+ * bandwidth and a current latency. The links are created
+ * when you call the function SD_create_environment.
+ *
+ * @see SD_link_t
+ * @{
+ */
void* SD_link_get_data(SD_link_t link);
void SD_link_set_data(SD_link_t link, void *data);
const char* SD_link_get_name(SD_link_t link);
-double SD_link_get_capacity(SD_link_t link);
double SD_link_get_current_bandwidth(SD_link_t link);
double SD_link_get_current_latency(SD_link_t link);
-/* private (called by SD_clean)
-void SD_link_destroy(SD_link_t link);
-*/
+/** @} */
/************************** Workstation handling ****************************/
-/* private (called by SD_environment_create)
-SD_workstation_t SD_workstation_create(void *data, const char *name, double power,
- double available_power);*/
+/** @defgroup SD_workstation_management Workstations
+ * @brief Functions for managing the workstations
+ *
+ * This section describes the functions for managing the workstations.
+ *
+ * A workstation is a place where a task can be executed.
+ * A workstation is represented as a physical
+ * resource with computing capabilities and has a name.
+ *
+ * The workstations are created when you call the function SD_create_environment.
+ *
+ * @see SD_workstation_t
+ * @{
+ */
SD_workstation_t SD_workstation_get_by_name(const char *name);
SD_workstation_t* SD_workstation_get_list(void);
int SD_workstation_get_number(void);
@@ -36,41 +53,69 @@ SD_link_t* SD_workstation_route_get_list(SD_workstation_t src, SD_workst
int SD_workstation_route_get_size(SD_workstation_t src, SD_workstation_t dst);
double SD_workstation_get_power(SD_workstation_t workstation);
double SD_workstation_get_available_power(SD_workstation_t workstation);
-/* private (called by SD_clean)
-void SD_workstation_destroy(SD_workstation_t workstation);
-*/
+/** @} */
/************************** Task handling ************************************/
+/** @defgroup SD_task_management Tasks
+ * @brief Functions for managing the tasks
+ *
+ * This section describes the functions for managing the tasks.
+ *
+ * A task is some computing amount that can be executed
+ * in parallel on several workstations. A task may depend on other
+ * tasks, this means that the task cannot start until the other tasks are done.
+ * Each task has a \ref e_SD_task_state_t "state" indicating whether
+ * the task is scheduled, running, done, etc.
+ *
+ * @see SD_task_t, SD_task_dependency_management
+ * @{
+ */
SD_task_t SD_task_create(const char *name, void *data, double amount);
-int SD_task_schedule(SD_task_t task, int workstation_nb,
- SD_workstation_t **workstation_list, double *computation_amount,
- double *communication_amount, double rate);
-
void* SD_task_get_data(SD_task_t task);
void SD_task_set_data(SD_task_t task, void *data);
+e_SD_task_state_t SD_task_get_state(SD_task_t task);
const char* SD_task_get_name(SD_task_t task);
double SD_task_get_amount(SD_task_t task);
double SD_task_get_remaining_amount(SD_task_t task);
-void SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst);
-void SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
-SD_task_state_t SD_task_get_state(SD_task_t task);
-/* SD_task_state_t can be either SD_SCHEDULED, SD_RUNNING, SD_DONE, or SD_FAILED */
+void SD_task_watch(SD_task_t task, e_SD_task_state_t state);
+void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state);
+void SD_task_schedule(SD_task_t task, int workstation_nb,
+ const SD_workstation_t *workstation_list, double *computation_amount,
+ double *communication_amount, double rate);
+void SD_task_unschedule(SD_task_t task);
+void SD_task_destroy(SD_task_t task);
+/** @} */
-void SD_task_watch(SD_task_t task, SD_task_state_t state);
-/* SD_simulate will stop as soon as the state of this task is the one given in argument.
- Watch-point is then automatically removed */
-void SD_task_unwatch(SD_task_t task, SD_task_state_t state);
-void SD_task_unschedule(SD_task_t task); /* change state and rerun */
-void SD_task_destroy(SD_task_t task);
+/** @defgroup SD_task_dependency_management Tasks dependencies
+ * @brief Functions for managing the task dependencies
+ *
+ * This section describes the functions for managing the dependencies between the tasks.
+ *
+ * @see SD_task_management
+ * @{
+ */
+void SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst);
+void SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
+void* SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
+/** @} */
/************************** Global *******************************************/
+/** @defgroup SD_simulation Simulation
+ * @brief Functions for creating the environment and launching the simulation
+ *
+ * This section describes the functions for initialising SimDag, launching
+ * the simulation and exiting SimDag.
+ *
+ * @{
+ */
void SD_init(int *argc, char **argv);
void SD_create_environment(const char *platform_file);
-SD_task_t *SD_simulate(double how_long); /* returns a NULL-terminated array of SD_task_t whose state has changed */
-void SD_clean(); /* cleans everything */
+SD_task_t* SD_simulate(double how_long);
+void SD_exit(void);
+/** @} */
SG_END_DECL()