Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
0a3bc8c1c18a857ec3b52be4106fc51ef23090a6
[simgrid.git] / src / simdag / simdag_private.h
1 /* Copyright (c) 2006-2015. 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/base.h"
11 #include "xbt/dict.h"
12 #include "xbt/dynar.h"
13 #include "xbt/fifo.h"
14 #include "simgrid/simdag.h"
15 #include "surf/surf.h"
16 #include "xbt/swag.h"
17 #include "xbt/mallocator.h"
18 #include <stdbool.h>
19
20 SG_BEGIN_DECL()
21
22 /* Global variables */
23
24 typedef struct SD_global {
25   SD_workstation_t *workstation_list;   /* array of workstations, created only if
26                                            necessary in SD_workstation_get_list */
27   SD_link_t *link_list;         /* array of links, created only if
28                                    necessary in SD_link_get_list */
29   SD_link_t *recyclable_route;  /* array returned by SD_route_get_list
30                                    and mallocated only once */
31
32   xbt_mallocator_t task_mallocator; /* to not remalloc new tasks */
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   xbt_swag_t return_set;
47   int task_number;
48
49 } s_SD_global_t, *SD_global_t;
50
51 extern XBT_PRIVATE SD_global_t sd_global;
52
53 /* Workstation */
54 typedef s_xbt_dictelm_t s_SD_workstation_t;
55 typedef struct SD_workstation {
56   e_SD_workstation_access_mode_t access_mode;
57
58   xbt_fifo_t task_fifo;         /* only used in sequential mode */
59   SD_task_t current_task;       /* only used in sequential mode */
60 } s_SD_workstation_priv_t, *SD_workstation_priv_t;
61
62 /* Storage */
63 typedef s_xbt_dictelm_t s_SD_storage_t;
64 typedef struct SD_storage {
65   void *data;                   /* user data */
66   const char *host;
67 } s_SD_storage_priv_t, *SD_storage_priv_t;
68
69 static inline SD_storage_priv_t SD_storage_priv(SD_storage_t storage){
70   return (SD_storage_priv_t)xbt_lib_get_level(storage, SD_STORAGE_LEVEL);
71 }
72
73 /* Task */
74 typedef struct SD_task {
75   s_xbt_swag_hookup_t state_hookup;
76   s_xbt_swag_hookup_t return_hookup;
77   xbt_swag_t state_set;
78   e_SD_task_state_t state;
79   void *data;                   /* user data */
80   char *name;
81   int kind;
82   double amount;
83   double alpha;          /* used by typed parallel tasks */
84   double remains;
85   double start_time;
86   double finish_time;
87   surf_action_t surf_action;
88   unsigned short watch_points;  /* bit field xor()ed with masks */
89
90   int fifo_checked;             /* used by SD_task_just_done to make sure we evaluate
91                                    the task only once */
92   int marked;                   /* used to check if the task DAG has some cycle*/
93
94   /* dependencies */
95   xbt_dynar_t tasks_before;
96   xbt_dynar_t tasks_after;
97   int unsatisfied_dependencies;
98   unsigned int is_not_ready;
99
100   /* scheduling parameters (only exist in state SD_SCHEDULED) */
101   int workstation_nb;
102   SD_workstation_t *workstation_list;   /* surf workstations */
103   double *flops_amount;
104   double *bytes_amount;
105   double rate;
106
107   long long int counter;        /* task unique identifier for instrumentation */
108   char *category;               /* sd task category for instrumentation */
109 } s_SD_task_t;
110
111 /* Task dependencies */
112 typedef struct SD_dependency {
113   char *name;
114   void *data;
115   SD_task_t src;
116   SD_task_t dst;
117   /* src must be finished before dst can start */
118 } s_SD_dependency_t, *SD_dependency_t;
119
120 /* SimDag private functions */
121 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 */
122
123
124 XBT_PRIVATE SD_workstation_t __SD_workstation_create(const char* name);
125 XBT_PRIVATE void __SD_workstation_destroy(void *workstation);
126 XBT_PRIVATE int __SD_workstation_is_busy(SD_workstation_t workstation);
127
128 XBT_PRIVATE void __SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state);
129 XBT_PRIVATE void __SD_task_really_run(SD_task_t task);
130 XBT_PRIVATE void __SD_task_just_done(SD_task_t task);
131 XBT_PRIVATE int __SD_task_try_to_run(SD_task_t task);
132 XBT_PRIVATE bool acyclic_graph_detail(xbt_dynar_t dag);
133
134 /* Task mallocator functions */
135 XBT_PRIVATE void* SD_task_new_f(void);
136 XBT_PRIVATE void SD_task_recycle_f(void *t);
137 XBT_PRIVATE 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 /********** Storage **********/
199 XBT_PRIVATE SD_storage_t __SD_storage_create(void *surf_storage, void *data);
200 XBT_PRIVATE void __SD_storage_destroy(void *storage);
201
202 /********** Tracing **********/
203 /* declaration of instrumentation functions from sd_task_instr.c */
204 XBT_PRIVATE void TRACE_sd_task_create(SD_task_t task);
205 XBT_PRIVATE void TRACE_sd_task_execute_start(SD_task_t task);
206 XBT_PRIVATE void TRACE_sd_task_execute_end(SD_task_t task);
207 XBT_PRIVATE void TRACE_sd_task_destroy(SD_task_t task);
208
209 SG_END_DECL()
210
211 #endif