Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] protecting category field in process structure
[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 "simgrid_config.h"     // for HAVE_TRACING
11
12 SG_BEGIN_DECL()
13
14 /* ******************************** Host ************************************ */
15 /** @defgroup m_datatypes_management_details Details on MSG datatypes
16     @ingroup  m_datatypes_management*/
17 typedef struct simdata_host *simdata_host_t;
18 /** @brief Host datatype 
19     @ingroup m_datatypes_management_details */
20 typedef struct m_host {
21   char *name;                   /**< @brief host name if any */
22   simdata_host_t simdata;       /**< @brief simulator data */
23   void *data;                   /**< @brief user data */
24 } s_m_host_t;
25 /** @brief Host datatype  
26     @ingroup m_datatypes_management
27
28     A <em>location</em> (or <em>host</em>) is any possible place where
29     a process may run. Thus it is represented as a <em>physical
30     resource with computing capabilities</em>, some <em>mailboxes</em>
31     to enable running process to communicate with remote ones, and
32     some <em>private data</em> that can be only accessed by local
33     process.
34
35     \see m_host_management
36   @{ */
37 typedef struct m_host *m_host_t;
38 /** @} */
39 /* ******************************** Task ************************************ */
40
41 typedef struct simdata_task *simdata_task_t;
42 /** @brief Task datatype 
43     @ingroup m_datatypes_management_details */
44 typedef struct m_task {
45   char *name;                   /**< @brief task name if any */
46   simdata_task_t simdata;       /**< @brief simulator data */
47   void *data;                   /**< @brief user data */
48 #ifdef HAVE_TRACING
49   long long int counter;        /* task unique identifier for instrumentation */
50   char *category;               /* task category for instrumentation */
51 #endif
52 } s_m_task_t;
53 /** @brief Task datatype  
54     @ingroup m_datatypes_management 
55
56     A <em>task</em> may then be defined by a <em>computing
57     amount</em>, a <em>message size</em> and some <em>private
58     data</em>.
59     \see m_task_management
60   @{ */
61 typedef struct m_task *m_task_t;
62
63 /** \brief Default value for an uninitialized #m_task_t.
64     \ingroup m_datatypes_management 
65 */
66 #define MSG_TASK_UNINITIALIZED NULL
67
68 typedef struct s_smx_action *msg_comm_t;
69 /** @} */
70
71
72
73 /* ****************************** Process *********************************** */
74 typedef struct simdata_process *simdata_process_t;
75 /** @brief Process datatype 
76     @ingroup m_datatypes_management_details @{ */
77 typedef struct m_process {
78   char *name;                   /**< @brief process name if any */
79   simdata_process_t simdata;
80                                 /**< @brief simulator data */
81   void *data;                   /**< @brief user data */
82 #ifdef HAVE_TRACING
83   char *category;               /* process category for instrumentation */
84 #endif
85 } s_m_process_t;
86 /** @} */
87 /** @brief Agent datatype  
88     @ingroup m_datatypes_management 
89
90     An agent may be defined as a <em>code</em>, with some <em>private
91     data</em>, executing in a <em>location</em>.
92     \see m_process_management
93   @{ */
94 typedef struct m_process *m_process_t;
95 /** @} */
96
97 /* ********************************* Channel ******************************** */
98 /** @brief Channel datatype  
99     @ingroup m_datatypes_management 
100
101     A <em>channel</em>  is a number and identifies a mailbox type (just as a 
102     port number does).
103     \see m_channel_management
104    @{ */
105 typedef int m_channel_t;
106 /** @} */
107
108 /* ******************************** Mailbox ************************************ */
109
110 typedef struct s_smx_rvpoint *msg_mailbox_t;
111 /** @brief Mailbox datatype
112     @ingroup m_datatypes_management_details @{ */
113
114 msg_mailbox_t MSG_mailbox_create(const char *alias);
115 void MSG_mailbox_free(void *mailbox);
116
117
118 /** @} */
119
120
121 /* ***************************** Error handling ***************************** */
122 /** @brief Error handling 
123     @ingroup m_datatypes_management 
124          @{
125 *//* Keep these code as binary values: java bindings manipulate | of these values */
126 typedef enum {
127   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
128   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
129   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
130       transfer. Either the network is down or the remote host has been
131       shutdown. */
132   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
133       running has just been rebooted. Free your datastructures and
134       return now !*/
135   MSG_TASK_CANCELLED = 8,     /**< @brief Canceled task. This task has been canceled by somebody!*/
136 } MSG_error_t;
137 /** @} */
138
139 SG_END_DECL()
140 #endif