1 /* Copyright (c) 2007-2018. 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.hpp"
18 #include "src/internal_config.h"
19 #include "src/simix/popping_private.hpp"
20 #include "src/simix/smx_host_private.hpp"
21 #include "src/simix/smx_io_private.hpp"
22 #include "src/simix/smx_network_private.hpp"
23 #include "src/simix/smx_synchro_private.hpp"
24 #include "surf/surf.hpp"
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 class XBT_PUBLIC ContextFactory {
45 explicit ContextFactory(std::string name) : name_(std::move(name)) {}
46 virtual ~ContextFactory();
47 virtual Context* create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process) = 0;
49 // Optional methods for attaching main() as a context:
51 /** Creates a context from the current context of execution
53 * This will not work on all implementation of `ContextFactory`.
55 virtual Context* attach(void_pfn_smxprocess_t cleanup_func, smx_actor_t process);
56 virtual Context* create_maestro(std::function<void()> code, smx_actor_t process);
58 virtual void run_all() = 0;
59 virtual Context* self();
60 std::string const& name() const { return name_; }
62 void declare_context(void* T, std::size_t size);
65 template <class T, class... Args> T* new_context(Args&&... args)
67 T* context = new T(std::forward<Args>(args)...);
68 this->declare_context(context, sizeof(T));
73 class XBT_PUBLIC Context {
75 std::function<void()> code_;
76 void_pfn_smxprocess_t cleanup_func_ = nullptr;
77 smx_actor_t process_ = nullptr;
81 /** @brief Exception launched to kill a process, in order to properly unwind its stack and release RAII stuff
83 * Nope, Sonar, this should not inherit of std::exception.
84 * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
89 Context(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process);
90 void operator()() { code_(); }
91 bool has_code() const { return static_cast<bool>(code_); }
92 smx_actor_t process() { return this->process_; }
93 void set_cleanup(void_pfn_smxprocess_t cleanup) { cleanup_func_ = cleanup; }
98 virtual void suspend() = 0;
101 class XBT_PUBLIC AttachContext : public Context {
103 AttachContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
104 : Context(std::move(code), cleanup_func, process)
108 ~AttachContext() override;
110 /** Called by the context when it is ready to give control
113 virtual void attach_start() = 0;
115 /** Called by the context when it has finished its job */
116 virtual void attach_stop() = 0;
119 /* This allows Java to hijack the context factory (Java induces factories of factory :) */
120 typedef ContextFactory* (*ContextFactoryInitializer)();
121 XBT_PUBLIC_DATA ContextFactoryInitializer factory_initializer;
123 XBT_PRIVATE ContextFactory* thread_factory();
124 XBT_PRIVATE ContextFactory* sysv_factory();
125 XBT_PRIVATE ContextFactory* raw_factory();
126 XBT_PRIVATE ContextFactory* boost_factory();
130 typedef simgrid::kernel::context::ContextFactory *smx_context_factory_t;
134 XBT_PRIVATE void SIMIX_context_mod_init();
135 XBT_PRIVATE void SIMIX_context_mod_exit();
137 XBT_PUBLIC smx_context_t SIMIX_context_new(std::function<void()> code, void_pfn_smxprocess_t cleanup_func,
138 smx_actor_t simix_process);
141 XBT_PUBLIC_DATA char sigsegv_stack[SIGSTKSZ];
144 /* We are using the bottom of the stack to save some information, like the
145 * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
146 * size for the stack. Round its value to a multiple of 16 (asan wants the stacks to be aligned this way). */
148 #define smx_context_usable_stack_size \
149 ((smx_context_stack_size - sizeof(unsigned int)) & ~0xf) /* for valgrind_stack_id */
151 #define smx_context_usable_stack_size (smx_context_stack_size & ~0xf)
154 /** @brief Executes all the processes to run (in parallel if possible). */
155 XBT_PRIVATE void SIMIX_context_runall();
156 /** @brief returns the current running context */
157 XBT_PUBLIC smx_context_t SIMIX_context_self(); // public because it's used in simgrid-java
159 XBT_PRIVATE void *SIMIX_context_stack_new();
160 XBT_PRIVATE void SIMIX_context_stack_delete(void *stack);
162 XBT_PUBLIC void SIMIX_context_set_current(smx_context_t context);
163 XBT_PRIVATE smx_context_t SIMIX_context_get_current();
165 XBT_PUBLIC int SIMIX_process_get_maxpid();
167 XBT_PRIVATE void SIMIX_post_create_environment();
170 XBT_PRIVATE simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(const char *name);