src/simix/private.h

   1 /* Copyright (c) 2007, 2008, 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_PRIVATE_H
   8 #define SIMIX_PRIVATE_H
   9
  10 #include "simix/simix.h"
  11 #include "surf/surf.h"
  12 #include "xbt/fifo.h"
  13 #include "xbt/swag.h"
  14 #include "xbt/dict.h"
  15 #include "xbt/config.h"
  16 #include "xbt/function_types.h"
  17 #include "xbt/ex_interface.h"
  18 #include "instr/private.h"
  19
  20 /******************************** Datatypes ***********************************/
  21
  22
  23 /*********************************** Host *************************************/
  24
  25 /** @brief Host datatype
  26     @ingroup m_datatypes_management_details */
  27 typedef struct s_smx_host {
  28   char *name;              /**< @brief host name if any */
  29   void *host;                   /* SURF modeling */
  30   xbt_swag_t process_list;
  31   void *data;              /**< @brief user data */
  32 } s_smx_host_t;
  33
  34 /********************************** Simix Global ******************************/
  35
  36 typedef struct s_smx_context_factory *smx_context_factory_t;
  37
  38 typedef struct SIMIX_Global {
  39   smx_context_factory_t context_factory;
  40   xbt_dict_t host;
  41   xbt_swag_t process_to_run;
  42   xbt_swag_t process_list;
  43   xbt_swag_t process_to_destroy;
  44   smx_process_t current_process;
  45   smx_process_t maestro_process;
  46   xbt_dict_t registered_functions;
  47   smx_creation_func_t create_process_function;
  48   void_f_pvoid_t kill_process_function;
  49   void_f_pvoid_t cleanup_process_function;
  50 } s_SIMIX_Global_t, *SIMIX_Global_t;
  51
  52 extern SIMIX_Global_t simix_global;
  53
  54 /******************************** Process *************************************/
  55
  56 /** @brief Process datatype
  57     @ingroup m_datatypes_management_details @{ */
  58 typedef struct s_smx_process {
  59   s_xbt_swag_hookup_t process_hookup;
  60   s_xbt_swag_hookup_t synchro_hookup;   /* process_to_run or mutex->sleeping and co */
  61   s_xbt_swag_hookup_t host_proc_hookup;
  62   s_xbt_swag_hookup_t destroy_hookup;
  63
  64   char *name;                   /**< @brief process name if any */
  65   smx_host_t smx_host;          /* the host on which the process is running */
  66   smx_context_t context;        /* the context that executes the scheduler function */
  67   ex_ctx_t *exception;
  68   int blocked:1;
  69   int suspended:1;
  70   int iwannadie:1;
  71   smx_mutex_t mutex;            /* mutex on which the process is blocked  */
  72   smx_cond_t cond;              /* cond on which the process is blocked  */
  73   smx_sem_t sem;                /* semaphore on which the process is blocked  */
  74   smx_action_t waiting_action;
  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 ex_ctx_t *SIMIX_process_get_exception(void);
  96 void SIMIX_process_exception_terminate(xbt_ex_t * e);
  97
  98 /******************************* Networking ***********************************/
  99
 100 /** @brief Rendez-vous point datatype */
 101 typedef struct s_smx_rvpoint {
 102   char *name;
 103   smx_mutex_t read;
 104   smx_mutex_t write;
 105   xbt_fifo_t comm_fifo;
 106   void *data;
 107 } s_smx_rvpoint_t;
 108
 109 typedef struct s_smx_comm {
 110
 111
 112   smx_comm_type_t type;         /* Type of the communication (comm_send,comm_recv) */
 113   smx_rdv_t rdv;                /* Rendez-vous where the comm is queued */
 114   smx_sem_t sem;                /* Semaphore associated to the surf simulation */
 115   int refcount;                 /* Number of processes involved in the cond */
 116
 117   /* Surf action data */
 118   smx_process_t src_proc;
 119   smx_process_t dst_proc;
 120   smx_action_t src_timeout;
 121   smx_action_t dst_timeout;
 122   smx_action_t act;
 123   double rate;
 124   double task_size;
 125
 126   /* Data to be transfered */
 127   void *src_buff;
 128   void *dst_buff;
 129   size_t src_buff_size;
 130   size_t *dst_buff_size;
 131   char copied;
 132
 133   void *data;                   /* User data associated to communication */
 134 } s_smx_comm_t;
 135
 136 void SIMIX_network_copy_data(smx_comm_t comm);
 137 smx_comm_t SIMIX_communication_new(smx_comm_type_t type);
 138 static XBT_INLINE void SIMIX_communication_use(smx_comm_t comm);
 139 static XBT_INLINE void SIMIX_communication_wait_for_completion(smx_comm_t
 140                                                                comm,
 141                                                                double
 142                                                                timeout);
 143 static XBT_INLINE void SIMIX_rdv_push(smx_rdv_t rdv, smx_comm_t comm);
 144 static XBT_INLINE void SIMIX_rdv_remove(smx_rdv_t rdv, smx_comm_t comm);
 145
 146 /********************************* Action *************************************/
 147
 148 typedef enum { ready, ongoing, done, failed } smx_action_state_t;
 149
 150 /** @brief Action datatype
 151     @ingroup m_datatypes_management_details */
 152 typedef struct s_smx_action {
 153   char *name;              /**< @brief action name if any */
 154   xbt_fifo_t cond_list;         /*< conditional variables that must be signaled when the action finish. */
 155   xbt_fifo_t sem_list;          /*< semaphores that must be signaled when the action finish. */
 156   void *data;              /**< @brief user data */
 157   int refcount;            /**< @brief reference counter */
 158   surf_action_t surf_action;    /* SURF modeling of computation  */
 159   smx_host_t source;
 160 #ifdef HAVE_TRACING
 161   long long int counter;        /* simix action unique identifier for instrumentation */
 162   char *category;               /* simix action category for instrumentation */
 163 #endif
 164 } s_smx_action_t;
 165
 166 /************************** Configuration support *****************************/
 167
 168 extern int _simix_init_status;  /* 0: beginning of time; FIXME: KILLME ?
 169                                    1: pre-inited (cfg_set created);
 170                                    2: inited (running) */
 171
 172 #define SIMIX_CHECK_HOST()  xbt_assert0(surf_workstation_model->extension.workstation. \
 173                                   get_state(SIMIX_host_self()->host)==SURF_RESOURCE_ON,\
 174                                   "Host failed, you cannot call this function.")
 175
 176 smx_host_t __SIMIX_host_create(const char *name, void *workstation,
 177                                void *data);
 178 void __SIMIX_host_destroy(void *host);
 179 void __SIMIX_cond_wait(smx_cond_t cond);
 180 void __SIMIX_cond_display_actions(smx_cond_t cond);
 181 void __SIMIX_action_display_conditions(smx_action_t action);
 182
 183 /******************************** Context *************************************/
 184
 185 /* The following function pointer types describe the interface that any context
 186    factory should implement */
 187
 188 typedef smx_context_t(*smx_pfn_context_factory_create_context_t)
 189  (xbt_main_func_t, int, char **, void_f_pvoid_t, void *);
 190 typedef int (*smx_pfn_context_factory_finalize_t) (smx_context_factory_t
 191                                                    *);
 192 typedef void (*smx_pfn_context_free_t) (smx_context_t);
 193 typedef void (*smx_pfn_context_start_t) (smx_context_t);
 194 typedef void (*smx_pfn_context_stop_t) (smx_context_t);
 195 typedef void (*smx_pfn_context_suspend_t) (smx_context_t context);
 196 typedef void (*smx_pfn_context_resume_t) (smx_context_t new_context);
 197
 198 /* interface of the context factories */
 199 typedef struct s_smx_context_factory {
 200   smx_pfn_context_factory_create_context_t create_context;
 201   smx_pfn_context_factory_finalize_t finalize;
 202   smx_pfn_context_free_t free;
 203   smx_pfn_context_stop_t stop;
 204   smx_pfn_context_suspend_t suspend;
 205   smx_pfn_context_resume_t resume;
 206   const char *name;
 207 } s_smx_context_factory_t;
 208
 209
 210 void SIMIX_context_mod_init(void);
 211
 212 void SIMIX_context_mod_exit(void);
 213
 214 /* Selects a context factory associated with the name specified by the parameter name.
 215  * If successful the function returns 0. Otherwise the function returns the error code.
 216  */
 217 int SIMIX_context_select_factory(const char *name);
 218
 219 /* Initializes a context factory from the name specified by the parameter name.
 220  * If the factory cannot be found, an exception is raised.
 221  */
 222 void SIMIX_context_init_factory_by_name(smx_context_factory_t * factory,
 223                                         const char *name);
 224
 225 /* All factories init */
 226 void SIMIX_ctx_thread_factory_init(smx_context_factory_t * factory);
 227
 228 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t * factory);
 229 void SIMIX_ctx_lua_factory_init(smx_context_factory_t * factory);
 230
 231
 232 void SIMIX_ctx_java_factory_init(smx_context_factory_t * factory);
 233
 234 /* ****************************** */
 235 /* context manipulation functions */
 236 /* ****************************** */
 237
 238 /* Scenario for the end of a context:
 239  *
 240  * CASE 1: death after end of the main function
 241  *   the context_wrapper, called internally by the context module, calls
 242  *   SIMIX_context_stop after user code stops, smx_context_stop calls user
 243  *   cleanup_func if any (in context settings), add current process to trashbin
 244  *   and yields back to maestro.
 245  *   From time to time, maestro calls SIMIX_context_empty_trash, which destroy
 246  *   all the process and context data structures, and frees the memory
 247  *
 248  * CASE 2: brutal death
 249  *   SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
 250  *   schedules the process. Then the process is awaken in the middle of the
 251  *   SIMIX_process_yield function, and at the end of it, it checks that
 252  *   iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
 253  */
 254
 255 /**
 256  * \brief creates a new context for a user level process
 257  * \param code a main function
 258  * \param argc the number of arguments of the main function
 259  * \param argv the vector of arguments of the main function
 260  * \param cleanup_func the function to call when the context stops
 261  * \param cleanup_arg the argument of the cleanup_func function
 262  */
 263 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
 264                                                   int argc, char **argv,
 265                                                   void_f_pvoid_t
 266                                                   cleanup_func,
 267                                                   void *cleanup_arg)
 268 {
 269
 270   return (*(simix_global->context_factory->create_context))
 271       (code, argc, argv, cleanup_func, cleanup_arg);
 272 }
 273
 274 /**
 275  * \brief destroy a context
 276  * \param context the context to destroy
 277  * Argument must be stopped first -- runs in maestro context
 278  */
 279 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
 280 {
 281   (*(simix_global->context_factory->free)) (context);
 282 }
 283
 284 /**
 285  * \brief stops the execution of a context
 286  * \param context to stop
 287  */
 288 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
 289 {
 290   (*(simix_global->context_factory->stop)) (context);
 291 }
 292
 293 /**
 294  \brief resumes the execution of a context
 295  \param old_context the actual context from which is resuming
 296  \param new_context the context to resume
 297  */
 298 static XBT_INLINE void SIMIX_context_resume(smx_context_t new_context)
 299 {
 300   (*(simix_global->context_factory->resume)) (new_context);
 301 }
 302
 303 /**
 304  \brief suspends a context and return the control back to the one which
 305         scheduled it
 306  \param context the context to be suspended (it must be the running one)
 307  */
 308 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
 309 {
 310   (*(simix_global->context_factory->suspend)) (context);
 311 }
 312
 313 #endif