src/simix/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/config.h"
  16 #include "xbt/function_types.h"
  17 #include "xbt/ex_interface.h"
  18 #include "instr/private.h"
  19 #include "process_private.h"
  20 #include "host_private.h"
  21 #include "network_private.h"
  22 #include "smurf_private.h"
  23 #include "synchro_private.h"
  24
  25 extern int _surf_do_model_check;
  26
  27 /********************************** Simix Global ******************************/
  28
  29 typedef struct s_smx_context_factory *smx_context_factory_t;
  30
  31 typedef struct SIMIX_Global {
  32   smx_context_factory_t context_factory;
  33   xbt_dict_t host;
  34   xbt_swag_t process_to_run;
  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_f_pvoid_t kill_process_function;
  41   void_pfn_smxprocess_t cleanup_process_function;
  42 #ifdef HAVE_LATENCY_BOUND_TRACKING
  43   xbt_dict_t latency_limited_dict;
  44 #endif
  45 } s_SIMIX_Global_t, *SIMIX_Global_t;
  46
  47 extern SIMIX_Global_t simix_global;
  48
  49
  50 /*********************************** Time ************************************/
  51
  52 /** @brief Timer datatype */
  53 typedef struct s_smx_timer {
  54   double date;
  55   void* func;
  56   void* args;
  57 } s_smx_timer_t;
  58
  59 /********************************* Action *************************************/
  60
  61 typedef enum {
  62   SIMIX_ACTION_EXECUTE,
  63   SIMIX_ACTION_PARALLEL_EXECUTE,
  64   SIMIX_ACTION_COMMUNICATE,
  65   SIMIX_ACTION_SLEEP,
  66   SIMIX_ACTION_SYNCHRO,
  67   SIMIX_ACTION_IO
  68 } e_smx_action_type_t;
  69
  70 typedef enum {
  71   SIMIX_COMM_SEND,
  72   SIMIX_COMM_RECEIVE,
  73   SIMIX_COMM_READY,
  74   SIMIX_COMM_DONE
  75 } e_smx_comm_type_t;
  76
  77 /** @brief Action datatype */
  78 typedef struct s_smx_action {
  79
  80   e_smx_action_type_t type;          /* Type of SIMIX action*/
  81   e_smx_state_t state;               /* State of the action */
  82   char *name;                        /* Action name if any */
  83   xbt_fifo_t request_list;           /* List of requests on this action */
  84
  85   /* Data specific to each action type */
  86   union {
  87
  88     struct {
  89       smx_host_t host;                /* The host where the execution takes place */
  90       surf_action_t surf_exec;        /* The Surf execution action encapsulated */
  91     } execution; /* Possibly parallel execution */
  92
  93     struct {
  94       e_smx_comm_type_t type;         /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
  95       smx_rdv_t rdv;                  /* Rendez-vous where the comm is queued */
  96       int refcount;                   /* Number of processes involved in the cond */
  97
  98       /* Surf action data */
  99       surf_action_t surf_comm;        /* The Surf communication action encapsulated */
 100       surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
 101       surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
 102       smx_process_t src_proc;
 103       smx_process_t dst_proc;
 104       double rate;
 105       double task_size;
 106
 107       /* Data to be transfered */
 108       void *src_buff;
 109       void *dst_buff;
 110       size_t src_buff_size;
 111       size_t *dst_buff_size;
 112       char copied;
 113
 114       void *data;                     /* User data associated to communication */
 115     } comm;
 116
 117     struct {
 118       smx_host_t host;                /* The host that is sleeping */
 119       surf_action_t surf_sleep;       /* The Surf sleeping action encapsulated */
 120     } sleep;
 121
 122     struct {
 123       surf_action_t sleep;
 124     } synchro;
 125
 126   };
 127
 128 #ifdef HAVE_TRACING
 129   long long int counter;              /* simix action unique identifier for instrumentation */
 130   char *category;                     /* simix action category for instrumentation */
 131 #endif
 132 } s_smx_action_t;
 133
 134 /* FIXME: check if we can delete this function */
 135 static XBT_INLINE e_smx_state_t SIMIX_action_map_state(e_surf_action_state_t state)
 136 {
 137   switch (state) {
 138     case SURF_ACTION_READY:
 139       return SIMIX_READY;
 140     case SURF_ACTION_RUNNING:
 141       return SIMIX_RUNNING;
 142     case SURF_ACTION_FAILED:
 143       return SIMIX_FAILED;
 144     case SURF_ACTION_DONE:
 145       return SIMIX_DONE;
 146     default:
 147       xbt_die("Unexpected SURF action state");
 148   }
 149 }
 150
 151 /******************************** Context *************************************/
 152
 153 /* The following function pointer types describe the interface that any context
 154    factory should implement */
 155
 156
 157 typedef smx_context_t(*smx_pfn_context_factory_create_context_t)
 158  (xbt_main_func_t, int, char **, void_pfn_smxprocess_t, void* data);
 159 typedef int (*smx_pfn_context_factory_finalize_t) (smx_context_factory_t
 160                                                    *);
 161 typedef void (*smx_pfn_context_free_t) (smx_context_t);
 162 typedef void (*smx_pfn_context_start_t) (smx_context_t);
 163 typedef void (*smx_pfn_context_stop_t) (smx_context_t);
 164 typedef void (*smx_pfn_context_suspend_t) (smx_context_t context);
 165 typedef void (*smx_pfn_context_runall_t) (xbt_swag_t processes);
 166 typedef smx_context_t (*smx_pfn_context_self_t) (void);
 167 typedef void* (*smx_pfn_context_get_data_t) (smx_context_t context);
 168
 169 /* interface of the context factories */
 170 typedef struct s_smx_context_factory {
 171   const char *name;
 172   smx_pfn_context_factory_create_context_t create_context;
 173   smx_pfn_context_factory_finalize_t finalize;
 174   smx_pfn_context_free_t free;
 175   smx_pfn_context_stop_t stop;
 176   smx_pfn_context_suspend_t suspend;
 177   smx_pfn_context_runall_t runall;
 178   smx_pfn_context_self_t self;
 179   smx_pfn_context_get_data_t get_data;
 180 } s_smx_context_factory_t;
 181
 182
 183 void SIMIX_context_mod_init(void);
 184
 185 void SIMIX_context_mod_exit(void);
 186
 187
 188 /* All factories init */
 189 void SIMIX_ctx_thread_factory_init(smx_context_factory_t * factory);
 190 void SIMIX_ctx_sysv_factory_init(smx_context_factory_t * factory);
 191
 192 /* ****************************** */
 193 /* context manipulation functions */
 194 /* ****************************** */
 195
 196 /* Scenario for the end of a context:
 197  *
 198  * CASE 1: death after end of the main function
 199  *   the context_wrapper, called internally by the context module, calls
 200  *   SIMIX_context_stop after user code stops, smx_context_stop calls user
 201  *   cleanup_func if any (in context settings), add current process to trashbin
 202  *   and yields back to maestro.
 203  *   From time to time, maestro calls SIMIX_context_empty_trash, which destroy
 204  *   all the process and context data structures, and frees the memory
 205  *
 206  * CASE 2: brutal death
 207  *   SIMIX_process_kill (from any process) set process->iwannadie = 1 and then
 208  *   schedules the process. Then the process is awaken in the middle of the
 209  *   SIMIX_process_yield function, and at the end of it, it checks that
 210  *   iwannadie == 1, and call SIMIX_context_stop(same than first case afterward)
 211  */
 212
 213 /**
 214  * \brief creates a new context for a user level process
 215  * \param code a main function
 216  * \param argc the number of arguments of the main function
 217  * \param argv the vector of arguments of the main function
 218  * \param cleanup_func the function to call when the context stops
 219  * \param cleanup_arg the argument of the cleanup_func function
 220  */
 221 static XBT_INLINE smx_context_t SIMIX_context_new(xbt_main_func_t code,
 222                                                   int argc, char **argv,
 223                                                   void_pfn_smxprocess_t cleanup_func,
 224                                                   smx_process_t simix_process)
 225 {
 226
 227   return (*(simix_global->context_factory->create_context))
 228       (code, argc, argv, cleanup_func, simix_process);
 229 }
 230
 231 /**
 232  * \brief destroy a context
 233  * \param context the context to destroy
 234  * Argument must be stopped first -- runs in maestro context
 235  */
 236 static XBT_INLINE void SIMIX_context_free(smx_context_t context)
 237 {
 238   (*(simix_global->context_factory->free)) (context);
 239 }
 240
 241 /**
 242  * \brief stops the execution of a context
 243  * \param context to stop
 244  */
 245 static XBT_INLINE void SIMIX_context_stop(smx_context_t context)
 246 {
 247   (*(simix_global->context_factory->stop)) (context);
 248 }
 249
 250 /**
 251  \brief suspends a context and return the control back to the one which
 252         scheduled it
 253  \param context the context to be suspended (it must be the running one)
 254  */
 255 static XBT_INLINE void SIMIX_context_suspend(smx_context_t context)
 256 {
 257   (*(simix_global->context_factory->suspend)) (context);
 258 }
 259
 260 /**
 261  \brief executes all the processes (in parallel if possible)
 262  \param processes the swag of processes to execute
 263  */
 264 static XBT_INLINE void SIMIX_context_runall(xbt_swag_t processes)
 265 {
 266   (*(simix_global->context_factory->runall)) (processes);
 267 }
 268
 269 /**
 270  \brief returns the current running context
 271  */
 272 static XBT_INLINE smx_context_t SIMIX_context_self(void)
 273 {
 274   if (simix_global->context_factory == NULL) {
 275     return NULL;
 276   }
 277
 278   return (*(simix_global->context_factory->self))();
 279 }
 280
 281 /**
 282  \brief returns the data associated to a context
 283  \param context The context
 284  \return The data
 285  */
 286 static XBT_INLINE void* SIMIX_context_get_data(smx_context_t context)
 287 {
 288   return (*(simix_global->context_factory->get_data))(context);
 289 }
 290
 291
 292 #endif