Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Lots of renamings from xbt_ to smx_
[simgrid.git] / src / simix / private.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_PRIVATE_H
10 #define SIMIX_PRIVATE_H
11
12 #include <stdio.h>
13 #include "simix/simix.h"
14 #include "surf/surf.h"
15 #include "xbt/fifo.h"
16 #include "xbt/swag.h"
17 #include "xbt/dict.h"
18 #include "xbt/config.h"
19 #include "xbt/function_types.h"
20
21 /******************************** Datatypes ***********************************/
22
23
24 /*********************************** Host *************************************/
25
26 /** @brief Host datatype 
27     @ingroup m_datatypes_management_details */
28 typedef struct s_smx_host {
29   char *name;              /**< @brief host name if any */
30   void *host;              /* SURF modeling */
31   xbt_swag_t process_list;
32   void *data;              /**< @brief user data */
33 } s_smx_host_t;
34
35 /********************************** Simix Global ******************************/
36
37 typedef struct s_smx_context_factory *smx_context_factory_t;
38
39 typedef struct SIMIX_Global {
40   smx_context_factory_t context_factory;
41   xbt_dict_t host;
42   xbt_swag_t process_to_run;
43   xbt_swag_t process_list;
44   xbt_swag_t process_to_destroy;
45   smx_process_t current_process;
46   smx_process_t maestro_process;
47   xbt_dict_t registered_functions;
48   smx_creation_func_t create_process_function;
49   void_f_pvoid_t kill_process_function;
50   void_f_pvoid_t cleanup_process_function;
51 } s_SIMIX_Global_t, *SIMIX_Global_t;
52
53 extern SIMIX_Global_t simix_global;
54
55 /******************************** Process *************************************/
56
57 typedef struct s_smx_context *smx_context_t;
58
59 /** @brief Process datatype 
60     @ingroup m_datatypes_management_details @{ */
61      typedef struct s_smx_process {
62        s_xbt_swag_hookup_t process_hookup;
63        s_xbt_swag_hookup_t synchro_hookup;
64        s_xbt_swag_hookup_t host_proc_hookup;
65        s_xbt_swag_hookup_t destroy_hookup;
66
67        char *name;              /**< @brief process name if any */
68        smx_host_t smx_host;     /* the host on which the process is running */
69        smx_context_t context;   /* the context that executes the scheduler function */
70        int argc;                /* arguments number if any */
71        char **argv;             /* arguments table if any */
72        int blocked : 1;
73        int suspended : 1;
74        int iwannadie : 1;
75        smx_mutex_t mutex;       /* mutex on which the process is blocked  */
76        smx_cond_t cond;         /* cond on which the process is blocked  */
77        xbt_dict_t properties;
78        void *data;              /* kept for compatibility, it should be replaced with moddata */
79        void_f_pvoid_t cleanup_func;
80        void *cleanup_arg;
81
82      } s_smx_process_t;
83 /** @} */
84
85 typedef struct s_smx_process_arg {
86   const char *name;
87   xbt_main_func_t code;
88   void *data;
89   char *hostname;
90   int argc;
91   char **argv;
92   double kill_time;
93   xbt_dict_t properties;
94 } s_smx_process_arg_t, *smx_process_arg_t;
95
96 /*************************** Mutex and Conditional ****************************/
97
98 typedef struct s_smx_mutex {
99
100   /* KEEP IT IN SYNC WITH src/xbt_sg_thread.c::struct s_xbt_mutex */
101   xbt_swag_t sleeping;          /* list of sleeping process */
102   int refcount;
103   /* KEEP IT IN SYNC WITH src/xbt_sg_thread.c::struct s_xbt_mutex */
104
105 } s_smx_mutex_t;
106
107 typedef struct s_smx_cond {
108
109   /* KEEP IT IN SYNC WITH src/xbt_sg_thread.c::struct s_xbt_cond */
110   xbt_swag_t sleeping;          /* list of sleeping process */
111   smx_mutex_t mutex;
112   xbt_fifo_t actions;           /* list of actions */
113   /* KEEP IT IN SYNC WITH src/xbt_sg_thread.c::struct s_xbt_cond */
114
115 } s_smx_cond_t;
116
117 /********************************* Action *************************************/
118
119 /** @brief Action datatype 
120     @ingroup m_datatypes_management_details */
121 typedef struct s_smx_action {
122   char *name;              /**< @brief action name if any */
123   xbt_fifo_t cond_list;    /*< conditional variables that must be signaled when the action finish. */
124   void *data;              /**< @brief user data */
125   int refcount;            /**< @brief reference counter */
126   surf_action_t surf_action;    /* SURF modeling of computation  */
127   smx_host_t source;
128 } s_smx_action_t;
129
130 /************************** Configuration support *****************************/
131
132 void simix_config_init(void);   /* create the config set, call this before use! */
133 void simix_config_finalize(void);       /* destroy the config set, call this at cleanup. */
134 extern int _simix_init_status;  /* 0: beginning of time; 
135                                    1: pre-inited (cfg_set created); 
136                                    2: inited (running) */
137 extern xbt_cfg_t _simix_cfg_set;
138
139
140 #define SIMIX_CHECK_HOST()  xbt_assert0(surf_workstation_model->extension_public-> \
141                                   get_state(SIMIX_host_self()->host)==SURF_CPU_ON,\
142                                   "Host failed, you cannot call this function.")
143
144 smx_host_t __SIMIX_host_create(const char *name, void *workstation, void *data);
145 void __SIMIX_host_destroy(void *host);
146 void __SIMIX_cond_wait(smx_cond_t cond);
147 void __SIMIX_cond_display_actions(smx_cond_t cond);
148 void __SIMIX_action_display_conditions(smx_action_t action);
149 void __SIMIX_create_maestro_process(void);
150
151 /******************************** Context *************************************/
152
153 int SIMIX_context_create_maestro(smx_process_t *process);
154
155 int SIMIX_context_new(smx_process_t *process, xbt_main_func_t code);
156
157 void SIMIX_context_kill(smx_process_t process);
158
159 void SIMIX_context_start(smx_process_t process);
160
161 void SIMIX_context_yield(void);
162
163 void SIMIX_context_schedule(smx_process_t process);
164      
165 void SIMIX_context_empty_trash(void);
166
167 void SIMIX_context_stop(int exit_code);
168      
169 void SIMIX_context_free(smx_process_t process);
170
171 void SIMIX_context_mod_init(void);
172
173 void SIMIX_context_mod_exit(void);
174 #endif