X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2807fde4fd1f59c230d69a934634c5dfb77905f2..d8eb62b207b566949a0d9ce649a7b21e226b9168:/examples/msg/README.doc diff --git a/examples/msg/README.doc b/examples/msg/README.doc index 63afa511bc..203c2495d2 100644 --- a/examples/msg/README.doc +++ b/examples/msg/README.doc @@ -7,63 +7,23 @@ documentation, but it should remain readable directly. @brief Find the MSG example fitting your needs from the extensive set provided in the archive. - @ref msg_ex_basics - - @ref msg_ex_async - @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_apps - - @ref msg_ex_misc -@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 - 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). +@warning MSG was deprecated in SimGrid v3.18. These examples should be + converted to S4U in the next releases. You really should + consider using S4U in your next project. - - Token Ring. - @ref examples/msg/app-token-ring/app-token-ring.c\n - Classical communication pattern, where a token is exchanged - along a ring to reach every participant. - The tesh file laying in the directory shows how to run the same - example on different virtual platforms. +@section msg_ex_basics Basic examples and features - Master Workers. @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. + task to dispatch to a set of several Worker processes. -@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: - - - Basic asynchronous communications. - @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. - - - Waiting for all communications in a set. - @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. - - - Waiting for the first completed communication in a set. - @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. @@ -71,30 +31,6 @@ shipped in the archive: 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 - thanks to the @ref MSG_process_suspend and @ref MSG_process_resume functions. - - - Kill processes. - @ref examples/msg/process-kill/process-kill.c \n - Processes can forcefully stop other processes with the @ref MSG_process_kill function. - - - Migrating processes. - @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. - - - Yielding to other processes. - @ref examples/msg/process-yield/process-yield.c\n - The @ref MSG_process_yield function interrupts the execution of the - current process, leaving a chance to run to the other processes - that are ready to run at the exact same timestamp - - - Controling the process life cycle from the XML. - @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. - @section msg_ex_tracing Tracing and visualization features Tracing can be activated by various configuration options which @@ -104,13 +40,6 @@ are illustrated in these example. See also the 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 - This program is a toy example just loading the platform, so that - you can play with the platform visualization. Recommanded options: - @verbatim --cfg=tracing:yes --cfg=tracing/categorized:yes - @endverbatim - - Setting Categories. @ref examples/msg/trace-categories/trace-categories.c \n This example declares several tracing categories @@ -135,8 +64,8 @@ options to see the task executions: 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 duplicate the C files. A full command line to see the result in the right tool (vite/FrameSoc) should be given along with some @@ -183,40 +112,6 @@ TODO: merge the C files 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. - - - Basic example. - @ref examples/msg/io-storage/io-storage.c \n - All main storage and file functions are demoed. - - - File Management. @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). - - - Remote I/O. @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. - -@section msg_ex_misc Miscellaneous - - - Task priorities. - @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. - - - User-defined properties. - @ref examples/msg/platform-properties/platform-properties.c \n - Attaching arbitrary information to host, processes and - such, and retrieving them with @ref MSG_host_get_properties, - @ref MSG_host_get_property_value, @ref MSG_process_get_properties, and - @ref MSG_process_get_property_value. Also make sure to read the - platform and deployment XML files to see how to declare these data. - -TODO: Document the many other examples that we have */ As a human, you can stop reading at this point. The rest is garbage: @@ -228,22 +123,10 @@ top of the example file). /** -@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-waitany/async-waitany.c -@example examples/msg/async-yield/async-yield.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-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 @@ -253,12 +136,5 @@ top of the example file). @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/task-priority/task-priority.c -@example examples/msg/platform-properties/platform-properties.c - */