-/* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2007-2023. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
#define SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
-#include "simgrid/forward.h"
-#include "src/internal_config.h"
+#include <simgrid/forward.h>
+#include <xbt/parmap.h>
+
#include "src/kernel/activity/ActivityImpl.hpp"
#include <csignal>
+#include <functional>
-/* Process creation/destruction callbacks */
-typedef void (*void_pfn_smxprocess_t)(smx_actor_t);
-
-namespace simgrid {
-namespace kernel {
-namespace context {
+namespace simgrid::kernel::context {
class XBT_PUBLIC ContextFactory {
-private:
- std::string name_;
-
public:
- explicit ContextFactory(std::string name) : name_(std::move(name)) {}
+ explicit ContextFactory() = default;
+ ContextFactory(const ContextFactory&) = delete;
+ ContextFactory& operator=(const ContextFactory&) = delete;
virtual ~ContextFactory();
- virtual Context* create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process) = 0;
+ virtual Context* create_context(std::function<void()>&& code, actor::ActorImpl* actor) = 0;
/** Turn the current thread into a simulation context */
- virtual Context* attach(void_pfn_smxprocess_t cleanup_func, smx_actor_t process);
+ virtual Context* attach(actor::ActorImpl* actor);
/** Turn the current thread into maestro (the old maestro becomes a regular actor) */
- virtual Context* create_maestro(std::function<void()> code, smx_actor_t process);
+ virtual Context* create_maestro(std::function<void()>&& code, actor::ActorImpl* actor);
- virtual void run_all() = 0;
- std::string const& name() const { return name_; }
+ virtual void run_all(std::vector<actor::ActorImpl*> const& actors_list) = 0;
protected:
template <class T, class... Args> T* new_context(Args&&... args)
{
- T* context = new T(std::forward<Args>(args)...);
+ auto* context = new T(std::forward<Args>(args)...);
context->declare_context(sizeof(T));
return context;
}
class XBT_PUBLIC Context {
friend ContextFactory;
-private:
+ static int parallel_contexts;
+ static thread_local Context* current_context_;
+
std::function<void()> code_;
- void_pfn_smxprocess_t cleanup_func_ = nullptr;
- smx_actor_t actor_ = nullptr;
+ actor::ActorImpl* actor_ = nullptr;
+ bool is_maestro_;
void declare_context(std::size_t size);
public:
- bool iwannadie = false;
+ static e_xbt_parmap_mode_t parallel_mode;
+ static unsigned stack_size;
+ static unsigned guard_size;
+
+ static int install_sigsegv_stack(bool enable);
- Context(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process);
+ Context(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro);
Context(const Context&) = delete;
Context& operator=(const Context&) = delete;
virtual ~Context();
- void operator()() { code_(); }
+ bool is_maestro() const { return is_maestro_; }
+ void operator()() const { code_(); }
bool has_code() const { return static_cast<bool>(code_); }
- smx_actor_t process() { return this->actor_; }
- void set_cleanup(void_pfn_smxprocess_t cleanup) { cleanup_func_ = cleanup; }
+ actor::ActorImpl* get_actor() const { return this->actor_; }
+
+ /** @brief Returns whether some parallel threads are used for the user contexts. */
+ static bool is_parallel() { return parallel_contexts > 1; }
+ /** @brief Returns the number of parallel threads used for the user contexts (1 means no parallelism). */
+ static int get_nthreads() { return parallel_contexts; }
+ /**
+ * @brief Sets the number of parallel threads to use for the user contexts.
+ *
+ * This function should be called before initializing SIMIX.
+ * A value of 1 means no parallelism (1 thread only).
+ * If the value is greater than 1, the thread support must be enabled.
+ * If the value is less than 1, the optimal number of threads is chosen automatically.
+ *
+ * @param nb_threads the number of threads to use
+ */
+ static void set_nthreads(int nb_threads);
// Scheduling methods
virtual void stop();
virtual void suspend() = 0;
// Retrieving the self() context
- /** @brief Retrives the current context of this thread */
+ /** @brief Retrieves the current context of this thread */
static Context* self();
/** @brief Sets the current context of this thread */
static void set_current(Context* self);
-
- class StopRequest {
- /** @brief Exception launched to kill a process, in order to properly unwind its stack and release RAII stuff
- *
- * Nope, Sonar, this should not inherit of std::exception nor of simgrid::Exception.
- * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
- */
- public:
- StopRequest() = default;
- explicit StopRequest(std::string msg) : msg_(msg) {}
-
- private:
- std::string msg_;
- };
};
class XBT_PUBLIC AttachContext : public Context {
public:
- AttachContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t actor)
- : Context(std::move(code), cleanup_func, actor)
+ AttachContext(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
+ : Context(std::move(code), actor, maestro)
{
}
-
+ AttachContext(const AttachContext&) = delete;
+ AttachContext& operator=(const AttachContext&) = delete;
~AttachContext() override;
- /** Called by the context when it is ready to give control
- * to the maestro.
- */
+ /** Called by the context when it is ready to give control to the maestro */
virtual void attach_start() = 0;
/** Called by the context when it has finished its job */
virtual void attach_stop() = 0;
};
-/* This allows Java to hijack the context factory (Java induces factories of factory :) */
-typedef ContextFactory* (*ContextFactoryInitializer)();
-XBT_PUBLIC_DATA ContextFactoryInitializer factory_initializer;
-
XBT_PRIVATE ContextFactory* thread_factory();
XBT_PRIVATE ContextFactory* sysv_factory();
XBT_PRIVATE ContextFactory* raw_factory();
XBT_PRIVATE ContextFactory* boost_factory();
-}}}
-
-typedef simgrid::kernel::context::ContextFactory *smx_context_factory_t;
-
-XBT_PRIVATE void SIMIX_context_mod_init();
-XBT_PRIVATE void SIMIX_context_mod_exit();
-
-XBT_PUBLIC smx_context_t SIMIX_context_new(std::function<void()> code, void_pfn_smxprocess_t cleanup_func,
- smx_actor_t simix_process);
-
-#ifndef WIN32
-XBT_PUBLIC_DATA char sigsegv_stack[SIGSTKSZ];
-#endif
-
-/* We are using the bottom of the stack to save some information, like the
- * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
- * size for the stack. Round its value to a multiple of 16 (asan wants the stacks to be aligned this way). */
-#if HAVE_VALGRIND_H
-#define smx_context_usable_stack_size \
- ((smx_context_stack_size - sizeof(unsigned int)) & ~0xf) /* for valgrind_stack_id */
-#else
-#define smx_context_usable_stack_size (smx_context_stack_size & ~0xf)
-#endif
-
-/** @brief Executes all the processes to run (in parallel if possible). */
-XBT_PRIVATE void SIMIX_context_runall();
-
-XBT_PUBLIC int SIMIX_process_get_maxpid();
-
-XBT_PRIVATE void SIMIX_post_create_environment();
-
-XBT_PRIVATE simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(std::string name);
+} // namespace simgrid::kernel::context
#endif