Logo AND Algorithmique Numérique Distribuée

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