File:  [Qemu by Fabrice Bellard] / qemu / block.h
Revision 1.1.1.12 (vendor branch): download - view: text, annotated - select for diffs
Tue Apr 24 19:17:39 2018 UTC (3 years, 1 month ago) by root
Branches: qemu, MAIN
CVS tags: qemu1001, HEAD
qemu 1.0.1

    1: #ifndef BLOCK_H
    2: #define BLOCK_H
    3: 
    4: #include "qemu-aio.h"
    5: #include "qemu-common.h"
    6: #include "qemu-option.h"
    7: #include "qemu-coroutine.h"
    8: #include "qobject.h"
    9: 
   10: /* block.c */
   11: typedef struct BlockDriver BlockDriver;
   12: 
   13: typedef struct BlockDriverInfo {
   14:     /* in bytes, 0 if irrelevant */
   15:     int cluster_size;
   16:     /* offset at which the VM state can be saved (0 if not possible) */
   17:     int64_t vm_state_offset;
   18: } BlockDriverInfo;
   19: 
   20: typedef struct QEMUSnapshotInfo {
   21:     char id_str[128]; /* unique snapshot id */
   22:     /* the following fields are informative. They are not needed for
   23:        the consistency of the snapshot */
   24:     char name[256]; /* user choosen name */
   25:     uint32_t vm_state_size; /* VM state info size */
   26:     uint32_t date_sec; /* UTC date of the snapshot */
   27:     uint32_t date_nsec;
   28:     uint64_t vm_clock_nsec; /* VM clock relative to boot */
   29: } QEMUSnapshotInfo;
   30: 
   31: /* Callbacks for block device models */
   32: typedef struct BlockDevOps {
   33:     /*
   34:      * Runs when virtual media changed (monitor commands eject, change)
   35:      * Argument load is true on load and false on eject.
   36:      * Beware: doesn't run when a host device's physical media
   37:      * changes.  Sure would be useful if it did.
   38:      * Device models with removable media must implement this callback.
   39:      */
   40:     void (*change_media_cb)(void *opaque, bool load);
   41:     /*
   42:      * Runs when an eject request is issued from the monitor, the tray
   43:      * is closed, and the medium is locked.
   44:      * Device models that do not implement is_medium_locked will not need
   45:      * this callback.  Device models that can lock the medium or tray might
   46:      * want to implement the callback and unlock the tray when "force" is
   47:      * true, even if they do not support eject requests.
   48:      */
   49:     void (*eject_request_cb)(void *opaque, bool force);
   50:     /*
   51:      * Is the virtual tray open?
   52:      * Device models implement this only when the device has a tray.
   53:      */
   54:     bool (*is_tray_open)(void *opaque);
   55:     /*
   56:      * Is the virtual medium locked into the device?
   57:      * Device models implement this only when device has such a lock.
   58:      */
   59:     bool (*is_medium_locked)(void *opaque);
   60:     /*
   61:      * Runs when the size changed (e.g. monitor command block_resize)
   62:      */
   63:     void (*resize_cb)(void *opaque);
   64: } BlockDevOps;
   65: 
   66: #define BDRV_O_RDWR        0x0002
   67: #define BDRV_O_SNAPSHOT    0x0008 /* open the file read only and save writes in a snapshot */
   68: #define BDRV_O_NOCACHE     0x0020 /* do not use the host page cache */
   69: #define BDRV_O_CACHE_WB    0x0040 /* use write-back caching */
   70: #define BDRV_O_NATIVE_AIO  0x0080 /* use native AIO instead of the thread pool */
   71: #define BDRV_O_NO_BACKING  0x0100 /* don't open the backing file */
   72: #define BDRV_O_NO_FLUSH    0x0200 /* disable flushing on this disk */
   73: 
   74: #define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
   75: 
   76: #define BDRV_SECTOR_BITS   9
   77: #define BDRV_SECTOR_SIZE   (1ULL << BDRV_SECTOR_BITS)
   78: #define BDRV_SECTOR_MASK   ~(BDRV_SECTOR_SIZE - 1)
   79: 
   80: typedef enum {
   81:     BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
   82:     BLOCK_ERR_STOP_ANY
   83: } BlockErrorAction;
   84: 
   85: typedef enum {
   86:     BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
   87: } BlockMonEventAction;
   88: 
   89: void bdrv_iostatus_enable(BlockDriverState *bs);
   90: void bdrv_iostatus_reset(BlockDriverState *bs);
   91: void bdrv_iostatus_disable(BlockDriverState *bs);
   92: bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
   93: void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
   94: void bdrv_mon_event(const BlockDriverState *bdrv,
   95:                     BlockMonEventAction action, int is_read);
   96: void bdrv_info_print(Monitor *mon, const QObject *data);
   97: void bdrv_info(Monitor *mon, QObject **ret_data);
   98: void bdrv_stats_print(Monitor *mon, const QObject *data);
   99: void bdrv_info_stats(Monitor *mon, QObject **ret_data);
  100: 
  101: void bdrv_init(void);
  102: void bdrv_init_with_whitelist(void);
  103: BlockDriver *bdrv_find_protocol(const char *filename);
  104: BlockDriver *bdrv_find_format(const char *format_name);
  105: BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
  106: int bdrv_create(BlockDriver *drv, const char* filename,
  107:     QEMUOptionParameter *options);
  108: int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
  109: BlockDriverState *bdrv_new(const char *device_name);
  110: void bdrv_make_anon(BlockDriverState *bs);
  111: void bdrv_delete(BlockDriverState *bs);
  112: int bdrv_parse_cache_flags(const char *mode, int *flags);
  113: int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
  114: int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
  115:               BlockDriver *drv);
  116: void bdrv_close(BlockDriverState *bs);
  117: int bdrv_attach_dev(BlockDriverState *bs, void *dev);
  118: void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev);
  119: void bdrv_detach_dev(BlockDriverState *bs, void *dev);
  120: void *bdrv_get_attached_dev(BlockDriverState *bs);
  121: void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
  122:                       void *opaque);
  123: void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
  124: bool bdrv_dev_has_removable_media(BlockDriverState *bs);
  125: bool bdrv_dev_is_tray_open(BlockDriverState *bs);
  126: bool bdrv_dev_is_medium_locked(BlockDriverState *bs);
  127: int bdrv_read(BlockDriverState *bs, int64_t sector_num,
  128:               uint8_t *buf, int nb_sectors);
  129: int bdrv_write(BlockDriverState *bs, int64_t sector_num,
  130:                const uint8_t *buf, int nb_sectors);
  131: int bdrv_pread(BlockDriverState *bs, int64_t offset,
  132:                void *buf, int count);
  133: int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
  134:                 const void *buf, int count);
  135: int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
  136:     const void *buf, int count);
  137: int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
  138:     int nb_sectors, QEMUIOVector *qiov);
  139: int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
  140:     int nb_sectors, QEMUIOVector *qiov);
  141: int bdrv_truncate(BlockDriverState *bs, int64_t offset);
  142: int64_t bdrv_getlength(BlockDriverState *bs);
  143: int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
  144: void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
  145: void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
  146: int bdrv_commit(BlockDriverState *bs);
  147: void bdrv_commit_all(void);
  148: int bdrv_change_backing_file(BlockDriverState *bs,
  149:     const char *backing_file, const char *backing_fmt);
  150: void bdrv_register(BlockDriver *bdrv);
  151: 
  152: 
  153: typedef struct BdrvCheckResult {
  154:     int corruptions;
  155:     int leaks;
  156:     int check_errors;
  157: } BdrvCheckResult;
  158: 
  159: int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res);
  160: 
  161: /* async block I/O */
  162: typedef struct BlockDriverAIOCB BlockDriverAIOCB;
  163: typedef void BlockDriverCompletionFunc(void *opaque, int ret);
  164: typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
  165:                                      int sector_num);
  166: BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
  167:                                  QEMUIOVector *iov, int nb_sectors,
  168:                                  BlockDriverCompletionFunc *cb, void *opaque);
  169: BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
  170:                                   QEMUIOVector *iov, int nb_sectors,
  171:                                   BlockDriverCompletionFunc *cb, void *opaque);
  172: BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
  173:                                  BlockDriverCompletionFunc *cb, void *opaque);
  174: BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
  175:                                    int64_t sector_num, int nb_sectors,
  176:                                    BlockDriverCompletionFunc *cb, void *opaque);
  177: void bdrv_aio_cancel(BlockDriverAIOCB *acb);
  178: 
  179: typedef struct BlockRequest {
  180:     /* Fields to be filled by multiwrite caller */
  181:     int64_t sector;
  182:     int nb_sectors;
  183:     QEMUIOVector *qiov;
  184:     BlockDriverCompletionFunc *cb;
  185:     void *opaque;
  186: 
  187:     /* Filled by multiwrite implementation */
  188:     int error;
  189: } BlockRequest;
  190: 
  191: int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
  192:     int num_reqs);
  193: 
  194: /* sg packet commands */
  195: int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
  196: BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
  197:         unsigned long int req, void *buf,
  198:         BlockDriverCompletionFunc *cb, void *opaque);
  199: 
  200: /* Invalidate any cached metadata used by image formats */
  201: void bdrv_invalidate_cache(BlockDriverState *bs);
  202: void bdrv_invalidate_cache_all(void);
  203: 
  204: /* Ensure contents are flushed to disk.  */
  205: int bdrv_flush(BlockDriverState *bs);
  206: int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
  207: void bdrv_flush_all(void);
  208: void bdrv_close_all(void);
  209: 
  210: int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
  211: int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
  212: int bdrv_has_zero_init(BlockDriverState *bs);
  213: int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
  214:                       int *pnum);
  215: 
  216: #define BIOS_ATA_TRANSLATION_AUTO   0
  217: #define BIOS_ATA_TRANSLATION_NONE   1
  218: #define BIOS_ATA_TRANSLATION_LBA    2
  219: #define BIOS_ATA_TRANSLATION_LARGE  3
  220: #define BIOS_ATA_TRANSLATION_RECHS  4
  221: 
  222: void bdrv_set_geometry_hint(BlockDriverState *bs,
  223:                             int cyls, int heads, int secs);
  224: void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
  225: void bdrv_get_geometry_hint(BlockDriverState *bs,
  226:                             int *pcyls, int *pheads, int *psecs);
  227: typedef enum FDriveType {
  228:     FDRIVE_DRV_144  = 0x00,   /* 1.44 MB 3"5 drive      */
  229:     FDRIVE_DRV_288  = 0x01,   /* 2.88 MB 3"5 drive      */
  230:     FDRIVE_DRV_120  = 0x02,   /* 1.2  MB 5"25 drive     */
  231:     FDRIVE_DRV_NONE = 0x03,   /* No drive connected     */
  232: } FDriveType;
  233: 
  234: void bdrv_get_floppy_geometry_hint(BlockDriverState *bs, int *nb_heads,
  235:                                    int *max_track, int *last_sect,
  236:                                    FDriveType drive_in, FDriveType *drive);
  237: int bdrv_get_translation_hint(BlockDriverState *bs);
  238: void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
  239:                        BlockErrorAction on_write_error);
  240: BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
  241: int bdrv_is_read_only(BlockDriverState *bs);
  242: int bdrv_is_sg(BlockDriverState *bs);
  243: int bdrv_enable_write_cache(BlockDriverState *bs);
  244: int bdrv_is_inserted(BlockDriverState *bs);
  245: int bdrv_media_changed(BlockDriverState *bs);
  246: void bdrv_lock_medium(BlockDriverState *bs, bool locked);
  247: void bdrv_eject(BlockDriverState *bs, int eject_flag);
  248: void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
  249: BlockDriverState *bdrv_find(const char *name);
  250: BlockDriverState *bdrv_next(BlockDriverState *bs);
  251: void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
  252:                   void *opaque);
  253: int bdrv_is_encrypted(BlockDriverState *bs);
  254: int bdrv_key_required(BlockDriverState *bs);
  255: int bdrv_set_key(BlockDriverState *bs, const char *key);
  256: int bdrv_query_missing_keys(void);
  257: void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
  258:                          void *opaque);
  259: const char *bdrv_get_device_name(BlockDriverState *bs);
  260: int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
  261:                           const uint8_t *buf, int nb_sectors);
  262: int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
  263: 
  264: const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
  265: void bdrv_get_backing_filename(BlockDriverState *bs,
  266:                                char *filename, int filename_size);
  267: int bdrv_can_snapshot(BlockDriverState *bs);
  268: int bdrv_is_snapshot(BlockDriverState *bs);
  269: BlockDriverState *bdrv_snapshots(void);
  270: int bdrv_snapshot_create(BlockDriverState *bs,
  271:                          QEMUSnapshotInfo *sn_info);
  272: int bdrv_snapshot_goto(BlockDriverState *bs,
  273:                        const char *snapshot_id);
  274: int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
  275: int bdrv_snapshot_list(BlockDriverState *bs,
  276:                        QEMUSnapshotInfo **psn_info);
  277: int bdrv_snapshot_load_tmp(BlockDriverState *bs,
  278:                            const char *snapshot_name);
  279: char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
  280: 
  281: char *get_human_readable_size(char *buf, int buf_size, int64_t size);
  282: int path_is_absolute(const char *path);
  283: void path_combine(char *dest, int dest_size,
  284:                   const char *base_path,
  285:                   const char *filename);
  286: 
  287: int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
  288:                       int64_t pos, int size);
  289: 
  290: int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
  291:                       int64_t pos, int size);
  292: 
  293: int bdrv_img_create(const char *filename, const char *fmt,
  294:                     const char *base_filename, const char *base_fmt,
  295:                     char *options, uint64_t img_size, int flags);
  296: 
  297: void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
  298: void *qemu_blockalign(BlockDriverState *bs, size_t size);
  299: 
  300: #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
  301: 
  302: void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
  303: int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
  304: void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
  305:                       int nr_sectors);
  306: int64_t bdrv_get_dirty_count(BlockDriverState *bs);
  307: 
  308: void bdrv_set_in_use(BlockDriverState *bs, int in_use);
  309: int bdrv_in_use(BlockDriverState *bs);
  310: 
  311: enum BlockAcctType {
  312:     BDRV_ACCT_READ,
  313:     BDRV_ACCT_WRITE,
  314:     BDRV_ACCT_FLUSH,
  315:     BDRV_MAX_IOTYPE,
  316: };
  317: 
  318: typedef struct BlockAcctCookie {
  319:     int64_t bytes;
  320:     int64_t start_time_ns;
  321:     enum BlockAcctType type;
  322: } BlockAcctCookie;
  323: 
  324: void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
  325:         int64_t bytes, enum BlockAcctType type);
  326: void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);
  327: 
  328: typedef enum {
  329:     BLKDBG_L1_UPDATE,
  330: 
  331:     BLKDBG_L1_GROW_ALLOC_TABLE,
  332:     BLKDBG_L1_GROW_WRITE_TABLE,
  333:     BLKDBG_L1_GROW_ACTIVATE_TABLE,
  334: 
  335:     BLKDBG_L2_LOAD,
  336:     BLKDBG_L2_UPDATE,
  337:     BLKDBG_L2_UPDATE_COMPRESSED,
  338:     BLKDBG_L2_ALLOC_COW_READ,
  339:     BLKDBG_L2_ALLOC_WRITE,
  340: 
  341:     BLKDBG_READ,
  342:     BLKDBG_READ_AIO,
  343:     BLKDBG_READ_BACKING,
  344:     BLKDBG_READ_BACKING_AIO,
  345:     BLKDBG_READ_COMPRESSED,
  346: 
  347:     BLKDBG_WRITE_AIO,
  348:     BLKDBG_WRITE_COMPRESSED,
  349: 
  350:     BLKDBG_VMSTATE_LOAD,
  351:     BLKDBG_VMSTATE_SAVE,
  352: 
  353:     BLKDBG_COW_READ,
  354:     BLKDBG_COW_WRITE,
  355: 
  356:     BLKDBG_REFTABLE_LOAD,
  357:     BLKDBG_REFTABLE_GROW,
  358: 
  359:     BLKDBG_REFBLOCK_LOAD,
  360:     BLKDBG_REFBLOCK_UPDATE,
  361:     BLKDBG_REFBLOCK_UPDATE_PART,
  362:     BLKDBG_REFBLOCK_ALLOC,
  363:     BLKDBG_REFBLOCK_ALLOC_HOOKUP,
  364:     BLKDBG_REFBLOCK_ALLOC_WRITE,
  365:     BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
  366:     BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
  367:     BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
  368: 
  369:     BLKDBG_CLUSTER_ALLOC,
  370:     BLKDBG_CLUSTER_ALLOC_BYTES,
  371:     BLKDBG_CLUSTER_FREE,
  372: 
  373:     BLKDBG_EVENT_MAX,
  374: } BlkDebugEvent;
  375: 
  376: #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
  377: void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
  378: 
  379: 
  380: /* Convenience for block device models */
  381: 
  382: typedef struct BlockConf {
  383:     BlockDriverState *bs;
  384:     uint16_t physical_block_size;
  385:     uint16_t logical_block_size;
  386:     uint16_t min_io_size;
  387:     uint32_t opt_io_size;
  388:     int32_t bootindex;
  389:     uint32_t discard_granularity;
  390: } BlockConf;
  391: 
  392: static inline unsigned int get_physical_block_exp(BlockConf *conf)
  393: {
  394:     unsigned int exp = 0, size;
  395: 
  396:     for (size = conf->physical_block_size;
  397:         size > conf->logical_block_size;
  398:         size >>= 1) {
  399:         exp++;
  400:     }
  401: 
  402:     return exp;
  403: }
  404: 
  405: #define DEFINE_BLOCK_PROPERTIES(_state, _conf)                          \
  406:     DEFINE_PROP_DRIVE("drive", _state, _conf.bs),                       \
  407:     DEFINE_PROP_UINT16("logical_block_size", _state,                    \
  408:                        _conf.logical_block_size, 512),                  \
  409:     DEFINE_PROP_UINT16("physical_block_size", _state,                   \
  410:                        _conf.physical_block_size, 512),                 \
  411:     DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0),  \
  412:     DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0),    \
  413:     DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1),        \
  414:     DEFINE_PROP_UINT32("discard_granularity", _state, \
  415:                        _conf.discard_granularity, 0)
  416: 
  417: #endif
  418: 

unix.superglobalmegacorp.com