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/plugins/live_migration.h"
15 #include "xbt/dynar.h"
18 #include "simgrid/simix.h"
25 typedef simgrid::msg::Comm sg_msg_Comm;
27 typedef struct msg_Comm sg_msg_Comm;
32 /* *************************** Network Zones ******************************** */
33 #define msg_as_t msg_netzone_t /* portability macro */
34 typedef s4u_NetZone* msg_netzone_t;
36 /* ******************************** Host ************************************ */
38 /** @brief Host datatype.
39 @ingroup m_host_management
41 A <em>location</em> (or <em>host</em>) is any possible place where
42 a process may run. Thus it is represented as a <em>physical
43 resource with computing capabilities</em>, some <em>mailboxes</em>
44 to enable running process to communicate with remote ones, and
45 some <em>private data</em> that can be only accessed by local
48 typedef sg_host_t msg_host_t;
51 XBT_PUBLIC_DATA(int) sg_storage_max_file_descriptors;
52 /* ******************************** Task ************************************ */
54 typedef struct s_simdata_task_t* simdata_task_t;
56 typedef struct msg_task {
57 char *name; /**< @brief task name if any */
58 simdata_task_t simdata; /**< @brief simulator data */
59 void *data; /**< @brief user data */
60 long long int counter; /* task unique identifier for instrumentation */
61 char *category; /* task category for instrumentation */
64 /** @brief Task datatype.
65 @ingroup m_task_management
67 A <em>task</em> may then be defined by a <em>computing
68 amount</em>, a <em>message size</em> and some <em>private
71 typedef struct msg_task *msg_task_t;
73 /* ******************************** VM ************************************* */
74 typedef sg_vm_t msg_vm_t;
76 /* ******************************** File ************************************ */
77 typedef sg_file_t msg_file_t;
79 /* ******************************** Storage ************************************ */
81 /** @brief Storage datatype.
82 * @ingroup msg_storage_management
84 * You should consider this as an opaque object.
86 typedef sg_storage_t msg_storage_t;
89 * \brief @brief Communication action.
90 * \ingroup msg_task_usage
92 * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
94 typedef sg_msg_Comm* msg_comm_t;
96 /** \brief Default value for an uninitialized #msg_task_t.
97 \ingroup m_task_management
99 #define MSG_TASK_UNINITIALIZED NULL
101 /* ****************************** Process *********************************** */
103 /** @brief Process datatype.
104 @ingroup m_process_management
106 A process may be defined as a <em>code</em>, with some
107 <em>private data</em>, executing in a <em>location</em>.
109 You should not access directly to the fields of the pointed
110 structure, but always use the provided API to interact with
113 typedef s4u_Actor* msg_process_t;
115 /** @brief Return code of most MSG functions
116 @ingroup msg_simulation
118 /* Keep these code as binary values: java bindings manipulate | of these values */
120 MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */
121 MSG_TIMEOUT = 1, /**< @brief nothing good happened before the timer you provided elapsed */
122 MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task
123 transfer. Either the network is down or the remote host has been
125 MSG_HOST_FAILURE = 4, /**< @brief System shutdown. The host on which you are
126 running has just been rebooted. Free your datastructures and
128 MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/
132 /************************** Global ******************************************/
133 XBT_PUBLIC void MSG_config(const char* key, const char* value);
134 /** \ingroup msg_simulation
135 * \brief Initialize the MSG internal data.
138 * It also check that the link-time and compile-time versions of SimGrid do
139 * match, so you should use this version instead of the #MSG_init_nocheck
140 * function that does the same initializations, but without this check.
142 * We allow to link against compiled versions that differ in the patch level.
144 #define MSG_init(argc,argv) do { \
145 sg_version_check(SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);\
146 MSG_init_nocheck(argc,argv); \
149 XBT_PUBLIC void MSG_init_nocheck(int* argc, char** argv);
150 XBT_PUBLIC msg_error_t MSG_main();
151 XBT_PUBLIC void MSG_function_register(const char* name, xbt_main_func_t code);
152 XBT_PUBLIC void MSG_function_register_default(xbt_main_func_t code);
153 XBT_PUBLIC void MSG_launch_application(const char* file);
154 /*Bypass the parser */
155 XBT_PUBLIC void MSG_set_function(const char* host_id, const char* function_name, xbt_dynar_t arguments);
157 XBT_PUBLIC double MSG_get_clock();
158 XBT_PUBLIC unsigned long int MSG_get_sent_msg();
160 /************************** Net Zones ***********************************/
161 XBT_PUBLIC msg_netzone_t MSG_zone_get_root();
162 XBT_PUBLIC const char* MSG_zone_get_name(msg_netzone_t zone);
163 XBT_PUBLIC msg_netzone_t MSG_zone_get_by_name(const char* name);
164 XBT_PUBLIC void MSG_zone_get_sons(msg_netzone_t zone, xbt_dict_t whereto);
165 XBT_PUBLIC const char* MSG_zone_get_property_value(msg_netzone_t as, const char* name);
166 XBT_PUBLIC void MSG_zone_set_property_value(msg_netzone_t netzone, const char* name, char* value);
167 XBT_PUBLIC void MSG_zone_get_hosts(msg_netzone_t zone, xbt_dynar_t whereto);
169 /************************** Storage handling ***********************************/
170 XBT_PUBLIC const char* sg_storage_get_name(sg_storage_t storage);
171 #define MSG_storage_get_name(storage) sg_storage_get_name(storage)
172 XBT_PUBLIC sg_storage_t sg_storage_get_by_name(const char* name);
173 #define MSG_storage_get_by_name(name) sg_storage_get_by_name(name)
174 XBT_PUBLIC xbt_dict_t sg_storage_get_properties(sg_storage_t storage);
175 #define MSG_storage_get_properties(storage) sg_storage_get_properties(storage)
176 XBT_PUBLIC void sg_storage_set_property_value(sg_storage_t storage, const char* name, char* value);
177 #define MSG_storage_set_property_value(storage, name, value) sg_storage_set_property_value(storage, name, value)
178 XBT_PUBLIC const char* sg_storage_get_property_value(sg_storage_t storage, const char* name);
179 #define MSG_storage_get_property_value(storage, name) sg_storage_get_property_value(storage, name)
180 XBT_PUBLIC xbt_dynar_t sg_storages_as_dynar();
181 #define MSG_storages_as_dynar() sg_storages_as_dynar()
182 XBT_PUBLIC void sg_storage_set_data(sg_storage_t host, void* data);
183 #define MSG_storage_set_data(storage, data) sg_storage_set_data(storage, data)
184 XBT_PUBLIC void* sg_storage_get_data(sg_storage_t storage);
185 #define MSG_storage_get_data(storage) sg_storage_get_data(storage)
186 XBT_PUBLIC const char* sg_storage_get_host(sg_storage_t storage);
187 #define MSG_storage_get_host(storage) sg_storage_get_host(storage)
188 XBT_PUBLIC sg_size_t sg_storage_read(sg_storage_t storage, sg_size_t size);
189 #define MSG_storage_read(storage, size) sg_storage_read(storage, size)
190 XBT_PUBLIC sg_size_t sg_storage_write(sg_storage_t storage, sg_size_t size);
191 #define MSG_storage_write(storage, size) sg_storage_write(storage, size)
193 /************************** Host handling ***********************************/
194 XBT_PUBLIC void MSG_host_get_process_list(msg_host_t h, xbt_dynar_t whereto);
196 XBT_ATTRIB_DEPRECATED_v320("Use MSG_host_get_speed(): v3.20 will drop MSG_host_get_current_power_peak() "
197 "completely.") static inline double MSG_host_get_current_power_peak(msg_host_t host)
199 return MSG_host_get_speed(host);
202 XBT_PUBLIC double MSG_host_get_power_peak_at(msg_host_t h, int pstate);
204 XBT_PUBLIC void MSG_create_environment(const char* file);
206 /************************** Process handling *********************************/
207 XBT_PUBLIC msg_process_t MSG_process_create(const char* name, xbt_main_func_t code, void* data, msg_host_t host);
208 XBT_PUBLIC msg_process_t MSG_process_create_with_arguments(const char* name, xbt_main_func_t code, void* data,
209 msg_host_t host, int argc, char** argv);
210 XBT_PUBLIC msg_process_t MSG_process_create_with_environment(const char* name, xbt_main_func_t code, void* data,
211 msg_host_t host, int argc, char** argv,
212 xbt_dict_t properties);
214 XBT_PUBLIC msg_process_t MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties);
215 XBT_PUBLIC void MSG_process_detach();
217 XBT_PUBLIC void MSG_process_kill(msg_process_t process);
218 XBT_PUBLIC int MSG_process_killall();
219 XBT_PUBLIC msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host);
220 XBT_PUBLIC void MSG_process_yield();
222 XBT_PUBLIC void* MSG_process_get_data(msg_process_t process);
223 XBT_PUBLIC msg_error_t MSG_process_set_data(msg_process_t process, void* data);
224 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
225 XBT_PUBLIC msg_host_t MSG_process_get_host(msg_process_t process);
226 XBT_PUBLIC msg_process_t MSG_process_from_PID(int PID);
227 XBT_PUBLIC int MSG_process_get_PID(msg_process_t process);
228 XBT_PUBLIC int MSG_process_get_PPID(msg_process_t process);
229 XBT_PUBLIC const char* MSG_process_get_name(msg_process_t process);
230 XBT_PUBLIC int MSG_process_self_PID();
231 XBT_PUBLIC int MSG_process_self_PPID();
232 XBT_PUBLIC const char* MSG_process_self_name();
233 XBT_PUBLIC msg_process_t MSG_process_self();
234 XBT_PUBLIC xbt_dynar_t MSG_processes_as_dynar();
235 XBT_PUBLIC int MSG_process_get_number();
237 XBT_PUBLIC msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time);
239 /*property handlers*/
240 XBT_PUBLIC xbt_dict_t MSG_process_get_properties(msg_process_t process);
241 XBT_PUBLIC const char* MSG_process_get_property_value(msg_process_t process, const char* name);
243 XBT_PUBLIC msg_error_t MSG_process_suspend(msg_process_t process);
244 XBT_PUBLIC msg_error_t MSG_process_resume(msg_process_t process);
245 XBT_PUBLIC int MSG_process_is_suspended(msg_process_t process);
246 XBT_PUBLIC void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void* data);
247 XBT_PUBLIC void MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
249 XBT_PUBLIC void MSG_process_daemonize(msg_process_t process);
250 XBT_PUBLIC msg_process_t MSG_process_restart(msg_process_t process);
251 XBT_PUBLIC void MSG_process_ref(msg_process_t process);
252 XBT_PUBLIC void MSG_process_unref(msg_process_t process);
254 /************************** Task handling ************************************/
255 XBT_PUBLIC msg_task_t MSG_task_create(const char* name, double flops_amount, double bytes_amount, void* data);
256 XBT_PUBLIC msg_task_t MSG_parallel_task_create(const char* name, int host_nb, const msg_host_t* host_list,
257 double* flops_amount, double* bytes_amount, void* data);
258 XBT_PUBLIC void* MSG_task_get_data(msg_task_t task);
259 XBT_PUBLIC void MSG_task_set_data(msg_task_t task, void* data);
260 XBT_PUBLIC void MSG_task_set_copy_callback(void (*callback)(msg_task_t task, msg_process_t src, msg_process_t dst));
261 XBT_PUBLIC msg_process_t MSG_task_get_sender(msg_task_t task);
262 XBT_PUBLIC msg_host_t MSG_task_get_source(msg_task_t task);
263 XBT_PUBLIC const char* MSG_task_get_name(msg_task_t task);
264 XBT_PUBLIC void MSG_task_set_name(msg_task_t task, const char* name);
265 XBT_PUBLIC msg_error_t MSG_task_cancel(msg_task_t task);
266 XBT_PUBLIC msg_error_t MSG_task_destroy(msg_task_t task);
268 XBT_PUBLIC msg_error_t MSG_task_execute(msg_task_t task);
269 XBT_PUBLIC msg_error_t MSG_parallel_task_execute(msg_task_t task);
270 XBT_PUBLIC msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout);
271 XBT_PUBLIC void MSG_task_set_priority(msg_task_t task, double priority);
272 XBT_PUBLIC void MSG_task_set_bound(msg_task_t task, double bound);
274 XBT_PUBLIC msg_error_t MSG_process_join(msg_process_t process, double timeout);
275 XBT_PUBLIC msg_error_t MSG_process_sleep(double nb_sec);
277 XBT_PUBLIC void MSG_task_set_flops_amount(msg_task_t task, double flops_amount);
278 XBT_PUBLIC double MSG_task_get_flops_amount(msg_task_t task);
279 XBT_PUBLIC double MSG_task_get_remaining_work_ratio(msg_task_t task);
280 XBT_PUBLIC void MSG_task_set_bytes_amount(msg_task_t task, double bytes_amount);
282 XBT_PUBLIC double MSG_task_get_remaining_communication(msg_task_t task);
283 XBT_PUBLIC double MSG_task_get_bytes_amount(msg_task_t task);
285 XBT_PUBLIC msg_error_t MSG_task_receive_ext(msg_task_t* task, const char* alias, double timeout, msg_host_t host);
287 XBT_PUBLIC msg_error_t MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, double timeout);
289 XBT_PUBLIC msg_error_t MSG_task_receive(msg_task_t* task, const char* alias);
290 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
292 XBT_PUBLIC msg_error_t MSG_task_receive_ext_bounded(msg_task_t* task, const char* alias, double timeout,
293 msg_host_t host, double rate);
295 XBT_PUBLIC msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t* task, const char* alias, double timeout,
297 XBT_PUBLIC msg_error_t MSG_task_receive_bounded(msg_task_t* task, const char* alias, double rate);
298 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
300 XBT_PUBLIC msg_comm_t MSG_task_isend(msg_task_t task, const char* alias);
301 XBT_PUBLIC msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char* alias, double maxrate);
302 XBT_ATTRIB_DEPRECATED_v320(
303 "This function will be removed from SimGrid v3.20. If you really need this function, please speak up quickly.")
304 XBT_PUBLIC msg_comm_t MSG_task_isend_with_matching(msg_task_t task, const char* alias,
305 int (*match_fun)(void*, void*, void*), void* match_data);
307 XBT_PUBLIC void MSG_task_dsend(msg_task_t task, const char* alias, void_f_pvoid_t cleanup);
308 XBT_PUBLIC void MSG_task_dsend_bounded(msg_task_t task, const char* alias, void_f_pvoid_t cleanup, double maxrate);
309 XBT_PUBLIC msg_comm_t MSG_task_irecv(msg_task_t* task, const char* alias);
310 XBT_PUBLIC msg_comm_t MSG_task_irecv_bounded(msg_task_t* task, const char* alias, double rate);
311 XBT_PUBLIC int MSG_comm_test(msg_comm_t comm);
312 XBT_PUBLIC int MSG_comm_testany(xbt_dynar_t comms);
313 XBT_PUBLIC void MSG_comm_destroy(msg_comm_t comm);
314 XBT_PUBLIC msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout);
315 XBT_PUBLIC void MSG_comm_waitall(msg_comm_t* comm, int nb_elem, double timeout);
316 XBT_PUBLIC int MSG_comm_waitany(xbt_dynar_t comms);
317 XBT_PUBLIC msg_task_t MSG_comm_get_task(msg_comm_t comm);
318 XBT_PUBLIC msg_error_t MSG_comm_get_status(msg_comm_t comm);
320 XBT_PUBLIC int MSG_task_listen(const char* alias);
321 XBT_PUBLIC msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char* alias, double timeout);
322 XBT_PUBLIC msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char* alias, double timeout,
324 XBT_PUBLIC msg_error_t MSG_task_send(msg_task_t task, const char* alias);
325 XBT_PUBLIC msg_error_t MSG_task_send_bounded(msg_task_t task, const char* alias, double rate);
326 XBT_PUBLIC int MSG_task_listen_from(const char* alias);
327 XBT_PUBLIC void MSG_task_set_category(msg_task_t task, const char* category);
328 XBT_PUBLIC const char* MSG_task_get_category(msg_task_t task);
330 /************************** Mailbox handling ************************************/
332 /* @brief MSG_mailbox_set_async - set a mailbox as eager
333 * Sets the mailbox to a permanent receiver mode. Messages sent to this mailbox will then be sent just after the send
334 * is issued, without waiting for the corresponding receive.
335 * This call should be done before issuing any receive, and on the receiver's side only
336 * @param alias The alias of the mailbox to modify.
338 XBT_PUBLIC void MSG_mailbox_set_async(const char* alias);
340 /************************** Action handling **********************************/
341 XBT_PUBLIC msg_error_t MSG_action_trace_run(char* path);
342 XBT_PUBLIC void MSG_action_init();
343 XBT_PUBLIC void MSG_action_exit();
345 /** @brief Opaque type representing a semaphore
346 * @ingroup msg_synchro
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
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);
359 /** @brief Opaque type representing a barrier identifier
360 * @ingroup msg_synchro
364 #define MSG_BARRIER_SERIAL_PROCESS -1
365 typedef struct s_msg_bar_t* msg_bar_t;
366 XBT_PUBLIC msg_bar_t MSG_barrier_init(unsigned int count);
367 XBT_PUBLIC void MSG_barrier_destroy(msg_bar_t bar);
368 XBT_PUBLIC int MSG_barrier_wait(msg_bar_t bar);
370 /** @brief Opaque type describing a Virtual Machine.
373 * All this is highly experimental and the interface will probably change in the future.
374 * Please don't depend on this yet (although testing is welcomed if you feel so).
375 * Usual lack of guaranty of any kind applies here, and is even increased.
379 XBT_PUBLIC int sg_vm_is_created(sg_vm_t vm);
380 #define MSG_vm_is_created(vm) sg_vm_is_created(vm)
381 XBT_PUBLIC int sg_vm_is_running(sg_vm_t vm);
382 #define MSG_vm_is_running(vm) sg_vm_is_running(vm)
383 XBT_PUBLIC int sg_vm_is_suspended(sg_vm_t vm);
384 #define MSG_vm_is_suspended(vm) sg_vm_is_suspended(vm)
386 XBT_PUBLIC const char* sg_vm_get_name(sg_vm_t vm);
387 #define MSG_vm_get_name(vm) sg_vm_get_name(vm)
388 XBT_PUBLIC void sg_vm_set_ramsize(sg_vm_t vm, size_t size);
389 #define MSG_vm_set_ramsize(vm, size) sg_vm_set_ramsize(vm, size)
390 XBT_PUBLIC size_t sg_vm_get_ramsize(sg_vm_t vm);
391 #define MSG_vm_get_ramsize(vm) sg_vm_get_ramsize(vm)
393 XBT_PUBLIC sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name);
394 #define MSG_vm_create_core(vm, name) sg_vm_create_core(vm, name)
395 XBT_PUBLIC sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount);
396 #define MSG_vm_create_multicore(vm, name, coreAmount) sg_vm_create_multicore(vm, name, coreAmount)
398 XBT_ATTRIB_DEPRECATED_v322("Use sg_vm_create_migratable() from the live migration plugin: "
399 "v3.22 will drop MSG_vm_create() completely.") XBT_PUBLIC msg_vm_t
400 MSG_vm_create(msg_host_t ind_pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity);
402 XBT_PUBLIC void sg_vm_start(msg_vm_t vm);
403 #define MSG_vm_start(vm) sg_vm_start(vm)
404 XBT_PUBLIC void sg_vm_suspend(msg_vm_t vm);
405 #define MSG_vm_suspend(vm) sg_vm_suspend(vm)
406 XBT_PUBLIC void sg_vm_resume(msg_vm_t vm);
407 #define MSG_vm_resume(vm) sg_vm_resume(vm)
408 XBT_PUBLIC void sg_vm_shutdown(msg_vm_t vm);
409 #define MSG_vm_shutdown(vm) sg_vm_shutdown(vm)
410 XBT_PUBLIC void sg_vm_destroy(msg_vm_t vm);
411 #define MSG_vm_destroy(vm) sg_vm_destroy(vm)
412 XBT_PUBLIC sg_host_t sg_vm_get_pm(sg_vm_t vm);
413 #define MSG_vm_get_pm(vm) sg_vm_get_pm(vm)
414 XBT_PUBLIC void sg_vm_set_bound(sg_vm_t vm, double bound);
415 #define MSG_vm_set_bound(vm, bound) sg_vm_set_bound(vm, bound)
417 #include "simgrid/instr.h"
419 /* ****************************************************************************************** */
420 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
421 XBT_PUBLIC smx_context_t MSG_process_get_smx_ctx(msg_process_t process);
426 XBT_PUBLIC msg_process_t MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data,
428 std::map<std::string, std::string>* properties);