Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Kill MSG_WARNING and MSG_FATAL return codes
[simgrid.git] / include / msg / datatypes.h
1 /*      $Id$     */
2
3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
4
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. */
7
8 #ifndef MSG_DATATYPE_H
9 #define MSG_DATATYPE_H
10 #include "xbt/misc.h"
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      } s_m_task_t;
49 /** @brief Task datatype  
50     @ingroup m_datatypes_management 
51
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
54     data</em>.
55     \see m_task_management
56   @{ */
57      typedef struct m_task *m_task_t;
58
59 /** \brief Default value for an uninitialized #m_task_t.
60     \ingroup m_datatypes_management 
61 */
62 #define MSG_TASK_UNINITIALIZED NULL
63
64 /** @} */
65
66
67
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 */
77      } s_m_process_t;
78 /** @} */
79 /** @brief Agent datatype  
80     @ingroup m_datatypes_management 
81
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
85   @{ */
86      typedef struct m_process *m_process_t;
87 /** @} */
88
89 /* ********************************* Channel ******************************** */
90 /** @brief Channel datatype  
91     @ingroup m_datatypes_management 
92
93     A <em>channel</em>  is a number and identifies a mailbox type (just as a 
94     port number does).
95     \see m_channel_management
96    @{ */
97      typedef int m_channel_t;
98 /** @} */
99
100 /* ******************************** Mailbox ************************************ */
101
102      typedef struct s_msg_mailbox *msg_mailbox_t;
103 /** @brief Mailbox datatype
104     @ingroup m_datatypes_management_details @{ */
105
106      msg_mailbox_t MSG_mailbox_create(const char *alias);
107      void MSG_mailbox_free(void *mailbox);
108
109
110 /** @} */
111
112
113 /* ***************************** Error handling ***************************** */
114 /** @brief Error handling 
115     @ingroup m_datatypes_management 
116     @{
117 */ /* Keep these code as binary values: java bindings manipulate | of these values */
118      typedef enum {
119        MSG_OK = 0,            /**< @brief Everything is right. Keep on going this way ! */
120        MSG_TIMEOUT_FAILURE=1, /**< @brief nothing good happened before the timer you provided elapsed */
121        MSG_TRANSFER_FAILURE=2,/**< @brief There has been a problem during you task
122       transfer. Either the network is down or the remote host has been
123       shutdown. */
124        MSG_HOST_FAILURE=4,    /**< @brief System shutdown. The host on which you are
125       running has just been rebooted. Free your datastructures and
126       return now !*/
127        MSG_TASK_CANCELLED=8,  /**< @brief Canceled task. This task has been canceled by somebody!*/
128      } MSG_error_t;
129 /** @} */
130
131 SG_END_DECL()
132 #endif