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#define BLOCK_OPT_PREALLOC      "preallocation"
41
42typedef struct AIOPool {
43    void (*cancel)(BlockDriverAIOCB *acb);
44    int aiocb_size;
45    BlockDriverAIOCB *free_aiocb;
46} AIOPool;
47
48struct BlockDriver {
49    const char *format_name;
50    int instance_size;
51    int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
52    int (*bdrv_probe_device)(const char *filename);
53    int (*bdrv_open)(BlockDriverState *bs, const char *filename, int flags);
54    int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
55                     uint8_t *buf, int nb_sectors);
56    int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
57                      const uint8_t *buf, int nb_sectors);
58    void (*bdrv_close)(BlockDriverState *bs);
59    int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
60    void (*bdrv_flush)(BlockDriverState *bs);
61    int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num,
62                             int nb_sectors, int *pnum);
63    int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
64    int (*bdrv_make_empty)(BlockDriverState *bs);
65    /* aio */
66    BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
67        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
68        BlockDriverCompletionFunc *cb, void *opaque);
69    BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
70        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
71        BlockDriverCompletionFunc *cb, void *opaque);
72
73    const char *protocol_name;
74    int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
75    int64_t (*bdrv_getlength)(BlockDriverState *bs);
76    int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
77                                 const uint8_t *buf, int nb_sectors);
78
79    int (*bdrv_snapshot_create)(BlockDriverState *bs,
80                                QEMUSnapshotInfo *sn_info);
81    int (*bdrv_snapshot_goto)(BlockDriverState *bs,
82                              const char *snapshot_id);
83    int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
84    int (*bdrv_snapshot_list)(BlockDriverState *bs,
85                              QEMUSnapshotInfo **psn_info);
86    int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
87
88    int (*bdrv_put_buffer)(BlockDriverState *bs, const uint8_t *buf,
89                           int64_t pos, int size);
90    int (*bdrv_get_buffer)(BlockDriverState *bs, uint8_t *buf,
91                           int64_t pos, int size);
92
93    /* removable device specific */
94    int (*bdrv_is_inserted)(BlockDriverState *bs);
95    int (*bdrv_media_changed)(BlockDriverState *bs);
96    int (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
97    int (*bdrv_set_locked)(BlockDriverState *bs, int locked);
98
99    /* to control generic scsi devices */
100    int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
101    BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
102        unsigned long int req, void *buf,
103        BlockDriverCompletionFunc *cb, void *opaque);
104
105    /* List of options for creating images, terminated by name == NULL */
106    QEMUOptionParameter *create_options;
107
108
109    /* Returns number of errors in image, -errno for internal errors */
110    int (*bdrv_check)(BlockDriverState* bs);
111
112    struct BlockDriver *next;
113};
114
115struct BlockDriverState {
116    int64_t total_sectors; /* if we are reading a disk image, give its
117                              size in sectors */
118    int read_only; /* if true, the media is read only */
119    int removable; /* if true, the media can be removed */
120    int locked;    /* if true, the media cannot temporarily be ejected */
121    int encrypted; /* if true, the media is encrypted */
122    int valid_key; /* if true, a valid encryption key has been set */
123    int sg;        /* if true, the device is a /dev/sg* */
124    /* event callback when inserting/removing */
125    void (*change_cb)(void *opaque);
126    void *change_opaque;
127
128    BlockDriver *drv; /* NULL means no media */
129    void *opaque;
130
131    char filename[1024];
132    char backing_file[1024]; /* if non zero, the image is a diff of
133                                this file image */
134    char backing_format[16]; /* if non-zero and backing_file exists */
135    int is_temporary;
136    int media_changed;
137
138    BlockDriverState *backing_hd;
139    /* async read/write emulation */
140
141    void *sync_aiocb;
142
143    /* I/O stats (display with "info blockstats"). */
144    uint64_t rd_bytes;
145    uint64_t wr_bytes;
146    uint64_t rd_ops;
147    uint64_t wr_ops;
148
149    /* Whether the disk can expand beyond total_sectors */
150    int growable;
151
152    /* the memory alignment required for the buffers handled by this driver */
153    int buffer_alignment;
154
155    /* NOTE: the following infos are only hints for real hardware
156       drivers. They are not used by the block driver */
157    int cyls, heads, secs, translation;
158    int type;
159    char device_name[32];
160    BlockDriverState *next;
161    void *private;
162};
163
164struct BlockDriverAIOCB {
165    AIOPool *pool;
166    BlockDriverState *bs;
167    BlockDriverCompletionFunc *cb;
168    void *opaque;
169    BlockDriverAIOCB *next;
170};
171
172void get_tmp_filename(char *filename, int size);
173
174void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
175                   BlockDriverCompletionFunc *cb, void *opaque);
176void qemu_aio_release(void *p);
177
178void *qemu_blockalign(BlockDriverState *bs, size_t size);
179
180extern BlockDriverState *bdrv_first;
181
182#ifdef _WIN32
183int is_windows_drive(const char *filename);
184#endif
185
186#endif /* BLOCK_INT_H */
187