Linux 2.6.x compat, blkdev_compat.h
[zfs.git] / include / linux / blkdev_compat.h
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21
22 /*
23  * Copyright (C) 2011 Lawrence Livermore National Security, LLC.
24  * Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
25  * Written by Brian Behlendorf <behlendorf1@llnl.gov>.
26  * LLNL-CODE-403049.
27  */
28
29 #ifndef _ZFS_BLKDEV_H
30 #define _ZFS_BLKDEV_H
31
32 #include <linux/blkdev.h>
33 #include <linux/elevator.h>
34
35 #ifndef HAVE_FMODE_T
36 typedef unsigned __bitwise__ fmode_t;
37 #endif /* HAVE_FMODE_T */
38
39 #ifndef HAVE_BLK_FETCH_REQUEST
40 static inline struct request *
41 blk_fetch_request(struct request_queue *q)
42 {
43         struct request *req;
44
45         req = elv_next_request(q);
46         if (req)
47                 blkdev_dequeue_request(req);
48
49         return req;
50 }
51 #endif /* HAVE_BLK_FETCH_REQUEST */
52
53 #ifndef HAVE_BLK_REQUEUE_REQUEST
54 static inline void
55 blk_requeue_request(request_queue_t *q, struct request *req)
56 {
57         elv_requeue_request(q, req);
58 }
59 #endif /* HAVE_BLK_REQUEUE_REQUEST */
60
61 #ifndef HAVE_BLK_END_REQUEST
62 static inline bool
63 __blk_end_request(struct request *req, int error, unsigned int nr_bytes)
64 {
65         LIST_HEAD(list);
66
67         /*
68          * Request has already been dequeued but 2.6.18 version of
69          * end_request() unconditionally dequeues the request so we
70          * add it to a local list to prevent hitting the BUG_ON.
71          */
72         list_add(&req->queuelist, &list);
73
74         /*
75          * The old API required the driver to end each segment and not
76          * the entire request.  In our case we always need to end the
77          * entire request partial requests are not supported.
78          */
79         req->hard_cur_sectors = nr_bytes >> 9;
80         end_request(req, ((error == 0) ? 1 : error));
81
82         return 0;
83 }
84
85 static inline bool
86 blk_end_request(struct request *req, int error, unsigned int nr_bytes)
87 {
88         struct request_queue *q = req->q;
89         bool rc;
90
91         spin_lock_irq(q->queue_lock);
92         rc = __blk_end_request(req, error, nr_bytes);
93         spin_unlock_irq(q->queue_lock);
94
95         return rc;
96 }
97 #else
98 # ifdef HAVE_BLK_END_REQUEST_GPL_ONLY
99 /*
100  * Define required to avoid conflicting 2.6.29 non-static prototype for a
101  * GPL-only version of the helper.  As of 2.6.31 the helper is available
102  * to non-GPL modules and is not explicitly exported GPL-only.
103  */
104 # define __blk_end_request __blk_end_request_x
105 # define blk_end_request blk_end_request_x
106
107 static inline bool
108 __blk_end_request_x(struct request *req, int error, unsigned int nr_bytes)
109 {
110         /*
111          * The old API required the driver to end each segment and not
112          * the entire request.  In our case we always need to end the
113          * entire request partial requests are not supported.
114          */
115         req->hard_cur_sectors = nr_bytes >> 9;
116         end_request(req, ((error == 0) ? 1 : error));
117
118         return 0;
119 }
120 static inline bool
121 blk_end_request_x(struct request *req, int error, unsigned int nr_bytes)
122 {
123         struct request_queue *q = req->q;
124         bool rc;
125
126         spin_lock_irq(q->queue_lock);
127         rc = __blk_end_request_x(req, error, nr_bytes);
128         spin_unlock_irq(q->queue_lock);
129
130         return rc;
131 }
132 # endif /* HAVE_BLK_END_REQUEST_GPL_ONLY */
133 #endif /* HAVE_BLK_END_REQUEST */
134
135 #ifndef HAVE_BLK_RQ_POS
136 static inline sector_t
137 blk_rq_pos(struct request *req)
138 {
139         return req->sector;
140 }
141 #endif /* HAVE_BLK_RQ_POS */
142
143 #ifndef HAVE_BLK_RQ_SECTORS
144 static inline unsigned int
145 blk_rq_sectors(struct request *req)
146 {
147         return req->nr_sectors;
148 }
149 #endif /* HAVE_BLK_RQ_SECTORS */
150
151 #if !defined(HAVE_BLK_RQ_BYTES) || defined(HAVE_BLK_RQ_BYTES_GPL_ONLY)
152 /*
153  * Define required to avoid conflicting 2.6.29 non-static prototype for a
154  * GPL-only version of the helper.  As of 2.6.31 the helper is available
155  * to non-GPL modules in the form of a static inline in the header.
156  */
157 #define blk_rq_bytes __blk_rq_bytes
158 static inline unsigned int
159 __blk_rq_bytes(struct request *req)
160 {
161         return blk_rq_sectors(req) << 9;
162 }
163 #endif /* !HAVE_BLK_RQ_BYTES || HAVE_BLK_RQ_BYTES_GPL_ONLY */
164
165 /*
166  * Most of the blk_* macros were removed in 2.6.36.  Ostensibly this was
167  * done to improve readability and allow easier grepping.  However, from
168  * a portability stand point the macros are helpful.  Therefore the needed
169  * macros are redefined here if they are missing from the kernel.
170  */
171 #ifndef blk_fs_request
172 #define blk_fs_request(rq)      ((rq)->cmd_type == REQ_TYPE_FS)
173 #endif
174
175 #ifndef HAVE_GET_DISK_RO
176 static inline int
177 get_disk_ro(struct gendisk *disk)
178 {
179         int policy = 0;
180
181         if (disk->part[0])
182                 policy = disk->part[0]->policy;
183
184         return policy;
185 }
186 #endif /* HAVE_GET_DISK_RO */
187
188 #ifndef HAVE_RQ_IS_SYNC
189 static inline bool
190 rq_is_sync(struct request *req)
191 {
192         return (req->flags & REQ_RW_SYNC);
193 }
194 #endif /* HAVE_RQ_IS_SYNC */
195
196 #ifndef HAVE_RQ_FOR_EACH_SEGMENT
197 struct req_iterator {
198         int i;
199         struct bio *bio;
200 };
201
202 # define for_each_bio(_bio)              \
203         for (; _bio; _bio = _bio->bi_next)
204
205 # define __rq_for_each_bio(_bio, rq)    \
206         if ((rq->bio))                  \
207                 for (_bio = (rq)->bio; _bio; _bio = _bio->bi_next)
208
209 # define rq_for_each_segment(bvl, _rq, _iter)                   \
210         __rq_for_each_bio(_iter.bio, _rq)                       \
211                 bio_for_each_segment(bvl, _iter.bio, _iter.i)
212 #endif /* HAVE_RQ_FOR_EACH_SEGMENT */
213
214 /*
215  * Portable helper for correctly setting the FAILFAST flags.  The
216  * correct usage has changed 3 times from 2.6.12 to 2.6.38.
217  */
218 static inline void
219 bio_set_flags_failfast(struct block_device *bdev, int *flags)
220 {
221 #ifdef CONFIG_BUG
222         /*
223          * Disable FAILFAST for loopback devices because of the
224          * following incorrect BUG_ON() in loop_make_request().
225          * This support is also disabled for md devices because the
226          * test suite layers md devices on top of loopback devices.
227          * This may be removed when the loopback driver is fixed.
228          *
229          *   BUG_ON(!lo || (rw != READ && rw != WRITE));
230          */
231         if ((MAJOR(bdev->bd_dev) == LOOP_MAJOR) ||
232             (MAJOR(bdev->bd_dev) == MD_MAJOR))
233                 return;
234
235 #ifdef BLOCK_EXT_MAJOR
236         if (MAJOR(bdev->bd_dev) == BLOCK_EXT_MAJOR)
237                 return;
238 #endif /* BLOCK_EXT_MAJOR */
239 #endif /* CONFIG_BUG */
240
241 #ifdef HAVE_BIO_RW_FAILFAST_DTD
242         /* BIO_RW_FAILFAST_* preferred interface from 2.6.28 - 2.6.35 */
243         *flags |=
244             ((1 << BIO_RW_FAILFAST_DEV) |
245              (1 << BIO_RW_FAILFAST_TRANSPORT) |
246              (1 << BIO_RW_FAILFAST_DRIVER));
247 #else
248 # ifdef HAVE_BIO_RW_FAILFAST
249         /* BIO_RW_FAILFAST preferred interface from 2.6.12 - 2.6.27 */
250         *flags |= (1 << BIO_RW_FAILFAST);
251 # else
252 #  ifdef HAVE_REQ_FAILFAST_MASK
253         /* REQ_FAILFAST_* preferred interface from 2.6.36 - 2.6.xx,
254          * the BIO_* and REQ_* flags were unified under REQ_* flags. */
255         *flags |= REQ_FAILFAST_MASK;
256 #  endif /* HAVE_REQ_FAILFAST_MASK */
257 # endif /* HAVE_BIO_RW_FAILFAST */
258 #endif /* HAVE_BIO_RW_FAILFAST_DTD */
259 }
260
261 /*
262  * Maximum disk label length, it may be undefined for some kernels.
263  */
264 #ifndef DISK_NAME_LEN
265 #define DISK_NAME_LEN   32
266 #endif /* DISK_NAME_LEN */
267
268 /*
269  * 2.6.24 API change,
270  * The bio_end_io() prototype changed slightly.  These are helper
271  * macro's to ensure the prototype and return value are handled.
272  */
273 #ifdef HAVE_2ARGS_BIO_END_IO_T
274 # define BIO_END_IO_PROTO(fn, x, y, z)  static void fn(struct bio *x, int z)
275 # define BIO_END_IO_RETURN(rc)          return
276 #else
277 # define BIO_END_IO_PROTO(fn, x, y, z)  static int fn(struct bio *x, \
278                                                       unsigned int y, int z)
279 # define BIO_END_IO_RETURN(rc)          return rc
280 #endif /* HAVE_2ARGS_BIO_END_IO_T */
281
282 /*
283  * 2.6.28 API change
284  * Used to exclusively open a block device from within the kernel.
285  */
286 #ifdef HAVE_OPEN_BDEV_EXCLUSIVE
287 # define vdev_bdev_open(path, md, hld)  open_bdev_exclusive(path, md, hld)
288 # define vdev_bdev_close(bdev, md)      close_bdev_exclusive(bdev, md)
289 #else
290 # define vdev_bdev_open(path, md, hld)  open_bdev_excl(path, md, hld)
291 # define vdev_bdev_close(bdev, md)      close_bdev_excl(bdev)
292 #endif /* HAVE_OPEN_BDEV_EXCLUSIVE */
293
294 /*
295  * 2.6.22 API change
296  * The function invalidate_bdev() lost it's second argument because
297  * it was unused.
298  */
299 #ifdef HAVE_1ARG_INVALIDATE_BDEV
300 # define vdev_bdev_invalidate(bdev)     invalidate_bdev(bdev)
301 #else
302 # define vdev_bdev_invalidate(bdev)     invalidate_bdev(bdev, 1)
303 #endif /* HAVE_1ARG_INVALIDATE_BDEV */
304
305 /*
306  * 2.6.30 API change
307  * Change to make it explicit there this is the logical block size.
308  */
309 #ifdef HAVE_BDEV_LOGICAL_BLOCK_SIZE
310 # define vdev_bdev_block_size(bdev)     bdev_logical_block_size(bdev)
311 #else
312 # define vdev_bdev_block_size(bdev)     bdev_hardsect_size(bdev)
313 #endif
314
315 /*
316  * Default Linux IO Scheduler,
317  * Setting the scheduler to noop will allow the Linux IO scheduler to
318  * still perform front and back merging, while leaving the request
319  * ordering and prioritization to the ZFS IO scheduler.
320  */
321 #define VDEV_SCHEDULER                  "noop"
322
323 #endif /* _ZFS_BLKDEV_H */