Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Finish SimDag documentation
[simgrid.git] / include / simdag / datatypes.h
1 #ifndef SIMDAG_DATATYPES_H
2 #define SIMDAG_DATATYPES_H
3
4 /** @brief Workstation datatype
5     @ingroup SD_datatypes_management
6     
7     A workstation is a place where a task can be executed.
8     A workstation is represented as a <em>physical
9     resource with computing capabilities</em> and has a <em>name</em>.
10
11     @see SD_workstation_management */
12 typedef struct SD_workstation *SD_workstation_t;
13
14 /** @brief Link datatype
15     @ingroup SD_datatypes_management
16
17     A link is a network node represented as a <em>name</em>, a <em>current
18     bandwidth</em> and a <em>current latency</em>. A route is a list of
19     links between two workstations.
20
21     @see SD_link_management */
22 typedef struct SD_link *SD_link_t;
23
24 /** @brief Task datatype
25     @ingroup SD_datatypes_management
26
27     A task is some <em>computing amount</em> that can be executed
28     in parallel on several workstations. A task may depend on other
29     tasks, this means that the task cannot start until the other tasks are done.
30     Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether 
31     the task is scheduled, running, done, etc.
32
33     @see SD_task_management */
34 typedef struct SD_task *SD_task_t;
35
36 /** @brief Task states
37     @ingroup SD_datatypes_management
38
39     @see SD_task_management */
40 typedef enum {
41   SD_NOT_SCHEDULED = 0,      /**< @brief Initial state (not valid for SD_watch and SD_unwatch). */
42   SD_SCHEDULED =     0x0001, /**< @brief A task becomes SD_SCHEDULED when you call function
43                                 SD_task_schedule. SD_simulate will execute it when it becomes SD_READY. */
44   SD_READY =         0x0002, /**< @brief A scheduled task becomes ready as soon as its dependencies are satisfied. */
45   SD_RUNNING =       0x0004, /**< @brief When a task is ready, it is launched in the function SD_simulate and becomes SD_RUNNING. */
46   SD_DONE =          0x0008, /**< @brief The task is successfuly finished. */
47   SD_FAILED =        0x0010  /**< @brief A problem occured during the execution of the task. */
48 } e_SD_task_state_t;
49
50 #endif