-/* Copyright (c) 2007-2019. 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
#ifndef SIMGRID_SIMIX_HPP
#define SIMGRID_SIMIX_HPP
+#include <simgrid/s4u/Actor.hpp>
#include <simgrid/simix.h>
-#include <xbt/functional.hpp>
-#include <xbt/future.hpp>
+#include <xbt/promise.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);
+XBT_PUBLIC void simcall_run_kernel(std::function<void()> const& code,
+ simgrid::kernel::actor::SimcallObserver* observer);
+XBT_PUBLIC void simcall_run_blocking(std::function<void()> const& code,
+ simgrid::kernel::actor::SimcallObserver* observer);
namespace simgrid {
namespace kernel {
*
* 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).
+ * 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).
*
* 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)
+template <class F> typename std::result_of_t<F()> 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<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;
+ using R = typename std::result_of_t<F()>;
simgrid::xbt::Result<R> result;
- simcall_run_kernel([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); });
+ simcall_run_kernel([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); }, observer);
return result.get();
}
/** 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.
+ * 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
* 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.
*/
-template <class F> typename std::result_of<F()>::type simcall_blocking(F&& code)
+template <class F> void simcall_blocking(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())
- return std::forward<F>(code)();
+ xbt_assert(not s4u::Actor::is_maestro(), "Cannot execute blocking call in kernel mode");
- // 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
+ // 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();
+ simgrid::xbt::Result<void> result;
+ simcall_run_blocking([&result, &code] { simgrid::xbt::fulfill_promise(result, std::forward<F>(code)); }, observer);
+ result.get(); // rethrow stored exception if any
+}
+
+template <class F, class Observer>
+auto simcall_blocking(F&& code, Observer* observer) -> decltype(observer->get_result())
+{
+ simcall_blocking(std::forward<F>(code), static_cast<SimcallObserver*>(observer));
+ return observer->get_result();
}
} // namespace actor
} // namespace kernel
-} // namespace simgrid
-namespace simgrid {
-namespace simix {
-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;
-
-public:
- 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 set(date, simgrid::xbt::Task<void()>(std::move(callback)));
- }
-
- 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 set(date, std::bind(callback, arg));
- }
+namespace simix {
- XBT_ATTRIB_DEPRECATED_v325("Please use a lambda or std::bind") static Timer* set(double date, void (*callback)(void*),
- void* arg)
- {
- return set(date, std::bind(callback, arg));
- }
- static Timer* set(double date, simgrid::xbt::Task<void()>&& callback);
- static double next() { return simix_timers.empty() ? -1.0 : simix_timers.top().first; }
-};
+XBT_PUBLIC void unblock(smx_actor_t process);
} // 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
