workqueue: Introduce enable_and_queue_work() convenience function
authorAllen Pais <apais@linux.microsoft.com>
Mon, 25 Mar 2024 18:02:01 +0000 (18:02 +0000)
committerTejun Heo <tj@kernel.org>
Mon, 25 Mar 2024 19:40:52 +0000 (09:40 -1000)
commit474a549ff4c989427a14fdab851e562c8a63fe24
tree6f9d1e51365e1925a2b9ead6fb37386a334e7015
parentd6a7bbdde67227127e5e33fb9500bcc4abc40fb3
workqueue: Introduce enable_and_queue_work() convenience function

The enable_and_queue_work() function is introduced to streamline
the process of enabling and queuing a work item on a specific
workqueue. This function combines the functionalities of
enable_work() and queue_work() in a single call, providing a
concise and convenient API for enabling and queuing work items.

The function accepts a target workqueue and a work item as parameters.
It first attempts to enable the work item using enable_work(). A successful
enable operation means that the work item was previously disabled
and is now marked as eligible for execution. If the enable operation
is successful, the work item is then queued on the specified workqueue
using queue_work(). The function returns true if the work item was
successfully enabled and queued, and false otherwise.

Note: This function may lead to unnecessary spurious wake-ups in cases
where the work item is expected to be dormant but enable/disable are called
frequently. Spurious wake-ups refer to the condition where worker threads
are woken up without actual work to be done. Callers should be aware of
this behavior and may need to employ additional synchronization mechanisms
to avoid these overheads if such wake-ups are not desired.

This addition aims to enhance code readability and maintainability by
providing a unified interface for the common use case of enabling and
queuing work items on a workqueue.

tj: Made the function comment more compact.

Signed-off-by: Allen Pais <allen.lkml@gmail.com>
Signed-off-by: Tejun Heo <tj@kernel.org>
include/linux/workqueue.h