[mirror_qemu.git] / blockjob.c

/*
 * QEMU System Emulator block driver
 *
 * 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.
 */

#include "config-host.h"
#include "qemu-common.h"
#include "trace.h"
#include "block/block.h"
#include "block/blockjob.h"
#include "block/block_int.h"
#include "qapi/qmp/qjson.h"
#include "block/coroutine.h"
#include "qmp-commands.h"
#include "qemu/timer.h"
#include "qapi-event.h"

void *block_job_create(const BlockJobDriver *driver, BlockDriverState *bs,
                       int64_t speed, BlockDriverCompletionFunc *cb,
                       void *opaque, Error **errp)
{
    BlockJob *job;

    if (bs->job) {
        error_set(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
        return NULL;
    }
    bdrv_ref(bs);
    job = g_malloc0(driver->instance_size);
    error_setg(&job->blocker, "block device is in use by block job: %s",
               BlockJobType_lookup[driver->job_type]);
    bdrv_op_block_all(bs, job->blocker);

    job->driver        = driver;
    job->bs            = bs;
    job->cb            = cb;
    job->opaque        = opaque;
    job->busy          = true;
    bs->job = job;

    /* Only set speed when necessary to avoid NotSupported error */
    if (speed != 0) {
        Error *local_err = NULL;

        block_job_set_speed(job, speed, &local_err);
        if (local_err) {
            bs->job = NULL;
            bdrv_op_unblock_all(bs, job->blocker);
            error_free(job->blocker);
            g_free(job);
            error_propagate(errp, local_err);
            return NULL;
        }
    }
    return job;
}

void block_job_completed(BlockJob *job, int ret)
{
    BlockDriverState *bs = job->bs;

    assert(bs->job == job);
    job->cb(job->opaque, ret);
    bs->job = NULL;
    bdrv_op_unblock_all(bs, job->blocker);
    error_free(job->blocker);
    g_free(job);
}

void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp)
{
    Error *local_err = NULL;

    if (!job->driver->set_speed) {
        error_set(errp, QERR_UNSUPPORTED);
        return;
    }
    job->driver->set_speed(job, speed, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }

    job->speed = speed;
}

void block_job_complete(BlockJob *job, Error **errp)
{
    if (job->paused || job->cancelled || !job->driver->complete) {
        error_set(errp, QERR_BLOCK_JOB_NOT_READY,
                  bdrv_get_device_name(job->bs));
        return;
    }

    job->driver->complete(job, errp);
}

void block_job_pause(BlockJob *job)
{
    job->paused = true;
}

bool block_job_is_paused(BlockJob *job)
{
    return job->paused;
}

void block_job_resume(BlockJob *job)
{
    job->paused = false;
    block_job_iostatus_reset(job);
    if (job->co && !job->busy) {
        qemu_coroutine_enter(job->co, NULL);
    }
}

void block_job_cancel(BlockJob *job)
{
    job->cancelled = true;
    block_job_resume(job);
}

bool block_job_is_cancelled(BlockJob *job)
{
    return job->cancelled;
}

void block_job_iostatus_reset(BlockJob *job)
{
    job->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
    if (job->driver->iostatus_reset) {
        job->driver->iostatus_reset(job);
    }
}

struct BlockCancelData {
    BlockJob *job;
    BlockDriverCompletionFunc *cb;
    void *opaque;
    bool cancelled;
    int ret;
};

static void block_job_cancel_cb(void *opaque, int ret)
{
    struct BlockCancelData *data = opaque;

    data->cancelled = block_job_is_cancelled(data->job);
    data->ret = ret;
    data->cb(data->opaque, ret);
}

int block_job_cancel_sync(BlockJob *job)
{
    struct BlockCancelData data;
    BlockDriverState *bs = job->bs;

    assert(bs->job == job);

    /* Set up our own callback to store the result and chain to
     * the original callback.
     */
    data.job = job;
    data.cb = job->cb;
    data.opaque = job->opaque;
    data.ret = -EINPROGRESS;
    job->cb = block_job_cancel_cb;
    job->opaque = &data;
    block_job_cancel(job);
    while (data.ret == -EINPROGRESS) {
        aio_poll(bdrv_get_aio_context(bs), true);
    }
    return (data.cancelled && data.ret == 0) ? -ECANCELED : data.ret;
}

