examples/msg/README.doc

   1 This file follows the Doxygen syntax to be included in the
   2 documentation, but it should remain readable directly.
   3
   4 /**
   5  @defgroup msg_examples MSG examples
   6  @ingroup MSG_API
   7  @brief Find the MSG example fitting your needs from the extensive set provided in the archive.
   8
   9   - @ref msg_ex_basics
  10   - @ref msg_ex_async
  11   - @ref msg_ex_process
  12   - @ref msg_ex_tracing
  13     - @ref msg_ex_tracing_user_variables
  14   - @ref msg_ex_models
  15     - @ref msg_ex_ns3
  16     - @ref msg_ex_io
  17   - @ref msg_ex_apps
  18   - @ref msg_ex_misc
  19
  20 @section msg_ex_basics Basic examples and features
  21
  22  - <b>Ping Pong</b>: @ref examples/msg/app-pingpong/app-pingpong.c\n
  23    It's hard to think of a simpler example: it is just sending one
  24    message back and forth.
  25    The tesh file laying in the directory show how to start the
  26    simulator binary, highlighting how to pass options to the simulators
  27    (as detailed in Section \ref options).
  28
  29  - <b>Token Ring</b>.
  30    @ref examples/msg/app-token-ring/app-token-ring.c\n
  31    Classical communication pattern, where a token is exchanged
  32    along a ring to reach every participant.
  33    The tesh file laying in the directory shows how to run the same
  34    example on different virtual platforms.
  35
  36  - <b>Master Workers</b>.
  37    @ref examples/msg/app-masterworker/app-masterworker.c\n
  38    Another good old example, where one Master process has a bunch of
  39    task to dispatch to a set of several Worker processes. It is fully
  40    commented in @ref msg_ex_master_worker.
  41
  42 @section msg_ex_async Asynchronous communications
  43
  44 In addition to the fully documented example of @ref
  45 MSG_ex_asynchronous_communications, there are several other examples
  46 shipped in the archive:
  47
  48  - <b>Basic asynchronous communications</b>.
  49    @ref examples/msg/async-wait/async-wait.c \n
  50    Illustrates how to have non-blocking communications, that are
  51    communications running in the background leaving the process free
  52    to do something else during their completion. The main functions
  53    involved are @ref MSG_task_isend, @ref MSG_task_irecv, and @ref
  54    MSG_comm_wait.
  55
  56  - <b>Waiting for all communications in a set</b>.
  57    @ref examples/msg/async-waitall/async-waitall.c\n
  58    The @ref MSG_comm_waitall function is useful when you want to block
  59    until all activities in a given set have completed.
  60
  61  - <b>Waiting for the first completed communication in a set</b>.
  62    @ref examples/msg/async-waitany/async-waitany.c\n
  63    The @ref MSG_comm_waitany function is useful when you want to block
  64    until one activity of the set completes, no matter which terminates
  65    first.
  66
  67 @section msg_ex_process Acting on Processes
  68
  69   - <b>Creating processes</b>.
  70     @ref examples/msg/process-create/process-create.c \n
  71     Most processes are started from the deployment XML file, but they
  72     can also be used with the @ref MSG_process_create() function.
  73
  74   - <b>Suspend and Resume processes</b>.
  75     @ref examples/msg/process-suspend/process-suspend.c \n
  76     Processes can be suspended and resumed during their executions
  77     thanks to the @ref MSG_process_suspend and @ref MSG_process_resume functions.
  78
  79   - <b>Kill processes</b>.
  80     @ref examples/msg/process-kill/process-kill.c \n
  81     Processes can forcefully stop other processes with the @ref MSG_process_kill function.
  82
  83   - <b>Migrating processes</b>.
  84     @ref examples/msg/process-migration/process-migration.c \n
  85     Processes can move or be moved from a host to another with the @ref MSG_process_migrate function.
  86
  87   - <b>Yielding to other processes</b>.
  88     @ref examples/msg/process-yield/process-yield.c\n
  89     The @ref MSG_process_yield function interrupts the execution of the
  90     current process, leaving a chance to run to the other processes
  91     that are ready to run at the exact same timestamp
  92
  93   - <b>Controling the process life cycle from the XML</b>.
  94     @ref examples/msg/process-startkilltime/process-startkilltime.c \n
  95     You can specify a start time and a kill time in the deployment
  96     file. See all *_d.xml files in this directory.
  97
  98   - <b>Using Pstates on a host</b>
  99     @ref examples/msg/energy-pstate/energy-pstate.c\n
 100     Show how define a set of pstates for a host and how the current
 101     pstate can be accessed/changed with @ref MSG_get_host_current_power_peak and @ref  MSG_set_host_pstate.
 102     See also the platform XML file for have a details on how to declare the CPU capacity for each pstate.
 103
 104 @section msg_ex_tracing Tracing and visualization features
 105
 106 Tracing can be activated by various configuration options which
 107 are illustrated in these example. See also the
 108 @ref tracing_tracing_options "full list of options related to tracing".
 109
 110 It is interesting to run the process-create example with the following
 111 options to see the task executions:
 112
 113   - <b>Platform tracing</b>.
 114     @ref examples/msg/trace-platform/trace-platform.c \n
 115     This program is a toy example just loading the platform, so that
 116     you can play with the platform visualization. Recommanded options:
 117     @verbatim --cfg=tracing:yes --cfg=tracing/categorized:yes
 118     @endverbatim
 119
 120   - <b>Setting Categories</b>.
 121     @ref examples/msg/trace-categories/trace-categories.c \n
 122     This example declares several tracing categories
 123     to that are used to classify its tasks. When the program is executed,
 124     the tracing mechanism registers the resource utilization of hosts
 125     and links according to these categories. Recommanded options:
 126     @verbatim --cfg=tracing:yes --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes --cfg=viva/categorized:viva_cat.plist --cfg=viva/uncategorized:viva_uncat.plist
 127     @endverbatim
 128
 129   - <b>Master Workers tracing</b>.
 130     @ref examples/msg/trace-masterworker/trace-masterworker.c \n
 131     This is an augmented version of our basic master/worker example
 132     using several tracing features. It traces resource usage, sorted
 133     out in several categories; Trace marks and user variables are also
 134     used. Recommanded options:
 135     @verbatim --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes --cfg=viva/categorized:viva_cat.plist --cfg=viva/uncategorized:viva_uncat.plist
 136     @endverbatim
 137
 138   - <b>Process migration tracing</b>.
 139     @ref examples/msg/trace-process-migration/trace-process-migration.c \n
 140     This version is enhanced so that the process migrations can be
 141     displayed as arrows in a Gantt-chart visualization. Recommanded
 142     options to that extend:
 143     @verbatim -cfg=tracing:yes --cfg=tracing/msg/process:yes
 144     @endverbatim
 145
 146 TODO: These tracing examples should be integrated in the examples to
 147 not duplicate the C files. A full command line to see the result in
 148 the right tool (viva/vite/FrameSoc) should be given along with some
 149 screenshots.
 150
 151 @subsection msg_ex_tracing_user_variables Tracing user variables
 152
 153 You can also attach your own variables to a any resource described in
 154 the platform file. The following examples illustrate this feature.
 155 They have to be run with the following options:
 156 @verbatim --cfg=tracing:yes --cfg=tracing/platform:yes
 157 @endverbatim
 158
 159   - <b>Attaching variables to Hosts</b>.
 160     @ref examples/msg/trace-host-user-variables/trace-host-user-variables.c
 161
 162   - <b>Attaching variables to Links</b>.
 163     @ref examples/msg/trace-link-user-variables/trace-link-user-variables.c \n
 164     The tricky part is that you have to know the name of the link you
 165     want to enhance with a variable.
 166
 167   - <b>Attaching variables to network Routes</b>
 168     @ref examples/msg/trace-route-user-variables/trace-route-user-variables.c \n
 169     It is often easier to update a given variable for all links of a
 170     given network path (identified by its source and destination
 171     hosts) instead of knowing the name of each specific link.
 172
 173 @section msg_ex_models Models-related examples
 174
 175 @subsection msg_ex_ns3 NS3 as a SimGrid Network Model
 176
 177 This example demonstrates how to use the bindings to the Network
 178 Simulator, as explained in @ref pls_ns3. The most
 179 interesting is probably not the C files since they are unchanged from
 180 the other simulations, but the associated files, such as the platform
 181 file to see how to declare a platform to be used with the ns-3 bindings
 182 of SimGrid and the tesh file to see how to actually start a simulation
 183 in these settings.
 184
 185   - @ref examples/msg/network-ns3/network-ns3.c. Simple ping-pong using
 186     ns-3 instead of the SimGrid network models.
 187
 188 TODO: merge the C files
 189
 190 TODO: show the XML files instead if it's what is interesting. On a "XML example files" page that does not exist yet.
 191
 192 @subsection msg_ex_io Simulating disks and files
 193
 194 The examples of this section demonstrate how to interact with the
 195 simulated storages.
 196
 197   - <b>Basic example</b>.
 198     @ref examples/msg/io-storage/io-storage.c \n
 199     All main storage and file functions are demoed.
 200
 201   - <b>File Management</b>. @ref examples/msg/io-file/io-file.c \n
 202     This example illustrates the use of operations on file
 203     (@ref MSG_file_open, @ref MSG_file_read, @ref MSG_file_write,
 204     or @ref MSG_file_close).
 205
 206   - <b>Remote I/O</b>. @ref examples/msg/io-remote/io-remote.c \n
 207     I/O operations can also be done in a remote, i.e. when the
 208     accessed disk is not mounted on the caller's host.
 209
 210 @section msg_ex_misc Miscellaneous
 211
 212  - <b>Task priorities</b>.
 213    @ref examples/msg/task-priority/task-priority.c \n
 214    Demonstrates the use of @ref MSG_task_set_priority to change the
 215    computation priority of  a given task.
 216
 217  - <b>User-defined properties</b>.
 218    @ref examples/msg/platform-properties/platform-properties.c \n
 219    Attaching arbitrary information to host, processes and
 220    such, and retrieving them with @ref MSG_host_get_properties,
 221    @ref MSG_host_get_property_value, @ref MSG_process_get_properties, and
 222    @ref MSG_process_get_property_value. Also make sure to read the
 223    platform and deployment XML files to see how to declare these data.
 224
 225 TODO: Document the many other examples that we have
 226 */
 227
 228 As a human, you can stop reading at this point. The rest is garbage:
 229
 230 Every example must be listed in the following, but it's not possible
 231 to move this content upper as each @example directive seems to eat
 232 everything until the next */ marker (and the content is placed at the
 233 top of the example file).
 234
 235
 236 /**
 237 @example examples/msg/app-pingpong/app-pingpong.c
 238 @example examples/msg/app-token-ring/app-token-ring.c
 239 @example examples/msg/app-masterworker/app-masterworker.c
 240
 241 @example examples/msg/async-wait/async-wait.c
 242 @example examples/msg/async-waitall/async-waitall.c
 243 @example examples/msg/async-waitany/async-waitany.c
 244 @example examples/msg/async-yield/async-yield.c
 245
 246 @example examples/msg/process-create/process-create.c
 247 @example examples/msg/process-suspend/process-suspend.c
 248 @example examples/msg/process-kill/process-kill.c
 249 @example examples/msg/process-migration/process-migration.c
 250 @example examples/msg/process-startkilltime/process-startkilltime.c
 251
 252 @example examples/msg/trace-platform/trace-platform.c
 253 @example examples/msg/trace-categories/trace-categories.c
 254 @example examples/msg/trace-masterworker/trace-masterworker.c
 255 @example examples/msg/trace-process-migration/trace-process-migration.c
 256 @example examples/msg/trace-host-user-variables/trace-host-user-variables.c
 257 @example examples/msg/trace-link-user-variables/trace-link-user-variables.c
 258 @example examples/msg/trace-route-user-variables/trace-route-user-variables.c
 259
 260 @example examples/msg/network-ns3/network-ns3.c
 261
 262 @example examples/msg/io-storage/io-storage.c
 263 @example examples/msg/io-file/io-file.c
 264 @example examples/msg/io-remote/io-remote.c
 265
 266 @example examples/msg/task-priority/task-priority.c
 267 @example examples/msg/platform-properties/platform-properties.c
 268
 269 */
 270