Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
6c7c2fe93f4b8c8abef5dff70b00ea4e89933de8
[simgrid.git] / src / msg / msg_host.cpp
1 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include "simgrid/s4u/Host.hpp"
7 #include "simgrid/s4u/Storage.hpp"
8 #include "src/msg/msg_private.h"
9 #include "src/simix/ActorImpl.hpp"
10 #include "src/simix/smx_host_private.h"
11
12
13 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
14
15 simgrid::xbt::Extension<simgrid::s4u::Host, simgrid::MsgHostExt> simgrid::MsgHostExt::EXTENSION_ID;
16
17 SG_BEGIN_DECL()
18
19 int sg_storage_max_file_descriptors = 1024;
20
21 /** @addtogroup m_host_management
22  * (#msg_host_t) and the functions for managing it.
23  *
24  *  A <em>location</em> (or <em>host</em>) is any possible place where  a process may run. Thus it may be represented
25  *  as a <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running process to
26  *  communicate with remote ones, and some <em>private data</em> that can be only accessed by local process.
27  *  \see msg_host_t
28  */
29
30 /********************************* Host **************************************/
31 /** \ingroup m_host_management
32  * \brief Finds a msg_host_t using its name.
33  *
34  * This is a name directory service
35  * \param name the name of an host.
36  * \return the corresponding host
37  */
38 msg_host_t MSG_host_by_name(const char *name)
39 {
40   return simgrid::s4u::Host::by_name_or_null(name);
41 }
42
43 /** \ingroup m_host_management
44  *
45  * \brief Set the user data of a #msg_host_t.
46  *
47  * This functions attach \a data to \a host if it is possible.
48  */
49 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
50   sg_host_user_set(host, data);
51   return MSG_OK;
52 }
53
54 /** \ingroup m_host_management
55  *
56  * \brief Return the user data of a #msg_host_t.
57  *
58  * This functions returns the user data associated to \a host if it is possible.
59  */
60 void *MSG_host_get_data(msg_host_t host) {
61   return sg_host_user(host);
62 }
63
64 /** \ingroup m_host_management
65  *
66  * \brief Return the location on which the current process is executed.
67  */
68 msg_host_t MSG_host_self()
69 {
70   return MSG_process_get_host(nullptr);
71 }
72
73 /** \ingroup m_host_management
74  *
75  * \brief Start the host if it is off
76  *
77  * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
78  * for more info on DVFS.
79  */
80 void MSG_host_on(msg_host_t host)
81 {
82   host->turnOn();
83 }
84
85 /** \ingroup m_host_management
86  *
87  * \brief Stop the host if it is on
88  *
89  * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
90  * for more info on DVFS.
91  */
92 void MSG_host_off(msg_host_t host)
93 {
94   host->turnOff();
95 }
96
97 /** \ingroup m_host_management
98  * \brief Return the current number MSG hosts.
99  */
100 int MSG_get_host_number()
101 {
102   return sg_host_count();
103 }
104
105 /** \ingroup m_host_management
106  * \brief Return a dynar containing all the hosts declared at a given point of time (including VMs)
107  * \remark The host order in the returned array is generally different from the host creation/declaration order in the
108  *         XML platform (we use a hash table internally)
109  */
110 xbt_dynar_t MSG_hosts_as_dynar() {
111   return sg_hosts_as_dynar();
112 }
113
114 /** \ingroup m_host_management
115  * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
116  */
117 double MSG_host_get_speed(msg_host_t host) {
118   return host->speed();
119 }
120
121 /** \ingroup m_host_management
122  * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
123  * Deprecated: use MSG_host_get_speed
124  */
125 double MSG_get_host_speed(msg_host_t host) {
126   XBT_WARN("MSG_get_host_speed is deprecated: use MSG_host_get_speed");
127   return MSG_host_get_speed(host);
128 }
129
130 /** \ingroup m_host_management
131  * \brief Return the number of cores.
132  *
133  * \param host a host
134  * \return the number of cores
135  */
136 int MSG_host_get_core_number(msg_host_t host) {
137   return host->coreCount();
138 }
139
140 /** \ingroup m_host_management
141  * \brief Return the list of processes attached to an host.
142  *
143  * \param host a host
144  * \param whereto a dynar in which we should push processes living on that host
145  */
146 void MSG_host_get_process_list(msg_host_t host, xbt_dynar_t whereto)
147 {
148   xbt_assert((host != nullptr), "Invalid parameters");
149   smx_actor_t actor = NULL;
150   xbt_swag_foreach(actor, host->extension<simgrid::simix::Host>()->process_list) {
151     msg_process_t p = actor->ciface();
152     xbt_dynar_push(whereto, &p);
153   }
154 }
155
156 /** \ingroup m_host_management
157  * \brief Returns the value of a given host property
158  *
159  * \param host a host
160  * \param name a property name
161  * \return value of a property (or nullptr if property not set)
162  */
163 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
164 {
165   return static_cast<const char*>(xbt_dict_get_or_null(MSG_host_get_properties(host), name));
166 }
167
168 /** \ingroup m_host_management
169  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
170  *
171  * \param host a host
172  * \return a dict containing the properties
173  */
174 xbt_dict_t MSG_host_get_properties(msg_host_t host)
175 {
176   xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
177   return host->properties();
178 }
179
180 /** \ingroup m_host_management
181  * \brief Change the value of a given host property
182  *
183  * \param host a host
184  * \param name a property name
185  * \param value what to change the property to
186  */
187 void MSG_host_set_property_value(msg_host_t host, const char* name, char* value)
188 {
189   xbt_dict_set(MSG_host_get_properties(host), name, value, nullptr);
190 }
191
192 /** @ingroup m_host_management
193  * @brief Determine if a host is up and running.
194  *
195  * 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.
196  *
197  * @param host host to test
198  * @return Returns true if the host is up and running, and false if it's currently down
199  */
200 int MSG_host_is_on(msg_host_t host)
201 {
202   return host->isOn();
203 }
204
205 /** @ingroup m_host_management
206  * @brief Determine if a host is currently off.
207  *
208  * 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.
209  */
210 int MSG_host_is_off(msg_host_t host)
211 {
212   return host->isOff();
213 }
214
215 /** \ingroup m_host_management
216  * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
217  *
218  * \param  host host to test
219  * \param pstate_index pstate to test
220  * \return Returns the processor speed associated with pstate_index
221  */
222 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
223   xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
224   return host->getPstateSpeed(pstate_index);
225 }
226
227 /** \ingroup m_host_management
228  * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
229  *
230  * \param  host host to test
231  */
232 int MSG_host_get_nb_pstates(msg_host_t host) {
233   return sg_host_get_nb_pstates(host);
234 }
235
236 /** \ingroup m_host_management
237  * \brief Return the list of mount point names on an host.
238  * \param host a host
239  * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
240  */
241 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
242 {
243   return sg_host_get_mounted_storage_list(host);
244 }
245
246 /** \ingroup m_host_management
247  * \brief Return the list of storages attached to an host.
248  * \param host a host
249  * \return a dynar containing all storages (name) attached to the host
250  */
251 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
252 {
253   return sg_host_get_attached_storage_list(host);
254 }
255
256 /** \ingroup m_host_management
257  * \brief Return the content of mounted storages on an host.
258  * \param host a host
259  * \return a dict containing content (as a dict) of all storages mounted on the host
260  */
261 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
262 {
263   xbt_assert((host != nullptr), "Invalid parameters");
264   xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
265   for (auto elm : host->mountedStorages())
266     xbt_dict_set(contents, elm.first.c_str(), MSG_storage_get_content(elm.second), nullptr);
267
268   return contents;
269 }
270
271 SG_END_DECL()