[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 45/50] job.h: categorize JobDriver callbacks that need the AioCont
From: |
Kevin Wolf |
Subject: |
[PULL 45/50] job.h: categorize JobDriver callbacks that need the AioContext lock |
Date: |
Fri, 7 Oct 2022 12:47:47 +0200 |
From: Emanuele Giuseppe Esposito <eesposit@redhat.com>
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>
Message-Id: <20220926093214.506243-18-eesposit@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
---
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 c96387069d..b943d90e8f 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.37.3
- [PULL 35/50] blockjob: introduce block_job _locked() APIs, (continued)
- [PULL 35/50] blockjob: introduce block_job _locked() APIs, Kevin Wolf, 2022/10/07
- [PULL 24/50] raw-format: add missing coroutine_fn annotations, Kevin Wolf, 2022/10/07
- [PULL 38/50] block/mirror.c: use of job helpers in drivers, Kevin Wolf, 2022/10/07
- [PULL 36/50] jobs: add job lock in find_* functions, Kevin Wolf, 2022/10/07
- [PULL 40/50] job: detect change of aiocontext within job coroutine, Kevin Wolf, 2022/10/07
- [PULL 50/50] file-posix: Remove unused s->discard_zeroes, Kevin Wolf, 2022/10/07
- [PULL 49/50] job: remove unused functions, Kevin Wolf, 2022/10/07
- [PULL 43/50] blockjob: rename notifier callbacks as _locked, Kevin Wolf, 2022/10/07
- [PULL 47/50] block_job_query: remove atomic read, Kevin Wolf, 2022/10/07
- [PULL 46/50] job.c: enable job lock/unlock and remove Aiocontext locks, Kevin Wolf, 2022/10/07
- [PULL 45/50] job.h: categorize JobDriver callbacks that need the AioContext lock,
Kevin Wolf <=
- [PULL 30/50] job.h: categorize fields in struct Job, Kevin Wolf, 2022/10/07
- [PULL 20/50] throttle: add missing coroutine_fn annotations, Kevin Wolf, 2022/10/07
- [PULL 34/50] job: move and update comments from blockjob.c, Kevin Wolf, 2022/10/07
- [PULL 41/50] jobs: protect job.aio_context with BQL and job_mutex, Kevin Wolf, 2022/10/07
- Re: [PULL 00/50] Block layer patches, Stefan Hajnoczi, 2022/10/12