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