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