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     BlockDriverAIOCB *(*bdrv_aio_read)(BlockDriverState *bs,
  46         int64_t sector_num, uint8_t *buf, int nb_sectors,
  47         BlockDriverCompletionFunc *cb, void *opaque);
  48     BlockDriverAIOCB *(*bdrv_aio_write)(BlockDriverState *bs,
  49         int64_t sector_num, const uint8_t *buf, int nb_sectors,
  50         BlockDriverCompletionFunc *cb, void *opaque);
  51     void (*bdrv_aio_cancel)(BlockDriverAIOCB *acb);
  52     int aiocb_size;
  53
  54     const char *protocol_name;
  55     int (*bdrv_pread)(BlockDriverState *bs, int64_t offset,
  56                       uint8_t *buf, int count);
  57     int (*bdrv_pwrite)(BlockDriverState *bs, int64_t offset,
  58                        const uint8_t *buf, int count);
  59     int (*bdrv_truncate)(BlockDriverState *bs, int64_t offset);
  60     int64_t (*bdrv_getlength)(BlockDriverState *bs);
  61     int (*bdrv_write_compressed)(BlockDriverState *bs, int64_t sector_num,
  62                                  const uint8_t *buf, int nb_sectors);
  63
  64     int (*bdrv_snapshot_create)(BlockDriverState *bs,
  65                                 QEMUSnapshotInfo *sn_info);
  66     int (*bdrv_snapshot_goto)(BlockDriverState *bs,
  67                               const char *snapshot_id);
  68     int (*bdrv_snapshot_delete)(BlockDriverState *bs, const char *snapshot_id);
  69     int (*bdrv_snapshot_list)(BlockDriverState *bs,
  70                               QEMUSnapshotInfo **psn_info);
  71     int (*bdrv_get_info)(BlockDriverState *bs, BlockDriverInfo *bdi);
  72
  73     /* removable device specific */
  74     int (*bdrv_is_inserted)(BlockDriverState *bs);
  75     int (*bdrv_media_changed)(BlockDriverState *bs);
  76     int (*bdrv_eject)(BlockDriverState *bs, int eject_flag);
  77     int (*bdrv_set_locked)(BlockDriverState *bs, int locked);
  78
  79     BlockDriverAIOCB *free_aiocb;
  80     struct BlockDriver *next;
  81 };
  82
  83 struct BlockDriverState {
  84     int64_t total_sectors; /* if we are reading a disk image, give its
  85                               size in sectors */
  86     int read_only; /* if true, the media is read only */
  87     int removable; /* if true, the media can be removed */
  88     int locked;    /* if true, the media cannot temporarily be ejected */
  89     int encrypted; /* if true, the media is encrypted */
  90     /* event callback when inserting/removing */
  91     void (*change_cb)(void *opaque);
  92     void *change_opaque;
  93
  94     BlockDriver *drv; /* NULL means no media */
  95     void *opaque;
  96
  97     int boot_sector_enabled;
  98     uint8_t boot_sector_data[512];
  99
 100     char filename[1024];
 101     char backing_file[1024]; /* if non zero, the image is a diff of
 102                                 this file image */
 103     int is_temporary;
 104     int media_changed;
 105
 106     BlockDriverState *backing_hd;
 107     /* async read/write emulation */
 108
 109     void *sync_aiocb;
 110
 111     /* NOTE: the following infos are only hints for real hardware
 112        drivers. They are not used by the block driver */
 113     int cyls, heads, secs, translation;
 114     int type;
 115     char device_name[32];
 116     BlockDriverState *next;
 117 };
 118
 119 struct BlockDriverAIOCB {
 120     BlockDriverState *bs;
 121     BlockDriverCompletionFunc *cb;
 122     void *opaque;
 123     BlockDriverAIOCB *next;
 124 };
 125
 126 void get_tmp_filename(char *filename, int size);
 127
 128 void *qemu_aio_get(BlockDriverState *bs, BlockDriverCompletionFunc *cb,
 129                    void *opaque);
 130 void qemu_aio_release(void *p);
 131
 132 #endif /* BLOCK_INT_H */