X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b65f1d94c7599974e73d5423312cb0b5137852c1..84e634fed3de105f1fe3e1e60000a64c93e9098b:/examples/msg/README.doc diff --git a/examples/msg/README.doc b/examples/msg/README.doc index 2f586f02c6..0e5654a04c 100644 --- a/examples/msg/README.doc +++ b/examples/msg/README.doc @@ -14,17 +14,16 @@ documentation, but it should remain readable directly. - @ref msg_ex_models - @ref msg_ex_ns3 - @ref msg_ex_io - - @ref msg_ex_actions - @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, enlighting how to pass options to the simulators + simulator binary, highlighting how to pass options to the simulators (as detailed in Section \ref options). - Token Ring. @@ -65,12 +64,6 @@ shipped in the archive: until one activity of the set completes, no matter which terminates first. - - Yielding to other processes. - @ref examples/msg/async-yield/async-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 - @section msg_ex_process Acting on Processes - Creating processes. @@ -91,6 +84,12 @@ shipped in the archive: @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 @@ -202,44 +201,6 @@ simulated storages. 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_actions Following Workload Traces - -This section details how to run trace-driven simulations. It is very -handy when you want to test an algorithm or protocol that only react -to external events. For example, many P2P protocols react to user -requests, but do nothing if there is no such event. - -In such situations, you should write your protocol in C, and separate -the workload that you want to play onto your protocol in a separate -text file. Declare a function handling each type of the events in your -trace, register them using @ref xbt_replay_action_register in your -main, and then use @ref MSG_action_trace_run to launch the simulation. - -Then, you can either have one trace file containing all your events, -or a file per simulated process: the former may be easier to work -with, but the second is more efficient on very large traces. Check -also the tesh files in the example directories for details. - - - Communication replay. - @ref examples/msg/actions-comm/actions-comm.c \n - Presents a set of event handlers reproducing classical communication - primitives (synchronous and asynchronous send/receive, broadcast, - barrier, etc). - - - I/O replay. - @ref examples/msg/actions-storage/actions-storage.c \n - Presents a set of event handlers reproducing classical I/O - primitives (open, read, write, close, etc). - -@section msg_ex_apps Examples of Full Applications - - - Chord P2P protocol. - @ref examples/msg/dht-chord/dht-chord.c \n - This example implements the well known Chord protocol, - constituting a fully working non-trivial example. This - implementation is also very efficient, as demonstrated in - http://hal.inria.fr/inria-00602216/ - @section msg_ex_misc Miscellaneous - Task priorities. @@ -267,8 +228,8 @@ 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-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 @@ -296,13 +257,8 @@ top of the example file). @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/dht-chord/dht-chord.c - @example examples/msg/task-priority/task-priority.c @example examples/msg/platform-properties/platform-properties.c - + */