src/simix/smx_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 "simgrid/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/mallocator.h"
  16 #include "xbt/config.h"
  17 #include "xbt/xbt_os_time.h"
  18 #include "xbt/function_types.h"
  19 #include "xbt/ex_interface.h"
  20 #include "instr/instr_private.h"
  21 #include "smx_process_private.h"
  22 #include "smx_host_private.h"
  23 #include "smx_io_private.h"
  24 #include "smx_network_private.h"
  25 #include "smx_smurf_private.h"
  26 #include "smx_synchro_private.h"
  27
  28 /* Define only for SimGrid benchmarking purposes */
  29 //#define TIME_BENCH_PER_SR /* this aims at measuring the time spent in each scheduling round per each thread. The code is thus run in sequential to bench separately each SSR */
  30 //#define TIME_BENCH_AMDAHL /* this aims at measuring the porting of time that could be parallelized at maximum (to get the optimal speedup by applying the amdahl law). */
  31
  32 /********************************** Simix Global ******************************/
  33 typedef struct s_smx_global {
  34   smx_context_factory_t context_factory;
  35   xbt_dynar_t process_to_run;
  36   xbt_dynar_t process_that_ran;
  37   xbt_swag_t process_list;
  38   xbt_swag_t process_to_destroy;
  39   smx_process_t maestro_process;
  40   xbt_dict_t registered_functions;
  41   smx_creation_func_t create_process_function;
  42   void_pfn_smxprocess_t_smxprocess_t kill_process_function;
  43   void_pfn_smxprocess_t cleanup_process_function;
  44   xbt_mallocator_t action_mallocator;
  45   void_pfn_smxhost_t autorestart;
  46
  47 #ifdef TIME_BENCH_AMDAHL
  48   xbt_os_timer_t timer_seq; /* used to bench the sequential and parallel parts of the simulation, if requested to */
  49   xbt_os_timer_t timer_par;
  50 #endif
  51 } s_smx_global_t, *smx_global_t;
  52
  53 extern smx_global_t simix_global;
  54 extern unsigned long simix_process_maxpid;
  55
  56 extern xbt_dict_t watched_hosts_lib;
  57
  58 /******************************** Exceptions *********************************/
  59
  60 #define SMX_EXCEPTION(issuer, c, v, m)                                  \
  61   if (1) {                                                              \
  62     smx_process_t _smx_throw_issuer = (issuer);                         \
  63     THROW_PREPARE(_smx_throw_issuer->running_ctx, (c), (v), xbt_strdup(m)); \
  64     _smx_throw_issuer->doexception = 1;                                 \
  65   } else ((void)0)
  66
  67 #define SMX_THROW() RETHROW
  68
  69 /* ******************************** File ************************************ */
  70 typedef struct s_smx_file {
  71   surf_file_t surf_file;
  72 } s_smx_file_t;
  73
  74 typedef struct s_smx_stat {
  75   s_file_stat_t surf_stat;
  76 } s_smx_stat_t;
  77
  78 /*********************************** Time ************************************/
  79
  80 /** @brief Timer datatype */
  81 typedef struct s_smx_timer {
  82   double date;
  83   void* func;
  84   void* args;
  85 } s_smx_timer_t;
  86
  87 /********************************* Action *************************************/
  88
  89 typedef enum {
  90   SIMIX_ACTION_EXECUTE,
  91   SIMIX_ACTION_PARALLEL_EXECUTE,
  92   SIMIX_ACTION_COMMUNICATE,
  93   SIMIX_ACTION_SLEEP,
  94   SIMIX_ACTION_SYNCHRO,
  95   SIMIX_ACTION_IO
  96 } e_smx_action_type_t;
  97
  98 typedef enum {
  99   SIMIX_COMM_SEND,
 100   SIMIX_COMM_RECEIVE,
 101   SIMIX_COMM_READY,
 102   SIMIX_COMM_DONE
 103 } e_smx_comm_type_t;
 104
 105 typedef enum {
 106   SIMIX_IO_OPEN,
 107   SIMIX_IO_WRITE,
 108   SIMIX_IO_READ,
 109   SIMIX_IO_STAT
 110 } e_smx_io_type_t;
 111
 112 /** @brief Action datatype */
 113 typedef struct s_smx_action {
 114
 115   e_smx_action_type_t type;          /* Type of SIMIX action*/
 116   e_smx_state_t state;               /* State of the action */
 117   char *name;                        /* Action name if any */
 118   xbt_fifo_t simcalls;               /* List of simcalls waiting for this action */
 119
 120   /* Data specific to each action type */
 121   union {
 122
 123     struct {
 124       smx_host_t host;                /* The host where the execution takes place */
 125       surf_action_t surf_exec;        /* The Surf execution action encapsulated */
 126     } execution; /* Possibly parallel execution */
 127
 128     struct {
 129       e_smx_comm_type_t type;         /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
 130       smx_rdv_t rdv;                  /* Rendez-vous where the comm is queued */
 131       int refcount;                   /* Number of processes involved in the cond */
 132       int detached;                   /* If detached or not */
 133
 134       void (*clean_fun)(void*);       /* Function to clean the detached src_buf if something goes wrong */
 135       int (*match_fun)(void*,void*,smx_action_t);  /* Filter function used by the other side. It is used when
 136                                          looking if a given communication matches my needs. For that, myself must match the
 137                                          expectations of the other side, too. See  */
 138
 139       /* Surf action data */
 140       surf_action_t surf_comm;        /* The Surf communication action encapsulated */
 141       surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
 142       surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
 143       smx_process_t src_proc;
 144       smx_process_t dst_proc;
 145       double rate;
 146       double task_size;
 147
 148       /* Data to be transfered */
 149       void *src_buff;
 150       void *dst_buff;
 151       size_t src_buff_size;
 152       size_t *dst_buff_size;
 153       unsigned copied:1;              /* whether the data were already copied */
 154
 155       void* src_data;                 /* User data associated to communication */
 156       void* dst_data;
 157     } comm;
 158
 159     struct {
 160       smx_host_t host;                /* The host that is sleeping */
 161       surf_action_t surf_sleep;       /* The Surf sleeping action encapsulated */
 162     } sleep;
 163
 164     struct {
 165       surf_action_t sleep;
 166     } synchro;
 167
 168     struct {
 169       smx_host_t host;
 170       surf_action_t surf_io;
 171     } io;
 172   };
 173
 174 #ifdef HAVE_LATENCY_BOUND_TRACKING
 175   int latency_limited;
 176 #endif
 177
 178 #ifdef HAVE_TRACING
 179   char *category;                     /* simix action category for instrumentation */
 180 #endif
 181 } s_smx_action_t;
 182
 183 /* FIXME: check if we can delete this function */
 184 static XBT_INLINE e_smx_state_t SIMIX_action_map_state(e_surf_action_state_t state)
 185 {
 186   switch (state) {
 187     case SURF_ACTION_READY:
 188       return SIMIX_READY;
 189     case SURF_ACTION_RUNNING:
 190       return SIMIX_RUNNING;
 191     case SURF_ACTION_FAILED:
 192       return SIMIX_FAILED;
 193     case SURF_ACTION_DONE:
 194       return SIMIX_DONE;
 195     default:
 196       xbt_die("Unexpected SURF action state");
 197   }
 198 }
 199
 200 void SIMIX_context_mod_init(void);
 201 void SIMIX_context_mod_exit(void);
 202
 203 void SIMIX_context_set_current(smx_context_t context);
 204 smx_context_t SIMIX_context_get_current(void);
 205
 206 /* All factories init */
 207
 208 typedef struct s_smx_ctx_sysv {
 209   s_smx_ctx_base_t super;       /* Fields of super implementation */
 210   ucontext_t uc;                /* the ucontext that executes the code */
 211 #ifdef HAVE_VALGRIND_VALGRIND_H
 212   unsigned int valgrind_stack_id;       /* the valgrind stack id */
 213 #endif
 214   char stack[0];                /* the thread stack (must remain the last element of the structure) */
 215 } s_smx_ctx_sysv_t, *smx_ctx_sysv_t;
 216
 217 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
 218 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
 219 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
 220
 221 /* ****************************** */
 222 /* context manipulation functions */
 223 /* ****************************** */
 224
 225 /* Scenario for the end of a context:
 226  *
 227  * CASE 1: death after end of the main function
 228  *   the context_wrapper, called internally by the context module, calls
 229  *   SIMIX_context_stop after user code stops, smx_context_stop calls user
 230  *   cleanup_func if any (in context settings), add current process to trashbin
 231  *   and yields back to maestro.
 232  *   From time to time, maestro calls SIMIX_context_empty_trash, which destroy
 233  *   all the process and context data structures, and frees the memory
 234  *
 235  * CASE 2: brutal death
 236  *   SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
 237  *   schedules the process. Then the process is awaken in the middle of the
 238  *   SIMIX_process_yield function, and at the end of it, it checks that
 239  *   iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
 240  */
 241
 242 /**
 243  * \brief creates a new context for a user level process
 244  * \param code a main function
 245  * \param argc the number of arguments of the main function
 246  * \param argv the vector of arguments of the main function
 247  * \param cleanup_func the function to call when the context stops
 248  * \param cleanup_arg the argument of the cleanup_func function
 249  */
 250 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
 251                                                   int argc, char **argv,
 252                                                   void_pfn_smxprocess_t cleanup_func,
 253                                                   smx_process_t simix_process)
 254 {
 255
 256   return simix_global->context_factory->create_context(code,
 257                                                        argc, argv,
 258                                                        cleanup_func,
 259                                                        simix_process);
 260 }
 261
 262 /**
 263  * \brief destroy a context
 264  * \param context the context to destroy
 265  * Argument must be stopped first -- runs in maestro context
 266  */
 267 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
 268 {
 269   simix_global->context_factory->free(context);
 270 }
 271
 272 /**
 273  * \brief stops the execution of a context
 274  * \param context to stop
 275  */
 276 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
 277 {
 278   simix_global->context_factory->stop(context);
 279 }
 280
 281 /**
 282  \brief suspends a context and return the control back to the one which
 283         scheduled it
 284  \param context the context to be suspended (it must be the running one)
 285  */
 286 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
 287 {
 288   simix_global->context_factory->suspend(context);
 289 }
 290
 291 /**
 292  \brief Executes all the processes to run (in parallel if possible).
 293  */
 294 static XBT_INLINE void SIMIX_context_runall(void)
 295 {
 296   simix_global->context_factory->runall();
 297 }
 298
 299 /**
 300  \brief returns the current running context
 301  */
 302 static XBT_INLINE smx_context_t SIMIX_context_self(void)
 303 {
 304   if (simix_global && simix_global->context_factory) {
 305     return simix_global->context_factory->self();
 306   }
 307
 308   return NULL;
 309 }
 310
 311 /**
 312  \brief returns the data associated to a context
 313  \param context The context
 314  \return The data
 315  */
 316 static XBT_INLINE void* SIMIX_context_get_data(smx_context_t context)
 317 {
 318   return simix_global->context_factory->get_data(context);
 319 }
 320
 321 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
 322
 323 void SIMIX_post_create_environment(void);
 324
 325 #endif