e40503ea38486f5de969c04fe2fb1284fd36e89c
[qemu] / block_int.h
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 struct BlockDriver {
28     const char *format_name;
29     int instance_size;
30     int (*bdrv_probe)(const uint8_t *buf, int buf_size, const char *filename);
31     int (*bdrv_open)(BlockDriverState *bs, const char *filename, int flags);
32     int (*bdrv_read)(BlockDriverState *bs, int64_t sector_num, 
33                      uint8_t *buf, int nb_sectors);
34     int (*bdrv_write)(BlockDriverState *bs, int64_t sector_num, 
35                       const uint8_t *buf, int nb_sectors);
36     void (*bdrv_close)(BlockDriverState *bs);
37     int (*bdrv_create)(const char *filename, int64_t total_sectors, 
38                        const char *backing_file, int flags);
39     void (*bdrv_flush)(BlockDriverState *bs);
40     int (*bdrv_is_allocated)(BlockDriverState *bs, int64_t sector_num,
41                              int nb_sectors, int *pnum);
42     int (*bdrv_set_key)(BlockDriverState *bs, const char *key);
43     int (*bdrv_make_empty)(BlockDriverState *bs);
44     /* aio */
45     int (*bdrv_aio_new)(BlockDriverAIOCB *acb);
46     int (*bdrv_aio_read)(BlockDriverAIOCB *acb, int64_t sector_num,
47                               uint8_t *buf, int nb_sectors);
48     int (*bdrv_aio_write)(BlockDriverAIOCB *acb, int64_t sector_num,
49                           const uint8_t *buf, int nb_sectors);
50     void (*bdrv_aio_cancel)(BlockDriverAIOCB *acb);
51     void (*bdrv_aio_delete)(BlockDriverAIOCB *acb);
52
53     const char *protocol_name;
54     int (*bdrv_pread)(BlockDriverState *bs, int64_t offset, 
55                       uint8_t *buf, int count);
56     int (*bdrv_pwrite)(BlockDriverState *bs, int64_t offset, 
57                        const uint8_t *buf, int count);
58     int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
59     int64_t (*bdrv_getlength)(BlockDriverState *bs);
60
61     struct BlockDriver *next;
62 };
63
64 struct BlockDriverState {
65     int64_t total_sectors; /* XXX: will be suppressed */
66     int read_only; /* if true, the media is read only */
67     int inserted; /* if true, the media is present */
68     int removable; /* if true, the media can be removed */
69     int locked;    /* if true, the media cannot temporarily be ejected */
70     int encrypted; /* if true, the media is encrypted */
71     /* event callback when inserting/removing */
72     void (*change_cb)(void *opaque);
73     void *change_opaque;
74
75     BlockDriver *drv;
76     void *opaque;
77
78     int boot_sector_enabled;
79     uint8_t boot_sector_data[512];
80
81     char filename[1024];
82     char backing_file[1024]; /* if non zero, the image is a diff of
83                                 this file image */
84     int is_temporary;
85     
86     BlockDriverState *backing_hd;
87     /* sync read/write emulation */
88
89     BlockDriverAIOCB *sync_aiocb;
90     
91     /* NOTE: the following infos are only hints for real hardware
92        drivers. They are not used by the block driver */
93     int cyls, heads, secs, translation;
94     int type;
95     char device_name[32];
96     BlockDriverState *next;
97 };
98
99 struct BlockDriverAIOCB {
100     BlockDriverState *bs;
101     BlockDriverCompletionFunc *cb;
102     void *cb_opaque;
103     
104     void *opaque; /* driver opaque */
105 };
106
107 void get_tmp_filename(char *filename, int size);
108
109 #endif /* BLOCK_INT_H */