include/simgrid/s4u/Exec.hpp

   1 /* Copyright (c) 2017-2019. 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 <xbt/ex.h>
  12
  13 #include <atomic>
  14
  15 namespace simgrid {
  16 namespace s4u {
  17
  18 /** Computation Activity, representing the asynchronous executions.
  19  *
  20  * They are generated from this_actor::exec_init() or Host::execute(), and can be used to model pools of threads or
  21  * similar mechanisms.
  22  */
  23 class XBT_PUBLIC Exec : public Activity {
  24   std::string name_             = "";
  25   double priority_              = 1.0;
  26   double bound_                 = 0.0;
  27   double timeout_               = 0.0;
  28   std::string tracing_category_ = "";
  29   std::atomic_int_fast32_t refcount_{0};
  30   Host* host_ = nullptr;
  31
  32 protected:
  33   Exec();
  34   virtual ~Exec() = default;
  35
  36 public:
  37 #ifndef DOXYGEN
  38   Exec(Exec const&) = delete;
  39   Exec& operator=(Exec const&) = delete;
  40
  41   friend ExecSeq;
  42   friend ExecPar;
  43   friend XBT_PUBLIC void intrusive_ptr_release(Exec* e);
  44   friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
  45 #endif
  46   static xbt::signal<void(Actor const&)> on_start;
  47   static xbt::signal<void(Actor const&)> on_completion;
  48
  49   virtual Exec* start() override          = 0;
  50   virtual double get_remaining_ratio()    = 0;
  51   virtual ExecPtr set_host(Host* host)    = 0;
  52
  53   Exec* wait() override;
  54   Exec* wait_for(double timeout) override;
  55   /*! take a vector of s4u::ExecPtr and return when one of them is finished.
  56    * The return value is the rank of the first finished ExecPtr. */
  57   static int wait_any(std::vector<ExecPtr>* execs) { return wait_any_for(execs, -1); }
  58   /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
  59   static int wait_any_for(std::vector<ExecPtr>* execs, double timeout);
  60
  61   bool test() override;
  62
  63   ExecPtr set_bound(double bound);
  64   ExecPtr set_name(const std::string& name);
  65   ExecPtr set_priority(double priority);
  66   ExecPtr set_tracing_category(const std::string& category);
  67   ExecPtr set_timeout(double timeout);
  68   Exec* cancel() override;
  69   std::string get_name() const { return name_; }
  70   const char* get_cname() const { return name_.c_str(); }
  71
  72   XBT_ATTRIB_DEPRECATED_v324("Please use Exec::wait_for()") void wait(double t) override { wait_for(t); }
  73 };
  74
  75 class XBT_PUBLIC ExecSeq : public Exec {
  76   double flops_amount_ = 0.0;
  77
  78   explicit ExecSeq(sg_host_t host, double flops_amount);
  79
  80 public:
  81   friend XBT_PUBLIC ExecPtr this_actor::exec_init(double flops_amount);
  82
  83   ~ExecSeq() = default;
  84
  85   Exec* start() override;
  86
  87   ExecPtr set_host(Host* host) override;
  88   Host* get_host();
  89
  90   double get_remaining() override;
  91   double get_remaining_ratio() override;
  92 };
  93
  94 class XBT_PUBLIC ExecPar : public Exec {
  95   std::vector<s4u::Host*> hosts_;
  96   std::vector<double> flops_amounts_;
  97   std::vector<double> bytes_amounts_;
  98   explicit ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
  99                    const std::vector<double>& bytes_amounts);
 100   ExecPtr set_host(Host* host) override { return this; }
 101
 102 public:
 103   ~ExecPar() = default;
 104   friend XBT_PUBLIC ExecPtr this_actor::exec_init(const std::vector<s4u::Host*>& hosts,
 105                                                   const std::vector<double>& flops_amounts,
 106                                                   const std::vector<double>& bytes_amounts);
 107   double get_remaining() override;
 108   double get_remaining_ratio() override;
 109   Exec* start() override;
 110 };
 111
 112 } // namespace s4u
 113 } // namespace simgrid
 114
 115 #endif /* SIMGRID_S4U_EXEC_HPP */