1 /* Copyright (c) 2004-2019. 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. */
6 #include "simgrid/Exception.hpp"
7 #include "src/msg/msg_private.hpp"
9 #define MSG_CALL(type, oldname, args)
11 /* ************************** Engine *************************** */
12 void MSG_create_environment(const char* filename)
14 simgrid_load_platform(filename);
17 void MSG_launch_application(const char* filename)
19 simgrid_load_deployment(filename);
21 msg_error_t MSG_main()
26 void MSG_function_register(const char* name, xbt_main_func_t code)
28 simgrid_register_function(name, code);
30 void MSG_function_register_default(xbt_main_func_t code)
32 simgrid_register_default(code);
34 double MSG_get_clock()
36 return simgrid_get_clock();
39 /* ************************** Mailboxes ************************ */
40 void MSG_mailbox_set_async(const char* alias)
42 sg_mailbox_set_receiver(alias);
44 int MSG_task_listen(const char* alias)
46 return sg_mailbox_listen(alias);
49 /* ************************** Actors *************************** */
50 int MSG_process_get_PID(const_sg_actor_t actor)
52 return sg_actor_get_PID(actor);
54 int MSG_process_get_PPID(const_sg_actor_t actor)
56 return sg_actor_get_PPID(actor);
58 msg_process_t MSG_process_from_PID(int PID)
60 return sg_actor_by_PID(PID);
62 const char* MSG_process_get_name(const_sg_actor_t actor)
64 return sg_actor_get_name(actor);
66 sg_host_t MSG_process_get_host(const_sg_actor_t actor)
68 return sg_actor_get_host(actor);
70 xbt_dict_t MSG_process_get_properties(const_sg_actor_t actor)
72 return sg_actor_get_properties(actor);
74 const char* MSG_process_get_property_value(const_sg_actor_t actor, const char* name)
76 return sg_actor_get_property_value(actor, name);
78 void MSG_process_suspend(sg_actor_t actor)
80 sg_actor_suspend(actor);
82 void MSG_process_resume(sg_actor_t actor)
84 sg_actor_resume(actor);
86 int MSG_process_is_suspended(sg_actor_t actor)
88 return sg_actor_is_suspended(actor);
90 void MSG_process_restart(sg_actor_t actor)
92 sg_actor_restart(actor);
94 void MSG_process_auto_restart_set(sg_actor_t actor, int auto_restart)
96 sg_actor_set_auto_restart(actor, auto_restart);
99 void MSG_process_daemonize(sg_actor_t actor)
101 sg_actor_daemonize(actor);
103 void MSG_process_migrate(sg_actor_t actor, sg_host_t host)
105 sg_actor_set_host(actor, host);
107 void MSG_process_join(sg_actor_t actor, double timeout)
109 sg_actor_join(actor, timeout);
111 void MSG_process_kill(sg_actor_t actor)
113 sg_actor_kill(actor);
115 void MSG_process_killall()
119 void MSG_process_set_kill_time(sg_actor_t actor, double kill_time)
121 sg_actor_set_kill_time(actor, kill_time);
123 void MSG_process_yield()
128 msg_error_t MSG_process_sleep(double duration)
131 sg_actor_sleep_for(duration);
133 } catch (const simgrid::HostFailureException&) {
134 return MSG_HOST_FAILURE;
138 /** @brief Returns the user data of a process.
140 * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
142 void* MSG_process_get_data(const_sg_actor_t process)
144 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
146 /* get from SIMIX the MSG process data, and then the user data */
147 return sg_actor_data(process);
150 /** @brief Sets the user data of a process.
152 * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
154 msg_error_t MSG_process_set_data(msg_process_t process, void* data)
156 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
157 sg_actor_data_set(process, data);
162 msg_process_t MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties)
164 return sg_actor_attach(name, data, host, properties);
167 void MSG_process_detach()
171 aid_t MSG_process_self_PID()
173 return sg_actor_self_get_pid();
176 /** @brief Return the PPID of the current process.
178 * This function returns the PID of the parent of the currently running #msg_process_t.
180 aid_t MSG_process_self_PPID()
182 return sg_actor_self_get_ppid();
185 /** @brief Return the name of the current process. */
186 const char* MSG_process_self_name()
188 return sg_actor_self_get_name();
190 /** @brief Return the current process.
192 * This function returns the currently running #msg_process_t.
194 msg_process_t MSG_process_self()
196 return sg_actor_self();
199 /** @brief Take an extra reference on that process to prevent it to be garbage-collected */
200 void MSG_process_ref(msg_process_t process)
202 sg_actor_ref(process);
204 /** @brief Release a reference on that process so that it can get be garbage-collected */
205 void MSG_process_unref(msg_process_t process)
207 sg_actor_unref(process);
209 /** @brief Return the current number MSG processes. */
210 int MSG_process_get_number()
212 return simgrid_get_actor_count();
214 /* ************************** NetZones *************************** */
215 sg_netzone_t MSG_zone_get_root()
217 return sg_zone_get_root();
219 const char* MSG_zone_get_name(sg_netzone_t zone)
221 return sg_zone_get_name(zone);
223 sg_netzone_t MSG_zone_get_by_name(const char* name)
225 return sg_zone_get_by_name(name);
227 void MSG_zone_get_sons(sg_netzone_t zone, xbt_dict_t whereto)
229 return sg_zone_get_sons(zone, whereto);
231 const char* MSG_zone_get_property_value(sg_netzone_t zone, const char* name)
233 return sg_zone_get_property_value(zone, name);
235 void MSG_zone_set_property_value(sg_netzone_t zone, const char* name, char* value)
237 sg_zone_set_property_value(zone, name, value);
239 void MSG_zone_get_hosts(sg_netzone_t zone, xbt_dynar_t whereto)
241 sg_zone_get_hosts(zone, whereto);
244 /* ************************** Storages *************************** */
245 const char* MSG_storage_get_name(sg_storage_t storage)
247 return sg_storage_get_name(storage);
249 sg_storage_t MSG_storage_get_by_name(const char* name)
251 return sg_storage_get_by_name(name);
253 xbt_dict_t MSG_storage_get_properties(sg_storage_t storage)
255 return sg_storage_get_properties(storage);
257 void MSG_storage_set_property_value(sg_storage_t storage, const char* name, const char* value)
259 sg_storage_set_property_value(storage, name, value);
261 const char* MSG_storage_get_property_value(sg_storage_t storage, const char* name)
263 return sg_storage_get_property_value(storage, name);
265 xbt_dynar_t MSG_storages_as_dynar()
267 return sg_storages_as_dynar();
269 void MSG_storage_set_data(sg_storage_t storage, void* data)
271 sg_storage_set_data(storage, data);
273 void* MSG_storage_get_data(sg_storage_t storage)
275 return sg_storage_get_data(storage);
277 const char* MSG_storage_get_host(sg_storage_t storage)
279 return sg_storage_get_host(storage);
281 sg_size_t MSG_storage_read(sg_storage_t storage, sg_size_t size)
283 return sg_storage_read(storage, size);
285 sg_size_t MSG_storage_write(sg_storage_t storage, sg_size_t size)
287 return sg_storage_write(storage, size);
290 /* ************************** hosts *************************** */
291 xbt_dynar_t MSG_hosts_as_dynar()
293 return sg_hosts_as_dynar();
295 size_t MSG_get_host_number()
297 return sg_host_count();
299 sg_host_t MSG_get_host_by_name(const char* name)
301 return sg_host_by_name(name);
303 sg_host_t MSG_host_by_name(const char* name)
305 return sg_host_by_name(name);
307 const char* MSG_host_get_name(const_sg_host_t host)
309 return sg_host_get_name(host);
311 void* MSG_host_get_data(const_sg_host_t host)
313 return sg_host_data(host);
315 void MSG_host_set_data(sg_host_t host, void* data)
317 return sg_host_data_set(host, data);
319 xbt_dict_t MSG_host_get_mounted_storage_list(sg_host_t host)
321 return sg_host_get_mounted_storage_list(host);
323 xbt_dynar_t MSG_host_get_attached_storage_lists(const_sg_host_t host)
325 return sg_host_get_attached_storage_list(host);
327 double MSG_host_get_speed(const_sg_host_t host)
329 return sg_host_speed(host);
331 double MSG_host_get_power_peak_at(const_sg_host_t host, int pstate_index)
333 return sg_host_get_pstate_speed(host, pstate_index);
335 int MSG_host_get_core_number(const_sg_host_t host)
337 return sg_host_core_count(host);
339 int MSG_host_get_nb_pstates(const_sg_host_t host)
341 return sg_host_get_nb_pstates(host);
343 int MSG_host_get_pstate(const_sg_host_t host)
345 return sg_host_get_pstate(host);
347 void MSG_host_set_pstate(sg_host_t host, int pstate)
349 sg_host_set_pstate(host, pstate);
351 void MSG_host_on(sg_host_t h)
355 void MSG_host_off(sg_host_t h)
359 int MSG_host_is_on(const_sg_host_t h)
361 return sg_host_is_on(h);
363 xbt_dict_t MSG_host_get_properties(const_sg_host_t host)
365 return sg_host_get_properties(host);
367 const char* MSG_host_get_property_value(const_sg_host_t host, const char* name)
369 return sg_host_get_property_value(host, name);
371 void MSG_host_set_property_value(sg_host_t host, const char* name, const char* value)
373 sg_host_set_property_value(host, name, value);
375 void MSG_host_get_process_list(const_sg_host_t host, xbt_dynar_t whereto)
377 sg_host_get_actor_list(host, whereto);
379 sg_host_t MSG_host_self()
381 return sg_host_self();
384 double MSG_host_get_load(const_sg_host_t host)
386 return sg_host_load(host);
388 /* ************************** Virtual Machines *************************** */
389 sg_vm_t MSG_vm_create_core(sg_host_t pm, const char* name)
391 return sg_vm_create_core(pm, name);
393 sg_vm_t MSG_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
395 return sg_vm_create_multicore(pm, name, coreAmount);
397 int MSG_vm_is_created(sg_vm_t vm)
399 return sg_vm_is_created(vm);
401 int MSG_vm_is_running(sg_vm_t vm)
403 return sg_vm_is_running(vm);
405 int MSG_vm_is_suspended(sg_vm_t vm)
407 return sg_vm_is_suspended(vm);
409 const char* MSG_vm_get_name(const_sg_vm_t vm)
411 return sg_vm_get_name(vm);
413 void MSG_vm_set_ramsize(sg_vm_t vm, size_t size)
415 sg_vm_set_ramsize(vm, size);
417 size_t MSG_vm_get_ramsize(sg_vm_t vm)
419 return sg_vm_get_ramsize(vm);
421 sg_host_t MSG_vm_get_pm(sg_vm_t vm)
423 return sg_vm_get_pm(vm);
425 void MSG_vm_set_bound(sg_vm_t vm, double bound)
427 sg_vm_set_bound(vm, bound);
429 void MSG_vm_start(sg_vm_t vm)
433 void MSG_vm_suspend(sg_vm_t vm)
437 void MSG_vm_resume(sg_vm_t vm)
441 void MSG_vm_shutdown(sg_vm_t vm)
445 void MSG_vm_destroy(sg_vm_t vm)
449 /********* barriers ************/
450 sg_bar_t MSG_barrier_init(unsigned int count)
452 return sg_barrier_init(count);
455 void MSG_barrier_destroy(const_sg_bar_t bar)
457 sg_barrier_destroy(bar);
460 int MSG_barrier_wait(sg_bar_t bar)
462 return sg_barrier_wait(bar);
465 sg_sem_t MSG_sem_init(int initial_value)
467 return sg_sem_init(initial_value);
469 void MSG_sem_acquire(sg_sem_t sem)
473 int MSG_sem_acquire_timeout(sg_sem_t sem, double timeout)
475 return sg_sem_acquire_timeout(sem, timeout);
477 void MSG_sem_release(sg_sem_t sem)
481 int MSG_sem_get_capacity(sg_sem_t sem)
483 return sg_sem_get_capacity(sem);
485 void MSG_sem_destroy(sg_sem_t sem)
489 int MSG_sem_would_block(sg_sem_t sem)
491 return sg_sem_would_block(sem);