Re: Warn people about flush_scheduled_work()

[Alan Stern]

On Tue, 15 Dec 2009, Tejun Heo wrote:

> Hello, Alan Stern.
> 
> On 12/15/2009 06:33 AM, Alan Stern wrote:
> > You've spent some time working on the workqueue implementation, right?  
> > I'd like to add comments or kerneldoc warning people about how 
> > dangerous it can be to use flush_scheduled_work() and related 
> > functions.  Something like this:
> > 
> > 	Think twice before calling this function!  It's very easy
> > 	to get into trouble if you don't take great care.  Either
> > 	of the following situations will lead to deadlock:
> > 
> > 		Your code is running in the context of a scheduled
> > 		work routine.
> >
> > 		Your code or its caller holds a lock needed by
> > 		one of the work items currently on the workqueue.
> >
> > 	Since you generally don't know who your caller is, what locks
> > 	it holds, or what locks are needed by the items on the 
> > 	workqueue, avoiding these situations is quite difficult.
> 
> I think both problems can be detected by lockdep, right?  So, they
> aren't that difficult to detect.

Maybe they can, now.  It used to be they couldn't.

However, lockdep doesn't help much -- it tells you the cause of the
deadlock but it doesn't prevent the deadlock from occurring.  The
programmer has to do this, by avoiding flush_scheduled_work().  I guess 
that could be added to the comment.

> > 	Consider using cancel_work_sync() or cancel_delayed_work_sync()
> > 	instead.  In most situations they will accomplish what you 
> > 	need.
> > 
> > Does this sound like a good idea?  Certainly flush_scheduled_work()  
> > is used in places where it shouldn't be.
> 
> Yeah, recommending more work-specific constructs definitely would be
> better.  It's bad that we can't recommend the use of flush_work() as
> it doesn't do cross-cpu flushing.  Maybe that needs explanation too.

I'll do my comments, and you can do yours.  :-)

Should these changes go through Andrew Morton?  Or can you take them?

Alan Stern

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/