-/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#include <simgrid/chrono.hpp>
#include <xbt/Extendable.hpp>
-#include <xbt/functional.hpp>
#include <xbt/signal.hpp>
#include <xbt/string.hpp>
#include <functional>
-#include <map> // deprecated wrappers
#include <unordered_map>
namespace simgrid {
/** An actor is an independent stream of execution in your distributed application.
*
- * \rst
+ * @beginrst
* It is located on a (simulated) :cpp:class:`host <simgrid::s4u::Host>`, but can interact
* with the whole simulated platform.
*
* The `documentation of this standard <http://en.cppreference.com/w/cpp/thread>`_
* may help to understand the philosophy of the SimGrid actors.
*
- * \endrst */
+ * @endrst
+ */
class XBT_PUBLIC Actor : public xbt::Extendable<Actor> {
#ifndef DOXYGEN
friend Exec;
kernel::actor::ActorImpl* const pimpl_;
#endif
- explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
+ explicit Actor(kernel::actor::ActorImpl* pimpl) : pimpl_(pimpl) {}
public:
#ifndef DOXYGEN
friend XBT_PUBLIC void intrusive_ptr_release(const Actor* actor);
#endif
/** Retrieve the amount of references on that object. Useful to debug the automatic refcounting */
- int get_refcount();
+ int get_refcount() const;
// ***** Actor creation *****
/** Retrieve a reference to myself */
/** Signal to others that an actor wakes up for a sleep **/
static xbt::signal<void(Actor const&)> on_wake_up;
/** Signal to others that an actor is has been migrated to another host **/
- static xbt::signal<void(Actor const&, Host const& previous_location)> on_host_change;
+ static xbt::signal<void(const Actor&, const Host& previous_location)> on_host_change;
#ifndef DOXYGEN
static xbt::signal<void(Actor const&)> on_migration_start; // XBT_ATTRIB_DEPRECATED_v329
static xbt::signal<void(Actor const&)> on_migration_end; // XBT_ATTRIB_DEPRECATED_v329
static ActorPtr create(const std::string& name, s4u::Host* host, const std::function<void()>& code);
/** Create an actor, but don't start it yet.
*
- * This is usefull to set some properties or extension before actually starting it */
+ * This is useful to set some properties or extension before actually starting it */
static ActorPtr init(const std::string& name, s4u::Host* host);
+ ActorPtr set_stacksize(unsigned stacksize);
/** Start a previously initialized actor */
ActorPtr start(const std::function<void()>& code);
+ template <class F> ActorPtr start(F code) { return start(std::function<void()>(std::move(code))); }
+
+ template <class F, class... Args,
+ // This constructor is enabled only if the call code(args...) is valid:
+#ifndef DOXYGEN /* breathe seem to choke on function signatures in template parameter, see breathe#611 */
+ typename = typename std::result_of_t<F(Args...)>
+#endif
+ >
+ ActorPtr start(F code, Args... args)
+ {
+ return start(std::bind(std::move(code), std::move(args)...));
+ }
+
+ ActorPtr start(const std::function<void()>& code, std::vector<std::string> args);
+
/** Create an actor from a callable thing. */
template <class F> static ActorPtr create(const std::string& name, s4u::Host* host, F code)
{
/** Create an actor using a callable thing and its arguments.
*
* Note that the arguments will be copied, so move-only parameters are forbidden */
+
template <class F, class... Args,
// This constructor is enabled only if the call code(args...) is valid:
- typename = typename std::result_of<F(Args...)>::type>
+#ifndef DOXYGEN /* breathe seem to choke on function signatures in template parameter, see breathe#611 */
+ typename = typename std::result_of_t<F(Args...)>
+#endif
+ >
static ActorPtr create(const std::string& name, s4u::Host* host, F code, Args... args)
{
return create(name, host, std::bind(std::move(code), std::move(args)...));
void resume();
/** Returns true if the actor is suspended. */
- bool is_suspended();
+ bool is_suspended() const;
/** If set to true, the actor will automatically restart when its host reboots */
void set_auto_restart(bool autorestart);
/** Sets the time at which that actor should be killed */
void set_kill_time(double time);
/** Retrieves the time at which that actor will be killed (or -1 if not set) */
- double get_kill_time();
+ double get_kill_time() const;
/** @brief Moves the actor to another host
*
* Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
* blocked until bob terminates.
*/
- void join();
+ void join() const;
/** Wait for the actor to finish, or for the timeout to elapse.
*
* Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
* blocked until bob terminates.
*/
- void join(double timeout);
+ void join(double timeout) const;
/** Kill that actor and restart it from start. */
Actor* restart();
/** Returns the internal implementation of this actor */
kernel::actor::ActorImpl* get_impl() const { return pimpl_; }
- /** Retrieve the property value (or nullptr if not set) */
+ /** Retrieve the list of properties for that actor */
const std::unordered_map<std::string, std::string>*
get_properties() const; // FIXME: do not export the map, but only the keys or something
+
+ /** Retrieve the property value (or nullptr if not set) */
const char* get_property(const std::string& key) const;
+
+ /** Set a property (old values will be overwritten) */
void set_property(const std::string& key, const std::string& value);
};
XBT_PUBLIC void execute(double flop, double priority);
/**
- * @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
+ * @example examples/cpp/exec-ptask/s4u-exec-ptask.cpp
*/
/** Block the current actor until the built parallel execution terminates
*
- * \rst
+ * @beginrst
* .. _API_s4u_parallel_execute:
*
- * **Example of use:** `examples/s4u/exec-ptask/s4u-exec-ptask.cpp
- * <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/exec-ptask/s4u-exec-ptask.cpp>`_
+ * **Example of use:** `examples/cpp/exec-ptask/s4u-exec-ptask.cpp
+ * <https://framagit.org/simgrid/simgrid/tree/master/examples/cpp/exec-ptask/s4u-exec-ptask.cpp>`_
*
* Parallel executions convenient abstractions of parallel computational kernels that span over several machines,
* such as a PDGEM and the other ScaLAPACK routines. If you are interested in the effects of such parallel kernel
* models, and you must :ref:`use the ptask_L07 host model <options_model_select>` for that. Note that you can mix
* regular executions and communications with parallel executions, provided that the host model is ptask_L07.
*
- * \endrst
+ * @endrst
*/
/** Block the current actor until the built parallel execution completes */
XBT_PUBLIC void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
* blocking functions forbidden in this setting, but also modifications to the global state.
*
* The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
- * It will be set to true if the actor was killed or failed because of an exception,
+ * It will be set to true if the actor was killed or failed because of an exception or if the simulation deadlocked,
* while it will remain to false if the actor terminated gracefully.
*/
