1 /* Copyright (c) 2004-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include "simgrid/forward.h"
12 #include "simgrid/simix.h"
16 /* *************************** Network Zones ******************************** */
17 #define msg_as_t msg_netzone_t /* portability macro */
18 typedef s4u_NetZone* msg_netzone_t;
20 /* ******************************** Host ************************************ */
22 /** @brief Host datatype.
23 @ingroup m_host_management
25 A <em>location</em> (or <em>host</em>) is any possible place where
26 a process may run. Thus it is represented as a <em>physical
27 resource with computing capabilities</em>, some <em>mailboxes</em>
28 to enable running process to communicate with remote ones, and
29 some <em>private data</em> that can be only accessed by local
32 typedef sg_host_t msg_host_t;
35 XBT_PUBLIC_DATA(int) sg_storage_max_file_descriptors;
36 /* ******************************** Task ************************************ */
38 typedef struct simdata_task *simdata_task_t;
40 typedef struct msg_task {
41 char *name; /**< @brief task name if any */
42 simdata_task_t simdata; /**< @brief simulator data */
43 void *data; /**< @brief user data */
44 long long int counter; /* task unique identifier for instrumentation */
45 char *category; /* task category for instrumentation */
48 /** @brief Task datatype.
49 @ingroup m_task_management
51 A <em>task</em> may then be defined by a <em>computing
52 amount</em>, a <em>message size</em> and some <em>private
55 typedef struct msg_task *msg_task_t;
57 /* ******************************** VM ************************************* */
58 typedef msg_host_t msg_vm_t;
60 /* ******************************** File ************************************ */
62 typedef struct simdata_file* simdata_file_t;
64 typedef struct msg_file_priv {
72 simdata_file_t simdata;
75 typedef struct msg_file_priv* msg_file_t;
77 /* ******************************** Storage ************************************ */
79 /** @brief Storage datatype.
80 * @ingroup msg_storage_management
82 * You should consider this as an opaque object.
84 typedef sg_storage_t msg_storage_t;
87 * \brief @brief Communication action.
88 * \ingroup msg_task_usage
90 * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
92 typedef struct msg_comm *msg_comm_t;
94 /** \brief Default value for an uninitialized #msg_task_t.
95 \ingroup m_task_management
97 #define MSG_TASK_UNINITIALIZED NULL
99 /* ****************************** Process *********************************** */
101 /** @brief Process datatype.
102 @ingroup m_process_management
104 A process may be defined as a <em>code</em>, with some
105 <em>private data</em>, executing in a <em>location</em>.
107 You should not access directly to the fields of the pointed
108 structure, but always use the provided API to interact with
111 typedef s4u_Actor* msg_process_t;
113 /** @brief Return code of most MSG functions
114 @ingroup msg_simulation
116 /* Keep these code as binary values: java bindings manipulate | of these values */
118 MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */
119 MSG_TIMEOUT = 1, /**< @brief nothing good happened before the timer you provided elapsed */
120 MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task
121 transfer. Either the network is down or the remote host has been
123 MSG_HOST_FAILURE = 4, /**< @brief System shutdown. The host on which you are
124 running has just been rebooted. Free your datastructures and
126 MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/
130 /************************** Global ******************************************/
131 XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
132 /** \ingroup msg_simulation
133 * \brief Initialize the MSG internal data.
136 * It also check that the link-time and compile-time versions of SimGrid do
137 * match, so you should use this version instead of the #MSG_init_nocheck
138 * function that does the same initializations, but without this check.
140 * We allow to link against compiled versions that differ in the patch level.
142 #define MSG_init(argc,argv) do { \
143 sg_version_check(SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);\
144 MSG_init_nocheck(argc,argv); \
147 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
148 XBT_PUBLIC(msg_error_t) MSG_main();;
149 XBT_PUBLIC(void) MSG_function_register(const char *name,
150 xbt_main_func_t code);
151 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
152 XBT_PUBLIC(void) MSG_launch_application(const char *file);
153 /*Bypass the parser */
154 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
155 const char *function_name,
156 xbt_dynar_t arguments);
158 XBT_PUBLIC(double) MSG_get_clock();
159 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg();
161 /************************** Net Zones ***********************************/
162 XBT_PUBLIC(msg_netzone_t) MSG_zone_get_root();
163 XBT_PUBLIC(const char*) MSG_zone_get_name(msg_netzone_t zone);
164 XBT_PUBLIC(msg_netzone_t) MSG_zone_get_by_name(const char* name);
165 XBT_PUBLIC(void) MSG_zone_get_sons(msg_netzone_t zone, xbt_dict_t whereto);
166 XBT_PUBLIC(const char*) MSG_zone_get_property_value(msg_netzone_t as, const char* name);
167 XBT_PUBLIC(void) MSG_zone_set_property_value(msg_netzone_t netzone, const char* name, char* value);
168 XBT_PUBLIC(void) MSG_zone_get_hosts(msg_netzone_t zone, xbt_dynar_t whereto);
170 /* Deprecated forms of the previous functions */
171 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_get_root since v3.16")
172 msg_netzone_t MSG_environment_get_routing_root() {
173 return MSG_zone_get_root();
175 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_get_name since v3.16")
176 const char* MSG_environment_as_get_name(msg_netzone_t zone) {
177 return MSG_zone_get_name(zone);
179 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_get_by_name since v3.16")
180 msg_netzone_t MSG_environment_as_get_by_name(const char* name) {
181 return MSG_zone_get_by_name(name);
183 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_get_sons since v3.16")
184 xbt_dict_t MSG_environment_as_get_routing_sons(msg_netzone_t zone) {
185 xbt_dict_t res = xbt_dict_new_homogeneous(NULL);
186 MSG_zone_get_sons(zone, res);
189 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_get_property_value since v3.16")
190 const char* MSG_environment_as_get_property_value(msg_netzone_t zone, const char* name) {
191 return MSG_zone_get_property_value(zone, name);
193 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_set_property_value since v3.16")
194 void MSG_environment_as_set_property_value(msg_netzone_t zone, const char* name, char* value) {
195 MSG_zone_set_property_value(zone, name, value);
197 static inline XBT_ATTRIB_DEPRECATED("Please use MSG_zone_get_hosts since v3.16")
198 xbt_dynar_t MSG_environment_as_get_hosts(msg_netzone_t zone) {
199 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), NULL);
200 MSG_zone_get_hosts(zone, res);
204 /************************** File handling ***********************************/
205 XBT_PUBLIC(sg_size_t) MSG_file_read(msg_file_t fd, sg_size_t size);
206 XBT_PUBLIC(sg_size_t) MSG_file_write(msg_file_t fd, sg_size_t size);
207 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* fullpath, void* data);
208 XBT_PUBLIC(void*) MSG_file_get_data(msg_file_t fd);
209 XBT_PUBLIC(msg_error_t) MSG_file_set_data(msg_file_t fd, void * data);
210 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
211 XBT_PUBLIC(sg_size_t) MSG_file_get_size(msg_file_t fd);
212 XBT_PUBLIC(void) MSG_file_dump(msg_file_t fd);
213 XBT_PUBLIC(msg_error_t) MSG_file_unlink(msg_file_t fd);
214 XBT_PUBLIC(msg_error_t) MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin);
215 XBT_PUBLIC(sg_size_t) MSG_file_tell (msg_file_t fd);
216 XBT_PUBLIC(void) __MSG_file_get_info(msg_file_t fd);
217 XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t file);
218 XBT_PUBLIC(msg_error_t) MSG_file_move(msg_file_t fd, const char* fullpath);
219 XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
220 XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
221 /************************** Storage handling ***********************************/
222 XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
223 XBT_PUBLIC(sg_size_t) MSG_storage_get_free_size(msg_storage_t storage);
224 XBT_PUBLIC(sg_size_t) MSG_storage_get_used_size(msg_storage_t storage);
225 XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
226 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
227 XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char* name, char* value);
228 XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name);
229 XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar();
230 XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
231 XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
232 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_content(msg_storage_t storage);
233 XBT_PUBLIC(sg_size_t) MSG_storage_get_size(msg_storage_t storage);
234 XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
236 /************************** Host handling ***********************************/
237 XBT_PUBLIC(msg_host_t) MSG_host_by_name(const char *name);
238 #define MSG_get_host_by_name(n) MSG_host_by_name(n) /* Rewrite the old name into the new one transparently */
239 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
240 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
241 /** \ingroup m_host_management
243 * \brief Return the name of the #msg_host_t. */
244 #define MSG_host_get_name(host) sg_host_get_name(host)
245 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
246 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
247 XBT_PUBLIC(msg_host_t) MSG_host_self();
248 XBT_PUBLIC(double) MSG_host_get_speed(msg_host_t h);
249 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
250 XBT_PUBLIC(void) MSG_host_get_process_list(msg_host_t h, xbt_dynar_t whereto);
251 XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
252 XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h);
254 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h); /* deprecated */
256 XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate);
257 #define MSG_host_get_current_power_peak(h) MSG_host_get_speed(h) /* deprecated */
258 XBT_PUBLIC(int) MSG_host_get_nb_pstates(msg_host_t h);
259 #define MSG_host_get_pstate(h) sg_host_get_pstate(h) /* deprecated */
260 #define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate) /* deprecated */
261 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar();
262 XBT_PUBLIC(int) MSG_get_host_number();
263 XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
264 XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
265 XBT_PUBLIC(xbt_dict_t) MSG_host_get_storage_content(msg_host_t host);
267 /*property handlers*/
268 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
269 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
271 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host, const char* name, char* value);
273 XBT_PUBLIC(void) MSG_create_environment(const char *file);
275 /************************** Process handling *********************************/
276 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
277 xbt_main_func_t code,
278 void *data, msg_host_t host);
279 XBT_PUBLIC(msg_process_t)
280 MSG_process_create_with_arguments(const char* name, xbt_main_func_t code, void* data, msg_host_t host, int argc,
282 XBT_PUBLIC(msg_process_t)
283 MSG_process_create_with_environment(const char* name, xbt_main_func_t code, void* data, msg_host_t host, int argc,
284 char** argv, xbt_dict_t properties);
286 XBT_PUBLIC(msg_process_t) MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties);
287 XBT_PUBLIC(void) MSG_process_detach();
289 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
290 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
291 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
292 XBT_PUBLIC(void) MSG_process_yield();
294 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
295 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
297 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
298 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
299 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
300 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
301 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
302 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
303 XBT_PUBLIC(int) MSG_process_self_PID();
304 XBT_PUBLIC(int) MSG_process_self_PPID();
305 XBT_PUBLIC(msg_process_t) MSG_process_self();
306 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar();
307 XBT_PUBLIC(int) MSG_process_get_number();
309 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
311 /*property handlers*/
312 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
313 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
317 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
318 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
319 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
320 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data);
321 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
323 XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process);
324 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
325 XBT_PUBLIC(void) MSG_process_ref(msg_process_t process);
326 XBT_PUBLIC(void) MSG_process_unref(msg_process_t process);
328 /************************** Task handling ************************************/
329 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
331 double bytes_amount, void *data);
332 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
334 const msg_host_t * host_list,
335 double *flops_amount,
336 double *bytes_amount,
338 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
339 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
340 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
341 msg_task_t task, msg_process_t src, msg_process_t dst));
342 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
343 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
344 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
345 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
346 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
347 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
349 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
350 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
351 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout);
352 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
353 XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound);
355 XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout);
356 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
358 XBT_PUBLIC(void) MSG_task_set_flops_amount(msg_task_t task,
359 double flops_amount);
360 XBT_PUBLIC(double) MSG_task_get_flops_amount(msg_task_t task);
361 XBT_PUBLIC(void) MSG_task_set_bytes_amount(msg_task_t task,
362 double bytes_amount);
364 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
365 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
366 XBT_PUBLIC(double) MSG_task_get_bytes_amount(msg_task_t task);
369 XBT_PUBLIC(msg_error_t)
370 MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
373 XBT_PUBLIC(msg_error_t)
374 MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
377 XBT_PUBLIC(msg_error_t)
378 MSG_task_receive(msg_task_t * task, const char *alias);
379 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
383 XBT_PUBLIC(msg_error_t)
384 MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
385 msg_host_t host, double rate);
387 XBT_PUBLIC(msg_error_t) MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, double timeout, double rate);
388 XBT_PUBLIC(msg_error_t) MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
389 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
391 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
392 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
393 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task, const char *alias,
394 int (*match_fun)(void*,void*, smx_activity_t), void *match_data);
396 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
397 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
398 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
399 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
400 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
401 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
402 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
403 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
404 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout);
405 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
406 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
407 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
409 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
410 XBT_PUBLIC(msg_error_t) MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout);
411 XBT_PUBLIC(msg_error_t) MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate);
412 XBT_PUBLIC(msg_error_t) MSG_task_send(msg_task_t task, const char *alias);
413 XBT_PUBLIC(msg_error_t) MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
414 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
415 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
416 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
418 /************************** Mailbox handling ************************************/
420 /* @brief MSG_mailbox_set_async - set a mailbox as eager
421 * Sets the mailbox to a permanent receiver mode. Messages sent to this mailbox will then be sent just after the send
422 * is issued, without waiting for the corresponding receive.
423 * This call should be done before issuing any receive, and on the receiver's side only
424 * @param alias The alias of the mailbox to modify.
426 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
428 /************************** Action handling **********************************/
429 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
430 XBT_PUBLIC(void) MSG_action_init();
431 XBT_PUBLIC(void) MSG_action_exit();
433 /** @brief Opaque type representing a semaphore
434 * @ingroup msg_synchro
437 typedef struct s_smx_sem *msg_sem_t; // Yeah that's a rename of the smx_sem_t which doesnt require smx_sem_t to be declared here
438 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
439 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
440 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
441 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
442 XBT_PUBLIC(int) MSG_sem_get_capacity(msg_sem_t sem);
443 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
444 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
446 /** @brief Opaque type representing a barrier identifier
447 * @ingroup msg_synchro
451 #define MSG_BARRIER_SERIAL_PROCESS -1
452 typedef struct s_msg_bar* msg_bar_t;
453 XBT_PUBLIC(msg_bar_t) MSG_barrier_init( unsigned int count);
454 XBT_PUBLIC(void) MSG_barrier_destroy(msg_bar_t bar);
455 XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
457 /** @brief Opaque type describing a Virtual Machine.
460 * All this is highly experimental and the interface will probably change in the future.
461 * Please don't depend on this yet (although testing is welcomed if you feel so).
462 * Usual lack of guaranty of any kind applies here, and is even increased.
466 XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t vm);
467 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t vm);
468 XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t vm);
469 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t vm);
471 #define MSG_vm_get_name(vm) MSG_host_get_name(vm)
473 XBT_PUBLIC(void) MSG_vm_get_params(msg_vm_t vm, vm_params_t params);
474 XBT_PUBLIC(void) MSG_vm_set_params(msg_vm_t vm, vm_params_t params);
476 // TODO add VDI later
477 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
478 XBT_PUBLIC(msg_vm_t) MSG_vm_create_multicore(msg_host_t pm, const char* name, int coreAmount);
480 MSG_vm_create(msg_host_t ind_pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity);
482 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
484 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t vm);
486 /* Shutdown the guest operating system. */
487 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
489 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
491 /* Suspend the execution of the VM, but keep its state on memory. */
492 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
493 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
495 XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
496 XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
499 #include "simgrid/instr.h"
501 /* ****************************************************************************************** */
502 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
503 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
506 /* Functions renamed in 3.14 */
507 #define MSG_mailbox_get_head(m) MSG_mailbox_front(m)
513 XBT_PUBLIC(msg_process_t)
514 MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
515 xbt_dict_t properties);