1 /* Copyright (c) 2017-2019. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_S4U_EXEC_HPP
7 #define SIMGRID_S4U_EXEC_HPP
9 #include <simgrid/forward.h>
10 #include <simgrid/s4u/Activity.hpp>
18 /** Computation Activity, representing the asynchronous executions.
20 * They are generated from this_actor::exec_init() or Host::execute(), and can be used to model pools of threads or
23 class XBT_PUBLIC Exec : public Activity_T<Exec> {
24 double priority_ = 1.0;
26 double timeout_ = 0.0;
27 std::atomic_int_fast32_t refcount_{0};
28 Host* host_ = nullptr;
32 virtual ~Exec() = default;
36 Exec(Exec const&) = delete;
37 Exec& operator=(Exec const&) = delete;
42 friend XBT_PUBLIC void intrusive_ptr_release(Exec* e);
43 friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
44 static xbt::signal<void(ActorPtr)> on_start;
45 static xbt::signal<void(ActorPtr)> on_completion;
47 virtual Exec* start() override = 0;
48 virtual double get_remaining_ratio() = 0;
49 virtual ExecPtr set_host(Host* host) = 0;
51 Exec* wait() override;
52 Exec* wait_for(double timeout) override;
55 ExecPtr set_bound(double bound);
56 ExecPtr set_priority(double priority);
57 ExecPtr set_timeout(double timeout);
58 Exec* cancel() override;
60 XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_priority()") ExecPtr setPriority(double priority)
62 return set_priority(priority);
64 XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_bound()") ExecPtr setBound(double bound) { return set_bound(bound); }
65 XBT_ATTRIB_DEPRECATED_v324("Please use Exec::wait_for()") void wait(double t) override { wait_for(t); }
68 class XBT_PUBLIC ExecSeq : public Exec {
69 double flops_amount_ = 0.0;
71 explicit ExecSeq(sg_host_t host, double flops_amount);
74 friend XBT_PUBLIC ExecPtr this_actor::exec_init(double flops_amount);
78 Exec* start() override;
80 ExecPtr set_host(Host* host) override;
83 double get_remaining() override;
84 double get_remaining_ratio() override;
87 //////////////// Deprecated functions
88 XBT_ATTRIB_DEPRECATED_v323("Please use Exec::set_host()") ExecPtr setHost(Host* host) { return set_host(host); }
89 XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_host()") Host* getHost() { return get_host(); }
90 XBT_ATTRIB_DEPRECATED_v323("Please use Exec::get_remaining_ratio()") double getRemainingRatio()
92 return get_remaining_ratio();
97 class XBT_PUBLIC ExecPar : public Exec {
98 std::vector<s4u::Host*> hosts_;
99 std::vector<double> flops_amounts_;
100 std::vector<double> bytes_amounts_;
101 explicit ExecPar(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
102 const std::vector<double>& bytes_amounts);
103 ExecPtr set_host(Host* host) override { return this; }
106 ~ExecPar() = default;
107 friend XBT_PUBLIC ExecPtr this_actor::exec_init(const std::vector<s4u::Host*>& hosts,
108 const std::vector<double>& flops_amounts,
109 const std::vector<double>& bytes_amounts);
110 double get_remaining() override;
111 double get_remaining_ratio() override;
112 Exec* start() override;
116 } // namespace simgrid
118 #endif /* SIMGRID_S4U_EXEC_HPP */