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.h"
9 #include "src/simix/ActorImpl.hpp"
10 #include "src/simix/smx_host_private.h"
13 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
15 simgrid::xbt::Extension<simgrid::s4u::Host, simgrid::MsgHostExt> simgrid::MsgHostExt::EXTENSION_ID;
19 int sg_storage_max_file_descriptors = 1024;
21 /** @addtogroup m_host_management
22 * (#msg_host_t) and the functions for managing it.
24 * A <em>location</em> (or <em>host</em>) is any possible place where a process may run. Thus it may be represented
25 * as a <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running process to
26 * communicate with remote ones, and some <em>private data</em> that can be only accessed by local process.
30 /********************************* Host **************************************/
31 /** \ingroup m_host_management
32 * \brief Finds a msg_host_t using its name.
34 * This is a name directory service
35 * \param name the name of an host.
36 * \return the corresponding host
38 msg_host_t MSG_host_by_name(const char *name)
40 return simgrid::s4u::Host::by_name_or_null(name);
43 /** \ingroup m_host_management
45 * \brief Set the user data of a #msg_host_t.
47 * This functions attach \a data to \a host if it is possible.
49 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
50 sg_host_user_set(host, data);
54 /** \ingroup m_host_management
56 * \brief Return the user data of a #msg_host_t.
58 * This functions returns the user data associated to \a host if it is possible.
60 void *MSG_host_get_data(msg_host_t host) {
61 return sg_host_user(host);
64 /** \ingroup m_host_management
66 * \brief Return the location on which the current process is executed.
68 msg_host_t MSG_host_self()
70 return MSG_process_get_host(nullptr);
73 /** \ingroup m_host_management
75 * \brief Start the host if it is off
77 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref plugin_energy
78 * for more info on DVFS.
80 void MSG_host_on(msg_host_t host)
85 /** \ingroup m_host_management
87 * \brief Stop the host if it is on
89 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref plugin_energy
90 * for more info on DVFS.
92 void MSG_host_off(msg_host_t host)
97 /** \ingroup m_host_management
98 * \brief Return the current number MSG hosts.
100 int MSG_get_host_number()
102 return sg_host_count();
105 /** \ingroup m_host_management
106 * \brief Return a dynar containing all the hosts declared at a given point of time (including VMs)
107 * \remark The host order in the returned array is generally different from the host creation/declaration order in the
108 * XML platform (we use a hash table internally)
110 xbt_dynar_t MSG_hosts_as_dynar() {
111 return sg_hosts_as_dynar();
114 /** \ingroup m_host_management
115 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
117 double MSG_host_get_speed(msg_host_t host) {
118 return host->getSpeed();
121 /** \ingroup m_host_management
122 * \brief Return the number of cores.
125 * \return the number of cores
127 int MSG_host_get_core_number(msg_host_t host) {
128 return host->getCoreCount();
131 /** \ingroup m_host_management
132 * \brief Return the list of processes attached to an host.
135 * \param whereto a dynar in which we should push processes living on that host
137 void MSG_host_get_process_list(msg_host_t host, xbt_dynar_t whereto)
139 xbt_assert((host != nullptr), "Invalid parameters");
140 smx_actor_t actor = NULL;
141 xbt_swag_foreach(actor, host->extension<simgrid::simix::Host>()->process_list) {
142 msg_process_t p = actor->ciface();
143 xbt_dynar_push(whereto, &p);
147 /** \ingroup m_host_management
148 * \brief Returns the value of a given host property
151 * \param name a property name
152 * \return value of a property (or nullptr if property not set)
154 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
156 return static_cast<const char*>(xbt_dict_get_or_null(MSG_host_get_properties(host), name));
159 /** \ingroup m_host_management
160 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
163 * \return a dict containing the properties
165 xbt_dict_t MSG_host_get_properties(msg_host_t host)
167 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
168 return host->getProperties();
171 /** \ingroup m_host_management
172 * \brief Change the value of a given host property
175 * \param name a property name
176 * \param value what to change the property to
178 void MSG_host_set_property_value(msg_host_t host, const char* name, char* value)
180 xbt_dict_set(MSG_host_get_properties(host), name, value, nullptr);
183 /** @ingroup m_host_management
184 * @brief Determine if a host is up and running.
186 * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref plugin_energy for more info on
189 * @param host host to test
190 * @return Returns true if the host is up and running, and false if it's currently down
192 int MSG_host_is_on(msg_host_t host)
197 /** @ingroup m_host_management
198 * @brief Determine if a host is currently off.
200 * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref plugin_energy for more info on
203 int MSG_host_is_off(msg_host_t host)
205 return host->isOff();
208 /** \ingroup m_host_management
209 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
211 * \param host host to test
212 * \param pstate_index pstate to test
213 * \return Returns the processor speed associated with pstate_index
215 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
216 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
217 return host->getPstateSpeed(pstate_index);
220 /** \ingroup m_host_management
221 * \brief Return the total count of pstates defined for a host. See also @ref plugin_energy.
223 * \param host host to test
225 int MSG_host_get_nb_pstates(msg_host_t host) {
226 return sg_host_get_nb_pstates(host);
229 /** \ingroup m_host_management
230 * \brief Return the list of mount point names on an host.
232 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
234 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
236 return sg_host_get_mounted_storage_list(host);
239 /** \ingroup m_host_management
240 * \brief Return the list of storages attached to an host.
242 * \return a dynar containing all storages (name) attached to the host
244 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
246 return sg_host_get_attached_storage_list(host);
249 /** \ingroup m_host_management
250 * \brief Return the content of mounted storages on an host.
252 * \return a dict containing content (as a dict) of all storages mounted on the host
254 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
256 xbt_assert((host != nullptr), "Invalid parameters");
257 xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
258 for (auto elm : host->getMountedStorages())
259 xbt_dict_set(contents, elm.first.c_str(), MSG_storage_get_content(elm.second), nullptr);