blk-map.c 5.75 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
2 3 4 5
/*
 * Functions related to mapping data to requests
 */
#include <linux/kernel.h>
6
#include <linux/sched/task_stack.h>
7 8 9
#include <linux/module.h>
#include <linux/bio.h>
#include <linux/blkdev.h>
10
#include <linux/uio.h>
11 12 13

#include "blk.h"

14 15 16 17 18
/*
 * Append a bio to a passthrough request.  Only works can be merged into
 * the request based on the driver constraints.
 */
int blk_rq_append_bio(struct request *rq, struct bio *bio)
19
{
20 21
	blk_queue_bounce(rq->q, &bio);

22 23 24 25 26 27
	if (!rq->bio) {
		blk_rq_bio_prep(rq->q, rq, bio);
	} else {
		if (!ll_back_merge_fn(rq->q, rq, bio))
			return -EINVAL;

28 29
		rq->biotail->bi_next = bio;
		rq->biotail = bio;
30
		rq->__data_len += bio->bi_iter.bi_size;
31
	}
32

33 34
	return 0;
}
35
EXPORT_SYMBOL(blk_rq_append_bio);
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50

static int __blk_rq_unmap_user(struct bio *bio)
{
	int ret = 0;

	if (bio) {
		if (bio_flagged(bio, BIO_USER_MAPPED))
			bio_unmap_user(bio);
		else
			ret = bio_uncopy_user(bio);
	}

	return ret;
}

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
static int __blk_rq_map_user_iov(struct request *rq,
		struct rq_map_data *map_data, struct iov_iter *iter,
		gfp_t gfp_mask, bool copy)
{
	struct request_queue *q = rq->q;
	struct bio *bio, *orig_bio;
	int ret;

	if (copy)
		bio = bio_copy_user_iov(q, map_data, iter, gfp_mask);
	else
		bio = bio_map_user_iov(q, iter, gfp_mask);

	if (IS_ERR(bio))
		return PTR_ERR(bio);

67 68 69
	bio->bi_opf &= ~REQ_OP_MASK;
	bio->bi_opf |= req_op(rq);

70 71 72 73 74 75
	orig_bio = bio;

	/*
	 * We link the bounce buffer in and could have to traverse it
	 * later so we have to get a ref to prevent it from being freed
	 */
76
	ret = blk_rq_append_bio(rq, bio);
77
	bio_get(bio);
78 79 80 81 82 83 84 85 86 87
	if (ret) {
		bio_endio(bio);
		__blk_rq_unmap_user(orig_bio);
		bio_put(bio);
		return ret;
	}

	return 0;
}

88
/**
89
 * blk_rq_map_user_iov - map user data to a request, for passthrough requests
90 91
 * @q:		request queue where request should be inserted
 * @rq:		request to map data to
92
 * @map_data:   pointer to the rq_map_data holding pages (if necessary)
93
 * @iter:	iovec iterator
94
 * @gfp_mask:	memory allocation flags
95 96
 *
 * Description:
97
 *    Data will be mapped directly for zero copy I/O, if possible. Otherwise
98 99
 *    a kernel bounce buffer is used.
 *
100
 *    A matching blk_rq_unmap_user() must be issued at the end of I/O, while
101 102 103 104 105 106 107 108 109
 *    still in process context.
 *
 *    Note: The mapped bio may need to be bounced through blk_queue_bounce()
 *    before being submitted to the device, as pages mapped may be out of
 *    reach. It's the callers responsibility to make sure this happens. The
 *    original bio must be passed back in to blk_rq_unmap_user() for proper
 *    unmapping.
 */
int blk_rq_map_user_iov(struct request_queue *q, struct request *rq,
110 111
			struct rq_map_data *map_data,
			const struct iov_iter *iter, gfp_t gfp_mask)
