1 /* Copyright (c) 2007-2022. 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 #include <simgrid/modelchecker.h>
7 #include <simgrid/s4u/Activity.hpp>
8 #include <simgrid/s4u/Engine.hpp>
10 #include "src/kernel/activity/ActivityImpl.hpp"
11 #include "src/kernel/activity/CommImpl.hpp"
12 #include "src/kernel/activity/Synchro.hpp"
13 #include "src/kernel/actor/ActorImpl.hpp"
14 #include "src/kernel/actor/SimcallObserver.hpp"
15 #include "src/kernel/resource/CpuImpl.hpp"
16 #include "src/mc/mc_replay.hpp"
18 #include <boost/range/algorithm.hpp>
19 #include <cmath> // isfinite()
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_activity, kernel, "Kernel activity-related synchronization");
23 namespace simgrid::kernel::activity {
25 ActivityImpl::~ActivityImpl()
28 XBT_DEBUG("Destroy activity %p", this);
31 void ActivityImpl::register_simcall(actor::Simcall* simcall)
33 simcalls_.push_back(simcall);
34 simcall->issuer_->waiting_synchro_ = this;
37 void ActivityImpl::unregister_simcall(actor::Simcall* simcall)
39 // Remove the first occurrence of simcall:
40 auto j = boost::range::find(simcalls_, simcall);
41 if (j != simcalls_.end())
45 void ActivityImpl::clean_action()
48 surf_action_->unref();
49 surf_action_ = nullptr;
53 double ActivityImpl::get_remaining() const
55 return surf_action_ ? surf_action_->get_remains() : 0;
58 const char* ActivityImpl::get_state_str() const
60 return to_c_str(state_);
63 bool ActivityImpl::test(actor::ActorImpl* issuer)
65 if (state_ != State::WAITING && state_ != State::RUNNING) {
67 issuer->exception_ = nullptr; // Do not propagate exception in that case
71 if (auto* observer = dynamic_cast<kernel::actor::ActivityTestSimcall*>(issuer->simcall_.observer_))
72 observer->set_result(false);
77 ssize_t ActivityImpl::test_any(actor::ActorImpl* issuer, const std::vector<ActivityImpl*>& activities)
79 auto* observer = dynamic_cast<kernel::actor::ActivityTestanySimcall*>(issuer->simcall_.observer_);
80 xbt_assert(observer != nullptr);
82 if (MC_is_active() || MC_record_replay_is_active()) {
83 int idx = observer->get_value();
84 xbt_assert(idx == -1 || activities[idx]->test(issuer));
88 for (std::size_t i = 0; i < activities.size(); ++i) {
89 if (activities[i]->test(issuer)) {
90 observer->set_result(i);
97 void ActivityImpl::wait_for(actor::ActorImpl* issuer, double timeout)
99 XBT_DEBUG("Wait for execution of synchro %p, state %s", this, get_state_str());
100 xbt_assert(std::isfinite(timeout), "timeout is not finite!");
102 /* Associate this simcall to the synchro */
103 register_simcall(&issuer->simcall_);
105 xbt_assert(not MC_is_active() && not MC_record_replay_is_active(), "MC is currently not supported here.");
107 /* If the synchro is already finished then perform the error handling */
108 if (state_ != State::WAITING && state_ != State::RUNNING) {
111 /* we need a sleep action (even when the timeout is infinite) to be notified of host failures */
112 /* Comms handle that a bit differently of the other activities */
113 if (auto* comm = dynamic_cast<CommImpl*>(this)) {
114 resource::Action* sleep_action = issuer->get_host()->get_cpu()->sleep(timeout);
115 sleep_action->set_activity(comm);
117 if (issuer == comm->src_actor_)
118 comm->src_timeout_ = sleep_action;
120 comm->dst_timeout_ = sleep_action;
122 SynchroImplPtr synchro(new SynchroImpl([this, issuer]() {
123 this->unregister_simcall(&issuer->simcall_);
124 issuer->waiting_synchro_ = nullptr;
125 issuer->exception_ = nullptr;
126 auto* observer = dynamic_cast<kernel::actor::ActivityWaitSimcall*>(issuer->simcall_.observer_);
127 xbt_assert(observer != nullptr);
128 observer->set_result(true); // Returns that the wait_for timeouted
130 synchro->set_host(issuer->get_host()).set_timeout(timeout).start();
131 synchro->register_simcall(&issuer->simcall_);
136 void ActivityImpl::wait_any_for(actor::ActorImpl* issuer, const std::vector<ActivityImpl*>& activities, double timeout)
138 XBT_DEBUG("Wait for execution of any synchro");
139 if (MC_is_active() || MC_record_replay_is_active()) {
140 auto* observer = dynamic_cast<kernel::actor::ActivityWaitanySimcall*>(issuer->simcall_.observer_);
141 xbt_assert(observer != nullptr);
142 xbt_assert(timeout <= 0.0, "Timeout not implemented for waitany in the model-checker");
143 if (int idx = observer->get_value(); idx != -1) {
144 auto* act = activities.at(idx);
145 act->simcalls_.push_back(&issuer->simcall_);
146 observer->set_result(idx);
147 act->set_state(State::DONE);
154 issuer->simcall_.timeout_cb_ = nullptr;
156 issuer->simcall_.timeout_cb_ = timer::Timer::set(s4u::Engine::get_clock() + timeout, [issuer, &activities]() {
157 issuer->simcall_.timeout_cb_ = nullptr;
158 for (auto* act : activities)
159 act->unregister_simcall(&issuer->simcall_);
160 // default result (-1) is set in actor::ActivityWaitanySimcall
161 issuer->simcall_answer();
165 for (auto* act : activities) {
166 /* associate this simcall to the the synchro */
167 act->simcalls_.push_back(&issuer->simcall_);
168 /* see if the synchro is already finished */
169 if (act->get_state() != State::WAITING && act->get_state() != State::RUNNING) {
174 XBT_DEBUG("Exit from ActivityImlp::wait_any_for");
177 void ActivityImpl::suspend()
179 if (surf_action_ == nullptr)
181 XBT_VERB("This activity is suspended (remain: %f)", surf_action_->get_remains());
182 surf_action_->suspend();
183 s4u::Activity::on_suspended(*get_iface());
186 void ActivityImpl::resume()
188 if (surf_action_ == nullptr)
190 XBT_VERB("This activity is resumed (remain: %f)", surf_action_->get_remains());
191 surf_action_->resume();
192 s4u::Activity::on_resumed(*get_iface());
195 void ActivityImpl::cancel()
197 XBT_VERB("Activity %p is canceled", this);
198 if (surf_action_ != nullptr)
199 surf_action_->cancel();
200 state_ = State::CANCELED;
203 void ActivityImpl::handle_activity_waitany(actor::Simcall* simcall)
205 /* If a waitany simcall is waiting for this synchro to finish, then remove it from the other synchros in the waitany
206 * list. Afterwards, get the position of the actual synchro in the waitany list and return it as the result of the
208 if (auto* observer = dynamic_cast<actor::ActivityWaitanySimcall*>(simcall->observer_)) {
209 if (simcall->timeout_cb_) {
210 simcall->timeout_cb_->remove();
211 simcall->timeout_cb_ = nullptr;
214 auto activities = observer->get_activities();
215 for (auto* act : activities)
216 act->unregister_simcall(simcall);
218 if (not MC_is_active() && not MC_record_replay_is_active()) {
219 auto element = std::find(activities.begin(), activities.end(), this);
220 int rank = element != activities.end() ? static_cast<int>(std::distance(activities.begin(), element)) : -1;
221 observer->set_result(rank);
226 // boost::intrusive_ptr<Activity> support:
227 void intrusive_ptr_add_ref(ActivityImpl* activity)
229 activity->refcount_.fetch_add(1, std::memory_order_relaxed);
232 void intrusive_ptr_release(ActivityImpl* activity)
234 if (activity->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
235 std::atomic_thread_fence(std::memory_order_acquire);
239 } // namespace simgrid::kernel::activity