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