186db1e29SJens Axboe /* 286db1e29SJens Axboe * Functions related to mapping data to requests 386db1e29SJens Axboe */ 486db1e29SJens Axboe #include <linux/kernel.h> 586db1e29SJens Axboe #include <linux/module.h> 686db1e29SJens Axboe #include <linux/bio.h> 786db1e29SJens Axboe #include <linux/blkdev.h> 886db1e29SJens Axboe 986db1e29SJens Axboe #include "blk.h" 1086db1e29SJens Axboe 1186db1e29SJens Axboe int blk_rq_append_bio(struct request_queue *q, struct request *rq, 1286db1e29SJens Axboe struct bio *bio) 1386db1e29SJens Axboe { 1486db1e29SJens Axboe if (!rq->bio) 1586db1e29SJens Axboe blk_rq_bio_prep(q, rq, bio); 1686db1e29SJens Axboe else if (!ll_back_merge_fn(q, rq, bio)) 1786db1e29SJens Axboe return -EINVAL; 1886db1e29SJens Axboe else { 1986db1e29SJens Axboe rq->biotail->bi_next = bio; 2086db1e29SJens Axboe rq->biotail = bio; 2186db1e29SJens Axboe 2286db1e29SJens Axboe rq->data_len += bio->bi_size; 2386db1e29SJens Axboe } 2486db1e29SJens Axboe return 0; 2586db1e29SJens Axboe } 2686db1e29SJens Axboe EXPORT_SYMBOL(blk_rq_append_bio); 2786db1e29SJens Axboe 2886db1e29SJens Axboe static int __blk_rq_unmap_user(struct bio *bio) 2986db1e29SJens Axboe { 3086db1e29SJens Axboe int ret = 0; 3186db1e29SJens Axboe 3286db1e29SJens Axboe if (bio) { 3386db1e29SJens Axboe if (bio_flagged(bio, BIO_USER_MAPPED)) 3486db1e29SJens Axboe bio_unmap_user(bio); 3586db1e29SJens Axboe else 3686db1e29SJens Axboe ret = bio_uncopy_user(bio); 3786db1e29SJens Axboe } 3886db1e29SJens Axboe 3986db1e29SJens Axboe return ret; 4086db1e29SJens Axboe } 4186db1e29SJens Axboe 4286db1e29SJens Axboe static int __blk_rq_map_user(struct request_queue *q, struct request *rq, 4386db1e29SJens Axboe void __user *ubuf, unsigned int len) 4486db1e29SJens Axboe { 4586db1e29SJens Axboe unsigned long uaddr; 4686db1e29SJens Axboe struct bio *bio, *orig_bio; 4786db1e29SJens Axboe int reading, ret; 4886db1e29SJens Axboe 4986db1e29SJens Axboe reading = rq_data_dir(rq) == READ; 5086db1e29SJens Axboe 5186db1e29SJens Axboe /* 5286db1e29SJens Axboe * if alignment requirement is satisfied, map in user pages for 5386db1e29SJens Axboe * direct dma. else, set up kernel bounce buffers 5486db1e29SJens Axboe */ 5586db1e29SJens Axboe uaddr = (unsigned long) ubuf; 5686db1e29SJens Axboe if (!(uaddr & queue_dma_alignment(q)) && !(len & queue_dma_alignment(q))) 5786db1e29SJens Axboe bio = bio_map_user(q, NULL, uaddr, len, reading); 5886db1e29SJens Axboe else 5986db1e29SJens Axboe bio = bio_copy_user(q, uaddr, len, reading); 6086db1e29SJens Axboe 6186db1e29SJens Axboe if (IS_ERR(bio)) 6286db1e29SJens Axboe return PTR_ERR(bio); 6386db1e29SJens Axboe 6486db1e29SJens Axboe orig_bio = bio; 6586db1e29SJens Axboe blk_queue_bounce(q, &bio); 6686db1e29SJens Axboe 6786db1e29SJens Axboe /* 6886db1e29SJens Axboe * We link the bounce buffer in and could have to traverse it 6986db1e29SJens Axboe * later so we have to get a ref to prevent it from being freed 7086db1e29SJens Axboe */ 7186db1e29SJens Axboe bio_get(bio); 7286db1e29SJens Axboe 7386db1e29SJens Axboe ret = blk_rq_append_bio(q, rq, bio); 7486db1e29SJens Axboe if (!ret) 7586db1e29SJens Axboe return bio->bi_size; 7686db1e29SJens Axboe 7786db1e29SJens Axboe /* if it was boucned we must call the end io function */ 7886db1e29SJens Axboe bio_endio(bio, 0); 7986db1e29SJens Axboe __blk_rq_unmap_user(orig_bio); 8086db1e29SJens Axboe bio_put(bio); 8186db1e29SJens Axboe return ret; 8286db1e29SJens Axboe } 8386db1e29SJens Axboe 8486db1e29SJens Axboe /** 8586db1e29SJens Axboe * blk_rq_map_user - map user data to a request, for REQ_BLOCK_PC usage 8686db1e29SJens Axboe * @q: request queue where request should be inserted 8786db1e29SJens Axboe * @rq: request structure to fill 8886db1e29SJens Axboe * @ubuf: the user buffer 8986db1e29SJens Axboe * @len: length of user data 9086db1e29SJens Axboe * 9186db1e29SJens Axboe * Description: 9286db1e29SJens Axboe * Data will be mapped directly for zero copy io, if possible. Otherwise 9386db1e29SJens Axboe * a kernel bounce buffer is used. 9486db1e29SJens Axboe * 9586db1e29SJens Axboe * A matching blk_rq_unmap_user() must be issued at the end of io, while 9686db1e29SJens Axboe * still in process context. 9786db1e29SJens Axboe * 9886db1e29SJens Axboe * Note: The mapped bio may need to be bounced through blk_queue_bounce() 9986db1e29SJens Axboe * before being submitted to the device, as pages mapped may be out of 10086db1e29SJens Axboe * reach. It's the callers responsibility to make sure this happens. The 10186db1e29SJens Axboe * original bio must be passed back in to blk_rq_unmap_user() for proper 10286db1e29SJens Axboe * unmapping. 10386db1e29SJens Axboe */ 10486db1e29SJens Axboe int blk_rq_map_user(struct request_queue *q, struct request *rq, 10586db1e29SJens Axboe void __user *ubuf, unsigned long len) 10686db1e29SJens Axboe { 10786db1e29SJens Axboe unsigned long bytes_read = 0; 10886db1e29SJens Axboe struct bio *bio = NULL; 10986db1e29SJens Axboe int ret; 11086db1e29SJens Axboe 11186db1e29SJens Axboe if (len > (q->max_hw_sectors << 9)) 11286db1e29SJens Axboe return -EINVAL; 11386db1e29SJens Axboe if (!len || !ubuf) 11486db1e29SJens Axboe return -EINVAL; 11586db1e29SJens Axboe 11686db1e29SJens Axboe while (bytes_read != len) { 11786db1e29SJens Axboe unsigned long map_len, end, start; 11886db1e29SJens Axboe 11986db1e29SJens Axboe map_len = min_t(unsigned long, len - bytes_read, BIO_MAX_SIZE); 12086db1e29SJens Axboe end = ((unsigned long)ubuf + map_len + PAGE_SIZE - 1) 12186db1e29SJens Axboe >> PAGE_SHIFT; 12286db1e29SJens Axboe start = (unsigned long)ubuf >> PAGE_SHIFT; 12386db1e29SJens Axboe 12486db1e29SJens Axboe /* 12586db1e29SJens Axboe * A bad offset could cause us to require BIO_MAX_PAGES + 1 12686db1e29SJens Axboe * pages. If this happens we just lower the requested 12786db1e29SJens Axboe * mapping len by a page so that we can fit 12886db1e29SJens Axboe */ 12986db1e29SJens Axboe if (end - start > BIO_MAX_PAGES) 13086db1e29SJens Axboe map_len -= PAGE_SIZE; 13186db1e29SJens Axboe 13286db1e29SJens Axboe ret = __blk_rq_map_user(q, rq, ubuf, map_len); 13386db1e29SJens Axboe if (ret < 0) 13486db1e29SJens Axboe goto unmap_rq; 13586db1e29SJens Axboe if (!bio) 13686db1e29SJens Axboe bio = rq->bio; 13786db1e29SJens Axboe bytes_read += ret; 13886db1e29SJens Axboe ubuf += ret; 13986db1e29SJens Axboe } 14086db1e29SJens Axboe 14186db1e29SJens Axboe rq->buffer = rq->data = NULL; 14286db1e29SJens Axboe return 0; 14386db1e29SJens Axboe unmap_rq: 14486db1e29SJens Axboe blk_rq_unmap_user(bio); 14586db1e29SJens Axboe return ret; 14686db1e29SJens Axboe } 14786db1e29SJens Axboe 14886db1e29SJens Axboe EXPORT_SYMBOL(blk_rq_map_user); 14986db1e29SJens Axboe 15086db1e29SJens Axboe /** 15186db1e29SJens Axboe * blk_rq_map_user_iov - map user data to a request, for REQ_BLOCK_PC usage 15286db1e29SJens Axboe * @q: request queue where request should be inserted 15386db1e29SJens Axboe * @rq: request to map data to 15486db1e29SJens Axboe * @iov: pointer to the iovec 15586db1e29SJens Axboe * @iov_count: number of elements in the iovec 15686db1e29SJens Axboe * @len: I/O byte count 15786db1e29SJens Axboe * 15886db1e29SJens Axboe * Description: 15986db1e29SJens Axboe * Data will be mapped directly for zero copy io, if possible. Otherwise 16086db1e29SJens Axboe * a kernel bounce buffer is used. 16186db1e29SJens Axboe * 16286db1e29SJens Axboe * A matching blk_rq_unmap_user() must be issued at the end of io, while 16386db1e29SJens Axboe * still in process context. 16486db1e29SJens Axboe * 16586db1e29SJens Axboe * Note: The mapped bio may need to be bounced through blk_queue_bounce() 16686db1e29SJens Axboe * before being submitted to the device, as pages mapped may be out of 16786db1e29SJens Axboe * reach. It's the callers responsibility to make sure this happens. The 16886db1e29SJens Axboe * original bio must be passed back in to blk_rq_unmap_user() for proper 16986db1e29SJens Axboe * unmapping. 17086db1e29SJens Axboe */ 17186db1e29SJens Axboe int blk_rq_map_user_iov(struct request_queue *q, struct request *rq, 17286db1e29SJens Axboe struct sg_iovec *iov, int iov_count, unsigned int len) 17386db1e29SJens Axboe { 17486db1e29SJens Axboe struct bio *bio; 17586db1e29SJens Axboe 17686db1e29SJens Axboe if (!iov || iov_count <= 0) 17786db1e29SJens Axboe return -EINVAL; 17886db1e29SJens Axboe 17986db1e29SJens Axboe /* we don't allow misaligned data like bio_map_user() does. If the 18086db1e29SJens Axboe * user is using sg, they're expected to know the alignment constraints 18186db1e29SJens Axboe * and respect them accordingly */ 18286db1e29SJens Axboe bio = bio_map_user_iov(q, NULL, iov, iov_count, rq_data_dir(rq)== READ); 18386db1e29SJens Axboe if (IS_ERR(bio)) 18486db1e29SJens Axboe return PTR_ERR(bio); 18586db1e29SJens Axboe 18686db1e29SJens Axboe if (bio->bi_size != len) { 18786db1e29SJens Axboe bio_endio(bio, 0); 18886db1e29SJens Axboe bio_unmap_user(bio); 18986db1e29SJens Axboe return -EINVAL; 19086db1e29SJens Axboe } 19186db1e29SJens Axboe 19286db1e29SJens Axboe bio_get(bio); 19386db1e29SJens Axboe blk_rq_bio_prep(q, rq, bio); 19486db1e29SJens Axboe rq->buffer = rq->data = NULL; 19586db1e29SJens Axboe return 0; 19686db1e29SJens Axboe } 19786db1e29SJens Axboe 19886db1e29SJens Axboe EXPORT_SYMBOL(blk_rq_map_user_iov); 19986db1e29SJens Axboe 20086db1e29SJens Axboe /** 20186db1e29SJens Axboe * blk_rq_unmap_user - unmap a request with user data 20286db1e29SJens Axboe * @bio: start of bio list 20386db1e29SJens Axboe * 20486db1e29SJens Axboe * Description: 20586db1e29SJens Axboe * Unmap a rq previously mapped by blk_rq_map_user(). The caller must 20686db1e29SJens Axboe * supply the original rq->bio from the blk_rq_map_user() return, since 20786db1e29SJens Axboe * the io completion may have changed rq->bio. 20886db1e29SJens Axboe */ 20986db1e29SJens Axboe int blk_rq_unmap_user(struct bio *bio) 21086db1e29SJens Axboe { 21186db1e29SJens Axboe struct bio *mapped_bio; 21286db1e29SJens Axboe int ret = 0, ret2; 21386db1e29SJens Axboe 21486db1e29SJens Axboe while (bio) { 21586db1e29SJens Axboe mapped_bio = bio; 21686db1e29SJens Axboe if (unlikely(bio_flagged(bio, BIO_BOUNCED))) 21786db1e29SJens Axboe mapped_bio = bio->bi_private; 21886db1e29SJens Axboe 21986db1e29SJens Axboe ret2 = __blk_rq_unmap_user(mapped_bio); 22086db1e29SJens Axboe if (ret2 && !ret) 22186db1e29SJens Axboe ret = ret2; 22286db1e29SJens Axboe 22386db1e29SJens Axboe mapped_bio = bio; 22486db1e29SJens Axboe bio = bio->bi_next; 22586db1e29SJens Axboe bio_put(mapped_bio); 22686db1e29SJens Axboe } 22786db1e29SJens Axboe 22886db1e29SJens Axboe return ret; 22986db1e29SJens Axboe } 23086db1e29SJens Axboe 23186db1e29SJens Axboe EXPORT_SYMBOL(blk_rq_unmap_user); 23286db1e29SJens Axboe 23386db1e29SJens Axboe /** 23486db1e29SJens Axboe * blk_rq_map_kern - map kernel data to a request, for REQ_BLOCK_PC usage 23586db1e29SJens Axboe * @q: request queue where request should be inserted 23686db1e29SJens Axboe * @rq: request to fill 23786db1e29SJens Axboe * @kbuf: the kernel buffer 23886db1e29SJens Axboe * @len: length of user data 23986db1e29SJens Axboe * @gfp_mask: memory allocation flags 24086db1e29SJens Axboe */ 24186db1e29SJens Axboe int blk_rq_map_kern(struct request_queue *q, struct request *rq, void *kbuf, 24286db1e29SJens Axboe unsigned int len, gfp_t gfp_mask) 24386db1e29SJens Axboe { 24486db1e29SJens Axboe struct bio *bio; 24586db1e29SJens Axboe 24686db1e29SJens Axboe if (len > (q->max_hw_sectors << 9)) 24786db1e29SJens Axboe return -EINVAL; 24886db1e29SJens Axboe if (!len || !kbuf) 24986db1e29SJens Axboe return -EINVAL; 25086db1e29SJens Axboe 25186db1e29SJens Axboe bio = bio_map_kern(q, kbuf, len, gfp_mask); 25286db1e29SJens Axboe if (IS_ERR(bio)) 25386db1e29SJens Axboe return PTR_ERR(bio); 25486db1e29SJens Axboe 25586db1e29SJens Axboe if (rq_data_dir(rq) == WRITE) 25686db1e29SJens Axboe bio->bi_rw |= (1 << BIO_RW); 25786db1e29SJens Axboe 25886db1e29SJens Axboe blk_rq_bio_prep(q, rq, bio); 25986db1e29SJens Axboe blk_queue_bounce(q, &rq->bio); 26086db1e29SJens Axboe rq->buffer = rq->data = NULL; 26186db1e29SJens Axboe return 0; 26286db1e29SJens Axboe } 26386db1e29SJens Axboe 26486db1e29SJens Axboe EXPORT_SYMBOL(blk_rq_map_kern); 265