2004-08-02 01:59:26 +04:00
|
|
|
/*
|
|
|
|
* QEMU System Emulator block driver
|
2007-09-17 01:08:06 +04:00
|
|
|
*
|
2004-08-02 01:59:26 +04:00
|
|
|
* Copyright (c) 2003 Fabrice Bellard
|
2007-09-17 01:08:06 +04:00
|
|
|
*
|
2004-08-02 01:59:26 +04:00
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
#ifndef BLOCK_INT_H
|
|
|
|
#define BLOCK_INT_H
|
|
|
|
|
2007-11-11 05:51:17 +03:00
|
|
|
#include "block.h"
|
2009-05-18 18:42:10 +04:00
|
|
|
#include "qemu-option.h"
|
2010-04-10 10:02:42 +04:00
|
|
|
#include "qemu-queue.h"
|
2011-07-14 19:27:13 +04:00
|
|
|
#include "qemu-coroutine.h"
|
2011-08-25 10:26:10 +04:00
|
|
|
#include "qemu-timer.h"
|
2007-11-11 05:51:17 +03:00
|
|
|
|
2007-09-17 01:59:02 +04:00
|
|
|
#define BLOCK_FLAG_ENCRYPT 1
|
|
|
|
#define BLOCK_FLAG_COMPAT6 4
|
|
|
|
|
2009-05-18 18:42:10 +04:00
|
|
|
#define BLOCK_OPT_SIZE "size"
|
|
|
|
#define BLOCK_OPT_ENCRYPT "encryption"
|
|
|
|
#define BLOCK_OPT_COMPAT6 "compat6"
|
|
|
|
#define BLOCK_OPT_BACKING_FILE "backing_file"
|
|
|
|
#define BLOCK_OPT_BACKING_FMT "backing_fmt"
|
2009-05-19 19:57:21 +04:00
|
|
|
#define BLOCK_OPT_CLUSTER_SIZE "cluster_size"
|
2010-12-06 19:08:00 +03:00
|
|
|
#define BLOCK_OPT_TABLE_SIZE "table_size"
|
2009-08-17 17:50:10 +04:00
|
|
|
#define BLOCK_OPT_PREALLOC "preallocation"
|
2011-07-19 04:45:23 +04:00
|
|
|
#define BLOCK_OPT_SUBFMT "subformat"
|
2009-05-18 18:42:10 +04:00
|
|
|
|
2009-03-20 21:25:59 +03:00
|
|
|
typedef struct AIOPool {
|
|
|
|
void (*cancel)(BlockDriverAIOCB *acb);
|
|
|
|
int aiocb_size;
|
|
|
|
BlockDriverAIOCB *free_aiocb;
|
|
|
|
} AIOPool;
|
|
|
|
|
2004-08-02 01:59:26 +04:00
|
|
|
struct BlockDriver {
|
|
|
|
const char *format_name;
|
|
|
|
int instance_size;
|
|
|
|
int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
|
2009-06-15 16:04:22 +04:00
|
|
|
int (*bdrv_probe_device)(const char *filename);
|
2010-04-14 16:17:38 +04:00
|
|
|
int (*bdrv_open)(BlockDriverState *bs, int flags);
|
|
|
|
int (*bdrv_file_open)(BlockDriverState *bs, const char *filename, int flags);
|
2007-09-17 01:08:06 +04:00
|
|
|
int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
|
2004-08-02 01:59:26 +04:00
|
|
|
uint8_t *buf, int nb_sectors);
|
2007-09-17 01:08:06 +04:00
|
|
|
int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
|
2004-08-02 01:59:26 +04:00
|
|
|
const uint8_t *buf, int nb_sectors);
|
2004-09-18 23:32:11 +04:00
|
|
|
void (*bdrv_close)(BlockDriverState *bs);
|
2009-05-18 18:42:10 +04:00
|
|
|
int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
|
2010-10-21 18:43:43 +04:00
|
|
|
int (*bdrv_flush)(BlockDriverState *bs);
|
2011-10-17 14:32:14 +04:00
|
|
|
int (*bdrv_discard)(BlockDriverState *bs, int64_t sector_num,
|
|
|
|
int nb_sectors);
|
2004-08-02 01:59:26 +04:00
|
|
|
int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num,
|
|
|
|
int nb_sectors, int *pnum);
|
|
|
|
int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
|
2005-12-18 21:28:15 +03:00
|
|
|
int (*bdrv_make_empty)(BlockDriverState *bs);
|
2006-08-01 20:21:11 +04:00
|
|
|
/* aio */
|
2009-04-07 22:43:24 +04:00
|
|
|
BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
|
|
|
|
int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
|
2006-08-07 06:38:06 +04:00
|
|
|
BlockDriverCompletionFunc *cb, void *opaque);
|
2009-04-07 22:43:24 +04:00
|
|
|
BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
|
|
|
|
int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
|
2006-08-07 06:38:06 +04:00
|
|
|
BlockDriverCompletionFunc *cb, void *opaque);
|
2009-09-04 21:01:49 +04:00
|
|
|
BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
|
|
|
|
BlockDriverCompletionFunc *cb, void *opaque);
|
2011-10-17 14:32:14 +04:00
|
|
|
BlockDriverAIOCB *(*bdrv_aio_discard)(BlockDriverState *bs,
|
|
|
|
int64_t sector_num, int nb_sectors,
|
|
|
|
BlockDriverCompletionFunc *cb, void *opaque);
|
2006-08-01 20:21:11 +04:00
|
|
|
|
2011-07-14 19:27:13 +04:00
|
|
|
int coroutine_fn (*bdrv_co_readv)(BlockDriverState *bs,
|
|
|
|
int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
|
|
|
|
int coroutine_fn (*bdrv_co_writev)(BlockDriverState *bs,
|
|
|
|
int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
|
2011-10-17 14:32:12 +04:00
|
|
|
int coroutine_fn (*bdrv_co_flush)(BlockDriverState *bs);
|
2011-10-17 14:32:14 +04:00
|
|
|
int coroutine_fn (*bdrv_co_discard)(BlockDriverState *bs,
|
|
|
|
int64_t sector_num, int nb_sectors);
|
2011-07-14 19:27:13 +04:00
|
|
|
|
2009-09-09 19:53:37 +04:00
|
|
|
int (*bdrv_aio_multiwrite)(BlockDriverState *bs, BlockRequest *reqs,
|
|
|
|
int num_reqs);
|
|
|
|
int (*bdrv_merge_requests)(BlockDriverState *bs, BlockRequest* a,
|
|
|
|
BlockRequest *b);
|
|
|
|
|
|
|
|
|
2006-08-01 20:21:11 +04:00
|
|
|
const char *protocol_name;
|
|
|
|
int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
|
|
|
|
int64_t (*bdrv_getlength)(BlockDriverState *bs);
|
2011-07-12 15:56:39 +04:00
|
|
|
int64_t (*bdrv_get_allocated_file_size)(BlockDriverState *bs);
|
2007-09-17 01:08:06 +04:00
|
|
|
int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
|
2006-08-06 01:31:00 +04:00
|
|
|
const uint8_t *buf, int nb_sectors);
|
|
|
|
|
2007-09-17 01:08:06 +04:00
|
|
|
int (*bdrv_snapshot_create)(BlockDriverState *bs,
|
2006-08-06 01:31:00 +04:00
|
|
|
QEMUSnapshotInfo *sn_info);
|
2007-09-17 01:08:06 +04:00
|
|
|
int (*bdrv_snapshot_goto)(BlockDriverState *bs,
|
2006-08-06 01:31:00 +04:00
|
|
|
const char *snapshot_id);
|
|
|
|
int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
|
2007-09-17 01:08:06 +04:00
|
|
|
int (*bdrv_snapshot_list)(BlockDriverState *bs,
|
2006-08-06 01:31:00 +04:00
|
|
|
QEMUSnapshotInfo **psn_info);
|
2010-09-22 06:58:41 +04:00
|
|
|
int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
|
|
|
|
const char *snapshot_name);
|
2006-08-06 01:31:00 +04:00
|
|
|
int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
|
2006-08-01 20:21:11 +04:00
|
|
|
|
2009-07-11 01:11:57 +04:00
|
|
|
int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf,
|
|
|
|
int64_t pos, int size);
|
|
|
|
int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
|
|
|
|
int64_t pos, int size);
|
2009-04-05 23:10:55 +04:00
|
|
|
|
2010-01-12 14:55:17 +03:00
|
|
|
int (*bdrv_change_backing_file)(BlockDriverState *bs,
|
|
|
|
const char *backing_file, const char *backing_fmt);
|
|
|
|
|
2006-08-19 15:45:59 +04:00
|
|
|
/* removable device specific */
|
|
|
|
int (*bdrv_is_inserted)(BlockDriverState *bs);
|
|
|
|
int (*bdrv_media_changed)(BlockDriverState *bs);
|
2011-07-20 20:23:42 +04:00
|
|
|
void (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
|
2011-09-06 20:58:47 +04:00
|
|
|
void (*bdrv_lock_medium)(BlockDriverState *bs, bool locked);
|
2007-09-17 12:09:54 +04:00
|
|
|
|
2007-12-24 19:10:43 +03:00
|
|
|
/* to control generic scsi devices */
|
|
|
|
int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
|
2009-03-28 20:28:41 +03:00
|
|
|
BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
|
|
|
|
unsigned long int req, void *buf,
|
|
|
|
BlockDriverCompletionFunc *cb, void *opaque);
|
2007-12-24 19:10:43 +03:00
|
|
|
|
2009-05-18 18:42:10 +04:00
|
|
|
/* List of options for creating images, terminated by name == NULL */
|
|
|
|
QEMUOptionParameter *create_options;
|
|
|
|
|
2009-03-28 20:55:10 +03:00
|
|
|
|
2010-06-29 14:37:54 +04:00
|
|
|
/*
|
|
|
|
* Returns 0 for completed check, -errno for internal errors.
|
|
|
|
* The check results are stored in result.
|
|
|
|
*/
|
|
|
|
int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result);
|
2009-04-22 03:11:50 +04:00
|
|
|
|
2010-03-15 19:27:00 +03:00
|
|
|
void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);
|
|
|
|
|
2010-07-28 13:26:29 +04:00
|
|
|
/*
|
|
|
|
* Returns 1 if newly created images are guaranteed to contain only
|
|
|
|
* zeros, 0 otherwise.
|
|
|
|
*/
|
|
|
|
int (*bdrv_has_zero_init)(BlockDriverState *bs);
|
2009-11-30 18:54:15 +03:00
|
|
|
|
2010-04-13 13:29:33 +04:00
|
|
|
QLIST_ENTRY(BlockDriver) list;
|
2004-08-02 01:59:26 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
struct BlockDriverState {
|
2006-08-06 17:35:09 +04:00
|
|
|
int64_t total_sectors; /* if we are reading a disk image, give its
|
|
|
|
size in sectors */
|
2004-08-02 01:59:26 +04:00
|
|
|
int read_only; /* if true, the media is read only */
|
2010-02-14 14:39:18 +03:00
|
|
|
int keep_read_only; /* if true, the media was requested to stay read only */
|
|
|
|
int open_flags; /* flags used to open the file, re-used for re-open */
|
2004-08-02 01:59:26 +04:00
|
|
|
int encrypted; /* if true, the media is encrypted */
|
2009-03-06 02:01:01 +03:00
|
|
|
int valid_key; /* if true, a valid encryption key has been set */
|
2007-12-24 19:10:43 +03:00
|
|
|
int sg; /* if true, the device is a /dev/sg* */
|
2004-08-02 01:59:26 +04:00
|
|
|
|
2006-08-19 15:45:59 +04:00
|
|
|
BlockDriver *drv; /* NULL means no media */
|
2004-08-02 01:59:26 +04:00
|
|
|
void *opaque;
|
|
|
|
|
2011-08-03 17:07:40 +04:00
|
|
|
void *dev; /* attached device model, if any */
|
|
|
|
/* TODO change to DeviceState when all users are qdevified */
|
2011-08-03 17:07:41 +04:00
|
|
|
const BlockDevOps *dev_ops;
|
|
|
|
void *dev_opaque;
|
2010-06-29 18:58:30 +04:00
|
|
|
|
2004-08-02 01:59:26 +04:00
|
|
|
char filename[1024];
|
|
|
|
char backing_file[1024]; /* if non zero, the image is a diff of
|
|
|
|
this file image */
|
2009-03-28 20:55:10 +03:00
|
|
|
char backing_format[16]; /* if non-zero and backing_file exists */
|
2004-08-02 01:59:26 +04:00
|
|
|
int is_temporary;
|
2006-08-19 15:45:59 +04:00
|
|
|
|
2004-08-02 01:59:26 +04:00
|
|
|
BlockDriverState *backing_hd;
|
2010-04-14 16:17:38 +04:00
|
|
|
BlockDriverState *file;
|
|
|
|
|
2006-08-07 06:38:06 +04:00
|
|
|
/* async read/write emulation */
|
2006-08-01 20:21:11 +04:00
|
|
|
|
2006-08-07 06:38:06 +04:00
|
|
|
void *sync_aiocb;
|
2007-09-17 12:09:54 +04:00
|
|
|
|
2007-12-02 08:18:19 +03:00
|
|
|
/* I/O stats (display with "info blockstats"). */
|
2011-08-25 10:26:01 +04:00
|
|
|
uint64_t nr_bytes[BDRV_MAX_IOTYPE];
|
|
|
|
uint64_t nr_ops[BDRV_MAX_IOTYPE];
|
2011-08-25 10:26:10 +04:00
|
|
|
uint64_t total_time_ns[BDRV_MAX_IOTYPE];
|
2010-04-28 16:34:01 +04:00
|
|
|
uint64_t wr_highest_sector;
|
2007-12-02 08:18:19 +03:00
|
|
|
|
2009-03-03 20:37:16 +03:00
|
|
|
/* Whether the disk can expand beyond total_sectors */
|
|
|
|
int growable;
|
|
|
|
|
2009-04-23 00:20:00 +04:00
|
|
|
/* the memory alignment required for the buffers handled by this driver */
|
|
|
|
int buffer_alignment;
|
|
|
|
|
2009-09-04 21:01:15 +04:00
|
|
|
/* do we need to tell the quest if we have a volatile write cache? */
|
|
|
|
int enable_write_cache;
|
|
|
|
|
2004-08-02 01:59:26 +04:00
|
|
|
/* NOTE: the following infos are only hints for real hardware
|
|
|
|
drivers. They are not used by the block driver */
|
2004-11-16 04:45:27 +03:00
|
|
|
int cyls, heads, secs, translation;
|
2010-06-02 20:55:17 +04:00
|
|
|
BlockErrorAction on_read_error, on_write_error;
|
2011-09-27 00:43:50 +04:00
|
|
|
BlockIOStatus iostatus;
|
2004-08-02 01:59:26 +04:00
|
|
|
char device_name[32];
|
2009-11-30 20:21:20 +03:00
|
|
|
unsigned long *dirty_bitmap;
|
2010-01-26 11:31:48 +03:00
|
|
|
int64_t dirty_count;
|
2011-01-26 17:12:34 +03:00
|
|
|
int in_use; /* users other than guest access, eg. block migration */
|
2010-04-10 10:02:42 +04:00
|
|
|
QTAILQ_ENTRY(BlockDriverState) list;
|
2009-02-11 18:20:29 +03:00
|
|
|
void *private;
|
2004-08-02 01:59:26 +04:00
|
|
|
};
|
|
|
|
|
2006-08-01 20:21:11 +04:00
|
|
|
struct BlockDriverAIOCB {
|
2009-03-20 21:25:59 +03:00
|
|
|
AIOPool *pool;
|
2006-08-01 20:21:11 +04:00
|
|
|
BlockDriverState *bs;
|
|
|
|
BlockDriverCompletionFunc *cb;
|
2006-08-07 06:38:06 +04:00
|
|
|
void *opaque;
|
|
|
|
BlockDriverAIOCB *next;
|
2006-08-01 20:21:11 +04:00
|
|
|
};
|
|
|
|
|
2005-12-18 21:28:15 +03:00
|
|
|
void get_tmp_filename(char *filename, int size);
|
|
|
|
|
2009-05-25 14:37:32 +04:00
|
|
|
void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
|
|
|
|
BlockDriverCompletionFunc *cb, void *opaque);
|
2006-08-07 06:38:06 +04:00
|
|
|
void qemu_aio_release(void *p);
|
|
|
|
|
2009-06-15 16:04:22 +04:00
|
|
|
#ifdef _WIN32
|
|
|
|
int is_windows_drive(const char *filename);
|
|
|
|
#endif
|
|
|
|
|
2004-08-02 01:59:26 +04:00
|
|
|
#endif /* BLOCK_INT_H */
|