Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
db39ef461c20bac759724ed8c6cce1aff9e51184
[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 "xbt/swag.h"
17 #include "xbt/mallocator.h"
18 #include <stdbool.h>
19
20 /* Global variables */
21
22 typedef struct SD_global {
23   SD_workstation_t *workstation_list;   /* array of workstations, created only if
24                                            necessary in SD_workstation_get_list */
25   SD_link_t *link_list;         /* array of links, created only if
26                                    necessary in SD_link_get_list */
27   SD_link_t *recyclable_route;  /* array returned by SD_route_get_list
28                                    and mallocated only once */
29
30   xbt_mallocator_t task_mallocator; /* to not remalloc new tasks */
31
32   int watch_point_reached;      /* has a task just reached a watch point? */
33
34   /* task state sets */
35   xbt_swag_t not_scheduled_task_set;
36   xbt_swag_t schedulable_task_set;
37   xbt_swag_t scheduled_task_set;
38   xbt_swag_t runnable_task_set;
39   xbt_swag_t in_fifo_task_set;
40   xbt_swag_t running_task_set;
41   xbt_swag_t done_task_set;
42   xbt_swag_t failed_task_set;
43
44   xbt_swag_t return_set;
45   int task_number;
46
47 } s_SD_global_t, *SD_global_t;
48
49 extern SD_global_t sd_global;
50
51 /* Link */
52 typedef struct SD_link {
53   void *surf_link;              /* surf object */
54   void *data;                   /* user data */
55   e_SD_link_sharing_policy_t sharing_policy;
56 } s_SD_link_t;
57
58 /* Workstation */
59 typedef struct SD_workstation {
60   void *surf_workstation;       /* surf object */
61   void *data;                   /* user data */
62   e_SD_workstation_access_mode_t access_mode;
63
64   xbt_fifo_t task_fifo;         /* only used in sequential mode */
65   SD_task_t current_task;       /* only used in sequential mode */
66 } s_SD_workstation_t;
67
68 /* Task */
69 typedef struct SD_task {
70   s_xbt_swag_hookup_t state_hookup;
71   s_xbt_swag_hookup_t return_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 alpha;          /* used by typed parallel tasks */
79   double remains;
80   double start_time;
81   double finish_time;
82   surf_action_t surf_action;
83   unsigned short watch_points;  /* bit field xor()ed with masks */
84
85   int fifo_checked;             /* used by SD_task_just_done to make sure we evaluate
86                                    the task only once */
87   int marked;                   /* used to check if the task DAG has some cycle*/
88
89   /* dependencies */
90   xbt_dynar_t tasks_before;
91   xbt_dynar_t tasks_after;
92   unsigned int unsatisfied_dependencies;
93   unsigned int is_not_ready;
94
95   /* scheduling parameters (only exist in state SD_SCHEDULED) */
96   int workstation_nb;
97   SD_workstation_t *workstation_list;   /* surf workstations */
98   double *computation_amount;
99   double *communication_amount;
100   double rate;
101
102 #ifdef HAVE_TRACING
103   char *category;               /* sd task category for instrumentation */
104 #endif
105 } s_SD_task_t;
106
107 /* Task dependencies */
108 typedef struct SD_dependency {
109   char *name;
110   void *data;
111   SD_task_t src;
112   SD_task_t dst;
113   /* src must be finished before dst can start */
114 } s_SD_dependency_t, *SD_dependency_t;
115
116 /* SimDag private functions */
117 XBT_PUBLIC(xbt_swag_t) SD_simulate_swag(double how_long); /* could be public, but you need to see the internals of the SD_task_t to use it */
118
119
120 SD_link_t __SD_link_create(void *surf_link, void *data);
121 #define __SD_link_destroy xbt_free_f
122
123 SD_workstation_t __SD_workstation_create(void *surf_workstation,
124                                          void *data);
125 void __SD_workstation_destroy(void *workstation);
126 int __SD_workstation_is_busy(SD_workstation_t workstation);
127
128 void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state);
129 void __SD_task_really_run(SD_task_t task);
130 int __SD_task_try_to_run(SD_task_t task);
131 void __SD_task_just_done(SD_task_t task);
132 bool acyclic_graph_detail(xbt_dynar_t dag);
133
134 /* Task mallocator functions */
135 void* SD_task_new_f(void);
136 void SD_task_recycle_f(void *t);
137 void SD_task_free_f(void *t);
138
139 /* Functions to test if the task is in a given state. */
140
141 /* Returns whether the given task is scheduled or runnable. */
142 static XBT_INLINE int __SD_task_is_scheduled_or_runnable(SD_task_t task)
143 {
144   return task->state_set == sd_global->scheduled_task_set ||
145       task->state_set == sd_global->runnable_task_set;
146 }
147
148 /* Returns whether the given task is scheduled or runnable. */
149 static XBT_INLINE int __SD_task_is_schedulable_or_done(SD_task_t task)
150 {
151   return task->state_set == sd_global->schedulable_task_set ||
152       task->state_set == sd_global->done_task_set;
153 }
154
155 /* Returns whether the state of the given task is SD_NOT_SCHEDULED. */
156 static XBT_INLINE int __SD_task_is_not_scheduled(SD_task_t task)
157 {
158   return task->state_set == sd_global->not_scheduled_task_set;
159 }
160
161 /* Returns whether the state of the given task is SD_SCHEDULED. */
162 static XBT_INLINE int __SD_task_is_schedulable(SD_task_t task)
163 {
164   return task->state_set == sd_global->schedulable_task_set;
165 }
166
167 /* Returns whether the state of the given task is SD_SCHEDULED. */
168 static XBT_INLINE int __SD_task_is_scheduled(SD_task_t task)
169 {
170   return task->state_set == sd_global->scheduled_task_set;
171 }
172
173 /* Returns whether the state of the given task is SD_RUNNABLE. */
174 static XBT_INLINE int __SD_task_is_runnable(SD_task_t task)
175 {
176   return task->state_set == sd_global->runnable_task_set;
177 }
178
179 /* Returns whether the state of the given task is SD_IN_FIFO. */
180 static XBT_INLINE int __SD_task_is_in_fifo(SD_task_t task)
181 {
182   return task->state_set == sd_global->in_fifo_task_set;
183 }
184
185 /* Returns whether the state of the given task is SD_RUNNABLE or SD_IN_FIFO. */
186 static XBT_INLINE int __SD_task_is_runnable_or_in_fifo(SD_task_t task)
187 {
188   return task->state_set == sd_global->runnable_task_set ||
189       task->state_set == sd_global->in_fifo_task_set;
190 }
191
192 /* Returns whether the state of the given task is SD_RUNNING. */
193 static XBT_INLINE int __SD_task_is_running(SD_task_t task)
194 {
195   return task->state_set == sd_global->running_task_set;
196 }
197
198 #endif