X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e30d391831c58e590aa83dce5f30f218cc3f53ce..3dd753cd9e46d794e00629d03183250aec4a17e4:/include/simgrid/simix.hpp diff --git a/include/simgrid/simix.hpp b/include/simgrid/simix.hpp index 172ebe9891..c9902637d6 100644 --- a/include/simgrid/simix.hpp +++ b/include/simgrid/simix.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2007-2018. The SimGrid Team. +/* Copyright (c) 2007-2022. The SimGrid Team. * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it @@ -7,121 +7,99 @@ #ifndef SIMGRID_SIMIX_HPP #define SIMGRID_SIMIX_HPP +#include #include -#include -#include +#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))); -} +XBT_PUBLIC void simcall_run_kernel(std::function const& code, + simgrid::kernel::actor::SimcallObserver* observer); +XBT_PUBLIC void simcall_run_blocking(std::function const& code, + simgrid::kernel::actor::SimcallObserver* observer); namespace simgrid { +namespace kernel { +namespace actor { -namespace simix { - -/** Execute some code in the kernel/maestro +/** 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. + * + * 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 + * finiteness but that's all. The main goal remain to ensure reproducible ordering of uncomparable events (in + * [parallel] simulation) and observability of events (in model-checking). * - * 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. + * 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. */ -template -typename std::result_of::type kernelImmediate(F&& code) +template typename std::result_of_t simcall(F&& code, SimcallObserver* observer = nullptr) { // 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()) + // code directly without simcall marshalling/unmarshalling/dispatch: + if (s4u::Actor::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; + using R = typename std::result_of_t; simgrid::xbt::Result result; - simcall_run_kernel([&]{ - xbt_assert(SIMIX_is_maestro(), "Not in maestro"); - simgrid::xbt::fulfillPromise(result, std::forward(code)); - }); + simcall_run_kernel([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward(code)); }, observer); return result.get(); } -XBT_PUBLIC const std::vector& process_get_runnable(); - -// 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); - -/** These functions will be called when we detect a deadlock: any remaining process is locked on an action +/** Execute some code (that does not return immediately) in kernel context * - * If these functions manage to unlock some of the processes, then the deadlock will be avoided. - */ -XBT_PUBLIC_DATA simgrid::xbt::signal onDeadlock; -} -} - -/* - * 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 - * std::map* props: properties + * This is very similar to simcall() right above, but the calling actor will not get rescheduled until + * actor->simcall_answer() is called explicitly. + * + * 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. + * + * The return value is obtained from observer->get_result() if it exists. Otherwise void is returned. */ -typedef smx_actor_t (*smx_creation_func_t)( - /* name */ const char*, std::function code, - /* userdata */ void*, - /* hostname */ sg_host_t, - /* props */ std::map*, - /* parent_process */ smx_actor_t); - -XBT_PUBLIC void SIMIX_function_register_process_create(smx_creation_func_t function); - -XBT_PUBLIC smx_actor_t simcall_process_create(const char* name, std::function code, void* data, sg_host_t host, - std::map* properties); - -XBT_PUBLIC smx_timer_t SIMIX_timer_set(double date, simgrid::xbt::Task callback); - -template inline -smx_timer_t SIMIX_timer_set(double date, F callback) +template void simcall_blocking(F&& code, SimcallObserver* observer = nullptr) { - return SIMIX_timer_set(date, simgrid::xbt::Task(std::move(callback))); + xbt_assert(not s4u::Actor::is_maestro(), "Cannot execute blocking call in kernel mode"); + + // 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. + simgrid::xbt::Result result; + simcall_run_blocking([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward(code)); }, observer); + result.get(); // rethrow stored exception if any } -template inline -smx_timer_t SIMIX_timer_set(double date, R(*callback)(T*), T* arg) +template +auto simcall_blocking(F&& code, Observer* observer) -> decltype(observer->get_result()) { - return SIMIX_timer_set(date, [=](){ callback(arg); }); + simcall_blocking(std::forward(code), static_cast(observer)); + return observer->get_result(); } +} // namespace actor +} // namespace kernel + +namespace simix { + +XBT_PUBLIC void unblock(smx_actor_t process); + +} // namespace simix +} // namespace simgrid #endif