src/kernel/context/Context.hpp

   1 /* Copyright (c) 2007-2016. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef _SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
   7 #define _SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
   8
   9 #include <functional>
  10 #include <memory>
  11 #include <unordered_map>
  12 #include <vector>
  13
  14 #include <xbt/functional.hpp>
  15
  16 #include "src/internal_config.h"
  17 #include "simgrid/simix.h"
  18 #include "surf/surf.h"
  19 #include "xbt/base.h"
  20 #include "xbt/fifo.h"
  21 #include "xbt/swag.h"
  22 #include "xbt/dict.h"
  23 #include "xbt/mallocator.h"
  24 #include "xbt/config.h"
  25 #include "xbt/xbt_os_time.h"
  26 #include "xbt/function_types.h"
  27 #include "src/xbt/ex_interface.h"
  28 #include "src/instr/instr_private.h"
  29 #include "src/simix/smx_host_private.h"
  30 #include "src/simix/smx_io_private.h"
  31 #include "src/simix/smx_network_private.h"
  32 #include "src/simix/popping_private.h"
  33 #include "src/simix/smx_synchro_private.h"
  34
  35 #include <signal.h>
  36 #include "src/simix/ActorImpl.hpp"
  37
  38 #include <simgrid/simix.hpp>
  39
  40 namespace simgrid {
  41 namespace kernel {
  42 namespace context {
  43
  44   class Context;
  45
  46   XBT_PUBLIC_CLASS ContextFactory {
  47   private:
  48     std::string name_;
  49   public:
  50
  51     explicit ContextFactory(std::string name) : name_(std::move(name)) {}
  52     virtual ~ContextFactory();
  53     virtual Context* create_context(std::function<void()> code,
  54       void_pfn_smxprocess_t cleanup, smx_process_t process) = 0;
  55
  56     // Optional methods for attaching main() as a context:
  57
  58     /** Creates a context from the current context of execution
  59      *
  60      *  This will not work on all implementation of `ContextFactory`.
  61      */
  62     virtual Context* attach(void_pfn_smxprocess_t cleanup_func, smx_process_t process);
  63     virtual Context* create_maestro(std::function<void()> code, smx_process_t process);
  64
  65     virtual void run_all() = 0;
  66     virtual Context* self();
  67     std::string const& name() const
  68     {
  69       return name_;
  70     }
  71   private:
  72     void declare_context(void* T, std::size_t size);
  73   protected:
  74     template<class T, class... Args>
  75     T* new_context(Args&&... args)
  76     {
  77       T* context = new T(std::forward<Args>(args)...);
  78       this->declare_context(context, sizeof(T));
  79       return context;
  80     }
  81   };
  82
  83   XBT_PUBLIC_CLASS Context {
  84   private:
  85     std::function<void()> code_;
  86     void_pfn_smxprocess_t cleanup_func_ = nullptr;
  87     smx_process_t process_ = nullptr;
  88   public:
  89     bool iwannadie;
  90   public:
  91     Context(std::function<void()> code,
  92             void_pfn_smxprocess_t cleanup_func,
  93             smx_process_t process);
  94     void operator()()
  95     {
  96       code_();
  97     }
  98     bool has_code() const
  99     {
 100       return (bool) code_;
 101     }
 102     smx_process_t process()
 103     {
 104       return this->process_;
 105     }
 106     void set_cleanup(void_pfn_smxprocess_t cleanup)
 107     {
 108       cleanup_func_ = cleanup;
 109     }
 110
 111     // Virtual methods
 112     virtual ~Context();
 113     virtual void stop();
 114     virtual void suspend() = 0;
 115   };
 116
 117   XBT_PUBLIC_CLASS AttachContext : public Context {
 118   public:
 119
 120     AttachContext(std::function<void()> code,
 121             void_pfn_smxprocess_t cleanup_func,
 122             smx_process_t process)
 123       : Context(std::move(code), cleanup_func, process)
 124     {}
 125
 126     ~AttachContext() override;
 127
 128     /** Called by the context when it is ready to give control
 129      *  to the maestro.
 130      */
 131     virtual void attach_start() = 0;
 132
 133     /** Called by the context when it has finished its job */
 134     virtual void attach_stop() = 0;
 135   };
 136
 137 /* This allows Java to hijack the context factory (Java induces factories of factory :) */
 138 typedef ContextFactory* (*ContextFactoryInitializer)();
 139 XBT_PUBLIC_DATA(ContextFactoryInitializer) factory_initializer;
 140
 141 XBT_PRIVATE ContextFactory* thread_factory();
 142 XBT_PRIVATE ContextFactory* sysv_factory();
 143 XBT_PRIVATE ContextFactory* raw_factory();
 144 XBT_PRIVATE ContextFactory* boost_factory();
 145
 146 }}}
 147
 148 typedef simgrid::kernel::context::ContextFactory *smx_context_factory_t;
 149
 150 SG_BEGIN_DECL()
 151
 152
 153 XBT_PRIVATE void SIMIX_context_mod_init();
 154 XBT_PRIVATE void SIMIX_context_mod_exit();
 155
 156 XBT_PRIVATE smx_context_t SIMIX_context_new(
 157   std::function<void()> code,
 158   void_pfn_smxprocess_t cleanup_func,
 159   smx_process_t simix_process);
 160
 161 #ifndef WIN32
 162 XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
 163 #endif
 164
 165 /* We are using the bottom of the stack to save some information, like the
 166  * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
 167  * size for the stack. */
 168 #if HAVE_VALGRIND_H
 169 # define smx_context_usable_stack_size                                  \
 170   (smx_context_stack_size - sizeof(unsigned int)) /* for valgrind_stack_id */
 171 #else
 172 # define smx_context_usable_stack_size smx_context_stack_size
 173 #endif
 174
 175 /** @brief Executes all the processes to run (in parallel if possible). */
 176 XBT_PRIVATE void SIMIX_context_runall();
 177 /** @brief returns the current running context */
 178 XBT_PUBLIC(smx_context_t) SIMIX_context_self(); // public because it's used in simgrid-java
 179
 180 XBT_PRIVATE void *SIMIX_context_stack_new();
 181 XBT_PRIVATE void SIMIX_context_stack_delete(void *stack);
 182
 183 XBT_PRIVATE void SIMIX_context_set_current(smx_context_t context);
 184 XBT_PRIVATE smx_context_t SIMIX_context_get_current();
 185
 186 XBT_PUBLIC(int) SIMIX_process_get_maxpid();
 187
 188 XBT_PRIVATE void SIMIX_post_create_environment();
 189
 190 SG_END_DECL()
 191
 192 XBT_PRIVATE simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(const char *name);
 193
 194 #endif