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