include/simgrid/host.h

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