Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use correct types for temporary variables.
[simgrid.git] / include / simgrid / host.h
1 /* Copyright (c) 2013-2021. 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 #ifndef SIMGRID_HOST_H_
7 #define SIMGRID_HOST_H_
8
9 #include <xbt/dict.h>
10 #include <xbt/dynar.h>
11 #include <simgrid/forward.h>
12
13 SG_BEGIN_DECL
14 /** Returns an array of all existing hosts (use sg_host_count() to know the array size).
15  *
16  * @remark The host order in this array is generally different from the
17  * creation/declaration order in the XML platform (we use a hash table
18  * internally).
19  */
20 XBT_PUBLIC sg_host_t* sg_host_list();
21
22 /** Returns the amount of hosts existing in the platform. */
23 XBT_PUBLIC size_t sg_host_count();
24
25 /**
26  * @brief Return a dynar containing all the hosts declared at a given point of time (including VMs)
27  * @remark The host order in the returned array is generally different from the host creation/declaration order in the
28  *         XML platform (we use a hash table internally)
29  */
30 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_list()") XBT_PUBLIC xbt_dynar_t sg_hosts_as_dynar();
31
32 XBT_PUBLIC size_t sg_host_extension_create(void (*deleter)(void*));
33 XBT_PUBLIC void* sg_host_extension_get(const_sg_host_t host, size_t rank);
34
35 /** Finds a host from its name */
36 XBT_PUBLIC sg_host_t sg_host_by_name(const char* name);
37
38 /** @brief Return the name of the sg_host_t. */
39 XBT_PUBLIC const char* sg_host_get_name(const_sg_host_t host);
40
41 #ifndef DOXYGEN
42 // ========== User Data ==============
43 /** @brief Return the user data of a #sg_host_t.
44  *
45  * This functions returns the user data associated to @a host if any.
46  */
47 XBT_PUBLIC void* sg_host_get_data(const_sg_host_t host);
48 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_get_data()") XBT_PUBLIC void* sg_host_data(const_sg_host_t host);
49 /** @brief Set the user data of a #sg_host_t.
50  *
51  * This functions attach @a data to @a host.
52  */
53 XBT_PUBLIC void sg_host_set_data(sg_host_t host, void* userdata);
54 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_set_data()") XBT_PUBLIC
55     void sg_host_data_set(sg_host_t host, void* userdata);
56 #endif
57
58 // ========= storage related functions ============
59 XBT_PUBLIC void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks);
60
61 // =========== user-level functions ===============
62 /** @brief Return the speed of the processor (in flop/s), regardless of the current load on the machine. */
63 XBT_PUBLIC double sg_host_get_speed(const_sg_host_t host);
64 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_get_speed()") XBT_PUBLIC double sg_host_speed(const_sg_host_t host);
65 XBT_PUBLIC double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index);
66
67 XBT_PUBLIC double sg_host_get_available_speed(const_sg_host_t host);
68
69 XBT_PUBLIC int sg_host_core_count(const_sg_host_t host);
70
71 /** @brief Returns the current computation load (in flops per second).
72  * @param host a host
73  */
74 XBT_PUBLIC double sg_host_get_load(const_sg_host_t host);
75 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_get_load()") XBT_PUBLIC double sg_host_load(const_sg_host_t host);
76
77 /** @brief Return the location on which the current process is running. */
78 XBT_PUBLIC sg_host_t sg_host_self();
79
80 XBT_PUBLIC const char* sg_host_self_get_name();
81
82 /** @brief Return the total count of pstates defined for a host.
83  *
84  * @beginrst
85  * See also :ref:`plugin_host_energy`.
86  * @endrst
87  *
88  * @param  host host to test
89  */
90 XBT_PUBLIC int sg_host_get_nb_pstates(const_sg_host_t host);
91
92 XBT_PUBLIC int sg_host_get_pstate(const_sg_host_t host);
93 XBT_PUBLIC void sg_host_set_pstate(sg_host_t host, int pstate);
94
95 XBT_PUBLIC void sg_host_turn_on(sg_host_t host);
96 XBT_PUBLIC void sg_host_turn_off(sg_host_t host);
97 XBT_PUBLIC int sg_host_is_on(const_sg_host_t host);
98
99 /** @ingroup m_host_management
100  * @brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
101  *
102  * @param host a host
103  * @return a dict containing the properties
104  */
105 XBT_PUBLIC xbt_dict_t sg_host_get_properties(const_sg_host_t host);
106
107 /** @ingroup m_host_management
108  * @brief Returns the value of a given host property
109  *
110  * @param host a host
111  * @param name a property name
112  * @return value of a property (or nullptr if property not set)
113  */
114 XBT_PUBLIC const char* sg_host_get_property_value(const_sg_host_t host, const char* name);
115
116 /** @ingroup m_host_management
117  * @brief Change the value of a given host property
118  *
119  * @param host a host
120  * @param name a property name
121  * @param value what to change the property to
122  */
123 XBT_PUBLIC void sg_host_set_property_value(sg_host_t host, const char* name, const char* value);
124
125 XBT_PUBLIC void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links);
126 XBT_PUBLIC double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to);
127 XBT_PUBLIC double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to);
128 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_get_route()") XBT_PUBLIC
129     void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links);
130 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_get_route_latency()") XBT_PUBLIC
131     double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to);
132 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_get_route_bandwidth()") XBT_PUBLIC
133     double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to);
134 XBT_PUBLIC void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount);
135
136 #ifndef DOXYGEN
137 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_sendto") inline void sg_host_send_to(sg_host_t from, sg_host_t to,
138                                                                                     double byte_amount)
139 {
140   sg_host_sendto(from, to, byte_amount);
141 }
142 #endif
143
144 XBT_PUBLIC void sg_host_dump(const_sg_host_t ws);
145
146 XBT_PUBLIC void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto);
147 SG_END_DECL
148
149 #endif /* SIMGRID_HOST_H_ */