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>
13 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
15 int sg_storage_max_file_descriptors = 1024;
17 /** @addtogroup m_host_management
18 * (#msg_host_t) and the functions for managing it.
20 * A <em>location</em> (or <em>host</em>) is any possible place where a process may run. Thus it may be represented
21 * as a <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running process to
22 * communicate with remote ones, and some <em>private data</em> that can be only accessed by local process.
26 /********************************* Host **************************************/
27 msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our parameter
29 msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
31 priv->dp_objs = xbt_dict_new();
33 priv->dp_updated_by_deleted_tasks = 0;
34 priv->is_migrating = 0;
36 priv->affinity_mask_db = xbt_dict_new_homogeneous(nullptr);
38 priv->file_descriptor_table = xbt_dynar_new(sizeof(int), nullptr);
39 for (int i=sg_storage_max_file_descriptors-1; i>=0;i--)
40 xbt_dynar_push_as(priv->file_descriptor_table, int, i);
42 sg_host_msg_set(host,priv);
47 /** \ingroup m_host_management
48 * \brief Finds a msg_host_t using its name.
50 * This is a name directory service
51 * \param name the name of an host.
52 * \return the corresponding host
54 msg_host_t MSG_host_by_name(const char *name)
56 return simgrid::s4u::Host::by_name_or_null(name);
59 /** \ingroup m_host_management
61 * \brief Set the user data of a #msg_host_t.
63 * This functions attach \a data to \a host if it is possible.
65 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
66 sg_host_user_set(host, data);
70 /** \ingroup m_host_management
72 * \brief Return the user data of a #msg_host_t.
74 * This functions returns the user data associated to \a host if it is possible.
76 void *MSG_host_get_data(msg_host_t host) {
77 return sg_host_user(host);
80 /** \ingroup m_host_management
82 * \brief Return the location on which the current process is executed.
84 msg_host_t MSG_host_self()
86 return MSG_process_get_host(nullptr);
89 /** \ingroup m_host_management
91 * \brief Start the host if it is off
93 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
94 * for more info on DVFS.
96 void MSG_host_on(msg_host_t host)
101 /** \ingroup m_host_management
103 * \brief Stop the host if it is on
105 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
106 * for more info on DVFS.
108 void MSG_host_off(msg_host_t host)
114 * \brief Frees private data of a host (internal call only)
116 void __MSG_host_priv_free(msg_host_priv_t priv)
120 unsigned int size = xbt_dict_size(priv->dp_objs);
122 XBT_WARN("dp_objs: %u pending task?", size);
123 xbt_dict_free(&priv->dp_objs);
124 xbt_dict_free(&priv->affinity_mask_db);
125 xbt_dynar_free(&priv->file_descriptor_table);
130 /** \ingroup m_host_management
131 * \brief Return the current number MSG hosts.
133 int MSG_get_host_number()
135 return xbt_dict_length(host_list);
138 /** \ingroup m_host_management
139 * \brief Return a dynar containing all the hosts declared at a given point of time
140 * \remark The host order in the returned array is generally different from the host creation/declaration order in the
141 * XML platform (we use a hash table internally)
143 xbt_dynar_t MSG_hosts_as_dynar() {
144 return sg_hosts_as_dynar();
147 /** \ingroup m_host_management
148 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
150 double MSG_host_get_speed(msg_host_t host) {
151 return host->speed();
154 /** \ingroup m_host_management
155 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
156 * Deprecated: use MSG_host_get_speed
158 double MSG_get_host_speed(msg_host_t host) {
159 XBT_WARN("MSG_get_host_speed is deprecated: use MSG_host_get_speed");
160 return MSG_host_get_speed(host);
164 /** \ingroup m_host_management
165 * \brief Return the number of cores.
168 * \return the number of cores
170 int MSG_host_get_core_number(msg_host_t host) {
171 return host->coresCount();
174 /** \ingroup m_host_management
175 * \brief Return the list of processes attached to an host.
178 * \return a swag with the attached processes
180 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
182 xbt_assert((host != nullptr), "Invalid parameters");
183 return host->processes();
186 /** \ingroup m_host_management
187 * \brief Returns the value of a given host property
190 * \param name a property name
191 * \return value of a property (or nullptr if property not set)
193 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
195 return static_cast<const char*>(xbt_dict_get_or_null(MSG_host_get_properties(host), name));
198 /** \ingroup m_host_management
199 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
202 * \return a dict containing the properties
204 xbt_dict_t MSG_host_get_properties(msg_host_t host)
206 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
207 return host->properties();
210 /** \ingroup m_host_management
211 * \brief Change the value of a given host property
214 * \param name a property name
215 * \param value what to change the property to
216 * \param free_ctn the freeing function to use to kill the value on need
218 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
219 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
222 /** @ingroup m_host_management
223 * @brief Determine if a host is up and running.
225 * 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.
227 * @param host host to test
228 * @return Returns true if the host is up and running, and false if it's currently down
230 int MSG_host_is_on(msg_host_t host)
235 /** @ingroup m_host_management
236 * @brief Determine if a host is currently off.
238 * 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.
240 int MSG_host_is_off(msg_host_t host)
242 return host->isOff();
245 /** \ingroup m_host_management
246 * \brief Set the parameters of a given host
249 * \param params a prameter object
251 void MSG_host_set_params(msg_host_t host, vm_params_t params)
253 host->setParameters(params);
256 /** \ingroup m_host_management
257 * \brief Get the parameters of a given host
260 * \param params a prameter object
262 void MSG_host_get_params(msg_host_t host, vm_params_t params)
264 host->parameters(params);
267 /** \ingroup m_host_management
268 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
270 * \param host host to test
271 * \param pstate_index pstate to test
272 * \return Returns the processor speed associated with pstate_index
274 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
275 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
276 return host->getPstateSpeed(pstate_index);
279 /** \ingroup m_host_management
280 * \brief Return the current speed of the processor (in flop/s)
282 * \param host host to test
283 * \return Returns the current processor speed
285 double MSG_host_get_current_power_peak(msg_host_t host) {
286 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
287 return host->getPstateSpeedCurrent();
290 /** \ingroup m_host_management
291 * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
293 * \param host host to test
295 int MSG_host_get_nb_pstates(msg_host_t host) {
296 return sg_host_get_nb_pstates(host);
299 /** \ingroup m_host_management
300 * \brief Return the list of mount point names on an host.
302 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
304 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
306 xbt_assert((host != nullptr), "Invalid parameters");
307 return host->mountedStoragesAsDict();
310 /** \ingroup m_host_management
311 * \brief Return the list of storages attached to an host.
313 * \return a dynar containing all storages (name) attached to the host
315 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
317 xbt_assert((host != nullptr), "Invalid parameters");
318 return host->attachedStorages();
321 /** \ingroup m_host_management
322 * \brief Return the content of mounted storages on an host.
324 * \return a dict containing content (as a dict) of all storages mounted on the host
326 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
328 xbt_assert((host != nullptr), "Invalid parameters");
329 xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
330 msg_storage_t storage;
333 xbt_dict_cursor_t cursor = nullptr;
335 xbt_dict_t storage_list = host->mountedStoragesAsDict();
337 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
338 storage = static_cast<msg_storage_t>(xbt_lib_get_elm_or_null(storage_lib,storage_name));
339 xbt_dict_t content = simcall_storage_get_content(storage);
340 xbt_dict_set(contents,mount_name, content,nullptr);
342 xbt_dict_free(&storage_list);
346 int __MSG_host_get_file_descriptor_id(msg_host_t host){
347 msg_host_priv_t priv = sg_host_msg(host);
348 xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table), "Too much files are opened! Some have to be closed.");
349 return xbt_dynar_pop_as(priv->file_descriptor_table, int);
352 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
353 msg_host_priv_t priv = sg_host_msg(host);
354 xbt_dynar_push_as(priv->file_descriptor_table, int, id);