examples/deprecated/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_tracing
  10     - @ref msg_ex_tracing_user_variables
  11
  12 @warning MSG was deprecated in SimGrid v3.18. These examples should be
  13          converted to S4U in the next releases. You really should
  14          consider using S4U in your next project.
  15
  16 @section msg_ex_tracing Tracing and visualization features
  17
  18 Tracing can be activated by various configuration options which
  19 are illustrated in these example. See also the
  20 @ref tracing_tracing_options "full list of options related to tracing".
  21
  22 It is interesting to run the process-create example with the following
  23 options to see the task executions:
  24
  25   - <b>Setting Categories</b>.
  26     @ref examples/deprecated/msg/trace-categories/trace-categories.c \n
  27     This example declares several tracing categories
  28     to that are used to classify its tasks. When the program is executed,
  29     the tracing mechanism registers the resource utilization of hosts
  30     and links according to these categories. Recommanded options:
  31     @verbatim --cfg=tracing:yes --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes
  32     @endverbatim
  33
  34   - <b>Master Workers tracing</b>.
  35     @ref examples/deprecated/msg/trace-masterworker/trace-masterworker.c \n
  36     This is an augmented version of our basic master/worker example
  37     using several tracing features. It traces resource usage, sorted
  38     out in several categories; Trace marks and user variables are also
  39     used. Recommanded options:
  40     @verbatim --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes
  41     @endverbatim
  42
  43   - <b>Process migration tracing</b>.
  44     @ref examples/deprecated/msg/trace-process-migration/trace-process-migration.c \n
  45     This version is enhanced so that the process migrations can be
  46     displayed as arrows in a Gantt-chart visualization. Recommanded
  47     options to that extend:
  48     @verbatim -cfg=tracing:yes --cfg=tracing/msg/process:yes
  49     @endverbatim
  50
  51 TODO: These tracing examples should be integrated in the examples to
  52 not duplicate the C files. A full command line to see the result in
  53 the right tool (vite/FrameSoc) should be given along with some
  54 screenshots.
  55
  56 @subsection msg_ex_tracing_user_variables Tracing user variables
  57
  58 You can also attach your own variables to a any resource described in
  59 the platform file. The following examples illustrate this feature.
  60 They have to be run with the following options:
  61 @verbatim --cfg=tracing:yes --cfg=tracing/platform:yes
  62 @endverbatim
  63
  64   - <b>Attaching variables to Hosts</b>.
  65     @ref examples/deprecated/msg/trace-host-user-variables/trace-host-user-variables.c
  66
  67   - <b>Attaching variables to Links</b>.
  68     @ref examples/deprecated/msg/trace-link-user-variables/trace-link-user-variables.c \n
  69     The tricky part is that you have to know the name of the link you
  70     want to enhance with a variable.
  71
  72   - <b>Attaching variables to network Routes</b>
  73     @ref examples/deprecated/msg/trace-route-user-variables/trace-route-user-variables.c \n
  74     It is often easier to update a given variable for all links of a
  75     given network path (identified by its source and destination
  76     hosts) instead of knowing the name of each specific link.
  77
  78 // As a human, you can stop reading at this point. The rest is garbage:
  79 //
  80 // Every example must be listed in the following, but it's not possible
  81 // to move this content upper as each @example directive seems to eat
  82 // everything until the next */ marker (and the content is placed at the
  83 // top of the example file).
  84
  85
  86 /**
  87
  88 @example examples/deprecated/msg/trace-categories/trace-categories.c
  89 @example examples/deprecated/msg/trace-masterworker/trace-masterworker.c
  90 @example examples/deprecated/msg/trace-process-migration/trace-process-migration.c
  91 @example examples/deprecated/msg/trace-host-user-variables/trace-host-user-variables.c
  92 @example examples/deprecated/msg/trace-link-user-variables/trace-link-user-variables.c
  93 @example examples/deprecated/msg/trace-route-user-variables/trace-route-user-variables.c
  94
  95 */
  96