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"
13 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
15 /** @addtogroup m_host_management
16 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
17 * (#msg_host_t) and the functions for managing it.
19 * A <em>location</em> (or <em>host</em>) is any possible place where
20 * a process may run. Thus it may be represented as a
21 * <em>physical resource with computing capabilities</em>, some
22 * <em>mailboxes</em> to enable running process to communicate with
23 * remote ones, and some <em>private data</em> that can be only
24 * accessed by local process.
28 /********************************* Host **************************************/
29 msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our parameter
31 msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
33 #ifdef MSG_USE_DEPRECATED
35 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
37 priv->mailboxes = (msg_global->max_channel > 0) ?
38 xbt_new0(msg_mailbox_t, msg_global->max_channel) : NULL;
40 for (i = 0; i < msg_global->max_channel; i++) {
41 sprintf(alias, "%s:%d", name, i);
43 /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
44 priv->mailboxes[i] = MSG_mailbox_new(alias);
45 memset(alias, 0, MAX_ALIAS_NAME + 1);
50 priv->dp_objs = xbt_dict_new();
52 priv->dp_updated_by_deleted_tasks = 0;
53 priv->is_migrating = 0;
55 priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
57 priv->file_descriptor_table = xbt_dynar_new(sizeof(int), NULL);
58 for (int i=1023; i>=0;i--)
59 xbt_dynar_push_as(priv->file_descriptor_table, int, i);
61 sg_host_msg_set(host,priv);
66 /** \ingroup m_host_management
67 * \brief Finds a msg_host_t using its name.
69 * This is a name directory service
70 * \param name the name of an host.
71 * \return the corresponding host
73 msg_host_t MSG_host_by_name(const char *name)
75 return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
78 /** \ingroup m_host_management
80 * \brief Set the user data of a #msg_host_t.
82 * This functions checks whether some data has already been associated to \a host
83 or not and attach \a data to \a host if it is possible.
85 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
86 sg_host_user_set(host, data);
90 /** \ingroup m_host_management
92 * \brief Return the user data of a #msg_host_t.
94 * This functions checks whether \a host is a valid pointer or not and return
95 the user data associated to \a host if it is possible.
97 void *MSG_host_get_data(msg_host_t host) {
98 return sg_host_user(host);
101 /** \ingroup m_host_management
103 * \brief Return the name of the #msg_host_t.
105 * This functions checks whether \a host is a valid pointer or not and return
108 const char *MSG_host_get_name(msg_host_t host) {
109 return SIMIX_host_get_name(host);
112 /** \ingroup m_host_management
114 * \brief Return the location on which the current process is executed.
116 msg_host_t MSG_host_self(void)
118 return MSG_process_get_host(NULL);
122 /** \ingroup m_host_management
124 * \brief Start the host if it is off
126 * 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.
128 void MSG_host_on(msg_host_t host)
130 simcall_host_on(host);
133 /** \ingroup m_host_management
135 * \brief Stop the host if it is on
137 * 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.
139 void MSG_host_off(msg_host_t host)
141 simcall_host_off(host);
145 * \brief Frees private data of a host (internal call only)
147 void __MSG_host_priv_free(msg_host_priv_t priv)
152 unsigned int size = xbt_dict_size(priv->dp_objs);
154 XBT_WARN("dp_objs: %u pending task?", size);
155 xbt_dict_free(&priv->dp_objs);
156 xbt_dict_free(&priv->affinity_mask_db);
157 xbt_dynar_free(&priv->file_descriptor_table);
158 #ifdef MSG_USE_DEPRECATED
159 free(priv->mailboxes);
166 * \brief Destroys a host (internal call only)
168 void __MSG_host_destroy(msg_host_t host) //FIXME: killme?
171 * What happens if VMs still remain on this host?
172 * Revisit here after the surf layer gets stable.
174 sg_host_msg_destroy(host);
177 /** \ingroup m_host_management
178 * \brief Return the current number MSG hosts.
180 int MSG_get_host_number(void)
182 return xbt_lib_length(host_lib);
185 #ifdef MSG_USE_DEPRECATED
186 msg_host_t *MSG_get_host_table(void)
190 xbt_lib_cursor_t cursor;
194 if (xbt_lib_length(host_lib) == 0)
197 array = xbt_new0(void *, xbt_lib_length(host_lib));
199 xbt_lib_foreach(host_lib, cursor, key, data) {
200 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
201 array[i++] = data[MSG_HOST_LEVEL];
204 return (msg_host_t *)array;
208 /** \ingroup m_host_management
209 * \brief Return a dynar containing all the hosts declared at a given point of time
210 * \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)
212 xbt_dynar_t MSG_hosts_as_dynar(void) {
213 return sg_hosts_as_dynar();
216 /** \ingroup m_host_management
217 * \brief Return the number of MSG tasks currently running on a
218 * #msg_host_t. The external load is not taken in account.
220 int MSG_get_host_msgload(msg_host_t h)
222 xbt_assert((h != NULL), "Invalid parameters");
223 xbt_die( "Not implemented yet");
228 /** \ingroup m_host_management
229 * \brief Return the speed of the processor (in flop/s), regardless of
230 the current load on the machine.
232 double MSG_get_host_speed(msg_host_t h)
234 xbt_assert((h != NULL), "Invalid parameters");
236 return sg_host_get_speed(h);
240 /** \ingroup m_host_management
241 * \brief Return the number of cores.
244 * \return the number of cores
246 int MSG_host_get_core_number(msg_host_t host)
248 xbt_assert((host != NULL), "Invalid parameters");
250 return sg_host_get_core(host);
253 /** \ingroup m_host_management
254 * \brief Return the list of processes attached to an host.
257 * \return a swag with the attached processes
259 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
261 xbt_assert((host != NULL), "Invalid parameters");
263 return (simcall_host_get_process_list(host));
267 /** \ingroup m_host_management
268 * \brief Returns the value of a given host property
271 * \param name a property name
272 * \return value of a property (or NULL if property not set)
274 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
276 return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
279 /** \ingroup m_host_management
280 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
283 * \return a dict containing the properties
285 xbt_dict_t MSG_host_get_properties(msg_host_t host)
287 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
289 return (simcall_host_get_properties(host));
292 /** \ingroup m_host_management
293 * \brief Change the value of a given host property
296 * \param name a property name
297 * \param value what to change the property to
298 * \param free_ctn the freeing function to use to kill the value on need
300 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
302 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
306 /** @ingroup m_host_management
308 * @brief Determine if a host is up and running.
310 * 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.
312 * @param host host to test
313 * @return Returns true if the host is up and running, and false if it's currently down
315 int MSG_host_is_on(msg_host_t host)
317 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
318 return sg_host_get_state(host);
320 /** @ingroup m_host_management
322 * @brief Determine if a host is currently off.
324 * 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.
326 int MSG_host_is_off(msg_host_t host)
328 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
329 return !(sg_host_get_state(host));
332 /** \ingroup m_host_management
333 * \brief Set the parameters of a given host
336 * \param params a prameter object
338 void MSG_host_set_params(msg_host_t host, vm_params_t params)
340 simcall_host_set_params(host, params);
343 /** \ingroup m_host_management
344 * \brief Get the parameters of a given host
347 * \param params a prameter object
349 void MSG_host_get_params(msg_host_t host, vm_params_t params)
351 simcall_host_get_params(host, params);
354 /** \ingroup m_host_management
355 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
357 * \param host host to test
358 * \param pstate_index pstate to test
359 * \return Returns the processor speed associated with pstate_index
361 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
362 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
363 return (simcall_host_get_power_peak_at(host, pstate_index));
366 /** \ingroup m_host_management
367 * \brief Return the current speed of the processor (in flop/s)
369 * \param host host to test
370 * \return Returns the current processor speed
372 double MSG_host_get_current_power_peak(msg_host_t host) {
373 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
374 return simcall_host_get_current_power_peak(host);
377 /** \ingroup m_host_management
378 * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
380 * \param host host to test
382 int MSG_host_get_nb_pstates(msg_host_t host) {
383 return sg_host_get_nb_pstates(host);
386 /** \ingroup m_host_management
387 * \brief Sets the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
389 * \param host host to test
390 * \param pstate_index pstate to switch to
392 void MSG_host_set_pstate(msg_host_t host, int pstate_index) {
393 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
395 simcall_host_set_pstate(host, pstate_index);
397 /** \ingroup m_host_management
398 * \brief Gets the pstate at which the given host is currently running. See also @ref SURF_plugin_energy.
400 * \param host host to test
402 int MSG_host_get_pstate(msg_host_t host) {
403 return sg_host_get_pstate(host);
406 /** \ingroup m_host_management
407 * \brief Return the total energy consumed by a host (in Joules). See also @ref SURF_plugin_energy.
409 * \param host host to test
410 * \return Returns the consumed energy
412 double MSG_host_get_consumed_energy(msg_host_t host) {
413 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
414 return sg_host_get_consumed_energy(host);
416 /** \ingroup m_host_management
417 * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
420 double MSG_host_get_wattmin_at(msg_host_t host, int pstate){
421 return simcall_host_get_wattmin_at(host, pstate);
423 /** \ingroup m_host_management
424 * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
427 double MSG_host_get_wattmax_at(msg_host_t host, int pstate){
428 return simcall_host_get_wattmax_at(host, pstate);
431 /** \ingroup m_host_management
432 * \brief Return the list of mount point names on an host.
434 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
436 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
438 xbt_assert((host != NULL), "Invalid parameters");
439 return (simcall_host_get_mounted_storage_list(host));
442 /** \ingroup m_host_management
443 * \brief Return the list of storages attached to an host.
445 * \return a dynar containing all storages (name) attached to the host
447 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
449 xbt_assert((host != NULL), "Invalid parameters");
450 return (simcall_host_get_attached_storage_list(host));
453 /** \ingroup m_host_management
454 * \brief Return the content of mounted storages on an host.
456 * \return a dict containing content (as a dict) of all storages mounted on the host
458 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
460 xbt_assert((host != NULL), "Invalid parameters");
461 xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
462 msg_storage_t storage;
465 xbt_dict_cursor_t cursor = NULL;
467 xbt_dict_t storage_list = simcall_host_get_mounted_storage_list(host);
469 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
470 storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
471 xbt_dict_t content = simcall_storage_get_content(storage);
472 xbt_dict_set(contents,mount_name, content,NULL);
474 xbt_dict_free(&storage_list);
478 int __MSG_host_get_file_descriptor_id(msg_host_t host){
479 msg_host_priv_t priv = sg_host_msg(host);
480 xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table),
481 "Too much files are opened! Some have to be closed.");
482 return xbt_dynar_pop_as(priv->file_descriptor_table, int);
485 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
486 msg_host_priv_t priv = sg_host_msg(host);
487 xbt_dynar_push_as(priv->file_descriptor_table, int, id);