1 /* Copyright (c) 2010-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 "catch_simgrid.hpp"
9 static void test_link_off_helper(double delay)
11 const double start = simgrid::s4u::Engine::get_clock();
13 simgrid::s4u::ActorPtr receiver = simgrid::s4u::Actor::create("receiver", all_hosts[1], [&start]() {
15 std::array<double, 5> milestone{{0.5, 3.5, 4.5, 7.5, 9.0}};
16 for (double& m : milestone)
18 for (int i = 0; i < 4; i++) {
19 simgrid::s4u::this_actor::sleep_until(milestone[i]);
20 REQUIRE_NETWORK_FAILURE({
21 INFO("get(" << ('A' + i) << ")");
22 simgrid::s4u::Mailbox::by_name("mb")->get<int>();
25 simgrid::s4u::this_actor::sleep_until(milestone[4]);
28 simgrid::s4u::ActorPtr sender = simgrid::s4u::Actor::create("sender", all_hosts[2], [&start]() {
31 std::array<double, 5> milestone{{1.5, 2.5, 5.5, 6.5, 9.0}};
32 for (double& m : milestone)
34 for (int i = 0; i < 2; i++) {
35 simgrid::s4u::this_actor::sleep_until(milestone[i]);
36 XBT_VERB("dsend(%c)", 'A' + i);
37 simgrid::s4u::Mailbox::by_name("mb")->put_init(&data, 100000)->detach();
39 for (int i = 2; i < 4; i++) {
40 simgrid::s4u::this_actor::sleep_until(milestone[i]);
41 REQUIRE_NETWORK_FAILURE({
42 INFO("put(" << ('A' + i) << ")");
43 simgrid::s4u::Mailbox::by_name("mb")->put(&data, 100000);
46 simgrid::s4u::this_actor::sleep_until(milestone[4]);
49 for (int i = 0; i < 4; i++) {
50 XBT_VERB("##### %d / 4 #####", i + 1);
51 simgrid::s4u::this_actor::sleep_for(delay);
53 simgrid::s4u::Link::by_name("link1")->turn_off();
54 simgrid::s4u::this_actor::sleep_for(2.0 - delay);
56 simgrid::s4u::Link::by_name("link1")->turn_on();
58 simgrid::s4u::this_actor::sleep_for(1.5);
61 static simgrid::s4u::ActorPtr sender_basic(bool& ending_boolean, bool expected_success, double duration,
64 return simgrid::s4u::Actor::create("sender", all_hosts[1], [&ending_boolean, expected_success, duration, delay]() {
65 assert_exit(expected_success, duration);
66 // Encapsulate the payload in a std::unique_ptr so that it is correctly free'd if/when the sender is killed during
67 // its communication (thanks to RAII). The pointer is then released when the communication is over.
68 std::unique_ptr<char, decltype(&xbt_free_f)> payload(xbt_strdup("toto"), &xbt_free_f);
70 simgrid::s4u::this_actor::sleep_for(delay / 2.0);
71 auto comm = simgrid::s4u::Mailbox::by_name("mb")->put_init(payload.get(), 5000);
72 simgrid::s4u::this_actor::sleep_for(delay / 2.0);
75 simgrid::s4u::Mailbox::by_name("mb")->put(payload.get(), 5000);
78 ending_boolean = true;
81 static simgrid::s4u::ActorPtr receiver_basic(bool& ending_boolean, bool expected_success, double duration,
84 return simgrid::s4u::Actor::create("receiver", all_hosts[2], [&ending_boolean, expected_success, duration, delay]() {
85 assert_exit(expected_success, duration);
88 simgrid::s4u::this_actor::sleep_for(delay / 2.0);
89 auto comm = simgrid::s4u::Mailbox::by_name("mb")->get_init()->set_dst_data(reinterpret_cast<void**>(&payload),
91 simgrid::s4u::this_actor::sleep_for(delay / 2.0);
94 payload = simgrid::s4u::Mailbox::by_name("mb")->get<char>();
97 ending_boolean = true;
100 static simgrid::s4u::ActorPtr sender_dtach(bool& ending_boolean, bool expected_success, double duration)
102 return simgrid::s4u::Actor::create("sender", all_hosts[1], [&ending_boolean, expected_success, duration]() {
103 assert_exit(expected_success, duration);
104 char* payload = xbt_strdup("toto");
105 simgrid::s4u::Mailbox::by_name("mb")->put_init(payload, 1000)->detach();
106 ending_boolean = true;
110 TEST_CASE("Activity lifecycle: comm activities")
112 XBT_INFO("#####[ launch next \"comm\" test ]#####");
114 BEGIN_SECTION("comm")
116 XBT_INFO("Launch a communication");
117 bool send_done = false;
118 bool recv_done = false;
120 sender_basic(send_done, true, 5);
121 receiver_basic(recv_done, true, 5);
123 simgrid::s4u::this_actor::sleep_for(9);
124 INFO("Sender or receiver killed somehow. It shouldn't");
131 BEGIN_SECTION("comm (delayed send)")
133 XBT_INFO("Launch a communication with a delay for the send");
134 bool send_done = false;
135 bool recv_done = false;
137 sender_basic(send_done, true, 6, 1); // cover Comm::send
138 receiver_basic(recv_done, true, 6);
140 simgrid::s4u::this_actor::sleep_for(9);
141 INFO("Sender or receiver killed somehow. It shouldn't");
148 BEGIN_SECTION("comm (delayed recv)")
150 XBT_INFO("Launch a communication with a delay for the recv");
151 bool send_done = false;
152 bool recv_done = false;
154 sender_basic(send_done, true, 6);
155 receiver_basic(recv_done, true, 6, 1); // cover Comm::recv
157 simgrid::s4u::this_actor::sleep_for(9);
158 INFO("Sender or receiver killed somehow. It shouldn't");
165 BEGIN_SECTION("comm dsend and quit (put before get)")
167 XBT_INFO("Launch a detached communication and end right after");
168 bool dsend_done = false;
169 bool recv_done = false;
171 sender_dtach(dsend_done, true, 0);
172 simgrid::s4u::this_actor::sleep_for(2);
173 receiver_basic(recv_done, true, 1);
175 // Sleep long enough to let the test ends by itself. 1 + surf_precision should be enough.
176 simgrid::s4u::this_actor::sleep_for(4);
177 INFO("Sender or receiver killed somehow. It shouldn't");
184 BEGIN_SECTION("comm dsend and quit (get before put)")
186 XBT_INFO("Launch a detached communication and end right after");
187 bool dsend_done = false;
188 bool recv_done = false;
190 receiver_basic(recv_done, true, 3);
191 simgrid::s4u::this_actor::sleep_for(2);
192 sender_dtach(dsend_done, true, 0);
194 // Sleep long enough to let the test ends by itself. 3 + surf_precision should be enough.
195 simgrid::s4u::this_actor::sleep_for(4);
196 INFO("Sender or receiver killed somehow. It shouldn't");
203 BEGIN_SECTION("comm kill sender")
205 XBT_INFO("Launch a communication and kill the sender");
206 bool send_done = false;
207 bool recv_done = false;
209 simgrid::s4u::ActorPtr sender = simgrid::s4u::Actor::create("sender", all_hosts[1], [&send_done]() {
210 assert_exit(false, 2);
211 // Encapsulate the payload in a std::unique_ptr so that it is correctly free'd when the sender is killed during
212 // its communication (thanks to RAII). The pointer is then released when the communication is over.
213 std::unique_ptr<char, decltype(&xbt_free_f)> payload(xbt_strdup("toto"), &xbt_free_f);
214 simgrid::s4u::Mailbox::by_name("mb")->put(payload.get(), 5000);
219 simgrid::s4u::Actor::create("receiver", all_hosts[2], [&recv_done]() {
220 assert_exit(true, 2);
221 REQUIRE_NETWORK_FAILURE({
222 char* payload = simgrid::s4u::Mailbox::by_name("mb")->get<char>();
228 simgrid::s4u::this_actor::sleep_for(2);
230 // let the test ends by itself. waiting for surf_precision should be enough.
231 simgrid::s4u::this_actor::sleep_for(0.00001);
233 INFO("Sender was not killed properly or receiver killed somehow. It shouldn't");
234 REQUIRE(not send_done);
240 BEGIN_SECTION("comm recv and kill")
242 XBT_INFO("Launch an actor that waits on a recv, kill its host");
243 bool in_on_exit = false;
244 bool returned_from_main = false;
245 bool in_catch_before_on_exit = false;
246 bool in_catch_after_on_exit = false;
247 bool send_done = false;
249 simgrid::s4u::ActorPtr receiver =
250 simgrid::s4u::Actor::create("receiver", all_hosts[1], [&in_on_exit, &returned_from_main,
251 &in_catch_before_on_exit, &in_catch_after_on_exit]() {
252 assert_exit(false, 1);
254 simgrid::s4u::Mailbox::by_name("mb")->get<int>();
255 } catch (simgrid::NetworkFailureException const&) {
256 // Shouldn't get in here after the on_exit function
257 in_catch_before_on_exit = not in_on_exit;
258 in_catch_after_on_exit = in_on_exit;
260 returned_from_main = true;
263 receiver->on_exit([&in_on_exit](bool) { in_on_exit = true; });
265 simgrid::s4u::ActorPtr sender = simgrid::s4u::Actor::create("sender", all_hosts[2], [&send_done]() {
266 assert_exit(true, 1);
268 REQUIRE_NETWORK_FAILURE(simgrid::s4u::Mailbox::by_name("mb")->put(&data, 100000));
272 simgrid::s4u::this_actor::sleep_for(1);
273 receiver->get_host()->turn_off();
275 // Note: If we don't sleep here, we don't "see" the bug
276 simgrid::s4u::this_actor::sleep_for(1);
278 INFO("Receiver's on_exit function was never called");
280 INFO("or receiver mistakenly went to catch clause (before the on_exit function was called)");
281 REQUIRE(not in_catch_before_on_exit);
282 INFO("or receiver mistakenly went to catch clause (after the on_exit function was called)");
283 REQUIRE(not in_catch_after_on_exit);
284 INFO("or receiver returned from main normally even though its host was killed");
285 REQUIRE(not returned_from_main);
286 INFO("or sender killed somehow, and it shouldn't");
288 receiver->get_host()->turn_on();
293 BEGIN_SECTION("comm turn link off before send/recv")
295 XBT_INFO("try to communicate with communicating link turned off before start");
296 test_link_off_helper(0.0);
301 BEGIN_SECTION("comm turn link off between send/recv")
303 XBT_INFO("try to communicate with communicating link turned off between send and receive");
304 test_link_off_helper(1.0);
309 BEGIN_SECTION("comm turn link off during transfer")
311 XBT_INFO("try to communicate with communicating link turned off during transfer");
312 test_link_off_helper(2.0);
317 BEGIN_SECTION("comm turn link off during wait_any")
319 XBT_INFO("try to communicate with communicating link turned off during wait_any");
320 simgrid::s4u::ActorPtr receiver = simgrid::s4u::Actor::create("receiver", all_hosts[1], []() {
321 assert_exit(true, 2);
323 simgrid::s4u::CommPtr comm = simgrid::s4u::Mailbox::by_name("mb")->get_async<int>(&data);
324 std::vector<simgrid::s4u::CommPtr> pending_comms = {comm};
325 REQUIRE_NETWORK_FAILURE(simgrid::s4u::Comm::wait_any(pending_comms));
328 simgrid::s4u::ActorPtr sender = simgrid::s4u::Actor::create("sender", all_hosts[2], []() {
329 assert_exit(true, 2);
331 REQUIRE_NETWORK_FAILURE(simgrid::s4u::Mailbox::by_name("mb")->put(&data, 100000));
334 simgrid::s4u::this_actor::sleep_for(2.0);
335 XBT_VERB("link off");
336 simgrid::s4u::Link::by_name("link1")->turn_off();
337 simgrid::s4u::this_actor::sleep_for(2.0);
339 simgrid::s4u::Link::by_name("link1")->turn_on();
344 simgrid::s4u::this_actor::sleep_for(10);