drivers/xen/blkback/common.h

   1 /*
   2  * This program is free software; you can redistribute it and/or
   3  * modify it under the terms of the GNU General Public License version 2
   4  * as published by the Free Software Foundation; or, when distributed
   5  * separately from the Linux kernel or incorporated into other
   6  * software packages, subject to the following license:
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this source file (the "Software"), to deal in the Software without
  10  * restriction, including without limitation the rights to use, copy, modify,
  11  * merge, publish, distribute, sublicense, and/or sell copies of the Software,
  12  * and to permit persons to whom the Software is furnished to do so, subject to
  13  * the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  24  * IN THE SOFTWARE.
  25  */
  26
  27 #ifndef __BLKIF__BACKEND__COMMON_H__
  28 #define __BLKIF__BACKEND__COMMON_H__
  29
  30 #include <linux/version.h>
  31 #include <linux/module.h>
  32 #include <linux/interrupt.h>
  33 #include <linux/slab.h>
  34 #include <linux/blkdev.h>
  35 #include <linux/vmalloc.h>
  36 #include <linux/wait.h>
  37 #include <asm/io.h>
  38 #include <asm/setup.h>
  39 #include <asm/pgalloc.h>
  40 #include <xen/evtchn.h>
  41 #include <asm/hypervisor.h>
  42 #include <xen/blkif.h>
  43 #include <xen/gnttab.h>
  44 #include <xen/driver_util.h>
  45 #include <xen/xenbus.h>
  46 #include "blkback-pagemap.h"
  47
  48
  49 #define DPRINTK(_f, _a...)                      \
  50         pr_debug("(file=%s, line=%d) " _f,      \
  51                  __FILE__ , __LINE__ , ## _a )
  52
  53 struct vbd {
  54         blkif_vdev_t   handle;      /* what the domain refers to this vbd as */
  55         unsigned char  readonly;    /* Non-zero -> read-only */
  56         unsigned char  type;        /* VDISK_xxx */
  57         u32            pdevice;     /* phys device that this vbd maps to */
  58         struct block_device *bdev;
  59         sector_t       size;        /* Cached size parameter */
  60 };
  61
  62 struct backend_info;
  63
  64 typedef struct blkif_st {
  65         /* Unique identifier for this interface. */
  66         domid_t           domid;
  67         unsigned int      handle;
  68         /* Physical parameters of the comms window. */
  69         unsigned int      irq;
  70         /* Comms information. */
  71         enum blkif_protocol blk_protocol;
  72         blkif_back_rings_t blk_rings;
  73         struct vm_struct *blk_ring_area;
  74         /* The VBD attached to this interface. */
  75         struct vbd        vbd;
  76         /* Back pointer to the backend_info. */
  77         struct backend_info *be;
  78         /* Private fields. */
  79         spinlock_t       blk_ring_lock;
  80         atomic_t         refcnt;
  81
  82         wait_queue_head_t   wq;
  83         struct task_struct  *xenblkd;
  84         unsigned int        waiting_reqs;
  85         struct request_queue *plug;
  86     int                 is_suspended_req;
  87     blkif_request_t     suspended_req;
  88
  89         /* statistics */
  90         unsigned long       st_print;
  91         int                 st_rd_req;
  92         int                 st_wr_req;
  93         int                 st_oo_req;
  94         int                 st_br_req;
  95         int                 st_pk_req;
  96         int                 st_rd_sect;
  97         int                 st_wr_sect;
  98
  99         wait_queue_head_t waiting_to_free;
 100
 101         grant_handle_t shmem_handle;
 102         grant_ref_t    shmem_ref;
 103 } blkif_t;
 104
 105 struct backend_info
 106 {
 107         struct xenbus_device *dev;
 108         blkif_t *blkif;
 109         struct xenbus_watch backend_watch;
 110         struct xenbus_watch cdrom_watch;
 111         unsigned major;
 112         unsigned minor;
 113         char *mode;
 114 };
 115
 116 blkif_t *blkif_alloc(domid_t domid);
 117 void blkif_disconnect(blkif_t *blkif);
 118 void blkif_free(blkif_t *blkif);
 119 int blkif_map(blkif_t *blkif, unsigned long shared_page, unsigned int evtchn);
 120 void vbd_resize(blkif_t *blkif);
 121
 122 #define blkif_get(_b) (atomic_inc(&(_b)->refcnt))
 123 #define blkif_put(_b)                                   \
 124         do {                                            \
 125                 if (atomic_dec_and_test(&(_b)->refcnt)) \
 126                         wake_up(&(_b)->waiting_to_free);\
 127         } while (0)
 128
 129 /* Create a vbd. */
 130 int vbd_create(blkif_t *blkif, blkif_vdev_t vdevice, unsigned major,
 131                unsigned minor, int readonly, int cdrom);
 132 void vbd_free(struct vbd *vbd);
 133
 134 unsigned long long vbd_size(struct vbd *vbd);
 135 unsigned int vbd_info(struct vbd *vbd);
 136 unsigned long vbd_secsize(struct vbd *vbd);
 137
 138 struct phys_req {
 139         unsigned short       dev;
 140         unsigned short       nr_sects;
 141         struct block_device *bdev;
 142         blkif_sector_t       sector_number;
 143 };
 144
 145 int vbd_translate(struct phys_req *req, blkif_t *blkif, int operation);
 146
 147 void blkif_interface_init(void);
 148
 149 void blkif_xenbus_init(void);
 150
 151 irqreturn_t blkif_be_int(int irq, void *dev_id);
 152 int blkif_schedule(void *arg);
 153
 154 int blkback_barrier(struct xenbus_transaction xbt,
 155                     struct backend_info *be, int state);
 156
 157 /* cdrom media change */
 158 void cdrom_add_media_watch(struct backend_info *be);
 159
 160 #endif /* __BLKIF__BACKEND__COMMON_H__ */