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