Statistics
| Branch: | Revision:

root / block_int.h @ bb8bf76f

History | View | Annotate | Download (9.7 kB)

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
#include "qemu-queue.h"
30

    
31
#define BLOCK_FLAG_ENCRYPT        1
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

    
42
typedef struct AIOPool {
43
    void (*cancel)(BlockDriverAIOCB *acb);
44
    int aiocb_size;
45
    BlockDriverAIOCB *free_aiocb;
46
} AIOPool;
47

    
48
struct 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, int flags);
54
    int (*bdrv_file_open)(BlockDriverState *bs, const char *filename, int flags);
55
    int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num,
56
                     uint8_t *buf, int nb_sectors);
57
    int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num,
58
                      const uint8_t *buf, int nb_sectors);
59
    void (*bdrv_close)(BlockDriverState *bs);
60
    int (*bdrv_create)(const char *filename, QEMUOptionParameter *options);
61
    int (*bdrv_flush)(BlockDriverState *bs);
62
    int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num,
63
                             int nb_sectors, int *pnum);
64
    int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
65
    int (*bdrv_make_empty)(BlockDriverState *bs);
66
    /* aio */
67
    BlockDriverAIOCB *(*bdrv_aio_readv)(BlockDriverState *bs,
68
        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
69
        BlockDriverCompletionFunc *cb, void *opaque);
70
    BlockDriverAIOCB *(*bdrv_aio_writev)(BlockDriverState *bs,
71
        int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
72
        BlockDriverCompletionFunc *cb, void *opaque);
73
    BlockDriverAIOCB *(*bdrv_aio_flush)(BlockDriverState *bs,
74
        BlockDriverCompletionFunc *cb, void *opaque);
75
    int (*bdrv_discard)(BlockDriverState *bs, int64_t sector_num,
76
                        int nb_sectors);
77

    
78
    int (*bdrv_aio_multiwrite)(BlockDriverState *bs, BlockRequest *reqs,
79
        int num_reqs);
80
    int (*bdrv_merge_requests)(BlockDriverState *bs, BlockRequest* a,
81
        BlockRequest *b);
82

    
83

    
84
    const char *protocol_name;
85
    int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
86
    int64_t (*bdrv_getlength)(BlockDriverState *bs);
87
    int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
88
                                 const uint8_t *buf, int nb_sectors);
89

    
90
    int (*bdrv_snapshot_create)(BlockDriverState *bs,
91
                                QEMUSnapshotInfo *sn_info);
92
    int (*bdrv_snapshot_goto)(BlockDriverState *bs,
93
                              const char *snapshot_id);
94
    int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
95
    int (*bdrv_snapshot_list)(BlockDriverState *bs,
96
                              QEMUSnapshotInfo **psn_info);
97
    int (*bdrv_snapshot_load_tmp)(BlockDriverState *bs,
98
                                  const char *snapshot_name);
99
    int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
100

    
101
    int (*bdrv_save_vmstate)(BlockDriverState *bs, const uint8_t *buf,
102
                             int64_t pos, int size);
103
    int (*bdrv_load_vmstate)(BlockDriverState *bs, uint8_t *buf,
104
                             int64_t pos, int size);
105

    
106
    int (*bdrv_change_backing_file)(BlockDriverState *bs,
107
        const char *backing_file, const char *backing_fmt);
108

    
109
    /* removable device specific */
110
    int (*bdrv_is_inserted)(BlockDriverState *bs);
111
    int (*bdrv_media_changed)(BlockDriverState *bs);
