[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v12 17/21] job.h: categorize JobDriver callbacks that need the Ai
From: |
Emanuele Giuseppe Esposito |
Subject: |
[PATCH v12 17/21] job.h: categorize JobDriver callbacks that need the AioContext lock |
Date: |
Mon, 26 Sep 2022 05:32:10 -0400 |
Some callbacks implementation use bdrv_* APIs that assume the
AioContext lock is held. Make sure this invariant is documented.
Signed-off-by: Emanuele Giuseppe Esposito <eesposit@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
---
include/qemu/job.h | 27 +++++++++++++++++++++++++--
1 file changed, 25 insertions(+), 2 deletions(-)
diff --git a/include/qemu/job.h b/include/qemu/job.h
index 50a4c06b93..a954f8f992 100644
--- a/include/qemu/job.h
+++ b/include/qemu/job.h
@@ -65,7 +65,11 @@ typedef struct Job {
/** True if this job should automatically dismiss itself */
bool auto_dismiss;
- /** The completion function that will be called when the job completes. */
+ /**
+ * The completion function that will be called when the job completes.
+ * Called with AioContext lock held, since many callback implementations
+ * use bdrv_* functions that require to hold the lock.
+ */
BlockCompletionFunc *cb;
/** The opaque value that is passed to the completion function. */
@@ -260,6 +264,9 @@ struct JobDriver {
*
* This callback will not be invoked if the job has already failed.
* If it fails, abort and then clean will be called.
+ *
+ * Called with AioContext lock held, since many callbacs implementations
+ * use bdrv_* functions that require to hold the lock.
*/
int (*prepare)(Job *job);
@@ -270,6 +277,9 @@ struct JobDriver {
*
* All jobs will complete with a call to either .commit() or .abort() but
* never both.
+ *
+ * Called with AioContext lock held, since many callback implementations
+ * use bdrv_* functions that require to hold the lock.
*/
void (*commit)(Job *job);
@@ -280,6 +290,9 @@ struct JobDriver {
*
* All jobs will complete with a call to either .commit() or .abort() but
* never both.
+ *
+ * Called with AioContext lock held, since many callback implementations
+ * use bdrv_* functions that require to hold the lock.
*/
void (*abort)(Job *job);
@@ -288,6 +301,9 @@ struct JobDriver {
* .commit() or .abort(). Regardless of which callback is invoked after
* completion, .clean() will always be called, even if the job does not
* belong to a transaction group.
+ *
+ * Called with AioContext lock held, since many callbacs implementations
+ * use bdrv_* functions that require to hold the lock.
*/
void (*clean)(Job *job);
@@ -302,11 +318,18 @@ struct JobDriver {
* READY).
* (If the callback is NULL, the job is assumed to terminate
* without I/O.)
+ *
+ * Called with AioContext lock held, since many callback implementations
+ * use bdrv_* functions that require to hold the lock.
*/
bool (*cancel)(Job *job, bool force);
- /** Called when the job is freed */
+ /**
+ * Called when the job is freed.
+ * Called with AioContext lock held, since many callback implementations
+ * use bdrv_* functions that require to hold the lock.
+ */
void (*free)(Job *job);
};
--
2.31.1
- [PATCH v12 00/21] job: replace AioContext lock with job_mutex, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 08/21] jobs: add job lock in find_* functions, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 04/21] aio-wait.h: introduce AIO_WAIT_WHILE_UNLOCKED, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 01/21] job.c: make job_mutex and job_lock/unlock() public, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 06/21] job: move and update comments from blockjob.c, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 10/21] block/mirror.c: use of job helpers in drivers, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 03/21] job.c: API functions not used outside should be static, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 02/21] job.h: categorize fields in struct Job, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 09/21] jobs: use job locks also in the unit tests, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 17/21] job.h: categorize JobDriver callbacks that need the AioContext lock,
Emanuele Giuseppe Esposito <=
- [PATCH v12 16/21] blockjob: protect iostatus field in BlockJob struct, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 19/21] block_job_query: remove atomic read, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 14/21] blockjob.h: categorize fields in struct BlockJob, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 15/21] blockjob: rename notifier callbacks as _locked, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 05/21] job.c: add job_lock/unlock while keeping job.h intact, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 13/21] jobs: protect job.aio_context with BQL and job_mutex, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 11/21] jobs: group together API calls under the same job lock, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 12/21] job: detect change of aiocontext within job coroutine, Emanuele Giuseppe Esposito, 2022/09/26
- [PATCH v12 20/21] blockjob: remove unused functions, Emanuele Giuseppe Esposito, 2022/09/26