Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
I'm told I have to care about users...
[simgrid.git] / include / simgrid / simdag.h
1 /* Copyright (c) 2006-2010, 2012-2016. 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_SIMDAG_H
8 #define SIMDAG_SIMDAG_H
9
10 #include "xbt/misc.h"
11 #include "xbt/dynar.h"
12 #include "xbt/dict.h"
13
14 #include "simgrid/link.h"
15
16 SG_BEGIN_DECL()
17
18 /** @brief Link datatype
19     @ingroup SD_datatypes_management
20
21     A link is a network node represented as a <em>name</em>, a <em>current
22     bandwidth</em> and a <em>current latency</em>. A route is a list of
23     links between two workstations.
24
25     @see SD_link_management */
26 typedef Link *SD_link_t;
27
28 /** @brief Task datatype
29     @ingroup SD_datatypes_management
30
31     A task is some <em>computing amount</em> that can be executed
32     in parallel on several workstations. A task may depend on other
33     tasks, this means that the task cannot start until the other tasks are done.
34     Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether
35     the task is scheduled, running, done, etc.
36
37     @see SD_task_management */
38 typedef struct SD_task *SD_task_t;
39
40 /** @brief Task states
41     @ingroup SD_datatypes_management
42
43     @see SD_task_management */
44 typedef enum {
45   SD_NOT_SCHEDULED = 0,      /**< @brief Initial state (not valid for SD_watch and SD_unwatch). */
46   SD_SCHEDULABLE = 0x0001,   /**< @brief A task becomes SD_SCHEDULABLE as soon as its dependencies are satisfied */
47   SD_SCHEDULED = 0x0002,     /**< @brief A task becomes SD_SCHEDULED when you call function
48                                   SD_task_schedule. SD_simulate will execute it when it becomes SD_RUNNABLE. */
49   SD_RUNNABLE = 0x0004,      /**< @brief A scheduled task becomes runnable is SD_simulate as soon as its dependencies are satisfied. */
50   SD_RUNNING = 0x0008,       /**< @brief An SD_RUNNABLE task becomes SD_RUNNING when it is launched. */
51   SD_DONE = 0x0010,          /**< @brief The task is successfully finished. */
52   SD_FAILED = 0x0020         /**< @brief A problem occurred during the execution of the task. */
53 } e_SD_task_state_t;
54
55 /** @brief Task kinds
56     @ingroup SD_datatypes_management
57
58     @see SD_task_management */
59 typedef enum {
60   SD_TASK_NOT_TYPED = 0,      /**< @brief no specified type */
61   SD_TASK_COMM_E2E = 1,       /**< @brief end to end communication */
62   SD_TASK_COMP_SEQ = 2,        /**< @brief sequential computation */
63   SD_TASK_COMP_PAR_AMDAHL = 3, /**< @brief parallel computation (Amdahl's law) */
64   SD_TASK_COMM_PAR_MXN_1D_BLOCK = 4 /**< @brief MxN data redistribution (1D Block distribution) */
65 } e_SD_task_kind_t;
66
67
68 /** @brief Storage datatype
69     @ingroup SD_datatypes_management
70
71  TODO PV: comment it !
72
73     @see SD_storage_management */
74 typedef xbt_dictelm_t SD_storage_t;
75
76 /************************** Workstation handling ****************************/
77
78 /** @defgroup sg_host_management Hosts
79  *  @brief Functions for managing the Hosts
80  *
81  *  This section describes the functions for managing the hosts.
82  *
83  *  A host is a place where a task can be executed.
84  *  A host is represented as a <em>physical resource with computing
85  *  capabilities</em> and has a <em>name</em>.
86  *
87  *  The hosts are created when you call the function SD_create_environment.
88  *
89  *  @see sg_host_t
90  *  @{
91  */
92 XBT_PUBLIC(const SD_link_t *) SD_route_get_list(sg_host_t src,
93                                                 sg_host_t dst);
94 XBT_PUBLIC(int) SD_route_get_size(sg_host_t src, sg_host_t dst);
95
96 XBT_PUBLIC(double) SD_route_get_latency(sg_host_t src, sg_host_t dst);
97 XBT_PUBLIC(double) SD_route_get_bandwidth(sg_host_t src, sg_host_t dst);
98
99 XBT_PUBLIC(const char*) SD_storage_get_host(SD_storage_t storage);
100 /** @} */
101
102 /************************** Task handling ************************************/
103
104 /** @defgroup SD_task_management Tasks
105  *  @brief Functions for managing the tasks
106  *
107  *  This section describes the functions for managing the tasks.
108  *
109  *  A task is some <em>working amount</em> that can be executed in parallel on several hosts. A task may depend on other
110  *  tasks, this means that the task cannot start until the other tasks are done. Each task has a
111  *  <em>\ref e_SD_task_state_t "state"</em> indicating whether the task is scheduled, running, done, etc.
112  *
113  *  @see SD_task_t, SD_task_dependency_management
114  *  @{
115  */
116 XBT_PUBLIC(SD_task_t) SD_task_create(const char *name, void *data, double amount);
117 XBT_PUBLIC(void *) SD_task_get_data(SD_task_t task);
118 XBT_PUBLIC(void) SD_task_set_data(SD_task_t task, void *data);
119 XBT_PUBLIC(e_SD_task_state_t) SD_task_get_state(SD_task_t task);
120 XBT_PUBLIC(const char *) SD_task_get_name(SD_task_t task);
121 XBT_PUBLIC(void) SD_task_set_name(SD_task_t task, const char *name);
122 XBT_PUBLIC(void) SD_task_set_rate(SD_task_t task, double rate);
123
124 XBT_PUBLIC(void) SD_task_watch(SD_task_t task, e_SD_task_state_t state);
125 XBT_PUBLIC(void) SD_task_unwatch(SD_task_t task, e_SD_task_state_t state);
126 XBT_PUBLIC(double) SD_task_get_amount(SD_task_t task);
127 XBT_PUBLIC(void) SD_task_set_amount(SD_task_t task, double amount);
128 XBT_PUBLIC(double) SD_task_get_alpha(SD_task_t task);
129 XBT_PUBLIC(double) SD_task_get_remaining_amount(SD_task_t task);
130 XBT_PUBLIC(double) SD_task_get_execution_time(SD_task_t task, int workstation_nb, const sg_host_t *workstation_list,
131                                               const double *flops_amount, const double *bytes_amount);
132 XBT_PUBLIC(e_SD_task_kind_t) SD_task_get_kind(SD_task_t task);
133 XBT_PUBLIC(void) SD_task_schedule(SD_task_t task, int workstation_nb, const sg_host_t *workstation_list,
134                                   const double *flops_amount, const double *bytes_amount, double rate);
135 XBT_PUBLIC(void) SD_task_unschedule(SD_task_t task);
136 XBT_PUBLIC(double) SD_task_get_start_time(SD_task_t task);
137 XBT_PUBLIC(double) SD_task_get_finish_time(SD_task_t task);
138 XBT_PUBLIC(xbt_dynar_t) SD_task_get_parents(SD_task_t task);
139 XBT_PUBLIC(xbt_dynar_t) SD_task_get_children(SD_task_t task);
140 XBT_PUBLIC(int) SD_task_get_workstation_count(SD_task_t task);
141 XBT_PUBLIC(sg_host_t *) SD_task_get_workstation_list(SD_task_t task);
142 XBT_PUBLIC(void) SD_task_destroy(SD_task_t task);
143 XBT_PUBLIC(void) SD_task_dump(SD_task_t task);
144 XBT_PUBLIC(void) SD_task_dotty(SD_task_t task, void *out_FILE);
145
146 XBT_PUBLIC(SD_task_t) SD_task_create_comp_seq(const char *name, void *data, double amount);
147 XBT_PUBLIC(SD_task_t) SD_task_create_comp_par_amdahl(const char *name, void *data, double amount, double alpha);
148 XBT_PUBLIC(SD_task_t) SD_task_create_comm_e2e(const char *name, void *data, double amount);
149 XBT_PUBLIC(SD_task_t) SD_task_create_comm_par_mxn_1d_block(const char *name, void *data, double amount);
150
151 XBT_PUBLIC(void) SD_task_distribute_comp_amdahl(SD_task_t task, int ws_count);
152 XBT_PUBLIC(void) SD_task_schedulev(SD_task_t task, int count, const sg_host_t * list);
153 XBT_PUBLIC(void) SD_task_schedulel(SD_task_t task, int count, ...);
154
155
156 /** @brief A constant to use in SD_task_schedule to mean that there is no cost.
157  *
158  *  For example, create a pure computation task (no comm) like this:
159  *
160  *  SD_task_schedule(task, my_host_count, my_host_list, my_flops_amount, SD_TASK_SCHED_NO_COST, my_rate);
161  */
162 #define SD_SCHED_NO_COST NULL
163
164 /** @} */
165
166
167 /** @defgroup SD_task_dependency_management Tasks dependencies
168  *  @brief Functions for managing the task dependencies
169  *
170  *  This section describes the functions for managing the dependencies between the tasks.
171  *
172  *  @see SD_task_management
173  *  @{
174  */
175 XBT_PUBLIC(void) SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst);
176 XBT_PUBLIC(void) SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
177 XBT_PUBLIC(const char *) SD_task_dependency_get_name(SD_task_t src, SD_task_t dst);
178 XBT_PUBLIC(void *) SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
179 XBT_PUBLIC(int) SD_task_dependency_exists(SD_task_t src, SD_task_t dst);
180 /** @} */
181
182 /************************** Global *******************************************/
183
184 /** @defgroup SD_simulation Simulation
185  *  @brief Functions for creating the environment and launching the simulation
186  *
187  *  This section describes the functions for initializing SimDag, launching the simulation and exiting SimDag.
188  *
189  *  @{
190  */
191 XBT_PUBLIC(void) SD_init(int *argc, char **argv);
192 XBT_PUBLIC(void) SD_config(const char *key, const char *value);
193 XBT_PUBLIC(void) SD_application_reinit(void);
194 XBT_PUBLIC(void) SD_create_environment(const char *platform_file);
195 XBT_PUBLIC(xbt_dynar_t) SD_simulate(double how_long);
196 XBT_PUBLIC(double) SD_get_clock(void);
197 XBT_PUBLIC(void) SD_exit(void);
198 XBT_PUBLIC(xbt_dynar_t) SD_daxload(const char *filename);
199 XBT_PUBLIC(xbt_dynar_t) SD_dotload(const char *filename);
200 XBT_PUBLIC(xbt_dynar_t) SD_PTG_dotload(const char *filename);
201 XBT_PUBLIC(xbt_dynar_t) SD_dotload_with_sched(const char *filename);
202
203 /** @} */
204
205 /* Support some backward compatibility */
206 #define SD_workstation_t sg_host_t
207
208 #define SD_link_get_name sg_link_name
209 #define SD_link_get_current_latency sg_link_latency
210 #define SD_link_get_current_bandwidth sg_link_bandwidth
211
212 #define SD_route_get_current_latency SD_route_get_latency
213 #define SD_route_get_current_bandwidth SD_route_get_bandwidth
214
215 #define SD_workstation_get_list sg_host_list
216 #define SD_workstation_get_number sg_host_count
217
218 #define SD_workstation_get_name sg_host_get_name
219 #define SD_workstation_get_by_name sg_host_by_name
220 #define SD_workstation_dump sg_host_dump
221 #define SD_workstation_get_data sg_host_user
222 #define SD_workstation_set_data sg_host_user_set
223 #define SD_workstation_get_properties sg_host_get_properties
224 #define SD_workstation_get_property_value sg_host_get_property_value
225 #define SD_workstation_get_power sg_host_speed
226 #define SD_workstation_get_available_power sg_host_get_available_speed
227
228 #define SD_workstation_get_mounted_storage_list sg_host_get_mounted_storage_list
229 // Lost functions
230 //SD_workstation_get_access_mode
231 //SD_workstation_set_access_mode
232 //SD_workstation_get_current_task
233 //SD_route_get_communication_time => SG_route_get_latency() + amount / SD_route_get_bandwidth()
234 //SD_workstation_get_computation_time => amount / sg_host_speed()
235 //TRACE_sd_set_task_category
236
237 SG_END_DECL()
238
239 #include "simgrid/instr.h"
240
241 #endif