112
{
113 114
	bool copy = false;
	unsigned long align = q->dma_pad_mask | queue_dma_alignment(q);
115 116 117
	struct bio *bio = NULL;
	struct iov_iter i;
	int ret;
118

119 120 121
	if (!iter_is_iovec(iter))
		goto fail;

122 123 124 125 126 127
	if (map_data)
		copy = true;
	else if (iov_iter_alignment(iter) & align)
		copy = true;
	else if (queue_virt_boundary(q))
		copy = queue_virt_boundary(q) & iov_iter_gap_alignment(iter);
128

129 130 131 132 133 134 135 136
	i = *iter;
	do {
		ret =__blk_rq_map_user_iov(rq, map_data, &i, gfp_mask, copy);
		if (ret)
			goto unmap_rq;
		if (!bio)
			bio = rq->bio;
	} while (iov_iter_count(&i));
137

138
	if (!bio_flagged(bio, BIO_USER_MAPPED))
139
		rq->rq_flags |= RQF_COPY_USER;
140
	return 0;
141 142 143

unmap_rq:
	__blk_rq_unmap_user(bio);
144
fail:
145 146
	rq->bio = NULL;
	return -EINVAL;
147
}
148
EXPORT_SYMBOL(blk_rq_map_user_iov);
149

150 151 152 153
int blk_rq_map_user(struct request_queue *q, struct request *rq,
		    struct rq_map_data *map_data, void __user *ubuf,
		    unsigned long len, gfp_t gfp_mask)
{
154 155
	struct iovec iov;
	struct iov_iter i;
156
	int ret = import_single_range(rq_data_dir(rq), ubuf, len, &iov, &i);
157

158 159
	if (unlikely(ret < 0))
		return ret;
160

161
	return blk_rq_map_user_iov(q, rq, map_data, &i, gfp_mask);
162 163 164
}
EXPORT_SYMBOL(blk_rq_map_user);

165 166 167 168 169 170 171
/**
 * blk_rq_unmap_user - unmap a request with user data
 * @bio:	       start of bio list
 *
 * Description:
 *    Unmap a rq previously mapped by blk_rq_map_user(). The caller must
 *    supply the original rq->bio from the blk_rq_map_user() return, since
172
 *    the I/O completion may have changed rq->bio.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
 */
int blk_rq_unmap_user(struct bio *bio)
{
	struct bio *mapped_bio;
	int ret = 0, ret2;

	while (bio) {
		mapped_bio = bio;
		if (unlikely(bio_flagged(bio, BIO_BOUNCED)))
			mapped_bio = bio->bi_private;

		ret2 = __blk_rq_unmap_user(mapped_bio);
		if (ret2 && !ret)
			ret = ret2;

		mapped_bio = bio;
		bio = bio->bi_next;
		bio_put(mapped_bio);
	}

	return ret;
}
EXPORT_SYMBOL(blk_rq_unmap_user);

/**
198
 * blk_rq_map_kern - map kernel data to a request, for passthrough requests
199 200 201 202 203
 * @q:		request queue where request should be inserted
 * @rq:		request to fill
 * @kbuf:	the kernel buffer
 * @len:	length of user data
 * @gfp_mask:	memory allocation flags
204 205 206
 *
 * Description:
 *    Data will be mapped directly if possible. Otherwise a bounce
207
 *    buffer is used. Can be called multiple times to append multiple
208
 *    buffers.
209 210 211 212
 */
int blk_rq_map_kern(struct request_queue *q, struct request *rq, void *kbuf,
		    unsigned int len, gfp_t gfp_mask)
{
213
	int reading = rq_data_dir(rq) == READ;
214
	unsigned long addr = (unsigned long) kbuf;
215
	int do_copy = 0;
216
	struct bio *bio;
217
	int ret;
218

219
	if (len > (queue_max_hw_sectors(q) << 9))
220 221 222 223
		return -EINVAL;
	if (!len || !kbuf)
		return -EINVAL;

224
	do_copy = !blk_rq_aligned(q, addr, len) || object_is_on_stack(kbuf);
225 226 227 228 229
	if (do_copy)
		bio = bio_copy_kern(q, kbuf, len, gfp_mask, reading);
	else
		bio = bio_map_kern(q, kbuf, len, gfp_mask);

230 231 232
	if (IS_ERR(bio))
		return PTR_ERR(bio);

233 234
	bio->bi_opf &= ~REQ_OP_MASK;
	bio->bi_opf |= req_op(rq);
235

236
	if (do_copy)
237
		rq->rq_flags |= RQF_COPY_USER;
238

239
	ret = blk_rq_append_bio(rq, bio);
240 241 242 243 244 245
	if (unlikely(ret)) {
		/* request is too big */
		bio_put(bio);
		return ret;
	}

246 247 248
	return 0;
}
EXPORT_SYMBOL(blk_rq_map_kern);