2 * Declarations for long-running block device operations
4 * Copyright (c) 2011 IBM Corp.
5 * Copyright (c) 2012 Red Hat, Inc.
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
33 * A class type for block job objects.
35 typedef struct BlockJobType
{
36 /** Derived BlockJob struct size */
39 /** String describing the operation, part of query-block-jobs QMP API */
42 /** Optional callback for job types that support setting a speed limit */
43 void (*set_speed
)(BlockJob
*job
, int64_t speed
, Error
**errp
);
46 * Optional callback for job types whose completion must be triggered
49 void (*complete
)(BlockJob
*job
, Error
**errp
);
55 * Long-running operation on a BlockDriverState.
58 /** The job type, including the job vtable. */
59 const BlockJobType
*job_type
;
61 /** The block device on which the job is operating. */
65 * The coroutine that executes the job. If not NULL, it is
66 * reentered when busy is false and the job is cancelled.
71 * Set to true if the job should cancel itself. The flag must
72 * always be tested just before toggling the busy flag from false
73 * to true. After a job has been cancelled, it should only yield
74 * if #qemu_aio_wait will ("sooner or later") reenter the coroutine.
79 * Set to true if the job is either paused, or will pause itself
80 * as soon as possible (if busy == true).
85 * Set to false by the job while it is in a quiescent state, where
86 * no I/O is pending and the job has yielded on any condition
87 * that is not detected by #qemu_aio_wait, such as a timer.
91 /** Status that is published by the query-block-jobs QMP API */
92 BlockDeviceIoStatus iostatus
;
94 /** Offset that is published by the query-block-jobs QMP API */
97 /** Length that is published by the query-block-jobs QMP API */
100 /** Speed that was set with @block_job_set_speed. */
103 /** The completion function that will be called when the job completes. */
104 BlockDriverCompletionFunc
*cb
;
106 /** The opaque value that is passed to the completion function. */
112 * @job_type: The class object for the newly-created job.
114 * @speed: The maximum speed, in bytes per second, or 0 for unlimited.
115 * @cb: Completion function for the job.
116 * @opaque: Opaque pointer value passed to @cb.
117 * @errp: Error object.
119 * Create a new long-running block device job and return it. The job
120 * will call @cb asynchronously when the job completes. Note that
121 * @bs may have been closed at the time the @cb it is called. If
122 * this is the case, the job may be reported as either cancelled or
125 * This function is not part of the public job interface; it should be
126 * called from a wrapper that is specific to the job type.
128 void *block_job_create(const BlockJobType
*job_type
, BlockDriverState
*bs
,
129 int64_t speed
, BlockDriverCompletionFunc
*cb
,
130 void *opaque
, Error
**errp
);
133 * block_job_sleep_ns:
134 * @job: The job that calls the function.
135 * @clock: The clock to sleep on.
136 * @ns: How many nanoseconds to stop for.
138 * Put the job to sleep (assuming that it wasn't canceled) for @ns
139 * nanoseconds. Canceling the job will interrupt the wait immediately.
141 void block_job_sleep_ns(BlockJob
*job
, QEMUClock
*clock
, int64_t ns
);
144 * block_job_completed:
145 * @job: The job being completed.
146 * @ret: The status code.
148 * Call the completion function that was registered at creation time, and
151 void block_job_completed(BlockJob
*job
, int ret
);
154 * block_job_set_speed:
155 * @job: The job to set the speed for.
156 * @speed: The new value
157 * @errp: Error object.
159 * Set a rate-limiting parameter for the job; the actual meaning may
160 * vary depending on the job type.
162 void block_job_set_speed(BlockJob
*job
, int64_t speed
, Error
**errp
);
166 * @job: The job to be canceled.
168 * Asynchronously cancel the specified job.
170 void block_job_cancel(BlockJob
*job
);
173 * block_job_complete:
174 * @job: The job to be completed.
175 * @errp: Error object.
177 * Asynchronously complete the specified job.
179 void block_job_complete(BlockJob
*job
, Error
**errp
);
182 * block_job_is_cancelled:
183 * @job: The job being queried.
185 * Returns whether the job is scheduled for cancellation.
187 bool block_job_is_cancelled(BlockJob
*job
);
191 * @job: The job to get information about.
193 * Return information about a job.
195 BlockJobInfo
*block_job_query(BlockJob
*job
);
199 * @job: The job to be paused.
201 * Asynchronously pause the specified job.
203 void block_job_pause(BlockJob
*job
);
207 * @job: The job to be resumed.
209 * Resume the specified job.
211 void block_job_resume(BlockJob
*job
);
214 * block_job_is_paused:
215 * @job: The job being queried.
217 * Returns whether the job is currently paused, or will pause
218 * as soon as it reaches a sleeping point.
220 bool block_job_is_paused(BlockJob
*job
);
223 * block_job_cancel_sync:
224 * @job: The job to be canceled.
226 * Synchronously cancel the job. The completion callback is called
227 * before the function returns. The job may actually complete
228 * instead of canceling itself; the circumstances under which this
229 * happens depend on the kind of job that is active.
231 * Returns the return value from the job if the job actually completed
232 * during the call, or -ECANCELED if it was canceled.
234 int block_job_cancel_sync(BlockJob
*job
);
237 * block_job_iostatus_reset:
238 * @job: The job whose I/O status should be reset.
240 * Reset I/O status on @job.
242 void block_job_iostatus_reset(BlockJob
*job
);
245 * block_job_error_action:
246 * @job: The job to signal an error for.
247 * @bs: The block device on which to set an I/O error.
248 * @on_err: The error action setting.
249 * @is_read: Whether the operation was a read.
250 * @error: The error that was reported.
252 * Report an I/O error for a block job and possibly stop the VM. Return the
253 * action that was selected based on @on_err and @error.
255 BlockErrorAction
block_job_error_action(BlockJob
*job
, BlockDriverState
*bs
,
256 BlockdevOnError on_err
,
257 int is_read
, int error
);