timer: Document TIMER_PINNED
authorPeter Xu <peterx@redhat.com>
Fri, 28 Jun 2019 10:59:42 +0000 (18:59 +0800)
committerThomas Gleixner <tglx@linutronix.de>
Sun, 7 Jul 2019 09:50:03 +0000 (11:50 +0200)
commit28ef2db8866495150e4260773fead8313f1a5625
treeb5eecff402061ee6fe7cb26b3c9a50543bfc2381
parentdd2cb348613b44f9d948b068775e159aad298599
timer: Document TIMER_PINNED

The flag hints the user that the pinned timers will always be run on a
static CPU (because that should be what "pinned" means...) but that's
not the truth, at least with the current implementation.

For example, currently if a pinned timer is set up but later mod_timer()
upon the pinned timer is invoked, mod_timer() will still try to queue the
timer on the current processor and migrate the timer if necessary.

Document it a bit with the definition of TIMER_PINNED so that all future
users will use it correctly.

Signed-off-by: Peter Xu <peterx@redhat.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Cc: Marcelo Tosatti <mtosatti@redhat.com>
Cc: Luiz Capitulino <lcapitulino@redhat.com>
Link: https://lkml.kernel.org/r/20190628105942.14131-1-peterx@redhat.com
include/linux/timer.h