12f0c9fe6SPaolo Bonzini /* 22f0c9fe6SPaolo Bonzini * QEMU System Emulator block driver 32f0c9fe6SPaolo Bonzini * 42f0c9fe6SPaolo Bonzini * Copyright (c) 2011 IBM Corp. 52f0c9fe6SPaolo Bonzini * Copyright (c) 2012 Red Hat, Inc. 62f0c9fe6SPaolo Bonzini * 72f0c9fe6SPaolo Bonzini * Permission is hereby granted, free of charge, to any person obtaining a copy 82f0c9fe6SPaolo Bonzini * of this software and associated documentation files (the "Software"), to deal 92f0c9fe6SPaolo Bonzini * in the Software without restriction, including without limitation the rights 102f0c9fe6SPaolo Bonzini * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 112f0c9fe6SPaolo Bonzini * copies of the Software, and to permit persons to whom the Software is 122f0c9fe6SPaolo Bonzini * furnished to do so, subject to the following conditions: 132f0c9fe6SPaolo Bonzini * 142f0c9fe6SPaolo Bonzini * The above copyright notice and this permission notice shall be included in 152f0c9fe6SPaolo Bonzini * all copies or substantial portions of the Software. 162f0c9fe6SPaolo Bonzini * 172f0c9fe6SPaolo Bonzini * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 182f0c9fe6SPaolo Bonzini * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 192f0c9fe6SPaolo Bonzini * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 202f0c9fe6SPaolo Bonzini * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 212f0c9fe6SPaolo Bonzini * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 222f0c9fe6SPaolo Bonzini * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 232f0c9fe6SPaolo Bonzini * THE SOFTWARE. 242f0c9fe6SPaolo Bonzini */ 252f0c9fe6SPaolo Bonzini 262f0c9fe6SPaolo Bonzini #include "config-host.h" 272f0c9fe6SPaolo Bonzini #include "qemu-common.h" 282f0c9fe6SPaolo Bonzini #include "trace.h" 292f0c9fe6SPaolo Bonzini #include "monitor.h" 30*737e150eSPaolo Bonzini #include "block/block.h" 31*737e150eSPaolo Bonzini #include "block/blockjob.h" 32*737e150eSPaolo Bonzini #include "block/block_int.h" 337b1b5d19SPaolo Bonzini #include "qapi/qmp/qjson.h" 34*737e150eSPaolo Bonzini #include "block/coroutine.h" 352f0c9fe6SPaolo Bonzini #include "qmp-commands.h" 362f0c9fe6SPaolo Bonzini #include "qemu-timer.h" 372f0c9fe6SPaolo Bonzini 382f0c9fe6SPaolo Bonzini void *block_job_create(const BlockJobType *job_type, BlockDriverState *bs, 392f0c9fe6SPaolo Bonzini int64_t speed, BlockDriverCompletionFunc *cb, 402f0c9fe6SPaolo Bonzini void *opaque, Error **errp) 412f0c9fe6SPaolo Bonzini { 422f0c9fe6SPaolo Bonzini BlockJob *job; 432f0c9fe6SPaolo Bonzini 442f0c9fe6SPaolo Bonzini if (bs->job || bdrv_in_use(bs)) { 452f0c9fe6SPaolo Bonzini error_set(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); 462f0c9fe6SPaolo Bonzini return NULL; 472f0c9fe6SPaolo Bonzini } 482f0c9fe6SPaolo Bonzini bdrv_set_in_use(bs, 1); 492f0c9fe6SPaolo Bonzini 502f0c9fe6SPaolo Bonzini job = g_malloc0(job_type->instance_size); 512f0c9fe6SPaolo Bonzini job->job_type = job_type; 522f0c9fe6SPaolo Bonzini job->bs = bs; 532f0c9fe6SPaolo Bonzini job->cb = cb; 542f0c9fe6SPaolo Bonzini job->opaque = opaque; 552f0c9fe6SPaolo Bonzini job->busy = true; 562f0c9fe6SPaolo Bonzini bs->job = job; 572f0c9fe6SPaolo Bonzini 582f0c9fe6SPaolo Bonzini /* Only set speed when necessary to avoid NotSupported error */ 592f0c9fe6SPaolo Bonzini if (speed != 0) { 602f0c9fe6SPaolo Bonzini Error *local_err = NULL; 612f0c9fe6SPaolo Bonzini 622f0c9fe6SPaolo Bonzini block_job_set_speed(job, speed, &local_err); 632f0c9fe6SPaolo Bonzini if (error_is_set(&local_err)) { 642f0c9fe6SPaolo Bonzini bs->job = NULL; 652f0c9fe6SPaolo Bonzini g_free(job); 662f0c9fe6SPaolo Bonzini bdrv_set_in_use(bs, 0); 672f0c9fe6SPaolo Bonzini error_propagate(errp, local_err); 682f0c9fe6SPaolo Bonzini return NULL; 692f0c9fe6SPaolo Bonzini } 702f0c9fe6SPaolo Bonzini } 712f0c9fe6SPaolo Bonzini return job; 722f0c9fe6SPaolo Bonzini } 732f0c9fe6SPaolo Bonzini 7465f46322SPaolo Bonzini void block_job_completed(BlockJob *job, int ret) 752f0c9fe6SPaolo Bonzini { 762f0c9fe6SPaolo Bonzini BlockDriverState *bs = job->bs; 772f0c9fe6SPaolo Bonzini 782f0c9fe6SPaolo Bonzini assert(bs->job == job); 792f0c9fe6SPaolo Bonzini job->cb(job->opaque, ret); 802f0c9fe6SPaolo Bonzini bs->job = NULL; 812f0c9fe6SPaolo Bonzini g_free(job); 822f0c9fe6SPaolo Bonzini bdrv_set_in_use(bs, 0); 832f0c9fe6SPaolo Bonzini } 842f0c9fe6SPaolo Bonzini 852f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 862f0c9fe6SPaolo Bonzini { 872f0c9fe6SPaolo Bonzini Error *local_err = NULL; 882f0c9fe6SPaolo Bonzini 892f0c9fe6SPaolo Bonzini if (!job->job_type->set_speed) { 902f0c9fe6SPaolo Bonzini error_set(errp, QERR_NOT_SUPPORTED); 912f0c9fe6SPaolo Bonzini return; 922f0c9fe6SPaolo Bonzini } 932f0c9fe6SPaolo Bonzini job->job_type->set_speed(job, speed, &local_err); 942f0c9fe6SPaolo Bonzini if (error_is_set(&local_err)) { 952f0c9fe6SPaolo Bonzini error_propagate(errp, local_err); 962f0c9fe6SPaolo Bonzini return; 972f0c9fe6SPaolo Bonzini } 982f0c9fe6SPaolo Bonzini 992f0c9fe6SPaolo Bonzini job->speed = speed; 1002f0c9fe6SPaolo Bonzini } 1012f0c9fe6SPaolo Bonzini 102aeae883bSPaolo Bonzini void block_job_complete(BlockJob *job, Error **errp) 103aeae883bSPaolo Bonzini { 104aeae883bSPaolo Bonzini if (job->paused || job->cancelled || !job->job_type->complete) { 105aeae883bSPaolo Bonzini error_set(errp, QERR_BLOCK_JOB_NOT_READY, job->bs->device_name); 106aeae883bSPaolo Bonzini return; 107aeae883bSPaolo Bonzini } 108aeae883bSPaolo Bonzini 109aeae883bSPaolo Bonzini job->job_type->complete(job, errp); 110aeae883bSPaolo Bonzini } 111aeae883bSPaolo Bonzini 1128acc72a4SPaolo Bonzini void block_job_pause(BlockJob *job) 1132f0c9fe6SPaolo Bonzini { 1148acc72a4SPaolo Bonzini job->paused = true; 1158acc72a4SPaolo Bonzini } 1168acc72a4SPaolo Bonzini 1178acc72a4SPaolo Bonzini bool block_job_is_paused(BlockJob *job) 1188acc72a4SPaolo Bonzini { 1198acc72a4SPaolo Bonzini return job->paused; 1208acc72a4SPaolo Bonzini } 1218acc72a4SPaolo Bonzini 1228acc72a4SPaolo Bonzini void block_job_resume(BlockJob *job) 1238acc72a4SPaolo Bonzini { 1248acc72a4SPaolo Bonzini job->paused = false; 12532c81a4aSPaolo Bonzini block_job_iostatus_reset(job); 1262f0c9fe6SPaolo Bonzini if (job->co && !job->busy) { 1272f0c9fe6SPaolo Bonzini qemu_coroutine_enter(job->co, NULL); 1282f0c9fe6SPaolo Bonzini } 1292f0c9fe6SPaolo Bonzini } 1302f0c9fe6SPaolo Bonzini 1318acc72a4SPaolo Bonzini void block_job_cancel(BlockJob *job) 1328acc72a4SPaolo Bonzini { 1338acc72a4SPaolo Bonzini job->cancelled = true; 1348acc72a4SPaolo Bonzini block_job_resume(job); 1358acc72a4SPaolo Bonzini } 1368acc72a4SPaolo Bonzini 1372f0c9fe6SPaolo Bonzini bool block_job_is_cancelled(BlockJob *job) 1382f0c9fe6SPaolo Bonzini { 1392f0c9fe6SPaolo Bonzini return job->cancelled; 1402f0c9fe6SPaolo Bonzini } 1412f0c9fe6SPaolo Bonzini 14232c81a4aSPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 14332c81a4aSPaolo Bonzini { 14432c81a4aSPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 1453bd293c3SPaolo Bonzini if (job->job_type->iostatus_reset) { 1463bd293c3SPaolo Bonzini job->job_type->iostatus_reset(job); 1473bd293c3SPaolo Bonzini } 14832c81a4aSPaolo Bonzini } 14932c81a4aSPaolo Bonzini 1502f0c9fe6SPaolo Bonzini struct BlockCancelData { 1512f0c9fe6SPaolo Bonzini BlockJob *job; 1522f0c9fe6SPaolo Bonzini BlockDriverCompletionFunc *cb; 1532f0c9fe6SPaolo Bonzini void *opaque; 1542f0c9fe6SPaolo Bonzini bool cancelled; 1552f0c9fe6SPaolo Bonzini int ret; 1562f0c9fe6SPaolo Bonzini }; 1572f0c9fe6SPaolo Bonzini 1582f0c9fe6SPaolo Bonzini static void block_job_cancel_cb(void *opaque, int ret) 1592f0c9fe6SPaolo Bonzini { 1602f0c9fe6SPaolo Bonzini struct BlockCancelData *data = opaque; 1612f0c9fe6SPaolo Bonzini 1622f0c9fe6SPaolo Bonzini data->cancelled = block_job_is_cancelled(data->job); 1632f0c9fe6SPaolo Bonzini data->ret = ret; 1642f0c9fe6SPaolo Bonzini data->cb(data->opaque, ret); 1652f0c9fe6SPaolo Bonzini } 1662f0c9fe6SPaolo Bonzini 1672f0c9fe6SPaolo Bonzini int block_job_cancel_sync(BlockJob *job) 1682f0c9fe6SPaolo Bonzini { 1692f0c9fe6SPaolo Bonzini struct BlockCancelData data; 1702f0c9fe6SPaolo Bonzini BlockDriverState *bs = job->bs; 1712f0c9fe6SPaolo Bonzini 1722f0c9fe6SPaolo Bonzini assert(bs->job == job); 1732f0c9fe6SPaolo Bonzini 1742f0c9fe6SPaolo Bonzini /* Set up our own callback to store the result and chain to 1752f0c9fe6SPaolo Bonzini * the original callback. 1762f0c9fe6SPaolo Bonzini */ 1772f0c9fe6SPaolo Bonzini data.job = job; 1782f0c9fe6SPaolo Bonzini data.cb = job->cb; 1792f0c9fe6SPaolo Bonzini data.opaque = job->opaque; 1802f0c9fe6SPaolo Bonzini data.ret = -EINPROGRESS; 1812f0c9fe6SPaolo Bonzini job->cb = block_job_cancel_cb; 1822f0c9fe6SPaolo Bonzini job->opaque = &data; 1832f0c9fe6SPaolo Bonzini block_job_cancel(job); 1842f0c9fe6SPaolo Bonzini while (data.ret == -EINPROGRESS) { 1852f0c9fe6SPaolo Bonzini qemu_aio_wait(); 1862f0c9fe6SPaolo Bonzini } 1872f0c9fe6SPaolo Bonzini return (data.cancelled && data.ret == 0) ? -ECANCELED : data.ret; 1882f0c9fe6SPaolo Bonzini } 1892f0c9fe6SPaolo Bonzini 1902f0c9fe6SPaolo Bonzini void block_job_sleep_ns(BlockJob *job, QEMUClock *clock, int64_t ns) 1912f0c9fe6SPaolo Bonzini { 1928acc72a4SPaolo Bonzini assert(job->busy); 1938acc72a4SPaolo Bonzini 1942f0c9fe6SPaolo Bonzini /* Check cancellation *before* setting busy = false, too! */ 1958acc72a4SPaolo Bonzini if (block_job_is_cancelled(job)) { 1968acc72a4SPaolo Bonzini return; 1972f0c9fe6SPaolo Bonzini } 1988acc72a4SPaolo Bonzini 1998acc72a4SPaolo Bonzini job->busy = false; 2008acc72a4SPaolo Bonzini if (block_job_is_paused(job)) { 2018acc72a4SPaolo Bonzini qemu_coroutine_yield(); 2028acc72a4SPaolo Bonzini } else { 2038acc72a4SPaolo Bonzini co_sleep_ns(clock, ns); 2048acc72a4SPaolo Bonzini } 2058acc72a4SPaolo Bonzini job->busy = true; 2062f0c9fe6SPaolo Bonzini } 20730e628b7SPaolo Bonzini 20830e628b7SPaolo Bonzini BlockJobInfo *block_job_query(BlockJob *job) 20930e628b7SPaolo Bonzini { 21030e628b7SPaolo Bonzini BlockJobInfo *info = g_new0(BlockJobInfo, 1); 21130e628b7SPaolo Bonzini info->type = g_strdup(job->job_type->job_type); 21230e628b7SPaolo Bonzini info->device = g_strdup(bdrv_get_device_name(job->bs)); 21330e628b7SPaolo Bonzini info->len = job->len; 2148d65883fSPaolo Bonzini info->busy = job->busy; 2158acc72a4SPaolo Bonzini info->paused = job->paused; 21630e628b7SPaolo Bonzini info->offset = job->offset; 21730e628b7SPaolo Bonzini info->speed = job->speed; 21832c81a4aSPaolo Bonzini info->io_status = job->iostatus; 21930e628b7SPaolo Bonzini return info; 22030e628b7SPaolo Bonzini } 22132c81a4aSPaolo Bonzini 22232c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 22332c81a4aSPaolo Bonzini { 22432c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 22532c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 22632c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 22732c81a4aSPaolo Bonzini } 22832c81a4aSPaolo Bonzini } 22932c81a4aSPaolo Bonzini 23032c81a4aSPaolo Bonzini 231a66a2a36SPaolo Bonzini QObject *qobject_from_block_job(BlockJob *job) 232a66a2a36SPaolo Bonzini { 233a66a2a36SPaolo Bonzini return qobject_from_jsonf("{ 'type': %s," 234a66a2a36SPaolo Bonzini "'device': %s," 235a66a2a36SPaolo Bonzini "'len': %" PRId64 "," 236a66a2a36SPaolo Bonzini "'offset': %" PRId64 "," 237a66a2a36SPaolo Bonzini "'speed': %" PRId64 " }", 238a66a2a36SPaolo Bonzini job->job_type->job_type, 239a66a2a36SPaolo Bonzini bdrv_get_device_name(job->bs), 240a66a2a36SPaolo Bonzini job->len, 241a66a2a36SPaolo Bonzini job->offset, 242a66a2a36SPaolo Bonzini job->speed); 243a66a2a36SPaolo Bonzini } 244a66a2a36SPaolo Bonzini 245a66a2a36SPaolo Bonzini void block_job_ready(BlockJob *job) 246a66a2a36SPaolo Bonzini { 247a66a2a36SPaolo Bonzini QObject *data = qobject_from_block_job(job); 248a66a2a36SPaolo Bonzini monitor_protocol_event(QEVENT_BLOCK_JOB_READY, data); 249a66a2a36SPaolo Bonzini qobject_decref(data); 250a66a2a36SPaolo Bonzini } 251a66a2a36SPaolo Bonzini 25232c81a4aSPaolo Bonzini BlockErrorAction block_job_error_action(BlockJob *job, BlockDriverState *bs, 25332c81a4aSPaolo Bonzini BlockdevOnError on_err, 25432c81a4aSPaolo Bonzini int is_read, int error) 25532c81a4aSPaolo Bonzini { 25632c81a4aSPaolo Bonzini BlockErrorAction action; 25732c81a4aSPaolo Bonzini 25832c81a4aSPaolo Bonzini switch (on_err) { 25932c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 26032c81a4aSPaolo Bonzini action = (error == ENOSPC) ? BDRV_ACTION_STOP : BDRV_ACTION_REPORT; 26132c81a4aSPaolo Bonzini break; 26232c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 26332c81a4aSPaolo Bonzini action = BDRV_ACTION_STOP; 26432c81a4aSPaolo Bonzini break; 26532c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 26632c81a4aSPaolo Bonzini action = BDRV_ACTION_REPORT; 26732c81a4aSPaolo Bonzini break; 26832c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 26932c81a4aSPaolo Bonzini action = BDRV_ACTION_IGNORE; 27032c81a4aSPaolo Bonzini break; 27132c81a4aSPaolo Bonzini default: 27232c81a4aSPaolo Bonzini abort(); 27332c81a4aSPaolo Bonzini } 27432c81a4aSPaolo Bonzini bdrv_emit_qmp_error_event(job->bs, QEVENT_BLOCK_JOB_ERROR, action, is_read); 27532c81a4aSPaolo Bonzini if (action == BDRV_ACTION_STOP) { 27632c81a4aSPaolo Bonzini block_job_pause(job); 27732c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 27832c81a4aSPaolo Bonzini if (bs != job->bs) { 27932c81a4aSPaolo Bonzini bdrv_iostatus_set_err(bs, error); 28032c81a4aSPaolo Bonzini } 28132c81a4aSPaolo Bonzini } 28232c81a4aSPaolo Bonzini return action; 28332c81a4aSPaolo Bonzini } 284