summaryrefslogtreecommitdiffstats
path: root/c-user/config/event-record.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-09 08:58:21 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-12 10:22:31 +0100
commita388de94168c1dc7544569e2f329a301d28182bf (patch)
tree58b4577f0ba1610cdb59c36c0c4904ac63f6339e /c-user/config/event-record.rst
parentc-user: Move "PCI Library Configuration" (diff)
downloadrtems-docs-a388de94168c1dc7544569e2f329a301d28182bf.tar.bz2
c-user: Move "Event Recording Configuration"
Update #3836.
Diffstat (limited to 'c-user/config/event-record.rst')
-rw-r--r--c-user/config/event-record.rst61
1 files changed, 61 insertions, 0 deletions
diff --git a/c-user/config/event-record.rst b/c-user/config/event-record.rst
new file mode 100644
index 0000000..6ac0db0
--- /dev/null
+++ b/c-user/config/event-record.rst
@@ -0,0 +1,61 @@
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+
+Event Recording Configuration
+=============================
+
+.. index:: CONFIGURE_RECORD_EXTENSIONS_ENABLED
+
+.. _CONFIGURE_RECORD_EXTENSIONS_ENABLED:
+
+CONFIGURE_RECORD_EXTENSIONS_ENABLED
+-----------------------------------
+
+CONSTANT:
+ ``CONFIGURE_RECORD_EXTENSIONS_ENABLED``
+
+DATA TYPE:
+ Boolean feature macro.
+
+RANGE:
+ Defined or undefined.
+
+DEFAULT VALUE:
+ This is not defined by default.
+
+DESCRIPTION:
+ If defined and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
+ <CONFIGURE_RECORD_PER_PROCESSOR_ITEMS>` is also defined properly, then the
+ record extensions are enabled.
+
+NOTES:
+ The record extensions capture thread create, start, restart, delete,
+ switch, begin, exitted and terminate events.
+
+.. index:: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
+
+.. _CONFIGURE_RECORD_PER_PROCESSOR_ITEMS:
+
+CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
+------------------------------------
+
+CONSTANT:
+ ``CONFIGURE_RECORD_PER_PROCESSOR_ITEMS``
+
+DATA TYPE:
+ Unsigned integer (``unsigned int``).
+
+RANGE:
+ A power of two greater than or equal to 16.
+
+DEFAULT VALUE:
+ This is not defined by default.
+
+DESCRIPTION:
+ If defined, then a record item buffer of the specified item count is
+ statically allocated for each configured processor
+ (:ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>`).
+
+NOTES:
+ None.