Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
properly split init/start for Exec activities
[simgrid.git] / src / s4u / s4u_Exec.cpp
1 /* Copyright (c) 2006-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 #include "simgrid/s4u/Actor.hpp"
7 #include "simgrid/s4u/Exec.hpp"
8 #include "src/kernel/activity/ExecImpl.hpp"
9 #include "xbt/log.h"
10
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_exec, s4u_activity, "S4U asynchronous executions");
12
13 namespace simgrid {
14 namespace s4u {
15 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Exec::on_start;
16 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Exec::on_completion;
17
18 Exec::Exec(sg_host_t host, double flops_amount) : Activity(), host_(host), flops_amount_(flops_amount)
19 {
20   Activity::set_remaining(flops_amount_);
21   pimpl_ = simix::simcall([this] {
22     return kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl(name_, tracing_category_,
23                                                                         /*timeout_detector*/ nullptr, host_));
24   });
25 }
26
27 Exec* Exec::start()
28 {
29   simix::simcall([this] {
30     dynamic_cast<kernel::activity::ExecImpl*>(pimpl_.get())->start(flops_amount_, 1. / priority_, bound_);
31   });
32   state_ = State::STARTED;
33   on_start(Actor::self());
34   return this;
35 }
36
37 Exec* Exec::cancel()
38 {
39   simgrid::simix::simcall([this] { dynamic_cast<kernel::activity::ExecImpl*>(pimpl_.get())->cancel(); });
40   state_ = State::CANCELED;
41   return this;
42 }
43
44 Exec* Exec::wait()
45 {
46   if (state_ == State::INITED)
47     start();
48   simcall_execution_wait(pimpl_);
49   state_ = State::FINISHED;
50   on_completion(Actor::self());
51   return this;
52 }
53
54 Exec* Exec::wait_for(double)
55 {
56   THROW_UNIMPLEMENTED;
57   return this;
58 }
59
60 /** @brief Returns whether the state of the exec is finished */
61 bool Exec::test()
62 {
63   xbt_assert(state_ == State::INITED || state_ == State::STARTED || state_ == State::FINISHED);
64
65   if (state_ == State::FINISHED)
66     return true;
67
68   if (state_ == State::INITED)
69     this->start();
70
71   if (simcall_execution_test(pimpl_)) {
72     state_ = State::FINISHED;
73     return true;
74   }
75
76   return false;
77 }
78
79 /** @brief  Change the execution priority, don't you think?
80  *
81  * An execution with twice the priority will get twice the amount of flops when the resource is shared.
82  * The default priority is 1.
83  *
84  * Currently, this cannot be changed once the exec started. */
85 ExecPtr Exec::set_priority(double priority)
86 {
87   xbt_assert(state_ == State::INITED, "Cannot change the priority of an exec after its start");
88   priority_ = priority;
89   return this;
90 }
91
92 /** @brief change the execution bound, ie the maximal amount of flops per second that it may consume, regardless of what
93  * the host may deliver
94  *
95  * Currently, this cannot be changed once the exec started. */
96 ExecPtr Exec::set_bound(double bound)
97 {
98   xbt_assert(state_ == State::INITED, "Cannot change the bound of an exec after its start");
99   bound_ = bound;
100   return this;
101 }
102
103 /** @brief Change the host on which this activity takes place.
104  *
105  * The activity cannot be terminated already (but it may be started). */
106 ExecPtr Exec::set_host(Host* host)
107 {
108   xbt_assert(state_ == State::INITED || state_ == State::STARTED,
109              "Cannot change the host of an exec once it's done (state: %d)", (int)state_);
110   if (state_ == State::STARTED)
111     boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->migrate(host);
112   host_ = host;
113   boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->host_ = host;
114   return this;
115 }
116
117 ExecPtr Exec::set_name(std::string name)
118 {
119   xbt_assert(state_ == State::INITED, "Cannot change the name of an exec after its start");
120   name_ = name;
121   return this;
122 }
123
124 ExecPtr Exec::set_tracing_category(std::string category)
125 {
126   xbt_assert(state_ == State::INITED, "Cannot change the tracing category of an exec after its start");
127   tracing_category_ = category;
128   return this;
129 }
130
131 /** @brief Retrieve the host on which this activity takes place. */
132 Host* Exec::get_host()
133 {
134   return host_;
135 }
136
137 /** @brief Returns the amount of flops that remain to be done */
138 double Exec::get_remaining()
139 {
140   return simgrid::simix::simcall(
141       [this]() { return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->get_remaining(); });
142 }
143
144 /** @brief Returns the ratio of elements that are still to do
145  *
146  * The returned value is between 0 (completely done) and 1 (nothing done yet).
147  */
148 double Exec::get_remaining_ratio()
149 {
150   return simgrid::simix::simcall([this]() {
151     return boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_)->get_remaining_ratio();
152   });
153 }
154
155 void intrusive_ptr_release(simgrid::s4u::Exec* e)
156 {
157   if (e->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
158     std::atomic_thread_fence(std::memory_order_acquire);
159     delete e;
160   }
161 }
162
163 void intrusive_ptr_add_ref(simgrid::s4u::Exec* e)
164 {
165   e->refcount_.fetch_add(1, std::memory_order_relaxed);
166 }
167 } // namespace s4u
168 } // namespace simgrid