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        smx_action_t waiting_action;
  76        xbt_dict_t properties;
  77        void *data;              /* kept for compatibility, it should be replaced with moddata */
  78
  79      } s_smx_process_t;
  80 /** @} */
  81
  82 typedef struct s_smx_process_arg {
  83   const char *name;
  84   xbt_main_func_t code;
  85   void *data;
  86   char *hostname;
  87   int argc;
  88   char **argv;
  89   double kill_time;
  90   xbt_dict_t properties;
  91 } s_smx_process_arg_t, *smx_process_arg_t;
  92
  93 void SIMIX_create_maestro_process(void);
  94 void SIMIX_process_empty_trash(void);
  95 void SIMIX_process_schedule(smx_process_t process);
  96 void SIMIX_process_yield(void);
  97 ex_ctx_t *SIMIX_process_get_exception(void);
  98 void SIMIX_process_exception_terminate(xbt_ex_t * e);
  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 /******************************* Networking ***********************************/
 122
 123 /** @brief Rendez-vous point datatype */
 124 typedef struct s_smx_rvpoint {
 125   char *name;
 126   smx_mutex_t read;
 127   smx_mutex_t write;
 128   xbt_fifo_t comm_fifo;
 129 } s_smx_rvpoint_t;
 130
 131 typedef struct s_smx_comm {
 132   smx_host_t src_host;
 133   smx_host_t dst_host;
 134   smx_rdv_t rdv;
 135   smx_cond_t cond;
 136   smx_action_t act;
 137   void *data;
 138   size_t data_size;
 139   void **dest_buff;
 140   size_t dest_buff_size;
 141   double rate;
 142   int refcount;
 143 } s_smx_comm_t;
 144
 145 /********************************* Action *************************************/
 146
 147 typedef enum {ready, ongoing, done, failed} smx_action_state_t;
 148
 149 /** @brief Action datatype
 150     @ingroup m_datatypes_management_details */
 151 typedef struct s_smx_action {
 152   char *name;              /**< @brief action name if any */
 153   xbt_fifo_t cond_list;    /*< conditional variables that must be signaled when the action finish. */
 154   void *data;              /**< @brief user data */
 155   int refcount;            /**< @brief reference counter */
 156   surf_action_t surf_action;    /* SURF modeling of computation  */
 157   smx_host_t source;
 158 } s_smx_action_t;
 159
 160 /************************** Configuration support *****************************/
 161
 162 extern int _simix_init_status;  /* 0: beginning of time; FIXME: KILLME ?
 163                                    1: pre-inited (cfg_set created);
 164                                    2: inited (running) */
 165
 166 #define SIMIX_CHECK_HOST()  xbt_assert0(surf_workstation_model->extension.workstation. \
 167                                   get_state(SIMIX_host_self()->host)==SURF_RESOURCE_ON,\
 168                                   "Host failed, you cannot call this function.")
 169
 170 smx_host_t __SIMIX_host_create(const char *name, void *workstation, void *data);
 171 void __SIMIX_host_destroy(void *host);
 172 void __SIMIX_cond_wait(smx_cond_t cond);
 173 void __SIMIX_cond_display_actions(smx_cond_t cond);
 174 void __SIMIX_action_display_conditions(smx_action_t action);
 175
 176 /******************************** Context *************************************/
 177
 178 void SIMIX_context_mod_init(void);
 179
 180 void SIMIX_context_mod_exit(void);
 181
 182 /* *********************** */
 183 /* Context type definition */
 184 /* *********************** */
 185 /* the following function pointers types describe the interface that all context
 186    concepts must implement */
 187
 188 /* each context type must contain this macro at its begining -- OOP in C :/ */
 189 #define SMX_CTX_BASE_T \
 190   s_xbt_swag_hookup_t hookup; \
 191   xbt_main_func_t code; \
 192   int argc; \
 193   char **argv; \
 194   void_f_pvoid_t cleanup_func; \
 195   void *cleanup_arg; \
 196
 197 /* all other context types derive from this structure */
 198 typedef struct s_smx_context {
 199   SMX_CTX_BASE_T;
 200 } s_smx_context_t;
 201
 202 /* *********************** */
 203 /* factory type definition */
 204 /* *********************** */
 205
 206 /* Each context implementation define its own context factory
 207  * A context factory is responsable of the creation and manipulation of the
 208  * execution context of all the simulated processes (and maestro) using the
 209  * selected implementation.
 210  *
 211  * For example, the context switch based on java thread use the
 212  * java implementation of the context and the java factory to build and control
 213  * the contexts depending on this implementation.
 214
 215  * The following function pointer types describe the interface that any context
 216  * factory should implement.
 217  */
 218
 219 /* function used to create a new context */
 220 typedef smx_context_t (*smx_pfn_context_factory_create_context_t)
 221                       (xbt_main_func_t, int, char**, void_f_pvoid_t, void*);
 222
 223 /* this function finalize the specified context factory */
 224 typedef int (*smx_pfn_context_factory_finalize_t) (smx_context_factory_t*);
 225
 226 /* function used to destroy the specified context */
 227 typedef void (*smx_pfn_context_free_t) (smx_context_t);
 228
 229 /* function used to start the specified context */
 230 typedef void (*smx_pfn_context_start_t) (smx_context_t);
 231
 232 /* function used to stop the current context */
 233 typedef void (*smx_pfn_context_stop_t) (smx_context_t);
 234
 235 /* function used to suspend the current context */
 236 typedef void (*smx_pfn_context_suspend_t) (smx_context_t context);
 237
 238 /* function used to resume the current context */
 239 typedef void (*smx_pfn_context_resume_t) (smx_context_t old_context,
 240                                           smx_context_t new_context);
 241
 242 /* interface of the context factories */
 243 typedef struct s_smx_context_factory {
 244   smx_pfn_context_factory_create_context_t create_context;
 245   smx_pfn_context_factory_finalize_t finalize;
 246   smx_pfn_context_free_t free;
 247   smx_pfn_context_start_t start;
 248   smx_pfn_context_stop_t stop;
 249   smx_pfn_context_suspend_t suspend;
 250   smx_pfn_context_resume_t resume;
 251   const char *name;
 252 } s_smx_context_factory_t;
 253
 254 /* Selects a context factory associated with the name specified by the parameter name.
 255  * If successful the function returns 0. Otherwise the function returns the error code.
 256  */
 257 int SIMIX_context_select_factory(const char *name);
 258
 259 /* Initializes a context factory from the name specified by the parameter name.
 260  * If the factory cannot be found, an exception is raised.
 261  */
 262 void SIMIX_context_init_factory_by_name(smx_context_factory_t * factory, const char *name);
 263
 264 /* All factories init */
 265 void SIMIX_ctx_thread_factory_init(smx_context_factory_t * factory);
 266
 267 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t * factory);
 268
 269 void SIMIX_ctx_java_factory_init(smx_context_factory_t * factory);
 270
 271 /* ****************************** */
 272 /* context manipulation functions */
 273 /* ****************************** */
 274
 275 /* Scenario for the end of a context:
 276  *
 277  * CASE 1: death after end of the main function
 278  *   the context_wrapper, called internally by the context module, calls
 279  *   SIMIX_context_stop after user code stops, smx_context_stop calls user
 280  *   cleanup_func if any (in context settings), add current process to trashbin
 281  *   and yields back to maestro.
 282  *   From time to time, maestro calls SIMIX_context_empty_trash, which destroy
 283  *   all the process and context data structures, and frees the memory
 284  *
 285  * CASE 2: brutal death
 286  *   SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
 287  *   schedules the process. Then the process is awaken in the middle of the
 288  *   SIMIX_process_yield function, and at the end of it, it checks that
 289  *   iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
 290  */
 291
 292 /**
 293  * \brief creates a new context for a user level process
 294  * \param code a main function
 295  * \param argc the number of arguments of the main function
 296  * \param argv the vector of arguments of the main function
 297  * \param cleanup_func the function to call when the context stops
 298  * \param cleanup_arg the argument of the cleanup_func function
 299  */
 300 static inline smx_context_t SIMIX_context_new(xbt_main_func_t code, int argc,
 301                                               char** argv,
 302                                               void_f_pvoid_t cleanup_func,
 303                                               void* cleanup_arg)
 304 {
 305   return (*(simix_global->context_factory->create_context))
 306            (code, argc, argv, cleanup_func, cleanup_arg);
 307 }
 308
 309 /**
 310  * \brief destroy a context
 311  * \param context the context to destroy
 312  * Argument must be stopped first -- runs in maestro context
 313  */
 314 static inline void SIMIX_context_free(smx_context_t context)
 315 {
 316   (*(simix_global->context_factory->free)) (context);
 317 }
 318
 319 /**
 320  * \brief prepares aa context to be run
 321  * \param context the context to start
 322  * It will however run effectively only when calling #SIMIX_process_schedule
 323  */
 324 static inline void SIMIX_context_start(smx_context_t context)
 325 {
 326   (*(simix_global->context_factory->start)) (context);
 327 }
 328
 329 /**
 330  * \brief stops the execution of a context
 331  * \param context to stop
 332  */
 333 static inline void SIMIX_context_stop(smx_context_t context)
 334 {
 335   (*(simix_global->context_factory->stop)) (context);
 336 }
 337
 338 /**
 339  \brief resumes the execution of a context
 340  \param old_context the actual context from which is resuming
 341  \param new_context the context to resume
 342  */
 343 static inline void SIMIX_context_resume(smx_context_t old_context,
 344                                         smx_context_t new_context)
 345 {
 346   (*(simix_global->context_factory->resume)) (old_context, new_context);
 347 }
 348
 349 /**
 350  \brief suspends a context and return the control back to the one which
 351         scheduled it
 352  \param context the context to be suspended (it must be the running one)
 353  */
 354 static inline void SIMIX_context_suspend(smx_context_t context)
 355 {
 356   (*(simix_global->context_factory->suspend)) (context);
 357 }
 358
 359 #endif