X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ce930ad96b622e2b3856b7d9c3d97e60ec2c93a1..b372d23d3d8818b4547ef207f43b45709298a002:/include/simgrid/s4u/Exec.hpp

diff --git a/include/simgrid/s4u/Exec.hpp b/include/simgrid/s4u/Exec.hpp
index 1e9de25b5b..d2a6a12ba3 100644
--- a/include/simgrid/s4u/Exec.hpp
+++ b/include/simgrid/s4u/Exec.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2017-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2017-2020. 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. */
@@ -11,42 +11,55 @@
 #include <simgrid/s4u/Actor.hpp>
 #include <xbt/ex.h>
 
-#include <atomic>
-
 namespace simgrid {
 namespace s4u {
 
 /** 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.
+ * @rst
+ * Most of them are created with :cpp:func:`simgrid::s4u::this_actor::exec_init()` or
+ * :cpp:func:`simgrid::s4u::Host::execute()`, and represent a classical (sequential) execution. This can be used to
+ * simulate some computation occurring in another thread when the calling actor is not blocked during the execution.
+ *
+ * You can also use :cpp:func:`simgrid::s4u::this_actor::parallel_execute()` to create *parallel* executions. These
+ * objects represent distributed computations involving computations on several hosts and communications between them.
+ * Such objects can for example represent a matrix multiplication done with ScaLAPACK on a real system. Once created,
+ * parallel Exec are very similar to the sequential ones. The only difference is that you cannot migrate them, and their
+ * remaining amount of work can only be defined as a ratio. See the doc of :cpp:func:`simgrid::s4u::Exec::get_remaining`
+ * and :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio` for more info.
+ * @endrst
  */
 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;
+  std::vector<double> flops_amounts_;
+  std::vector<double> bytes_amounts_;
+  std::vector<Host*> hosts_;
+  bool parallel_ = false;
 
 public:
+  Exec();
+  ~Exec() override = default;
 #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;
+  static xbt::signal<void(Exec const&)> on_start;
+  static xbt::signal<void(Exec const&)> on_completion;
 
-  virtual Exec* start() override          = 0;
-  virtual double get_remaining_ratio()    = 0;
-  virtual ExecPtr set_host(Host* host)    = 0;
+  Exec* start() override;
+  /** @brief On sequential executions, returns the amount of flops that remain to be done; This cannot be used on
+   * parallel executions. */
+  double get_remaining() const override;
+  double get_remaining_ratio() const;
+  ExecPtr set_host(Host* host);
+  ExecPtr set_hosts(const std::vector<Host*>& hosts);
+
+  ExecPtr set_flops_amount(double flops_amount);
+  ExecPtr set_flops_amounts(const std::vector<double>& flops_amounts);
+  ExecPtr set_bytes_amounts(const std::vector<double>& bytes_amounts);
 
   Exec* wait() override;
   Exec* wait_for(double timeout) override;
@@ -56,55 +69,17 @@ public:
   /*! 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_bound(double bound);
   ExecPtr set_priority(double priority);
-  ExecPtr set_timeout(double timeout);
+  XBT_ATTRIB_DEPRECATED_v329("Please use exec_init(...)->wait_for(timeout)") 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;
-
-  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;
+  bool is_parallel() const { return parallel_; }
 };
 
 } // namespace s4u