1 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */
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. */
6 #include "simgrid/s4u/Host.hpp"
7 #include "simgrid/s4u/Storage.hpp"
8 #include "src/msg/msg_private.hpp"
9 #include "src/simix/ActorImpl.hpp"
10 #include "src/simix/smx_host_private.hpp"
12 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
16 /** @addtogroup m_host_management
17 * (#msg_host_t) and the functions for managing it.
19 * A <em>location</em> (or <em>host</em>) is any possible place where a process may run. Thus it may be represented
20 * as a <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running process to
21 * communicate with remote ones, and some <em>private data</em> that can be only accessed by local process.
25 /********************************* Host **************************************/
26 /** \ingroup m_host_management
27 * \brief Finds a msg_host_t using its name.
29 * This is a name directory service
30 * \param name the name of an host.
31 * \return the corresponding host
33 msg_host_t MSG_host_by_name(const char *name)
35 return simgrid::s4u::Host::by_name_or_null(name);
38 /** \ingroup m_host_management
40 * \brief Set the user data of a #msg_host_t.
42 * This functions attach \a data to \a host if it is possible.
44 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
45 sg_host_user_set(host, data);
49 /** \ingroup m_host_management
51 * \brief Return the user data of a #msg_host_t.
53 * This functions returns the user data associated to \a host if it is possible.
55 void *MSG_host_get_data(msg_host_t host) {
56 return sg_host_user(host);
59 /** \ingroup m_host_management
61 * \brief Return the location on which the current process is executed.
63 msg_host_t MSG_host_self()
65 return MSG_process_get_host(nullptr);
68 /** \ingroup m_host_management
70 * \brief Start the host if it is off
72 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref plugin_energy
73 * for more info on DVFS.
75 void MSG_host_on(msg_host_t host)
80 /** \ingroup m_host_management
82 * \brief Stop the host if it is on
84 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref plugin_energy
85 * for more info on DVFS.
87 void MSG_host_off(msg_host_t host)
92 /** \ingroup m_host_management
93 * \brief Return the current number MSG hosts.
95 int MSG_get_host_number()
97 return sg_host_count();
100 /** \ingroup m_host_management
101 * \brief Return a dynar containing all the hosts declared at a given point of time (including VMs)
102 * \remark The host order in the returned array is generally different from the host creation/declaration order in the
103 * XML platform (we use a hash table internally)
105 xbt_dynar_t MSG_hosts_as_dynar() {
106 return sg_hosts_as_dynar();
109 /** \ingroup m_host_management
110 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
112 double MSG_host_get_speed(msg_host_t host) {
113 return host->getSpeed();
116 /** \ingroup m_host_management
117 * \brief Return the number of cores.
120 * \return the number of cores
122 int MSG_host_get_core_number(msg_host_t host) {
123 return host->getCoreCount();
126 /** \ingroup m_host_management
127 * \brief Return the list of processes attached to an host.
130 * \param whereto a dynar in which we should push processes living on that host
132 void MSG_host_get_process_list(msg_host_t host, xbt_dynar_t whereto)
134 xbt_assert((host != nullptr), "Invalid parameters");
135 smx_actor_t actor = NULL;
136 xbt_swag_foreach(actor, host->extension<simgrid::simix::Host>()->process_list) {
137 msg_process_t p = actor->ciface();
138 xbt_dynar_push(whereto, &p);
142 /** \ingroup m_host_management
143 * \brief Returns the value of a given host property
146 * \param name a property name
147 * \return value of a property (or nullptr if property not set)
149 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
151 return host->getProperty(name);
154 /** \ingroup m_host_management
155 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
158 * \return a dict containing the properties
160 xbt_dict_t MSG_host_get_properties(msg_host_t host)
162 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
163 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
164 std::map<std::string, std::string>* props = host->getProperties();
165 if (props == nullptr)
167 for (auto const& elm : *props) {
168 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
173 /** \ingroup m_host_management
174 * \brief Change the value of a given host property
177 * \param name a property name
178 * \param value what to change the property to
180 void MSG_host_set_property_value(msg_host_t host, const char* name, char* value)
182 host->setProperty(name, value);
185 /** @ingroup m_host_management
186 * @brief Determine if a host is up and running.
188 * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref plugin_energy for more info on
191 * @param host host to test
192 * @return Returns true if the host is up and running, and false if it's currently down
194 int MSG_host_is_on(msg_host_t host)
199 /** @ingroup m_host_management
200 * @brief Determine if a host is currently off.
202 * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref plugin_energy for more info on
205 int MSG_host_is_off(msg_host_t host)
207 return host->isOff();
210 /** \ingroup m_host_management
211 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
213 * \param host host to test
214 * \param pstate_index pstate to test
215 * \return Returns the processor speed associated with pstate_index
217 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
218 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
219 return host->getPstateSpeed(pstate_index);
222 /** \ingroup m_host_management
223 * \brief Return the total count of pstates defined for a host. See also @ref plugin_energy.
225 * \param host host to test
227 int MSG_host_get_nb_pstates(msg_host_t host) {
228 return sg_host_get_nb_pstates(host);
231 /** \ingroup m_host_management
232 * \brief Return the list of mount point names on an host.
234 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
236 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
238 return sg_host_get_mounted_storage_list(host);
241 /** \ingroup m_host_management
242 * \brief Return the list of storages attached to an host.
244 * \return a dynar containing all storages (name) attached to the host
246 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
248 return sg_host_get_attached_storage_list(host);