include/simgrid/host.h

   1 /* Copyright (c) 2013-2019. 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 /** @brief Host datatype.
  15  *
  16  *   A <em>location</em> (or <em>host</em>) is any possible place where an actor may run. Thus it is represented as a
  17  *   <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running actors to
  18  *   communicate with remote ones, and some <em>private data</em> that can be only accessed by local actors.
  19  */
  20
  21 XBT_PUBLIC sg_host_t* sg_host_list();
  22
  23 /** @brief Return the current number of hosts. */
  24 XBT_PUBLIC size_t sg_host_count();
  25
  26 /**
  27  * @brief Return a dynar containing all the hosts declared at a given point of time (including VMs)
  28  * @remark The host order in the returned array is generally different from the host creation/declaration order in the
  29  *         XML platform (we use a hash table internally)
  30  */
  31 XBT_PUBLIC xbt_dynar_t sg_hosts_as_dynar();
  32
  33 XBT_PUBLIC size_t sg_host_extension_create(void (*deleter)(void*));
  34 XBT_PUBLIC void* sg_host_extension_get(sg_host_t host, size_t rank);
  35
  36 /** @brief Finds a sg_host_t using its name.
  37  *
  38  * This is a name directory service
  39  * @param name the name of an host.
  40  * @return the corresponding host
  41  */
  42 XBT_PUBLIC sg_host_t sg_host_by_name(const char* name);
  43
  44 /** @brief Return the name of the #sg_host_t. */
  45 XBT_PUBLIC const char* sg_host_get_name(sg_host_t host);
  46
  47 // ========== User Data ==============
  48 /** @brief Return the user data of a #sg_host_t.
  49  *
  50  * This functions returns the user data associated to @a host if any.
  51  */
  52 XBT_PUBLIC void* sg_host_data(sg_host_t host);
  53 XBT_ATTRIB_DEPRECATED_v327("Please use sg_host_data()") XBT_PUBLIC void* sg_host_user(sg_host_t host);
  54 /** @brief Set the user data of a #sg_host_t.
  55  *
  56  * This functions attach @a data to @a host.
  57  */
  58 XBT_PUBLIC void sg_host_data_set(sg_host_t host, void* userdata);
  59 XBT_ATTRIB_DEPRECATED_v327("Please use sg_host_data_set()") XBT_PUBLIC
  60     void sg_host_user_set(sg_host_t host, void* userdata);
  61 XBT_ATTRIB_DEPRECATED_v327("Please use sg_host_data_set(h, NULL)") XBT_PUBLIC void sg_host_user_destroy(sg_host_t host);
  62
  63 // ========= storage related functions ============
  64 /** @brief Return the list of mount point names on an host.
  65  * @param host a host
  66  * @return a dict containing all mount point on the host (mount_name => sg_storage_t)
  67  */
  68 XBT_PUBLIC xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host);
  69
  70 /** @brief Return the list of storages attached to an host.
  71  * @param host a host
  72  * @return a dynar containing all storages (name) attached to the host
  73  */
  74 XBT_PUBLIC xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host);
  75
  76 // =========== user-level functions ===============
  77 /** @brief Return the speed of the processor (in flop/s), regardless of the current load on the machine. */
  78 XBT_PUBLIC double sg_host_speed(sg_host_t host);
  79 XBT_PUBLIC double sg_host_get_pstate_speed(sg_host_t host, int pstate_index);
  80
  81 XBT_PUBLIC double sg_host_get_available_speed(sg_host_t host);
  82
  83 XBT_PUBLIC int sg_host_core_count(sg_host_t host);
  84
  85 /** @brief Returns the current computation load (in flops per second).
  86  * @param host a host
  87  */
  88 XBT_PUBLIC double sg_host_load(sg_host_t host);
  89
  90 /** @brief Return the location on which the current process is running. */
  91 XBT_PUBLIC sg_host_t sg_host_self();
  92
  93 XBT_PUBLIC const char* sg_host_self_get_name();
  94
  95 /** @brief Return the total count of pstates defined for a host. See also @ref plugin_energy.
  96  *
  97  * @param  host host to test
  98  */
  99 XBT_PUBLIC int sg_host_get_nb_pstates(sg_host_t host);
 100
 101 XBT_PUBLIC int sg_host_get_pstate(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(sg_host_t host);
 107 XBT_ATTRIB_DEPRECATED_v325("Please use !sg_host_is_on()") XBT_PUBLIC int sg_host_is_off(sg_host_t host);
 108
 109 /** @ingroup m_host_management
 110  * @brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 111  *
 112  * @param host a host
 113  * @return a dict containing the properties
 114  */
 115 XBT_PUBLIC xbt_dict_t sg_host_get_properties(sg_host_t host);
 116
 117 /** @ingroup m_host_management
 118  * @brief Returns the value of a given host property
 119  *
 120  * @param host a host
 121  * @param name a property name
 122  * @return value of a property (or nullptr if property not set)
 123  */
 124 XBT_PUBLIC const char* sg_host_get_property_value(sg_host_t host, const char* name);
 125
 126 /** @ingroup m_host_management
 127  * @brief Change the value of a given host property
 128  *
 129  * @param host a host
 130  * @param name a property name
 131  * @param value what to change the property to
 132  */
 133 XBT_PUBLIC void sg_host_set_property_value(sg_host_t host, const char* name, const char* value);
 134
 135 XBT_PUBLIC void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links);
 136 XBT_PUBLIC double sg_host_route_latency(sg_host_t from, sg_host_t to);
 137 XBT_PUBLIC double sg_host_route_bandwidth(sg_host_t from, sg_host_t to);
 138 void sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount);
 139
 140 XBT_PUBLIC void sg_host_dump(sg_host_t ws);
 141
 142 XBT_PUBLIC void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto);
 143 SG_END_DECL()
 144
 145 #endif /* SIMGRID_HOST_H_ */