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 #ifdef __cplusplus
  30
  31 #include <simgrid/simix.hpp>
  32
  33 namespace simgrid {
  34 namespace simix {
  35
  36 /* Hack: let msg load directly the right factory
  37  *
  38  * This is a factory of factory! How nice is this?
  39  */
  40 typedef ContextFactory* (*ContextFactoryInitializer)(void);
  41 XBT_PUBLIC_DATA(ContextFactoryInitializer) factory_initializer;
  42
  43 }
  44 }
  45
  46 typedef simgrid::simix::ContextFactory *smx_context_factory_t;
  47
  48 #else
  49
  50 typedef struct s_smx_context_factory *smx_context_factory_t;
  51
  52 #endif
  53
  54 SG_BEGIN_DECL()
  55
  56 /* Define only for SimGrid benchmarking purposes */
  57 //#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 */
  58 //#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). */
  59 //#define ADAPTIVE_THRESHOLD    /* this is to enable the adaptive threshold algorithm in raw contexts*/
  60 //#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)*/
  61
  62 #ifdef TIME_BENCH_PER_SR
  63 XBT_PRIVATE void smx_ctx_raw_new_sr(void);
  64 #endif
  65
  66 /********************************** Simix Global ******************************/
  67 typedef struct s_smx_global {
  68   smx_context_factory_t context_factory;
  69   xbt_dynar_t process_to_run;
  70   xbt_dynar_t process_that_ran;
  71   xbt_swag_t process_list;
  72   xbt_swag_t process_to_destroy;
  73   smx_process_t maestro_process;
  74   xbt_dict_t registered_functions;
  75   smx_creation_func_t create_process_function;
  76   void_pfn_smxprocess_t kill_process_function;
  77   /** Callback used when killing a SMX_process */
  78   void_pfn_smxprocess_t cleanup_process_function;
  79   xbt_mallocator_t synchro_mallocator;
  80   void_pfn_sghost_t autorestart;
  81
  82 #ifdef TIME_BENCH_AMDAHL
  83   xbt_os_timer_t timer_seq; /* used to bench the sequential and parallel parts of the simulation, if requested to */
  84   xbt_os_timer_t timer_par;
  85 #endif
  86
  87   xbt_os_mutex_t mutex;
  88 } s_smx_global_t, *smx_global_t;
  89
  90 XBT_PUBLIC_DATA(smx_global_t) simix_global;
  91 extern XBT_PRIVATE unsigned long simix_process_maxpid;
  92
  93 XBT_PUBLIC(void) SIMIX_clean(void);
  94
  95 /******************************** Exceptions *********************************/
  96 /** @brief Ask to the provided simix process to raise the provided exception */
  97 #define SMX_EXCEPTION(issuer, cat, val, msg)                            \
  98   if (1) {                                                              \
  99     smx_process_t _smx_throw_issuer = (issuer); /* evaluate only once */\
 100     THROW_PREPARE(_smx_throw_issuer->running_ctx, (cat), (val), xbt_strdup(msg)); \
 101     _smx_throw_issuer->doexception = 1;                                 \
 102   } else ((void)0)
 103
 104 #define SMX_THROW() RETHROW
 105
 106 /* ******************************** File ************************************ */
 107 typedef struct s_smx_file {
 108   surf_file_t surf_file;
 109   void* data;                   /**< @brief user data */
 110 } s_smx_file_t;
 111
 112 /********************************* synchro *************************************/
 113
 114 typedef enum {
 115   SIMIX_SYNC_EXECUTE,
 116   SIMIX_SYNC_PARALLEL_EXECUTE,
 117   SIMIX_SYNC_COMMUNICATE,
 118   SIMIX_SYNC_JOIN,
 119   SIMIX_SYNC_SLEEP,
 120   SIMIX_SYNC_SYNCHRO,
 121   SIMIX_SYNC_IO,
 122 } e_smx_synchro_type_t;
 123
 124 typedef enum {
 125   SIMIX_COMM_SEND,
 126   SIMIX_COMM_RECEIVE,
 127   SIMIX_COMM_READY,
 128   SIMIX_COMM_DONE
 129 } e_smx_comm_type_t;
 130
 131 typedef enum {
 132   SIMIX_IO_OPEN,
 133   SIMIX_IO_WRITE,
 134   SIMIX_IO_READ,
 135   SIMIX_IO_STAT
 136 } e_smx_io_type_t;
 137
 138 /** @brief synchro datatype */
 139 typedef struct s_smx_synchro {
 140
 141   e_smx_synchro_type_t type;          /* Type of SIMIX synchro */
 142   e_smx_state_t state;               /* State of the synchro */
 143   char *name;                        /* synchro name if any */
 144   xbt_fifo_t simcalls;               /* List of simcalls waiting for this synchro */
 145
 146   /* Data specific to each synchro type */
 147   union {
 148
 149     struct {
 150       sg_host_t host;                /* The host where the execution takes place */
 151       surf_action_t surf_exec;        /* The Surf execution action encapsulated */
 152     } execution; /* Possibly parallel execution */
 153
 154     struct {
 155       e_smx_comm_type_t type;         /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
 156       smx_rdv_t rdv;                  /* Rendez-vous where the comm is queued */
 157
 158 #ifdef HAVE_MC
 159       smx_rdv_t rdv_cpy;              /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
 160                                          (comm.rdv set to NULL when the communication is removed from the mailbox
 161                                          (used as garbage collector)) */
 162 #endif
 163       int refcount;                   /* Number of processes involved in the cond */
 164       int detached;                   /* If detached or not */
 165
 166       void (*clean_fun)(void*);       /* Function to clean the detached src_buf if something goes wrong */
 167       int (*match_fun)(void*,void*,smx_synchro_t);  /* Filter function used by the other side. It is used when
 168                                          looking if a given communication matches my needs. For that, myself must match the
 169                                          expectations of the other side, too. See  */
 170       void (*copy_data_fun) (smx_synchro_t, void*, size_t);
 171
 172       /* Surf action data */
 173       surf_action_t surf_comm;        /* The Surf communication action encapsulated */
 174       surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
 175       surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
 176       smx_process_t src_proc;
 177       smx_process_t dst_proc;
 178       double rate;
 179       double task_size;
 180
 181       /* Data to be transfered */
 182       void *src_buff;
 183       void *dst_buff;
 184       size_t src_buff_size;
 185       size_t *dst_buff_size;
 186       unsigned copied:1;              /* whether the data were already copied */
 187
 188       void* src_data;                 /* User data associated to communication */
 189       void* dst_data;
 190     } comm;
 191
 192     struct {
 193       sg_host_t host;                /* The host that is sleeping */
 194       surf_action_t surf_sleep;       /* The Surf sleeping action encapsulated */
 195     } sleep;
 196
 197     struct {
 198       surf_action_t sleep;
 199     } synchro;
 200
 201     struct {
 202       sg_host_t host;
 203       surf_action_t surf_io;
 204     } io;
 205   };
 206
 207 #ifdef HAVE_LATENCY_BOUND_TRACKING
 208   int latency_limited;
 209 #endif
 210
 211   char *category;                     /* simix action category for instrumentation */
 212 } s_smx_synchro_t;
 213
 214 XBT_PRIVATE void SIMIX_context_mod_init(void);
 215 XBT_PRIVATE void SIMIX_context_mod_exit(void);
 216
 217 smx_context_t SIMIX_context_new(
 218   xbt_main_func_t code, int argc, char **argv,
 219   void_pfn_smxprocess_t cleanup_func,
 220   smx_process_t simix_process);
 221
 222 #ifndef WIN32
 223 XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
 224 #endif
 225
 226 /* We are using the bottom of the stack to save some information, like the
 227  * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
 228  * size for the stack. */
 229 #ifdef HAVE_VALGRIND_VALGRIND_H
 230 # define smx_context_usable_stack_size                                  \
 231   (smx_context_stack_size - sizeof(unsigned int)) /* for valgrind_stack_id */
 232 #else
 233 # define smx_context_usable_stack_size smx_context_stack_size
 234 #endif
 235
 236 XBT_PRIVATE void *SIMIX_context_stack_new(void);
 237 XBT_PRIVATE void SIMIX_context_stack_delete(void *stack);
 238
 239 XBT_PRIVATE void SIMIX_context_set_current(smx_context_t context);
 240 XBT_PRIVATE smx_context_t SIMIX_context_get_current(void);
 241
 242 /* ****************************** */
 243 /* context manipulation functions */
 244 /* ****************************** */
 245
 246 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
 247
 248 XBT_PRIVATE void SIMIX_post_create_environment(void);
 249
 250 // FIXME, Dirty hack for SMPI+MSG
 251 XBT_PRIVATE void SIMIX_process_set_cleanup_function(
 252   smx_process_t process, void_pfn_smxprocess_t cleanup);
 253
 254 SG_END_DECL()
 255
 256 #endif