X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d33e7a563a884247bff85406dcc589a70a162e79..6db737c47368af61478a5913db284b6e22a47d93:/examples/msg/README.doc diff --git a/examples/msg/README.doc b/examples/msg/README.doc index 0e5654a04c..0cd0792078 100644 --- a/examples/msg/README.doc +++ b/examples/msg/README.doc @@ -7,13 +7,11 @@ 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 @@ -39,31 +37,6 @@ documentation, but it should remain readable directly. 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: - - - 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 +44,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 @@ -117,7 +66,7 @@ options to see the task executions: 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 - Master Workers tracing. @@ -126,7 +75,7 @@ options to see the task executions: 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 - Process migration tracing. @@ -135,11 +84,11 @@ 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 (viva/vite/FrameSoc) should be given along with some +the right tool (vite/FrameSoc) should be given along with some screenshots. @subsection msg_ex_tracing_user_variables Tracing user variables @@ -183,38 +132,12 @@ 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 */ @@ -232,16 +155,7 @@ top of the example file). @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 @@ -253,12 +167,7 @@ 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 */