src/simix/smx_private.h

   1 /* Copyright (c) 2007-2010, 2012-2014. 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/fifo.h"
  13 #include "xbt/swag.h"
  14 #include "xbt/dict.h"
  15 #include "xbt/mallocator.h"
  16 #include "xbt/config.h"
  17 #include "xbt/xbt_os_time.h"
  18 #include "xbt/function_types.h"
  19 #include "xbt/ex_interface.h"
  20 #include "instr/instr_private.h"
  21 #include "smx_process_private.h"
  22 #include "smx_host_private.h"
  23 #include "smx_io_private.h"
  24 #include "smx_network_private.h"
  25 #include "smx_smurf_private.h"
  26 #include "smx_synchro_private.h"
  27 /* ****************************************************************************************** */
  28 /* TUTORIAL: New API                                                                        */
  29 /* ****************************************************************************************** */
  30 #include "smx_new_api_private.h"
  31
  32 /* Define only for SimGrid benchmarking purposes */
  33 //#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 */
  34 //#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). */
  35
  36 #ifdef TIME_BENCH_PER_SR
  37 void smx_ctx_raw_new_sr(void);
  38 #endif
  39 /********************************** Simix Global ******************************/
  40 typedef struct s_smx_global {
  41   smx_context_factory_t context_factory;
  42   xbt_dynar_t process_to_run;
  43   xbt_dynar_t process_that_ran;
  44   xbt_swag_t process_list;
  45   xbt_swag_t process_to_destroy;
  46   smx_process_t maestro_process;
  47   xbt_dict_t registered_functions;
  48   smx_creation_func_t create_process_function;
  49   void_pfn_smxprocess_t_smxprocess_t kill_process_function;
  50   void_pfn_smxprocess_t cleanup_process_function;
  51   xbt_mallocator_t action_mallocator;
  52   void_pfn_smxhost_t autorestart;
  53
  54 #ifdef TIME_BENCH_AMDAHL
  55   xbt_os_timer_t timer_seq; /* used to bench the sequential and parallel parts of the simulation, if requested to */
  56   xbt_os_timer_t timer_par;
  57 #endif
  58 } s_smx_global_t, *smx_global_t;
  59
  60 extern smx_global_t simix_global;
  61 extern unsigned long simix_process_maxpid;
  62
  63 extern xbt_dict_t watched_hosts_lib;
  64
  65 #ifdef __cplusplus
  66 extern "C" {
  67 #endif
  68 XBT_PUBLIC(void) SIMIX_clean(void);
  69 #ifdef __cplusplus
  70 }
  71 #endif
  72
  73 /******************************** Exceptions *********************************/
  74 /** @brief Ask to the provided simix process to raise the provided exception */
  75 #define SMX_EXCEPTION(issuer, cat, val, msg)                            \
  76   if (1) {                                                              \
  77     smx_process_t _smx_throw_issuer = (issuer); /* evaluate only once */\
  78     THROW_PREPARE(_smx_throw_issuer->running_ctx, (cat), (val), xbt_strdup(msg)); \
  79     _smx_throw_issuer->doexception = 1;                                 \
  80   } else ((void)0)
  81
  82 #define SMX_THROW() RETHROW
  83
  84 /* ******************************** File ************************************ */
  85 typedef struct s_smx_file {
  86   surf_file_t surf_file;
  87   void* data;                   /**< @brief user data */
  88 } s_smx_file_t;
  89
  90 /*********************************** Time ************************************/
  91
  92 /** @brief Timer datatype */
  93 typedef struct s_smx_timer {
  94   double date;
  95   void* func;
  96   void* args;
  97 } s_smx_timer_t;
  98
  99 /********************************* Action *************************************/
 100
 101 typedef enum {
 102   SIMIX_ACTION_EXECUTE,
 103   SIMIX_ACTION_PARALLEL_EXECUTE,
 104   SIMIX_ACTION_COMMUNICATE,
 105   SIMIX_ACTION_JOIN,
 106   SIMIX_ACTION_SLEEP,
 107   SIMIX_ACTION_SYNCHRO,
 108   SIMIX_ACTION_IO,
 109   /* ****************************************************************************************** */
 110   /* TUTORIAL: New API                                                                        */
 111   /* ****************************************************************************************** */
 112   SIMIX_ACTION_NEW_API
 113 } e_smx_action_type_t;
 114
 115 typedef enum {
 116   SIMIX_COMM_SEND,
 117   SIMIX_COMM_RECEIVE,
 118   SIMIX_COMM_READY,
 119   SIMIX_COMM_DONE
 120 } e_smx_comm_type_t;
 121
 122 typedef enum {
 123   SIMIX_IO_OPEN,
 124   SIMIX_IO_WRITE,
 125   SIMIX_IO_READ,
 126   SIMIX_IO_STAT
 127 } e_smx_io_type_t;
 128
 129 /** @brief Action datatype */
 130 typedef struct s_smx_action {
 131
 132   e_smx_action_type_t type;          /* Type of SIMIX action*/
 133   e_smx_state_t state;               /* State of the action */
 134   char *name;                        /* Action name if any */
 135   xbt_fifo_t simcalls;               /* List of simcalls waiting for this action */
 136
 137   /* Data specific to each action type */
 138   union {
 139
 140     struct {
 141       smx_host_t host;                /* The host where the execution takes place */
 142       surf_action_t surf_exec;        /* The Surf execution action encapsulated */
 143     } execution; /* Possibly parallel execution */
 144
 145     struct {
 146       e_smx_comm_type_t type;         /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
 147       smx_rdv_t rdv;                  /* Rendez-vous where the comm is queued */
 148
 149 #ifdef HAVE_MC
 150       smx_rdv_t rdv_cpy;              /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
 151                                          (comm.rdv set to NULL when the communication is removed from the mailbox
 152                                          (used as garbage collector)) */
 153 #endif
 154       int refcount;                   /* Number of processes involved in the cond */
 155       int detached;                   /* If detached or not */
 156
 157       void (*clean_fun)(void*);       /* Function to clean the detached src_buf if something goes wrong */
 158       int (*match_fun)(void*,void*,smx_action_t);  /* Filter function used by the other side. It is used when
 159                                          looking if a given communication matches my needs. For that, myself must match the
 160                                          expectations of the other side, too. See  */
 161       void (*copy_data_fun) (smx_action_t, void*, size_t);
 162
 163       /* Surf action data */
 164       surf_action_t surf_comm;        /* The Surf communication action encapsulated */
 165       surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
 166       surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
 167       smx_process_t src_proc;
 168       smx_process_t dst_proc;
 169       double rate;
 170       double task_size;
 171
 172       /* Data to be transfered */
 173       void *src_buff;
 174       void *dst_buff;
 175       size_t src_buff_size;
 176       size_t *dst_buff_size;
 177       unsigned copied:1;              /* whether the data were already copied */
 178
 179       void* src_data;                 /* User data associated to communication */
 180       void* dst_data;
 181     } comm;
 182
 183     struct {
 184       smx_host_t host;                /* The host that is sleeping */
 185       surf_action_t surf_sleep;       /* The Surf sleeping action encapsulated */
 186     } sleep;
 187
 188     struct {
 189       surf_action_t sleep;
 190     } synchro;
 191
 192     struct {
 193       smx_host_t host;
 194       surf_action_t surf_io;
 195     } io;
 196
 197     /* ****************************************************************************************** */
 198     /* TUTORIAL: New API                                                                        */
 199     /* ****************************************************************************************** */
 200     struct {
 201       surf_action_t surf_new_api;
 202     } new_api;
 203   };
 204
 205 #ifdef HAVE_LATENCY_BOUND_TRACKING
 206   int latency_limited;
 207 #endif
 208
 209 #ifdef HAVE_TRACING
 210   char *category;                     /* simix action category for instrumentation */
 211 #endif
 212 } s_smx_action_t;
 213
 214 void SIMIX_context_mod_init(void);
 215 void SIMIX_context_mod_exit(void);
 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 void *SIMIX_context_stack_new(void);
 232 void SIMIX_context_stack_delete(void *stack);
 233
 234 void SIMIX_context_set_current(smx_context_t context);
 235 smx_context_t SIMIX_context_get_current(void);
 236
 237 /* All factories init */
 238
 239 void SIMIX_ctx_thread_factory_init(smx_context_factory_t *factory);
 240 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory);
 241 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory);
 242
 243 /* ****************************** */
 244 /* context manipulation functions */
 245 /* ****************************** */
 246
 247 /* Scenario for the end of a context:
 248  *
 249  * CASE 1: death after end of the main function
 250  *   the context_wrapper, called internally by the context module, calls
 251  *   SIMIX_context_stop after user code stops, smx_context_stop calls user
 252  *   cleanup_func if any (in context settings), add current process to trashbin
 253  *   and yields back to maestro.
 254  *   From time to time, maestro calls SIMIX_context_empty_trash, which destroy
 255  *   all the process and context data structures, and frees the memory
 256  *
 257  * CASE 2: brutal death
 258  *   SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
 259  *   schedules the process. Then the process is awaken in the middle of the
 260  *   SIMIX_process_yield function, and at the end of it, it checks that
 261  *   iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
 262  */
 263
 264 /**
 265  * \brief creates a new context for a user level process
 266  * \param code a main function
 267  * \param argc the number of arguments of the main function
 268  * \param argv the vector of arguments of the main function
 269  * \param cleanup_func the function to call when the context stops
 270  * \param cleanup_arg the argument of the cleanup_func function
 271  */
 272 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
 273                                                   int argc, char **argv,
 274                                                   void_pfn_smxprocess_t cleanup_func,
 275                                                   smx_process_t simix_process)
 276 {
 277   if (!simix_global)
 278     xbt_die("simix is not initialized, please call MSG_init first");
 279   return simix_global->context_factory->create_context(code,
 280                                                        argc, argv,
 281                                                        cleanup_func,
 282                                                        simix_process);
 283 }
 284
 285 /**
 286  * \brief destroy a context
 287  * \param context the context to destroy
 288  * Argument must be stopped first -- runs in maestro context
 289  */
 290 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
 291 {
 292   simix_global->context_factory->free(context);
 293 }
 294
 295 /**
 296  * \brief stops the execution of a context
 297  * \param context to stop
 298  */
 299 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
 300 {
 301   simix_global->context_factory->stop(context);
 302 }
 303
 304 /**
 305  \brief suspends a context and return the control back to the one which
 306         scheduled it
 307  \param context the context to be suspended (it must be the running one)
 308  */
 309 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
 310 {
 311   simix_global->context_factory->suspend(context);
 312 }
 313
 314 /**
 315  \brief Executes all the processes to run (in parallel if possible).
 316  */
 317 static XBT_INLINE void SIMIX_context_runall(void)
 318 {
 319   if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
 320     simix_global->context_factory->runall();
 321   }
 322 }
 323
 324 /**
 325  \brief returns the current running context
 326  */
 327 static XBT_INLINE smx_context_t SIMIX_context_self(void)
 328 {
 329   if (simix_global && simix_global->context_factory) {
 330     return simix_global->context_factory->self();
 331   }
 332   return NULL;
 333 }
 334
 335 /**
 336  \brief returns the SIMIX process associated to a context
 337  \param context The context
 338  \return The SIMIX process
 339  */
 340 static XBT_INLINE smx_process_t SIMIX_context_get_process(smx_context_t context)
 341 {
 342   return simix_global->context_factory->get_process(context);
 343 }
 344
 345 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
 346
 347 void SIMIX_post_create_environment(void);
 348
 349 #endif