1 /* Copyright (c) 2004-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include "src/msg/msg_private.h"
8 #include "xbt/sysdep.h"
10 #include "simgrid/simix.h"
11 #include <simgrid/s4u/host.hpp>
14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
16 int sg_storage_max_file_descriptors = 1024;
18 /** @addtogroup m_host_management
19 * (#msg_host_t) and the functions for managing it.
21 * A <em>location</em> (or <em>host</em>) is any possible place where a process may run. Thus it may be represented
22 * as a <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running process to
23 * communicate with remote ones, and some <em>private data</em> that can be only accessed by local process.
27 /********************************* Host **************************************/
28 msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our parameter
30 msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
32 priv->file_descriptor_table = nullptr;
34 sg_host_msg_set(host,priv);
39 /** \ingroup m_host_management
40 * \brief Finds a msg_host_t using its name.
42 * This is a name directory service
43 * \param name the name of an host.
44 * \return the corresponding host
46 msg_host_t MSG_host_by_name(const char *name)
48 return simgrid::s4u::Host::by_name_or_null(name);
51 /** \ingroup m_host_management
53 * \brief Set the user data of a #msg_host_t.
55 * This functions attach \a data to \a host if it is possible.
57 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
58 sg_host_user_set(host, data);
62 /** \ingroup m_host_management
64 * \brief Return the user data of a #msg_host_t.
66 * This functions returns the user data associated to \a host if it is possible.
68 void *MSG_host_get_data(msg_host_t host) {
69 return sg_host_user(host);
72 /** \ingroup m_host_management
74 * \brief Return the location on which the current process is executed.
76 msg_host_t MSG_host_self()
78 return MSG_process_get_host(nullptr);
81 /** \ingroup m_host_management
83 * \brief Start the host if it is off
85 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
86 * for more info on DVFS.
88 void MSG_host_on(msg_host_t host)
93 /** \ingroup m_host_management
95 * \brief Stop the host if it is on
97 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
98 * for more info on DVFS.
100 void MSG_host_off(msg_host_t host)
106 * \brief Frees private data of a host (internal call only)
108 void __MSG_host_priv_free(msg_host_priv_t priv)
112 delete priv->file_descriptor_table;
116 /** \ingroup m_host_management
117 * \brief Return the current number MSG hosts.
119 int MSG_get_host_number()
121 return sg_host_count();
124 /** \ingroup m_host_management
125 * \brief Return a dynar containing all the hosts declared at a given point of time
126 * \remark The host order in the returned array is generally different from the host creation/declaration order in the
127 * XML platform (we use a hash table internally)
129 xbt_dynar_t MSG_hosts_as_dynar() {
130 return sg_hosts_as_dynar();
133 /** \ingroup m_host_management
134 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
136 double MSG_host_get_speed(msg_host_t host) {
137 return host->speed();
140 /** \ingroup m_host_management
141 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
142 * Deprecated: use MSG_host_get_speed
144 double MSG_get_host_speed(msg_host_t host) {
145 XBT_WARN("MSG_get_host_speed is deprecated: use MSG_host_get_speed");
146 return MSG_host_get_speed(host);
149 /** \ingroup m_host_management
150 * \brief Return the number of cores.
153 * \return the number of cores
155 int MSG_host_get_core_number(msg_host_t host) {
156 return host->coreCount();
159 /** \ingroup m_host_management
160 * \brief Return the list of processes attached to an host.
163 * \return a swag with the attached processes
165 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
167 xbt_assert((host != nullptr), "Invalid parameters");
168 return host->processes();
171 /** \ingroup m_host_management
172 * \brief Returns the value of a given host property
175 * \param name a property name
176 * \return value of a property (or nullptr if property not set)
178 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
180 return static_cast<const char*>(xbt_dict_get_or_null(MSG_host_get_properties(host), name));
183 /** \ingroup m_host_management
184 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
187 * \return a dict containing the properties
189 xbt_dict_t MSG_host_get_properties(msg_host_t host)
191 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
192 return host->properties();
195 /** \ingroup m_host_management
196 * \brief Change the value of a given host property
199 * \param name a property name
200 * \param value what to change the property to
202 void MSG_host_set_property_value(msg_host_t host, const char* name, char* value)
204 xbt_dict_set(MSG_host_get_properties(host), name, value, nullptr);
207 /** @ingroup m_host_management
208 * @brief Determine if a host is up and running.
210 * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref SURF_plugin_energy for more info on DVFS.
212 * @param host host to test
213 * @return Returns true if the host is up and running, and false if it's currently down
215 int MSG_host_is_on(msg_host_t host)
220 /** @ingroup m_host_management
221 * @brief Determine if a host is currently off.
223 * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref SURF_plugin_energy for more info on DVFS.
225 int MSG_host_is_off(msg_host_t host)
227 return host->isOff();
230 /** \ingroup m_host_management
231 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
233 * \param host host to test
234 * \param pstate_index pstate to test
235 * \return Returns the processor speed associated with pstate_index
237 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
238 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
239 return host->getPstateSpeed(pstate_index);
242 /** \ingroup m_host_management
243 * \brief Return the current speed of the processor (in flop/s)
245 * \param host host to test
246 * \return Returns the current processor speed
248 double MSG_host_get_current_power_peak(msg_host_t host) {
249 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
250 return host->getPstateSpeedCurrent();
253 /** \ingroup m_host_management
254 * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
256 * \param host host to test
258 int MSG_host_get_nb_pstates(msg_host_t host) {
259 return sg_host_get_nb_pstates(host);
262 /** \ingroup m_host_management
263 * \brief Return the list of mount point names on an host.
265 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
267 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
269 xbt_assert((host != nullptr), "Invalid parameters");
270 return host->mountedStoragesAsDict();
273 /** \ingroup m_host_management
274 * \brief Return the list of storages attached to an host.
276 * \return a dynar containing all storages (name) attached to the host
278 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
280 xbt_assert((host != nullptr), "Invalid parameters");
281 return host->attachedStorages();
284 /** \ingroup m_host_management
285 * \brief Return the content of mounted storages on an host.
287 * \return a dict containing content (as a dict) of all storages mounted on the host
289 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
291 xbt_assert((host != nullptr), "Invalid parameters");
292 xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
293 msg_storage_t storage;
296 xbt_dict_cursor_t cursor = nullptr;
298 xbt_dict_t storage_list = host->mountedStoragesAsDict();
300 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
301 storage = static_cast<msg_storage_t>(xbt_lib_get_elm_or_null(storage_lib,storage_name));
302 xbt_dict_t content = simcall_storage_get_content(storage);
303 xbt_dict_set(contents,mount_name, content,nullptr);
305 xbt_dict_free(&storage_list);
309 int __MSG_host_get_file_descriptor_id(msg_host_t host){
310 msg_host_priv_t priv = sg_host_msg(host);
311 if(!priv->file_descriptor_table){
312 priv->file_descriptor_table = new std::vector<int>(sg_storage_max_file_descriptors);
313 std::iota (priv->file_descriptor_table->rbegin(), priv->file_descriptor_table->rend(), 0); // Fill with ..., 1, 0.
315 xbt_assert(!priv->file_descriptor_table->empty(), "Too much files are opened! Some have to be closed.");
316 int desc = priv->file_descriptor_table->back();
317 priv->file_descriptor_table->pop_back();
321 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
322 msg_host_priv_t priv = sg_host_msg(host);
323 priv->file_descriptor_table->push_back(id);