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