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