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 #endif
  41
  42   friend simgrid::s4u::ExecSeq;
  43   friend simgrid::s4u::ExecPar;
  44   friend XBT_PUBLIC void intrusive_ptr_release(Exec* e);
  45   friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
  46   static xbt::signal<void(ActorPtr)> on_start;
  47   static xbt::signal<void(ActorPtr)> 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   bool test() override;
  56
  57   ExecPtr set_bound(double bound);
  58   ExecPtr set_name(const std::string& name);
  59   ExecPtr set_priority(double priority);
  60   ExecPtr set_tracing_category(const std::string& category);
  61   ExecPtr set_timeout(double timeout);
  62   Exec* cancel() override;
  63
  64   XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_priority()") ExecPtr setPriority(double priority)
  65   {
  66     return set_priority(priority);
  67   }
  68   XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_bound()") ExecPtr setBound(double bound) { return set_bound(bound); }
  69   XBT_ATTRIB_DEPRECATED_v324("Please use Exec::wait_for()") void wait(double t) override { wait_for(t); }
  70 };
  71
  72 class XBT_PUBLIC ExecSeq : public Exec {
  73   double flops_amount_ = 0.0;
  74
  75   explicit ExecSeq(sg_host_t host, double flops_amount);
  76
  77 public:
  78   friend XBT_PUBLIC ExecPtr this_actor::exec_init(double flops_amount);
  79
  80   ~ExecSeq() = default;
  81
  82   Exec* start() override;
  83
  84   ExecPtr set_host(Host* host) override;
  85   Host* get_host();
  86
  87   double get_remaining() override;
  88   double get_remaining_ratio() override;
  89
  90 #ifndef DOXYGEN
  91   //////////////// Deprecated functions
  92   XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_host()") ExecPtr setHost(Host* host) { return set_host(host); }
  93   XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_host()") Host* getHost() { return get_host(); }
  94   XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_remaining_ratio()") double getRemainingRatio()
  95   {
  96     return get_remaining_ratio();
  97   }
  98 #endif
  99 };
 100
 101 class XBT_PUBLIC ExecPar : public Exec {
 102   std::vector<s4u::Host*> hosts_;
 103   std::vector<double> flops_amounts_;
 104   std::vector<double> bytes_amounts_;
 105   explicit ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
 106                    const std::vector<double>& bytes_amounts);
 107   ExecPtr set_host(Host* host) override { return this; }
 108
 109 public:
 110   ~ExecPar() = default;
 111   friend XBT_PUBLIC ExecPtr this_actor::exec_init(const std::vector<s4u::Host*>& hosts,
 112                                                   const std::vector<double>& flops_amounts,
 113                                                   const std::vector<double>& bytes_amounts);
 114   double get_remaining() override;
 115   double get_remaining_ratio() override;
 116   Exec* start() override;
 117 };
 118
 119 } // namespace s4u
 120 } // namespace simgrid
 121
 122 #endif /* SIMGRID_S4U_EXEC_HPP */