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 #include "xbt/ex_interface.h"
  21
  22 /******************************** Datatypes ***********************************/
  23
  24
  25 /*********************************** Host *************************************/
  26
  27 /** @brief Host datatype
  28     @ingroup m_datatypes_management_details */
  29 typedef struct s_smx_host {
  30   char *name;              /**< @brief host name if any */
  31   void *host;              /* SURF modeling */
  32   xbt_swag_t process_list;
  33   void *data;              /**< @brief user data */
  34 } s_smx_host_t;
  35
  36 /********************************** Simix Global ******************************/
  37
  38 typedef struct s_smx_context_factory *smx_context_factory_t;
  39
  40 typedef struct SIMIX_Global {
  41   smx_context_factory_t context_factory;
  42   xbt_dict_t host;
  43   xbt_swag_t process_to_run;
  44   xbt_swag_t process_list;
  45   xbt_swag_t process_to_destroy;
  46   smx_process_t current_process;
  47   smx_process_t maestro_process;
  48   xbt_dict_t registered_functions;
  49   smx_creation_func_t create_process_function;
  50   void_f_pvoid_t kill_process_function;
  51   void_f_pvoid_t cleanup_process_function;
  52 } s_SIMIX_Global_t, *SIMIX_Global_t;
  53
  54 extern SIMIX_Global_t simix_global;
  55
  56 /******************************** Process *************************************/
  57
  58 /** @brief Process datatype
  59     @ingroup m_datatypes_management_details @{ */
  60      typedef struct s_smx_process {
  61        s_xbt_swag_hookup_t process_hookup;
  62        s_xbt_swag_hookup_t synchro_hookup;
  63        s_xbt_swag_hookup_t host_proc_hookup;
  64        s_xbt_swag_hookup_t destroy_hookup;
  65
  66        char *name;              /**< @brief process name if any */
  67        smx_host_t smx_host;     /* the host on which the process is running */
  68        smx_context_t context;   /* the context that executes the scheduler function */
  69        ex_ctx_t *exception;
  70        int blocked : 1;
  71        int suspended : 1;
  72        int iwannadie : 1;
  73        smx_mutex_t mutex;       /* mutex on which the process is blocked  */
  74        smx_cond_t cond;         /* cond on which the process is blocked  */
  75        xbt_dict_t properties;
  76        void *data;              /* kept for compatibility, it should be replaced with moddata */
  77
  78      } s_smx_process_t;
  79 /** @} */
  80
  81 typedef struct s_smx_process_arg {
  82   const char *name;
  83   xbt_main_func_t code;
  84   void *data;
  85   char *hostname;
  86   int argc;
  87   char **argv;
  88   double kill_time;
  89   xbt_dict_t properties;
  90 } s_smx_process_arg_t, *smx_process_arg_t;
  91
  92 void SIMIX_create_maestro_process(void);
  93 void SIMIX_process_empty_trash(void);
  94 void SIMIX_process_schedule(smx_process_t process);
  95 void SIMIX_process_yield(void);
  96 ex_ctx_t *SIMIX_process_get_exception(void);
  97 void SIMIX_process_exception_terminate(xbt_ex_t * e);
  98
  99
 100 /*************************** Mutex and Conditional ****************************/
 101
 102 typedef struct s_smx_mutex {
 103
 104   /* KEEP IT IN SYNC WITH src/xbt_sg_thread.c::struct s_xbt_mutex */
 105   xbt_swag_t sleeping;          /* list of sleeping process */
 106   int refcount;
 107   /* KEEP IT IN SYNC WITH src/xbt_sg_thread.c::struct s_xbt_mutex */
 108
 109 } s_smx_mutex_t;
 110
 111 typedef struct s_smx_cond {
 112
 113   /* KEEP IT IN SYNC WITH src/xbt_sg_thread.c::struct s_xbt_cond */
 114   xbt_swag_t sleeping;          /* list of sleeping process */
 115   smx_mutex_t mutex;
 116   xbt_fifo_t actions;           /* list of actions */
 117   /* KEEP IT IN SYNC WITH src/xbt_sg_thread.c::struct s_xbt_cond */
 118
 119 } s_smx_cond_t;
 120
 121 /********************************* Action *************************************/
 122
 123 /** @brief Action datatype
 124     @ingroup m_datatypes_management_details */
 125 typedef struct s_smx_action {
 126   char *name;              /**< @brief action name if any */
 127   xbt_fifo_t cond_list;    /*< conditional variables that must be signaled when the action finish. */
 128   void *data;              /**< @brief user data */
 129   int refcount;            /**< @brief reference counter */
 130   surf_action_t surf_action;    /* SURF modeling of computation  */
 131   smx_host_t source;
 132 } s_smx_action_t;
 133
 134 /************************** Configuration support *****************************/
 135
 136 extern int _simix_init_status;  /* 0: beginning of time; FIXME: KILLME ?
 137                                    1: pre-inited (cfg_set created);
 138                                    2: inited (running) */
 139
 140 #define SIMIX_CHECK_HOST()  xbt_assert0(surf_workstation_model->extension.workstation. \
 141                                   get_state(SIMIX_host_self()->host)==SURF_RESOURCE_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
 150 /******************************** Context *************************************/
 151
 152 void SIMIX_context_mod_init(void);
 153
 154 void SIMIX_context_mod_exit(void);
 155
 156 /* *********************** */
 157 /* Context type definition */
 158 /* *********************** */
 159 /* the following function pointers types describe the interface that all context
 160    concepts must implement */
 161
 162 /* each context type must contain this macro at its begining -- OOP in C :/ */
 163 #define SMX_CTX_BASE_T \
 164   s_xbt_swag_hookup_t hookup; \
 165   xbt_main_func_t code; \
 166   int argc; \
 167   char **argv; \
 168   void_f_pvoid_t cleanup_func; \
 169   void *cleanup_arg; \
 170
 171 /* all other context types derive from this structure */
 172 typedef struct s_smx_context {
 173   SMX_CTX_BASE_T;
 174 } s_smx_context_t;
 175
 176 /* *********************** */
 177 /* factory type definition */
 178 /* *********************** */
 179
 180 /* Each context implementation define its own context factory
 181  * A context factory is responsable of the creation and manipulation of the
 182  * execution context of all the simulated processes (and maestro) using the
 183  * selected implementation.
 184  *
 185  * For example, the context switch based on java thread use the
 186  * java implementation of the context and the java factory to build and control
 187  * the contexts depending on this implementation.
 188
 189  * The following function pointer types describe the interface that any context
 190  * factory should implement.
 191  */
 192
 193 /* function used to create a new context */
 194 typedef smx_context_t (*smx_pfn_context_factory_create_context_t)
 195                       (xbt_main_func_t, int, char**, void_f_pvoid_t, void*);
 196
 197 /* this function finalize the specified context factory */
 198 typedef int (*smx_pfn_context_factory_finalize_t) (smx_context_factory_t*);
 199
 200 /* function used to destroy the specified context */
 201 typedef void (*smx_pfn_context_free_t) (smx_context_t);
 202
 203 /* function used to start the specified context */
 204 typedef void (*smx_pfn_context_start_t) (smx_context_t);
 205
 206 /* function used to stop the current context */
 207 typedef void (*smx_pfn_context_stop_t) (smx_context_t);
 208
 209 /* function used to suspend the current context */
 210 typedef void (*smx_pfn_context_suspend_t) (smx_context_t context);
 211
 212 /* function used to resume the current context */
 213 typedef void (*smx_pfn_context_resume_t) (smx_context_t old_context,
 214                                           smx_context_t new_context);
 215
 216 /* interface of the context factories */
 217 typedef struct s_smx_context_factory {
 218   smx_pfn_context_factory_create_context_t create_context;
 219   smx_pfn_context_factory_finalize_t finalize;
 220   smx_pfn_context_free_t free;
 221   smx_pfn_context_start_t start;
 222   smx_pfn_context_stop_t stop;
 223   smx_pfn_context_suspend_t suspend;
 224   smx_pfn_context_resume_t resume;
 225   const char *name;
 226 } s_smx_context_factory_t;
 227
 228 /* Selects a context factory associated with the name specified by the parameter name.
 229  * If successful the function returns 0. Otherwise the function returns the error code.
 230  */
 231 int SIMIX_context_select_factory(const char *name);
 232
 233 /* Initializes a context factory from the name specified by the parameter name.
 234  * If the factory cannot be found, an exception is raised.
 235  */
 236 void SIMIX_context_init_factory_by_name(smx_context_factory_t * factory, const char *name);
 237
 238 /* All factories init */
 239 void SIMIX_ctx_thread_factory_init(smx_context_factory_t * factory);
 240
 241 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t * factory);
 242
 243 void SIMIX_ctx_java_factory_init(smx_context_factory_t * factory);
 244
 245 /* ****************************** */
 246 /* context manipulation functions */
 247 /* ****************************** */
 248
 249 /* Scenario for the end of a context:
 250  *
 251  * CASE 1: death after end of the main function
 252  *   the context_wrapper, called internally by the context module, calls
 253  *   SIMIX_context_stop after user code stops, smx_context_stop calls user
 254  *   cleanup_func if any (in context settings), add current process to trashbin
 255  *   and yields back to maestro.
 256  *   From time to time, maestro calls SIMIX_context_empty_trash, which destroy
 257  *   all the process and context data structures, and frees the memory
 258  *
 259  * CASE 2: brutal death
 260  *   SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
 261  *   schedules the process. Then the process is awaken in the middle of the
 262  *   SIMIX_process_yield function, and at the end of it, it checks that
 263  *   iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
 264  */
 265
 266 /**
 267  * \brief creates a new context for a user level process
 268  * \param code a main function
 269  * \param argc the number of arguments of the main function
 270  * \param argv the vector of arguments of the main function
 271  * \param cleanup_func the function to call when the context stops
 272  * \param cleanup_arg the argument of the cleanup_func function
 273  */
 274 static inline smx_context_t SIMIX_context_new(xbt_main_func_t code, int argc,
 275                                               char** argv,
 276                                               void_f_pvoid_t cleanup_func,
 277                                               void* cleanup_arg)
 278 {
 279   return (*(simix_global->context_factory->create_context))
 280            (code, argc, argv, cleanup_func, cleanup_arg);
 281 }
 282
 283 /**
 284  * \brief destroy a context
 285  * \param context the context to destroy
 286  * Argument must be stopped first -- runs in maestro context
 287  */
 288 static inline void SIMIX_context_free(smx_context_t context)
 289 {
 290   (*(simix_global->context_factory->free)) (context);
 291 }
 292
 293 /**
 294  * \brief prepares aa context to be run
 295  * \param context the context to start
 296  * It will however run effectively only when calling #SIMIX_process_schedule
 297  */
 298 static inline void SIMIX_context_start(smx_context_t context)
 299 {
 300   (*(simix_global->context_factory->start)) (context);
 301 }
 302
 303 /**
 304  * \brief stops the execution of a context
 305  * \param context to stop
 306  */
 307 static inline void SIMIX_context_stop(smx_context_t context)
 308 {
 309   (*(simix_global->context_factory->stop)) (context);
 310 }
 311
 312 /**
 313  \brief resumes the execution of a context
 314  \param old_context the actual context from which is resuming
 315  \param new_context the context to resume
 316  */
 317 static inline void SIMIX_context_resume(smx_context_t old_context,
 318                                         smx_context_t new_context)
 319 {
 320   (*(simix_global->context_factory->resume)) (old_context, new_context);
 321 }
 322
 323 /**
 324  \brief suspends a context and return the control back to the one which
 325         scheduled it
 326  \param context the context to be suspended (it must be the running one)
 327  */
 328 static inline void SIMIX_context_suspend(smx_context_t context)
 329 {
 330   (*(simix_global->context_factory->suspend)) (context);
 331 }
 332
 333 #endif