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,
152 xbt_main_func_t code);
153 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
154 XBT_PUBLIC(void) MSG_launch_application(const char *file);
155 /*Bypass the parser */
156 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
157 const char *function_name,
158 xbt_dynar_t arguments);
160 XBT_PUBLIC(double) MSG_get_clock();
161 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg();
163 /************************** Net Zones ***********************************/
164 XBT_PUBLIC(msg_netzone_t) MSG_zone_get_root();
165 XBT_PUBLIC(const char*) MSG_zone_get_name(msg_netzone_t zone);
166 XBT_PUBLIC(msg_netzone_t) MSG_zone_get_by_name(const char* name);
167 XBT_PUBLIC(void) MSG_zone_get_sons(msg_netzone_t zone, xbt_dict_t whereto);
168 XBT_PUBLIC(const char*) MSG_zone_get_property_value(msg_netzone_t as, const char* name);
169 XBT_PUBLIC(void) MSG_zone_set_property_value(msg_netzone_t netzone, const char* name, char* value);
170 XBT_PUBLIC(void) MSG_zone_get_hosts(msg_netzone_t zone, xbt_dynar_t whereto);
172 /************************** Storage handling ***********************************/
173 XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
174 XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
175 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
176 XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char* name, char* value);
177 XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name);
178 XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar();
179 XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
180 XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
181 XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
182 XBT_PUBLIC(sg_size_t) MSG_storage_read(msg_storage_t storage, sg_size_t size);
183 XBT_PUBLIC(sg_size_t) MSG_storage_write(msg_storage_t storage, sg_size_t size);
185 /************************** Host handling ***********************************/
186 XBT_PUBLIC(msg_host_t) MSG_host_by_name(const char *name);
187 #define MSG_get_host_by_name(n) MSG_host_by_name(n) /* Rewrite the old name into the new one transparently */
188 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
189 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
190 /** \ingroup m_host_management
192 * \brief Return the name of the #msg_host_t. */
193 #define MSG_host_get_name(host) sg_host_get_name(host)
194 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
195 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
196 XBT_PUBLIC(msg_host_t) MSG_host_self();
197 XBT_PUBLIC(double) MSG_host_get_speed(msg_host_t h);
198 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
199 XBT_PUBLIC(void) MSG_host_get_process_list(msg_host_t h, xbt_dynar_t whereto);
200 XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
201 XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h);
203 XBT_ATTRIB_DEPRECATED_v320("Use MSG_host_get_speed(): v3.20 will drop MSG_host_get_current_power_peak() "
204 "completely.") static inline double MSG_host_get_current_power_peak(msg_host_t host)
206 return MSG_host_get_speed(host);
209 XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate);
210 XBT_PUBLIC(int) MSG_host_get_nb_pstates(msg_host_t h);
211 #define MSG_host_get_pstate(h) sg_host_get_pstate(h) /* users don't know that MSG is the C version of SimGrid */
212 #define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate) /* (same here) */
213 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar();
214 XBT_PUBLIC(int) MSG_get_host_number();
215 XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
216 XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
218 /*property handlers*/
219 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
220 XBT_PUBLIC(const char*) MSG_host_get_property_value(msg_host_t host, const char* name);
221 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host, const char* name, char* value);
223 XBT_PUBLIC(void) MSG_create_environment(const char *file);
225 /************************** Process handling *********************************/
226 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
227 xbt_main_func_t code,
228 void *data, msg_host_t host);
229 XBT_PUBLIC(msg_process_t)
230 MSG_process_create_with_arguments(const char* name, xbt_main_func_t code, void* data, msg_host_t host, int argc,
232 XBT_PUBLIC(msg_process_t)
233 MSG_process_create_with_environment(const char* name, xbt_main_func_t code, void* data, msg_host_t host, int argc,
234 char** argv, xbt_dict_t properties);
236 XBT_PUBLIC(msg_process_t) MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties);
237 XBT_PUBLIC(void) MSG_process_detach();
239 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
240 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
241 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
242 XBT_PUBLIC(void) MSG_process_yield();
244 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
245 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
247 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
248 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
249 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
250 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
251 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
252 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
253 XBT_PUBLIC(int) MSG_process_self_PID();
254 XBT_PUBLIC(int) MSG_process_self_PPID();
255 XBT_PUBLIC(const char*) MSG_process_self_name();
256 XBT_PUBLIC(msg_process_t) MSG_process_self();
257 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar();
258 XBT_PUBLIC(int) MSG_process_get_number();
260 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
262 /*property handlers*/
263 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
264 XBT_PUBLIC(const char*) MSG_process_get_property_value(msg_process_t process, const char* name);
266 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
267 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
268 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
269 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data);
270 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
272 XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process);
273 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
274 XBT_PUBLIC(void) MSG_process_ref(msg_process_t process);
275 XBT_PUBLIC(void) MSG_process_unref(msg_process_t process);
277 /************************** Task handling ************************************/
278 XBT_PUBLIC(msg_task_t) MSG_task_create(const char* name, double flops_amount, double bytes_amount, void* data);
279 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
281 const msg_host_t * host_list,
282 double *flops_amount,
283 double *bytes_amount,
285 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
286 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
287 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
288 msg_task_t task, msg_process_t src, msg_process_t dst));
289 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
290 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
291 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
292 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
293 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
294 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
296 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
297 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
298 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout);
299 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
300 XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound);
302 XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout);
303 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
305 XBT_PUBLIC(void) MSG_task_set_flops_amount(msg_task_t task, double flops_amount);
306 XBT_PUBLIC(double) MSG_task_get_flops_amount(msg_task_t task);
307 XBT_PUBLIC(double) MSG_task_get_remaining_work_ratio(msg_task_t task);
308 XBT_PUBLIC(void) MSG_task_set_bytes_amount(msg_task_t task, double bytes_amount);
311 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
312 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
313 XBT_PUBLIC(double) MSG_task_get_bytes_amount(msg_task_t task);
315 XBT_PUBLIC(msg_error_t) MSG_task_receive_ext(msg_task_t* task, const char* alias, double timeout, msg_host_t host);
317 XBT_PUBLIC(msg_error_t) MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, double timeout);
319 XBT_PUBLIC(msg_error_t) MSG_task_receive(msg_task_t* task, const char* alias);
320 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
322 XBT_PUBLIC(msg_error_t)
323 MSG_task_receive_ext_bounded(msg_task_t* task, const char* alias, double timeout, msg_host_t host, double rate);
325 XBT_PUBLIC(msg_error_t)
326 MSG_task_receive_with_timeout_bounded(msg_task_t* task, const char* alias, double timeout, double rate);
327 XBT_PUBLIC(msg_error_t) MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
328 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
330 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
331 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
332 XBT_ATTRIB_DEPRECATED_v320(
333 "This function will be removed from SimGrid v3.20. If you really need this function, please speak up quickly.")
334 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task, const char* alias,
335 int (*match_fun)(void*, void*, void*), void* match_data);
337 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
338 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
339 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
340 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
341 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
342 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
343 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
344 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
345 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout);
346 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
347 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
348 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
350 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
351 XBT_PUBLIC(msg_error_t) MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout);
352 XBT_PUBLIC(msg_error_t) MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate);
353 XBT_PUBLIC(msg_error_t) MSG_task_send(msg_task_t task, const char *alias);
354 XBT_PUBLIC(msg_error_t) MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
355 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
356 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
357 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
359 /************************** Mailbox handling ************************************/
361 /* @brief MSG_mailbox_set_async - set a mailbox as eager
362 * Sets the mailbox to a permanent receiver mode. Messages sent to this mailbox will then be sent just after the send
363 * is issued, without waiting for the corresponding receive.
364 * This call should be done before issuing any receive, and on the receiver's side only
365 * @param alias The alias of the mailbox to modify.
367 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
369 /************************** Action handling **********************************/
370 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
371 XBT_PUBLIC(void) MSG_action_init();
372 XBT_PUBLIC(void) MSG_action_exit();
374 /** @brief Opaque type representing a semaphore
375 * @ingroup msg_synchro
378 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
380 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
381 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
382 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
383 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
384 XBT_PUBLIC(int) MSG_sem_get_capacity(msg_sem_t sem);
385 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
386 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
388 /** @brief Opaque type representing a barrier identifier
389 * @ingroup msg_synchro
393 #define MSG_BARRIER_SERIAL_PROCESS -1
394 typedef struct s_msg_bar_t* msg_bar_t;
395 XBT_PUBLIC(msg_bar_t) MSG_barrier_init( unsigned int count);
396 XBT_PUBLIC(void) MSG_barrier_destroy(msg_bar_t bar);
397 XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
399 /** @brief Opaque type describing a Virtual Machine.
402 * All this is highly experimental and the interface will probably change in the future.
403 * Please don't depend on this yet (although testing is welcomed if you feel so).
404 * Usual lack of guaranty of any kind applies here, and is even increased.
408 XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t vm);
409 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t vm);
410 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t vm);
412 XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t vm);
413 XBT_PUBLIC(void) MSG_vm_set_ramsize(msg_vm_t vm, size_t size);
414 XBT_PUBLIC(size_t) MSG_vm_get_ramsize(msg_vm_t vm);
416 // TODO add VDI later
417 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
418 XBT_PUBLIC(msg_vm_t) MSG_vm_create_multicore(msg_host_t pm, const char* name, int coreAmount);
420 XBT_ATTRIB_DEPRECATED_v321("Use MSG_vm_create_migratable() from the live migration plugin: "
421 "v3.21 will drop MSG_vm_create() completely.") static msg_vm_t
422 MSG_vm_create(msg_host_t ind_pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity)
424 return sg_vm_create_migratable(ind_pm, name, coreAmount, ramsize, mig_netspeed, dp_intensity);
427 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
429 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t vm);
431 /* Shutdown the guest operating system. */
432 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
434 /* Suspend the execution of the VM, but keep its state on memory. */
435 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
436 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
438 XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
439 XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
441 #include "simgrid/instr.h"
443 /* ****************************************************************************************** */
444 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
445 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
450 XBT_PUBLIC(msg_process_t)
451 MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
452 std::map<std::string, std::string>* properties);