X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/424d509a49e75c18f5b4de3b9065f6623b39a0c5..a707ad979be7c88d7581f403661c67598d320d55:/include/simgrid/host.h diff --git a/include/simgrid/host.h b/include/simgrid/host.h index 410091f56f..8d709566b0 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-2022. 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,64 +6,118 @@ #ifndef SIMGRID_HOST_H_ #define SIMGRID_HOST_H_ -#include - #include #include - #include -#ifdef __cplusplus -#include -#endif +SG_BEGIN_DECL +/** Returns an array of all existing hosts (use sg_host_count() to know the array size). + * + * @remark The host order in this array is generally different from the + * creation/declaration order in the XML platform (we use a hash table + * internally). + */ +XBT_PUBLIC sg_host_t* sg_host_list(); -SG_BEGIN_DECL() +/** Returns the amount of hosts existing in the platform. */ +XBT_PUBLIC size_t sg_host_count(); -XBT_PUBLIC(size_t) sg_host_count(); -XBT_PUBLIC(const sg_host_t *) sg_host_list(void); +XBT_PUBLIC size_t sg_host_extension_create(void (*deleter)(void*)); +XBT_PUBLIC void* sg_host_extension_get(const_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); -XBT_PUBLIC(sg_host_t) sg_host_by_name(const char *name); -XBT_PUBLIC(sg_host_t) sg_host_by_name_or_create(const char *name); -XBT_PUBLIC(const char*) sg_host_get_name(sg_host_t host); -XBT_PUBLIC(xbt_dynar_t) sg_hosts_as_dynar(void); - -// ========== User Data ============== -XBT_PUBLIC(void*) sg_host_user(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); +/** Finds a host from its name */ +XBT_PUBLIC sg_host_t sg_host_by_name(const char* name); -// ========== MSG Layer ============== -typedef struct s_msg_host_priv *msg_host_priv_t; -msg_host_priv_t sg_host_msg(sg_host_t host); -XBT_PUBLIC(void) sg_host_msg_set(sg_host_t host, msg_host_priv_t priv); +/** @brief Return the name of the sg_host_t. */ +XBT_PUBLIC const char* sg_host_get_name(const_sg_host_t host); -// ========== Simix layer ============= -typedef struct s_smx_host_priv *smx_host_priv_t; -XBT_PUBLIC(smx_host_priv_t) sg_host_simix(sg_host_t host); -XBT_PUBLIC(void) sg_host_simix_set(sg_host_t host, smx_host_priv_t priv); -XBT_PUBLIC(void) sg_host_simix_destroy(sg_host_t host); - -// Module initializer. Won't survive the conversion to C++. Hopefully. -XBT_PUBLIC(void) sg_host_init(void); +// ========== User Data ============== +/** @brief Return the user data of a #sg_host_t. + * + * This functions returns the user data associated to @a host if any. + */ +XBT_PUBLIC void* sg_host_get_data(const_sg_host_t host); + +/** @brief Set the user data of a #sg_host_t. + * + * This functions attach @a data to @a host. + */ +XBT_PUBLIC void sg_host_set_data(sg_host_t host, void* userdata); // ========= storage related functions ============ -XBT_PUBLIC(xbt_dict_t) sg_host_get_mounted_storage_list(sg_host_t host); -XBT_PUBLIC(xbt_dynar_t) sg_host_get_attached_storage_list(sg_host_t host); +XBT_PUBLIC void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks); + // =========== user-level functions =============== -XBT_PUBLIC(double) sg_host_speed(sg_host_t host); -XBT_PUBLIC(double) sg_host_get_available_speed(sg_host_t host); -XBT_PUBLIC(int) sg_host_core_count(sg_host_t host); -XBT_PUBLIC(int) sg_host_is_on(sg_host_t 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(xbt_dict_t) sg_host_get_properties(sg_host_t host); -XBT_PUBLIC(const char *) sg_host_get_property_value(sg_host_t host, - const char *name); -XBT_PUBLIC(void) sg_host_dump(sg_host_t ws); -SG_END_DECL() +/** @brief Return the speed of the processor (in flop/s), regardless of the current load on the machine. */ +XBT_PUBLIC double sg_host_get_speed(const_sg_host_t host); +XBT_PUBLIC double sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index); + +XBT_PUBLIC double sg_host_get_available_speed(const_sg_host_t host); + +XBT_PUBLIC int sg_host_core_count(const_sg_host_t host); + +/** @brief Returns the current computation load (in flops per second). + * @param host a host + */ +XBT_PUBLIC double sg_host_get_load(const_sg_host_t host); + +/** @brief Return the location on which the current process is running. */ +XBT_PUBLIC sg_host_t sg_host_self(); + +XBT_PUBLIC const char* sg_host_self_get_name(); + +/** @brief Return the total count of pstates defined for a host. + * + * @beginrst + * See also :ref:`plugin_host_energy`. + * @endrst + * + * @param host host to test + */ +XBT_PUBLIC unsigned long sg_host_get_nb_pstates(const_sg_host_t host); + +XBT_PUBLIC unsigned long sg_host_get_pstate(const_sg_host_t host); +XBT_PUBLIC void sg_host_set_pstate(sg_host_t host, unsigned long 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(const_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 + */ +XBT_PUBLIC xbt_dict_t sg_host_get_properties(const_sg_host_t host); + +/** @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) + */ +XBT_PUBLIC const char* sg_host_get_property_value(const_sg_host_t host, const char* name); + +/** @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 + */ +XBT_PUBLIC void sg_host_set_property_value(sg_host_t host, const char* name, const char* value); + +XBT_PUBLIC void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links); +XBT_PUBLIC double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to); +XBT_PUBLIC double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to); +XBT_PUBLIC void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount); + +XBT_ATTRIB_DEPRECATED_v335("Please manifest if you actually need this function") XBT_PUBLIC + void sg_host_dump(const_sg_host_t ws); + +XBT_PUBLIC void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto); +SG_END_DECL #endif /* SIMGRID_HOST_H_ */