summaryrefslogtreecommitdiff
path: root/Documentation/irqflags-tracing.txt
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2020-05-01 17:37:51 +0200
committerJonathan Corbet <corbet@lwn.net>2020-05-15 12:00:56 -0600
commite00b0ab86c79c4e82eb821ac6d6a3daef2e3e600 (patch)
treeb4ff4930b099762724de349e73b85fe1ff731691 /Documentation/irqflags-tracing.txt
parenta74e2a226452ea75d26b1f83860bff91a11da1ac (diff)
docs: add IRQ documentation at the core-api book
There are 4 IRQ documentation files under Documentation/*.txt. Move them into a new directory (core-api/irq) and add a new index file for it. While here, use a title markup for the Debugging section of the irq-domain.rst file. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/2da7485c3718e1442e6b4c2dd66857b776e8899b.1588345503.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/irqflags-tracing.txt')
-rw-r--r--Documentation/irqflags-tracing.txt52
1 files changed, 0 insertions, 52 deletions
diff --git a/Documentation/irqflags-tracing.txt b/Documentation/irqflags-tracing.txt
deleted file mode 100644
index bdd208259fb3..000000000000
--- a/Documentation/irqflags-tracing.txt
+++ /dev/null
@@ -1,52 +0,0 @@
-=======================
-IRQ-flags state tracing
-=======================
-
-:Author: started by Ingo Molnar <mingo@redhat.com>
-
-The "irq-flags tracing" feature "traces" hardirq and softirq state, in
-that it gives interested subsystems an opportunity to be notified of
-every hardirqs-off/hardirqs-on, softirqs-off/softirqs-on event that
-happens in the kernel.
-
-CONFIG_TRACE_IRQFLAGS_SUPPORT is needed for CONFIG_PROVE_SPIN_LOCKING
-and CONFIG_PROVE_RW_LOCKING to be offered by the generic lock debugging
-code. Otherwise only CONFIG_PROVE_MUTEX_LOCKING and
-CONFIG_PROVE_RWSEM_LOCKING will be offered on an architecture - these
-are locking APIs that are not used in IRQ context. (the one exception
-for rwsems is worked around)
-
-Architecture support for this is certainly not in the "trivial"
-category, because lots of lowlevel assembly code deal with irq-flags
-state changes. But an architecture can be irq-flags-tracing enabled in a
-rather straightforward and risk-free manner.
-
-Architectures that want to support this need to do a couple of
-code-organizational changes first:
-
-- add and enable TRACE_IRQFLAGS_SUPPORT in their arch level Kconfig file
-
-and then a couple of functional changes are needed as well to implement
-irq-flags-tracing support:
-
-- in lowlevel entry code add (build-conditional) calls to the
- trace_hardirqs_off()/trace_hardirqs_on() functions. The lock validator
- closely guards whether the 'real' irq-flags matches the 'virtual'
- irq-flags state, and complains loudly (and turns itself off) if the
- two do not match. Usually most of the time for arch support for
- irq-flags-tracing is spent in this state: look at the lockdep
- complaint, try to figure out the assembly code we did not cover yet,
- fix and repeat. Once the system has booted up and works without a
- lockdep complaint in the irq-flags-tracing functions arch support is
- complete.
-- if the architecture has non-maskable interrupts then those need to be
- excluded from the irq-tracing [and lock validation] mechanism via
- lockdep_off()/lockdep_on().
-
-In general there is no risk from having an incomplete irq-flags-tracing
-implementation in an architecture: lockdep will detect that and will
-turn itself off. I.e. the lock validator will still be reliable. There
-should be no crashes due to irq-tracing bugs. (except if the assembly
-changes break other code by modifying conditions or registers that
-shouldn't be)
-