Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge with master and fix conflicts
[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 s_xbt_dictelm_t s_SD_workstation_t;
60 typedef struct SD_workstation {
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_priv_t, *SD_workstation_priv_t;
67
68 static inline SD_workstation_priv_t SD_workstation_priv(SD_workstation_t host){
69   return xbt_lib_get_level(host, SD_HOST_LEVEL);
70 }
71
72 /* Task */
73 typedef struct SD_task {
74   s_xbt_swag_hookup_t state_hookup;
75   s_xbt_swag_hookup_t return_hookup;
76   xbt_swag_t state_set;
77   e_SD_task_state_t state;
78   void *data;                   /* user data */
79   char *name;
80   int kind;
81   double amount;
82   double alpha;          /* used by typed parallel tasks */
83   double remains;
84   double start_time;
85   double finish_time;
86   surf_action_t surf_action;
87   unsigned short watch_points;  /* bit field xor()ed with masks */
88
89   int fifo_checked;             /* used by SD_task_just_done to make sure we evaluate
90                                    the task only once */
91   int marked;                   /* used to check if the task DAG has some cycle*/
92
93   /* dependencies */
94   xbt_dynar_t tasks_before;
95   xbt_dynar_t tasks_after;
96   int unsatisfied_dependencies;
97   unsigned int is_not_ready;
98
99   /* scheduling parameters (only exist in state SD_SCHEDULED) */
100   int workstation_nb;
101   SD_workstation_t *workstation_list;   /* surf workstations */
102   double *computation_amount;
103   double *communication_amount;
104   double rate;
105
106 #ifdef HAVE_TRACING
107   long long int counter;        /* task unique identifier for instrumentation */
108   char *category;               /* sd task category for instrumentation */
109 #endif
110 } s_SD_task_t;
111
112 /* Task dependencies */
113 typedef struct SD_dependency {
114   char *name;
115   void *data;
116   SD_task_t src;
117   SD_task_t dst;
118   /* src must be finished before dst can start */
119 } s_SD_dependency_t, *SD_dependency_t;
120
121 /* SimDag private functions */
122 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 */
123
124
125 SD_link_t __SD_link_create(void *surf_link, void *data);
126 #define __SD_link_destroy xbt_free_f
127
128 SD_workstation_t __SD_workstation_create(void *surf_workstation,
129                                          void *data);
130 void __SD_workstation_destroy(void *workstation);
131 int __SD_workstation_is_busy(SD_workstation_t workstation);
132
133 void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state);
134 void __SD_task_really_run(SD_task_t task);
135 int __SD_task_try_to_run(SD_task_t task);
136 void __SD_task_just_done(SD_task_t task);
137 bool acyclic_graph_detail(xbt_dynar_t dag);
138
139 /* Task mallocator functions */
140 void* SD_task_new_f(void);
141 void SD_task_recycle_f(void *t);
142 void SD_task_free_f(void *t);
143
144 /* Functions to test if the task is in a given state. */
145
146 /* Returns whether the given task is scheduled or runnable. */
147 static XBT_INLINE int __SD_task_is_scheduled_or_runnable(SD_task_t task)
148 {
149   return task->state_set == sd_global->scheduled_task_set ||
150       task->state_set == sd_global->runnable_task_set;
151 }
152
153 /* Returns whether the given task is scheduled or runnable. */
154 static XBT_INLINE int __SD_task_is_schedulable_or_done(SD_task_t task)
155 {
156   return task->state_set == sd_global->schedulable_task_set ||
157       task->state_set == sd_global->done_task_set;
158 }
159
160 /* Returns whether the state of the given task is SD_NOT_SCHEDULED. */
161 static XBT_INLINE int __SD_task_is_not_scheduled(SD_task_t task)
162 {
163   return task->state_set == sd_global->not_scheduled_task_set;
164 }
165
166 /* Returns whether the state of the given task is SD_SCHEDULED. */
167 static XBT_INLINE int __SD_task_is_schedulable(SD_task_t task)
168 {
169   return task->state_set == sd_global->schedulable_task_set;
170 }
171
172 /* Returns whether the state of the given task is SD_SCHEDULED. */
173 static XBT_INLINE int __SD_task_is_scheduled(SD_task_t task)
174 {
175   return task->state_set == sd_global->scheduled_task_set;
176 }
177
178 /* Returns whether the state of the given task is SD_RUNNABLE. */
179 static XBT_INLINE int __SD_task_is_runnable(SD_task_t task)
180 {
181   return task->state_set == sd_global->runnable_task_set;
182 }
183
184 /* Returns whether the state of the given task is SD_IN_FIFO. */
185 static XBT_INLINE int __SD_task_is_in_fifo(SD_task_t task)
186 {
187   return task->state_set == sd_global->in_fifo_task_set;
188 }
189
190 /* Returns whether the state of the given task is SD_RUNNABLE or SD_IN_FIFO. */
191 static XBT_INLINE int __SD_task_is_runnable_or_in_fifo(SD_task_t task)
192 {
193   return task->state_set == sd_global->runnable_task_set ||
194       task->state_set == sd_global->in_fifo_task_set;
195 }
196
197 /* Returns whether the state of the given task is SD_RUNNING. */
198 static XBT_INLINE int __SD_task_is_running(SD_task_t task)
199 {
200   return task->state_set == sd_global->running_task_set;
201 }
202 /********** Tracing **********/
203 /* declaration of instrumentation functions from sd_task_instr.c */
204 void TRACE_sd_task_create(SD_task_t task);
205 void TRACE_sd_task_execute_start(SD_task_t task);
206 void TRACE_sd_task_execute_end(SD_task_t task);
207 void TRACE_sd_task_destroy(SD_task_t task);
208
209
210 #endif