X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/88fad0aaff9eb463f048bfdfe4ad6218aba44ddb..9fd6cbc6c3b06f4b09e3c3339ffb3cc8a68f9bfa:/include/simgrid/host.h diff --git a/include/simgrid/host.h b/include/simgrid/host.h index 75aceb87ed..4a72056e6e 100644 --- a/include/simgrid/host.h +++ b/include/simgrid/host.h @@ -6,11 +6,8 @@ #ifndef SIMGRID_HOST_H_ #define SIMGRID_HOST_H_ -#include - #include #include - #include SG_BEGIN_DECL() @@ -24,14 +21,14 @@ SG_BEGIN_DECL() XBT_PUBLIC sg_host_t* sg_host_list(); -/** \ingroup m_host_management - * \brief Return the current number of hosts. +/** @ingroup m_host_management + * @brief Return the current number of hosts. */ XBT_PUBLIC size_t sg_host_count(); -/** \ingroup m_host_management - * \brief Return a dynar containing all the hosts declared at a given point of time (including VMs) - * \remark The host order in the returned array is generally different from the host creation/declaration order in the +/** @ingroup m_host_management + * @brief Return a dynar containing all the hosts declared at a given point of time (including VMs) + * @remark The host order in the returned array is generally different from the host creation/declaration order in the * XML platform (we use a hash table internally) */ XBT_PUBLIC xbt_dynar_t sg_hosts_as_dynar(); @@ -39,55 +36,55 @@ XBT_PUBLIC xbt_dynar_t sg_hosts_as_dynar(); XBT_PUBLIC size_t sg_host_extension_create(void (*deleter)(void*)); XBT_PUBLIC void* sg_host_extension_get(sg_host_t host, size_t rank); -/** \ingroup m_host_management - * \brief Finds a sg_host_t using its name. +/** @ingroup m_host_management + * @brief Finds a sg_host_t using its name. * * This is a name directory service - * \param name the name of an host. - * \return the corresponding host + * @param name the name of an host. + * @return the corresponding host */ XBT_PUBLIC sg_host_t sg_host_by_name(const char* name); -/** \ingroup m_host_management +/** @ingroup m_host_management * - * \brief Return the name of the #sg_host_t. */ + * @brief Return the name of the #sg_host_t. */ XBT_PUBLIC const char* sg_host_get_name(sg_host_t host); // ========== User Data ============== -/** \ingroup m_host_management +/** @ingroup m_host_management * - * \brief Return the user data of a #sg_host_t. + * @brief Return the user data of a #sg_host_t. * - * This functions returns the user data associated to \a host if it is possible. + * This functions returns the user data associated to @a host if it is possible. */ XBT_PUBLIC void* sg_host_user(sg_host_t host); -/** \ingroup m_host_management +/** @ingroup m_host_management * - * \brief Set the user data of a #sg_host_t. + * @brief Set the user data of a #sg_host_t. * - * This functions attach \a data to \a host if it is possible. + * This functions attach @a data to @a host if it is possible. */ XBT_PUBLIC void sg_host_user_set(sg_host_t host, void* userdata); XBT_PUBLIC void sg_host_user_destroy(sg_host_t host); // ========= storage related functions ============ -/** \ingroup m_host_management - * \brief Return the list of mount point names on an host. - * \param host a host - * \return a dict containing all mount point on the host (mount_name => sg_storage_t) +/** @ingroup m_host_management + * @brief Return the list of mount point names on an host. + * @param host a host + * @return a dict containing all mount point on the host (mount_name => sg_storage_t) */ XBT_PUBLIC xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host); -/** \ingroup m_host_management - * \brief Return the list of storages attached to an host. - * \param host a host - * \return a dynar containing all storages (name) attached to the host +/** @ingroup m_host_management + * @brief Return the list of storages attached to an host. + * @param host a host + * @return a dynar containing all storages (name) attached to the host */ XBT_PUBLIC xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host); // =========== user-level functions =============== -/** \ingroup m_host_management - * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine. +/** @ingroup m_host_management + * @brief Return the speed of the processor (in flop/s), regardless of the current load on the machine. */ XBT_PUBLIC double sg_host_speed(sg_host_t host); XBT_PUBLIC double sg_host_get_pstate_speed(sg_host_t host, int pstate_index); @@ -96,19 +93,18 @@ XBT_PUBLIC double sg_host_get_available_speed(sg_host_t host); XBT_PUBLIC int sg_host_core_count(sg_host_t host); -/** \ingroup m_process_management - * \brief Return the location on which a process is running. - * \param process a process (nullptr means the current one) - * \return the sg_host_t corresponding to the location on which \a process is running. +/** @ingroup m_process_management + * @brief Return the location on which a process is running. + * @return the sg_host_t corresponding to the location on which @a process is running. */ XBT_PUBLIC sg_host_t sg_host_self(); XBT_PUBLIC const char* sg_host_self_get_name(); -/** \ingroup m_host_management - * \brief Return the total count of pstates defined for a host. See also @ref plugin_energy. +/** @ingroup m_host_management + * @brief Return the total count of pstates defined for a host. See also @ref plugin_energy. * - * \param host host to test + * @param host host to test */ XBT_PUBLIC int sg_host_get_nb_pstates(sg_host_t host); @@ -120,29 +116,29 @@ XBT_PUBLIC void sg_host_turn_off(sg_host_t host); XBT_PUBLIC int sg_host_is_on(sg_host_t host); XBT_PUBLIC int sg_host_is_off(sg_host_t host); -/** \ingroup m_host_management - * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host +/** @ingroup m_host_management + * @brief Returns a xbt_dict_t consisting of the list of properties assigned to this host * - * \param host a host - * \return a dict containing the properties + * @param host a host + * @return a dict containing the properties */ XBT_PUBLIC xbt_dict_t sg_host_get_properties(sg_host_t host); -/** \ingroup m_host_management - * \brief Returns the value of a given host property +/** @ingroup m_host_management + * @brief Returns the value of a given host property * - * \param host a host - * \param name a property name - * \return value of a property (or nullptr if property not set) + * @param host a host + * @param name a property name + * @return value of a property (or nullptr if property not set) */ XBT_PUBLIC const char* sg_host_get_property_value(sg_host_t host, const char* name); -/** \ingroup m_host_management - * \brief Change the value of a given host property +/** @ingroup m_host_management + * @brief Change the value of a given host property * - * \param host a host - * \param name a property name - * \param value what to change the property to + * @param host a host + * @param name a property name + * @param value what to change the property to */ XBT_PUBLIC void sg_host_set_property_value(sg_host_t host, const char* name, const char* value);