Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
mv msg/msg.h simgrid/msg.h
[simgrid.git] / include / simgrid / msg.h
similarity index 80%
rename from include/msg/msg.h
rename to include/simgrid/msg.h
index 77881dc..264a16e 100644 (file)
 #define MSG_H
 
 #include "xbt.h"
-
-#include "msg/datatypes.h"
-
+#include "xbt/lib.h"
 #include "simgrid/simix.h"
-
 #include "simgrid/platf.h"
 
 SG_BEGIN_DECL()
 
+/* ******************************** Mailbox ************************************ */
+
+/** @brief Mailbox datatype
+ *  @ingroup msg_task_usage
+ *
+ * Object representing a communication rendez-vous point, on which
+ * the sender finds the receiver it wants to communicate with. As a
+ * MSG user, you will only rarely manipulate any of these objects
+ * directly, since most of the public interface (such as
+ * #MSG_task_send and friends) hide this object behind a string
+ * alias. That mean that you don't provide the mailbox on which you
+ * want to send your task, but only the name of this mailbox. */
+typedef struct s_smx_rvpoint *msg_mailbox_t;
+
+/* ******************************** Environment ************************************ */
+typedef struct As *msg_as_t;
+
+/* ******************************** Host ************************************ */
+
+extern int MSG_HOST_LEVEL;
+
+/** @brief Host datatype.
+    @ingroup m_host_management
+
+    A <em>location</em> (or <em>host</em>) is any possible place where
+    a process may run. Thus it is represented as a <em>physical
+    resource with computing capabilities</em>, some <em>mailboxes</em>
+    to enable running process to communicate with remote ones, and
+    some <em>private data</em> that can be only accessed by local
+    process.
+ */
+typedef xbt_dictelm_t msg_host_t;
+typedef s_xbt_dictelm_t s_msg_host_t;
+
+typedef struct msg_host_priv {
+  int        dp_enabled;
+  xbt_dict_t dp_objs;
+  double     dp_updated_by_deleted_tasks;
+  int        is_migrating;
+
+  xbt_dict_t affinity_mask_db;
+
+#ifdef MSG_USE_DEPRECATED
+  msg_mailbox_t *mailboxes;     /**< the channels  */
+#endif
+} s_msg_host_priv_t, *msg_host_priv_t;
+
+static inline msg_host_priv_t MSG_host_priv(msg_host_t host){
+  return (msg_host_priv_t )xbt_lib_get_level(host, MSG_HOST_LEVEL);
+}
+
+
+
+/* ******************************** Task ************************************ */
+
+typedef struct simdata_task *simdata_task_t;
+
+typedef struct msg_task {
+  char *name;                   /**< @brief task name if any */
+  simdata_task_t simdata;       /**< @brief simulator data */
+  void *data;                   /**< @brief user data */
+  long long int counter;        /* task unique identifier for instrumentation */
+  char *category;               /* task category for instrumentation */
+} s_msg_task_t;
+
+/** @brief Task datatype.
+    @ingroup m_task_management
+
+    A <em>task</em> may then be defined by a <em>computing
+    amount</em>, a <em>message size</em> and some <em>private
+    data</em>.
+ */
+typedef struct msg_task *msg_task_t;
+
+/* ******************************** VM ************************************* */
+typedef msg_host_t msg_vm_t;
+typedef msg_host_priv_t msg_vm_priv_t;
+
+static inline msg_vm_priv_t MSG_vm_priv(msg_vm_t vm){
+  return (msg_vm_priv_t) xbt_lib_get_level(vm, MSG_HOST_LEVEL);
+}
+
+/** ******************************** File ************************************ */
+
+/** @brief File datatype.
+*  @ingroup msg_file_management
+*
+*  You should consider this as an opaque object.
+*/
+typedef xbt_dictelm_t msg_file_t;
+typedef s_xbt_dictelm_t s_msg_file_t;
+
+extern int MSG_FILE_LEVEL;
+typedef struct simdata_file *simdata_file_t;
+
+typedef struct msg_file_priv  {
+  char *fullpath;
+  sg_size_t size;
+  char* mount_point;
+  char* storageId;
+  char* storage_type;
+  char* content_type;
+  void *data;
+  simdata_file_t simdata;
+} s_msg_file_priv_t, *msg_file_priv_t;
+
+static inline msg_file_priv_t MSG_file_priv(msg_file_t file){
+  return (msg_file_priv_t )xbt_lib_get_level(file, MSG_FILE_LEVEL);
+}
+
+/* ******************************** Storage ************************************ */
+/* TODO: PV: to comment */
+
+extern int MSG_STORAGE_LEVEL;
+
+/** @brief Storage datatype.
+ *  @ingroup msg_storage_management
+ *
+ *  You should consider this as an opaque object.
+ */
+typedef xbt_dictelm_t msg_storage_t;
+typedef s_xbt_dictelm_t s_msg_storage_t;
+
+typedef struct msg_storage_priv  {
+  const char *hostname;
+  void *data;
+} s_msg_storage_priv_t, *msg_storage_priv_t;
+
+static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){
+  return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL);
+}
+
+/*************** Begin GPU ***************/
+typedef struct simdata_gpu_task *simdata_gpu_task_t;
+
+typedef struct msg_gpu_task {
+  char *name;                   /**< @brief task name if any */
+  simdata_gpu_task_t simdata;       /**< @brief simulator data */
+  long long int counter;        /* task unique identifier for instrumentation */
+  char *category;               /* task category for instrumentation */
+} s_msg_gpu_task_t;
+
+/** @brief GPU task datatype.
+    @ingroup m_task_management
+
+    A <em>task</em> may then be defined by a <em>computing
+    amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
+    \see m_task_management
+*/
+typedef struct msg_gpu_task *msg_gpu_task_t;
+/*************** End GPU ***************/
+
+/**
+ * \brief @brief Communication action.
+ * \ingroup msg_task_usage
+ *
+ * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
+ */
+typedef struct msg_comm *msg_comm_t;
+
+/** \brief Default value for an uninitialized #msg_task_t.
+    \ingroup m_task_management
+*/
+#define MSG_TASK_UNINITIALIZED NULL
+
+/* ****************************** Process *********************************** */
+
+/** @brief Process datatype.
+    @ingroup m_process_management
+
+    A process may be defined as a <em>code</em>, with some
+    <em>private data</em>, executing in a <em>location</em>.
+
+    You should not access directly to the fields of the pointed
+    structure, but always use the provided API to interact with
+    processes.
+ */
+typedef struct s_smx_process *msg_process_t;
+
+#ifdef MSG_USE_DEPRECATED
+
+/* Compatibility typedefs */
+typedef int                     m_channel_t;
+typedef msg_gpu_task_t          m_gpu_task_t;
+typedef msg_host_t              m_host_t;
+typedef msg_process_t           m_process_t;
+typedef msg_task_t              m_task_t;
+typedef s_msg_gpu_task_t        s_m_gpu_task_t;
+typedef s_msg_host_t            s_m_host_t;
+typedef s_msg_task_t            s_m_task_t;
+#endif
+
 /** @brief Return code of most MSG functions
     @ingroup msg_simulation
     @{ */