X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e55e975804ae9c6ec82a5fbac2c7ea2497757a28..5b576eb1c0ab1acba1ceb0808b3708efe8a26dc1:/include/simgrid/simix.hpp diff --git a/include/simgrid/simix.hpp b/include/simgrid/simix.hpp index 99d241054f..9539451154 100644 --- a/include/simgrid/simix.hpp +++ b/include/simgrid/simix.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2007-2010, 2012-2015. The SimGrid Team. +/* Copyright (c) 2007-2019. The SimGrid Team. * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it @@ -7,55 +7,75 @@ #ifndef SIMGRID_SIMIX_HPP #define SIMGRID_SIMIX_HPP -#include +#include +#include +#include +#include +#include #include -#include -#include -#include -#include - -#include -#include +#include -#include +XBT_PUBLIC void simcall_run_kernel(std::function const& code, simgrid::mc::SimcallInspector* t); +XBT_PUBLIC void simcall_run_blocking(std::function const& code, simgrid::mc::SimcallInspector* t); -XBT_PUBLIC(void) simcall_run_kernel(std::function const& code); +namespace simgrid { +namespace kernel { +namespace actor { -/** Execute some code in the kernel and block +/** Execute some code in kernel context on behalf of the user code. + * + * Every modification of the environment must be protected this way: every setter, constructor and similar. + * Getters don't have to be protected this way. + * + * This allows deterministic parallel simulation without any locking, even if almost nobody uses parallel simulation in + * SimGrid. More interestingly it makes every modification of the simulated world observable by the model-checker, + * allowing the whole MC business. * - * 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. + * It is highly inspired from the syscalls in a regular operating system, allowing the user code to get some specific + * code executed in the kernel context. But here, there is almost no security involved. Parameters get checked for + * finitness but that's all. The main goal remain to ensure reproductible ordering of uncomparable events (in [parallel] + * simulation) and observability of events (in model-checking). * - * @ref simix::kernelSync() is a higher level wrapper for this. + * The code passed as argument is supposed to terminate at the exact same simulated timestamp. + * Do not use it if your code may block waiting for a subsequent event, e.g. if you lock a mutex, + * you may need to wait for that mutex to be unlocked by its current owner. + * Potentially blocking simcall must be issued using simcall_blocking(), right below in this file. */ -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) +template typename std::result_of::type simcall(F&& code, mc::SimcallInspector* t = nullptr) { - simcall_run_blocking(std::function(std::ref(f))); -} - -namespace simgrid { + // 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)(); -namespace simix { + // 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([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward(code)); }, t); + return result.get(); +} -/** Execute some code in the kernel/maestro +/** Execute some code (that does not return immediately) in kernel context + * + * This is very similar to simcall() right above, but the calling actor will not get rescheduled until + * actor->simcall_answer() is called explicitely. + * + * Since the return value does not come from the lambda directly, its type cannot be guessed automatically and must + * be provided as template parameter. * - * 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. + * This is meant for blocking actions. For example, locking a mutex is a blocking simcall. + * First it's a simcall because that's obviously a modification of the world. Then, that's a blocking simcall because if + * the mutex happens not to be free, the actor is added to a queue of actors in the mutex. Every mutex->unlock() takes + * the first actor from the queue, mark it as current owner of the mutex and call actor->simcall_answer() to mark that + * this mutex is now unblocked and ready to run again. If the mutex is initially free, the calling actor is unblocked + * right away with actor->simcall_answer() once the mutex is marked as locked. + * + * If your code never calls actor->simcall_answer() itself, the actor will never return from its simcall. */ -template -typename std::result_of::type kernelImmediate(F&& code) +template R simcall_blocking(F&& code, mc::SimcallInspector* t = nullptr) { // If we are in the maestro, we take the fast path and execute the // code directly without simcall mashalling/unmarshalling/dispatch: @@ -65,159 +85,72 @@ typename std::result_of::type kernelImmediate(F&& 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)); - }); + simcall_run_blocking([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward(code)); }, t); return result.get(); } +} // namespace actor +} // namespace kernel +} // namespace simgrid +namespace simgrid { +namespace simix { -class Context; -class ContextFactory; +XBT_ATTRIB_DEPRECATED_v325("Please manifest if you actually need this function") + XBT_PUBLIC const std::vector& process_get_runnable(); -XBT_PUBLIC_CLASS ContextFactory { -private: - std::string name_; -public: +// What's executed as SIMIX actor code: +typedef std::function ActorCode; - 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; +// Create an ActorCode based on a std::string +typedef std::function args)> ActorCodeFactory; - // Optional methods for attaching main() as a context: +XBT_PUBLIC void register_function(const std::string& name, const ActorCodeFactory& factory); - /** 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); +typedef std::pair TimerQelt; +static boost::heap::fibonacci_heap>> simix_timers; - virtual void run_all() = 0; - virtual Context* self(); - std::string const& name() const - { - return name_; - } -private: - void declare_context(void* T, std::size_t size); -protected: - template - T* new_context(Args&&... args) - { - T* context = new T(std::forward(args)...); - this->declare_context(context, sizeof(T)); - return context; - } -}; +/** @brief Timer datatype */ +class Timer { + double date = 0.0; -XBT_PUBLIC_CLASS Context { -private: - std::function code_; - void_pfn_smxprocess_t cleanup_func_ = nullptr; - smx_process_t process_ = nullptr; -public: - bool iwannadie; public: - Context(std::function code, - void_pfn_smxprocess_t cleanup_func, - smx_process_t process); - void operator()() - { - code_(); - } - bool has_code() const + decltype(simix_timers)::handle_type handle_; + + Timer(double date, simgrid::xbt::Task&& callback) : date(date), callback(std::move(callback)) {} + + simgrid::xbt::Task callback; + double get_date() { return date; } + void remove(); + + template static inline Timer* set(double date, F callback) { - return (bool) code_; + return set(date, simgrid::xbt::Task(std::move(callback))); } - smx_process_t process() + + template + XBT_ATTRIB_DEPRECATED_v325("Please use a lambda or std::bind") static inline Timer* set(double date, + R (*callback)(T*), T* arg) { - return this->process_; + return set(date, std::bind(callback, arg)); } - void set_cleanup(void_pfn_smxprocess_t cleanup) + + XBT_ATTRIB_DEPRECATED_v325("Please use a lambda or std::bind") static Timer* set(double date, void (*callback)(void*), + void* arg) { - cleanup_func_ = cleanup; + return set(date, std::bind(callback, arg)); } - - // Virtual methods - virtual ~Context(); - virtual void stop(); - virtual void suspend() = 0; + static Timer* set(double date, simgrid::xbt::Task&& callback); + static double next() { return simix_timers.empty() ? -1.0 : simix_timers.top().first; } }; -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; +} // namespace simix +} // namespace simgrid - /** 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); +XBT_PUBLIC smx_actor_t simcall_process_create(const std::string& name, const simgrid::simix::ActorCode& code, + void* data, sg_host_t host, + std::unordered_map* properties); -} -} - -/* - * 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, std::packaged_task callback); - -template inline -XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, F callback) -{ - return SIMIX_timer_set(date, std::packaged_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); }); -} +XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::xbt::Timer::set") XBT_PUBLIC smx_timer_t + SIMIX_timer_set(double date, simgrid::xbt::Task&& callback); #endif