1 /* Copyright (c) 2007-2010, 2012-2015. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #ifndef SIMGRID_SIMIX_HPP
8 #define SIMGRID_SIMIX_HPP
18 #include <xbt/function_types.h>
19 #include <xbt/future.hpp>
21 #include <simgrid/simix.h>
23 XBT_PUBLIC(void) simcall_run_kernel(std::function<void()> const& code);
24 XBT_PUBLIC(void) simcall_run_blocking(std::function<void()> const& code);
26 template<class F> inline
27 void simcall_run_kernel(F& f)
29 simcall_run_kernel(std::function<void()>(std::ref(f)));
31 template<class F> inline
32 void simcall_run_blocking(F& f)
34 simcall_run_blocking(std::function<void()>(std::ref(f)));
41 /** Execute some code in the kernel/maestro
43 * This can be used to enforce mutual exclusion with other simcall.
44 * More importantly, this enforces a deterministic/reproducible ordering
45 * of the operation with respect to other simcalls.
48 typename std::result_of<F()>::type kernel(F&& code)
50 // If we are in the maestro, we take the fast path and execute the
51 // code directly without simcall mashalling/unmarshalling/dispatch:
52 if (SIMIX_is_maestro())
53 return std::forward<F>(code)();
55 // If we are in the application, pass the code to the maestro which
56 // executes it for us and reports the result. We use a std::future which
57 // conveniently handles the success/failure value for us.
58 typedef typename std::result_of<F()>::type R;
59 simgrid::xbt::Result<R> result;
60 simcall_run_kernel([&]{
61 xbt_assert(SIMIX_is_maestro(), "Not in maestro");
62 simgrid::xbt::fulfillPromise(result, std::forward<F>(code));
70 XBT_PUBLIC_CLASS ContextFactory {
75 explicit ContextFactory(std::string name) : name_(std::move(name)) {}
76 virtual ~ContextFactory();
77 virtual Context* create_context(std::function<void()> code,
78 void_pfn_smxprocess_t cleanup, smx_process_t process) = 0;
80 // Optional methods for attaching main() as a context:
82 /** Creates a context from the current context of execution
84 * This will not work on all implementation of `ContextFactory`.
86 virtual Context* attach(void_pfn_smxprocess_t cleanup_func, smx_process_t process);
87 virtual Context* create_maestro(std::function<void()> code, smx_process_t process);
89 virtual void run_all() = 0;
90 virtual Context* self();
91 std::string const& name() const
96 void declare_context(void* T, std::size_t size);
98 template<class T, class... Args>
99 T* new_context(Args&&... args)
101 T* context = new T(std::forward<Args>(args)...);
102 this->declare_context(context, sizeof(T));
107 XBT_PUBLIC_CLASS Context {
109 std::function<void()> code_;
110 void_pfn_smxprocess_t cleanup_func_ = nullptr;
111 smx_process_t process_ = nullptr;
115 Context(std::function<void()> code,
116 void_pfn_smxprocess_t cleanup_func,
117 smx_process_t process);
122 bool has_code() const
126 smx_process_t process()
128 return this->process_;
130 void set_cleanup(void_pfn_smxprocess_t cleanup)
132 cleanup_func_ = cleanup;
138 virtual void suspend() = 0;
141 XBT_PUBLIC_CLASS AttachContext : public Context {
144 AttachContext(std::function<void()> code,
145 void_pfn_smxprocess_t cleanup_func,
146 smx_process_t process)
147 : Context(std::move(code), cleanup_func, process)
150 ~AttachContext() override;
152 /** Called by the context when it is ready to give control
155 virtual void attach_start() = 0;
157 /** Called by the context when it has finished its job */
158 virtual void attach_stop() = 0;
161 XBT_PUBLIC(void) set_maestro(std::function<void()> code);
162 XBT_PUBLIC(void) create_maestro(std::function<void()> code);
168 * Type of function that creates a process.
169 * The function must accept the following parameters:
170 * void* process: the process created will be stored there
171 * const char *name: a name for the object. It is for user-level information and can be NULL
172 * xbt_main_func_t code: is a function describing the behavior of the process
173 * void *data: data a pointer to any data one may want to attach to the new object.
174 * sg_host_t host: the location where the new process is executed
175 * int argc, char **argv: parameters passed to code
176 * xbt_dict_t pros: properties
178 typedef smx_process_t (*smx_creation_func_t) (
179 /* name */ const char*,
180 std::function<void()> code,
181 /* userdata */ void*,
182 /* hostname */ const char*,
183 /* kill_time */ double,
184 /* props */ xbt_dict_t,
185 /* auto_restart */ int,
186 /* parent_process */ smx_process_t);
189 XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t function);
191 XBT_PUBLIC(smx_process_t) simcall_process_create(const char *name,
192 std::function<void()> code,
194 const char *hostname,
196 xbt_dict_t properties,
199 XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, std::packaged_task<void()> callback);
201 template<class F> inline
202 XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, F callback)
204 return SIMIX_timer_set(date, std::packaged_task<void()>(std::move(callback)));
207 template<class R, class T> inline
208 XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, R(*callback)(T*), T* arg)
210 return SIMIX_timer_set(date, [=](){ callback(arg); });