Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Got bored during a meeting: fix the copyright notice of several useless files (found...
[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
18 typedef struct simdata_host *simdata_host_t;
19 /** @brief Host datatype 
20     @ingroup m_datatypes_management_details */
21 typedef struct m_host {
22   char *name;                   /**< @brief host name if any */
23   simdata_host_t simdata;       /**< @brief simulator data */
24   void *data;                   /**< @brief user data */
25 } s_m_host_t;
26 /** @brief Host datatype  
27     @ingroup m_datatypes_management
28
29     A <em>location</em> (or <em>host</em>) is any possible place where
30     a process may run. Thus it is represented as a <em>physical
31     resource with computing capabilities</em>, some <em>mailboxes</em>
32     to enable running process to communicate with remote ones, and
33     some <em>private data</em> that can be only accessed by local
34     process.
35
36     \see m_host_management
37   @{ */
38 typedef struct m_host *m_host_t;
39 /** @} */
40 /* ******************************** Task ************************************ */
41
42 typedef struct simdata_task *simdata_task_t;
43 /** @brief Task datatype 
44     @ingroup m_datatypes_management_details */
45 typedef struct m_task {
46   char *name;                   /**< @brief task name if any */
47   simdata_task_t simdata;       /**< @brief simulator data */
48   void *data;                   /**< @brief user data */
49 } s_m_task_t;
50 /** @brief Task datatype  
51     @ingroup m_datatypes_management 
52
53     A <em>task</em> may then be defined by a <em>computing
54     amount</em>, a <em>message size</em> and some <em>private
55     data</em>.
56     \see m_task_management
57   @{ */
58 typedef struct m_task  *m_task_t;
59
60 /** \brief Default value for an uninitialized #m_task_t.
61     \ingroup m_datatypes_management 
62 */
63 #define MSG_TASK_UNINITIALIZED NULL
64
65 /** @} */
66
67 /* ****************************** Process *********************************** */
68 typedef struct simdata_process *simdata_process_t;
69 /** @brief Process datatype 
70     @ingroup m_datatypes_management_details @{ */
71 typedef struct m_process {
72   char *name;                   /**< @brief process name if any */
73   simdata_process_t simdata;    /**< @brief simulator data */
74   void *data;                   /**< @brief user data */
75 } s_m_process_t;
76 /** @} */
77 /** @brief Agent datatype  
78     @ingroup m_datatypes_management 
79
80     An agent may be defined as a <em>code</em>, with some <em>private
81     data</em>, executing in a <em>location</em>.
82     \see m_process_management
83   @{ */
84 typedef struct m_process *m_process_t;
85 /** @} */
86
87 /* ********************************* Channel ******************************** */
88 /** @brief Channel datatype  
89     @ingroup m_datatypes_management 
90
91     A <em>channel</em>  is a number and identifies a mailbox type (just as a 
92     port number does).
93     \see m_channel_management
94    @{ */
95 typedef int m_channel_t;
96 /** @} */
97
98 /* ***************************** Error handling ***************************** */
99 /** @brief Error handling 
100     @ingroup m_datatypes_management 
101     @{
102 */
103 typedef enum {
104   MSG_OK = 0,  /**< @brief Everything is right. Keep on going this way ! */
105   MSG_WARNING, /**< @brief Mmmh! Something must be not perfectly clean. But I
106       may be a paranoid freak... ! */
107   MSG_TRANSFER_FAILURE, /**< @brief There has been a problem during you task
108       transfer. Either the network is down or the remote host has been
109       shutdown. */
110   MSG_HOST_FAILURE, /**< @brief System shutdown. The host on which you are
111       running has just been rebooted. Free your datastructures and
112       return now !*/
113   MSG_TASK_CANCELLED, /**< @brief Cancelled task. This task has been cancelled 
114                         by somebody!*/
115   MSG_FATAL /**< @brief You've done something wrong. You'd better look at it... */
116 } MSG_error_t;
117 /** @} */
118
119 SG_END_DECL()
120 #endif