X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/29a3b2869c0075fc75e8ccc66fc1d9c4c8bf6a85..e04e3ae8fec7cb28eef7705e4aebf2370e6fdd6a:/include/simgrid/host.h diff --git a/include/simgrid/host.h b/include/simgrid/host.h index e75e509845..a7cce00f17 100644 --- a/include/simgrid/host.h +++ b/include/simgrid/host.h @@ -1,4 +1,4 @@ -/* Copyright (c) 2013-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2013-2019. 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. */ @@ -10,23 +10,20 @@ #include #include -SG_BEGIN_DECL() +SG_BEGIN_DECL /** @brief Host datatype. - @ingroup m_host_management - - 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. + * + * 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(); -/** @ingroup m_host_management - * @brief Return the current number of hosts. - */ +/** @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 * XML platform (we use a hash table internally) @@ -36,8 +33,7 @@ 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. +/** @brief Finds a sg_host_t using its name. * * This is a name directory service * @param name the name of an host. @@ -45,47 +41,40 @@ 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); -/** @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 - * - * @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 any. */ -XBT_PUBLIC void* sg_host_user(sg_host_t host); -/** @ingroup m_host_management - * - * @brief Set the user data of a #sg_host_t. +XBT_PUBLIC void* sg_host_data(sg_host_t host); +XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data()") 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. */ -XBT_PUBLIC void sg_host_user_set(sg_host_t host, void* userdata); -XBT_PUBLIC void sg_host_user_destroy(sg_host_t host); +XBT_PUBLIC void sg_host_data_set(sg_host_t host, void* userdata); +XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set()") XBT_PUBLIC + void sg_host_user_set(sg_host_t host, void* userdata); +XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set(h, NULL)") 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. +/** @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. +/** @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. - */ +/** @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); @@ -93,22 +82,17 @@ 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_host_management - * @brief Returns the current computation load (in flops per second). +/** @brief Returns the current computation load (in flops per second). * @param host a host */ XBT_PUBLIC double sg_host_load(sg_host_t host); -/** @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. - */ +/** @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(); -/** @ingroup m_host_management - * @brief Return the total count of pstates defined for a host. See also @ref plugin_energy. +/** @brief Return the total count of pstates defined for a host. See also @ref plugin_energy. * * @param host host to test */ @@ -120,7 +104,6 @@ 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 @@ -151,9 +134,11 @@ XBT_PUBLIC void sg_host_set_property_value(sg_host_t host, const char* name, con 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); +void sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount); + 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() +SG_END_DECL #endif /* SIMGRID_HOST_H_ */