include/msg/datatypes.h

   1 /* Copyright (c) 2004-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef MSG_DATATYPE_H
   8 #define MSG_DATATYPE_H
   9 #include "xbt/misc.h"
  10 #include "xbt/lib.h"
  11 #include "simgrid/simix.h"
  12 #include "simgrid_config.h"     // for HAVE_TRACING
  13
  14 SG_BEGIN_DECL()
  15
  16 /* ******************************** Mailbox ************************************ */
  17
  18 /** @brief Mailbox datatype
  19  *  @ingroup msg_task_usage
  20  *
  21  * Object representing a communication rendez-vous point, on which
  22  * the sender finds the receiver it wants to communicate with. As a
  23  * MSG user, you will only rarely manipulate any of these objects
  24  * directly, since most of the public interface (such as
  25  * #MSG_task_send and friends) hide this object behind a string
  26  * alias. That mean that you don't provide the mailbox on which you
  27  * want to send your task, but only the name of this mailbox. */
  28 typedef struct s_smx_rvpoint *msg_mailbox_t;
  29
  30 /* ******************************** Environment ************************************ */
  31 typedef struct As *msg_as_t;
  32
  33 /* ******************************** Host ************************************ */
  34
  35 extern int MSG_HOST_LEVEL;
  36
  37 /** @brief Host datatype.
  38     @ingroup m_host_management
  39
  40     A <em>location</em> (or <em>host</em>) is any possible place where
  41     a process may run. Thus it is represented as a <em>physical
  42     resource with computing capabilities</em>, some <em>mailboxes</em>
  43     to enable running process to communicate with remote ones, and
  44     some <em>private data</em> that can be only accessed by local
  45     process.
  46  */
  47 typedef xbt_dictelm_t msg_host_t;
  48 typedef s_xbt_dictelm_t s_msg_host_t;
  49
  50 typedef struct msg_host_priv {
  51   int        dp_enabled;
  52   xbt_dict_t dp_objs;
  53   double     dp_updated_by_deleted_tasks;
  54   int        is_migrating;
  55
  56   xbt_dict_t affinity_mask_db;
  57
  58 #ifdef MSG_USE_DEPRECATED
  59   msg_mailbox_t *mailboxes;     /**< the channels  */
  60 #endif
  61 } s_msg_host_priv_t, *msg_host_priv_t;
  62
  63 static inline msg_host_priv_t MSG_host_priv(msg_host_t host){
  64   return (msg_host_priv_t )xbt_lib_get_level(host, MSG_HOST_LEVEL);
  65 }
  66
  67
  68
  69 /* ******************************** Task ************************************ */
  70
  71 typedef struct simdata_task *simdata_task_t;
  72
  73 typedef struct msg_task {
  74   char *name;                   /**< @brief task name if any */
  75   simdata_task_t simdata;       /**< @brief simulator data */
  76   void *data;                   /**< @brief user data */
  77 #ifdef HAVE_TRACING
  78   long long int counter;        /* task unique identifier for instrumentation */
  79   char *category;               /* task category for instrumentation */
  80 #endif
  81 } s_msg_task_t;
  82
  83 /** @brief Task datatype.
  84     @ingroup m_task_management
  85
  86     A <em>task</em> may then be defined by a <em>computing
  87     amount</em>, a <em>message size</em> and some <em>private
  88     data</em>.
  89  */
  90 typedef struct msg_task *msg_task_t;
  91
  92 /* ******************************** VM ************************************* */
  93 typedef msg_host_t msg_vm_t;
  94 typedef msg_host_priv_t msg_vm_priv_t;
  95
  96 static inline msg_vm_priv_t MSG_vm_priv(msg_vm_t vm){
  97   return (msg_vm_priv_t) xbt_lib_get_level(vm, MSG_HOST_LEVEL);
  98 }
  99
 100 /** ******************************** File ************************************ */
 101
 102 /** @brief File datatype.
 103 *  @ingroup msg_file_management
 104 *
 105 *  You should consider this as an opaque object.
 106 */
 107 typedef xbt_dictelm_t msg_file_t;
 108 typedef s_xbt_dictelm_t s_msg_file_t;
 109
 110 extern int MSG_FILE_LEVEL;
 111 typedef struct simdata_file *simdata_file_t;
 112
 113 typedef struct msg_file_priv  {
 114   char *fullpath;
 115   sg_size_t size;
 116   char* mount_point;
 117   char* storageId;
 118   char* storage_type;
 119   char* content_type;
 120   void *data;
 121   simdata_file_t simdata;
 122 } s_msg_file_priv_t, *msg_file_priv_t;
 123
 124 static inline msg_file_priv_t MSG_file_priv(msg_file_t file){
 125   return (msg_file_priv_t )xbt_lib_get_level(file, MSG_FILE_LEVEL);
 126 }
 127
 128 /* ******************************** Storage ************************************ */
 129 /* TODO: PV: to comment */
 130
 131 extern int MSG_STORAGE_LEVEL;
 132
 133 /** @brief Storage datatype.
 134  *  @ingroup msg_storage_management
 135  *
 136  *  You should consider this as an opaque object.
 137  */
 138 typedef xbt_dictelm_t msg_storage_t;
 139 typedef s_xbt_dictelm_t s_msg_storage_t;
 140
 141 typedef struct msg_storage_priv  {
 142   const char *hostname;
 143   void *data;
 144 } s_msg_storage_priv_t, *msg_storage_priv_t;
 145
 146 static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){
 147   return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL);
 148 }
 149
 150 /*************** Begin GPU ***************/
 151 typedef struct simdata_gpu_task *simdata_gpu_task_t;
 152
 153 typedef struct msg_gpu_task {
 154   char *name;                   /**< @brief task name if any */
 155   simdata_gpu_task_t simdata;       /**< @brief simulator data */
 156 #ifdef HAVE_TRACING
 157   long long int counter;        /* task unique identifier for instrumentation */
 158   char *category;               /* task category for instrumentation */
 159 #endif
 160 } s_msg_gpu_task_t;
 161
 162 /** @brief GPU task datatype.
 163     @ingroup m_task_management
 164
 165     A <em>task</em> may then be defined by a <em>computing
 166     amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
 167     \see m_task_management
 168 */
 169 typedef struct msg_gpu_task *msg_gpu_task_t;
 170 /*************** End GPU ***************/
 171
 172 /**
 173  * \brief @brief Communication action.
 174  * \ingroup msg_task_usage
 175  *
 176  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
 177  */
 178 typedef struct msg_comm *msg_comm_t;
 179
 180 /** \brief Default value for an uninitialized #msg_task_t.
 181     \ingroup m_task_management
 182 */
 183 #define MSG_TASK_UNINITIALIZED NULL
 184
 185 /* ****************************** Process *********************************** */
 186
 187 /** @brief Process datatype.
 188     @ingroup m_process_management
 189
 190     A process may be defined as a <em>code</em>, with some
 191     <em>private data</em>, executing in a <em>location</em>.
 192
 193     You should not access directly to the fields of the pointed
 194     structure, but always use the provided API to interact with
 195     processes.
 196  */
 197 typedef struct s_smx_process *msg_process_t;
 198
 199 #ifdef MSG_USE_DEPRECATED
 200
 201 /* Compatibility typedefs */
 202 typedef int                     m_channel_t;
 203 typedef msg_gpu_task_t          m_gpu_task_t;
 204 typedef msg_host_t              m_host_t;
 205 typedef msg_process_t           m_process_t;
 206 typedef msg_task_t              m_task_t;
 207 typedef s_msg_gpu_task_t        s_m_gpu_task_t;
 208 typedef s_msg_host_t            s_m_host_t;
 209 typedef s_msg_task_t            s_m_task_t;
 210 #endif
 211
 212 SG_END_DECL()
 213 #endif