Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add documentation for workstations and fix a few bugs
[simgrid.git] / include / simdag / simdag.h
index 90ed019..6efe56b 100644 (file)
@@ -1,5 +1,5 @@
-#ifndef SIMDAG_H
-#define SIMDAG_H
+#ifndef SIMDAG_SIMDAG_H
+#define SIMDAG_SIMDAG_H
 
 #include "simdag/datatypes.h"
 #include "xbt/misc.h"
@@ -8,61 +8,79 @@ SG_BEGIN_DECL()
 
 /************************** Link handling ***********************************/
 
-SG_link_t    SG_link_create(void *data, const char *name,/* double capacity,*/
-                           double bandwidth, double latency);
-void*        SG_link_get_data(SG_link_t link);
-void         SG_link_set_data(SG_link_t link, void *data);
-const char*  SG_link_get_name(SG_link_t link);
-double       SG_link_get_capacity(SG_link_t link);
-double       SG_link_get_current_bandwidth(SG_link_t link);
-double       SG_link_get_current_latency(SG_link_t link);
-void         SG_link_destroy(SG_link_t link);
+/* private (called by SD_environment_create)
+SD_link_t    SD_link_create(void *data, const char *name,
+double bandwidth, double latency);*/
+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 ****************************/
 
-SG_workstation_t   SG_workstation_create(void *data, const char *name, double power,
-                                        double available_power);
-SG_workstation_t   SG_workstation_get_by_name(const char *name);
-SG_workstation_t*  SG_workstation_get_list(void);
-int                SG_workstation_get_number(void);
-void               SG_workstation_set_data(SG_workstation_t workstation, void *data);
-void*              SG_workstation_get_data(SG_workstation_t workstation);
-const char*        SG_workstation_get_name(SG_workstation_t workstation);
-SG_link_t*         SG_workstation_route_get_list(SG_workstation_t src, SG_workstation_t dst);
-int                SG_workstation_route_get_size(SG_workstation_t src, SG_workstation_t dst);
-double             SG_workstation_get_power(SG_workstation_t workstation);
-double             SG_workstation_get_available_power(SG_workstation_t workstation);
-void               SG_workstation_destroy(SG_workstation_t workstation);
+/** @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 <em>physical
+ *  resource with computing capabilities</em> and has a <em>name</em>.
+ *
+ *  @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);
+void               SD_workstation_set_data(SD_workstation_t workstation, void *data);
+void*              SD_workstation_get_data(SD_workstation_t workstation);
+const char*        SD_workstation_get_name(SD_workstation_t workstation);
+SD_link_t*         SD_workstation_route_get_list(SD_workstation_t src, SD_workstation_t dst);
+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);
+
+/** @} */
 
 /************************** Task handling ************************************/
 
-SG_task_t         SG_task_create(const char *name, void *data, double amount);
-int               SG_task_schedule(SG_task_t task, int workstation_nb,
-                                  SG_workstation_t **workstation_list, double *computation_amount,
+SD_task_t         SD_task_create(const char *name, void *data, double amount);
+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_reset(SD_task_t task);
+void*             SD_task_get_data(SD_task_t task);
+void              SD_task_set_data(SD_task_t task, void *data);
+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);
+void*             SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
+e_SD_task_state_t SD_task_get_state(SD_task_t task);
+/* e_SD_task_state_t can be either SD_SCHEDULED, SD_RUNNING, SD_DONE, or SD_FAILED */
 
-void*             SG_task_get_data(SG_task_t task);
-void              SG_task_set_data(SG_task_t task, void *data);
-const char*       SG_task_get_name(SG_task_t task);
-double            SG_task_get_amount(SG_task_t task);
-double            SG_task_get_remaining_amount(SG_task_t task);
-void              SG_task_dependency_add(const char *name, void *data, SG_task_t src, SG_task_t dst);
-void              SG_task_dependency_remove(SG_task_t src, SG_task_t dst); 
-SG_task_state_t   SG_task_get_state(SG_task_t task);
-/* SG_task_state_t can be either SG_SCHEDULED, SG_RUNNING, SG_DONE, or SG_FAILED */
-
-void              SG_task_watch(SG_task_t task, SG_task_state_t state);
-/* SG_simulate will stop as soon as the state of this task is the one given in argument.
+void              SD_task_watch(SD_task_t task, e_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              SG_task_unwatch(SG_task_t task, SG_task_state_t state);
-void              SG_task_unschedule(SG_task_t task); /* change state and rerun */
-void              SG_task_destroy(SG_task_t task);
+void              SD_task_unwatch(SD_task_t task, e_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);
 
 /************************** Global *******************************************/
 
-void              SG_init(int *argc, char **argv);
-SG_task_t         *SG_simulate(double how_long); /* returns a NULL-terminated array of SG_task_t whose state has changed */
+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_exit(void); /* cleans everything */
 
 SG_END_DECL()