Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix doxygen warnings.
[simgrid.git] / include / msg / datatypes.h
index 79fc90a..d898c4d 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004, 2005, 2007, 2008, 2009, 2010. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -7,7 +7,7 @@
 #ifndef MSG_DATATYPE_H
 #define MSG_DATATYPE_H
 #include "xbt/misc.h"
-#include "xbt/file_stat.h"
+#include "xbt/lib.h"
 #include "simgrid/simix.h"
 #include "simgrid_config.h"     // for HAVE_TRACING
 
@@ -27,17 +27,14 @@ SG_BEGIN_DECL()
  * 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 ************************************ */
 
-typedef struct m_host {
-  smx_host_t smx_host;          /**< SIMIX representation of this host   */
-#ifdef MSG_USE_DEPRECATED
-  msg_mailbox_t *mailboxes;     /**< the channels  */
-#endif
-} s_m_host_t;
+extern int MSG_HOST_LEVEL;
 
-/** @brief Host datatype  
+/** @brief Host datatype.
     @ingroup m_host_management
 
     A <em>location</em> (or <em>host</em>) is any possible place where
@@ -47,13 +44,32 @@ typedef struct m_host {
     some <em>private data</em> that can be only accessed by local
     process.
  */
-typedef struct m_host *m_host_t;
+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;
+
+  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 m_task {
+typedef struct msg_task {
   char *name;                   /**< @brief task name if any */
   simdata_task_t simdata;       /**< @brief simulator data */
   void *data;                   /**< @brief user data */
@@ -61,57 +77,95 @@ typedef struct m_task {
   long long int counter;        /* task unique identifier for instrumentation */
   char *category;               /* task category for instrumentation */
 #endif
-} s_m_task_t;
+} s_msg_task_t;
 
-/** @brief Task datatype  
+/** @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 m_task *m_task_t;
+typedef struct msg_task *msg_task_t;
 
+/* ******************************** VM ************************************* */
+typedef msg_host_t msg_vm_t;
+typedef msg_host_priv_t msg_vm_priv_t;
 
-/* ******************************** File ************************************ */
-typedef struct simdata_file *simdata_file_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);
+}
 
-typedef struct msg_file {
-  char *name;                   /**< @brief file name */
-  simdata_file_t simdata;                /**< @brief simulator data  */
-  void *data;                   /**< @brief user data */
-} s_msg_file_t;
+/** ******************************** File ************************************ */
 
 /** @brief File datatype.
-    @ingroup msg_file_management 
-    You should consider this as an opaque object.
+*  @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  {
+  const char *fullname;
+  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 struct msg_file *msg_file_t;
+typedef xbt_dictelm_t msg_storage_t;
+typedef s_xbt_dictelm_t s_msg_storage_t;
 
-typedef s_file_stat_t s_msg_stat_t, *msg_stat_t;
+typedef struct msg_storage_priv  {
+  // TODO PV: fill it (or not) !
+  void * dummy;
+} 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 m_gpu_task {
+typedef struct msg_gpu_task {
   char *name;                   /**< @brief task name if any */
   simdata_gpu_task_t simdata;       /**< @brief simulator data */
 #ifdef HAVE_TRACING
   long long int counter;        /* task unique identifier for instrumentation */
   char *category;               /* task category for instrumentation */
 #endif
-} s_m_gpu_task_t;
+} s_msg_gpu_task_t;
 
-/** @brief GPU task datatype
+/** @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 m_gpu_task *m_gpu_task_t;
+typedef struct msg_gpu_task *msg_gpu_task_t;
 /*************** End GPU ***************/
 
 /**
@@ -122,7 +176,7 @@ typedef struct m_gpu_task *m_gpu_task_t;
  */
 typedef struct msg_comm *msg_comm_t;
 
-/** \brief Default value for an uninitialized #m_task_t.
+/** \brief Default value for an uninitialized #msg_task_t.
     \ingroup m_task_management 
 */
 #define MSG_TASK_UNINITIALIZED NULL
@@ -139,13 +193,20 @@ typedef struct msg_comm *msg_comm_t;
     structure, but always use the provided API to interact with
     processes.
  */
-typedef struct s_smx_process *m_process_t;
+typedef struct s_smx_process *msg_process_t;
 
 #ifdef MSG_USE_DEPRECATED
-typedef int m_channel_t;
-#endif
-
 
+/* 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
 
 SG_END_DECL()
 #endif