Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Making MSG fade away (part 1)
[simgrid.git] / include / simgrid / host.h
index 3c869c3..8e76b05 100644 (file)
 
 SG_BEGIN_DECL()
 
-XBT_PUBLIC(size_t) sg_host_count();
 XBT_PUBLIC(sg_host_t *) sg_host_list();
 
+/** \ingroup m_host_management
+ * \brief Return the current number MSG hosts.
+ */
+XBT_PUBLIC(size_t) sg_host_count();
+#define MSG_get_host_number() sg_host_count()
+
+/** \ingroup m_host_management
+ * \brief Return a dynar containing all the hosts declared at a given point of time (including VMs)
+ * \remark The host order in the returned array is generally different from the host creation/declaration order in the
+ *         XML platform (we use a hash table internally)
+ */
+XBT_PUBLIC(xbt_dynar_t) sg_hosts_as_dynar();
+#define MSG_hosts_as_dynar() sg_hosts_as_dynar()
+
 XBT_PUBLIC(size_t) sg_host_extension_create(void(*deleter)(void*));
 XBT_PUBLIC(void*) sg_host_extension_get(sg_host_t host, size_t rank);
+
+/** \ingroup m_host_management
+ * \brief Finds a msg_host_t using its name.
+ *
+ * This is a name directory service
+ * \param name the name of an host.
+ * \return the corresponding host
+ */
 XBT_PUBLIC(sg_host_t) sg_host_by_name(const char *name);
+#define MSG_host_by_name(name) sg_host_by_name(name)
+#define MSG_get_host_by_name(n) sg_host_by_name(n) /* Rewrite the old name into the new one transparently */
+
 XBT_PUBLIC(const char*) sg_host_get_name(sg_host_t host);
-XBT_PUBLIC(xbt_dynar_t) sg_hosts_as_dynar();
 
 // ========== User Data ==============
 XBT_PUBLIC(void*) sg_host_user(sg_host_t host);
@@ -31,20 +54,82 @@ XBT_PUBLIC(void) sg_host_user_set(sg_host_t host, void* userdata);
 XBT_PUBLIC(void) sg_host_user_destroy(sg_host_t host);
 
 // ========= storage related functions ============
+/** \ingroup m_host_management
+ * \brief Return the list of mount point names on an host.
+ * \param host a host
+ * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
+ */
 XBT_PUBLIC(xbt_dict_t) sg_host_get_mounted_storage_list(sg_host_t host);
+#define MSG_host_get_mounted_storage_list(host) sg_host_get_mounted_storage_list(host)
+
+/** \ingroup m_host_management
+ * \brief Return the list of storages attached to an host.
+ * \param host a host
+ * \return a dynar containing all storages (name) attached to the host
+ */
 XBT_PUBLIC(xbt_dynar_t) sg_host_get_attached_storage_list(sg_host_t host);
+#define MSG_host_get_attached_storage_list(host) host_get_attached_storage_list(host)
+
 // =========== user-level functions ===============
+/** \ingroup m_host_management
+ * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
+ */
 XBT_PUBLIC(double) sg_host_speed(sg_host_t host);
+#define MSG_host_get_speed(host) sg_host_speed(host)
 XBT_PUBLIC(double) sg_host_get_available_speed(sg_host_t host);
 
+/** \ingroup m_process_management
+ * \brief Return the location on which a process is running.
+ * \param process a process (nullptr means the current one)
+ * \return the msg_host_t corresponding to the location on which \a process is running.
+ */
 XBT_PUBLIC(sg_host_t) sg_host_self();
+#define MSG_host_self() sg_host_self()
+
 XBT_PUBLIC(const char*) sg_host_self_get_name();
+
+/** \ingroup m_host_management
+ * \brief Return the total count of pstates defined for a host. See also @ref plugin_energy.
+ *
+ * \param  host host to test
+ */
 XBT_PUBLIC(int) sg_host_get_nb_pstates(sg_host_t host);
+#define MSG_host_get_nb_pstates(host) sg_host_get_nb_pstates(host)
+
 XBT_PUBLIC(int) sg_host_get_pstate(sg_host_t host);
+#define MSG_host_get_pstate(h) sg_host_get_pstate(h) /* users don't know that MSG is the C version of SimGrid */
 XBT_PUBLIC(void) sg_host_set_pstate(sg_host_t host,int pstate);
+#define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate) /* (same here) */
+
+/** \ingroup m_host_management
+ * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
+ *
+ * \param host a host
+ * \return a dict containing the properties
+ */
 XBT_PUBLIC(xbt_dict_t) sg_host_get_properties(sg_host_t host);
+#define MSG_host_get_properties(host) sg_host_get_properties(host)
+
+/** \ingroup m_host_management
+ * \brief Returns the value of a given host property
+ *
+ * \param host a host
+ * \param name a property name
+ * \return value of a property (or nullptr if property not set)
+ */
 XBT_PUBLIC(const char*) sg_host_get_property_value(sg_host_t host, const char* name);
+#define MSG_host_get_property_value(host, name) sg_host_get_property_value(host, name)
+
+/** \ingroup m_host_management
+ * \brief Change the value of a given host property
+ *
+ * \param host a host
+ * \param name a property name
+ * \param value what to change the property to
+ */
 XBT_PUBLIC(void) sg_host_set_property_value(sg_host_t host, const char* name, const char* value);
+#define MSG_host_set_property_value(host, name, value) sg_host_set_property_value(host, name, value)
+
 XBT_PUBLIC(void) sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links);
 XBT_PUBLIC(double) sg_host_route_latency(sg_host_t from, sg_host_t to);
 XBT_PUBLIC(double) sg_host_route_bandwidth(sg_host_t from, sg_host_t to);