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_
12 #include <xbt/dynar.h>
14 #include <simgrid/forward.h>
17 /** @brief Host datatype.
18 @ingroup m_host_management
20 A <em>location</em> (or <em>host</em>) is any possible place where an actor may run. Thus it is represented as a
21 <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running actors to
22 communicate with remote ones, and some <em>private data</em> that can be only accessed by local actors.
25 XBT_PUBLIC sg_host_t* sg_host_list();
27 /** \ingroup m_host_management
28 * \brief Return the current number of hosts.
30 XBT_PUBLIC size_t sg_host_count();
32 /** \ingroup m_host_management
33 * \brief Return a dynar containing all the hosts declared at a given point of time (including VMs)
34 * \remark The host order in the returned array is generally different from the host creation/declaration order in the
35 * XML platform (we use a hash table internally)
37 XBT_PUBLIC xbt_dynar_t sg_hosts_as_dynar();
39 XBT_PUBLIC size_t sg_host_extension_create(void (*deleter)(void*));
40 XBT_PUBLIC void* sg_host_extension_get(sg_host_t host, size_t rank);
42 /** \ingroup m_host_management
43 * \brief Finds a sg_host_t using its name.
45 * This is a name directory service
46 * \param name the name of an host.
47 * \return the corresponding host
49 XBT_PUBLIC sg_host_t sg_host_by_name(const char* name);
51 /** \ingroup m_host_management
53 * \brief Return the name of the #sg_host_t. */
54 XBT_PUBLIC const char* sg_host_get_name(sg_host_t host);
56 // ========== User Data ==============
57 /** \ingroup m_host_management
59 * \brief Return the user data of a #sg_host_t.
61 * This functions returns the user data associated to \a host if it is possible.
63 XBT_PUBLIC void* sg_host_user(sg_host_t host);
64 /** \ingroup m_host_management
66 * \brief Set the user data of a #sg_host_t.
68 * This functions attach \a data to \a host if it is possible.
70 XBT_PUBLIC void sg_host_user_set(sg_host_t host, void* userdata);
71 XBT_PUBLIC void sg_host_user_destroy(sg_host_t host);
73 // ========= storage related functions ============
74 /** \ingroup m_host_management
75 * \brief Return the list of mount point names on an host.
77 * \return a dict containing all mount point on the host (mount_name => sg_storage_t)
79 XBT_PUBLIC xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host);
81 /** \ingroup m_host_management
82 * \brief Return the list of storages attached to an host.
84 * \return a dynar containing all storages (name) attached to the host
86 XBT_PUBLIC xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host);
88 // =========== user-level functions ===============
89 /** \ingroup m_host_management
90 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
92 XBT_PUBLIC double sg_host_speed(sg_host_t host);
93 XBT_PUBLIC double sg_host_get_pstate_speed(sg_host_t host, int pstate_index);
95 XBT_PUBLIC double sg_host_get_available_speed(sg_host_t host);
97 XBT_PUBLIC int sg_host_core_count(sg_host_t host);
99 /** \ingroup m_process_management
100 * \brief Return the location on which a process is running.
101 * \param process a process (nullptr means the current one)
102 * \return the sg_host_t corresponding to the location on which \a process is running.
104 XBT_PUBLIC sg_host_t sg_host_self();
106 XBT_PUBLIC const char* sg_host_self_get_name();
108 /** \ingroup m_host_management
109 * \brief Return the total count of pstates defined for a host. See also @ref plugin_energy.
111 * \param host host to test
113 XBT_PUBLIC int sg_host_get_nb_pstates(sg_host_t host);
115 XBT_PUBLIC int sg_host_get_pstate(sg_host_t host);
116 XBT_PUBLIC void sg_host_set_pstate(sg_host_t host, int pstate);
118 XBT_PUBLIC void sg_host_turn_on(sg_host_t host);
119 XBT_PUBLIC void sg_host_turn_off(sg_host_t host);
120 XBT_PUBLIC int sg_host_is_on(sg_host_t host);
121 XBT_PUBLIC int sg_host_is_off(sg_host_t host);
123 /** \ingroup m_host_management
124 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
127 * \return a dict containing the properties
129 XBT_PUBLIC xbt_dict_t sg_host_get_properties(sg_host_t host);
131 /** \ingroup m_host_management
132 * \brief Returns the value of a given host property
135 * \param name a property name
136 * \return value of a property (or nullptr if property not set)
138 XBT_PUBLIC const char* sg_host_get_property_value(sg_host_t host, const char* name);
140 /** \ingroup m_host_management
141 * \brief Change the value of a given host property
144 * \param name a property name
145 * \param value what to change the property to
147 XBT_PUBLIC void sg_host_set_property_value(sg_host_t host, const char* name, const char* value);
149 XBT_PUBLIC void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links);
150 XBT_PUBLIC double sg_host_route_latency(sg_host_t from, sg_host_t to);
151 XBT_PUBLIC double sg_host_route_bandwidth(sg_host_t from, sg_host_t to);
152 XBT_PUBLIC void sg_host_dump(sg_host_t ws);
154 XBT_PUBLIC void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto);
157 #endif /* SIMGRID_HOST_H_ */