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