1 /* Copyright (c) 2013-2018. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_HOST_H_
7 #define SIMGRID_HOST_H_
10 #include <xbt/dynar.h>
11 #include <simgrid/forward.h>
14 /** @brief Host datatype.
15 @ingroup m_host_management
17 A <em>location</em> (or <em>host</em>) is any possible place where an actor may run. Thus it is represented as a
18 <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running actors to
19 communicate with remote ones, and some <em>private data</em> that can be only accessed by local actors.
22 XBT_PUBLIC sg_host_t* sg_host_list();
24 /** @ingroup m_host_management
25 * @brief Return the current number of hosts.
27 XBT_PUBLIC size_t sg_host_count();
29 /** @ingroup m_host_management
30 * @brief Return a dynar containing all the hosts declared at a given point of time (including VMs)
31 * @remark The host order in the returned array is generally different from the host creation/declaration order in the
32 * XML platform (we use a hash table internally)
34 XBT_PUBLIC xbt_dynar_t sg_hosts_as_dynar();
36 XBT_PUBLIC size_t sg_host_extension_create(void (*deleter)(void*));
37 XBT_PUBLIC void* sg_host_extension_get(sg_host_t host, size_t rank);
39 /** @ingroup m_host_management
40 * @brief Finds a sg_host_t using its name.
42 * This is a name directory service
43 * @param name the name of an host.
44 * @return the corresponding host
46 XBT_PUBLIC sg_host_t sg_host_by_name(const char* name);
48 /** @ingroup m_host_management
50 * @brief Return the name of the #sg_host_t. */
51 XBT_PUBLIC const char* sg_host_get_name(sg_host_t host);
53 // ========== User Data ==============
54 /** @ingroup m_host_management
56 * @brief Return the user data of a #sg_host_t.
58 * This functions returns the user data associated to @a host if it is possible.
60 XBT_PUBLIC void* sg_host_user(sg_host_t host);
61 /** @ingroup m_host_management
63 * @brief Set the user data of a #sg_host_t.
65 * This functions attach @a data to @a host if it is possible.
67 XBT_PUBLIC void sg_host_user_set(sg_host_t host, void* userdata);
68 XBT_PUBLIC void sg_host_user_destroy(sg_host_t host);
70 // ========= storage related functions ============
71 /** @ingroup m_host_management
72 * @brief Return the list of mount point names on an host.
74 * @return a dict containing all mount point on the host (mount_name => sg_storage_t)
76 XBT_PUBLIC xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host);
78 /** @ingroup m_host_management
79 * @brief Return the list of storages attached to an host.
81 * @return a dynar containing all storages (name) attached to the host
83 XBT_PUBLIC xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host);
85 // =========== user-level functions ===============
86 /** @ingroup m_host_management
87 * @brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
89 XBT_PUBLIC double sg_host_speed(sg_host_t host);
90 XBT_PUBLIC double sg_host_get_pstate_speed(sg_host_t host, int pstate_index);
92 XBT_PUBLIC double sg_host_get_available_speed(sg_host_t host);
94 XBT_PUBLIC int sg_host_core_count(sg_host_t host);
96 /** @ingroup m_process_management
97 * @brief Return the location on which a process is running.
98 * @return the sg_host_t corresponding to the location on which @a process is running.
100 XBT_PUBLIC sg_host_t sg_host_self();
102 XBT_PUBLIC const char* sg_host_self_get_name();
104 /** @ingroup m_host_management
105 * @brief Return the total count of pstates defined for a host. See also @ref plugin_energy.
107 * @param host host to test
109 XBT_PUBLIC int sg_host_get_nb_pstates(sg_host_t host);
111 XBT_PUBLIC int sg_host_get_pstate(sg_host_t host);
112 XBT_PUBLIC void sg_host_set_pstate(sg_host_t host, int pstate);
114 XBT_PUBLIC void sg_host_turn_on(sg_host_t host);
115 XBT_PUBLIC void sg_host_turn_off(sg_host_t host);
116 XBT_PUBLIC int sg_host_is_on(sg_host_t host);
117 XBT_PUBLIC int sg_host_is_off(sg_host_t host);
119 /** @ingroup m_host_management
120 * @brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
123 * @return a dict containing the properties
125 XBT_PUBLIC xbt_dict_t sg_host_get_properties(sg_host_t host);
127 /** @ingroup m_host_management
128 * @brief Returns the value of a given host property
131 * @param name a property name
132 * @return value of a property (or nullptr if property not set)
134 XBT_PUBLIC const char* sg_host_get_property_value(sg_host_t host, const char* name);
136 /** @ingroup m_host_management
137 * @brief Change the value of a given host property
140 * @param name a property name
141 * @param value what to change the property to
143 XBT_PUBLIC void sg_host_set_property_value(sg_host_t host, const char* name, const char* value);
145 XBT_PUBLIC void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links);
146 XBT_PUBLIC double sg_host_route_latency(sg_host_t from, sg_host_t to);
147 XBT_PUBLIC double sg_host_route_bandwidth(sg_host_t from, sg_host_t to);
148 XBT_PUBLIC void sg_host_dump(sg_host_t ws);
150 XBT_PUBLIC void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto);
153 #endif /* SIMGRID_HOST_H_ */