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