-/* Copyright (c) 2013-2015. The SimGrid Team.
+/* Copyright (c) 2013-2016. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
#ifndef SIMGRID_HOST_H_
#define SIMGRID_HOST_H_
+#include <stddef.h>
+
#include <xbt/dict.h>
#include <xbt/dynar.h>
+
+#include <simgrid/forward.h>
+
SG_BEGIN_DECL()
-typedef xbt_dictelm_t sg_host_t;
+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);
-XBT_PUBLIC(sg_host_t) sg_host_by_name_or_create(const char *name);
-static XBT_INLINE char *sg_host_get_name(sg_host_t host){
- return host->key;
-}
-XBT_PUBLIC(xbt_dynar_t) sg_hosts_as_dynar(void);
-
-#ifdef __cplusplus
-#define DEFINE_EXTERNAL_CLASS(klass) class klass;
-class Cpu;
-#else
-#define DEFINE_EXTERNAL_CLASS(klass) typedef struct klass klass;
-#endif
+#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 */
+
+/** \ingroup m_host_management
+ *
+ * \brief Return the name of the #msg_host_t. */
+XBT_PUBLIC(const char*) sg_host_get_name(sg_host_t host);
+#define MSG_host_get_name(host) sg_host_get_name(host)
+
// ========== User Data ==============
+/** \ingroup m_host_management
+ *
+ * \brief Return the user data of a #msg_host_t.
+ *
+ * This functions returns the user data associated to \a host if it is possible.
+ */
XBT_PUBLIC(void*) sg_host_user(sg_host_t host);
+#define MSG_host_get_data(host) sg_host_user(host)
+/** \ingroup m_host_management
+ *
+ * \brief Set the user data of a #msg_host_t.
+ *
+ * This functions attach \a data to \a host if it is possible.
+ */
XBT_PUBLIC(void) sg_host_user_set(sg_host_t host, void* userdata);
+#define MSG_host_set_data(host, data) sg_host_user_set(host, data)
XBT_PUBLIC(void) sg_host_user_destroy(sg_host_t host);
-// ========== MSG Layer ==============
-typedef struct s_msg_host_priv *msg_host_priv_t;
-msg_host_priv_t sg_host_msg(sg_host_t host);
-XBT_PUBLIC(void) sg_host_msg_set(sg_host_t host, msg_host_priv_t priv);
-XBT_PUBLIC(void) sg_host_msg_destroy(sg_host_t host);
-
-// ========== SD Layer ==============
-typedef struct SD_workstation *SD_workstation_priv_t;
-SD_workstation_priv_t sg_host_sd(sg_host_t host);
-XBT_PUBLIC(void) sg_host_sd_set(sg_host_t host, SD_workstation_priv_t priv);
-XBT_PUBLIC(void) sg_host_sd_destroy(sg_host_t host);
-
-// ========== Simix layer =============
-typedef struct s_smx_host_priv *smx_host_priv_t;
-XBT_PUBLIC(smx_host_priv_t) sg_host_simix(sg_host_t host);
-XBT_PUBLIC(void) sg_host_simix_set(sg_host_t host, smx_host_priv_t priv);
-XBT_PUBLIC(void) sg_host_simix_destroy(sg_host_t host);
-
-// ========== SURF CPU ============
-DEFINE_EXTERNAL_CLASS(Cpu);
-typedef Cpu *surf_cpu_t;
-XBT_PUBLIC(surf_cpu_t) sg_host_surfcpu(sg_host_t host);
-XBT_PUBLIC(void) sg_host_surfcpu_set(sg_host_t host, surf_cpu_t cpu);
-XBT_PUBLIC(void) sg_host_surfcpu_register(sg_host_t host, surf_cpu_t cpu);
-XBT_PUBLIC(void) sg_host_surfcpu_destroy(sg_host_t host);
-
-// ========== RoutingEdge ============
-DEFINE_EXTERNAL_CLASS(RoutingEdge);
-XBT_PUBLIC(RoutingEdge*) sg_host_edge(sg_host_t host);
-XBT_PUBLIC(void) sg_host_edge_set(sg_host_t host, RoutingEdge* edge);
-XBT_PUBLIC(void) sg_host_edge_destroy(sg_host_t host, int do_callback);
-
-
-// Module initializer. Won't survive the conversion to C++. Hopefully.
-XBT_PUBLIC(void) sg_host_init(void);
+// ========= 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 ===============
-XBT_PUBLIC(double) sg_host_get_speed(sg_host_t host);
+/** \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);
-XBT_PUBLIC(int) sg_host_get_core(sg_host_t host);
-XBT_PUBLIC(int) sg_host_get_state(sg_host_t host);
-XBT_PUBLIC(int) sg_host_get_nb_pstates(sg_host_t host);
-XBT_PUBLIC(int) sg_host_get_pstate(sg_host_t host);
-XBT_PUBLIC(double) sg_host_get_consumed_energy(sg_host_t host);
+XBT_PUBLIC(int) sg_host_core_count(sg_host_t host);
+#define MSG_host_get_core_number(host) sg_host_core_count(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) */
+
+XBT_PUBLIC(void) sg_host_turn_on(sg_host_t host);
+#define MSG_host_on(h) sg_host_turn_on(h)
+XBT_PUBLIC(void) sg_host_turn_off(sg_host_t host);
+#define MSG_host_off(h) sg_host_turn_off(h)
+XBT_PUBLIC(int) sg_host_is_on(sg_host_t host);
+#define MSG_host_is_on(h) sg_host_is_on(h)
+XBT_PUBLIC(int) sg_host_is_off(sg_host_t host);
+#define MSG_host_is_off(h) sg_host_is_off(h)
+
+/** \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);
+XBT_PUBLIC(void) sg_host_dump(sg_host_t ws);
SG_END_DECL()
#endif /* SIMGRID_HOST_H_ */
