|
|
@@ -155,7 +155,8 @@ subdirectories:
|
|
|
Holds query files generated by a CMake project with the
|
|
|
:command:`cmake_instrumentation` command or the
|
|
|
:envvar:`CTEST_USE_INSTRUMENTATION` variable. These files are owned by CMake
|
|
|
- and are deleted and regenerated automatically during the CMake configure step.
|
|
|
+ and are deleted and regenerated automatically during the CMake configure
|
|
|
+ step.
|
|
|
|
|
|
``data/``
|
|
|
Holds instrumentation data collected on the project. CMake owns all data
|
|
|
@@ -288,15 +289,16 @@ invocation, an index file ``index-<timestamp>.json`` will be generated in
|
|
|
``<build>/.cmake/instrumentation/v1/data/index`` containing a list of data
|
|
|
snippet files created since the previous indexing. The commands
|
|
|
``/usr/bin/python callback.py index-<timestamp>.json`` and
|
|
|
-``/usr/bin/cmake -P callback.cmake arg index-<timestamp>.json`` will be executed
|
|
|
-in that order. The index file will contain the ``staticSystemInformation`` data
|
|
|
-and each snippet file listed in the index will contain the
|
|
|
-``dynamicSystemInformation`` data. Additionally, the index file will contain
|
|
|
-the path to the generated `Google Trace File`_. Once both callbacks have completed,
|
|
|
-the index file and data files listed by it (including snippet files, but not
|
|
|
-the trace file) will be deleted from the project build tree. The instrumentation
|
|
|
-data will be present in the XML files submitted to CDash, but with truncated
|
|
|
-command strings because ``cdashVerbose`` was not enabled.
|
|
|
+``/usr/bin/cmake -P callback.cmake arg index-<timestamp>.json`` will be
|
|
|
+executed in that order. The index file will contain the
|
|
|
+``staticSystemInformation`` data and each snippet file listed in the index will
|
|
|
+contain the ``dynamicSystemInformation`` data. Additionally, the index file
|
|
|
+will contain the path to the generated `Google Trace File`_. Once both
|
|
|
+callbacks have completed, the index file and data files listed by it (including
|
|
|
+snippet files, but not the trace file) will be deleted from the project build
|
|
|
+tree. The instrumentation data will be present in the XML files submitted to
|
|
|
+CDash, but with truncated command strings because ``cdashVerbose`` was not
|
|
|
+enabled.
|
|
|
|
|
|
.. _`cmake-instrumentation Data v1`:
|
|
|
|
|
|
@@ -318,8 +320,9 @@ v1 Snippet File
|
|
|
---------------
|
|
|
|
|
|
Snippet files are generated for every compile, link and custom command invoked
|
|
|
-as part of the CMake build or install step and contain instrumentation data about
|
|
|
-the command executed. Additionally, snippet files are created for the following:
|
|
|
+as part of the CMake build or install step and contain instrumentation data
|
|
|
+about the command executed. Additionally, snippet files are created for the
|
|
|
+following:
|
|
|
|
|
|
* The CMake configure step
|
|
|
* The CMake generate step
|
|
|
@@ -331,8 +334,8 @@ the command executed. Additionally, snippet files are created for the following:
|
|
|
These files remain in the build tree until after `Indexing`_ occurs and any
|
|
|
user-specified `Callbacks`_ are executed.
|
|
|
|
|
|
-Snippet files have a filename with the syntax ``<role>-<hash>-<timestamp>.json``
|
|
|
-and contain the following data:
|
|
|
+Snippet files have a filename with the syntax
|
|
|
+``<role>-<hash>-<timestamp>.json`` and contain the following data:
|
|
|
|
|
|
``version``
|
|
|
The Data version of the snippet file, an integer. Currently the version is
|
|
|
@@ -365,8 +368,8 @@ and contain the following data:
|
|
|
* ``test``: a single test executed by CTest
|
|
|
|
|
|
``target``
|
|
|
- The CMake target associated with the command. Only included when ``role`` is
|
|
|
- ``compile`` or ``link``. In conjunction with ``cmakeContent``, this can
|
|
|
+ The CMake target associated with the command. Only included when ``role``
|
|
|
+ is ``compile`` or ``link``. In conjunction with ``cmakeContent``, this can
|
|
|
be used to look up the target type and labels.
|
|
|
|
|
|
``timeStart``
|
|
|
@@ -389,11 +392,12 @@ and contain the following data:
|
|
|
The source file being compiled. Only included when ``role`` is ``compile``.
|
|
|
|
|
|
``language``
|
|
|
- The language of the source file being compiled. Only included when ``role`` is
|
|
|
- ``compile`` or ``link``.
|
|
|
+ The language of the source file being compiled. Only included when ``role``
|
|
|
+ is ``compile`` or ``link``.
|
|
|
|
|
|
``testName``
|
|
|
- The name of the test being executed. Only included when ``role`` is ``test``.
|
|
|
+ The name of the test being executed. Only included when ``role`` is
|
|
|
+ ``test``.
|
|
|
|
|
|
``config``
|
|
|
The type of build, such as ``Release`` or ``Debug``. Only included when
|
|
|
@@ -417,8 +421,8 @@ and contain the following data:
|
|
|
determined.
|
|
|
|
|
|
``afterCPULoadAverage``
|
|
|
- The Average CPU Load at ``timeStart + duration``, or ``null`` if it cannot
|
|
|
- be determined.
|
|
|
+ The Average CPU Load at ``timeStart + duration``, or ``null`` if it
|
|
|
+ cannot be determined.
|
|
|
|
|
|
``cmakeContent``
|
|
|
The path to a `v1 CMake Content File`_ located under ``data``, which
|
|
|
@@ -476,8 +480,8 @@ generated whenever `Indexing`_ occurs and deleted after any user-specified
|
|
|
|
|
|
``hook``
|
|
|
The name of the hook responsible for generating the index file. In addition
|
|
|
- to the hooks that can be specified by one of the `v1 Query Files`_, this value may
|
|
|
- be set to ``manual`` if indexing is performed by invoking
|
|
|
+ to the hooks that can be specified by one of the `v1 Query Files`_, this
|
|
|
+ value may be set to ``manual`` if indexing is performed by invoking
|
|
|
``ctest --collect-instrumentation <build>``.
|
|
|
|
|
|
``snippets``
|
|
|
@@ -553,8 +557,8 @@ Each CMake content file contains the following:
|
|
|
:command:`cmake_instrumentation` command.
|
|
|
|
|
|
``targets``
|
|
|
- An object containing CMake targets, indexed by name, that have corresponding
|
|
|
- instrumentation data. Each target contains the following:
|
|
|
+ An object containing CMake targets, indexed by name, that have
|
|
|
+ corresponding instrumentation data. Each target contains the following:
|
|
|
|
|
|
``type``
|
|
|
The target type. One of ``EXECUTABLE``, ``STATIC_LIBRARY``,
|
|
|
@@ -582,7 +586,7 @@ event contains the following data:
|
|
|
The ``role`` from the `v1 Snippet File`_.
|
|
|
|
|
|
``ph``
|
|
|
- Currently, always ``"X"`` to represent ``Complete Events``.
|
|
|
+ Currently, always ``"X"`` to represent "Complete Events".
|
|
|
|
|
|
``ts``
|
|
|
The ``timeStart`` from the `v1 Snippet File`_, converted from milliseconds to
|
|
|
@@ -602,6 +606,7 @@ event contains the following data:
|
|
|
order to produce a more useful visualization of the process concurrency.
|
|
|
|
|
|
``args``
|
|
|
- Contains all data from the `v1 Snippet File`_ corresponding to this trace event.
|
|
|
+ Contains all data from the `v1 Snippet File`_ corresponding to this trace
|
|
|
+ event.
|
|
|
|
|
|
.. _`Google Trace Event Format`: https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview
|