examples/s4u/actor-create/s4u-actor-create.cpp

   1 /* Copyright (c) 2006-2018. 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 /* This example shows how to declare and start your actors.
   7  *
   8  * The first step is to declare the code of your actors (what they do exactly does not matter to this example) and then
   9  * you ask SimGrid to start your actors. There is three ways of doing so:
  10  *  - Directly, by instantiating your actor as paramter to Actor::create()
  11  *  - By first registering your actors before instantiating it;
  12  *  - Through the deployment file.
  13  *
  14  * This example shows all these solutions, even if you obviously should use only one of these solutions to start your
  15  * actors. The most advised solution is to use a deployment file, as it creates a clear separation between your
  16  * application and the settings to test it. This is a better scientific methodology. Actually, starting an actor with
  17  * Actor::create() is mostly useful to start an actor from another actor.
  18  */
  19
  20 #include <simgrid/s4u.hpp>
  21 #include <string>
  22
  23 // This declares a logging channel so that XBT_INFO can be used later
  24 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor_create, "The logging channel used in this example");
  25
  26 /* Declares a first class of actors which sends a message to the mailbox 'mb42'.
  27  * The sent message is what was passed as parameter on creation (or 'GaBuZoMeu' by default)
  28  *
  29  * Later, this actor class is instantiated twice in the simulation.
  30  */
  31 class Sender {
  32 public:
  33   std::string msg = "GaBuZoMeu";
  34   explicit Sender() = default;
  35   explicit Sender(std::vector<std::string> args)
  36   {
  37     /* This constructor is used when we pass parameters to the actor */
  38     if (args.size() > 0)
  39       msg = args[0];
  40   }
  41   void operator()()
  42   {
  43     XBT_INFO("Hello s4u, I have something to send");
  44     simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::byName("mb42");
  45
  46     mailbox->put(new std::string(msg), msg.size());
  47     XBT_INFO("I'm done. See you.");
  48   }
  49 };
  50
  51 /* Declares a second class of actor which receive two messages on the mailbox which
  52  * name is passed as parameter ('thingy' by default, ie the wrong one).
  53  *
  54  * Later, this actor class is instantiated once in the simulation.
  55  */
  56 class Receiver {
  57 public:
  58   simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::byName("thingy");
  59
  60   explicit Receiver() = default;
  61   explicit Receiver(std::vector<std::string> args)
  62   {
  63     /* This constructor is used when we pass parameters to the actor */
  64     /* as with argc/argv, args[0] is the actor's name, so the first parameter is args[1] */
  65
  66     /* FIXME: this is a bug as this does not happen when starting the process directly
  67      * We should fix it by not adding the process name as argv[0] from the deployment file,
  68      * which is useless anyway since it's always the function name in this setting.
  69      * But this will break MSG...
  70      */
  71     if (args.size() > 1)
  72       mailbox = simgrid::s4u::Mailbox::byName(args[1]);
  73   }
  74   void operator()()
  75   {
  76     XBT_INFO("Hello s4u, I'm ready to get any message you'd want on %s", mailbox->get_cname());
  77
  78     std::string* msg1 = static_cast<std::string*>(mailbox->get());
  79     std::string* msg2 = static_cast<std::string*>(mailbox->get());
  80     XBT_INFO("I received '%s' and '%s'", msg1->c_str(), msg2->c_str());
  81     delete msg1;
  82     delete msg2;
  83     XBT_INFO("I'm done. See you.");
  84   }
  85 };
  86
  87 /* Here comes the main function of your program */
  88 int main(int argc, char** argv)
  89 {
  90   /* When your program starts, you have to first start a new simulation engine, as follows */
  91   simgrid::s4u::Engine e(&argc, argv);
  92
  93   /* Then you should load a platform file, describing your simulated platform */
  94   e.loadPlatform("../../platforms/small_platform.xml");
  95
  96   /* And now you have to ask SimGrid to actually start your actors.
  97    *
  98    * You can first directly start your actor, as follows. Note the last parameter: 'Sender()',
  99    * as if you would call the Sender function.
 100    */
 101   simgrid::s4u::Actor::create("sender1", simgrid::s4u::Host::by_name("Tremblay"), Sender());
 102
 103   /* The second way is to first register your function, and then retrieve it */
 104   e.registerFunction<Sender>("sender");  // The sender is passed as a template parameter here
 105   std::vector<std::string> args;         // Here we declare the parameter that the actor will get
 106   args.push_back("GloubiBoulga");        // Add a parameter to the set (we could have done it in the first approach too)
 107
 108   simgrid::s4u::Actor::create("sender2", simgrid::s4u::Host::by_name("Jupiter"), "sender", args);
 109
 110   /* The third way to start your actors is to use a deployment file. */
 111   e.registerFunction<Receiver>("receiver");   // You first have to register the actor as with the second approach
 112   e.loadDeployment("s4u-actor-create_d.xml"); // And then, you load the deployment file
 113
 114   /* Once every actors are started in the engine, the simulation can start */
 115   e.run();
 116
 117   /* Once the simulation is done, the program is ended */
 118   return 0;
 119 }