block_job_cancel_async() did two things that were still block job specific: * Setting job->force. This field makes sense on the Job level, so we can just move it. While at it, rename it to job->force_cancel to make its purpose more obvious. * Resetting the I/O status. This can't be moved because generic Jobs don't have an I/O status. What the function really implements is a user resume, except without entering the coroutine. Consequently, it makes sense to call the .user_resume driver callback here which already resets the I/O status. The old block_job_cancel_async() has two separate if statements that check job->iostatus != BLOCK_DEVICE_IO_STATUS_OK and job->user_paused. However, the former condition always implies the latter (as is asserted in block_job_iostatus_reset()), so changing the explicit call of block_job_iostatus_reset() on the former condition with the .user_resume callback on the latter condition is equivalent and doesn't need to access any BlockJob specific state. Signed-off-by: Kevin Wolf <kwolf@redhat.com> Reviewed-by: Max Reitz <mreitz@redhat.com>
324 lines
9.4 KiB
C
324 lines
9.4 KiB
C
/*
|
|
* Declarations for long-running block device operations
|
|
*
|
|
* Copyright (c) 2011 IBM Corp.
|
|
* Copyright (c) 2012 Red Hat, Inc.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef BLOCKJOB_H
|
|
#define BLOCKJOB_H
|
|
|
|
#include "qemu/job.h"
|
|
#include "block/block.h"
|
|
#include "qemu/ratelimit.h"
|
|
|
|
#define BLOCK_JOB_SLICE_TIME 100000000ULL /* ns */
|
|
|
|
typedef struct BlockJobDriver BlockJobDriver;
|
|
typedef struct BlockJobTxn BlockJobTxn;
|
|
|
|
/**
|
|
* BlockJob:
|
|
*
|
|
* Long-running operation on a BlockDriverState.
|
|
*/
|
|
typedef struct BlockJob {
|
|
/** Data belonging to the generic Job infrastructure */
|
|
Job job;
|
|
|
|
/** The job type, including the job vtable. */
|
|
const BlockJobDriver *driver;
|
|
|
|
/** The block device on which the job is operating. */
|
|
BlockBackend *blk;
|
|
|
|
/**
|
|
* Set to true when the job is ready to be completed.
|
|
*/
|
|
bool ready;
|
|
|
|
/** Status that is published by the query-block-jobs QMP API */
|
|
BlockDeviceIoStatus iostatus;
|
|
|
|
/** Offset that is published by the query-block-jobs QMP API */
|
|
int64_t offset;
|
|
|
|
/** Length that is published by the query-block-jobs QMP API */
|
|
int64_t len;
|
|
|
|
/** Speed that was set with @block_job_set_speed. */
|
|
int64_t speed;
|
|
|
|
/** Rate limiting data structure for implementing @speed. */
|
|
RateLimit limit;
|
|
|
|
/** Block other operations when block job is running */
|
|
Error *blocker;
|
|
|
|
/** Called when a cancelled job is finalised. */
|
|
Notifier finalize_cancelled_notifier;
|
|
|
|
/** Called when a successfully completed job is finalised. */
|
|
Notifier finalize_completed_notifier;
|
|
|
|
/** Called when the job transitions to PENDING */
|
|
Notifier pending_notifier;
|
|
|
|
/** BlockDriverStates that are involved in this block job */
|
|
GSList *nodes;
|
|
|
|
BlockJobTxn *txn;
|
|
QLIST_ENTRY(BlockJob) txn_list;
|
|
} BlockJob;
|
|
|
|
/**
|
|
* block_job_next:
|
|
* @job: A block job, or %NULL.
|
|
*
|
|
* Get the next element from the list of block jobs after @job, or the
|
|
* first one if @job is %NULL.
|
|
*
|
|
* Returns the requested job, or %NULL if there are no more jobs left.
|
|
*/
|
|
BlockJob *block_job_next(BlockJob *job);
|
|
|
|
/**
|
|
* block_job_get:
|
|
* @id: The id of the block job.
|
|
*
|
|
* Get the block job identified by @id (which must not be %NULL).
|
|
*
|
|
* Returns the requested job, or %NULL if it doesn't exist.
|
|
*/
|
|
BlockJob *block_job_get(const char *id);
|
|
|
|
/**
|
|
* block_job_add_bdrv:
|
|
* @job: A block job
|
|
* @name: The name to assign to the new BdrvChild
|
|
* @bs: A BlockDriverState that is involved in @job
|
|
* @perm, @shared_perm: Permissions to request on the node
|
|
*
|
|
* Add @bs to the list of BlockDriverState that are involved in
|
|
* @job. This means that all operations will be blocked on @bs while
|
|
* @job exists.
|
|
*/
|
|
int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs,
|
|
uint64_t perm, uint64_t shared_perm, Error **errp);
|
|
|
|
/**
|
|
* block_job_remove_all_bdrv:
|
|
* @job: The block job
|
|
*
|
|
* Remove all BlockDriverStates from the list of nodes that are involved in the
|
|
* job. This removes the blockers added with block_job_add_bdrv().
|
|
*/
|
|
void block_job_remove_all_bdrv(BlockJob *job);
|
|
|
|
/**
|
|
* block_job_set_speed:
|
|
* @job: The job to set the speed for.
|
|
* @speed: The new value
|
|
* @errp: Error object.
|
|
*
|
|
* Set a rate-limiting parameter for the job; the actual meaning may
|
|
* vary depending on the job type.
|
|
*/
|
|
void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp);
|
|
|
|
/**
|
|
* block_job_cancel:
|
|
* @job: The job to be canceled.
|
|
* @force: Quit a job without waiting for data to be in sync.
|
|
*
|
|
* Asynchronously cancel the specified job.
|
|
*/
|
|
void block_job_cancel(BlockJob *job, bool force);
|
|
|
|
/**
|
|
* block_job_complete:
|
|
* @job: The job to be completed.
|
|
* @errp: Error object.
|
|
*
|
|
* Asynchronously complete the specified job.
|
|
*/
|
|
void block_job_complete(BlockJob *job, Error **errp);
|
|
|
|
|
|
/**
|
|
* block_job_finalize:
|
|
* @job: The job to fully commit and finish.
|
|
* @errp: Error object.
|
|
*
|
|
* For jobs that have finished their work and are pending
|
|
* awaiting explicit acknowledgement to commit their work,
|
|
* This will commit that work.
|
|
*
|
|
* FIXME: Make the below statement universally true:
|
|
* For jobs that support the manual workflow mode, all graph
|
|
* changes that occur as a result will occur after this command
|
|
* and before a successful reply.
|
|
*/
|
|
void block_job_finalize(BlockJob *job, Error **errp);
|
|
|
|
/**
|
|
* block_job_dismiss:
|
|
* @job: The job to be dismissed.
|
|
* @errp: Error object.
|
|
*
|
|
* Remove a concluded job from the query list.
|
|
*/
|
|
void block_job_dismiss(BlockJob **job, Error **errp);
|
|
|
|
/**
|
|
* block_job_progress_update:
|
|
* @job: The job that has made progress
|
|
* @done: How much progress the job made
|
|
*
|
|
* Updates the progress counter of the job.
|
|
*/
|
|
void block_job_progress_update(BlockJob *job, uint64_t done);
|
|
|
|
/**
|
|
* block_job_progress_set_remaining:
|
|
* @job: The job whose expected progress end value is set
|
|
* @remaining: Expected end value of the progress counter of the job
|
|
*
|
|
* Sets the expected end value of the progress counter of a job so that a
|
|
* completion percentage can be calculated when the progress is updated.
|
|
*/
|
|
void block_job_progress_set_remaining(BlockJob *job, uint64_t remaining);
|
|
|
|
/**
|
|
* block_job_query:
|
|
* @job: The job to get information about.
|
|
*
|
|
* Return information about a job.
|
|
*/
|
|
BlockJobInfo *block_job_query(BlockJob *job, Error **errp);
|
|
|
|
/**
|
|
* block_job_user_cancel:
|
|
* @job: The job to be cancelled.
|
|
* @force: Quit a job without waiting for data to be in sync.
|
|
*
|
|
* Cancels the specified job, but may refuse to do so if the
|
|
* operation isn't currently meaningful.
|
|
*/
|
|
void block_job_user_cancel(BlockJob *job, bool force, Error **errp);
|
|
|
|
/**
|
|
* block_job_cancel_sync:
|
|
* @job: The job to be canceled.
|
|
*
|
|
* Synchronously cancel the job. The completion callback is called
|
|
* before the function returns. The job may actually complete
|
|
* instead of canceling itself; the circumstances under which this
|
|
* happens depend on the kind of job that is active.
|
|
*
|
|
* Returns the return value from the job if the job actually completed
|
|
* during the call, or -ECANCELED if it was canceled.
|
|
*/
|
|
int block_job_cancel_sync(BlockJob *job);
|
|
|
|
/**
|
|
* block_job_cancel_sync_all:
|
|
*
|
|
* Synchronously cancels all jobs using block_job_cancel_sync().
|
|
*/
|
|
void block_job_cancel_sync_all(void);
|
|
|
|
/**
|
|
* block_job_complete_sync:
|
|
* @job: The job to be completed.
|
|
* @errp: Error object which may be set by block_job_complete(); this is not
|
|
* necessarily set on every error, the job return value has to be
|
|
* checked as well.
|
|
*
|
|
* Synchronously complete the job. The completion callback is called before the
|
|
* function returns, unless it is NULL (which is permissible when using this
|
|
* function).
|
|
*
|
|
* Returns the return value from the job.
|
|
*/
|
|
int block_job_complete_sync(BlockJob *job, Error **errp);
|
|
|
|
/**
|
|
* block_job_iostatus_reset:
|
|
* @job: The job whose I/O status should be reset.
|
|
*
|
|
* Reset I/O status on @job and on BlockDriverState objects it uses,
|
|
* other than job->blk.
|
|
*/
|
|
void block_job_iostatus_reset(BlockJob *job);
|
|
|
|
/**
|
|
* block_job_txn_new:
|
|
*
|
|
* Allocate and return a new block job transaction. Jobs can be added to the
|
|
* transaction using block_job_txn_add_job().
|
|
*
|
|
* The transaction is automatically freed when the last job completes or is
|
|
* cancelled.
|
|
*
|
|
* All jobs in the transaction either complete successfully or fail/cancel as a
|
|
* group. Jobs wait for each other before completing. Cancelling one job
|
|
* cancels all jobs in the transaction.
|
|
*/
|
|
BlockJobTxn *block_job_txn_new(void);
|
|
|
|
/**
|
|
* block_job_txn_unref:
|
|
*
|
|
* Release a reference that was previously acquired with block_job_txn_add_job
|
|
* or block_job_txn_new. If it's the last reference to the object, it will be
|
|
* freed.
|
|
*/
|
|
void block_job_txn_unref(BlockJobTxn *txn);
|
|
|
|
/**
|
|
* block_job_txn_add_job:
|
|
* @txn: The transaction (may be NULL)
|
|
* @job: Job to add to the transaction
|
|
*
|
|
* Add @job to the transaction. The @job must not already be in a transaction.
|
|
* The caller must call either block_job_txn_unref() or block_job_completed()
|
|
* to release the reference that is automatically grabbed here.
|
|
*/
|
|
void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job);
|
|
|
|
/**
|
|
* block_job_is_internal:
|
|
* @job: The job to determine if it is user-visible or not.
|
|
*
|
|
* Returns true if the job should not be visible to the management layer.
|
|
*/
|
|
bool block_job_is_internal(BlockJob *job);
|
|
|
|
/**
|
|
* block_job_driver:
|
|
*
|
|
* Returns the driver associated with a block job.
|
|
*/
|
|
const BlockJobDriver *block_job_driver(BlockJob *job);
|
|
|
|
#endif
|