X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/93cdf2806f1b01f205897e8fd6434be1b0ee0141..da6da59e6a2770e25be5d88661e8f8e32810e0ff:/examples/msg/README.doc diff --git a/examples/msg/README.doc b/examples/msg/README.doc index 1ee4a2e5da..baefe269dc 100644 --- a/examples/msg/README.doc +++ b/examples/msg/README.doc @@ -6,7 +6,7 @@ documentation, but it should remain readable directly. @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_basics - @ref msg_ex_async - @ref msg_ex_process - @ref msg_ex_tracing @@ -18,7 +18,7 @@ documentation, but it should remain readable directly. - @ref msg_ex_apps - @ref msg_ex_misc -@section msg_ex_basic Basic examples and features +@section msg_ex_basics Basic examples and features - Ping Pong: @ref examples/msg/app-pingpong/app-pingpong.c\n It's hard to think of a simpler example: it is just sending one @@ -60,13 +60,18 @@ shipped in the archive: until all activities in a given set have completed. - Waiting for the first completed communication in a set. - @ref examples/msg/async-waitall/async-waitany.c\n + @ref examples/msg/async-waitany/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. @section msg_ex_process Acting on Processes + - Creating processes. + @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. + - Suspend and Resume processes. @ref examples/msg/process-suspend/process-suspend.c \n Processes can be suspended and resumed during their executions @@ -85,18 +90,14 @@ shipped in the archive: 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() - @section msg_ex_tracing Tracing and visualization features Tracing can be activated by various configuration options which are illustrated in these example. See also the @ref tracing_tracing_options "full list of options related to tracing". - - Basic example. @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: - Platform tracing. @ref examples/msg/trace-platform/trace-platform.c \n @@ -132,7 +133,7 @@ are illustrated in these example. See also the @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 +not duplicate the C files. A full command line to see the result in the right tool (viva/vite/FrameSoc) should be given along with some screenshots. @@ -143,34 +144,30 @@ the platform file. The following examples illustrate this feature. They have to be run with the following options: @verbatim --cfg=tracing:yes --cfg=tracing/platform:yes @endverbatim - + - Attaching variables to Hosts. - @ref examples/msg/trace-user-variables/trace-user-variables.c - + @ref examples/msg/trace-host-user-variables/trace-host-user-variables.c + - Attaching variables to Links. @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. - + - Attaching variables to network Routes - @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. @@ -272,28 +269,27 @@ 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-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/async-waitany/async-waitany.c +@example examples/msg/process-create/process-create.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/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 @@ -305,10 +301,10 @@ top of the example file). @example examples/msg/actions-storage/actions-storage.c @example examples/msg/app-pmm/app-pmm.c -@example examples/msg/dht-chord +@example examples/msg/dht-chord/dht-chord.c @example examples/msg/task-priority/task-priority.c -@example examples/msg/properties/properties.c +@example examples/msg/platform-properties/platform-properties.c */