LXR qemu/include/sysemu/block-backend.h

   1/*
   2 * QEMU Block backends
   3 *
   4 * Copyright (C) 2014 Red Hat, Inc.
   5 *
   6 * Authors:
   7 *  Markus Armbruster <armbru@redhat.com>,
   8 *
   9 * This work is licensed under the terms of the GNU LGPL, version 2.1
  10 * or later.  See the COPYING.LIB file in the top-level directory.
  11 */
  12
  13#ifndef BLOCK_BACKEND_H
  14#define BLOCK_BACKEND_H
  15
  16#include "qemu/iov.h"
  17
  18/*
  19 * TODO Have to include block/block.h for a bunch of block layer
  20 * types.  Unfortunately, this pulls in the whole BlockDriverState
  21 * API, which we don't want used by many BlockBackend users.  Some of
  22 * the types belong here, and the rest should be split into a common
  23 * header and one for the BlockDriverState API.
  24 */
  25#include "block/block.h"
  26
  27/* Callbacks for block device models */
  28typedef struct BlockDevOps {
  29    /*
  30     * Runs when virtual media changed (monitor commands eject, change)
  31     * Argument load is true on load and false on eject.
  32     * Beware: doesn't run when a host device's physical media
  33     * changes.  Sure would be useful if it did.
  34     * Device models with removable media must implement this callback.
  35     */
  36    void (*change_media_cb)(void *opaque, bool load);
  37    /*
  38     * Runs when an eject request is issued from the monitor, the tray
  39     * is closed, and the medium is locked.
  40     * Device models that do not implement is_medium_locked will not need
  41     * this callback.  Device models that can lock the medium or tray might
  42     * want to implement the callback and unlock the tray when "force" is
  43     * true, even if they do not support eject requests.
  44     */
  45    void (*eject_request_cb)(void *opaque, bool force);
  46    /*
  47     * Is the virtual tray open?
  48     * Device models implement this only when the device has a tray.
  49     */
  50    bool (*is_tray_open)(void *opaque);
  51    /*
  52     * Is the virtual medium locked into the device?
  53     * Device models implement this only when device has such a lock.
  54     */
  55    bool (*is_medium_locked)(void *opaque);
  56    /*
  57     * Runs when the size changed (e.g. monitor command block_resize)
  58     */
  59    void (*resize_cb)(void *opaque);
  60} BlockDevOps;
  61
  62BlockBackend *blk_new(Error **errp);
  63BlockBackend *blk_new_with_bs(Error **errp);
  64BlockBackend *blk_new_open(const char *filename, const char *reference,
  65                           QDict *options, int flags, Error **errp);
  66int blk_get_refcnt(BlockBackend *blk);
  67void blk_ref(BlockBackend *blk);
  68void blk_unref(BlockBackend *blk);
  69void blk_remove_all_bs(void);
  70const char *blk_name(BlockBackend *blk);
  71BlockBackend *blk_by_name(const char *name);
  72BlockBackend *blk_next(BlockBackend *blk);
  73BlockDriverState *blk_next_root_bs(BlockDriverState *bs);
  74bool monitor_add_blk(BlockBackend *blk, const char *name, Error **errp);
  75void monitor_remove_blk(BlockBackend *blk);
  76
  77BlockDriverState *blk_bs(BlockBackend *blk);
  78void blk_remove_bs(BlockBackend *blk);
  79void blk_insert_bs(BlockBackend *blk, BlockDriverState *bs);
  80
  81void blk_set_allow_write_beyond_eof(BlockBackend *blk, bool allow);
  82void blk_iostatus_enable(BlockBackend *blk);
  83bool blk_iostatus_is_enabled(const BlockBackend *blk);
  84BlockDeviceIoStatus blk_iostatus(const BlockBackend *blk);
  85void blk_iostatus_disable(BlockBackend *blk);
  86void blk_iostatus_reset(BlockBackend *blk);
  87void blk_iostatus_set_err(BlockBackend *blk, int error);
  88int blk_attach_dev(BlockBackend *blk, void *dev);
  89void blk_attach_dev_nofail(BlockBackend *blk, void *dev);
  90void blk_detach_dev(BlockBackend *blk, void *dev);
  91void *blk_get_attached_dev(BlockBackend *blk);
  92void blk_set_dev_ops(BlockBackend *blk, const BlockDevOps *ops, void *opaque);
  93int blk_read(BlockBackend *blk, int64_t sector_num, uint8_t *buf,
  94             int nb_sectors);
  95int blk_read_unthrottled(BlockBackend *blk, int64_t sector_num, uint8_t *buf,
  96                         int nb_sectors);
  97int blk_write(BlockBackend *blk, int64_t sector_num, const uint8_t *buf,
  98              int nb_sectors);
  99int blk_write_zeroes(BlockBackend *blk, int64_t sector_num,
 100                     int nb_sectors, BdrvRequestFlags flags);
 101BlockAIOCB *blk_aio_write_zeroes(BlockBackend *blk, int64_t sector_num,
 102                                 int nb_sectors, BdrvRequestFlags flags,
 103                                 BlockCompletionFunc *cb, void *opaque);
 104int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int count);
 105int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int count);
 106int64_t blk_getlength(BlockBackend *blk);
 107void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr);
 108int64_t blk_nb_sectors(BlockBackend *blk);
 109BlockAIOCB *blk_aio_readv(BlockBackend *blk, int64_t sector_num,
 110                          QEMUIOVector *iov, int nb_sectors,
 111                          BlockCompletionFunc *cb, void *opaque);
 112BlockAIOCB *blk_aio_writev(BlockBackend *blk, int64_t sector_num,
 113                           QEMUIOVector *iov, int nb_sectors,
 114                           BlockCompletionFunc *cb, void *opaque);
 115BlockAIOCB *blk_aio_flush(BlockBackend *blk,
 116                          BlockCompletionFunc *cb, void *opaque);
 117BlockAIOCB *blk_aio_discard(BlockBackend *blk,
 118                            int64_t sector_num, int nb_sectors,
 119                            BlockCompletionFunc *cb, void *opaque);
 120void blk_aio_cancel(BlockAIOCB *acb);
 121void blk_aio_cancel_async(BlockAIOCB *acb);
 122int blk_aio_multiwrite(BlockBackend *blk, BlockRequest *reqs, int num_reqs);
 123int blk_ioctl(BlockBackend *blk, unsigned long int req, void *buf);
 124BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf,
 125                          BlockCompletionFunc *cb, void *opaque);
 126int blk_co_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors);
 127int blk_co_flush(BlockBackend *blk);
 128int blk_flush(BlockBackend *blk);
 129int blk_flush_all(void);
 130int blk_commit_all(void);
 131void blk_drain(BlockBackend *blk);
 132void blk_drain_all(void);
 133void blk_set_on_error(BlockBackend *blk, BlockdevOnError on_read_error,
 134                      BlockdevOnError on_write_error);
 135BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read);
 136BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read,
 137                                      int error);
 138void blk_error_action(BlockBackend *blk, BlockErrorAction action,
 139                      bool is_read, int error);
 140int blk_is_read_only(BlockBackend *blk);
 141int blk_is_sg(BlockBackend *blk);
 142int blk_enable_write_cache(BlockBackend *blk);
 143void blk_set_enable_write_cache(BlockBackend *blk, bool wce);
 144void blk_invalidate_cache(BlockBackend *blk, Error **errp);
 145bool blk_is_inserted(BlockBackend *blk);
 146bool blk_is_available(BlockBackend *blk);
 147void blk_lock_medium(BlockBackend *blk, bool locked);
 148void blk_eject(BlockBackend *blk, bool eject_flag);
 149int blk_get_flags(BlockBackend *blk);
 150int blk_get_max_transfer_length(BlockBackend *blk);
 151int blk_get_max_iov(BlockBackend *blk);
 152void blk_set_guest_block_size(BlockBackend *blk, int align);
 153void *blk_try_blockalign(BlockBackend *blk, size_t size);
 154void *blk_blockalign(BlockBackend *blk, size_t size);
 155bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp);
 156void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason);
 157void blk_op_block_all(BlockBackend *blk, Error *reason);
 158void blk_op_unblock_all(BlockBackend *blk, Error *reason);
 159AioContext *blk_get_aio_context(BlockBackend *blk);
 160void blk_set_aio_context(BlockBackend *blk, AioContext *new_context);
 161void blk_add_aio_context_notifier(BlockBackend *blk,
 162        void (*attached_aio_context)(AioContext *new_context, void *opaque),
 163        void (*detach_aio_context)(void *opaque), void *opaque);
 164void blk_remove_aio_context_notifier(BlockBackend *blk,
 165                                     void (*attached_aio_context)(AioContext *,
 166                                                                  void *),
 167                                     void (*detach_aio_context)(void *),
 168                                     void *opaque);
 169void blk_add_remove_bs_notifier(BlockBackend *blk, Notifier *notify);
 170void blk_add_insert_bs_notifier(BlockBackend *blk, Notifier *notify);
 171void blk_io_plug(BlockBackend *blk);
 172void blk_io_unplug(BlockBackend *blk);
 173BlockAcctStats *blk_get_stats(BlockBackend *blk);
 174BlockBackendRootState *blk_get_root_state(BlockBackend *blk);
 175void blk_update_root_state(BlockBackend *blk);
 176void blk_apply_root_state(BlockBackend *blk, BlockDriverState *bs);
 177int blk_get_open_flags_from_root_state(BlockBackend *blk);
 178
 179void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk,
 180                  BlockCompletionFunc *cb, void *opaque);
 181int coroutine_fn blk_co_write_zeroes(BlockBackend *blk, int64_t sector_num,
 182                                     int nb_sectors, BdrvRequestFlags flags);
 183int blk_write_compressed(BlockBackend *blk, int64_t sector_num,
 184                         const uint8_t *buf, int nb_sectors);
 185int blk_truncate(BlockBackend *blk, int64_t offset);
 186int blk_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors);
 187int blk_save_vmstate(BlockBackend *blk, const uint8_t *buf,
 188                     int64_t pos, int size);
 189int blk_load_vmstate(BlockBackend *blk, uint8_t *buf, int64_t pos, int size);
 190int blk_probe_blocksizes(BlockBackend *blk, BlockSizes *bsz);
 191int blk_probe_geometry(BlockBackend *blk, HDGeometry *geo);
 192BlockAIOCB *blk_abort_aio_request(BlockBackend *blk,
 193                                  BlockCompletionFunc *cb,
 194                                  void *opaque, int ret);
 195
 196#endif
 197