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 "src/xbt/ex_interface.h"
  21 #include "src/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 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 /********************************* synchro *************************************/
  87
  88 typedef enum {
  89   SIMIX_SYNC_EXECUTE,
  90   SIMIX_SYNC_PARALLEL_EXECUTE,
  91   SIMIX_SYNC_COMMUNICATE,
  92   SIMIX_SYNC_JOIN,
  93   SIMIX_SYNC_SLEEP,
  94   SIMIX_SYNC_SYNCHRO,
  95   SIMIX_SYNC_IO,
  96 } e_smx_synchro_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 synchro datatype */
 113 typedef struct s_smx_synchro {
 114
 115   e_smx_synchro_type_t type;          /* Type of SIMIX synchro */
 116   e_smx_state_t state;               /* State of the synchro */
 117   char *name;                        /* synchro name if any */
 118   xbt_fifo_t simcalls;               /* List of simcalls waiting for this synchro */
 119
 120   /* Data specific to each synchro type */
 121   union {
 122
 123     struct {
 124       sg_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
 132 #ifdef HAVE_MC
 133       smx_rdv_t rdv_cpy;              /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
 134                                          (comm.rdv set to NULL when the communication is removed from the mailbox
 135                                          (used as garbage collector)) */
 136 #endif
 137       int refcount;                   /* Number of processes involved in the cond */
 138       int detached;                   /* If detached or not */
 139
 140       void (*clean_fun)(void*);       /* Function to clean the detached src_buf if something goes wrong */
 141       int (*match_fun)(void*,void*,smx_synchro_t);  /* Filter function used by the other side. It is used when
 142                                          looking if a given communication matches my needs. For that, myself must match the
 143                                          expectations of the other side, too. See  */
 144       void (*copy_data_fun) (smx_synchro_t, void*, size_t);
 145
 146       /* Surf action data */
 147       surf_action_t surf_comm;        /* The Surf communication action encapsulated */
 148       surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
 149       surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
 150       smx_process_t src_proc;
 151       smx_process_t dst_proc;
 152       double rate;
 153       double task_size;
 154
 155       /* Data to be transfered */
 156       void *src_buff;
 157       void *dst_buff;
 158       size_t src_buff_size;
 159       size_t *dst_buff_size;
 160       unsigned copied:1;              /* whether the data were already copied */
 161
 162       void* src_data;                 /* User data associated to communication */
 163       void* dst_data;
 164     } comm;
 165
 166     struct {
 167       sg_host_t host;                /* The host that is sleeping */
 168       surf_action_t surf_sleep;       /* The Surf sleeping action encapsulated */
 169     } sleep;
 170
 171     struct {
 172       surf_action_t sleep;
 173     } synchro;
 174
 175     struct {
 176       sg_host_t host;
 177       surf_action_t surf_io;
 178     } io;
 179   };
 180
 181 #ifdef HAVE_LATENCY_BOUND_TRACKING
 182   int latency_limited;
 183 #endif
 184
 185   char *category;                     /* simix action category for instrumentation */
 186 } s_smx_synchro_t;
 187
 188 XBT_PRIVATE void SIMIX_context_mod_init(void);
 189 XBT_PRIVATE void SIMIX_context_mod_exit(void);
 190
 191 #ifndef WIN32
 192 XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
 193 #endif
 194
 195 /* We are using the bottom of the stack to save some information, like the
 196  * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
 197  * size for the stack. */
 198 #ifdef HAVE_VALGRIND_VALGRIND_H
 199 # define smx_context_usable_stack_size                                  \
 200   (smx_context_stack_size - sizeof(unsigned int)) /* for valgrind_stack_id */
 201 #else
 202 # define smx_context_usable_stack_size smx_context_stack_size
 203 #endif
 204
 205 XBT_PRIVATE void *SIMIX_context_stack_new(void);
 206 XBT_PRIVATE void SIMIX_context_stack_delete(void *stack);
 207
 208 XBT_PRIVATE void SIMIX_context_set_current(smx_context_t context);
 209 XBT_PRIVATE smx_context_t SIMIX_context_get_current(void);
 210
 211 /* All factories init */
 212
 213 XBT_PRIVATE void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
 214 XBT_PRIVATE void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
 215 XBT_PRIVATE void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
 216 XBT_PRIVATE void SIMIX_ctx_boost_factory_init(smx_context_factory_t *factory);
 217
 218 /* ****************************** */
 219 /* context manipulation functions */
 220 /* ****************************** */
 221
 222 /* Scenario for the end of a context:
 223  *
 224  * CASE 1: death after end of the main function
 225  *   the context_wrapper, called internally by the context module, calls
 226  *   SIMIX_context_stop after user code stops, smx_context_stop calls user
 227  *   cleanup_func if any (in context settings), add current process to trashbin
 228  *   and yields back to maestro.
 229  *   From time to time, maestro calls SIMIX_context_empty_trash, which destroy
 230  *   all the process and context data structures, and frees the memory
 231  *
 232  * CASE 2: brutal death
 233  *   SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
 234  *   schedules the process. Then the process is awaken in the middle of the
 235  *   SIMIX_process_yield function, and at the end of it, it checks that
 236  *   iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
 237  */
 238
 239 /**
 240  * \brief creates a new context for a user level process
 241  * \param code a main function
 242  * \param argc the number of arguments of the main function
 243  * \param argv the vector of arguments of the main function
 244  * \param cleanup_func the function to call when the context stops
 245  * \param cleanup_arg the argument of the cleanup_func function
 246  */
 247 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
 248                                                   int argc, char **argv,
 249                                                   void_pfn_smxprocess_t cleanup_func,
 250                                                   smx_process_t simix_process)
 251 {
 252   if (!simix_global)
 253     xbt_die("simix is not initialized, please call MSG_init first");
 254   return simix_global->context_factory->create_context(code,
 255                                                        argc, argv,
 256                                                        cleanup_func,
 257                                                        simix_process);
 258 }
 259
 260 /**
 261  * \brief destroy a context
 262  * \param context the context to destroy
 263  * Argument must be stopped first -- runs in maestro context
 264  */
 265 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
 266 {
 267   simix_global->context_factory->free(context);
 268 }
 269
 270 /**
 271  * \brief stops the execution of a context
 272  * \param context to stop
 273  */
 274 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
 275 {
 276   simix_global->context_factory->stop(context);
 277 }
 278
 279 /**
 280  \brief suspends a context and return the control back to the one which
 281         scheduled it
 282  \param context the context to be suspended (it must be the running one)
 283  */
 284 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
 285 {
 286   simix_global->context_factory->suspend(context);
 287 }
 288
 289 /**
 290  \brief Executes all the processes to run (in parallel if possible).
 291  */
 292 static XBT_INLINE void SIMIX_context_runall(void)
 293 {
 294   if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
 295     simix_global->context_factory->runall();
 296   }
 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   return NULL;
 308 }
 309
 310 /**
 311  \brief returns the SIMIX process associated to a context
 312  \param context The context
 313  \return The SIMIX process
 314  */
 315 static XBT_INLINE smx_process_t SIMIX_context_get_process(smx_context_t context)
 316 {
 317   return simix_global->context_factory->get_process(context);
 318 }
 319
 320 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
 321
 322 XBT_PRIVATE void SIMIX_post_create_environment(void);
 323
 324 SG_END_DECL()
 325
 326 #endif