Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
SD_link_get_list -> sd_link_list
[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/mallocator.h"
17 #include <stdbool.h>
18
19 SG_BEGIN_DECL()
20
21 /* Global variables */
22
23 typedef struct SD_global {
24   SD_workstation_t *workstation_list;   /* array of workstations, created only if
25                                            necessary in SD_workstation_get_list */
26   SD_link_t *link_list;         /* array of links */
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   xbt_dynar_t initial_task_set;
35   xbt_dynar_t executable_task_set;
36   xbt_dynar_t completed_task_set;
37
38   xbt_dynar_t return_set;
39   int task_number;
40
41 } s_SD_global_t, *SD_global_t;
42
43 extern XBT_PRIVATE SD_global_t sd_global;
44
45 /* Workstation */
46 typedef s_xbt_dictelm_t s_SD_workstation_t;
47 typedef struct SD_workstation {
48   e_SD_workstation_access_mode_t access_mode;
49
50   xbt_fifo_t task_fifo;         /* only used in sequential mode */
51   SD_task_t current_task;       /* only used in sequential mode */
52 } s_SD_workstation_priv_t, *SD_workstation_priv_t;
53
54 /* Storage */
55 typedef s_xbt_dictelm_t s_SD_storage_t;
56 typedef struct SD_storage {
57   void *data;                   /* user data */
58   const char *host;
59 } s_SD_storage_priv_t, *SD_storage_priv_t;
60
61 static inline SD_storage_priv_t SD_storage_priv(SD_storage_t storage){
62   return (SD_storage_priv_t)xbt_lib_get_level(storage, SD_STORAGE_LEVEL);
63 }
64
65 /* Task */
66 typedef struct SD_task {
67   e_SD_task_state_t state;
68   void *data;                   /* user data */
69   char *name;
70   e_SD_task_kind_t kind;
71   double amount;
72   double alpha;          /* used by typed parallel tasks */
73   double remains;
74   double start_time;
75   double finish_time;
76   surf_action_t surf_action;
77   unsigned short watch_points;  /* bit field xor()ed with masks */
78
79   int fifo_checked;             /* used by SD_task_just_done to make sure we evaluate
80                                    the task only once */
81   int marked;                   /* used to check if the task DAG has some cycle*/
82
83   /* dependencies */
84   xbt_dynar_t tasks_before;
85   xbt_dynar_t tasks_after;
86   int unsatisfied_dependencies;
87   unsigned int is_not_ready;
88
89   /* scheduling parameters (only exist in state SD_SCHEDULED) */
90   int workstation_nb;
91   SD_workstation_t *workstation_list;   /* surf workstations */
92   double *flops_amount;
93   double *bytes_amount;
94   double rate;
95
96   long long int counter;        /* task unique identifier for instrumentation */
97   char *category;               /* sd task category for instrumentation */
98 } s_SD_task_t;
99
100 /* Task dependencies */
101 typedef struct SD_dependency {
102   char *name;
103   void *data;
104   SD_task_t src;
105   SD_task_t dst;
106   /* src must be finished before dst can start */
107 } s_SD_dependency_t, *SD_dependency_t;
108
109 /* SimDag private functions */
110 XBT_PRIVATE SD_workstation_t __SD_workstation_create(const char* name);
111 XBT_PRIVATE void __SD_workstation_destroy(void *workstation);
112 XBT_PRIVATE int __SD_workstation_is_busy(SD_workstation_t workstation);
113
114 XBT_PRIVATE void SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state);
115 XBT_PRIVATE void __SD_task_really_run(SD_task_t task);
116 XBT_PRIVATE void __SD_task_just_done(SD_task_t task);
117 XBT_PRIVATE int __SD_task_try_to_run(SD_task_t task);
118 XBT_PRIVATE bool acyclic_graph_detail(xbt_dynar_t dag);
119
120 /* Task mallocator functions */
121 XBT_PRIVATE void* SD_task_new_f(void);
122 XBT_PRIVATE void SD_task_recycle_f(void *t);
123 XBT_PRIVATE void SD_task_free_f(void *t);
124
125 /* Functions to test if the task is in a given state. */
126
127 /* Returns whether the given task is scheduled or runnable. */
128 static XBT_INLINE int __SD_task_is_scheduled_or_runnable(SD_task_t task)
129 {
130   return task->state == SD_SCHEDULED || task->state == SD_RUNNABLE;
131 }
132
133 /* Returns whether the given task is scheduled or runnable. */
134 static XBT_INLINE int __SD_task_is_schedulable_or_done(SD_task_t task)
135 {
136   return task->state == SD_SCHEDULABLE || task->state == SD_DONE;
137 }
138
139 /* Returns whether the state of the given task is SD_RUNNABLE or SD_IN_FIFO. */
140 static XBT_INLINE int __SD_task_is_runnable_or_in_fifo(SD_task_t task)
141 {
142   return task->state == SD_RUNNABLE || task->state == SD_IN_FIFO;
143 }
144
145 /********** Storage **********/
146 XBT_PRIVATE SD_storage_t __SD_storage_create(void *surf_storage, void *data);
147 XBT_PRIVATE void __SD_storage_destroy(void *storage);
148
149 /********** Tracing **********/
150 /* declaration of instrumentation functions from sd_task_instr.c */
151 XBT_PRIVATE void TRACE_sd_task_create(SD_task_t task);
152 XBT_PRIVATE void TRACE_sd_task_execute_start(SD_task_t task);
153 XBT_PRIVATE void TRACE_sd_task_execute_end(SD_task_t task);
154 XBT_PRIVATE void TRACE_sd_task_destroy(SD_task_t task);
155
156 SG_END_DECL()
157
158 #endif