block: make blk_rq_map_user() clear ->bio if it unmaps it
[linux-2.6.git] / block / blk-map.c
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>
8
9 #include "blk.h"
10
11 int blk_rq_append_bio(struct request_queue *q, struct request *rq,
12                       struct bio *bio)
13 {
14         if (!rq->bio)
15                 blk_rq_bio_prep(q, rq, bio);
16         else if (!ll_back_merge_fn(q, rq, bio))
17                 return -EINVAL;
18         else {
19                 rq->biotail->bi_next = bio;
20                 rq->biotail = bio;
21
22                 rq->data_len += bio->bi_size;
23         }
24         return 0;
25 }
26 EXPORT_SYMBOL(blk_rq_append_bio);
27
28 static int __blk_rq_unmap_user(struct bio *bio)
29 {
30         int ret = 0;
31
32         if (bio) {
33                 if (bio_flagged(bio, BIO_USER_MAPPED))
34                         bio_unmap_user(bio);
35                 else
36                         ret = bio_uncopy_user(bio);
37         }
38
39         return ret;
40 }
41
42 static int __blk_rq_map_user(struct request_queue *q, struct request *rq,
43                              void __user *ubuf, unsigned int len)
44 {
45         unsigned long uaddr;
46         struct bio *bio, *orig_bio;
47         int reading, ret;
48
49         reading = rq_data_dir(rq) == READ;
50
51         /*
52          * if alignment requirement is satisfied, map in user pages for
53          * direct dma. else, set up kernel bounce buffers
54          */
55         uaddr = (unsigned long) ubuf;
56         if (!(uaddr & queue_dma_alignment(q)) &&
57             !(len & queue_dma_alignment(q)))
58                 bio = bio_map_user(q, NULL, uaddr, len, reading);
59         else
60                 bio = bio_copy_user(q, uaddr, len, reading);
61
62         if (IS_ERR(bio))
63                 return PTR_ERR(bio);
64
65         orig_bio = bio;
66         blk_queue_bounce(q, &bio);
67
68         /*
69          * We link the bounce buffer in and could have to traverse it
70          * later so we have to get a ref to prevent it from being freed
71          */
72         bio_get(bio);
73
74         ret = blk_rq_append_bio(q, rq, bio);
75         if (!ret)
76                 return bio->bi_size;
77
78         /* if it was boucned we must call the end io function */
79         bio_endio(bio, 0);
80         __blk_rq_unmap_user(orig_bio);
81         bio_put(bio);
82         return ret;
83 }
84
85 /**
86  * blk_rq_map_user - map user data to a request, for REQ_BLOCK_PC usage
87  * @q:          request queue where request should be inserted
88  * @rq:         request structure to fill
89  * @ubuf:       the user buffer
90  * @len:        length of user data
91  *
92  * Description:
93  *    Data will be mapped directly for zero copy io, if possible. Otherwise
94  *    a kernel bounce buffer is used.
95  *
96  *    A matching blk_rq_unmap_user() must be issued at the end of io, while
97  *    still in process context.
98  *
99  *    Note: The mapped bio may need to be bounced through blk_queue_bounce()
100  *    before being submitted to the device, as pages mapped may be out of
101  *    reach. It's the callers responsibility to make sure this happens. The
102  *    original bio must be passed back in to blk_rq_unmap_user() for proper
103  *    unmapping.
104  */
105 int blk_rq_map_user(struct request_queue *q, struct request *rq,
106                     void __user *ubuf, unsigned long len)
107 {
108         unsigned long bytes_read = 0;
109         struct bio *bio = NULL;
110         int ret;
111
112         if (len > (q->max_hw_sectors << 9))
113                 return -EINVAL;
114         if (!len || !ubuf)
115                 return -EINVAL;
116
117         while (bytes_read != len) {
118                 unsigned long map_len, end, start;
119
120                 map_len = min_t(unsigned long, len - bytes_read, BIO_MAX_SIZE);
121                 end = ((unsigned long)ubuf + map_len + PAGE_SIZE - 1)
122                                                                 >> PAGE_SHIFT;
123                 start = (unsigned long)ubuf >> PAGE_SHIFT;
124
125                 /*
126                  * A bad offset could cause us to require BIO_MAX_PAGES + 1
127                  * pages. If this happens we just lower the requested
128                  * mapping len by a page so that we can fit
129                  */
130                 if (end - start > BIO_MAX_PAGES)
131                         map_len -= PAGE_SIZE;
132
133                 ret = __blk_rq_map_user(q, rq, ubuf, map_len);
134                 if (ret < 0)
135                         goto unmap_rq;
136                 if (!bio)
137                         bio = rq->bio;
138                 bytes_read += ret;
139                 ubuf += ret;
140         }
141
142         rq->buffer = rq->data = NULL;
143         return 0;
144 unmap_rq:
145         blk_rq_unmap_user(bio);
146         rq->bio = NULL;
147         return ret;
148 }
149 EXPORT_SYMBOL(blk_rq_map_user);
150
151 /**
152  * blk_rq_map_user_iov - map user data to a request, for REQ_BLOCK_PC usage
153  * @q:          request queue where request should be inserted
154  * @rq:         request to map data to
155  * @iov:        pointer to the iovec
156  * @iov_count:  number of elements in the iovec
157  * @len:        I/O byte count
158  *
159  * Description:
160  *    Data will be mapped directly for zero copy io, if possible. Otherwise
161  *    a kernel bounce buffer is used.
162  *
163  *    A matching blk_rq_unmap_user() must be issued at the end of io, while
164  *    still in process context.
165  *
166  *    Note: The mapped bio may need to be bounced through blk_queue_bounce()
167  *    before being submitted to the device, as pages mapped may be out of
168  *    reach. It's the callers responsibility to make sure this happens. The
169  *    original bio must be passed back in to blk_rq_unmap_user() for proper
170  *    unmapping.
171  */
172 int blk_rq_map_user_iov(struct request_queue *q, struct request *rq,
173                         struct sg_iovec *iov, int iov_count, unsigned int len)
174 {
175         struct bio *bio;
176
177         if (!iov || iov_count <= 0)
178                 return -EINVAL;
179
180         /* we don't allow misaligned data like bio_map_user() does.  If the
181          * user is using sg, they're expected to know the alignment constraints
182          * and respect them accordingly */
183         bio = bio_map_user_iov(q, NULL, iov, iov_count,
184                                 rq_data_dir(rq) == READ);
185         if (IS_ERR(bio))
186                 return PTR_ERR(bio);
187
188         if (bio->bi_size != len) {
189                 bio_endio(bio, 0);
190                 bio_unmap_user(bio);
191                 return -EINVAL;
192         }
193
194         bio_get(bio);
195         blk_rq_bio_prep(q, rq, bio);
196         rq->buffer = rq->data = NULL;
197         return 0;
198 }
199 EXPORT_SYMBOL(blk_rq_map_user_iov);
200
201 /**
202  * blk_rq_unmap_user - unmap a request with user data
203  * @bio:               start of bio list
204  *
205  * Description:
206  *    Unmap a rq previously mapped by blk_rq_map_user(). The caller must
207  *    supply the original rq->bio from the blk_rq_map_user() return, since
208  *    the io completion may have changed rq->bio.
209  */
210 int blk_rq_unmap_user(struct bio *bio)
211 {
212         struct bio *mapped_bio;
213         int ret = 0, ret2;
214
215         while (bio) {
216                 mapped_bio = bio;
217                 if (unlikely(bio_flagged(bio, BIO_BOUNCED)))
218                         mapped_bio = bio->bi_private;
219
220                 ret2 = __blk_rq_unmap_user(mapped_bio);
221                 if (ret2 && !ret)
222                         ret = ret2;
223
224                 mapped_bio = bio;
225                 bio = bio->bi_next;
226                 bio_put(mapped_bio);
227         }
228
229         return ret;
230 }
231 EXPORT_SYMBOL(blk_rq_unmap_user);
232
233 /**
234  * blk_rq_map_kern - map kernel data to a request, for REQ_BLOCK_PC usage
235  * @q:          request queue where request should be inserted
236  * @rq:         request to fill
237  * @kbuf:       the kernel buffer
238  * @len:        length of user data
239  * @gfp_mask:   memory allocation flags
240  */
241 int blk_rq_map_kern(struct request_queue *q, struct request *rq, void *kbuf,
242                     unsigned int len, gfp_t gfp_mask)
243 {
244         struct bio *bio;
245
246         if (len > (q->max_hw_sectors << 9))
247                 return -EINVAL;
248         if (!len || !kbuf)
249                 return -EINVAL;
250
251         bio = bio_map_kern(q, kbuf, len, gfp_mask);
252         if (IS_ERR(bio))
253                 return PTR_ERR(bio);
254
255         if (rq_data_dir(rq) == WRITE)
256                 bio->bi_rw |= (1 << BIO_RW);
257
258         blk_rq_bio_prep(q, rq, bio);
259         blk_queue_bounce(q, &rq->bio);
260         rq->buffer = rq->data = NULL;
261         return 0;
262 }
263 EXPORT_SYMBOL(blk_rq_map_kern);