include/simgrid/host.h

   1 /* Copyright (c) 2013-2020. 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_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 an 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_data(const_sg_host_t host);
  48 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data()") XBT_PUBLIC void* sg_host_user(sg_host_t host);
  49 /** @brief Set the user data of a #sg_host_t.
  50  *
  51  * This functions attach @a data to @a host.
  52  */
  53 XBT_PUBLIC void sg_host_data_set(sg_host_t host, void* userdata);
  54 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set()") XBT_PUBLIC
  55     void sg_host_user_set(sg_host_t host, void* userdata);
  56 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set(h, NULL)") XBT_PUBLIC void sg_host_user_destroy(sg_host_t host);
  57 #endif
  58
  59 // ========= storage related functions ============
  60 /** @brief Return the list of mount point names on an host.
  61  * @param host a host
  62  * @return a dict containing all mount point on the host (mount_name => sg_storage_t)
  63  */
  64 XBT_PUBLIC xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host);
  65
  66 /** @brief Return the list of storages attached to an host.
  67  * @param host a host
  68  * @return a dynar containing all storages (name) attached to the host
  69  */
  70 XBT_PUBLIC xbt_dynar_t sg_host_get_attached_storage_list(const_sg_host_t host);
  71
  72 // =========== user-level functions ===============
  73 /** @brief Return the speed of the processor (in flop/s), regardless of the current load on the machine. */
  74 XBT_PUBLIC double sg_host_speed(const_sg_host_t host);
  75 XBT_PUBLIC double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index);
  76
  77 XBT_PUBLIC double sg_host_get_available_speed(const_sg_host_t host);
  78
  79 XBT_PUBLIC int sg_host_core_count(const_sg_host_t host);
  80
  81 /** @brief Returns the current computation load (in flops per second).
  82  * @param host a host
  83  */
  84 XBT_PUBLIC double sg_host_load(const_sg_host_t host);
  85
  86 /** @brief Return the location on which the current process is running. */
  87 XBT_PUBLIC sg_host_t sg_host_self();
  88
  89 XBT_PUBLIC const char* sg_host_self_get_name();
  90
  91 /** @brief Return the total count of pstates defined for a host.
  92  *
  93  * @beginrst
  94  * See also :ref:`plugin_host_energy`.
  95  * @endrst
  96  *
  97  * @param  host host to test
  98  */
  99 XBT_PUBLIC int sg_host_get_nb_pstates(const_sg_host_t host);
 100
 101 XBT_PUBLIC int sg_host_get_pstate(const_sg_host_t host);
 102 XBT_PUBLIC void sg_host_set_pstate(sg_host_t host, int pstate);
 103
 104 XBT_PUBLIC void sg_host_turn_on(sg_host_t host);
 105 XBT_PUBLIC void sg_host_turn_off(sg_host_t host);
 106 XBT_PUBLIC int sg_host_is_on(const_sg_host_t host);
 107
 108 /** @ingroup m_host_management
 109  * @brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 110  *
 111  * @param host a host
 112  * @return a dict containing the properties
 113  */
 114 XBT_PUBLIC xbt_dict_t sg_host_get_properties(const_sg_host_t host);
 115
 116 /** @ingroup m_host_management
 117  * @brief Returns the value of a given host property
 118  *
 119  * @param host a host
 120  * @param name a property name
 121  * @return value of a property (or nullptr if property not set)
 122  */
 123 XBT_PUBLIC const char* sg_host_get_property_value(const_sg_host_t host, const char* name);
 124
 125 /** @ingroup m_host_management
 126  * @brief Change the value of a given host property
 127  *
 128  * @param host a host
 129  * @param name a property name
 130  * @param value what to change the property to
 131  */
 132 XBT_PUBLIC void sg_host_set_property_value(sg_host_t host, const char* name, const char* value);
 133
 134 XBT_PUBLIC void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links);
 135 XBT_PUBLIC double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to);
 136 XBT_PUBLIC double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to);
 137 void sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount);
 138
 139 XBT_PUBLIC void sg_host_dump(const_sg_host_t ws);
 140
 141 XBT_PUBLIC void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto);
 142 SG_END_DECL
 143
 144 #endif /* SIMGRID_HOST_H_ */