X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/75e8b2ae65722d849ef899616de7091286ec91f5..8c951864f05ce6317348dc112454f00c92a4659c:/include/simgrid/msg.h diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h index 059ee658a4..70bc569741 100644 --- a/include/simgrid/msg.h +++ b/include/simgrid/msg.h @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -67,12 +67,12 @@ typedef enum { typedef sg_netzone_t msg_netzone_t; XBT_PUBLIC msg_netzone_t MSG_zone_get_root(); -XBT_PUBLIC const char* MSG_zone_get_name(msg_netzone_t zone); +XBT_PUBLIC const char* MSG_zone_get_name(const_sg_netzone_t zone); XBT_PUBLIC msg_netzone_t MSG_zone_get_by_name(const char* name); -XBT_PUBLIC void MSG_zone_get_sons(msg_netzone_t zone, xbt_dict_t whereto); -XBT_PUBLIC const char* MSG_zone_get_property_value(msg_netzone_t zone, const char* name); -XBT_PUBLIC void MSG_zone_set_property_value(msg_netzone_t zone, const char* name, char* value); -XBT_PUBLIC void MSG_zone_get_hosts(msg_netzone_t zone, xbt_dynar_t whereto); +XBT_PUBLIC void MSG_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto); +XBT_PUBLIC const char* MSG_zone_get_property_value(const_sg_netzone_t zone, const char* name); +XBT_PUBLIC void MSG_zone_set_property_value(msg_netzone_t zone, const char* name, const char* value); +XBT_PUBLIC void MSG_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto); /* ******************************** Hosts ************************************ */ /** @brief Host datatype. @@ -113,14 +113,18 @@ XBT_PUBLIC int MSG_host_get_pstate(const_sg_host_t host); XBT_PUBLIC void MSG_host_set_pstate(sg_host_t host, int pstate); /** @brief Start the host if it is off * - * See also #MSG_host_is_on() to test the current state of the host and @ref SURF_plugin_energy + * @beginrst + * See also :cpp:func:`MSG_host_is_on()` to test the current state of the host, and :ref:`plugin_host_energy` * for more info on DVFS. + * @endrst */ XBT_PUBLIC void MSG_host_on(sg_host_t h); /** @brief Stop the host if it is on * - * See also MSG_host_is_on() to test the current state of the host and @ref SURF_plugin_energy + * @beginrst + * See also :cpp:func:`MSG_host_is_on()` to test the current state of the host, and :ref:`plugin_host_energy` * for more info on DVFS. + * @endrst */ XBT_PUBLIC void MSG_host_off(sg_host_t h); XBT_PUBLIC int MSG_host_is_on(const_sg_host_t h); @@ -145,8 +149,8 @@ XBT_PUBLIC int MSG_vm_is_suspended(msg_vm_t vm); XBT_PUBLIC const char* MSG_vm_get_name(const_sg_vm_t vm); XBT_PUBLIC void MSG_vm_set_ramsize(msg_vm_t vm, size_t size); -XBT_PUBLIC size_t MSG_vm_get_ramsize(msg_vm_t vm); -XBT_PUBLIC msg_host_t MSG_vm_get_pm(msg_vm_t vm); +XBT_PUBLIC size_t MSG_vm_get_ramsize(const_sg_vm_t vm); +XBT_PUBLIC msg_host_t MSG_vm_get_pm(const_sg_vm_t vm); XBT_PUBLIC void MSG_vm_set_bound(msg_vm_t vm, double bound); XBT_PUBLIC void MSG_vm_start(msg_vm_t vm); @@ -158,15 +162,15 @@ XBT_PUBLIC void MSG_vm_destroy(msg_vm_t vm); /* ******************************** Storage ********************************* */ typedef sg_storage_t msg_storage_t; -XBT_PUBLIC const char* MSG_storage_get_name(msg_storage_t storage); +XBT_PUBLIC const char* MSG_storage_get_name(const_sg_storage_t storage); XBT_PUBLIC msg_storage_t MSG_storage_get_by_name(const char* name); -XBT_PUBLIC xbt_dict_t MSG_storage_get_properties(msg_storage_t storage); +XBT_PUBLIC xbt_dict_t MSG_storage_get_properties(const_sg_storage_t storage); XBT_PUBLIC void MSG_storage_set_property_value(msg_storage_t storage, const char* name, const char* value); -XBT_PUBLIC const char* MSG_storage_get_property_value(msg_storage_t storage, const char* name); +XBT_PUBLIC const char* MSG_storage_get_property_value(const_sg_storage_t storage, const char* name); XBT_PUBLIC xbt_dynar_t MSG_storages_as_dynar(); XBT_PUBLIC void MSG_storage_set_data(msg_storage_t storage, void* data); -XBT_PUBLIC void* MSG_storage_get_data(msg_storage_t storage); -XBT_PUBLIC const char* MSG_storage_get_host(msg_storage_t storage); +XBT_PUBLIC void* MSG_storage_get_data(const_sg_storage_t storage); +XBT_PUBLIC const char* MSG_storage_get_host(const_sg_storage_t storage); XBT_PUBLIC sg_size_t MSG_storage_read(msg_storage_t storage, sg_size_t size); XBT_PUBLIC sg_size_t MSG_storage_write(msg_storage_t storage, sg_size_t size); @@ -231,8 +235,8 @@ XBT_PUBLIC msg_process_t MSG_process_self(); XBT_PUBLIC aid_t MSG_process_self_PID(); XBT_PUBLIC aid_t MSG_process_self_PPID(); XBT_PUBLIC const char* MSG_process_self_name(); -XBT_PUBLIC void MSG_process_ref(msg_process_t process); -XBT_PUBLIC void MSG_process_unref(msg_process_t process); +XBT_PUBLIC void MSG_process_ref(const_sg_actor_t process); +XBT_PUBLIC void MSG_process_unref(const_sg_actor_t process); /** @brief Object representing an ongoing communication between processes. * @@ -262,8 +266,10 @@ typedef const sg_msg_Task* const_msg_task_t; /************************** Global ******************************************/ /** @brief set a configuration variable * - * Do --help on any simgrid binary to see the list of currently existing configuration variables, and see Section @ref - * options. + * @beginrst + * Do --help on any simgrid binary to see the list of currently existing configuration variables, and see Section + * :ref:`options`. + * @endrst * * Example: * MSG_config("host/model","ptask_L07"); @@ -385,11 +391,11 @@ XBT_PUBLIC void MSG_task_dsend_bounded(msg_task_t task, const char* alias, void_ XBT_PUBLIC msg_comm_t MSG_task_irecv(msg_task_t* task, const char* alias); XBT_PUBLIC msg_comm_t MSG_task_irecv_bounded(msg_task_t* task, const char* alias, double rate); XBT_PUBLIC int MSG_comm_test(msg_comm_t comm); -XBT_PUBLIC int MSG_comm_testany(xbt_dynar_t comms); +XBT_PUBLIC int MSG_comm_testany(const_xbt_dynar_t comms); XBT_PUBLIC void MSG_comm_destroy(const_msg_comm_t comm); XBT_PUBLIC msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout); XBT_PUBLIC void MSG_comm_waitall(msg_comm_t* comm, int nb_elem, double timeout); -XBT_PUBLIC int MSG_comm_waitany(xbt_dynar_t comms); +XBT_PUBLIC int MSG_comm_waitany(const_xbt_dynar_t comms); XBT_PUBLIC msg_task_t MSG_comm_get_task(const_msg_comm_t comm); XBT_PUBLIC msg_error_t MSG_comm_get_status(const_msg_comm_t comm); @@ -427,7 +433,7 @@ XBT_PUBLIC void MSG_sem_acquire(msg_sem_t sem); XBT_PUBLIC int MSG_sem_acquire_timeout(msg_sem_t sem, double timeout); XBT_PUBLIC void MSG_sem_release(msg_sem_t sem); XBT_PUBLIC int MSG_sem_get_capacity(msg_sem_t sem); -XBT_PUBLIC void MSG_sem_destroy(msg_sem_t sem); +XBT_PUBLIC void MSG_sem_destroy(const_sg_sem_t sem); XBT_PUBLIC int MSG_sem_would_block(msg_sem_t sem); /** @brief Opaque type representing a barrier identifier */