From 7212601385a2db12e1ee3d0a06084cd383702c79 Mon Sep 17 00:00:00 2001 From: Arnaud Giersch Date: Tue, 8 Dec 2020 21:06:17 +0100 Subject: [PATCH] Rename runtime option 'tracing/msg/process' to 'tracing/actor'. --- ChangeLog | 4 +++- doc/doxygen/outcomes_vizu.doc | 9 ++++----- docs/source/Tutorial_Algorithms.rst | 4 ++-- .../trace-process-migration/trace-process-migration.tesh | 1 + .../s4u/trace-masterworkers/s4u-trace-masterworkers.tesh | 4 ++-- src/instr/instr_config.cpp | 3 ++- 6 files changed, 14 insertions(+), 11 deletions(-) diff --git a/ChangeLog b/ChangeLog index 304fb9329f..b48ceaf5a3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -33,7 +33,9 @@ General: - LTO behavior on GCC can be parameterized using LTO_EXTRA_FLAG in cmake. Setting it to "auto" will use all available cores, while setting it to n will use n cores to speedup link step (usage: cmake -DLTO_EXTRA_FLAG=4). - - Remove obsolete option --cfg=contexts/parallel-threshold. + - Remove obsolete runtime option 'contexts/parallel-threshold'. + - Runtime option 'tracing/msg/process' renamed to 'tracing/actor'. The old name + has been kept for compatibility. - Further improve the documentation. S4U: diff --git a/doc/doxygen/outcomes_vizu.doc b/doc/doxygen/outcomes_vizu.doc index b45b90f7d0..351a7b2e63 100644 --- a/doc/doxygen/outcomes_vizu.doc +++ b/doc/doxygen/outcomes_vizu.doc @@ -209,13 +209,12 @@ TODO @endverbatim @li @c -tracing/msg/process +tracing/actor : - This option only has effect if this simulator is MSG-based. It traces the - behavior of all categorized MSG processes, grouping them by hosts. This option - can be used to track process location if this simulator has process migration. + This option traces the behavior of all categorized actors, grouping them by hosts. This option + can be used to track actor location if this simulator has actor migration. @verbatim ---cfg=tracing/msg/process:yes +--cfg=tracing/actor:yes @endverbatim @li @c diff --git a/docs/source/Tutorial_Algorithms.rst b/docs/source/Tutorial_Algorithms.rst index 1f9b28d5a0..8233f3c53a 100644 --- a/docs/source/Tutorial_Algorithms.rst +++ b/docs/source/Tutorial_Algorithms.rst @@ -413,7 +413,7 @@ is a better way to visualize SimGrid traces (see below). .. code-block:: shell - ./master-workers small_platform.xml master-workers_d.xml --cfg=tracing:yes --cfg=tracing/msg/process:yes + ./master-workers small_platform.xml master-workers_d.xml --cfg=tracing:yes --cfg=tracing/actor:yes vite simgrid.trace .. image:: /tuto_s4u/img/vite-screenshot.png @@ -426,7 +426,7 @@ and use it as follows: .. code-block:: shell - ./master-workers small_platform.xml master-workers_d.xml --cfg=tracing:yes --cfg=tracing/msg/process:yes + ./master-workers small_platform.xml master-workers_d.xml --cfg=tracing:yes --cfg=tracing/actor:yes Rscript draw_gantt.R simgrid.trace It produces a ``Rplots.pdf`` with the following content: diff --git a/examples/deprecated/msg/trace-process-migration/trace-process-migration.tesh b/examples/deprecated/msg/trace-process-migration/trace-process-migration.tesh index 853cbc68c6..d935ce20f8 100644 --- a/examples/deprecated/msg/trace-process-migration/trace-process-migration.tesh +++ b/examples/deprecated/msg/trace-process-migration/trace-process-migration.tesh @@ -5,6 +5,7 @@ $ ${bindir:=.}/trace-process-migration --cfg=tracing:yes --cfg=tracing/filename: > [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing' to 'yes' > [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing/filename' to 'procmig.trace' > [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing/msg/process' to 'yes' +> [0.000000] [xbt_cfg/INFO] Option tracing/msg/process has been renamed to tracing/actor. Consider switching. $ tail -n +3 procmig.trace > %EventDef PajeDefineContainerType 0 diff --git a/examples/s4u/trace-masterworkers/s4u-trace-masterworkers.tesh b/examples/s4u/trace-masterworkers/s4u-trace-masterworkers.tesh index a1b7c5021e..f63ba23b90 100644 --- a/examples/s4u/trace-masterworkers/s4u-trace-masterworkers.tesh +++ b/examples/s4u/trace-masterworkers/s4u-trace-masterworkers.tesh @@ -31,9 +31,9 @@ p Not tracing master/worker application $ ${bindir:=.}/s4u-trace-masterworkers ${platfdir}/small_platform.xml ${srcdir:=.}/../app-masterworkers/s4u-app-masterworkers_d.xml p Testing tracing by process -$ ${bindir:=.}/s4u-trace-masterworkers --cfg=tracing:yes --cfg=tracing/msg/process:yes --cfg=tracing/filename:trace-masterworker.trace --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes ${platfdir}/small_platform.xml ${srcdir:=.}/../app-masterworkers/s4u-app-masterworkers_d.xml +$ ${bindir:=.}/s4u-trace-masterworkers --cfg=tracing:yes --cfg=tracing/actor:yes --cfg=tracing/filename:trace-masterworker.trace --cfg=tracing/categorized:yes --cfg=tracing/uncategorized:yes ${platfdir}/small_platform.xml ${srcdir:=.}/../app-masterworkers/s4u-app-masterworkers_d.xml > [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing' to 'yes' -> [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing/msg/process' to 'yes' +> [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing/actor' to 'yes' > [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing/filename' to 'trace-masterworker.trace' > [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing/categorized' to 'yes' > [0.000000] [xbt_cfg/INFO] Configuration change: Set 'tracing/uncategorized' to 'yes' diff --git a/src/instr/instr_config.cpp b/src/instr/instr_config.cpp index cf95509dcd..11dce17f90 100644 --- a/src/instr/instr_config.cpp +++ b/src/instr/instr_config.cpp @@ -37,7 +37,8 @@ static simgrid::config::Flag trace_enabled{ "tracing", "Enable the tracing system. You have to enable this option to use other tracing options.", false}; static simgrid::config::Flag trace_actor_enabled{ - "tracing/msg/process", // FIXME rename this flag + "tracing/actor", + {"tracing/msg/process"}, // XBT_ATTRIB_DEPRECATED_v330(option alias) "Trace the behavior of all categorized actors, grouping them by host. " "Can be used to track actor location if the simulator does actor migration.", false}; -- 2.20.1