3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
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 */
25 /** @brief Host datatype
26 @ingroup m_datatypes_management
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
35 \see m_host_management
37 typedef struct m_host *m_host_t;
39 /* ******************************** Task ************************************ */
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 */
49 /** @brief Task datatype
50 @ingroup m_datatypes_management
52 A <em>task</em> may then be defined by a <em>computing
53 amount</em>, a <em>message size</em> and some <em>private
55 \see m_task_management
57 typedef struct m_task *m_task_t;
59 /** \brief Default value for an uninitialized #m_task_t.
60 \ingroup m_datatypes_management
62 #define MSG_TASK_UNINITIALIZED NULL
68 /* ****************************** Process *********************************** */
69 typedef struct simdata_process *simdata_process_t;
70 /** @brief Process datatype
71 @ingroup m_datatypes_management_details @{ */
72 typedef struct m_process {
73 char *name; /**< @brief process name if any */
74 simdata_process_t simdata;
75 /**< @brief simulator data */
76 void *data; /**< @brief user data */
79 /** @brief Agent datatype
80 @ingroup m_datatypes_management
82 An agent may be defined as a <em>code</em>, with some <em>private
83 data</em>, executing in a <em>location</em>.
84 \see m_process_management
86 typedef struct m_process *m_process_t;
89 /* ********************************* Channel ******************************** */
90 /** @brief Channel datatype
91 @ingroup m_datatypes_management
93 A <em>channel</em> is a number and identifies a mailbox type (just as a
95 \see m_channel_management
97 typedef int m_channel_t;
100 /* ******************************** Mailbox ************************************ */
102 typedef struct s_msg_mailbox *msg_mailbox_t;
103 /** @brief Mailbox datatype
104 @ingroup m_datatypes_management_details @{ */
106 msg_mailbox_t MSG_mailbox_create(const char *alias);
107 void MSG_mailbox_free(void *mailbox);
113 /* ***************************** Error handling ***************************** */
114 /** @brief Error handling
115 @ingroup m_datatypes_management
120 /**< @brief Everything is right. Keep on going this way ! */
122 /**< @brief Mmmh! Something must be not perfectly clean. But I
123 may be a paranoid freak... ! */
124 MSG_TIMEOUT_FAILURE, /**< @brief nothing good happened before the timer you provided elapsed */
125 MSG_TRANSFER_FAILURE,
126 /**< @brief There has been a problem during you task
127 transfer. Either the network is down or the remote host has been
130 /**< @brief System shutdown. The host on which you are
131 running has just been rebooted. Free your datastructures and
134 /**< @brief Cancelled task. This task has been cancelled
137 /**< @brief You've done something wrong. You'd better look at it... */