X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9caf173e476622d309cc5653a83d224d05787cc7..f1671393f75bd162d50e64573db72c0e80cd137f:/examples/s4u/actor-create/s4u-actor-create.cpp diff --git a/examples/s4u/actor-create/s4u-actor-create.cpp b/examples/s4u/actor-create/s4u-actor-create.cpp index 8757433184..ee1e6ef49a 100644 --- a/examples/s4u/actor-create/s4u-actor-create.cpp +++ b/examples/s4u/actor-create/s4u-actor-create.cpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -7,8 +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 * you ask SimGrid to start your actors. There is three ways of doing so: - * - Directly, by instantiating your actor as paramter to Actor::create() - * - By first registering your actors before instantiating it; + * - Directly, by instantiating your actor as parameter to Actor::create() + * - By first registering your actors before instantiating it * - Through the deployment file. * * This example shows all these solutions, even if you obviously should use only one of these solutions to start your @@ -23,67 +23,68 @@ // This declares a logging channel so that XBT_INFO can be used later XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor_create, "The logging channel used in this example"); -/* Declares a first class of actors which sends a message to the mailbox 'mb42'. +/* Our first class of actors is simply implemented with a function, that takes a single string as parameter. + * + * Later, this actor class is instantiated within the simulation. + */ +static void receiver(const std::string& mailbox_name) +{ + simgrid::s4u::Mailbox* mailbox = simgrid::s4u::Mailbox::by_name(mailbox_name); + + XBT_INFO("Hello s4u, I'm ready to get any message you'd want on %s", mailbox->get_cname()); + + const std::string* msg1 = static_cast(mailbox->get()); + const std::string* msg2 = static_cast(mailbox->get()); + const std::string* msg3 = static_cast(mailbox->get()); + XBT_INFO("I received '%s', '%s' and '%s'", msg1->c_str(), msg2->c_str(), msg3->c_str()); + delete msg1; + delete msg2; + delete msg3; + XBT_INFO("I'm done. See you."); +} + +/* Our second class of actors is also a function */ +static void forwarder(int argc, char** argv) +{ + xbt_assert(argc >= 3, "Actor forwarder requires 2 parameters, but got only %d", argc - 1); + simgrid::s4u::Mailbox* in = simgrid::s4u::Mailbox::by_name(argv[1]); + simgrid::s4u::Mailbox* out = simgrid::s4u::Mailbox::by_name(argv[2]); + std::string* msg = static_cast(in->get()); + XBT_INFO("Forward '%s'.", msg->c_str()); + out->put(msg, msg->size()); +} + +/* Declares a third class of actors which sends a message to the mailbox 'mb42'. * The sent message is what was passed as parameter on creation (or 'GaBuZoMeu' by default) * * Later, this actor class is instantiated twice in the simulation. */ class Sender { public: + std::string mbox = "mb42"; std::string msg = "GaBuZoMeu"; - explicit Sender() = default; + explicit Sender() = default; /* Sending the default message */ + explicit Sender(const std::string& arg) : msg(arg) { /* Sending the specified message */} explicit Sender(std::vector args) { - /* This constructor is used when we pass parameters to the actor */ - if (args.size() > 0) - msg = args[0]; + /* This constructor is used when we start the actor from the deployment file */ + /* args[0] is the actor's name, so the first parameter is args[1] */ + + xbt_assert(args.size() >= 3, "The sender is expecting 2 parameters from the deployment file but got %zu", + args.size() - 1); + msg = args[1]; + mbox = args[2]; } - void operator()() + void operator()() const /* This is the main code of the actor */ { XBT_INFO("Hello s4u, I have something to send"); - simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::byName("mb42"); + simgrid::s4u::Mailbox* mailbox = simgrid::s4u::Mailbox::by_name(mbox); mailbox->put(new std::string(msg), msg.size()); XBT_INFO("I'm done. See you."); } }; -/* Declares a second class of actor which receive two messages on the mailbox which - * name is passed as parameter ('thingy' by default, ie the wrong one). - * - * Later, this actor class is instantiated once in the simulation. - */ -class Receiver { -public: - simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::byName("thingy"); - - explicit Receiver() = default; - explicit Receiver(std::vector args) - { - /* This constructor is used when we pass parameters to the actor */ - /* as with argc/argv, args[0] is the actor's name, so the first parameter is args[1] */ - - /* FIXME: this is a bug as this does not happen when starting the process directly - * We should fix it by not adding the process name as argv[0] from the deployment file, - * which is useless anyway since it's always the function name in this setting. - * But this will break MSG... - */ - if (args.size() > 1) - mailbox = simgrid::s4u::Mailbox::byName(args[1]); - } - void operator()() - { - XBT_INFO("Hello s4u, I'm ready to get any message you'd want on %s", mailbox->get_cname()); - - std::string* msg1 = static_cast(mailbox->get()); - std::string* msg2 = static_cast(mailbox->get()); - XBT_INFO("I received '%s' and '%s'", msg1->c_str(), msg2->c_str()); - delete msg1; - delete msg2; - XBT_INFO("I'm done. See you."); - } -}; - /* Here comes the main function of your program */ int main(int argc, char** argv) { @@ -91,25 +92,35 @@ int main(int argc, char** argv) simgrid::s4u::Engine e(&argc, argv); /* Then you should load a platform file, describing your simulated platform */ - e.loadPlatform("../../platforms/small_platform.xml"); + e.load_platform("../../platforms/small_platform.xml"); /* And now you have to ask SimGrid to actually start your actors. * - * You can first directly start your actor, as follows. Note the last parameter: 'Sender()', - * as if you would call the Sender function. + * The easiest way to do so is to implement the behavior of your actor in a single function, + * as we do here for the receiver actors. This function can take any kind of parameters, as + * long as the last parameters of Actor::create() match what your function expects. */ - simgrid::s4u::Actor::createActor("sender1", simgrid::s4u::Host::by_name("Tremblay"), Sender()); - - /* The second way is to first register your function, and then retrieve it */ - e.registerFunction("sender"); // The sender is passed as a template parameter here - std::vector args; // Here we declare the parameter that the actor will get - args.push_back("GloubiBoulga"); // Add a parameter to the set (we could have done it in the first approach too) + simgrid::s4u::Actor::create("receiver", simgrid::s4u::Host::by_name("Fafard"), &receiver, "mb42"); - simgrid::s4u::Actor::createActor("sender2", simgrid::s4u::Host::by_name("Jupiter"), "sender", args); - - /* The third way to start your actors is to use a deployment file. */ - e.registerFunction("receiver"); // You first have to register the actor as with the second approach - e.loadDeployment("s4u-actor-create_d.xml"); // And then, you load the deployment file + /* If your actor is getting more complex, you probably want to implement it as a class instead, + * as we do here for the sender actors. The main behavior goes into operator()() of the class. + * + * You can then directly start your actor, as follows: */ + simgrid::s4u::Actor::create("sender1", simgrid::s4u::Host::by_name("Tremblay"), Sender()); + /* If you want to pass parameters to your class, that's very easy: just use your constructors */ + simgrid::s4u::Actor::create("sender2", simgrid::s4u::Host::by_name("Jupiter"), Sender("GloubiBoulga")); + + /* But starting actors directly is considered as a bad experimental habit, since it ties the code + * you want to test with the experimental scenario. Starting your actors from an external deployment + * file in XML ensures that you can test your code in several scenarios without changing the code itself. + * + * For that, you first need to register your function or your actor as follows. + * Actor classes must have a (std::vector) constructor, + * and actor functions must be of type int(*)(int argc, char**argv). */ + e.register_actor("sender"); // The sender class is passed as a template parameter here + e.register_function("forwarder", &forwarder); + /* Once actors and functions are registered, just load the deployment file */ + e.load_deployment("s4u-actor-create_d.xml"); /* Once every actors are started in the engine, the simulation can start */ e.run();