common.h 7.2 KB
Newer Older
K
Konrad Rzeszutek Wilk 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation; or, when distributed
 * separately from the Linux kernel or incorporated into other
 * software packages, subject to the following license:
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this source file (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy, modify,
 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef __BLKIF__BACKEND__COMMON_H__
#define __BLKIF__BACKEND__COMMON_H__

#include <linux/version.h>
#include <linux/module.h>
#include <linux/interrupt.h>
#include <linux/slab.h>
#include <linux/blkdev.h>
#include <linux/vmalloc.h>
#include <linux/wait.h>
37
#include <linux/io.h>
K
Konrad Rzeszutek Wilk 已提交
38 39 40
#include <asm/setup.h>
#include <asm/pgalloc.h>
#include <asm/hypervisor.h>
J
Jeremy Fitzhardinge 已提交
41
#include <xen/grant_table.h>
K
Konrad Rzeszutek Wilk 已提交
42
#include <xen/xenbus.h>
43 44 45
#include <xen/interface/io/ring.h>
#include <xen/interface/io/blkif.h>
#include <xen/interface/io/protocols.h>
K
Konrad Rzeszutek Wilk 已提交
46

47
#define DRV_PFX "xen-blkback:"
48
#define DPRINTK(fmt, args...)				\
49
	pr_debug(DRV_PFX "(%s:%d) " fmt ".\n",	\
50
		 __func__, __LINE__, ##args)
K
Konrad Rzeszutek Wilk 已提交
51

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115

/* Not a real protocol.  Used to generate ring structs which contain
 * the elements common to all protocols only.  This way we get a
 * compiler-checkable way to use common struct elements, so we can
 * avoid using switch(protocol) in a number of places.  */
struct blkif_common_request {
	char dummy;
};
struct blkif_common_response {
	char dummy;
};

/* i386 protocol version */
#pragma pack(push, 4)
struct blkif_x86_32_request {
	uint8_t        operation;    /* BLKIF_OP_???                         */
	uint8_t        nr_segments;  /* number of segments                   */
	blkif_vdev_t   handle;       /* only for read/write requests         */
	uint64_t       id;           /* private guest value, echoed in resp  */
	blkif_sector_t sector_number;/* start sector idx on disk (r/w only)  */
	struct blkif_request_segment seg[BLKIF_MAX_SEGMENTS_PER_REQUEST];
};
struct blkif_x86_32_response {
	uint64_t        id;              /* copied from request */
	uint8_t         operation;       /* copied from request */
	int16_t         status;          /* BLKIF_RSP_???       */
};
#pragma pack(pop)

/* x86_64 protocol version */
struct blkif_x86_64_request {
	uint8_t        operation;    /* BLKIF_OP_???                         */
	uint8_t        nr_segments;  /* number of segments                   */
	blkif_vdev_t   handle;       /* only for read/write requests         */
	uint64_t       __attribute__((__aligned__(8))) id;
	blkif_sector_t sector_number;/* start sector idx on disk (r/w only)  */
	struct blkif_request_segment seg[BLKIF_MAX_SEGMENTS_PER_REQUEST];
};
struct blkif_x86_64_response {
	uint64_t       __attribute__((__aligned__(8))) id;
	uint8_t         operation;       /* copied from request */
	int16_t         status;          /* BLKIF_RSP_???       */
};

DEFINE_RING_TYPES(blkif_common, struct blkif_common_request,
		  struct blkif_common_response);
DEFINE_RING_TYPES(blkif_x86_32, struct blkif_x86_32_request,
		  struct blkif_x86_32_response);
DEFINE_RING_TYPES(blkif_x86_64, struct blkif_x86_64_request,
		  struct blkif_x86_64_response);

union blkif_back_rings {
	struct blkif_back_ring        native;
	struct blkif_common_back_ring common;
	struct blkif_x86_32_back_ring x86_32;
	struct blkif_x86_64_back_ring x86_64;
};

enum blkif_protocol {
	BLKIF_PROTOCOL_NATIVE = 1,
	BLKIF_PROTOCOL_X86_32 = 2,
	BLKIF_PROTOCOL_X86_64 = 3,
};

116
struct xen_vbd {
117 118 119 120 121 122 123 124 125 126 127 128
	/* What the domain refers to this vbd as. */
	blkif_vdev_t		handle;
	/* Non-zero -> read-only */
	unsigned char		readonly;
	/* VDISK_xxx */
	unsigned char		type;
	/* phys device that this vbd maps to. */
	u32			pdevice;
	struct block_device	*bdev;
	/* Cached size parameter. */
	sector_t		size;
	bool			flush_support;
K
Konrad Rzeszutek Wilk 已提交
129 130 131 132
};

struct backend_info;

133
struct xen_blkif {
K
Konrad Rzeszutek Wilk 已提交
134
	/* Unique identifier for this interface. */
135 136
	domid_t			domid;
	unsigned int		handle;
K
Konrad Rzeszutek Wilk 已提交
137
	/* Physical parameters of the comms window. */
138
	unsigned int		irq;
K
Konrad Rzeszutek Wilk 已提交
139
	/* Comms information. */
140 141 142
	enum blkif_protocol	blk_protocol;
	union blkif_back_rings	blk_rings;
	struct vm_struct	*blk_ring_area;
K
Konrad Rzeszutek Wilk 已提交
143
	/* The VBD attached to this interface. */
144
	struct xen_vbd		vbd;
K
Konrad Rzeszutek Wilk 已提交
145
	/* Back pointer to the backend_info. */
146
	struct backend_info	*be;
K
Konrad Rzeszutek Wilk 已提交
147
	/* Private fields. */
148 149
	spinlock_t		blk_ring_lock;
	atomic_t		refcnt;
K
Konrad Rzeszutek Wilk 已提交
150

151
	wait_queue_head_t	wq;
152
	/* One thread per one blkif. */
153 154
	struct task_struct	*xenblkd;
	unsigned int		waiting_reqs;
K
Konrad Rzeszutek Wilk 已提交
155 156

	/* statistics */
157 158 159 160 161 162 163 164 165 166 167 168
	unsigned long		st_print;
	int			st_rd_req;
	int			st_wr_req;
	int			st_oo_req;
	int			st_f_req;
	int			st_rd_sect;
	int			st_wr_sect;

	wait_queue_head_t	waiting_to_free;

	grant_handle_t		shmem_handle;
	grant_ref_t		shmem_ref;
169
};
K
Konrad Rzeszutek Wilk 已提交
170

171 172 173 174

#define vbd_sz(_v)	((_v)->bdev->bd_part ? \
			 (_v)->bdev->bd_part->nr_sects : \
			  get_capacity((_v)->bdev->bd_disk))
K
Konrad Rzeszutek Wilk 已提交
175

176 177
#define xen_blkif_get(_b) (atomic_inc(&(_b)->refcnt))
#define xen_blkif_put(_b)				\
K
Konrad Rzeszutek Wilk 已提交
178 179 180 181 182 183
	do {						\
		if (atomic_dec_and_test(&(_b)->refcnt))	\
			wake_up(&(_b)->waiting_to_free);\
	} while (0)

struct phys_req {
184 185 186 187
	unsigned short		dev;
	unsigned short		nr_sects;
	struct block_device	*bdev;
	blkif_sector_t		sector_number;
K
Konrad Rzeszutek Wilk 已提交
188
};
189
int xen_blkif_interface_init(void);
K
Konrad Rzeszutek Wilk 已提交
190

191
int xen_blkif_xenbus_init(void);
K
Konrad Rzeszutek Wilk 已提交
192

193 194
irqreturn_t xen_blkif_be_int(int irq, void *dev_id);
int xen_blkif_schedule(void *arg);
K
Konrad Rzeszutek Wilk 已提交
195

196 197
int xen_blkbk_flush_diskcache(struct xenbus_transaction xbt,
			      struct backend_info *be, int state);
K
Konrad Rzeszutek Wilk 已提交
198

199
struct xenbus_device *xen_blkbk_xenbus(struct backend_info *be);
200

201
static inline void blkif_get_x86_32_req(struct blkif_request *dst,
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
					struct blkif_x86_32_request *src)
{
	int i, n = BLKIF_MAX_SEGMENTS_PER_REQUEST;
	dst->operation = src->operation;
	dst->nr_segments = src->nr_segments;
	dst->handle = src->handle;
	dst->id = src->id;
	dst->u.rw.sector_number = src->sector_number;
	barrier();
	if (n > dst->nr_segments)
		n = dst->nr_segments;
	for (i = 0; i < n; i++)
		dst->u.rw.seg[i] = src->seg[i];
}

217
static inline void blkif_get_x86_64_req(struct blkif_request *dst,
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
					struct blkif_x86_64_request *src)
{
	int i, n = BLKIF_MAX_SEGMENTS_PER_REQUEST;
	dst->operation = src->operation;
	dst->nr_segments = src->nr_segments;
	dst->handle = src->handle;
	dst->id = src->id;
	dst->u.rw.sector_number = src->sector_number;
	barrier();
	if (n > dst->nr_segments)
		n = dst->nr_segments;
	for (i = 0; i < n; i++)
		dst->u.rw.seg[i] = src->seg[i];
}

K
Konrad Rzeszutek Wilk 已提交
233
#endif /* __BLKIF__BACKEND__COMMON_H__ */