void block_job_sleep_ns(BlockJob *job, QEMUClockType type, int64_t ns)
{
    assert(job->busy);

    /* Check cancellation *before* setting busy = false, too!  */
    if (block_job_is_cancelled(job)) {
        return;
    }

    job->busy = false;
    if (block_job_is_paused(job)) {
        qemu_coroutine_yield();
    } else {
        co_aio_sleep_ns(bdrv_get_aio_context(job->bs), type, ns);
    }
    job->busy = true;
}

void block_job_yield(BlockJob *job)
{
    assert(job->busy);

    /* Check cancellation *before* setting busy = false, too!  */
    if (block_job_is_cancelled(job)) {
        return;
    }

    job->busy = false;
    qemu_coroutine_yield();
    job->busy = true;
}

BlockJobInfo *block_job_query(BlockJob *job)
{
    BlockJobInfo *info = g_new0(BlockJobInfo, 1);
    info->type      = g_strdup(BlockJobType_lookup[job->driver->job_type]);
    info->device    = g_strdup(bdrv_get_device_name(job->bs));
    info->len       = job->len;
    info->busy      = job->busy;
    info->paused    = job->paused;
    info->offset    = job->offset;
    info->speed     = job->speed;
    info->io_status = job->iostatus;
    return info;
}

static void block_job_iostatus_set_err(BlockJob *job, int error)
{
    if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
        job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
                                          BLOCK_DEVICE_IO_STATUS_FAILED;
    }
}

void block_job_event_cancelled(BlockJob *job)
{
    qapi_event_send_block_job_cancelled(job->driver->job_type,
                                        bdrv_get_device_name(job->bs),
                                        job->len,
                                        job->offset,
                                        job->speed,
                                        &error_abort);
}

void block_job_event_completed(BlockJob *job, const char *msg)
{
    qapi_event_send_block_job_completed(job->driver->job_type,
                                        bdrv_get_device_name(job->bs),
                                        job->len,
                                        job->offset,
                                        job->speed,
                                        !!msg,
                                        msg,
                                        &error_abort);
}

void block_job_event_ready(BlockJob *job)
{
    qapi_event_send_block_job_ready(job->driver->job_type,
                                    bdrv_get_device_name(job->bs),
                                    job->len,
                                    job->offset,
                                    job->speed, &error_abort);
}

BlockErrorAction block_job_error_action(BlockJob *job, BlockDriverState *bs,
                                        BlockdevOnError on_err,
                                        int is_read, int error)
{
    BlockErrorAction action;

    switch (on_err) {
    case BLOCKDEV_ON_ERROR_ENOSPC:
        action = (error == ENOSPC) ?
                 BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
        break;
    case BLOCKDEV_ON_ERROR_STOP:
        action = BLOCK_ERROR_ACTION_STOP;
        break;
    case BLOCKDEV_ON_ERROR_REPORT:
        action = BLOCK_ERROR_ACTION_REPORT;
        break;
    case BLOCKDEV_ON_ERROR_IGNORE:
        action = BLOCK_ERROR_ACTION_IGNORE;
        break;
    default:
        abort();
    }
    qapi_event_send_block_job_error(bdrv_get_device_name(job->bs),
                                    is_read ? IO_OPERATION_TYPE_READ :
                                    IO_OPERATION_TYPE_WRITE,
                                    action, &error_abort);
    if (action == BLOCK_ERROR_ACTION_STOP) {
        block_job_pause(job);
        block_job_iostatus_set_err(job, error);
        if (bs != job->bs) {
            bdrv_iostatus_set_err(bs, error);
        }
    }
    return action;
}
Commit	Line	Data
2f0c9fe6 PB	1	/*
	2	* QEMU System Emulator block driver
	3	*
	4	* Copyright (c) 2011 IBM Corp.
	5	* Copyright (c) 2012 Red Hat, Inc.
	6	*
	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:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	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
	23	* THE SOFTWARE.
	24	*/
	25
	26	#include "config-host.h"
	27	#include "qemu-common.h"
	28	#include "trace.h"
