1 /* 2 * QEMU System Emulator block driver 3 * 4 * Copyright (c) 2003 Fabrice Bellard 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy 7 * of this software and associated documentation files (the "Software"), to deal 8 * in the Software without restriction, including without limitation the rights 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 * copies of the Software, and to permit persons to whom the Software is 11 * furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in 14 * all copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 22 * THE SOFTWARE. 23 */ 24 #ifndef BLOCK_INT_H 25 #define BLOCK_INT_H 26 27 #include "block.h" 28 #include "qemu-option.h" 29 30 #define BLOCK_FLAG_ENCRYPT 1 31 #define BLOCK_FLAG_COMPRESS 2 32 #define BLOCK_FLAG_COMPAT6 4 33 34 #define BLOCK_OPT_SIZE "size" 35 #define BLOCK_OPT_ENCRYPT "encryption" 36 #define BLOCK_OPT_COMPAT6 "compat6" 37 #define BLOCK_OPT_BACKING_FILE "backing_file" 38 #define BLOCK_OPT_BACKING_FMT "backing_fmt" 39 #define BLOCK_OPT_CLUSTER_SIZE "cluster_size" 40 41 typedef struct AIOPool { 42 void (*cancel)(BlockDriverAIOCB *acb); 43 int aiocb_size; 44 BlockDriverAIOCB *free_aiocb; 45 } AIOPool; 46 47 struct BlockDriver { 48 const char *format_name; 49 int instance_size; 50 int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename); 51 int (*bdrv_probe_device)(const char *filename); 52 int (*bdrv_open)(BlockDriverState *bs, const char *filename, int flags); 53 int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num, 54 uint8_t *buf, int nb_sectors); 55 int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num, 56 const uint8_t *buf, int nb_sectors); 57 void (*bdrv_close)(BlockDriverState *bs); 58 int (*bdrv_create)(const char *filename, QEMUOptionParameter *options); 59 void (*bdrv_flush)(BlockDriverState *bs); 60 int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num, 61 int nb_sectors, int *pnum); 62 int (*bdrv_set_key)(BlockDriverState *bs, const char *key); 63 int (*bdrv_make_empty)(BlockDriverState *bs); 64 /* aio */ 65 BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs, 66 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, 67 BlockDriverCompletionFunc *cb, void *opaque); 68 BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs, 69 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, 70 BlockDriverCompletionFunc *cb, void *opaque); 71 72 const char *protocol_name; 73 int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset); 74 int64_t (*bdrv_getlength)(BlockDriverState *bs); 75 int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num, 76 const uint8_t *buf, int nb_sectors); 77 78 int (*bdrv_snapshot_create)(BlockDriverState *bs, 79 QEMUSnapshotInfo *sn_info); 80 int (*bdrv_snapshot_goto)(BlockDriverState *bs, 81 const char *snapshot_id); 82 int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id); 83 int (*bdrv_snapshot_list)(BlockDriverState *bs, 84 QEMUSnapshotInfo **psn_info); 85 int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi); 86 87 int (*bdrv_put_buffer)(BlockDriverState *bs, const uint8_t *buf, 88 int64_t pos, int size); 89 int (*bdrv_get_buffer)(BlockDriverState *bs, uint8_t *buf, 90 int64_t pos, int size); 91 92 /* removable device specific */ 93 int (*bdrv_is_inserted)(BlockDriverState *bs); 94 int (*bdrv_media_changed)(BlockDriverState *bs); 95 int (*bdrv_eject)(BlockDriverState *bs, int eject_flag); 96 int (*bdrv_set_locked)(BlockDriverState *bs, int locked); 97 98 /* to control generic scsi devices */ 99 int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf); 100 BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs, 101 unsigned long int req, void *buf, 102 BlockDriverCompletionFunc *cb, void *opaque); 103 104 /* List of options for creating images, terminated by name == NULL */ 105 QEMUOptionParameter *create_options; 106 107 108 /* Returns number of errors in image, -errno for internal errors */ 109 int (*bdrv_check)(BlockDriverState* bs); 110 111 struct BlockDriver *next; 112 }; 113 114 struct BlockDriverState { 115 int64_t total_sectors; /* if we are reading a disk image, give its 116 size in sectors */ 117 int read_only; /* if true, the media is read only */ 118 int removable; /* if true, the media can be removed */ 119 int locked; /* if true, the media cannot temporarily be ejected */ 120 int encrypted; /* if true, the media is encrypted */ 121 int valid_key; /* if true, a valid encryption key has been set */ 122 int sg; /* if true, the device is a /dev/sg* */ 123 /* event callback when inserting/removing */ 124 void (*change_cb)(void *opaque); 125 void *change_opaque; 126 127 BlockDriver *drv; /* NULL means no media */ 128 void *opaque; 129 130 char filename[1024]; 131 char backing_file[1024]; /* if non zero, the image is a diff of 132 this file image */ 133 char backing_format[16]; /* if non-zero and backing_file exists */ 134 int is_temporary; 135 int media_changed; 136 137 BlockDriverState *backing_hd; 138 /* async read/write emulation */ 139 140 void *sync_aiocb; 141 142 /* I/O stats (display with "info blockstats"). */ 143 uint64_t rd_bytes; 144 uint64_t wr_bytes; 145 uint64_t rd_ops; 146 uint64_t wr_ops; 147 148 /* Whether the disk can expand beyond total_sectors */ 149 int growable; 150 151 /* the memory alignment required for the buffers handled by this driver */ 152 int buffer_alignment; 153 154 /* NOTE: the following infos are only hints for real hardware 155 drivers. They are not used by the block driver */ 156 int cyls, heads, secs, translation; 157 int type; 158 char device_name[32]; 159 BlockDriverState *next; 160 void *private; 161 }; 162 163 struct BlockDriverAIOCB { 164 AIOPool *pool; 165 BlockDriverState *bs; 166 BlockDriverCompletionFunc *cb; 167 void *opaque; 168 BlockDriverAIOCB *next; 169 }; 170 171 void get_tmp_filename(char *filename, int size); 172 173 void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs, 174 BlockDriverCompletionFunc *cb, void *opaque); 175 void qemu_aio_release(void *p); 176 177 void *qemu_blockalign(BlockDriverState *bs, size_t size); 178 179 extern BlockDriverState *bdrv_first; 180 181 #ifdef _WIN32 182 int is_windows_drive(const char *filename); 183 #endif 184 185 #endif /* BLOCK_INT_H */ 186
