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. */
11 #include "instr/tracing_config.h" // for HAVE_TRACING
15 /* ******************************** Host ************************************ */
16 /** @defgroup m_datatypes_management_details Details on MSG datatypes
17 @ingroup m_datatypes_management*/
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 */
26 /** @brief Host datatype
27 @ingroup m_datatypes_management
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
36 \see m_host_management
38 typedef struct m_host *m_host_t;
40 /* ******************************** Task ************************************ */
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 */
50 long long int counter; /* task unique identifier for instrumentation */
51 char *category; /* task category for instrumentation */
54 /** @brief Task datatype
55 @ingroup m_datatypes_management
57 A <em>task</em> may then be defined by a <em>computing
58 amount</em>, a <em>message size</em> and some <em>private
60 \see m_task_management
62 typedef struct m_task *m_task_t;
64 /** \brief Default value for an uninitialized #m_task_t.
65 \ingroup m_datatypes_management
67 #define MSG_TASK_UNINITIALIZED NULL
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 char *category; /* process category for instrumentation */
85 /** @brief Agent datatype
86 @ingroup m_datatypes_management
88 An agent may be defined as a <em>code</em>, with some <em>private
89 data</em>, executing in a <em>location</em>.
90 \see m_process_management
92 typedef struct m_process *m_process_t;
95 /* ********************************* Channel ******************************** */
96 /** @brief Channel datatype
97 @ingroup m_datatypes_management
99 A <em>channel</em> is a number and identifies a mailbox type (just as a
101 \see m_channel_management
103 typedef int m_channel_t;
106 /* ******************************** Mailbox ************************************ */
108 typedef struct s_msg_mailbox *msg_mailbox_t;
109 /** @brief Mailbox datatype
110 @ingroup m_datatypes_management_details @{ */
112 msg_mailbox_t MSG_mailbox_create(const char *alias);
113 void MSG_mailbox_free(void *mailbox);
119 /* ***************************** Error handling ***************************** */
120 /** @brief Error handling
121 @ingroup m_datatypes_management
123 */ /* Keep these code as binary values: java bindings manipulate | of these values */
125 MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */
126 MSG_TIMEOUT=1, /**< @brief nothing good happened before the timer you provided elapsed */
127 MSG_TRANSFER_FAILURE=2,/**< @brief There has been a problem during you task
128 transfer. Either the network is down or the remote host has been
130 MSG_HOST_FAILURE=4, /**< @brief System shutdown. The host on which you are
131 running has just been rebooted. Free your datastructures and
133 MSG_TASK_CANCELLED=8, /**< @brief Canceled task. This task has been canceled by somebody!*/