examples/c/actor-exiting/actor-exiting.c

   1 /* Copyright (c) 2017-2020. 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 /* In C, there is a single way of being informed when an actor exits.
   7  *
   8  * The sg_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 sg_actor_on_exit() are in charge
  16  * of releasing any memory allocated by the actor during its execution.
  17  */
  18
  19 #include <simgrid/actor.h>
  20 #include <simgrid/engine.h>
  21 #include <simgrid/host.h>
  22 #include <simgrid/mailbox.h>
  23
  24 #include <xbt/asserts.h>
  25 #include <xbt/log.h>
  26
  27 XBT_LOG_NEW_DEFAULT_CATEGORY(actor_exiting, "Messages specific for this example");
  28
  29 static void A_on_exit(int ignored1, void* ignored2)
  30 {
  31   XBT_INFO("I stop now");
  32 }
  33
  34 static void actorA_fun(int argc, char* argv[])
  35 {
  36   // Register a lambda function to be executed once it stops
  37   sg_actor_on_exit(&A_on_exit, NULL);
  38
  39   sg_actor_sleep_for(1);
  40 }
  41 static void actorB_fun(int argc, char* argv[])
  42 {
  43   sg_actor_sleep_for(2);
  44 }
  45 static void C_on_exit(int failed, void* ignored2)
  46 {
  47   if (failed) {
  48     XBT_INFO("I was killed!");
  49     if (xbt_log_no_loc)
  50       XBT_INFO("The backtrace would be displayed here if --log=no_loc would not have been passed");
  51     else
  52       xbt_backtrace_display_current();
  53   } else
  54     XBT_INFO("Exiting gracefully.");
  55 }
  56 static void actorC_fun(int argc, char* argv[])
  57 {
  58   // Register a lambda function to be executed once it stops
  59   sg_actor_on_exit(&C_on_exit, NULL);
  60
  61   sg_actor_sleep_for(3);
  62   XBT_INFO("And now, induce a deadlock by waiting for a message that will never come\n\n");
  63   sg_mailbox_get(sg_mailbox_by_name("nobody"));
  64   xbt_die("Receiving is not supposed to succeed when nobody is sending");
  65 }
  66
  67 int main(int argc, char* argv[])
  68 {
  69   simgrid_init(&argc, argv);
  70   xbt_assert(argc == 2, "Usage: %s platform_file\n\tExample: %s ../platforms/small_platform.xml\n", argv[0], argv[0]);
  71
  72   simgrid_load_platform(argv[1]); /* - Load the platform description */
  73
  74   sg_actor_create("A", sg_host_by_name("Tremblay"), actorA_fun, 0, NULL);
  75   sg_actor_create("B", sg_host_by_name("Fafard"), actorB_fun, 0, NULL);
  76   sg_actor_create("C", sg_host_by_name("Ginette"), actorC_fun, 0, NULL);
  77
  78   simgrid_run();
  79
  80   return 0;
  81 }