Logo AND Algorithmique Numérique Distribuée

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