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/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 #ifdef MSG_USE_DEPRECATED
36 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
38 priv->mailboxes = (msg_global->max_channel > 0) ?
39 xbt_new0(msg_mailbox_t, msg_global->max_channel) : NULL;
41 for (i = 0; i < msg_global->max_channel; i++) {
42 sprintf(alias, "%s:%d", name, i);
44 /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
45 priv->mailboxes[i] = MSG_mailbox_new(alias);
46 memset(alias, 0, MAX_ALIAS_NAME + 1);
51 priv->dp_objs = xbt_dict_new();
53 priv->dp_updated_by_deleted_tasks = 0;
54 priv->is_migrating = 0;
56 priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
58 priv->file_descriptor_table = xbt_dynar_new(sizeof(int), NULL);
59 for (int i=1023; i>=0;i--)
60 xbt_dynar_push_as(priv->file_descriptor_table, int, i);
62 sg_host_msg_set(host,priv);
67 /** \ingroup m_host_management
68 * \brief Finds a msg_host_t using its name.
70 * This is a name directory service
71 * \param name the name of an host.
72 * \return the corresponding host
74 msg_host_t MSG_host_by_name(const char *name)
76 return simgrid::Host::by_name_or_null(name);
79 /** \ingroup m_host_management
81 * \brief Set the user data of a #msg_host_t.
83 * This functions checks whether some data has already been associated to \a host
84 or not and attach \a data to \a host if it is possible.
86 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
87 sg_host_user_set(host, data);
91 /** \ingroup m_host_management
93 * \brief Return the user data of a #msg_host_t.
95 * This functions checks whether \a host is a valid pointer or not and return
96 the user data associated to \a host if it is possible.
98 void *MSG_host_get_data(msg_host_t host) {
99 return sg_host_user(host);
102 /** \ingroup m_host_management
104 * \brief Return the name of the #msg_host_t.
106 * This functions checks whether \a host is a valid pointer or not and return
109 const char *MSG_host_get_name(msg_host_t host) {
110 return SIMIX_host_get_name(host);
113 /** \ingroup m_host_management
115 * \brief Return the location on which the current process is executed.
117 msg_host_t MSG_host_self(void)
119 return MSG_process_get_host(NULL);
123 /** \ingroup m_host_management
125 * \brief Start the host if it is off
127 * 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.
129 void MSG_host_on(msg_host_t host)
131 simcall_host_on(host);
134 /** \ingroup m_host_management
136 * \brief Stop the host if it is on
138 * 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.
140 void MSG_host_off(msg_host_t host)
142 simcall_host_off(host);
146 * \brief Frees private data of a host (internal call only)
148 void __MSG_host_priv_free(msg_host_priv_t priv)
153 unsigned int size = xbt_dict_size(priv->dp_objs);
155 XBT_WARN("dp_objs: %u pending task?", size);
156 xbt_dict_free(&priv->dp_objs);
157 xbt_dict_free(&priv->affinity_mask_db);
158 xbt_dynar_free(&priv->file_descriptor_table);
159 #ifdef MSG_USE_DEPRECATED
160 free(priv->mailboxes);
167 * \brief Destroys a host (internal call only)
169 void __MSG_host_destroy(msg_host_t host) //FIXME: killme?
172 * What happens if VMs still remain on this host?
173 * Revisit here after the surf layer gets stable.
175 sg_host_msg_destroy(host);
178 /** \ingroup m_host_management
179 * \brief Return the current number MSG hosts.
181 int MSG_get_host_number(void)
183 return xbt_dict_length(host_list);
186 #ifdef MSG_USE_DEPRECATED
187 msg_host_t *MSG_get_host_table(void)
189 if (xbt_dict_is_empty(host_list))
192 void **array = xbt_new0(void *, xbt_dict_length(host_list));
194 xbt_lib_cursor_t cursor;
197 xbt_dict_foreach(host_list, cursor, id, host)
198 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
199 array[i++] = host->facet(MSG_HOST_LEVEL);
201 return (msg_host_t *)array;
205 /** \ingroup m_host_management
206 * \brief Return a dynar containing all the hosts declared at a given point of time
207 * \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)
209 xbt_dynar_t MSG_hosts_as_dynar(void) {
210 return sg_hosts_as_dynar();
213 /** \ingroup m_host_management
214 * \brief Return the number of MSG tasks currently running on a
215 * #msg_host_t. The external load is not taken in account.
217 int MSG_get_host_msgload(msg_host_t h)
219 xbt_assert((h != NULL), "Invalid parameters");
220 xbt_die( "Not implemented yet");
225 /** \ingroup m_host_management
226 * \brief Return the speed of the processor (in flop/s), regardless of
227 the current load on the machine.
229 double MSG_get_host_speed(msg_host_t h)
231 xbt_assert((h != NULL), "Invalid parameters");
233 return sg_host_get_speed(h);
237 /** \ingroup m_host_management
238 * \brief Return the number of cores.
241 * \return the number of cores
243 int MSG_host_get_core_number(msg_host_t host)
245 xbt_assert((host != NULL), "Invalid parameters");
247 return sg_host_get_core(host);
250 /** \ingroup m_host_management
251 * \brief Return the list of processes attached to an host.
254 * \return a swag with the attached processes
256 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
258 xbt_assert((host != NULL), "Invalid parameters");
260 return (simcall_host_get_process_list(host));
264 /** \ingroup m_host_management
265 * \brief Returns the value of a given host property
268 * \param name a property name
269 * \return value of a property (or NULL if property not set)
271 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
273 return (const char*) xbt_dict_get_or_null(MSG_host_get_properties(host), name);
276 /** \ingroup m_host_management
277 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
280 * \return a dict containing the properties
282 xbt_dict_t MSG_host_get_properties(msg_host_t host)
284 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
286 return (simcall_host_get_properties(host));
289 /** \ingroup m_host_management
290 * \brief Change the value of a given host property
293 * \param name a property name
294 * \param value what to change the property to
295 * \param free_ctn the freeing function to use to kill the value on need
297 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
299 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
303 /** @ingroup m_host_management
305 * @brief Determine if a host is up and running.
307 * 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.
309 * @param host host to test
310 * @return Returns true if the host is up and running, and false if it's currently down
312 int MSG_host_is_on(msg_host_t host)
314 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
315 return sg_host_get_state(host);
317 /** @ingroup m_host_management
319 * @brief Determine if a host is currently off.
321 * 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.
323 int MSG_host_is_off(msg_host_t host)
325 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
326 return !(sg_host_get_state(host));
329 /** \ingroup m_host_management
330 * \brief Set the parameters of a given host
333 * \param params a prameter object
335 void MSG_host_set_params(msg_host_t host, vm_params_t params)
337 simcall_host_set_params(host, params);
340 /** \ingroup m_host_management
341 * \brief Get the parameters of a given host
344 * \param params a prameter object
346 void MSG_host_get_params(msg_host_t host, vm_params_t params)
348 simcall_host_get_params(host, params);
351 /** \ingroup m_host_management
352 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
354 * \param host host to test
355 * \param pstate_index pstate to test
356 * \return Returns the processor speed associated with pstate_index
358 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
359 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
360 return (simcall_host_get_power_peak_at(host, pstate_index));
363 /** \ingroup m_host_management
364 * \brief Return the current speed of the processor (in flop/s)
366 * \param host host to test
367 * \return Returns the current processor speed
369 double MSG_host_get_current_power_peak(msg_host_t host) {
370 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
371 return simcall_host_get_current_power_peak(host);
374 /** \ingroup m_host_management
375 * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
377 * \param host host to test
379 int MSG_host_get_nb_pstates(msg_host_t host) {
380 return sg_host_get_nb_pstates(host);
383 /** \ingroup m_host_management
384 * \brief Sets the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
386 * \param host host to test
387 * \param pstate_index pstate to switch to
389 void MSG_host_set_pstate(msg_host_t host, int pstate_index) {
390 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
392 simcall_host_set_pstate(host, pstate_index);
394 /** \ingroup m_host_management
395 * \brief Gets the pstate at which the given host is currently running. See also @ref SURF_plugin_energy.
397 * \param host host to test
399 int MSG_host_get_pstate(msg_host_t host) {
400 return sg_host_get_pstate(host);
403 /** \ingroup m_host_management
404 * \brief Return the total energy consumed by a host (in Joules). See also @ref SURF_plugin_energy.
406 * \param host host to test
407 * \return Returns the consumed energy
409 double MSG_host_get_consumed_energy(msg_host_t host) {
410 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
411 return sg_host_get_consumed_energy(host);
413 /** \ingroup m_host_management
414 * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
417 double MSG_host_get_wattmin_at(msg_host_t host, int pstate){
418 return simcall_host_get_wattmin_at(host, pstate);
420 /** \ingroup m_host_management
421 * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
424 double MSG_host_get_wattmax_at(msg_host_t host, int pstate){
425 return simcall_host_get_wattmax_at(host, pstate);
428 /** \ingroup m_host_management
429 * \brief Return the list of mount point names on an host.
431 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
433 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
435 xbt_assert((host != NULL), "Invalid parameters");
436 return (simcall_host_get_mounted_storage_list(host));
439 /** \ingroup m_host_management
440 * \brief Return the list of storages attached to an host.
442 * \return a dynar containing all storages (name) attached to the host
444 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
446 xbt_assert((host != NULL), "Invalid parameters");
447 return (simcall_host_get_attached_storage_list(host));
450 /** \ingroup m_host_management
451 * \brief Return the content of mounted storages on an host.
453 * \return a dict containing content (as a dict) of all storages mounted on the host
455 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
457 xbt_assert((host != NULL), "Invalid parameters");
458 xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
459 msg_storage_t storage;
462 xbt_dict_cursor_t cursor = NULL;
464 xbt_dict_t storage_list = simcall_host_get_mounted_storage_list(host);
466 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
467 storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
468 xbt_dict_t content = simcall_storage_get_content(storage);
469 xbt_dict_set(contents,mount_name, content,NULL);
471 xbt_dict_free(&storage_list);
475 int __MSG_host_get_file_descriptor_id(msg_host_t host){
476 msg_host_priv_t priv = sg_host_msg(host);
477 xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table),
478 "Too much files are opened! Some have to be closed.");
479 return xbt_dynar_pop_as(priv->file_descriptor_table, int);
482 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
483 msg_host_priv_t priv = sg_host_msg(host);
484 xbt_dynar_push_as(priv->file_descriptor_table, int, id);