examples/s4u/actor-exiting/s4u-actor-exiting.cpp

   1 /* Copyright (c) 2017-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 /* There is two very different ways of being informed when an actor exits.
   7  *
   8  * The this_actor::on_exit() function allows one to register a function to be
   9  * executed when this very actor exits. The registered function will run
  10  * when this actor terminates (either because its main function returns, or
  11  * because it's killed in any way). No simcall are allowed here: your actor
  12  * is dead already, so it cannot interact with its environment in any way
  13  * (network, executions, disks, etc).
  14  *
  15  * Usually, the functions registered in this_actor::on_exit() are in charge
  16  * of releasing any memory allocated by the actor during its execution.
  17  *
  18  * The other way of getting informed when an actor terminates is to connect a
  19  * function in the Actor::on_termination signal, that is shared between
  20  * all actors. Callbacks to this signal are executed for each terminating
  21  * actors, no matter what. This is useful in many cases, in particular
  22  * when developing SimGrid plugins.
  23  *
  24  * Finally, you can attach callbacks to the Actor::on_destruction signal.
  25  * It is also shared between all actors, and gets fired when the actors
  26  * are destroyed. A delay is possible between the termination of an actor
  27  * (ie, when it terminates executing its code) and its destruction (ie,
  28  * when it is not referenced anywhere in the simulation and can be collected).
  29  *
  30  * In both cases, you can stack more than one callback in the signal.
  31  * They will all be executed in the registration order.
  32  */
  33
  34 #include <simgrid/s4u.hpp>
  35
  36 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor_exiting, "Messages specific for this s4u example");
  37
  38 static void actor_a()
  39 {
  40   // Register a lambda function to be executed once it stops
  41   simgrid::s4u::this_actor::on_exit([](bool /*failed*/) { XBT_INFO("I stop now"); });
  42
  43   simgrid::s4u::this_actor::execute(1e9);
  44 }
  45
  46 static void actor_b()
  47 {
  48   simgrid::s4u::this_actor::execute(2e9);
  49 }
  50
  51 int main(int argc, char* argv[])
  52 {
  53   simgrid::s4u::Engine e(&argc, argv);
  54   xbt_assert(argc == 2, "Usage: %s platform_file\n\tExample: %s ../platforms/small_platform.xml\n", argv[0], argv[0]);
  55
  56   e.load_platform(argv[1]); /* - Load the platform description */
  57
  58   /* Register a callback in the Actor::on_termination signal. It will be called for every terminated actors */
  59   simgrid::s4u::Actor::on_termination.connect(
  60       [](simgrid::s4u::Actor const& actor) { XBT_INFO("Actor %s terminates now", actor.get_cname()); });
  61   /* Register a callback in the Actor::on_destruction signal. It will be called for every destructed actors */
  62   simgrid::s4u::Actor::on_destruction.connect(
  63       [](simgrid::s4u::Actor const& actor) { XBT_INFO("Actor %s gets destroyed now", actor.get_cname()); });
  64
  65   /* Create some actors */
  66   simgrid::s4u::Actor::create("A", simgrid::s4u::Host::by_name("Tremblay"), actor_a);
  67   simgrid::s4u::Actor::create("B", simgrid::s4u::Host::by_name("Fafard"), actor_b);
  68
  69   e.run(); /* - Run the simulation */
  70
  71   return 0;
  72 }