1 /* Copyright (c) 2006-2010, 2012-2014. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #ifndef SIMDAG_SIMDAG_H
8 #define SIMDAG_SIMDAG_H
10 #include "simdag/datatypes.h"
12 #include "xbt/dynar.h"
18 /************************** AS handling *************************************/
19 XBT_PUBLIC(xbt_dict_t) SD_as_router_get_properties(const char *as);
20 XBT_PUBLIC(const char*) SD_as_router_get_property_value(const char * as,
23 /************************** Link handling ***********************************/
24 /** @defgroup SD_link_management Links
25 * @brief Functions for managing the network links
27 * This section describes the functions for managing the network links.
29 * A link is a network node represented as a <em>name</em>, a <em>current
30 * bandwidth</em> and a <em>current latency</em>. The links are created
31 * when you call the function SD_create_environment.
36 XBT_PUBLIC(const SD_link_t *) SD_link_get_list(void);
37 XBT_PUBLIC(int) SD_link_get_number(void);
38 XBT_PUBLIC(void *) SD_link_get_data(SD_link_t link);
39 XBT_PUBLIC(void) SD_link_set_data(SD_link_t link, void *data);
40 XBT_PUBLIC(const char *) SD_link_get_name(SD_link_t link);
41 XBT_PUBLIC(double) SD_link_get_current_bandwidth(SD_link_t link);
42 XBT_PUBLIC(double) SD_link_get_current_latency(SD_link_t link);
43 XBT_PUBLIC(e_SD_link_sharing_policy_t) SD_link_get_sharing_policy(SD_link_t
47 /************************** Workstation handling ****************************/
49 /** @defgroup SD_workstation_management Workstations
50 * @brief Functions for managing the workstations
52 * This section describes the functions for managing the workstations.
54 * A workstation is a place where a task can be executed.
55 * A workstation is represented as a <em>physical
56 * resource with computing capabilities</em> and has a <em>name</em>.
58 * The workstations are created when you call the function SD_create_environment.
60 * @see SD_workstation_t
63 XBT_PUBLIC(SD_workstation_t) SD_workstation_get_by_name(const char *name);
64 XBT_PUBLIC(const SD_workstation_t *) SD_workstation_get_list(void);
65 XBT_PUBLIC(int) SD_workstation_get_number(void);
66 XBT_PUBLIC(void) SD_workstation_set_data(SD_workstation_t workstation,
68 XBT_PUBLIC(void *) SD_workstation_get_data(SD_workstation_t workstation);
69 XBT_PUBLIC(const char *) SD_workstation_get_name(SD_workstation_t
71 /*property handling functions*/
72 XBT_PUBLIC(xbt_dict_t) SD_workstation_get_properties(SD_workstation_t
74 XBT_PUBLIC(const char *) SD_workstation_get_property_value(SD_workstation_t
78 XBT_PUBLIC(void) SD_workstation_dump(SD_workstation_t ws);
79 XBT_PUBLIC(const SD_link_t *) SD_route_get_list(SD_workstation_t src,
80 SD_workstation_t dst);
81 XBT_PUBLIC(int) SD_route_get_size(SD_workstation_t src,
82 SD_workstation_t dst);
83 XBT_PUBLIC(double) SD_workstation_get_power(SD_workstation_t workstation);
84 XBT_PUBLIC(double) SD_workstation_get_available_power(SD_workstation_t
86 XBT_PUBLIC(e_SD_workstation_access_mode_t)
87 SD_workstation_get_access_mode(SD_workstation_t workstation);
88 XBT_PUBLIC(void) SD_workstation_set_access_mode(SD_workstation_t
90 e_SD_workstation_access_mode_t
93 XBT_PUBLIC(double) SD_workstation_get_computation_time(SD_workstation_t
97 XBT_PUBLIC(double) SD_route_get_current_latency(SD_workstation_t src,
98 SD_workstation_t dst);
99 XBT_PUBLIC(double) SD_route_get_current_bandwidth(SD_workstation_t src,
100 SD_workstation_t dst);
101 XBT_PUBLIC(double) SD_route_get_communication_time(SD_workstation_t src,
102 SD_workstation_t dst,
104 communication_amount);
106 XBT_PUBLIC(SD_task_t) SD_workstation_get_current_task(SD_workstation_t
108 XBT_PUBLIC(xbt_dict_t)
109 SD_workstation_get_mounted_storage_list(SD_workstation_t workstation);
110 XBT_PUBLIC(xbt_dict_t)
111 SD_workstation_get_attached_storage_list(SD_workstation_t workstation);
114 /************************** Task handling ************************************/
116 /** @defgroup SD_task_management Tasks
117 * @brief Functions for managing the tasks
119 * This section describes the functions for managing the tasks.
121 * A task is some <em>working amount</em> that can be executed
122 * in parallel on several workstations. A task may depend on other
123 * tasks, this means that the task cannot start until the other tasks are done.
124 * Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether
125 * the task is scheduled, running, done, etc.
127 * @see SD_task_t, SD_task_dependency_management
130 XBT_PUBLIC(SD_task_t) SD_task_create(const char *name, void *data,
132 XBT_PUBLIC(void *) SD_task_get_data(SD_task_t task);
133 XBT_PUBLIC(void) SD_task_set_data(SD_task_t task, void *data);
134 XBT_PUBLIC(e_SD_task_state_t) SD_task_get_state(SD_task_t task);
135 XBT_PUBLIC(const char *) SD_task_get_name(SD_task_t task);
136 XBT_PUBLIC(void) SD_task_set_name(SD_task_t task, const char *name);
137 XBT_PUBLIC(void) SD_task_set_rate(SD_task_t task, double rate);
139 XBT_PUBLIC(void) SD_task_watch(SD_task_t task, e_SD_task_state_t state);
140 XBT_PUBLIC(void) SD_task_unwatch(SD_task_t task, e_SD_task_state_t state);
141 XBT_PUBLIC(double) SD_task_get_amount(SD_task_t task);
142 XBT_PUBLIC(void) SD_task_set_amount(SD_task_t task, double amount);
143 XBT_PUBLIC(double) SD_task_get_alpha(SD_task_t task);
144 XBT_PUBLIC(double) SD_task_get_remaining_amount(SD_task_t task);
145 XBT_PUBLIC(double) SD_task_get_execution_time(SD_task_t task,
147 const SD_workstation_t *
150 *computation_amount, const double
151 *communication_amount);
152 XBT_PUBLIC(int) SD_task_get_kind(SD_task_t task);
153 XBT_PUBLIC(void) SD_task_schedule(SD_task_t task, int workstation_nb,
154 const SD_workstation_t *
156 const double *computation_amount,
157 const double *communication_amount,
159 XBT_PUBLIC(void) SD_task_unschedule(SD_task_t task);
160 XBT_PUBLIC(double) SD_task_get_start_time(SD_task_t task);
161 XBT_PUBLIC(double) SD_task_get_finish_time(SD_task_t task);
162 XBT_PUBLIC(xbt_dynar_t) SD_task_get_parents(SD_task_t task);
163 XBT_PUBLIC(xbt_dynar_t) SD_task_get_children(SD_task_t task);
164 XBT_PUBLIC(int) SD_task_get_workstation_count(SD_task_t task);
165 XBT_PUBLIC(SD_workstation_t *) SD_task_get_workstation_list(SD_task_t
167 XBT_PUBLIC(void) SD_task_destroy(SD_task_t task);
168 XBT_PUBLIC(void) SD_task_dump(SD_task_t task);
169 XBT_PUBLIC(void) SD_task_dotty(SD_task_t task, void *out_FILE);
171 XBT_PUBLIC(SD_task_t) SD_task_create_comp_seq(const char *name, void *data,
173 XBT_PUBLIC(SD_task_t) SD_task_create_comp_par_amdahl(const char *name,
177 XBT_PUBLIC(SD_task_t) SD_task_create_comm_e2e(const char *name, void *data,
179 XBT_PUBLIC(SD_task_t) SD_task_create_comm_par_mxn_1d_block(const char *name,
183 XBT_PUBLIC(void) SD_task_distribute_comp_amdahl(SD_task_t task, int ws_count);
184 XBT_PUBLIC(void) SD_task_schedulev(SD_task_t task, int count,
185 const SD_workstation_t * list);
186 XBT_PUBLIC(void) SD_task_schedulel(SD_task_t task, int count, ...);
189 /** @brief A constant to use in SD_task_schedule to mean that there is no cost.
191 * For example, create a pure computation task (no comm) like this:
193 * SD_task_schedule(task, my_workstation_nb,
194 * my_workstation_list,
195 * my_computation_amount,
196 * SD_TASK_SCHED_NO_COST,
199 #define SD_SCHED_NO_COST NULL
204 /** @defgroup SD_task_dependency_management Tasks dependencies
205 * @brief Functions for managing the task dependencies
207 * This section describes the functions for managing the dependencies between the tasks.
209 * @see SD_task_management
212 XBT_PUBLIC(void) SD_task_dependency_add(const char *name, void *data,
213 SD_task_t src, SD_task_t dst);
214 XBT_PUBLIC(void) SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
215 XBT_PUBLIC(const char *) SD_task_dependency_get_name(SD_task_t src,
217 XBT_PUBLIC(void *) SD_task_dependency_get_data(SD_task_t src,
219 XBT_PUBLIC(int) SD_task_dependency_exists(SD_task_t src, SD_task_t dst);
222 /************************** Global *******************************************/
224 /** @defgroup SD_simulation Simulation
225 * @brief Functions for creating the environment and launching the simulation
227 * This section describes the functions for initialising SimDag, launching
228 * the simulation and exiting SimDag.
232 XBT_PUBLIC(void) SD_init(int *argc, char **argv);
233 XBT_PUBLIC(void) SD_config(const char *key, const char *value);
234 XBT_PUBLIC(void) SD_application_reinit(void);
235 XBT_PUBLIC(void) SD_create_environment(const char *platform_file);
236 XBT_PUBLIC(xbt_dynar_t) SD_simulate(double how_long);
237 XBT_PUBLIC(double) SD_get_clock(void);
238 XBT_PUBLIC(void) SD_exit(void);
239 XBT_PUBLIC(xbt_dynar_t) SD_daxload(const char *filename);
240 XBT_PUBLIC(xbt_dynar_t) SD_dotload(const char *filename);
241 XBT_PUBLIC(xbt_dynar_t) SD_PTG_dotload(const char *filename);
242 XBT_PUBLIC(xbt_dynar_t) SD_dotload_with_sched(const char *filename);
243 XBT_PUBLIC(void) uniq_transfer_task_name(SD_task_t task);
247 #include "instr/instr.h"