@CMAKE_HOME_DIRECTORY@/examples/msg/process-migration/process-migration.c \
@CMAKE_HOME_DIRECTORY@/examples/msg/process-startkilltime/process-startkilltime.c \
@CMAKE_HOME_DIRECTORY@/examples/msg/trace-simple/trace-simple.c \
- @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/ms.c \
- @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/categories.c \
- @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/procmig.c \
- @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/trace_platform.c \
- @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/user_variables.c \
- @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/link_user_variables.c \
- @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/link_srcdst_user_variables.c \
+ @CMAKE_HOME_DIRECTORY@/examples/msg/trace-platform/trace-platform.c \
+ @CMAKE_HOME_DIRECTORY@/examples/msg/trace-categories/trace-categories.c \
+ @CMAKE_HOME_DIRECTORY@/examples/msg/trace-masterworker/trace-masterworker.c \
+ @CMAKE_HOME_DIRECTORY@/examples/msg/trace-process-migration/trace-process-migration.c \
+ @CMAKE_HOME_DIRECTORY@/examples/msg/trace-user-variables/trace-user-variables.c \
+ @CMAKE_HOME_DIRECTORY@/examples/msg/trace-link-user-variables/trace-link-user-variables.c \
+ @CMAKE_HOME_DIRECTORY@/examples/msg/trace-link-srcdst-user-variables/trace-link-srcdst-user-variables.c \
@CMAKE_HOME_DIRECTORY@/examples/msg/ns3 \
@CMAKE_HOME_DIRECTORY@/examples/msg/io \
@CMAKE_HOME_DIRECTORY@/examples/msg/gpu \
/** @addtogroup MSG_examples
*
- * - <b>tracing/categories.c</b> This is a master/worker program. The master creates tasks and send them to workers.
- * For each task received, the worker executes it and then destroys it. This program declares several tracing categories
+ * - <b>Setting Categories: trace-categories/trace-categories.c</b>. This example declares several tracing categories
* that are used to classify tasks. When the program is executed, the tracing mechanism registers the resource
* utilization of hosts and links according to these categories. You might want to run this program with the following
- * parameters:
- * --cfg=tracing:yes
- * --cfg=tracing/categorized:yes
- * --cfg=tracing/uncategorized:yes
- * --cfg=viva/categorized:viva_cat.plist
- * --cfg=viva/uncategorized:viva_uncat.plist
- * (See \ref tracing_tracing_options for details)
+ * options: <i>--cfg=tracing:yes</i>, <i>--cfg=tracing/categorized:yes</i>, <i>--cfg=tracing/uncategorized:yes</i>,
+ * <i>--cfg=viva/categorized:viva_cat.plist</i>, and <i>--cfg=viva/uncategorized:viva_uncat.plist</i>.
*/
#include "simgrid/msg.h"
/** @addtogroup MSG_examples
*
- * - <b>tracing/link_srcdst_user_variables.c</b>: This program demonstrates how to trace user variables associated to
- * the links of the platform file. Instead of providing the name of the link to update one of its variable, this
- * example shows how to provide two hosts as parameter (source and destination, use their names as defined in the
- * platform file). The tracing mechanism will get the route between these two hosts, if there is one defined in the
- * platform file, and update the variable of all the links of that route to the value provided.
- * You might want to run this program with the following parameters:
- * --cfg=tracing:yes
- * --cfg=tracing/platform:yes
- * (See \ref tracing_tracing_options for details)
+ * - <b>Routes: trace-link-srcdst-user-variables/trace-link-srcdst-user-variables.c</b>. Instead of providing the name
+ * of the link to update one of its variable, this example shows how to provide two hosts as parameter (source and
+ * destination, as defined in the platform file). The tracing mechanism will get the route between these two hosts, if
+ * it is defined in the platform file, and update the variable of all the links of that route to the value provided.
*/
//dump function to create and execute a task
/** @addtogroup MSG_examples
*
- * - <b>tracing/link_user_variables.c</b>: This program demonstrates how to trace user variables associated to the
- * links of the platform file. You need to provide the name of the link to update the value of the variable associated
- * to that link. You might want to run this program with the following parameters:
- * --cfg=tracing:yes
- * --cfg=tracing/platform:yes
- * (See \ref tracing_tracing_options for details)
+ * - <b>Links: trace-link-user-variables/trace-link-user-variables.c</b>. You need to provide the name of the link to
+ * update the value of the variable associated to that link.
*/
//dump function to create and execute a task
/** @addtogroup MSG_examples
*
- * - <b>tracing/ms.c</b> This is a master/worker program where the master creates tasks, send them to the workers. For
- * each task received, the worker executes it and then destroys it. This program uses several tracing functions that
- * enable the tracing of categorized resource utilization, the use of trace marks, and user variables associated to the
- * hosts of the platform file. You might want to run this program with the following parameters:
- * --cfg=tracing/categorized:yes
- * --cfg=tracing/uncategorized:yes
- * --cfg=viva/categorized:viva_cat.plist
- * --cfg=viva/uncategorized:viva_uncat.plist
- * (See \ref tracing_tracing_options for details)
+ * - <b>Master/Worker: trace-masterworker/trace-masterworker.c</b> This is an augmented version of our basic
+ * master/worker example. It uses several tracing functions that enable the tracing of categorized resource
+ * utilization, the use of trace marks, and user variables associated to the hosts of the platform file. You might
+ * want to run this program with the following configuration options:
+ * <i>--cfg=tracing/categorized:yes</i>, <i>--cfg=tracing/uncategorized:yes</i>,
+ * <i>--cfg=viva/categorized:viva_cat.plist</i>, and <i>--cfg=viva/uncategorized:viva_uncat.plist</i>.
*/
#include "simgrid/msg.h"
-XBT_LOG_NEW_DEFAULT_CATEGORY(msg_test, "Messages specific for this msg example");
+XBT_LOG_NEW_DEFAULT_CATEGORY(msg_trace_masterworker, "Messages specific for this msg example");
static int master(int argc, char *argv[])
{
> [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing/uncategorized' to 'yes'
> [0.000000] [xbt_cfg/INFO] Configuration change: Set 'viva/categorized' to 'trace-masterworker.cat.plist'
> [0.000000] [xbt_cfg/INFO] Configuration change: Set 'viva/uncategorized' to 'trace-masterworker.uncat.plist'
-> [4.214821] [msg_test/INFO] Declared tracing categories:
-> [4.214821] [msg_test/INFO] request
-> [4.214821] [msg_test/INFO] finalize
-> [4.214821] [msg_test/INFO] report
-> [4.214821] [msg_test/INFO] compute
-> [4.214821] [msg_test/INFO] Declared marks:
-> [4.214821] [msg_test/INFO] msmark
+> [4.214821] [msg_trace_masterworker/INFO] Declared tracing categories:
+> [4.214821] [msg_trace_masterworker/INFO] request
+> [4.214821] [msg_trace_masterworker/INFO] finalize
+> [4.214821] [msg_trace_masterworker/INFO] report
+> [4.214821] [msg_trace_masterworker/INFO] compute
+> [4.214821] [msg_trace_masterworker/INFO] Declared marks:
+> [4.214821] [msg_trace_masterworker/INFO] msmark
p Tracing master/worker application with xml config
$ $SG_TEST_EXENV ${bindir:=.}/trace-masterworker$EXEEXT ${srcdir:=.}/config_tracing.xml ${srcdir:=.}/../msg/app-masterworker/app-masterworker_d.xml
> [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing/filename' to 'trace-masterworker.trace'
> [0.000000] [xbt_cfg/INFO] Configuration change: Set 'viva/uncategorized' to 'trace-masterworker.uncat.plist'
> [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing/categorized' to 'yes'
-> [4.214821] [msg_test/INFO] Declared tracing categories:
-> [4.214821] [msg_test/INFO] request
-> [4.214821] [msg_test/INFO] finalize
-> [4.214821] [msg_test/INFO] report
-> [4.214821] [msg_test/INFO] compute
-> [4.214821] [msg_test/INFO] Declared marks:
-> [4.214821] [msg_test/INFO] msmark
+> [4.214821] [msg_trace_masterworker/INFO] Declared tracing categories:
+> [4.214821] [msg_trace_masterworker/INFO] request
+> [4.214821] [msg_trace_masterworker/INFO] finalize
+> [4.214821] [msg_trace_masterworker/INFO] report
+> [4.214821] [msg_trace_masterworker/INFO] compute
+> [4.214821] [msg_trace_masterworker/INFO] Declared marks:
+> [4.214821] [msg_trace_masterworker/INFO] msmark
p Not tracing master/worker application
$ $SG_TEST_EXENV ${bindir:=.}/trace-masterworker$EXEEXT ${srcdir:=.}/small_platform.xml ${srcdir:=.}/../msg/app-masterworker/app-masterworker_d.xml
> [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing/uncategorized' to 'yes'
> [0.000000] [xbt_cfg/INFO] Configuration change: Set 'viva/categorized' to 'trace-masterworker.cat.plist'
> [0.000000] [xbt_cfg/INFO] Configuration change: Set 'viva/uncategorized' to 'trace-masterworker.uncat.plist'
-> [4.214821] [msg_test/INFO] Declared tracing categories:
-> [4.214821] [msg_test/INFO] request
-> [4.214821] [msg_test/INFO] finalize
-> [4.214821] [msg_test/INFO] report
-> [4.214821] [msg_test/INFO] compute
-> [4.214821] [msg_test/INFO] Declared marks:
-> [4.214821] [msg_test/INFO] msmark
+> [4.214821] [msg_trace_masterworker/INFO] Declared tracing categories:
+> [4.214821] [msg_trace_masterworker/INFO] request
+> [4.214821] [msg_trace_masterworker/INFO] finalize
+> [4.214821] [msg_trace_masterworker/INFO] report
+> [4.214821] [msg_trace_masterworker/INFO] compute
+> [4.214821] [msg_trace_masterworker/INFO] Declared marks:
+> [4.214821] [msg_trace_masterworker/INFO] msmark
$ $SG_TEST_EXENV cat trace-masterworker.uncat.plist
> node = ("HOST","LINK");
/** @addtogroup MSG_examples
*
- * - <b>tracing/trace_platform.c</b>: This program demonstrates how a platform file is traced to a Paje trace file
- * format using the tracing mechanism of Simgrid. You might want to run this program with the following parameters:
- * --cfg=tracing:yes
- * --cfg=tracing/categorized:yes
- * (See \ref tracing_tracing_options for details)
+ * - <b>Tracing the platform: trace-platform/trace-platform.c</b>. This example just loads a platform file to
+ * demonstrate how it can be traced into the Paje trace file format. You might want to run this program with the
+ * following options: <i>--cfg=tracing:yes</i> and <i>--cfg=tracing/categorized:yes</i>.
*/
#include "simgrid/msg.h"
/** @addtogroup MSG_examples
*
- * - <b>tracing/procmig.c</b> This program shows a process migration. Tracing this program with the options below
- * enables a gantt-chart visualization of where the process has been during its execution. Migrations are represented by
- * arrows from the origin to the destination host. You might want to run this program with the following parameters:
- * --cfg=tracing:yes
- * --cfg=tracing/msg/process:yes
- * (See \ref tracing_tracing_options for details)
+ * - <b>Process migration: trace-process-migration/trace-process-migration.c</b>. Running this program with the
+ * <i>--cfg=tracing:yes</i> and <i>--cfg=tracing/msg/process:yes</i> options enables a Gantt-chart visualization of
+ * where the process has been hosted during its execution. Migrations are represented by arrows from the origin to
+ * the destination host.
*/
#include "simgrid/msg.h"
/** @addtogroup MSG_examples
*
- * @section MSG_ex_tracing Tracing and vizualisation features
- *
- * - <b>tracing/simple.c</b> very simple program where each process creates, executes and destroy a task. You might want
- * to run this program with the following parameters:
- * --cfg=tracing/uncategorized:yes
- * (See \ref tracing_tracing_options for details)
+ * @section MSG_ex_tracing Tracing and visualization features
+ * Tracing can be activated by various configuration options which are illustrated in these example.
+ * See \ref tracing_tracing_options for details.
+ * - <b>Basic example: trace-simple/trace-simple.c</b>. In this very simple program, each process creates, executes,
+ * and destroy a task. You might want to run it with the <i>--cfg=tracing/uncategorized:yes</i> option.
*/
static int simple_func(int argc, char *argv[])
* under the terms of the license (GNU LGPL) which comes with this package. */
/** @addtogroup MSG_examples
+ *
+ * @section MSG_ex_tracing_user_variables Tracing user variables
+ * The tracing mechanism of SimGrid also allows to associate user variables to resources described in the platform file.
+ * The following examples illustrate this feature. They have to be run with the <i>--cfg=tracing:yes</i> and
+ * <i>--cfg=tracing/platform:yes</i> options.
*
- * - <b>tracing/user_variables.c</b>: This program demonstrates how to trace user variables associated to the hosts of
- * the platform file. You might want to run this program with the following parameters:
- * --cfg=tracing:yes
- * --cfg=tracing/platform:yes
- * (See \ref tracing_tracing_options for details)
+ * - <b>Hosts: trace-user-variables/trace-user-variables.c</b>. This example shows how user defined variables can be
+ * associated to an host and how to manage the tracing of their evolution.
*/
#include <stdio.h>
#include "simgrid/msg.h"
