Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
79fc90ae62a1d05247629e492114f0ccbb503e13
[simgrid.git] / include / msg / datatypes.h
1 /* Copyright (c) 2004, 2005, 2007, 2008, 2009, 2010. 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/file_stat.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 typedef struct m_host {
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_m_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 m_host *m_host_t;
51
52 /* ******************************** Task ************************************ */
53
54 typedef struct simdata_task *simdata_task_t;
55
56 typedef struct m_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_m_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 m_task *m_task_t;
74
75
76 /* ******************************** File ************************************ */
77 typedef struct simdata_file *simdata_file_t;
78
79 typedef struct msg_file {
80   char *name;                   /**< @brief file name */
81   simdata_file_t simdata;                /**< @brief simulator data  */
82   void *data;                   /**< @brief user data */
83 } s_msg_file_t;
84
85 /** @brief File datatype.
86     @ingroup msg_file_management 
87  
88     You should consider this as an opaque object.
89  */
90 typedef struct msg_file *msg_file_t;
91
92 typedef s_file_stat_t s_msg_stat_t, *msg_stat_t;
93
94
95 /*************** Begin GPU ***************/
96 typedef struct simdata_gpu_task *simdata_gpu_task_t;
97
98 typedef struct m_gpu_task {
99   char *name;                   /**< @brief task name if any */
100   simdata_gpu_task_t simdata;       /**< @brief simulator data */
101 #ifdef HAVE_TRACING
102   long long int counter;        /* task unique identifier for instrumentation */
103   char *category;               /* task category for instrumentation */
104 #endif
105 } s_m_gpu_task_t;
106
107 /** @brief GPU task datatype
108     @ingroup m_task_management
109
110     A <em>task</em> may then be defined by a <em>computing
111     amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
112     \see m_task_management
113 */
114 typedef struct m_gpu_task *m_gpu_task_t;
115 /*************** End GPU ***************/
116
117 /**
118  * \brief @brief Communication action.
119  * \ingroup msg_task_usage
120  *
121  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
122  */
123 typedef struct msg_comm *msg_comm_t;
124
125 /** \brief Default value for an uninitialized #m_task_t.
126     \ingroup m_task_management 
127 */
128 #define MSG_TASK_UNINITIALIZED NULL
129
130 /* ****************************** Process *********************************** */
131
132 /** @brief Process datatype.
133     @ingroup m_process_management
134
135     A process may be defined as a <em>code</em>, with some
136     <em>private data</em>, executing in a <em>location</em>. 
137  
138     You should not access directly to the fields of the pointed
139     structure, but always use the provided API to interact with
140     processes.
141  */
142 typedef struct s_smx_process *m_process_t;
143
144 #ifdef MSG_USE_DEPRECATED
145 typedef int m_channel_t;
146 #endif
147
148
149
150 SG_END_DECL()
151 #endif