-/* 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
#ifndef SIMGRID_SIMIX_HPP
#define SIMGRID_SIMIX_HPP
-#include <utility>
-#include <memory>
-#include <functional>
-
-#include <xbt/function_types.h>
#include <simgrid/simix.h>
+#include <xbt/functional.hpp>
+#include <xbt/future.hpp>
+#include <xbt/signal.hpp>
+
+#include <boost/heap/fibonacci_heap.hpp>
+#include <string>
+#include <unordered_map>
+
+XBT_PUBLIC void simcall_run_kernel(std::function<void()> const& code);
+XBT_PUBLIC void simcall_run_blocking(std::function<void()> const& code);
namespace simgrid {
namespace simix {
-class Context;
-class ContextFactory;
+/** 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
+ * 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).
+ *
+ * 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 <class F> typename std::result_of<F()>::type simcall(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<F>(code)();
-class ContextFactory {
-private:
- std::string name_;
-public:
+ // 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<F()>::type R;
+ simgrid::xbt::Result<R> result;
+ simcall_run_kernel([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); });
+ return result.get();
+}
- ContextFactory(std::string name) : name_(std::move(name)) {}
- virtual ~ContextFactory();
- virtual Context* create_context(std::function<void()> code,
- void_pfn_smxprocess_t cleanup, smx_process_t process) = 0;
- 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<class T, class... Args>
- T* new_context(Args&&... args)
- {
- T* context = new T(std::forward<Args>(args)...);
- this->declare_context(context, sizeof(T));
- return context;
- }
-};
+/** 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.
+ *
+ * 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 <class F> typename std::result_of<F()>::type simcall_blocking(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<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<F()>::type R;
+ simgrid::xbt::Result<R> result;
+ simcall_run_blocking([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); });
+ return result.get();
+}
+
+XBT_ATTRIB_DEPRECATED_v325("Please manifest if you actually need this function")
+ XBT_PUBLIC const std::vector<smx_actor_t>& process_get_runnable();
+
+// What's executed as SIMIX actor code:
+typedef std::function<void()> ActorCode;
+
+// Create an ActorCode based on a std::string
+typedef std::function<ActorCode(std::vector<std::string> args)> ActorCodeFactory;
+
+XBT_PUBLIC void register_function(const std::string& name, const ActorCodeFactory& factory);
+
+typedef std::pair<double, Timer*> TimerQelt;
+static boost::heap::fibonacci_heap<TimerQelt, boost::heap::compare<xbt::HeapComparator<TimerQelt>>> simix_timers;
+
+/** @brief Timer datatype */
+class Timer {
+ double date = 0.0;
-class Context {
-private:
- std::function<void()> code_;
- void_pfn_smxprocess_t cleanup_func_ = nullptr;
- smx_process_t process_ = nullptr;
-public:
- bool iwannadie;
public:
- Context(std::function<void()> 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<void()>&& callback) : date(date), callback(std::move(callback)) {}
+
+ simgrid::xbt::Task<void()> callback;
+ double get_date() { return date; }
+ void remove();
+
+ template <class F> static inline Timer* set(double date, F callback)
{
- return (bool) code_;
+ return set(date, simgrid::xbt::Task<void()>(std::move(callback)));
}
- smx_process_t process()
+
+ template <class R, class T>
+ 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<void()>&& callback);
+ static double next() { return simix_timers.empty() ? -1.0 : simix_timers.top().first; }
};
-}
-}
+} // namespace simix
+} // namespace simgrid
+
+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<std::string, std::string>* properties);
+
+XBT_ATTRIB_DEPRECATED_v325("Please use simgrid::xbt::Timer::set") XBT_PUBLIC smx_timer_t
+ SIMIX_timer_set(double date, simgrid::xbt::Task<void()>&& callback);
-#endif
\ No newline at end of file
+#endif
