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