1 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */
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. */
9 #include <simgrid/forward.h>
10 #include <simgrid/host.h>
11 #include <simgrid/instr.h>
12 #include <simgrid/plugins/live_migration.h>
13 #include <simgrid/vm.h>
16 #include <xbt/dynar.h>
20 #include <simgrid/simix.h>
26 typedef simgrid::msg::Comm sg_msg_Comm;
28 typedef struct msg_Comm sg_msg_Comm;
33 /* *************************** Network Zones ******************************** */
34 #define msg_as_t msg_netzone_t /* portability macro */
35 typedef sg_netzone_t msg_netzone_t;
37 /* ******************************** Host ************************************ */
39 typedef sg_host_t msg_host_t;
41 #define MSG_get_host_number() sg_host_count()
42 #define MSG_get_host_by_name(n) sg_host_by_name(n) /* Rewrite the old name into the new one transparently */
44 #define MSG_hosts_as_dynar() sg_hosts_as_dynar()
46 #define MSG_host_by_name(name) sg_host_by_name(name)
47 #define MSG_host_get_name(host) sg_host_get_name(host)
48 #define MSG_host_get_data(host) sg_host_user(host)
49 #define MSG_host_set_data(host, data) sg_host_user_set(host, data)
50 #define MSG_host_get_mounted_storage_list(host) sg_host_get_mounted_storage_list(host)
51 #define MSG_host_get_attached_storage_list(host) host_get_attached_storage_list(host)
52 #define MSG_host_get_speed(host) sg_host_speed(host)
53 #define MSG_host_get_power_peak_at(host, pstate_index) sg_host_get_pstate_speed(host, pstate_index)
54 #define MSG_host_get_core_number(host) sg_host_core_count(host)
55 #define MSG_host_self() sg_host_self()
56 #define MSG_host_get_nb_pstates(host) sg_host_get_nb_pstates(host)
57 #define MSG_host_get_pstate(h) sg_host_get_pstate(h)
58 #define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate)
59 #define MSG_host_on(h) sg_host_turn_on(h)
60 #define MSG_host_off(h) sg_host_turn_off(h)
61 #define MSG_host_is_on(h) sg_host_is_on(h)
62 #define MSG_host_is_off(h) sg_host_is_off(h)
63 #define MSG_host_get_properties(host) sg_host_get_properties(host)
64 #define MSG_host_get_property_value(host, name) sg_host_get_property_value(host, name)
65 #define MSG_host_set_property_value(host, name, value) sg_host_set_property_value(host, name, value)
66 #define MSG_host_get_process_list(host, whereto) sg_host_get_actor_list(host, whereto)
68 XBT_PUBLIC_DATA int sg_storage_max_file_descriptors;
69 /* ******************************** Task ************************************ */
71 typedef struct s_simdata_task_t* simdata_task_t;
73 typedef struct msg_task {
74 char *name; /**< @brief task name if any */
75 simdata_task_t simdata; /**< @brief simulator data */
76 void *data; /**< @brief user data */
77 long long int counter; /* task unique identifier for instrumentation */
78 char *category; /* task category for instrumentation */
81 /** @brief Task datatype.
82 @ingroup m_task_management
84 A <em>task</em> may then be defined by a <em>computing
85 amount</em>, a <em>message size</em> and some <em>private
88 typedef struct msg_task *msg_task_t;
90 /* ******************************** VM ************************************* */
91 typedef sg_vm_t msg_vm_t;
93 #define MSG_vm_create_core(vm, name) sg_vm_create_core(vm, name)
94 #define MSG_vm_create_multicore(vm, name, coreAmount) sg_vm_create_multicore(vm, name, coreAmount)
95 XBT_ATTRIB_DEPRECATED_v322("Use sg_vm_create_migratable() from the live migration plugin: "
96 "v3.22 will drop MSG_vm_create() completely.") XBT_PUBLIC sg_vm_t
97 MSG_vm_create(sg_host_t ind_pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity);
99 #define MSG_vm_is_created(vm) sg_vm_is_created(vm)
100 #define MSG_vm_is_running(vm) sg_vm_is_running(vm)
101 #define MSG_vm_is_suspended(vm) sg_vm_is_suspended(vm)
103 #define MSG_vm_get_name(vm) sg_vm_get_name(vm)
104 #define MSG_vm_set_ramsize(vm, size) sg_vm_set_ramsize(vm, size)
105 #define MSG_vm_get_ramsize(vm) sg_vm_get_ramsize(vm)
106 #define MSG_vm_set_bound(vm, bound) sg_vm_set_bound(vm, bound)
107 #define MSG_vm_get_pm(vm) sg_vm_get_pm(vm)
109 #define MSG_vm_start(vm) sg_vm_start(vm)
110 #define MSG_vm_suspend(vm) sg_vm_suspend(vm)
111 #define MSG_vm_resume(vm) sg_vm_resume(vm)
112 #define MSG_vm_shutdown(vm) sg_vm_shutdown(vm)
113 #define MSG_vm_destroy(vm) sg_vm_destroy(vm)
115 /* ******************************** File ************************************ */
116 typedef sg_file_t msg_file_t;
118 /* ******************************** Storage ************************************ */
120 /** @brief Storage datatype.
121 * @ingroup msg_storage_management
123 * You should consider this as an opaque object.
125 typedef sg_storage_t msg_storage_t;
128 * \brief @brief Communication action.
129 * \ingroup msg_task_usage
131 * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
133 typedef sg_msg_Comm* msg_comm_t;
135 /** \brief Default value for an uninitialized #msg_task_t.
136 \ingroup m_task_management
138 #define MSG_TASK_UNINITIALIZED NULL
140 /* ****************************** Process *********************************** */
142 /** @brief Process datatype.
143 @ingroup m_process_management
145 A process may be defined as a <em>code</em>, with some
146 <em>private data</em>, executing in a <em>location</em>.
148 You should not access directly to the fields of the pointed
149 structure, but always use the provided API to interact with
152 typedef s4u_Actor* msg_process_t;
154 /** @brief Return code of most MSG functions
155 @ingroup msg_simulation
157 /* Keep these code as binary values: java bindings manipulate | of these values */
159 MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */
160 MSG_TIMEOUT = 1, /**< @brief nothing good happened before the timer you provided elapsed */
161 MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task
162 transfer. Either the network is down or the remote host has been
164 MSG_HOST_FAILURE = 4, /**< @brief System shutdown. The host on which you are
165 running has just been rebooted. Free your datastructures and
167 MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/
171 /************************** Global ******************************************/
172 XBT_PUBLIC void MSG_config(const char* key, const char* value);
173 /** \ingroup msg_simulation
174 * \brief Initialize the MSG internal data.
177 * It also check that the link-time and compile-time versions of SimGrid do
178 * match, so you should use this version instead of the #MSG_init_nocheck
179 * function that does the same initializations, but without this check.
181 * We allow to link against compiled versions that differ in the patch level.
183 #define MSG_init(argc,argv) do { \
184 sg_version_check(SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);\
185 MSG_init_nocheck(argc,argv); \
188 XBT_PUBLIC void MSG_init_nocheck(int* argc, char** argv);
189 XBT_PUBLIC msg_error_t MSG_main();
190 XBT_PUBLIC void MSG_function_register(const char* name, xbt_main_func_t code);
191 XBT_PUBLIC void MSG_function_register_default(xbt_main_func_t code);
192 XBT_PUBLIC void MSG_launch_application(const char* file);
193 /*Bypass the parser */
194 XBT_PUBLIC void MSG_set_function(const char* host_id, const char* function_name, xbt_dynar_t arguments);
196 XBT_PUBLIC double MSG_get_clock();
197 XBT_PUBLIC unsigned long int MSG_get_sent_msg();
199 /************************** Net Zones ***********************************/
200 XBT_PUBLIC sg_netzone_t sg_zone_get_root();
201 #define MSG_zone_get_root() sg_zone_get_root()
202 XBT_PUBLIC const char* sg_zone_get_name(sg_netzone_t zone);
203 #define MSG_zone_get_name(zone) sg_zone_get_name(zone)
204 XBT_PUBLIC sg_netzone_t sg_zone_get_by_name(const char* name);
205 #define MSG_zone_get_by_name(name) sg_zone_get_by_name(name)
206 XBT_PUBLIC void sg_zone_get_sons(sg_netzone_t zone, xbt_dict_t whereto);
207 #define MSG_zone_get_sons(zone, whereto) sg_zone_get_sons(zone, whereto)
208 XBT_PUBLIC const char* sg_zone_get_property_value(sg_netzone_t as, const char* name);
209 #define MSG_zone_get_property_value(zone, name) sg_zone_get_property_value(zone, name)
210 XBT_PUBLIC void sg_zone_set_property_value(sg_netzone_t netzone, const char* name, char* value);
211 #define MSG_zone_set_property_value(zone, name, value) sg_zone_set_property_value(zone, name, value)
212 XBT_PUBLIC void sg_zone_get_hosts(sg_netzone_t zone, xbt_dynar_t whereto);
213 #define MSG_zone_get_hosts(zone, whereto) sg_zone_get_hosts(zone, whereto)
215 /************************** Storage handling ***********************************/
216 XBT_PUBLIC const char* sg_storage_get_name(sg_storage_t storage);
217 #define MSG_storage_get_name(storage) sg_storage_get_name(storage)
218 XBT_PUBLIC sg_storage_t sg_storage_get_by_name(const char* name);
219 #define MSG_storage_get_by_name(name) sg_storage_get_by_name(name)
220 XBT_PUBLIC xbt_dict_t sg_storage_get_properties(sg_storage_t storage);
221 #define MSG_storage_get_properties(storage) sg_storage_get_properties(storage)
222 XBT_PUBLIC void sg_storage_set_property_value(sg_storage_t storage, const char* name, char* value);
223 #define MSG_storage_set_property_value(storage, name, value) sg_storage_set_property_value(storage, name, value)
224 XBT_PUBLIC const char* sg_storage_get_property_value(sg_storage_t storage, const char* name);
225 #define MSG_storage_get_property_value(storage, name) sg_storage_get_property_value(storage, name)
226 XBT_PUBLIC xbt_dynar_t sg_storages_as_dynar();
227 #define MSG_storages_as_dynar() sg_storages_as_dynar()
228 XBT_PUBLIC void sg_storage_set_data(sg_storage_t host, void* data);
229 #define MSG_storage_set_data(storage, data) sg_storage_set_data(storage, data)
230 XBT_PUBLIC void* sg_storage_get_data(sg_storage_t storage);
231 #define MSG_storage_get_data(storage) sg_storage_get_data(storage)
232 XBT_PUBLIC const char* sg_storage_get_host(sg_storage_t storage);
233 #define MSG_storage_get_host(storage) sg_storage_get_host(storage)
234 XBT_PUBLIC sg_size_t sg_storage_read(sg_storage_t storage, sg_size_t size);
235 #define MSG_storage_read(storage, size) sg_storage_read(storage, size)
236 XBT_PUBLIC sg_size_t sg_storage_write(sg_storage_t storage, sg_size_t size);
237 #define MSG_storage_write(storage, size) sg_storage_write(storage, size)
239 /************************** Host handling ***********************************/
240 XBT_ATTRIB_DEPRECATED_v320("Use MSG_host_get_speed(): v3.20 will drop MSG_host_get_current_power_peak() "
241 "completely.") static inline double MSG_host_get_current_power_peak(msg_host_t host)
243 return MSG_host_get_speed(host);
246 XBT_PUBLIC void MSG_create_environment(const char* file);
248 /************************** Process handling *********************************/
249 XBT_PUBLIC msg_process_t MSG_process_create(const char* name, xbt_main_func_t code, void* data, msg_host_t host);
250 XBT_PUBLIC msg_process_t MSG_process_create_with_arguments(const char* name, xbt_main_func_t code, void* data,
251 msg_host_t host, int argc, char** argv);
252 XBT_PUBLIC msg_process_t MSG_process_create_with_environment(const char* name, xbt_main_func_t code, void* data,
253 msg_host_t host, int argc, char** argv,
254 xbt_dict_t properties);
256 XBT_PUBLIC msg_process_t MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties);
257 XBT_PUBLIC void MSG_process_detach();
259 XBT_PUBLIC void MSG_process_kill(msg_process_t process);
260 XBT_PUBLIC int MSG_process_killall();
261 XBT_PUBLIC msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host);
262 XBT_PUBLIC void MSG_process_yield();
264 XBT_PUBLIC void* MSG_process_get_data(msg_process_t process);
265 XBT_PUBLIC msg_error_t MSG_process_set_data(msg_process_t process, void* data);
266 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
267 XBT_PUBLIC msg_host_t MSG_process_get_host(msg_process_t process);
268 XBT_PUBLIC msg_process_t MSG_process_from_PID(int PID);
269 XBT_PUBLIC int MSG_process_get_PID(msg_process_t process);
270 XBT_PUBLIC int MSG_process_get_PPID(msg_process_t process);
271 XBT_PUBLIC const char* MSG_process_get_name(msg_process_t process);
272 XBT_PUBLIC int MSG_process_self_PID();
273 XBT_PUBLIC int MSG_process_self_PPID();
274 XBT_PUBLIC const char* MSG_process_self_name();
275 XBT_PUBLIC msg_process_t MSG_process_self();
276 XBT_PUBLIC xbt_dynar_t MSG_processes_as_dynar();
277 XBT_PUBLIC int MSG_process_get_number();
279 XBT_PUBLIC msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time);
281 /*property handlers*/
282 XBT_PUBLIC xbt_dict_t MSG_process_get_properties(msg_process_t process);
283 XBT_PUBLIC const char* MSG_process_get_property_value(msg_process_t process, const char* name);
285 XBT_PUBLIC msg_error_t MSG_process_suspend(msg_process_t process);
286 XBT_PUBLIC msg_error_t MSG_process_resume(msg_process_t process);
287 XBT_PUBLIC int MSG_process_is_suspended(msg_process_t process);
288 XBT_PUBLIC void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void* data);
289 XBT_PUBLIC void MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
291 XBT_PUBLIC void MSG_process_daemonize(msg_process_t process);
292 XBT_PUBLIC msg_process_t MSG_process_restart(msg_process_t process);
293 XBT_PUBLIC void MSG_process_ref(msg_process_t process);
294 XBT_PUBLIC void MSG_process_unref(msg_process_t process);
296 /************************** Task handling ************************************/
297 XBT_PUBLIC msg_task_t MSG_task_create(const char* name, double flops_amount, double bytes_amount, void* data);
298 XBT_PUBLIC msg_task_t MSG_parallel_task_create(const char* name, int host_nb, const msg_host_t* host_list,
299 double* flops_amount, double* bytes_amount, void* data);
300 XBT_PUBLIC void* MSG_task_get_data(msg_task_t task);
301 XBT_PUBLIC void MSG_task_set_data(msg_task_t task, void* data);
302 XBT_PUBLIC void MSG_task_set_copy_callback(void (*callback)(msg_task_t task, msg_process_t src, msg_process_t dst));
303 XBT_PUBLIC msg_process_t MSG_task_get_sender(msg_task_t task);
304 XBT_PUBLIC msg_host_t MSG_task_get_source(msg_task_t task);
305 XBT_PUBLIC const char* MSG_task_get_name(msg_task_t task);
306 XBT_PUBLIC void MSG_task_set_name(msg_task_t task, const char* name);
307 XBT_PUBLIC msg_error_t MSG_task_cancel(msg_task_t task);
308 XBT_PUBLIC msg_error_t MSG_task_destroy(msg_task_t task);
310 XBT_PUBLIC msg_error_t MSG_task_execute(msg_task_t task);
311 XBT_PUBLIC msg_error_t MSG_parallel_task_execute(msg_task_t task);
312 XBT_PUBLIC msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout);
313 XBT_PUBLIC void MSG_task_set_priority(msg_task_t task, double priority);
314 XBT_PUBLIC void MSG_task_set_bound(msg_task_t task, double bound);
316 XBT_PUBLIC msg_error_t MSG_process_join(msg_process_t process, double timeout);
317 XBT_PUBLIC msg_error_t MSG_process_sleep(double nb_sec);
319 XBT_PUBLIC void MSG_task_set_flops_amount(msg_task_t task, double flops_amount);
320 XBT_PUBLIC double MSG_task_get_flops_amount(msg_task_t task);
321 XBT_PUBLIC double MSG_task_get_remaining_work_ratio(msg_task_t task);
322 XBT_PUBLIC void MSG_task_set_bytes_amount(msg_task_t task, double bytes_amount);
324 XBT_PUBLIC double MSG_task_get_remaining_communication(msg_task_t task);
325 XBT_PUBLIC double MSG_task_get_bytes_amount(msg_task_t task);
327 XBT_PUBLIC msg_error_t MSG_task_receive_ext(msg_task_t* task, const char* alias, double timeout, msg_host_t host);
329 XBT_PUBLIC msg_error_t MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, double timeout);
331 XBT_PUBLIC msg_error_t MSG_task_receive(msg_task_t* task, const char* alias);
332 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
334 XBT_PUBLIC msg_error_t MSG_task_receive_ext_bounded(msg_task_t* task, const char* alias, double timeout,
335 msg_host_t host, double rate);
337 XBT_PUBLIC msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t* task, const char* alias, double timeout,
339 XBT_PUBLIC msg_error_t MSG_task_receive_bounded(msg_task_t* task, const char* alias, double rate);
340 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
342 XBT_PUBLIC msg_comm_t MSG_task_isend(msg_task_t task, const char* alias);
343 XBT_PUBLIC msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char* alias, double maxrate);
344 XBT_ATTRIB_DEPRECATED_v320(
345 "This function will be removed from SimGrid v3.20. If you really need this function, please speak up quickly.")
346 XBT_PUBLIC msg_comm_t MSG_task_isend_with_matching(msg_task_t task, const char* alias,
347 int (*match_fun)(void*, void*, void*), void* match_data);
349 XBT_PUBLIC void MSG_task_dsend(msg_task_t task, const char* alias, void_f_pvoid_t cleanup);
350 XBT_PUBLIC void MSG_task_dsend_bounded(msg_task_t task, const char* alias, void_f_pvoid_t cleanup, double maxrate);
351 XBT_PUBLIC msg_comm_t MSG_task_irecv(msg_task_t* task, const char* alias);
352 XBT_PUBLIC msg_comm_t MSG_task_irecv_bounded(msg_task_t* task, const char* alias, double rate);
353 XBT_PUBLIC int MSG_comm_test(msg_comm_t comm);
354 XBT_PUBLIC int MSG_comm_testany(xbt_dynar_t comms);
355 XBT_PUBLIC void MSG_comm_destroy(msg_comm_t comm);
356 XBT_PUBLIC msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout);
357 XBT_PUBLIC void MSG_comm_waitall(msg_comm_t* comm, int nb_elem, double timeout);
358 XBT_PUBLIC int MSG_comm_waitany(xbt_dynar_t comms);
359 XBT_PUBLIC msg_task_t MSG_comm_get_task(msg_comm_t comm);
360 XBT_PUBLIC msg_error_t MSG_comm_get_status(msg_comm_t comm);
362 XBT_PUBLIC int MSG_task_listen(const char* alias);
363 XBT_PUBLIC msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char* alias, double timeout);
364 XBT_PUBLIC msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char* alias, double timeout,
366 XBT_PUBLIC msg_error_t MSG_task_send(msg_task_t task, const char* alias);
367 XBT_PUBLIC msg_error_t MSG_task_send_bounded(msg_task_t task, const char* alias, double rate);
368 XBT_PUBLIC int MSG_task_listen_from(const char* alias);
369 XBT_PUBLIC void MSG_task_set_category(msg_task_t task, const char* category);
370 XBT_PUBLIC const char* MSG_task_get_category(msg_task_t task);
372 /************************** Mailbox handling ************************************/
374 /* @brief MSG_mailbox_set_async - set a mailbox as eager
375 * Sets the mailbox to a permanent receiver mode. Messages sent to this mailbox will then be sent just after the send
376 * is issued, without waiting for the corresponding receive.
377 * This call should be done before issuing any receive, and on the receiver's side only
378 * @param alias The alias of the mailbox to modify.
380 XBT_PUBLIC void MSG_mailbox_set_async(const char* alias);
382 /************************** Action handling **********************************/
383 XBT_PUBLIC msg_error_t MSG_action_trace_run(char* path);
384 XBT_PUBLIC void MSG_action_init();
385 XBT_PUBLIC void MSG_action_exit();
387 /** @brief Opaque type representing a semaphore
388 * @ingroup msg_synchro
391 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
393 XBT_PUBLIC msg_sem_t MSG_sem_init(int initial_value);
394 XBT_PUBLIC void MSG_sem_acquire(msg_sem_t sem);
395 XBT_PUBLIC msg_error_t MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
396 XBT_PUBLIC void MSG_sem_release(msg_sem_t sem);
397 XBT_PUBLIC int MSG_sem_get_capacity(msg_sem_t sem);
398 XBT_PUBLIC void MSG_sem_destroy(msg_sem_t sem);
399 XBT_PUBLIC int MSG_sem_would_block(msg_sem_t sem);
401 /** @brief Opaque type representing a barrier identifier
402 * @ingroup msg_synchro
406 #define MSG_BARRIER_SERIAL_PROCESS -1
407 typedef struct s_msg_bar_t* msg_bar_t;
408 XBT_PUBLIC msg_bar_t MSG_barrier_init(unsigned int count);
409 XBT_PUBLIC void MSG_barrier_destroy(msg_bar_t bar);
410 XBT_PUBLIC int MSG_barrier_wait(msg_bar_t bar);
412 /* ****************************************************************************************** */
413 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
414 XBT_PUBLIC smx_context_t MSG_process_get_smx_ctx(msg_process_t process);
419 XBT_PUBLIC msg_process_t MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data,
421 std::map<std::string, std::string>* properties);