include/block/blockjob.h

30 #include "qemu/job.h"
44      * Data belonging to the generic Job infrastructure.
45      * Protected by job mutex.
47     Job job;  member
51      * Protected by job mutex.
68      * Block other operations when block job is running.
75     /** Called when a cancelled job is finalised. */
78     /** Called when a successfully completed job is finalised. */
81     /** Called when the job transitions to PENDING */
84     /** Called when the job transitions to READY */
87     /** Called when the job coroutine yields or terminates */
91      * BlockDriverStates that are involved in this block job.
106  * @job: A block job, or %NULL.
108  * Get the next element from the list of block jobs after @job, or the
109  * first one if @job is %NULL.
111  * Returns the requested job, or %NULL if there are no more jobs left.
112  * Called with job lock held.
114 BlockJob *block_job_next_locked(BlockJob *job);
118  * @id: The id of the block job.
120  * Get the block job identified by @id (which must not be %NULL).
122  * Returns the requested job, or %NULL if it doesn't exist.
123  * Called with job lock *not* held.
127 /* Same as block_job_get(), but called with job lock held. */
132  * @job: A block job
134  * @bs: A BlockDriverState that is involved in @job
138  * @job. This means that all operations will be blocked on @bs while
139  * @job exists.
142 block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs,
147  * @job: The block job
150  * job. This removes the blockers added with block_job_add_bdrv().
152 void block_job_remove_all_bdrv(BlockJob *job);
156  * @job: The block job
159  * job.
161 bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs);
165  * @job: The job to set the speed for.
169  * Set a rate-limiting parameter for the job; the actual meaning may
170  * vary depending on the job type.
172  * Called with job lock held, but might release it temporarily.
174 bool block_job_set_speed_locked(BlockJob *job, int64_t speed, Error **errp);
178  * @job: The job to change.
182  * Change the job according to opts.
184 void block_job_change_locked(BlockJob *job, BlockJobChangeOptions *opts,
189  * @job: The job to get information about.
191  * Return information about a job.
193  * Called with job lock held.
195 BlockJobInfo *block_job_query_locked(BlockJob *job, Error **errp);
199  * @job: The job whose I/O status should be reset.
201  * Reset I/O status on @job and on BlockDriverState objects it uses,
202  * other than job->blk.
204  * Called with job lock held.
206 void block_job_iostatus_reset_locked(BlockJob *job);
211  * Returns aio context associated with a block job.
213 AioContext *block_job_get_aio_context(BlockJob *job);
225  * @job: The job to determine if it is user-visible or not.
227  * Returns true if the job should not be visible to the management layer.
229 bool block_job_is_internal(BlockJob *job);
234  * Returns the driver associated with a block job.
236 const BlockJobDriver *block_job_driver(BlockJob *job);