From: Yuyang Du <duyuyang@gmail.com>
To: peterz@infradead.org, will.deacon@arm.com, mingo@kernel.org
Cc: bvanassche@acm.org, ming.lei@redhat.com,
linux-kernel@vger.kernel.org, joe@perches.com,
Yuyang Du <duyuyang@gmail.com>
Subject: [PATCH v3 02/18] locking/lockdep: Add description and explanation in lockdep design doc
Date: Thu, 21 Mar 2019 15:57:09 +0800 [thread overview]
Message-ID: <20190321075725.14054-3-duyuyang@gmail.com> (raw)
In-Reply-To: <20190321075725.14054-1-duyuyang@gmail.com>
More words are added to lockdep design document regarding key concepts,
which helps people understand the design as well as read the reports.
Signed-off-by: Yuyang Du <duyuyang@gmail.com>
---
Documentation/locking/lockdep-design.txt | 80 ++++++++++++++++++++++++--------
1 file changed, 60 insertions(+), 20 deletions(-)
diff --git a/Documentation/locking/lockdep-design.txt b/Documentation/locking/lockdep-design.txt
index 49f58a0..1dcceaa 100644
--- a/Documentation/locking/lockdep-design.txt
+++ b/Documentation/locking/lockdep-design.txt
@@ -15,51 +15,91 @@ tens of thousands of) instantiations. For example a lock in the inode
struct is one class, while each inode has its own instantiation of that
lock class.
-The validator tracks the 'state' of lock-classes, and it tracks
-dependencies between different lock-classes. The validator maintains a
-rolling proof that the state and the dependencies are correct.
-
-Unlike an lock instantiation, the lock-class itself never goes away: when
-a lock-class is used for the first time after bootup it gets registered,
-and all subsequent uses of that lock-class will be attached to this
-lock-class.
+The validator tracks the 'usage state' of lock-classes, and it tracks the
+dependencies between different lock-classes. The dependency can be
+understood as lock order, where L1 -> L2 suggests L1 depends on L2, which
+can also be expressed as a forward dependency (L1 -> L2) or a backward
+dependency (L2 <- L1). From lockdep's perspective, the two locks (L1 and L2)
+are not necessarily related as opposed to in some modules an order must be
+followed. Here it just means that order ever happened. The validator
+maintains a continuing effort to prove that the lock usages and their
+dependencies are correct or the validator will shoot a splat if they are
+potentially incorrect.
+
+Unlike a lock instance, a lock-class itself never goes away: when a
+lock-class's instance is used for the first time after bootup the class gets
+registered, and all (subsequent) instances of that lock-class will be mapped
+to the lock-class.
State
-----
-The validator tracks lock-class usage history into 4 * nSTATEs + 1 separate
-state bits:
+The validator tracks lock-class usage history and divides the usage into
+(4 usages * n STATEs + 1) categories:
+Where the 4 usages can be:
- 'ever held in STATE context'
- 'ever held as readlock in STATE context'
- 'ever held with STATE enabled'
- 'ever held as readlock with STATE enabled'
-Where STATE can be either one of (kernel/locking/lockdep_states.h)
- - hardirq
- - softirq
+Where the n STATEs are coded in kernel/locking/lockdep_states.h and as of
+now they include:
+- hardirq
+- softirq
+Where the last 1 category is:
- 'ever used' [ == !unused ]
-When locking rules are violated, these state bits are presented in the
-locking error messages, inside curlies. A contrived example:
+When locking rules are violated, these usage bits are presented in the
+locking error messages, inside curlies, with a total of 2 * n STATEs bits.
+See a contrived example:
modprobe/2287 is trying to acquire lock:
- (&sio_locks[i].lock){-.-...}, at: [<c02867fd>] mutex_lock+0x21/0x24
+ (&sio_locks[i].lock){-.-.}, at: [<c02867fd>] mutex_lock+0x21/0x24
but task is already holding lock:
- (&sio_locks[i].lock){-.-...}, at: [<c02867fd>] mutex_lock+0x21/0x24
+ (&sio_locks[i].lock){-.-.}, at: [<c02867fd>] mutex_lock+0x21/0x24
-The bit position indicates STATE, STATE-read, for each of the states listed
-above, and the character displayed in each indicates:
+For a given lock, the bit positions from left to right indicate the usage
+of the lock and readlock (if exists), for each of the n STATEs listed
+above respectively, and the character displayed at each bit position
+indicates:
'.' acquired while irqs disabled and not in irq context
'-' acquired in irq context
'+' acquired with irqs enabled
'?' acquired in irq context with irqs enabled.
-Unused mutexes cannot be part of the cause of an error.
+The bits are illustrated with an example:
+
+ (&sio_locks[i].lock){-.-.}, at: [<c02867fd>] mutex_lock+0x21/0x24
+ ||||
+ ||| \-> softirq disabled and not in softirq context
+ || \--> acquired in softirq context
+ | \---> hardirq disabled and not in hardirq context
+ \----> acquired in hardirq context
+
+
+For a given STATE, whether the lock is ever acquired in that STATE context
+and whether that STATE is enabled yields four possible cases as shown in the
+table below. It is worth noting that the bit character is able to indicate
+which exact case is for the lock as of the reporting time.
+
+ -------------------------------------------
+ | | irq enabled | irq disabled |
+ -------------------------------------------
+ | ever in irq | ? | - |
+ -------------------------------------------
+ | never in irq | + | . |
+ -------------------------------------------
+
+The character '-' suggests irq is disabled because if otherwise, the
+charactor '?' would have been shown instead. Similar deduction can be
+applied for '+' too.
+
+Unused locks (e.g., mutexes) cannot be part of the cause of an error.
Single-lock state rules:
--
1.8.3.1
next prev parent reply other threads:[~2019-03-21 7:57 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-21 7:57 [PATCH v3 00/18] locking/lockdep: Add comments and make some code Yuyang Du
2019-03-21 7:57 ` [PATCH v3 01/18] locking/lockdep: Change all print_*() return type to void Yuyang Du
2019-03-21 7:57 ` Yuyang Du [this message]
2019-03-21 7:57 ` [PATCH v3 03/18] locking/lockdep: Adjust lock usage bit character checks Yuyang Du
2019-03-21 7:57 ` [PATCH v3 04/18] locking/lockdep: Remove useless conditional macro Yuyang Du
2019-03-21 7:57 ` [PATCH v3 05/18] locking/lockdep: Print the right depth for chain key colission Yuyang Du
2019-03-21 7:57 ` [PATCH v3 06/18] locking/lockdep: Update obsolete struct field description Yuyang Du
2019-03-21 7:57 ` [PATCH v3 07/18] locking/lockdep: Use lockdep_init_task for task initiation consistently Yuyang Du
2019-03-21 7:57 ` [PATCH v3 08/18] locking/lockdep: Define INITIAL_CHAIN_KEY for chain keys to start with Yuyang Du
2019-03-21 7:57 ` [PATCH v3 09/18] locking/lockdep: Change the range of class_idx in held_lock struct Yuyang Du
2019-03-21 7:57 ` [PATCH v3 10/18] locking/lockdep: Remove unused argument in validate_chain() and check_deadlock() Yuyang Du
2019-03-21 7:57 ` [PATCH v3 11/18] locking/lockdep: Update comment Yuyang Du
2019-03-21 7:57 ` [PATCH v3 12/18] locking/lockdep: Remove unnecessary function pointer argument Yuyang Du
2019-03-21 7:57 ` [PATCH v3 13/18] locking/lockdep: Change type of the element field in circular_queue Yuyang Du
2019-03-21 7:57 ` [PATCH v3 14/18] locking/lockdep: Change the return type of __cq_dequeue() Yuyang Du
2019-03-21 7:57 ` [PATCH v3 15/18] locking/lockdep: Avoid constant checks in __bfs by using offset reference Yuyang Du
2019-03-21 7:57 ` [PATCH v3 16/18] locking/lockdep: Combine check_noncircular and check_redundant Yuyang Du
2019-03-21 7:57 ` [PATCH v3 17/18] locking/lockdep: Update comments on dependency search Yuyang Du
2019-03-21 7:57 ` [PATCH v3 18/18] locking/lockdep: Add explanation to lock usage rules in lockdep design doc Yuyang Du
2019-04-04 5:03 ` Question on a lockdep test case about mixed read-write ABBA Yuyang Du
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190321075725.14054-3-duyuyang@gmail.com \
--to=duyuyang@gmail.com \
--cc=bvanassche@acm.org \
--cc=joe@perches.com \
--cc=linux-kernel@vger.kernel.org \
--cc=ming.lei@redhat.com \
--cc=mingo@kernel.org \
--cc=peterz@infradead.org \
--cc=will.deacon@arm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).