Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
28bd9bbf3b635dbe583074df85bfa5049222b228
[simgrid.git] / src / msg / msg_host.cpp
1 /* Copyright (c) 2004-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include "src/msg/msg_private.h"
8 #include "xbt/sysdep.h"
9 #include "xbt/log.h"
10 #include "simgrid/simix.h"
11 #include <simgrid/s4u/host.hpp>
12 #include <numeric>
13
14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
15
16 int sg_storage_max_file_descriptors = 1024;
17
18 /** @addtogroup m_host_management
19  * (#msg_host_t) and the functions for managing it.
20  *  
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.
24  *  \see msg_host_t
25  */
26
27 /********************************* Host **************************************/
28 msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our parameter
29 {
30   msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
31
32   priv->dp_objs = nullptr;
33   priv->dp_enabled = 0;
34   priv->dp_updated_by_deleted_tasks = 0;
35   priv->is_migrating = 0;
36
37   priv->file_descriptor_table = nullptr;
38
39   sg_host_msg_set(host,priv);
40
41   return host;
42 }
43
44 /** \ingroup m_host_management
45  * \brief Finds a msg_host_t using its name.
46  *
47  * This is a name directory service
48  * \param name the name of an host.
49  * \return the corresponding host
50  */
51 msg_host_t MSG_host_by_name(const char *name)
52 {
53   return simgrid::s4u::Host::by_name_or_null(name);
54 }
55
56 /** \ingroup m_host_management
57  *
58  * \brief Set the user data of a #msg_host_t.
59  *
60  * This functions attach \a data to \a host if it is possible.
61  */
62 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
63   sg_host_user_set(host, data);
64   return MSG_OK;
65 }
66
67 /** \ingroup m_host_management
68  *
69  * \brief Return the user data of a #msg_host_t.
70  *
71  * This functions returns the user data associated to \a host if it is possible.
72  */
73 void *MSG_host_get_data(msg_host_t host) {
74   return sg_host_user(host);
75 }
76
77 /** \ingroup m_host_management
78  *
79  * \brief Return the location on which the current process is executed.
80  */
81 msg_host_t MSG_host_self()
82 {
83   return MSG_process_get_host(nullptr);
84 }
85
86 /** \ingroup m_host_management
87  *
88  * \brief Start the host if it is off
89  *
90  * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
91  * for more info on DVFS.
92  */
93 void MSG_host_on(msg_host_t host)
94 {
95   host->turnOn();
96 }
97
98 /** \ingroup m_host_management
99  *
100  * \brief Stop the host if it is on
101  *
102  * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
103  * for more info on DVFS.
104  */
105 void MSG_host_off(msg_host_t host)
106 {
107   host->turnOff();
108 }
109
110 /*
111  * \brief Frees private data of a host (internal call only)
112  */
113 void __MSG_host_priv_free(msg_host_priv_t priv)
114 {
115   if (priv == nullptr)
116     return;
117   unsigned int size = priv->dp_objs ? xbt_dict_size(priv->dp_objs) : 0;
118   if (size > 0)
119     XBT_WARN("dp_objs: %u pending task?", size);
120   xbt_dict_free(&priv->dp_objs);
121   delete priv->file_descriptor_table;
122   free(priv);
123 }
124
125 /** \ingroup m_host_management
126  * \brief Return the current number MSG hosts.
127  */
128 int MSG_get_host_number()
129 {
130   return sg_host_count();
131 }
132
133 /** \ingroup m_host_management
134  * \brief Return a dynar containing all the hosts declared at a given point of time
135  * \remark The host order in the returned array is generally different from the host creation/declaration order in the
136  *         XML platform (we use a hash table internally)
137  */
138 xbt_dynar_t MSG_hosts_as_dynar() {
139   return sg_hosts_as_dynar();
140 }
141
142 /** \ingroup m_host_management
143  * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
144  */
145 double MSG_host_get_speed(msg_host_t host) {
146   return host->speed();
147 }
148
149 /** \ingroup m_host_management
150  * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
151  * Deprecated: use MSG_host_get_speed
152  */
153 double MSG_get_host_speed(msg_host_t host) {
154   XBT_WARN("MSG_get_host_speed is deprecated: use MSG_host_get_speed");
155   return MSG_host_get_speed(host);
156 }
157
158 /** \ingroup m_host_management
159  * \brief Return the number of cores.
160  *
161  * \param host a host
162  * \return the number of cores
163  */
164 int MSG_host_get_core_number(msg_host_t host) {
165   return host->coreCount();
166 }
167
168 /** \ingroup m_host_management
169  * \brief Return the list of processes attached to an host.
170  *
171  * \param host a host
172  * \return a swag with the attached processes
173  */
174 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
175 {
176   xbt_assert((host != nullptr), "Invalid parameters");
177   return host->processes();
178 }
179
180 /** \ingroup m_host_management
181  * \brief Returns the value of a given host property
182  *
183  * \param host a host
184  * \param name a property name
185  * \return value of a property (or nullptr if property not set)
186  */
187 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
188 {
189   return static_cast<const char*>(xbt_dict_get_or_null(MSG_host_get_properties(host), name));
190 }
191
192 /** \ingroup m_host_management
193  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
194  *
195  * \param host a host
196  * \return a dict containing the properties
197  */
198 xbt_dict_t MSG_host_get_properties(msg_host_t host)
199 {
200   xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
201   return host->properties();
202 }
203
204 /** \ingroup m_host_management
205  * \brief Change the value of a given host property
206  *
207  * \param host a host
208  * \param name a property name
209  * \param value what to change the property to
210  * \param free_ctn the freeing function to use to kill the value on need
211  */
212 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
213   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
214 }
215
216 /** @ingroup m_host_management
217  * @brief Determine if a host is up and running.
218  *
219  * 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.
220  *
221  * @param host host to test
222  * @return Returns true if the host is up and running, and false if it's currently down
223  */
224 int MSG_host_is_on(msg_host_t host)
225 {
226   return host->isOn();
227 }
228
229 /** @ingroup m_host_management
230  * @brief Determine if a host is currently off.
231  *
232  * 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.
233  */
234 int MSG_host_is_off(msg_host_t host)
235 {
236   return host->isOff();
237 }
238
239 /** \ingroup m_host_management
240  * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
241  *
242  * \param  host host to test
243  * \param pstate_index pstate to test
244  * \return Returns the processor speed associated with pstate_index
245  */
246 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
247   xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
248   return host->getPstateSpeed(pstate_index);
249 }
250
251 /** \ingroup m_host_management
252  * \brief Return the current speed of the processor (in flop/s)
253  *
254  * \param  host host to test
255  * \return Returns the current processor speed
256  */
257 double MSG_host_get_current_power_peak(msg_host_t host) {
258   xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
259   return host->getPstateSpeedCurrent();
260 }
261
262 /** \ingroup m_host_management
263  * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
264  *
265  * \param  host host to test
266  */
267 int MSG_host_get_nb_pstates(msg_host_t host) {
268   return sg_host_get_nb_pstates(host);
269 }
270
271 /** \ingroup m_host_management
272  * \brief Return the list of mount point names on an host.
273  * \param host a host
274  * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
275  */
276 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
277 {
278   xbt_assert((host != nullptr), "Invalid parameters");
279   return host->mountedStoragesAsDict();
280 }
281
282 /** \ingroup m_host_management
283  * \brief Return the list of storages attached to an host.
284  * \param host a host
285  * \return a dynar containing all storages (name) attached to the host
286  */
287 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
288 {
289   xbt_assert((host != nullptr), "Invalid parameters");
290   return host->attachedStorages();
291 }
292
293 /** \ingroup m_host_management
294  * \brief Return the content of mounted storages on an host.
295  * \param host a host
296  * \return a dict containing content (as a dict) of all storages mounted on the host
297  */
298 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
299 {
300   xbt_assert((host != nullptr), "Invalid parameters");
301   xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
302   msg_storage_t storage;
303   char* storage_name;
304   char* mount_name;
305   xbt_dict_cursor_t cursor = nullptr;
306
307   xbt_dict_t storage_list = host->mountedStoragesAsDict();
308
309   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
310     storage = static_cast<msg_storage_t>(xbt_lib_get_elm_or_null(storage_lib,storage_name));
311     xbt_dict_t content = simcall_storage_get_content(storage);
312     xbt_dict_set(contents,mount_name, content,nullptr);
313   }
314   xbt_dict_free(&storage_list);
315   return contents;
316 }
317
318 int __MSG_host_get_file_descriptor_id(msg_host_t host){
319   msg_host_priv_t priv = sg_host_msg(host);
320   if(!priv->file_descriptor_table){
321     priv->file_descriptor_table = new std::vector<int>(sg_storage_max_file_descriptors);
322     std::iota (priv->file_descriptor_table->rbegin(), priv->file_descriptor_table->rend(), 0); // Fill with ..., 1, 0.
323   }
324   xbt_assert(!priv->file_descriptor_table->empty(), "Too much files are opened! Some have to be closed.");
325   int desc = priv->file_descriptor_table->back();
326   priv->file_descriptor_table->pop_back();
327   return desc;
328 }
329
330 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
331   msg_host_priv_t priv = sg_host_msg(host);
332   priv->file_descriptor_table->push_back(id);
333 }