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 "simgrid/simix.h"
  11 #include "simgrid_config.h"     // for HAVE_TRACING
  12
  13 SG_BEGIN_DECL()
  14
  15 /* ******************************** Mailbox ************************************ */
  16
  17 /** @brief Mailbox datatype
  18  *  @ingroup msg_task_usage
  19  *
  20  * Object representing a communication rendez-vous point, on which
  21  * the sender finds the receiver it wants to communicate with. As a
  22  * MSG user, you will only rarely manipulate any of these objects
  23  * directly, since most of the public interface (such as
  24  * #MSG_task_send and friends) hide this object behind a string
  25  * alias. That mean that you don't provide the mailbox on which you
  26  * want to send your task, but only the name of this mailbox. */
  27 typedef struct s_smx_rvpoint *msg_mailbox_t;
  28
  29
  30 /* ******************************** Host ************************************ */
  31
  32 typedef struct msg_host {
  33   xbt_swag_t vms;
  34   smx_host_t smx_host;          /**< SIMIX representation of this host   */
  35 #ifdef MSG_USE_DEPRECATED
  36   msg_mailbox_t *mailboxes;     /**< the channels  */
  37 #endif
  38 } s_msg_host_t;
  39
  40 /** @brief Host datatype.
  41     @ingroup m_host_management
  42
  43     A <em>location</em> (or <em>host</em>) is any possible place where
  44     a process may run. Thus it is represented as a <em>physical
  45     resource with computing capabilities</em>, some <em>mailboxes</em>
  46     to enable running process to communicate with remote ones, and
  47     some <em>private data</em> that can be only accessed by local
  48     process.
  49  */
  50 typedef struct msg_host *msg_host_t;
  51
  52 /* ******************************** Task ************************************ */
  53
  54 typedef struct simdata_task *simdata_task_t;
  55
  56 typedef struct msg_task {
  57   char *name;                   /**< @brief task name if any */
  58   simdata_task_t simdata;       /**< @brief simulator data */
  59   void *data;                   /**< @brief user data */
  60 #ifdef HAVE_TRACING
  61   long long int counter;        /* task unique identifier for instrumentation */
  62   char *category;               /* task category for instrumentation */
  63 #endif
  64 } s_msg_task_t;
  65
  66 /** @brief Task datatype.
  67     @ingroup m_task_management
  68
  69     A <em>task</em> may then be defined by a <em>computing
  70     amount</em>, a <em>message size</em> and some <em>private
  71     data</em>.
  72  */
  73 typedef struct msg_task *msg_task_t;
  74
  75 /* ********************************  VM ************************************* */
  76 typedef struct msg_vm *msg_vm_t;
  77
  78 typedef enum {
  79   msg_vm_state_suspended, msg_vm_state_running, msg_vm_state_migrating
  80 } e_msg_vm_state_t;
  81
  82 typedef struct msg_vm {
  83   const char *name;
  84   s_xbt_swag_hookup_t all_vms_hookup;
  85   s_xbt_swag_hookup_t host_vms_hookup;
  86   xbt_dynar_t processes;
  87   e_msg_vm_state_t state;
  88   msg_host_t location;
  89   int coreAmount;
  90 } s_msg_vm_t;
  91
  92 /* ******************************** File ************************************ */
  93 typedef struct simdata_file *simdata_file_t;
  94
  95 typedef struct msg_file {
  96   char *name;                   /**< @brief file name */
  97   simdata_file_t simdata;                /**< @brief simulator data  */
  98   void *data;                   /**< @brief user data */
  99 } s_msg_file_t;
 100
 101 /** @brief File datatype.
 102     @ingroup msg_file_management
 103
 104     You should consider this as an opaque object.
 105  */
 106 typedef struct msg_file *msg_file_t;
 107
 108
 109 /** @brief File datatype.
 110     @ingroup msg_file_management
 111
 112     You should consider this as an opaque object.
 113  */
 114 typedef s_file_stat_t s_msg_stat_t, *msg_stat_t;
 115
 116
 117 /*************** Begin GPU ***************/
 118 typedef struct simdata_gpu_task *simdata_gpu_task_t;
 119
 120 typedef struct msg_gpu_task {
 121   char *name;                   /**< @brief task name if any */
 122   simdata_gpu_task_t simdata;       /**< @brief simulator data */
 123 #ifdef HAVE_TRACING
 124   long long int counter;        /* task unique identifier for instrumentation */
 125   char *category;               /* task category for instrumentation */
 126 #endif
 127 } s_msg_gpu_task_t;
 128
 129 /** @brief GPU task datatype.
 130     @ingroup m_task_management
 131
 132     A <em>task</em> may then be defined by a <em>computing
 133     amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
 134     \see m_task_management
 135 */
 136 typedef struct msg_gpu_task *msg_gpu_task_t;
 137 /*************** End GPU ***************/
 138
 139 /**
 140  * \brief @brief Communication action.
 141  * \ingroup msg_task_usage
 142  *
 143  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
 144  */
 145 typedef struct msg_comm *msg_comm_t;
 146
 147 /** \brief Default value for an uninitialized #msg_task_t.
 148     \ingroup m_task_management
 149 */
 150 #define MSG_TASK_UNINITIALIZED NULL
 151
 152 /* ****************************** Process *********************************** */
 153
 154 /** @brief Process datatype.
 155     @ingroup m_process_management
 156
 157     A process may be defined as a <em>code</em>, with some
 158     <em>private data</em>, executing in a <em>location</em>.
 159
 160     You should not access directly to the fields of the pointed
 161     structure, but always use the provided API to interact with
 162     processes.
 163  */
 164 typedef struct s_smx_process *msg_process_t;
 165
 166 #ifdef MSG_USE_DEPRECATED
 167
 168 /* Compatibility typedefs */
 169 typedef int                     m_channel_t;
 170 typedef msg_gpu_task_t          m_gpu_task_t;
 171 typedef msg_host_t              m_host_t;
 172 typedef msg_process_t           m_process_t;
 173 typedef msg_task_t              m_task_t;
 174 typedef s_msg_gpu_task_t        s_m_gpu_task_t;
 175 typedef s_msg_host_t            s_m_host_t;
 176 typedef s_msg_task_t            s_m_task_t;
 177 #endif
 178
 179 SG_END_DECL()
 180 #endif