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 {
24 std::string name_ = "";
25 double priority_ = 1.0;
27 double timeout_ = 0.0;
28 std::string tracing_category_ = "";
29 std::atomic_int_fast32_t refcount_{0};
30 Host* host_ = nullptr;
34 virtual ~Exec() = default;
38 Exec(Exec const&) = delete;
39 Exec& operator=(Exec const&) = delete;
43 friend XBT_PUBLIC void intrusive_ptr_release(Exec* e);
44 friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
46 static xbt::signal<void(Actor const&)> on_start;
47 static xbt::signal<void(Actor const&)> on_completion;
49 virtual Exec* start() override = 0;
50 virtual double get_remaining_ratio() = 0;
51 virtual ExecPtr set_host(Host* host) = 0;
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);
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 const std::string& get_name() const { return name_; }
70 const char* get_cname() const { return name_.c_str(); }
72 XBT_ATTRIB_DEPRECATED_v324("Please use Exec::wait_for()") void wait(double t) override { wait_for(t); }
75 class XBT_PUBLIC ExecSeq : public Exec {
76 double flops_amount_ = 0.0;
78 explicit ExecSeq(sg_host_t host, double flops_amount);
81 friend XBT_PUBLIC ExecPtr this_actor::exec_init(double flops_amount);
85 Exec* start() override;
87 ExecPtr set_host(Host* host) override;
90 double get_remaining() override;
91 double get_remaining_ratio() override;
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*) override { /* parallel exec cannot be moved */ THROW_UNIMPLEMENTED; }
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;
113 } // namespace simgrid
115 #endif /* SIMGRID_S4U_EXEC_HPP */