Update copyright lines for 2022.

[simgrid.git] / include / simgrid / s4u / Exec.hpp

diff --git a/include/simgrid/s4u/Exec.hpp b/include/simgrid/s4u/Exec.hpp
index b15ed1b..754b4bd 100644 (file)
--- a/include/simgrid/s4u/Exec.hpp
+++ b/include/simgrid/s4u/Exec.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2017-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2017-2022. 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. */
@@ -16,7 +16,7 @@ namespace s4u {
 
 /** Computation Activity, representing the asynchronous executions.
  *
- * @rst
+ * @beginrst
  * 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.
@@ -30,56 +30,66 @@ namespace s4u {
  * @endrst
  */
 class XBT_PUBLIC Exec : public Activity_T<Exec> {
-  double priority_              = 1.0;
-  double bound_                 = 0.0;
-  double timeout_               = 0.0;
-  std::vector<double> flops_amounts_;
-  std::vector<double> bytes_amounts_;
-  std::vector<Host*> hosts_;
+#ifndef DOXYGEN
+  friend kernel::activity::ExecImpl;
+  friend kernel::EngineImpl; // Auto-completes the execs of maestro (in simDAG)
+#endif
+
   bool parallel_ = false;
 
+protected:
+  explicit Exec(kernel::activity::ExecImplPtr pimpl);
+
+  void reset() const;
+
+  static xbt::signal<void(Exec const&)> on_start;
+
 public:
-  Exec();
-  ~Exec() override = default;
 #ifndef DOXYGEN
   Exec(Exec const&) = delete;
   Exec& operator=(Exec const&) = delete;
-
 #endif
-  static xbt::signal<void(Actor const&, Exec const&)> on_start;
-  static xbt::signal<void(Actor const&, Exec const&)> on_completion;
+  /*! Signal fired each time that an execution actually starts (no veto) */
+  static void on_start_cb(const std::function<void(Exec const&)>& cb) { on_start.connect(cb); }
 
+  static ExecPtr init();
   Exec* start() 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 ssize_t wait_any(const 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 ssize_t wait_any_for(const std::vector<ExecPtr>& execs, double timeout);
+
+#ifndef DOXYGEN
+  XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter")
+  static int wait_any(std::vector<ExecPtr>* execs) { return static_cast<int>(wait_any_for(*execs, -1)); }
+  XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for first parameter")
+  static int wait_any_for(std::vector<ExecPtr>* execs, double timeout) { return static_cast<int>(wait_any_for(*execs, timeout)); }
+#endif
+
   /** @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 unset_host();
+  ExecPtr unset_hosts() { return unset_host(); }
 
   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;
-  /*! 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 set_bound(double bound);
   ExecPtr set_priority(double priority);
-  XBT_ATTRIB_DEPRECATED_v329("Please use exec_init(...)->wait_for(timeout)") ExecPtr set_timeout(double timeout);
+  ExecPtr update_priority(double priority);
 
-  Exec* cancel() override;
   Host* get_host() const;
   unsigned int get_host_number() const;
-  double get_start_time() const;
-  double get_finish_time() const;
   double get_cost() const;
   bool is_parallel() const { return parallel_; }
+  bool is_assigned() const override;
 };
 
 } // namespace s4u