737e150e PB	29	#include "block/block.h"
	30	#include "block/blockjob.h"
	31	#include "block/block_int.h"
7b1b5d19	32	#include "qapi/qmp/qjson.h"
737e150e	33	#include "block/coroutine.h"
2f0c9fe6	34	#include "qmp-commands.h"
1de7afc9	35	#include "qemu/timer.h"
5a2d2cbd	36	#include "qapi-event.h"
2f0c9fe6	37
3fc4b10a	38	void block_job_create(const BlockJobDriver driver, BlockDriverState *bs,
2f0c9fe6 PB	39	int64_t speed, BlockDriverCompletionFunc *cb,
	40	void opaque, Error *errp)
	41	{
	42	BlockJob *job;
	43
628ff683	44	if (bs->job) {
2f0c9fe6 PB	45	error_set(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
	46	return NULL;
	47	}
fa510ebf	48	bdrv_ref(bs);
3fc4b10a	49	job = g_malloc0(driver->instance_size);
3718d8ab FZ	50	error_setg(&job->blocker, "block device is in use by block job: %s",
	51	BlockJobType_lookup[driver->job_type]);
	52	bdrv_op_block_all(bs, job->blocker);
	53
3fc4b10a	54	job->driver = driver;
2f0c9fe6 PB	55	job->bs = bs;
	56	job->cb = cb;
	57	job->opaque = opaque;
	58	job->busy = true;
	59	bs->job = job;
	60
	61	/* Only set speed when necessary to avoid NotSupported error */
	62	if (speed != 0) {
	63	Error *local_err = NULL;
	64
	65	block_job_set_speed(job, speed, &local_err);
84d18f06	66	if (local_err) {
2f0c9fe6	67	bs->job = NULL;
3718d8ab FZ	68	bdrv_op_unblock_all(bs, job->blocker);
3718d8ab FZ	69	error_free(job->blocker);
2f0c9fe6	70	g_free(job);
2f0c9fe6 PB	71	error_propagate(errp, local_err);
	72	return NULL;
	73	}
	74	}
	75	return job;
	76	}
	77
65f46322	78	void block_job_completed(BlockJob *job, int ret)
2f0c9fe6 PB	79	{
	80	BlockDriverState *bs = job->bs;
	81
	82	assert(bs->job == job);
	83	job->cb(job->opaque, ret);
	84	bs->job = NULL;
3718d8ab FZ	85	bdrv_op_unblock_all(bs, job->blocker);
3718d8ab FZ	86	error_free(job->blocker);
2f0c9fe6	87	g_free(job);
2f0c9fe6 PB	88	}
	89
	90	void block_job_set_speed(BlockJob job, int64_t speed, Error *errp)
	91	{
	92	Error *local_err = NULL;
	93
3fc4b10a	94	if (!job->driver->set_speed) {
0b15abfc	95	error_set(errp, QERR_UNSUPPORTED);
2f0c9fe6 PB	96	return;
2f0c9fe6 PB	97	}
3fc4b10a	98	job->driver->set_speed(job, speed, &local_err);
84d18f06	99	if (local_err) {
2f0c9fe6 PB	100	error_propagate(errp, local_err);
	101	return;
	102	}
	103
	104	job->speed = speed;
	105	}
	106
aeae883b PB	107	void block_job_complete(BlockJob job, Error *errp)
aeae883b PB	108	{
3fc4b10a	109	if (job->paused \|\| job->cancelled \|\| !job->driver->complete) {
bfb197e0 MA	110	error_set(errp, QERR_BLOCK_JOB_NOT_READY,
bfb197e0 MA	111	bdrv_get_device_name(job->bs));
aeae883b PB	112	return;
	113	}
	114
3fc4b10a	115	job->driver->complete(job, errp);
aeae883b PB	116	}
aeae883b PB	117
8acc72a4	118	void block_job_pause(BlockJob *job)
2f0c9fe6	119	{
8acc72a4 PB	120	job->paused = true;
	121	}
	122
	123	bool block_job_is_paused(BlockJob *job)
	124	{
	125	return job->paused;
	126	}
	127
	128	void block_job_resume(BlockJob *job)
	129	{
	130	job->paused = false;
32c81a4a	131	block_job_iostatus_reset(job);
2f0c9fe6 PB	132	if (job->co && !job->busy) {
	133	qemu_coroutine_enter(job->co, NULL);
	134	}
	135	}
	136
8acc72a4 PB	137	void block_job_cancel(BlockJob *job)
	138	{
	139	job->cancelled = true;
	140	block_job_resume(job);
	141	}
	142
2f0c9fe6 PB	143	bool block_job_is_cancelled(BlockJob *job)
	144	{
	145	return job->cancelled;
	146	}
	147
32c81a4a PB	148	void block_job_iostatus_reset(BlockJob *job)
	149	{
	150	job->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
3fc4b10a FZ	151	if (job->driver->iostatus_reset) {
3fc4b10a FZ	152	job->driver->iostatus_reset(job);
3bd293c3	153	}
32c81a4a PB	154	}
32c81a4a PB	155
2f0c9fe6 PB	156	struct BlockCancelData {
	157	BlockJob *job;
	158	BlockDriverCompletionFunc *cb;
	159	void *opaque;
	160	bool cancelled;
	161	int ret;
	162	};
	163
	164	static void block_job_cancel_cb(void *opaque, int ret)
	165	{
	166	struct BlockCancelData *data = opaque;
	167
	168	data->cancelled = block_job_is_cancelled(data->job);
	169	data->ret = ret;
	170	data->cb(data->opaque, ret);
	171	}
	172
	173	int block_job_cancel_sync(BlockJob *job)
	174	{
	175	struct BlockCancelData data;
	176	BlockDriverState *bs = job->bs;
	177
	178	assert(bs->job == job);
	179
	180	/* Set up our own callback to store the result and chain to
	181	* the original callback.
	182	*/
	183	data.job = job;
	184	data.cb = job->cb;
	185	data.opaque = job->opaque;
	186	data.ret = -EINPROGRESS;
	187	job->cb = block_job_cancel_cb;
	188	job->opaque = &data;
	189	block_job_cancel(job);
	190	while (data.ret == -EINPROGRESS) {
b47ec2c4	191	aio_poll(bdrv_get_aio_context(bs), true);
2f0c9fe6 PB	192	}
	193	return (data.cancelled && data.ret == 0) ? -ECANCELED : data.ret;
	194	}
	195
7483d1e5	196	void block_job_sleep_ns(BlockJob *job, QEMUClockType type, int64_t ns)
2f0c9fe6	197	{
8acc72a4 PB	198	assert(job->busy);
8acc72a4 PB	199
2f0c9fe6	200	/* Check cancellation before setting busy = false, too! */
8acc72a4 PB	201	if (block_job_is_cancelled(job)) {
	202	return;
	203	}
	204
	205	job->busy = false;
	206	if (block_job_is_paused(job)) {
	207	qemu_coroutine_yield();
	208	} else {
0b9caf9b	209	co_aio_sleep_ns(bdrv_get_aio_context(job->bs), type, ns);
2f0c9fe6	210	}
8acc72a4	211	job->busy = true;
2f0c9fe6	212	}
30e628b7	213
dc71ce45 FZ	214	void block_job_yield(BlockJob *job)
	215	{
	216	assert(job->busy);
	217
	218	/* Check cancellation before setting busy = false, too! */
	219	if (block_job_is_cancelled(job)) {
	220	return;
	221	}
	222
	223	job->busy = false;
	224	qemu_coroutine_yield();
	225	job->busy = true;
	226	}
	227
30e628b7 PB	228	BlockJobInfo block_job_query(BlockJob job)
	229	{
	230	BlockJobInfo *info = g_new0(BlockJobInfo, 1);
79e14bf7	231	info->type = g_strdup(BlockJobType_lookup[job->driver->job_type]);
32c81a4a PB	232	info->device = g_strdup(bdrv_get_device_name(job->bs));
	233	info->len = job->len;
	234	info->busy = job->busy;
	235	info->paused = job->paused;
	236	info->offset = job->offset;
	237	info->speed = job->speed;
	238	info->io_status = job->iostatus;
30e628b7 PB	239	return info;
30e628b7 PB	240	}
32c81a4a PB	241
	242	static void block_job_iostatus_set_err(BlockJob *job, int error)
	243	{
	244	if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
	245	job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
	246	BLOCK_DEVICE_IO_STATUS_FAILED;
	247	}
	248	}
	249
