Logo AND Algorithmique Numérique Distribuée

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