Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add a comment to explain previous changes.
[simgrid.git] / teshsuite / s4u / activity-lifecycle / activity-lifecycle.cpp
1 /* Copyright (c) 2010-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.hpp"
7
8 #include <cmath>
9
10 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_test, "Messages specific for this s4u example");
11
12 std::vector<simgrid::s4u::Host*> all_hosts;
13
14 /* Helper function easing the testing of actor's ending condition */
15 static void assert_exit(int status, double duration)
16 {
17   double expected_time = simgrid::s4u::Engine::get_clock() + duration;
18   simgrid::s4u::this_actor::on_exit(
19       [status, expected_time](int got_status, void* /*ignored*/) {
20         xbt_assert(status == got_status, "Exit status mismatch. Expected %d, got %d", status, got_status);
21         xbt_assert(std::fabs(expected_time - simgrid::s4u::Engine::get_clock()) < 0.001,
22                    "Exit time mismatch. Expected %f", expected_time);
23         XBT_VERB("Checks on exit successful");
24       },
25       nullptr);
26 }
27 /* Helper function in charge of running a test and doing some sanity checks afterward */
28 static void run_test(const char* test_name, std::function<void()> test)
29 {
30   simgrid::s4u::Actor::create(test_name, all_hosts[0], test);
31   simgrid::s4u::this_actor::sleep_for(10);
32
33   /* Check that no actor remain (but on host[0], where main_dispatcher lives */
34   for (unsigned int i = 0; i < all_hosts.size(); i++) {
35     std::vector<simgrid::s4u::ActorPtr> all_actors = all_hosts[i]->get_all_actors();
36     unsigned int expected_count = (i == 0) ? 1 : 0; // host[0] contains main_dispatcher, all other are empty
37     if (all_actors.size() != expected_count) {
38       XBT_CRITICAL("Host %s contains %zu actors but %u are expected (i=%u). Existing actors: ",
39                    all_hosts[i]->get_cname(), all_actors.size(), expected_count, i);
40       for (auto act : all_actors)
41         XBT_CRITICAL(" - %s", act->get_cname());
42       xbt_die("This is wrong");
43     }
44   }
45   xbt_assert("TODO: Check that all LMM are empty");
46   XBT_INFO("SUCCESS: %s", test_name);
47   XBT_INFO("#########################################################################################################");
48 }
49
50 /**
51  ** Each tests
52  **/
53
54 static void test_sleep()
55 {
56   XBT_INFO("%s: Launch a sleep(5), and let it proceed", __func__);
57   bool global = false;
58
59   simgrid::s4u::ActorPtr sleeper5 = simgrid::s4u::Actor::create("sleep5", all_hosts[1], [&global]() {
60     assert_exit(0, 5.);
61     simgrid::s4u::this_actor::sleep_for(5);
62     global = true;
63   });
64   simgrid::s4u::this_actor::sleep_for(10);
65   xbt_assert(global, "The forked actor did not modify the global after sleeping. Was it killed before?");
66 }
67
68 static void test_sleep_kill_middle()
69 {
70   XBT_INFO("%s: Launch a sleep(5), and kill it after 2 secs", __func__);
71
72   simgrid::s4u::ActorPtr sleeper5 = simgrid::s4u::Actor::create("sleep5_killed", all_hosts[1], []() {
73     assert_exit(1, 2);
74     simgrid::s4u::this_actor::sleep_for(5);
75     xbt_die("I should be dead now");
76   });
77
78   simgrid::s4u::this_actor::sleep_for(2);
79   sleeper5->kill();
80 }
81
82 static void test_sleep_kill_begin()
83 {
84   XBT_INFO("%s: Launch a sleep(5), and kill it right after start", __func__);
85
86   simgrid::s4u::ActorPtr sleeper5 = simgrid::s4u::Actor::create("sleep5_killed", all_hosts[1], []() {
87     assert_exit(1, 0);
88     simgrid::s4u::this_actor::sleep_for(5);
89     xbt_die("I should be dead now");
90   });
91
92   simgrid::s4u::this_actor::yield();
93   sleeper5->kill();
94 }
95
96 static void test_sleep_restart_begin()
97 {
98   XBT_INFO("%s: Launch a sleep(5), and restart its host right after start", __func__);
99
100   simgrid::s4u::ActorPtr sleeper5 = simgrid::s4u::Actor::create("sleep5_restarted", all_hosts[1], []() {
101     assert_exit(1, 0);
102     simgrid::s4u::this_actor::sleep_for(5);
103     xbt_die("I should be dead now");
104   });
105
106   simgrid::s4u::this_actor::yield();
107   sleeper5->get_host()->turn_off();
108   sleeper5->get_host()->turn_on();
109   XBT_INFO("Test %s is ending", __func__);
110 }
111
112 static void test_sleep_restart_middle()
113 {
114   XBT_INFO("%s: Launch a sleep(5), and restart its host after 2 secs", __func__);
115
116   simgrid::s4u::ActorPtr sleeper5 = simgrid::s4u::Actor::create("sleep5_restarted", all_hosts[1], []() {
117     assert_exit(1, 2);
118     simgrid::s4u::this_actor::sleep_for(5);
119     xbt_die("I should be dead now");
120   });
121
122   simgrid::s4u::this_actor::sleep_for(2);
123   sleeper5->get_host()->turn_off();
124   sleeper5->get_host()->turn_on();
125   XBT_INFO("Test %s is ending", __func__);
126 }
127 static void test_sleep_restart_end()
128 {
129   XBT_INFO("%s: Launch a sleep(5), and restart its host right when it stops", __func__);
130   bool sleeper_done = false;
131
132   simgrid::s4u::Actor::create("sleep5_restarted", all_hosts[1], [&sleeper_done]() {
133     assert_exit(0, 5);
134     simgrid::s4u::this_actor::sleep_for(5);
135     sleeper_done = true;
136   });
137   simgrid::s4u::Actor::create("killer", all_hosts[0], []() {
138     simgrid::s4u::this_actor::sleep_for(5);
139     XBT_INFO("Killer!");
140     all_hosts[1]->turn_off();
141     all_hosts[1]->turn_on();
142   });
143   simgrid::s4u::this_actor::sleep_for(10);
144   xbt_assert(sleeper_done,
145              "Restarted actor was already dead in the scheduling round during which the host_off simcall was issued");
146 }
147 static void test_exec()
148 {
149   XBT_INFO("%s: Launch a execute(5s), and let it proceed", __func__);
150   bool global = false;
151
152   simgrid::s4u::ActorPtr exec5 = simgrid::s4u::Actor::create("exec5", all_hosts[1], [&global]() {
153     assert_exit(0, 5.);
154     simgrid::s4u::this_actor::execute(500000000);
155     global = true;
156   });
157   simgrid::s4u::this_actor::sleep_for(10);
158   xbt_assert(global, "The forked actor did not modify the global after executing. Was it killed before?");
159 }
160
161 static void test_exec_kill_middle()
162 {
163   XBT_INFO("%s: Launch a execute(5s), and kill it after 2 secs", __func__);
164
165   simgrid::s4u::ActorPtr exec5 = simgrid::s4u::Actor::create("exec5_killed", all_hosts[1], []() {
166     assert_exit(1, 2);
167     simgrid::s4u::this_actor::execute(500000000);
168     xbt_die("I should be dead now");
169   });
170
171   simgrid::s4u::this_actor::sleep_for(2);
172   exec5->kill();
173 }
174
175 static void test_exec_kill_begin()
176 {
177   XBT_INFO("%s: Launch a execute(5s), and kill it right after start", __func__);
178
179   simgrid::s4u::ActorPtr exec5 = simgrid::s4u::Actor::create("exec5_killed", all_hosts[1], []() {
180     assert_exit(1, 0);
181     simgrid::s4u::this_actor::execute(500000000);
182     xbt_die("I should be dead now");
183   });
184
185   simgrid::s4u::this_actor::yield();
186   exec5->kill();
187 }
188
189 static void test_exec_restart_begin()
190 {
191   XBT_INFO("%s: Launch a execute(5s), and restart its host right after start", __func__);
192
193   simgrid::s4u::ActorPtr exec5 = simgrid::s4u::Actor::create("exec5_restarted", all_hosts[1], []() {
194     assert_exit(1, 0);
195     simgrid::s4u::this_actor::execute(500000000);
196     xbt_die("I should be dead now");
197   });
198
199   simgrid::s4u::this_actor::yield();
200   exec5->get_host()->turn_off();
201   exec5->get_host()->turn_on();
202   XBT_INFO("Test %s is ending", __func__);
203 }
204
205 static void test_exec_restart_middle()
206 {
207   XBT_INFO("%s: Launch a execute(5s), and restart its host after 2 secs", __func__);
208
209   simgrid::s4u::ActorPtr exec5 = simgrid::s4u::Actor::create("exec5_restarted", all_hosts[1], []() {
210     assert_exit(1, 2);
211     simgrid::s4u::this_actor::execute(500000000);
212     xbt_die("I should be dead now");
213   });
214
215   simgrid::s4u::this_actor::sleep_for(2);
216   exec5->get_host()->turn_off();
217   exec5->get_host()->turn_on();
218   XBT_INFO("Test %s is ending", __func__);
219 }
220 static void test_exec_restart_end()
221 {
222   XBT_INFO("%s: Launch a execute(5s), and restart its host right when it stops", __func__);
223   bool execution_done = false;
224
225   simgrid::s4u::Actor::create("exec5_restarted", all_hosts[1], [&execution_done]() {
226     assert_exit(0, 5);
227     simgrid::s4u::this_actor::execute(500000000);
228     execution_done = true;
229   });
230   simgrid::s4u::Actor::create("killer", all_hosts[0], []() {
231     simgrid::s4u::this_actor::sleep_for(5);
232     XBT_INFO("Killer!");
233     all_hosts[1]->turn_off();
234     all_hosts[1]->turn_on();
235   });
236   simgrid::s4u::this_actor::sleep_for(10);
237   xbt_assert(execution_done,
238              "Restarted actor was already dead in the scheduling round during which the host_off simcall was issued");
239 }
240
241 static void test_comm()
242 {
243   XBT_INFO("%s: Launch a communication", __func__);
244   bool send_done = false;
245   bool recv_done = false;
246
247   simgrid::s4u::Actor::create("sender", all_hosts[1], [&send_done]() {
248     assert_exit(0, 5);
249     char* payload = xbt_strdup("toto");
250     simgrid::s4u::Mailbox::by_name("mb")->put(payload, 5000);
251     send_done = true;
252   });
253   simgrid::s4u::Actor::create("receiver", all_hosts[2], [&recv_done]() {
254     assert_exit(0, 5);
255     void* payload = simgrid::s4u::Mailbox::by_name("mb")->get();
256     xbt_free(payload);
257     recv_done = true;
258   });
259
260   simgrid::s4u::this_actor::sleep_for(10);
261   xbt_assert(send_done, "Sender killed somehow. It shouldn't");
262   xbt_assert(recv_done, "Receiver killed somehow. It shouldn't");
263 }
264
265 static void test_comm_dsend_and_quit()
266 {
267   XBT_INFO("%s: Launch a detached communication and end right after", __func__);
268   bool dsend_done = false;
269   bool recv_done  = false;
270
271   simgrid::s4u::ActorPtr sender = simgrid::s4u::Actor::create("sender", all_hosts[1], [&dsend_done]() {
272     assert_exit(0, 0);
273     char* payload = xbt_strdup("toto");
274     simgrid::s4u::Mailbox::by_name("mb")->put_init(payload, 1000)->detach();
275     dsend_done = true;
276     return;
277   });
278
279   simgrid::s4u::Actor::create("receiver", all_hosts[2], [&recv_done]() {
280     assert_exit(0, 3);
281     bool got_exception = false;
282     simgrid::s4u::this_actor::sleep_for(2);
283     try {
284       void* payload = simgrid::s4u::Mailbox::by_name("mb")->get();
285       xbt_free(payload);
286     } catch (xbt_ex const& e) {
287       got_exception = true;
288     }
289     recv_done = true;
290     xbt_assert(not got_exception);
291     return;
292   });
293
294   // Sleep long enough to let the test ends by itself. 3 + surf_precision should be enough.
295   simgrid::s4u::this_actor::sleep_for(4);
296   xbt_assert(dsend_done, "Sender killed somehow. It shouldn't");
297   xbt_assert(recv_done, "Receiver killed somehow. It shouldn't");
298 }
299
300 static void test_comm_killsend()
301 {
302   XBT_INFO("%s: Launch a communication and kill the sender", __func__);
303   bool send_done = false;
304   bool recv_done = false;
305
306   simgrid::s4u::ActorPtr sender = simgrid::s4u::Actor::create("sender", all_hosts[1], [&send_done]() {
307     assert_exit(1, 2);
308     // Encapsulate the payload in a std::unique_ptr so that it is correctly free'd when the sender is killed during its
309     // communication (thanks to RAII).  The pointer is then released when the communication is over.
310     std::unique_ptr<char, decltype(&xbt_free_f)> payload(xbt_strdup("toto"), &xbt_free_f);
311     simgrid::s4u::Mailbox::by_name("mb")->put(payload.get(), 5000);
312     payload.release();
313     send_done = true;
314   });
315   simgrid::s4u::Actor::create("receiver", all_hosts[2], [&recv_done]() {
316     assert_exit(0, 2);
317     bool got_exception = false;
318     try {
319       void* payload = simgrid::s4u::Mailbox::by_name("mb")->get();
320       xbt_free(payload);
321     } catch (simgrid::NetworkFailureException const&) {
322       got_exception = true;
323     }
324     xbt_assert(got_exception);
325     recv_done = true;
326   });
327
328   simgrid::s4u::this_actor::sleep_for(2);
329   sender->kill();
330   // let the test ends by itself. waiting for surf_precision should be enough.
331   simgrid::s4u::this_actor::sleep_for(0.00001);
332
333   xbt_assert(not send_done, "Sender was not killed properly");
334   xbt_assert(recv_done, "Receiver killed somehow. It shouldn't");
335 }
336
337 /* We need an extra actor here, so that it can sleep until the end of each test */
338 static void main_dispatcher()
339 {
340   run_test("sleep", static_cast<std::function<void()>>(test_sleep));
341   run_test("sleep killed at start", test_sleep_kill_begin);
342   run_test("sleep killed in middle", test_sleep_kill_middle);
343   /* We cannot kill right at the end of the action because killer actors are always rescheduled to the end of the round
344    * to avoid that they exit before their victim dereferences their name */
345   run_test("sleep restarted at start", test_sleep_restart_begin);
346   run_test("sleep restarted at middle", test_sleep_restart_middle);
347   run_test("sleep restarted at end", test_sleep_restart_end);
348
349   run_test("exec", static_cast<std::function<void()>>(test_exec));
350   run_test("exec killed at start", test_exec_kill_begin);
351   run_test("exec killed in middle", test_exec_kill_middle);
352   run_test("exec restarted at start", test_exec_restart_begin);
353   run_test("exec restarted at middle", test_exec_restart_middle);
354   run_test("exec restarted at end", test_exec_restart_end);
355
356   run_test("comm", test_comm);
357   run_test("comm dsend and quit", test_comm_dsend_and_quit);
358   run_test("comm kill sender", test_comm_killsend);
359 }
360
361 int main(int argc, char* argv[])
362 {
363   simgrid::s4u::Engine e(&argc, argv);
364
365   const char* platf = argv[1];
366   if (argc <= 1) {
367     XBT_WARN("No platform file provided. Using './testing_platform.xml'");
368     platf = "./testing_platform.xml";
369   }
370   e.load_platform(platf);
371
372   all_hosts = e.get_all_hosts();
373   simgrid::s4u::Actor::create("main_dispatcher", all_hosts[0], main_dispatcher);
374
375   e.run();
376
377   XBT_INFO("Simulation done");
378
379   return 0;
380 }