include/simgrid/s4u/Exec.hpp

   1 /* Copyright (c) 2017-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_S4U_EXEC_HPP
   7 #define SIMGRID_S4U_EXEC_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <simgrid/s4u/Activity.hpp>
  11 #include <simgrid/s4u/Actor.hpp>
  12 #include <xbt/ex.h>
  13
  14 namespace simgrid {
  15 namespace s4u {
  16
  17 /** Computation Activity, representing the asynchronous executions.
  18  *
  19  * @beginrst
  20  * Most of them are created with :cpp:func:`simgrid::s4u::this_actor::exec_init()` or
  21  * :cpp:func:`simgrid::s4u::Host::execute()`, and represent a classical (sequential) execution. This can be used to
  22  * simulate some computation occurring in another thread when the calling actor is not blocked during the execution.
  23  *
  24  * You can also use :cpp:func:`simgrid::s4u::this_actor::parallel_execute()` to create *parallel* executions. These
  25  * objects represent distributed computations involving computations on several hosts and communications between them.
  26  * Such objects can for example represent a matrix multiplication done with ScaLAPACK on a real system. Once created,
  27  * parallel Exec are very similar to the sequential ones. The only difference is that you cannot migrate them, and their
  28  * remaining amount of work can only be defined as a ratio. See the doc of :cpp:func:`simgrid::s4u::Exec::get_remaining`
  29  * and :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio` for more info.
  30  * @endrst
  31  */
  32 class XBT_PUBLIC Exec : public Activity_T<Exec> {
  33   friend kernel::activity::ExecImpl;
  34   bool parallel_ = false;
  35
  36 protected:
  37   explicit Exec(kernel::activity::ExecImplPtr pimpl);
  38
  39   void complete(Activity::State state) override;
  40
  41 public:
  42 #ifndef DOXYGEN
  43   Exec(Exec const&) = delete;
  44   Exec& operator=(Exec const&) = delete;
  45 #endif
  46   static xbt::signal<void(Exec const&)> on_start;
  47   static xbt::signal<void(Exec const&)> on_completion;
  48
  49   static ExecPtr init();
  50   Exec* start() override;
  51
  52   /*! take a vector of s4u::ExecPtr and return when one of them is finished.
  53    * The return value is the rank of the first finished ExecPtr. */
  54   static int wait_any(const std::vector<ExecPtr>& execs) { return wait_any_for(execs, -1); }
  55   /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
  56   static int wait_any_for(const std::vector<ExecPtr>& execs, double timeout);
  57
  58   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter")
  59   static int wait_any(std::vector<ExecPtr>* execs) { return wait_any_for(*execs, -1); }
  60   XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for first parameter")
  61   static int wait_any_for(std::vector<ExecPtr>* execs, double timeout) { return wait_any_for(*execs, timeout); }
  62
  63   /** @brief On sequential executions, returns the amount of flops that remain to be done; This cannot be used on
  64    * parallel executions. */
  65   double get_remaining() const override;
  66   double get_remaining_ratio() const;
  67   ExecPtr set_host(Host* host);
  68   ExecPtr set_hosts(const std::vector<Host*>& hosts);
  69
  70   ExecPtr set_flops_amount(double flops_amount);
  71   ExecPtr set_flops_amounts(const std::vector<double>& flops_amounts);
  72   ExecPtr set_bytes_amounts(const std::vector<double>& bytes_amounts);
  73
  74   ExecPtr set_bound(double bound);
  75   ExecPtr set_priority(double priority);
  76   XBT_ATTRIB_DEPRECATED_v329("Please use exec_init(...)->wait_for(timeout)") ExecPtr set_timeout(double timeout);
  77
  78   Host* get_host() const;
  79   unsigned int get_host_number() const;
  80   double get_start_time() const;
  81   double get_finish_time() const;
  82   double get_cost() const;
  83   bool is_parallel() const { return parallel_; }
  84   bool is_assigned() const override;
  85 };
  86
  87 } // namespace s4u
  88 } // namespace simgrid
  89
  90 #endif /* SIMGRID_S4U_EXEC_HPP */