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
  12 #include <atomic>
  13
  14 namespace simgrid {
  15 namespace s4u {
  16
  17 /** Computation Activity, representing the asynchronous executions.
  18  *
  19  * They are generated from simgrid::s4u::this_actor::exec_init() or simgrid::s4u::Host::execute(),
  20  * and can be used to model pools of threads or similar mechanisms.
  21  */
  22
  23 class XBT_PUBLIC Exec : public Activity {
  24   Exec() : Activity() {}
  25 public:
  26   friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Exec * e);
  27   friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Exec * e);
  28   friend XBT_PUBLIC ExecPtr this_actor::exec_init(double flops_amount);
  29
  30   ~Exec() = default;
  31
  32   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_start;
  33   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_completion;
  34
  35   Exec* start() override;
  36   Exec* wait() override;
  37   Exec* wait_for(double timeout) override;
  38   Exec* cancel() override;
  39   bool test() override;
  40
  41   ExecPtr set_priority(double priority);
  42   ExecPtr set_bound(double bound);
  43   ExecPtr set_host(Host* host);
  44   ExecPtr set_name(std::string name);
  45   ExecPtr set_tracing_category(std::string category);
  46   Host* get_host();
  47
  48   double get_remaining() override;
  49   double get_remaining_ratio();
  50
  51 #ifndef DOXYGEN
  52   //////////////// Deprecated functions
  53   XBT_ATTRIB_DEPRECATED_v324("Please use Exec::wait_for()") void wait(double t) override { wait_for(t); }
  54   XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_priority()") ExecPtr setPriority(double priority)
  55   {
  56     return set_priority(priority);
  57   }
  58   XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_bound()") ExecPtr setBound(double bound) { return set_bound(bound); }
  59   XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_host()") ExecPtr setHost(Host* host) { return set_host(host); }
  60   XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_host()") Host* getHost() { return get_host(); }
  61   XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_remaining_ratio()") double getRemainingRatio()
  62   {
  63     return get_remaining_ratio();
  64   }
  65 #endif
  66
  67 private:
  68   Host* host_                   = nullptr;
  69   double flops_amount_          = 0.0;
  70   double priority_              = 1.0;
  71   double bound_                 = 0.0;
  72   std::string name_             = "";
  73   std::string tracing_category_ = "";
  74   std::atomic_int_fast32_t refcount_{0};
  75 }; // class
  76 }
  77 }; // Namespace simgrid::s4u
  78
  79 #endif /* SIMGRID_S4U_EXEC_HPP */