src/simix/smx_private.h

   1 /* Copyright (c) 2007-2010, 2012-2015. 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 "src/internal_config.h"
  11 #include "simgrid/simix.h"
  12 #include "surf/surf.h"
  13 #include "xbt/base.h"
  14 #include "xbt/fifo.h"
  15 #include "xbt/swag.h"
  16 #include "xbt/dict.h"
  17 #include "xbt/mallocator.h"
  18 #include "xbt/config.h"
  19 #include "xbt/xbt_os_time.h"
  20 #include "xbt/function_types.h"
  21 #include "src/xbt/ex_interface.h"
  22 #include "src/instr/instr_private.h"
  23 #include "smx_process_private.h"
  24 #include "smx_host_private.h"
  25 #include "smx_io_private.h"
  26 #include "smx_network_private.h"
  27 #include "popping_private.h"
  28 #include "smx_synchro_private.h"
  29
  30 #include <signal.h>
  31
  32 #ifdef __cplusplus
  33
  34 #include <simgrid/simix.hpp>
  35
  36 namespace simgrid {
  37 namespace simix {
  38
  39 /* This allows Java to hijack the context factory (Java induces factories of factory :) */
  40 typedef ContextFactory* (*ContextFactoryInitializer)(void);
  41 XBT_PUBLIC_DATA(ContextFactoryInitializer) factory_initializer;
  42
  43 XBT_PRIVATE ContextFactory* thread_factory();
  44 XBT_PRIVATE ContextFactory* sysv_factory();
  45 XBT_PRIVATE ContextFactory* raw_factory();
  46 XBT_PRIVATE ContextFactory* boost_factory();
  47
  48 }
  49 }
  50
  51 typedef simgrid::simix::ContextFactory *smx_context_factory_t;
  52
  53 #else
  54
  55 typedef struct s_smx_context_factory *smx_context_factory_t;
  56
  57 #endif
  58
  59 SG_BEGIN_DECL()
  60
  61 /********************************** Simix Global ******************************/
  62 typedef struct s_smx_global {
  63   smx_context_factory_t context_factory;
  64   xbt_dynar_t process_to_run;
  65   xbt_dynar_t process_that_ran;
  66   xbt_swag_t process_list;
  67   xbt_swag_t process_to_destroy;
  68   smx_process_t maestro_process;
  69   xbt_dict_t registered_functions;
  70   smx_creation_func_t create_process_function;
  71   void_pfn_smxprocess_t kill_process_function;
  72   /** Callback used when killing a SMX_process */
  73   void_pfn_smxprocess_t cleanup_process_function;
  74
  75   xbt_os_mutex_t mutex;
  76 } s_smx_global_t, *smx_global_t;
  77
  78 XBT_PUBLIC_DATA(smx_global_t) simix_global;
  79 extern XBT_PRIVATE unsigned long simix_process_maxpid;
  80
  81 XBT_PUBLIC(void) SIMIX_clean(void);
  82
  83 /******************************** Exceptions *********************************/
  84 /** @brief Ask to the provided simix process to raise the provided exception */
  85 #define SMX_EXCEPTION(issuer, cat, val, msg)                            \
  86   if (1) {                                                              \
  87     smx_process_t _smx_throw_issuer = (issuer); /* evaluate only once */\
  88     THROW_PREPARE(_smx_throw_issuer->running_ctx, (cat), (val), xbt_strdup(msg)); \
  89     _smx_throw_issuer->doexception = 1;                                 \
  90   } else ((void)0)
  91
  92 /* ******************************** File ************************************ */
  93 typedef struct s_smx_file {
  94   surf_file_t surf_file;
  95   void* data;                   /**< @brief user data */
  96 } s_smx_file_t;
  97
  98 XBT_PRIVATE void SIMIX_context_mod_init(void);
  99 XBT_PRIVATE void SIMIX_context_mod_exit(void);
 100
 101 XBT_PRIVATE smx_context_t SIMIX_context_new(
 102   xbt_main_func_t code, int argc, char **argv,
 103   void_pfn_smxprocess_t cleanup_func,
 104   smx_process_t simix_process);
 105
 106 #ifndef WIN32
 107 XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
 108 #endif
 109
 110 /* We are using the bottom of the stack to save some information, like the
 111  * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
 112  * size for the stack. */
 113 #if HAVE_VALGRIND_H
 114 # define smx_context_usable_stack_size                                  \
 115   (smx_context_stack_size - sizeof(unsigned int)) /* for valgrind_stack_id */
 116 #else
 117 # define smx_context_usable_stack_size smx_context_stack_size
 118 #endif
 119
 120 /** @brief Executes all the processes to run (in parallel if possible). */
 121 static inline void SIMIX_context_runall(void)
 122 {
 123   if (!xbt_dynar_is_empty(simix_global->process_to_run))
 124     simix_global->context_factory->run_all();
 125 }
 126
 127 /** @brief returns the current running context */
 128 static inline smx_context_t SIMIX_context_self(void)
 129 {
 130   if (simix_global && simix_global->context_factory)
 131     return simix_global->context_factory->self();
 132   else
 133     return nullptr;
 134 }
 135
 136 XBT_PRIVATE void *SIMIX_context_stack_new(void);
 137 XBT_PRIVATE void SIMIX_context_stack_delete(void *stack);
 138
 139 XBT_PRIVATE void SIMIX_context_set_current(smx_context_t context);
 140 XBT_PRIVATE smx_context_t SIMIX_context_get_current(void);
 141
 142 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
 143
 144 XBT_PRIVATE void SIMIX_post_create_environment(void);
 145
 146 // FIXME, Dirty hack for SMPI+MSG
 147 XBT_PRIVATE void SIMIX_process_set_cleanup_function(smx_process_t process, void_pfn_smxprocess_t cleanup);
 148
 149 SG_END_DECL()
 150
 151 #endif