documentation, but it should remain readable directly.
/**
- @defgroup MSG_examples MSG examples
+ @defgroup msg_examples MSG examples
@ingroup MSG_API
@brief Find the MSG example fitting your needs from the extensive set provided in the archive.
- - @ref msg_ex_basic
- - @ref msg_ex_async
+ - @ref msg_ex_basics
- @ref msg_ex_process
- @ref msg_ex_tracing
- @ref msg_ex_tracing_user_variables
- @ref msg_ex_models
- @ref msg_ex_ns3
- - @ref msg_ex_io
- - @ref msg_ex_actions
- - @ref msg_ex_full_apps
+ - @ref msg_ex_apps
- @ref msg_ex_misc
-
-@section msg_ex_basic Basic examples and features
+
+@section msg_ex_basics Basic examples and features
- <b>Ping Pong</b>: @ref examples/msg/app-pingpong/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, enlighting how to pass options to the simulators
+ simulator binary, highlighting how to pass options to the simulators
(as detailed in Section \ref options).
- <b>Token Ring</b>.
@ref examples/msg/app-masterworker/app-masterworker.c\n
Another good old example, where one Master process has a bunch of
task to dispatch to a set of several Worker processes. It is fully
- commented in @ref MSG_ex_master_worker.
-
-@section msg_ex_async Asynchronous communications
-
-In addition to the fully documented example of @ref
-MSG_ex_asynchronous_communications, there are several other examples
-shipped in the archive:
-
- - <b>Basic asynchronous communications</b>.
- @ref examples/msg/async-wait/async-wait.c \n
- Illustrates how to have non-blocking communications, that are
- communications running in the background leaving the process free
- to do something else during their completion. The main functions
- involved are @ref MSG_task_isend, @ref MSG_task_irecv, and @ref
- MSG_comm_wait.
-
- - <b>Waiting for all communications in a set</b>.
- @ref examples/msg/async-waitall/async-waitall.c\n
- The @ref MSG_comm_waitall function is useful when you want to block
- until all activities in a given set have completed.
-
- - <b>Waiting for the first completed communication in a set</b>.
- @ref examples/msg/async-waitall/async-waitany.c\n
- The @ref MSG_comm_waitany function is useful when you want to block
- until one activity of the set completes, no matter which terminates
- first.
+ commented in @ref msg_ex_master_worker.
@section msg_ex_process Acting on Processes
- - <b>Suspend and Resume processes</b>.
- @ref examples/msg/process-suspend/process-suspend.c \n
- Processes can be suspended and resumed during their executions
- thanks to the @ref MSG_process_suspend and @ref MSG_process_resume functions.
-
- - <b>Kill processes</b>.
- @ref examples/msg/process-kill/process-kill.c \n
- Processes can forcefully stop other processes with the @ref MSG_process_kill function.
-
- - <b>Migrating processes</b>.
- @ref examples/msg/process-migration/process-migration.c \n
- Processes can move or be moved from a host to another with the @ref MSG_process_migrate function.
-
- - <b>Controling the process life cycle from the XML</b>.
- @ref examples/msg/process-startkilltime/process-startkilltime.c \n
- You can specify a start time and a kill time in the deployment
- file. See all *_d.xml files in this directory.
-
-TODO: add an example using @ref MSG_process_create()
+ - <b>Creating processes</b>.
+ @ref examples/msg/process-create/process-create.c \n
+ Most processes are started from the deployment XML file, but they
+ can also be used with the @ref MSG_process_create() function.
@section msg_ex_tracing Tracing and visualization features
are illustrated in these example. See also the
@ref tracing_tracing_options "full list of options related to tracing".
- - <b>Basic example</b>. @ref examples/msg/trace-simple/trace-simple.c \n
- In this very simple program, each process creates, executes,
- and destroy a task. Recommanded options:
- @verbatim --cfg=tracing:yes --cfg=tracing/uncategorized:yes @endverbatim
+It is interesting to run the process-create example with the following
+options to see the task executions:
- <b>Platform tracing</b>.
@ref examples/msg/trace-platform/trace-platform.c \n
to that are used to classify its tasks. When the program is executed,
the tracing mechanism registers the resource utilization of hosts
and links according to these categories. Recommanded options:
- @verbatim --cfg=tracing:yes --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes --cfg=viva/categorized:viva_cat.plist --cfg=viva/uncategorized:viva_uncat.plist
+ @verbatim --cfg=tracing:yes --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes
@endverbatim
- <b>Master Workers tracing</b>.
using several tracing features. It traces resource usage, sorted
out in several categories; Trace marks and user variables are also
used. Recommanded options:
- @verbatim --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes --cfg=viva/categorized:viva_cat.plist --cfg=viva/uncategorized:viva_uncat.plist
+ @verbatim --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes
@endverbatim
- <b>Process migration tracing</b>.
displayed as arrows in a Gantt-chart visualization. Recommanded
options to that extend:
@verbatim -cfg=tracing:yes --cfg=tracing/msg/process:yes
- @endverbatim
-
+ @endverbatim
+
TODO: These tracing examples should be integrated in the examples to
-not dupplicate the C files. A full command line to see the result in
-the right tool (viva/vite/FrameSoc) should be given along with some
+not duplicate the C files. A full command line to see the result in
+the right tool (vite/FrameSoc) should be given along with some
screenshots.
@subsection msg_ex_tracing_user_variables Tracing user variables
They have to be run with the following options:
@verbatim --cfg=tracing:yes --cfg=tracing/platform:yes
@endverbatim
-
+
- <b>Attaching variables to Hosts</b>.
- @ref examples/msg/trace-user-variables/trace-user-variables.c
-
+ @ref examples/msg/trace-host-user-variables/trace-host-user-variables.c
+
- <b>Attaching variables to Links</b>.
@ref examples/msg/trace-link-user-variables/trace-link-user-variables.c \n
The tricky part is that you have to know the name of the link you
want to enhance with a variable.
-
+
- <b>Attaching variables to network Routes</b>
- @ref examples/msg/trace-link-srcdst-user-variables/trace-link-srcdst-user-variables.c \n
+ @ref examples/msg/trace-route-user-variables/trace-route-user-variables.c \n
It is often easier to update a given variable for all links of a
given network path (identified by its source and destination
hosts) instead of knowing the name of each specific link.
-TODO: rename trace-user-variables to trace-host-user-variables
-
-TODO: rename trace-link-srcdst-user-variables to trace-route-user-variables
-
@section msg_ex_models Models-related examples
@subsection msg_ex_ns3 NS3 as a SimGrid Network Model
This example demonstrates how to use the bindings to the Network
-Simulator, as explained in @ref pls. The most
+Simulator, as explained in @ref pls_ns3. The most
interesting is probably not the C files since they are unchanged from
the other simulations, but the associated files, such as the platform
-file to see how to declare a platform to be used with the PLS bindings
+file to see how to declare a platform to be used with the ns-3 bindings
of SimGrid and the tesh file to see how to actually start a simulation
in these settings.
TODO: show the XML files instead if it's what is interesting. On a "XML example files" page that does not exist yet.
-@subsection msg_ex_io Simulating disks and files
-
-The examples of this section demonstrate how to interact with the
-simulated storages.
-
- - <b>Basic example</b>.
- @ref examples/msg/io-storage/io-storage.c \n
- All main storage and file functions are demoed.
-
- - <b>File Management</b>. @ref examples/msg/io-file/io-file.c \n
- This example illustrates the use of operations on file
- (@ref MSG_file_open, @ref MSG_file_read, @ref MSG_file_write,
- or @ref MSG_file_close).
-
- - <b>Remote I/O</b>. @ref examples/msg/io-remote/io-remote.c \n
- I/O operations can also be done in a remote, i.e. when the
- accessed disk is not mounted on the caller's host.
-
- - @ref examples/msg/actions-comm/actions-comm.c \n
- - @ref examples/msg/actions-storage/actions-storage.c \n
- - @ref examples/msg/app-pmm/app-pmm.c \n
- - @ref examples/msg/dht-chord \n
- - @ref examples/msg/task-priority/task-priority.c \n
- - @ref examples/msg/properties/properties.c \n
+@section msg_ex_misc Miscellaneous
+ - <b>Task priorities</b>.
+ @ref examples/msg/task-priority/task-priority.c \n
+ Demonstrates the use of @ref MSG_task_set_priority to change the
+ computation priority of a given task.
+
+TODO: Document the many other examples that we have
*/
As a human, you can stop reading at this point. The rest is garbage:
Every example must be listed in the following, but it's not possible
-to move this content upper as each @example directive seems to eat the
-next doxygen commands (and the content is placed at the top of the
-example file).
+to move this content upper as each @example directive seems to eat
+everything until the next */ marker (and the content is placed at the
+top of the example file).
/**
-@defgroup MSG_ex_examples ignored
-@example examples/msg/app-pingpong/app-pingpong.c
-@example examples/msg/app-token-ring/app-token-ring.c
+@example examples/msg/app-pingpong/app-pingpong.c
+@example examples/msg/app-token-ring/app-token-ring.c
@example examples/msg/app-masterworker/app-masterworker.c
-@example examples/msg/async-wait/async-wait.c
-@example examples/msg/async-waitall/async-waitall.c
-@example examples/msg/async-waitall/async-waitany.c
-
-@example examples/msg/process-suspend/process-suspend.c
-@example examples/msg/process-kill/process-kill.c
-@example examples/msg/process-migration/process-migration.c
-@example examples/msg/process-startkilltime/process-startkilltime.c
+@example examples/msg/process-create/process-create.c
-@example examples/msg/trace-simple/trace-simple.c
@example examples/msg/trace-platform/trace-platform.c
@example examples/msg/trace-categories/trace-categories.c
@example examples/msg/trace-masterworker/trace-masterworker.c
@example examples/msg/trace-process-migration/trace-process-migration.c
-@example examples/msg/trace-user-variables/trace-user-variables.c
+@example examples/msg/trace-host-user-variables/trace-host-user-variables.c
@example examples/msg/trace-link-user-variables/trace-link-user-variables.c
-@example examples/msg/trace-link-srcdst-user-variables/trace-link-srcdst-user-variables.c
+@example examples/msg/trace-route-user-variables/trace-route-user-variables.c
@example examples/msg/network-ns3/network-ns3.c
-@example examples/msg/io-storage/io-storage.c
-@example examples/msg/io-file/io-file.c
-@example examples/msg/io-remote/io-remote.c
-@example examples/msg/actions-comm/actions-comm.c
-@example examples/msg/actions-storage/actions-storage.c
-@example examples/msg/app-pmm/app-pmm.c
-@example examples/msg/dht-chord
@example examples/msg/task-priority/task-priority.c
-@example examples/msg/properties/properties.c
-
-*/
-
-Basic examples and features
-===========================
-
- * properties/msg_prop.c Attaching arbitrary information to host,
- processes and such, and retrieving them with
- MSG_host_get_properties(), MSG_host_get_property_value(),
- MSG_process_get_properties() and MSG_process_get_property_value().
- Also make sure to read the platform and deployment XML files to see
- how to declare these data.
-
- * parallel_task/parallel_task.c: Demonstrates the use of
- MSG_parallel_task_create(), to create special tasks that run on
- several hosts at the same time. The resulting simulations are very
- close to what can be achieved in SimDag, but still allows to use
- the other features of MSG (it'd be cool to be able to mix
- interfaces, but it's not possible ATM).
-
- * priority/priority.c: Demonstrates the use of
- MSG_task_set_priority() to change the computation priority of a
- given task.
-
-Trace driven simulations
-========================
-
-The actions/actions.c example demonstrates how to run trace-driven
-simulations. It is very handy when you want to test an algorithm or
-protocol that does nothing unless it receives some events from
-outside. For example, a P2P protocol reacts to requests from the user,
-but does nothing if there is no such event.
-
-In such situations, SimGrid allows to write your protocol in your C
-file, and the events to react to in a separate text file. Declare a
-function handling each of the events that you want to accept in your
-trace files, register them using MSG_action_register in your main, and
-then use MSG_action_trace_run to launch the simulation. You can either
-have one trace file containing all your events, or a file per
-simulated process. Check the tesh files in the example directory for
-details on how to do it.
-
-This example uses this approach to replay MPI-like traces. It comes
-with a set of event handlers reproducing MPI events. This is somehow
-similar to SMPI, yet differently implemented. This code should
-probably be changed to use SMPI internals instead, but wasn't, so far.
-
-Examples of full applications
-=============================
-
- * chord/chord.c: Classical Chord P2P protocol This example implements
- the well known Chord P2P protocol. Its main advantage is that it
- constitute a fully working non-trivial example. In addition, its
- implementation is rather efficient, as demonstrated in
- [57]http://hal.inria.fr/inria-00602216/
+*/
