Logo AND Algorithmique Numérique Distribuée

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