Logo AND Algorithmique Numérique Distribuée

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