X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0cdd9ef0a986b5eadd2012e013eae9ecfd2f156c..20801428bec07ed58c348d25ad39878f2c208389:/include/msg/datatypes.h diff --git a/include/msg/datatypes.h b/include/msg/datatypes.h index d6d9afb5a3..0f0ab9dd65 100644 --- a/include/msg/datatypes.h +++ b/include/msg/datatypes.h @@ -1,6 +1,4 @@ -/* $Id$ */ - -/* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved. */ +/* Copyright (c) 2004-2012. 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,23 +6,39 @@ #ifndef MSG_DATATYPE_H #define MSG_DATATYPE_H #include "xbt/misc.h" +#include "xbt/file_stat.h" +#include "simgrid/simix.h" +#include "simgrid_config.h" // for HAVE_TRACING SG_BEGIN_DECL() +/* ******************************** Mailbox ************************************ */ + +/** @brief Mailbox datatype + * @ingroup msg_task_usage + * + * Object representing a communication rendez-vous point, on which + * the sender finds the receiver it wants to communicate with. As a + * MSG user, you will only rarely manipulate any of these objects + * directly, since most of the public interface (such as + * #MSG_task_send and friends) hide this object behind a string + * alias. That mean that you don't provide the mailbox on which you + * want to send your task, but only the name of this mailbox. */ +typedef struct s_smx_rvpoint *msg_mailbox_t; + + /* ******************************** 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 */ + xbt_swag_t vms; + smx_host_t smx_host; /**< SIMIX representation of this host */ +#ifdef MSG_USE_DEPRECATED + msg_mailbox_t *mailboxes; /**< the channels */ +#endif } s_m_host_t; -/** @brief Host datatype - @ingroup m_datatypes_management + +/** @brief Host datatype. + @ingroup m_host_management A location (or host) is any possible place where a process may run. Thus it is represented as a physical @@ -32,98 +46,106 @@ typedef struct m_host { to enable running process to communicate with remote ones, and some private data that can be only accessed by local process. - - \see m_host_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 */ + 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 + +/** @brief Task datatype. + @ingroup m_task_management A task may then be defined by a computing amount, a message size and some private data. + */ +typedef struct m_task *m_task_t; + + +/* ******************************** File ************************************ */ +typedef struct simdata_file *simdata_file_t; + +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 msg_file_management + + You should consider this as an opaque object. + */ +typedef struct msg_file *msg_file_t; + +typedef s_file_stat_t s_msg_stat_t, *msg_stat_t; + + +/*************** Begin GPU ***************/ +typedef struct simdata_gpu_task *simdata_gpu_task_t; + +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_task_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_task *m_task_t; +*/ +typedef struct m_gpu_task *m_gpu_task_t; +/*************** End GPU ***************/ + +/** + * \brief @brief Communication action. + * \ingroup msg_task_usage + * + * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends. + */ +typedef struct msg_comm *msg_comm_t; /** \brief Default value for an uninitialized #m_task_t. - \ingroup m_datatypes_management + \ingroup m_task_management */ #define MSG_TASK_UNINITIALIZED NULL -/** @} */ - /* ****************************** 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 */ -} 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 struct m_process *m_process_t; -/** @} */ - -/** @brief Agent code - @ingroup m_datatypes_management - The code of an agent is a m_process_code_t, i.e. a function with no arguments - returning no value. - \see m_process_management - @{ */ -typedef int(*m_process_code_t)(int argc,char *argv[]) ; -/** @} */ - -/* ********************************* 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 - @{ */ + +/** @brief Process datatype. + @ingroup m_process_management + + A process may be defined as a code, with some + private data, executing in a location. + + You should not access directly to the fields of the pointed + structure, but always use the provided API to interact with + processes. + */ +typedef struct s_smx_process *m_process_t; + +#ifdef MSG_USE_DEPRECATED typedef int m_channel_t; -/** @} */ +#endif + -/* ***************************** Error handling ***************************** */ -/** @brief Error handling - @ingroup m_datatypes_management - @{ -*/ -typedef enum { - MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */ - MSG_WARNING, /**< @brief Mmmh! Something must be not perfectly clean. But I - may be a paranoid freak... ! */ - MSG_TRANSFER_FAILURE, /**< @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, /**< @brief System shutdown. The host on which you are - running has just been rebooted. Free your datastructures and - return now !*/ - MSG_TASK_CANCELLED, /**< @brief Cancelled task. This task has been cancelled - by somebody!*/ - MSG_FATAL /**< @brief You've done something wrong. You'd better look at it... */ -} MSG_error_t; -/** @} */ SG_END_DECL() #endif