DEPT(DEPendency Tracker)
Subsystems (34)
v17 cover DEPT(DEPendency Tracker)
Found out a recent deadlock issue can be reported by dept. The issue is:
https://lore.kernel.org/all/[email protected]/
I'm happy to see that dept reported real problems in practice. See:
https://lore.kernel.org/lkml/[email protected]/
https://lore.kernel.org/lkml/[email protected]/
https://lore.kernel.org/all/[email protected]/
I added documents describing dept, that would help you understand what dept is and how dept works. You can use dept just with CONFIG_DEPT on and checking dmesg at runtime.
There are still false positives and some of them are already in progress to suppress and the efforts need to be kept for a while as lockdep experienced. Especially, since dept tracks PG_locked but folios have never been split in class - which needs help from maybe fs guys tho.. - we should put up with the AA report of PG_locked for a while, for instance, any nested folio_lock()s will give the dept splat for now :(
It's worth noting that *EXPERIMENTAL* in Kconfig is tagged, which means dept is not proper for an automation tool yet.
Thanks for the support and contribution, to:
Harry Yoo <[email protected]>
Gwan-gyeong Mun <[email protected]>
Yunseong Kim <[email protected]>
Yeoreum Yun <[email protected]>
---
Hi Linus and folks,
I've been developing a tool for detecting deadlock possibilities by tracking wait/event rather than lock acquisition order to try to cover all synchonization machanisms.
Benefits:
0. Works with all lock primitives.
1. Works with wait_for_completion()/complete().
2. Works with PG_locked.
3. Works with swait/wakeup.
4. Works with waitqueue.
5. Works with wait_bit.
6. Multiple reports are allowed.
7. Deduplication control on multiple reports.
8. Withstand false positives thanks to 7.
9. Easy to annotate on waits/events.
Future works after getting merged:
0. To separates dept from lockdep.
1. To use dept as a dependency engine for lockdep.
2. To add missing annotations on waits/events.
How to interpret reports:
(See the document in this patchset for more detail.)
[S] the start of the event context
[W] the wait disturbing the event from being triggered
[E] the event that cannot be reachable
Thanks.
Byungchul
---
Changes from v16:
1. Rebase on v6.17.
2. Fix a false positive from rcu (by Yunseong Kim)
3. Introduce APIs to set page's usage, dept_set_page_usage() and dept_reset_page_usage() to avoid false positives.
4. Consider lock_page() as a potential wait unconditionally.
5. Consider folio_lock_killable() as a potential wait unconditionally.
6. Add support for tracking PG_writeback waits and events.
7. Fix two build errors due to the additional debug information added by dept. (by Yunseong Kim)
Changes from v15:
1. Fix typo and improve comments and commit messages (feedbacked by ALOK TIWARI, Waiman Long, and kernel test robot).
2. Do not stop dept on detection of cicular dependency of recover event, allowing to keep reporting.
3. Add SK hynix to copyright.
4. Consider folio_lock() as a potential wait unconditionally.
5. Fix Kconfig dependency bug (feedbacked by kernel test rebot).
6. Do not suppress reports that involve classes even that have already involved in other reports, allowing to keep reporting.
Changes from v14:
1. Rebase on the current latest, v6.15-rc6.
2. Refactor dept code.
3. With multi event sites for a single wait, even if an event forms a circular dependency, the event can be recovered by other event(or wake up) paths. Even though informing the circular dependency is worthy but it should be suppressed once informing it, if it doesn't lead an actual deadlock. So introduce APIs to annotate the relationship between event site and recover site, that are, event_site() and dept_recover_event().
4. wait_for_completion() worked with dept map embedded in struct completion. However, it generates a few false positves since all the waits using the instance of struct completion, share the map and key. To avoid the false positves, make it not to share the map and key but each wait_for_completion() caller have its own key by default. Of course, external maps also can be used if needed.
5. Fix a bug about hardirq on/off tracing.
6. Implement basic unit test for dept.
7. Add more supports for dma fence synchronization.
8. Add emergency stop of dept e.g. on panic().
9. Fix false positives by mmu_notifier_invalidate_*().
10. Fix recursive call bug by DEPT_WARN_*() and DEPT_STOP().
11. Fix trivial bugs in DEPT_WARN_*() and DEPT_STOP().
12. Fix a bug that a spin lock, dept_pool_spin, is used in both contexts of irq disabled and enabled without irq disabled.
13. Suppress reports with classes, any of that already have been reported, even though they have different chains but being barely meaningful.
14. Print stacktrace of the wait that an event is now waking up, not only stacktrace of the event.
15. Make dept aware of lockdep_cmp_fn() that is used to avoid false positives in lockdep so that dept can also avoid them.
16. Do do_event() only if there are no ecxts have been delimited.
17. Fix a bug that was not synchronized for stage_m in struct dept_task, using a spin lock, dept_task()->stage_lock.
18. Fix a bug that dept didn't handle the case that multiple ttwus for a single waiter can be called at the same time e.i. a race issue.
19. Distinguish each kernel context from others, not only by system call but also by user oriented fault so that dept can work with more accuracy information about kernel context. That helps to avoid a few false positives.
20. Limit dept's working to x86_64 and arm64.
Changes from v13:
1. Rebase on the current latest version, v6.9-rc7.
2. Add 'dept' documentation describing dept APIs.
Changes from v12:
1. Refine the whole document for dept.
2. Add 'Interpret dept report' section in the document, using a deadlock report obtained in practice. Hope this version of document helps guys understand dept better.
https://lore.kernel.org/lkml/[email protected]/#t
https://lore.kernel.org/lkml/[email protected]/
Changes from v11:
1. Add 'dept' documentation describing the concept of dept.
2. Rewrite the commit messages of the following commits for using weaker lockdep annotation, for better description.
fs/jbd2: Use a weaker annotation in journal handling cpu/hotplug: Use a weaker annotation in AP thread
(feedbacked by Thomas Gleixner)
Changes from v10:
1. Fix noinstr warning when building kernel source.
2. dept has been reporting some false positives due to the folio lock's unfairness. Reflect it and make dept work based on dept annotaions instead of just wait and wake up primitives.
3. Remove the support for PG_writeback while working on 2. I will add the support later if needed.
4. dept didn't print stacktrace for [S] if the participant of a deadlock is not lock mechanism but general wait and event. However, it made hard to interpret the report in that case. So add support to print stacktrace of the requestor who asked the event context to run - usually a waiter of the event does it just before going to wait state.
5. Give up tracking raw_local_irq_{disable,enable}() since it totally messed up dept's irq tracking. So make it work in the same way as lockdep does. I will consider it once any false positives by those are observed again.
6. Change the manual rwsem_acquire_read(->j_trans_commit_map) annotation in fs/jbd2/transaction.c to the try version so that it works as much as it exactly needs.
7. Remove unnecessary 'inline' keyword in dept.c and add '__maybe_unused' to a needed place.
Changes from v9:
1. Fix a bug. SDT tracking didn't work well because of my big mistake that I should've used waiter's map to indentify its class but it had been working with waker's one. FYI, PG_locked and PG_writeback weren't affected. They still worked well. (reported by YoungJun)
Changes from v8:
1. Fix build error by adding EXPORT_SYMBOL(PG_locked_map) and EXPORT_SYMBOL(PG_writeback_map) for kernel module build - appologize for that. (reported by kernel test robot)
2. Fix build error by removing header file's circular dependency that was caused by "atomic.h", "kernel.h" and "irqflags.h", which I introduced - appolgize for that. (reported by kernel test robot)
Changes from v7:
1. Fix a bug that cannot track rwlock dependency properly, introduced in v7. (reported by Boqun and lockdep selftest)
2. Track wait/event of PG_{locked,writeback} more aggressively assuming that when a bit of PG_{locked,writeback} is cleared there might be waits on the bit. (reported by Linus, Hillf and syzbot)
3. Fix and clean bad style code e.i. unnecessarily introduced a randome pattern and so on. (pointed out by Linux)
4. Clean code for applying dept to wait_for_completion().
Changes from v6:
1. Tie to task scheduler code to track sleep and try_to_wake_up() assuming sleeps cause waits, try_to_wake_up()s would be the events that those are waiting for, of course with proper dept annotations, sdt_might_sleep_weak(), sdt_might_sleep_strong() and so on. For these cases, class is classified at sleep entrance rather than the synchronization initialization code. Which would extremely reduce false alarms.
2. Remove the dept associated instance in each page struct for tracking dependencies by PG_locked and PG_writeback thanks to the 1. work above.
3. Introduce CONFIG_dept_AGGRESIVE_TIMEOUT_WAIT to suppress reports that waits with timeout set are involved, for those who don't like verbose reporting.
4. Add a mechanism to refill the internal memory pools on running out so that dept could keep working as long as free memory is available in the system.
5. Re-enable tracking hashed-waitqueue wait. That's going to no longer generate false positives because class is classified at sleep entrance rather than the waitqueue initailization.
6. Refactor to make it easier to port onto each new version of the kernel.
7. Apply dept to dma fence.
8. Do trivial optimizaitions.
Changes from v5:
1. Use just pr_warn_once() rather than WARN_ONCE() on the lack of internal resources because WARN_*() printing stacktrace is too much for informing the lack. (feedback from Ted, Hyeonggon)
2. Fix trivial bugs like missing initializing a struct before using it.
3. Assign a different class per task when handling onstack variables for waitqueue or the like. Which makes dept distinguish between onstack variables of different tasks so as to prevent false positives. (reported by Hyeonggon)
4. Make dept aware of even raw_local_irq_*() to prevent false positives. (reported by Hyeonggon)
5. Don't consider dependencies between the events that might be triggered within __schedule() and the waits that requires __schedule(), real ones. (reported by Hyeonggon)
6. Unstage the staged wait that has prepare_to_wait_event()'ed *and* yet to get to __schedule(), if we encounter __schedule() in-between for another sleep, which is possible if e.g. a mutex_lock() exists in 'condition' of ___wait_event().
7. Turn on CONFIG_PROVE_LOCKING when CONFIG_DEPT is on, to rely on the hardirq and softirq entrance tracing to make dept more portable for now.
Changes from v4:
1. Fix some bugs that produce false alarms.
2. Distinguish each syscall context from another *for arm64*.
3. Make it not warn it but just print it in case dept ring buffer gets exhausted. (feedback from Hyeonggon)
4. Explicitely describe "EXPERIMENTAL" and "dept might produce false positive reports" in Kconfig. (feedback from Ted)
Changes from v3:
1. dept shouldn't create dependencies between different depths of a class that were indicated by *_lock_nested(). dept normally doesn't but it does once another lock class comes in. So fixed it. (feedback from Hyeonggon)
2. dept considered a wait as a real wait once getting to __schedule() even if it has been set to TASK_RUNNING by wake up sources in advance. Fixed it so that dept doesn't consider the case as a real wait. (feedback from Jan Kara)
3. Stop tracking dependencies with a map once the event associated with the map has been handled. dept will start to work with the map again, on the next sleep.
Changes from v2:
1. Disable dept on bit_wait_table[] in sched/wait_bit.c reporting a lot of false positives, which is my fault. Wait/event for bit_wait_table[] should've been tagged in a higher layer for better work, which is a future work. (feedback from Jan Kara)
2. Disable dept on crypto_larval's completion to prevent a false positive.
Changes from v1:
1. Fix coding style and typo. (feedback from Steven)
2. Distinguish each work context from another in workqueue.
3. Skip checking lock acquisition with nest_lock, which is about correct lock usage that should be checked by lockdep.
Changes from RFC(v0):
1. Prevent adding a wait tag at prepare_to_wait() but __schedule(). (feedback from Linus and Matthew)
2. Use try version at lockdep_acquire_cpus_lock() annotation.
3. Distinguish each syscall context from another.
Byungchul Park (47):
llist: move llist_{head,node} definition to types.h
dept: implement DEPT(DEPendency Tracker)
dept: add single event dependency tracker APIs
dept: add lock dependency tracker APIs
dept: tie to lockdep and IRQ tracing
dept: add proc knobs to show stats and dependency graph
dept: distinguish each kernel context from another
x86_64, dept: add support CONFIG_ARCH_HAS_DEPT_SUPPORT to x86_64 arm64, dept: add support CONFIG_ARCH_HAS_DEPT_SUPPORT to arm64
dept: distinguish each work from another
dept: add a mechanism to refill the internal memory pools on running
out
dept: record the latest one out of consecutive waits of the same class
dept: apply sdt_might_sleep_{start,end}() to
wait_for_completion()/complete()
dept: apply sdt_might_sleep_{start,end}() to swait
dept: apply sdt_might_sleep_{start,end}() to waitqueue wait
dept: apply sdt_might_sleep_{start,end}() to hashed-waitqueue wait
dept: apply sdt_might_sleep_{start,end}() to dma fence
dept: track timeout waits separately with a new Kconfig
dept: apply timeout consideration to wait_for_completion()/complete()
dept: apply timeout consideration to swait
dept: apply timeout consideration to waitqueue wait
dept: apply timeout consideration to hashed-waitqueue wait
dept: apply timeout consideration to dma fence wait
dept: make dept able to work with an external wgen
dept: track PG_locked with dept
dept: print staged wait's stacktrace on report locking/lockdep: prevent various lockdep assertions when
lockdep_off()'ed
dept: add documentation for dept
cpu/hotplug: use a weaker annotation in AP thread
fs/jbd2: use a weaker annotation in journal handling
dept: assign dept map to mmu notifier invalidation synchronization
dept: assign unique dept_key to each distinct dma fence caller
dept: make dept aware of lockdep_set_lock_cmp_fn() annotation
dept: make dept stop from working on debug_locks_off()
i2c: rename wait_for_completion callback to wait_for_completion_cb
dept: assign unique dept_key to each distinct wait_for_completion()
caller
completion, dept: introduce init_completion_dmap() API
dept: introduce a new type of dependency tracking between multi event
sites
dept: add module support for struct dept_event_site and
dept_event_site_dep
dept: introduce event_site() to disable event tracking if it's
recoverable
dept: implement a basic unit test for dept
dept: call dept_hardirqs_off() in local_irq_*() regardless of irq
state
rcu/update: fix same dept key collision between various types of RCU
dept: introduce APIs to set page usage and use subclasses_evt for the
usage
dept: track PG_writeback with dept
SUNRPC: relocate struct rcu_head to the first field of struct rpc_xprt
mm: percpu: increase PERCPU_DYNAMIC_SIZE_SHIFT on DEPT and large
PAGE_SIZE
Documentation/dependency/dept.txt | 735 ++++++ Documentation/dependency/dept_api.txt | 117 + arch/arm64/Kconfig | 1 + arch/arm64/kernel/syscall.c | 7 + arch/arm64/mm/fault.c | 7 + arch/x86/Kconfig | 1 + arch/x86/entry/syscall_64.c | 7 + arch/x86/mm/fault.c | 7 + drivers/dma-buf/dma-fence.c | 23 +- drivers/i2c/algos/i2c-algo-pca.c | 2 +- drivers/i2c/busses/i2c-pca-isa.c | 2 +- drivers/i2c/busses/i2c-pca-platform.c | 2 +- fs/jbd2/transaction.c | 2 +- include/asm-generic/vmlinux.lds.h | 13 +- include/linux/completion.h | 124 +- include/linux/dept.h | 647 +++++ include/linux/dept_ldt.h | 78 + include/linux/dept_sdt.h | 68 + include/linux/dept_unit_test.h | 67 + include/linux/dma-fence.h | 74 +- include/linux/hardirq.h | 3 + include/linux/i2c-algo-pca.h | 2 +- include/linux/irqflags.h | 21 +- include/linux/llist.h | 8 - include/linux/local_lock_internal.h | 1 + include/linux/lockdep.h | 105 +- include/linux/lockdep_types.h | 3 + include/linux/mm_types.h | 4 + include/linux/mmu_notifier.h | 26 + include/linux/module.h | 5 + include/linux/mutex.h | 1 + include/linux/page-flags.h | 204 +- include/linux/pagemap.h | 37 +- include/linux/percpu-rwsem.h | 2 +- include/linux/percpu.h | 4 + include/linux/rcupdate_wait.h | 13 +- include/linux/rtmutex.h | 1 + include/linux/rwlock_types.h | 1 + include/linux/rwsem.h | 1 + include/linux/sched.h | 118 + include/linux/seqlock.h | 2 +- include/linux/spinlock_types_raw.h | 3 + include/linux/srcu.h | 2 +- include/linux/sunrpc/xprt.h | 9 +- include/linux/swait.h | 3 + include/linux/types.h | 8 + include/linux/wait.h | 3 + include/linux/wait_bit.h | 3 + init/init_task.c | 2 + init/main.c | 2 + kernel/Makefile | 1 + kernel/cpu.c | 2 +- kernel/dependency/Makefile | 5 + kernel/dependency/dept.c | 3499 +++++++++++++++++++++++++ kernel/dependency/dept_hash.h | 10 + kernel/dependency/dept_internal.h | 65 + kernel/dependency/dept_object.h | 13 + kernel/dependency/dept_proc.c | 94 + kernel/dependency/dept_unit_test.c | 173 ++ kernel/exit.c | 1 + kernel/fork.c | 2 + kernel/locking/lockdep.c | 33 + kernel/module/main.c | 19 + kernel/rcu/rcu.h | 1 + kernel/rcu/update.c | 5 +- kernel/sched/completion.c | 62 +- kernel/sched/core.c | 9 + kernel/workqueue.c | 3 + lib/Kconfig.debug | 51 + lib/debug_locks.c | 2 + lib/locking-selftest.c | 2 + mm/filemap.c | 37 + mm/mm_init.c | 3 + mm/mmu_notifier.c | 31 +- 74 files changed, 6570 insertions(+), 134 deletions(-) create mode 100644 Documentation/dependency/dept.txt create mode 100644 Documentation/dependency/dept_api.txt create mode 100644 include/linux/dept.h create mode 100644 include/linux/dept_ldt.h create mode 100644 include/linux/dept_sdt.h create mode 100644 include/linux/dept_unit_test.h create mode 100644 kernel/dependency/Makefile create mode 100644 kernel/dependency/dept.c create mode 100644 kernel/dependency/dept_hash.h create mode 100644 kernel/dependency/dept_internal.h create mode 100644 kernel/dependency/dept_object.h create mode 100644 kernel/dependency/dept_proc.c create mode 100644 kernel/dependency/dept_unit_test.c
base-commit: e5f0a698b34ed76002dc5cff3804a61c80233a7a
Signature · 1 line
2.17.1
PATCH v17 1/47 llist: move llist_{head,node} definition to types.h
llist_head and llist_node can be used by some other header files. For example, dept for tracking dependencies uses llist in its header. To avoid header dependency, move them to types.h.
--- include/linux/llist.h | 8 -------- include/linux/types.h | 8 ++++++++ 2 files changed, 8 insertions(+), 8 deletions(-)
include/linux/llist.h +0 -8
@@ -53,14 +53,6 @@#include <linux/stddef.h> #include <linux/types.h> -struct llist_head { -struct llist_node *first; -}; - -struct llist_node { -struct llist_node *next; -}; -#define LLIST_HEAD_INIT (name) { NULL }#define LLIST_HEAD (name) struct llist_head name = LLIST_HEAD_INIT(name)
include/linux/types.h +8 -0
@@ -208,6 +208,14 @@ struct hlist_node {struct hlist_node *next, **pprev; }; +struct llist_head { +struct llist_node *first; +}; + +struct llist_node { +struct llist_node *next; +}; +struct ustat {__kernel_daddr_t f_tfree;#ifdef CONFIG_ARCH_32BIT_USTAT_F_TINODE
Signature · 1 line
2.17.1
Re: [PATCH v17 01/47] llist: move llist_{head,node} definition to types.h
Quoted 3 lines · Byungchul Park
llist_headandllist_nodecan be used by some other header files. For example, dept for tracking dependencies uses llist in its header. To avoid header dependency, move them totypes.h.
If you need llist in your code, then include llist.h. Don't force all types.h users to do so as there is not a dependency in types.h for llist.h.
This patch shouldn't be needed as you are hiding "header dependency" for other files.
thanks,
greg k-h
Mathieu Desnoyers
reviewerRe: [PATCH v17 01/47] llist: move llist_{head,node} definition to types.h
Quoted 11 lines · Greg KH
Quoted 3 lines · Byungchul Park
llist_headandllist_nodecan be used by some other header files. For example, dept for tracking dependencies uses llist in its header. To avoid header dependency, move them totypes.h.If you need llist in your code, then include
llist.h. Don't force alltypes.husers to do so as there is not a dependency intypes.hforllist.h.This patch shouldn't be needed as you are hiding "header dependency" for other files.
I agree that moving this into a catch-all types.h is not what we should aim for.
However, it's a good practice to move the type declarations to a separate header file, so code that only cares about type and not implementation of static inline functions can include just that.
Perhaps we can move struct llist_head and struct llist_node to a new include/linux/llist_types.h instead ?
Thanks,
Mathieu
Signature · 3 lines
Mathieu Desnoyers EfficiOS Inc. https://www.efficios.com
Arnd Bergmann
maintainerRe: [PATCH v17 01/47] llist: move llist_{head,node} definition to types.h
Quoted 16 lines · Mathieu Desnoyers
Quoted 11 lines · Greg KH
Quoted 3 lines · Byungchul Park
llist_headandllist_nodecan be used by some other header files. For example, dept for tracking dependencies uses llist in its header. To avoid header dependency, move them totypes.h.If you need llist in your code, then include
llist.h. Don't force alltypes.husers to do so as there is not a dependency intypes.hforllist.h.This patch shouldn't be needed as you are hiding "header dependency" for other files.
I agree that moving this into a catch-all
types.his not what we should aim for.
Quoted 6 lines
However, it's a good practice to move the type declarations to a separate header file, so code that only cares about type and not implementation of static inline functions can include just that.
Perhaps we can move struct
llist_headand structllist_nodeto a newinclude/linux/llist_types.hinstead ?
We have around a dozen types of linked lists, and the most common two of them are currently defined in linux/types.h, while the rest of them are each defined in the same header as the inteface definition.
Duplicating each of those headers by splitting out the trivial type definition doesn't quite seem right either, as we'd end up with even more headers that have to be included indirectly in each compilation unit.
Maybe a shared linux/list_types.h would work, to specifically contain all the list_head variants that are meant to be included in larger structures?
Arnd
Re: [PATCH v17 01/47] llist: move llist_{head,node} definition to types.h
Quoted 29 lines · Arnd Bergmann
Quoted 16 lines · Mathieu Desnoyers
Quoted 11 lines · Greg KH
Quoted 3 lines · Byungchul Park
llist_headandllist_nodecan be used by some other header files. For example, dept for tracking dependencies uses llist in its header. To avoid header dependency, move them totypes.h.If you need llist in your code, then include
llist.h. Don't force alltypes.husers to do so as there is not a dependency intypes.hforllist.h.This patch shouldn't be needed as you are hiding "header dependency" for other files.
I agree that moving this into a catch-all
types.his not what we should aim for.Quoted 6 lines
However, it's a good practice to move the type declarations to a separate header file, so code that only cares about type and not implementation of static inline functions can include just that.
Perhaps we can move struct
llist_headand structllist_nodeto a newinclude/linux/llist_types.hinstead ?We have around a dozen types of linked lists, and the most common two of them are currently defined in
linux/types.h, while the rest of them are each defined in the same header as the inteface definition.
Quoted 6 lines
Duplicating each of those headers by splitting out the trivial type definition doesn't quite seem right either, as we'd end up with even more headers that have to be included indirectly in each compilation unit.
Maybe a shared
linux/list_types.hwould work, to specifically
I found a way to resolve my issue, but I thought it's good idea regardless of my issue and took a quick look. However, it seems like there's an overwhelming amount of work since it might require to replace all the existing include <linux/types.h> for use of list things with the new one :-).
Byungchul
Quoted 4 lines
contain all the
list_headvariants that are meant to be included in larger structures?Arnd
Arnd Bergmann
maintainerRe: [PATCH v17 01/47] llist: move llist_{head,node} definition to types.h
Quoted 5 lines · Byungchul Park
Quoted 3 lines · Arnd Bergmann
Quoted 2 lines · Mathieu Desnoyers
Quoted 1 line · Greg KH
On Thu, Oct 02, 2025 at 05:12:01PM +0900, Byungchul Park wrote:
Quoted 7 lines
Quoted 1 line
Maybe a shared
linux/list_types.hwould work, to specificallyI found a way to resolve my issue, but I thought it's good idea regardless of my issue and took a quick look. However, it seems like there's an overwhelming amount of work since it might require to replace all the existing include <
linux/types.h> for use of list things with the new one :-).
I don't think it's that bad, since almost every header ends up including linux/list.h indirectly at the moment.
A little bit of scripting to find the headers that reference 'struct list_head' but don't also include linux/list.h reveals this relatively short set that would need to include the new header:
Quoted 36 lines
include/keys/asymmetric-parser.hinclude/linux/dynamic_debug.hinclude/linux/genalloc.hinclude/linux/gpio/machine.hinclude/linux/hiddev.hinclude/linux/iio/iio-opaque.hinclude/linux/iio/sysfs.hinclude/linux/input/touch-overlay.hinclude/linux/irq_poll.hinclude/linux/iscsi_boot_sysfs.hinclude/linux/kcore.hinclude/linux/kcsan-checks.hinclude/linux/kcsan.hinclude/linux/lockdep_types.hinclude/linux/logic_pio.hinclude/linux/maple.hinclude/linux/mfd/iqs62x.hinclude/linux/mlx5/macsec.hinclude/linux/mount.hinclude/linux/mtd/map.hinclude/linux/mtd/nand-qpic-common.hinclude/linux/mtd/partitions.hinclude/linux/mutex_types.hinclude/linux/nfs_fs_i.hinclude/linux/of_iommu.hinclude/linux/parport_pc.hinclude/linux/pinctrl/pinctrl.hinclude/linux/plist_types.hinclude/linux/pm_wakeup.hinclude/linux/reboot-mode.hinclude/linux/shm.hinclude/linux/smpboot.hinclude/linux/sunrpc/xprtmultipath.hinclude/linux/usb/audio.hinclude/linux/workqueue_types.hinclude/linux/zpool.h
Quoted 8 lines
include/net/bluetooth/hci_sync.hinclude/net/bluetooth/l2cap.hinclude/net/bluetooth/rfcomm.hinclude/net/dcbnl.hinclude/sound/i2c.hinclude/sound/soc-jack.hinclude/target/iscsi/iscsi_transport.hinclude/video/udlfb.h
A lot of these don't have any #include statements at all, which indicates that they expect to only be included in places where the dependencies are already visible.
Arnd
Re: [PATCH v17 01/47] llist: move llist_{head,node} definition to types.h
In reply to Greg KHQuoted 6 lines · Greg KH
Quoted 3 lines · Byungchul Park
llist_headandllist_nodecan be used by some other header files. For example, dept for tracking dependencies uses llist in its header. To avoid header dependency, move them totypes.h.If you need llist in your code, then include
llist.h. Don't force all
Eventually, I found out another way to avoid the dependency issue. Thanks anyway for the feedback.
Byungchul
Quoted 9 lines
types.husers to do so as there is not a dependency intypes.hforllist.h.This patch shouldn't be needed as you are hiding "header dependency" for other files.
thanks,
greg k-h
PATCH v17 2/47 dept: implement DEPT(DEPendency Tracker)
In reply to Byungchul ParkCURRENT STATUS
--------------
lockdep tracks acquisition order of locks in order to detect deadlock, and IRQ and IRQ enable/disable state as well to take accident acquisitions into account.
lockdep should be turned off once it detects and reports a deadlock since the data structure and algorithm are not reusable after detection because of the complex design.
PROBLEM
-------
*Waits* and their *events* that never reach eventually cause deadlock. However, lockdep is only interested in lock acquisition order, forcing to emulate lock acqusition even for just waits and events that have nothing to do with real lock.
Even worse, no one likes lockdep's false positive detection because that prevents further one that might be more valuable. That's why all the kernel developers are sensitive to lockdep's false positive.
Besides those, by tracking acquisition order, it cannot correctly deal with read lock and cross-event e.g. wait_for_completion()/complete() for deadlock detection. lockdep is no longer a good tool for that purpose.
SOLUTION
--------
Again, *waits* and their *events* that never reach eventually cause deadlock. The new solution, DEPT(DEPendency Tracker), focuses on waits and events themselves. dept tracks waits and events and report it if any event would be never reachable.
dept does:
. Works with read lock in the right way.
. Works with any wait and event e.i. cross-event. . Continue to work even after reporting multiple times. . Provides simple and intuitive APIs.
. Does exactly what dependency checker should do.
Q & A
-----
Q. Is this the first try ever to address the problem?
A. No, cross-release feature (b09be676e0ff2 locking/lockdep: Implement
the 'crossrelease' feature) addressed it that was a lockdep extension and merged but reverted shortly because:
cross-release started to report valuable hidden problems but started to give report false positive reports as well. For sure, no one likes lockdep's false positive reports since it makes lockdep stop, preventing reporting further real problems.
Q. Why not dept was developed as an extension of lockdep? A. lockdep definitely includes all the efforts great developers have
made for a long time so as to be quite stable enough. But I had to design and implement newly because of the following:
1) lockdep was designed to track lock acquisition order. The APIs and implementation do not fit on wait-event model.
2) lockdep is turned off on detection including false positive. Which is terrible and prevents developing any extension for stronger detection.
Q. Do you intend to totally replace lockdep?
A. No, lockdep also checks if lock usage is correct. Of course, the
dependency check routine should be replaced but the other functions should be still there.
Q. Do you mean the dependency check routine should be replaced right
away?
A. No, I admit lockdep is stable enough thanks to great efforts kernel
developers have made. lockdep and dept, both should be in the kernel until dept gets considered stable.
Q. Stronger detection capability would give more false positive report.
Which was a big problem when cross-release was introduced. Is it ok with dept?
A. It's ok. dept allows multiple reporting thanks to simple and quite
generalized design. Of course, false positive reports should be fixed anyway but it's no longer as a critical problem as it was.
--- include/linux/dept.h | 446 +++++ include/linux/hardirq.h | 3 + include/linux/sched.h | 108 ++ init/init_task.c | 2 + init/main.c | 2 + kernel/Makefile | 1 + kernel/dependency/Makefile | 3 + kernel/dependency/dept.c | 3002 +++++++++++++++++++++++++++++++ kernel/dependency/dept_hash.h | 10 + kernel/dependency/dept_object.h | 13 + kernel/exit.c | 1 + kernel/fork.c | 2 + kernel/module/main.c | 4 + kernel/sched/core.c | 9 + lib/Kconfig.debug | 26 + lib/locking-selftest.c | 2 + 16 files changed, 3634 insertions(+) create mode 100644 include/linux/dept.h create mode 100644 kernel/dependency/Makefile create mode 100644 kernel/dependency/dept.c create mode 100644 kernel/dependency/dept_hash.h create mode 100644 kernel/dependency/dept_object.h
include/linux/dept.h new file +446 -0
@@ -0,0 +1,446 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* +* DEPT(DEPendency Tracker) - runtime dependency tracker +* +* Started by Byungchul Park <[email protected]>: +* +* Copyright (c) 2020 LG Electronics, Inc., Byungchul Park +* Copyright (c) 2024 SK hynix, Inc., Byungchul Park +*/ + +#ifndef __LINUX_DEPT_H +#define __LINUX_DEPT_H + +#ifdef CONFIG_DEPT + +#include <linux/types.h> + +struct task_struct ; + +#define DEPT_MAX_STACK_ENTRY 16 +#define DEPT_MAX_WAIT_HIST 64 +#define DEPT_MAX_ECXT_HELD 48 + +#define DEPT_MAX_SUBCLASSES 16 +#define DEPT_MAX_SUBCLASSES_EVT 2 +#define DEPT_MAX_SUBCLASSES_USR (DEPT_MAX_SUBCLASSES / DEPT_MAX_SUBCLASSES_EVT) +#define DEPT_MAX_SUBCLASSES_CACHE 2 + +#define DEPT_SIRQ 0 +#define DEPT_HIRQ 1 +#define DEPT_IRQS_NR 2 +#define DEPT_SIRQF (1UL << DEPT_SIRQ) +#define DEPT_HIRQF (1UL << DEPT_HIRQ) + +struct dept_ecxt ; +struct dept_iecxt { +struct dept_ecxt *ecxt; +int enirq; +/* +* for preventing to add a new ecxt +*/ +bool staled; +}; + +struct dept_wait ; +struct dept_iwait { +struct dept_wait *wait; +int irq; +/* +* for preventing to add a new wait +*/ +bool staled; +bool touched; +}; + +struct dept_class { +union { +struct llist_node pool_node; +struct { +/* +* reference counter for object management +*/ +atomic_t ref; + +/* +* unique information about the class +*/ +const char *name; +unsigned long key; +int sub_id; + +/* +* for BFS +*/ +unsigned int bfs_gen; +struct dept_class *bfs_parent; +struct list_head bfs_node; + +/* +* for hashing this object +*/ +struct hlist_node hash_node; + +/* +* for linking all classes +*/ +struct list_head all_node; + +/* +* for associating its dependencies +*/ +struct list_head dep_head; +struct list_head dep_rev_head; + +/* +* for tracking IRQ dependencies +*/ +struct dept_iecxt iecxt[DEPT_IRQS_NR ]; +struct dept_iwait iwait[DEPT_IRQS_NR ]; + +/* +* classified by a map embedded in task_struct, +* not an explicit map +*/ +bool sched_map; + }; + }; +}; + +struct dept_key { +union { +/* +* Each byte-wise address will be used as its key. +*/ +char base[DEPT_MAX_SUBCLASSES ]; + +/* +* for caching the main class pointer +*/ +struct dept_class *classes[DEPT_MAX_SUBCLASSES_CACHE ]; + }; +}; + +struct dept_map { +const char *name; +struct dept_key *keys; + +/* +* subclass that can be set from user +*/ +int sub_u; + +/* +* It's local copy for fast access to the associated classes. +* Also used for dept_key for static maps. +*/ +struct dept_key map_key; + +/* +* wait timestamp associated to this map +*/ +unsigned int wgen; + +/* +* whether this map should be going to be checked or not +*/ +bool nocheck; +}; + +#define DEPT_MAP_INITIALIZER (n, k) \ +{ \ + .name = #n, \ + .keys = (struct dept_key *)(k), \ + .sub_u = 0, \ + .map_key = { .classes = { NULL, } }, \ + .wgen = 0U, \ + .nocheck = false, \ +} + +struct dept_stack { +union { +struct llist_node pool_node; +struct { +/* +* reference counter for object management +*/ +atomic_t ref; + +/* +* backtrace entries +*/ +unsigned long raw[DEPT_MAX_STACK_ENTRY ]; +int nr; + }; + }; +}; + +struct dept_ecxt { +union { +struct llist_node pool_node; +struct { +/* +* reference counter for object management +*/ +atomic_t ref; + +/* +* function that entered to this ecxt +*/ +const char *ecxt_fn; + +/* +* event function +*/ +const char *event_fn; + +/* +* associated class +*/ +struct dept_class *class; + +/* +* flag indicating which IRQ has been +* enabled within the event context +*/ +unsigned long enirqf; + +/* +* where the IRQ-enabled happened +*/ +unsigned long enirq_ip[DEPT_IRQS_NR ]; +struct dept_stack *enirq_stack[DEPT_IRQS_NR ]; + +/* +* where the event context started +*/ +unsigned long ecxt_ip; +struct dept_stack *ecxt_stack; + +/* +* where the event triggered +*/ +unsigned long event_ip; +struct dept_stack *event_stack; + }; + }; +}; + +struct dept_wait { +union { +struct llist_node pool_node; +struct { +/* +* reference counter for object management +*/ +atomic_t ref; + +/* +* function causing this wait +*/ +const char *wait_fn; + +/* +* the associated class +*/ +struct dept_class *class; + +/* +* which IRQ the wait was placed in +*/ +unsigned long irqf; + +/* +* where the IRQ wait happened +*/ +unsigned long irq_ip[DEPT_IRQS_NR ]; +struct dept_stack *irq_stack[DEPT_IRQS_NR ]; + +/* +* where the wait happened +*/ +unsigned long wait_ip; +struct dept_stack *wait_stack; + +/* +* whether this wait is for commit in scheduler +*/ +bool sched_sleep; + }; + }; +}; + +struct dept_dep { +union { +struct llist_node pool_node; +struct { +/* +* reference counter for object management +*/ +atomic_t ref; + +/* +* key data of dependency +*/ +struct dept_ecxt *ecxt; +struct dept_wait *wait; + +/* +* This object can be referred without dept_lock +* held but with IRQ disabled, e.g. for hash +* lookup. So deferred deletion is needed. +*/ +struct rcu_head rh; + +/* +* for hashing this object +*/ +struct hlist_node hash_node; + +/* +* for linking to a class object +*/ +struct list_head dep_node; +struct list_head dep_rev_node; + }; + }; +}; + +struct dept_hash { +/* +* hash table +*/ +struct hlist_head *table; + +/* +* size of the table e.i. 2^bits +*/ +int bits; +}; + +struct dept_ecxt_held { +/* +* associated event context +*/ +struct dept_ecxt *ecxt; + +/* +* unique key for this dept_ecxt_held +*/ +struct dept_map *map; + +/* +* class of the ecxt of this dept_ecxt_held +*/ +struct dept_class *class; + +/* +* the wgen when the event context started +*/ +unsigned int wgen; + +/* +* subclass that only works in the local context +*/ +int sub_l; +}; + +struct dept_wait_hist { +/* +* associated wait +*/ +struct dept_wait *wait; + +/* +* unique id of all waits system-wise until wrapped +*/ +unsigned int wgen; + +/* +* local context id to identify IRQ context +*/ +unsigned int ctxt_id; +}; + +extern void dept_on (void ); +extern void dept_off (void ); +extern void dept_init (void ); +extern void dept_task_init (struct task_struct *t); +extern void dept_task_exit (struct task_struct *t); +extern void dept_free_range (void *start,unsigned int sz); + +extern void dept_map_init (struct dept_map *m,struct dept_key *k,int sub_u,const char *n); +extern void dept_map_reinit (struct dept_map *m,struct dept_key *k,int sub_u,const char *n); +extern void dept_map_copy (struct dept_map *to,struct dept_map *from); +extern void dept_wait (struct dept_map *m,unsigned long w_f,unsigned long ip,const char *w_fn,int sub_l); +extern void dept_stage_wait (struct dept_map *m,struct dept_key *k,unsigned long ip,const char *w_fn); +extern void dept_request_event_wait_commit (void ); +extern void dept_clean_stage (void ); +extern void dept_ttwu_stage_wait (struct task_struct *t,unsigned long ip); +extern void dept_ecxt_enter (struct dept_map *m,unsigned long e_f,unsigned long ip,const char *c_fn,const char *e_fn,int sub_l); +extern bool dept_ecxt_holding (struct dept_map *m,unsigned long e_f); +extern void dept_request_event (struct dept_map *m); +extern void dept_event (struct dept_map *m,unsigned long e_f,unsigned long ip,const char *e_fn); +extern void dept_ecxt_exit (struct dept_map *m,unsigned long e_f,unsigned long ip); +extern void dept_sched_enter (void ); +extern void dept_sched_exit (void ); + +static inline void dept_ecxt_enter_nokeep (struct dept_map *m) +{ +dept_ecxt_enter (m,0UL ,0UL ,NULL ,NULL ,0 ); +} + +/* +* for users who want to manage external keys +*/ +extern void dept_key_init (struct dept_key *k); +extern void dept_key_destroy (struct dept_key *k); +extern void dept_map_ecxt_modify (struct dept_map *m,unsigned long e_f,struct dept_key *new_k,unsigned long new_e_f,unsigned long new_ip,const char *new_c_fn,const char *new_e_fn,int new_sub_l); + +extern void dept_softirq_enter (void ); +extern void dept_hardirq_enter (void ); +extern void dept_softirqs_on_ip (unsigned long ip); +extern void dept_hardirqs_on (void ); +extern void dept_softirqs_off (void ); +extern void dept_hardirqs_off (void ); +#else /* !CONFIG_DEPT */ +struct dept_key { }; +struct dept_map { }; + +#define DEPT_MAP_INITIALIZER (n, k) { } + +#define dept_on () do { } while (0) +#define dept_off () do { } while (0) +#define dept_init () do { } while (0) +#define dept_task_init (t) do { } while (0) +#define dept_task_exit (t) do { } while (0) +#define dept_free_range (s, sz) do { } while (0) + +#define dept_map_init (m, k, su, n) do { (void)(n); (void)(k); } while (0) +#define dept_map_reinit (m, k, su, n) do { (void)(n); (void)(k); } while (0) +#define dept_map_copy (t, f) do { } while (0) +#define dept_wait (m, w_f, ip, w_fn, sl) do { (void)(w_fn); } while (0) +#define dept_stage_wait (m, k, ip, w_fn) do { (void)(k); (void)(w_fn); } while (0) +#define dept_request_event_wait_commit () do { } while (0) +#define dept_clean_stage () do { } while (0) +#define dept_ttwu_stage_wait (t, ip) do { } while (0) +#define dept_ecxt_enter (m, e_f, ip, c_fn, e_fn, sl) do { (void)(c_fn); (void)(e_fn); } while (0) +#define dept_ecxt_holding (m, e_f) false +#define dept_request_event (m) do { } while (0) +#define dept_event (m, e_f, ip, e_fn) do { (void)(e_fn); } while (0) +#define dept_ecxt_exit (m, e_f, ip) do { } while (0) +#define dept_sched_enter () do { } while (0) +#define dept_sched_exit () do { } while (0) +#define dept_ecxt_enter_nokeep (m) do { } while (0) +#define dept_key_init (k) do { (void)(k); } while (0) +#define dept_key_destroy (k) do { (void)(k); } while (0) +#define dept_map_ecxt_modify (m, e_f, n_k, n_e_f, n_ip, n_c_fn, n_e_fn, n_sl) do { (void)(n_k); (void)(n_c_fn); (void)(n_e_fn); } while (0) + +#define dept_softirq_enter () do { } while (0) +#define dept_hardirq_enter () do { } while (0) +#define dept_softirqs_on_ip (ip) do { } while (0) +#define dept_hardirqs_on () do { } while (0) +#define dept_softirqs_off () do { } while (0) +#define dept_hardirqs_off () do { } while (0) +#endif +#endif /* __LINUX_DEPT_H */
include/linux/hardirq.h +3 -0
@@ -5,6 +5,7 @@#include <linux/context_tracking_state.h> #include <linux/preempt.h> #include <linux/lockdep.h> +#include <linux/dept.h> #include <linux/ftrace_irq.h> #include <linux/sched.h> #include <linux/vtime.h>
@@ -106,6 +107,7 @@ void irq_exit_rcu(void);*/ #define __nmi_enter () \ do { \ + dept_off(); \ lockdep_off(); \ arch_nmi_enter(); \ BUG_ON(in_nmi() == NMI_MASK); \
@@ -128,6 +130,7 @@ void irq_exit_rcu(void);__preempt_count_sub (NMI_OFFSET +HARDIRQ_OFFSET ); \arch_nmi_exit (); \lockdep_on (); \ +dept_on (); \ }while (0 ) #define nmi_exit() \
include/linux/sched.h +108 -0
126 lines not on this page · raw message
init/init_task.c +2 -0
@@ -14,6 +14,7 @@#include <linux/numa.h> #include <linux/scs.h> #include <linux/plist.h> +#include <linux/dept.h> #include <linux/uaccess.h>
@@ -204,6 +205,7 @@ struct task_struct init_task __aligned(L1_CACHE_BYTES) = { .curr_chain_key = INITIAL_CHAIN_KEY, .lockdep_recursion = 0, #endif + .dept_task =DEPT_TASK_INITIALIZER (init_task), #ifdef CONFIG_FUNCTION_GRAPH_TRACER .ret_stack =NULL , .tracing_graph_pause = ATOMIC_INIT(0),
init/main.c +2 -0
@@ -66,6 +66,7 @@#include <linux/debug_locks.h> #include <linux/debugobjects.h> #include <linux/lockdep.h> +#include <linux/dept.h> #include <linux/kmemleak.h> #include <linux/padata.h> #include <linux/pid_namespace.h>
@@ -1038,6 +1039,7 @@ void start_kernel(void) panic_param);lockdep_init (); +dept_init ();/* * Need to run this when irqs are enabled, because it wants
kernel/Makefile +1 -0
@@ -56,6 +56,7 @@ obj-y += dma/ obj-y += entry/ obj-y += unwind/ obj-$(CONFIG_MODULES) += module/ +obj-y += dependency/ obj-$(CONFIG_KCMP) += kcmp.o obj-$(CONFIG_FREEZER) += freezer.o
kernel/dependency/Makefile new file +3 -0
@@ -0,0 +1,3 @@ +# SPDX-License-Identifier: GPL-2.0 + +obj-$(CONFIG_DEPT) += dept.o
kernel/dependency/dept.c new file +3002 -0
2,369 lines not on this page · raw message
kernel/dependency/dept_hash.h new file +10 -0
Lines of this file are not shown. View the raw message.
kernel/dependency/dept_object.h new file +13 -0
Lines of this file are not shown. View the raw message.
The rest of this diff is not shown. View the raw message.
Signature · 1 line
2.17.1
Part of the diff is not shown here. View the raw message.
Re: [PATCH v17 02/47] dept: implement DEPT(DEPendency Tracker)
include/linux/dept.h line 8
Quoted 9 lines
include/linux/dept.h new file +8
-0@@ -0,0 +1,446 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* +* DEPT(DEPendency Tracker) - runtime dependency tracker +* +* Started by Byungchul Park <[email protected]>: +* +* Copyright (c) 2020 LG Electronics, Inc., Byungchul Park +* Copyright (c) 2024 SK hynix, Inc., Byungchul Park
Nit, it's now 2025 :)
thanks,
greg k-h
Re: [PATCH v17 02/47] dept: implement DEPT(DEPendency Tracker)
Hi Greg,
Quoted 11 lines · Greg KH
include/linux/dept.h line 8
Quoted 9 lines
include/linux/dept.h new file +8
-0@@ -0,0 +1,446 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* +* DEPT(DEPendency Tracker) - runtime dependency tracker +* +* Started by Byungchul Park <[email protected]>: +* +* Copyright (c) 2020 LG Electronics, Inc., Byungchul Park +* Copyright (c) 2024 SK hynix, Inc., Byungchul Park Nit, it's now 2025 :)
The last non-trivial change to this file was between the last version posted in 2024 (v14) and the first version posted in 2025 (v15), so 2024 doesn't sound that off to me.
You are not supposed to bump the copyright year when republishing without any actual changes. It is meant to be the work’s first year of publication.
Gr{oetje,eeting}s,
Geert
Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected] In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that. -- Linus Torvalds
PATCH v17 3/47 dept: add single event dependency tracker APIs
In reply to Byungchul ParkWrapped the base APIs for easier annotation on wait and event. Start with supporting waiters on each single event. More general support for multiple events is a future work. Do more when the need arises.
How to annotate:
1. Initaialize a map for the interesting wait.
/*
* Place along with the wait instance.
*/
struct dept_map my_wait;
/*
* Place in the initialization code.
*/
sdt_map_init(&my_wait);
2. Place the following at the wait code.
sdt_wait(&my_wait);
3. Place the following at the event code.
sdt_event(&my_wait);
That's it!
--- include/linux/dept_sdt.h | 65 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 include/linux/dept_sdt.h
include/linux/dept_sdt.h new file +65 -0
@@ -0,0 +1,65 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* +* Single-event Dependency Tracker +* +* Started by Byungchul Park <[email protected]>: +* +* Copyright (c) 2020 LG Electronics, Inc., Byungchul Park +* Copyright (c) 2024 SK hynix, Inc., Byungchul Park +*/ + +#ifndef __LINUX_DEPT_SDT_H +#define __LINUX_DEPT_SDT_H + +#include <linux/kernel.h> +#include <linux/dept.h> + +#ifdef CONFIG_DEPT +#define sdt_map_init (m) \ + do { \ + static struct dept_key __key; \ + dept_map_init(m, &__key, 0, #m); \ + } while (0) + +#define sdt_map_init_key (m, k) dept_map_init(m, k, 0, #m) + +#define sdt_wait (m) \ + do { \ + dept_request_event(m); \ + dept_wait(m, 1UL, _THIS_IP_, __func__, 0); \ + } while (0) + +/* +* sdt_might_sleep() and its family will be committed in __schedule() +* when it actually gets to __schedule(). Both dept_request_event() and +* dept_wait() will be performed on the commit. +*/ + +/* +* Use the code location as the class key if an explicit map is not used. +*/ +#define sdt_might_sleep_start (m) \ + do { \ + struct dept_map *__m = m; \ + static struct dept_key __key; \ + dept_stage_wait(__m, __m ? NULL : &__key, _THIS_IP_, __func__);\ + } while (0) + +#define sdt_might_sleep_end () dept_clean_stage() + +#define sdt_ecxt_enter (m) dept_ecxt_enter(m, 1UL, _THIS_IP_, "start", "event", 0) +#define sdt_event (m) dept_event(m, 1UL, _THIS_IP_, __func__) +#define sdt_ecxt_exit (m) dept_ecxt_exit(m, 1UL, _THIS_IP_) +#define sdt_request_event (m) dept_request_event(m) +#else /* !CONFIG_DEPT */ +#define sdt_map_init (m) do { } while (0) +#define sdt_map_init_key (m, k) do { (void)(k); } while (0) +#define sdt_wait (m) do { } while (0) +#define sdt_might_sleep_start (m) do { } while (0) +#define sdt_might_sleep_end () do { } while (0) +#define sdt_ecxt_enter (m) do { } while (0) +#define sdt_event (m) do { } while (0) +#define sdt_ecxt_exit (m) do { } while (0) +#define sdt_request_event (m) do { } while (0) +#endif +#endif /* __LINUX_DEPT_SDT_H */
Signature · 1 line
2.17.1
PATCH v17 4/47 dept: add lock dependency tracker APIs
In reply to Byungchul ParkWrap the base APIs for easier annotation on typical lock.
--- include/linux/dept_ldt.h | 78 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 include/linux/dept_ldt.h
include/linux/dept_ldt.h new file +78 -0
@@ -0,0 +1,78 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* +* Lock Dependency Tracker +* +* Started by Byungchul Park <[email protected]>: +* +* Copyright (c) 2020 LG Electronics, Inc., Byungchul Park +* Copyright (c) 2024 SK hynix, Inc., Byungchul Park +*/ + +#ifndef __LINUX_DEPT_LDT_H +#define __LINUX_DEPT_LDT_H + +#include <linux/dept.h> + +#ifdef CONFIG_DEPT +#define LDT_EVT_L 1UL +#define LDT_EVT_R 2UL +#define LDT_EVT_W 1UL +#define LDT_EVT_RW (LDT_EVT_R | LDT_EVT_W) +#define LDT_EVT_ALL (LDT_EVT_L | LDT_EVT_RW) + +#define ldt_init (m, k, su, n) dept_map_init(m, k, su, n) +#define ldt_lock (m, sl, t, n, i) \ + do { \ + if (n) \ + dept_ecxt_enter_nokeep(m); \ + else if (t) \ + dept_ecxt_enter(m, LDT_EVT_L, i, "trylock", "unlock", sl);\ + else { \ + dept_wait(m, LDT_EVT_L, i, "lock", sl); \ + dept_ecxt_enter(m, LDT_EVT_L, i, "lock", "unlock", sl);\ + } \ + } while (0) + +#define ldt_rlock (m, sl, t, n, i, q) \ + do { \ + if (n) \ + dept_ecxt_enter_nokeep(m); \ + else if (t) \ + dept_ecxt_enter(m, LDT_EVT_R, i, "read_trylock", "read_unlock", sl);\ + else { \ + dept_wait(m, q ? LDT_EVT_RW : LDT_EVT_W, i, "read_lock", sl);\ + dept_ecxt_enter(m, LDT_EVT_R, i, "read_lock", "read_unlock", sl);\ + } \ + } while (0) + +#define ldt_wlock (m, sl, t, n, i) \ + do { \ + if (n) \ + dept_ecxt_enter_nokeep(m); \ + else if (t) \ + dept_ecxt_enter(m, LDT_EVT_W, i, "write_trylock", "write_unlock", sl);\ + else { \ + dept_wait(m, LDT_EVT_RW, i, "write_lock", sl); \ + dept_ecxt_enter(m, LDT_EVT_W, i, "write_lock", "write_unlock", sl);\ + } \ + } while (0) + +#define ldt_unlock (m, i) dept_ecxt_exit(m, LDT_EVT_ALL, i) + +#define ldt_downgrade (m, i) \ + do { \ + if (dept_ecxt_holding(m, LDT_EVT_W)) \ + dept_map_ecxt_modify(m, LDT_EVT_W, NULL, LDT_EVT_R, i, "downgrade", "read_unlock", -1);\ + } while (0) + +#define ldt_set_class (m, n, k, sl, i) dept_map_ecxt_modify(m, LDT_EVT_ALL, k, 0UL, i, "lock_set_class", "(any)unlock", sl) +#else /* !CONFIG_DEPT */ +#define ldt_init (m, k, su, n) do { (void)(k); } while (0) +#define ldt_lock (m, sl, t, n, i) do { } while (0) +#define ldt_rlock (m, sl, t, n, i, q) do { } while (0) +#define ldt_wlock (m, sl, t, n, i) do { } while (0) +#define ldt_unlock (m, i) do { } while (0) +#define ldt_downgrade (m, i) do { } while (0) +#define ldt_set_class (m, n, k, sl, i) do { } while (0) +#endif +#endif /* __LINUX_DEPT_LDT_H */
Signature · 1 line
2.17.1
PATCH v17 5/47 dept: tie to lockdep and IRQ tracing
In reply to Byungchul ParkHow to place dept this way looks so ugly. However, it's inevitable for now. The way should be enhanced gradually.
--- include/linux/irqflags.h | 7 +- include/linux/local_lock_internal.h | 1 + include/linux/lockdep.h | 102 ++++++++++++++++++++++------ include/linux/lockdep_types.h | 3 + include/linux/mutex.h | 1 + include/linux/percpu-rwsem.h | 2 +- include/linux/rtmutex.h | 1 + include/linux/rwlock_types.h | 1 + include/linux/rwsem.h | 1 + include/linux/seqlock.h | 2 +- include/linux/spinlock_types_raw.h | 3 + include/linux/srcu.h | 2 +- kernel/dependency/dept.c | 8 +-- kernel/locking/lockdep.c | 22 ++++++ 14 files changed, 127 insertions(+), 29 deletions(-)
include/linux/irqflags.h +6 -1
@@ -15,6 +15,7 @@#include <linux/irqflags_types.h> #include <linux/typecheck.h> #include <linux/cleanup.h> +#include <linux/dept.h> #include <asm/irqflags.h> #include <asm/percpu.h>
@@ -55,8 +56,10 @@ extern void trace_hardirqs_off(void);# define lockdep_softirqs_enabled (p) ((p)->softirqs_enabled)# define lockdep_hardirq_enter () \ do { \ - if (__this_cpu_inc_return(hardirq_context) == 1)\ + if (__this_cpu_inc_return(hardirq_context) == 1) { \ current->hardirq_threaded = 0; \ + dept_hardirq_enter(); \ + } \ } while (0)# define lockdep_hardirq_threaded () \ do { \
@@ -131,6 +134,8 @@ do { \# define lockdep_softirq_enter () \ do { \ current->softirq_context++; \ + if (current->softirq_context == 1) \ + dept_softirq_enter(); \ } while (0)# define lockdep_softirq_exit () \ do { \
include/linux/local_lock_internal.h +1 -0
@@ -27,6 +27,7 @@ typedef struct { .name = #lockname, \ .wait_type_inner = LD_WAIT_CONFIG, \ .lock_type = LD_LOCK_PERCPU, \ + .dmap = DEPT_MAP_INITIALIZER(lockname, NULL),\ }, \ .owner = NULL,
include/linux/lockdep.h +81 -21
133 lines not on this page · raw message
include/linux/lockdep_types.h +3 -0
@@ -11,6 +11,7 @@#define __LINUX_LOCKDEP_TYPES_H#include <linux/types.h> +#include <linux/dept.h> #define MAX_LOCKDEP_SUBCLASSES 8UL
@@ -77,6 +78,7 @@ struct lock_class_key {struct hlist_node hash_entry;struct lockdep_subclass_key subkeys[MAX_LOCKDEP_SUBCLASSES ]; }; +struct dept_key dkey; };extern struct lock_class_key __lockdep_no_validate__;
@@ -195,6 +197,7 @@ struct lockdep_map {int cpu;unsigned long ip;#endif +struct dept_map dmap; };struct pin_cookie {unsigned int val; };
include/linux/mutex.h +1 -0
@@ -29,6 +29,7 @@ struct device; , .dep_map = { \ .name = #lockname, \ .wait_type_inner = LD_WAIT_SLEEP, \ + .dmap = DEPT_MAP_INITIALIZER(lockname, NULL),\ }#else # define __DEP_MAP_MUTEX_INITIALIZER (lockname)
include/linux/percpu-rwsem.h +1 -1
@@ -22,7 +22,7 @@ struct percpu_rw_semaphore { };#ifdef CONFIG_DEBUG_LOCK_ALLOC -#define __PERCPU_RWSEM_DEP_MAP_INIT (lockname) .dep_map = { .name = #lockname }, +#define __PERCPU_RWSEM_DEP_MAP_INIT (lockname) .dep_map = { .name = #lockname, .dmap = DEPT_MAP_INITIALIZER(lockname, NULL) },#else #define __PERCPU_RWSEM_DEP_MAP_INIT (lockname)#endif
include/linux/rtmutex.h +1 -0
@@ -81,6 +81,7 @@ do { \ .dep_map = { \ .name = #mutexname, \ .wait_type_inner = LD_WAIT_SLEEP, \ + .dmap = DEPT_MAP_INITIALIZER(mutexname, NULL),\ }#else #define __DEP_MAP_RT_MUTEX_INITIALIZER (mutexname)
include/linux/rwlock_types.h +1 -0
@@ -10,6 +10,7 @@ .dep_map = { \ .name = #lockname, \ .wait_type_inner = LD_WAIT_CONFIG, \ + .dmap = DEPT_MAP_INITIALIZER(lockname, NULL), \ }#else # define RW_DEP_MAP_INIT (lockname)
include/linux/rwsem.h +1 -0
@@ -22,6 +22,7 @@ .dep_map = { \ .name = #lockname, \ .wait_type_inner = LD_WAIT_SLEEP, \ + .dmap = DEPT_MAP_INITIALIZER(lockname, NULL),\ },#else # define __RWSEM_DEP_MAP_INIT (lockname)
include/linux/seqlock.h +1 -1
@@ -51,7 +51,7 @@ static inline void __seqcount_init(seqcount_t *s, const char *name,#ifdef CONFIG_DEBUG_LOCK_ALLOC # define SEQCOUNT_DEP_MAP_INIT (lockname) \ - .dep_map = { .name = #lockname } + .dep_map = { .name = #lockname, .dmap = DEPT_MAP_INITIALIZER(lockname, NULL) }/** * seqcount_init() - runtime initializer for seqcount_t
include/linux/spinlock_types_raw.h +3 -0
@@ -31,11 +31,13 @@ typedef struct raw_spinlock { .dep_map = { \ .name = #lockname, \ .wait_type_inner = LD_WAIT_SPIN, \ + .dmap = DEPT_MAP_INITIALIZER(lockname, NULL),\ }# define SPIN_DEP_MAP_INIT (lockname) \ .dep_map = { \ .name = #lockname, \ .wait_type_inner = LD_WAIT_CONFIG, \ + .dmap = DEPT_MAP_INITIALIZER(lockname, NULL),\ }# define LOCAL_SPIN_DEP_MAP_INIT (lockname) \
@@ -43,6 +45,7 @@ typedef struct raw_spinlock { .name = #lockname, \ .wait_type_inner = LD_WAIT_CONFIG, \ .lock_type = LD_LOCK_PERCPU, \ + .dmap = DEPT_MAP_INITIALIZER(lockname, NULL),\ }#else # define RAW_SPIN_DEP_MAP_INIT (lockname)
include/linux/srcu.h +1 -1
@@ -35,7 +35,7 @@ int __init_srcu_struct(struct srcu_struct *ssp, const char *name, __init_srcu_struct((ssp), #ssp, &__srcu_key); \ }) -#define __SRCU_DEP_MAP_INIT (srcu_name) .dep_map = { .name = #srcu_name }, +#define __SRCU_DEP_MAP_INIT (srcu_name) .dep_map = { .name = #srcu_name, .dmap = DEPT_MAP_INITIALIZER(srcu_name, NULL) },#else /* #ifdef CONFIG_DEBUG_LOCK_ALLOC */ int init_srcu_struct (struct srcu_struct *ssp);
kernel/dependency/dept.c +4 -4
@@ -249,10 +249,10 @@ static bool dept_working(void)* Even k == NULL is considered as a valid key because it would use * &->map_key as the key in that case. */ -struct dept_key __dept_no_validate__; +extern struct lock_class_key __lockdep_no_validate__;static bool valid_key (struct dept_key *k) { -return &__dept_no_validate__ != k; +return &__lockdep_no_validate__.dkey != k; }/*
@@ -1946,7 +1946,7 @@ void dept_softirqs_off(void)dept_task ()->softirqs_enabled = false; } -void dept_hardirqs_off (void ) +void noinstr dept_hardirqs_off(void) {/* * Assumes that it's called with IRQ disabled so that accessing
@@ -1968,7 +1968,7 @@ void dept_softirq_enter(void)/* * Ensure it's the outmost hardirq context. */ -void dept_hardirq_enter (void ) +void noinstr dept_hardirq_enter(void) {struct dept_task *dt =dept_task ();
kernel/locking/lockdep.c +22 -0
@@ -1224,6 +1224,8 @@ void lockdep_register_key(struct lock_class_key *key)struct lock_class_key *k;unsigned long flags; +dept_key_init (&key->dkey); +if (WARN_ON_ONCE (static_obj (key)))return ; hash_head =keyhashentry (key);
@@ -4361,6 +4363,8 @@ static void __trace_hardirqs_on_caller(void)*/ void lockdep_hardirqs_on_prepare (void ) { +dept_hardirqs_on (); +if (unlikely (!debug_locks))return ;
@@ -4481,6 +4485,8 @@ EXPORT_SYMBOL_GPL(lockdep_hardirqs_on);*/ void noinstr lockdep_hardirqs_off(unsigned long ip) { +dept_hardirqs_off (); +if (unlikely (!debug_locks))return ;
@@ -4525,6 +4531,8 @@ void lockdep_softirqs_on(unsigned long ip) {struct irqtrace_events *trace = ¤t->irqtrace; +dept_softirqs_on_ip (ip); +if (unlikely (!lockdep_enabled ()))return ;
@@ -4563,6 +4571,8 @@ void lockdep_softirqs_on(unsigned long ip)*/ void lockdep_softirqs_off (unsigned long ip) { +dept_softirqs_off (); +if (unlikely (!lockdep_enabled ()))return ;
@@ -4940,6 +4950,8 @@ void lockdep_init_map_type(struct lockdep_map *lock, const char *name, {int i; +ldt_init (&lock->dmap, &key->dkey, subclass, name); +for (i =0 ; i <NR_LOCKDEP_CACHING_CLASSES ; i++) lock->class_cache[i] =NULL ;
@@ -5736,6 +5748,12 @@ void lock_set_class(struct lockdep_map *lock, const char *name, {unsigned long flags; +/* +* dept_map_(re)init() might be called twice redundantly. But +* there's no choice as long as Dept relies on Lockdep. +*/ +ldt_set_class (&lock->dmap, name, &key->dkey, subclass, ip); +if (unlikely (!lockdep_enabled ()))return ;
@@ -5753,6 +5771,8 @@ void lock_downgrade(struct lockdep_map *lock, unsigned long ip) {unsigned long flags; +ldt_downgrade (&lock->dmap, ip); +if (unlikely (!lockdep_enabled ()))return ;
@@ -6588,6 +6608,8 @@ void lockdep_unregister_key(struct lock_class_key *key)bool found = false;bool need_callback = false; +dept_key_destroy (&key->dkey); +might_sleep ();if (WARN_ON_ONCE (static_obj (key)))
Signature · 1 line
2.17.1
PATCH v17 6/47 dept: add proc knobs to show stats and dependency graph
In reply to Byungchul ParkIt'd be useful to show dept internal stats and dependency graph on runtime via proc for better information. Introduce the knobs.
--- kernel/dependency/Makefile | 1 + kernel/dependency/dept.c | 50 +++------------- kernel/dependency/dept_internal.h | 54 +++++++++++++++++ kernel/dependency/dept_proc.c | 96 +++++++++++++++++++++++++++++++ 4 files changed, 160 insertions(+), 41 deletions(-) create mode 100644 kernel/dependency/dept_internal.h create mode 100644 kernel/dependency/dept_proc.c
kernel/dependency/Makefile +1 -0
@@ -1,3 +1,4 @@ # SPDX-License-Identifier: GPL-2.0 obj-$(CONFIG_DEPT) += dept.o +obj-$(CONFIG_DEPT) += dept_proc.o
kernel/dependency/dept.c +9 -41
104 lines not on this page · raw message
kernel/dependency/dept_internal.h new file +54 -0
54 lines not on this page · raw message
kernel/dependency/dept_proc.c new file +96 -0
96 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v17 7/47 dept: distinguish each kernel context from another
In reply to Byungchul ParkEach unique kernel context, in dept's point of view, should be identified on every entrance to kernel mode e.g. system call or user oriented fault. Otherwise, dept may track meaningless dependencies across different kernel context.
Plus, in order to update kernel context id at the very beginning of each entrance, arch code support is required, that could be configured by CONFIG_ARCH_HAS_DEPT_SUPPORT.
--- include/linux/dept.h | 29 ++++++++++------- include/linux/sched.h | 10 +++--- kernel/dependency/dept.c | 67 ++++++++++++++++++++-------------------- lib/Kconfig.debug | 5 ++- 4 files changed, 61 insertions(+), 50 deletions(-)
include/linux/dept.h +18 -11
@@ -26,11 +26,16 @@ struct task_struct;#define DEPT_MAX_SUBCLASSES_USR (DEPT_MAX_SUBCLASSES / DEPT_MAX_SUBCLASSES_EVT)#define DEPT_MAX_SUBCLASSES_CACHE 2 -#define DEPT_SIRQ 0 -#define DEPT_HIRQ 1 -#define DEPT_IRQS_NR 2 -#define DEPT_SIRQF (1UL << DEPT_SIRQ) -#define DEPT_HIRQF (1UL << DEPT_HIRQ) +enum { +DEPT_CXT_SIRQ =0 , +DEPT_CXT_HIRQ , +DEPT_CXT_IRQS_NR , +DEPT_CXT_PROCESS =DEPT_CXT_IRQS_NR , +DEPT_CXTS_NR +}; + +#define DEPT_SIRQF (1UL << DEPT_CXT_SIRQ) +#define DEPT_HIRQF (1UL << DEPT_CXT_HIRQ)struct dept_ecxt ;struct dept_iecxt {
@@ -95,8 +100,8 @@ struct dept_class {/* * for tracking IRQ dependencies */ -struct dept_iecxt iecxt[DEPT_IRQS_NR ]; -struct dept_iwait iwait[DEPT_IRQS_NR ]; +struct dept_iecxt iecxt[DEPT_CXT_IRQS_NR ]; +struct dept_iwait iwait[DEPT_CXT_IRQS_NR ];/* * classified by a map embedded in task_struct,
@@ -208,8 +213,8 @@ struct dept_ecxt {/* * where the IRQ-enabled happened */ -unsigned long enirq_ip[DEPT_IRQS_NR ]; -struct dept_stack *enirq_stack[DEPT_IRQS_NR ]; +unsigned long enirq_ip[DEPT_CXT_IRQS_NR ]; +struct dept_stack *enirq_stack[DEPT_CXT_IRQS_NR ];/* * where the event context started
@@ -253,8 +258,8 @@ struct dept_wait {/* * where the IRQ wait happened */ -unsigned long irq_ip[DEPT_IRQS_NR ]; -struct dept_stack *irq_stack[DEPT_IRQS_NR ]; +unsigned long irq_ip[DEPT_CXT_IRQS_NR ]; +struct dept_stack *irq_stack[DEPT_CXT_IRQS_NR ];/* * where the wait happened
@@ -384,6 +389,7 @@ extern void dept_event(struct dept_map *m, unsigned long e_f, unsigned long ip,extern void dept_ecxt_exit (struct dept_map *m,unsigned long e_f,unsigned long ip);extern void dept_sched_enter (void );extern void dept_sched_exit (void ); +extern void dept_update_cxt (void );static inline void dept_ecxt_enter_nokeep (struct dept_map *m) {
@@ -431,6 +437,7 @@ struct dept_map { };#define dept_ecxt_exit (m, e_f, ip) do { } while (0)#define dept_sched_enter () do { } while (0)#define dept_sched_exit () do { } while (0) +#define dept_update_cxt () do { } while (0)#define dept_ecxt_enter_nokeep (m) do { } while (0)#define dept_key_init (k) do { (void)(k); } while (0)#define dept_key_destroy (k) do { (void)(k); } while (0)
include/linux/sched.h +5 -5
@@ -830,19 +830,19 @@ struct dept_task {int wait_hist_pos;/* -* sequential id to identify each IRQ context +* sequential id to identify each context */ -unsigned int irq_id[DEPT_IRQS_NR ]; +unsigned int cxt_id[DEPT_CXTS_NR ];/* * for tracking IRQ-enabled points with cross-event */ -unsigned int wgen_enirq[DEPT_IRQS_NR ]; +unsigned int wgen_enirq[DEPT_CXT_IRQS_NR ];/* * for keeping up-to-date IRQ-enabled points */ -unsigned long enirq_ip[DEPT_IRQS_NR ]; +unsigned long enirq_ip[DEPT_CXT_IRQS_NR ];/* * for reserving a current stack instance at each operation
@@ -896,7 +896,7 @@ struct dept_task { .wait_hist = { { .wait = NULL, } }, \ .ecxt_held_pos = 0, \ .wait_hist_pos = 0, \ - .irq_id = { 0U }, \ + .cxt_id = { 0U }, \ .wgen_enirq = { 0U }, \ .enirq_ip = { 0UL }, \ .stack = NULL, \
kernel/dependency/dept.c +34 -33
197 lines not on this page · raw message
lib/Kconfig.debug +4 -1
@@ -1365,9 +1365,12 @@ config DEBUG_PREEMPT menu "Lock Debugging (spinlocks, mutexes, etc...)" +config ARCH_HAS_DEPT_SUPPORT + bool + config DEPT bool "Dependency tracking (EXPERIMENTAL)" - depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT + depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT && ARCH_HAS_DEPT_SUPPORT select DEBUG_SPINLOCK select DEBUG_MUTEXES if !PREEMPT_RT select DEBUG_RT_MUTEXES if RT_MUTEXES
Signature · 1 line
2.17.1
PATCH v17 8/47 x86_64, dept: add support CONFIG_ARCH_HAS_DEPT_SUPPORT to x86_64
In reply to Byungchul Parkdept needs to notice every entrance from user to kernel mode to treat every kernel context independently when tracking wait-event dependencies. Roughly, system call and user oriented fault are the cases.
Make dept aware of the entrances of x86_64 and add support CONFIG_ARCH_HAS_DEPT_SUPPORT to x86_64.
--- arch/x86/Kconfig | 1 + arch/x86/entry/syscall_64.c | 7 +++++++ arch/x86/mm/fault.c | 7 +++++++ 3 files changed, 15 insertions(+)
arch/x86/Kconfig +1 -0
@@ -38,6 +38,7 @@ config X86_64 select ZONE_DMA32 select EXECMEM if DYNAMIC_FTRACE select ACPI_MRRM if ACPI + select ARCH_HAS_DEPT_SUPPORT config FORCE_DYNAMIC_FTRACE def_bool y
arch/x86/entry/syscall_64.c +7 -0
@@ -8,6 +8,7 @@#include <linux/entry-common.h> #include <linux/nospec.h> #include <asm/syscall.h> +#include <linux/dept.h> #define __SYSCALL (nr, sym) extern long __x64_##sym(const struct pt_regs *);#define __SYSCALL_NORETURN (nr, sym) extern long __noreturn __x64_##sym(const struct pt_regs *);
@@ -86,6 +87,12 @@ static __always_inline bool do_syscall_x32(struct pt_regs *regs, int nr)/* Returns true to return using SYSRET, or false to use IRET */ __visible noinstr bool do_syscall_64(struct pt_regs *regs, int nr) { +/* +* This is a system call from user mode. Make dept work with a +* new kernel mode context. +*/ +dept_update_cxt (); +add_random_kstack_offset (); nr =syscall_enter_from_user_mode (regs, nr);
arch/x86/mm/fault.c +7 -0
@@ -19,6 +19,7 @@#include <linux/mm_types.h> #include <linux/mm.h> /* find_and_lock_vma() */ #include <linux/vmalloc.h> +#include <linux/dept.h> #include <asm/cpufeature.h> /* boot_cpu_has, ... */ #include <asm/traps.h> /* dotraplinkage, ... */
@@ -1219,6 +1220,12 @@ void do_user_addr_fault(struct pt_regs *regs, tsk = current; mm = tsk->mm; +/* +* This fault comes from user mode. Make dept work with a new +* kernel mode context. +*/ +dept_update_cxt (); +if (unlikely ((error_code & (X86_PF_USER |X86_PF_INSTR )) ==X86_PF_INSTR )) {/* * Whoops, this is kernel mode code trying to execute from
Signature · 1 line
2.17.1
Re: [PATCH v17 08/47] x86_64, dept: add support CONFIG_ARCH_HAS_DEPT_SUPPORT to x86_64
Quoted 3 lines · Byungchul Park
dept needs to notice every entrance from user to kernel mode to treat every kernel context independently when tracking wait-event dependencies. Roughly, system call and user oriented fault are the cases.
"Roughly"?
Quoted 4 lines
#define
__SYSCALL(nr, sym)extern long __x64_##sym(const structpt_regs*); #define__SYSCALL_NORETURN(nr, sym)extern long__noreturn__x64_##sym(const structpt_regs*);arch/x86/entry/syscall_64.c +0
-0@@ -86,6 +87,12 @@ static __always_inline bool do_syscall_x32(struct pt_regs *regs, int nr)/* Returns true to return using SYSRET, or false to use IRET */
arch/x86/entry/syscall_64.c static __always_inline bool do_syscall_x32(struct pt_regs *regs, int nr) · line 97
Quoted 10 lines
arch/x86/entry/syscall_64.c +6
-0__visible noinstr bool do_syscall_64(struct pt_regs *regs, int nr) { +/* +* This is a system call from user mode. Make dept work with a +* new kernel mode context. +*/ +dept_update_cxt (); +add_random_kstack_offset (); nr =syscall_enter_from_user_mode (regs, nr);
Please take a look in syscall_enter_from_user_mode(). You'll see the quite nicely-named function: enter_from_user_mode(). That might be a nice place to put code that you want to run when the kernel is entered from user mode.
Quoted 13 lines
arch/x86/mm/fault.c +1
-0@@ -19,6 +19,7 @@#include <linux/mm_types.h> #include <linux/mm.h> /* find_and_lock_vma() */ #include <linux/vmalloc.h> +#include <linux/dept.h> #include <asm/cpufeature.h> /* boot_cpu_has, ... */ #include <asm/traps.h> /* dotraplinkage, ... */
arch/x86/mm/fault.c void do_user_addr_fault(struct pt_regs *regs, · line 1227
Quoted 8 lines
arch/x86/mm/fault.c +5
-0@@ -1219,6 +1220,12 @@ void do_user_addr_fault(struct pt_regs *regs, tsk = current; mm = tsk->mm; +/* +* This fault comes from user mode. Make dept work with a new +* kernel mode context. +*/ +dept_update_cxt ();
No, this fault does not come from user mode. That's why we call it "user addr" fault, not "user mode" fault. You end up here if, for instance, the kernel faults doing a copy_from_user().
Re: [PATCH v17 08/47] x86_64, dept: add support CONFIG_ARCH_HAS_DEPT_SUPPORT to x86_64
Quoted 6 lines · Dave Hansen
Quoted 3 lines · Byungchul Park
dept needs to notice every entrance from user to kernel mode to treat every kernel context independently when tracking wait-event dependencies. Roughly, system call and user oriented fault are the cases.
"Roughly"?
I will change it to a better one.
Quoted 11 lines
Quoted 11 lines
#define
__SYSCALL(nr, sym)extern long __x64_##sym(const structpt_regs*); #define__SYSCALL_NORETURN(nr, sym)extern long__noreturn__x64_##sym(const structpt_regs*);arch/x86/entry/syscall_64.c +5
-0@@ -86,6 +87,12 @@ static __always_inline bool do_syscall_x32(struct pt_regs *regs, int nr)/* Returns true to return using SYSRET, or false to use IRET */ __visible noinstr bool do_syscall_64(struct pt_regs *regs, int nr) { +/* +* This is a system call from user mode. Make dept work with a +* new kernel mode context. +*/ +dept_update_cxt ();
Quoted 8 lines
arch/x86/entry/syscall_64.c static __always_inline bool do_syscall_x32(struct pt_regs *regs, int nr) · line 97
Quoted 3 lines
arch/x86/entry/syscall_64.c +1
-0+add_random_kstack_offset (); nr =syscall_enter_from_user_mode (regs, nr);Please take a look in
syscall_enter_from_user_mode(). You'll see the quite nicely-named function:enter_from_user_mode(). That might be a nice place to put code that you want to run when the kernel is entered from user mode.
I wanted to put dept_update_cxt() to the very beginning of c code but.. yeah enter_from_user_mode() looks fine or even better. Thanks a lot.
Quoted 16 lines
Quoted 16 lines
arch/x86/mm/fault.c +1
-0@@ -19,6 +19,7 @@#include <linux/mm_types.h> #include <linux/mm.h> /* find_and_lock_vma() */ #include <linux/vmalloc.h> +#include <linux/dept.h> #include <asm/cpufeature.h> /* boot_cpu_has, ... */ #include <asm/traps.h> /* dotraplinkage, ... */ @@ -1219,6 +1220,12 @@ void do_user_addr_fault(struct pt_regs *regs, tsk = current; mm = tsk->mm;
Quoted 8 lines
arch/x86/mm/fault.c void do_user_addr_fault(struct pt_regs *regs, · line 1227
Quoted 5 lines
arch/x86/mm/fault.c +5
-0+/* +* This fault comes from user mode. Make dept work with a new +* kernel mode context. +*/ +dept_update_cxt ();No, this fault does not come from user mode. That's why we call it "user addr" fault, not "user mode" fault. You end up here if, for instance, the kernel faults doing a
copy_from_user().
My bad. Thank you. I will fix it. Thank you very much.
Byungchul
PATCH v17 9/47 arm64, dept: add support CONFIG_ARCH_HAS_DEPT_SUPPORT to arm64
In reply to Byungchul Parkdept needs to notice every entrance from user to kernel mode to treat every kernel context independently when tracking wait-event dependencies. Roughly, system call and user oriented fault are the cases.
Make dept aware of the entrances of arm64 and add support CONFIG_ARCH_HAS_DEPT_SUPPORT to arm64.
--- arch/arm64/Kconfig | 1 + arch/arm64/kernel/syscall.c | 7 +++++++ arch/arm64/mm/fault.c | 7 +++++++ 3 files changed, 15 insertions(+)
arch/arm64/Kconfig +1 -0
@@ -281,6 +281,7 @@ config ARM64 select USER_STACKTRACE_SUPPORT select VDSO_GETRANDOM select VMAP_STACK + select ARCH_HAS_DEPT_SUPPORT help ARM 64-bit (AArch64) Linux support.
arch/arm64/kernel/syscall.c +7 -0
@@ -7,6 +7,7 @@#include <linux/ptrace.h> #include <linux/randomize_kstack.h> #include <linux/syscalls.h> +#include <linux/dept.h> #include <asm/debug-monitors.h> #include <asm/exception.h>
@@ -96,6 +97,12 @@ static void el0_svc_common(struct pt_regs *regs, int scno, int sc_nr,* (Similarly for HVC and SMC elsewhere.) */ +/* +* This is a system call from user mode. Make dept work with a +* new kernel mode context. +*/ +dept_update_cxt (); +if (flags & _TIF_MTE_ASYNC_FAULT) {/* * Process the asynchronous tag check fault before the actual
arch/arm64/mm/fault.c +7 -0
@@ -26,6 +26,7 @@#include <linux/pkeys.h> #include <linux/preempt.h> #include <linux/hugetlb.h> +#include <linux/dept.h> #include <asm/acpi.h> #include <asm/bug.h>
@@ -622,6 +623,12 @@ static int __kprobes do_page_fault(unsigned long far, unsigned long esr,if (!(mm_flags &FAULT_FLAG_USER )) goto lock_mmap; +/* +* This fault comes from user mode. Make dept work with a new +* kernel mode context. +*/ +dept_update_cxt (); + vma =lock_vma_under_rcu (mm, addr);if (!vma) goto lock_mmap;
Signature · 1 line
2.17.1
Re: [PATCH v17 09/47] arm64, dept: add support CONFIG_ARCH_HAS_DEPT_SUPPORT to arm64
Quoted 6 lines · Byungchul Park
dept needs to notice every entrance from user to kernel mode to treat every kernel context independently when tracking wait-event dependencies. Roughly, system call and user oriented fault are the cases.
Make dept aware of the entrances of arm64 and add support
CONFIG_ARCH_HAS_DEPT_SUPPORTto arm64.
The description of what needs to be tracked probably needs some tightening up here, it's not clear to me for example why exceptions for mops or the vector extensions aren't included here, or what the distinction is with error faults like BTI or GCS not being tracked?
Re: [PATCH v17 09/47] arm64, dept: add support CONFIG_ARCH_HAS_DEPT_SUPPORT to arm64
Quoted 5 lines · Mark Brown
Quoted 4 lines · Byungchul Park
dept needs to notice every entrance from user to kernel mode to treat every kernel context independently when tracking wait-event dependencies. Roughly, system call and user oriented fault are the cases.
Quoted 7 lines
Quoted 2 lines
Make dept aware of the entrances of arm64 and add support
CONFIG_ARCH_HAS_DEPT_SUPPORTto arm64.The description of what needs to be tracked probably needs some tightening up here, it's not clear to me for example why exceptions for mops or the vector extensions aren't included here, or what the distinction is with error faults like BTI or GCS not being tracked?
Thanks for the feedback but I'm afraid I don't get you. Can you explain in more detail with example?
JFYI, pairs of wait and its event need to be tracked to see if each event can be prevented from being reachable by other waits like:
context X context Y
lock L
...
initiate event A context start toward event A
... ...
wait A // wait for event A and lock L // wait for unlock L and
// prevent unlock L // prevent event A ... ... unlock L unlock L ... event A
I meant things like this need to be tracked.
Byungchul
Re: [PATCH v17 09/47] arm64, dept: add support CONFIG_ARCH_HAS_DEPT_SUPPORT to arm64
Quoted 9 lines · Byungchul Park
Quoted 7 lines · Mark Brown
Quoted 6 lines · Byungchul Park
dept needs to notice every entrance from user to kernel mode to treat every kernel context independently when tracking wait-event dependencies. Roughly, system call and user oriented fault are the cases.
Make dept aware of the entrances of arm64 and add support
CONFIG_ARCH_HAS_DEPT_SUPPORTto arm64.
Quoted 7 lines
Quoted 4 lines
The description of what needs to be tracked probably needs some tightening up here, it's not clear to me for example why exceptions for mops or the vector extensions aren't included here, or what the distinction is with error faults like BTI or GCS not being tracked?
Thanks for the feedback but I'm afraid I don't get you. Can you explain in more detail with example?
Your commit log says we need to track every entrance from user mode to kernel mode but the code only adds tracking to syscalls and some memory faults. The exception types listed above (and some others) also result in entries to the kernel from userspace.
Quoted 16 lines
JFYI, pairs of wait and its event need to be tracked to see if each event can be prevented from being reachable by other waits like:
context X context Y lock L ... initiate event A context start toward event A ... ... wait A // wait for event A and lock L // wait for unlock L and // prevent unlock L // prevent event A ... ... unlock L unlock L ... event A
Quoted 1 line
I meant things like this need to be tracked.
I don't think that's at all clear from the above context, and the handling for some of the above exception types (eg, the vector extensions) includes taking locks.
Re: [PATCH v17 09/47] arm64, dept: add support CONFIG_ARCH_HAS_DEPT_SUPPORT to arm64
Quoted 15 lines · Mark Brown
Quoted 13 lines · Byungchul Park
Quoted 12 lines · Mark Brown
Quoted 6 lines · Byungchul Park
dept needs to notice every entrance from user to kernel mode to treat every kernel context independently when tracking wait-event dependencies. Roughly, system call and user oriented fault are the cases.
Make dept aware of the entrances of arm64 and add support
CONFIG_ARCH_HAS_DEPT_SUPPORTto arm64.The description of what needs to be tracked probably needs some tightening up here, it's not clear to me for example why exceptions for mops or the vector extensions aren't included here, or what the distinction is with error faults like BTI or GCS not being tracked?
Quoted 7 lines
Quoted 2 lines
Thanks for the feedback but I'm afraid I don't get you. Can you explain in more detail with example?
Your commit log says we need to track every entrance from user mode to kernel mode but the code only adds tracking to syscalls and some memory faults. The exception types listed above (and some others) also result in entries to the kernel from userspace.
You're right. Each kernel mode context needs to be tracked independently. Just for your information, context ID is used for making DEPT only track waits and events within each context, preventing tracking those across independent contexts to avoid false positives.
Currently, irq, fault, and system calls are covered. It should be taken into account if any other exceptions can include waits and events anyway.
Quoted 16 lines
Quoted 15 lines
JFYI, pairs of wait and its event need to be tracked to see if each event can be prevented from being reachable by other waits like:
context X context Y lock L ... initiate event A context start toward event A ... ... wait A // wait for event A and lock L // wait for unlock L and // prevent unlock L // prevent event A ... ... unlock L unlock L ... event A
Quoted 5 lines
Quoted 1 line
I meant things like this need to be tracked.
I don't think that's at all clear from the above context, and the handling for some of the above exception types (eg, the vector extensions) includes taking locks.
A trivial thing to mention, each typical lock pair, lock and unlock, can only happen within each independent context, not across different contexts. So the context ID is not necessary for typical locks.
exception X
lock A;
...
unlock A; // already guarateed to unlock A in the context that lock A
// has been acqured in.
...
finish exception X and return back to user mode;
But yes, as you concern, we should take into account all the exceptions if any can include general waits and events in it, to avoid unnecessary false positives.
Thank you!
Byungchul
Mark Rutland
reviewerRe: [PATCH v17 09/47] arm64, dept: add support CONFIG_ARCH_HAS_DEPT_SUPPORT to arm64
In reply to Byungchul ParkQuoted 39 lines · Byungchul Park
dept needs to notice every entrance from user to kernel mode to treat every kernel context independently when tracking wait-event dependencies. Roughly, system call and user oriented fault are the cases.
Make dept aware of the entrances of arm64 and add support
CONFIG_ARCH_HAS_DEPT_SUPPORTto arm64.Signed-off-by Byungchul Park <[email protected]>--- arch/arm64/Kconfig | 1 + arch/arm64/kernel/syscall.c | 7 +++++++ arch/arm64/mm/fault.c | 7 +++++++ 3 files changed, 15 insertions(+)arch/arm64/Kconfig +1
-0@@ -281,6 +281,7 @@ config ARM64 select USER_STACKTRACE_SUPPORT select VDSO_GETRANDOM select VMAP_STACK + select ARCH_HAS_DEPT_SUPPORT help ARM 64-bit (AArch64) Linux support.arch/arm64/kernel/syscall.c +1
-0@@ -7,6 +7,7 @@#include <linux/ptrace.h> #include <linux/randomize_kstack.h> #include <linux/syscalls.h> +#include <linux/dept.h> #include <asm/debug-monitors.h> #include <asm/exception.h>
arch/arm64/kernel/syscall.c static void el0_svc_common(struct pt_regs *regs, int scno, int sc_nr, · line 104
Quoted 8 lines
arch/arm64/kernel/syscall.c +5
-0@@ -96,6 +97,12 @@ static void el0_svc_common(struct pt_regs *regs, int scno, int sc_nr,* (Similarly for HVC and SMC elsewhere.) */ +/* +* This is a system call from user mode. Make dept work with a +* new kernel mode context. +*/ +dept_update_cxt ();
As Mark Brown pointed out in his replies, this patch is missing a whole bunch of cases and does not work correctly as-is.
As Dave Hansen pointed out on the x86 patch, you shouldn't do this piecemeal in architecture code, and should instead work with the existing context tracking, e.g. by adding logic to enter_from_user_mode() and exit_to_user_mode(), or by reusing some existing context tracking logic that's called there.
Mark.
Re: [PATCH v17 09/47] arm64, dept: add support CONFIG_ARCH_HAS_DEPT_SUPPORT to arm64
Quoted 52 lines · Mark Rutland
Quoted 39 lines · Byungchul Park
dept needs to notice every entrance from user to kernel mode to treat every kernel context independently when tracking wait-event dependencies. Roughly, system call and user oriented fault are the cases.
Make dept aware of the entrances of arm64 and add support
CONFIG_ARCH_HAS_DEPT_SUPPORTto arm64.Signed-off-by Byungchul Park <[email protected]>--- arch/arm64/Kconfig | 1 + arch/arm64/kernel/syscall.c | 7 +++++++ arch/arm64/mm/fault.c | 7 +++++++ 3 files changed, 15 insertions(+)arch/arm64/Kconfig +1
-0@@ -281,6 +281,7 @@ config ARM64 select USER_STACKTRACE_SUPPORT select VDSO_GETRANDOM select VMAP_STACK + select ARCH_HAS_DEPT_SUPPORT help ARM 64-bit (AArch64) Linux support.arch/arm64/kernel/syscall.c +1
-0@@ -7,6 +7,7 @@#include <linux/ptrace.h> #include <linux/randomize_kstack.h> #include <linux/syscalls.h> +#include <linux/dept.h> #include <asm/debug-monitors.h> #include <asm/exception.h> arch/arm64/kernel/syscall.c static void el0_svc_common(struct pt_regs *regs, int scno, int sc_nr, · line 104
Quoted 8 lines
arch/arm64/kernel/syscall.c +5
-0@@ -96,6 +97,12 @@ static void el0_svc_common(struct pt_regs *regs, int scno, int sc_nr,* (Similarly for HVC and SMC elsewhere.) */ +/* +* This is a system call from user mode. Make dept work with a +* new kernel mode context. +*/ +dept_update_cxt ();As Mark Brown pointed out in his replies, this patch is missing a whole bunch of cases and does not work correctly as-is.
Quoted 4 lines
As Dave Hansen pointed out on the x86 patch, you shouldn't do this piecemeal in architecture code, and should instead work with the existing context tracking, e.g. by adding logic to
enter_from_user_mode()andexit_to_user_mode(), or by reusing some
I will consider it. However, I need to check if there are not any waits and events before enter_from_user_mode(), or after exit_to_user_mode() since those functions aren't the outmost functions for kernel mode C code anyway.
Byungchul
Quoted 3 lines
existing context tracking logic that's called there.
Mark.
PATCH v17 10/47 dept: distinguish each work from another
In reply to Byungchul ParkWorkqueue already provides concurrency control. By that, any wait in a work doesn't prevents events in other works with the control enabled. Thus, each work would better be considered a different context.
So let dept assign a different context id to each work.
--- kernel/workqueue.c | 3 +++ 1 file changed, 3 insertions(+)
kernel/workqueue.c +3 -0
@@ -55,6 +55,7 @@#include <linux/kvm_para.h> #include <linux/delay.h> #include <linux/irq_work.h> +#include <linux/dept.h> #include "workqueue_internal.h"
@@ -3153,6 +3154,8 @@ __acquires(&pool->lock)lockdep_copy_map (&lockdep_map, &work->lockdep_map);#endif +dept_update_cxt (); +/* ensure we're on the correct CPU */ WARN_ON_ONCE (!(pool->flags &POOL_DISASSOCIATED ) &&raw_smp_processor_id () != pool->cpu);
Signature · 1 line
2.17.1
PATCH v17 11/47 dept: add a mechanism to refill the internal memory pools on running out
In reply to Byungchul Parkdept engine works in a constrained environment. For example, dept cannot make use of dynamic allocation e.g. kmalloc(). So dept has been using static pools to keep memory chunks dept uses.
However, dept would barely work once any of the pools gets run out. So implemented a mechanism for the refill on the lack, using irq work and workqueue that fits on the contrained environment.
--- kernel/dependency/dept.c | 108 +++++++++++++++++++++++++----- kernel/dependency/dept_internal.h | 19 ++++-- kernel/dependency/dept_object.h | 10 +-- kernel/dependency/dept_proc.c | 8 +-- 4 files changed, 116 insertions(+), 29 deletions(-)
kernel/dependency/dept.c +93 -15
@@ -75,6 +75,9 @@#include <linux/dept.h> #include <linux/utsname.h> #include <linux/kernel.h> +#include <linux/workqueue.h> +#include <linux/irq_work.h> +#include <linux/vmalloc.h> #include "dept_internal.h" static int dept_stop;
@@ -143,9 +146,11 @@ static inline struct dept_task *dept_task(void) } \ }) -#define DEPT_INFO_ONCE(s...) pr_warn_once("DEPT_INFO_ONCE: " s) +#define DEPT_INFO_ONCE(s...) pr_warn_once("DEPT_INFO_ONCE: " s) +#define DEPT_INFO(s...) pr_warn("DEPT_INFO: " s)static arch_spinlock_t dept_spin = (arch_spinlock_t )__ARCH_SPIN_LOCK_UNLOCKED; +static arch_spinlock_t dept_pool_spin = (arch_spinlock_t )__ARCH_SPIN_LOCK_UNLOCKED;/* * DEPT internal engine should be cautious in using outside functions
@@ -268,6 +273,7 @@ static bool valid_key(struct dept_key *k)#define OBJECT (id, nr) \ static struct dept_##id spool_##id[nr]; \ +static struct dept_##id rpool_##id[nr]; \ static DEFINE_PER_CPU(struct llist_head, lpool_##id);#include "dept_object.h" #undef OBJECT
@@ -276,14 +282,74 @@ struct dept_pool dept_pool[OBJECT_NR] = {#define OBJECT (id, nr) { \ .name = #id, \ .obj_sz = sizeof(struct dept_##id), \ - .obj_nr = ATOMIC_INIT(nr), \ + .obj_nr = nr, \ + .tot_nr = nr, \ + .acc_sz = ATOMIC_INIT(sizeof(spool_##id) + sizeof(rpool_##id)), \ .node_off = offsetof(struct dept_##id, pool_node), \ .spool = spool_##id, \ + .rpool = rpool_##id, \ .lpool = &lpool_##id, },#include "dept_object.h" #undef OBJECT }; +static void dept_wq_work_fn (struct work_struct *work) +{ +int i; + +for (i =0 ; i <OBJECT_NR ; i++) { +struct dept_pool *p = dept_pool + i; +int sz = p->tot_nr * p->obj_sz; +void *rpool; +bool need; + +local_irq_disable (); +arch_spin_lock (&dept_pool_spin); + need = !p->rpool; +arch_spin_unlock (&dept_pool_spin); +local_irq_enable (); + +if (!need) +continue ; + + rpool =vmalloc (sz); + +if (!rpool) { +DEPT_STOP ("Failed to extend internal resources.\n" ); +break ; + } + +local_irq_disable (); +arch_spin_lock (&dept_pool_spin); +if (!p->rpool) { + p->rpool = rpool; + rpool =NULL ; +atomic_add (sz, &p->acc_sz); + } +arch_spin_unlock (&dept_pool_spin); +local_irq_enable (); + +if (rpool) +vfree (rpool); +else +DEPT_INFO ("Dept object(%s) just got refilled successfully.\n" , p->name); + } +} + +static DECLARE_WORK(dept_wq_work, dept_wq_work_fn); + +static void dept_irq_work_fn (struct irq_work *w) +{ +schedule_work (&dept_wq_work); +} + +static DEFINE_IRQ_WORK(dept_irq_work, dept_irq_work_fn); + +static void request_rpool_refill (void ) +{ +irq_work_queue (&dept_irq_work); +} +/* * Can use llist no matter whether CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG is * enabled or not because NMI and other contexts in the same CPU never
@@ -319,19 +385,31 @@ static void *from_pool(enum object_t t)/* * Try static pool. */ -if (atomic_read (&p->obj_nr) >0 ) { -int idx =atomic_dec_return (&p->obj_nr); +arch_spin_lock (&dept_pool_spin); + +if (!p->obj_nr) { + p->spool = p->rpool; + p->obj_nr = p->rpool ? p->tot_nr :0 ; + p->rpool =NULL ; +request_rpool_refill (); + } + +if (p->obj_nr) { +void *ret; + + p->obj_nr--; + ret = p->spool + (p->obj_nr * p->obj_sz); +arch_spin_unlock (&dept_pool_spin); -if (idx >=0 ) -return p->spool + (idx * p->obj_sz); +return ret; } +arch_spin_unlock (&dept_pool_spin); -DEPT_INFO_ONCE ("---------------------------------------------\n" -" Some of Dept internal resources are run out.\n" -" Dept might still work if the resources get freed.\n" -" However, the chances are Dept will suffer from\n" -" the lack from now. Needs to extend the internal\n" -" resource pools. Ask [email protected]\n" ); +DEPT_INFO ("------------------------------------------\n" +" Dept object(%s) is run out.\n" +" Dept is trying to refill the object.\n" +" Nevertheless, if it fails, Dept will stop.\n" , + p->name);return NULL ; }
@@ -2957,8 +3035,8 @@ void __init dept_init(void)pr_info ("... DEPT_MAX_ECXT_HELD : %d\n" ,DEPT_MAX_ECXT_HELD );pr_info ("... DEPT_MAX_SUBCLASSES : %d\n" ,DEPT_MAX_SUBCLASSES );#define OBJECT (id, nr) \ - pr_info("... memory used by %s: %zu KB\n", \ - #id, B2KB(sizeof(struct dept_##id) * nr)); + pr_info("... memory initially used by %s: %zu KB\n", \ + #id, B2KB(sizeof(spool_##id) + sizeof(rpool_##id)));#include "dept_object.h" #undef OBJECT#define HASH (id, bits) \
@@ -2966,6 +3044,6 @@ void __init dept_init(void)#id , B2KB(sizeof(struct hlist_head) * (1 << (bits))));#include "dept_hash.h" #undef HASH -pr_info ("... total memory used by objects and hashs: %zu KB\n" ,B2KB (mem_total)); +pr_info ("... total memory initially used by objects and hashs: %zu KB\n" ,B2KB (mem_total));pr_info ("... per task memory footprint: %zu bytes\n" ,sizeof (struct dept_task )); }
kernel/dependency/dept_internal.h +15 -4
@@ -23,9 +23,19 @@ struct dept_pool {size_t obj_sz;/* -* the number of the static array +* the remaining number of the object in spool */ -atomic_t obj_nr; +int obj_nr; + +/* +* the number of the object in spool +*/ +int tot_nr; + +/* +* accumulated amount of memory used by the object in byte +*/ +atomic_t acc_sz;/* * offset of ->pool_node
@@ -35,9 +45,10 @@ struct dept_pool {/* * pointer to the pool */ -void *spool; +void *spool;/* static pool */ +void *rpool;/* reserved pool */ struct llist_head boot_pool; -struct llist_head __percpu *lpool; +struct llist_head __percpu *lpool;/* local pool */ };enum object_t {
kernel/dependency/dept_object.h +5 -5
@@ -6,8 +6,8 @@* nr: # of the object that should be kept in the pool. */ -OBJECT(dep, 1024 * 8) -OBJECT(class, 1024 * 8) -OBJECT(stack, 1024 * 32) -OBJECT(ecxt, 1024 * 16) -OBJECT (wait,1024 *32 ) +OBJECT(dep, 1024 * 4 * 2) +OBJECT(class, 1024 * 4) +OBJECT(stack, 1024 * 4 * 8) +OBJECT(ecxt, 1024 * 4 * 2) +OBJECT (wait,1024 *4 *4 )
kernel/dependency/dept_proc.c +3 -5
@@ -74,12 +74,10 @@ static int dept_stats_show(struct seq_file *m, void *v) {int r; -seq_puts (m,"Availability in the static pools:\n\n" ); +seq_puts (m,"Accumulated amount of memory used by pools:\n\n" );#define OBJECT (id, nr) \ - r = atomic_read(&dept_pool[OBJECT_##id].obj_nr); \ - if (r < 0) \ - r = 0; \ - seq_printf(m, "%s\t%d/%d(%d%%)\n", #id, r, nr, (r * 100) / (nr)); + r = atomic_read(&dept_pool[OBJECT_##id].acc_sz); \ + seq_printf(m, "%s\t%d KB\n", #id, r / 1024);#include "dept_object.h" #undef OBJECT
Signature · 1 line
2.17.1
PATCH v17 12/47 dept: record the latest one out of consecutive waits of the same class
In reply to Byungchul ParkThe current code records all the waits for later use to track relation between waits and events within each context. However, since the same class is handled the same way, it'd be okay to record only one on behalf of the others if they all have the same class.
Even though it's the ideal to search the whole history buffer for that, since it'd cost too high, alternatively, let's keep the latest one when the same class'ed waits consecutively appear.
--- kernel/dependency/dept.c | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-)
kernel/dependency/dept.c +20 -1
@@ -1486,9 +1486,28 @@ static struct dept_wait_hist *new_hist(void)return wh; } +static struct dept_wait_hist *last_hist (void ) +{ +int pos_n =hist_pos_next (); +struct dept_wait_hist *wh_n =hist (pos_n); + +/* +* This is the first try. +*/ +if (!pos_n && !wh_n->wait) +return NULL ; + +return hist (pos_n +DEPT_MAX_WAIT_HIST -1 ); +} +static void add_hist (struct dept_wait *w,unsigned int wg,unsigned int ctxt_id) { -struct dept_wait_hist *wh =new_hist (); +struct dept_wait_hist *wh; + + wh =last_hist (); + +if (!wh || wh->wait->class != w->class || wh->ctxt_id != ctxt_id) + wh =new_hist ();if (likely (wh->wait))put_wait (wh->wait);
Signature · 1 line
2.17.1
PATCH v17 13/47 dept: apply sdt_might_sleep_{start,end}() to wait_for_completion()/complete()
In reply to Byungchul ParkMake dept able to track dependencies by wait_for_completion()/complete().
--- include/linux/completion.h | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-)
include/linux/completion.h +25 -5
@@ -10,6 +10,7 @@*/ #include <linux/swait.h> +#include <linux/dept_sdt.h> /* * struct completion - structure used to maintain state for a "completion"
@@ -26,14 +27,33 @@struct completion {unsigned int done;struct swait_queue_head wait; +struct dept_map dmap; }; +#define init_completion (x) \ +do { \ + sdt_map_init(&(x)->dmap); \ + __init_completion(x); \ +} while (0) + +/* +* XXX: No use cases for now. Fill the body when needed. +*/ #define init_completion_map (x, m) init_completion(x) -static inline void complete_acquire (struct completion *x) {} -static inline void complete_release (struct completion *x) {} + +static inline void complete_acquire (struct completion *x) +{ +sdt_might_sleep_start (&x->dmap); +} + +static inline void complete_release (struct completion *x) +{ +sdt_might_sleep_end (); +}#define COMPLETION_INITIALIZER (work) \ - { 0, __SWAIT_QUEUE_HEAD_INITIALIZER((work).wait) } + { 0, __SWAIT_QUEUE_HEAD_INITIALIZER((work).wait), \ + .dmap = DEPT_MAP_INITIALIZER(work, NULL), }#define COMPLETION_INITIALIZER_ONSTACK_MAP (work, map) \ (*({ init_completion_map(&(work), &(map)); &(work); }))
@@ -75,13 +95,13 @@ static inline void complete_release(struct completion *x) {}#endif /** -* init_completion - Initialize a dynamically allocated completion +* __init_completion - Initialize a dynamically allocated completion * @x: pointer to completion structure that is to be initialized * * This inline function will initialize a dynamically created completion * structure. */ -static inline void init_completion (struct completion *x) +static inline void __init_completion (struct completion *x) { x->done =0 ;init_swait_queue_head (&x->wait);
Signature · 1 line
2.17.1
PATCH v17 14/47 dept: apply sdt_might_sleep_{start,end}() to swait
In reply to Byungchul ParkMake dept able to track dependencies by swaits.
--- include/linux/swait.h | 3 +++ 1 file changed, 3 insertions(+)
include/linux/swait.h +3 -0
@@ -6,6 +6,7 @@#include <linux/stddef.h> #include <linux/spinlock.h> #include <linux/wait.h> +#include <linux/dept_sdt.h> #include <asm/current.h> /*
@@ -161,6 +162,7 @@ extern void finish_swait(struct swait_queue_head *q, struct swait_queue *wait);struct swait_queue __wait; \long __ret = ret; \ \ +sdt_might_sleep_start (NULL ); \INIT_LIST_HEAD (&__wait.task_list); \for (;;) { \long __int =prepare_to_swait_event (&wq, &__wait, state);\
@@ -176,6 +178,7 @@ extern void finish_swait(struct swait_queue_head *q, struct swait_queue *wait); cmd; \ } \finish_swait (&wq, &__wait); \ +sdt_might_sleep_end (); \ __out: __ret; \ })
Signature · 1 line
2.17.1
PATCH v17 15/47 dept: apply sdt_might_sleep_{start,end}() to waitqueue wait
In reply to Byungchul ParkMake dept able to track dependencies by waitqueue waits.
--- include/linux/wait.h | 3 +++ 1 file changed, 3 insertions(+)
include/linux/wait.h +3 -0
@@ -7,6 +7,7 @@#include <linux/list.h> #include <linux/stddef.h> #include <linux/spinlock.h> +#include <linux/dept_sdt.h> #include <asm/current.h>
@@ -305,6 +306,7 @@ extern void init_wait_entry(struct wait_queue_entry *wq_entry, int flags);struct wait_queue_entry __wq_entry; \long __ret = ret;/* explicit shadow */ \ \ +sdt_might_sleep_start (NULL ); \init_wait_entry (&__wq_entry, exclusive ?WQ_FLAG_EXCLUSIVE :0 ); \for (;;) { \long __int =prepare_to_wait_event (&wq_head, &__wq_entry, state);\
@@ -323,6 +325,7 @@ extern void init_wait_entry(struct wait_queue_entry *wq_entry, int flags);break ; \ } \finish_wait (&wq_head, &__wq_entry); \ +sdt_might_sleep_end (); \ __out: __ret; \ })
Signature · 1 line
2.17.1
PATCH v17 16/47 dept: apply sdt_might_sleep_{start,end}() to hashed-waitqueue wait
In reply to Byungchul ParkMake dept able to track dependencies by hashed-waitqueue waits.
--- include/linux/wait_bit.h | 3 +++ 1 file changed, 3 insertions(+)
include/linux/wait_bit.h +3 -0
@@ -6,6 +6,7 @@* Linux wait-bit related types and methods: */ #include <linux/wait.h> +#include <linux/dept_sdt.h> struct wait_bit_key {unsigned long *flags;
@@ -257,6 +258,7 @@ extern wait_queue_head_t *__var_waitqueue(void *p);struct wait_bit_queue_entry __wbq_entry; \long __ret = ret;/* explicit shadow */ \ \ +sdt_might_sleep_start (NULL ); \init_wait_var_entry (&__wbq_entry, var, \ exclusive ?WQ_FLAG_EXCLUSIVE :0 ); \for (;;) { \
@@ -274,6 +276,7 @@ extern wait_queue_head_t *__var_waitqueue(void *p); cmd; \ } \finish_wait (__wq_head, &__wbq_entry.wq_entry); \ +sdt_might_sleep_end (); \ __out: __ret; \ })
Signature · 1 line
2.17.1
PATCH v17 17/47 dept: apply sdt_might_sleep_{start,end}() to dma fence
In reply to Byungchul ParkMake dept able to track dependencies by dma fence waits and signals.
--- drivers/dma-buf/dma-fence.c | 5 +++++ 1 file changed, 5 insertions(+)
drivers/dma-buf/dma-fence.c +5 -0
@@ -16,6 +16,7 @@#include <linux/dma-fence.h> #include <linux/sched/signal.h> #include <linux/seq_file.h> +#include <linux/dept_sdt.h> #define CREATE_TRACE_POINTS #include <trace/events/dma_fence.h>
@@ -800,6 +801,7 @@ dma_fence_default_wait(struct dma_fence *fence, bool intr, signed long timeout) cb.task = current;list_add (&cb.base.node, &fence->cb_list); +sdt_might_sleep_start (NULL );while (!test_bit (DMA_FENCE_FLAG_SIGNALED_BIT , &fence->flags) && ret >0 ) {if (intr)__set_current_state (TASK_INTERRUPTIBLE );
@@ -813,6 +815,7 @@ dma_fence_default_wait(struct dma_fence *fence, bool intr, signed long timeout)if (ret >0 && intr &&signal_pending (current)) ret = -ERESTARTSYS ; } +sdt_might_sleep_end ();if (!list_empty (&cb.base.node))list_del (&cb.base.node);
@@ -902,6 +905,7 @@ dma_fence_wait_any_timeout(struct dma_fence **fences, uint32_t count, } } +sdt_might_sleep_start (NULL );while (ret >0 ) {if (intr)set_current_state (TASK_INTERRUPTIBLE );
@@ -916,6 +920,7 @@ dma_fence_wait_any_timeout(struct dma_fence **fences, uint32_t count,if (ret >0 && intr &&signal_pending (current)) ret = -ERESTARTSYS ; } +sdt_might_sleep_end ();__set_current_state (TASK_RUNNING );
Signature · 1 line
2.17.1
PATCH v17 18/47 dept: track timeout waits separately with a new Kconfig
In reply to Byungchul ParkWaits with valid timeouts don't actually cause deadlocks. However, dept has been reporting the cases as well because it's worth informing the circular dependency for some cases where, for example, timeout is used to avoid a deadlock.
However, yes, there are also a lot of, even more, cases where timeout is used for its clear purpose and meant to be expired.
Report these as an information rather than warning DEADLOCK. Plus, introduce CONFIG_DEPT_AGGRESSIVE_TIMEOUT_WAIT Kconfig to make it optional so that any reports involving waits with timeouts can be turned on/off depending on the purpose.
--- include/linux/dept.h | 13 +++++--- include/linux/dept_ldt.h | 6 ++-- include/linux/dept_sdt.h | 13 +++++--- include/linux/sched.h | 2 ++ kernel/dependency/dept.c | 66 ++++++++++++++++++++++++++++++++++------ lib/Kconfig.debug | 10 ++++++ 6 files changed, 89 insertions(+), 21 deletions(-)
include/linux/dept.h +9 -4
@@ -271,6 +271,11 @@ struct dept_wait {* whether this wait is for commit in scheduler */ bool sched_sleep; + +/* +* whether a timeout is set +*/ +bool timeout; }; }; };
@@ -377,8 +382,8 @@ extern void dept_free_range(void *start, unsigned int sz);extern void dept_map_init (struct dept_map *m,struct dept_key *k,int sub_u,const char *n);extern void dept_map_reinit (struct dept_map *m,struct dept_key *k,int sub_u,const char *n);extern void dept_map_copy (struct dept_map *to,struct dept_map *from); -extern void dept_wait (struct dept_map *m,unsigned long w_f,unsigned long ip,const char *w_fn,int sub_l); -extern void dept_stage_wait (struct dept_map *m,struct dept_key *k,unsigned long ip,const char *w_fn); +extern void dept_wait (struct dept_map *m,unsigned long w_f,unsigned long ip,const char *w_fn,int sub_l,long timeout); +extern void dept_stage_wait (struct dept_map *m,struct dept_key *k,unsigned long ip,const char *w_fn,long timeout);extern void dept_request_event_wait_commit (void );extern void dept_clean_stage (void );extern void dept_ttwu_stage_wait (struct task_struct *t,unsigned long ip);
@@ -425,8 +430,8 @@ struct dept_map { };#define dept_map_init (m, k, su, n) do { (void)(n); (void)(k); } while (0)#define dept_map_reinit (m, k, su, n) do { (void)(n); (void)(k); } while (0)#define dept_map_copy (t, f) do { } while (0) -#define dept_wait (m, w_f, ip, w_fn, sl) do { (void)(w_fn); } while (0) -#define dept_stage_wait (m, k, ip, w_fn) do { (void)(k); (void)(w_fn); } while (0) +#define dept_wait (m, w_f, ip, w_fn, sl, t) do { (void)(w_fn); } while (0) +#define dept_stage_wait (m, k, ip, w_fn, t) do { (void)(k); (void)(w_fn); } while (0)#define dept_request_event_wait_commit () do { } while (0)#define dept_clean_stage () do { } while (0)#define dept_ttwu_stage_wait (t, ip) do { } while (0)
include/linux/dept_ldt.h +3 -3
@@ -28,7 +28,7 @@else if (t) \dept_ecxt_enter (m,LDT_EVT_L , i,"trylock" ,"unlock" , sl);\else { \ -dept_wait (m,LDT_EVT_L , i,"lock" , sl); \ +dept_wait (m,LDT_EVT_L , i,"lock" , sl, false); \dept_ecxt_enter (m,LDT_EVT_L , i,"lock" ,"unlock" , sl);\ } \ }while (0 )
@@ -40,7 +40,7 @@else if (t) \dept_ecxt_enter (m,LDT_EVT_R , i,"read_trylock" ,"read_unlock" , sl);\else { \ -dept_wait (m, q ?LDT_EVT_RW :LDT_EVT_W , i,"read_lock" , sl);\ +dept_wait (m, q ?LDT_EVT_RW :LDT_EVT_W , i,"read_lock" , sl, false);\dept_ecxt_enter (m,LDT_EVT_R , i,"read_lock" ,"read_unlock" , sl);\ } \ }while (0 )
@@ -52,7 +52,7 @@else if (t) \dept_ecxt_enter (m,LDT_EVT_W , i,"write_trylock" ,"write_unlock" , sl);\else { \ -dept_wait (m,LDT_EVT_RW , i,"write_lock" , sl); \ +dept_wait (m,LDT_EVT_RW , i,"write_lock" , sl, false);\dept_ecxt_enter (m,LDT_EVT_W , i,"write_lock" ,"write_unlock" , sl);\ } \ }while (0 )
include/linux/dept_sdt.h +8 -5
@@ -23,11 +23,12 @@#define sdt_map_init_key (m, k) dept_map_init(m, k, 0, #m) -#define sdt_wait (m) \ +#define sdt_wait_timeout (m, t) \ do { \ dept_request_event(m); \ - dept_wait(m, 1UL, _THIS_IP_, __func__, 0); \ + dept_wait(m, 1UL, _THIS_IP_, __func__, 0, t); \ } while (0) +#define sdt_wait (m) sdt_wait_timeout(m, -1L)/* * sdt_might_sleep() and its family will be committed in __schedule()
@@ -38,13 +39,13 @@/* * Use the code location as the class key if an explicit map is not used. */ -#define sdt_might_sleep_start (m) \ +#define sdt_might_sleep_start_timeout (m, t) \ do { \ struct dept_map *__m = m; \ static struct dept_key __key; \ - dept_stage_wait(__m, __m ? NULL : &__key, _THIS_IP_, __func__);\ + dept_stage_wait(__m, __m ? NULL : &__key, _THIS_IP_, __func__, t);\ } while (0) - +#define sdt_might_sleep_start (m) sdt_might_sleep_start_timeout(m, -1L)#define sdt_might_sleep_end () dept_clean_stage()#define sdt_ecxt_enter (m) dept_ecxt_enter(m, 1UL, _THIS_IP_, "start", "event", 0)
@@ -54,7 +55,9 @@#else /* !CONFIG_DEPT */ #define sdt_map_init (m) do { } while (0)#define sdt_map_init_key (m, k) do { (void)(k); } while (0) +#define sdt_wait_timeout (m, t) do { } while (0)#define sdt_wait (m) do { } while (0) +#define sdt_might_sleep_start_timeout (m, t) do { } while (0)#define sdt_might_sleep_start (m) do { } while (0)#define sdt_might_sleep_end () do { } while (0)#define sdt_ecxt_enter (m) do { } while (0)
include/linux/sched.h +2 -0
@@ -867,6 +867,7 @@ struct dept_task {bool stage_sched_map;const char *stage_w_fn;unsigned long stage_ip; +bool stage_timeout;arch_spinlock_t stage_lock;/*
@@ -907,6 +908,7 @@ struct dept_task { .stage_sched_map = false, \ .stage_w_fn = NULL, \ .stage_ip = 0UL, \ + .stage_timeout = false, \ .stage_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED,\ .missing_ecxt = 0, \ .hardirqs_enabled = false, \
kernel/dependency/dept.c +57 -9
171 lines not on this page · raw message
lib/Kconfig.debug +10 -0
@@ -1394,6 +1394,16 @@ config DEPT noting, to mitigate the impact by the false positives, multi reporting has been supported. +config DEPT_AGGRESSIVE_TIMEOUT_WAIT + bool "Aggressively track even timeout waits" + depends on DEPT + default n + help + Timeout wait doesn't contribute to a deadlock. However, + informing a circular dependency might be helpful for cases + that timeout is used to avoid a deadlock. Say N if you'd like + to avoid verbose reports. + config LOCK_DEBUGGING_SUPPORT bool depends on TRACE_IRQFLAGS_SUPPORT && STACKTRACE_SUPPORT && LOCKDEP_SUPPORT
Signature · 1 line
2.17.1
PATCH v17 19/47 dept: apply timeout consideration to wait_for_completion()/complete()
In reply to Byungchul ParkNow that CONFIG_DEPT_AGGRESSIVE_TIMEOUT_WAIT was introduced, apply the consideration to wait_for_completion()/complete().
--- include/linux/completion.h | 4 ++-- kernel/sched/completion.c | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-)
include/linux/completion.h +2 -2
@@ -41,9 +41,9 @@ do { \*/ #define init_completion_map (x, m) init_completion(x) -static inline void complete_acquire (struct completion *x) +static inline void complete_acquire (struct completion *x,long timeout) { -sdt_might_sleep_start (&x->dmap); +sdt_might_sleep_start_timeout (&x->dmap, timeout); }static inline void complete_release (struct completion *x)
kernel/sched/completion.c +1 -1
@@ -115,7 +115,7 @@ __wait_for_common(struct completion *x, {might_sleep (); -complete_acquire (x); +complete_acquire (x, timeout);raw_spin_lock_irq (&x->wait.lock); timeout =do_wait_for_common (x, action, timeout, state);
Signature · 1 line
2.17.1
PATCH v17 20/47 dept: apply timeout consideration to swait
In reply to Byungchul ParkNow that CONFIG_DEPT_AGGRESSIVE_TIMEOUT_WAIT was introduced, apply the consideration to swait, assuming an input 'ret' in ___swait_event() macro is used as a timeout value.
--- include/linux/swait.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/swait.h +1 -1
@@ -162,7 +162,7 @@ extern void finish_swait(struct swait_queue_head *q, struct swait_queue *wait);struct swait_queue __wait; \long __ret = ret; \ \ -sdt_might_sleep_start (NULL ); \ +sdt_might_sleep_start_timeout (NULL , __ret); \INIT_LIST_HEAD (&__wait.task_list); \for (;;) { \long __int =prepare_to_swait_event (&wq, &__wait, state);\
Signature · 1 line
2.17.1
PATCH v17 21/47 dept: apply timeout consideration to waitqueue wait
In reply to Byungchul ParkNow that CONFIG_DEPT_AGGRESSIVE_TIMEOUT_WAIT was introduced, apply the consideration to waitqueue wait, assuming an input 'ret' in ___wait_event() macro is used as a timeout value.
--- include/linux/wait.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/wait.h +1 -1
@@ -306,7 +306,7 @@ extern void init_wait_entry(struct wait_queue_entry *wq_entry, int flags);struct wait_queue_entry __wq_entry; \long __ret = ret;/* explicit shadow */ \ \ -sdt_might_sleep_start (NULL ); \ +sdt_might_sleep_start_timeout (NULL , __ret); \init_wait_entry (&__wq_entry, exclusive ?WQ_FLAG_EXCLUSIVE :0 ); \for (;;) { \long __int =prepare_to_wait_event (&wq_head, &__wq_entry, state);\
Signature · 1 line
2.17.1
PATCH v17 22/47 dept: apply timeout consideration to hashed-waitqueue wait
In reply to Byungchul ParkNow that CONFIG_DEPT_AGGRESSIVE_TIMEOUT_WAIT was introduced, apply the consideration to hashed-waitqueue wait, assuming an input 'ret' in ___wait_var_event() macro is used as a timeout value.
--- include/linux/wait_bit.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/wait_bit.h +1 -1
@@ -258,7 +258,7 @@ extern wait_queue_head_t *__var_waitqueue(void *p);struct wait_bit_queue_entry __wbq_entry; \long __ret = ret;/* explicit shadow */ \ \ -sdt_might_sleep_start (NULL ); \ +sdt_might_sleep_start_timeout (NULL , __ret); \init_wait_var_entry (&__wbq_entry, var, \ exclusive ?WQ_FLAG_EXCLUSIVE :0 ); \for (;;) { \
Signature · 1 line
2.17.1
PATCH v17 23/47 dept: apply timeout consideration to dma fence wait
In reply to Byungchul ParkNow that CONFIG_DEPT_AGGRESSIVE_TIMEOUT_WAIT was introduced, apply the consideration to dma fence wait.
--- drivers/dma-buf/dma-fence.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/dma-buf/dma-fence.c +2 -2
@@ -801,7 +801,7 @@ dma_fence_default_wait(struct dma_fence *fence, bool intr, signed long timeout) cb.task = current;list_add (&cb.base.node, &fence->cb_list); -sdt_might_sleep_start (NULL ); +sdt_might_sleep_start_timeout (NULL , timeout);while (!test_bit (DMA_FENCE_FLAG_SIGNALED_BIT , &fence->flags) && ret >0 ) {if (intr)__set_current_state (TASK_INTERRUPTIBLE );
@@ -905,7 +905,7 @@ dma_fence_wait_any_timeout(struct dma_fence **fences, uint32_t count, } } -sdt_might_sleep_start (NULL ); +sdt_might_sleep_start_timeout (NULL , timeout);while (ret >0 ) {if (intr)set_current_state (TASK_INTERRUPTIBLE );
Signature · 1 line
2.17.1
PATCH v17 24/47 dept: make dept able to work with an external wgen
In reply to Byungchul ParkThere is a case where the total map size of waits of a class is so large. For instance, PG_locked is the case if every struct page embeds its regular map for PG_locked. The total size for the maps will be 'the # of pages * sizeof(struct dept_map)', which is too big to accept.
Keep the minimum data in the case, timestamp called 'wgen', that dept uses. Make dept able to work with the wgen instead of whole regular map.
--- include/linux/dept.h | 18 ++++++++++++++---- include/linux/dept_sdt.h | 6 +++--- kernel/dependency/dept.c | 30 +++++++++++++++++++++--------- 3 files changed, 38 insertions(+), 16 deletions(-)
include/linux/dept.h +14 -4
@@ -372,6 +372,13 @@ struct dept_wait_hist {unsigned int ctxt_id; }; +/* +* for subsystems that requires compact use of memory e.g. struct page +*/ +struct dept_ext_wgen { +unsigned int wgen; +}; +extern void dept_on (void );extern void dept_off (void );extern void dept_init (void );
@@ -381,6 +388,7 @@ extern void dept_free_range(void *start, unsigned int sz);extern void dept_map_init (struct dept_map *m,struct dept_key *k,int sub_u,const char *n);extern void dept_map_reinit (struct dept_map *m,struct dept_key *k,int sub_u,const char *n); +extern void dept_ext_wgen_init (struct dept_ext_wgen *ewg);extern void dept_map_copy (struct dept_map *to,struct dept_map *from);extern void dept_wait (struct dept_map *m,unsigned long w_f,unsigned long ip,const char *w_fn,int sub_l,long timeout);extern void dept_stage_wait (struct dept_map *m,struct dept_key *k,unsigned long ip,const char *w_fn,long timeout);
@@ -389,8 +397,8 @@ extern void dept_clean_stage(void);extern void dept_ttwu_stage_wait (struct task_struct *t,unsigned long ip);extern void dept_ecxt_enter (struct dept_map *m,unsigned long e_f,unsigned long ip,const char *c_fn,const char *e_fn,int sub_l);extern bool dept_ecxt_holding (struct dept_map *m,unsigned long e_f); -extern void dept_request_event (struct dept_map *m); -extern void dept_event (struct dept_map *m,unsigned long e_f,unsigned long ip,const char *e_fn); +extern void dept_request_event (struct dept_map *m,struct dept_ext_wgen *ewg); +extern void dept_event (struct dept_map *m,unsigned long e_f,unsigned long ip,const char *e_fn,struct dept_ext_wgen *ewg);extern void dept_ecxt_exit (struct dept_map *m,unsigned long e_f,unsigned long ip);extern void dept_sched_enter (void );extern void dept_sched_exit (void );
@@ -417,6 +425,7 @@ extern void dept_hardirqs_off(void);#else /* !CONFIG_DEPT */ struct dept_key { };struct dept_map { }; +struct dept_ext_wgen { };#define DEPT_MAP_INITIALIZER (n, k) { }
@@ -429,6 +438,7 @@ struct dept_map { };#define dept_map_init (m, k, su, n) do { (void)(n); (void)(k); } while (0)#define dept_map_reinit (m, k, su, n) do { (void)(n); (void)(k); } while (0) +#define dept_ext_wgen_init (wg) do { } while (0)#define dept_map_copy (t, f) do { } while (0)#define dept_wait (m, w_f, ip, w_fn, sl, t) do { (void)(w_fn); } while (0)#define dept_stage_wait (m, k, ip, w_fn, t) do { (void)(k); (void)(w_fn); } while (0)
@@ -437,8 +447,8 @@ struct dept_map { };#define dept_ttwu_stage_wait (t, ip) do { } while (0)#define dept_ecxt_enter (m, e_f, ip, c_fn, e_fn, sl) do { (void)(c_fn); (void)(e_fn); } while (0)#define dept_ecxt_holding (m, e_f) false -#define dept_request_event (m) do { } while (0) -#define dept_event (m, e_f, ip, e_fn) do { (void)(e_fn); } while (0) +#define dept_request_event (m, wg) do { } while (0) +#define dept_event (m, e_f, ip, e_fn, wg) do { (void)(e_fn); } while (0)#define dept_ecxt_exit (m, e_f, ip) do { } while (0)#define dept_sched_enter () do { } while (0)#define dept_sched_exit () do { } while (0)
include/linux/dept_sdt.h +3 -3
@@ -25,7 +25,7 @@#define sdt_wait_timeout (m, t) \ do { \ - dept_request_event(m); \ + dept_request_event(m, NULL); \ dept_wait(m, 1UL, _THIS_IP_, __func__, 0, t); \ } while (0)#define sdt_wait (m) sdt_wait_timeout(m, -1L)
@@ -49,9 +49,9 @@#define sdt_might_sleep_end () dept_clean_stage()#define sdt_ecxt_enter (m) dept_ecxt_enter(m, 1UL, _THIS_IP_, "start", "event", 0) -#define sdt_event (m) dept_event(m, 1UL, _THIS_IP_, __func__) +#define sdt_event (m) dept_event(m, 1UL, _THIS_IP_, __func__, NULL)#define sdt_ecxt_exit (m) dept_ecxt_exit(m, 1UL, _THIS_IP_) -#define sdt_request_event (m) dept_request_event(m) +#define sdt_request_event (m) dept_request_event(m, NULL)#else /* !CONFIG_DEPT */ #define sdt_map_init (m) do { } while (0)#define sdt_map_init_key (m, k) do { (void)(k); } while (0)
kernel/dependency/dept.c +21 -9
@@ -2172,6 +2172,11 @@ void dept_map_reinit(struct dept_map *m, struct dept_key *k, int sub_u, }EXPORT_SYMBOL_GPL (dept_map_reinit); +void dept_ext_wgen_init (struct dept_ext_wgen *ewg) +{ + ewg->wgen =0U ; +} +void dept_map_copy (struct dept_map *to,struct dept_map *from) {if (unlikely (!dept_working ())) {
@@ -2355,7 +2360,7 @@ static void __dept_wait(struct dept_map *m, unsigned long w_f,*/ static void __dept_event (struct dept_map *m,struct dept_map *real_m,unsigned long e_f,unsigned long ip,const char *e_fn, -bool sched_map) +bool sched_map,unsigned int wg) {struct dept_class *c;struct dept_key *k;
@@ -2377,7 +2382,7 @@ static void __dept_event(struct dept_map *m, struct dept_map *real_m, c =check_new_class (&m->map_key, k,sub_id (m, e), m->name, sched_map);if (c) -do_event (m, real_m, c,READ_ONCE (m->wgen), ip, e_fn); +do_event (m, real_m, c, wg, ip, e_fn); } void dept_wait(struct dept_map *m, unsigned long w_f,
@@ -2602,7 +2607,7 @@ void dept_ttwu_stage_wait(struct task_struct *requestor, unsigned long ip)if (!m.keys) goto exit; -__dept_event (&m, real_m,1UL , ip,"try_to_wake_up" , sched_map); +__dept_event (&m, real_m,1UL , ip,"try_to_wake_up" , sched_map, m.wgen); exit:dept_exit (flags); }
@@ -2781,10 +2786,11 @@ bool dept_ecxt_holding(struct dept_map *m, unsigned long e_f) }EXPORT_SYMBOL_GPL (dept_ecxt_holding); -void dept_request_event (struct dept_map *m) +void dept_request_event (struct dept_map *m,struct dept_ext_wgen *ewg) {unsigned long flags;unsigned int wg; +unsigned int *wg_p;if (unlikely (!dept_working ()))return ;
@@ -2797,18 +2803,22 @@ void dept_request_event(struct dept_map *m)*/ flags =dept_enter_recursive (); + wg_p = ewg ? &ewg->wgen : &m->wgen; + wg =next_wgen (); -WRITE_ONCE (m->wgen, wg); +WRITE_ONCE (*wg_p, wg);dept_exit_recursive (flags); }EXPORT_SYMBOL_GPL (dept_request_event);void dept_event (struct dept_map *m,unsigned long e_f, -unsigned long ip,const char *e_fn) +unsigned long ip,const char *e_fn, +struct dept_ext_wgen *ewg) {struct dept_task *dt =dept_task ();unsigned long flags; +unsigned int *wg_p;if (unlikely (!dept_working ()))return ;
@@ -2816,24 +2826,26 @@ void dept_event(struct dept_map *m, unsigned long e_f,if (m->nocheck)return ; + wg_p = ewg ? &ewg->wgen : &m->wgen; +if (dt->recursive) {/* * Dept won't work with this even though an event * context has been asked. Don't make it confused at * handling the event. Disable it until the next. */ -WRITE_ONCE (m->wgen,0U ); +WRITE_ONCE (*wg_p,0U );return ; } flags =dept_enter (); -__dept_event (m, m, e_f, ip, e_fn, false); +__dept_event (m, m, e_f, ip, e_fn, false,READ_ONCE (*wg_p));/* * Keep the map diabled until the next sleep. */ -WRITE_ONCE (m->wgen,0U ); +WRITE_ONCE (*wg_p,0U );dept_exit (flags); }
Signature · 1 line
2.17.1
PATCH v17 25/47 dept: track PG_locked with dept
In reply to Byungchul ParkMakes dept able to track PG_locked waits and events, which will be useful in practice. See the following link that shows dept worked with PG_locked and detected real issues in practice:
https://lore.kernel.org/lkml/[email protected]/
--- include/linux/mm_types.h | 2 + include/linux/page-flags.h | 125 +++++++++++++++++++++++++++++++++---- include/linux/pagemap.h | 37 ++++++++++- mm/filemap.c | 26 ++++++++ mm/mm_init.c | 2 + 5 files changed, 179 insertions(+), 13 deletions(-)
include/linux/mm_types.h +2 -0
@@ -20,6 +20,7 @@#include <linux/seqlock.h> #include <linux/percpu_counter.h> #include <linux/types.h> +#include <linux/dept.h> #include <asm/mmu.h>
@@ -223,6 +224,7 @@ struct page {struct page *kmsan_shadow;struct page *kmsan_origin;#endif +struct dept_ext_wgen pg_locked_wgen; } _struct_page_alignment;/*
include/linux/page-flags.h +113 -12
178 lines not on this page · raw message
include/linux/pagemap.h +36 -1
@@ -1093,7 +1093,12 @@ void folio_unlock(struct folio *folio);*/ static inline bool folio_trylock (struct folio *folio) { -return likely (!test_and_set_bit_lock (PG_locked,folio_flags (folio,0 ))); +bool ret = !test_and_set_bit_lock (PG_locked,folio_flags (folio,0 )); + +if (ret) +dept_page_set_bit (&folio->page, PG_locked); + +return likely (ret); }/*
@@ -1129,6 +1134,16 @@ static inline bool trylock_page(struct page *page)static inline void folio_lock (struct folio *folio) {might_sleep (); + +/* +* dept_page_wait_on_bit() will be called if __folio_lock() goes +* through a real wait path. However, for better job to detect +* *potential* deadlocks, let's assume that folio_lock() always +* goes through wait so that dept can take into account all the +* potential cases. +*/ +dept_page_wait_on_bit (&folio->page, PG_locked); +if (!folio_trylock (folio))__folio_lock (folio); }
@@ -1149,6 +1164,15 @@ static inline void lock_page(struct page *page)struct folio *folio;might_sleep (); +/* +* dept_page_wait_on_bit() will be called if __folio_lock() goes +* through a real wait path. However, for better job to detect +* *potential* deadlocks, let's assume that lock_page() always +* goes through wait so that dept can take into account all the +* potential cases. +*/ +dept_page_wait_on_bit (page, PG_locked); + folio =page_folio (page);if (!folio_trylock (folio))__folio_lock (folio);
@@ -1167,6 +1191,17 @@ static inline void lock_page(struct page *page)static inline int folio_lock_killable (struct folio *folio) {might_sleep (); + +/* +* dept_page_wait_on_bit() will be called if +* __folio_lock_killable() goes through a real wait path. +* However, for better job to detect *potential* deadlocks, +* let's assume that folio_lock_killable() always goes through +* wait so that dept can take into account all the potential +* cases. +*/ +dept_page_wait_on_bit (&folio->page, PG_locked); +if (!folio_trylock (folio))return __folio_lock_killable (folio);return 0 ;
mm/filemap.c +26 -0
@@ -48,6 +48,7 @@#include <linux/rcupdate_wait.h> #include <linux/sched/mm.h> #include <linux/sysctl.h> +#include <linux/dept.h> #include <asm/pgalloc.h> #include <asm/tlbflush.h> #include "internal.h"
@@ -1145,6 +1146,7 @@ static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync,if (flags &WQ_FLAG_CUSTOM ) {if (test_and_set_bit (key->bit_nr, &key->folio->flags))return -1 ; +dept_page_set_bit (&key->folio->page, key->bit_nr); flags |=WQ_FLAG_DONE ; } }
@@ -1228,6 +1230,7 @@ static inline bool folio_trylock_flag(struct folio *folio, int bit_nr,if (wait->flags &WQ_FLAG_EXCLUSIVE ) {if (test_and_set_bit (bit_nr, &folio->flags))return false; +dept_page_set_bit (&folio->page, bit_nr); }else if (test_bit (bit_nr, &folio->flags))return false;
@@ -1235,6 +1238,9 @@ static inline bool folio_trylock_flag(struct folio *folio, int bit_nr,return true; } +struct dept_map __maybe_unused pg_locked_map =DEPT_MAP_INITIALIZER (pg_locked_map,NULL ); +EXPORT_SYMBOL (pg_locked_map); +static inline int folio_wait_bit_common (struct folio *folio,int bit_nr,int state,enum behavior behavior) {
@@ -1246,6 +1252,8 @@ static inline int folio_wait_bit_common(struct folio *folio, int bit_nr,unsigned long pflags;bool in_thrashing; +dept_page_wait_on_bit (&folio->page, bit_nr); +if (bit_nr == PG_locked && !folio_test_uptodate (folio) &&folio_test_workingset (folio)) {delayacct_thrashing_start (&in_thrashing);
@@ -1339,6 +1347,23 @@ static inline int folio_wait_bit_common(struct folio *folio, int bit_nr,break ; } +/* +* dept_page_set_bit() might have been called already in +* folio_trylock_flag(), wake_page_function() or somewhere. +* However, call it again to reset the wgen of dept to ensure +* dept_page_wait_on_bit() is called prior to +* dept_page_set_bit(). +* +* Remind dept considers all the waits between +* dept_page_set_bit() and dept_page_clear_bit() as potential +* event disturbers. Ensure the correct sequence so that dept +* can make correct decisions: +* +* wait -> acquire(set bit) -> release(clear bit) +*/ +if (wait->flags &WQ_FLAG_DONE ) +dept_page_set_bit (&folio->page, bit_nr); +/* * If a signal happened, this 'finish_wait()' may remove the last * waiter from the wait-queues, but the folio waiters bit will remain
@@ -1496,6 +1521,7 @@ void folio_unlock(struct folio *folio)BUILD_BUG_ON (PG_waiters !=7 );BUILD_BUG_ON (PG_locked >7 );VM_BUG_ON_FOLIO (!folio_test_locked (folio), folio); +dept_page_clear_bit (&folio->page, PG_locked);if (folio_xor_flags_has_waiters (folio,1 << PG_locked))folio_wake_bit (folio, PG_locked); }
mm/mm_init.c +2 -0
@@ -32,6 +32,7 @@#include <linux/vmstat.h> #include <linux/kexec_handover.h> #include <linux/hugetlb.h> +#include <linux/dept.h> #include "internal.h" #include "slab.h" #include "shuffle.h"
@@ -587,6 +588,7 @@ void __meminit __init_single_page(struct page *page, unsigned long pfn,atomic_set (&page->_mapcount,-1 );page_cpupid_reset_last (page);page_kasan_tag_reset (page); +dept_ext_wgen_init (&page->pg_locked_wgen);INIT_LIST_HEAD (&page->lru);#ifdef WANT_PAGE_VIRTUAL
Signature · 1 line
2.17.1
PATCH v17 26/47 dept: print staged wait's stacktrace on report
In reply to Byungchul ParkCurrently, print nothing about what event wakes up in report. However, it makes hard to interpret dept's report.
Make it print wait's stacktrace that the event wakes up.
--- include/linux/dept.h | 5 ++++ include/linux/sched.h | 2 ++ kernel/dependency/dept.c | 59 ++++++++++++++++++++++++++++++++++------ 3 files changed, 57 insertions(+), 9 deletions(-)
include/linux/dept.h +5 -0
@@ -227,6 +227,11 @@ struct dept_ecxt {*/ unsigned long event_ip;struct dept_stack *event_stack; + +/* +* wait that this event ttwu +*/ +struct dept_stack *ewait_stack; }; }; };
include/linux/sched.h +2 -0
@@ -868,6 +868,7 @@ struct dept_task {const char *stage_w_fn;unsigned long stage_ip;bool stage_timeout; +struct dept_stack *stage_wait_stack;arch_spinlock_t stage_lock;/*
@@ -909,6 +910,7 @@ struct dept_task { .stage_w_fn = NULL, \ .stage_ip = 0UL, \ .stage_timeout = false, \ + .stage_wait_stack = NULL, \ .stage_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED,\ .missing_ecxt = 0, \ .hardirqs_enabled = false, \
kernel/dependency/dept.c +50 -9
174 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v17 27/47 locking/lockdep: prevent various lockdep assertions when lockdep_off()'ed
In reply to Byungchul Parklockdep provides APIs for assertion only if lockdep is enabled at the moment asserting to avoid unnecessary confusion, using the following condition, debug_locks && !this_cpu_read(lockdep_recursion).
However, lockdep_{off,on}() are also used for disabling and enabling lockdep for a simular purpose. Add !lockdep_recursing(current) that is updated by lockdep_{off,on}() to the condition so that the assertions are aware of !__lockdep_enabled if lockdep_off()'ed.
--- include/linux/lockdep.h | 3 ++- kernel/locking/lockdep.c | 10 ++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-)
include/linux/lockdep.h +2 -1
@@ -303,6 +303,7 @@ extern void lock_unpin_lock(struct lockdep_map *lock, struct pin_cookie); lockdep_assert_once(!current->lockdep_depth)#define lockdep_recursing (tsk) ((tsk)->lockdep_recursion) +extern bool lockdep_recursing_current (void );#define lockdep_pin_lock (l) lock_pin_lock(&(l)->dep_map)#define lockdep_repin_lock (l,c) lock_repin_lock(&(l)->dep_map, (c))
@@ -630,7 +631,7 @@ DECLARE_PER_CPU(int, hardirqs_enabled);DECLARE_PER_CPU (int, hardirq_context); DECLARE_PER_CPU(unsigned int, lockdep_recursion); -#define __lockdep_enabled (debug_locks && !this_cpu_read(lockdep_recursion)) +#define __lockdep_enabled (debug_locks && !this_cpu_read(lockdep_recursion) && !lockdep_recursing_current())#define lockdep_assert_irqs_enabled () \ do { \
kernel/locking/lockdep.c +10 -0
@@ -6900,3 +6900,13 @@ void lockdep_rcu_suspicious(const char *file, const int line, const char *s)warn_rcu_exit (rcu); }EXPORT_SYMBOL_GPL (lockdep_rcu_suspicious); + +/* +* For avoiding header dependency when using (struct task_struct *)current +* and lockdep_recursing() at the same time. +*/ +noinstr bool lockdep_recursing_current(void) +{ +return lockdep_recursing (current); +} +EXPORT_SYMBOL_GPL (lockdep_recursing_current);
Signature · 1 line
2.17.1
PATCH v17 28/47 dept: add documentation for dept
In reply to Byungchul ParkThis document describes the concept and APIs of dept.
--- Documentation/dependency/dept.txt | 735 ++++++++++++++++++++++++++ Documentation/dependency/dept_api.txt | 117 ++++ 2 files changed, 852 insertions(+) create mode 100644 Documentation/dependency/dept.txt create mode 100644 Documentation/dependency/dept_api.txt
Documentation/dependency/dept.txt new file +735 -0
@@ -0,0 +1,735 @@ +DEPT(DEPendency Tracker) +======================== + +Started by Byungchul Park <[email protected]> + +How lockdep works +----------------- + +Lockdep detects a deadlock by checking lock acquisition order. For +example, a graph to track acquisition order built by lockdep might look +like: + + A -> B - + \ + -> E + / + C -> D - + + where 'A -> B' means that acquisition A is prior to acquisition B + with A still held. + +Lockdep keeps adding each new acquisition order into the graph in +runtime. For example, 'E -> C' will be added when the two locks have +been acquired in the order, E and then C. The graph will look like: + + A -> B - + \ + -> E - + / \ + -> C -> D - \ + / / + \ / + ------------------ + + where 'A -> B' means that acquisition A is prior to acquisition B + with A still held. + +This graph contains a subgraph that demonstrates a loop like: + + -> E - + / \ + -> C -> D - \ + / / + \ / + ------------------ + + where 'A -> B' means that acquisition A is prior to acquisition B + with A still held. + +Lockdep reports it as a deadlock on detection of a loop and stops its +working. + +CONCLUSION + +Lockdep detects a deadlock by checking if a loop has been created after +adding a new acquisition order into the graph. + + +Limitation of lockdep +--------------------- + +Lockdep deals with a deadlock by typical lock e.g. spinlock and mutex, +that are supposed to be released within the acquisition context. However, +when it comes to a deadlock by folio lock that is not supposed to be +released within the acquisition context or other general synchronization +mechanisms, lockdep doesn't work. + +Can lockdep detect the following deadlock? + + context X context Y context Z + + mutex_lock A + folio_lock B + folio_lock B <- DEADLOCK + mutex_lock A <- DEADLOCK + folio_unlock B + folio_unlock B + mutex_unlock A + mutex_unlock A + +No. What about the following? + + context X context Y + + mutex_lock A + mutex_lock A <- DEADLOCK + wait_for_complete B <- DEADLOCK + complete B + mutex_unlock A + mutex_unlock A + +No. + +CONCLUSION + +Lockdep cannot detect a deadlock by folio lock or other general +synchronization mechanisms. + + +What leads a deadlock +--------------------- + +A deadlock occurs when one or multi contexts are waiting for events that +will never happen. For example: + + context X context Y context Z + + | | | + v | | + 1 wait for A v | + . 2 wait for C v + event C . 3 wait for B + event B . + event A + +Event C cannot be triggered because context X is stuck at 1, event B +cannot be triggered because context Y is stuck at 2, and event A cannot +be triggered because context Z is stuck at 3. All the contexts are stuck. +We call this *deadlock*. + +If an event occurrence is a prerequisite to reaching another event, we +call it *dependency*. In this example: + + Event A occurrence is a prerequisite to reaching event C. + Event C occurrence is a prerequisite to reaching event B. + Event B occurrence is a prerequisite to reaching event A. + +In terms of dependency: + + Event C depends on event A. + Event B depends on event C. + Event A depends on event B. + +Dependency graph reflecting this example will look like: + + -> C -> A -> B - + / \ + \ / + ---------------- + + where 'A -> B' means that event A depends on event B. + +A circular dependency exists. Such a circular dependency leads a +deadlock since no waiters can have desired events triggered. + +CONCLUSION + +A circular dependency of events leads a deadlock. + + +Introduce DEPT +-------------- + +DEPT(DEPendency Tracker) tracks wait and event instead of lock +acquisition order so as to recognize the following situation: + + context X context Y context Z + + | | | + v | | + wait for A v | + . wait for C v + event C . wait for B + event B . + event A + +and builds up a dependency graph in runtime that is similar to lockdep. +The graph might look like: + + -> C -> A -> B - + / \ + \ / + ---------------- + + where 'A -> B' means that event A depends on event B. + +DEPT keeps adding each new dependency into the graph in runtime. For +example, 'B -> D' will be added when event D occurrence is a +prerequisite to reaching event B like: + + | + v + wait for D + . + event B + +After the addition, the graph will look like: + + -> D + / + -> C -> A -> B - + / \ + \ / + ---------------- + + where 'A -> B' means that event A depends on event B. + +DEPT is going to report a deadlock on detection of a new loop. + +CONCLUSION + +DEPT works on wait and event so as to theoretically detect all the +potential deadlocks. + + +How DEPT works +-------------- + +Let's take a look how DEPT works with the 1st example in the section +'Limitation of lockdep'. + + context X context Y context Z + + mutex_lock A + folio_lock B + folio_lock B <- DEADLOCK + mutex_lock A <- DEADLOCK + folio_unlock B + folio_unlock B + mutex_unlock A + mutex_unlock A + +Adding comments to describe DEPT's view in terms of wait and event: + + context X context Y context Z + + mutex_lock A + /* wait for A */ + folio_lock B + /* wait for A */ + /* start event A context */ + + folio_lock B + /* wait for B */ <- DEADLOCK + /* start event B context */ + + mutex_lock A + /* wait for A */ <- DEADLOCK + /* start event A context */ + + folio_unlock B + /* event B */ + folio_unlock B + /* event B */ + + mutex_unlock A + /* event A */ + mutex_unlock A + /* event A */ + +Adding more supplementary comments to describe DEPT's view in detail: + + context X context Y context Z + + mutex_lock A + /* might wait for A */ + /* start to take into account event A's context */ + /* 1 */ + folio_lock B + /* might wait for B */ + /* start to take into account event B's context */ + /* 2 */ + + folio_lock B + /* might wait for B */ <- DEADLOCK + /* start to take into account event B's context */ + /* 3 */ + + mutex_lock A + /* might wait for A */ <- DEADLOCK + /* start to take into account + event A's context */ + /* 4 */ + + folio_unlock B + /* event B that's been valid since 2 */ + folio_unlock B + /* event B that's been valid since 3 */ + + mutex_unlock A + /* event A that's been valid since 1 */ + + mutex_unlock A + /* event A that's been valid since 4 */ + +Let's build up dependency graph with this example. Firstly, context X: + + context X + + folio_lock B + /* might wait for B */ + /* start to take into account event B's context */ + /* 2 */ + +There are no events to create dependency. Next, context Y: + + context Y + + mutex_lock A + /* might wait for A */ + /* start to take into account event A's context */ + /* 1 */ + + folio_lock B + /* might wait for B */ + /* start to take into account event B's context */ + /* 3 */ + + folio_unlock B + /* event B that's been valid since 3 */ + + mutex_unlock A + /* event A that's been valid since 1 */ + +There are two events. For event B, folio_unlock B, since there are no +waits between 3 and the event, event B does not create dependency. For +event A, there is a wait, folio_lock B, between 1 and the event. Which +means event A cannot be triggered if event B does not wake up the wait. +Therefore, we can say event A depends on event B, say, 'A -> B'. The +graph will look like after adding the dependency: + + A -> B + + where 'A -> B' means that event A depends on event B. + +Lastly, context Z: + + context Z + + mutex_lock A + /* might wait for A */ + /* start to take into account event A's context */ + /* 4 */ + + folio_unlock B + /* event B that's been valid since 2 */ + + mutex_unlock A + /* event A that's been valid since 4 */ + +There are also two events. For event B, folio_unlock B, there is a +wait, mutex_lock A, between 2 and the event - remind 2 is at a very +start and before the wait in timeline. Which means event B cannot be +triggered if event A does not wake up the wait. Therefore, we can say +event B depends on event A, say, 'B -> A'. The graph will look like +after adding the dependency: + + -> A -> B - + / \ + \ / + ----------- + + where 'A -> B' means that event A depends on event B. + +A new loop has been created. So DEPT can report it as a deadlock. For +event A, mutex_unlock A, since there are no waits between 4 and the +event, event A does not create dependency. That's it. + +CONCLUSION + +DEPT works well with any general synchronization mechanisms by focusing +on wait, event and its context. + + +Interpret DEPT report +--------------------- + +The following is the example in the section 'How DEPT works'. + + context X context Y context Z + + mutex_lock A + /* might wait for A */ + /* start to take into account event A's context */ + /* 1 */ + folio_lock B + /* might wait for B */ + /* start to take into account event B's context */ + /* 2 */ + + folio_lock B + /* might wait for B */ <- DEADLOCK + /* start to take into account event B's context */ + /* 3 */ + + mutex_lock A + /* might wait for A */ <- DEADLOCK + /* start to take into account + event A's context */ + /* 4 */ + + folio_unlock B + /* event B that's been valid since 2 */ + folio_unlock B + /* event B that's been valid since 3 */ + + mutex_unlock A + /* event A that's been valid since 1 */ + + mutex_unlock A + /* event A that's been valid since 4 */ + +We can Simplify this by replacing each waiting point with [W], each +point where its event's context starts with [S] and each event with [E]. +This example will look like after the replacement: + + context X context Y context Z + + [W][S] mutex_lock A + [W][S] folio_lock B + [W][S] folio_lock B <- DEADLOCK + + [W][S] mutex_lock A <- DEADLOCK + [E] folio_unlock B + [E] folio_unlock B + [E] mutex_unlock A + [E] mutex_unlock A + +DEPT uses the symbols [W], [S] and [E] in its report as described above. +The following is an example reported by DEPT for a real problem. + + Link: https://lore.kernel.org/lkml/[email protected]/#t + Link: https://lore.kernel.org/lkml/[email protected]/ + + =================================================== + DEPT: Circular dependency has been detected. + 6.2.0-rc1-00025-gb0c20ebf51ac-dirty #28 Not tainted + --------------------------------------------------- + summary + --------------------------------------------------- + *** DEADLOCK *** + + context A + [S] lock(&ni->ni_lock:0) + [W] folio_wait_bit_common(PG_locked_map:0) + [E] unlock(&ni->ni_lock:0) + + context B + [S] (unknown)(PG_locked_map:0) + [W] lock(&ni->ni_lock:0) + [E] folio_unlock(PG_locked_map:0) + + [S]: start of the event context + [W]: the wait blocked + [E]: the event not reachable + --------------------------------------------------- + context A's detail + --------------------------------------------------- + context A + [S] lock(&ni->ni_lock:0) + [W] folio_wait_bit_common(PG_locked_map:0) + [E] unlock(&ni->ni_lock:0) + + [S] lock(&ni->ni_lock:0): + [<ffffffff82b396fb>] ntfs3_setattr+0x54b/0xd40 + stacktrace: + ntfs3_setattr+0x54b/0xd40 + notify_change+0xcb3/0x1430 + do_truncate+0x149/0x210 + path_openat+0x21a3/0x2a90 + do_filp_open+0x1ba/0x410 + do_sys_openat2+0x16d/0x4e0 + __x64_sys_creat+0xcd/0x120 + do_syscall_64+0x41/0xc0 + entry_SYSCALL_64_after_hwframe+0x63/0xcd + + [W] folio_wait_bit_common(PG_locked_map:0): + [<ffffffff81b228b0>] truncate_inode_pages_range+0x9b0/0xf20 + stacktrace: + folio_wait_bit_common+0x5e0/0xaf0 + truncate_inode_pages_range+0x9b0/0xf20 + truncate_pagecache+0x67/0x90 + ntfs3_setattr+0x55a/0xd40 + notify_change+0xcb3/0x1430 + do_truncate+0x149/0x210 + path_openat+0x21a3/0x2a90 + do_filp_open+0x1ba/0x410 + do_sys_openat2+0x16d/0x4e0 + __x64_sys_creat+0xcd/0x120 + do_syscall_64+0x41/0xc0 + entry_SYSCALL_64_after_hwframe+0x63/0xcd + + [E] unlock(&ni->ni_lock:0): + (N/A) + --------------------------------------------------- + context B's detail + --------------------------------------------------- + context B + [S] (unknown)(PG_locked_map:0) + [W] lock(&ni->ni_lock:0) + [E] folio_unlock(PG_locked_map:0) + + [S] (unknown)(PG_locked_map:0): + (N/A) + + [W] lock(&ni->ni_lock:0): + [<ffffffff82b009ec>] attr_data_get_block+0x32c/0x19f0 + stacktrace: + attr_data_get_block+0x32c/0x19f0 + ntfs_get_block_vbo+0x264/0x1330 + __block_write_begin_int+0x3bd/0x14b0 + block_write_begin+0xb9/0x4d0 + ntfs_write_begin+0x27e/0x480 + generic_perform_write+0x256/0x570 + __generic_file_write_iter+0x2ae/0x500 + ntfs_file_write_iter+0x66d/0x1d70 + do_iter_readv_writev+0x20b/0x3c0 + do_iter_write+0x188/0x710 + vfs_iter_write+0x74/0xa0 + iter_file_splice_write+0x745/0xc90 + direct_splice_actor+0x114/0x180 + splice_direct_to_actor+0x33b/0x8b0 + do_splice_direct+0x1b7/0x280 + do_sendfile+0xb49/0x1310 + + [E] folio_unlock(PG_locked_map:0): + [<ffffffff81f10222>] generic_write_end+0xf2/0x440 + stacktrace: + generic_write_end+0xf2/0x440 + ntfs_write_end+0x42e/0x980 + generic_perform_write+0x316/0x570 + __generic_file_write_iter+0x2ae/0x500 + ntfs_file_write_iter+0x66d/0x1d70 + do_iter_readv_writev+0x20b/0x3c0 + do_iter_write+0x188/0x710 + vfs_iter_write+0x74/0xa0 + iter_file_splice_write+0x745/0xc90 + direct_splice_actor+0x114/0x180 + splice_direct_to_actor+0x33b/0x8b0 + do_splice_direct+0x1b7/0x280 + do_sendfile+0xb49/0x1310 + __x64_sys_sendfile64+0x1d0/0x210 + do_syscall_64+0x41/0xc0 + entry_SYSCALL_64_after_hwframe+0x63/0xcd + --------------------------------------------------- + information that might be helpful + --------------------------------------------------- + CPU: 1 PID: 8060 Comm: a.out Not tainted + 6.2.0-rc1-00025-gb0c20ebf51ac-dirty #28 + Hardware name: QEMU Standard PC (i440FX + PIIX, 1996), + BIOS Bochs 01/01/2011 + Call Trace: + <TASK> + dump_stack_lvl+0xf2/0x169 + print_circle.cold+0xca4/0xd28 + ? lookup_dep+0x240/0x240 + ? extend_queue+0x223/0x300 + cb_check_dl+0x1e7/0x260 + bfs+0x27b/0x610 + ? print_circle+0x240/0x240 + ? llist_add_batch+0x180/0x180 + ? extend_queue_rev+0x300/0x300 + ? __add_dep+0x60f/0x810 + add_dep+0x221/0x5b0 + ? __add_idep+0x310/0x310 + ? add_iecxt+0x1bc/0xa60 + ? add_iecxt+0x1bc/0xa60 + ? add_iecxt+0x1bc/0xa60 + ? add_iecxt+0x1bc/0xa60 + __dept_wait+0x600/0x1490 + ? add_iecxt+0x1bc/0xa60 + ? truncate_inode_pages_range+0x9b0/0xf20 + ? check_new_class+0x790/0x790 + ? dept_enirq_transition+0x519/0x9c0 + dept_wait+0x159/0x3b0 + ? truncate_inode_pages_range+0x9b0/0xf20 + folio_wait_bit_common+0x5e0/0xaf0 + ? filemap_get_folios_contig+0xa30/0xa30 + ? dept_enirq_transition+0x519/0x9c0 + ? lock_is_held_type+0x10e/0x160 + ? lock_is_held_type+0x11e/0x160 + truncate_inode_pages_range+0x9b0/0xf20 + ? truncate_inode_partial_folio+0xba0/0xba0 + ? setattr_prepare+0x142/0xc40 + truncate_pagecache+0x67/0x90 + ntfs3_setattr+0x55a/0xd40 + ? ktime_get_coarse_real_ts64+0x1e5/0x2f0 + ? ntfs_extend+0x5c0/0x5c0 + ? mode_strip_sgid+0x210/0x210 + ? ntfs_extend+0x5c0/0x5c0 + notify_change+0xcb3/0x1430 + ? do_truncate+0x149/0x210 + do_truncate+0x149/0x210 + ? file_open_root+0x430/0x430 + ? process_measurement+0x18c0/0x18c0 + ? ntfs_file_release+0x230/0x230 + path_openat+0x21a3/0x2a90 + ? path_lookupat+0x840/0x840 + ? dept_enirq_transition+0x519/0x9c0 + ? lock_is_held_type+0x10e/0x160 + do_filp_open+0x1ba/0x410 + ? may_open_dev+0xf0/0xf0 + ? find_held_lock+0x2d/0x110 + ? lock_release+0x43c/0x830 + ? dept_ecxt_exit+0x31a/0x590 + ? _raw_spin_unlock+0x3b/0x50 + ? alloc_fd+0x2de/0x6e0 + do_sys_openat2+0x16d/0x4e0 + ? __ia32_sys_get_robust_list+0x3b0/0x3b0 + ? build_open_flags+0x6f0/0x6f0 + ? dept_enirq_transition+0x519/0x9c0 + ? dept_enirq_transition+0x519/0x9c0 + ? lock_is_held_type+0x4e/0x160 + ? lock_is_held_type+0x4e/0x160 + __x64_sys_creat+0xcd/0x120 + ? __x64_compat_sys_openat+0x1f0/0x1f0 + do_syscall_64+0x41/0xc0 + entry_SYSCALL_64_after_hwframe+0x63/0xcd + RIP: 0033:0x7f8b9e4e4469 + Code: 00 f3 c3 66 2e 0f 1f 84 00 00 00 00 00 0f 1f 40 00 48 89 f8 48 + 89 f7 48 89 d6 48 89 ca 4d 89 c2 4d 89 c8 4c 8b 4c 24 08 0f 05 <48> + 3d 01 f0 ff ff 73 01 c3 48 8b 0d ff 49 2b 00 f7 d8 64 89 01 48 + RSP: 002b:00007f8b9eea4ef8 EFLAGS: 00000202 ORIG_RAX: 0000000000000055 + RAX: ffffffffffffffda RBX: 0000000000000000 RCX: 00007f8b9e4e4469 + RDX: 0000000000737562 RSI: 0000000000000000 RDI: 0000000020000000 + RBP: 00007f8b9eea4f20 R08: 0000000000000000 R09: 0000000000000000 + R10: 0000000000000000 R11: 0000000000000202 R12: 00007fffa75511ee + R13: 00007fffa75511ef R14: 00007f8b9ee85000 R15: 0000000000000003 + </TASK> + +Let's take a look at the summary that is the most important part. + + --------------------------------------------------- + summary + --------------------------------------------------- + *** DEADLOCK *** + + context A + [S] lock(&ni->ni_lock:0) + [W] folio_wait_bit_common(PG_locked_map:0) + [E] unlock(&ni->ni_lock:0) + + context B + [S] (unknown)(PG_locked_map:0) + [W] lock(&ni->ni_lock:0) + [E] folio_unlock(PG_locked_map:0) + + [S]: start of the event context + [W]: the wait blocked + [E]: the event not reachable + +The summary shows the following scenario: + + context A context B context ?(unknown) + + [S] folio_lock(&f1) + [S] lock(&ni->ni_lock:0) + [W] folio_wait_bit_common(PG_locked_map:0) + + [W] lock(&ni->ni_lock:0) + [E] folio_unlock(&f1) + + [E] unlock(&ni->ni_lock:0) + +Adding supplementary comments to describe DEPT's view in detail: + + context A context B context ?(unknown) + + [S] folio_lock(&f1) + /* start to take into account context + B heading for folio_unlock(&f1) */ + /* 1 */ + [S] lock(&ni->ni_lock:0) + /* start to take into account this context heading for + unlock(&ni->ni_lock:0) */ + /* 2 */ + + [W] folio_wait_bit_common(PG_locked_map:0) (= folio_lock(&f1)) + /* might wait for folio_unlock(&f1) */ + + [W] lock(&ni->ni_lock:0) + /* might wait for unlock(&ni->ni_lock:0) */ + + [E] folio_unlock(&f1) + /* event that's been valid since 1 */ + + [E] unlock(&ni->ni_lock:0) + /* event that's been valid since 2 */ + +Let's build up dependency graph with this report. Firstly, context A: + + context A + + [S] lock(&ni->ni_lock:0) + /* start to take into account this context heading for + unlock(&ni->ni_lock:0) */ + /* 2 */ + + [W] folio_wait_bit_common(PG_locked_map:0) (= folio_lock(&f1)) + /* might wait for folio_unlock(&f1) */ + + [E] unlock(&ni->ni_lock:0) + /* event that's been valid since 2 */ + +There is one interesting event, unlock(&ni->ni_lock:0). There is a +wait, folio_lock(&f1), between 2 and the event. Which means +unlock(&ni->ni_lock:0) is not reachable if folio_unlock(&f1) does not +wake up the wait. Therefore, we can say unlock(&ni->ni_lock:0) depends +on folio_unlock(&f1), say, 'unlock(&ni->ni_lock:0) -> folio_unlock(&f1)'. +The graph will look like after adding the dependency: + + unlock(&ni->ni_lock:0) -> folio_unlock(&f1) + + where 'A -> B' means that event A depends on event B. + +Secondly, context B: + + context B + + [W] lock(&ni->ni_lock:0) + /* might wait for unlock(&ni->ni_lock:0) */ + + [E] folio_unlock(&f1) + /* event that's been valid since 1 */ + +There is also one interesting event, folio_unlock(&f1). There is a +wait, lock(&ni->ni_lock:0), between 1 and the event - remind 1 is at a +very start and before the wait in timeline. Which means folio_unlock(&f1) +is not reachable if unlock(&ni->ni_lock:0) does not wake up the wait. +Therefore, we can say folio_unlock(&f1) depends on unlock(&ni->ni_lock:0), +say, 'folio_unlock(&f1) -> unlock(&ni->ni_lock:0)'. The graph will look +like after adding the dependency: + + -> unlock(&ni->ni_lock:0) -> folio_unlock(&f1) - + / \ + \ / + ------------------------------------------------ + + where 'A -> B' means that event A depends on event B. + +A new loop has been created. So DEPT can report it as a deadlock! Cool! + +CONCLUSION + +DEPT works awesome!
Documentation/dependency/dept_api.txt new file +117 -0
117 lines not on this page · raw message
Signature · 1 line
2.17.1
Re: [PATCH v17 28/47] dept: add documentation for dept
Quoted 9 lines · Byungchul Park
This document describes the concept and APIs of dept.
Signed-off-by Byungchul Park <[email protected]>--- Documentation/dependency/dept.txt | 735 ++++++++++++++++++++++++++ Documentation/dependency/dept_api.txt | 117 ++++ 2 files changed, 852 insertions(+) create mode 100644 Documentation/dependency/dept.txt create mode 100644 Documentation/dependency/dept_api.txt
What about writing dept docs in reST (like the rest of kernel documentation)?
---- >8 ----
Documentation/locking/dept.rst renamed from Documentation/dependency/dept.txt +50 -38
@@ -8,7 +8,7 @@ How lockdep works Lockdep detects a deadlock by checking lock acquisition order. For example, a graph to track acquisition order built by lockdep might look -like: +like:: A -> B - \
@@ -16,12 +16,12 @@ like: / C -> D - - where 'A -> B' means that acquisition A is prior to acquisition B - with A still held. +where 'A -> B' means that acquisition A is prior to acquisition B +with A still held. Lockdep keeps adding each new acquisition order into the graph in runtime. For example, 'E -> C' will be added when the two locks have -been acquired in the order, E and then C. The graph will look like: +been acquired in the order, E and then C. The graph will look like:: A -> B - \
@@ -32,10 +32,10 @@ been acquired in the order, E and then C. The graph will look like: \ / ------------------ - where 'A -> B' means that acquisition A is prior to acquisition B - with A still held. +where 'A -> B' means that acquisition A is prior to acquisition B +with A still held. -This graph contains a subgraph that demonstrates a loop like: +This graph contains a subgraph that demonstrates a loop like:: -> E - / \
@@ -67,6 +67,8 @@ mechanisms, lockdep doesn't work. Can lockdep detect the following deadlock? +:: + context X context Y context Z mutex_lock A
@@ -80,6 +82,8 @@ Can lockdep detect the following deadlock? No. What about the following? +:: + context X context Y mutex_lock A
@@ -101,7 +105,7 @@ What leads a deadlock --------------------- A deadlock occurs when one or multi contexts are waiting for events that -will never happen. For example: +will never happen. For example:: context X context Y context Z
@@ -121,24 +125,24 @@ We call this *deadlock*. If an event occurrence is a prerequisite to reaching another event, we call it *dependency*. In this example: - Event A occurrence is a prerequisite to reaching event C. - Event C occurrence is a prerequisite to reaching event B. - Event B occurrence is a prerequisite to reaching event A. + * Event A occurrence is a prerequisite to reaching event C. + * Event C occurrence is a prerequisite to reaching event B. + * Event B occurrence is a prerequisite to reaching event A. In terms of dependency: - Event C depends on event A. - Event B depends on event C. - Event A depends on event B. + * Event C depends on event A. + * Event B depends on event C. + * Event A depends on event B. -Dependency graph reflecting this example will look like: +Dependency graph reflecting this example will look like:: -> C -> A -> B - / \ \ / ---------------- - where 'A -> B' means that event A depends on event B. +where 'A -> B' means that event A depends on event B. A circular dependency exists. Such a circular dependency leads a deadlock since no waiters can have desired events triggered.
@@ -152,7 +156,7 @@ Introduce DEPT -------------- DEPT(DEPendency Tracker) tracks wait and event instead of lock -acquisition order so as to recognize the following situation: +acquisition order so as to recognize the following situation:: context X context Y context Z
@@ -165,18 +169,18 @@ acquisition order so as to recognize the following situation: event A and builds up a dependency graph in runtime that is similar to lockdep. -The graph might look like: +The graph might look like:: -> C -> A -> B - / \ \ / ---------------- - where 'A -> B' means that event A depends on event B. +where 'A -> B' means that event A depends on event B. DEPT keeps adding each new dependency into the graph in runtime. For example, 'B -> D' will be added when event D occurrence is a -prerequisite to reaching event B like: +prerequisite to reaching event B like:: | v
@@ -184,7 +188,7 @@ prerequisite to reaching event B like: . event B -After the addition, the graph will look like: +After the addition, the graph will look like:: -> D /
@@ -209,6 +213,8 @@ How DEPT works Let's take a look how DEPT works with the 1st example in the section 'Limitation of lockdep'. +:: + context X context Y context Z mutex_lock A
@@ -220,7 +226,7 @@ Let's take a look how DEPT works with the 1st example in the section mutex_unlock A mutex_unlock A -Adding comments to describe DEPT's view in terms of wait and event: +Adding comments to describe DEPT's view in terms of wait and event:: context X context Y context Z
@@ -248,7 +254,7 @@ Adding comments to describe DEPT's view in terms of wait and event: mutex_unlock A /* event A */ -Adding more supplementary comments to describe DEPT's view in detail: +Adding more supplementary comments to describe DEPT's view in detail:: context X context Y context Z
@@ -283,7 +289,7 @@ Adding more supplementary comments to describe DEPT's view in detail: mutex_unlock A /* event A that's been valid since 4 */ -Let's build up dependency graph with this example. Firstly, context X: +Let's build up dependency graph with this example. Firstly, context X:: context X
@@ -292,7 +298,7 @@ Let's build up dependency graph with this example. Firstly, context X: /* start to take into account event B's context */ /* 2 */ -There are no events to create dependency. Next, context Y: +There are no events to create dependency. Next, context Y:: context Y
@@ -317,13 +323,13 @@ waits between 3 and the event, event B does not create dependency. For event A, there is a wait, folio_lock B, between 1 and the event. Which means event A cannot be triggered if event B does not wake up the wait. Therefore, we can say event A depends on event B, say, 'A -> B'. The -graph will look like after adding the dependency: +graph will look like after adding the dependency:: A -> B - where 'A -> B' means that event A depends on event B. +where 'A -> B' means that event A depends on event B. -Lastly, context Z: +Lastly, context Z:: context Z
@@ -343,7 +349,7 @@ wait, mutex_lock A, between 2 and the event - remind 2 is at a very start and before the wait in timeline. Which means event B cannot be triggered if event A does not wake up the wait. Therefore, we can say event B depends on event A, say, 'B -> A'. The graph will look like -after adding the dependency: +after adding the dependency:: -> A -> B - / \
@@ -367,6 +373,8 @@ Interpret DEPT report The following is the example in the section 'How DEPT works'. +:: + context X context Y context Z mutex_lock A
@@ -402,7 +410,7 @@ The following is the example in the section 'How DEPT works'. We can Simplify this by replacing each waiting point with [W], each point where its event's context starts with [S] and each event with [E]. -This example will look like after the replacement: +This example will look like after the replacement:: context X context Y context Z
@@ -419,6 +427,8 @@ This example will look like after the replacement: DEPT uses the symbols [W], [S] and [E] in its report as described above. The following is an example reported by DEPT for a real problem. +:: + Link: https://lore.kernel.org/lkml/[email protected]/#t Link: https://lore.kernel.org/lkml/[email protected]/
@@ -620,6 +630,8 @@ The following is an example reported by DEPT for a real problem. Let's take a look at the summary that is the most important part. +:: + --------------------------------------------------- summary ---------------------------------------------------
@@ -639,7 +651,7 @@ Let's take a look at the summary that is the most important part. [W]: the wait blocked [E]: the event not reachable -The summary shows the following scenario: +The summary shows the following scenario:: context A context B context ?(unknown)
@@ -652,7 +664,7 @@ The summary shows the following scenario: [E] unlock(&ni->ni_lock:0) -Adding supplementary comments to describe DEPT's view in detail: +Adding supplementary comments to describe DEPT's view in detail:: context A context B context ?(unknown)
@@ -677,7 +689,7 @@ Adding supplementary comments to describe DEPT's view in detail: [E] unlock(&ni->ni_lock:0) /* event that's been valid since 2 */ -Let's build up dependency graph with this report. Firstly, context A: +Let's build up dependency graph with this report. Firstly, context A:: context A
@@ -697,13 +709,13 @@ wait, folio_lock(&f1), between 2 and the event. Which means unlock(&ni->ni_lock:0) is not reachable if folio_unlock(&f1) does not wake up the wait. Therefore, we can say unlock(&ni->ni_lock:0) depends on folio_unlock(&f1), say, 'unlock(&ni->ni_lock:0) -> folio_unlock(&f1)'. -The graph will look like after adding the dependency: +The graph will look like after adding the dependency:: unlock(&ni->ni_lock:0) -> folio_unlock(&f1) - where 'A -> B' means that event A depends on event B. +where 'A -> B' means that event A depends on event B. -Secondly, context B: +Secondly, context B:: context B
@@ -719,14 +731,14 @@ very start and before the wait in timeline. Which means folio_unlock(&f1) is not reachable if unlock(&ni->ni_lock:0) does not wake up the wait. Therefore, we can say folio_unlock(&f1) depends on unlock(&ni->ni_lock:0), say, 'folio_unlock(&f1) -> unlock(&ni->ni_lock:0)'. The graph will look -like after adding the dependency: +like after adding the dependency:: -> unlock(&ni->ni_lock:0) -> folio_unlock(&f1) - / \ \ / ------------------------------------------------ - where 'A -> B' means that event A depends on event B. +where 'A -> B' means that event A depends on event B. A new loop has been created. So DEPT can report it as a deadlock! Cool!
Documentation/locking/dept_api.rst renamed from Documentation/dependency/dept_api.txt +8 -0
@@ -10,6 +10,8 @@ already applied into the existing synchronization primitives e.g. waitqueue, swait, wait_for_completion(), dma fence and so on. The basic APIs of SDT are: +.. code-block:: c + /* * After defining 'struct dept_map map', initialize the instance. */
@@ -27,6 +29,8 @@ APIs of SDT are: The advanced APIs of SDT are: +.. code-block:: c + /* * After defining 'struct dept_map map', initialize the instance * using an external key.
@@ -83,6 +87,8 @@ Do not use these APIs directly. These are the wrappers for typical locks, that have been already applied into major locks internally e.g. spin lock, mutex, rwlock and so on. The APIs of LDT are: +.. code-block:: c + ldt_init(map, key, sub, name); ldt_lock(map, sub_local, try, nest, ip); ldt_rlock(map, sub_local, try, nest, ip, queued);
@@ -96,6 +102,8 @@ Raw APIs -------- Do not use these APIs directly. The raw APIs of dept are: +.. code-block:: c + dept_free_range(start, size); dept_map_init(map, key, sub, name); dept_map_reinit(map, key, sub, name);
Documentation/locking/index.rst +2 -0
@@ -24,6 +24,8 @@ Locking percpu-rw-semaphore robust-futexes robust-futex-ABI + dept + dept_api .. only:: subproject and html
Quoted 13 lines
(quoted diff) +13
-0+Can lockdep detect the following deadlock? + + context X context Y context Z + + mutex_lock A + folio_lock B + folio_lock B <- DEADLOCK + mutex_lock A <- DEADLOCK + folio_unlock B + folio_unlock B + mutex_unlock A + mutex_unlock A +
Review
Quoted 10 lines
(quoted diff) +10
-0+No. What about the following? + + context X context Y + + mutex_lock A + mutex_lock A <- DEADLOCK + wait_for_complete B <- DEADLOCK + complete B + mutex_unlock A + mutex_unlock A
Can you explain how DEPT detects deadlock on the second example above (like the first one being described in "How DEPT works" section)?
Confused...
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Re: [PATCH v17 28/47] dept: add documentation for dept
Quoted 11 lines · Bagas Sanjaya
Quoted 9 lines · Byungchul Park
This document describes the concept and APIs of dept.
Signed-off-by Byungchul Park <[email protected]>--- Documentation/dependency/dept.txt | 735 ++++++++++++++++++++++++++ Documentation/dependency/dept_api.txt | 117 ++++ 2 files changed, 852 insertions(+) create mode 100644 Documentation/dependency/dept.txt create mode 100644 Documentation/dependency/dept_api.txt
Quoted 1 line
What about writing dept docs in reST (like the rest of kernel documentation)?
Sorry for late reply, but sure. I should and will. Thank you!
Documentation/locking/dept.rst
Quoted 8 lines
---- >8 ----
Documentation/locking/dept.rst renamed from Documentation/dependency/dept.txt +0
-0
However, I'm not sure if dept is about locking. dept is about general waits e.g. wait_for_completion(), wait_event(), and so on, rather than just waits involved in typical locking mechanisms e.g. spin lock, mutex, and so on.
[snip]
Quoted 3 lines
Review
Quoted 3 lines
(quoted diff) +3
-0+ + context X context Y +
/* * Acquired A. */
Quoted 1 line
Quoted 1 line
+
mutex_lockA
/*
* Request something that will be handled
* through e.g. wq, deamon or any its own
* way, and then do 'complete B'. */
request_xxx_and_complete_B();
/*
* The request from
* context Y has been
* done. So running
* toward 'complete B'.
*/
/*
* Wait for A to be
* released, but will
* never happen.
*/
Quoted 1 line
Quoted 1 line
+
mutex_lockA <- DEADLOCK
/* * Wait for 'complete B' to happen, but * will never happen. */
Quoted 1 line
Quoted 1 line
+
wait_for_completeB <- DEADLOCK
/* * Never reachable. */
Quoted 1 line
Quoted 1 line
+ complete B
/* * Never reachable. */
Quoted 5 lines
Review
Quoted 2 lines
(quoted diff) +2
-0+ mutex_unlock A + mutex_unlock ACan you explain how DEPT detects deadlock on the second example above (like the first one being described in "How DEPT works" section)?
Sure. I added the explanation inline above. Don't hesitate if you have any questions. Thanks.
Byungchul
Quoted 5 lines
Confused...
--
An old man doll... just what I always wanted! - Clara
Jonathan Corbet
maintainerRe: [PATCH v17 28/47] dept: add documentation for dept
In reply to Byungchul ParkQuoted 9 lines · Byungchul Park
This document describes the concept and APIs of dept.
Signed-off-by Byungchul Park <[email protected]>--- Documentation/dependency/dept.txt | 735 ++++++++++++++++++++++++++ Documentation/dependency/dept_api.txt | 117 ++++ 2 files changed, 852 insertions(+) create mode 100644 Documentation/dependency/dept.txt create mode 100644 Documentation/dependency/dept_api.txt
As already suggested, this should be in RST; you're already 95% of the way there. Also, please put it under Documentation/dev-tools; we don't need another top-level directory for this.
Thanks,
jon
Re: [PATCH v17 28/47] dept: add documentation for dept
Quoted 12 lines · Jonathan Corbet
Quoted 9 lines · Byungchul Park
This document describes the concept and APIs of dept.
Signed-off-by Byungchul Park <[email protected]>--- Documentation/dependency/dept.txt | 735 ++++++++++++++++++++++++++ Documentation/dependency/dept_api.txt | 117 ++++ 2 files changed, 852 insertions(+) create mode 100644 Documentation/dependency/dept.txt create mode 100644 Documentation/dependency/dept_api.txt
Quoted 3 lines
As already suggested, this should be in RST; you're already 95% of the way there. Also, please put it under
Documentation/dev-tools; we don't need another top-level directory for this.
Sure. I will. Thanks!
Byungchul
Quoted 4 lines
Thanks,
jon
Re: [PATCH v17 28/47] dept: add documentation for dept
In reply to Byungchul ParkQuoted 2 lines · Byungchul Park
This document describes the concept and APIs of dept.
Thanks for the documentation. I've been trying to understand it.
Quoted 35 lines
Documentation/dependency/dept.txt new file +35
-0+How DEPT works +-------------- + +Let's take a look how DEPT works with the 1st example in the section +'Limitation of lockdep'. + + context X context Y context Z + + mutex_lock A + folio_lock B + folio_lock B <- DEADLOCK + mutex_lock A <- DEADLOCK + folio_unlock B + folio_unlock B + mutex_unlock A + mutex_unlock A + +Adding comments to describe DEPT's view in terms of wait and event: + + context X context Y context Z + + mutex_lock A + /* wait for A */ + folio_lock B + /* wait for A */ + /* start event A context */ + + folio_lock B + /* wait for B */ <- DEADLOCK + /* start event B context */ + + mutex_lock A + /* wait for A */ <- DEADLOCK + /* start event A context */ +
Documentation/dependency/dept.txt line 250
Quoted 10 lines
Documentation/dependency/dept.txt new file +10
-0+ folio_unlock B + /* event B */ + folio_unlock B + /* event B */ + + mutex_unlock A + /* event A */ + mutex_unlock A + /* event A */ +
I can't see the value of the above section.
The first section with no comments is useful as it is easy to see the deadlock being investigate. The section below is useful as it add comments to explain how DEPT sees the situation. But the above section, with some but not all of the comments, does seem (to me) to add anything useful.
Documentation/dependency/dept.txt line 257
Quoted 7 lines
Documentation/dependency/dept.txt new file +7
-0+Adding more supplementary comments to describe DEPT's view in detail: + + context X context Y context Z + + mutex_lock A + /* might wait for A */ + /* start to take into account event A's context */
What do you mean precisely by "context".
You use the word in the heading "context X context Y context Z" so it seems like "context" means "task" or "process". But then as I read on, I think - maybe it means something else. If it does, then you should use different words. Maybe "task X ..." in the heading.
If the examples that follow It seems that the "context" for event A starts at "mutex lock A" when it (possibly) waits for a mutex and ends at "mutex unlock A" - which are both in the same process. Clearly various other events that happen between these two points in the same process could be seen as the "context" for event A.
However event B starts in "context X" with "folio_lock B" and ends in "context Z" or "context Y" with "folio_unlock B". Is that right?
My question then is: how do you decide which, of all the event in all the processes in all the system, between the start[S] and the end[E] are considered to be part of the "context" of event A.
I think it would help me if you defined what a "context" is earlier. What sorts of things appear in a context?
Thanks,
NeilBrown
Quoted 106 lines
Documentation/dependency/dept.txt new file +106
-0+ /* 1 */ + folio_lock B + /* might wait for B */ + /* start to take into account event B's context */ + /* 2 */ + + folio_lock B + /* might wait for B */ <- DEADLOCK + /* start to take into account event B's context */ + /* 3 */ + + mutex_lock A + /* might wait for A */ <- DEADLOCK + /* start to take into account + event A's context */ + /* 4 */ + + folio_unlock B + /* event B that's been valid since 2 */ + folio_unlock B + /* event B that's been valid since 3 */ + + mutex_unlock A + /* event A that's been valid since 1 */ + + mutex_unlock A + /* event A that's been valid since 4 */ + +Let's build up dependency graph with this example. Firstly, context X: + + context X + + folio_lock B + /* might wait for B */ + /* start to take into account event B's context */ + /* 2 */ + +There are no events to create dependency. Next, context Y: + + context Y + + mutex_lock A + /* might wait for A */ + /* start to take into account event A's context */ + /* 1 */ + + folio_lock B + /* might wait for B */ + /* start to take into account event B's context */ + /* 3 */ + + folio_unlock B + /* event B that's been valid since 3 */ + + mutex_unlock A + /* event A that's been valid since 1 */ + +There are two events. For event B, folio_unlock B, since there are no +waits between 3 and the event, event B does not create dependency. For +event A, there is a wait, folio_lock B, between 1 and the event. Which +means event A cannot be triggered if event B does not wake up the wait. +Therefore, we can say event A depends on event B, say, 'A -> B'. The +graph will look like after adding the dependency: + + A -> B + + where 'A -> B' means that event A depends on event B. + +Lastly, context Z: + + context Z + + mutex_lock A + /* might wait for A */ + /* start to take into account event A's context */ + /* 4 */ + + folio_unlock B + /* event B that's been valid since 2 */ + + mutex_unlock A + /* event A that's been valid since 4 */ + +There are also two events. For event B, folio_unlock B, there is a +wait, mutex_lock A, between 2 and the event - remind 2 is at a very +start and before the wait in timeline. Which means event B cannot be +triggered if event A does not wake up the wait. Therefore, we can say +event B depends on event A, say, 'B -> A'. The graph will look like +after adding the dependency: + + -> A -> B - + / \ + \ / + ----------- + + where 'A -> B' means that event A depends on event B. + +A new loop has been created. So DEPT can report it as a deadlock. For +event A, mutex_unlock A, since there are no waits between 4 and the +event, event A does not create dependency. That's it. + +CONCLUSION + +DEPT works well with any general synchronization mechanisms by focusing +on wait, event and its context. +
Re: [PATCH v17 28/47] dept: add documentation for dept
Quoted 5 lines · NeilBrown
Quoted 2 lines · Byungchul Park
This document describes the concept and APIs of dept.
Thanks for the documentation. I've been trying to understand it.
You're welcome. Feel free to ask me if you have any questions.
Quoted 44 lines
Quoted 44 lines
Documentation/dependency/dept.txt new file +44
-0+How DEPT works +-------------- + +Let's take a look how DEPT works with the 1st example in the section +'Limitation of lockdep'. + + context X context Y context Z + + mutex_lock A + folio_lock B + folio_lock B <- DEADLOCK + mutex_lock A <- DEADLOCK + folio_unlock B + folio_unlock B + mutex_unlock A + mutex_unlock A + +Adding comments to describe DEPT's view in terms of wait and event: + + context X context Y context Z + + mutex_lock A + /* wait for A */ + folio_lock B + /* wait for A */ + /* start event A context */ + + folio_lock B + /* wait for B */ <- DEADLOCK + /* start event B context */ + + mutex_lock A + /* wait for A */ <- DEADLOCK + /* start event A context */ + + folio_unlock B + /* event B */ + folio_unlock B + /* event B */ + + mutex_unlock A + /* event A */ + mutex_unlock A + /* event A */
Quoted 8 lines
Quoted 1 line
+
I can't see the value of the above section.
The first section with no comments is useful as it is easy to see the deadlock being investigate. The section below is useful as it add comments to explain how DEPT sees the situation. But the above section, with some but not all of the comments, does seem (to me) to add anything useful.
I just wanted to convert 'locking terms' to 'wait and event terms' by one step. However, I can remove the section you pointed out that you thought was useless.
Quoted 9 lines
Documentation/dependency/dept.txt line 257
Quoted 7 lines
Documentation/dependency/dept.txt new file +7
-0+Adding more supplementary comments to describe DEPT's view in detail: + + context X context Y context Z + + mutex_lock A + /* might wait for A */ + /* start to take into account event A's context */What do you mean precisely by "context".
That means one of task context, irq context, wq worker context (even though it can also be considered as task context), or something.
Of course, in the example above, it must be task context since it showed a case involving only sleepible ones. However, I wanted to use general terms in the document to cover all the types of context e.g. irq, task, and so on.
Quoted 4 lines
You use the word in the heading "context X context Y context Z" so it seems like "context" means "task" or "process". But then as I read on, I think - maybe it means something else. If it does, then you should use different words. Maybe "task X ..." in the heading.
It should cover all the types of context. What word would you recommend for that purpose?
Quoted 8 lines
If the examples that follow It seems that the "context" for event A starts at "mutex lock A" when it (possibly) waits for a mutex and ends at "mutex unlock A" - which are both in the same process. Clearly various other events that happen between these two points in the same process could be seen as the "context" for event A.
However event B starts in "context X" with "
folio_lockB" and ends in "context Z" or "context Y" with "folio_unlockB". Is that right?
Right.
Quoted 3 lines
My question then is: how do you decide which, of all the event in all the processes in all the system, between the start[S] and the end[E] are considered to be part of the "context" of event A.
DEPT can identify the "context" of event A only *once* the event A is actually executed, and builds dependencies between the event and the recorded waits in the "context" of event A since [S].
Quoted 1 line
I think it would help me if you defined what a "context" is earlier.
Sorry if my description was not clear enough.
Byungchul
Quoted 112 lines
What sorts of things appear in a context?
Thanks,
NeilBrownQuoted 106 lines
Documentation/dependency/dept.txt new file +106
-0+ /* 1 */ + folio_lock B + /* might wait for B */ + /* start to take into account event B's context */ + /* 2 */ + + folio_lock B + /* might wait for B */ <- DEADLOCK + /* start to take into account event B's context */ + /* 3 */ + + mutex_lock A + /* might wait for A */ <- DEADLOCK + /* start to take into account + event A's context */ + /* 4 */ + + folio_unlock B + /* event B that's been valid since 2 */ + folio_unlock B + /* event B that's been valid since 3 */ + + mutex_unlock A + /* event A that's been valid since 1 */ + + mutex_unlock A + /* event A that's been valid since 4 */ + +Let's build up dependency graph with this example. Firstly, context X: + + context X + + folio_lock B + /* might wait for B */ + /* start to take into account event B's context */ + /* 2 */ + +There are no events to create dependency. Next, context Y: + + context Y + + mutex_lock A + /* might wait for A */ + /* start to take into account event A's context */ + /* 1 */ + + folio_lock B + /* might wait for B */ + /* start to take into account event B's context */ + /* 3 */ + + folio_unlock B + /* event B that's been valid since 3 */ + + mutex_unlock A + /* event A that's been valid since 1 */ + +There are two events. For event B, folio_unlock B, since there are no +waits between 3 and the event, event B does not create dependency. For +event A, there is a wait, folio_lock B, between 1 and the event. Which +means event A cannot be triggered if event B does not wake up the wait. +Therefore, we can say event A depends on event B, say, 'A -> B'. The +graph will look like after adding the dependency: + + A -> B + + where 'A -> B' means that event A depends on event B. + +Lastly, context Z: + + context Z + + mutex_lock A + /* might wait for A */ + /* start to take into account event A's context */ + /* 4 */ + + folio_unlock B + /* event B that's been valid since 2 */ + + mutex_unlock A + /* event A that's been valid since 4 */ + +There are also two events. For event B, folio_unlock B, there is a +wait, mutex_lock A, between 2 and the event - remind 2 is at a very +start and before the wait in timeline. Which means event B cannot be +triggered if event A does not wake up the wait. Therefore, we can say +event B depends on event A, say, 'B -> A'. The graph will look like +after adding the dependency: + + -> A -> B - + / \ + \ / + ----------- + + where 'A -> B' means that event A depends on event B. + +A new loop has been created. So DEPT can report it as a deadlock. For +event A, mutex_unlock A, since there are no waits between 4 and the +event, event A does not create dependency. That's it. + +CONCLUSION + +DEPT works well with any general synchronization mechanisms by focusing +on wait, event and its context. +
Re: [PATCH v17 28/47] dept: add documentation for dept
Quoted 62 lines · Byungchul Park
Quoted 5 lines · NeilBrown
Quoted 2 lines · Byungchul Park
This document describes the concept and APIs of dept.
Thanks for the documentation. I've been trying to understand it.
You're welcome. Feel free to ask me if you have any questions.
Quoted 44 lines
Quoted 44 lines
Documentation/dependency/dept.txt new file +44
-0+How DEPT works +-------------- + +Let's take a look how DEPT works with the 1st example in the section +'Limitation of lockdep'. + + context X context Y context Z + + mutex_lock A + folio_lock B + folio_lock B <- DEADLOCK + mutex_lock A <- DEADLOCK + folio_unlock B + folio_unlock B + mutex_unlock A + mutex_unlock A + +Adding comments to describe DEPT's view in terms of wait and event: + + context X context Y context Z + + mutex_lock A + /* wait for A */ + folio_lock B + /* wait for A */ + /* start event A context */ + + folio_lock B + /* wait for B */ <- DEADLOCK + /* start event B context */ + + mutex_lock A + /* wait for A */ <- DEADLOCK + /* start event A context */ + + folio_unlock B + /* event B */ + folio_unlock B + /* event B */ + + mutex_unlock A + /* event A */ + mutex_unlock A + /* event A */Quoted 8 lines
Quoted 1 line
+
I can't see the value of the above section.
The first section with no comments is useful as it is easy to see the deadlock being investigate. The section below is useful as it add comments to explain how DEPT sees the situation. But the above section, with some but not all of the comments, does seem (to me) to add anything useful.
Quoted 3 lines
I just wanted to convert 'locking terms' to 'wait and event terms' by one step. However, I can remove the section you pointed out that you thought was useless.
But it seems you did it in two steps???
If you think the middle section with some but not all of the comments adds value (And maybe it does - maybe I just haven't seen it yet), the please explain what value is being added at each step.
It is currently documented as:
+Adding comments to describe DEPT's view in terms of wait and event:
then
+Adding more supplementary comments to describe DEPT's view in detail:
Maybe if you said more DEPT's view so at this point so that when we see the supplementary comments, we can understand how they relate to DEPT's view.
Quoted 10 lines
Quoted 9 lines
Documentation/dependency/dept.txt line 257
Quoted 7 lines
Documentation/dependency/dept.txt new file +6
-0+ + context X context Y context Z + + mutex_lock A + /* might wait for A */ + /* start to take into account event A's context */What do you mean precisely by "context".
Quoted 2 lines
That means one of task context, irq context, wq worker context (even though it can also be considered as task context), or something.
OK, that makes sense. If you provide this definition for "context" before you use the term, I think that will help the reader.
Quoted 11 lines
Quoted 8 lines
If the examples that follow It seems that the "context" for event A starts at "mutex lock A" when it (possibly) waits for a mutex and ends at "mutex unlock A" - which are both in the same process. Clearly various other events that happen between these two points in the same process could be seen as the "context" for event A.
However event B starts in "context X" with "
folio_lockB" and ends in "context Z" or "context Y" with "folio_unlockB". Is that right?Right.
Quoted 7 lines
Quoted 3 lines
My question then is: how do you decide which, of all the event in all the processes in all the system, between the start[S] and the end[E] are considered to be part of the "context" of event A.
DEPT can identify the "context" of event A only *once* the event A is actually executed, and builds dependencies between the event and the recorded waits in the "context" of event A since [S].
So a dependency is an ordered set of pairs of "context" and "wait" or "context" and "event". "wait"s and "event"s are linked by some abstract identifier for the event (like lockdep's lock classes).
How are the contexts abstracted. Is it just "same" or "different"
I'll try reading the document again and see how much further I get.
Thanks,
NeilBrown
Re: [PATCH v17 28/47] dept: add documentation for dept
Quoted 77 lines · NeilBrown
Quoted 62 lines · Byungchul Park
Quoted 5 lines · NeilBrown
Quoted 2 lines · Byungchul Park
This document describes the concept and APIs of dept.
Thanks for the documentation. I've been trying to understand it.
You're welcome. Feel free to ask me if you have any questions.
Quoted 44 lines
Quoted 44 lines
Documentation/dependency/dept.txt new file +44
-0+How DEPT works +-------------- + +Let's take a look how DEPT works with the 1st example in the section +'Limitation of lockdep'. + + context X context Y context Z + + mutex_lock A + folio_lock B + folio_lock B <- DEADLOCK + mutex_lock A <- DEADLOCK + folio_unlock B + folio_unlock B + mutex_unlock A + mutex_unlock A + +Adding comments to describe DEPT's view in terms of wait and event: + + context X context Y context Z + + mutex_lock A + /* wait for A */ + folio_lock B + /* wait for A */ + /* start event A context */ + + folio_lock B + /* wait for B */ <- DEADLOCK + /* start event B context */ + + mutex_lock A + /* wait for A */ <- DEADLOCK + /* start event A context */ + + folio_unlock B + /* event B */ + folio_unlock B + /* event B */ + + mutex_unlock A + /* event A */ + mutex_unlock A + /* event A */Quoted 8 lines
Quoted 1 line
+
I can't see the value of the above section.
The first section with no comments is useful as it is easy to see the deadlock being investigate. The section below is useful as it add comments to explain how DEPT sees the situation. But the above section, with some but not all of the comments, does seem (to me) to add anything useful.Quoted 3 lines
I just wanted to convert 'locking terms' to 'wait and event terms' by one step. However, I can remove the section you pointed out that you thought was useless.
But it seems you did it in two steps???
If you think the middle section with some but not all of the comments adds value (And maybe it does - maybe I just haven't seen it yet), the please explain what value is being added at each step.
It is currently documented as:
+Adding comments to describe DEPT's view in terms of wait and event:
Quoted 7 lines
then
+Adding more supplementary comments to describe DEPT's view in detail:
Maybe if you said more DEPT's view so at this point so that when we see the supplementary comments, we can understand how they relate to DEPT's view.
As you pointed out, I'd better remove the middle part so as to simplify it. It doesn't give much information I also think.
Quoted 9 lines
Quoted 9 lines
Quoted 8 lines
Documentation/dependency/dept.txt line 257
Quoted 6 lines
Documentation/dependency/dept.txt new file +6
-0+ + context X context Y context Z + + mutex_lock A + /* might wait for A */ + /* start to take into account event A's context */What do you mean precisely by "context".
Quoted 5 lines
Quoted 2 lines
That means one of task context, irq context, wq worker context (even though it can also be considered as task context), or something.
OK, that makes sense. If you provide this definition for "context" before you use the term, I think that will help the reader.
Thank you. I will add it.
Quoted 15 lines
Quoted 15 lines
Quoted 8 lines
If the examples that follow It seems that the "context" for event A starts at "mutex lock A" when it (possibly) waits for a mutex and ends at "mutex unlock A" - which are both in the same process. Clearly various other events that happen between these two points in the same process could be seen as the "context" for event A.
However event B starts in "context X" with "
folio_lockB" and ends in "context Z" or "context Y" with "folio_unlockB". Is that right?Right.
Quoted 3 lines
My question then is: how do you decide which, of all the event in all the processes in all the system, between the start[S] and the end[E] are considered to be part of the "context" of event A.
Quoted 5 lines
Quoted 3 lines
DEPT can identify the "context" of event A only *once* the event A is actually executed, and builds dependencies between the event and the recorded waits in the "context" of event A since [S].
So a dependency is an ordered set of pairs of "context" and "wait" or
I don't get what you were trying to tell here. FWIW, DEPT focuses on *event* contexts and, within each event context, it tracks pairs of waits that appears since [S] and the interesting event that identifies the event context.
Quoted 2 lines
"context" and "event". "wait"s and "event"s are linked by some abstract identifier for the event (like lockdep's lock classes).
Yeah, kind of.
Quoted 1 line
How are the contexts abstracted. Is it just "same" or "different"
I don't get this. Can you explain in more detail?
Byungchul
Quoted 4 lines
I'll try reading the document again and see how much further I get.
Thanks,
NeilBrown
PATCH v17 29/47 cpu/hotplug: use a weaker annotation in AP thread
In reply to Byungchul Parkcb92173d1f0 ("locking/lockdep, cpu/hotplug: Annotate AP thread") was introduced to make lockdep_assert_cpus_held() work in AP thread.
However, the annotation is too strong for that purpose. We don't have to use more than try lock annotation for that.
rwsem_acquire() implies:
1. might be a waiter on contention of the lock.
2. enter to the critical section of the lock.
All we need in here is to act 2, not 1. So trylock version of annotation is sufficient for that purpose. Now that dept partially relies on lockdep annotaions, dept interpets rwsem_acquire() as a potential wait and might report a deadlock by the wait.
Replace it with trylock version of annotation.
--- kernel/cpu.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/cpu.c +1 -1
@@ -538,7 +538,7 @@ int lockdep_is_cpus_held(void)static void lockdep_acquire_cpus_lock (void ) { -rwsem_acquire (&cpu_hotplug_lock.dep_map,0 ,0 , _THIS_IP_); +rwsem_acquire (&cpu_hotplug_lock.dep_map,0 ,1 , _THIS_IP_); }static void lockdep_release_cpus_lock (void )
Signature · 1 line
2.17.1
PATCH v17 30/47 fs/jbd2: use a weaker annotation in journal handling
In reply to Byungchul Parkjbd2 journal handling code doesn't want jbd2_might_wait_for_commit() to be placed between start_this_handle() and stop_this_handle(). So it marks the region with rwsem_acquire_read() and rwsem_release().
However, the annotation is too strong for that purpose. We don't have to use more than try lock annotation for that.
rwsem_acquire_read() implies:
1. might be a waiter on contention of the lock.
2. enter to the critical section of the lock.
All we need in here is to act 2, not 1. So trylock version of annotation is sufficient for that purpose. Now that dept partially relies on lockdep annotaions, dept interpets rwsem_acquire_read() as a potential wait and might report a deadlock by the wait.
Replace it with trylock version of annotation.
--- fs/jbd2/transaction.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
fs/jbd2/transaction.c +1 -1
@@ -441,7 +441,7 @@ static int start_this_handle(journal_t *journal, handle_t *handle,read_unlock (&journal->j_state_lock); current->journal_info = handle; -rwsem_acquire_read (&journal->j_trans_commit_map,0 ,0 , _THIS_IP_); +rwsem_acquire_read (&journal->j_trans_commit_map,0 ,1 , _THIS_IP_);jbd2_journal_free_transaction (new_transaction);/* * Ensure that no allocations done while the transaction is open are
Signature · 1 line
2.17.1
Re: [PATCH v17 30/47] fs/jbd2: use a weaker annotation in journal handling
Quoted 12 lines · Byungchul Park
jbd2 journal handling code doesn't want
jbd2_might_wait_for_commit()to be placed betweenstart_this_handle()andstop_this_handle(). So it marks the region withrwsem_acquire_read()andrwsem_release().However, the annotation is too strong for that purpose. We don't have to use more than try lock annotation for that.
rwsem_acquire_read()implies:1. might be a waiter on contention of the lock.
2. enter to the critical section of the lock.
Quoted 8 lines
All we need in here is to act 2, not 1. So trylock version of annotation is sufficient for that purpose. Now that dept partially relies on lockdep annotaions, dept interpets
rwsem_acquire_read()as a potential wait and might report a deadlock by the wait.Replace it with trylock version of annotation.
Signed-off-by Byungchul Park <[email protected]>
Indeed. Feel free to add:
Honza
Quoted 20 lines
--- fs/jbd2/transaction.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)fs/jbd2/transaction.c +1
-1@@ -441,7 +441,7 @@ static int start_this_handle(journal_t *journal, handle_t *handle,read_unlock (&journal->j_state_lock); current->journal_info = handle; -rwsem_acquire_read (&journal->j_trans_commit_map,0 ,0 , _THIS_IP_); +rwsem_acquire_read (&journal->j_trans_commit_map,0 ,1 , _THIS_IP_);jbd2_journal_free_transaction (new_transaction);/* * Ensure that no allocations done while the transaction is open are Signature · 1 line
2.17.1
Signature · 2 lines
Jan Kara <[email protected]> SUSE Labs, CR
Re: [PATCH v17 30/47] fs/jbd2: use a weaker annotation in journal handling
Quoted 18 lines · Jan Kara
Quoted 17 lines · Byungchul Park
jbd2 journal handling code doesn't want
jbd2_might_wait_for_commit()to be placed betweenstart_this_handle()andstop_this_handle(). So it marks the region withrwsem_acquire_read()andrwsem_release().However, the annotation is too strong for that purpose. We don't have to use more than try lock annotation for that.
rwsem_acquire_read()implies:1. might be a waiter on contention of the lock.
2. enter to the critical section of the lock.All we need in here is to act 2, not 1. So trylock version of annotation is sufficient for that purpose. Now that dept partially relies on lockdep annotaions, dept interpets
rwsem_acquire_read()as a potential wait and might report a deadlock by the wait.
Quoted 7 lines
Quoted 3 lines
Replace it with trylock version of annotation.
Signed-off-by Byungchul Park <[email protected]>Indeed. Feel free to add:
Reviewed-by Jan Kara <[email protected]>
Thank you, Jan.
Byungchul
Quoted 25 lines
Honza
Quoted 18 lines
--- fs/jbd2/transaction.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)fs/jbd2/transaction.c +1
-2@@ -441,7 +441,7 @@ static int start_this_handle(journal_t *journal, handle_t *handle,read_unlock (&journal->j_state_lock); current->journal_info = handle; -rwsem_acquire_read (&journal->j_trans_commit_map,0 ,0 , _THIS_IP_); +rwsem_acquire_read (&journal->j_trans_commit_map,0 ,1 , _THIS_IP_);jbd2_journal_free_transaction (new_transaction);/* * Ensure that no allocations done while the transaction is open are -- Quoted 2 lines
2.17.1
--
Jan Kara <[email protected]>
SUSE Labs, CR
PATCH v17 31/47 dept: assign dept map to mmu notifier invalidation synchronization
In reply to Byungchul ParkResolved the following false positive by introducing explicit dept map and annotations for dealing with this case:
*** DEADLOCK ***
context A
[S] (unknown)(<sched>:0)
[W] lock(&mm->mmap_lock:0)
[E] try_to_wake_up(<sched>:0)context B
[S] lock(&mm->mmap_lock:0)
[W] mmu_interval_read_begin(<sched>:0)
[E] unlock(&mm->mmap_lock:0) [S]: start of the event context
[W]: the wait blocked
[E]: the event not reachable
dept already tracks dependencies between scheduler sleep and ttwu based on internal timestamp called wgen. However, in case that more than one event contexts are overwrapped, dept has chance to wrongly guess the start of the event context like the following:
<before this patch>
context A: lock L
context A: mmu_notifier_invalidate_range_start()
context B: lock L'
context B: mmu_interval_read_begin() : wait <- here is the start of the event context of C. context B: unlock L'
context C: lock L''
context C: mmu_notifier_invalidate_range_start()
context A: mmu_notifier_invalidate_range_end()
context A: unlock L
context C: mmu_notifier_invalidate_range_end() : ttwu
<- here is the end of the event context of C. dept observes a wait,
lock L'' within the event context of C. Which causes a false positive dept report.
context C: unlock L''
By explicitly annotating the interesting event context range, make dept work with more precise information like:
<after this patch>
context A: lock L
context A: mmu_notifier_invalidate_range_start()
context B: lock L'
context B: mmu_interval_read_begin() : wait
context B: unlock L'
context C: lock L''
context C: mmu_notifier_invalidate_range_start() <- here is the start of the event context of C.
context A: mmu_notifier_invalidate_range_end()
context A: unlock L
context C: mmu_notifier_invalidate_range_end() : ttwu
<- here is the end of the event context of C. dept doesn't observe
the wait, lock L'' within the event context of C. context C is responsible only for the range delimited by mmu_notifier_invalidate_range_{start,end}().
context C: unlock L''
--- include/linux/mmu_notifier.h | 26 ++++++++++++++++++++++++++ mm/mmu_notifier.c | 31 +++++++++++++++++++++++++++++-- 2 files changed, 55 insertions(+), 2 deletions(-)
include/linux/mmu_notifier.h +26 -0
@@ -428,6 +428,14 @@ static inline int mmu_notifier_test_young(struct mm_struct *mm,return 0 ; } +#ifdef CONFIG_DEPT +void mmu_notifier_invalidate_dept_ecxt_start (struct mmu_notifier_range *range); +void mmu_notifier_invalidate_dept_ecxt_end (struct mmu_notifier_range *range); +#else +static inline void mmu_notifier_invalidate_dept_ecxt_start (struct mmu_notifier_range *range) {} +static inline void mmu_notifier_invalidate_dept_ecxt_end (struct mmu_notifier_range *range) {} +#endif +static inline void mmu_notifier_invalidate_range_start (struct mmu_notifier_range *range) {
@@ -439,6 +447,12 @@ mmu_notifier_invalidate_range_start(struct mmu_notifier_range *range)__mmu_notifier_invalidate_range_start (range); }lock_map_release (&__mmu_notifier_invalidate_range_start_map); + +/* +* From now on, waiters could be there by this start until +* mmu_notifier_invalidate_range_end(). +*/ +mmu_notifier_invalidate_dept_ecxt_start (range); }/*
@@ -459,6 +473,12 @@ mmu_notifier_invalidate_range_start_nonblock(struct mmu_notifier_range *range) ret =__mmu_notifier_invalidate_range_start (range); }lock_map_release (&__mmu_notifier_invalidate_range_start_map); + +/* +* From now on, waiters could be there by this start until +* mmu_notifier_invalidate_range_end(). +*/ +mmu_notifier_invalidate_dept_ecxt_start (range);return ret; }
@@ -470,6 +490,12 @@ mmu_notifier_invalidate_range_end(struct mmu_notifier_range *range)if (mm_has_notifiers (range->mm))__mmu_notifier_invalidate_range_end (range); + +/* +* The event context that has been started by +* mmu_notifier_invalidate_range_start() ends. +*/ +mmu_notifier_invalidate_dept_ecxt_end (range); } static inline void mmu_notifier_arch_invalidate_secondary_tlbs(struct mm_struct *mm,
mm/mmu_notifier.c +29 -2
@@ -46,6 +46,7 @@ struct mmu_notifier_subscriptions {unsigned long active_invalidate_ranges;struct rb_root_cached itree;wait_queue_head_t wq; +struct dept_map dmap;struct hlist_head deferred_list; };
@@ -165,6 +166,25 @@ static void mn_itree_inv_end(struct mmu_notifier_subscriptions *subscriptions)wake_up_all (&subscriptions->wq); } +#ifdef CONFIG_DEPT +void mmu_notifier_invalidate_dept_ecxt_start (struct mmu_notifier_range *range) +{ +struct mmu_notifier_subscriptions *subscriptions = + range->mm->notifier_subscriptions; + +if (subscriptions) +sdt_ecxt_enter (&subscriptions->dmap); +} +void mmu_notifier_invalidate_dept_ecxt_end (struct mmu_notifier_range *range) +{ +struct mmu_notifier_subscriptions *subscriptions = + range->mm->notifier_subscriptions; + +if (subscriptions) +sdt_ecxt_exit (&subscriptions->dmap); +} +#endif +/** * mmu_interval_read_begin - Begin a read side critical section against a VA * range
@@ -246,9 +266,12 @@ mmu_interval_read_begin(struct mmu_interval_notifier *interval_sub)*/ lock_map_acquire (&__mmu_notifier_invalidate_range_start_map);lock_map_release (&__mmu_notifier_invalidate_range_start_map); -if (is_invalidating) +if (is_invalidating) { +sdt_might_sleep_start (&subscriptions->dmap);wait_event (subscriptions->wq,READ_ONCE (subscriptions->invalidate_seq) != seq); +sdt_might_sleep_end (); + }/* * Notice that mmu_interval_read_retry() can already be true at this
@@ -625,6 +648,7 @@ int __mmu_notifier_register(struct mmu_notifier *subscription,INIT_HLIST_HEAD (&subscriptions->list);spin_lock_init (&subscriptions->lock); +sdt_map_init (&subscriptions->dmap); subscriptions->invalidate_seq =2 ; subscriptions->itree =RB_ROOT_CACHED ;init_waitqueue_head (&subscriptions->wq);
@@ -1070,9 +1094,12 @@ void mmu_interval_notifier_remove(struct mmu_interval_notifier *interval_sub)*/ lock_map_acquire (&__mmu_notifier_invalidate_range_start_map);lock_map_release (&__mmu_notifier_invalidate_range_start_map); -if (seq) +if (seq) { +sdt_might_sleep_start (&subscriptions->dmap);wait_event (subscriptions->wq,mmu_interval_seq_released (subscriptions, seq)); +sdt_might_sleep_end (); + }/* pairs with mmgrab in mmu_interval_notifier_insert() */ mmdrop (mm);
Signature · 1 line
2.17.1
PATCH v17 32/47 dept: assign unique dept_key to each distinct dma fence caller
In reply to Byungchul Parkdma fence can be used at various points in the code and it's very hard to distinguish dma fences between different usages. Using a single dept_key for all the dma fences could trigger false positive reports.
Assign unique dept_key to each distinct dma fence wait to avoid false positive reports.
--- drivers/dma-buf/dma-fence.c | 18 ++++----- include/linux/dma-fence.h | 74 +++++++++++++++++++++++++++++-------- 2 files changed, 68 insertions(+), 24 deletions(-)
drivers/dma-buf/dma-fence.c +9 -9
@@ -481,7 +481,7 @@ int dma_fence_signal(struct dma_fence *fence)EXPORT_SYMBOL (dma_fence_signal);/** -* dma_fence_wait_timeout - sleep until the fence gets signaled +* __dma_fence_wait_timeout - sleep until the fence gets signaled * or until timeout elapses * @fence: the fence to wait on * @intr: if true, do an interruptible wait
@@ -499,7 +499,7 @@ EXPORT_SYMBOL(dma_fence_signal);* See also dma_fence_wait() and dma_fence_wait_any_timeout(). */ signed long -dma_fence_wait_timeout (struct dma_fence *fence,bool intr,signed long timeout) +__dma_fence_wait_timeout (struct dma_fence *fence,bool intr,signed long timeout) {signed long ret;
@@ -528,7 +528,7 @@ dma_fence_wait_timeout(struct dma_fence *fence, bool intr, signed long timeout) }return ret; } -EXPORT_SYMBOL (dma_fence_wait_timeout); +EXPORT_SYMBOL (__dma_fence_wait_timeout);/** * dma_fence_release - default release function for fences
@@ -764,7 +764,7 @@ dma_fence_default_wait_cb(struct dma_fence *fence, struct dma_fence_cb *cb) }/** -* dma_fence_default_wait - default sleep until the fence gets signaled +* __dma_fence_default_wait - default sleep until the fence gets signaled * or until timeout elapses * @fence: the fence to wait on * @intr: if true, do an interruptible wait
@@ -776,7 +776,7 @@ dma_fence_default_wait_cb(struct dma_fence *fence, struct dma_fence_cb *cb)* functions taking a jiffies timeout. */ signed long -dma_fence_default_wait (struct dma_fence *fence,bool intr,signed long timeout) +__dma_fence_default_wait (struct dma_fence *fence,bool intr,signed long timeout) {struct default_wait_cb cb;unsigned long flags;
@@ -825,7 +825,7 @@ dma_fence_default_wait(struct dma_fence *fence, bool intr, signed long timeout)spin_unlock_irqrestore (fence->lock, flags);return ret; } -EXPORT_SYMBOL (dma_fence_default_wait); +EXPORT_SYMBOL (__dma_fence_default_wait); static bool dma_fence_test_signaled_any(struct dma_fence **fences, uint32_t count,
@@ -845,7 +845,7 @@ dma_fence_test_signaled_any(struct dma_fence **fences, uint32_t count, }/** -* dma_fence_wait_any_timeout - sleep until any fence gets signaled +* __dma_fence_wait_any_timeout - sleep until any fence gets signaled * or until timeout elapses * @fences: array of fences to wait on * @count: number of fences to wait on
@@ -865,7 +865,7 @@ dma_fence_test_signaled_any(struct dma_fence **fences, uint32_t count,* See also dma_fence_wait() and dma_fence_wait_timeout(). */ signed long -dma_fence_wait_any_timeout (struct dma_fence **fences,uint32_t count, +__dma_fence_wait_any_timeout (struct dma_fence **fences,uint32_t count,bool intr,signed long timeout,uint32_t *idx) {struct default_wait_cb *cb;
@@ -933,7 +933,7 @@ dma_fence_wait_any_timeout(struct dma_fence **fences, uint32_t count,return ret; } -EXPORT_SYMBOL (dma_fence_wait_any_timeout); +EXPORT_SYMBOL (__dma_fence_wait_any_timeout);/** * DOC: deadline hints
include/linux/dma-fence.h +59 -15
98 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v17 33/47 dept: make dept aware of lockdep_set_lock_cmp_fn() annotation
In reply to Byungchul Parkcommit eb1cfd09f788e ("lockdep: Add lock_set_cmp_fn() annotation") has been added to address the issue that lockdep was not able to detect a true deadlock like the following:
https://lore.kernel.org/lkml/20220510232633.GA18445@X58A-UD3R/
The approach is only for lockdep but dept should work being aware of it because the new annotation is already used to avoid false positive of lockdep in the code.
Make dept aware of the new lockdep annotation.
--- include/linux/dept.h | 10 +++++++++ kernel/dependency/dept.c | 48 +++++++++++++++++++++++++++++++++++----- kernel/locking/lockdep.c | 1 + 3 files changed, 53 insertions(+), 6 deletions(-)
include/linux/dept.h +10 -0
@@ -130,6 +130,11 @@ struct dept_map {const char *name;struct dept_key *keys; +/* +* keep lockdep map to handle lockdep_set_lock_cmp_fn(). +*/ +void *lockdep_map; +/* * subclass that can be set from user */
@@ -156,6 +161,7 @@ struct dept_map { { \ .name = #n, \ .keys = (struct dept_key *)(k), \ + .lockdep_map = NULL, \ .sub_u = 0, \ .map_key = { .classes = { NULL, } }, \ .wgen = 0U, \
@@ -427,6 +433,8 @@ extern void dept_softirqs_on_ip(unsigned long ip);extern void dept_hardirqs_on (void );extern void dept_softirqs_off (void );extern void dept_hardirqs_off (void ); + +#define dept_set_lockdep_map (m, lockdep_m) ({ (m)->lockdep_map = lockdep_m; })#else /* !CONFIG_DEPT */ struct dept_key { };struct dept_map { };
@@ -469,5 +477,7 @@ struct dept_ext_wgen { };#define dept_hardirqs_on () do { } while (0)#define dept_softirqs_off () do { } while (0)#define dept_hardirqs_off () do { } while (0) + +#define dept_set_lockdep_map (m, lockdep_m) do { } while (0)#endif #endif /* __LINUX_DEPT_H */
kernel/dependency/dept.c +42 -6
72 lines not on this page · raw message
kernel/locking/lockdep.c +1 -0
@@ -5035,6 +5035,7 @@ void lockdep_set_lock_cmp_fn(struct lockdep_map *lock, lock_cmp_fn cmp_fn, class->print_fn = print_fn; } +dept_set_lockdep_map (&lock->dmap, lock);lockdep_recursion_finish ();raw_local_irq_restore (flags); }
Signature · 1 line
2.17.1
PATCH v17 34/47 dept: make dept stop from working on debug_locks_off()
In reply to Byungchul ParkFor many reasons, debug_locks_off() is called to stop lock debuging feature e.g. on panic(). dept should also stop it in the conditions.
--- include/linux/dept.h | 2 ++ kernel/dependency/dept.c | 6 ++++++ lib/debug_locks.c | 2 ++ 3 files changed, 10 insertions(+)
include/linux/dept.h +2 -0
@@ -390,6 +390,7 @@ struct dept_ext_wgen {unsigned int wgen; }; +extern void dept_stop_emerg (void );extern void dept_on (void );extern void dept_off (void );extern void dept_init (void );
@@ -442,6 +443,7 @@ struct dept_ext_wgen { };#define DEPT_MAP_INITIALIZER (n, k) { } +#define dept_stop_emerg () do { } while (0)#define dept_on () do { } while (0)#define dept_off () do { } while (0)#define dept_init () do { } while (0)
kernel/dependency/dept.c +6 -0
@@ -187,6 +187,12 @@ static void dept_unlock(void)arch_spin_unlock (&dept_spin); } +void dept_stop_emerg (void ) +{ +WRITE_ONCE (dept_stop,1 ); +} +EXPORT_SYMBOL_GPL (dept_stop_emerg); +enum bfs_ret {BFS_CONTINUE ,BFS_DONE ,
lib/debug_locks.c +2 -0
@@ -38,6 +38,8 @@ EXPORT_SYMBOL_GPL(debug_locks_silent);*/ int debug_locks_off (void ) { +dept_stop_emerg (); +if (debug_locks &&__debug_locks_off ()) {if (!debug_locks_silent) {console_verbose ();
Signature · 1 line
2.17.1
PATCH v17 35/47 i2c: rename wait_for_completion callback to wait_for_completion_cb
In reply to Byungchul ParkFunctionally no change. This patch is a preparation for DEPT(DEPendency Tracker) to track dependencies related to a scheduler API, wait_for_completion().
Unfortunately, struct i2c_algo_pca_data has a callback member named wait_for_completion, that is the same as the scheduler API, which makes it hard to change the scheduler API to a macro form because of the ambiguity.
Add a postfix _cb to the callback member to remove the ambiguity.
--- drivers/i2c/algos/i2c-algo-pca.c | 2 +- drivers/i2c/busses/i2c-pca-isa.c | 2 +- drivers/i2c/busses/i2c-pca-platform.c | 2 +- include/linux/i2c-algo-pca.h | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-)
drivers/i2c/algos/i2c-algo-pca.c +1 -1
@@ -30,7 +30,7 @@ static int i2c_debug;#define pca_clock (adap) adap->i2c_clock#define pca_set_con (adap, val) pca_outw(adap, I2C_PCA_CON, val)#define pca_get_con (adap) pca_inw(adap, I2C_PCA_CON) -#define pca_wait (adap) adap->wait_for_completion(adap->data) +#define pca_wait (adap) adap->wait_for_completion_cb(adap->data)static void pca_reset (struct i2c_algo_pca_data *adap) {
drivers/i2c/busses/i2c-pca-isa.c +1 -1
@@ -95,7 +95,7 @@ static struct i2c_algo_pca_data pca_isa_data = {/* .data intentionally left NULL, not needed with ISA */ .write_byte = pca_isa_writebyte, .read_byte = pca_isa_readbyte, - .wait_for_completion = pca_isa_waitforcompletion, + .wait_for_completion_cb = pca_isa_waitforcompletion, .reset_chip = pca_isa_resetchip, };
drivers/i2c/busses/i2c-pca-platform.c +1 -1
@@ -180,7 +180,7 @@ static int i2c_pca_pf_probe(struct platform_device *pdev) } i2c->algo_data.data = i2c; - i2c->algo_data.wait_for_completion = i2c_pca_pf_waitforcompletion; + i2c->algo_data.wait_for_completion_cb = i2c_pca_pf_waitforcompletion;if (i2c->gpio) i2c->algo_data.reset_chip = i2c_pca_pf_resetchip;else
include/linux/i2c-algo-pca.h +1 -1
@@ -71,7 +71,7 @@ struct i2c_algo_pca_data {void *data;/* private low level data */ void (*write_byte) (void *data,int reg,int val);int (*read_byte) (void *data,int reg); -int (*wait_for_completion) (void *data); +int (*wait_for_completion_cb) (void *data);void (*reset_chip) (void *data);/* For PCA9564, use one of the predefined frequencies: * 330000, 288000, 217000, 146000, 88000, 59000, 44000, 36000
Signature · 1 line
2.17.1
Wolfram Sang
AppliedRe: [PATCH v17 35/47] i2c: rename wait_for_completion callback to wait_for_completion_cb
Quoted 4 lines · Byungchul Park
Functionally no change. This patch is a preparation for DEPT(DEPendency Tracker) to track dependencies related to a scheduler API,
wait_for_completion().
Quoted 8 lines
Unfortunately, struct
i2c_algo_pca_datahas a callback member namedwait_for_completion, that is the same as the scheduler API, which makes it hard to change the scheduler API to a macro form because of the ambiguity.Add a postfix
_cbto the callback member to remove the ambiguity.Signed-off-by Byungchul Park <[email protected]>
This patch seems reasonable in any case. I'll pick it, so you have one dependency less. Good luck with the series!
Applied to for-next, thanks!
Re: [PATCH v17 35/47] i2c: rename wait_for_completion callback to wait_for_completion_cb
Quoted 10 lines · Wolfram Sang
Quoted 9 lines · Byungchul Park
Functionally no change. This patch is a preparation for DEPT(DEPendency Tracker) to track dependencies related to a scheduler API,
wait_for_completion().Unfortunately, struct
i2c_algo_pca_datahas a callback member namedwait_for_completion, that is the same as the scheduler API, which makes it hard to change the scheduler API to a macro form because of the ambiguity.
Quoted 6 lines
Quoted 3 lines
Add a postfix
_cbto the callback member to remove the ambiguity.Signed-off-by Byungchul Park <[email protected]>This patch seems reasonable in any case. I'll pick it, so you have one dependency less. Good luck with the series!
Thanks, Wolfram Sang!
Byungchul
Quoted 1 line
Applied to for-next, thanks!
PATCH v17 36/47 dept: assign unique dept_key to each distinct wait_for_completion() caller
In reply to Byungchul Parkwait_for_completion() can be used at various points in the code and it's very hard to distinguish wait_for_completion()s between different usages. Using a single dept_key for all the wait_for_completion()s could trigger false positive reports.
Assign unique dept_key to each distinct wait_for_completion() caller to avoid false positive reports.
--- include/linux/completion.h | 100 +++++++++++++++++++++++++++++++------ kernel/sched/completion.c | 60 +++++++++++----------- 2 files changed, 115 insertions(+), 45 deletions(-)
include/linux/completion.h +85 -15
@@ -27,12 +27,10 @@struct completion {unsigned int done;struct swait_queue_head wait; -struct dept_map dmap; };#define init_completion (x) \ do { \ - sdt_map_init(&(x)->dmap); \ __init_completion(x); \ } while (0)
@@ -43,17 +41,14 @@ do { \static inline void complete_acquire (struct completion *x,long timeout) { -sdt_might_sleep_start_timeout (&x->dmap, timeout); }static inline void complete_release (struct completion *x) { -sdt_might_sleep_end (); }#define COMPLETION_INITIALIZER (work) \ - { 0, __SWAIT_QUEUE_HEAD_INITIALIZER((work).wait), \ - .dmap = DEPT_MAP_INITIALIZER(work, NULL), } + { 0, __SWAIT_QUEUE_HEAD_INITIALIZER((work).wait), }#define COMPLETION_INITIALIZER_ONSTACK_MAP (work, map) \ (*({ init_completion_map(&(work), &(map)); &(work); }))
@@ -119,18 +114,18 @@ static inline void reinit_completion(struct completion *x) x->done =0 ; } -extern void wait_for_completion (struct completion *); -extern void wait_for_completion_io (struct completion *); -extern int wait_for_completion_interruptible (struct completion *x); -extern int wait_for_completion_killable (struct completion *x); -extern int wait_for_completion_state (struct completion *x,unsigned int state); -extern unsigned long wait_for_completion_timeout (struct completion *x, +extern void __wait_for_completion (struct completion *); +extern void __wait_for_completion_io (struct completion *); +extern int __wait_for_completion_interruptible (struct completion *x); +extern int __wait_for_completion_killable (struct completion *x); +extern int __wait_for_completion_state (struct completion *x,unsigned int state); +extern unsigned long __wait_for_completion_timeout (struct completion *x,unsigned long timeout); -extern unsigned long wait_for_completion_io_timeout (struct completion *x, +extern unsigned long __wait_for_completion_io_timeout (struct completion *x,unsigned long timeout); -extern long wait_for_completion_interruptible_timeout ( +extern long __wait_for_completion_interruptible_timeout (struct completion *x,unsigned long timeout); -extern long wait_for_completion_killable_timeout ( +extern long __wait_for_completion_killable_timeout (struct completion *x,unsigned long timeout);extern bool try_wait_for_completion (struct completion *x);extern bool completion_done (struct completion *x);
@@ -139,4 +134,79 @@ extern void complete(struct completion *);extern void complete_on_current_cpu (struct completion *x);extern void complete_all (struct completion *); +#define wait_for_completion (x) \ +({ \ + sdt_might_sleep_start_timeout(NULL, -1L); \ + __wait_for_completion(x); \ + sdt_might_sleep_end(); \ +}) +#define wait_for_completion_io (x) \ +({ \ + sdt_might_sleep_start_timeout(NULL, -1L); \ + __wait_for_completion_io(x); \ + sdt_might_sleep_end(); \ +}) +#define wait_for_completion_interruptible (x) \ +({ \ + int __ret; \ + \ + sdt_might_sleep_start_timeout(NULL, -1L); \ + __ret = __wait_for_completion_interruptible(x); \ + sdt_might_sleep_end(); \ + __ret; \ +}) +#define wait_for_completion_killable (x) \ +({ \ + int __ret; \ + \ + sdt_might_sleep_start_timeout(NULL, -1L); \ + __ret = __wait_for_completion_killable(x); \ + sdt_might_sleep_end(); \ + __ret; \ +}) +#define wait_for_completion_state (x, s) \ +({ \ + int __ret; \ + \ + sdt_might_sleep_start_timeout(NULL, -1L); \ + __ret = __wait_for_completion_state(x, s); \ + sdt_might_sleep_end(); \ + __ret; \ +}) +#define wait_for_completion_timeout (x, t) \ +({ \ + unsigned long __ret; \ + \ + sdt_might_sleep_start_timeout(NULL, t); \ + __ret = __wait_for_completion_timeout(x, t); \ + sdt_might_sleep_end(); \ + __ret; \ +}) +#define wait_for_completion_io_timeout (x, t) \ +({ \ + unsigned long __ret; \ + \ + sdt_might_sleep_start_timeout(NULL, t); \ + __ret = __wait_for_completion_io_timeout(x, t); \ + sdt_might_sleep_end(); \ + __ret; \ +}) +#define wait_for_completion_interruptible_timeout (x, t) \ +({ \ + long __ret; \ + \ + sdt_might_sleep_start_timeout(NULL, t); \ + __ret = __wait_for_completion_interruptible_timeout(x, t); \ + sdt_might_sleep_end(); \ + __ret; \ +}) +#define wait_for_completion_killable_timeout (x, t) \ +({ \ + long __ret; \ + \ + sdt_might_sleep_start_timeout(NULL, t); \ + __ret = __wait_for_completion_killable_timeout(x, t); \ + sdt_might_sleep_end(); \ + __ret; \ +})#endif
kernel/sched/completion.c +30 -30
186 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH 1/1 rust: bindings: add `rust_helper_wait_for_completion` helper function
Quoted 25 lines
(quoted diff) +9
-9-extern void wait_for_completion(struct completion *); -extern void wait_for_completion_io(struct completion *); -extern int wait_for_completion_interruptible(struct completion *x); -extern int wait_for_completion_killable(struct completion *x); -extern int wait_for_completion_state(struct completion *x, unsigned int state); -extern unsigned long wait_for_completion_timeout(struct completion *x, +extern void __wait_for_completion(struct completion *); +extern void __wait_for_completion_io(struct completion *); +extern int __wait_for_completion_interruptible(struct completion *x); +extern int __wait_for_completion_killable(struct completion *x); +extern int __wait_for_completion_state(struct completion *x, unsigned int state); +extern unsigned long __wait_for_completion_timeout(struct completion *x, unsigned long timeout); -extern unsigned long wait_for_completion_io_timeout(struct completion *x, +extern unsigned long __wait_for_completion_io_timeout(struct completion *x, unsigned long timeout); -extern long wait_for_completion_interruptible_timeout( +extern long __wait_for_completion_interruptible_timeout( struct completion *x, unsigned long timeout); -extern long wait_for_completion_killable_timeout( +extern long __wait_for_completion_killable_timeout( struct completion *x, unsigned long timeout); extern bool try_wait_for_completion(struct completion *x); extern bool completion_done(struct completion *x);
Review extern void complete(struct completion *); · line 142
Quoted 9 lines
(quoted diff) +6
-0@@ -139,4 +134,79 @@ extern void complete(struct completion *); extern void complete_on_current_cpu(struct completion *x); extern void complete_all(struct completion *); +#define wait_for_completion(x) \ +({ \ + sdt_might_sleep_start_timeout(NULL, -1L); \ + __wait_for_completion(x); \ + sdt_might_sleep_end(); \ +})
The DEPT patch series changed wait_for_completion into a macro. Because bindgen cannot handle function-like macros, this caused Rust build errors. Add a helper function to fix it.
```
error[E0425]: cannot find function `wait_for_completion` in crate `bindings`
--> rust/kernel/sync/completion.rs:110:28
|
110 | unsafe { bindings::wait_for_completion(self.as_raw()) };
| ^^^^^^^^^^^^^^^^^^^ help: a function with a similar name exists: `__wait_for_completion`
|
::: /root/linux/rust/bindings/bindings_generated.rs:33440:5
|
33440 | pub fn __wait_for_completion(arg1: *mut completion);
| ---------------------------------------------------- similarly named function `__wait_for_completion` defined here
error: aborting due to 1 previous error
For more information about this error, try `rustc --explain E0425`.
```--- rust/helpers/completion.c | 5 +++++ 1 file changed, 5 insertions(+)
rust/helpers/completion.c +5 -0
@@ -6,3 +6,8 @@ void rust_helper_init_completion(struct completion *x) {init_completion (x); } + +void rust_helper_wait_for_completion (struct completion *x) +{ +wait_for_completion (x); +}
Signature · 1 line
2.43.0
Danilo Krummrich
reviewerRe: [PATCH] rust: bindings: add `rust_helper_wait_for_completion` helper function
Quoted 3 lines · Guangbo Cui
The DEPT patch series changed
wait_for_completioninto a macro. Because bindgen cannot handle function-like macros, this caused Rust build errors. Add a helper function to fix it.
Good catch!
Given that the latest version of this series was just posted, please squash this fix into patch "dept: assign unique dept_key to each distinct wait_for_completion() caller" [1].
Thanks,
Danilo
Re: [PATCH] rust: bindings: add `rust_helper_wait_for_completion` helper function
Quoted 10 lines · Danilo Krummrich
Quoted 3 lines · Guangbo Cui
The DEPT patch series changed
wait_for_completioninto a macro. Because bindgen cannot handle function-like macros, this caused Rust build errors. Add a helper function to fix it.Good catch!
Given that the latest version of this series was just posted, please squash this fix into patch "dept: assign unique
dept_keyto each distinctwait_for_completion()caller" [1].
Thank you all. I will squash this into the patch. Thanks again!
Byungchul
Quoted 5 lines
Thanks,
Danilo
Re: [PATCH] rust: bindings: add `rust_helper_wait_for_completion` helper function
In reply to Guangbo CuiQuoted 2 lines · Guangbo Cui
The DEPT patch series changed
wait_for_completioninto a macro.
Thanks!
In general, it is useful to provide a Link: to Lore to the right patch (i.e. context is good), and please clarify in which tree you found the issue if any -- I don't see it in linux-next, so I imagine it is not applied, but "changed" sounds like it was? If it was actually applied, please also provide a Fixes: tag.
Cheers,
Miguel
Re: [PATCH] rust: bindings: add `rust_helper_wait_for_completion` helper function
Quoted 3 lines · Miguel Ojeda
issue if any -- I don't see it in linux-next, so I imagine it is not applied, but "changed" sounds like it was? If it was actually applied, please also provide a Fixes: tag.
Yeah, it's not applied yet, this should be squashed into [1].
Sorry, I forgot to check the commit message.
Thanks,
Guangbo
Re: [PATCH] rust: bindings: add `rust_helper_wait_for_completion` helper function
In reply to Guangbo CuiQuoted 39 lines · Guangbo Cui
Quoted 25 lines
(quoted diff) +9
-9-extern void wait_for_completion(struct completion *); -extern void wait_for_completion_io(struct completion *); -extern int wait_for_completion_interruptible(struct completion *x); -extern int wait_for_completion_killable(struct completion *x); -extern int wait_for_completion_state(struct completion *x, unsigned int state); -extern unsigned long wait_for_completion_timeout(struct completion *x, +extern void __wait_for_completion(struct completion *); +extern void __wait_for_completion_io(struct completion *); +extern int __wait_for_completion_interruptible(struct completion *x); +extern int __wait_for_completion_killable(struct completion *x); +extern int __wait_for_completion_state(struct completion *x, unsigned int state); +extern unsigned long __wait_for_completion_timeout(struct completion *x, unsigned long timeout); -extern unsigned long wait_for_completion_io_timeout(struct completion *x, +extern unsigned long __wait_for_completion_io_timeout(struct completion *x, unsigned long timeout); -extern long wait_for_completion_interruptible_timeout( +extern long __wait_for_completion_interruptible_timeout( struct completion *x, unsigned long timeout); -extern long wait_for_completion_killable_timeout( +extern long __wait_for_completion_killable_timeout( struct completion *x, unsigned long timeout); extern bool try_wait_for_completion(struct completion *x); extern bool completion_done(struct completion *x);Review extern void complete(struct completion *); · line 142
Quoted 9 lines
(quoted diff) +6
-0@@ -139,4 +134,79 @@ extern void complete(struct completion *); extern void complete_on_current_cpu(struct completion *x); extern void complete_all(struct completion *); +#define wait_for_completion(x) \ +({ \ + sdt_might_sleep_start_timeout(NULL, -1L); \ + __wait_for_completion(x); \ + sdt_might_sleep_end(); \ +})The DEPT patch series changed
wait_for_completioninto a macro. Because bindgen cannot handle function-like macros, this caused Rust build errors. Add a helper function to fix it.
Quoted 17 lines
```
error[E0425]: cannot find function `wait_for_completion` in crate `bindings`
--> rust/kernel/sync/completion.rs:110:28
|
110 | unsafe { bindings::wait_for_completion(self.as_raw()) };
| ^^^^^^^^^^^^^^^^^^^ help: a function with a similar name exists: `__wait_for_completion`
|
::: /root/linux/rust/bindings/bindings_generated.rs:33440:5
|
33440 | pub fn __wait_for_completion(arg1: *mut completion);
| ---------------------------------------------------- similarly named function `__wait_for_completion` defined here
error: aborting due to 1 previous error
For more information about this error, try `rustc --explain E0425`.
```I think Danilo already made it clear, please fold this the existing patch. Moreover, since this patchset doesn't adjust init_completion() from the Rust side, the result is Rust code will also use the same dept key for completion, which has to be fixed if dept wants to be in-tree.
Regards,
Boqun
Quoted 21 lines
Signed-off-by Guangbo Cui <[email protected]>--- rust/helpers/completion.c | 5 +++++ 1 file changed, 5 insertions(+)rust/helpers/completion.c +5
-0@@ -6,3 +6,8 @@ void rust_helper_init_completion(struct completion *x) {init_completion (x); } + +void rust_helper_wait_for_completion (struct completion *x) +{ +wait_for_completion (x); +}Signature · 1 line
2.43.0
Re: [PATCH] rust: bindings: add `rust_helper_wait_for_completion` helper function
Quoted 54 lines · Boqun Feng
Quoted 53 lines · Guangbo Cui
Quoted 25 lines
(quoted diff) +9
-9-extern void wait_for_completion(struct completion *); -extern void wait_for_completion_io(struct completion *); -extern int wait_for_completion_interruptible(struct completion *x); -extern int wait_for_completion_killable(struct completion *x); -extern int wait_for_completion_state(struct completion *x, unsigned int state); -extern unsigned long wait_for_completion_timeout(struct completion *x, +extern void __wait_for_completion(struct completion *); +extern void __wait_for_completion_io(struct completion *); +extern int __wait_for_completion_interruptible(struct completion *x); +extern int __wait_for_completion_killable(struct completion *x); +extern int __wait_for_completion_state(struct completion *x, unsigned int state); +extern unsigned long __wait_for_completion_timeout(struct completion *x, unsigned long timeout); -extern unsigned long wait_for_completion_io_timeout(struct completion *x, +extern unsigned long __wait_for_completion_io_timeout(struct completion *x, unsigned long timeout); -extern long wait_for_completion_interruptible_timeout( +extern long __wait_for_completion_interruptible_timeout( struct completion *x, unsigned long timeout); -extern long wait_for_completion_killable_timeout( +extern long __wait_for_completion_killable_timeout( struct completion *x, unsigned long timeout); extern bool try_wait_for_completion(struct completion *x); extern bool completion_done(struct completion *x);Review extern void complete(struct completion *); · line 142
Quoted 9 lines
(quoted diff) +6
-0@@ -139,4 +134,79 @@ extern void complete(struct completion *); extern void complete_on_current_cpu(struct completion *x); extern void complete_all(struct completion *); +#define wait_for_completion(x) \ +({ \ + sdt_might_sleep_start_timeout(NULL, -1L); \ + __wait_for_completion(x); \ + sdt_might_sleep_end(); \ +})The DEPT patch series changed
wait_for_completioninto a macro. Because bindgen cannot handle function-like macros, this caused Rust build errors. Add a helper function to fix it.```
error[E0425]: cannot find functionwait_for_completionin cratebindings--> rust/kernel/sync/completion.rs:110:28 | 110 | unsafe { bindings::wait_for_completion(self.as_raw()) }; | ^^^^^^^^^^^^^^^^^^^ help: a function with a similar name exists: `__wait_for_completion` | ::: /root/linux/rust/bindings/bindings_generated.rs:33440:5 | 33440 | pub fn __wait_for_completion(arg1: *mut completion); | ---------------------------------------------------- similarly named function `__wait_for_completion` defined hereerror: aborting due to 1 previous error
Quoted 8 lines
Quoted 3 lines
For more information about this error, try
rustc --explain E0425. ```I think Danilo already made it clear, please fold this the existing patch. Moreover, since this patchset doesn't adjust
init_completion()from the Rust side, the result is Rust code will also use the same dept key for completion, which has to be fixed if dept wants to be in-tree.
Thank you for informing that. I will take a look on it.
Byungchul
Quoted 25 lines
Regards,
BoqunQuoted 21 lines
Signed-off-by Guangbo Cui <[email protected]>--- rust/helpers/completion.c | 5 +++++ 1 file changed, 5 insertions(+)rust/helpers/completion.c +5
-1@@ -6,3 +6,8 @@ void rust_helper_init_completion(struct completion *x) {init_completion (x); } + +void rust_helper_wait_for_completion (struct completion *x) +{ +wait_for_completion (x); +} --2.43.0
Re: [PATCH] rust: bindings: add `rust_helper_wait_for_completion` helper function
Quoted 59 lines · Byungchul Park
Quoted 58 lines · Boqun Feng
Quoted 56 lines · Guangbo Cui
Quoted 25 lines
(quoted diff) +9
-9-extern void wait_for_completion(struct completion *); -extern void wait_for_completion_io(struct completion *); -extern int wait_for_completion_interruptible(struct completion *x); -extern int wait_for_completion_killable(struct completion *x); -extern int wait_for_completion_state(struct completion *x, unsigned int state); -extern unsigned long wait_for_completion_timeout(struct completion *x, +extern void __wait_for_completion(struct completion *); +extern void __wait_for_completion_io(struct completion *); +extern int __wait_for_completion_interruptible(struct completion *x); +extern int __wait_for_completion_killable(struct completion *x); +extern int __wait_for_completion_state(struct completion *x, unsigned int state); +extern unsigned long __wait_for_completion_timeout(struct completion *x, unsigned long timeout); -extern unsigned long wait_for_completion_io_timeout(struct completion *x, +extern unsigned long __wait_for_completion_io_timeout(struct completion *x, unsigned long timeout); -extern long wait_for_completion_interruptible_timeout( +extern long __wait_for_completion_interruptible_timeout( struct completion *x, unsigned long timeout); -extern long wait_for_completion_killable_timeout( +extern long __wait_for_completion_killable_timeout( struct completion *x, unsigned long timeout); extern bool try_wait_for_completion(struct completion *x); extern bool completion_done(struct completion *x);Review extern void complete(struct completion *); · line 142
Quoted 9 lines
(quoted diff) +6
-0@@ -139,4 +134,79 @@ extern void complete(struct completion *); extern void complete_on_current_cpu(struct completion *x); extern void complete_all(struct completion *); +#define wait_for_completion(x) \ +({ \ + sdt_might_sleep_start_timeout(NULL, -1L); \ + __wait_for_completion(x); \ + sdt_might_sleep_end(); \ +})The DEPT patch series changed
wait_for_completioninto a macro. Because bindgen cannot handle function-like macros, this caused Rust build errors. Add a helper function to fix it.``` error[E0425]: cannot find function `wait_for_completion` in crate `bindings` --> rust/kernel/sync/completion.rs:110:28 | 110 | unsafe { bindings::wait_for_completion(self.as_raw()) }; | ^^^^^^^^^^^^^^^^^^^ help: a function with a similar name exists: `__wait_for_completion` | ::: /root/linux/rust/bindings/bindings_generated.rs:33440:5 | 33440 | pub fn __wait_for_completion(arg1: *mut completion); | ---------------------------------------------------- similarly named function `__wait_for_completion` defined here error: aborting due to 1 previous error For more information about this error, try `rustc --explain E0425`. ```
Quoted 6 lines
Quoted 4 lines
I think Danilo already made it clear, please fold this the existing patch. Moreover, since this patchset doesn't adjust
init_completion()from the Rust side, the result is Rust code will also use the same dept key for completion, which has to be fixed if dept wants to be in-tree.Thank you for informing that. I will take a look on it.
It looks not easy unless Rust side uses explicit maps for that purpose. I think there are the same issues in 'lockdep + typical lock' too. How does lockdep deal with the issue? Use explicit keys for that?
Byungchul
Quoted 27 lines
Byungchul
Quoted 25 lines
Regards,
BoqunQuoted 21 lines
Signed-off-by Guangbo Cui <[email protected]>--- rust/helpers/completion.c | 5 +++++ 1 file changed, 5 insertions(+)rust/helpers/completion.c +5
-1@@ -6,3 +6,8 @@ void rust_helper_init_completion(struct completion *x) {init_completion (x); } + +void rust_helper_wait_for_completion (struct completion *x) +{ +wait_for_completion (x); +} --2.43.0
Re: [PATCH] rust: bindings: add `rust_helper_wait_for_completion` helper function
In reply to Boqun FengQuoted 54 lines · Boqun Feng
Quoted 53 lines · Guangbo Cui
Quoted 25 lines
(quoted diff) +9
-9-extern void wait_for_completion(struct completion *); -extern void wait_for_completion_io(struct completion *); -extern int wait_for_completion_interruptible(struct completion *x); -extern int wait_for_completion_killable(struct completion *x); -extern int wait_for_completion_state(struct completion *x, unsigned int state); -extern unsigned long wait_for_completion_timeout(struct completion *x, +extern void __wait_for_completion(struct completion *); +extern void __wait_for_completion_io(struct completion *); +extern int __wait_for_completion_interruptible(struct completion *x); +extern int __wait_for_completion_killable(struct completion *x); +extern int __wait_for_completion_state(struct completion *x, unsigned int state); +extern unsigned long __wait_for_completion_timeout(struct completion *x, unsigned long timeout); -extern unsigned long wait_for_completion_io_timeout(struct completion *x, +extern unsigned long __wait_for_completion_io_timeout(struct completion *x, unsigned long timeout); -extern long wait_for_completion_interruptible_timeout( +extern long __wait_for_completion_interruptible_timeout( struct completion *x, unsigned long timeout); -extern long wait_for_completion_killable_timeout( +extern long __wait_for_completion_killable_timeout( struct completion *x, unsigned long timeout); extern bool try_wait_for_completion(struct completion *x); extern bool completion_done(struct completion *x);Review extern void complete(struct completion *); · line 142
Quoted 9 lines
(quoted diff) +6
-0@@ -139,4 +134,79 @@ extern void complete(struct completion *); extern void complete_on_current_cpu(struct completion *x); extern void complete_all(struct completion *); +#define wait_for_completion(x) \ +({ \ + sdt_might_sleep_start_timeout(NULL, -1L); \ + __wait_for_completion(x); \ + sdt_might_sleep_end(); \ +})The DEPT patch series changed
wait_for_completioninto a macro. Because bindgen cannot handle function-like macros, this caused Rust build errors. Add a helper function to fix it.```
error[E0425]: cannot find functionwait_for_completionin cratebindings--> rust/kernel/sync/completion.rs:110:28 | 110 | unsafe { bindings::wait_for_completion(self.as_raw()) }; | ^^^^^^^^^^^^^^^^^^^ help: a function with a similar name exists: `__wait_for_completion` | ::: /root/linux/rust/bindings/bindings_generated.rs:33440:5 | 33440 | pub fn __wait_for_completion(arg1: *mut completion); | ---------------------------------------------------- similarly named function `__wait_for_completion` defined hereerror: aborting due to 1 previous error
Quoted 8 lines
Quoted 3 lines
For more information about this error, try
rustc --explain E0425. ```I think Danilo already made it clear, please fold this the existing patch. Moreover, since this patchset doesn't adjust
init_completion()from the Rust side, the result is Rust code will also use the same dept key for completion, which has to be fixed if dept wants to be in-tree.
Right. The same key in Rust may generate false positives. However, for now, I will keep the current code until finding ways to assign appropriate keys in Rust. Thanks anyway.
Byungchul
Quoted 24 lines
Regards,
BoqunQuoted 21 lines
Signed-off-by Guangbo Cui <[email protected]>--- rust/helpers/completion.c | 5 +++++ 1 file changed, 5 insertions(+)rust/helpers/completion.c +5
-1@@ -6,3 +6,8 @@ void rust_helper_init_completion(struct completion *x) {init_completion (x); } + +void rust_helper_wait_for_completion (struct completion *x) +{ +wait_for_completion (x); +} --2.43.0
PATCH v17 37/47 completion, dept: introduce init_completion_dmap() API
In reply to Byungchul ParkCurrently, dept uses dept's map embedded in task_struct to track dependencies related to wait_for_completion() and its family. So it doesn't need an explicit map basically.
However, for those who want to set the maps with customized class or key, introduce a new API to use external maps.
--- include/linux/completion.h | 40 +++++++++++++++++++++----------------- 1 file changed, 22 insertions(+), 18 deletions(-)
include/linux/completion.h +22 -18
@@ -27,17 +27,15 @@struct completion {unsigned int done;struct swait_queue_head wait; +struct dept_map *dmap; }; -#define init_completion (x) \ -do { \ - __init_completion(x); \ -} while (0) +#define init_completion (x) init_completion_dmap(x, NULL)/* -* XXX: No use cases for now. Fill the body when needed. +* XXX: This usage using lockdep's map should be deprecated. */ -#define init_completion_map (x, m) init_completion(x) +#define init_completion_map (x, m) init_completion_dmap(x, NULL)static inline void complete_acquire (struct completion *x,long timeout) {
@@ -48,8 +46,11 @@ static inline void complete_release(struct completion *x) }#define COMPLETION_INITIALIZER (work) \ - { 0, __SWAIT_QUEUE_HEAD_INITIALIZER((work).wait), } + { 0, __SWAIT_QUEUE_HEAD_INITIALIZER((work).wait), .dmap = NULL, } +/* +* XXX: This usage using lockdep's map should be deprecated. +*/ #define COMPLETION_INITIALIZER_ONSTACK_MAP (work, map) \ (*({ init_completion_map(&(work), &(map)); &(work); }))
@@ -90,15 +91,18 @@ static inline void complete_release(struct completion *x)#endif /** -* __init_completion - Initialize a dynamically allocated completion +* init_completion_dmap - Initialize a dynamically allocated completion * @x: pointer to completion structure that is to be initialized +* @dmap: pointer to external dept's map to be used as a separated map * * This inline function will initialize a dynamically created completion * structure. */ -static inline void __init_completion (struct completion *x) +static inline void init_completion_dmap (struct completion *x, +struct dept_map *dmap) { x->done =0 ; + x->dmap = dmap;init_swait_queue_head (&x->wait); }
@@ -136,13 +140,13 @@ extern void complete_all(struct completion *);#define wait_for_completion (x) \ ({ \ - sdt_might_sleep_start_timeout(NULL, -1L); \ + sdt_might_sleep_start_timeout((x)->dmap, -1L); \ __wait_for_completion(x); \ sdt_might_sleep_end(); \ })#define wait_for_completion_io (x) \ ({ \ - sdt_might_sleep_start_timeout(NULL, -1L); \ + sdt_might_sleep_start_timeout((x)->dmap, -1L); \ __wait_for_completion_io(x); \ sdt_might_sleep_end(); \ })
@@ -150,7 +154,7 @@ extern void complete_all(struct completion *); ({ \ int __ret; \ \ - sdt_might_sleep_start_timeout(NULL, -1L); \ + sdt_might_sleep_start_timeout((x)->dmap, -1L); \ __ret = __wait_for_completion_interruptible(x); \ sdt_might_sleep_end(); \ __ret; \
@@ -159,7 +163,7 @@ extern void complete_all(struct completion *); ({ \ int __ret; \ \ - sdt_might_sleep_start_timeout(NULL, -1L); \ + sdt_might_sleep_start_timeout((x)->dmap, -1L); \ __ret = __wait_for_completion_killable(x); \ sdt_might_sleep_end(); \ __ret; \
@@ -168,7 +172,7 @@ extern void complete_all(struct completion *); ({ \ int __ret; \ \ - sdt_might_sleep_start_timeout(NULL, -1L); \ + sdt_might_sleep_start_timeout((x)->dmap, -1L); \ __ret = __wait_for_completion_state(x, s); \ sdt_might_sleep_end(); \ __ret; \
@@ -177,7 +181,7 @@ extern void complete_all(struct completion *); ({ \ unsigned long __ret; \ \ - sdt_might_sleep_start_timeout(NULL, t); \ + sdt_might_sleep_start_timeout((x)->dmap, t); \ __ret = __wait_for_completion_timeout(x, t); \ sdt_might_sleep_end(); \ __ret; \
@@ -186,7 +190,7 @@ extern void complete_all(struct completion *); ({ \ unsigned long __ret; \ \ - sdt_might_sleep_start_timeout(NULL, t); \ + sdt_might_sleep_start_timeout((x)->dmap, t); \ __ret = __wait_for_completion_io_timeout(x, t); \ sdt_might_sleep_end(); \ __ret; \
@@ -195,7 +199,7 @@ extern void complete_all(struct completion *); ({ \ long __ret; \ \ - sdt_might_sleep_start_timeout(NULL, t); \ + sdt_might_sleep_start_timeout((x)->dmap, t); \ __ret = __wait_for_completion_interruptible_timeout(x, t); \ sdt_might_sleep_end(); \ __ret; \
@@ -204,7 +208,7 @@ extern void complete_all(struct completion *); ({ \ long __ret; \ \ - sdt_might_sleep_start_timeout(NULL, t); \ + sdt_might_sleep_start_timeout((x)->dmap, t); \ __ret = __wait_for_completion_killable_timeout(x, t); \ sdt_might_sleep_end(); \ __ret; \
Signature · 1 line
2.17.1
PATCH v17 38/47 dept: introduce a new type of dependency tracking between multi event sites
In reply to Byungchul ParkIt's worth reporting wait-event circular dependency even if it doesn't lead to an actual deadlock, because it's a good information about a circular dependency anyway. However, it should be suppressed once turning out it doesn't lead an actual deadlock, for instance, there are other wake-up(or event) paths.
The report needs to be suppressed by annotating that an event can be recovered by other sites triggering the desired wake-up, using a newly introduced API, dept_recover_event() specifying an event site and its recover site.
By the introduction, need of a new type of dependency tracking arises since a loop of recover dependency could trigger another type of deadlock. So implement a logic to track the new type of dependency between multi event sites for a single wait.
Lastly, to make sure that recover sites must be used in code, introduce a section '.dept.event_sites' to mark it as 'used' only if used in code, and warn it if dept_recover_event()s are annotated with recover sites, not used in code.
--- include/asm-generic/vmlinux.lds.h | 13 +- include/linux/dept.h | 91 ++++++++++++++ kernel/dependency/dept.c | 196 ++++++++++++++++++++++++++++++ 3 files changed, 299 insertions(+), 1 deletion(-)
include/asm-generic/vmlinux.lds.h +12 -1
@@ -700,6 +700,16 @@ defined(CONFIG_AUTOFDO_CLANG) || defined(CONFIG_PROPELLER_CLANG)#define KERNEL_CTORS ()#endif +#ifdef CONFIG_DEPT +#define DEPT_EVNET_SITES_USED () \ + . = ALIGN(8); \ + __dept_event_sites_start = .; \ + KEEP(*(.dept.event_sites)) \ + __dept_event_sites_end = .; +#else +#define DEPT_EVNET_SITES_USED () +#endif +/* init and exit section handling */ #define INIT_DATA \ KEEP(*(SORT(___kentry+*))) \
@@ -724,7 +734,8 @@ defined(CONFIG_AUTOFDO_CLANG) || defined(CONFIG_PROPELLER_CLANG) EARLYCON_TABLE() \ LSM_TABLE() \ EARLY_LSM_TABLE() \ - KUNIT_INIT_TABLE() + KUNIT_INIT_TABLE() \ + DEPT_EVNET_SITES_USED()#define INIT_TEXT \ *(.init.text .init.text.*) \
include/linux/dept.h +91 -0
121 lines not on this page · raw message
kernel/dependency/dept.c +196 -0
216 lines not on this page · raw message
Signature · 1 line
2.17.1
PATCH v17 39/47 dept: add module support for struct dept_event_site and dept_event_site_dep
In reply to Byungchul Parkstruct dept_event_site and struct dept_event_site_dep have been introduced to track dependencies between multi event sites for a single wait, that will be loaded to data segment. Plus, a custom section, '.dept.event_sites', also has been introduced to keep pointers to the objects to make sure all the event sites defined exist in code.
dept should work with the section and segment of module. Add the support to handle the section and segment properly whenever modules are loaded and unloaded.
--- include/linux/dept.h | 14 +++++++ include/linux/module.h | 5 +++ kernel/dependency/dept.c | 79 +++++++++++++++++++++++++++++++++++----- kernel/module/main.c | 15 ++++++++ 4 files changed, 103 insertions(+), 10 deletions(-)
include/linux/dept.h +14 -0
@@ -414,6 +414,11 @@ struct dept_event_site {struct dept_event_site *bfs_parent;struct list_head bfs_node; +/* +* for linking all dept_event_site's +*/ +struct list_head all_node; +/* * flag indicating the event is not only declared but also * actually used in code
@@ -430,6 +435,11 @@ struct dept_event_site_dep {*/ struct list_head dep_node;struct list_head dep_rev_node; + +/* +* for linking all dept_event_site_dep's +*/ +struct list_head all_node; };#define DEPT_EVENT_SITE_INITIALIZER (es) \
@@ -441,6 +451,7 @@ struct dept_event_site_dep { .bfs_gen = 0, \ .bfs_parent = NULL, \ .bfs_node = LIST_HEAD_INIT((es).bfs_node), \ + .all_node = LIST_HEAD_INIT((es).all_node), \ .used = false, \ }
@@ -450,6 +461,7 @@ struct dept_event_site_dep { .recover_site = NULL, \ .dep_node = LIST_HEAD_INIT((esd).dep_node), \ .dep_rev_node = LIST_HEAD_INIT((esd).dep_rev_node), \ + .all_node = LIST_HEAD_INIT((esd).all_node), \ }struct dept_event_site_init {
@@ -473,6 +485,7 @@ extern void dept_init(void);extern void dept_task_init (struct task_struct *t);extern void dept_task_exit (struct task_struct *t);extern void dept_free_range (void *start,unsigned int sz); +extern void dept_mark_event_site_used (void *start,void *end);extern void dept_map_init (struct dept_map *m,struct dept_key *k,int sub_u,const char *n);extern void dept_map_reinit (struct dept_map *m,struct dept_key *k,int sub_u,const char *n);
@@ -536,6 +549,7 @@ struct dept_event_site { };#define dept_task_init (t) do { } while (0)#define dept_task_exit (t) do { } while (0)#define dept_free_range (s, sz) do { } while (0) +#define dept_mark_event_site_used (s, e) do { } while (0)#define dept_map_init (m, k, su, n) do { (void)(n); (void)(k); } while (0)#define dept_map_reinit (m, k, su, n) do { (void)(n); (void)(k); } while (0)
include/linux/module.h +5 -0
@@ -29,6 +29,7 @@#include <linux/srcu.h> #include <linux/static_call_types.h> #include <linux/dynamic_debug.h> +#include <linux/dept.h> #include <linux/percpu.h> #include <asm/module.h>
@@ -579,6 +580,10 @@ struct module {#ifdef CONFIG_DYNAMIC_DEBUG_CORE struct _ddebug_info dyndbg_info;#endif +#ifdef CONFIG_DEPT +struct dept_event_site **dept_event_sites; +unsigned int num_dept_event_sites; +#endif }____cacheline_aligned __randomize_layout;#ifndef MODULE_ARCH_INIT #define MODULE_ARCH_INIT {}
kernel/dependency/dept.c +69 -10
125 lines not on this page · raw message
kernel/module/main.c +15 -0
@@ -2720,6 +2720,11 @@ static int find_module_sections(struct module *mod, struct load_info *info) &mod->dyndbg_info.num_classes);#endif +#ifdef CONFIG_DEPT + mod->dept_event_sites =section_objs (info,".dept.event_sites" , +sizeof (*mod->dept_event_sites), + &mod->num_dept_event_sites); +#endif return 0 ; }
@@ -3346,6 +3351,14 @@ static int early_mod_check(struct load_info *info, int flags)return err; } +static void dept_mark_event_site_used_module (struct module *mod) +{ +#ifdef CONFIG_DEPT +dept_mark_event_site_used (mod->dept_event_sites, + mod->dept_event_sites + mod->num_dept_event_sites); +#endif +} +/* * Allocate and load the module: note that size of section 0 is always * zero, and we rely on this for optional sections.
@@ -3508,6 +3521,8 @@ static int load_module(struct load_info *info, const char __user *uargs,/* Done! */ trace_module_load (mod); +dept_mark_event_site_used_module (mod); +return do_init_module (mod); sysfs_cleanup:
Signature · 1 line
2.17.1
PATCH v17 40/47 dept: introduce event_site() to disable event tracking if it's recoverable
In reply to Byungchul ParkWith multi event sites for a single wait, dept allows to skip tracking an event that is recoverable by other recover paths.
Introduce an API, event_site(), to skip tracking the event in the case.
--- include/linux/dept.h | 30 ++++++++++++++++++++++++++++++ include/linux/sched.h | 6 ++++++ kernel/dependency/dept.c | 20 ++++++++++++++++++++ 3 files changed, 56 insertions(+)
include/linux/dept.h +30 -0
@@ -487,6 +487,31 @@ extern void dept_task_exit(struct task_struct *t);extern void dept_free_range (void *start,unsigned int sz);extern void dept_mark_event_site_used (void *start,void *end); +extern void disable_event_track (void ); +extern void enable_event_track (void ); + +#define event_site (es, evt_func, ...) \ +do { \ + unsigned long _flags; \ + bool _disable; \ + \ + local_irq_save(_flags); \ + dept_event_site_used(es); \ +/* \ +* If !list_empty(&(es)->dept_head), the event site can be \ +* recovered by others. Do not track event dependency if so. \ +*/ \ + _disable = !list_empty (&(es)->dep_head); \ +if (_disable) \ +disable_event_track (); \ + \ +evt_func (__VA_ARGS__); \ + \ +if (_disable) \ +enable_event_track (); \ +local_irq_restore (_flags); \ +}while (0 ) + extern void dept_map_init(struct dept_map *m, struct dept_key *k, int sub_u, const char *n);extern void dept_map_reinit (struct dept_map *m,struct dept_key *k,int sub_u,const char *n);extern void dept_ext_wgen_init (struct dept_ext_wgen *ewg);
@@ -550,6 +575,11 @@ struct dept_event_site { };#define dept_task_exit (t) do { } while (0)#define dept_free_range (s, sz) do { } while (0)#define dept_mark_event_site_used (s, e) do { } while (0) +#define event_site (es, evt_func, ...) \ +do { \ + (void)(es); \ + evt_func(__VA_ARGS__); \ +} while (0)#define dept_map_init (m, k, su, n) do { (void)(n); (void)(k); } while (0)#define dept_map_reinit (m, k, su, n) do { (void)(n); (void)(k); } while (0)
include/linux/sched.h +6 -0
@@ -876,6 +876,11 @@ struct dept_task {*/ int missing_ecxt; +/* +* not to track events +*/ +int disable_event_track_cnt; +/* * for tracking IRQ-enable state */
@@ -913,6 +918,7 @@ struct dept_task { .stage_wait_stack = NULL, \ .stage_lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED,\ .missing_ecxt = 0, \ + .disable_event_track_cnt = 0, \ .hardirqs_enabled = false, \ .softirqs_enabled = false, \ .task_exit = false, \
kernel/dependency/dept.c +20 -0
@@ -2573,6 +2573,23 @@ static void __dept_wait(struct dept_map *m, unsigned long w_f, } } +void disable_event_track (void ) +{ +dept_task ()->disable_event_track_cnt++; +} +EXPORT_SYMBOL_GPL (disable_event_track); + +void enable_event_track (void ) +{ +dept_task ()->disable_event_track_cnt--; +} +EXPORT_SYMBOL_GPL (enable_event_track); + +static bool event_track_disabled (void ) +{ +return !!dept_task ()->disable_event_track_cnt; +} +/* * Called between dept_enter() and dept_exit(). */
@@ -2585,6 +2602,9 @@ static void __dept_event(struct dept_map *m, struct dept_map *real_m,struct dept_key *k;int e; +if (event_track_disabled ()) +return ; + e =find_first_bit (&e_f,DEPT_MAX_SUBCLASSES_EVT );if (DEPT_WARN_ON (e >=DEPT_MAX_SUBCLASSES_EVT ))
Signature · 1 line
2.17.1
PATCH v17 41/47 dept: implement a basic unit test for dept
In reply to Byungchul ParkImplement CONFIG_DEPT_UNIT_TEST introducing a kernel module that runs basic unit test for dept.
--- include/linux/dept_unit_test.h | 67 +++++++++++ kernel/dependency/Makefile | 1 + kernel/dependency/dept.c | 12 ++ kernel/dependency/dept_unit_test.c | 173 +++++++++++++++++++++++++++++ lib/Kconfig.debug | 12 ++ 5 files changed, 265 insertions(+) create mode 100644 include/linux/dept_unit_test.h create mode 100644 kernel/dependency/dept_unit_test.c
include/linux/dept_unit_test.h new file +67 -0
@@ -0,0 +1,67 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* +* DEPT unit test +* +* Started by Byungchul Park <[email protected]>: +* +* Copyright (c) 2025 SK hynix, Inc., Byungchul Park +*/ + +#ifndef __LINUX_DEPT_UNIT_TEST_H +#define __LINUX_DEPT_UNIT_TEST_H + +#if defined(CONFIG_DEPT_UNIT_TEST ) || defined(CONFIG_DEPT_UNIT_TEST_MODULE ) +struct dept_ut { +bool circle_detected; +bool recover_circle_detected; + +int ecxt_stack_total_cnt; +int wait_stack_total_cnt; +int evnt_stack_total_cnt; +int ecxt_stack_valid_cnt; +int wait_stack_valid_cnt; +int evnt_stack_valid_cnt; +}; + +extern struct dept_ut dept_ut_results; + +static inline void dept_ut_circle_detect (void ) +{ + dept_ut_results.circle_detected = true; +} +static inline void dept_ut_recover_circle_detect (void ) +{ + dept_ut_results.recover_circle_detected = true; +} +static inline void dept_ut_ecxt_stack_account (bool valid) +{ + dept_ut_results.ecxt_stack_total_cnt++; + +if (valid) + dept_ut_results.ecxt_stack_valid_cnt++; +} +static inline void dept_ut_wait_stack_account (bool valid) +{ + dept_ut_results.wait_stack_total_cnt++; + +if (valid) + dept_ut_results.wait_stack_valid_cnt++; +} +static inline void dept_ut_evnt_stack_account (bool valid) +{ + dept_ut_results.evnt_stack_total_cnt++; + +if (valid) + dept_ut_results.evnt_stack_valid_cnt++; +} +#else +struct dept_ut {}; + +#define dept_ut_circle_detect () do { } while (0) +#define dept_ut_recover_circle_detect () do { } while (0) +#define dept_ut_ecxt_stack_account (v) do { } while (0) +#define dept_ut_wait_stack_account (v) do { } while (0) +#define dept_ut_evnt_stack_account (v) do { } while (0) + +#endif +#endif /* __LINUX_DEPT_UNIT_TEST_H */
kernel/dependency/Makefile +1 -0
@@ -2,3 +2,4 @@ obj-$(CONFIG_DEPT) += dept.o obj-$(CONFIG_DEPT) += dept_proc.o +obj-$(CONFIG_DEPT_UNIT_TEST) += dept_unit_test.o
kernel/dependency/dept.c +12 -0
@@ -78,8 +78,12 @@#include <linux/workqueue.h> #include <linux/irq_work.h> #include <linux/vmalloc.h> +#include <linux/dept_unit_test.h> #include "dept_internal.h" +struct dept_ut dept_ut_results; +EXPORT_SYMBOL_GPL (dept_ut_results); +static int dept_stop;static int dept_per_cpu_ready;
@@ -826,6 +830,10 @@ static void print_dep(struct dept_dep *d)pr_warn ("(wait to wake up)\n" );print_ip_stack (0 , e->ewait_stack); } + +dept_ut_ecxt_stack_account (valid_stack (e->ecxt_stack)); +dept_ut_wait_stack_account (valid_stack (w->wait_stack)); +dept_ut_evnt_stack_account (valid_stack (e->event_stack)); } }
@@ -920,6 +928,8 @@ static void print_circle(struct dept_class *c)dump_stack ();dept_outworld_exit (); + +dept_ut_circle_detect (); }/*
@@ -1021,6 +1031,8 @@ static void print_recover_circle(struct dept_event_site *es)dump_stack ();dept_outworld_exit (); + +dept_ut_recover_circle_detect (); }static void bfs_init_recover (void *node,void *in,void **out)
kernel/dependency/dept_unit_test.c new file +173 -0
173 lines not on this page · raw message
lib/Kconfig.debug +12 -0
@@ -1404,6 +1404,18 @@ config DEPT_AGGRESSIVE_TIMEOUT_WAIT that timeout is used to avoid a deadlock. Say N if you'd like to avoid verbose reports. +config DEPT_UNIT_TEST + tristate "unit test for DEPT" + depends on DEBUG_KERNEL && DEPT + default n + help + This option provides a kernel module that runs unit test for + DEPT. + + Say Y if you want DEPT unit test to be built into the kernel. + Say M if you want DEPT unit test to build as a module. + Say N if you are unsure. + config LOCK_DEBUGGING_SUPPORT bool depends on TRACE_IRQFLAGS_SUPPORT && STACKTRACE_SUPPORT && LOCKDEP_SUPPORT
Signature · 1 line
2.17.1
PATCH v17 42/47 dept: call dept_hardirqs_off() in local_irq_*() regardless of irq state
In reply to Byungchul ParkFor dept to function properly, dept_task()->hardirqs_enabled must be set correctly. If it fails to set this value to false, for example, dept may mistakenly think irq is still enabled even when it's not.
Do dept_hardirqs_off() regardless of irq state not to miss any unexpected cases by any chance e.g. changes of the state by asm code.
--- include/linux/irqflags.h | 14 ++++++++++++++ kernel/dependency/dept.c | 1 + 2 files changed, 15 insertions(+)
include/linux/irqflags.h +14 -0
@@ -214,6 +214,13 @@ extern void warn_bogus_irq_restore(void);raw_local_irq_disable (); \if (!was_disabled) \trace_hardirqs_off (); \ +/* \ +* Just in case that C code has missed \ +* trace_hardirqs_off() at the first \ +* place e.g. disabling irq at asm code.\ +*/ \ +else \ +dept_hardirqs_off (); \ }while (0 ) #define local_irq_save(flags) \
@@ -221,6 +228,13 @@ extern void warn_bogus_irq_restore(void);raw_local_irq_save (flags); \if (!raw_irqs_disabled_flags (flags)) \trace_hardirqs_off (); \ +/* \ +* Just in case that C code has missed \ +* trace_hardirqs_off() at the first \ +* place e.g. disabling irq at asm code.\ +*/ \ +else \ +dept_hardirqs_off (); \ }while (0 ) #define local_irq_restore(flags) \
kernel/dependency/dept.c +1 -0
@@ -2248,6 +2248,7 @@ void noinstr dept_hardirqs_off(void)*/ dept_task ()->hardirqs_enabled = false; } +EXPORT_SYMBOL_GPL (dept_hardirqs_off); void noinstr dept_update_cxt(void) {
Signature · 1 line
2.17.1
PATCH v17 43/47 rcu/update: fix same dept key collision between various types of RCU
In reply to Byungchul ParkThe current implementation shares the same dept key for multiple synchronization points, which can lead to false positive reports in dependency tracking and potential confusion in debugging. For example, both normal RCU and tasks trace RCU synchronization points use the same dept key. Specifically:
1. synchronize_rcu() uses a dept key embedded in __wait_rcu_gp():
synchronize_rcu()
synchronize_rcu_normal()
_wait_rcu_gp()
__wait_rcu_gp() <- the key as static variable
2. synchronize_rcu_tasks_trace() uses the dept key, too:
synchronize_rcu_tasks_trace()
synchronize_rcu_tasks_generic()
_wait_rcu_gp()
__wait_rcu_gp() <- the key as static variable
Since the both rely on the same dept key, dept may report false positive circular dependency. To resolve this, separate dept keys and maps should be assigned to each struct rcu_synchronize.
===================================================
DEPT: Circular dependency has been detected.
6.15.0-rc6-00042-ged94bafc6405 #2 Not tainted
---------------------------------------------------
summary
---------------------------------------------------
*** DEADLOCK ***
context A
[S] lock(cpu_hotplug_lock:0)
[W] __wait_rcu_gp(<sched>:0)
[E] unlock(cpu_hotplug_lock:0)context B
[S] (unknown)(<sched>:0)
[W] lock(cpu_hotplug_lock:0)
[E] try_to_wake_up(<sched>:0) [S]: start of the event context
[W]: the wait blocked
[E]: the event not reachable
---------------------------------------------------
context A's detail
---------------------------------------------------
context A
[S] lock(cpu_hotplug_lock:0)
[W] __wait_rcu_gp(<sched>:0)
[E] unlock(cpu_hotplug_lock:0) [S] lock(cpu_hotplug_lock:0):
[<ffff8000802ce964>] cpus_read_lock+0x14/0x20
stacktrace:
percpu_down_read.constprop.0+0x88/0x2ec
cpus_read_lock+0x14/0x20
cgroup_procs_write_start+0x164/0x634
__cgroup_procs_write+0xdc/0x4d0
cgroup_procs_write+0x34/0x74
cgroup_file_write+0x25c/0x670
kernfs_fop_write_iter+0x2ec/0x498
vfs_write+0x574/0xc30
ksys_write+0x124/0x244
__arm64_sys_write+0x70/0xa4
invoke_syscall+0x88/0x2e0
el0_svc_common.constprop.0+0xe8/0x2e0
do_el0_svc+0x44/0x60
el0_svc+0x50/0x188
el0t_64_sync_handler+0x10c/0x140
el0t_64_sync+0x198/0x19c [W] __wait_rcu_gp(<sched>:0):
[<ffff8000804ce88c>] __wait_rcu_gp+0x324/0x498
stacktrace:
schedule+0xcc/0x348
schedule_timeout+0x1a4/0x268
__wait_for_common+0x1c4/0x3f0
__wait_for_completion_state+0x20/0x38
__wait_rcu_gp+0x35c/0x498
synchronize_rcu_normal+0x200/0x218
synchronize_rcu+0x234/0x2a0
rcu_sync_enter+0x11c/0x300
percpu_down_write+0xb4/0x3e0
cgroup_procs_write_start+0x174/0x634
__cgroup_procs_write+0xdc/0x4d0
cgroup_procs_write+0x34/0x74
cgroup_file_write+0x25c/0x670
kernfs_fop_write_iter+0x2ec/0x498
vfs_write+0x574/0xc30
ksys_write+0x124/0x244 [E] unlock(cpu_hotplug_lock:0):
(N/A)
---------------------------------------------------
context B's detail
---------------------------------------------------
context B
[S] (unknown)(<sched>:0)
[W] lock(cpu_hotplug_lock:0)
[E] try_to_wake_up(<sched>:0) [S] (unknown)(<sched>:0):
(N/A)
[W] lock(cpu_hotplug_lock:0):
[<ffff8000802ce964>] cpus_read_lock+0x14/0x20
stacktrace:
percpu_down_read.constprop.0+0x6c/0x2ec
cpus_read_lock+0x14/0x20
check_all_holdout_tasks_trace+0x90/0xa30
rcu_tasks_wait_gp+0x47c/0x938
rcu_tasks_one_gp+0x75c/0xef8
rcu_tasks_kthread+0x180/0x1dc
kthread+0x3ac/0x74c
ret_from_fork+0x10/0x20 [E] try_to_wake_up(<sched>:0):
[<ffff8000804233b8>] complete+0xb8/0x1e8
stacktrace:
try_to_wake_up+0x374/0x1164
complete+0xb8/0x1e8
wakeme_after_rcu+0x14/0x20
rcu_tasks_invoke_cbs+0x218/0xaa8
rcu_tasks_one_gp+0x834/0xef8
rcu_tasks_kthread+0x180/0x1dc
kthread+0x3ac/0x74c
ret_from_fork+0x10/0x20
(wait to wake up)
stacktrace:
__schedule+0xf64/0x3614
schedule+0xcc/0x348
schedule_timeout+0x1a4/0x268
__wait_for_common+0x1c4/0x3f0
__wait_for_completion_state+0x20/0x38
__wait_rcu_gp+0x35c/0x498
synchronize_rcu_tasks_generic+0x14c/0x220
synchronize_rcu_tasks_trace+0x24/0x8c
rcu_init_tasks_generic+0x168/0x194
do_one_initcall+0x174/0xa00
kernel_init_freeable+0x744/0x7dc
kernel_init+0x78/0x220
ret_from_fork+0x10/0x20Separating the dept key and map for each of struct rcu_synchronize, ensuring proper tracking for each execution context.
--- include/linux/rcupdate_wait.h | 13 ++++++++----- kernel/rcu/rcu.h | 1 + kernel/rcu/update.c | 5 +++-- 3 files changed, 12 insertions(+), 7 deletions(-)
include/linux/rcupdate_wait.h +8 -5
@@ -19,17 +19,20 @@ struct rcu_synchronize {/* This is for debugging. */ struct rcu_gp_oldstate oldstate; +struct dept_map dmap; +struct dept_key dkey; };void wakeme_after_rcu (struct rcu_head *head);void __wait_rcu_gp (bool checktiny,unsigned int state,int n,call_rcu_func_t *crcu_array, -struct rcu_synchronize *rs_array); +struct rcu_synchronize *rs_array,struct dept_key *dkey);#define _wait_rcu_gp (checktiny, state, ...) \ -do { \ - call_rcu_func_t __crcu_array[] = { __VA_ARGS__ }; \ - struct rcu_synchronize __rs_array[ARRAY_SIZE(__crcu_array)]; \ - __wait_rcu_gp(checktiny, state, ARRAY_SIZE(__crcu_array), __crcu_array, __rs_array); \ +do { \ + call_rcu_func_t __crcu_array[] = { __VA_ARGS__ }; \ + static struct dept_key __key; \ + struct rcu_synchronize __rs_array[ARRAY_SIZE(__crcu_array)]; \ + __wait_rcu_gp(checktiny, state, ARRAY_SIZE(__crcu_array), __crcu_array, __rs_array, &__key); \ } while (0)#define wait_rcu_gp (...) _wait_rcu_gp(false, TASK_UNINTERRUPTIBLE, __VA_ARGS__)
kernel/rcu/rcu.h +1 -0
@@ -12,6 +12,7 @@#include <linux/slab.h> #include <trace/events/rcu.h> +#include <linux/dept_sdt.h> /* * Grace-period counter management.
kernel/rcu/update.c +3 -2
@@ -409,7 +409,7 @@ void wakeme_after_rcu(struct rcu_head *head)EXPORT_SYMBOL_GPL (wakeme_after_rcu);void __wait_rcu_gp (bool checktiny,unsigned int state,int n,call_rcu_func_t *crcu_array, -struct rcu_synchronize *rs_array) +struct rcu_synchronize *rs_array,struct dept_key *dkey) {int i;int j;
@@ -426,7 +426,8 @@ void __wait_rcu_gp(bool checktiny, unsigned int state, int n, call_rcu_func_t *cbreak ;if (j == i) {init_rcu_head_on_stack (&rs_array[i].head); -init_completion (&rs_array[i].completion); +sdt_map_init_key (&rs_array[i].dmap, dkey); +init_completion_dmap (&rs_array[i].completion, &rs_array[i].dmap); (crcu_array[i])(&rs_array[i].head, wakeme_after_rcu); } }
Signature · 1 line
2.17.1
PATCH v17 44/47 dept: introduce APIs to set page usage and use subclasses_evt for the usage
In reply to Byungchul ParkFalse positive reports have been observed since dept works with the assumption that all the pages have the same dept class, but the class should be split since the problematic call paths are different depending on what the page is used for.
At least, ones in block device's address_space and ones in regular file's address_space have exclusively different usages.
Thus, define usage candidates like:
DEPT_PAGE_REGFILE_CACHE /* page in regular file's address_space */
DEPT_PAGE_BDEV_CACHE /* page in block device's address_space */
DEPT_PAGE_DEFAULT /* the others */
Introduce APIs to set each page's usage properly and make sure not to interact between at least between DEPT_PAGE_REGFILE_CACHE and DEPT_PAGE_BDEV_CACHE. However, besides the exclusive usages, allow any other combinations to interact to the other for example:
PG_locked for DEPT_PAGE_DEFAULT page can wait for PG_locked for DEPT_PAGE_REGFILE_CACHE page and vice versa.
PG_locked for DEPT_PAGE_DEFAULT page can wait for PG_locked for DEPT_PAGE_BDEV_CACHE page and vice versa.
PG_locked for DEPT_PAGE_DEFAULT page can wait for PG_locked for DEPT_PAGE_DEFAULT page.
--- include/linux/dept.h | 31 +++++++++++++++- include/linux/mm_types.h | 1 + include/linux/page-flags.h | 76 +++++++++++++++++++++++++++++++++++++- 3 files changed, 104 insertions(+), 4 deletions(-)
include/linux/dept.h +29 -2
@@ -21,8 +21,8 @@ struct task_struct;#define DEPT_MAX_WAIT_HIST 64#define DEPT_MAX_ECXT_HELD 48 -#define DEPT_MAX_SUBCLASSES 16 -#define DEPT_MAX_SUBCLASSES_EVT 2 +#define DEPT_MAX_SUBCLASSES 24 +#define DEPT_MAX_SUBCLASSES_EVT 3#define DEPT_MAX_SUBCLASSES_USR (DEPT_MAX_SUBCLASSES / DEPT_MAX_SUBCLASSES_EVT)#define DEPT_MAX_SUBCLASSES_CACHE 2
@@ -390,6 +390,32 @@ struct dept_ext_wgen {unsigned int wgen; }; +enum { +DEPT_PAGE_DEFAULT =0 , +DEPT_PAGE_REGFILE_CACHE ,/* regular file page cache */ +DEPT_PAGE_BDEV_CACHE ,/* block device cache */ +DEPT_PAGE_USAGE_NR ,/* nr of usages options */ +}; + +#define DEPT_PAGE_USAGE_SHIFT 16 +#define DEPT_PAGE_USAGE_MASK ((1U << DEPT_PAGE_USAGE_SHIFT) - 1) +#define DEPT_PAGE_USAGE_PENDING_MASK (DEPT_PAGE_USAGE_MASK << DEPT_PAGE_USAGE_SHIFT) + +/* +* Identify each page's usage type +*/ +struct dept_page_usage { +/* +* low 16 bits : the current usage type +* high 16 bits : usage type requested to be set +* +* Do not apply the type requested immediately but defer until +* after clearing PG_locked bit of the folio or page e.g. by +* folio_unlock(). +*/ +atomic_t type;/* Update and read atomically */ +}; +struct dept_event_site {/* * event site name
@@ -562,6 +588,7 @@ extern void dept_hardirqs_off(void);struct dept_key { };struct dept_map { };struct dept_ext_wgen { }; +struct dept_page_usage { };struct dept_event_site { };#define DEPT_MAP_INITIALIZER (n, k) { }
include/linux/mm_types.h +1 -0
@@ -224,6 +224,7 @@ struct page {struct page *kmsan_shadow;struct page *kmsan_origin;#endif +struct dept_page_usage usage;struct dept_ext_wgen pg_locked_wgen; } _struct_page_alignment;
include/linux/page-flags.h +74 -2
106 lines not on this page · raw message
Signature · 1 line
2.17.1
Re: [PATCH v17 44/47] dept: introduce APIs to set page usage and use subclasses_evt for the usage
Quoted 5 lines · Byungchul Park
False positive reports have been observed since dept works with the assumption that all the pages have the same dept class, but the class should be split since the problematic call paths are different depending on what the page is used for.
Quoted 8 lines
At least, ones in block device's
address_spaceand ones in regular file'saddress_spacehave exclusively different usages.Thus, define usage candidates like:
DEPT_PAGE_REGFILE_CACHE/* page in regular file'saddress_space*/
DEPT_PAGE_BDEV_CACHE/* page in block device'saddress_space*/
DEPT_PAGE_DEFAULT/* the others */
1. I'd like to annotate a page to DEPT_PAGE_REGFILE_CACHE when the page starts to be associated with a page cache for fs data.
2. And I'd like to annotate a page to DEPT_PAGE_BDEV_CACHE when the page starts to be associated with meta data of fs e.g. super block.
3. Lastly, I'd like to reset the annotated value if any, that has been set in the page, when the page ends the assoication with either page cache or meta block of fs e.g. freeing the page.
Can anyone suggest good places in code for the annotation 1, 2, 3? It'd be totally appreciated. :-)
Byungchul
Quoted 204 lines
Introduce APIs to set each page's usage properly and make sure not to interact between at least between
DEPT_PAGE_REGFILE_CACHEandDEPT_PAGE_BDEV_CACHE. However, besides the exclusive usages, allow any other combinations to interact to the other for example:
PG_lockedforDEPT_PAGE_DEFAULTpage can wait forPG_lockedforDEPT_PAGE_REGFILE_CACHEpage and vice versa.
PG_lockedforDEPT_PAGE_DEFAULTpage can wait forPG_lockedforDEPT_PAGE_BDEV_CACHEpage and vice versa.
PG_lockedforDEPT_PAGE_DEFAULTpage can wait forPG_lockedforDEPT_PAGE_DEFAULTpage.Signed-off-by Byungchul Park <[email protected]>--- include/linux/dept.h | 31 +++++++++++++++- include/linux/mm_types.h | 1 + include/linux/page-flags.h | 76 +++++++++++++++++++++++++++++++++++++- 3 files changed, 104 insertions(+), 4 deletions(-)include/linux/dept.h +29
-2@@ -21,8 +21,8 @@ struct task_struct;#define DEPT_MAX_WAIT_HIST 64#define DEPT_MAX_ECXT_HELD 48 -#define DEPT_MAX_SUBCLASSES 16 -#define DEPT_MAX_SUBCLASSES_EVT 2 +#define DEPT_MAX_SUBCLASSES 24 +#define DEPT_MAX_SUBCLASSES_EVT 3#define DEPT_MAX_SUBCLASSES_USR (DEPT_MAX_SUBCLASSES / DEPT_MAX_SUBCLASSES_EVT)#define DEPT_MAX_SUBCLASSES_CACHE 2@@ -390,6 +390,32 @@ struct dept_ext_wgen {unsigned int wgen; }; +enum { +DEPT_PAGE_DEFAULT =0 , +DEPT_PAGE_REGFILE_CACHE ,/* regular file page cache */ +DEPT_PAGE_BDEV_CACHE ,/* block device cache */ +DEPT_PAGE_USAGE_NR ,/* nr of usages options */ +}; + +#define DEPT_PAGE_USAGE_SHIFT 16 +#define DEPT_PAGE_USAGE_MASK ((1U << DEPT_PAGE_USAGE_SHIFT) - 1) +#define DEPT_PAGE_USAGE_PENDING_MASK (DEPT_PAGE_USAGE_MASK << DEPT_PAGE_USAGE_SHIFT) + +/* +* Identify each page's usage type +*/ +struct dept_page_usage { +/* +* low 16 bits : the current usage type +* high 16 bits : usage type requested to be set +* +* Do not apply the type requested immediately but defer until +* after clearing PG_locked bit of the folio or page e.g. by +* folio_unlock(). +*/ +atomic_t type;/* Update and read atomically */ +}; +struct dept_event_site {/* * event site name @@ -562,6 +588,7 @@ extern void dept_hardirqs_off(void);struct dept_key { };struct dept_map { };struct dept_ext_wgen { }; +struct dept_page_usage { };struct dept_event_site { };#define DEPT_MAP_INITIALIZER (n, k) { }include/linux/mm_types.h +1
-0@@ -224,6 +224,7 @@ struct page {struct page *kmsan_shadow;struct page *kmsan_origin;#endif +struct dept_page_usage usage;struct dept_ext_wgen pg_locked_wgen; } _struct_page_alignment;include/linux/page-flags.h +74
-2@@ -204,6 +204,68 @@ enum pageflags {extern struct dept_map pg_locked_map; +static inline int dept_set_page_usage (struct page *p, +unsigned int new_type) +{ +unsigned int type =atomic_read (&p->usage.type); + +if (WARN_ON_ONCE (new_type >=DEPT_PAGE_USAGE_NR )) +return -1 ; + + new_type <<=DEPT_PAGE_USAGE_SHIFT ; +retry: + new_type &= ~DEPT_PAGE_USAGE_MASK ; + new_type |= type &DEPT_PAGE_USAGE_MASK ; + +if (!atomic_try_cmpxchg (&p->usage.type, &type, new_type)) + goto retry; + +return 0 ; +} + +static inline int dept_reset_page_usage (struct page *p) +{ +return dept_set_page_usage (p,DEPT_PAGE_DEFAULT ); +} + +static inline void dept_update_page_usage (struct page *p) +{ +unsigned int type =atomic_read (&p->usage.type); +unsigned int new_type; + +retry: + new_type = type &DEPT_PAGE_USAGE_PENDING_MASK ; + new_type >>=DEPT_PAGE_USAGE_SHIFT ; + new_type |= type &DEPT_PAGE_USAGE_PENDING_MASK ; + +/* +* Already updated by others. +*/ +if (type == new_type) +return ; + +if (!atomic_try_cmpxchg (&p->usage.type, &type, new_type)) + goto retry; +} + +static inline unsigned long dept_event_flags (struct page *p,bool wait) +{ +unsigned int type; + + type =atomic_read (&p->usage.type) &DEPT_PAGE_USAGE_MASK ; + +if (WARN_ON_ONCE (type >=DEPT_PAGE_USAGE_NR )) +return 0 ; + +/* +* event +*/ +if (!wait) +return 1UL << type; + +return (1UL <<DEPT_PAGE_DEFAULT ) | (1UL << type); +} +/* * Place the following annotations in its suitable point in code: * @@ -214,20 +276,28 @@ extern struct dept_map pg_locked_map;static inline void dept_page_set_bit (struct page *p,int bit_nr) { +dept_update_page_usage (p);if (bit_nr == PG_locked)dept_request_event (&pg_locked_map, &p->pg_locked_wgen); }static inline void dept_page_clear_bit (struct page *p,int bit_nr) { +unsigned long evt_f; + + evt_f =dept_event_flags (p, false);if (bit_nr == PG_locked) -dept_event (&pg_locked_map,1UL , _RET_IP_, __func__, &p->pg_locked_wgen); +dept_event (&pg_locked_map, evt_f, _RET_IP_, __func__, &p->pg_locked_wgen); }static inline void dept_page_wait_on_bit (struct page *p,int bit_nr) { +unsigned long evt_f; + +dept_update_page_usage (p); + evt_f =dept_event_flags (p, true);if (bit_nr == PG_locked) -dept_wait (&pg_locked_map,1UL , _RET_IP_, __func__,0 ,-1L ); +dept_wait (&pg_locked_map, evt_f, _RET_IP_, __func__,0 ,-1L ); }static inline void dept_folio_set_bit (struct folio *f,int bit_nr)@@ -245,6 +315,8 @@ static inline void dept_folio_wait_on_bit(struct folio *f, int bit_nr) dept_page_wait_on_bit(&f->page, bit_nr); }#else +#define dept_set_page_usage (p, t) do { } while (0) +#define dept_reset_page_usage (p) do { } while (0)#define dept_page_set_bit (p, bit_nr) do { } while (0)#define dept_page_clear_bit (p, bit_nr) do { } while (0)#define dept_page_wait_on_bit (p, bit_nr) do { } while (0)Signature · 1 line
2.17.1
Matthew Wilcox
maintainerRe: [PATCH v17 44/47] dept: introduce APIs to set page usage and use subclasses_evt for the usage
Quoted 21 lines · Byungchul Park
Quoted 5 lines · Byungchul Park
False positive reports have been observed since dept works with the assumption that all the pages have the same dept class, but the class should be split since the problematic call paths are different depending on what the page is used for.
Quoted 8 lines
At least, ones in block device's
address_spaceand ones in regular file'saddress_spacehave exclusively different usages.Thus, define usage candidates like:
DEPT_PAGE_REGFILE_CACHE/* page in regular file'saddress_space*/
DEPT_PAGE_BDEV_CACHE/* page in block device'saddress_space*/
DEPT_PAGE_DEFAULT/* the others */1. I'd like to annotate a page to
DEPT_PAGE_REGFILE_CACHEwhen the page starts to be associated with a page cache for fs data.2. And I'd like to annotate a page to
DEPT_PAGE_BDEV_CACHEwhen the page starts to be associated with meta data of fs e.g. super block.
Quoted 6 lines
3. Lastly, I'd like to reset the annotated value if any, that has been set in the page, when the page ends the assoication with either page cache or meta block of fs e.g. freeing the page.
Can anyone suggest good places in code for the annotation 1, 2, 3? It'd be totally appreciated. :-)
I don't think it makes sense to track lock state in the page (nor folio). Partly bcause there's just so many of them, but also because the locking rules don't really apply to individual folios so much as they do to the mappings (or anon_vmas) that contain folios.
If you're looking to find deadlock scenarios, I think it makes more sense to track all folio locks in a given mapping as the same lock type rather than track each folio's lock status.
For example, let's suppose we did something like this in the page fault path:
Look up and lock a folio (we need folios locked to insert them into the page tables to avoid a race with truncate)
Try to allocate a page table
Go into reclaim, attempt to reclaim a folio from this mapping
We ought to detect that as a potential deadlock, regardless of which folio in the mapping we attempt to reclaim. So can we track folio locking at the mapping/anon_vma level instead?
---
My current understanding of folio locking rules:
If you hold a lock on folio A, you can take a lock on folio B if:
1. A->mapping == B->mapping and A->index < B->index
(for example writeback; we take locks on all folios to be written
back in order)
2. !S_ISBLK(A->mapping->host) and S_ISBLK(B->mapping->host)
3. S_ISREG(A->mapping->host) and S_ISREG(B->mapping->host) with inode_lock() held on both and A->index < B->index
(the remap_range code)
Re: [PATCH v17 44/47] dept: introduce APIs to set page usage and use subclasses_evt for the usage
Quoted 26 lines · Matthew Wilcox
Quoted 25 lines · Byungchul Park
Quoted 5 lines · Byungchul Park
False positive reports have been observed since dept works with the assumption that all the pages have the same dept class, but the class should be split since the problematic call paths are different depending on what the page is used for.
Quoted 8 lines
At least, ones in block device's
address_spaceand ones in regular file'saddress_spacehave exclusively different usages.Thus, define usage candidates like:
DEPT_PAGE_REGFILE_CACHE/* page in regular file'saddress_space*/
DEPT_PAGE_BDEV_CACHE/* page in block device'saddress_space*/
DEPT_PAGE_DEFAULT/* the others */1. I'd like to annotate a page to
DEPT_PAGE_REGFILE_CACHEwhen the page starts to be associated with a page cache for fs data.2. And I'd like to annotate a page to
DEPT_PAGE_BDEV_CACHEwhen the page starts to be associated with meta data of fs e.g. super block.3. Lastly, I'd like to reset the annotated value if any, that has been set in the page, when the page ends the assoication with either page cache or meta block of fs e.g. freeing the page.
Quoted 7 lines
Quoted 2 lines
Can anyone suggest good places in code for the annotation 1, 2, 3? It'd be totally appreciated. :-)
I don't think it makes sense to track lock state in the page (nor folio). Partly bcause there's just so many of them, but also because the locking rules don't really apply to individual folios so much as they do to the mappings (or
anon_vmas) that contain folios.
Thank you for the suggestion!
Since two folios associated to different mappings might appear in the same callpath that usually be classified to a single class, I need to think how to reflect the suggestion.
I guess you wanted to tell me a folio can only be associated to a single mapping at once. Right? If so, sure, I should reflect it.
Quoted 7 lines
If you're looking to find deadlock scenarios, I think it makes more sense to track all folio locks in a given mapping as the same lock type rather than track each folio's lock status.
For example, let's suppose we did something like this in the page fault path:
Quoted 7 lines
Look up and lock a folio (we need folios locked to insert them into the page tables to avoid a race with truncate)
Try to allocate a page table
Go into reclaim, attempt to reclaim a folio from this mappingWe ought to detect that as a potential deadlock, regardless of which folio in the mapping we attempt to reclaim. So can we track folio
Did you mean 'regardless' for 'potential' detection, right?
Quoted 1 line
locking at the mapping/anon_vma level instead?
Piece of cake. Even though it may increase the number of DEPT classes, I hope it will be okay. I just need to know the points in code where folios start/end being associated to their specific mappings.
Byungchul
Quoted 13 lines
---
My current understanding of folio locking rules:
If you hold a lock on folio A, you can take a lock on folio B if:
1.
A->mapping==B->mappingandA->index<B->index
(for example writeback; we take locks on all folios to be written
back in order)
2. !S_ISBLK(A->mapping->host) andS_ISBLK(B->mapping->host)
3.S_ISREG(A->mapping->host)andS_ISREG(B->mapping->host)withinode_lock()held on both andA->index<B->index
(theremap_rangecode)
Re: [PATCH v17 44/47] dept: introduce APIs to set page usage and use subclasses_evt for the usage
Quoted 59 lines · Byungchul Park
Quoted 26 lines · Matthew Wilcox
Quoted 25 lines · Byungchul Park
Quoted 5 lines · Byungchul Park
False positive reports have been observed since dept works with the assumption that all the pages have the same dept class, but the class should be split since the problematic call paths are different depending on what the page is used for.
Quoted 8 lines
At least, ones in block device's
address_spaceand ones in regular file'saddress_spacehave exclusively different usages.Thus, define usage candidates like:
DEPT_PAGE_REGFILE_CACHE/* page in regular file'saddress_space*/
DEPT_PAGE_BDEV_CACHE/* page in block device'saddress_space*/
DEPT_PAGE_DEFAULT/* the others */1. I'd like to annotate a page to
DEPT_PAGE_REGFILE_CACHEwhen the page starts to be associated with a page cache for fs data.2. And I'd like to annotate a page to
DEPT_PAGE_BDEV_CACHEwhen the page starts to be associated with meta data of fs e.g. super block.3. Lastly, I'd like to reset the annotated value if any, that has been set in the page, when the page ends the assoication with either page cache or meta block of fs e.g. freeing the page.
Quoted 7 lines
Quoted 2 lines
Can anyone suggest good places in code for the annotation 1, 2, 3? It'd be totally appreciated. :-)
I don't think it makes sense to track lock state in the page (nor folio). Partly bcause there's just so many of them, but also because the locking rules don't really apply to individual folios so much as they do to the mappings (or
anon_vmas) that contain folios.Thank you for the suggestion!
Since two folios associated to different mappings might appear in the same callpath that usually be classified to a single class, I need to think how to reflect the suggestion.
I guess you wanted to tell me a folio can only be associated to a single mapping at once. Right? If so, sure, I should reflect it.
Quoted 7 lines
If you're looking to find deadlock scenarios, I think it makes more sense to track all folio locks in a given mapping as the same lock type rather than track each folio's lock status.
For example, let's suppose we did something like this in the page fault path:
Quoted 7 lines
Look up and lock a folio (we need folios locked to insert them into the page tables to avoid a race with truncate)
Try to allocate a page table
Go into reclaim, attempt to reclaim a folio from this mappingWe ought to detect that as a potential deadlock, regardless of which folio in the mapping we attempt to reclaim. So can we track folio
Quoted 7 lines
Did you mean 'regardless' for 'potential' detection, right?
Quoted 1 line
locking at the mapping/anon_vma level instead?
Piece of cake. Even though it may increase the number of DEPT classes, I hope it will be okay. I just need to know the points in code where folios start/end being associated to their specific mappings.
Assuming that I understand what you meant correctly, I can use the @mapping value in struct page as a second key in DEPT. Of course, it doesn't guarantee unique ids of the mappings for ever. However, I think it can be a good and quite simple start.
Byungchul
Quoted 15 lines
Byungchul
Quoted 13 lines
---
My current understanding of folio locking rules:
If you hold a lock on folio A, you can take a lock on folio B if:
1.
A->mapping==B->mappingandA->index<B->index
(for example writeback; we take locks on all folios to be written
back in order)
2. !S_ISBLK(A->mapping->host) andS_ISBLK(B->mapping->host)
3.S_ISREG(A->mapping->host)andS_ISREG(B->mapping->host)withinode_lock()held on both andA->index<B->index
(theremap_rangecode)
Re: [PATCH v17 44/47] dept: introduce APIs to set page usage and use subclasses_evt for the usage
In reply to Byungchul ParkQuoted 56 lines · Byungchul Park
Quoted 26 lines · Matthew Wilcox
Quoted 25 lines · Byungchul Park
Quoted 5 lines · Byungchul Park
False positive reports have been observed since dept works with the assumption that all the pages have the same dept class, but the class should be split since the problematic call paths are different depending on what the page is used for.
Quoted 8 lines
At least, ones in block device's
address_spaceand ones in regular file'saddress_spacehave exclusively different usages.Thus, define usage candidates like:
DEPT_PAGE_REGFILE_CACHE/* page in regular file'saddress_space*/
DEPT_PAGE_BDEV_CACHE/* page in block device'saddress_space*/
DEPT_PAGE_DEFAULT/* the others */1. I'd like to annotate a page to
DEPT_PAGE_REGFILE_CACHEwhen the page starts to be associated with a page cache for fs data.2. And I'd like to annotate a page to
DEPT_PAGE_BDEV_CACHEwhen the page starts to be associated with meta data of fs e.g. super block.3. Lastly, I'd like to reset the annotated value if any, that has been set in the page, when the page ends the assoication with either page cache or meta block of fs e.g. freeing the page.
Quoted 7 lines
Quoted 2 lines
Can anyone suggest good places in code for the annotation 1, 2, 3? It'd be totally appreciated. :-)
I don't think it makes sense to track lock state in the page (nor folio). Partly bcause there's just so many of them, but also because the locking rules don't really apply to individual folios so much as they do to the mappings (or
anon_vmas) that contain folios.Thank you for the suggestion!
Since two folios associated to different mappings might appear in the same callpath that usually be classified to a single class, I need to think how to reflect the suggestion.
I guess you wanted to tell me a folio can only be associated to a single mapping at once. Right? If so, sure, I should reflect it.
Quoted 12 lines
If you're looking to find deadlock scenarios, I think it makes more sense to track all folio locks in a given mapping as the same lock type rather than track each folio's lock status.
For example, let's suppose we did something like this in the page fault path:
Look up and lock a folio (we need folios locked to insert them into the page tables to avoid a race with truncate)
Try to allocate a page table
Go into reclaim, attempt to reclaim a folio from this mapping
Quoted 8 lines
Quoted 2 lines
We ought to detect that as a potential deadlock, regardless of which folio in the mapping we attempt to reclaim. So can we track folio
Did you mean 'regardless' for 'potential' detection, right?
Quoted 1 line
locking at the mapping/anon_vma level instead?
Piece of cake. Even though it may increase the number of DEPT classes,
Might be not as easy as I thought it'd be. I need to think it more..
Byungchul
Quoted 18 lines
I hope it will be okay. I just need to know the points in code where folios start/end being associated to their specific mappings.
Byungchul
Quoted 13 lines
---
My current understanding of folio locking rules:
If you hold a lock on folio A, you can take a lock on folio B if:
1.
A->mapping==B->mappingandA->index<B->index
(for example writeback; we take locks on all folios to be written
back in order)
2. !S_ISBLK(A->mapping->host) andS_ISBLK(B->mapping->host)
3.S_ISREG(A->mapping->host)andS_ISREG(B->mapping->host)withinode_lock()held on both andA->index<B->index
(theremap_rangecode)
Re: [PATCH v17 44/47] dept: introduce APIs to set page usage and use subclasses_evt for the usage
In reply to Matthew WilcoxQuoted 26 lines · Matthew Wilcox
Quoted 25 lines · Byungchul Park
Quoted 5 lines · Byungchul Park
False positive reports have been observed since dept works with the assumption that all the pages have the same dept class, but the class should be split since the problematic call paths are different depending on what the page is used for.
Quoted 8 lines
At least, ones in block device's
address_spaceand ones in regular file'saddress_spacehave exclusively different usages.Thus, define usage candidates like:
DEPT_PAGE_REGFILE_CACHE/* page in regular file'saddress_space*/
DEPT_PAGE_BDEV_CACHE/* page in block device'saddress_space*/
DEPT_PAGE_DEFAULT/* the others */1. I'd like to annotate a page to
DEPT_PAGE_REGFILE_CACHEwhen the page starts to be associated with a page cache for fs data.2. And I'd like to annotate a page to
DEPT_PAGE_BDEV_CACHEwhen the page starts to be associated with meta data of fs e.g. super block.3. Lastly, I'd like to reset the annotated value if any, that has been set in the page, when the page ends the assoication with either page cache or meta block of fs e.g. freeing the page.
Quoted 7 lines
Quoted 2 lines
Can anyone suggest good places in code for the annotation 1, 2, 3? It'd be totally appreciated. :-)
I don't think it makes sense to track lock state in the page (nor folio). Partly bcause there's just so many of them, but also because the locking rules don't really apply to individual folios so much as they do to the mappings (or
anon_vmas) that contain folios.
I've been trying to fully understand what you meant but maybe failed.
FWIW, dept is working based on classification, not instance by instance, that is similar to lockdep. This patch is for resolving issues that might come from the fact that there is a **single class** for PG_locked, by splitting the class to several ones according to their usages.
Quoted 11 lines
If you're looking to find deadlock scenarios, I think it makes more sense to track all folio locks in a given mapping as the same lock type rather than track each folio's lock status.
For example, let's suppose we did something like this in the page fault path:
Look up and lock a folio (we need folios locked to insert them into the page tables to avoid a race with truncate)
Try to allocate a page table
Go into reclaim, attempt to reclaim a folio from this mapping
I think you are talking about nested lock patterns involving PG_locked.
Even though dept can do much more jobs than just tracking nested lock patterns within a single context, of course, nested lock patterns involving PG_locked should be handled appropriately, maybe with the useful information you gave. When I work on handling nested locks esp. involving PG_locked, I will try to get you again. Thanks.
However, I have no choice but to keep this approach for the **single class** issue. Feel free to ask if any.
Byungchul
Quoted 17 lines
We ought to detect that as a potential deadlock, regardless of which folio in the mapping we attempt to reclaim. So can we track folio locking at the mapping/anon_vma level instead?
---
My current understanding of folio locking rules:
If you hold a lock on folio A, you can take a lock on folio B if:
1.
A->mapping==B->mappingandA->index<B->index
(for example writeback; we take locks on all folios to be written
back in order)
2. !S_ISBLK(A->mapping->host) andS_ISBLK(B->mapping->host)
3.S_ISREG(A->mapping->host)andS_ISREG(B->mapping->host)withinode_lock()held on both andA->index<B->index
(theremap_rangecode)
PATCH v17 45/47 dept: track PG_writeback with dept
In reply to Byungchul ParkMakes dept able to track PG_writeback waits and events, which will be useful in practice.
--- include/linux/mm_types.h | 1 + include/linux/page-flags.h | 7 +++++++ mm/filemap.c | 11 +++++++++++ mm/mm_init.c | 1 + 4 files changed, 20 insertions(+)
include/linux/mm_types.h +1 -0
@@ -226,6 +226,7 @@ struct page {#endif struct dept_page_usage usage;struct dept_ext_wgen pg_locked_wgen; +struct dept_ext_wgen pg_writeback_wgen; } _struct_page_alignment;/*
include/linux/page-flags.h +7 -0
@@ -203,6 +203,7 @@ enum pageflags {#include <linux/dept.h> extern struct dept_map pg_locked_map; +extern struct dept_map pg_writeback_map;static inline int dept_set_page_usage (struct page *p,unsigned int new_type)
@@ -279,6 +280,8 @@ static inline void dept_page_set_bit(struct page *p, int bit_nr)dept_update_page_usage (p);if (bit_nr == PG_locked)dept_request_event (&pg_locked_map, &p->pg_locked_wgen); +else if (bit_nr == PG_writeback) +dept_request_event (&pg_writeback_map, &p->pg_writeback_wgen); }static inline void dept_page_clear_bit (struct page *p,int bit_nr)
@@ -288,6 +291,8 @@ static inline void dept_page_clear_bit(struct page *p, int bit_nr) evt_f =dept_event_flags (p, false);if (bit_nr == PG_locked)dept_event (&pg_locked_map, evt_f, _RET_IP_, __func__, &p->pg_locked_wgen); +else if (bit_nr == PG_writeback) +dept_event (&pg_writeback_map, evt_f, _RET_IP_, __func__, &p->pg_writeback_wgen); }static inline void dept_page_wait_on_bit (struct page *p,int bit_nr)
@@ -298,6 +303,8 @@ static inline void dept_page_wait_on_bit(struct page *p, int bit_nr) evt_f =dept_event_flags (p, true);if (bit_nr == PG_locked)dept_wait (&pg_locked_map, evt_f, _RET_IP_, __func__,0 ,-1L ); +else if (bit_nr == PG_writeback) +dept_wait (&pg_writeback_map, evt_f, _RET_IP_, __func__,0 ,-1L ); }static inline void dept_folio_set_bit (struct folio *f,int bit_nr)
mm/filemap.c +11 -0
@@ -1187,6 +1187,13 @@ static void folio_wake_bit(struct folio *folio, int bit_nr) key.bit_nr = bit_nr; key.page_match =0 ; +/* +* dept_page_clear_bit() being called multiple times is harmless. +* The worst case is to miss some dependencies but it's okay. +*/ +if (bit_nr == PG_locked || bit_nr == PG_writeback) +dept_page_clear_bit (&folio->page, bit_nr); +spin_lock_irqsave (&q->lock, flags);__wake_up_locked_key (q,TASK_NORMAL , &key);
@@ -1241,6 +1248,9 @@ static inline bool folio_trylock_flag(struct folio *folio, int bit_nr,struct dept_map __maybe_unused pg_locked_map =DEPT_MAP_INITIALIZER (pg_locked_map,NULL );EXPORT_SYMBOL (pg_locked_map); +struct dept_map __maybe_unused pg_writeback_map =DEPT_MAP_INITIALIZER (pg_writeback_map,NULL ); +EXPORT_SYMBOL (pg_writeback_map); +static inline int folio_wait_bit_common (struct folio *folio,int bit_nr,int state,enum behavior behavior) {
@@ -1683,6 +1693,7 @@ void folio_end_writeback(struct folio *folio)* reused before the folio_wake_bit(). */ folio_get (folio); +dept_page_clear_bit (&folio->page, PG_writeback);if (__folio_end_writeback (folio))folio_wake_bit (folio, PG_writeback);
mm/mm_init.c +1 -0
@@ -589,6 +589,7 @@ void __meminit __init_single_page(struct page *page, unsigned long pfn,page_cpupid_reset_last (page);page_kasan_tag_reset (page);dept_ext_wgen_init (&page->pg_locked_wgen); +dept_ext_wgen_init (&page->pg_writeback_wgen);INIT_LIST_HEAD (&page->lru);#ifdef WANT_PAGE_VIRTUAL
Signature · 1 line
2.17.1
PATCH v17 46/47 SUNRPC: relocate struct rcu_head to the first field of struct rpc_xprt
In reply to Byungchul ParkWhile compiling Linux kernel with DEPT on, the following error was observed:
./include/linux/rcupdate.h:1084:17: note: in expansion of macro ‘BUILD_BUG_ON’
1084 | BUILD_BUG_ON(offsetof(typeof(*(ptr)), rhf) >= 4096); \
| ^~~~~~~~~~~~
./include/linux/rcupdate.h:1047:29: note: in expansion of macro
'kvfree_rcu_arg_2'
1047 | #define kfree_rcu(ptr, rhf) kvfree_rcu_arg_2(ptr, rhf)
| ^~~~~~~~~~~~~~~~
net/sunrpc/xprt.c:1856:9: note: in expansion of macro 'kfree_rcu'
1856 | kfree_rcu(xprt, rcu);
| ^~~~~~~~~
CC net/kcm/kcmproc.o make[4]: *** [scripts/Makefile.build:203: net/sunrpc/xprt.o] Error 1
Since kfree_rcu() assumes 'offset of struct rcu_head in a rcu-managed struct < 4096', the offest of struct rcu_head in struct rpc_xprt should not exceed 4096 but does, due to the debug information added by DEPT.
Relocate struct rcu_head to the first field of struct rpc_xprt from an arbitrary location to avoid the issue and meet the assumption.
--- include/linux/sunrpc/xprt.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-)
include/linux/sunrpc/xprt.h +8 -1
@@ -211,6 +211,14 @@ enum xprt_transports {struct rpc_sysfs_xprt ;struct rpc_xprt { +/* +* Place struct rcu_head within the first 4096 bytes of struct +* rpc_xprt if sizeof(struct rpc_xprt) > 4096, so that +* kfree_rcu() can simply work assuming that. See the comment +* in kfree_rcu(). +*/ +struct rcu_head rcu; +struct kref kref;/* Reference count */ const struct rpc_xprt_ops *ops;/* transport methods */ unsigned int id;/* transport id */
@@ -317,7 +325,6 @@ struct rpc_xprt {#if IS_ENABLED (CONFIG_SUNRPC_DEBUG )struct dentry *debugfs;/* debugfs directory */ #endif -struct rcu_head rcu;const struct xprt_class *xprt_class;struct rpc_sysfs_xprt *xprt_sysfs;bool main;/*mark if this is the 1st transport */
Signature · 1 line
2.17.1
PATCH v17 47/47 mm: percpu: increase PERCPU_DYNAMIC_SIZE_SHIFT on DEPT and large PAGE_SIZE
In reply to Byungchul ParkYunseong reported a build failure due to the BUILD_BUG_ON() statement in alloc_kmem_cache_cpus(). In the following test:
PERCPU_DYNAMIC_EARLY_SIZE < NR_KMALLOC_TYPES * KMALLOC_SHIFT_HIGH * sizeof(struct kmem_cache_cpu)
The following factors increase the right side of the equation:
1. PAGE_SIZE > 4KiB increases KMALLOC_SHIFT_HIGH.
2. DEPT increases the size of the local_lock_t in kmem_cache_cpu.
Increase PERCPU_DYNAMIC_SIZE_SHIFT to 11 on configs with PAGE_SIZE larger than 4KiB and DEPT enabled.
--- include/linux/percpu.h | 4 ++++ 1 file changed, 4 insertions(+)
include/linux/percpu.h +4 -0
@@ -43,7 +43,11 @@# define PERCPU_DYNAMIC_SIZE_SHIFT 12#endif /* LOCKDEP and PAGE_SIZE > 4KiB */ #else +#if defined(CONFIG_DEPT ) && !defined(CONFIG_PAGE_SIZE_4KB ) +#define PERCPU_DYNAMIC_SIZE_SHIFT 11 +#else #define PERCPU_DYNAMIC_SIZE_SHIFT 10 +#endif /* DEPT and PAGE_SIZE > 4KiB */ #endif /*
Signature · 1 line
2.17.1