X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a182030b5a8c0db05a1de18ca230b61e76363ebc..af0b5e9494ca8988c8dd7d3874c3c7a400a63172:/include/msg/datatypes.h diff --git a/include/msg/datatypes.h b/include/msg/datatypes.h index 255b1558d5..8816397c02 100644 --- a/include/msg/datatypes.h +++ b/include/msg/datatypes.h @@ -1,6 +1,5 @@ -/* $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. */ @@ -8,21 +7,24 @@ #ifndef MSG_DATATYPE_H #define MSG_DATATYPE_H #include "xbt/misc.h" -#include "instr/tracing_config.h" // for HAVE_TRACING +#include "simgrid_config.h" // for HAVE_TRACING SG_BEGIN_DECL() /* ******************************** Host ************************************ */ + /** @defgroup m_datatypes_management_details Details on MSG datatypes @ingroup m_datatypes_management*/ - typedef struct simdata_host *simdata_host_t; +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; +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 @@ -35,22 +37,25 @@ SG_BEGIN_DECL() \see m_host_management @{ */ - typedef struct m_host *m_host_t; +typedef struct m_host *m_host_t; /** @} */ + /* ******************************** Task ************************************ */ - typedef struct simdata_task *simdata_task_t; +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 */ +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 */ + long long int counter; /* task unique identifier for instrumentation */ + char *category; /* task category for instrumentation */ #endif - } s_m_task_t; +} s_m_task_t; + /** @brief Task datatype @ingroup m_datatypes_management @@ -59,7 +64,56 @@ SG_BEGIN_DECL() data. \see m_task_management @{ */ - typedef struct m_task *m_task_t; +typedef struct m_task *m_task_t; + +/* ******************************** File ************************************ */ + +typedef struct simdata_file *simdata_file_t; + +/** @brief File datatype + @ingroup m_datatypes_management_details */ +typedef struct msg_file { + char *name; /**< @brief file name */ + simdata_file_t simdata; /**< @brief simulator data */ + void *data; /**< @brief user data */ +} s_msg_file_t; +/** @brief File datatype + @ingroup m_datatypes_management_details */ +typedef struct msg_file *msg_file_t; + + +/*************** Begin GPU ***************/ +typedef struct simdata_gpu_task *simdata_gpu_task_t; + +/** @brief GPU task datatype + @ingroup m_datatypes_management_details */ +typedef struct m_gpu_task { + char *name; /**< @brief task name if any */ + simdata_gpu_task_t simdata; /**< @brief simulator data */ +#ifdef HAVE_TRACING + long long int counter; /* task unique identifier for instrumentation */ + char *category; /* task category for instrumentation */ +#endif +} s_m_gpu_task_t; + +/** @brief GPU task datatype + @ingroup m_datatypes_management + + A task may then be defined by a computing + amount, a dispatch latency and a collect latency. + \see m_task_management + @{ */ +typedef struct m_gpu_task *m_gpu_task_t; +/*************** End GPU ***************/ + +/** + * \brief @brief Communication action + * \ingroup m_datatypes_management + * + * Communication actions transfer tasks between processes. + * For a given task, the sender and the receiver have distinct objects. + */ +typedef struct msg_comm *msg_comm_t; /** \brief Default value for an uninitialized #m_task_t. \ingroup m_datatypes_management @@ -68,49 +122,38 @@ SG_BEGIN_DECL() /** @} */ - - /* ****************************** Process *********************************** */ - typedef struct simdata_process *simdata_process_t; -/** @brief Process datatype - @ingroup m_datatypes_management_details @{ */ - typedef struct m_process { - char *name; /**< @brief process name if any */ - simdata_process_t simdata; - /**< @brief simulator data */ - void *data; /**< @brief user data */ - char *category; /* process category for instrumentation */ - } s_m_process_t; -/** @} */ -/** @brief Agent datatype + +/** @brief Process datatype @ingroup m_datatypes_management - An agent may be defined as a code, with some private + A process may be defined as a code, with some private data, executing in a location. \see m_process_management @{ */ - typedef struct m_process *m_process_t; +typedef struct s_smx_process *m_process_t; /** @} */ +#ifdef MSG_USE_DEPRECATED /* ********************************* Channel ******************************** */ /** @brief Channel datatype - @ingroup m_datatypes_management + @ingroup msg_deprecated_functions 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; +typedef int m_channel_t; /** @} */ +#endif /* ******************************** Mailbox ************************************ */ - typedef struct s_msg_mailbox *msg_mailbox_t; +typedef struct s_smx_rvpoint *msg_mailbox_t; /** @brief Mailbox datatype @ingroup m_datatypes_management_details @{ */ - msg_mailbox_t MSG_mailbox_create(const char *alias); - void MSG_mailbox_free(void *mailbox); +void MSG_mailbox_free(void *mailbox); /** @} */ @@ -119,20 +162,21 @@ SG_BEGIN_DECL() /* ***************************** 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 + @{ +*//* 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=4, /**< @brief 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_TASK_CANCELLED=8, /**< @brief Canceled task. This task has been canceled by somebody!*/ - } MSG_error_t; + MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/ +} MSG_error_t; /** @} */ + SG_END_DECL() #endif