include/simgrid/host.h

   1 /* Copyright (c) 2013-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_HOST_H_
   7 #define SIMGRID_HOST_H_
   8
   9 #include <xbt/dict.h>
  10 #include <xbt/dynar.h>
  11 #include <simgrid/forward.h>
  12
  13 SG_BEGIN_DECL
  14 /** Returns an array of all existing hosts (use sg_host_count() to know the array size).
  15  *
  16  * @remark The host order in this array is generally different from the
  17  * creation/declaration order in the XML platform (we use a hash table
  18  * internally).
  19  */
  20 XBT_PUBLIC sg_host_t* sg_host_list();
  21
  22 /** Returns the amount of hosts existing in the platform. */
  23 XBT_PUBLIC size_t sg_host_count();
  24
  25 /**
  26  * @brief Return a dynar containing all the hosts declared at a given point of time (including VMs)
  27  * @remark The host order in the returned array is generally different from the host creation/declaration order in the
  28  *         XML platform (we use a hash table internally)
  29  */
  30 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_list()") XBT_PUBLIC xbt_dynar_t sg_hosts_as_dynar();
  31
  32 XBT_PUBLIC size_t sg_host_extension_create(void (*deleter)(void*));
  33 XBT_PUBLIC void* sg_host_extension_get(const_sg_host_t host, size_t rank);
  34
  35 /** Finds a host from its name */
  36 XBT_PUBLIC sg_host_t sg_host_by_name(const char* name);
  37
  38 /** @brief Return the name of the sg_host_t. */
  39 XBT_PUBLIC const char* sg_host_get_name(const_sg_host_t host);
  40
  41 #ifndef DOXYGEN
  42 // ========== User Data ==============
  43 /** @brief Return the user data of a #sg_host_t.
  44  *
  45  * This functions returns the user data associated to @a host if any.
  46  */
  47 XBT_PUBLIC void* sg_host_get_data(const_sg_host_t host);
  48 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_get_data()") XBT_PUBLIC void* sg_host_data(const_sg_host_t host);
  49 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_get_data()") XBT_PUBLIC void* sg_host_user(sg_host_t host);
  50 /** @brief Set the user data of a #sg_host_t.
  51  *
  52  * This functions attach @a data to @a host.
  53  */
  54 XBT_PUBLIC void sg_host_set_data(sg_host_t host, void* userdata);
  55 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_set_data()") XBT_PUBLIC
  56     void sg_host_data_set(sg_host_t host, void* userdata);
  57 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_set_data()") XBT_PUBLIC
  58     void sg_host_user_set(sg_host_t host, void* userdata);
  59 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_set_data(h, NULL)") XBT_PUBLIC void sg_host_user_destroy(sg_host_t host);
  60 #endif
  61
  62 // ========= storage related functions ============
  63 XBT_PUBLIC void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks);
  64
  65 // =========== user-level functions ===============
  66 /** @brief Return the speed of the processor (in flop/s), regardless of the current load on the machine. */
  67 XBT_PUBLIC double sg_host_get_speed(const_sg_host_t host);
  68 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_get_speed()") XBT_PUBLIC double sg_host_speed(const_sg_host_t host);
  69 XBT_PUBLIC double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index);
  70
  71 XBT_PUBLIC double sg_host_get_available_speed(const_sg_host_t host);
  72
  73 XBT_PUBLIC int sg_host_core_count(const_sg_host_t host);
  74
  75 /** @brief Returns the current computation load (in flops per second).
  76  * @param host a host
  77  */
  78 XBT_PUBLIC double sg_host_get_load(const_sg_host_t host);
  79 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_get_load()") XBT_PUBLIC double sg_host_load(const_sg_host_t host);
  80
  81 /** @brief Return the location on which the current process is running. */
  82 XBT_PUBLIC sg_host_t sg_host_self();
  83
  84 XBT_PUBLIC const char* sg_host_self_get_name();
  85
  86 /** @brief Return the total count of pstates defined for a host.
  87  *
  88  * @beginrst
  89  * See also :ref:`plugin_host_energy`.
  90  * @endrst
  91  *
  92  * @param  host host to test
  93  */
  94 XBT_PUBLIC int sg_host_get_nb_pstates(const_sg_host_t host);
  95
  96 XBT_PUBLIC int sg_host_get_pstate(const_sg_host_t host);
  97 XBT_PUBLIC void sg_host_set_pstate(sg_host_t host, int pstate);
  98
  99 XBT_PUBLIC void sg_host_turn_on(sg_host_t host);
 100 XBT_PUBLIC void sg_host_turn_off(sg_host_t host);
 101 XBT_PUBLIC int sg_host_is_on(const_sg_host_t host);
 102
 103 /** @ingroup m_host_management
 104  * @brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 105  *
 106  * @param host a host
 107  * @return a dict containing the properties
 108  */
 109 XBT_PUBLIC xbt_dict_t sg_host_get_properties(const_sg_host_t host);
 110
 111 /** @ingroup m_host_management
 112  * @brief Returns the value of a given host property
 113  *
 114  * @param host a host
 115  * @param name a property name
 116  * @return value of a property (or nullptr if property not set)
 117  */
 118 XBT_PUBLIC const char* sg_host_get_property_value(const_sg_host_t host, const char* name);
 119
 120 /** @ingroup m_host_management
 121  * @brief Change the value of a given host property
 122  *
 123  * @param host a host
 124  * @param name a property name
 125  * @param value what to change the property to
 126  */
 127 XBT_PUBLIC void sg_host_set_property_value(sg_host_t host, const char* name, const char* value);
 128
 129 XBT_PUBLIC void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links);
 130 XBT_PUBLIC double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to);
 131 XBT_PUBLIC double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to);
 132 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_get_route()") XBT_PUBLIC
 133     void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links);
 134 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_get_route_latency()") XBT_PUBLIC
 135     double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to);
 136 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_get_route_bandwidth()") XBT_PUBLIC
 137     double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to);
 138 XBT_PUBLIC void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount);
 139
 140 #ifndef DOXYGEN
 141 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_sendto") inline void sg_host_send_to(sg_host_t from, sg_host_t to,
 142                                                                                     double byte_amount)
 143 {
 144   sg_host_sendto(from, to, byte_amount);
 145 }
 146 #endif
 147
 148 XBT_PUBLIC void sg_host_dump(const_sg_host_t ws);
 149
 150 XBT_PUBLIC void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto);
 151 SG_END_DECL
 152
 153 #endif /* SIMGRID_HOST_H_ */