X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a9b94bc9be0c3ad5b5f816bf343152a3617a1bc2..b423e899ab6e257d5c2cf489585ad5ca0af21724:/include/msg/datatypes.h
diff --git a/include/msg/datatypes.h b/include/msg/datatypes.h
index 0dc9911455..fd06f2f44b 100644
--- a/include/msg/datatypes.h
+++ b/include/msg/datatypes.h
@@ -1,21 +1,29 @@
-/* $Id$ */
-
-/* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved. */
+/* Copyright (c) 2004, 2005, 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef MSG_DATATYPE_H
#define MSG_DATATYPE_H
+#include "xbt/misc.h"
+#include "simgrid_config.h" // for HAVE_TRACING
-/** \defgroup m_datatypes_management MSG Data Types
- \brief This section describes the different datatypes provided by MSG.
-*/
-
-/********************************* Host **************************************/
+SG_BEGIN_DECL()
-/** @name Host datatype
- \ingroup m_datatypes_management
+/* ******************************** Host ************************************ */
+/** @defgroup m_datatypes_management_details Details on MSG datatypes
+ @ingroup m_datatypes_management*/
+typedef struct simdata_host *simdata_host_t;
+/** @brief Host datatype
+ @ingroup m_datatypes_management_details */
+typedef struct m_host {
+ char *name; /**< @brief host name if any */
+ simdata_host_t simdata; /**< @brief simulator data */
+ void *data; /**< @brief user data */
+} s_m_host_t;
+/** @brief Host datatype
+ @ingroup m_datatypes_management
A location (or host) is any possible place where
a process may run. Thus it is represented as a physical
@@ -25,113 +33,104 @@
process.
\see m_host_management
-*/
-/*@{*/
-typedef struct simdata_host *simdata_host_t;
-typedef struct m_host {
- char *name; /**< host name if any */
- simdata_host_t simdata; /**< simulator data */
- void *data; /**< user data */
-} s_m_host_t, *m_host_t;
-/*@}*/
-/********************************* Task **************************************/
-
-/** @name Task datatype
- \ingroup m_datatypes_management
+ @{ */
+typedef struct m_host *m_host_t;
+/** @} */
+/* ******************************** Task ************************************ */
+
+typedef struct simdata_task *simdata_task_t;
+/** @brief Task datatype
+ @ingroup m_datatypes_management_details */
+typedef struct m_task {
+ char *name; /**< @brief task name if any */
+ simdata_task_t simdata; /**< @brief simulator data */
+ void *data; /**< @brief user data */
+#ifdef HAVE_TRACING
+ long long int counter; /* task unique identifier for instrumentation */
+ char *category; /* task category for instrumentation */
+#endif
+} s_m_task_t;
+/** @brief Task datatype
+ @ingroup m_datatypes_management
A task may then be defined by a computing
amount, a message size and some private
data.
\see m_task_management
-*/
-/*@{*/
-typedef struct simdata_task *simdata_task_t;
-typedef struct m_task {
- char *name; /* host name if any */
- simdata_task_t simdata; /* simulator data */
- void *data; /* user data */
-} s_m_task_t, *m_task_t;
+ @{ */
+typedef struct m_task *m_task_t;
/** \brief Default value for an uninitialized #m_task_t.
\ingroup m_datatypes_management
*/
#define MSG_TASK_UNINITIALIZED NULL
-/*@}*/
+typedef struct s_smx_action *msg_comm_t;
+/** @} */
-/******************************* Process *************************************/
-/** @name Agent datatype
- \ingroup m_datatypes_management
- An agent may be defined as a code, with some private
- data, executing in a location.
- \see m_process_management
-*/
-/*@{*/
+/* ****************************** Process *********************************** */
typedef struct simdata_process *simdata_process_t;
+/** @brief Process datatype
+ @ingroup m_datatypes_management_details @{ */
typedef struct m_process {
- /** A name */
- /** process name if any */
- char *name;
- simdata_process_t simdata; /* simulator data */
- void *data; /* user data */
-} s_m_process_t, *m_process_t;
-
-/**
- The code of an agent is a m_process_code_t, i.e. a function with no arguments
- returning no value.
+ char *name; /**< @brief process name if any */
+ simdata_process_t simdata;
+ /**< @brief simulator data */
+ void *data; /**< @brief user data */
+} s_m_process_t;
+/** @} */
+/** @brief Agent datatype
+ @ingroup m_datatypes_management
+
+ An agent may be defined as a code, with some private
+ data, executing in a location.
\see m_process_management
-*/
-typedef int(*m_process_code_t)(int argc,char *argv[]) ;
-/*@}*/
+ @{ */
+typedef struct m_process *m_process_t;
+/** @} */
-/********************************** Channel **********************************/
-/** @name Channel datatype
- \ingroup m_datatypes_management
+/* ********************************* Channel ******************************** */
+/** @brief Channel datatype
+ @ingroup m_datatypes_management
A channel is a number and identifies a mailbox type (just as a
port number does).
\see m_channel_management
-*/
-/*@{*/
+ @{ */
typedef int m_channel_t;
-/*@}*/
-
-/****************************** Error handling *******************************/
-/** \brief Error handling
-*/typedef enum {
- MSG_OK = 0, /**< Everything is right. Keep on going this way ! */
- MSG_WARNING, /**< Mmmh! Something must be not perfectly clean. But I
- may be a paranoid freak... ! */
- MSG_TRANSFER_FAILURE, /**< There has been a problem during you task
+/** @} */
+
+/* ******************************** Mailbox ************************************ */
+
+typedef struct s_smx_rvpoint *msg_mailbox_t;
+/** @brief Mailbox datatype
+ @ingroup m_datatypes_management_details @{ */
+
+void MSG_mailbox_free(void *mailbox);
+
+
+/** @} */
+
+
+/* ***************************** Error handling ***************************** */
+/** @brief Error handling
+ @ingroup m_datatypes_management
+ @{
+*//* Keep these code as binary values: java bindings manipulate | of these values */
+typedef enum {
+ MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */
+ MSG_TIMEOUT = 1, /**< @brief nothing good happened before the timer you provided elapsed */
+ MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task
transfer. Either the network is down or the remote host has been
shutdown. */
- MSG_HOST_FAILURE, /**< System shutdown. The host on which you are
+ MSG_HOST_FAILURE = 4, /**< @brief System shutdown. The host on which you are
running has just been rebooted. Free your datastructures and
return now !*/
- MSG_FATAL /**< You've done something wrong. You'd better look at it... */
+ MSG_TASK_CANCELLED = 8, /**< @brief Canceled task. This task has been canceled by somebody!*/
} MSG_error_t;
+/** @} */
-typedef enum {
- MSG_SILENT = 0,
- MSG_SOME,
- MSG_VERBOSE
-} MSG_outputmode_t;
-
-/** \deprecated Network sharing mechanism
- \ingroup m_datatypes_management*/
-typedef enum {
- MSG_STORE_AND_FORWARD = 1, /* 0 means uninitialized value */
- MSG_TCP
-} MSG_sharing_t;
-
-/** \deprecated Link datatype
- * \ingroup m_datatypes_management
- * The notion of link was present in the earliest versions of MSG.
- * It was an agglomeration of communicating resources representing a set of
- * physical network links. This abstraction a disappeared because in real-life,
- * it is generally not possible to interact directly with a link...
- */
-typedef struct m_link *m_link_t;
+SG_END_DECL()
#endif