sched/wait: Disambiguate wq_entry->task_list and wq_head->task_list naming
authorIngo Molnar <mingo@kernel.org>
Tue, 20 Jun 2017 10:06:46 +0000 (12:06 +0200)
committerIngo Molnar <mingo@kernel.org>
Tue, 20 Jun 2017 10:19:14 +0000 (12:19 +0200)
commit2055da97389a605c8a00d163d40903afbe413921
tree6aec7243076aab2d4d239f03e34598752ce1512a
parent5822a454d6d22297c5fcd66264120587b2ec21cd
sched/wait: Disambiguate wq_entry->task_list and wq_head->task_list naming

So I've noticed a number of instances where it was not obvious from the
code whether ->task_list was for a wait-queue head or a wait-queue entry.

Furthermore, there's a number of wait-queue users where the lists are
not for 'tasks' but other entities (poll tables, etc.), in which case
the 'task_list' name is actively confusing.

To clear this all up, name the wait-queue head and entry list structure
fields unambiguously:

struct wait_queue_head::task_list => ::head
struct wait_queue_entry::task_list => ::entry

For example, this code:

rqw->wait.task_list.next != &wait->task_list

... is was pretty unclear (to me) what it's doing, while now it's written this way:

rqw->wait.head.next != &wait->entry

... which makes it pretty clear that we are iterating a list until we see the head.

Other examples are:

list_for_each_entry_safe(pos, next, &x->task_list, task_list) {
list_for_each_entry(wq, &fence->wait.task_list, task_list) {

... where it's unclear (to me) what we are iterating, and during review it's
hard to tell whether it's trying to walk a wait-queue entry (which would be
a bug), while now it's written as:

list_for_each_entry_safe(pos, next, &x->head, entry) {
list_for_each_entry(wq, &fence->wait.head, entry) {

Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Ingo Molnar <mingo@kernel.org>
18 files changed:
block/blk-mq.c
block/blk-wbt.c
block/kyber-iosched.c
drivers/gpu/drm/i915/i915_sw_fence.c
drivers/rtc/rtc-imxdi.c
fs/cachefiles/rdwr.c
fs/eventpoll.c
fs/fs_pin.c
fs/nilfs2/segment.c
fs/orangefs/orangefs-bufmap.c
fs/userfaultfd.c
include/linux/wait.h
include/linux/wait_bit.h
kernel/sched/wait.c
kernel/sched/wait_bit.c
mm/filemap.c
mm/memcontrol.c
mm/shmem.c