Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
154c19510d63522b819366610b919820bd79ebf8
[simgrid.git] / include / simgrid / msg.h
1 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #ifndef SIMGRID_MSG_H
7 #define SIMGRID_MSG_H
8
9 #include <simgrid/actor.h>
10 #include <simgrid/barrier.h>
11 #include <simgrid/engine.h>
12 #include <simgrid/forward.h>
13 #include <simgrid/host.h>
14 #include <simgrid/instr.h>
15 #include <simgrid/mailbox.h>
16 #include <simgrid/plugins/live_migration.h>
17 #include <simgrid/storage.h>
18 #include <simgrid/vm.h>
19 #include <simgrid/zone.h>
20 #include <xbt.h>
21
22 #ifndef MIN
23 #define MIN(a, b) ((a) < (b) ? (a) : (b))
24 #endif
25 #ifndef MAX
26 #define MAX(a, b) ((a) > (b) ? (a) : (b))
27 #endif
28
29 #ifdef __cplusplus
30 #include <map>
31 #include <simgrid/simix.h>
32 namespace simgrid {
33 namespace msg {
34 class Comm;
35 }
36 }
37 typedef simgrid::msg::Comm sg_msg_Comm;
38 #else
39 typedef struct msg_Comm sg_msg_Comm;
40 #endif
41
42 SG_BEGIN_DECL()
43
44 /* *************************** Network Zones ******************************** */
45 #define msg_as_t msg_netzone_t /* portability macro */
46 typedef sg_netzone_t msg_netzone_t;
47
48 XBT_PUBLIC msg_netzone_t MSG_zone_get_root();
49 XBT_PUBLIC const char* MSG_zone_get_name(msg_netzone_t zone);
50 XBT_PUBLIC msg_netzone_t MSG_zone_get_by_name(const char* name);
51 XBT_PUBLIC void MSG_zone_get_sons(msg_netzone_t zone, xbt_dict_t whereto);
52 XBT_PUBLIC const char* MSG_zone_get_property_value(msg_netzone_t zone, const char* name);
53 XBT_PUBLIC void MSG_zone_set_property_value(msg_netzone_t zone, const char* name, char* value);
54 XBT_PUBLIC void MSG_zone_get_hosts(msg_netzone_t zone, xbt_dynar_t whereto);
55
56 /* ******************************** Hosts ************************************ */
57 typedef sg_host_t msg_host_t;
58
59 XBT_PUBLIC size_t MSG_get_host_number();
60 XBT_PUBLIC sg_host_t MSG_get_host_by_name(const char* name);
61 XBT_PUBLIC sg_host_t MSG_host_by_name(const char* name);
62
63 XBT_PUBLIC xbt_dynar_t MSG_hosts_as_dynar();
64
65 XBT_PUBLIC const char* MSG_host_get_name(sg_host_t host);
66 XBT_PUBLIC void* MSG_host_get_data(sg_host_t host);
67 XBT_PUBLIC void MSG_host_set_data(sg_host_t host, void* data);
68 XBT_PUBLIC xbt_dict_t MSG_host_get_mounted_storage_list(sg_host_t host);
69 XBT_PUBLIC xbt_dynar_t MSG_host_get_attached_storage_lists(sg_host_t host);
70 XBT_PUBLIC double MSG_host_get_speed(sg_host_t host);
71 XBT_PUBLIC double MSG_host_get_power_peak_at(sg_host_t host, int pstate_index);
72 XBT_PUBLIC int MSG_host_get_core_number(sg_host_t host);
73 XBT_PUBLIC int MSG_host_get_nb_pstates(sg_host_t host);
74 XBT_PUBLIC int MSG_host_get_pstate(sg_host_t host);
75 XBT_PUBLIC void MSG_host_set_pstate(sg_host_t host, int pstate);
76 XBT_PUBLIC void MSG_host_on(sg_host_t h);
77 XBT_PUBLIC void MSG_host_off(sg_host_t h);
78 XBT_PUBLIC int MSG_host_is_on(sg_host_t h);
79 XBT_PUBLIC int MSG_host_is_off(sg_host_t h);
80 XBT_PUBLIC xbt_dict_t MSG_host_get_properties(sg_host_t host);
81 XBT_PUBLIC const char* MSG_host_get_property_value(sg_host_t host, const char* name);
82 XBT_PUBLIC void MSG_host_set_property_value(sg_host_t host, const char* name, const char* value);
83 XBT_PUBLIC void MSG_host_get_process_list(sg_host_t host, xbt_dynar_t whereto);
84
85 XBT_PUBLIC sg_host_t MSG_host_self();
86
87 /* ******************************** VMs ************************************* */
88 typedef sg_vm_t msg_vm_t;
89
90 XBT_ATTRIB_DEPRECATED_v322("Use sg_vm_create_migratable() from the live migration plugin: "
91                            "v3.22 will drop MSG_vm_create() completely.") XBT_PUBLIC sg_vm_t
92     MSG_vm_create(sg_host_t ind_pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity);
93
94 XBT_PUBLIC msg_vm_t MSG_vm_create_core(msg_host_t pm, const char* name);
95 XBT_PUBLIC msg_vm_t MSG_vm_create_multicore(msg_host_t pm, const char* name, int coreAmount);
96
97 XBT_PUBLIC int MSG_vm_is_created(msg_vm_t vm);
98 XBT_PUBLIC int MSG_vm_is_running(msg_vm_t vm);
99 XBT_PUBLIC int MSG_vm_is_suspended(msg_vm_t vm);
100
101 XBT_PUBLIC const char* MSG_vm_get_name(msg_vm_t vm);
102 XBT_PUBLIC void MSG_vm_set_ramsize(msg_vm_t vm, size_t size);
103 XBT_PUBLIC size_t MSG_vm_get_ramsize(msg_vm_t vm);
104 XBT_PUBLIC msg_host_t MSG_vm_get_pm(msg_vm_t vm);
105 XBT_PUBLIC void MSG_vm_set_bound(msg_vm_t vm, double bound);
106
107 XBT_PUBLIC void MSG_vm_start(msg_vm_t vm);
108 XBT_PUBLIC void MSG_vm_suspend(msg_vm_t vm);
109 XBT_PUBLIC void MSG_vm_resume(msg_vm_t vm);
110 XBT_PUBLIC void MSG_vm_shutdown(msg_vm_t vm);
111 XBT_PUBLIC void MSG_vm_destroy(msg_vm_t vm);
112
113 /* ******************************** Storage ********************************* */
114 typedef sg_storage_t msg_storage_t;
115
116 XBT_PUBLIC const char* MSG_storage_get_name(msg_storage_t storage);
117 XBT_PUBLIC msg_storage_t MSG_storage_get_by_name(const char* name);
118 XBT_PUBLIC xbt_dict_t MSG_storage_get_properties(msg_storage_t storage);
119 XBT_PUBLIC void MSG_storage_set_property_value(msg_storage_t storage, const char* name, const char* value);
120 XBT_PUBLIC const char* MSG_storage_get_property_value(msg_storage_t storage, const char* name);
121 XBT_PUBLIC xbt_dynar_t MSG_storages_as_dynar();
122 XBT_PUBLIC void MSG_storage_set_data(msg_storage_t storage, void* data);
123 XBT_PUBLIC void* MSG_storage_get_data(msg_storage_t storage);
124 XBT_PUBLIC const char* MSG_storage_get_host(msg_storage_t storage);
125 XBT_PUBLIC sg_size_t MSG_storage_read(msg_storage_t storage, sg_size_t size);
126 XBT_PUBLIC sg_size_t MSG_storage_write(msg_storage_t storage, sg_size_t size);
127
128 /* ******************************** Actor/process *************************** */
129 typedef sg_actor_t msg_process_t;
130
131 XBT_PUBLIC int MSG_process_get_PID(msg_process_t process);
132 XBT_PUBLIC int MSG_process_get_PPID(msg_process_t process);
133 XBT_PUBLIC sg_actor_t MSG_process_from_PID(int pid);
134 XBT_PUBLIC const char* MSG_process_get_name(msg_process_t process);
135 XBT_PUBLIC sg_host_t MSG_process_get_host(msg_process_t process);
136
137 /*property handlers*/
138 XBT_PUBLIC xbt_dict_t MSG_process_get_properties(msg_process_t process);
139 XBT_PUBLIC const char* MSG_process_get_property_value(msg_process_t process, const char* name);
140
141 XBT_PUBLIC void MSG_process_suspend(msg_process_t process);
142 XBT_PUBLIC void MSG_process_resume(msg_process_t process);
143 XBT_PUBLIC int MSG_process_is_suspended(msg_process_t process);
144 XBT_PUBLIC void MSG_process_restart(msg_process_t process);
145 XBT_PUBLIC void MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
146 XBT_PUBLIC void MSG_process_daemonize(msg_process_t process);
147 XBT_PUBLIC void MSG_process_migrate(msg_process_t process, msg_host_t host);
148 XBT_PUBLIC void MSG_process_join(msg_process_t process, double timeout);
149 XBT_PUBLIC void MSG_process_kill(msg_process_t process);
150 XBT_PUBLIC void MSG_process_killall();
151 XBT_PUBLIC void MSG_process_set_kill_time(msg_process_t process, double kill_time);
152 XBT_PUBLIC void MSG_process_yield();
153
154 /**
155  * @brief @brief Communication action.
156  * @ingroup msg_task_usage
157  *
158  * Object representing an ongoing communication between processes. Such beast is usually obtained by using
159  * #MSG_task_isend, #MSG_task_irecv or friends.
160  */
161 typedef sg_msg_Comm* msg_comm_t;
162
163 /* ******************************** Task ************************************ */
164
165 typedef struct s_simdata_task_t* simdata_task_t;
166
167 typedef struct msg_task {
168   char* name;             /**< @brief task name if any */
169   simdata_task_t simdata; /**< @brief simulator data */
170   void* data;             /**< @brief user data */
171   long long int counter;  /* task unique identifier for instrumentation */
172   char* category;         /* task category for instrumentation */
173 } s_msg_task_t;
174
175 /** @brief Task datatype.
176     @ingroup m_task_management
177
178     A <em>task</em> may then be defined by a <em>computing
179     amount</em>, a <em>message size</em> and some <em>private
180     data</em>.
181  */
182
183 typedef struct msg_task* msg_task_t;
184
185 /** @brief Default value for an uninitialized #msg_task_t.
186     @ingroup m_task_management
187 */
188 #define MSG_TASK_UNINITIALIZED NULL
189
190 /** @brief Return code of most MSG functions
191     @ingroup msg_simulation
192     @{ */
193 /* Keep these code as binary values: java bindings manipulate | of these values */
194 typedef enum {
195   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
196   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
197   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
198       transfer. Either the network is down or the remote host has been
199       shutdown. */
200   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
201       running has just been rebooted. Free your datastructures and
202       return now !*/
203   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
204 } msg_error_t;
205 /** @} */
206
207 /************************** Global ******************************************/
208 XBT_PUBLIC void MSG_config(const char* key, const char* value);
209 /** @ingroup msg_simulation
210  *  @brief Initialize the MSG internal data.
211  *  @hideinitializer
212  *
213  *  It also check that the link-time and compile-time versions of SimGrid do
214  *  match, so you should use this version instead of the #MSG_init_nocheck
215  *  function that does the same initializations, but without this check.
216  *
217  *  We allow to link against compiled versions that differ in the patch level.
218  */
219 #define MSG_init(argc, argv)                                                                                           \
220   do {                                                                                                                 \
221     sg_version_check(SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR, SIMGRID_VERSION_PATCH);                             \
222     MSG_init_nocheck(argc, argv);                                                                                      \
223   } while (0)
224
225 XBT_PUBLIC void MSG_init_nocheck(int* argc, char** argv);
226 XBT_PUBLIC msg_error_t MSG_main();
227 XBT_PUBLIC void MSG_function_register(const char* name, xbt_main_func_t code);
228 XBT_PUBLIC void MSG_function_register_default(xbt_main_func_t code);
229 XBT_PUBLIC void MSG_create_environment(const char* file);
230 XBT_PUBLIC void MSG_launch_application(const char* file);
231 /*Bypass the parser */
232 XBT_PUBLIC void MSG_set_function(const char* host_id, const char* function_name, xbt_dynar_t arguments);
233
234 XBT_PUBLIC double MSG_get_clock();
235 XBT_PUBLIC unsigned long int MSG_get_sent_msg();
236
237 /************************** Process handling *********************************/
238 XBT_PUBLIC msg_process_t MSG_process_create(const char* name, xbt_main_func_t code, void* data, msg_host_t host);
239 XBT_PUBLIC msg_process_t MSG_process_create_with_arguments(const char* name, xbt_main_func_t code, void* data,
240                                                            msg_host_t host, int argc, char** argv);
241 XBT_PUBLIC msg_process_t MSG_process_create_with_environment(const char* name, xbt_main_func_t code, void* data,
242                                                              msg_host_t host, int argc, char** argv,
243                                                              xbt_dict_t properties);
244
245 XBT_PUBLIC msg_process_t MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties);
246 XBT_PUBLIC void MSG_process_detach();
247
248 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
249 XBT_PUBLIC int MSG_process_self_PID();
250 XBT_PUBLIC int MSG_process_self_PPID();
251 XBT_PUBLIC const char* MSG_process_self_name();
252 XBT_PUBLIC msg_process_t MSG_process_self();
253 XBT_PUBLIC xbt_dynar_t MSG_processes_as_dynar();
254 XBT_PUBLIC int MSG_process_get_number();
255
256 XBT_PUBLIC void* MSG_process_get_data(msg_process_t process);
257 XBT_PUBLIC msg_error_t MSG_process_set_data(msg_process_t process, void* data);
258
259 XBT_PUBLIC void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void* data);
260
261 XBT_PUBLIC void MSG_process_ref(msg_process_t process);
262 XBT_PUBLIC void MSG_process_unref(msg_process_t process);
263
264 /************************** Task handling ************************************/
265 XBT_PUBLIC msg_task_t MSG_task_create(const char* name, double flops_amount, double bytes_amount, void* data);
266 XBT_PUBLIC msg_task_t MSG_parallel_task_create(const char* name, int host_nb, const msg_host_t* host_list,
267                                                double* flops_amount, double* bytes_amount, void* data);
268 XBT_PUBLIC void* MSG_task_get_data(msg_task_t task);
269 XBT_PUBLIC void MSG_task_set_data(msg_task_t task, void* data);
270 XBT_PUBLIC void MSG_task_set_copy_callback(void (*callback)(msg_task_t task, msg_process_t src, msg_process_t dst));
271 XBT_PUBLIC msg_process_t MSG_task_get_sender(msg_task_t task);
272 XBT_PUBLIC msg_host_t MSG_task_get_source(msg_task_t task);
273 XBT_PUBLIC const char* MSG_task_get_name(msg_task_t task);
274 XBT_PUBLIC void MSG_task_set_name(msg_task_t task, const char* name);
275 XBT_PUBLIC msg_error_t MSG_task_cancel(msg_task_t task);
276 XBT_PUBLIC msg_error_t MSG_task_destroy(msg_task_t task);
277
278 XBT_PUBLIC msg_error_t MSG_task_execute(msg_task_t task);
279 XBT_PUBLIC msg_error_t MSG_parallel_task_execute(msg_task_t task);
280 XBT_PUBLIC msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout);
281 XBT_PUBLIC void MSG_task_set_priority(msg_task_t task, double priority);
282 XBT_PUBLIC void MSG_task_set_bound(msg_task_t task, double bound);
283
284 XBT_PUBLIC msg_error_t MSG_process_sleep(double nb_sec);
285
286 XBT_PUBLIC void MSG_task_set_flops_amount(msg_task_t task, double flops_amount);
287 XBT_PUBLIC double MSG_task_get_flops_amount(msg_task_t task);
288 XBT_PUBLIC double MSG_task_get_remaining_work_ratio(msg_task_t task);
289 XBT_PUBLIC void MSG_task_set_bytes_amount(msg_task_t task, double bytes_amount);
290
291 XBT_PUBLIC double MSG_task_get_remaining_communication(msg_task_t task);
292 XBT_PUBLIC double MSG_task_get_bytes_amount(msg_task_t task);
293
294 XBT_PUBLIC msg_error_t MSG_task_receive_ext(msg_task_t* task, const char* alias, double timeout, msg_host_t host);
295
296 XBT_PUBLIC msg_error_t MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, double timeout);
297
298 XBT_PUBLIC msg_error_t MSG_task_receive(msg_task_t* task, const char* alias);
299 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
300
301 XBT_PUBLIC msg_error_t MSG_task_receive_ext_bounded(msg_task_t* task, const char* alias, double timeout,
302                                                     msg_host_t host, double rate);
303
304 XBT_PUBLIC msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t* task, const char* alias, double timeout,
305                                                              double rate);
306 XBT_PUBLIC msg_error_t MSG_task_receive_bounded(msg_task_t* task, const char* alias, double rate);
307 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
308
309 XBT_PUBLIC msg_comm_t MSG_task_isend(msg_task_t task, const char* alias);
310 XBT_PUBLIC msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char* alias, double maxrate);
311
312 XBT_PUBLIC void MSG_task_dsend(msg_task_t task, const char* alias, void_f_pvoid_t cleanup);
313 XBT_PUBLIC void MSG_task_dsend_bounded(msg_task_t task, const char* alias, void_f_pvoid_t cleanup, double maxrate);
314 XBT_PUBLIC msg_comm_t MSG_task_irecv(msg_task_t* task, const char* alias);
315 XBT_PUBLIC msg_comm_t MSG_task_irecv_bounded(msg_task_t* task, const char* alias, double rate);
316 XBT_PUBLIC int MSG_comm_test(msg_comm_t comm);
317 XBT_PUBLIC int MSG_comm_testany(xbt_dynar_t comms);
318 XBT_PUBLIC void MSG_comm_destroy(msg_comm_t comm);
319 XBT_PUBLIC msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout);
320 XBT_PUBLIC void MSG_comm_waitall(msg_comm_t* comm, int nb_elem, double timeout);
321 XBT_PUBLIC int MSG_comm_waitany(xbt_dynar_t comms);
322 XBT_PUBLIC msg_task_t MSG_comm_get_task(msg_comm_t comm);
323 XBT_PUBLIC msg_error_t MSG_comm_get_status(msg_comm_t comm);
324
325 XBT_PUBLIC int MSG_task_listen(const char* alias);
326 XBT_PUBLIC msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char* alias, double timeout);
327 XBT_PUBLIC msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char* alias, double timeout,
328                                                           double maxrate);
329 XBT_PUBLIC msg_error_t MSG_task_send(msg_task_t task, const char* alias);
330 XBT_PUBLIC msg_error_t MSG_task_send_bounded(msg_task_t task, const char* alias, double rate);
331 XBT_PUBLIC int MSG_task_listen_from(const char* alias);
332 XBT_PUBLIC void MSG_task_set_category(msg_task_t task, const char* category);
333 XBT_PUBLIC const char* MSG_task_get_category(msg_task_t task);
334
335 /************************** Mailbox handling ************************************/
336
337 /* @brief MSG_mailbox_set_async - set a mailbox as eager
338  * Sets the mailbox to a permanent receiver mode. Messages sent to this mailbox will then be sent just after the send
339  * is issued, without waiting for the corresponding receive.
340  * This call should be done before issuing any receive, and on the receiver's side only
341  * @param alias    The alias of the mailbox to modify.
342  */
343 XBT_PUBLIC void MSG_mailbox_set_async(const char* alias);
344
345 /** @brief Opaque type representing a semaphore
346  *  @ingroup msg_synchro
347  *  @hideinitializer
348  */
349 typedef struct s_smx_sem_t* msg_sem_t; // Yeah that's a rename of the smx_sem_t which doesnt require smx_sem_t to be
350                                        // declared here
351 XBT_PUBLIC msg_sem_t MSG_sem_init(int initial_value);
352 XBT_PUBLIC void MSG_sem_acquire(msg_sem_t sem);
353 XBT_PUBLIC msg_error_t MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
354 XBT_PUBLIC void MSG_sem_release(msg_sem_t sem);
355 XBT_PUBLIC int MSG_sem_get_capacity(msg_sem_t sem);
356 XBT_PUBLIC void MSG_sem_destroy(msg_sem_t sem);
357 XBT_PUBLIC int MSG_sem_would_block(msg_sem_t sem);
358
359 typedef sg_bar_t msg_bar_t;
360 XBT_PUBLIC msg_bar_t MSG_barrier_init(unsigned int count);
361 XBT_PUBLIC void MSG_barrier_destroy(msg_bar_t bar);
362 XBT_PUBLIC int MSG_barrier_wait(msg_bar_t bar);
363
364 /* ****************************************************************************************** */
365 /* DO NOT USE this nasty pimple (unless if you're writing a binding) */
366 XBT_PUBLIC smx_context_t
367 XBT_ATTRIB_DEPRECATED_v323("MSG_process_get_smx_ctx is deprecated. Please contact us if you need it.")
368 MSG_process_get_smx_ctx(msg_process_t process);
369
370 SG_END_DECL()
371
372 #ifdef __cplusplus
373 XBT_PUBLIC msg_process_t MSG_process_create_from_stdfunc(std::string name, std::function<void()> code, void* data,
374                                                          msg_host_t host,
375                                                          std::unordered_map<std::string, std::string>* properties);
376 #endif
377
378 #endif