src/simix/smx_private.h

   1 /* Copyright (c) 2007-2010, 2012-2015. 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 "popping_private.h"
  26 #include "smx_synchro_private.h"
  27
  28 SG_BEGIN_DECL()
  29
  30 /* Define only for SimGrid benchmarking purposes */
  31 //#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 */
  32 //#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). */
  33 //#define ADAPTIVE_THRESHOLD    /* this is to enable the adaptive threshold algorithm in raw contexts*/
  34 //#define TIME_BENCH_ENTIRE_SRS /* more general benchmark than TIME_BENCH_PER_SR. It aims to measure the total time spent in a whole scheduling round (including synchro costs)*/
  35
  36 #ifdef TIME_BENCH_PER_SR
  37 void smx_ctx_raw_new_sr(void);
  38 #endif
  39 /********************************** Simix Global ******************************/
  40 typedef struct s_smx_global {
  41   smx_context_factory_t context_factory;
  42   xbt_dynar_t process_to_run;
  43   xbt_dynar_t process_that_ran;
  44   xbt_swag_t process_list;
  45   xbt_swag_t process_to_destroy;
  46   smx_process_t maestro_process;
  47   xbt_dict_t registered_functions;
  48   smx_creation_func_t create_process_function;
  49   void_pfn_smxprocess_t_smxprocess_t kill_process_function;
  50   /** Callback used when killing a SMX_process */
  51   void_pfn_smxprocess_t cleanup_process_function;
  52   xbt_mallocator_t synchro_mallocator;
  53   void_pfn_sghost_t autorestart;
  54
  55 #ifdef TIME_BENCH_AMDAHL
  56   xbt_os_timer_t timer_seq; /* used to bench the sequential and parallel parts of the simulation, if requested to */
  57   xbt_os_timer_t timer_par;
  58 #endif
  59
  60   xbt_os_mutex_t mutex;
  61 } s_smx_global_t, *smx_global_t;
  62
  63 XBT_PUBLIC_DATA(smx_global_t) simix_global;
  64 extern unsigned long simix_process_maxpid;
  65
  66 XBT_PUBLIC(void) SIMIX_clean(void);
  67
  68 /******************************** Exceptions *********************************/
  69 /** @brief Ask to the provided simix process to raise the provided exception */
  70 #define SMX_EXCEPTION(issuer, cat, val, msg)                            \
  71   if (1) {                                                              \
  72     smx_process_t _smx_throw_issuer = (issuer); /* evaluate only once */\
  73     THROW_PREPARE(_smx_throw_issuer->running_ctx, (cat), (val), xbt_strdup(msg)); \
  74     _smx_throw_issuer->doexception = 1;                                 \
  75   } else ((void)0)
  76
  77 #define SMX_THROW() RETHROW
  78
  79 /* ******************************** File ************************************ */
  80 typedef struct s_smx_file {
  81   surf_file_t surf_file;
  82   void* data;                   /**< @brief user data */
  83 } s_smx_file_t;
  84
  85 /*********************************** Time ************************************/
  86
  87 /** @brief Timer datatype */
  88 typedef struct s_smx_timer {
  89   double date;
  90   void* func;
  91   void* args;
  92 } s_smx_timer_t;
  93
  94 /********************************* synchro *************************************/
  95
  96 typedef enum {
  97   SIMIX_SYNC_EXECUTE,
  98   SIMIX_SYNC_PARALLEL_EXECUTE,
  99   SIMIX_SYNC_COMMUNICATE,
 100   SIMIX_SYNC_JOIN,
 101   SIMIX_SYNC_SLEEP,
 102   SIMIX_SYNC_SYNCHRO,
 103   SIMIX_SYNC_IO,
 104 } e_smx_synchro_type_t;
 105
 106 typedef enum {
 107   SIMIX_COMM_SEND,
 108   SIMIX_COMM_RECEIVE,
 109   SIMIX_COMM_READY,
 110   SIMIX_COMM_DONE
 111 } e_smx_comm_type_t;
 112
 113 typedef enum {
 114   SIMIX_IO_OPEN,
 115   SIMIX_IO_WRITE,
 116   SIMIX_IO_READ,
 117   SIMIX_IO_STAT
 118 } e_smx_io_type_t;
 119
 120 /** @brief synchro datatype */
 121 typedef struct s_smx_synchro {
 122
 123   e_smx_synchro_type_t type;          /* Type of SIMIX synchro */
 124   e_smx_state_t state;               /* State of the synchro */
 125   char *name;                        /* synchro name if any */
 126   xbt_fifo_t simcalls;               /* List of simcalls waiting for this synchro */
 127
 128   /* Data specific to each synchro type */
 129   union {
 130
 131     struct {
 132       sg_host_t host;                /* The host where the execution takes place */
 133       surf_action_t surf_exec;        /* The Surf execution action encapsulated */
 134     } execution; /* Possibly parallel execution */
 135
 136     struct {
 137       e_smx_comm_type_t type;         /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
 138       smx_rdv_t rdv;                  /* Rendez-vous where the comm is queued */
 139
 140 #ifdef HAVE_MC
 141       smx_rdv_t rdv_cpy;              /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
 142                                          (comm.rdv set to NULL when the communication is removed from the mailbox
 143                                          (used as garbage collector)) */
 144 #endif
 145       int refcount;                   /* Number of processes involved in the cond */
 146       int detached;                   /* If detached or not */
 147
 148       void (*clean_fun)(void*);       /* Function to clean the detached src_buf if something goes wrong */
 149       int (*match_fun)(void*,void*,smx_synchro_t);  /* Filter function used by the other side. It is used when
 150                                          looking if a given communication matches my needs. For that, myself must match the
 151                                          expectations of the other side, too. See  */
 152       void (*copy_data_fun) (smx_synchro_t, void*, size_t);
 153
 154       /* Surf action data */
 155       surf_action_t surf_comm;        /* The Surf communication action encapsulated */
 156       surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
 157       surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
 158       smx_process_t src_proc;
 159       smx_process_t dst_proc;
 160       double rate;
 161       double task_size;
 162
 163       /* Data to be transfered */
 164       void *src_buff;
 165       void *dst_buff;
 166       size_t src_buff_size;
 167       size_t *dst_buff_size;
 168       unsigned copied:1;              /* whether the data were already copied */
 169
 170       void* src_data;                 /* User data associated to communication */
 171       void* dst_data;
 172     } comm;
 173
 174     struct {
 175       sg_host_t host;                /* The host that is sleeping */
 176       surf_action_t surf_sleep;       /* The Surf sleeping action encapsulated */
 177     } sleep;
 178
 179     struct {
 180       surf_action_t sleep;
 181     } synchro;
 182
 183     struct {
 184       sg_host_t host;
 185       surf_action_t surf_io;
 186     } io;
 187   };
 188
 189 #ifdef HAVE_LATENCY_BOUND_TRACKING
 190   int latency_limited;
 191 #endif
 192
 193   char *category;                     /* simix action category for instrumentation */
 194 } s_smx_synchro_t;
 195
 196 void SIMIX_context_mod_init(void);
 197 void SIMIX_context_mod_exit(void);
 198
 199 #ifndef WIN32
 200 XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
 201 #endif
 202
 203 /* We are using the bottom of the stack to save some information, like the
 204  * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
 205  * size for the stack. */
 206 #ifdef HAVE_VALGRIND_VALGRIND_H
 207 # define smx_context_usable_stack_size                                  \
 208   (smx_context_stack_size - sizeof(unsigned int)) /* for valgrind_stack_id */
 209 #else
 210 # define smx_context_usable_stack_size smx_context_stack_size
 211 #endif
 212
 213 void *SIMIX_context_stack_new(void);
 214 void SIMIX_context_stack_delete(void *stack);
 215
 216 void SIMIX_context_set_current(smx_context_t context);
 217 smx_context_t SIMIX_context_get_current(void);
 218
 219 /* All factories init */
 220
 221 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
 222 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
 223 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
 224 void SIMIX_ctx_boost_factory_init(smx_context_factory_t *factory);
 225
 226 /* ****************************** */
 227 /* context manipulation functions */
 228 /* ****************************** */
 229
 230 /* Scenario for the end of a context:
 231  *
 232  * CASE 1: death after end of the main function
 233  *   the context_wrapper, called internally by the context module, calls
 234  *   SIMIX_context_stop after user code stops, smx_context_stop calls user
 235  *   cleanup_func if any (in context settings), add current process to trashbin
 236  *   and yields back to maestro.
 237  *   From time to time, maestro calls SIMIX_context_empty_trash, which destroy
 238  *   all the process and context data structures, and frees the memory
 239  *
 240  * CASE 2: brutal death
 241  *   SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
 242  *   schedules the process. Then the process is awaken in the middle of the
 243  *   SIMIX_process_yield function, and at the end of it, it checks that
 244  *   iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
 245  */
 246
 247 /**
 248  * \brief creates a new context for a user level process
 249  * \param code a main function
 250  * \param argc the number of arguments of the main function
 251  * \param argv the vector of arguments of the main function
 252  * \param cleanup_func the function to call when the context stops
 253  * \param cleanup_arg the argument of the cleanup_func function
 254  */
 255 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
 256                                                   int argc, char **argv,
 257                                                   void_pfn_smxprocess_t cleanup_func,
 258                                                   smx_process_t simix_process)
 259 {
 260   if (!simix_global)
 261     xbt_die("simix is not initialized, please call MSG_init first");
 262   return simix_global->context_factory->create_context(code,
 263                                                        argc, argv,
 264                                                        cleanup_func,
 265                                                        simix_process);
 266 }
 267
 268 /**
 269  * \brief destroy a context
 270  * \param context the context to destroy
 271  * Argument must be stopped first -- runs in maestro context
 272  */
 273 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
 274 {
 275   simix_global->context_factory->free(context);
 276 }
 277
 278 /**
 279  * \brief stops the execution of a context
 280  * \param context to stop
 281  */
 282 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
 283 {
 284   simix_global->context_factory->stop(context);
 285 }
 286
 287 /**
 288  \brief suspends a context and return the control back to the one which
 289         scheduled it
 290  \param context the context to be suspended (it must be the running one)
 291  */
 292 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
 293 {
 294   simix_global->context_factory->suspend(context);
 295 }
 296
 297 /**
 298  \brief Executes all the processes to run (in parallel if possible).
 299  */
 300 static XBT_INLINE void SIMIX_context_runall(void)
 301 {
 302   if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
 303     simix_global->context_factory->runall();
 304   }
 305 }
 306
 307 /**
 308  \brief returns the current running context
 309  */
 310 static XBT_INLINE smx_context_t SIMIX_context_self(void)
 311 {
 312   if (simix_global && simix_global->context_factory) {
 313     return simix_global->context_factory->self();
 314   }
 315   return NULL;
 316 }
 317
 318 /**
 319  \brief returns the SIMIX process associated to a context
 320  \param context The context
 321  \return The SIMIX process
 322  */
 323 static XBT_INLINE smx_process_t SIMIX_context_get_process(smx_context_t context)
 324 {
 325   return simix_global->context_factory->get_process(context);
 326 }
 327
 328 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
 329
 330 void SIMIX_post_create_environment(void);
 331
 332 SG_END_DECL()
 333
 334 #endif