Remove calibrate documentation
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Tue, 14 Jun 2016 23:17:06 +0000 (19:17 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Fri, 7 Oct 2016 16:16:06 +0000 (12:16 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
configure.ac
doc/Makefile.am
doc/calibrate.txt [deleted file]
doc/man/Makefile.am
doc/man/asciidoc-attrs.conf.in
doc/man/lttng-calibrate.1.txt [deleted file]
doc/man/lttng.1.txt

index ab72dbe5e4f1d2807b6b3ffcd846a453d4e59dbe..d03305a0b0b027df58d484163490ae2c8f5fcfe4 100644 (file)
@@ -271,7 +271,6 @@ _AC_DEFINE_QUOTED_AND_SUBST([DEFAULT_NETWORK_VIEWER_BIND_ADDRESS], [localhost])
 
 # Command short descriptions
 _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_ADD_CONTEXT], [Add context fields to a channel])
-_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_CALIBRATE], [Quantify LTTng overhead])
 _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_CREATE], [Create a tracing session])
 _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DESTROY], [Tear down tracing sessions])
 _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DISABLE_CHANNEL], [Disable tracing channels])
index 7ae930356b534eb9275d1056d7ebcaaf8673568a..045170937f409dab5c070ce4ef4bbc11b2a37b6b 100644 (file)
@@ -1,9 +1,9 @@
 SUBDIRS = man
 EXTRA_DIST = quickstart.txt streaming-howto.txt python-howto.txt \
-       snapshot-howto.txt calibrate.txt kernel-CodingStyle.txt \
+       snapshot-howto.txt kernel-CodingStyle.txt \
        live-reading-howto.txt live-reading-protocol.txt \
        relayd-architecture.txt
 
 dist_doc_DATA = quickstart.txt streaming-howto.txt python-howto.txt \
-       snapshot-howto.txt calibrate.txt live-reading-howto.txt \
+       snapshot-howto.txt live-reading-howto.txt \
        live-reading-protocol.txt valgrind-howto.txt
diff --git a/doc/calibrate.txt b/doc/calibrate.txt
deleted file mode 100644 (file)
index e37075f..0000000
+++ /dev/null
@@ -1,56 +0,0 @@
-LTTng calibrate command documentation
-Mathieu Desnoyers, August 6, 2011
-
-The LTTng calibrate command can be used to find out the combined average
-overhead of the LTTng tracer and the instrumentation mechanisms used.
-This overhead can be calibrated in terms of time or using any of the PMU
-performance counter available on the system.
-
-For now, the only calibration implemented is that of the kernel function
-instrumentation (kretprobes).
-
-
-* Calibrate kernel function instrumentation
-
-Let's use an example to show this calibration. We use an i7 processor
-with 4 general-purpose PMU registers. This information is available by
-issuing dmesg, looking for "generic registers".
-
-This sequence of commands will gather a trace executing a kretprobe
-hooked on an empty function, gathering PMU counters LLC (Last Level
-Cache) misses information (see lttng add-context --help to see the list
-of available PMU counters).
-
-(as root)
-lttng create calibrate-function
-lttng enable-event calibrate --kernel --function lttng_calibrate_kretprobe
-lttng add-context --kernel -t perf:LLC-load-misses -t perf:LLC-store-misses \
-               -t perf:LLC-prefetch-misses
-lttng start
-for a in $(seq 1 10); do \
-       lttng calibrate --kernel --function;
-done
-lttng destroy
-babeltrace $(ls -1drt ~/lttng-traces/calibrate-function-* | tail -n 1)
-
-The output from babeltrace can be saved to a text file and opened in a
-spreadsheet (e.g. oocalc) to focus on the per-PMU counter delta between
-consecutive "calibrate_entry" and "calibrate_return" events. Note that
-these counters are per-CPU, so scheduling events would need to be
-present to account for migration between CPU. Therefore, for calibration
-purposes, only events staying on the same CPU must be considered.
-
-The average result, for the i7, on 10 samples:
-
-                             Average     Std.Dev.
-perf_LLC_load_misses:          5.0       0.577
-perf_LLC_store_misses:         1.6       0.516
-perf_LLC_prefetch_misses:      9.0      14.742
-
-As we can notice, the load and store misses are relatively stable across
-runs (their standard deviation is relatively low) compared to the
-prefetch misses. We can conclude from this information that LLC load and
-store misses can be accounted for quite precisely, but prefetches within
-a function seems to behave too erratically (not much causality link
-between the code executed and the CPU prefetch activity) to be accounted
-for.
index 8c1472e875840e5d7a13f73cfba4c1a9b46cfbb9..9c7f125d00e08ff3a195186b275cddb370fab3c4 100644 (file)
@@ -21,7 +21,6 @@ MAN1_NAMES = \
        lttng-disable-channel \
        lttng-add-context \
        lttng-list \
-       lttng-calibrate \
        lttng-track \
        lttng-untrack \
        lttng-status \
