1 /* Copyright (c) 2006-2015. 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
12 #include "xbt/dynar.h"
14 #include "simgrid/simdag.h"
15 #include "surf/surf.h"
17 #include "xbt/mallocator.h"
22 /* Global variables */
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 */
32 xbt_mallocator_t task_mallocator; /* to not remalloc new tasks */
34 int watch_point_reached; /* has a task just reached a watch point? */
36 xbt_dynar_t initial_task_set;
37 xbt_dynar_t executable_task_set;
38 xbt_dynar_t completed_task_set;
40 xbt_swag_t return_set;
43 } s_SD_global_t, *SD_global_t;
45 extern XBT_PRIVATE SD_global_t sd_global;
48 typedef s_xbt_dictelm_t s_SD_workstation_t;
49 typedef struct SD_workstation {
50 e_SD_workstation_access_mode_t access_mode;
52 xbt_fifo_t task_fifo; /* only used in sequential mode */
53 SD_task_t current_task; /* only used in sequential mode */
54 } s_SD_workstation_priv_t, *SD_workstation_priv_t;
57 typedef s_xbt_dictelm_t s_SD_storage_t;
58 typedef struct SD_storage {
59 void *data; /* user data */
61 } s_SD_storage_priv_t, *SD_storage_priv_t;
63 static inline SD_storage_priv_t SD_storage_priv(SD_storage_t storage){
64 return (SD_storage_priv_t)xbt_lib_get_level(storage, SD_STORAGE_LEVEL);
68 typedef struct SD_task {
69 s_xbt_swag_hookup_t return_hookup;
70 e_SD_task_state_t state;
71 void *data; /* user data */
75 double alpha; /* used by typed parallel tasks */
79 surf_action_t surf_action;
80 unsigned short watch_points; /* bit field xor()ed with masks */
82 int fifo_checked; /* used by SD_task_just_done to make sure we evaluate
84 int marked; /* used to check if the task DAG has some cycle*/
87 xbt_dynar_t tasks_before;
88 xbt_dynar_t tasks_after;
89 int unsatisfied_dependencies;
90 unsigned int is_not_ready;
92 /* scheduling parameters (only exist in state SD_SCHEDULED) */
94 SD_workstation_t *workstation_list; /* surf workstations */
99 long long int counter; /* task unique identifier for instrumentation */
100 char *category; /* sd task category for instrumentation */
103 /* Task dependencies */
104 typedef struct SD_dependency {
109 /* src must be finished before dst can start */
110 } s_SD_dependency_t, *SD_dependency_t;
112 /* SimDag private functions */
113 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 */
116 XBT_PRIVATE SD_workstation_t __SD_workstation_create(const char* name);
117 XBT_PRIVATE void __SD_workstation_destroy(void *workstation);
118 XBT_PRIVATE int __SD_workstation_is_busy(SD_workstation_t workstation);
120 XBT_PRIVATE void SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state);
121 XBT_PRIVATE void __SD_task_really_run(SD_task_t task);
122 XBT_PRIVATE void __SD_task_just_done(SD_task_t task);
123 XBT_PRIVATE int __SD_task_try_to_run(SD_task_t task);
124 XBT_PRIVATE bool acyclic_graph_detail(xbt_dynar_t dag);
126 /* Task mallocator functions */
127 XBT_PRIVATE void* SD_task_new_f(void);
128 XBT_PRIVATE void SD_task_recycle_f(void *t);
129 XBT_PRIVATE void SD_task_free_f(void *t);
131 /* Functions to test if the task is in a given state. */
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)
136 return task->state == SD_SCHEDULED || task->state == SD_RUNNABLE;
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 == SD_SCHEDULABLE || task->state == SD_DONE;
145 /* Returns whether the state of the given task is SD_RUNNABLE or SD_IN_FIFO. */
146 static XBT_INLINE int __SD_task_is_runnable_or_in_fifo(SD_task_t task)
148 return task->state == SD_RUNNABLE || task->state == SD_IN_FIFO;
151 /********** Storage **********/
152 XBT_PRIVATE SD_storage_t __SD_storage_create(void *surf_storage, void *data);
153 XBT_PRIVATE void __SD_storage_destroy(void *storage);
155 /********** Tracing **********/
156 /* declaration of instrumentation functions from sd_task_instr.c */
157 XBT_PRIVATE void TRACE_sd_task_create(SD_task_t task);
158 XBT_PRIVATE void TRACE_sd_task_execute_start(SD_task_t task);
159 XBT_PRIVATE void TRACE_sd_task_execute_end(SD_task_t task);
160 XBT_PRIVATE void TRACE_sd_task_destroy(SD_task_t task);