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