1 /* BlockDriver implementation for "raw" format driver
3 * Copyright (C) 2010-2016 Red Hat, Inc.
4 * Copyright (C) 2010, Blue Swirl <blauwirbel@gmail.com>
5 * Copyright (C) 2009, Anthony Liguori <aliguori@us.ibm.com>
8 * Laszlo Ersek <lersek@redhat.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to
12 * deal in the Software without restriction, including without limitation the
13 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
14 * sell copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
25 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
29 #include "qemu/osdep.h"
30 #include "block/block-io.h"
31 #include "block/block_int.h"
32 #include "qapi/error.h"
33 #include "qemu/module.h"
34 #include "qemu/option.h"
35 #include "qemu/memalign.h"
37 typedef struct BDRVRawState
{
43 static const char *const mutable_opts
[] = { "offset", "size", NULL
};
45 static QemuOptsList raw_runtime_opts
= {
47 .head
= QTAILQ_HEAD_INITIALIZER(raw_runtime_opts
.head
),
51 .type
= QEMU_OPT_SIZE
,
52 .help
= "offset in the disk where the image starts",
56 .type
= QEMU_OPT_SIZE
,
57 .help
= "virtual disk size",
63 static QemuOptsList raw_create_opts
= {
64 .name
= "raw-create-opts",
65 .head
= QTAILQ_HEAD_INITIALIZER(raw_create_opts
.head
),
68 .name
= BLOCK_OPT_SIZE
,
69 .type
= QEMU_OPT_SIZE
,
70 .help
= "Virtual disk size"
76 static int raw_read_options(QDict
*options
, uint64_t *offset
, bool *has_size
,
77 uint64_t *size
, Error
**errp
)
79 QemuOpts
*opts
= NULL
;
82 opts
= qemu_opts_create(&raw_runtime_opts
, NULL
, 0, &error_abort
);
83 if (!qemu_opts_absorb_qdict(opts
, options
, errp
)) {
88 *offset
= qemu_opt_get_size(opts
, "offset", 0);
89 *has_size
= qemu_opt_find(opts
, "size");
90 *size
= qemu_opt_get_size(opts
, "size", 0);
98 static int raw_apply_options(BlockDriverState
*bs
, BDRVRawState
*s
,
99 uint64_t offset
, bool has_size
, uint64_t size
,
102 int64_t real_size
= 0;
104 real_size
= bdrv_getlength(bs
->file
->bs
);
106 error_setg_errno(errp
, -real_size
, "Could not get image size");
110 /* Check size and offset */
111 if (offset
> real_size
) {
112 error_setg(errp
, "Offset (%" PRIu64
") cannot be greater than "
113 "size of the containing file (%" PRId64
")",
114 s
->offset
, real_size
);
118 if (has_size
&& (real_size
- offset
) < size
) {
119 error_setg(errp
, "The sum of offset (%" PRIu64
") and size "
120 "(%" PRIu64
") has to be smaller or equal to the "
121 " actual size of the containing file (%" PRId64
")",
122 s
->offset
, s
->size
, real_size
);
126 /* Make sure size is multiple of BDRV_SECTOR_SIZE to prevent rounding
127 * up and leaking out of the specified area. */
128 if (has_size
&& !QEMU_IS_ALIGNED(size
, BDRV_SECTOR_SIZE
)) {
129 error_setg(errp
, "Specified size is not multiple of %llu",
135 s
->has_size
= has_size
;
136 s
->size
= has_size
? size
: real_size
- offset
;
141 static int raw_reopen_prepare(BDRVReopenState
*reopen_state
,
142 BlockReopenQueue
*queue
, Error
**errp
)
145 uint64_t offset
, size
;
148 assert(reopen_state
!= NULL
);
149 assert(reopen_state
->bs
!= NULL
);
151 reopen_state
->opaque
= g_new0(BDRVRawState
, 1);
153 ret
= raw_read_options(reopen_state
->options
, &offset
, &has_size
, &size
,
159 ret
= raw_apply_options(reopen_state
->bs
, reopen_state
->opaque
,
160 offset
, has_size
, size
, errp
);
168 static void raw_reopen_commit(BDRVReopenState
*state
)
170 BDRVRawState
*new_s
= state
->opaque
;
171 BDRVRawState
*s
= state
->bs
->opaque
;
173 memcpy(s
, new_s
, sizeof(BDRVRawState
));
175 g_free(state
->opaque
);
176 state
->opaque
= NULL
;
179 static void raw_reopen_abort(BDRVReopenState
*state
)
181 g_free(state
->opaque
);
182 state
->opaque
= NULL
;
185 /* Check and adjust the offset, against 'offset' and 'size' options. */
186 static inline int raw_adjust_offset(BlockDriverState
*bs
, int64_t *offset
,
187 int64_t bytes
, bool is_write
)
189 BDRVRawState
*s
= bs
->opaque
;
191 if (s
->has_size
&& (*offset
> s
->size
|| bytes
> (s
->size
- *offset
))) {
192 /* There's not enough space for the write, or the read request is
193 * out-of-range. Don't read/write anything to prevent leaking out of
194 * the size specified in options. */
195 return is_write
? -ENOSPC
: -EINVAL
;
198 if (*offset
> INT64_MAX
- s
->offset
) {
201 *offset
+= s
->offset
;
206 static int coroutine_fn
raw_co_preadv(BlockDriverState
*bs
, int64_t offset
,
207 int64_t bytes
, QEMUIOVector
*qiov
,
208 BdrvRequestFlags flags
)
212 ret
= raw_adjust_offset(bs
, &offset
, bytes
, false);
217 BLKDBG_EVENT(bs
->file
, BLKDBG_READ_AIO
);
218 return bdrv_co_preadv(bs
->file
, offset
, bytes
, qiov
, flags
);
221 static int coroutine_fn
raw_co_pwritev(BlockDriverState
*bs
, int64_t offset
,
222 int64_t bytes
, QEMUIOVector
*qiov
,
223 BdrvRequestFlags flags
)
227 QEMUIOVector local_qiov
;
230 if (bs
->probed
&& offset
< BLOCK_PROBE_BUF_SIZE
&& bytes
) {
231 /* Handling partial writes would be a pain - so we just
232 * require that guests have 512-byte request alignment if
233 * probing occurred */
234 QEMU_BUILD_BUG_ON(BLOCK_PROBE_BUF_SIZE
!= 512);
235 QEMU_BUILD_BUG_ON(BDRV_SECTOR_SIZE
!= 512);
236 assert(offset
== 0 && bytes
>= BLOCK_PROBE_BUF_SIZE
);
238 buf
= qemu_try_blockalign(bs
->file
->bs
, 512);
244 ret
= qemu_iovec_to_buf(qiov
, 0, buf
, 512);
250 drv
= bdrv_probe_all(buf
, 512, NULL
);
251 if (drv
!= bs
->drv
) {
256 /* Use the checked buffer, a malicious guest might be overwriting its
257 * original buffer in the background. */
258 qemu_iovec_init(&local_qiov
, qiov
->niov
+ 1);
259 qemu_iovec_add(&local_qiov
, buf
, 512);
260 qemu_iovec_concat(&local_qiov
, qiov
, 512, qiov
->size
- 512);
263 flags
&= ~BDRV_REQ_REGISTERED_BUF
;
266 ret
= raw_adjust_offset(bs
, &offset
, bytes
, true);
271 BLKDBG_EVENT(bs
->file
, BLKDBG_WRITE_AIO
);
272 ret
= bdrv_co_pwritev(bs
->file
, offset
, bytes
, qiov
, flags
);
275 if (qiov
== &local_qiov
) {
276 qemu_iovec_destroy(&local_qiov
);
282 static int coroutine_fn
raw_co_block_status(BlockDriverState
*bs
,
283 bool want_zero
, int64_t offset
,
284 int64_t bytes
, int64_t *pnum
,
286 BlockDriverState
**file
)
288 BDRVRawState
*s
= bs
->opaque
;
290 *file
= bs
->file
->bs
;
291 *map
= offset
+ s
->offset
;
292 return BDRV_BLOCK_RAW
| BDRV_BLOCK_OFFSET_VALID
;
295 static int coroutine_fn
raw_co_pwrite_zeroes(BlockDriverState
*bs
,
296 int64_t offset
, int64_t bytes
,
297 BdrvRequestFlags flags
)
301 ret
= raw_adjust_offset(bs
, &offset
, bytes
, true);
305 return bdrv_co_pwrite_zeroes(bs
->file
, offset
, bytes
, flags
);
308 static int coroutine_fn
raw_co_pdiscard(BlockDriverState
*bs
,
309 int64_t offset
, int64_t bytes
)
313 ret
= raw_adjust_offset(bs
, &offset
, bytes
, true);
317 return bdrv_co_pdiscard(bs
->file
, offset
, bytes
);
320 static int64_t raw_getlength(BlockDriverState
*bs
)
323 BDRVRawState
*s
= bs
->opaque
;
325 /* Update size. It should not change unless the file was externally
327 len
= bdrv_getlength(bs
->file
->bs
);
332 if (len
< s
->offset
) {
336 /* Try to honour the size */
337 s
->size
= MIN(s
->size
, len
- s
->offset
);
339 s
->size
= len
- s
->offset
;
346 static BlockMeasureInfo
*raw_measure(QemuOpts
*opts
, BlockDriverState
*in_bs
,
349 BlockMeasureInfo
*info
;
353 required
= bdrv_getlength(in_bs
);
355 error_setg_errno(errp
, -required
, "Unable to get image size");
359 required
= ROUND_UP(qemu_opt_get_size_del(opts
, BLOCK_OPT_SIZE
, 0),
363 info
= g_new0(BlockMeasureInfo
, 1);
364 info
->required
= required
;
366 /* Unallocated sectors count towards the file size in raw images */
367 info
->fully_allocated
= info
->required
;
371 static int raw_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
373 return bdrv_get_info(bs
->file
->bs
, bdi
);
376 static void raw_refresh_limits(BlockDriverState
*bs
, Error
**errp
)
379 /* To make it easier to protect the first sector, any probed
380 * image is restricted to read-modify-write on sub-sector
382 bs
->bl
.request_alignment
= BDRV_SECTOR_SIZE
;
386 static int coroutine_fn
raw_co_truncate(BlockDriverState
*bs
, int64_t offset
,
387 bool exact
, PreallocMode prealloc
,
388 BdrvRequestFlags flags
, Error
**errp
)
390 BDRVRawState
*s
= bs
->opaque
;
393 error_setg(errp
, "Cannot resize fixed-size raw disks");
397 if (INT64_MAX
- offset
< s
->offset
) {
398 error_setg(errp
, "Disk size too large for the chosen offset");
404 return bdrv_co_truncate(bs
->file
, offset
, exact
, prealloc
, flags
, errp
);
407 static void raw_eject(BlockDriverState
*bs
, bool eject_flag
)
409 bdrv_eject(bs
->file
->bs
, eject_flag
);
412 static void raw_lock_medium(BlockDriverState
*bs
, bool locked
)
414 bdrv_lock_medium(bs
->file
->bs
, locked
);
417 static int coroutine_fn
raw_co_ioctl(BlockDriverState
*bs
,
418 unsigned long int req
, void *buf
)
420 BDRVRawState
*s
= bs
->opaque
;
421 if (s
->offset
|| s
->has_size
) {
424 return bdrv_co_ioctl(bs
->file
->bs
, req
, buf
);
427 static int raw_has_zero_init(BlockDriverState
*bs
)
429 return bdrv_has_zero_init(bs
->file
->bs
);
432 static int coroutine_fn
raw_co_create_opts(BlockDriver
*drv
,
433 const char *filename
,
437 return bdrv_co_create_file(filename
, opts
, errp
);
440 static int raw_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
443 BDRVRawState
*s
= bs
->opaque
;
445 uint64_t offset
, size
;
446 BdrvChildRole file_role
;
449 ret
= raw_read_options(options
, &offset
, &has_size
, &size
, errp
);
455 * Without offset and a size limit, this driver behaves very much
456 * like a filter. With any such limit, it does not.
458 if (offset
|| has_size
) {
459 file_role
= BDRV_CHILD_DATA
| BDRV_CHILD_PRIMARY
;
461 file_role
= BDRV_CHILD_FILTERED
| BDRV_CHILD_PRIMARY
;
464 bdrv_open_child(NULL
, options
, "file", bs
, &child_of_bds
,
465 file_role
, false, errp
);
470 bs
->sg
= bdrv_is_sg(bs
->file
->bs
);
471 bs
->supported_write_flags
= BDRV_REQ_WRITE_UNCHANGED
|
472 (BDRV_REQ_FUA
& bs
->file
->bs
->supported_write_flags
);
473 bs
->supported_zero_flags
= BDRV_REQ_WRITE_UNCHANGED
|
474 ((BDRV_REQ_FUA
| BDRV_REQ_MAY_UNMAP
| BDRV_REQ_NO_FALLBACK
) &
475 bs
->file
->bs
->supported_zero_flags
);
476 bs
->supported_truncate_flags
= bs
->file
->bs
->supported_truncate_flags
&
479 if (bs
->probed
&& !bdrv_is_read_only(bs
)) {
480 bdrv_refresh_filename(bs
->file
->bs
);
482 "WARNING: Image format was not specified for '%s' and probing "
484 " Automatically detecting the format is dangerous for "
485 "raw images, write operations on block 0 will be restricted.\n"
486 " Specify the 'raw' format explicitly to remove the "
488 bs
->file
->bs
->filename
);
491 ret
= raw_apply_options(bs
, s
, offset
, has_size
, size
, errp
);
496 if (bdrv_is_sg(bs
) && (s
->offset
|| s
->has_size
)) {
497 error_setg(errp
, "Cannot use offset/size with SCSI generic devices");
504 static int raw_probe(const uint8_t *buf
, int buf_size
, const char *filename
)
506 /* smallest possible positive score so that raw is used if and only if no
507 * other block driver works
512 static int raw_probe_blocksizes(BlockDriverState
*bs
, BlockSizes
*bsz
)
514 BDRVRawState
*s
= bs
->opaque
;
517 ret
= bdrv_probe_blocksizes(bs
->file
->bs
, bsz
);
522 if (!QEMU_IS_ALIGNED(s
->offset
, MAX(bsz
->log
, bsz
->phys
))) {
529 static int raw_probe_geometry(BlockDriverState
*bs
, HDGeometry
*geo
)
531 BDRVRawState
*s
= bs
->opaque
;
532 if (s
->offset
|| s
->has_size
) {
535 return bdrv_probe_geometry(bs
->file
->bs
, geo
);
538 static int coroutine_fn
raw_co_copy_range_from(BlockDriverState
*bs
,
544 BdrvRequestFlags read_flags
,
545 BdrvRequestFlags write_flags
)
549 ret
= raw_adjust_offset(bs
, &src_offset
, bytes
, false);
553 return bdrv_co_copy_range_from(bs
->file
, src_offset
, dst
, dst_offset
,
554 bytes
, read_flags
, write_flags
);
557 static int coroutine_fn
raw_co_copy_range_to(BlockDriverState
*bs
,
563 BdrvRequestFlags read_flags
,
564 BdrvRequestFlags write_flags
)
568 ret
= raw_adjust_offset(bs
, &dst_offset
, bytes
, true);
572 return bdrv_co_copy_range_to(src
, src_offset
, bs
->file
, dst_offset
, bytes
,
573 read_flags
, write_flags
);
576 static const char *const raw_strong_runtime_opts
[] = {
583 static void raw_cancel_in_flight(BlockDriverState
*bs
)
585 bdrv_cancel_in_flight(bs
->file
->bs
);
588 static void raw_child_perm(BlockDriverState
*bs
, BdrvChild
*c
,
590 BlockReopenQueue
*reopen_queue
,
591 uint64_t parent_perm
, uint64_t parent_shared
,
592 uint64_t *nperm
, uint64_t *nshared
)
594 bdrv_default_perms(bs
, c
, role
, reopen_queue
, parent_perm
,
595 parent_shared
, nperm
, nshared
);
598 * bdrv_default_perms() may add WRITE and/or RESIZE (see comment in
599 * bdrv_default_perms_for_storage() for an explanation) but we only need
600 * them if they are in parent_perm. Drop WRITE and RESIZE whenever possible
601 * to avoid permission conflicts.
603 *nperm
&= ~(BLK_PERM_WRITE
| BLK_PERM_RESIZE
);
604 *nperm
|= parent_perm
& (BLK_PERM_WRITE
| BLK_PERM_RESIZE
);
607 BlockDriver bdrv_raw
= {
608 .format_name
= "raw",
609 .instance_size
= sizeof(BDRVRawState
),
610 .bdrv_probe
= &raw_probe
,
611 .bdrv_reopen_prepare
= &raw_reopen_prepare
,
612 .bdrv_reopen_commit
= &raw_reopen_commit
,
613 .bdrv_reopen_abort
= &raw_reopen_abort
,
614 .bdrv_open
= &raw_open
,
615 .bdrv_child_perm
= raw_child_perm
,
616 .bdrv_co_create_opts
= &raw_co_create_opts
,
617 .bdrv_co_preadv
= &raw_co_preadv
,
618 .bdrv_co_pwritev
= &raw_co_pwritev
,
619 .bdrv_co_pwrite_zeroes
= &raw_co_pwrite_zeroes
,
620 .bdrv_co_pdiscard
= &raw_co_pdiscard
,
621 .bdrv_co_block_status
= &raw_co_block_status
,
622 .bdrv_co_copy_range_from
= &raw_co_copy_range_from
,
623 .bdrv_co_copy_range_to
= &raw_co_copy_range_to
,
624 .bdrv_co_truncate
= &raw_co_truncate
,
625 .bdrv_getlength
= &raw_getlength
,
627 .has_variable_length
= true,
628 .bdrv_measure
= &raw_measure
,
629 .bdrv_get_info
= &raw_get_info
,
630 .bdrv_refresh_limits
= &raw_refresh_limits
,
631 .bdrv_probe_blocksizes
= &raw_probe_blocksizes
,
632 .bdrv_probe_geometry
= &raw_probe_geometry
,
633 .bdrv_eject
= &raw_eject
,
634 .bdrv_lock_medium
= &raw_lock_medium
,
635 .bdrv_co_ioctl
= &raw_co_ioctl
,
636 .create_opts
= &raw_create_opts
,
637 .bdrv_has_zero_init
= &raw_has_zero_init
,
638 .strong_runtime_opts
= raw_strong_runtime_opts
,
639 .mutable_opts
= mutable_opts
,
640 .bdrv_cancel_in_flight
= raw_cancel_in_flight
,
643 static void bdrv_raw_init(void)
645 bdrv_register(&bdrv_raw
);
648 block_init(bdrv_raw_init
);