1 /* Copyright (c) 2013-2020. 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 /** Returns an array of all existing hosts (use sg_host_count() to know the array size).
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
20 XBT_PUBLIC sg_host_t* sg_host_list();
22 /** Returns the amount of hosts existing in the platform. */
23 XBT_PUBLIC size_t sg_host_count();
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)
30 XBT_PUBLIC xbt_dynar_t sg_hosts_as_dynar();
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);
35 /** Finds an host from its name */
36 XBT_PUBLIC sg_host_t sg_host_by_name(const char* name);
38 /** @brief Return the name of the sg_host_t. */
39 XBT_PUBLIC const char* sg_host_get_name(const_sg_host_t host);
42 // ========== User Data ==============
43 /** @brief Return the user data of a #sg_host_t.
45 * This functions returns the user data associated to @a host if any.
47 XBT_PUBLIC void* sg_host_data(const_sg_host_t host);
48 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data()") XBT_PUBLIC void* sg_host_user(sg_host_t host);
49 /** @brief Set the user data of a #sg_host_t.
51 * This functions attach @a data to @a host.
53 XBT_PUBLIC void sg_host_data_set(sg_host_t host, void* userdata);
54 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set()") XBT_PUBLIC
55 void sg_host_user_set(sg_host_t host, void* userdata);
56 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set(h, NULL)") XBT_PUBLIC void sg_host_user_destroy(sg_host_t host);
59 // ========= storage related functions ============
60 /** @brief Return the list of mount point names on an host.
62 * @return a dict containing all mount point on the host (mount_name => sg_storage_t)
64 XBT_PUBLIC xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host);
66 /** @brief Return the list of storages attached to an host.
68 * @return a dynar containing all storages (name) attached to the host
70 XBT_PUBLIC xbt_dynar_t sg_host_get_attached_storage_list(const_sg_host_t host);
71 XBT_PUBLIC void sg_host_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks);
73 // =========== user-level functions ===============
74 /** @brief Return the speed of the processor (in flop/s), regardless of the current load on the machine. */
75 XBT_PUBLIC double sg_host_speed(const_sg_host_t host);
76 XBT_PUBLIC double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index);
78 XBT_PUBLIC double sg_host_get_available_speed(const_sg_host_t host);
80 XBT_PUBLIC int sg_host_core_count(const_sg_host_t host);
82 /** @brief Returns the current computation load (in flops per second).
85 XBT_PUBLIC double sg_host_load(const_sg_host_t host);
87 /** @brief Return the location on which the current process is running. */
88 XBT_PUBLIC sg_host_t sg_host_self();
90 XBT_PUBLIC const char* sg_host_self_get_name();
92 /** @brief Return the total count of pstates defined for a host.
95 * See also :ref:`plugin_host_energy`.
98 * @param host host to test
100 XBT_PUBLIC int sg_host_get_nb_pstates(const_sg_host_t host);
102 XBT_PUBLIC int sg_host_get_pstate(const_sg_host_t host);
103 XBT_PUBLIC void sg_host_set_pstate(sg_host_t host, int pstate);
105 XBT_PUBLIC void sg_host_turn_on(sg_host_t host);
106 XBT_PUBLIC void sg_host_turn_off(sg_host_t host);
107 XBT_PUBLIC int sg_host_is_on(const_sg_host_t host);
109 /** @ingroup m_host_management
110 * @brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
113 * @return a dict containing the properties
115 XBT_PUBLIC xbt_dict_t sg_host_get_properties(const_sg_host_t host);
117 /** @ingroup m_host_management
118 * @brief Returns the value of a given host property
121 * @param name a property name
122 * @return value of a property (or nullptr if property not set)
124 XBT_PUBLIC const char* sg_host_get_property_value(const_sg_host_t host, const char* name);
126 /** @ingroup m_host_management
127 * @brief Change the value of a given host property
130 * @param name a property name
131 * @param value what to change the property to
133 XBT_PUBLIC void sg_host_set_property_value(sg_host_t host, const char* name, const char* value);
135 XBT_PUBLIC void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links);
136 XBT_PUBLIC double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to);
137 XBT_PUBLIC double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to);
138 XBT_PUBLIC void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount);
141 XBT_ATTRIB_DEPRECATED_v330("Please use sg_host_sendto") inline void sg_host_send_to(sg_host_t from, sg_host_t to,
144 sg_host_sendto(from, to, byte_amount);
148 XBT_PUBLIC void sg_host_dump(const_sg_host_t ws);
150 XBT_PUBLIC void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto);
153 #endif /* SIMGRID_HOST_H_ */