2004-08-01 23:59:26 +02:00
|
|
|
/*
|
|
|
|
* QEMU System Emulator block driver
|
2007-09-16 23:08:06 +02:00
|
|
|
*
|
2004-08-01 23:59:26 +02:00
|
|
|
* Copyright (c) 2003 Fabrice Bellard
|
2007-09-16 23:08:06 +02:00
|
|
|
*
|
2004-08-01 23:59:26 +02: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 03:51:17 +01:00
|
|
|
#include "block.h"
|
2009-05-18 16:42:10 +02:00
|
|
|
#include "qemu-option.h"
|
2007-11-11 03:51:17 +01:00
|
|
|
|
2007-09-16 23:59:02 +02:00
|
|
|
#define BLOCK_FLAG_ENCRYPT 1
|
|
|
|
#define BLOCK_FLAG_COMPRESS 2
|
|
|
|
#define BLOCK_FLAG_COMPAT6 4
|
|
|
|
|
2009-05-18 16:42:10 +02: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 17:57:21 +02:00
|
|
|
#define BLOCK_OPT_CLUSTER_SIZE "cluster_size"
|
2009-05-18 16:42:10 +02:00
|
|
|
|
2009-03-20 19:25:59 +01:00
|
|
|
typedef struct AIOPool {
|
|
|
|
void (*cancel)(BlockDriverAIOCB *acb);
|
|
|
|
int aiocb_size;
|
|
|
|
BlockDriverAIOCB *free_aiocb;
|
|
|
|
} AIOPool;
|
|
|
|
|
2004-08-01 23:59:26 +02: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 14:04:22 +02:00
|
|
|
int (*bdrv_probe_device)(const char *filename);
|
2006-08-01 18:21:11 +02:00
|
|
|
int (*bdrv_open)(BlockDriverState *bs, const char *filename, int flags);
|
2007-09-16 23:08:06 +02:00
|
|
|
int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
|
2004-08-01 23:59:26 +02:00
|
|
|
uint8_t *buf, int nb_sectors);
|
2007-09-16 23:08:06 +02:00
|
|
|
int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
|
2004-08-01 23:59:26 +02:00
|
|
|
const uint8_t *buf, int nb_sectors);
|
2004-09-18 21:32:11 +02:00
|
|
|
void (*bdrv_close)(BlockDriverState *bs);
|
2009-05-18 16:42:10 +02:00
|
|
|
int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
|
2006-06-04 13:39:07 +02:00
|
|
|
void (*bdrv_flush)(BlockDriverState *bs);
|
2004-08-01 23:59:26 +02: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 19:28:15 +01:00
|
|
|
int (*bdrv_make_empty)(BlockDriverState *bs);
|
2006-08-01 18:21:11 +02:00
|
|
|
/* aio */
|
2009-04-07 20:43:24 +02:00
|
|
|
BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
|
|
|
|
int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
|
2006-08-07 04:38:06 +02:00
|
|
|
BlockDriverCompletionFunc *cb, void *opaque);
|
2009-04-07 20:43:24 +02:00
|
|
|
BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
|
|
|
|
int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
|
2006-08-07 04:38:06 +02:00
|
|
|
BlockDriverCompletionFunc *cb, void *opaque);
|
2006-08-01 18:21:11 +02:00
|
|
|
|
|
|
|
const char *protocol_name;
|
|
|
|
int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
|
|
|
|
int64_t (*bdrv_getlength)(BlockDriverState *bs);
|
2007-09-16 23:08:06 +02:00
|
|
|
int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
|
2006-08-05 23:31:00 +02:00
|
|
|
const uint8_t *buf, int nb_sectors);
|
|
|
|
|
2007-09-16 23:08:06 +02:00
|
|
|
int (*bdrv_snapshot_create)(BlockDriverState *bs,
|
2006-08-05 23:31:00 +02:00
|
|
|
QEMUSnapshotInfo *sn_info);
|
2007-09-16 23:08:06 +02:00
|
|
|
int (*bdrv_snapshot_goto)(BlockDriverState *bs,
|
2006-08-05 23:31:00 +02:00
|
|
|
const char *snapshot_id);
|
|
|
|
int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
|
2007-09-16 23:08:06 +02:00
|
|
|
int (*bdrv_snapshot_list)(BlockDriverState *bs,
|
2006-08-05 23:31:00 +02:00
|
|
|
QEMUSnapshotInfo **psn_info);
|
|
|
|
int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
|
2006-08-01 18:21:11 +02:00
|
|
|
|
2009-04-05 21:10:55 +02:00
|
|
|
int (*bdrv_put_buffer)(BlockDriverState *bs, const uint8_t *buf,
|
|
|
|
int64_t pos, int size);
|
|
|
|
int (*bdrv_get_buffer)(BlockDriverState *bs, uint8_t *buf,
|
|
|
|
int64_t pos, int size);
|
|
|
|
|
2006-08-19 13:45:59 +02:00
|
|
|
/* removable device specific */
|
|
|
|
int (*bdrv_is_inserted)(BlockDriverState *bs);
|
|
|
|
int (*bdrv_media_changed)(BlockDriverState *bs);
|
|
|
|
int (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
|
|
|
|
int (*bdrv_set_locked)(BlockDriverState *bs, int locked);
|
2007-09-17 10:09:54 +02:00
|
|
|
|
2007-12-24 17:10:43 +01:00
|
|
|
/* to control generic scsi devices */
|
|
|
|
int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
|
2009-03-28 18:28:41 +01:00
|
|
|
BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
|
|
|
|
unsigned long int req, void *buf,
|
|
|
|
BlockDriverCompletionFunc *cb, void *opaque);
|
2007-12-24 17:10:43 +01:00
|
|
|
|
2009-05-18 16:42:10 +02:00
|
|
|
/* List of options for creating images, terminated by name == NULL */
|
|
|
|
QEMUOptionParameter *create_options;
|
|
|
|
|
2009-03-28 18:55:10 +01:00
|
|
|
|
2009-04-22 01:11:50 +02:00
|
|
|
/* Returns number of errors in image, -errno for internal errors */
|
|
|
|
int (*bdrv_check)(BlockDriverState* bs);
|
|
|
|
|
2004-08-01 23:59:26 +02:00
|
|
|
struct BlockDriver *next;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct BlockDriverState {
|
2006-08-06 15:35:09 +02:00
|
|
|
int64_t total_sectors; /* if we are reading a disk image, give its
|
|
|
|
size in sectors */
|
2004-08-01 23:59:26 +02:00
|
|
|
int read_only; /* if true, the media is read only */
|
|
|
|
int removable; /* if true, the media can be removed */
|
|
|
|
int locked; /* if true, the media cannot temporarily be ejected */
|
|
|
|
int encrypted; /* if true, the media is encrypted */
|
2009-03-06 00:01:01 +01:00
|
|
|
int valid_key; /* if true, a valid encryption key has been set */
|
2007-12-24 17:10:43 +01:00
|
|
|
int sg; /* if true, the device is a /dev/sg* */
|
2004-08-01 23:59:26 +02:00
|
|
|
/* event callback when inserting/removing */
|
|
|
|
void (*change_cb)(void *opaque);
|
|
|
|
void *change_opaque;
|
|
|
|
|
2006-08-19 13:45:59 +02:00
|
|
|
BlockDriver *drv; /* NULL means no media */
|
2004-08-01 23:59:26 +02:00
|
|
|
void *opaque;
|
|
|
|
|
|
|
|
char filename[1024];
|
|
|
|
char backing_file[1024]; /* if non zero, the image is a diff of
|
|
|
|
this file image */
|
2009-03-28 18:55:10 +01:00
|
|
|
char backing_format[16]; /* if non-zero and backing_file exists */
|
2004-08-01 23:59:26 +02:00
|
|
|
int is_temporary;
|
2006-08-19 13:45:59 +02:00
|
|
|
int media_changed;
|
|
|
|
|
2004-08-01 23:59:26 +02:00
|
|
|
BlockDriverState *backing_hd;
|
2006-08-07 04:38:06 +02:00
|
|
|
/* async read/write emulation */
|
2006-08-01 18:21:11 +02:00
|
|
|
|
2006-08-07 04:38:06 +02:00
|
|
|
void *sync_aiocb;
|
2007-09-17 10:09:54 +02:00
|
|
|
|
2007-12-02 06:18:19 +01:00
|
|
|
/* I/O stats (display with "info blockstats"). */
|
|
|
|
uint64_t rd_bytes;
|
|
|
|
uint64_t wr_bytes;
|
|
|
|
uint64_t rd_ops;
|
|
|
|
uint64_t wr_ops;
|
|
|
|
|
2009-03-03 18:37:16 +01:00
|
|
|
/* Whether the disk can expand beyond total_sectors */
|
|
|
|
int growable;
|
|
|
|
|
2009-04-22 22:20:00 +02:00
|
|
|
/* the memory alignment required for the buffers handled by this driver */
|
|
|
|
int buffer_alignment;
|
|
|
|
|
2004-08-01 23:59:26 +02:00
|
|
|
/* NOTE: the following infos are only hints for real hardware
|
|
|
|
drivers. They are not used by the block driver */
|
2004-11-16 02:45:27 +01:00
|
|
|
int cyls, heads, secs, translation;
|
2004-08-01 23:59:26 +02:00
|
|
|
int type;
|
|
|
|
char device_name[32];
|
|
|
|
BlockDriverState *next;
|
2009-02-11 16:20:29 +01:00
|
|
|
void *private;
|
2004-08-01 23:59:26 +02:00
|
|
|
};
|
|
|
|
|
2006-08-01 18:21:11 +02:00
|
|
|
struct BlockDriverAIOCB {
|
2009-03-20 19:25:59 +01:00
|
|
|
AIOPool *pool;
|
2006-08-01 18:21:11 +02:00
|
|
|
BlockDriverState *bs;
|
|
|
|
BlockDriverCompletionFunc *cb;
|
2006-08-07 04:38:06 +02:00
|
|
|
void *opaque;
|
|
|
|
BlockDriverAIOCB *next;
|
2006-08-01 18:21:11 +02:00
|
|
|
};
|
|
|
|
|
2005-12-18 19:28:15 +01:00
|
|
|
void get_tmp_filename(char *filename, int size);
|
|
|
|
|
2009-05-25 12:37:32 +02:00
|
|
|
void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
|
|
|
|
BlockDriverCompletionFunc *cb, void *opaque);
|
2006-08-07 04:38:06 +02:00
|
|
|
void qemu_aio_release(void *p);
|
|
|
|
|
2009-04-22 22:20:00 +02:00
|
|
|
void *qemu_blockalign(BlockDriverState *bs, size_t size);
|
|
|
|
|
2008-09-17 21:04:14 +02:00
|
|
|
extern BlockDriverState *bdrv_first;
|
2007-11-11 03:51:17 +01:00
|
|
|
|
2009-06-15 14:04:22 +02:00
|
|
|
#ifdef _WIN32
|
|
|
|
int is_windows_drive(const char *filename);
|
|
|
|
#endif
|
|
|
|
|
2004-08-01 23:59:26 +02:00
|
|
|
#endif /* BLOCK_INT_H */
|