5 * Fam Zheng <famz@redhat.com>
7 * Copyright (C) 2014 Red Hat, Inc.
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
13 #include "qemu/osdep.h"
14 #include "qapi/error.h"
15 #include "qapi/qmp/qdict.h"
16 #include "qapi/qmp/qstring.h"
17 #include "block/block_int.h"
19 #define NULL_OPT_LATENCY "latency-ns"
20 #define NULL_OPT_ZEROES "read-zeroes"
28 static QemuOptsList runtime_opts
= {
30 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
34 .type
= QEMU_OPT_STRING
,
38 .name
= BLOCK_OPT_SIZE
,
39 .type
= QEMU_OPT_SIZE
,
40 .help
= "size of the null block",
43 .name
= NULL_OPT_LATENCY
,
44 .type
= QEMU_OPT_NUMBER
,
45 .help
= "nanoseconds (approximated) to wait "
46 "before completing request",
49 .name
= NULL_OPT_ZEROES
,
50 .type
= QEMU_OPT_BOOL
,
51 .help
= "return zeroes when read",
57 static int null_file_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
61 BDRVNullState
*s
= bs
->opaque
;
64 opts
= qemu_opts_create(&runtime_opts
, NULL
, 0, &error_abort
);
65 qemu_opts_absorb_qdict(opts
, options
, &error_abort
);
67 qemu_opt_get_size(opts
, BLOCK_OPT_SIZE
, 1 << 30);
69 qemu_opt_get_number(opts
, NULL_OPT_LATENCY
, 0);
70 if (s
->latency_ns
< 0) {
71 error_setg(errp
, "latency-ns is invalid");
74 s
->read_zeroes
= qemu_opt_get_bool(opts
, NULL_OPT_ZEROES
, false);
79 static void null_close(BlockDriverState
*bs
)
83 static int64_t null_getlength(BlockDriverState
*bs
)
85 BDRVNullState
*s
= bs
->opaque
;
89 static coroutine_fn
int null_co_common(BlockDriverState
*bs
)
91 BDRVNullState
*s
= bs
->opaque
;
94 co_aio_sleep_ns(bdrv_get_aio_context(bs
), QEMU_CLOCK_REALTIME
,
100 static coroutine_fn
int null_co_readv(BlockDriverState
*bs
,
101 int64_t sector_num
, int nb_sectors
,
104 BDRVNullState
*s
= bs
->opaque
;
106 if (s
->read_zeroes
) {
107 qemu_iovec_memset(qiov
, 0, 0, nb_sectors
* BDRV_SECTOR_SIZE
);
110 return null_co_common(bs
);
113 static coroutine_fn
int null_co_writev(BlockDriverState
*bs
,
114 int64_t sector_num
, int nb_sectors
,
117 return null_co_common(bs
);
120 static coroutine_fn
int null_co_flush(BlockDriverState
*bs
)
122 return null_co_common(bs
);
130 static const AIOCBInfo null_aiocb_info
= {
131 .aiocb_size
= sizeof(NullAIOCB
),
134 static void null_bh_cb(void *opaque
)
136 NullAIOCB
*acb
= opaque
;
137 AioContext
*ctx
= bdrv_get_aio_context(acb
->common
.bs
);
139 aio_context_acquire(ctx
);
140 acb
->common
.cb(acb
->common
.opaque
, 0);
141 aio_context_release(ctx
);
145 static void null_timer_cb(void *opaque
)
147 NullAIOCB
*acb
= opaque
;
148 AioContext
*ctx
= bdrv_get_aio_context(acb
->common
.bs
);
150 aio_context_acquire(ctx
);
151 acb
->common
.cb(acb
->common
.opaque
, 0);
152 aio_context_release(ctx
);
153 timer_deinit(&acb
->timer
);
157 static inline BlockAIOCB
*null_aio_common(BlockDriverState
*bs
,
158 BlockCompletionFunc
*cb
,
162 BDRVNullState
*s
= bs
->opaque
;
164 acb
= qemu_aio_get(&null_aiocb_info
, bs
, cb
, opaque
);
165 /* Only emulate latency after vcpu is running. */
167 aio_timer_init(bdrv_get_aio_context(bs
), &acb
->timer
,
168 QEMU_CLOCK_REALTIME
, SCALE_NS
,
170 timer_mod_ns(&acb
->timer
,
171 qemu_clock_get_ns(QEMU_CLOCK_REALTIME
) + s
->latency_ns
);
173 aio_bh_schedule_oneshot(bdrv_get_aio_context(bs
), null_bh_cb
, acb
);
178 static BlockAIOCB
*null_aio_readv(BlockDriverState
*bs
,
179 int64_t sector_num
, QEMUIOVector
*qiov
,
181 BlockCompletionFunc
*cb
,
184 BDRVNullState
*s
= bs
->opaque
;
186 if (s
->read_zeroes
) {
187 qemu_iovec_memset(qiov
, 0, 0, nb_sectors
* BDRV_SECTOR_SIZE
);
190 return null_aio_common(bs
, cb
, opaque
);
193 static BlockAIOCB
*null_aio_writev(BlockDriverState
*bs
,
194 int64_t sector_num
, QEMUIOVector
*qiov
,
196 BlockCompletionFunc
*cb
,
199 return null_aio_common(bs
, cb
, opaque
);
202 static BlockAIOCB
*null_aio_flush(BlockDriverState
*bs
,
203 BlockCompletionFunc
*cb
,
206 return null_aio_common(bs
, cb
, opaque
);
209 static int null_reopen_prepare(BDRVReopenState
*reopen_state
,
210 BlockReopenQueue
*queue
, Error
**errp
)
215 static int64_t coroutine_fn
null_co_get_block_status(BlockDriverState
*bs
,
217 int nb_sectors
, int *pnum
,
218 BlockDriverState
**file
)
220 BDRVNullState
*s
= bs
->opaque
;
221 off_t start
= sector_num
* BDRV_SECTOR_SIZE
;
226 if (s
->read_zeroes
) {
227 return BDRV_BLOCK_OFFSET_VALID
| start
| BDRV_BLOCK_ZERO
;
229 return BDRV_BLOCK_OFFSET_VALID
| start
;
233 static void null_refresh_filename(BlockDriverState
*bs
, QDict
*opts
)
236 qdict_del(opts
, "filename");
238 if (!qdict_size(opts
)) {
239 snprintf(bs
->exact_filename
, sizeof(bs
->exact_filename
), "%s://",
240 bs
->drv
->format_name
);
243 qdict_put(opts
, "driver", qstring_from_str(bs
->drv
->format_name
));
244 bs
->full_open_options
= opts
;
247 static BlockDriver bdrv_null_co
= {
248 .format_name
= "null-co",
249 .protocol_name
= "null-co",
250 .instance_size
= sizeof(BDRVNullState
),
252 .bdrv_file_open
= null_file_open
,
253 .bdrv_close
= null_close
,
254 .bdrv_getlength
= null_getlength
,
256 .bdrv_co_readv
= null_co_readv
,
257 .bdrv_co_writev
= null_co_writev
,
258 .bdrv_co_flush_to_disk
= null_co_flush
,
259 .bdrv_reopen_prepare
= null_reopen_prepare
,
261 .bdrv_co_get_block_status
= null_co_get_block_status
,
263 .bdrv_refresh_filename
= null_refresh_filename
,
266 static BlockDriver bdrv_null_aio
= {
267 .format_name
= "null-aio",
268 .protocol_name
= "null-aio",
269 .instance_size
= sizeof(BDRVNullState
),
271 .bdrv_file_open
= null_file_open
,
272 .bdrv_close
= null_close
,
273 .bdrv_getlength
= null_getlength
,
275 .bdrv_aio_readv
= null_aio_readv
,
276 .bdrv_aio_writev
= null_aio_writev
,
277 .bdrv_aio_flush
= null_aio_flush
,
278 .bdrv_reopen_prepare
= null_reopen_prepare
,
280 .bdrv_co_get_block_status
= null_co_get_block_status
,
282 .bdrv_refresh_filename
= null_refresh_filename
,
285 static void bdrv_null_init(void)
287 bdrv_register(&bdrv_null_co
);
288 bdrv_register(&bdrv_null_aio
);
291 block_init(bdrv_null_init
);