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_read)(BlockDriverState *bs,
  58         int64_t sector_num, uint8_t *buf, int nb_sectors,
  59         BlockDriverCompletionFunc *cb, void *opaque);
  60     BlockDriverAIOCB *(*bdrv_aio_write)(BlockDriverState *bs,
  61         int64_t sector_num, const uint8_t *buf, 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_pread)(BlockDriverState *bs, int64_t offset,
  68                       uint8_t *buf, int count);
  69     int (*bdrv_pwrite)(BlockDriverState *bs, int64_t offset,
  70                        const uint8_t *buf, int count);
  71     int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
  72     int64_t (*bdrv_getlength)(BlockDriverState *bs);
  73     int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
  74                                  const uint8_t *buf, int nb_sectors);
  75
  76     int (*bdrv_snapshot_create)(BlockDriverState *bs,
  77                                 QEMUSnapshotInfo *sn_info);
  78     int (*bdrv_snapshot_goto)(BlockDriverState *bs,
  79                               const char *snapshot_id);
  80     int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
  81     int (*bdrv_snapshot_list)(BlockDriverState *bs,
  82                               QEMUSnapshotInfo **psn_info);
  83     int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
  84
  85     int (*bdrv_put_buffer)(BlockDriverState *bs, const uint8_t *buf,
  86                            int64_t pos, int size);
  87     int (*bdrv_get_buffer)(BlockDriverState *bs, uint8_t *buf,
  88                            int64_t pos, int size);
  89
  90     /* removable device specific */
  91     int (*bdrv_is_inserted)(BlockDriverState *bs);
  92     int (*bdrv_media_changed)(BlockDriverState *bs);
  93     int (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
  94     int (*bdrv_set_locked)(BlockDriverState *bs, int locked);
  95
  96     /* to control generic scsi devices */
  97     int (*bdrv_ioctl)(BlockDriverState *bs, unsigned long int req, void *buf);
  98
  99     AIOPool aio_pool;
 100     struct BlockDriver *next;
 101 };
 102
 103 struct BlockDriverState {
 104     int64_t total_sectors; /* if we are reading a disk image, give its
 105                               size in sectors */
 106     int read_only; /* if true, the media is read only */
 107     int removable; /* if true, the media can be removed */
 108     int locked;    /* if true, the media cannot temporarily be ejected */
 109     int encrypted; /* if true, the media is encrypted */
 110     int valid_key; /* if true, a valid encryption key has been set */
 111     int sg;        /* if true, the device is a /dev/sg* */
 112     /* event callback when inserting/removing */
 113     void (*change_cb)(void *opaque);
 114     void *change_opaque;
 115
 116     BlockDriver *drv; /* NULL means no media */
 117     void *opaque;
 118
 119     char filename[1024];
 120     char backing_file[1024]; /* if non zero, the image is a diff of
 121                                 this file image */
 122     int is_temporary;
 123     int media_changed;
 124
 125     BlockDriverState *backing_hd;
 126     /* async read/write emulation */
 127
 128     void *sync_aiocb;
 129
 130     /* I/O stats (display with "info blockstats"). */
 131     uint64_t rd_bytes;
 132     uint64_t wr_bytes;
 133     uint64_t rd_ops;
 134     uint64_t wr_ops;
 135
 136     /* Whether the disk can expand beyond total_sectors */
 137     int growable;
 138
 139     /* NOTE: the following infos are only hints for real hardware
 140        drivers. They are not used by the block driver */
 141     int cyls, heads, secs, translation;
 142     int type;
 143     char device_name[32];
 144     BlockDriverState *next;
 145     void *private;
 146 };
 147
 148 struct BlockDriverAIOCB {
 149     AIOPool *pool;
 150     BlockDriverState *bs;
 151     BlockDriverCompletionFunc *cb;
 152     void *opaque;
 153     BlockDriverAIOCB *next;
 154 };
 155
 156 void get_tmp_filename(char *filename, int size);
 157
 158 void aio_pool_init(AIOPool *pool, int aiocb_size,
 159                    void (*cancel)(BlockDriverAIOCB *acb));
 160
 161 void *qemu_aio_get(BlockDriverState *bs, BlockDriverCompletionFunc *cb,
 162                    void *opaque);
 163 void *qemu_aio_get_pool(AIOPool *pool, BlockDriverState *bs,
 164                         BlockDriverCompletionFunc *cb, void *opaque);
 165 void qemu_aio_release(void *p);
 166
 167 extern BlockDriverState *bdrv_first;
 168
 169 #endif /* BLOCK_INT_H */