-/* Copyright (c) 2017-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2017-2019. 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. */
namespace simgrid {
namespace s4u {
-/** Computation #Activity, representing the asynchronous disk access.
+/** Computation Activity, representing the asynchronous executions.
*
- * They are generated from simgrid::s4u::this_actor::exec_init() or simgrid::s4u::Host::execute().
+ * They are generated from this_actor::exec_init() or Host::execute(), and can be used to model pools of threads or
+ * similar mechanisms.
*/
class XBT_PUBLIC Exec : public Activity {
- Exec() : Activity() {}
+ Host* host_ = nullptr;
+ double flops_amount_ = 0.0;
+ double priority_ = 1.0;
+ double bound_ = 0.0;
+ std::string name_ = "";
+ std::string tracing_category_ = "";
+ std::atomic_int_fast32_t refcount_{0};
+
+ explicit Exec(sg_host_t host, double flops_amount);
+
public:
- friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Exec * e);
- friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Exec * e);
+ friend XBT_PUBLIC void intrusive_ptr_release(Exec* e);
+ friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
friend XBT_PUBLIC ExecPtr this_actor::exec_init(double flops_amount);
~Exec() = default;
- static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_start;
- static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_completion;
+ static xbt::signal<void(ActorPtr)> on_start;
+ static xbt::signal<void(ActorPtr)> on_completion;
- Activity* start() override;
- Activity* wait() override;
- Activity* wait(double timeout) override;
- Activity* cancel() override;
- bool test();
+ Exec* start() override;
+ Exec* wait() override;
+ Exec* wait_for(double timeout) override;
+ Exec* cancel() override;
+ bool test() override;
ExecPtr set_priority(double priority);
ExecPtr set_bound(double bound);
double get_remaining() override;
double get_remaining_ratio();
+#ifndef DOXYGEN
//////////////// Deprecated functions
- /** @deprecated See Exec::set_priority() */
+ XBT_ATTRIB_DEPRECATED_v324("Please use Exec::wait_for()") void wait(double t) override { wait_for(t); }
XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_priority()") ExecPtr setPriority(double priority)
{
return set_priority(priority);
}
- /** @deprecated See Exec::set_bound() */
XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_bound()") ExecPtr setBound(double bound) { return set_bound(bound); }
- /** @deprecated See Exec::set_host() */
XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_host()") ExecPtr setHost(Host* host) { return set_host(host); }
- /** @deprecated See Exec::get_host() */
XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_host()") Host* getHost() { return get_host(); }
- /** @deprecated See Exec::get_remaining_ratio() */
XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_remaining_ratio()") double getRemainingRatio()
{
return get_remaining_ratio();
}
-
-private:
- Host* host_ = nullptr;
- double flops_amount_ = 0.0;
- double priority_ = 1.0;
- double bound_ = 0.0;
- std::string name_ = "";
- std::string tracing_category_ = "";
- std::atomic_int_fast32_t refcount_{0};
-}; // class
-}
-}; // Namespace simgrid::s4u
+#endif
+};
+} // namespace s4u
+} // namespace simgrid
#endif /* SIMGRID_S4U_EXEC_HPP */