include/msg/datatypes.h

   1 /* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef MSG_DATATYPE_H
   7 #define MSG_DATATYPE_H
   8 #include "xbt/misc.h"
   9 #include "xbt/file_stat.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 s_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
  55 #ifdef MSG_USE_DEPRECATED
  56   msg_mailbox_t *mailboxes;     /**< the channels  */
  57 #endif
  58 } s_msg_host_priv_t, *msg_host_priv_t;
  59
  60 static inline msg_host_priv_t MSG_host_priv(msg_host_t host){
  61   return (msg_host_priv_t )xbt_lib_get_level(host, MSG_HOST_LEVEL);
  62 }
  63
  64
  65
  66 /* ******************************** Task ************************************ */
  67
  68 typedef struct simdata_task *simdata_task_t;
  69
  70 typedef struct msg_task {
  71   char *name;                   /**< @brief task name if any */
  72   simdata_task_t simdata;       /**< @brief simulator data */
  73   void *data;                   /**< @brief user data */
  74 #ifdef HAVE_TRACING
  75   long long int counter;        /* task unique identifier for instrumentation */
  76   char *category;               /* task category for instrumentation */
  77 #endif
  78 } s_msg_task_t;
  79
  80 /** @brief Task datatype.
  81     @ingroup m_task_management
  82
  83     A <em>task</em> may then be defined by a <em>computing
  84     amount</em>, a <em>message size</em> and some <em>private
  85     data</em>.
  86  */
  87 typedef struct msg_task *msg_task_t;
  88
  89 /* ******************************** VM ************************************* */
  90 typedef msg_host_t msg_vm_t;
  91 typedef msg_host_priv_t msg_vm_priv_t;
  92
  93 static inline msg_vm_priv_t MSG_vm_priv(msg_vm_t vm){
  94   return xbt_lib_get_level(vm, MSG_HOST_LEVEL);
  95 }
  96
  97 /* ******************************** File ************************************ */
  98 typedef struct simdata_file *simdata_file_t;
  99
 100 typedef struct msg_file {
 101   char *name;                   /**< @brief file name */
 102   simdata_file_t simdata;                /**< @brief simulator data  */
 103   void *data;                   /**< @brief user data */
 104 } s_msg_file_t;
 105
 106 /** @brief File datatype.
 107     @ingroup msg_file_management
 108
 109     You should consider this as an opaque object.
 110  */
 111 typedef struct msg_file *msg_file_t;
 112
 113
 114 /** @brief File datatype.
 115     @ingroup msg_file_management
 116
 117     You should consider this as an opaque object.
 118  */
 119 typedef s_file_stat_t s_msg_stat_t, *msg_stat_t;
 120
 121
 122 /*************** Begin GPU ***************/
 123 typedef struct simdata_gpu_task *simdata_gpu_task_t;
 124
 125 typedef struct msg_gpu_task {
 126   char *name;                   /**< @brief task name if any */
 127   simdata_gpu_task_t simdata;       /**< @brief simulator data */
 128 #ifdef HAVE_TRACING
 129   long long int counter;        /* task unique identifier for instrumentation */
 130   char *category;               /* task category for instrumentation */
 131 #endif
 132 } s_msg_gpu_task_t;
 133
 134 /** @brief GPU task datatype.
 135     @ingroup m_task_management
 136
 137     A <em>task</em> may then be defined by a <em>computing
 138     amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
 139     \see m_task_management
 140 */
 141 typedef struct msg_gpu_task *msg_gpu_task_t;
 142 /*************** End GPU ***************/
 143
 144 /**
 145  * \brief @brief Communication action.
 146  * \ingroup msg_task_usage
 147  *
 148  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
 149  */
 150 typedef struct msg_comm *msg_comm_t;
 151
 152 /** \brief Default value for an uninitialized #msg_task_t.
 153     \ingroup m_task_management
 154 */
 155 #define MSG_TASK_UNINITIALIZED NULL
 156
 157 /* ****************************** Process *********************************** */
 158
 159 /** @brief Process datatype.
 160     @ingroup m_process_management
 161
 162     A process may be defined as a <em>code</em>, with some
 163     <em>private data</em>, executing in a <em>location</em>.
 164
 165     You should not access directly to the fields of the pointed
 166     structure, but always use the provided API to interact with
 167     processes.
 168  */
 169 typedef struct s_smx_process *msg_process_t;
 170
 171 #ifdef MSG_USE_DEPRECATED
 172
 173 /* Compatibility typedefs */
 174 typedef int                     m_channel_t;
 175 typedef msg_gpu_task_t          m_gpu_task_t;
 176 typedef msg_host_t              m_host_t;
 177 typedef msg_process_t           m_process_t;
 178 typedef msg_task_t              m_task_t;
 179 typedef s_msg_gpu_task_t        s_m_gpu_task_t;
 180 typedef s_msg_host_t            s_m_host_t;
 181 typedef s_msg_task_t            s_m_task_t;
 182 #endif
 183
 184 SG_END_DECL()
 185 #endif