bcada37b WX	250	void block_job_event_cancelled(BlockJob *job)
	251	{
	252	qapi_event_send_block_job_cancelled(job->driver->job_type,
	253	bdrv_get_device_name(job->bs),
	254	job->len,
	255	job->offset,
	256	job->speed,
	257	&error_abort);
	258	}
32c81a4a	259
bcada37b	260	void block_job_event_completed(BlockJob job, const char msg)
a66a2a36	261	{
bcada37b WX	262	qapi_event_send_block_job_completed(job->driver->job_type,
	263	bdrv_get_device_name(job->bs),
	264	job->len,
	265	job->offset,
	266	job->speed,
	267	!!msg,
	268	msg,
	269	&error_abort);
a66a2a36 PB	270	}
a66a2a36 PB	271
bcada37b	272	void block_job_event_ready(BlockJob *job)
a66a2a36	273	{
518848a2 MA	274	qapi_event_send_block_job_ready(job->driver->job_type,
	275	bdrv_get_device_name(job->bs),
	276	job->len,
	277	job->offset,
	278	job->speed, &error_abort);
a66a2a36 PB	279	}
a66a2a36 PB	280
32c81a4a PB	281	BlockErrorAction block_job_error_action(BlockJob job, BlockDriverState bs,
	282	BlockdevOnError on_err,
	283	int is_read, int error)
	284	{
	285	BlockErrorAction action;
	286
	287	switch (on_err) {
	288	case BLOCKDEV_ON_ERROR_ENOSPC:
a589569f WX	289	action = (error == ENOSPC) ?
a589569f WX	290	BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
32c81a4a PB	291	break;
32c81a4a PB	292	case BLOCKDEV_ON_ERROR_STOP:
a589569f	293	action = BLOCK_ERROR_ACTION_STOP;
32c81a4a PB	294	break;
32c81a4a PB	295	case BLOCKDEV_ON_ERROR_REPORT:
a589569f	296	action = BLOCK_ERROR_ACTION_REPORT;
32c81a4a PB	297	break;
32c81a4a PB	298	case BLOCKDEV_ON_ERROR_IGNORE:
a589569f	299	action = BLOCK_ERROR_ACTION_IGNORE;
32c81a4a PB	300	break;
	301	default:
	302	abort();
	303	}
823c6863	304	qapi_event_send_block_job_error(bdrv_get_device_name(job->bs),
5a2d2cbd WX	305	is_read ? IO_OPERATION_TYPE_READ :
	306	IO_OPERATION_TYPE_WRITE,
	307	action, &error_abort);
a589569f	308	if (action == BLOCK_ERROR_ACTION_STOP) {
32c81a4a PB	309	block_job_pause(job);
	310	block_job_iostatus_set_err(job, error);
	311	if (bs != job->bs) {
	312	bdrv_iostatus_set_err(bs, error);
	313	}
	314	}
	315	return action;
	316	}