112
    int (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
113
    int (*bdrv_set_locked)(BlockDriverState *bs, int locked);
114

    
115
    /* to control generic scsi devices */
116
    int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
117
    BlockDriverAIOCB *(*bdrv_aio_ioctl)(BlockDriverState *bs,
118
        unsigned long int req, void *buf,
119
        BlockDriverCompletionFunc *cb, void *opaque);
120

    
121
    /* List of options for creating images, terminated by name == NULL */
122
    QEMUOptionParameter *create_options;
123

    
124

    
125
    /*
126
     * Returns 0 for completed check, -errno for internal errors.
127
     * The check results are stored in result.
128
     */
129
    int (*bdrv_check)(BlockDriverState* bs, BdrvCheckResult *result);
130

    
131
    void (*bdrv_debug_event)(BlockDriverState *bs, BlkDebugEvent event);
132

    
133
    /*
134
     * Returns 1 if newly created images are guaranteed to contain only
135
     * zeros, 0 otherwise.
136
     */
137
    int (*bdrv_has_zero_init)(BlockDriverState *bs);
138

    
139
    QLIST_ENTRY(BlockDriver) list;
140
};
141

    
142
struct BlockDriverState {
143
    int64_t total_sectors; /* if we are reading a disk image, give its
144
                              size in sectors */
145
    int read_only; /* if true, the media is read only */
146
    int keep_read_only; /* if true, the media was requested to stay read only */
147
    int open_flags; /* flags used to open the file, re-used for re-open */
148
    int removable; /* if true, the media can be removed */
149
    int locked;    /* if true, the media cannot temporarily be ejected */
150
    int tray_open; /* if true, the virtual tray is open */
151
    int encrypted; /* if true, the media is encrypted */
152
    int valid_key; /* if true, a valid encryption key has been set */
153
    int sg;        /* if true, the device is a /dev/sg* */
154
    /* event callback when inserting/removing */
155
    void (*change_cb)(void *opaque);
156
    void *change_opaque;
157

    
158
    BlockDriver *drv; /* NULL means no media */
159
    void *opaque;
160

    
161
    DeviceState *peer;
162

    
163
    char filename[1024];
164
    char backing_file[1024]; /* if non zero, the image is a diff of
165
                                this file image */
166
    char backing_format[16]; /* if non-zero and backing_file exists */
167
    int is_temporary;
168
    int media_changed;
169

    
170
    BlockDriverState *backing_hd;
171
    BlockDriverState *file;
172

    
173
    /* async read/write emulation */
174

    
175
    void *sync_aiocb;
176

    
177
    /* I/O stats (display with "info blockstats"). */
178
    uint64_t rd_bytes;
179
    uint64_t wr_bytes;
180
    uint64_t rd_ops;
181
    uint64_t wr_ops;
182
    uint64_t wr_highest_sector;
183

    
184
    /* Whether the disk can expand beyond total_sectors */
185
    int growable;
186

    
187
    /* the memory alignment required for the buffers handled by this driver */
188
    int buffer_alignment;
189

    
190
    /* do we need to tell the quest if we have a volatile write cache? */
191
    int enable_write_cache;
192

    
193
    /* NOTE: the following infos are only hints for real hardware
194
       drivers. They are not used by the block driver */
195
    int cyls, heads, secs, translation;
196
    int type;
197
    BlockErrorAction on_read_error, on_write_error;
198
    char device_name[32];
199
    unsigned long *dirty_bitmap;
200
    int64_t dirty_count;
201
    QTAILQ_ENTRY(BlockDriverState) list;
202
    void *private;
203
};
204

    
205
struct BlockDriverAIOCB {
206
    AIOPool *pool;
207
    BlockDriverState *bs;
208
    BlockDriverCompletionFunc *cb;
209
    void *opaque;
210
    BlockDriverAIOCB *next;
211
};
212

    
213
void get_tmp_filename(char *filename, int size);
214

    
215
void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
216
                   BlockDriverCompletionFunc *cb, void *opaque);
217
void qemu_aio_release(void *p);
218

    
219
void *qemu_blockalign(BlockDriverState *bs, size_t size);
220

    
221
#ifdef _WIN32
222
int is_windows_drive(const char *filename);
223
#endif
224

    
225
typedef struct BlockConf {
226
    BlockDriverState *bs;
227
    uint16_t physical_block_size;
228
    uint16_t logical_block_size;
229
    uint16_t min_io_size;
230
    uint32_t opt_io_size;
231
    int32_t bootindex;
232
    uint32_t discard_granularity;
233
} BlockConf;
234

    
235
static inline unsigned int get_physical_block_exp(BlockConf *conf)
236
{
237
    unsigned int exp = 0, size;
238

    
239
    for (size = conf->physical_block_size;
240
        size > conf->logical_block_size;
241
        size >>= 1) {
242
        exp++;
243
    }
244

    
245
    return exp;
246
}
247

    
248
#define DEFINE_BLOCK_PROPERTIES(_state, _conf)                          \
249
    DEFINE_PROP_DRIVE("drive", _state, _conf.bs),                       \
250
    DEFINE_PROP_UINT16("logical_block_size", _state,                    \
251
                       _conf.logical_block_size, 512),                  \
252
    DEFINE_PROP_UINT16("physical_block_size", _state,                   \
253
                       _conf.physical_block_size, 512),                 \
254
    DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0),  \
255
    DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0),    \
256
    DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1),        \
257
    DEFINE_PROP_UINT32("discard_granularity", _state, \
258
                       _conf.discard_granularity, 0)
259

    
260
#endif /* BLOCK_INT_H */