2 * QEMU System Emulator block driver
4 * Copyright (c) 2003 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
29 #define BLOCK_FLAG_ENCRYPT 1
30 #define BLOCK_FLAG_COMPRESS 2
31 #define BLOCK_FLAG_COMPAT6 4
34 const char *format_name
;
36 int (*bdrv_probe
)(const uint8_t *buf
, int buf_size
, const char *filename
);
37 int (*bdrv_open
)(BlockDriverState
*bs
, const char *filename
, int flags
);
38 int (*bdrv_read
)(BlockDriverState
*bs
, int64_t sector_num
,
39 uint8_t *buf
, int nb_sectors
);
40 int (*bdrv_write
)(BlockDriverState
*bs
, int64_t sector_num
,
41 const uint8_t *buf
, int nb_sectors
);
42 void (*bdrv_close
)(BlockDriverState
*bs
);
43 int (*bdrv_create
)(const char *filename
, int64_t total_sectors
,
44 const char *backing_file
, int flags
);
45 void (*bdrv_flush
)(BlockDriverState
*bs
);
46 int (*bdrv_is_allocated
)(BlockDriverState
*bs
, int64_t sector_num
,
47 int nb_sectors
, int *pnum
);
48 int (*bdrv_set_key
)(BlockDriverState
*bs
, const char *key
);
49 int (*bdrv_make_empty
)(BlockDriverState
*bs
);
51 BlockDriverAIOCB
*(*bdrv_aio_read
)(BlockDriverState
*bs
,
52 int64_t sector_num
, uint8_t *buf
, int nb_sectors
,
53 BlockDriverCompletionFunc
*cb
, void *opaque
);
54 BlockDriverAIOCB
*(*bdrv_aio_write
)(BlockDriverState
*bs
,
55 int64_t sector_num
, const uint8_t *buf
, int nb_sectors
,
56 BlockDriverCompletionFunc
*cb
, void *opaque
);
57 void (*bdrv_aio_cancel
)(BlockDriverAIOCB
*acb
);
60 const char *protocol_name
;
61 int (*bdrv_truncate
)(BlockDriverState
*bs
, int64_t offset
);
62 int64_t (*bdrv_getlength
)(BlockDriverState
*bs
);
63 int (*bdrv_write_compressed
)(BlockDriverState
*bs
, int64_t sector_num
,
64 const uint8_t *buf
, int nb_sectors
);
66 int (*bdrv_snapshot_create
)(BlockDriverState
*bs
,
67 QEMUSnapshotInfo
*sn_info
);
68 int (*bdrv_snapshot_goto
)(BlockDriverState
*bs
,
69 const char *snapshot_id
);
70 int (*bdrv_snapshot_delete
)(BlockDriverState
*bs
, const char *snapshot_id
);
71 int (*bdrv_snapshot_list
)(BlockDriverState
*bs
,
72 QEMUSnapshotInfo
**psn_info
);
73 int (*bdrv_get_info
)(BlockDriverState
*bs
, BlockDriverInfo
*bdi
);
75 /* removable device specific */
76 int (*bdrv_is_inserted
)(BlockDriverState
*bs
);
77 int (*bdrv_media_changed
)(BlockDriverState
*bs
);
78 int (*bdrv_eject
)(BlockDriverState
*bs
, int eject_flag
);
79 int (*bdrv_set_locked
)(BlockDriverState
*bs
, int locked
);
81 /* to control generic scsi devices */
82 int (*bdrv_ioctl
)(BlockDriverState
*bs
, unsigned long int req
, void *buf
);
83 int (*bdrv_sg_send_command
)(BlockDriverState
*bs
, void *buf
, int count
);
84 int (*bdrv_sg_recv_response
)(BlockDriverState
*bs
, void *buf
, int count
);
85 BlockDriverAIOCB
*(*bdrv_sg_aio_read
)(BlockDriverState
*bs
,
87 BlockDriverCompletionFunc
*cb
,
89 BlockDriverAIOCB
*(*bdrv_sg_aio_write
)(BlockDriverState
*bs
,
91 BlockDriverCompletionFunc
*cb
,
94 BlockDriverAIOCB
*free_aiocb
;
95 struct BlockDriver
*next
;
98 struct BlockDriverState
{
99 int64_t total_sectors
; /* if we are reading a disk image, give its
101 int read_only
; /* if true, the media is read only */
102 int removable
; /* if true, the media can be removed */
103 int locked
; /* if true, the media cannot temporarily be ejected */
104 int encrypted
; /* if true, the media is encrypted */
105 int valid_key
; /* if true, a valid encryption key has been set */
106 int sg
; /* if true, the device is a /dev/sg* */
107 /* event callback when inserting/removing */
108 void (*change_cb
)(void *opaque
);
111 BlockDriver
*drv
; /* NULL means no media */
115 char backing_file
[1024]; /* if non zero, the image is a diff of
120 BlockDriverState
*backing_hd
;
121 /* async read/write emulation */
125 /* I/O stats (display with "info blockstats"). */
131 /* Whether the disk can expand beyond total_sectors */
134 /* NOTE: the following infos are only hints for real hardware
135 drivers. They are not used by the block driver */
136 int cyls
, heads
, secs
, translation
;
138 char device_name
[32];
139 /* PCI devfn of parent */
141 BlockDriverState
*next
;
145 struct BlockDriverAIOCB
{
146 BlockDriverState
*bs
;
147 BlockDriverCompletionFunc
*cb
;
149 BlockDriverAIOCB
*next
;
152 void get_tmp_filename(char *filename
, int size
);
154 void *qemu_aio_get(BlockDriverState
*bs
, BlockDriverCompletionFunc
*cb
,
156 void qemu_aio_release(void *p
);
158 extern BlockDriverState
*bdrv_first
;
160 #endif /* BLOCK_INT_H */