src/simix/smx_private.h

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