1 /* Copyright (c) 2004, 2005, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
10 #include "simgrid_config.h" // for HAVE_TRACING
14 /* ******************************** Host ************************************ */
16 /** @defgroup m_datatypes_management_details Details on MSG datatypes
17 @ingroup m_datatypes_management*/
18 typedef struct simdata_host *simdata_host_t;
20 /** @brief Host datatype
21 @ingroup m_datatypes_management_details */
22 typedef struct m_host {
23 char *name; /**< @brief host name if any */
24 simdata_host_t simdata; /**< @brief simulator data */
25 void *data; /**< @brief user data */
28 /** @brief Host datatype
29 @ingroup m_datatypes_management
31 A <em>location</em> (or <em>host</em>) is any possible place where
32 a process may run. Thus it is represented as a <em>physical
33 resource with computing capabilities</em>, some <em>mailboxes</em>
34 to enable running process to communicate with remote ones, and
35 some <em>private data</em> that can be only accessed by local
38 \see m_host_management
40 typedef struct m_host *m_host_t;
43 /* ******************************** Task ************************************ */
45 typedef struct simdata_task *simdata_task_t;
47 /** @brief Task datatype
48 @ingroup m_datatypes_management_details */
49 typedef struct m_task {
50 char *name; /**< @brief task name if any */
51 simdata_task_t simdata; /**< @brief simulator data */
52 void *data; /**< @brief user data */
54 long long int counter; /* task unique identifier for instrumentation */
55 char *category; /* task category for instrumentation */
59 /** @brief Task datatype
60 @ingroup m_datatypes_management
62 A <em>task</em> may then be defined by a <em>computing
63 amount</em>, a <em>message size</em> and some <em>private
65 \see m_task_management
67 typedef struct m_task *m_task_t;
69 /* ******************************** File ************************************ */
71 typedef struct simdata_file *simdata_file_t;
73 /** @brief File datatype
74 @ingroup m_datatypes_management_details */
75 typedef struct msg_file {
76 char *name; /**< @brief file name */
77 simdata_file_t simdata; /**< @brief simulator data */
78 void *data; /**< @brief user data */
80 /** @brief File datatype
81 @ingroup m_datatypes_management_details */
82 typedef struct msg_file *msg_file_t;
85 /*************** Begin GPU ***************/
86 typedef struct simdata_gpu_task *simdata_gpu_task_t;
88 /** @brief GPU task datatype
89 @ingroup m_datatypes_management_details */
90 typedef struct m_gpu_task {
91 char *name; /**< @brief task name if any */
92 simdata_gpu_task_t simdata; /**< @brief simulator data */
94 long long int counter; /* task unique identifier for instrumentation */
95 char *category; /* task category for instrumentation */
99 /** @brief GPU task datatype
100 @ingroup m_datatypes_management
102 A <em>task</em> may then be defined by a <em>computing
103 amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
104 \see m_task_management
106 typedef struct m_gpu_task *m_gpu_task_t;
107 /*************** End GPU ***************/
110 * \brief @brief Communication action
111 * \ingroup m_datatypes_management
113 * Communication actions transfer tasks between processes.
114 * For a given task, the sender and the receiver have distinct objects.
116 typedef struct msg_comm *msg_comm_t;
118 /** \brief Default value for an uninitialized #m_task_t.
119 \ingroup m_datatypes_management
121 #define MSG_TASK_UNINITIALIZED NULL
125 /* ****************************** Process *********************************** */
127 /** @brief Process datatype
128 @ingroup m_datatypes_management
130 A process may be defined as a <em>code</em>, with some <em>private
131 data</em>, executing in a <em>location</em>.
132 \see m_process_management
134 typedef struct s_smx_process *m_process_t;
137 #ifdef MSG_USE_DEPRECATED
138 /* ********************************* Channel ******************************** */
139 /** @brief Channel datatype
140 @ingroup msg_deprecated_functions
142 A <em>channel</em> is a number and identifies a mailbox type (just as a
144 \see m_channel_management
146 typedef int m_channel_t;
150 /* ******************************** Mailbox ************************************ */
152 typedef struct s_smx_rvpoint *msg_mailbox_t;
153 /** @brief Mailbox datatype
154 @ingroup m_datatypes_management_details @{ */
156 void MSG_mailbox_free(void *mailbox);
162 /* ***************************** Error handling ***************************** */
163 /** @brief Error handling
164 @ingroup m_datatypes_management
166 *//* Keep these code as binary values: java bindings manipulate | of these values */
168 MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */
169 MSG_TIMEOUT = 1, /**< @brief nothing good happened before the timer you provided elapsed */
170 MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task
171 transfer. Either the network is down or the remote host has been
173 MSG_HOST_FAILURE = 4, /**< @brief System shutdown. The host on which you are
174 running has just been rebooted. Free your datastructures and
176 MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/