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 "src/msg/msg_mailbox.h"
9 #include "xbt/sysdep.h"
11 #include "simgrid/simix.h"
12 #include <simgrid/s4u/host.hpp>
14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
16 /** @addtogroup m_host_management
17 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
18 * (#msg_host_t) and the functions for managing it.
20 * A <em>location</em> (or <em>host</em>) is any possible place where
21 * a process may run. Thus it may be represented as a
22 * <em>physical resource with computing capabilities</em>, some
23 * <em>mailboxes</em> to enable running process to communicate with
24 * remote ones, and some <em>private data</em> that can be only
25 * accessed by local process.
29 /********************************* Host **************************************/
30 msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our parameter
32 msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
34 priv->dp_objs = xbt_dict_new();
36 priv->dp_updated_by_deleted_tasks = 0;
37 priv->is_migrating = 0;
39 priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
41 priv->file_descriptor_table = xbt_dynar_new(sizeof(int), NULL);
42 for (int i=1023; i>=0;i--)
43 xbt_dynar_push_as(priv->file_descriptor_table, int, i);
45 sg_host_msg_set(host,priv);
50 /** \ingroup m_host_management
51 * \brief Finds a msg_host_t using its name.
53 * This is a name directory service
54 * \param name the name of an host.
55 * \return the corresponding host
57 msg_host_t MSG_host_by_name(const char *name)
59 return simgrid::s4u::Host::by_name_or_null(name);
62 /** \ingroup m_host_management
64 * \brief Set the user data of a #msg_host_t.
66 * This functions checks whether some data has already been associated to \a host
67 or not and attach \a data to \a host if it is possible.
69 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
70 sg_host_user_set(host, data);
74 /** \ingroup m_host_management
76 * \brief Return the user data of a #msg_host_t.
78 * This functions checks whether \a host is a valid pointer or not and return
79 the user data associated to \a host if it is possible.
81 void *MSG_host_get_data(msg_host_t host) {
82 return sg_host_user(host);
85 /** \ingroup m_host_management
87 * \brief Return the location on which the current process is executed.
89 msg_host_t MSG_host_self(void)
91 return MSG_process_get_host(NULL);
95 /** \ingroup m_host_management
97 * \brief Start the host if it is off
99 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy for more info on DVFS.
101 void MSG_host_on(msg_host_t host)
106 /** \ingroup m_host_management
108 * \brief Stop the host if it is on
110 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy for more info on DVFS.
112 void MSG_host_off(msg_host_t host)
118 * \brief Frees private data of a host (internal call only)
120 void __MSG_host_priv_free(msg_host_priv_t priv)
125 unsigned int size = xbt_dict_size(priv->dp_objs);
127 XBT_WARN("dp_objs: %u pending task?", size);
128 xbt_dict_free(&priv->dp_objs);
129 xbt_dict_free(&priv->affinity_mask_db);
130 xbt_dynar_free(&priv->file_descriptor_table);
135 /** \ingroup m_host_management
136 * \brief Return the current number MSG hosts.
138 int MSG_get_host_number(void)
140 return xbt_dict_length(host_list);
143 /** \ingroup m_host_management
144 * \brief Return a dynar containing all the hosts declared at a given point of time
145 * \remark The host order in the returned array is generally different from the host creation/declaration order in the XML platform (we use a hash table internally)
147 xbt_dynar_t MSG_hosts_as_dynar(void) {
148 return sg_hosts_as_dynar();
151 /** \ingroup m_host_management
152 * \brief Return the speed of the processor (in flop/s), regardless of
153 the current load on the machine.
155 double MSG_get_host_speed(msg_host_t host) {
156 return host->speed();
160 /** \ingroup m_host_management
161 * \brief Return the number of cores.
164 * \return the number of cores
166 int MSG_host_get_core_number(msg_host_t host) {
167 return host->core_count();
170 /** \ingroup m_host_management
171 * \brief Return the list of processes attached to an host.
174 * \return a swag with the attached processes
176 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
178 xbt_assert((host != NULL), "Invalid parameters");
179 return host->processes();
183 /** \ingroup m_host_management
184 * \brief Returns the value of a given host property
187 * \param name a property name
188 * \return value of a property (or NULL if property not set)
190 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
192 return (const char*) xbt_dict_get_or_null(MSG_host_get_properties(host), name);
195 /** \ingroup m_host_management
196 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
199 * \return a dict containing the properties
201 xbt_dict_t MSG_host_get_properties(msg_host_t host)
203 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
204 return host->properties();
207 /** \ingroup m_host_management
208 * \brief Change the value of a given host property
211 * \param name a property name
212 * \param value what to change the property to
213 * \param free_ctn the freeing function to use to kill the value on need
215 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
217 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
221 /** @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)
232 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
233 return sg_host_is_on(host);
235 /** @ingroup m_host_management
237 * @brief Determine if a host is currently off.
239 * 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.
241 int MSG_host_is_off(msg_host_t host)
243 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
244 return !(sg_host_is_on(host));
247 /** \ingroup m_host_management
248 * \brief Set the parameters of a given host
251 * \param params a prameter object
253 void MSG_host_set_params(msg_host_t host, vm_params_t params)
255 host->setParameters(params);
258 /** \ingroup m_host_management
259 * \brief Get the parameters of a given host
262 * \param params a prameter object
264 void MSG_host_get_params(msg_host_t host, vm_params_t params)
266 host->parameters(params);
269 /** \ingroup m_host_management
270 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
272 * \param host host to test
273 * \param pstate_index pstate to test
274 * \return Returns the processor speed associated with pstate_index
276 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
277 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
278 return host->powerPeakAt(pstate_index);
281 /** \ingroup m_host_management
282 * \brief Return the current speed of the processor (in flop/s)
284 * \param host host to test
285 * \return Returns the current processor speed
287 double MSG_host_get_current_power_peak(msg_host_t host) {
288 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
289 return host->currentPowerPeak();
292 /** \ingroup m_host_management
293 * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
295 * \param host host to test
297 int MSG_host_get_nb_pstates(msg_host_t host) {
298 return sg_host_get_nb_pstates(host);
301 /** \ingroup m_host_management
302 * \brief Return the list of mount point names on an host.
304 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
306 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
308 xbt_assert((host != NULL), "Invalid parameters");
309 return host->mountedStoragesAsDict();
312 /** \ingroup m_host_management
313 * \brief Return the list of storages attached to an host.
315 * \return a dynar containing all storages (name) attached to the host
317 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
319 xbt_assert((host != NULL), "Invalid parameters");
320 return host->attachedStorages();
323 /** \ingroup m_host_management
324 * \brief Return the content of mounted storages on an host.
326 * \return a dict containing content (as a dict) of all storages mounted on the host
328 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
330 xbt_assert((host != NULL), "Invalid parameters");
331 xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
332 msg_storage_t storage;
335 xbt_dict_cursor_t cursor = NULL;
337 xbt_dict_t storage_list = host->mountedStoragesAsDict();
339 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
340 storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
341 xbt_dict_t content = simcall_storage_get_content(storage);
342 xbt_dict_set(contents,mount_name, content,NULL);
344 xbt_dict_free(&storage_list);
348 int __MSG_host_get_file_descriptor_id(msg_host_t host){
349 msg_host_priv_t priv = sg_host_msg(host);
350 xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table),
351 "Too much files are opened! Some have to be closed.");
352 return xbt_dynar_pop_as(priv->file_descriptor_table, int);
355 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
356 msg_host_priv_t priv = sg_host_msg(host);
357 xbt_dynar_push_as(priv->file_descriptor_table, int, id);