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