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 void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data)
56 sg_actor_on_exit(fun, data);
59 int MSG_process_get_PID(const_sg_actor_t actor)
61 return sg_actor_get_PID(actor);
63 int MSG_process_get_PPID(const_sg_actor_t actor)
65 return sg_actor_get_PPID(actor);
67 msg_process_t MSG_process_from_PID(int PID)
69 return sg_actor_by_PID(PID);
71 const char* MSG_process_get_name(const_sg_actor_t actor)
73 return sg_actor_get_name(actor);
75 sg_host_t MSG_process_get_host(const_sg_actor_t actor)
77 return sg_actor_get_host(actor);
79 xbt_dict_t MSG_process_get_properties(const_sg_actor_t actor)
81 return sg_actor_get_properties(actor);
83 const char* MSG_process_get_property_value(const_sg_actor_t actor, const char* name)
85 return sg_actor_get_property_value(actor, name);
87 void MSG_process_suspend(sg_actor_t actor)
89 sg_actor_suspend(actor);
91 void MSG_process_resume(sg_actor_t actor)
93 sg_actor_resume(actor);
95 int MSG_process_is_suspended(sg_actor_t actor)
97 return sg_actor_is_suspended(actor);
99 void MSG_process_restart(sg_actor_t actor)
101 sg_actor_restart(actor);
103 void MSG_process_auto_restart_set(sg_actor_t actor, int auto_restart)
105 sg_actor_set_auto_restart(actor, auto_restart);
108 void MSG_process_daemonize(sg_actor_t actor)
110 sg_actor_daemonize(actor);
112 void MSG_process_migrate(sg_actor_t actor, sg_host_t host)
114 sg_actor_set_host(actor, host);
116 void MSG_process_join(sg_actor_t actor, double timeout)
118 sg_actor_join(actor, timeout);
120 void MSG_process_kill(sg_actor_t actor)
122 sg_actor_kill(actor);
124 void MSG_process_killall()
128 void MSG_process_set_kill_time(sg_actor_t actor, double kill_time)
130 sg_actor_set_kill_time(actor, kill_time);
132 void MSG_process_yield()
137 msg_error_t MSG_process_sleep(double duration)
140 sg_actor_sleep_for(duration);
142 } catch (const simgrid::HostFailureException&) {
143 return MSG_HOST_FAILURE;
147 /** @brief Returns the user data of a process.
149 * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
151 void* MSG_process_get_data(const_sg_actor_t process)
153 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
155 /* get from SIMIX the MSG process data, and then the user data */
156 return sg_actor_data(process);
159 /** @brief Sets the user data of a process.
161 * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
163 msg_error_t MSG_process_set_data(msg_process_t process, void* data)
165 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
166 sg_actor_data_set(process, data);
171 msg_process_t MSG_process_attach(const char* name, void* data, msg_host_t host, xbt_dict_t properties)
173 return sg_actor_attach(name, data, host, properties);
176 void MSG_process_detach()
180 aid_t MSG_process_self_PID()
182 return sg_actor_self_get_pid();
185 /** @brief Return the PPID of the current process.
187 * This function returns the PID of the parent of the currently running #msg_process_t.
189 aid_t MSG_process_self_PPID()
191 return sg_actor_self_get_ppid();
194 /** @brief Return the name of the current process. */
195 const char* MSG_process_self_name()
197 return sg_actor_self_get_name();
199 /** @brief Return the current process.
201 * This function returns the currently running #msg_process_t.
203 msg_process_t MSG_process_self()
205 return sg_actor_self();
208 /** @brief Take an extra reference on that process to prevent it to be garbage-collected */
209 void MSG_process_ref(const_sg_actor_t process)
211 sg_actor_ref(process);
213 /** @brief Release a reference on that process so that it can get be garbage-collected */
214 void MSG_process_unref(const_sg_actor_t process)
216 sg_actor_unref(process);
218 /** @brief Return the current number MSG processes. */
219 int MSG_process_get_number()
221 return simgrid_get_actor_count();
223 /* ************************** NetZones *************************** */
224 sg_netzone_t MSG_zone_get_root()
226 return sg_zone_get_root();
228 const char* MSG_zone_get_name(const_sg_netzone_t zone)
230 return sg_zone_get_name(zone);
232 sg_netzone_t MSG_zone_get_by_name(const char* name)
234 return sg_zone_get_by_name(name);
236 void MSG_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
238 return sg_zone_get_sons(zone, whereto);
240 const char* MSG_zone_get_property_value(const_sg_netzone_t zone, const char* name)
242 return sg_zone_get_property_value(zone, name);
244 void MSG_zone_set_property_value(sg_netzone_t zone, const char* name, const char* value)
246 sg_zone_set_property_value(zone, name, value);
248 void MSG_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
250 sg_zone_get_hosts(zone, whereto);
253 /* ************************** Storages *************************** */
254 const char* MSG_storage_get_name(const_sg_storage_t storage)
256 return sg_storage_get_name(storage);
258 sg_storage_t MSG_storage_get_by_name(const char* name)
260 return sg_storage_get_by_name(name);
262 xbt_dict_t MSG_storage_get_properties(const_sg_storage_t storage)
264 return sg_storage_get_properties(storage);
266 void MSG_storage_set_property_value(sg_storage_t storage, const char* name, const char* value)
268 sg_storage_set_property_value(storage, name, value);
270 const char* MSG_storage_get_property_value(const_sg_storage_t storage, const char* name)
272 return sg_storage_get_property_value(storage, name);
274 xbt_dynar_t MSG_storages_as_dynar()
276 return sg_storages_as_dynar();
278 void MSG_storage_set_data(sg_storage_t storage, void* data)
280 sg_storage_set_data(storage, data);
282 void* MSG_storage_get_data(const_sg_storage_t storage)
284 return sg_storage_get_data(storage);
286 const char* MSG_storage_get_host(const_sg_storage_t storage)
288 return sg_storage_get_host(storage);
290 sg_size_t MSG_storage_read(sg_storage_t storage, sg_size_t size)
292 return sg_storage_read(storage, size);
294 sg_size_t MSG_storage_write(sg_storage_t storage, sg_size_t size)
296 return sg_storage_write(storage, size);
299 /* ************************** hosts *************************** */
300 xbt_dynar_t MSG_hosts_as_dynar()
302 return sg_hosts_as_dynar();
304 size_t MSG_get_host_number()
306 return sg_host_count();
308 sg_host_t MSG_get_host_by_name(const char* name)
310 return sg_host_by_name(name);
312 sg_host_t MSG_host_by_name(const char* name)
314 return sg_host_by_name(name);
316 const char* MSG_host_get_name(const_sg_host_t host)
318 return sg_host_get_name(host);
320 void* MSG_host_get_data(const_sg_host_t host)
322 return sg_host_data(host);
324 void MSG_host_set_data(sg_host_t host, void* data)
326 return sg_host_data_set(host, data);
328 xbt_dict_t MSG_host_get_mounted_storage_list(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
330 return sg_host_get_mounted_storage_list(host);
332 xbt_dynar_t MSG_host_get_attached_storage_lists(const_sg_host_t host)
334 return sg_host_get_attached_storage_list(host);
336 double MSG_host_get_speed(const_sg_host_t host)
338 return sg_host_speed(host);
340 double MSG_host_get_power_peak_at(const_sg_host_t host, int pstate_index)
342 return sg_host_get_pstate_speed(host, pstate_index);
344 int MSG_host_get_core_number(const_sg_host_t host)
346 return sg_host_core_count(host);
348 int MSG_host_get_nb_pstates(const_sg_host_t host)
350 return sg_host_get_nb_pstates(host);
352 int MSG_host_get_pstate(const_sg_host_t host)
354 return sg_host_get_pstate(host);
356 void MSG_host_set_pstate(sg_host_t host, int pstate)
358 sg_host_set_pstate(host, pstate);
360 void MSG_host_on(sg_host_t h)
364 void MSG_host_off(sg_host_t h)
368 int MSG_host_is_on(const_sg_host_t h)
370 return sg_host_is_on(h);
372 xbt_dict_t MSG_host_get_properties(const_sg_host_t host)
374 return sg_host_get_properties(host);
376 const char* MSG_host_get_property_value(const_sg_host_t host, const char* name)
378 return sg_host_get_property_value(host, name);
380 void MSG_host_set_property_value(sg_host_t host, const char* name, const char* value)
382 sg_host_set_property_value(host, name, value);
384 void MSG_host_get_process_list(const_sg_host_t host, xbt_dynar_t whereto)
386 sg_host_get_actor_list(host, whereto);
388 sg_host_t MSG_host_self()
390 return sg_host_self();
393 double MSG_host_get_load(const_sg_host_t host)
395 return sg_host_load(host);
397 /* ************************** Virtual Machines *************************** */
398 sg_vm_t MSG_vm_create_core(sg_host_t pm, const char* name)
400 return sg_vm_create_core(pm, name);
402 sg_vm_t MSG_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
404 return sg_vm_create_multicore(pm, name, coreAmount);
406 int MSG_vm_is_created(sg_vm_t vm)
408 return sg_vm_is_created(vm);
410 int MSG_vm_is_running(sg_vm_t vm)
412 return sg_vm_is_running(vm);
414 int MSG_vm_is_suspended(sg_vm_t vm)
416 return sg_vm_is_suspended(vm);
418 const char* MSG_vm_get_name(const_sg_vm_t vm)
420 return sg_vm_get_name(vm);
422 void MSG_vm_set_ramsize(sg_vm_t vm, size_t size)
424 sg_vm_set_ramsize(vm, size);
426 size_t MSG_vm_get_ramsize(const_sg_vm_t vm)
428 return sg_vm_get_ramsize(vm);
430 sg_host_t MSG_vm_get_pm(const_sg_vm_t vm)
432 return sg_vm_get_pm(vm);
434 void MSG_vm_set_bound(sg_vm_t vm, double bound)
436 sg_vm_set_bound(vm, bound);
438 void MSG_vm_start(sg_vm_t vm)
442 void MSG_vm_suspend(sg_vm_t vm)
446 void MSG_vm_resume(sg_vm_t vm)
450 void MSG_vm_shutdown(sg_vm_t vm)
454 void MSG_vm_destroy(sg_vm_t vm)
458 /********* barriers ************/
459 sg_bar_t MSG_barrier_init(unsigned int count)
461 return sg_barrier_init(count);
464 void MSG_barrier_destroy(const_sg_bar_t bar)
466 sg_barrier_destroy(bar);
469 int MSG_barrier_wait(sg_bar_t bar)
471 return sg_barrier_wait(bar);
474 sg_sem_t MSG_sem_init(int initial_value)
476 return sg_sem_init(initial_value);
478 void MSG_sem_acquire(sg_sem_t sem)
482 int MSG_sem_acquire_timeout(sg_sem_t sem, double timeout)
484 return sg_sem_acquire_timeout(sem, timeout);
486 void MSG_sem_release(sg_sem_t sem)
490 int MSG_sem_get_capacity(sg_sem_t sem)
492 return sg_sem_get_capacity(sem);
494 void MSG_sem_destroy(const_sg_sem_t sem)
498 int MSG_sem_would_block(sg_sem_t sem)
500 return sg_sem_would_block(sem);