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
  31 /* ******************************** Host ************************************ */
  32
  33 extern int MSG_HOST_LEVEL;
  34
  35 /** @brief Host datatype.
  36     @ingroup m_host_management
  37
  38     A <em>location</em> (or <em>host</em>) is any possible place where
  39     a process may run. Thus it is represented as a <em>physical
  40     resource with computing capabilities</em>, some <em>mailboxes</em>
  41     to enable running process to communicate with remote ones, and
  42     some <em>private data</em> that can be only accessed by local
  43     process.
  44  */
  45 typedef xbt_dictelm_t msg_host_t;
  46 typedef s_xbt_dictelm_t s_msg_host_t;
  47
  48 typedef struct msg_host_priv {
  49   int        dp_enabled;
  50   xbt_dict_t dp_objs;
  51   double     dp_updated_by_deleted_tasks;
  52
  53 #ifdef MSG_USE_DEPRECATED
  54   msg_mailbox_t *mailboxes;     /**< the channels  */
  55 #endif
  56 } s_msg_host_priv_t, *msg_host_priv_t;
  57
  58 static inline msg_host_priv_t MSG_host_priv(msg_host_t host){
  59   return (msg_host_priv_t )xbt_lib_get_level(host, MSG_HOST_LEVEL);
  60 }
  61
  62
  63
  64 /* ******************************** Task ************************************ */
  65
  66 typedef struct simdata_task *simdata_task_t;
  67
  68 typedef struct msg_task {
  69   char *name;                   /**< @brief task name if any */
  70   simdata_task_t simdata;       /**< @brief simulator data */
  71   void *data;                   /**< @brief user data */
  72 #ifdef HAVE_TRACING
  73   long long int counter;        /* task unique identifier for instrumentation */
  74   char *category;               /* task category for instrumentation */
  75 #endif
  76 } s_msg_task_t;
  77
  78 /** @brief Task datatype.
  79     @ingroup m_task_management
  80
  81     A <em>task</em> may then be defined by a <em>computing
  82     amount</em>, a <em>message size</em> and some <em>private
  83     data</em>.
  84  */
  85 typedef struct msg_task *msg_task_t;
  86
  87 /* ******************************** VM ************************************* */
  88 typedef msg_host_t msg_vm_t;
  89 typedef msg_host_priv_t msg_vm_priv_t;
  90
  91 static inline msg_vm_priv_t MSG_vm_priv(msg_vm_t vm){
  92   return xbt_lib_get_level(vm, MSG_HOST_LEVEL);
  93 }
  94
  95 /* ******************************** File ************************************ */
  96 typedef struct simdata_file *simdata_file_t;
  97
  98 typedef struct msg_file {
  99   char *name;                   /**< @brief file name */
 100   simdata_file_t simdata;                /**< @brief simulator data  */
 101   void *data;                   /**< @brief user data */
 102 } s_msg_file_t;
 103
 104 /** @brief File datatype.
 105     @ingroup msg_file_management
 106
 107     You should consider this as an opaque object.
 108  */
 109 typedef struct msg_file *msg_file_t;
 110
 111
 112 /** @brief File datatype.
 113     @ingroup msg_file_management
 114
 115     You should consider this as an opaque object.
 116  */
 117 typedef s_file_stat_t s_msg_stat_t, *msg_stat_t;
 118
 119
 120 /*************** Begin GPU ***************/
 121 typedef struct simdata_gpu_task *simdata_gpu_task_t;
 122
 123 typedef struct msg_gpu_task {
 124   char *name;                   /**< @brief task name if any */
 125   simdata_gpu_task_t simdata;       /**< @brief simulator data */
 126 #ifdef HAVE_TRACING
 127   long long int counter;        /* task unique identifier for instrumentation */
 128   char *category;               /* task category for instrumentation */
 129 #endif
 130 } s_msg_gpu_task_t;
 131
 132 /** @brief GPU task datatype.
 133     @ingroup m_task_management
 134
 135     A <em>task</em> may then be defined by a <em>computing
 136     amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
 137     \see m_task_management
 138 */
 139 typedef struct msg_gpu_task *msg_gpu_task_t;
 140 /*************** End GPU ***************/
 141
 142 /**
 143  * \brief @brief Communication action.
 144  * \ingroup msg_task_usage
 145  *
 146  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
 147  */
 148 typedef struct msg_comm *msg_comm_t;
 149
 150 /** \brief Default value for an uninitialized #msg_task_t.
 151     \ingroup m_task_management
 152 */
 153 #define MSG_TASK_UNINITIALIZED NULL
 154
 155 /* ****************************** Process *********************************** */
 156
 157 /** @brief Process datatype.
 158     @ingroup m_process_management
 159
 160     A process may be defined as a <em>code</em>, with some
 161     <em>private data</em>, executing in a <em>location</em>.
 162
 163     You should not access directly to the fields of the pointed
 164     structure, but always use the provided API to interact with
 165     processes.
 166  */
 167 typedef struct s_smx_process *msg_process_t;
 168
 169 #ifdef MSG_USE_DEPRECATED
 170
 171 /* Compatibility typedefs */
 172 typedef int                     m_channel_t;
 173 typedef msg_gpu_task_t          m_gpu_task_t;
 174 typedef msg_host_t              m_host_t;
 175 typedef msg_process_t           m_process_t;
 176 typedef msg_task_t              m_task_t;
 177 typedef s_msg_gpu_task_t        s_m_gpu_task_t;
 178 typedef s_msg_host_t            s_m_host_t;
 179 typedef s_msg_task_t            s_m_task_t;
 180 #endif
 181
 182 SG_END_DECL()
 183 #endif