1 S4U (Simgrid for you) is the next interface of SimGrid, expected to be released with SimGrid 4.0.
3 Even if it is not completely rock stable yet, it may well already fit
4 your needs. You are welcome to try it and report any interface
5 glitches that you see. Be however warned that the interface may change
6 until its final release. You will have to adapt your code on the way.
8 This file follows the Doxygen syntax to be included in the
9 documentation, but it should remain readable directly.
12 @defgroup s4u_examples S4U examples
14 @brief Find the S4U example fitting your needs in the archive.
24 @section s4u_ex_basics Basics of SimGrid simulation
26 - <b>Creating actors:</b> @ref examples/s4u/actor-create/s4u-actor-create.cpp and
27 @ref examples/s4u/actor-create/s4u-actor-create_d.xml \n
28 Shows how to start your actors to populate your simulation.
30 - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u-app-pingpong.cpp\n
31 This simple example just sends one message back and forth.
32 The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to
33 the simulators (as detailed in Section \ref options).
35 - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u-app-token-ring.cpp \n
36 Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every
39 - <b>Master Workers:</b> @ref examples/s4u/app-masterworker/s4u-app-masterworker.cpp \n
40 Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
43 @section s4u_ex_async Asynchronous communications
45 - <b>Basic asynchronous communications</b>.
46 @ref examples/s4u/async-wait/s4u-async-wait.cpp \n
47 Illustrates how to have non-blocking communications, that are
48 communications running in the background leaving the process free
49 to do something else during their completion. The main functions
50 involved are @ref simgrid::s4u::Comm::put_async and
51 @ref simgrid::s4u::Comm::wait().
53 - <b>Waiting for all communications in a set</b>.
54 @ref examples/s4u/async-waitall/s4u-async-waitall.cpp\n
55 The @ref simgrid::s4u::Comm::wait_all() function is useful when you want to block
56 until all activities in a given set have completed.
58 - <b>Waiting for the first completed communication in a set</b>.
59 @ref examples/s4u/async-waitany/s4u-async-waitany.cpp\n
60 The @ref simgrid::s4u::Comm::wait_any() function is useful when you want to block
61 until one activity of the set completes, no matter which terminates
64 @section s4u_ex_actors Acting on Actors
66 - <b>Creating actors</b>.
67 @ref examples/s4u/actor-create/s4u-actor-create.cpp \n
68 Most actors are started from the deployment XML file, but they exist other methods.
70 - <b>Actors using CPU time</b>.
71 @ref examples/s4u/actor-execute/s4u-actor-execute.cpp \n
72 The computations done in your program are not reported to the
73 simulated world, unless you explicitely request the simulator to pause
74 the actor until a given amount of flops gets computed on its simulated
77 - <b>Daemonize actors</b>
78 @ref examples/s4u/actor-daemon/s4u-actor-daemon.cpp \n
79 Some actors may be intended to simulate daemons that run in background. This example show how to transform a regular
80 actor into a daemon that will be automatically killed once the simulation is over.
82 - <b>Suspend and Resume actors</b>.
83 @ref examples/s4u/actor-suspend/s4u-actor-suspend.cpp \n
84 Actors can be suspended and resumed during their executions
85 thanks to the @ref suspend and @ref resume methods.
87 - <b>Priority actors</b>.
88 @ref examples/s4u/actor-priority/s4u-actor-priority.cpp \n
89 Actors can be launched according their priorities thanks to the @ref
93 @ref examples/s4u/actor-kill/s4u-actor-kill.cpp \n
94 Actors can forcefully stop other actors with the @ref kill method.
96 - <b>Controling the actor life cycle from the XML</b>.
97 @ref examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
98 @ref examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml
100 You can specify a start time and a kill time in the deployment file.
102 - <b>Migrating Actors</b>.
103 @ref examples/s4u/actor-migration/s4u-actor-migration.cpp \n
104 Actors can move or be moved from a host to another with the @ref migrate method.
106 - <b>Yielding to other actor</b>.
107 @ref examples/s4u/actor-yield/s4u-actor-yield.c\n
108 The simgrid::s4u::this_actor::yield() function interrupts the
109 execution of the current actor, leaving a chance to the other actors
110 that are ready to run at this timestamp.
112 @section s4u_ex_synchro Inter-Actor Synchronization
114 - <b>Mutex: </b> @ref examples/s4u/mutex/s4u-mutex.cpp \n
115 Shows how to use simgrid::s4u::Mutex synchronization objects.
117 @section s4u_ex_actions Following Workload Traces
119 This section details how to run trace-driven simulations. It is very
120 handy when you want to test an algorithm or protocol that only react
121 to external events. For example, many P2P protocols react to user
122 requests, but do nothing if there is no such event.
124 In such situations, you should write your protocol in C++, and separate
125 the workload that you want to play onto your protocol in a separate
126 text file. Declare a function handling each type of the events in your
127 trace, register them using @ref xbt_replay_action_register in your
128 main, and then run the simulation.
130 Then, you can either have one trace file containing all your events,
131 or a file per simulated process: the former may be easier to work
132 with, but the second is more efficient on very large traces. Check
133 also the tesh files in the example directories for details.
135 - <b>Communication replay</b>.
136 @ref examples/s4u/actions-comm/s4u-actions-comm.cpp \n
137 Presents a set of event handlers reproducing classical communication
138 primitives (asynchronous send/receive at the moment).
141 @ref examples/s4u/actions-storage/s4u-actions-storage.cpp \n
142 Presents a set of event handlers reproducing classical I/O
143 primitives (open, read, close).
145 @section s4u_ex_io Simulating disks and files
147 The examples of this section demonstrate how to interact with the
150 - <b>Access to raw storage devices </b>.
151 @ref examples/s4u/io-raw-storage/s4u-io-raw-storage.cpp \n
152 This example illustrates how to simply read and write data on a
153 simulated storage resource.
156 @ref examples/s4u/io-file-remote/s4u-io-file-remote.cpp \n
157 I/O operations on files can also be done in a remote fashion,
158 i.e. when the accessed disk is not mounted on the caller's host.
160 @section s4u_ex_energy Simulating the energy consumption
162 - <b>Using Pstates on a host</b>
163 @ref examples/s4u/energy-pstate/s4u-energy-pstate.cpp and
164 @ref examples/platforms/energy_platform.xml \n
165 Show how define a set of pstates for a host and how the current
166 pstate can be accessed/changed with @ref getPstateSpeed and @ref sg_host_set_pstate.
167 See also the platform XML file for have a details on how to declare the CPU capacity for each pstate.
172 @example examples/s4u/actions-comm/s4u-actions-comm.cpp
173 @example examples/s4u/actions-storage/s4u-actions-storage.cpp
174 @example examples/s4u/actor-create/s4u-actor-create.cpp
175 @example examples/s4u/actor-create/s4u-actor-create_d.xml
176 @example examples/s4u/actor-daemon/s4u-actor-daemon.cpp
177 @example examples/s4u/actor-execute/s4u-actor-execute.cpp
178 @example examples/s4u/actor-kill/s4u-actor-kill.cpp
179 @example examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
180 @example examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml
181 @example examples/s4u/actor-migration/s4u-actor-migration.cpp
182 @example examples/s4u/actor-suspend/s4u-actor-suspend.cpp
183 @example examples/s4u/app-token-ring/s4u-app-token-ring.cpp
184 @example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
185 @example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
186 @example examples/s4u/energy-pstate/s4u-energy-pstate.cpp
187 @example examples/platforms/energy_platform.xml
188 @example examples/s4u/io-file-remote/s4u-io-file-remote.cpp
189 @example examples/s4u/io-raw-storage/s4u-io-raw-storage.cpp
190 @example examples/s4u/mutex/s4u-mutex.cpp