1 /* Copyright (c) 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #ifndef SIMDAG_PRIVATE_H
8 #define SIMDAG_PRIVATE_H
11 #include "xbt/dynar.h"
13 #include "simdag/simdag.h"
14 #include "simdag/datatypes.h"
15 #include "surf/surf.h"
17 #define SD_INITIALISED() (sd_global != NULL)
18 #define SD_CHECK_INIT_DONE() xbt_assert0(SD_INITIALISED(), "Call SD_init() first");
20 /* Global variables */
22 typedef struct SD_global {
23 xbt_dict_t workstations; /* workstation dictionary */
24 int workstation_count; /* number of workstations */
25 SD_workstation_t *workstation_list; /* array of workstations, created only if
26 necessary in SD_workstation_get_list */
28 xbt_dict_t links; /* links */
29 int link_count; /* number of links */
30 SD_link_t *link_list; /* array of links, created only if
31 necessary in SD_link_get_list */
32 SD_link_t *recyclable_route; /* array returned by SD_route_get_list
33 and mallocated only once */
35 int watch_point_reached; /* has a task just reached a watch point? */
38 xbt_swag_t not_scheduled_task_set;
39 xbt_swag_t schedulable_task_set;
40 xbt_swag_t scheduled_task_set;
41 xbt_swag_t runnable_task_set;
42 xbt_swag_t in_fifo_task_set;
43 xbt_swag_t running_task_set;
44 xbt_swag_t done_task_set;
45 xbt_swag_t failed_task_set;
49 } s_SD_global_t, *SD_global_t;
51 extern SD_global_t sd_global;
54 typedef struct SD_link {
55 void *surf_link; /* surf object */
56 void *data; /* user data */
57 e_SD_link_sharing_policy_t sharing_policy;
61 typedef struct SD_workstation {
62 void *surf_workstation; /* surf object */
63 void *data; /* user data */
64 e_SD_workstation_access_mode_t access_mode;
66 xbt_fifo_t task_fifo; /* only used in sequential mode */
67 SD_task_t current_task; /* only used in sequential mode */
71 typedef struct SD_task {
72 s_xbt_swag_hookup_t state_hookup;
74 e_SD_task_state_t state;
75 void *data; /* user data */
82 surf_action_t surf_action;
83 unsigned short watch_points; /* bit field xor()ed with masks */
85 int fifo_checked; /* used by SD_task_just_done to make sure we evaluate
89 xbt_dynar_t tasks_before;
90 xbt_dynar_t tasks_after;
91 unsigned int unsatisfied_dependencies;
92 unsigned int is_not_ready;
94 /* scheduling parameters (only exist in state SD_SCHEDULED) */
96 SD_workstation_t *workstation_list; /* surf workstations */
97 double *computation_amount;
98 double *communication_amount;
102 char *category; /* sd task category for instrumentation */
106 /* Task dependencies */
107 typedef struct SD_dependency {
112 /* src must be finished before dst can start */
113 } s_SD_dependency_t, *SD_dependency_t;
115 /* SimDag private functions */
117 SD_link_t __SD_link_create(void *surf_link, void *data);
118 void __SD_link_destroy(void *link);
120 SD_workstation_t __SD_workstation_create(void *surf_workstation,
122 void __SD_workstation_destroy(void *workstation);
123 int __SD_workstation_is_busy(SD_workstation_t workstation);
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);
130 /* Functions to test if the task is in a given state. */
132 /* Returns whether the given task is scheduled or runnable. */
133 static XBT_INLINE int __SD_task_is_scheduled_or_runnable(SD_task_t task)
135 return task->state_set == sd_global->scheduled_task_set ||
136 task->state_set == sd_global->runnable_task_set;
139 /* Returns whether the given task is scheduled or runnable. */
140 static XBT_INLINE int __SD_task_is_schedulable_or_done(SD_task_t task)
142 return task->state_set == sd_global->schedulable_task_set ||
143 task->state_set == sd_global->done_task_set;
146 /* Returns whether the state of the given task is SD_NOT_SCHEDULED. */
147 static XBT_INLINE int __SD_task_is_not_scheduled(SD_task_t task)
149 return task->state_set == sd_global->not_scheduled_task_set;
152 /* Returns whether the state of the given task is SD_SCHEDULED. */
153 static XBT_INLINE int __SD_task_is_schedulable(SD_task_t task)
155 return task->state_set == sd_global->schedulable_task_set;
158 /* Returns whether the state of the given task is SD_SCHEDULED. */
159 static XBT_INLINE int __SD_task_is_scheduled(SD_task_t task)
161 return task->state_set == sd_global->scheduled_task_set;
164 /* Returns whether the state of the given task is SD_RUNNABLE. */
165 static XBT_INLINE int __SD_task_is_runnable(SD_task_t task)
167 return task->state_set == sd_global->runnable_task_set;
170 /* Returns whether the state of the given task is SD_IN_FIFO. */
171 static XBT_INLINE int __SD_task_is_in_fifo(SD_task_t task)
173 return task->state_set == sd_global->in_fifo_task_set;
176 /* Returns whether the state of the given task is SD_RUNNABLE or SD_IN_FIFO. */
177 static XBT_INLINE int __SD_task_is_runnable_or_in_fifo(SD_task_t task)
179 return task->state_set == sd_global->runnable_task_set ||
180 task->state_set == sd_global->in_fifo_task_set;
183 /* Returns whether the state of the given task is SD_RUNNING. */
184 static XBT_INLINE int __SD_task_is_running(SD_task_t task)
186 return task->state_set == sd_global->running_task_set;