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