rename cancel_rearming_delayed_work() to cancel_delayed_work_sync()
PATCH 1/3 rename cancel_rearming_delayed_work() to cancel_delayed_work_sync()
Imho, the current naming of cancel_xxx workqueue functions is very confusing.
cancel_delayed_work()
cancel_rearming_delayed_work()
cancel_rearming_delayed_workqueue() // obsolete
cancel_work_sync()
This looks as if the first 2 functions differ in "type" of their argument which is not true any longer, nowadays the difference is the behaviour.
The semantics of cancel_rearming_delayed_work(dwork) was changed significantly, it doesn't require that dwork rearms itself, and cancels dwork synchronously.
Rename it to cancel_delayed_work_sync(). This matches cancel_delayed_work() and cancel_work_sync(). Re-create cancel_rearming_delayed_work() as a simple inline obsolete wrapper, like cancel_rearming_delayed_workqueue().
include/linux/workqueue.h renamed from include/linux/workqueue.h~1_rename +10 -3
@@ -166,14 +166,21 @@ static inline int cancel_delayed_work(st return ret; } -extern void cancel_rearming_delayed_work (struct delayed_work *work); +extern void cancel_delayed_work_sync (struct delayed_work *work); -/* Obsolete. use cancel_rearming_delayed_work() */ +/* Obsolete. use cancel_delayed_work_sync() */ static inline void cancel_rearming_delayed_workqueue (struct workqueue_struct *wq,struct delayed_work *work) { -cancel_rearming_delayed_work (work); +cancel_delayed_work_sync (work); +} + +/* Obsolete. use cancel_delayed_work_sync() */ +static inline +void cancel_rearming_delayed_work (struct delayed_work *work) +{ +cancel_delayed_work_sync (work); }#endif
kernel/workqueue.c renamed from kernel/workqueue.c~1_rename +3 -3
@@ -486,13 +486,13 @@ void cancel_work_sync(struct work_structEXPORT_SYMBOL_GPL (cancel_work_sync);/** -* cancel_rearming_delayed_work - reliably kill off a delayed work. +* cancel_delayed_work_sync - reliably kill off a delayed work. * @dwork: the delayed work struct * * It is possible to use this function if @dwork rearms itself via queue_work() * or queue_delayed_work(). See also the comment for cancel_work_sync(). */ -void cancel_rearming_delayed_work (struct delayed_work *dwork) +void cancel_delayed_work_sync (struct delayed_work *dwork) {while (!del_timer (&dwork->timer) && !try_to_grab_pending (&dwork->work))
@@ -500,7 +500,7 @@ void cancel_rearming_delayed_work(structwait_on_work (&dwork->work);work_clear_pending (&dwork->work); } -EXPORT_SYMBOL (cancel_rearming_delayed_work); +EXPORT_SYMBOL (cancel_delayed_work_sync);static struct workqueue_struct *keventd_wq__read_mostly ;
Quoted 11 lines · Oleg Nesterov
Imho, the current naming of
cancel_xxxworkqueue functions is very confusing.
cancel_delayed_work()
cancel_rearming_delayed_work()
cancel_rearming_delayed_workqueue()// obsolete
cancel_work_sync()This looks as if the first 2 functions differ in "type" of their argument which is not true any longer, nowadays the difference is the behaviour.
Quoted 6 lines
The semantics of
cancel_rearming_delayed_work(dwork)was changed significantly, it doesn't require that dwork rearms itself, and cancels dwork synchronously.Rename it to
cancel_delayed_work_sync(). This matchescancel_delayed_work()andcancel_work_sync(). Re-createcancel_rearming_delayed_work()as a simple inline obsolete wrapper, likecancel_rearming_delayed_workqueue().
I like the idea of this change, but have some doubt: "_sync" usually suggests the main difference from "" (or _nosync) is:_sync waits for something, while _nosync doesn't wait and instantly returns.
Here it's a bit complicated: cancel_delayed_work() (so nosync), actually can wait a little too (on del_timer_sync). And cancel_rearming_delayed_work() is really more universal now, but still the main difference is this should be used with works that rearm (at least sometimes). If there is no rearming - no reason for this function (of course not forbidden too) - and maybe it better helps to remember the difference?
So, I would probably prefer cancel_delayed_work_rearming(), but I don't write/read enough code with this, and I may be wrong. I'm not agains the current proposal too - maybe one more reason for sync?
Regards,
Jarek P.
Quoted 16 lines · Jarek Poplawski
Quoted 14 lines · Oleg Nesterov
Imho, the current naming of
cancel_xxxworkqueue functions is very confusing.
cancel_delayed_work()
cancel_rearming_delayed_work()
cancel_rearming_delayed_workqueue()// obsolete
cancel_work_sync()This looks as if the first 2 functions differ in "type" of their argument which is not true any longer, nowadays the difference is the behaviour.
The semantics of
cancel_rearming_delayed_work(dwork)was changed significantly, it doesn't require that dwork rearms itself, and cancels dwork synchronously.
Quoted 8 lines
Quoted 3 lines
Rename it to
cancel_delayed_work_sync(). This matchescancel_delayed_work()andcancel_work_sync(). Re-createcancel_rearming_delayed_work()as a simple inline obsolete wrapper, likecancel_rearming_delayed_workqueue().I like the idea of this change, but have some doubt: "
_sync" usually suggests the main difference from "" (or_nosync) is:_syncwaits for something, while_nosyncdoesn't wait and instantly returns.
Yes, but we already have cancel_work_sync().
Quoted 7 lines
Here it's a bit complicated:
cancel_delayed_work()(so nosync), actually can wait a little too (ondel_timer_sync). Andcancel_rearming_delayed_work()is really more universal now, but still the main difference is this should be used with works that rearm (at least sometimes). If there is no rearming - no reason for this function (of course not forbidden too) - and maybe it better helps to remember the difference?
There is a reason even if no rearming. We have a lot of
cancel_delayed_work(); flush_workqueue();
This should be converted to use cancel_delayed_work_sync().
Note also that both cancel_work_sync() and cancel_rearming_delayed_work() can be used on any work (rearming or not) and both imply "flush". I think the "_rearming" part of the name is very confusing, and a "good" name should be consistent with cancel_work_sync() and cancel_delayed_work() which we already have.
Oleg.
Quoted 21 lines · Oleg Nesterov
Quoted 20 lines · Jarek Poplawski
Quoted 17 lines · Oleg Nesterov
Imho, the current naming of
cancel_xxxworkqueue functions is very confusing.
cancel_delayed_work()
cancel_rearming_delayed_work()
cancel_rearming_delayed_workqueue()// obsolete
cancel_work_sync()This looks as if the first 2 functions differ in "type" of their argument which is not true any longer, nowadays the difference is the behaviour.
The semantics of
cancel_rearming_delayed_work(dwork)was changed significantly, it doesn't require that dwork rearms itself, and cancels dwork synchronously.Rename it to
cancel_delayed_work_sync(). This matchescancel_delayed_work()andcancel_work_sync(). Re-createcancel_rearming_delayed_work()as a simple inline obsolete wrapper, likecancel_rearming_delayed_workqueue().
Quoted 6 lines
Quoted 4 lines
I like the idea of this change, but have some doubt: "
_sync" usually suggests the main difference from "" (or_nosync) is:_syncwaits for something, while_nosyncdoesn't wait and instantly returns.Yes, but we already have
cancel_work_sync().
And it's OK because it actually can block. Some confusion could appear (maybe to me only) if we would add cancel_work() which would also ... block.
Quoted 14 lines
Quoted 8 lines
Here it's a bit complicated:
cancel_delayed_work()(so nosync), actually can wait a little too (ondel_timer_sync). Andcancel_rearming_delayed_work()is really more universal now, but still the main difference is this should be used with works that rearm (at least sometimes). If there is no rearming - no reason for this function (of course not forbidden too) - and maybe it better helps to remember the difference?There is a reason even if no rearming. We have a lot of
cancel_delayed_work(); flush_workqueue();
Quoted 7 lines
This should be converted to use
cancel_delayed_work_sync().Note also that both
cancel_work_sync()andcancel_rearming_delayed_work()can be used on any work (rearming or not) and both imply "flush". I think the "_rearming" part of the name is very confusing, and a "good" name should be consistent withcancel_work_sync()andcancel_delayed_work()which we already have.
I know, but I'm a little afraid of "overloading" the "_sync":
here it's kind of double sync (can block plus really finish something). I wonder if this way is used elsewhere in linux.
But I see the more serious reason for it is: it's in your next patches and we don't want to waste time. So, I'll try to check this in the evening, and if nothing strange - I'll send acks tomorrow (of course - not that I think they are needed...).
Thanks,
Jarek P.
Quoted 11 lines · Oleg Nesterov
Imho, the current naming of
cancel_xxxworkqueue functions is very confusing.
cancel_delayed_work()
cancel_rearming_delayed_work()
cancel_rearming_delayed_workqueue()// obsolete
cancel_work_sync()This looks as if the first 2 functions differ in "type" of their argument which is not true any longer, nowadays the difference is the behaviour.
Quoted 8 lines
The semantics of
cancel_rearming_delayed_work(dwork)was changed significantly, it doesn't require that dwork rearms itself, and cancels dwork synchronously.Rename it to
cancel_delayed_work_sync(). This matchescancel_delayed_work()andcancel_work_sync(). Re-createcancel_rearming_delayed_work()as a simple inline obsolete wrapper, likecancel_rearming_delayed_workqueue().Signed-off-by Oleg Nesterov <[email protected]>