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 the 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.
16 SimGrid comes with an extensive set of examples, documented on this
17 page. Most of them only demonstrate one single feature, with some
18 larger examplars listed below.
20 Each of these examples can be found in a subdirectory under
21 examples/s4u in the archive. It contains the source code (also listed
22 from this page), and the so-called tesh file containing how to call
23 the binary obtained by compiling this example and also the expected
24 output. Tesh files are used to turn each of our examples into an
25 integration test. Some examples also contain other files, on need.
27 A good way to bootstrap your own project is to copy and combine some
28 of the provided examples to constitute the skeleton of what you plan
32 - @ref s4u_ex_actors_start
33 - @ref s4u_ex_actors_synchro
34 - @ref s4u_ex_actors_replay
35 - @ref s4u_ex_activities
36 - @ref s4u_ex_activity_comm
37 - @ref s4u_ex_activity_exec
38 - @ref s4u_ex_activity_io
39 - @ref s4u_ex_activity_synchro
44 - @ref s4u_ex_app_data
47 TODO: document here the examples about plugins
49 @section s4u_ex_actors Actors: the active entities
51 @subsection s4u_ex_actors_start Starting and stoping actors
53 - <b>Creating actors</b>.
54 @ref examples/s4u/actor-create/s4u-actor-create.cpp \n
55 Most actors are started from the deployment XML file, but there is other methods.
56 This example show them all.
59 @ref examples/s4u/actor-kill/s4u-actor-kill.cpp \n
60 Actors can forcefully stop other actors with the @ref
61 simgrid::s4u::Actor::kill() method.
63 - <b>Controling the actor life cycle from the XML</b>.
64 @ref examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
65 @ref examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml
67 You can specify a start time and a kill time in the deployment file.
69 - <b>Daemonize actors</b>
70 @ref examples/s4u/actor-daemon/s4u-actor-daemon.cpp \n
71 Some actors may be intended to simulate daemons that run in background. This example show how to transform a regular
72 actor into a daemon that will be automatically killed once the simulation is over.
74 @subsection s4u_ex_actors_synchro Inter-actors interactions
76 - <b>Suspend and Resume actors</b>.
77 @ref examples/s4u/actor-suspend/s4u-actor-suspend.cpp \n
78 Actors can be suspended and resumed during their executions
79 thanks to the @ref simgrid::s4u::Actor::suspend and @ref simgrid::s4u::Actor::resume methods.
81 - <b>Migrating Actors</b>.
82 @ref examples/s4u/actor-migration/s4u-actor-migration.cpp \n
83 Actors can move or be moved from a host to another with the @ref
84 simgrid::s4u::this_actor::migrate() method.
86 - <b>Waiting for the termination of an actor</b> (joining on it)
87 @ref examples/s4u/actor-join/s4u-actor-join.cpp \n
88 The simgrid::s4u::Actor::join() method allows to block the current
89 actor until the end of the receiving actor.
91 - <b>Yielding to other actor</b>.
92 @ref examples/s4u/actor-yield/s4u-actor-yield.cpp\n
93 The simgrid::s4u::this_actor::yield() function interrupts the
94 execution of the current actor, leaving a chance to the other actors
95 that are ready to run at this timestamp.
97 @subsection s4u_ex_actors_replay Traces Replay as a Workload
99 This section details how to run trace-driven simulations. It is very
100 handy when you want to test an algorithm or protocol that only react
101 to external events. For example, many P2P protocols react to user
102 requests, but do nothing if there is no such event.
104 In such situations, you should write your protocol in C++, and separate
105 the workload that you want to play onto your protocol in a separate
106 text file. Declare a function handling each type of the events in your
107 trace, register them using @ref xbt_replay_action_register in your
108 main, and then run the simulation.
110 Then, you can either have one trace file containing all your events,
111 or a file per simulated process: the former may be easier to work
112 with, but the second is more efficient on very large traces. Check
113 also the tesh files in the example directories for details.
115 - <b>Communication replay</b>.
116 @ref examples/s4u/replay-comm/s4u-replay-comm.cpp \n
117 Presents a set of event handlers reproducing classical communication
118 primitives (asynchronous send/receive at the moment).
121 @ref examples/s4u/replay-storage/s4u-replay-storage.cpp \n
122 Presents a set of event handlers reproducing classical I/O
123 primitives (open, read, close).
125 @section s4u_ex_activities Activities: the things that Actors do
127 @subsection s4u_ex_activity_comm Communications on the network
129 - <b>Basic asynchronous communications</b>.
130 @ref examples/s4u/async-wait/s4u-async-wait.cpp \n
131 Illustrates how to have non-blocking communications, that are
132 communications running in the background leaving the process free
133 to do something else during their completion. The main functions
134 involved are @ref simgrid::s4u::Mailbox::put_async and
135 @ref simgrid::s4u::Comm::wait().
137 - <b>Waiting for all communications in a set</b>.
138 @ref examples/s4u/async-waitall/s4u-async-waitall.cpp\n
139 The @ref simgrid::s4u::Comm::wait_all() function is useful when you want to block
140 until all activities in a given set have completed.
142 - <b>Waiting for the first completed communication in a set</b>.
143 @ref examples/s4u/async-waitany/s4u-async-waitany.cpp\n
144 The @ref simgrid::s4u::Comm::wait_any() function is useful when you want to block
145 until one activity of the set completes, no matter which terminates
148 @subsection s4u_ex_activity_exec Executions on the CPU
150 - <b>Basic execution</b>.
151 @ref examples/s4u/exec-basic/s4u-exec-basic.cpp \n
152 The computations done in your program are not reported to the
153 simulated world, unless you explicitely request the simulator to pause
154 the actor until a given amount of flops gets computed on its simulated
155 host. Some executions can be given an higher priority so that they
158 - <b>Asynchronous execution</b>.
159 @ref examples/s4u/exec-async/s4u-exec-async.cpp \n
160 You can start asynchronous executions, just like you would fire
163 - <b>Monitoring asynchronous executions</b>.
164 @ref examples/s4u/exec-monitor/s4u-exec-monitor.cpp \n
165 This example shows how to start an asynchronous execution, and
168 - <b>Remote execution</b>.
169 @ref examples/s4u/exec-remote/s4u-exec-remote.cpp \n
170 Before its start, you can change the host on which a given execution will occur.
172 - <b>Using Pstates on a host</b>
173 @ref examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp and
174 @ref examples/platforms/energy_platform.xml \n
175 Show how define a set of pstatesfor a host in the XML, and how the current
176 pstate can be accessed/changed with @ref simgrid::s4u::Host::getPstateSpeed and @ref simgrid::s4u::Host::setPstate.
178 - <b>Parallel tasks</b>
179 @ref examples/s4u/exec-ptask/s4u-exec-ptask.cpp\n
180 These objects are convenient abstractions of parallel
181 computational kernels that span over several machines.
183 @subsection s4u_ex_activity_io I/O on disks and files
185 SimGrid provides two levels of abstraction to interact with the
186 simulated storages. At the simplest level, you simply create read and
187 write actions on the storage resources.
189 - <b>Access to raw storage devices</b>.
190 @ref examples/s4u/io-storage-raw/s4u-io-storage-raw.cpp \n
191 This example illustrates how to simply read and write data on a
192 simulated storage resource.
194 The FileSystem plugin provides a more detailed view, with the
195 classical operations over files: open, move, unlink, and of course
196 read and write. The file and disk sizes are also dealt with and can
197 result in short reads and short write, as in reality.
199 - <b>File Management</b>. @ref examples/s4u/io-file-system/s4u-io-file-system.cpp \n
200 This example illustrates the use of operations on files
201 (read, write, seek, tell, unlink, ...).
204 @ref examples/s4u/io-file-remote/s4u-io-file-remote.cpp \n
205 I/O operations on files can also be done in a remote fashion,
206 i.e. when the accessed disk is not mounted on the caller's host.
208 @subsection s4u_ex_activity_synchro Classical synchronization objects
210 - <b>Mutex: </b> @ref examples/s4u/mutex/s4u-mutex.cpp \n
211 Shows how to use simgrid::s4u::Mutex synchronization objects.
213 @section s4u_ex_platf Interacting with the platform
215 - <b>User-defined properties</b>.
216 @ref examples/s4u/platform-properties/s4u-platform-properties.cpp and
217 @ref examples/s4u/platform-properties/s4u-platform-properties_d.xml and
218 @ref examples/platforms/prop.xml \n
219 You can attach arbitrary information to most platform elements from
220 the XML file, and then interact with these values from your
221 program. Note that the changes are not written into the XML file: they
222 will only last until the end of your simulation.
223 - simgrid::s4u::Actor::getProperty() and simgrid::s4u::Actor::setProperty()
224 - simgrid::s4u::Host::getProperty() and simgrid::s4u::Host::setProperty()
225 - simgrid::s4u::Link::getProperty() and simgrid::s4u::Link::setProperty()
226 - simgrid::s4u::NetZone::getProperty() and simgrid::s4u::NetZone::setProperty()
228 @section s4u_ex_energy Simulating the energy consumption
230 - <b>Describing the energy profiles in the platform</b>
231 @ref examples/platforms/energy_platform.xml \n
232 This platform file contains the energy profile of each links and
233 hosts, which is necessary to get energy consumption predictions.
234 As usual, you should not trust our example, and you should strive
235 to double-check that your instanciation matches your target platform.
237 - <b>Consumption due to the CPU</b>
238 @ref examples/s4u/energy-exec/s4u-energy-exec.cpp \n
239 This example shows how to retrieve the amount of energy consumed
240 by the CPU during computations, and the impact of the pstate.
242 - <b>Consumption due to the network</b>
243 @ref examples/s4u/energy-link/s4u-energy-link.cpp
244 This example shows how to retrieve and display the energy consumed
245 by the network during communications.
247 - <b>Modeling the shutdown and boot of hosts</b>
248 @ref examples/s4u/energy-boot/platform_boot.xml
249 @ref examples/s4u/energy-boot/s4u-energy-boot.cpp\n
250 Simple example of model of model for the energy consumption during
251 the host boot and shutdown periods.
253 @section s4u_ex_tracing Tracing and visualization features
255 Tracing can be activated by various configuration options which
256 are illustrated in these example. See also the
257 @ref tracing_tracing_options "full list of options related to tracing".
259 It is interesting to run the process-create example with the following
260 options to see the task executions:
262 - <b>Platform tracing</b>.
263 @ref examples/s4u/trace-platform/s4u-trace-platform.cpp \n
264 This program is a toy example just loading the platform, so that
265 you can play with the platform visualization. Recommanded options:
266 @verbatim --cfg=tracing:yes --cfg=tracing/categorized:yes
269 @section s4u_ex_app Larger SimGrid examplars
271 This section contains application examples that are somewhat larger
272 than the previous examples.
274 - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u-app-pingpong.cpp\n
275 This simple example just sends one message back and forth.
276 The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to
277 the simulators (as detailed in Section \ref options).
279 - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u-app-token-ring.cpp \n
280 Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every
283 - <b>Master Workers:</b> @ref examples/s4u/app-masterworker/s4u-app-masterworker.cpp \n
284 Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker
287 @subsection s4u_ex_app_data Data diffusion
290 @ref examples/s4u/app-bittorrent/s4u-bittorrent.cpp\n
291 Classical protocol for Peer-to-Peer data diffusion.
293 - <b>Chained send</b>
294 @ref examples/s4u/app-chainsend/s4u-app-chainsend.cpp\n
295 Data broadcast over a ring of processes.
297 @subsection s4u_ex_app_dht Distributed Hash Tables (DHT)
299 - <b>Chord Protocol</b>
300 @ref examples/s4u/dht-chord/s4u-dht-chord.cpp\n
301 One of the most famous DHT protocol.
306 @example examples/s4u/actor-create/s4u-actor-create.cpp
307 @example examples/s4u/actor-create/s4u-actor-create_d.xml
308 @example examples/s4u/actor-daemon/s4u-actor-daemon.cpp
309 @example examples/s4u/actor-join/s4u-actor-join.cpp
310 @example examples/s4u/actor-kill/s4u-actor-kill.cpp
311 @example examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
312 @example examples/s4u/actor-lifetime/s4u-actor-lifetime_d.xml
313 @example examples/s4u/actor-migration/s4u-actor-migration.cpp
314 @example examples/s4u/actor-suspend/s4u-actor-suspend.cpp
315 @example examples/s4u/actor-yield/s4u-actor-yield.cpp
316 @example examples/s4u/async-wait/s4u-async-wait.cpp
317 @example examples/s4u/async-waitall/s4u-async-waitall.cpp
318 @example examples/s4u/async-waitany/s4u-async-waitany.cpp
319 @example examples/s4u/app-bittorrent/s4u-bittorrent.cpp
320 @example examples/s4u/app-chainsend/s4u-app-chainsend.cpp
321 @example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
322 @example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
323 @example examples/s4u/app-token-ring/s4u-app-token-ring.cpp
324 @example examples/s4u/dht-chord/s4u-dht-chord.cpp
325 @example examples/s4u/energy-boot/platform_boot.xml
326 @example examples/s4u/energy-boot/s4u-energy-boot.cpp
327 @example examples/s4u/energy-exec/s4u-energy-exec.cpp
328 @example examples/s4u/energy-link/s4u-energy-link.cpp
329 @example examples/s4u/exec-basic/s4u-exec-basic.cpp
330 @example examples/s4u/exec-async/s4u-exec-async.cpp
331 @example examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp
332 @example examples/s4u/exec-monitor/s4u-exec-monitor.cpp
333 @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
334 @example examples/s4u/exec-remote/s4u-exec-remote.cpp
335 @example examples/s4u/io-file-system/s4u-io-file-system.cpp
336 @example examples/s4u/io-file-remote/s4u-io-file-remote.cpp
337 @example examples/s4u/io-storage-raw/s4u-io-storage-raw.cpp
338 @example examples/s4u/mutex/s4u-mutex.cpp
339 @example examples/s4u/platform-properties/s4u-platform-properties.cpp
340 @example examples/s4u/platform-properties/s4u-platform-properties_d.xml
341 @example examples/s4u/replay-comm/s4u-replay-comm.cpp
342 @example examples/s4u/replay-storage/s4u-replay-storage.cpp
343 @example examples/s4u/trace-platform/s4u-trace-platform.cpp
344 @example examples/platforms/energy_platform.xml
345 @example examples/platforms/prop.xml