index 83f59cd722d31547892116c412e4fc83f970e2ea..a3d0c3ac70e83617a7999a487d2cc27b1a0bccfa 100644 (file)
@@ -40,7 +40,6 @@ system_lttng_conf="@CONFDIR@/lttng/lttng.conf"
 
 # command short descriptions
 cmd_descr_add_context="@CMD_DESCR_ADD_CONTEXT@"
-cmd_descr_calibrate="@CMD_DESCR_CALIBRATE@"
 cmd_descr_create="@CMD_DESCR_CREATE@"
 cmd_descr_destroy="@CMD_DESCR_DESTROY@"
 cmd_descr_disable_channel="@CMD_DESCR_DISABLE_CHANNEL@"
diff --git a/doc/man/lttng-calibrate.1.txt b/doc/man/lttng-calibrate.1.txt
deleted file mode 100644 (file)
index 02195b8..0000000
+++ /dev/null
@@ -1,116 +0,0 @@
-lttng-calibrate(1)
-==================
-
-
-NAME
-----
-lttng-calibrate - Quantify LTTng overhead
-
-
-SYNOPSIS
---------
-[verse]
-*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *calibrate*
-
-
-DESCRIPTION
------------
-The `lttng calibrate` commands quantifies the overhead of LTTng tracers.
-
-The `lttng calibrate` command can be used to find out the combined
-average overhead of the LTTng tracers and the instrumentation mechanisms
-used. This overhead can be calibrated in terms of time or using any of
-the PMU performance counter available on the system.
-
-For now, the only implemented calibration is the Linux kernel function
-instrumentation (_kretprobes_).
-
-
-Calibrate Linux kernel function instrumentation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-As an example, we use an i7 processor with 4 general-purpose PMU
-registers. This information is available by issuing `dmesg`, looking
-for `generic registers`.
-
-The following sequence of commands gathers a trace executing a kretprobe
-hooked on an empty function, gathering PMU counters LLC
-(Last Level Cache) misses information (use `lttng add-context --list` to
-get the list of available PMU counters).
-
-[role="term"]
-------------------------------------------------------------------------
-lttng create calibrate-function
-lttng enable-event calibrate --kernel \
-                             --function=lttng_calibrate_kretprobe
-lttng add-context --kernel --type=perf:cpu:LLC-load-misses \
-                           --type=perf:cpu:LLC-store-misses \
-                           --type=perf:cpu:LLC-prefetch-misses
-lttng start
-
-for a in $(seq 1 10); do
-    lttng calibrate --kernel --function
-done
-
-lttng destroy
-babeltrace $(ls -1drt ~/lttng-traces/calibrate-function-* | tail -n 1)
-------------------------------------------------------------------------
-
-The output from man:babeltrace(1) can be saved to a text file and
-opened in a spreadsheet (for example, in LibreOffice) to focus on the
-per-PMU counter delta between consecutive `calibrate_entry` and
-`calibrate_return` events. Note that these counters are per-CPU, so
-scheduling events would need to be present to account for migration
-between CPUs. Therefore, for calibration purposes, only events staying
-on the same CPU must be considered.
-
-Here's an example of the average result, for the i7, on 10 samples:
-
-[width="40%",options="header"]
-|=============================================================
-| PMU counter                | Average   | Standard deviation
-| `perf_LLC_load_misses`     | 5.0       | 0.577
-| `perf_LLC_store_misses`    | 1.6       | 0.516
-| `perf_LLC_prefetch_misses` | 9.0       | 14.742
-|=============================================================
-
-As we can notice, the load and store misses are relatively stable across
-runs (their standard deviation is relatively low) compared to the
-prefetch misses. We could conclude from this information that LLC load
-and store misses can be accounted for quite precisely, but prefetches
-within a function seems to behave too erratically (not much causality
-link between the code executed and the CPU prefetch activity) to be
-accounted for.
-
-
-include::common-cmd-options-head.txt[]
-
-
-Domain
-~~~~~~
-One of:
-
-option:-k, option:--kernel::
-    Quantify LTTng overhead in the Linux kernel domain.
-
-option:-u, option:--userspace::
-    Quantify LTTng overhead in the user space domain.
-
-
-Calibration
-~~~~~~~~~~~
-option:--function::
-    Use dynamic function entry/return probes to calibrate (default).
-+
-This option requires the option:--kernel option.
-
-
-include::common-cmd-help-options.txt[]
-
-
-include::common-cmd-footer.txt[]
-
-
-SEE ALSO
---------
-man:lttng(1)
index 55359186f0b603ebd93fd208123150a71affff79..748ccf9a224ddc87a639b8e567202ea330f9ee3f 100644 (file)
@@ -219,9 +219,6 @@ man:lttng-untrack(1)::
 
 Miscellaneous
 ~~~~~~~~~~~~~
-man:lttng-calibrate(1)::
-    {cmd_descr_calibrate}.
-
 man:lttng-help(1)::
     {cmd_descr_help}.
 
This page took 0.046826 seconds and 4 git commands to generate.