1 #ifndef SIMDAG_SIMDAG_H
2 #define SIMDAG_SIMDAG_H
4 #include "simdag/datatypes.h"
12 /************************** Link handling ***********************************/
13 /** @defgroup SD_link_management Links
14 * @brief Functions for managing the network links
16 * This section describes the functions for managing the network links.
18 * A link is a network node represented as a <em>name</em>, a <em>current
19 * bandwidth</em> and a <em>current latency</em>. The links are created
20 * when you call the function SD_create_environment.
25 XBT_PUBLIC(const SD_link_t *) SD_link_get_list(void);
26 XBT_PUBLIC(int) SD_link_get_number(void);
27 XBT_PUBLIC(void *) SD_link_get_data(SD_link_t link);
28 XBT_PUBLIC(void) SD_link_set_data(SD_link_t link, void *data);
29 XBT_PUBLIC(const char *) SD_link_get_name(SD_link_t link);
30 XBT_PUBLIC(double) SD_link_get_current_bandwidth(SD_link_t link);
31 XBT_PUBLIC(double) SD_link_get_current_latency(SD_link_t link);
32 XBT_PUBLIC(e_SD_link_sharing_policy_t) SD_link_get_sharing_policy(SD_link_t
36 /************************** Workstation handling ****************************/
38 /** @defgroup SD_workstation_management Workstations
39 * @brief Functions for managing the workstations
41 * This section describes the functions for managing the workstations.
43 * A workstation is a place where a task can be executed.
44 * A workstation is represented as a <em>physical
45 * resource with computing capabilities</em> and has a <em>name</em>.
47 * The workstations are created when you call the function SD_create_environment.
49 * @see SD_workstation_t
52 XBT_PUBLIC(SD_workstation_t) SD_workstation_get_by_name(const char *name);
53 XBT_PUBLIC(const SD_workstation_t *) SD_workstation_get_list(void);
54 XBT_PUBLIC(int) SD_workstation_get_number(void);
55 XBT_PUBLIC(void) SD_workstation_set_data(SD_workstation_t workstation,
57 XBT_PUBLIC(void *) SD_workstation_get_data(SD_workstation_t workstation);
58 XBT_PUBLIC(const char *) SD_workstation_get_name(SD_workstation_t
60 /*property handling functions*/
61 XBT_PUBLIC(xbt_dict_t) SD_workstation_get_properties(SD_workstation_t
63 XBT_PUBLIC(const char *) SD_workstation_get_property_value(SD_workstation_t
67 XBT_PUBLIC(const SD_link_t *) SD_route_get_list(SD_workstation_t src,
68 SD_workstation_t dst);
69 XBT_PUBLIC(int) SD_route_get_size(SD_workstation_t src, SD_workstation_t dst);
70 XBT_PUBLIC(double) SD_workstation_get_power(SD_workstation_t workstation);
71 XBT_PUBLIC(double) SD_workstation_get_available_power(SD_workstation_t
73 XBT_PUBLIC(e_SD_workstation_access_mode_t)
74 SD_workstation_get_access_mode(SD_workstation_t workstation);
75 XBT_PUBLIC(void) SD_workstation_set_access_mode(SD_workstation_t workstation,
76 e_SD_workstation_access_mode_t
79 XBT_PUBLIC(double) SD_workstation_get_computation_time(SD_workstation_t
83 XBT_PUBLIC(double) SD_route_get_current_latency(SD_workstation_t src,
84 SD_workstation_t dst);
85 XBT_PUBLIC(double) SD_route_get_current_bandwidth(SD_workstation_t src,
86 SD_workstation_t dst);
87 XBT_PUBLIC(double) SD_route_get_communication_time(SD_workstation_t src,
90 communication_amount);
94 /************************** Task handling ************************************/
96 /** @defgroup SD_task_management Tasks
97 * @brief Functions for managing the tasks
99 * This section describes the functions for managing the tasks.
101 * A task is some <em>working amount</em> that can be executed
102 * in parallel on several workstations. A task may depend on other
103 * tasks, this means that the task cannot start until the other tasks are done.
104 * Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether
105 * the task is scheduled, running, done, etc.
107 * @see SD_task_t, SD_task_dependency_management
110 XBT_PUBLIC(SD_task_t) SD_task_create(const char *name, void *data,
112 XBT_PUBLIC(void *) SD_task_get_data(SD_task_t task);
113 XBT_PUBLIC(void) SD_task_set_data(SD_task_t task, void *data);
114 XBT_PUBLIC(e_SD_task_state_t) SD_task_get_state(SD_task_t task);
115 XBT_PUBLIC(const char *) SD_task_get_name(SD_task_t task);
116 XBT_PUBLIC(void) SD_task_watch(SD_task_t task, e_SD_task_state_t state);
117 XBT_PUBLIC(void) SD_task_unwatch(SD_task_t task, e_SD_task_state_t state);
118 XBT_PUBLIC(double) SD_task_get_amount(SD_task_t task);
119 XBT_PUBLIC(double) SD_task_get_remaining_amount(SD_task_t task);
120 XBT_PUBLIC(double) SD_task_get_execution_time(SD_task_t task,
122 const SD_workstation_t *
123 workstation_list, const double
124 *computation_amount, const double
125 *communication_amount,
127 XBT_PUBLIC(void) SD_task_schedule(SD_task_t task, int workstation_nb,
128 const SD_workstation_t * workstation_list,
129 const double *computation_amount,
130 const double *communication_amount,
132 XBT_PUBLIC(void) SD_task_unschedule(SD_task_t task);
133 XBT_PUBLIC(double) SD_task_get_start_time(SD_task_t task);
134 XBT_PUBLIC(double) SD_task_get_finish_time(SD_task_t task);
135 XBT_PUBLIC(void) SD_task_destroy(SD_task_t task);
139 /** @defgroup SD_task_dependency_management Tasks dependencies
140 * @brief Functions for managing the task dependencies
142 * This section describes the functions for managing the dependencies between the tasks.
144 * @see SD_task_management
147 XBT_PUBLIC(void) SD_task_dependency_add(const char *name, void *data,
148 SD_task_t src, SD_task_t dst);
149 XBT_PUBLIC(void) SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
150 XBT_PUBLIC(void *) SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
151 XBT_PUBLIC(int) SD_task_dependency_exists(SD_task_t src, SD_task_t dst);
154 /************************** Global *******************************************/
156 /** @defgroup SD_simulation Simulation
157 * @brief Functions for creating the environment and launching the simulation
159 * This section describes the functions for initialising SimDag, launching
160 * the simulation and exiting SimDag.
164 XBT_PUBLIC(void) SD_init(int *argc, char **argv);
165 XBT_PUBLIC(void) SD_application_reinit(void);
166 XBT_PUBLIC(void) SD_create_environment(const char *platform_file);
167 XBT_PUBLIC(SD_task_t *) SD_simulate(double how_long);
168 XBT_PUBLIC(double) SD_get_clock(void);
169 XBT_PUBLIC(void) SD_exit(void);