1 /* Copyright (c) 2004-2020. 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 "simgrid/s4u/Engine.hpp"
8 #include "src/msg/msg_private.hpp"
9 #include "xbt/functional.hpp"
11 #define MSG_CALL(type, oldname, args)
13 /* ************************** Engine *************************** */
14 void MSG_create_environment(const char* filename)
16 simgrid_load_platform(filename);
19 void MSG_launch_application(const char* filename)
21 simgrid_load_deployment(filename);
23 msg_error_t MSG_main()
28 void MSG_function_register(const char* name, int (*code)(int, char**))
30 simgrid::s4u::Engine::get_instance()->register_function(
31 name, [code](std::vector<std::string> args) { return simgrid::xbt::wrap_main(code, std::move(args)); });
33 void MSG_function_register_default(int (*code)(int, char**))
35 simgrid::s4u::Engine::get_instance()->register_default(
36 [code](std::vector<std::string> args) { return simgrid::xbt::wrap_main(code, std::move(args)); });
38 double MSG_get_clock()
40 return simgrid_get_clock();
43 /* ************************** Mailboxes ************************ */
44 void MSG_mailbox_set_async(const char* alias)
46 sg_mailbox_set_receiver(alias);
48 int MSG_task_listen(const char* alias)
50 return sg_mailbox_listen(alias);
53 /* ************************** Actors *************************** */
54 int MSG_process_get_PID(const_sg_actor_t actor)
56 return sg_actor_get_PID(actor);
58 int MSG_process_get_PPID(const_sg_actor_t actor)
60 return sg_actor_get_PPID(actor);
62 msg_process_t MSG_process_from_PID(int PID)
64 return sg_actor_by_PID(PID);
66 const char* MSG_process_get_name(const_sg_actor_t actor)
68 return sg_actor_get_name(actor);
70 sg_host_t MSG_process_get_host(const_sg_actor_t actor)
72 return sg_actor_get_host(actor);
74 xbt_dict_t MSG_process_get_properties(const_sg_actor_t actor)
76 return sg_actor_get_properties(actor);
78 const char* MSG_process_get_property_value(const_sg_actor_t actor, const char* name)
80 return sg_actor_get_property_value(actor, name);
82 void MSG_process_suspend(sg_actor_t actor)
84 sg_actor_suspend(actor);
86 void MSG_process_resume(sg_actor_t actor)
88 sg_actor_resume(actor);
90 int MSG_process_is_suspended(sg_actor_t actor)
92 return sg_actor_is_suspended(actor);
94 void MSG_process_restart(sg_actor_t actor)
96 sg_actor_restart(actor);
98 void MSG_process_auto_restart_set(sg_actor_t actor, int auto_restart)
100 sg_actor_set_auto_restart(actor, auto_restart);
103 void MSG_process_daemonize(sg_actor_t actor)
105 sg_actor_daemonize(actor);
107 void MSG_process_migrate(sg_actor_t actor, sg_host_t host)
109 sg_actor_set_host(actor, host);
111 void MSG_process_join(sg_actor_t actor, double timeout)
113 sg_actor_join(actor, timeout);
115 void MSG_process_kill(sg_actor_t actor)
117 sg_actor_kill(actor);
119 void MSG_process_killall()
123 void MSG_process_set_kill_time(sg_actor_t actor, double kill_time)
125 sg_actor_set_kill_time(actor, kill_time);
127 void MSG_process_yield()
132 msg_error_t MSG_process_sleep(double duration)
135 sg_actor_sleep_for(duration);
137 } catch (const simgrid::HostFailureException&) {
138 return MSG_HOST_FAILURE;
142 /** @brief Returns the user data of a process.
144 * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
146 void* MSG_process_get_data(const_sg_actor_t process)
148 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
150 /* get from SIMIX the MSG process data, and then the user data */
151 return sg_actor_data(process);
154 /** @brief Sets the user data of a process.
156 * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
158 msg_error_t MSG_process_set_data(msg_process_t process, void* data)
160 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
161 sg_actor_data_set(process, data);
166 msg_process_t MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties)
168 return sg_actor_attach(name, data, host, properties);
171 void MSG_process_detach()
175 aid_t MSG_process_self_PID()
177 return sg_actor_self_get_pid();
180 /** @brief Return the PPID of the current process.
182 * This function returns the PID of the parent of the currently running #msg_process_t.
184 aid_t MSG_process_self_PPID()
186 return sg_actor_self_get_ppid();
189 /** @brief Return the name of the current process. */
190 const char* MSG_process_self_name()
192 return sg_actor_self_get_name();
194 /** @brief Return the current process.
196 * This function returns the currently running #msg_process_t.
198 msg_process_t MSG_process_self()
200 return sg_actor_self();
203 /** @brief Take an extra reference on that process to prevent it to be garbage-collected */
204 void MSG_process_ref(const_sg_actor_t process)
206 sg_actor_ref(process);
208 /** @brief Release a reference on that process so that it can get be garbage-collected */
209 void MSG_process_unref(const_sg_actor_t process)
211 sg_actor_unref(process);
213 /** @brief Return the current number MSG processes. */
214 int MSG_process_get_number()
216 return simgrid_get_actor_count();
218 /* ************************** NetZones *************************** */
219 sg_netzone_t MSG_zone_get_root()
221 return sg_zone_get_root();
223 const char* MSG_zone_get_name(const_sg_netzone_t zone)
225 return sg_zone_get_name(zone);
227 sg_netzone_t MSG_zone_get_by_name(const char* name)
229 return sg_zone_get_by_name(name);
231 void MSG_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
233 return sg_zone_get_sons(zone, whereto);
235 const char* MSG_zone_get_property_value(const_sg_netzone_t zone, const char* name)
237 return sg_zone_get_property_value(zone, name);
239 void MSG_zone_set_property_value(sg_netzone_t zone, const char* name, const char* value)
241 sg_zone_set_property_value(zone, name, value);
243 void MSG_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
245 sg_zone_get_hosts(zone, whereto);
248 /* ************************** Storages *************************** */
249 const char* MSG_storage_get_name(const_sg_storage_t storage)
251 return sg_storage_get_name(storage);
253 sg_storage_t MSG_storage_get_by_name(const char* name)
255 return sg_storage_get_by_name(name);
257 xbt_dict_t MSG_storage_get_properties(const_sg_storage_t storage)
259 return sg_storage_get_properties(storage);
261 void MSG_storage_set_property_value(sg_storage_t storage, const char* name, const char* value)
263 sg_storage_set_property_value(storage, name, value);
265 const char* MSG_storage_get_property_value(const_sg_storage_t storage, const char* name)
267 return sg_storage_get_property_value(storage, name);
269 xbt_dynar_t MSG_storages_as_dynar()
271 return sg_storages_as_dynar();
273 void MSG_storage_set_data(sg_storage_t storage, void* data)
275 sg_storage_set_data(storage, data);
277 void* MSG_storage_get_data(const_sg_storage_t storage)
279 return sg_storage_get_data(storage);
281 const char* MSG_storage_get_host(const_sg_storage_t storage)
283 return sg_storage_get_host(storage);
285 sg_size_t MSG_storage_read(sg_storage_t storage, sg_size_t size)
287 return sg_storage_read(storage, size);
289 sg_size_t MSG_storage_write(sg_storage_t storage, sg_size_t size)
291 return sg_storage_write(storage, size);
294 /* ************************** hosts *************************** */
295 xbt_dynar_t MSG_hosts_as_dynar()
297 return sg_hosts_as_dynar();
299 size_t MSG_get_host_number()
301 return sg_host_count();
303 sg_host_t MSG_get_host_by_name(const char* name)
305 return sg_host_by_name(name);
307 sg_host_t MSG_host_by_name(const char* name)
309 return sg_host_by_name(name);
311 const char* MSG_host_get_name(const_sg_host_t host)
313 return sg_host_get_name(host);
315 void* MSG_host_get_data(const_sg_host_t host)
317 return sg_host_data(host);
319 void MSG_host_set_data(sg_host_t host, void* data)
321 return sg_host_data_set(host, data);
323 xbt_dict_t MSG_host_get_mounted_storage_list(sg_host_t host)
325 return sg_host_get_mounted_storage_list(host);
327 xbt_dynar_t MSG_host_get_attached_storage_lists(const_sg_host_t host)
329 return sg_host_get_attached_storage_list(host);
331 double MSG_host_get_speed(const_sg_host_t host)
333 return sg_host_speed(host);
335 double MSG_host_get_power_peak_at(const_sg_host_t host, int pstate_index)
337 return sg_host_get_pstate_speed(host, pstate_index);
339 int MSG_host_get_core_number(const_sg_host_t host)
341 return sg_host_core_count(host);
343 int MSG_host_get_nb_pstates(const_sg_host_t host)
345 return sg_host_get_nb_pstates(host);
347 int MSG_host_get_pstate(const_sg_host_t host)
349 return sg_host_get_pstate(host);
351 void MSG_host_set_pstate(sg_host_t host, int pstate)
353 sg_host_set_pstate(host, pstate);
355 void MSG_host_on(sg_host_t h)
359 void MSG_host_off(sg_host_t h)
363 int MSG_host_is_on(const_sg_host_t h)
365 return sg_host_is_on(h);
367 xbt_dict_t MSG_host_get_properties(const_sg_host_t host)
369 return sg_host_get_properties(host);
371 const char* MSG_host_get_property_value(const_sg_host_t host, const char* name)
373 return sg_host_get_property_value(host, name);
375 void MSG_host_set_property_value(sg_host_t host, const char* name, const char* value)
377 sg_host_set_property_value(host, name, value);
379 void MSG_host_get_process_list(const_sg_host_t host, xbt_dynar_t whereto)
381 sg_host_get_actor_list(host, whereto);
383 sg_host_t MSG_host_self()
385 return sg_host_self();
388 double MSG_host_get_load(const_sg_host_t host)
390 return sg_host_load(host);
392 /* ************************** Virtual Machines *************************** */
393 sg_vm_t MSG_vm_create_core(sg_host_t pm, const char* name)
395 return sg_vm_create_core(pm, name);
397 sg_vm_t MSG_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
399 return sg_vm_create_multicore(pm, name, coreAmount);
401 int MSG_vm_is_created(sg_vm_t vm)
403 return sg_vm_is_created(vm);
405 int MSG_vm_is_running(sg_vm_t vm)
407 return sg_vm_is_running(vm);
409 int MSG_vm_is_suspended(sg_vm_t vm)
411 return sg_vm_is_suspended(vm);
413 const char* MSG_vm_get_name(const_sg_vm_t vm)
415 return sg_vm_get_name(vm);
417 void MSG_vm_set_ramsize(sg_vm_t vm, size_t size)
419 sg_vm_set_ramsize(vm, size);
421 size_t MSG_vm_get_ramsize(const_sg_vm_t vm)
423 return sg_vm_get_ramsize(vm);
425 sg_host_t MSG_vm_get_pm(const_sg_vm_t vm)
427 return sg_vm_get_pm(vm);
429 void MSG_vm_set_bound(sg_vm_t vm, double bound)
431 sg_vm_set_bound(vm, bound);
433 void MSG_vm_start(sg_vm_t vm)
437 void MSG_vm_suspend(sg_vm_t vm)
441 void MSG_vm_resume(sg_vm_t vm)
445 void MSG_vm_shutdown(sg_vm_t vm)
449 void MSG_vm_destroy(sg_vm_t vm)
453 /********* barriers ************/
454 sg_bar_t MSG_barrier_init(unsigned int count)
456 return sg_barrier_init(count);
459 void MSG_barrier_destroy(const_sg_bar_t bar)
461 sg_barrier_destroy(bar);
464 int MSG_barrier_wait(sg_bar_t bar)
466 return sg_barrier_wait(bar);
469 sg_sem_t MSG_sem_init(int initial_value)
471 return sg_sem_init(initial_value);
473 void MSG_sem_acquire(sg_sem_t sem)
477 int MSG_sem_acquire_timeout(sg_sem_t sem, double timeout)
479 return sg_sem_acquire_timeout(sem, timeout);
481 void MSG_sem_release(sg_sem_t sem)
485 int MSG_sem_get_capacity(sg_sem_t sem)
487 return sg_sem_get_capacity(sem);
489 void MSG_sem_destroy(const_sg_sem_t sem)
493 int MSG_sem_would_block(sg_sem_t sem)
495 return sg_sem_would_block(sem);