-/* 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. */
#include <simgrid/forward.h>
#include <simgrid/s4u/Activity.hpp>
+#include <simgrid/s4u/Actor.hpp>
+#include <xbt/ex.h>
#include <atomic>
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_T<Exec> {
+ double priority_ = 1.0;
+ double bound_ = 0.0;
+ double timeout_ = 0.0;
+ std::atomic_int_fast32_t refcount_{0};
+ Host* host_ = nullptr;
+
+protected:
+ Exec();
+ virtual ~Exec() = default;
-class XBT_PUBLIC Exec : public Activity {
- Exec() : Activity() {}
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 ExecPtr this_actor::exec_init(double flops_amount);
+#ifndef DOXYGEN
+ Exec(Exec const&) = delete;
+ Exec& operator=(Exec const&) = delete;
- ~Exec() = default;
+ friend ExecSeq;
+ friend ExecPar;
+ friend XBT_PUBLIC void intrusive_ptr_release(Exec* e);
+ friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
+#endif
+ static xbt::signal<void(Actor const&, Exec const&)> on_start;
+ static xbt::signal<void(Actor const&, Exec const&)> on_completion;
- static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_start;
- static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_completion;
+ virtual Exec* start() override = 0;
+ virtual double get_remaining_ratio() = 0;
+ virtual ExecPtr set_host(Host* host) = 0;
- Exec* start() override;
Exec* wait() override;
Exec* wait_for(double timeout) override;
- Exec* cancel() override;
+ /*! take a vector of s4u::ExecPtr and return when one of them is finished.
+ * The return value is the rank of the first finished ExecPtr. */
+ static int wait_any(std::vector<ExecPtr>* execs) { return wait_any_for(execs, -1); }
+ /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
+ static int wait_any_for(std::vector<ExecPtr>* execs, double timeout);
+
bool test() override;
- ExecPtr set_priority(double priority);
ExecPtr set_bound(double bound);
- ExecPtr set_host(Host* host);
- ExecPtr set_name(std::string name);
- ExecPtr set_tracing_category(std::string category);
+ ExecPtr set_priority(double priority);
+ ExecPtr set_timeout(double timeout);
+ Exec* cancel() override;
+ const std::string& get_name() const { return name_; }
+ const char* get_cname() const { return name_.c_str(); }
+ Host* get_host() const;
+ unsigned int get_host_number() const;
+ double get_start_time() const;
+ double get_finish_time() const;
+ double get_cost() const;
+};
+
+class XBT_PUBLIC ExecSeq : public Exec {
+ double flops_amount_ = 0.0;
+
+ explicit ExecSeq(sg_host_t host, double flops_amount);
+
+public:
+ friend XBT_PUBLIC ExecPtr this_actor::exec_init(double flops_amount);
+
+ ~ExecSeq() = default;
+
+ Exec* start() override;
+
+ ExecPtr set_host(Host* host) override;
Host* get_host();
double get_remaining() override;
- double get_remaining_ratio();
+ double get_remaining_ratio() override;
+};
-#ifndef DOXYGEN
- //////////////// Deprecated functions
- 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);
- }
- XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_bound()") ExecPtr setBound(double bound) { return set_bound(bound); }
- XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_host()") ExecPtr setHost(Host* host) { return set_host(host); }
- XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_host()") Host* getHost() { return get_host(); }
- XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_remaining_ratio()") double getRemainingRatio()
- {
- return get_remaining_ratio();
- }
-#endif
+class XBT_PUBLIC ExecPar : public Exec {
+ std::vector<s4u::Host*> hosts_;
+ std::vector<double> flops_amounts_;
+ std::vector<double> bytes_amounts_;
+ explicit ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
+ const std::vector<double>& bytes_amounts);
+ ExecPtr set_host(Host*) override { /* parallel exec cannot be moved */ THROW_UNIMPLEMENTED; }
-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
+public:
+ ~ExecPar() = default;
+ friend XBT_PUBLIC ExecPtr this_actor::exec_init(const std::vector<s4u::Host*>& hosts,
+ const std::vector<double>& flops_amounts,
+ const std::vector<double>& bytes_amounts);
+ double get_remaining() override;
+ double get_remaining_ratio() override;
+ Exec* start() override;
+};
+
+} // namespace s4u
+} // namespace simgrid
#endif /* SIMGRID_S4U_EXEC_HPP */
