summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjhb <jhb@FreeBSD.org>2000-09-21 06:50:02 +0000
committerjhb <jhb@FreeBSD.org>2000-09-21 06:50:02 +0000
commit5b97c1ba6513d84b8e072c64d729a6c4acc490d4 (patch)
tree2de9edc6f5c93170c10a3105e7cd583aec5a9f6f
parent2e74df8cf9d7a838a52f79054094b3d8746ee86a (diff)
downloadFreeBSD-src-5b97c1ba6513d84b8e072c64d729a6c4acc490d4.zip
FreeBSD-src-5b97c1ba6513d84b8e072c64d729a6c4acc490d4.tar.gz
Add in documentation and examples of the KTR kernel config options.
Prompted by: phk's kernel include script
-rw-r--r--sys/conf/NOTES19
-rw-r--r--sys/i386/conf/NOTES19
2 files changed, 38 insertions, 0 deletions
diff --git a/sys/conf/NOTES b/sys/conf/NOTES
index 5c812dc..813845a 100644
--- a/sys/conf/NOTES
+++ b/sys/conf/NOTES
@@ -322,6 +322,25 @@ options GDB_REMOTE_CHAT
options KTRACE #kernel tracing
#
+# KTR is a kernel tracing mechanism imported from BSD/OS. Currently it
+# has no userland interface aside from a few sysctl's. It is enabled with
+# the KTR option. The KTR_EXTEND option causes trace events to be generated
+# as a string from snprintf rather than as a string and up to 5 argument
+# pointers. KTR_ENTRIES defines the number of entries in the circular trace
+# buffer. KTR_COMPILE defines the mask of events to compile into the kernel
+# as defined by the KTR_* constants in <sys/ktr.h>. KTR_MASK defines the
+# initial value of the ktr_mask variable which determines at runtime what
+# events to trace. KTR_CPUMASK determines which CPU's log events, with
+# bit X corresponding to cpu X.
+#
+options KTR
+options KTR_EXTEND
+options KTR_ENTRIES=1024
+options KTR_COMPILE=0x3fffff
+options KTR_MASK=0x201208
+options KTR_CPUMASK=0x3
+
+#
# The INVARIANTS option is used in a number of source files to enable
# extra sanity checking of internal structures. This support is not
# enabled by default because of the extra time it would take to check
diff --git a/sys/i386/conf/NOTES b/sys/i386/conf/NOTES
index 5c812dc..813845a 100644
--- a/sys/i386/conf/NOTES
+++ b/sys/i386/conf/NOTES
@@ -322,6 +322,25 @@ options GDB_REMOTE_CHAT
options KTRACE #kernel tracing
#
+# KTR is a kernel tracing mechanism imported from BSD/OS. Currently it
+# has no userland interface aside from a few sysctl's. It is enabled with
+# the KTR option. The KTR_EXTEND option causes trace events to be generated
+# as a string from snprintf rather than as a string and up to 5 argument
+# pointers. KTR_ENTRIES defines the number of entries in the circular trace
+# buffer. KTR_COMPILE defines the mask of events to compile into the kernel
+# as defined by the KTR_* constants in <sys/ktr.h>. KTR_MASK defines the
+# initial value of the ktr_mask variable which determines at runtime what
+# events to trace. KTR_CPUMASK determines which CPU's log events, with
+# bit X corresponding to cpu X.
+#
+options KTR
+options KTR_EXTEND
+options KTR_ENTRIES=1024
+options KTR_COMPILE=0x3fffff
+options KTR_MASK=0x201208
+options KTR_CPUMASK=0x3
+
+#
# The INVARIANTS option is used in a number of source files to enable
# extra sanity checking of internal structures. This support is not
# enabled by default because of the extra time it would take to check
OpenPOWER on IntegriCloud