X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/87abed69d2734abfc0474c30b6f6d04b25a2c8ac..93c7b4bd9208b45b5a5899abd1da65262431c33f:/include/simgrid/host.h diff --git a/include/simgrid/host.h b/include/simgrid/host.h index 60696b6496..d65ace35fb 100644 --- a/include/simgrid/host.h +++ b/include/simgrid/host.h @@ -1,5 +1,4 @@ -/* Copyright (c) 2013-2016. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2013-2018. 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. */ @@ -7,163 +6,135 @@ #ifndef SIMGRID_HOST_H_ #define SIMGRID_HOST_H_ -#include - #include #include - #include SG_BEGIN_DECL() +/** @brief Host datatype. + * + * A location (or host) is any possible place where an actor may run. Thus it is represented as a + * physical resource with computing capabilities, some mailboxes to enable running actors to + * communicate with remote ones, and some private data that can be only accessed by local actors. + */ -XBT_PUBLIC(sg_host_t *) sg_host_list(); +XBT_PUBLIC sg_host_t* sg_host_list(); -/** \ingroup m_host_management - * \brief Return the current number MSG hosts. - */ -XBT_PUBLIC(size_t) sg_host_count(); -#define MSG_get_host_number() sg_host_count() +/** @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 +/** + * @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(); -#define MSG_hosts_as_dynar() sg_hosts_as_dynar() +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); +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 msg_host_t using its name. +/** @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); -#define MSG_host_by_name(name) sg_host_by_name(name) -#define MSG_get_host_by_name(n) sg_host_by_name(n) /* Rewrite the old name into the new one transparently */ +XBT_PUBLIC sg_host_t sg_host_by_name(const char* name); -/** \ingroup m_host_management - * - * \brief Return the name of the #msg_host_t. */ -XBT_PUBLIC(const char*) sg_host_get_name(sg_host_t host); -#define MSG_host_get_name(host) sg_host_get_name(host) +/** @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 +/** @brief Return the user data of a #sg_host_t. * - * \brief Return the user data of a #msg_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); -#define MSG_host_get_data(host) sg_host_user(host) -/** \ingroup m_host_management - * - * \brief Set the user data of a #msg_host_t. +XBT_PUBLIC void* sg_host_user(sg_host_t host); +/** @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); -#define MSG_host_set_data(host, data) sg_host_user_set(host, data) -XBT_PUBLIC(void) sg_host_user_destroy(sg_host_t host); +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 => msg_storage_t) +/** @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); -#define MSG_host_get_mounted_storage_list(host) sg_host_get_mounted_storage_list(host) +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 +/** @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); -#define MSG_host_get_attached_storage_list(host) host_get_attached_storage_list(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. - */ -XBT_PUBLIC(double) sg_host_speed(sg_host_t host); -#define MSG_host_get_speed(host) sg_host_speed(host) -XBT_PUBLIC(double) sg_host_get_available_speed(sg_host_t host); +/** @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); + +XBT_PUBLIC double sg_host_get_available_speed(sg_host_t host); -XBT_PUBLIC(int) sg_host_core_count(sg_host_t host); -#define MSG_host_get_core_number(host) sg_host_core_count(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 msg_host_t corresponding to the location on which \a process is running. +/** @brief Returns the current computation load (in flops per second). + * @param host a host */ -XBT_PUBLIC(sg_host_t) sg_host_self(); -#define MSG_host_self() sg_host_self() +XBT_PUBLIC double sg_host_load(sg_host_t host); -XBT_PUBLIC(const char*) sg_host_self_get_name(); +/** @brief Return the location on which the current process is running. */ +XBT_PUBLIC sg_host_t sg_host_self(); -/** \ingroup m_host_management - * \brief Return the total count of pstates defined for a host. See also @ref plugin_energy. +XBT_PUBLIC const char* sg_host_self_get_name(); + +/** @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); -#define MSG_host_get_nb_pstates(host) sg_host_get_nb_pstates(host) - -XBT_PUBLIC(int) sg_host_get_pstate(sg_host_t host); -#define MSG_host_get_pstate(h) sg_host_get_pstate(h) /* users don't know that MSG is the C version of SimGrid */ -XBT_PUBLIC(void) sg_host_set_pstate(sg_host_t host,int pstate); -#define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate) /* (same here) */ - -XBT_PUBLIC(void) sg_host_turn_on(sg_host_t host); -#define MSG_host_on(h) sg_host_turn_on(h) -XBT_PUBLIC(void) sg_host_turn_off(sg_host_t host); -#define MSG_host_off(h) sg_host_turn_off(h) -XBT_PUBLIC(int) sg_host_is_on(sg_host_t host); -#define MSG_host_is_on(h) sg_host_is_on(h) -XBT_PUBLIC(int) sg_host_is_off(sg_host_t host); -#define MSG_host_is_off(h) sg_host_is_off(h) - -/** \ingroup m_host_management - * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host +XBT_PUBLIC int sg_host_get_nb_pstates(sg_host_t host); + +XBT_PUBLIC int sg_host_get_pstate(sg_host_t host); +XBT_PUBLIC void sg_host_set_pstate(sg_host_t host, int pstate); + +XBT_PUBLIC void sg_host_turn_on(sg_host_t host); +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 * - * \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); -#define MSG_host_get_properties(host) sg_host_get_properties(host) +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); -#define MSG_host_get_property_value(host, name) sg_host_get_property_value(host, name) +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); -#define MSG_host_set_property_value(host, name, value) sg_host_set_property_value(host, name, value) +XBT_PUBLIC void sg_host_set_property_value(sg_host_t host, const char* name, const char* value); + +XBT_PUBLIC void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links); +XBT_PUBLIC double sg_host_route_latency(sg_host_t from, sg_host_t to); +XBT_PUBLIC double sg_host_route_bandwidth(sg_host_t from, sg_host_t to); +XBT_PUBLIC void sg_host_dump(sg_host_t ws); -XBT_PUBLIC(void) sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links); -XBT_PUBLIC(double) sg_host_route_latency(sg_host_t from, sg_host_t to); -XBT_PUBLIC(double) sg_host_route_bandwidth(sg_host_t from, sg_host_t to); -XBT_PUBLIC(void) sg_host_dump(sg_host_t ws); +XBT_PUBLIC void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto); SG_END_DECL() #endif /* SIMGRID_HOST_H_ */