Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Finish SimDag documentation
[simgrid.git] / src / simdag / private.h
1 #ifndef SIMDAG_PRIVATE_H
2 #define SIMDAG_PRIVATE_H
3
4 #include "xbt/dict.h"
5 #include "xbt/dynar.h"
6 #include "simdag/simdag.h"
7 #include "simdag/datatypes.h"
8 #include "surf/surf.h"
9
10 #define SD_CHECK_INIT_DONE() xbt_assert0(sd_global != NULL, "Call SD_init() first")
11
12 /* Global variables */
13
14 typedef struct SD_global {
15   xbt_dict_t workstations; /* workstation list */
16   int workstation_count; /* number of workstations */
17   xbt_dict_t links; /* link list */
18   int watch_point_reached; /* has a task just reached a watch point? */
19   
20   /* task state sets */
21   xbt_swag_t not_scheduled_task_set;
22   xbt_swag_t scheduled_task_set;
23   xbt_swag_t ready_task_set;
24   xbt_swag_t running_task_set;
25   xbt_swag_t done_task_set;
26   xbt_swag_t failed_task_set;
27
28 } s_SD_global_t, *SD_global_t;
29
30 extern SD_global_t sd_global;
31
32 /* Link */
33 typedef struct SD_link {
34   void *surf_link; /* surf object */
35   void *data; /* user data */
36 } s_SD_link_t;
37
38 /* Workstation */
39 typedef struct SD_workstation {
40   void *surf_workstation; /* surf object */
41   void *data; /* user data */
42 } s_SD_workstation_t;
43
44 /* Task */
45 typedef struct SD_task {
46   s_xbt_swag_hookup_t state_hookup;
47   xbt_swag_t state_set;
48   void *data; /* user data */
49   char *name;
50   double amount;
51   surf_action_t surf_action;
52   unsigned short watch_points;
53   int state_changed; /* used only by SD_simulate, to make sure we put
54                         the task only once in the returning array */
55
56   /* dependencies */
57   xbt_dynar_t tasks_before;
58   xbt_dynar_t tasks_after;
59
60   /* scheduling parameters (only exist in state SD_SCHEDULED) */
61   int workstation_nb;
62   void **workstation_list; /* surf workstations */
63   double *computation_amount;
64   double *communication_amount;
65   double rate;
66 } s_SD_task_t;
67
68 /* Task dependencies */
69 typedef struct SD_dependency {
70   char *name;
71   void *data;
72   SD_task_t src;
73   SD_task_t dst;
74   /* src must be finished before dst can start */
75 } s_SD_dependency_t, *SD_dependency_t;
76
77 /* SimDag private functions */
78
79 SD_link_t __SD_link_create(void *surf_link, void *data);
80 void __SD_link_destroy(void *link);
81
82 SD_workstation_t __SD_workstation_create(void *surf_workstation, void *data);
83 void __SD_workstation_destroy(void *workstation);
84
85 void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state);
86 surf_action_t __SD_task_run(SD_task_t task);
87 void __SD_task_remove_dependencies(SD_task_t task);
88
89 /* Functions to test if the task is in a given state.
90    These functions are faster than using SD_task_get_state() */
91
92 /* Returns whether the given task is scheduled or ready. */
93 static _XBT_INLINE int __SD_task_is_scheduled_or_ready(SD_task_t task) {
94   return task->state_set == sd_global->scheduled_task_set ||
95     task->state_set == sd_global->ready_task_set;
96 }
97
98 /* Returns whether the state of the given task is SD_NOT_SCHEDULED. */
99 static _XBT_INLINE int __SD_task_is_not_scheduled(SD_task_t task) {
100   return task->state_set == sd_global->not_scheduled_task_set;
101 }
102
103 /* Returns whether the state of the given task is SD_SCHEDULED. */
104 static _XBT_INLINE int __SD_task_is_scheduled(SD_task_t task) {
105   return task->state_set == sd_global->scheduled_task_set;
106 }
107
108 /* Returns whether the state of the given task is SD_READY. */
109 static _XBT_INLINE int __SD_task_is_ready(SD_task_t task) {
110   return task->state_set == sd_global->ready_task_set;
111 }
112
113 /* Returns whether the state of the given task is SD_RUNNING. */
114 static _XBT_INLINE int __SD_task_is_running(SD_task_t task) {
115   return task->state_set == sd_global->running_task_set;
116 }
117
118 #endif