Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove xbt_dict_t links from struct SD_global.
[simgrid.git] / src / simdag / private.h
1 /* Copyright (c) 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef SIMDAG_PRIVATE_H
8 #define SIMDAG_PRIVATE_H
9
10 #include "xbt/dict.h"
11 #include "xbt/dynar.h"
12 #include "xbt/fifo.h"
13 #include "simdag/simdag.h"
14 #include "simdag/datatypes.h"
15 #include "surf/surf.h"
16 #include <stdbool.h>
17
18 #define SD_INITIALISED() (sd_global != NULL)
19 #define SD_CHECK_INIT_DONE() xbt_assert0(SD_INITIALISED(), "Call SD_init() first");
20
21 /* Global variables */
22
23 typedef struct SD_global {
24   xbt_dict_t workstations;      /* workstation dictionary */
25   int workstation_count;        /* number of workstations */
26   SD_workstation_t *workstation_list;   /* array of workstations, created only if
27                                            necessary in SD_workstation_get_list */
28
29   SD_link_t *link_list;         /* array of links, created only if
30                                    necessary in SD_link_get_list */
31   SD_link_t *recyclable_route;  /* array returned by SD_route_get_list
32                                    and mallocated only once */
33
34   int watch_point_reached;      /* has a task just reached a watch point? */
35
36   /* task state sets */
37   xbt_swag_t not_scheduled_task_set;
38   xbt_swag_t schedulable_task_set;
39   xbt_swag_t scheduled_task_set;
40   xbt_swag_t runnable_task_set;
41   xbt_swag_t in_fifo_task_set;
42   xbt_swag_t running_task_set;
43   xbt_swag_t done_task_set;
44   xbt_swag_t failed_task_set;
45
46   int task_number;
47
48 } s_SD_global_t, *SD_global_t;
49
50 extern SD_global_t sd_global;
51
52 /* Link */
53 typedef struct SD_link {
54   void *surf_link;              /* surf object */
55   void *data;                   /* user data */
56   e_SD_link_sharing_policy_t sharing_policy;
57 } s_SD_link_t;
58
59 /* Workstation */
60 typedef struct SD_workstation {
61   void *surf_workstation;       /* surf object */
62   void *data;                   /* user data */
63   e_SD_workstation_access_mode_t access_mode;
64
65   xbt_fifo_t task_fifo;         /* only used in sequential mode */
66   SD_task_t current_task;       /* only used in sequential mode */
67 } s_SD_workstation_t;
68
69 /* Task */
70 typedef struct SD_task {
71   s_xbt_swag_hookup_t state_hookup;
72   xbt_swag_t state_set;
73   e_SD_task_state_t state;
74   void *data;                   /* user data */
75   char *name;
76   int kind;
77   double amount;
78   double remains;
79   double start_time;
80   double finish_time;
81   surf_action_t surf_action;
82   unsigned short watch_points;  /* bit field xor()ed with masks */
83
84   int fifo_checked;             /* used by SD_task_just_done to make sure we evaluate
85                                    the task only once */
86   int marked;                   /* used to check if the task DAG has some cycle*/
87
88   /* dependencies */
89   xbt_dynar_t tasks_before;
90   xbt_dynar_t tasks_after;
91   unsigned int unsatisfied_dependencies;
92   unsigned int is_not_ready;
93
94   /* scheduling parameters (only exist in state SD_SCHEDULED) */
95   int workstation_nb;
96   SD_workstation_t *workstation_list;   /* surf workstations */
97   double *computation_amount;
98   double *communication_amount;
99   double rate;
100
101 #ifdef HAVE_TRACING
102   char *category;               /* sd task category for instrumentation */
103 #endif
104 } s_SD_task_t;
105
106 /* Task dependencies */
107 typedef struct SD_dependency {
108   char *name;
109   void *data;
110   SD_task_t src;
111   SD_task_t dst;
112   /* src must be finished before dst can start */
113 } s_SD_dependency_t, *SD_dependency_t;
114
115 /* SimDag private functions */
116
117 SD_link_t __SD_link_create(void *surf_link, void *data);
118 void __SD_link_destroy(void *link);
119
120 SD_workstation_t __SD_workstation_create(void *surf_workstation,
121                                          void *data);
122 void __SD_workstation_destroy(void *workstation);
123 int __SD_workstation_is_busy(SD_workstation_t workstation);
124
125 void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state);
126 void __SD_task_really_run(SD_task_t task);
127 int __SD_task_try_to_run(SD_task_t task);
128 void __SD_task_just_done(SD_task_t task);
129 bool acyclic_graph_detail(xbt_dynar_t dag);
130
131 /* Functions to test if the task is in a given state. */
132
133 /* Returns whether the given task is scheduled or runnable. */
134 static XBT_INLINE int __SD_task_is_scheduled_or_runnable(SD_task_t task)
135 {
136   return task->state_set == sd_global->scheduled_task_set ||
137       task->state_set == sd_global->runnable_task_set;
138 }
139
140 /* Returns whether the given task is scheduled or runnable. */
141 static XBT_INLINE int __SD_task_is_schedulable_or_done(SD_task_t task)
142 {
143   return task->state_set == sd_global->schedulable_task_set ||
144       task->state_set == sd_global->done_task_set;
145 }
146
147 /* Returns whether the state of the given task is SD_NOT_SCHEDULED. */
148 static XBT_INLINE int __SD_task_is_not_scheduled(SD_task_t task)
149 {
150   return task->state_set == sd_global->not_scheduled_task_set;
151 }
152
153 /* Returns whether the state of the given task is SD_SCHEDULED. */
154 static XBT_INLINE int __SD_task_is_schedulable(SD_task_t task)
155 {
156   return task->state_set == sd_global->schedulable_task_set;
157 }
158
159 /* Returns whether the state of the given task is SD_SCHEDULED. */
160 static XBT_INLINE int __SD_task_is_scheduled(SD_task_t task)
161 {
162   return task->state_set == sd_global->scheduled_task_set;
163 }
164
165 /* Returns whether the state of the given task is SD_RUNNABLE. */
166 static XBT_INLINE int __SD_task_is_runnable(SD_task_t task)
167 {
168   return task->state_set == sd_global->runnable_task_set;
169 }
170
171 /* Returns whether the state of the given task is SD_IN_FIFO. */
172 static XBT_INLINE int __SD_task_is_in_fifo(SD_task_t task)
173 {
174   return task->state_set == sd_global->in_fifo_task_set;
175 }
176
177 /* Returns whether the state of the given task is SD_RUNNABLE or SD_IN_FIFO. */
178 static XBT_INLINE int __SD_task_is_runnable_or_in_fifo(SD_task_t task)
179 {
180   return task->state_set == sd_global->runnable_task_set ||
181       task->state_set == sd_global->in_fifo_task_set;
182 }
183
184 /* Returns whether the state of the given task is SD_RUNNING. */
185 static XBT_INLINE int __SD_task_is_running(SD_task_t task)
186 {
187   return task->state_set == sd_global->running_task_set;
188 }
189
190 #endif