Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Frederic's patch to get the sharing policy in SimDAG.
[simgrid.git] / include / simdag / simdag.h
1 #ifndef SIMDAG_SIMDAG_H
2 #define SIMDAG_SIMDAG_H
3
4 #include "simdag/datatypes.h"
5 #include "xbt/misc.h"
6 #include "xbt/dynar.h"
7 #include "xbt/dict.h"
8
9
10 SG_BEGIN_DECL()
11
12 /************************** Link handling ***********************************/
13
14 /** @defgroup SD_link_management Links
15  *  @brief Functions for managing the network links
16  * 
17  *  This section describes the functions for managing the network links.
18  *  
19  *  A link is a network node represented as a <em>name</em>, a <em>current
20  *  bandwidth</em> and a <em>current latency</em>. The links are created
21  *  when you call the function SD_create_environment.
22  *
23  *  @see SD_link_t
24  *  @{
25  */
26 XBT_PUBLIC(const SD_link_t*)   SD_link_get_list(void);
27 XBT_PUBLIC(int)                SD_link_get_number(void);
28 XBT_PUBLIC(void*)              SD_link_get_data(SD_link_t link);
29 XBT_PUBLIC(void)               SD_link_set_data(SD_link_t link, void *data);
30 XBT_PUBLIC(const char*)        SD_link_get_name(SD_link_t link);
31 XBT_PUBLIC(double)             SD_link_get_current_bandwidth(SD_link_t link);
32 XBT_PUBLIC(double)             SD_link_get_current_latency(SD_link_t link);
33 XBT_PUBLIC(e_SD_link_sharing_policy_t) SD_link_get_sharing_policy(SD_link_t link);
34 /*property handling functions*/
35 XBT_PUBLIC(xbt_dict_t) SD_link_get_properties(SD_link_t link);
36 XBT_PUBLIC(const char*) SD_link_get_property_value(SD_link_t link, const char* name);
37 /** @} */
38
39 /************************** Workstation handling ****************************/
40
41 /** @defgroup SD_workstation_management Workstations
42  *  @brief Functions for managing the workstations
43  * 
44  *  This section describes the functions for managing the workstations.
45  *  
46  *  A workstation is a place where a task can be executed.
47  *  A workstation is represented as a <em>physical
48  *  resource with computing capabilities</em> and has a <em>name</em>.
49  *
50  *  The workstations are created when you call the function SD_create_environment.
51  *
52  *  @see SD_workstation_t
53  *  @{
54  */
55 XBT_PUBLIC(SD_workstation_t)        SD_workstation_get_by_name(const char *name);
56 XBT_PUBLIC(const SD_workstation_t*) SD_workstation_get_list(void);
57 XBT_PUBLIC(int)                     SD_workstation_get_number(void);
58 XBT_PUBLIC(void)                    SD_workstation_set_data(SD_workstation_t workstation, void *data);
59 XBT_PUBLIC(void*)                   SD_workstation_get_data(SD_workstation_t workstation);
60 XBT_PUBLIC(const char*)             SD_workstation_get_name(SD_workstation_t workstation);
61 /*property handling functions*/
62 XBT_PUBLIC(xbt_dict_t) SD_workstation_get_properties(SD_workstation_t workstation);
63 XBT_PUBLIC(const char*) SD_workstation_get_property_value(SD_workstation_t workstation, const char* name);
64  
65 XBT_PUBLIC(const SD_link_t*)              SD_route_get_list(SD_workstation_t src, SD_workstation_t dst);
66 XBT_PUBLIC(int)                     SD_route_get_size(SD_workstation_t src, SD_workstation_t dst);
67 XBT_PUBLIC(double)                  SD_workstation_get_power(SD_workstation_t workstation);
68 XBT_PUBLIC(double)                  SD_workstation_get_available_power(SD_workstation_t workstation);
69 XBT_PUBLIC(e_SD_workstation_access_mode_t) SD_workstation_get_access_mode(SD_workstation_t workstation);
70 XBT_PUBLIC(void)                    SD_workstation_set_access_mode(SD_workstation_t workstation,
71                                                        e_SD_workstation_access_mode_t access_mode);
72
73 XBT_PUBLIC(double)    SD_workstation_get_computation_time(SD_workstation_t workstation, double computation_amount);
74 XBT_PUBLIC(double)    SD_route_get_current_latency(SD_workstation_t src, SD_workstation_t dst);
75 XBT_PUBLIC(double)    SD_route_get_current_bandwidth(SD_workstation_t src, SD_workstation_t dst);
76 XBT_PUBLIC(double)    SD_route_get_communication_time(SD_workstation_t src, SD_workstation_t dst,
77                                                       double communication_amount);
78
79 /** @} */
80
81 /************************** Task handling ************************************/
82
83 /** @defgroup SD_task_management Tasks
84  *  @brief Functions for managing the tasks
85  * 
86  *  This section describes the functions for managing the tasks.
87  *  
88  *  A task is some <em>working amount</em> that can be executed
89  *  in parallel on several workstations. A task may depend on other
90  *  tasks, this means that the task cannot start until the other tasks are done.
91  *  Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether
92  *  the task is scheduled, running, done, etc.
93  *  
94  *  @see SD_task_t, SD_task_dependency_management
95  *  @{
96  */
97 XBT_PUBLIC(SD_task_t)         SD_task_create(const char *name, void *data, double amount);
98 XBT_PUBLIC(void*)         SD_task_get_data(SD_task_t task);
99 XBT_PUBLIC(void)              SD_task_set_data(SD_task_t task, void *data);
100 XBT_PUBLIC(e_SD_task_state_t) SD_task_get_state(SD_task_t task);
101 XBT_PUBLIC(const char*)       SD_task_get_name(SD_task_t task);
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(double)            SD_task_get_remaining_amount(SD_task_t task);
106 XBT_PUBLIC(double)            SD_task_get_execution_time(SD_task_t task, int workstation_nb,
107                                              const SD_workstation_t *workstation_list,
108                                              const double *computation_amount, const double *communication_amount,
109                                              double rate);
110 XBT_PUBLIC(void)              SD_task_schedule(SD_task_t task, int workstation_nb,
111                                    const SD_workstation_t *workstation_list, const double *computation_amount,
112                                    const double *communication_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(void)              SD_task_destroy(SD_task_t task);
117 /** @} */
118
119
120 /** @defgroup SD_task_dependency_management Tasks dependencies
121  *  @brief Functions for managing the task dependencies
122  *
123  *  This section describes the functions for managing the dependencies between the tasks.
124  *
125  *  @see SD_task_management
126  *  @{
127  */
128 XBT_PUBLIC(void)              SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst);
129 XBT_PUBLIC(void)              SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
130 XBT_PUBLIC(void*)             SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
131 XBT_PUBLIC(int)               SD_task_dependency_exists(SD_task_t src, SD_task_t dst);
132 /** @} */
133
134 /************************** Global *******************************************/
135
136 /** @defgroup SD_simulation Simulation
137  *  @brief Functions for creating the environment and launching the simulation
138  * 
139  *  This section describes the functions for initialising SimDag, launching
140  *  the simulation and exiting SimDag.
141  *  
142  *  @{
143  */
144 XBT_PUBLIC(void)              SD_init(int *argc, char **argv);
145 XBT_PUBLIC(void)              SD_application_reinit(void);
146 XBT_PUBLIC(void)              SD_create_environment(const char *platform_file);
147 XBT_PUBLIC(SD_task_t*)        SD_simulate(double how_long);
148 XBT_PUBLIC(double)            SD_get_clock(void);
149 XBT_PUBLIC(void)              SD_exit(void);
150 /** @} */
151
152 SG_END_DECL()
153
154 #endif