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" 2983c9089eSPaolo Bonzini #include "monitor/monitor.h" 30737e150eSPaolo Bonzini #include "block/block.h" 31737e150eSPaolo Bonzini #include "block/blockjob.h" 32737e150eSPaolo Bonzini #include "block/block_int.h" 337b1b5d19SPaolo Bonzini #include "qapi/qmp/qjson.h" 34737e150eSPaolo Bonzini #include "block/coroutine.h" 352f0c9fe6SPaolo Bonzini #include "qmp-commands.h" 361de7afc9SPaolo Bonzini #include "qemu/timer.h" 37*5a2d2cbdSWenchao Xia #include "qapi-event.h" 382f0c9fe6SPaolo Bonzini 393fc4b10aSFam Zheng void *block_job_create(const BlockJobDriver *driver, BlockDriverState *bs, 402f0c9fe6SPaolo Bonzini int64_t speed, BlockDriverCompletionFunc *cb, 412f0c9fe6SPaolo Bonzini void *opaque, Error **errp) 422f0c9fe6SPaolo Bonzini { 432f0c9fe6SPaolo Bonzini BlockJob *job; 442f0c9fe6SPaolo Bonzini 45628ff683SFam Zheng if (bs->job) { 462f0c9fe6SPaolo Bonzini error_set(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); 472f0c9fe6SPaolo Bonzini return NULL; 482f0c9fe6SPaolo Bonzini } 49fa510ebfSFam Zheng bdrv_ref(bs); 503fc4b10aSFam Zheng job = g_malloc0(driver->instance_size); 513718d8abSFam Zheng error_setg(&job->blocker, "block device is in use by block job: %s", 523718d8abSFam Zheng BlockJobType_lookup[driver->job_type]); 533718d8abSFam Zheng bdrv_op_block_all(bs, job->blocker); 543718d8abSFam Zheng 553fc4b10aSFam Zheng job->driver = driver; 562f0c9fe6SPaolo Bonzini job->bs = bs; 572f0c9fe6SPaolo Bonzini job->cb = cb; 582f0c9fe6SPaolo Bonzini job->opaque = opaque; 592f0c9fe6SPaolo Bonzini job->busy = true; 602f0c9fe6SPaolo Bonzini bs->job = job; 612f0c9fe6SPaolo Bonzini 622f0c9fe6SPaolo Bonzini /* Only set speed when necessary to avoid NotSupported error */ 632f0c9fe6SPaolo Bonzini if (speed != 0) { 642f0c9fe6SPaolo Bonzini Error *local_err = NULL; 652f0c9fe6SPaolo Bonzini 662f0c9fe6SPaolo Bonzini block_job_set_speed(job, speed, &local_err); 6784d18f06SMarkus Armbruster if (local_err) { 682f0c9fe6SPaolo Bonzini bs->job = NULL; 693718d8abSFam Zheng bdrv_op_unblock_all(bs, job->blocker); 703718d8abSFam Zheng error_free(job->blocker); 712f0c9fe6SPaolo Bonzini g_free(job); 722f0c9fe6SPaolo Bonzini error_propagate(errp, local_err); 732f0c9fe6SPaolo Bonzini return NULL; 742f0c9fe6SPaolo Bonzini } 752f0c9fe6SPaolo Bonzini } 762f0c9fe6SPaolo Bonzini return job; 772f0c9fe6SPaolo Bonzini } 782f0c9fe6SPaolo Bonzini 7965f46322SPaolo Bonzini void block_job_completed(BlockJob *job, int ret) 802f0c9fe6SPaolo Bonzini { 812f0c9fe6SPaolo Bonzini BlockDriverState *bs = job->bs; 822f0c9fe6SPaolo Bonzini 832f0c9fe6SPaolo Bonzini assert(bs->job == job); 842f0c9fe6SPaolo Bonzini job->cb(job->opaque, ret); 852f0c9fe6SPaolo Bonzini bs->job = NULL; 863718d8abSFam Zheng bdrv_op_unblock_all(bs, job->blocker); 873718d8abSFam Zheng error_free(job->blocker); 882f0c9fe6SPaolo Bonzini g_free(job); 892f0c9fe6SPaolo Bonzini } 902f0c9fe6SPaolo Bonzini 912f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 922f0c9fe6SPaolo Bonzini { 932f0c9fe6SPaolo Bonzini Error *local_err = NULL; 942f0c9fe6SPaolo Bonzini 953fc4b10aSFam Zheng if (!job->driver->set_speed) { 960b15abfcSCole Robinson error_set(errp, QERR_UNSUPPORTED); 972f0c9fe6SPaolo Bonzini return; 982f0c9fe6SPaolo Bonzini } 993fc4b10aSFam Zheng job->driver->set_speed(job, speed, &local_err); 10084d18f06SMarkus Armbruster if (local_err) { 1012f0c9fe6SPaolo Bonzini error_propagate(errp, local_err); 1022f0c9fe6SPaolo Bonzini return; 1032f0c9fe6SPaolo Bonzini } 1042f0c9fe6SPaolo Bonzini 1052f0c9fe6SPaolo Bonzini job->speed = speed; 1062f0c9fe6SPaolo Bonzini } 1072f0c9fe6SPaolo Bonzini 108aeae883bSPaolo Bonzini void block_job_complete(BlockJob *job, Error **errp) 109aeae883bSPaolo Bonzini { 1103fc4b10aSFam Zheng if (job->paused || job->cancelled || !job->driver->complete) { 111aeae883bSPaolo Bonzini error_set(errp, QERR_BLOCK_JOB_NOT_READY, job->bs->device_name); 112aeae883bSPaolo Bonzini return; 113aeae883bSPaolo Bonzini } 114aeae883bSPaolo Bonzini 1153fc4b10aSFam Zheng job->driver->complete(job, errp); 116aeae883bSPaolo Bonzini } 117aeae883bSPaolo Bonzini 1188acc72a4SPaolo Bonzini void block_job_pause(BlockJob *job) 1192f0c9fe6SPaolo Bonzini { 1208acc72a4SPaolo Bonzini job->paused = true; 1218acc72a4SPaolo Bonzini } 1228acc72a4SPaolo Bonzini 1238acc72a4SPaolo Bonzini bool block_job_is_paused(BlockJob *job) 1248acc72a4SPaolo Bonzini { 1258acc72a4SPaolo Bonzini return job->paused; 1268acc72a4SPaolo Bonzini } 1278acc72a4SPaolo Bonzini 1288acc72a4SPaolo Bonzini void block_job_resume(BlockJob *job) 1298acc72a4SPaolo Bonzini { 1308acc72a4SPaolo Bonzini job->paused = false; 13132c81a4aSPaolo Bonzini block_job_iostatus_reset(job); 1322f0c9fe6SPaolo Bonzini if (job->co && !job->busy) { 1332f0c9fe6SPaolo Bonzini qemu_coroutine_enter(job->co, NULL); 1342f0c9fe6SPaolo Bonzini } 1352f0c9fe6SPaolo Bonzini } 1362f0c9fe6SPaolo Bonzini 1378acc72a4SPaolo Bonzini void block_job_cancel(BlockJob *job) 1388acc72a4SPaolo Bonzini { 1398acc72a4SPaolo Bonzini job->cancelled = true; 1408acc72a4SPaolo Bonzini block_job_resume(job); 1418acc72a4SPaolo Bonzini } 1428acc72a4SPaolo Bonzini 1432f0c9fe6SPaolo Bonzini bool block_job_is_cancelled(BlockJob *job) 1442f0c9fe6SPaolo Bonzini { 1452f0c9fe6SPaolo Bonzini return job->cancelled; 1462f0c9fe6SPaolo Bonzini } 1472f0c9fe6SPaolo Bonzini 14832c81a4aSPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 14932c81a4aSPaolo Bonzini { 15032c81a4aSPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 1513fc4b10aSFam Zheng if (job->driver->iostatus_reset) { 1523fc4b10aSFam Zheng job->driver->iostatus_reset(job); 1533bd293c3SPaolo Bonzini } 15432c81a4aSPaolo Bonzini } 15532c81a4aSPaolo Bonzini 1562f0c9fe6SPaolo Bonzini struct BlockCancelData { 1572f0c9fe6SPaolo Bonzini BlockJob *job; 1582f0c9fe6SPaolo Bonzini BlockDriverCompletionFunc *cb; 1592f0c9fe6SPaolo Bonzini void *opaque; 1602f0c9fe6SPaolo Bonzini bool cancelled; 1612f0c9fe6SPaolo Bonzini int ret; 1622f0c9fe6SPaolo Bonzini }; 1632f0c9fe6SPaolo Bonzini 1642f0c9fe6SPaolo Bonzini static void block_job_cancel_cb(void *opaque, int ret) 1652f0c9fe6SPaolo Bonzini { 1662f0c9fe6SPaolo Bonzini struct BlockCancelData *data = opaque; 1672f0c9fe6SPaolo Bonzini 1682f0c9fe6SPaolo Bonzini data->cancelled = block_job_is_cancelled(data->job); 1692f0c9fe6SPaolo Bonzini data->ret = ret; 1702f0c9fe6SPaolo Bonzini data->cb(data->opaque, ret); 1712f0c9fe6SPaolo Bonzini } 1722f0c9fe6SPaolo Bonzini 1732f0c9fe6SPaolo Bonzini int block_job_cancel_sync(BlockJob *job) 1742f0c9fe6SPaolo Bonzini { 1752f0c9fe6SPaolo Bonzini struct BlockCancelData data; 1762f0c9fe6SPaolo Bonzini BlockDriverState *bs = job->bs; 1772f0c9fe6SPaolo Bonzini 1782f0c9fe6SPaolo Bonzini assert(bs->job == job); 1792f0c9fe6SPaolo Bonzini 1802f0c9fe6SPaolo Bonzini /* Set up our own callback to store the result and chain to 1812f0c9fe6SPaolo Bonzini * the original callback. 1822f0c9fe6SPaolo Bonzini */ 1832f0c9fe6SPaolo Bonzini data.job = job; 1842f0c9fe6SPaolo Bonzini data.cb = job->cb; 1852f0c9fe6SPaolo Bonzini data.opaque = job->opaque; 1862f0c9fe6SPaolo Bonzini data.ret = -EINPROGRESS; 1872f0c9fe6SPaolo Bonzini job->cb = block_job_cancel_cb; 1882f0c9fe6SPaolo Bonzini job->opaque = &data; 1892f0c9fe6SPaolo Bonzini block_job_cancel(job); 1902f0c9fe6SPaolo Bonzini while (data.ret == -EINPROGRESS) { 1912f0c9fe6SPaolo Bonzini qemu_aio_wait(); 1922f0c9fe6SPaolo Bonzini } 1932f0c9fe6SPaolo Bonzini return (data.cancelled && data.ret == 0) ? -ECANCELED : data.ret; 1942f0c9fe6SPaolo Bonzini } 1952f0c9fe6SPaolo Bonzini 1967483d1e5SAlex Bligh void block_job_sleep_ns(BlockJob *job, QEMUClockType type, int64_t ns) 1972f0c9fe6SPaolo Bonzini { 1988acc72a4SPaolo Bonzini assert(job->busy); 1998acc72a4SPaolo Bonzini 2002f0c9fe6SPaolo Bonzini /* Check cancellation *before* setting busy = false, too! */ 2018acc72a4SPaolo Bonzini if (block_job_is_cancelled(job)) { 2028acc72a4SPaolo Bonzini return; 2032f0c9fe6SPaolo Bonzini } 2048acc72a4SPaolo Bonzini 2058acc72a4SPaolo Bonzini job->busy = false; 2068acc72a4SPaolo Bonzini if (block_job_is_paused(job)) { 2078acc72a4SPaolo Bonzini qemu_coroutine_yield(); 2088acc72a4SPaolo Bonzini } else { 2097483d1e5SAlex Bligh co_sleep_ns(type, ns); 2108acc72a4SPaolo Bonzini } 2118acc72a4SPaolo Bonzini job->busy = true; 2122f0c9fe6SPaolo Bonzini } 21330e628b7SPaolo Bonzini 21430e628b7SPaolo Bonzini BlockJobInfo *block_job_query(BlockJob *job) 21530e628b7SPaolo Bonzini { 21630e628b7SPaolo Bonzini BlockJobInfo *info = g_new0(BlockJobInfo, 1); 21779e14bf7SFam Zheng info->type = g_strdup(BlockJobType_lookup[job->driver->job_type]); 21830e628b7SPaolo Bonzini info->device = g_strdup(bdrv_get_device_name(job->bs)); 21930e628b7SPaolo Bonzini info->len = job->len; 2208d65883fSPaolo Bonzini info->busy = job->busy; 2218acc72a4SPaolo Bonzini info->paused = job->paused; 22230e628b7SPaolo Bonzini info->offset = job->offset; 22330e628b7SPaolo Bonzini info->speed = job->speed; 22432c81a4aSPaolo Bonzini info->io_status = job->iostatus; 22530e628b7SPaolo Bonzini return info; 22630e628b7SPaolo Bonzini } 22732c81a4aSPaolo Bonzini 22832c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 22932c81a4aSPaolo Bonzini { 23032c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 23132c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 23232c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 23332c81a4aSPaolo Bonzini } 23432c81a4aSPaolo Bonzini } 23532c81a4aSPaolo Bonzini 23632c81a4aSPaolo Bonzini 237a66a2a36SPaolo Bonzini QObject *qobject_from_block_job(BlockJob *job) 238a66a2a36SPaolo Bonzini { 239a66a2a36SPaolo Bonzini return qobject_from_jsonf("{ 'type': %s," 240a66a2a36SPaolo Bonzini "'device': %s," 241a66a2a36SPaolo Bonzini "'len': %" PRId64 "," 242a66a2a36SPaolo Bonzini "'offset': %" PRId64 "," 243a66a2a36SPaolo Bonzini "'speed': %" PRId64 " }", 24479e14bf7SFam Zheng BlockJobType_lookup[job->driver->job_type], 245a66a2a36SPaolo Bonzini bdrv_get_device_name(job->bs), 246a66a2a36SPaolo Bonzini job->len, 247a66a2a36SPaolo Bonzini job->offset, 248a66a2a36SPaolo Bonzini job->speed); 249a66a2a36SPaolo Bonzini } 250a66a2a36SPaolo Bonzini 251a66a2a36SPaolo Bonzini void block_job_ready(BlockJob *job) 252a66a2a36SPaolo Bonzini { 253a66a2a36SPaolo Bonzini QObject *data = qobject_from_block_job(job); 254a66a2a36SPaolo Bonzini monitor_protocol_event(QEVENT_BLOCK_JOB_READY, data); 255a66a2a36SPaolo Bonzini qobject_decref(data); 256a66a2a36SPaolo Bonzini } 257a66a2a36SPaolo Bonzini 25832c81a4aSPaolo Bonzini BlockErrorAction block_job_error_action(BlockJob *job, BlockDriverState *bs, 25932c81a4aSPaolo Bonzini BlockdevOnError on_err, 26032c81a4aSPaolo Bonzini int is_read, int error) 26132c81a4aSPaolo Bonzini { 26232c81a4aSPaolo Bonzini BlockErrorAction action; 26332c81a4aSPaolo Bonzini 26432c81a4aSPaolo Bonzini switch (on_err) { 26532c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 266a589569fSWenchao Xia action = (error == ENOSPC) ? 267a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 26832c81a4aSPaolo Bonzini break; 26932c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 270a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 27132c81a4aSPaolo Bonzini break; 27232c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 273a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 27432c81a4aSPaolo Bonzini break; 27532c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 276a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 27732c81a4aSPaolo Bonzini break; 27832c81a4aSPaolo Bonzini default: 27932c81a4aSPaolo Bonzini abort(); 28032c81a4aSPaolo Bonzini } 281*5a2d2cbdSWenchao Xia qapi_event_send_block_job_error(bdrv_get_device_name(bs), 282*5a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 283*5a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 284*5a2d2cbdSWenchao Xia action, &error_abort); 285a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 28632c81a4aSPaolo Bonzini block_job_pause(job); 28732c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 28832c81a4aSPaolo Bonzini if (bs != job->bs) { 28932c81a4aSPaolo Bonzini bdrv_iostatus_set_err(bs, error); 29032c81a4aSPaolo Bonzini } 29132c81a4aSPaolo Bonzini } 29232c81a4aSPaolo Bonzini return action; 29332c81a4aSPaolo Bonzini } 294