Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
move the MSG process-kill example to teshsuite
[simgrid.git] / examples / msg / README.doc
index 56533bc..17aeb0a 100644 (file)
@@ -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
 
  - <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>.
@@ -77,20 +76,11 @@ shipped in the archive:
     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>Yielding to other processes</b>.
-    @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
-
   - <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
@@ -118,7 +108,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
     
   - <b>Master Workers tracing</b>.
@@ -127,7 +117,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
     
   - <b>Process migration tracing</b>.
@@ -140,7 +130,7 @@ options to see the task executions:
 
 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
@@ -202,36 +192,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.
-
-  - <b>Communication replay</b>.
-    @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).
-
-  - <b>I/O replay</b>.
-    @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_misc Miscellaneous
 
  - <b>Task priorities</b>.
@@ -259,18 +219,16 @@ 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
 @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
 
@@ -288,11 +246,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/task-priority/task-priority.c
 @example examples/msg/platform-properties/platform-properties.c
-                        
+
 */