1 /* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
7 #define SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
11 #include <unordered_map>
14 #include <xbt/functional.hpp>
16 #include "simgrid/simix.h"
17 #include "src/instr/instr_private.h"
18 #include "src/internal_config.h"
19 #include "src/simix/popping_private.h"
20 #include "src/simix/smx_host_private.h"
21 #include "src/simix/smx_io_private.h"
22 #include "src/simix/smx_network_private.h"
23 #include "src/simix/smx_synchro_private.hpp"
24 #include "surf/surf.h"
26 #include "xbt/config.h"
27 #include "xbt/function_types.h"
28 #include "xbt/mallocator.h"
29 #include "xbt/xbt_os_time.h"
31 #include "src/simix/ActorImpl.hpp"
34 #include <simgrid/simix.hpp>
40 XBT_PUBLIC_CLASS ContextFactory {
45 explicit ContextFactory(std::string name) : name_(std::move(name)) {}
46 virtual ~ContextFactory();
47 virtual Context* create_context(std::function<void()> code,
48 void_pfn_smxprocess_t cleanup, smx_actor_t process) = 0;
50 // Optional methods for attaching main() as a context:
52 /** Creates a context from the current context of execution
54 * This will not work on all implementation of `ContextFactory`.
56 virtual Context* attach(void_pfn_smxprocess_t cleanup_func, smx_actor_t process);
57 virtual Context* create_maestro(std::function<void()> code, smx_actor_t process);
59 virtual void run_all() = 0;
60 virtual Context* self();
61 std::string const& name() const
66 void declare_context(void* T, std::size_t size);
68 template<class T, class... Args>
69 T* new_context(Args&&... args)
71 T* context = new T(std::forward<Args>(args)...);
72 this->declare_context(context, sizeof(T));
77 XBT_PUBLIC_CLASS Context {
79 std::function<void()> code_;
80 void_pfn_smxprocess_t cleanup_func_ = nullptr;
81 smx_actor_t process_ = nullptr;
85 Context(std::function<void()> code,
86 void_pfn_smxprocess_t cleanup_func,
94 return static_cast<bool>(code_);
98 return this->process_;
100 void set_cleanup(void_pfn_smxprocess_t cleanup)
102 cleanup_func_ = cleanup;
108 virtual void suspend() = 0;
111 XBT_PUBLIC_CLASS AttachContext : public Context {
114 AttachContext(std::function<void()> code,
115 void_pfn_smxprocess_t cleanup_func,
117 : Context(std::move(code), cleanup_func, process)
120 ~AttachContext() override;
122 /** Called by the context when it is ready to give control
125 virtual void attach_start() = 0;
127 /** Called by the context when it has finished its job */
128 virtual void attach_stop() = 0;
131 /* This allows Java to hijack the context factory (Java induces factories of factory :) */
132 typedef ContextFactory* (*ContextFactoryInitializer)();
133 XBT_PUBLIC_DATA(ContextFactoryInitializer) factory_initializer;
135 XBT_PRIVATE ContextFactory* thread_factory();
136 XBT_PRIVATE ContextFactory* sysv_factory();
137 XBT_PRIVATE ContextFactory* raw_factory();
138 XBT_PRIVATE ContextFactory* boost_factory();
142 typedef simgrid::kernel::context::ContextFactory *smx_context_factory_t;
147 XBT_PRIVATE void SIMIX_context_mod_init();
148 XBT_PRIVATE void SIMIX_context_mod_exit();
150 XBT_PUBLIC(smx_context_t)
151 SIMIX_context_new(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t simix_process);
154 XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
157 /* We are using the bottom of the stack to save some information, like the
158 * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
159 * size for the stack. */
161 # define smx_context_usable_stack_size \
162 (smx_context_stack_size - sizeof(unsigned int)) /* for valgrind_stack_id */
164 # define smx_context_usable_stack_size smx_context_stack_size
167 /** @brief Executes all the processes to run (in parallel if possible). */
168 XBT_PRIVATE void SIMIX_context_runall();
169 /** @brief returns the current running context */
170 XBT_PUBLIC(smx_context_t) SIMIX_context_self(); // public because it's used in simgrid-java
172 XBT_PRIVATE void *SIMIX_context_stack_new();
173 XBT_PRIVATE void SIMIX_context_stack_delete(void *stack);
175 XBT_PUBLIC(void) SIMIX_context_set_current(smx_context_t context);
176 XBT_PRIVATE smx_context_t SIMIX_context_get_current();
178 XBT_PUBLIC(int) SIMIX_process_get_maxpid();
180 XBT_PRIVATE void SIMIX_post_create_environment();
184 XBT_PRIVATE simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(const char *name);