Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics after integrating #228
authorMartin Quinson <martin.quinson@loria.fr>
Sun, 15 Oct 2017 15:21:43 +0000 (17:21 +0200)
committerMartin Quinson <martin.quinson@loria.fr>
Sun, 15 Oct 2017 15:21:43 +0000 (17:21 +0200)
examples/s4u/CMakeLists.txt
examples/s4u/README.doc
examples/s4u/actor-execute/s4u-actor-execute.cpp

index 933e55d..9fa8945 100644 (file)
@@ -1,8 +1,7 @@
 foreach (example actions-comm actions-storage 
-                 actor-create actor-daemon actor-kill actor-migration actor-suspend 
+                 actor-create actor-daemon actor-execute actor-kill actor-migration actor-suspend 
                  app-masterworker app-pingpong app-token-ring
                 async-wait async-waitany async-waitall
-     actor-execute 
                 plugin-hostload io mutex)
   add_executable       (s4u-${example}  ${example}/s4u-${example}.cpp)
   target_link_libraries(s4u-${example}  simgrid)
@@ -54,10 +53,9 @@ set(txt_files     ${txt_files}    ${CMAKE_CURRENT_SOURCE_DIR}/actions-comm/s4u-a
                                   ${CMAKE_CURRENT_SOURCE_DIR}/README.doc                                   PARENT_SCOPE)
 
 foreach(example actions-comm actions-storage 
-                actor-create actor-daemon actor-kill actor-migration actor-suspend
+                actor-create actor-daemon actor-execute actor-kill actor-migration actor-suspend
                 app-bittorrent app-masterworker app-pingpong app-token-ring 
                async-wait async-waitall async-waitany
-    actor-execute 
                dht-chord plugin-hostload io mutex)
   ADD_TESH_FACTORIES(s4u-${example} "thread;ucontext;raw;boost" --setenv bindir=${CMAKE_CURRENT_BINARY_DIR}/${example} --setenv srcdir=${CMAKE_HOME_DIRECTORY}/examples/platforms --cd ${CMAKE_HOME_DIRECTORY}/examples/s4u/${example} s4u-${example}.tesh)
 endforeach()
index 9766f81..c3df307 100644 (file)
@@ -25,14 +25,10 @@ documentation, but it should remain readable directly.
     @ref examples/s4u/actor-create/s4u-actor-create_d.xml \n
     Shows how to start your actors to populate your simulation.
 
-  - <b>Excute actors</b>. 
-    @ref examples/s4u/process-create/s4u-process-create.cpp \n
-    Most processes are started from the deployment XML file.     
-
   - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u-app-pingpong.c\n
-   It's hard to think of a simpler example: it is just sending one message back and forth.
-   The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to 
-   the simulators (as detailed in Section \ref options). 
+    This simple example just sends one message back and forth.
+    The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to 
+    the simulators (as detailed in Section \ref options). 
 
   - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u-app-token-ring.cpp \n
     Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every
@@ -42,7 +38,7 @@ documentation, but it should remain readable directly.
     Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker 
     processes. 
     
-@section msg_ex_async Asynchronous communications
+@section s4u_ex_async Asynchronous communications
 
  - <b>Basic asynchronous communications</b>. 
    @ref examples/s4u/async-wait/s4u-async-wait.cpp \n
@@ -69,6 +65,13 @@ documentation, but it should remain readable directly.
     @ref examples/s4u/actor-create/s4u-actor-create.cpp \n
     Most actors are started from the deployment XML file, but they exist other methods.
 
+  - <b>Actors using CPU time</b>.
+    @ref examples/s4u/actor-execute/s4u-actor-execute.cpp \n
+    The computations done in your program are not reported to the
+    simulated world, unless you explicitely request the simulator to pause
+    the actor until a given amount of flops gets computed on its simulated
+    host.
+
   - <b>Daemonize actors</b>
     @ref examples/s4u/actor-daemon/s4u-actor-daemon.cpp \n
     Some actors may be intended to simulate daemons that run in background. This example show how to transform a regular
@@ -128,6 +131,7 @@ also the tesh files in the example directories for details.
 @example examples/s4u/actor-create/s4u-actor-create.cpp
 @example examples/s4u/actor-create/s4u-actor-create_d.xml
 @example examples/s4u/actor-daemon/s4u-actor-daemon.cpp
+@example examples/s4u/actor-execute/s4u-actor-execute.cpp
 @example examples/s4u/actor-kill/s4u-actor-kill.cpp
 @example examples/s4u/actor-migration/s4u-actor-migration.cpp
 @example examples/s4u/actor-suspend/s4u-actor-suspend.cpp
index 26fc7d1..b0c5e67 100644 (file)
@@ -3,14 +3,17 @@
 /* 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. */
 
- #include "simgrid/s4u.hpp"
- #include <cstdlib>
- #include <iostream>
+#include "simgrid/s4u.hpp"
+#include <cstdlib>
+#include <iostream>
 
-/* Main function of the actor I want to start manually */
-static int actor_function(std::vector<std::string> args)
+static int executor(std::vector<std::string> args)
 {
+  /* this_actor::execute() tells SimGrid to pause the calling actor
+   * until its host has computed the amount of flops passed as a parameter */
   simgrid::s4u::this_actor::execute(100);
+
+  /* This simple example does not do anything beyond that */
   return 0;
 }
 
@@ -20,9 +23,9 @@ int main(int argc, char *argv[])
   std::vector<std::string> args;
   xbt_assert(argc > 1, "Usage: %s platform_file\n\tExample: %s msg_platform.xml\n", argv[0], argv[0]);
 
-  e.loadPlatform(argv[1]); 
-  
-  simgrid::s4u::Actor::createActor("simple_func", simgrid::s4u::Host::by_name("Tremblay"), actor_function, args);
+  e.loadPlatform(argv[1]);
+
+  simgrid::s4u::Actor::createActor("executor", simgrid::s4u::Host::by_name("Tremblay"), executor, args);
 
   e.run();