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->dp_objs = xbt_dict_new();
34 priv->dp_updated_by_deleted_tasks = 0;
35 priv->is_migrating = 0;
37 priv->file_descriptor_table = new std::vector<int>(sg_storage_max_file_descriptors);
38 std::iota (priv->file_descriptor_table->rbegin(), priv->file_descriptor_table->rend(), 0); // Fill with ..., 1, 0.
40 sg_host_msg_set(host,priv);
45 /** \ingroup m_host_management
46 * \brief Finds a msg_host_t using its name.
48 * This is a name directory service
49 * \param name the name of an host.
50 * \return the corresponding host
52 msg_host_t MSG_host_by_name(const char *name)
54 return simgrid::s4u::Host::by_name_or_null(name);
57 /** \ingroup m_host_management
59 * \brief Set the user data of a #msg_host_t.
61 * This functions attach \a data to \a host if it is possible.
63 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
64 sg_host_user_set(host, data);
68 /** \ingroup m_host_management
70 * \brief Return the user data of a #msg_host_t.
72 * This functions returns the user data associated to \a host if it is possible.
74 void *MSG_host_get_data(msg_host_t host) {
75 return sg_host_user(host);
78 /** \ingroup m_host_management
80 * \brief Return the location on which the current process is executed.
82 msg_host_t MSG_host_self()
84 return MSG_process_get_host(nullptr);
87 /** \ingroup m_host_management
89 * \brief Start the host if it is off
91 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
92 * for more info on DVFS.
94 void MSG_host_on(msg_host_t host)
99 /** \ingroup m_host_management
101 * \brief Stop the host if it is on
103 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
104 * for more info on DVFS.
106 void MSG_host_off(msg_host_t host)
112 * \brief Frees private data of a host (internal call only)
114 void __MSG_host_priv_free(msg_host_priv_t priv)
118 unsigned int size = xbt_dict_size(priv->dp_objs);
120 XBT_WARN("dp_objs: %u pending task?", size);
121 xbt_dict_free(&priv->dp_objs);
122 delete priv->file_descriptor_table;
126 /** \ingroup m_host_management
127 * \brief Return the current number MSG hosts.
129 int MSG_get_host_number()
131 return sg_host_count();
134 /** \ingroup m_host_management
135 * \brief Return a dynar containing all the hosts declared at a given point of time
136 * \remark The host order in the returned array is generally different from the host creation/declaration order in the
137 * XML platform (we use a hash table internally)
139 xbt_dynar_t MSG_hosts_as_dynar() {
140 return sg_hosts_as_dynar();
143 /** \ingroup m_host_management
144 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
146 double MSG_host_get_speed(msg_host_t host) {
147 return host->speed();
150 /** \ingroup m_host_management
151 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
152 * Deprecated: use MSG_host_get_speed
154 double MSG_get_host_speed(msg_host_t host) {
155 XBT_WARN("MSG_get_host_speed is deprecated: use MSG_host_get_speed");
156 return MSG_host_get_speed(host);
159 /** \ingroup m_host_management
160 * \brief Return the number of cores.
163 * \return the number of cores
165 int MSG_host_get_core_number(msg_host_t host) {
166 return host->coreCount();
169 /** \ingroup m_host_management
170 * \brief Return the list of processes attached to an host.
173 * \return a swag with the attached processes
175 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
177 xbt_assert((host != nullptr), "Invalid parameters");
178 return host->processes();
181 /** \ingroup m_host_management
182 * \brief Returns the value of a given host property
185 * \param name a property name
186 * \return value of a property (or nullptr if property not set)
188 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
190 return static_cast<const char*>(xbt_dict_get_or_null(MSG_host_get_properties(host), name));
193 /** \ingroup m_host_management
194 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
197 * \return a dict containing the properties
199 xbt_dict_t MSG_host_get_properties(msg_host_t host)
201 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
202 return host->properties();
205 /** \ingroup m_host_management
206 * \brief Change the value of a given host property
209 * \param name a property name
210 * \param value what to change the property to
211 * \param free_ctn the freeing function to use to kill the value on need
213 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
214 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
217 /** @ingroup m_host_management
218 * @brief Determine if a host is up and running.
220 * 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.
222 * @param host host to test
223 * @return Returns true if the host is up and running, and false if it's currently down
225 int MSG_host_is_on(msg_host_t host)
230 /** @ingroup m_host_management
231 * @brief Determine if a host is currently off.
233 * 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.
235 int MSG_host_is_off(msg_host_t host)
237 return host->isOff();
240 /** \ingroup m_host_management
241 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
243 * \param host host to test
244 * \param pstate_index pstate to test
245 * \return Returns the processor speed associated with pstate_index
247 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
248 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
249 return host->getPstateSpeed(pstate_index);
252 /** \ingroup m_host_management
253 * \brief Return the current speed of the processor (in flop/s)
255 * \param host host to test
256 * \return Returns the current processor speed
258 double MSG_host_get_current_power_peak(msg_host_t host) {
259 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
260 return host->getPstateSpeedCurrent();
263 /** \ingroup m_host_management
264 * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
266 * \param host host to test
268 int MSG_host_get_nb_pstates(msg_host_t host) {
269 return sg_host_get_nb_pstates(host);
272 /** \ingroup m_host_management
273 * \brief Return the list of mount point names on an host.
275 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
277 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
279 xbt_assert((host != nullptr), "Invalid parameters");
280 return host->mountedStoragesAsDict();
283 /** \ingroup m_host_management
284 * \brief Return the list of storages attached to an host.
286 * \return a dynar containing all storages (name) attached to the host
288 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
290 xbt_assert((host != nullptr), "Invalid parameters");
291 return host->attachedStorages();
294 /** \ingroup m_host_management
295 * \brief Return the content of mounted storages on an host.
297 * \return a dict containing content (as a dict) of all storages mounted on the host
299 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
301 xbt_assert((host != nullptr), "Invalid parameters");
302 xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
303 msg_storage_t storage;
306 xbt_dict_cursor_t cursor = nullptr;
308 xbt_dict_t storage_list = host->mountedStoragesAsDict();
310 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
311 storage = static_cast<msg_storage_t>(xbt_lib_get_elm_or_null(storage_lib,storage_name));
312 xbt_dict_t content = simcall_storage_get_content(storage);
313 xbt_dict_set(contents,mount_name, content,nullptr);
315 xbt_dict_free(&storage_list);
319 int __MSG_host_get_file_descriptor_id(msg_host_t host){
320 msg_host_priv_t priv = sg_host_msg(host);
321 xbt_assert(!priv->file_descriptor_table->empty(), "Too much files are opened! Some have to be closed.");
322 int desc = priv->file_descriptor_table->back();
323 priv->file_descriptor_table->pop_back();
327 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
328 msg_host_priv_t priv = sg_host_msg(host);
329 priv->file_descriptor_table->push_back(id);