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