Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' into CRTP
[simgrid.git] / include / simgrid / s4u / Exec.hpp
index 37c85ef..1e9de25 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2017. 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/forward.hpp>
+#include <simgrid/s4u/Actor.hpp>
+#include <xbt/ex.h>
 
 #include <atomic>
 
 namespace simgrid {
 namespace s4u {
 
-XBT_PUBLIC_CLASS Exec : public Activity
-{
-  Exec() : Activity() {}
+/** Computation Activity, representing the asynchronous executions.
+ *
+ * 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};
+
+protected:
+  Exec();
+  virtual ~Exec() = default;
+
 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;
+
+  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;
 
-  ~Exec() = default;
+  virtual Exec* start() override          = 0;
+  virtual double get_remaining_ratio()    = 0;
+  virtual ExecPtr set_host(Host* host)    = 0;
 
-  Activity* start() override;
-  Activity* wait() override;
-  Activity* wait(double timeout) override;
-  bool test();
+  Exec* wait() override;
+  Exec* wait_for(double timeout) 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);
 
-  ExecPtr setPriority(double priority);
-  ExecPtr setHost(Host * host);
-  Host* getHost() { return host_; }
+  bool test() override;
 
-  double getRemains() override;
-  double getRemainingRatio();
+  ExecPtr set_bound(double bound);
+  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;
+};
 
-private:
-  Host* host_          = nullptr;
+class XBT_PUBLIC ExecSeq : public Exec {
   double flops_amount_ = 0.0;
-  double priority_     = 1.0;
 
-  std::atomic_int_fast32_t refcount_{0};
-}; // class
-}
-}; // Namespace simgrid::s4u
+  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;
+
+  double get_remaining() override;
+  double get_remaining_ratio() override;
+};
+
+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; }
+
+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 */