src/include/simix/datatypes.h

   1 /* Copyright (c) 2007, 2009, 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef SIMIX_DATATYPE_H
   8 #define SIMIX_DATATYPE_H
   9 #include "xbt/misc.h"
  10 #include "xbt/swag.h"
  11 #include "xbt/fifo.h"
  12
  13 SG_BEGIN_DECL()
  14
  15 /* ******************************** Host ************************************ */
  16 /** @defgroup m_datatypes_management_details Details on SIMIX datatypes */
  17 /** @brief Host datatype
  18     @ingroup m_datatypes_management
  19
  20     A <em>location</em> (or <em>host</em>) is any possible place where
  21     a process may run. Thus it is represented as a <em>physical
  22     resource with computing capabilities</em>, some <em>mailboxes</em>
  23     to enable running process to communicate with remote ones, and
  24     some <em>private data</em> that can be only accessed by local
  25     process.
  26
  27     \see m_host_management
  28   @{ */
  29      typedef struct s_smx_host *smx_host_t;
  30 /** @} */
  31
  32
  33 /* ******************************** Syncro ************************************ */
  34      typedef struct s_smx_mutex *smx_mutex_t;
  35      typedef struct s_smx_cond *smx_cond_t;
  36      typedef struct s_smx_sem *smx_sem_t;
  37
  38 /********************************** Action *************************************/
  39      typedef struct s_smx_action *smx_action_t;
  40
  41 /* ****************************** Process *********************************** */
  42 /** @brief Agent datatype
  43     @ingroup m_datatypes_management
  44
  45     An agent may be defined as a <em>code</em>, with some <em>private
  46     data</em>, executing in a <em>location</em>.
  47     \see m_process_management
  48   @{ */
  49      typedef struct s_smx_process *smx_process_t;
  50 /** @} */
  51
  52      typedef struct s_smx_context *smx_context_t;
  53
  54 /******************************* Networking ***********************************/
  55     typedef struct s_smx_rvpoint *smx_rdv_t;
  56     typedef struct s_smx_comm *smx_comm_t;
  57     typedef enum {comm_send,
  58                   comm_recv
  59     } smx_comm_type_t;
  60
  61
  62
  63 SG_END_DECL()
  64 #endif