X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7f4f03348bd07609e258eb3b545bdafc2c881847..1cce0801abcad7c884f9e72ceda87e36d6635104:/include/simgrid/simix.hpp diff --git a/include/simgrid/simix.hpp b/include/simgrid/simix.hpp index 1829bad3a3..d08f865bfe 100644 --- a/include/simgrid/simix.hpp +++ b/include/simgrid/simix.hpp @@ -15,23 +15,87 @@ #include #include +#include +#include + #include +XBT_PUBLIC(void) simcall_run_kernel(std::function const& code); + +/** Execute some code in the kernel and block + * + * run_blocking() is a generic blocking simcall. It is given a callback + * which is executed immediately in the SimGrid kernel. The callback is + * responsible for setting the suitable logic for waking up the process + * when needed. + * + * @ref simix::kernelSync() is a higher level wrapper for this. + */ +XBT_PUBLIC(void) simcall_run_blocking(std::function const& code); + +template inline +void simcall_run_kernel(F& f) +{ + simcall_run_kernel(std::function(std::ref(f))); +} +template inline +void simcall_run_blocking(F& f) +{ + simcall_run_blocking(std::function(std::ref(f))); +} + namespace simgrid { + namespace simix { +/** Execute some code in the kernel/maestro + * + * This can be used to enforce mutual exclusion with other simcall. + * More importantly, this enforces a deterministic/reproducible ordering + * of the operation with respect to other simcalls. + */ +template +typename std::result_of::type kernelImmediate(F&& code) +{ + // If we are in the maestro, we take the fast path and execute the + // code directly without simcall mashalling/unmarshalling/dispatch: + if (SIMIX_is_maestro()) + return std::forward(code)(); + + // If we are in the application, pass the code to the maestro which + // executes it for us and reports the result. We use a std::future which + // conveniently handles the success/failure value for us. + typedef typename std::result_of::type R; + simgrid::xbt::Result result; + simcall_run_kernel([&]{ + xbt_assert(SIMIX_is_maestro(), "Not in maestro"); + simgrid::xbt::fulfillPromise(result, std::forward(code)); + }); + return result.get(); +} + class Context; class ContextFactory; -class ContextFactory { +XBT_PUBLIC_CLASS ContextFactory { private: std::string name_; public: - ContextFactory(std::string name) : name_(std::move(name)) {} + explicit ContextFactory(std::string name) : name_(std::move(name)) {} virtual ~ContextFactory(); virtual Context* create_context(std::function code, void_pfn_smxprocess_t cleanup, smx_process_t process) = 0; + + // Optional methods for attaching main() as a context: + + /** Creates a context from the current context of execution + * + * This will not work on all implementation of `ContextFactory`. + */ + virtual Context* attach(void_pfn_smxprocess_t cleanup_func, smx_process_t process); + virtual Context* create_maestro(std::function code, smx_process_t process); + virtual void run_all() = 0; virtual Context* self(); std::string const& name() const @@ -50,7 +114,7 @@ protected: } }; -class Context { +XBT_PUBLIC_CLASS Context { private: std::function code_; void_pfn_smxprocess_t cleanup_func_ = nullptr; @@ -84,7 +148,84 @@ public: virtual void suspend() = 0; }; +XBT_PUBLIC_CLASS AttachContext : public Context { +public: + + AttachContext(std::function code, + void_pfn_smxprocess_t cleanup_func, + smx_process_t process) + : Context(std::move(code), cleanup_func, process) + {} + + ~AttachContext() override; + + /** 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; +}; + +XBT_PUBLIC(void) set_maestro(std::function code); +XBT_PUBLIC(void) create_maestro(std::function code); + +// What's executed as SIMIX actor code: +typedef std::function ActorCode; + +// Create ActorCode based on argv: +typedef std::function args)> ActorCodeFactory; + +XBT_PUBLIC(void) registerFunction(const char* name, ActorCodeFactory factory); + } } -#endif \ No newline at end of file +/* + * Type of function that creates a process. + * The function must accept the following parameters: + * void* process: the process created will be stored there + * const char *name: a name for the object. It is for user-level information and can be NULL + * xbt_main_func_t code: is a function describing the behavior of the process + * void *data: data a pointer to any data one may want to attach to the new object. + * sg_host_t host: the location where the new process is executed + * int argc, char **argv: parameters passed to code + * xbt_dict_t pros: properties + */ +typedef smx_process_t (*smx_creation_func_t) ( + /* name */ const char*, + std::function code, + /* userdata */ void*, + /* hostname */ const char*, + /* kill_time */ double, + /* props */ xbt_dict_t, + /* auto_restart */ int, + /* parent_process */ smx_process_t); + +extern "C" +XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t function); + +XBT_PUBLIC(smx_process_t) simcall_process_create(const char *name, + std::function code, + void *data, + const char *hostname, + double kill_time, + xbt_dict_t properties, + int auto_restart); + +XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, simgrid::xbt::Task callback); + +template inline +XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, F callback) +{ + return SIMIX_timer_set(date, simgrid::xbt::Task(std::move(callback))); +} + +template inline +XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, R(*callback)(T*), T* arg) +{ + return SIMIX_timer_set(date, [=](){ callback(arg); }); +} + +#endif