X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f3af8b430269d158689ad7cdef5b5e54df8360a1..b4036710f1d7f435ac50328d290cb95b108d505e:/include/simdag/datatypes.h

diff --git a/include/simdag/datatypes.h b/include/simdag/datatypes.h
index f21af30453..6613f54b37 100644
--- a/include/simdag/datatypes.h
+++ b/include/simdag/datatypes.h
@@ -1,40 +1,66 @@
 #ifndef SIMDAG_DATATYPES_H
 #define SIMDAG_DATATYPES_H
 
-/* Link */
-typedef struct SG_link {
-  void *data;
-  char *name;
-  /*double capacity;*/
-  /*double current_bandwidth;
-    double current_latency;*/
-} s_SG_link_t, *SG_link_t;
-
-/* Workstation */
-typedef struct SG_workstation {
-  void *data;
-  char *name;
-  /*double power;
-    double available_power;*/
-  /* TODO: route */
-} s_SG_workstation_t, *SG_workstation_t;
-
-/* Task state */
+/** @brief Workstation datatype
+    @ingroup SD_datatypes_management
+    
+    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_management */
+typedef struct SD_workstation *SD_workstation_t;
+
+/** @brief Workstation access mode
+    @ingroup SD_datatypes_management
+
+    By default, a workstation resource is shared, i.e. several tasks
+    can be executed at the same time on a workstation. The CPU power of
+    the workstation is shared between the running tasks on the workstation.
+    In sequential mode, only one task can use the workstation, and the other
+    tasks wait in a FIFO.
+
+    @see SD_workstation_get_access_mode(), SD_workstation_set_access_mode() */
+typedef enum {
+  SD_WORKSTATION_SHARED_ACCESS,     /**< @brief Several tasks can be executed at the same time */
+  SD_WORKSTATION_SEQUENTIAL_ACCESS  /**< @brief Only one task can be executed, the others wait in a FIFO. */
+} e_SD_workstation_access_mode_t;
+
+/** @brief Link datatype
+    @ingroup SD_datatypes_management
+
+    A link is a network node represented as a <em>name</em>, a <em>current
+    bandwidth</em> and a <em>current latency</em>. A route is a list of
+    links between two workstations.
+
+    @see SD_link_management */
+typedef struct SD_link *SD_link_t;
+
+/** @brief Task datatype
+    @ingroup SD_datatypes_management
+
+    A task is some <em>computing amount</em> 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 <em>\ref e_SD_task_state_t "state"</em> indicating whether 
+    the task is scheduled, running, done, etc.
+
+    @see SD_task_management */
+typedef struct SD_task *SD_task_t;
+
+/** @brief Task states
+    @ingroup SD_datatypes_management
+
+    @see SD_task_management */
 typedef enum {
-  SG_SCHEDULED,
-  SG_RUNNING,
-  SG_DONE,
-  SG_FAILED
-} SG_task_state_t;
-
-/* Task */
-typedef struct SG_task {
-  void *data;
-  char *name;
-  /*double amount;
-    double remaining_amount;*/
-  SG_task_state_t state;
-  /* TODO: dependencies + watch */
-} s_SG_task_t, *SG_task_t;
+  SD_NOT_SCHEDULED = 0,      /**< @brief Initial state (not valid for SD_watch and SD_unwatch). */
+  SD_SCHEDULED =     0x0001, /**< @brief A task becomes SD_SCHEDULED when you call function
+				SD_task_schedule. SD_simulate will execute it when it becomes SD_READY. */
+  SD_READY =         0x0002, /**< @brief A scheduled task becomes ready is SD_simulate as soon as its dependencies are satisfied. */
+  SD_IN_FIFO =       0x0004, /**< @brief A ready task can have to wait in a workstation fifo if the workstation is sequential */
+  SD_RUNNING =       0x0008, /**< @brief An SD_READY or SD_IN_FIFO becomes SD_RUNNING when it is launched. */
+  SD_DONE =          0x0010, /**< @brief The task is successfuly finished. */
+  SD_FAILED =        0x0020  /**< @brief A problem occured during the execution of the task. */
+} e_SD_task_state_t;
 
 #endif