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/interface/io/blkif.h>
  43 #include <xen/interface/io/ring.h>
  44 #include <xen/gnttab.h>
  45 #include <xen/driver_util.h>
  46
  47 #define DPRINTK(_f, _a...)                      \
  48         pr_debug("(file=%s, line=%d) " _f,      \
  49                  __FILE__ , __LINE__ , ## _a )
  50
  51 struct vbd {
  52         blkif_vdev_t   handle;      /* what the domain refers to this vbd as */
  53         unsigned char  readonly;    /* Non-zero -> read-only */
  54         unsigned char  type;        /* VDISK_xxx */
  55         u32            pdevice;     /* phys device that this vbd maps to */
  56         struct block_device *bdev;
  57 };
  58
  59 struct backend_info;
  60
  61 typedef struct blkif_st {
  62         /* Unique identifier for this interface. */
  63         domid_t           domid;
  64         unsigned int      handle;
  65         /* Physical parameters of the comms window. */
  66         unsigned int      evtchn;
  67         unsigned int      irq;
  68         /* Comms information. */
  69         blkif_back_ring_t blk_ring;
  70         struct vm_struct *blk_ring_area;
  71         /* The VBD attached to this interface. */
  72         struct vbd        vbd;
  73         /* Back pointer to the backend_info. */
  74         struct backend_info *be;
  75         /* Private fields. */
  76         spinlock_t       blk_ring_lock;
  77         atomic_t         refcnt;
  78
  79         wait_queue_head_t   wq;
  80         struct task_struct  *xenblkd;
  81         unsigned int        waiting_reqs;
  82         request_queue_t     *plug;
  83
  84         /* statistics */
  85         unsigned long       st_print;
  86         int                 st_rd_req;
  87         int                 st_wr_req;
  88         int                 st_oo_req;
  89
  90         wait_queue_head_t waiting_to_free;
  91
  92         grant_handle_t shmem_handle;
  93         grant_ref_t    shmem_ref;
  94 } blkif_t;
  95
  96 blkif_t *blkif_alloc(domid_t domid);
  97 void blkif_disconnect(blkif_t *blkif);
  98 void blkif_free(blkif_t *blkif);
  99 int blkif_map(blkif_t *blkif, unsigned long shared_page, unsigned int evtchn);
 100
 101 #define blkif_get(_b) (atomic_inc(&(_b)->refcnt))
 102 #define blkif_put(_b)                                   \
 103         do {                                            \
 104                 if (atomic_dec_and_test(&(_b)->refcnt)) \
 105                         wake_up(&(_b)->waiting_to_free);\
 106         } while (0)
 107
 108 /* Create a vbd. */
 109 int vbd_create(blkif_t *blkif, blkif_vdev_t vdevice, unsigned major,
 110                unsigned minor, int readonly);
 111 void vbd_free(struct vbd *vbd);
 112
 113 unsigned long vbd_size(struct vbd *vbd);
 114 unsigned int vbd_info(struct vbd *vbd);
 115 unsigned long vbd_secsize(struct vbd *vbd);
 116
 117 struct phys_req {
 118         unsigned short       dev;
 119         unsigned short       nr_sects;
 120         struct block_device *bdev;
 121         blkif_sector_t       sector_number;
 122 };
 123
 124 int vbd_translate(struct phys_req *req, blkif_t *blkif, int operation);
 125
 126 void blkif_interface_init(void);
 127
 128 void blkif_xenbus_init(void);
 129
 130 irqreturn_t blkif_be_int(int irq, void *dev_id, struct pt_regs *regs);
 131 int blkif_schedule(void *arg);
 132
 133 #endif /* __BLKIF__BACKEND__COMMON_H__ */