Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Functions related to mapping data to requests |
| 3 | */ |
| 4 | #include <linux/kernel.h> |
| 5 | #include <linux/module.h> |
| 6 | #include <linux/bio.h> |
| 7 | #include <linux/blkdev.h> |
FUJITA Tomonori | afdc1a7 | 2008-04-11 12:56:51 +0200 | [diff] [blame] | 8 | #include <scsi/sg.h> /* for struct sg_iovec */ |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 9 | |
| 10 | #include "blk.h" |
| 11 | |
| 12 | int blk_rq_append_bio(struct request_queue *q, struct request *rq, |
| 13 | struct bio *bio) |
| 14 | { |
| 15 | if (!rq->bio) |
| 16 | blk_rq_bio_prep(q, rq, bio); |
| 17 | else if (!ll_back_merge_fn(q, rq, bio)) |
| 18 | return -EINVAL; |
| 19 | else { |
| 20 | rq->biotail->bi_next = bio; |
| 21 | rq->biotail = bio; |
| 22 | |
| 23 | rq->data_len += bio->bi_size; |
| 24 | } |
| 25 | return 0; |
| 26 | } |
| 27 | EXPORT_SYMBOL(blk_rq_append_bio); |
| 28 | |
| 29 | static int __blk_rq_unmap_user(struct bio *bio) |
| 30 | { |
| 31 | int ret = 0; |
| 32 | |
| 33 | if (bio) { |
| 34 | if (bio_flagged(bio, BIO_USER_MAPPED)) |
| 35 | bio_unmap_user(bio); |
| 36 | else |
| 37 | ret = bio_uncopy_user(bio); |
| 38 | } |
| 39 | |
| 40 | return ret; |
| 41 | } |
| 42 | |
| 43 | static int __blk_rq_map_user(struct request_queue *q, struct request *rq, |
FUJITA Tomonori | 152e283 | 2008-08-28 16:17:06 +0900 | [diff] [blame] | 44 | struct rq_map_data *map_data, void __user *ubuf, |
FUJITA Tomonori | 8188276 | 2008-09-02 16:20:19 +0900 | [diff] [blame] | 45 | unsigned int len, int null_mapped, gfp_t gfp_mask) |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 46 | { |
| 47 | unsigned long uaddr; |
| 48 | struct bio *bio, *orig_bio; |
| 49 | int reading, ret; |
| 50 | |
| 51 | reading = rq_data_dir(rq) == READ; |
| 52 | |
| 53 | /* |
| 54 | * if alignment requirement is satisfied, map in user pages for |
| 55 | * direct dma. else, set up kernel bounce buffers |
| 56 | */ |
| 57 | uaddr = (unsigned long) ubuf; |
FUJITA Tomonori | 8790407 | 2008-08-28 15:05:58 +0900 | [diff] [blame] | 58 | if (blk_rq_aligned(q, ubuf, len) && !map_data) |
FUJITA Tomonori | a3bce90 | 2008-08-28 16:17:05 +0900 | [diff] [blame] | 59 | bio = bio_map_user(q, NULL, uaddr, len, reading, gfp_mask); |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 60 | else |
FUJITA Tomonori | 152e283 | 2008-08-28 16:17:06 +0900 | [diff] [blame] | 61 | bio = bio_copy_user(q, map_data, uaddr, len, reading, gfp_mask); |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 62 | |
| 63 | if (IS_ERR(bio)) |
| 64 | return PTR_ERR(bio); |
| 65 | |
FUJITA Tomonori | 8188276 | 2008-09-02 16:20:19 +0900 | [diff] [blame] | 66 | if (null_mapped) |
| 67 | bio->bi_flags |= (1 << BIO_NULL_MAPPED); |
| 68 | |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 69 | orig_bio = bio; |
| 70 | blk_queue_bounce(q, &bio); |
| 71 | |
| 72 | /* |
| 73 | * We link the bounce buffer in and could have to traverse it |
| 74 | * later so we have to get a ref to prevent it from being freed |
| 75 | */ |
| 76 | bio_get(bio); |
| 77 | |
| 78 | ret = blk_rq_append_bio(q, rq, bio); |
| 79 | if (!ret) |
| 80 | return bio->bi_size; |
| 81 | |
| 82 | /* if it was boucned we must call the end io function */ |
| 83 | bio_endio(bio, 0); |
| 84 | __blk_rq_unmap_user(orig_bio); |
| 85 | bio_put(bio); |
| 86 | return ret; |
| 87 | } |
| 88 | |
| 89 | /** |
Randy Dunlap | 710027a | 2008-08-19 20:13:11 +0200 | [diff] [blame] | 90 | * blk_rq_map_user - map user data to a request, for REQ_TYPE_BLOCK_PC usage |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 91 | * @q: request queue where request should be inserted |
| 92 | * @rq: request structure to fill |
FUJITA Tomonori | 152e283 | 2008-08-28 16:17:06 +0900 | [diff] [blame] | 93 | * @map_data: pointer to the rq_map_data holding pages (if necessary) |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 94 | * @ubuf: the user buffer |
| 95 | * @len: length of user data |
FUJITA Tomonori | a3bce90 | 2008-08-28 16:17:05 +0900 | [diff] [blame] | 96 | * @gfp_mask: memory allocation flags |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 97 | * |
| 98 | * Description: |
Randy Dunlap | 710027a | 2008-08-19 20:13:11 +0200 | [diff] [blame] | 99 | * Data will be mapped directly for zero copy I/O, if possible. Otherwise |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 100 | * a kernel bounce buffer is used. |
| 101 | * |
Randy Dunlap | 710027a | 2008-08-19 20:13:11 +0200 | [diff] [blame] | 102 | * A matching blk_rq_unmap_user() must be issued at the end of I/O, while |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 103 | * still in process context. |
| 104 | * |
| 105 | * Note: The mapped bio may need to be bounced through blk_queue_bounce() |
| 106 | * before being submitted to the device, as pages mapped may be out of |
| 107 | * reach. It's the callers responsibility to make sure this happens. The |
| 108 | * original bio must be passed back in to blk_rq_unmap_user() for proper |
| 109 | * unmapping. |
| 110 | */ |
| 111 | int blk_rq_map_user(struct request_queue *q, struct request *rq, |
FUJITA Tomonori | 152e283 | 2008-08-28 16:17:06 +0900 | [diff] [blame] | 112 | struct rq_map_data *map_data, void __user *ubuf, |
| 113 | unsigned long len, gfp_t gfp_mask) |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 114 | { |
| 115 | unsigned long bytes_read = 0; |
| 116 | struct bio *bio = NULL; |
FUJITA Tomonori | 8188276 | 2008-09-02 16:20:19 +0900 | [diff] [blame] | 117 | int ret, null_mapped = 0; |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 118 | |
| 119 | if (len > (q->max_hw_sectors << 9)) |
| 120 | return -EINVAL; |
FUJITA Tomonori | 8188276 | 2008-09-02 16:20:19 +0900 | [diff] [blame] | 121 | if (!len) |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 122 | return -EINVAL; |
FUJITA Tomonori | 8188276 | 2008-09-02 16:20:19 +0900 | [diff] [blame] | 123 | if (!ubuf) { |
| 124 | if (!map_data || rq_data_dir(rq) != READ) |
| 125 | return -EINVAL; |
| 126 | null_mapped = 1; |
| 127 | } |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 128 | |
| 129 | while (bytes_read != len) { |
| 130 | unsigned long map_len, end, start; |
| 131 | |
| 132 | map_len = min_t(unsigned long, len - bytes_read, BIO_MAX_SIZE); |
| 133 | end = ((unsigned long)ubuf + map_len + PAGE_SIZE - 1) |
| 134 | >> PAGE_SHIFT; |
| 135 | start = (unsigned long)ubuf >> PAGE_SHIFT; |
| 136 | |
| 137 | /* |
| 138 | * A bad offset could cause us to require BIO_MAX_PAGES + 1 |
| 139 | * pages. If this happens we just lower the requested |
| 140 | * mapping len by a page so that we can fit |
| 141 | */ |
| 142 | if (end - start > BIO_MAX_PAGES) |
| 143 | map_len -= PAGE_SIZE; |
| 144 | |
FUJITA Tomonori | 152e283 | 2008-08-28 16:17:06 +0900 | [diff] [blame] | 145 | ret = __blk_rq_map_user(q, rq, map_data, ubuf, map_len, |
FUJITA Tomonori | 8188276 | 2008-09-02 16:20:19 +0900 | [diff] [blame] | 146 | null_mapped, gfp_mask); |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 147 | if (ret < 0) |
| 148 | goto unmap_rq; |
| 149 | if (!bio) |
| 150 | bio = rq->bio; |
| 151 | bytes_read += ret; |
| 152 | ubuf += ret; |
| 153 | } |
| 154 | |
FUJITA Tomonori | f18573a | 2008-04-11 12:56:52 +0200 | [diff] [blame] | 155 | if (!bio_flagged(bio, BIO_USER_MAPPED)) |
| 156 | rq->cmd_flags |= REQ_COPY_USER; |
Tejun Heo | 40b01b9 | 2008-02-19 11:35:38 +0100 | [diff] [blame] | 157 | |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 158 | rq->buffer = rq->data = NULL; |
| 159 | return 0; |
| 160 | unmap_rq: |
| 161 | blk_rq_unmap_user(bio); |
Jens Axboe | 84e9e03 | 2008-02-18 13:51:56 +0100 | [diff] [blame] | 162 | rq->bio = NULL; |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 163 | return ret; |
| 164 | } |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 165 | EXPORT_SYMBOL(blk_rq_map_user); |
| 166 | |
| 167 | /** |
Randy Dunlap | 710027a | 2008-08-19 20:13:11 +0200 | [diff] [blame] | 168 | * blk_rq_map_user_iov - map user data to a request, for REQ_TYPE_BLOCK_PC usage |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 169 | * @q: request queue where request should be inserted |
| 170 | * @rq: request to map data to |
FUJITA Tomonori | 152e283 | 2008-08-28 16:17:06 +0900 | [diff] [blame] | 171 | * @map_data: pointer to the rq_map_data holding pages (if necessary) |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 172 | * @iov: pointer to the iovec |
| 173 | * @iov_count: number of elements in the iovec |
| 174 | * @len: I/O byte count |
FUJITA Tomonori | a3bce90 | 2008-08-28 16:17:05 +0900 | [diff] [blame] | 175 | * @gfp_mask: memory allocation flags |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 176 | * |
| 177 | * Description: |
Randy Dunlap | 710027a | 2008-08-19 20:13:11 +0200 | [diff] [blame] | 178 | * Data will be mapped directly for zero copy I/O, if possible. Otherwise |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 179 | * a kernel bounce buffer is used. |
| 180 | * |
Randy Dunlap | 710027a | 2008-08-19 20:13:11 +0200 | [diff] [blame] | 181 | * A matching blk_rq_unmap_user() must be issued at the end of I/O, while |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 182 | * still in process context. |
| 183 | * |
| 184 | * Note: The mapped bio may need to be bounced through blk_queue_bounce() |
| 185 | * before being submitted to the device, as pages mapped may be out of |
| 186 | * reach. It's the callers responsibility to make sure this happens. The |
| 187 | * original bio must be passed back in to blk_rq_unmap_user() for proper |
| 188 | * unmapping. |
| 189 | */ |
| 190 | int blk_rq_map_user_iov(struct request_queue *q, struct request *rq, |
FUJITA Tomonori | 152e283 | 2008-08-28 16:17:06 +0900 | [diff] [blame] | 191 | struct rq_map_data *map_data, struct sg_iovec *iov, |
| 192 | int iov_count, unsigned int len, gfp_t gfp_mask) |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 193 | { |
| 194 | struct bio *bio; |
FUJITA Tomonori | afdc1a7 | 2008-04-11 12:56:51 +0200 | [diff] [blame] | 195 | int i, read = rq_data_dir(rq) == READ; |
| 196 | int unaligned = 0; |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 197 | |
| 198 | if (!iov || iov_count <= 0) |
| 199 | return -EINVAL; |
| 200 | |
FUJITA Tomonori | afdc1a7 | 2008-04-11 12:56:51 +0200 | [diff] [blame] | 201 | for (i = 0; i < iov_count; i++) { |
| 202 | unsigned long uaddr = (unsigned long)iov[i].iov_base; |
| 203 | |
| 204 | if (uaddr & queue_dma_alignment(q)) { |
| 205 | unaligned = 1; |
| 206 | break; |
| 207 | } |
| 208 | } |
| 209 | |
FUJITA Tomonori | 152e283 | 2008-08-28 16:17:06 +0900 | [diff] [blame] | 210 | if (unaligned || (q->dma_pad_mask & len) || map_data) |
| 211 | bio = bio_copy_user_iov(q, map_data, iov, iov_count, read, |
| 212 | gfp_mask); |
FUJITA Tomonori | afdc1a7 | 2008-04-11 12:56:51 +0200 | [diff] [blame] | 213 | else |
FUJITA Tomonori | a3bce90 | 2008-08-28 16:17:05 +0900 | [diff] [blame] | 214 | bio = bio_map_user_iov(q, NULL, iov, iov_count, read, gfp_mask); |
FUJITA Tomonori | afdc1a7 | 2008-04-11 12:56:51 +0200 | [diff] [blame] | 215 | |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 216 | if (IS_ERR(bio)) |
| 217 | return PTR_ERR(bio); |
| 218 | |
| 219 | if (bio->bi_size != len) { |
Jens Axboe | c26156b | 2008-11-18 15:07:05 +0100 | [diff] [blame^] | 220 | /* |
| 221 | * Grab an extra reference to this bio, as bio_unmap_user() |
| 222 | * expects to be able to drop it twice as it happens on the |
| 223 | * normal IO completion path |
| 224 | */ |
| 225 | bio_get(bio); |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 226 | bio_endio(bio, 0); |
| 227 | bio_unmap_user(bio); |
| 228 | return -EINVAL; |
| 229 | } |
| 230 | |
FUJITA Tomonori | f18573a | 2008-04-11 12:56:52 +0200 | [diff] [blame] | 231 | if (!bio_flagged(bio, BIO_USER_MAPPED)) |
| 232 | rq->cmd_flags |= REQ_COPY_USER; |
| 233 | |
FUJITA Tomonori | 07359fc | 2008-06-26 19:39:23 +0200 | [diff] [blame] | 234 | blk_queue_bounce(q, &bio); |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 235 | bio_get(bio); |
| 236 | blk_rq_bio_prep(q, rq, bio); |
| 237 | rq->buffer = rq->data = NULL; |
| 238 | return 0; |
| 239 | } |
FUJITA Tomonori | 152e283 | 2008-08-28 16:17:06 +0900 | [diff] [blame] | 240 | EXPORT_SYMBOL(blk_rq_map_user_iov); |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 241 | |
| 242 | /** |
| 243 | * blk_rq_unmap_user - unmap a request with user data |
| 244 | * @bio: start of bio list |
| 245 | * |
| 246 | * Description: |
| 247 | * Unmap a rq previously mapped by blk_rq_map_user(). The caller must |
| 248 | * supply the original rq->bio from the blk_rq_map_user() return, since |
Randy Dunlap | 710027a | 2008-08-19 20:13:11 +0200 | [diff] [blame] | 249 | * the I/O completion may have changed rq->bio. |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 250 | */ |
| 251 | int blk_rq_unmap_user(struct bio *bio) |
| 252 | { |
| 253 | struct bio *mapped_bio; |
| 254 | int ret = 0, ret2; |
| 255 | |
| 256 | while (bio) { |
| 257 | mapped_bio = bio; |
| 258 | if (unlikely(bio_flagged(bio, BIO_BOUNCED))) |
| 259 | mapped_bio = bio->bi_private; |
| 260 | |
| 261 | ret2 = __blk_rq_unmap_user(mapped_bio); |
| 262 | if (ret2 && !ret) |
| 263 | ret = ret2; |
| 264 | |
| 265 | mapped_bio = bio; |
| 266 | bio = bio->bi_next; |
| 267 | bio_put(mapped_bio); |
| 268 | } |
| 269 | |
| 270 | return ret; |
| 271 | } |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 272 | EXPORT_SYMBOL(blk_rq_unmap_user); |
| 273 | |
| 274 | /** |
Randy Dunlap | 710027a | 2008-08-19 20:13:11 +0200 | [diff] [blame] | 275 | * blk_rq_map_kern - map kernel data to a request, for REQ_TYPE_BLOCK_PC usage |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 276 | * @q: request queue where request should be inserted |
| 277 | * @rq: request to fill |
| 278 | * @kbuf: the kernel buffer |
| 279 | * @len: length of user data |
| 280 | * @gfp_mask: memory allocation flags |
FUJITA Tomonori | 68154e9 | 2008-04-25 12:47:50 +0200 | [diff] [blame] | 281 | * |
| 282 | * Description: |
| 283 | * Data will be mapped directly if possible. Otherwise a bounce |
| 284 | * buffer is used. |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 285 | */ |
| 286 | int blk_rq_map_kern(struct request_queue *q, struct request *rq, void *kbuf, |
| 287 | unsigned int len, gfp_t gfp_mask) |
| 288 | { |
FUJITA Tomonori | 68154e9 | 2008-04-25 12:47:50 +0200 | [diff] [blame] | 289 | int reading = rq_data_dir(rq) == READ; |
| 290 | int do_copy = 0; |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 291 | struct bio *bio; |
| 292 | |
| 293 | if (len > (q->max_hw_sectors << 9)) |
| 294 | return -EINVAL; |
| 295 | if (!len || !kbuf) |
| 296 | return -EINVAL; |
| 297 | |
FUJITA Tomonori | 8790407 | 2008-08-28 15:05:58 +0900 | [diff] [blame] | 298 | do_copy = !blk_rq_aligned(q, kbuf, len) || object_is_on_stack(kbuf); |
FUJITA Tomonori | 68154e9 | 2008-04-25 12:47:50 +0200 | [diff] [blame] | 299 | if (do_copy) |
| 300 | bio = bio_copy_kern(q, kbuf, len, gfp_mask, reading); |
| 301 | else |
| 302 | bio = bio_map_kern(q, kbuf, len, gfp_mask); |
| 303 | |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 304 | if (IS_ERR(bio)) |
| 305 | return PTR_ERR(bio); |
| 306 | |
| 307 | if (rq_data_dir(rq) == WRITE) |
| 308 | bio->bi_rw |= (1 << BIO_RW); |
| 309 | |
FUJITA Tomonori | 68154e9 | 2008-04-25 12:47:50 +0200 | [diff] [blame] | 310 | if (do_copy) |
| 311 | rq->cmd_flags |= REQ_COPY_USER; |
| 312 | |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 313 | blk_rq_bio_prep(q, rq, bio); |
| 314 | blk_queue_bounce(q, &rq->bio); |
| 315 | rq->buffer = rq->data = NULL; |
| 316 | return 0; |
| 317 | } |
Jens Axboe | 86db1e2 | 2008-01-29 14:53:40 +0100 | [diff] [blame] | 318 | EXPORT_SYMBOL(blk_rq_map_kern); |