• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Userspace block device - block device which IO is handled from userspace
4  *
5  * Take full use of io_uring passthrough command for communicating with
6  * ublk userspace daemon(ublksrvd) for handling basic IO request.
7  *
8  * Copyright 2022 Ming Lei <ming.lei@redhat.com>
9  *
10  * (part of code stolen from loop.c)
11  */
12 #include <linux/module.h>
13 #include <linux/moduleparam.h>
14 #include <linux/sched.h>
15 #include <linux/fs.h>
16 #include <linux/pagemap.h>
17 #include <linux/file.h>
18 #include <linux/stat.h>
19 #include <linux/errno.h>
20 #include <linux/major.h>
21 #include <linux/wait.h>
22 #include <linux/blkdev.h>
23 #include <linux/init.h>
24 #include <linux/swap.h>
25 #include <linux/slab.h>
26 #include <linux/compat.h>
27 #include <linux/mutex.h>
28 #include <linux/writeback.h>
29 #include <linux/completion.h>
30 #include <linux/highmem.h>
31 #include <linux/sysfs.h>
32 #include <linux/miscdevice.h>
33 #include <linux/falloc.h>
34 #include <linux/uio.h>
35 #include <linux/ioprio.h>
36 #include <linux/sched/mm.h>
37 #include <linux/uaccess.h>
38 #include <linux/cdev.h>
39 #include <linux/io_uring/cmd.h>
40 #include <linux/blk-mq.h>
41 #include <linux/delay.h>
42 #include <linux/mm.h>
43 #include <asm/page.h>
44 #include <linux/task_work.h>
45 #include <linux/namei.h>
46 #include <linux/kref.h>
47 #include <uapi/linux/ublk_cmd.h>
48 
49 #define UBLK_MINORS		(1U << MINORBITS)
50 
51 /* private ioctl command mirror */
52 #define UBLK_CMD_DEL_DEV_ASYNC	_IOC_NR(UBLK_U_CMD_DEL_DEV_ASYNC)
53 
54 /* All UBLK_F_* have to be included into UBLK_F_ALL */
55 #define UBLK_F_ALL (UBLK_F_SUPPORT_ZERO_COPY \
56 		| UBLK_F_URING_CMD_COMP_IN_TASK \
57 		| UBLK_F_NEED_GET_DATA \
58 		| UBLK_F_USER_RECOVERY \
59 		| UBLK_F_USER_RECOVERY_REISSUE \
60 		| UBLK_F_UNPRIVILEGED_DEV \
61 		| UBLK_F_CMD_IOCTL_ENCODE \
62 		| UBLK_F_USER_COPY \
63 		| UBLK_F_ZONED)
64 
65 /* All UBLK_PARAM_TYPE_* should be included here */
66 #define UBLK_PARAM_TYPE_ALL                                \
67 	(UBLK_PARAM_TYPE_BASIC | UBLK_PARAM_TYPE_DISCARD | \
68 	 UBLK_PARAM_TYPE_DEVT | UBLK_PARAM_TYPE_ZONED)
69 
70 struct ublk_rq_data {
71 	struct llist_node node;
72 
73 	struct kref ref;
74 };
75 
76 struct ublk_uring_cmd_pdu {
77 	struct ublk_queue *ubq;
78 	u16 tag;
79 };
80 
81 /*
82  * io command is active: sqe cmd is received, and its cqe isn't done
83  *
84  * If the flag is set, the io command is owned by ublk driver, and waited
85  * for incoming blk-mq request from the ublk block device.
86  *
87  * If the flag is cleared, the io command will be completed, and owned by
88  * ublk server.
89  */
90 #define UBLK_IO_FLAG_ACTIVE	0x01
91 
92 /*
93  * IO command is completed via cqe, and it is being handled by ublksrv, and
94  * not committed yet
95  *
96  * Basically exclusively with UBLK_IO_FLAG_ACTIVE, so can be served for
97  * cross verification
98  */
99 #define UBLK_IO_FLAG_OWNED_BY_SRV 0x02
100 
101 /*
102  * IO command is aborted, so this flag is set in case of
103  * !UBLK_IO_FLAG_ACTIVE.
104  *
105  * After this flag is observed, any pending or new incoming request
106  * associated with this io command will be failed immediately
107  */
108 #define UBLK_IO_FLAG_ABORTED 0x04
109 
110 /*
111  * UBLK_IO_FLAG_NEED_GET_DATA is set because IO command requires
112  * get data buffer address from ublksrv.
113  *
114  * Then, bio data could be copied into this data buffer for a WRITE request
115  * after the IO command is issued again and UBLK_IO_FLAG_NEED_GET_DATA is unset.
116  */
117 #define UBLK_IO_FLAG_NEED_GET_DATA 0x08
118 
119 /* atomic RW with ubq->cancel_lock */
120 #define UBLK_IO_FLAG_CANCELED	0x80000000
121 
122 struct ublk_io {
123 	/* userspace buffer address from io cmd */
124 	__u64	addr;
125 	unsigned int flags;
126 	int res;
127 
128 	struct io_uring_cmd *cmd;
129 };
130 
131 struct ublk_queue {
132 	int q_id;
133 	int q_depth;
134 
135 	unsigned long flags;
136 	struct task_struct	*ubq_daemon;
137 	char *io_cmd_buf;
138 
139 	struct llist_head	io_cmds;
140 
141 	unsigned long io_addr;	/* mapped vm address */
142 	unsigned int max_io_sz;
143 	bool force_abort;
144 	bool timeout;
145 	bool canceling;
146 	unsigned short nr_io_ready;	/* how many ios setup */
147 	spinlock_t		cancel_lock;
148 	struct ublk_device *dev;
149 	struct ublk_io ios[];
150 };
151 
152 struct ublk_device {
153 	struct gendisk		*ub_disk;
154 
155 	char	*__queues;
156 
157 	unsigned int	queue_size;
158 	struct ublksrv_ctrl_dev_info	dev_info;
159 
160 	struct blk_mq_tag_set	tag_set;
161 
162 	struct cdev		cdev;
163 	struct device		cdev_dev;
164 
165 #define UB_STATE_OPEN		0
166 #define UB_STATE_USED		1
167 #define UB_STATE_DELETED	2
168 	unsigned long		state;
169 	int			ub_number;
170 
171 	struct mutex		mutex;
172 
173 	spinlock_t		lock;
174 	struct mm_struct	*mm;
175 
176 	struct ublk_params	params;
177 
178 	struct completion	completion;
179 	unsigned int		nr_queues_ready;
180 	unsigned int		nr_privileged_daemon;
181 
182 	struct work_struct	quiesce_work;
183 	struct work_struct	stop_work;
184 };
185 
186 /* header of ublk_params */
187 struct ublk_params_header {
188 	__u32	len;
189 	__u32	types;
190 };
191 
192 static bool ublk_abort_requests(struct ublk_device *ub, struct ublk_queue *ubq);
193 
194 static inline unsigned int ublk_req_build_flags(struct request *req);
195 static inline struct ublksrv_io_desc *ublk_get_iod(struct ublk_queue *ubq,
196 						   int tag);
ublk_dev_is_user_copy(const struct ublk_device * ub)197 static inline bool ublk_dev_is_user_copy(const struct ublk_device *ub)
198 {
199 	return ub->dev_info.flags & UBLK_F_USER_COPY;
200 }
201 
ublk_dev_is_zoned(const struct ublk_device * ub)202 static inline bool ublk_dev_is_zoned(const struct ublk_device *ub)
203 {
204 	return ub->dev_info.flags & UBLK_F_ZONED;
205 }
206 
ublk_queue_is_zoned(struct ublk_queue * ubq)207 static inline bool ublk_queue_is_zoned(struct ublk_queue *ubq)
208 {
209 	return ubq->flags & UBLK_F_ZONED;
210 }
211 
212 #ifdef CONFIG_BLK_DEV_ZONED
213 
214 struct ublk_zoned_report_desc {
215 	__u64 sector;
216 	__u32 operation;
217 	__u32 nr_zones;
218 };
219 
220 static DEFINE_XARRAY(ublk_zoned_report_descs);
221 
ublk_zoned_insert_report_desc(const struct request * req,struct ublk_zoned_report_desc * desc)222 static int ublk_zoned_insert_report_desc(const struct request *req,
223 		struct ublk_zoned_report_desc *desc)
224 {
225 	return xa_insert(&ublk_zoned_report_descs, (unsigned long)req,
226 			    desc, GFP_KERNEL);
227 }
228 
ublk_zoned_erase_report_desc(const struct request * req)229 static struct ublk_zoned_report_desc *ublk_zoned_erase_report_desc(
230 		const struct request *req)
231 {
232 	return xa_erase(&ublk_zoned_report_descs, (unsigned long)req);
233 }
234 
ublk_zoned_get_report_desc(const struct request * req)235 static struct ublk_zoned_report_desc *ublk_zoned_get_report_desc(
236 		const struct request *req)
237 {
238 	return xa_load(&ublk_zoned_report_descs, (unsigned long)req);
239 }
240 
ublk_get_nr_zones(const struct ublk_device * ub)241 static int ublk_get_nr_zones(const struct ublk_device *ub)
242 {
243 	const struct ublk_param_basic *p = &ub->params.basic;
244 
245 	/* Zone size is a power of 2 */
246 	return p->dev_sectors >> ilog2(p->chunk_sectors);
247 }
248 
ublk_revalidate_disk_zones(struct ublk_device * ub)249 static int ublk_revalidate_disk_zones(struct ublk_device *ub)
250 {
251 	return blk_revalidate_disk_zones(ub->ub_disk);
252 }
253 
ublk_dev_param_zoned_validate(const struct ublk_device * ub)254 static int ublk_dev_param_zoned_validate(const struct ublk_device *ub)
255 {
256 	const struct ublk_param_zoned *p = &ub->params.zoned;
257 	int nr_zones;
258 
259 	if (!ublk_dev_is_zoned(ub))
260 		return -EINVAL;
261 
262 	if (!p->max_zone_append_sectors)
263 		return -EINVAL;
264 
265 	nr_zones = ublk_get_nr_zones(ub);
266 
267 	if (p->max_active_zones > nr_zones)
268 		return -EINVAL;
269 
270 	if (p->max_open_zones > nr_zones)
271 		return -EINVAL;
272 
273 	return 0;
274 }
275 
ublk_dev_param_zoned_apply(struct ublk_device * ub)276 static void ublk_dev_param_zoned_apply(struct ublk_device *ub)
277 {
278 	ub->ub_disk->nr_zones = ublk_get_nr_zones(ub);
279 }
280 
281 /* Based on virtblk_alloc_report_buffer */
ublk_alloc_report_buffer(struct ublk_device * ublk,unsigned int nr_zones,size_t * buflen)282 static void *ublk_alloc_report_buffer(struct ublk_device *ublk,
283 				      unsigned int nr_zones, size_t *buflen)
284 {
285 	struct request_queue *q = ublk->ub_disk->queue;
286 	size_t bufsize;
287 	void *buf;
288 
289 	nr_zones = min_t(unsigned int, nr_zones,
290 			 ublk->ub_disk->nr_zones);
291 
292 	bufsize = nr_zones * sizeof(struct blk_zone);
293 	bufsize =
294 		min_t(size_t, bufsize, queue_max_hw_sectors(q) << SECTOR_SHIFT);
295 
296 	while (bufsize >= sizeof(struct blk_zone)) {
297 		buf = kvmalloc(bufsize, GFP_KERNEL | __GFP_NORETRY);
298 		if (buf) {
299 			*buflen = bufsize;
300 			return buf;
301 		}
302 		bufsize >>= 1;
303 	}
304 
305 	*buflen = 0;
306 	return NULL;
307 }
308 
ublk_report_zones(struct gendisk * disk,sector_t sector,unsigned int nr_zones,report_zones_cb cb,void * data)309 static int ublk_report_zones(struct gendisk *disk, sector_t sector,
310 		      unsigned int nr_zones, report_zones_cb cb, void *data)
311 {
312 	struct ublk_device *ub = disk->private_data;
313 	unsigned int zone_size_sectors = disk->queue->limits.chunk_sectors;
314 	unsigned int first_zone = sector >> ilog2(zone_size_sectors);
315 	unsigned int done_zones = 0;
316 	unsigned int max_zones_per_request;
317 	int ret;
318 	struct blk_zone *buffer;
319 	size_t buffer_length;
320 
321 	nr_zones = min_t(unsigned int, ub->ub_disk->nr_zones - first_zone,
322 			 nr_zones);
323 
324 	buffer = ublk_alloc_report_buffer(ub, nr_zones, &buffer_length);
325 	if (!buffer)
326 		return -ENOMEM;
327 
328 	max_zones_per_request = buffer_length / sizeof(struct blk_zone);
329 
330 	while (done_zones < nr_zones) {
331 		unsigned int remaining_zones = nr_zones - done_zones;
332 		unsigned int zones_in_request =
333 			min_t(unsigned int, remaining_zones, max_zones_per_request);
334 		struct request *req;
335 		struct ublk_zoned_report_desc desc;
336 		blk_status_t status;
337 
338 		memset(buffer, 0, buffer_length);
339 
340 		req = blk_mq_alloc_request(disk->queue, REQ_OP_DRV_IN, 0);
341 		if (IS_ERR(req)) {
342 			ret = PTR_ERR(req);
343 			goto out;
344 		}
345 
346 		desc.operation = UBLK_IO_OP_REPORT_ZONES;
347 		desc.sector = sector;
348 		desc.nr_zones = zones_in_request;
349 		ret = ublk_zoned_insert_report_desc(req, &desc);
350 		if (ret)
351 			goto free_req;
352 
353 		ret = blk_rq_map_kern(disk->queue, req, buffer, buffer_length,
354 					GFP_KERNEL);
355 		if (ret)
356 			goto erase_desc;
357 
358 		status = blk_execute_rq(req, 0);
359 		ret = blk_status_to_errno(status);
360 erase_desc:
361 		ublk_zoned_erase_report_desc(req);
362 free_req:
363 		blk_mq_free_request(req);
364 		if (ret)
365 			goto out;
366 
367 		for (unsigned int i = 0; i < zones_in_request; i++) {
368 			struct blk_zone *zone = buffer + i;
369 
370 			/* A zero length zone means no more zones in this response */
371 			if (!zone->len)
372 				break;
373 
374 			ret = cb(zone, i, data);
375 			if (ret)
376 				goto out;
377 
378 			done_zones++;
379 			sector += zone_size_sectors;
380 
381 		}
382 	}
383 
384 	ret = done_zones;
385 
386 out:
387 	kvfree(buffer);
388 	return ret;
389 }
390 
ublk_setup_iod_zoned(struct ublk_queue * ubq,struct request * req)391 static blk_status_t ublk_setup_iod_zoned(struct ublk_queue *ubq,
392 					 struct request *req)
393 {
394 	struct ublksrv_io_desc *iod = ublk_get_iod(ubq, req->tag);
395 	struct ublk_io *io = &ubq->ios[req->tag];
396 	struct ublk_zoned_report_desc *desc;
397 	u32 ublk_op;
398 
399 	switch (req_op(req)) {
400 	case REQ_OP_ZONE_OPEN:
401 		ublk_op = UBLK_IO_OP_ZONE_OPEN;
402 		break;
403 	case REQ_OP_ZONE_CLOSE:
404 		ublk_op = UBLK_IO_OP_ZONE_CLOSE;
405 		break;
406 	case REQ_OP_ZONE_FINISH:
407 		ublk_op = UBLK_IO_OP_ZONE_FINISH;
408 		break;
409 	case REQ_OP_ZONE_RESET:
410 		ublk_op = UBLK_IO_OP_ZONE_RESET;
411 		break;
412 	case REQ_OP_ZONE_APPEND:
413 		ublk_op = UBLK_IO_OP_ZONE_APPEND;
414 		break;
415 	case REQ_OP_ZONE_RESET_ALL:
416 		ublk_op = UBLK_IO_OP_ZONE_RESET_ALL;
417 		break;
418 	case REQ_OP_DRV_IN:
419 		desc = ublk_zoned_get_report_desc(req);
420 		if (!desc)
421 			return BLK_STS_IOERR;
422 		ublk_op = desc->operation;
423 		switch (ublk_op) {
424 		case UBLK_IO_OP_REPORT_ZONES:
425 			iod->op_flags = ublk_op | ublk_req_build_flags(req);
426 			iod->nr_zones = desc->nr_zones;
427 			iod->start_sector = desc->sector;
428 			return BLK_STS_OK;
429 		default:
430 			return BLK_STS_IOERR;
431 		}
432 	case REQ_OP_DRV_OUT:
433 		/* We do not support drv_out */
434 		return BLK_STS_NOTSUPP;
435 	default:
436 		return BLK_STS_IOERR;
437 	}
438 
439 	iod->op_flags = ublk_op | ublk_req_build_flags(req);
440 	iod->nr_sectors = blk_rq_sectors(req);
441 	iod->start_sector = blk_rq_pos(req);
442 	iod->addr = io->addr;
443 
444 	return BLK_STS_OK;
445 }
446 
447 #else
448 
449 #define ublk_report_zones (NULL)
450 
ublk_dev_param_zoned_validate(const struct ublk_device * ub)451 static int ublk_dev_param_zoned_validate(const struct ublk_device *ub)
452 {
453 	return -EOPNOTSUPP;
454 }
455 
ublk_dev_param_zoned_apply(struct ublk_device * ub)456 static void ublk_dev_param_zoned_apply(struct ublk_device *ub)
457 {
458 }
459 
ublk_revalidate_disk_zones(struct ublk_device * ub)460 static int ublk_revalidate_disk_zones(struct ublk_device *ub)
461 {
462 	return 0;
463 }
464 
ublk_setup_iod_zoned(struct ublk_queue * ubq,struct request * req)465 static blk_status_t ublk_setup_iod_zoned(struct ublk_queue *ubq,
466 					 struct request *req)
467 {
468 	return BLK_STS_NOTSUPP;
469 }
470 
471 #endif
472 
473 static inline void __ublk_complete_rq(struct request *req);
474 static void ublk_complete_rq(struct kref *ref);
475 
476 static dev_t ublk_chr_devt;
477 static const struct class ublk_chr_class = {
478 	.name = "ublk-char",
479 };
480 
481 static DEFINE_IDR(ublk_index_idr);
482 static DEFINE_SPINLOCK(ublk_idr_lock);
483 static wait_queue_head_t ublk_idr_wq;	/* wait until one idr is freed */
484 
485 static DEFINE_MUTEX(ublk_ctl_mutex);
486 
487 
488 #define UBLK_MAX_UBLKS UBLK_MINORS
489 
490 /*
491  * Max unprivileged ublk devices allowed to add
492  *
493  * It can be extended to one per-user limit in future or even controlled
494  * by cgroup.
495  */
496 static unsigned int unprivileged_ublks_max = 64;
497 static unsigned int unprivileged_ublks_added; /* protected by ublk_ctl_mutex */
498 
499 static struct miscdevice ublk_misc;
500 
ublk_pos_to_hwq(loff_t pos)501 static inline unsigned ublk_pos_to_hwq(loff_t pos)
502 {
503 	return ((pos - UBLKSRV_IO_BUF_OFFSET) >> UBLK_QID_OFF) &
504 		UBLK_QID_BITS_MASK;
505 }
506 
ublk_pos_to_buf_off(loff_t pos)507 static inline unsigned ublk_pos_to_buf_off(loff_t pos)
508 {
509 	return (pos - UBLKSRV_IO_BUF_OFFSET) & UBLK_IO_BUF_BITS_MASK;
510 }
511 
ublk_pos_to_tag(loff_t pos)512 static inline unsigned ublk_pos_to_tag(loff_t pos)
513 {
514 	return ((pos - UBLKSRV_IO_BUF_OFFSET) >> UBLK_TAG_OFF) &
515 		UBLK_TAG_BITS_MASK;
516 }
517 
ublk_dev_param_basic_apply(struct ublk_device * ub)518 static void ublk_dev_param_basic_apply(struct ublk_device *ub)
519 {
520 	const struct ublk_param_basic *p = &ub->params.basic;
521 
522 	if (p->attrs & UBLK_ATTR_READ_ONLY)
523 		set_disk_ro(ub->ub_disk, true);
524 
525 	set_capacity(ub->ub_disk, p->dev_sectors);
526 }
527 
ublk_validate_params(const struct ublk_device * ub)528 static int ublk_validate_params(const struct ublk_device *ub)
529 {
530 	/* basic param is the only one which must be set */
531 	if (ub->params.types & UBLK_PARAM_TYPE_BASIC) {
532 		const struct ublk_param_basic *p = &ub->params.basic;
533 
534 		if (p->logical_bs_shift > PAGE_SHIFT || p->logical_bs_shift < 9)
535 			return -EINVAL;
536 
537 		if (p->logical_bs_shift > p->physical_bs_shift)
538 			return -EINVAL;
539 
540 		if (p->max_sectors > (ub->dev_info.max_io_buf_bytes >> 9))
541 			return -EINVAL;
542 
543 		if (ublk_dev_is_zoned(ub) && !p->chunk_sectors)
544 			return -EINVAL;
545 	} else
546 		return -EINVAL;
547 
548 	if (ub->params.types & UBLK_PARAM_TYPE_DISCARD) {
549 		const struct ublk_param_discard *p = &ub->params.discard;
550 
551 		/* So far, only support single segment discard */
552 		if (p->max_discard_sectors && p->max_discard_segments != 1)
553 			return -EINVAL;
554 
555 		if (!p->discard_granularity)
556 			return -EINVAL;
557 	}
558 
559 	/* dev_t is read-only */
560 	if (ub->params.types & UBLK_PARAM_TYPE_DEVT)
561 		return -EINVAL;
562 
563 	if (ub->params.types & UBLK_PARAM_TYPE_ZONED)
564 		return ublk_dev_param_zoned_validate(ub);
565 	else if (ublk_dev_is_zoned(ub))
566 		return -EINVAL;
567 
568 	return 0;
569 }
570 
ublk_apply_params(struct ublk_device * ub)571 static void ublk_apply_params(struct ublk_device *ub)
572 {
573 	ublk_dev_param_basic_apply(ub);
574 
575 	if (ub->params.types & UBLK_PARAM_TYPE_ZONED)
576 		ublk_dev_param_zoned_apply(ub);
577 }
578 
ublk_support_user_copy(const struct ublk_queue * ubq)579 static inline bool ublk_support_user_copy(const struct ublk_queue *ubq)
580 {
581 	return ubq->flags & UBLK_F_USER_COPY;
582 }
583 
ublk_need_req_ref(const struct ublk_queue * ubq)584 static inline bool ublk_need_req_ref(const struct ublk_queue *ubq)
585 {
586 	/*
587 	 * read()/write() is involved in user copy, so request reference
588 	 * has to be grabbed
589 	 */
590 	return ublk_support_user_copy(ubq);
591 }
592 
ublk_init_req_ref(const struct ublk_queue * ubq,struct request * req)593 static inline void ublk_init_req_ref(const struct ublk_queue *ubq,
594 		struct request *req)
595 {
596 	if (ublk_need_req_ref(ubq)) {
597 		struct ublk_rq_data *data = blk_mq_rq_to_pdu(req);
598 
599 		kref_init(&data->ref);
600 	}
601 }
602 
ublk_get_req_ref(const struct ublk_queue * ubq,struct request * req)603 static inline bool ublk_get_req_ref(const struct ublk_queue *ubq,
604 		struct request *req)
605 {
606 	if (ublk_need_req_ref(ubq)) {
607 		struct ublk_rq_data *data = blk_mq_rq_to_pdu(req);
608 
609 		return kref_get_unless_zero(&data->ref);
610 	}
611 
612 	return true;
613 }
614 
ublk_put_req_ref(const struct ublk_queue * ubq,struct request * req)615 static inline void ublk_put_req_ref(const struct ublk_queue *ubq,
616 		struct request *req)
617 {
618 	if (ublk_need_req_ref(ubq)) {
619 		struct ublk_rq_data *data = blk_mq_rq_to_pdu(req);
620 
621 		kref_put(&data->ref, ublk_complete_rq);
622 	} else {
623 		__ublk_complete_rq(req);
624 	}
625 }
626 
ublk_need_get_data(const struct ublk_queue * ubq)627 static inline bool ublk_need_get_data(const struct ublk_queue *ubq)
628 {
629 	return ubq->flags & UBLK_F_NEED_GET_DATA;
630 }
631 
632 /* Called in slow path only, keep it noinline for trace purpose */
ublk_get_device(struct ublk_device * ub)633 static noinline struct ublk_device *ublk_get_device(struct ublk_device *ub)
634 {
635 	if (kobject_get_unless_zero(&ub->cdev_dev.kobj))
636 		return ub;
637 	return NULL;
638 }
639 
640 /* Called in slow path only, keep it noinline for trace purpose */
ublk_put_device(struct ublk_device * ub)641 static noinline void ublk_put_device(struct ublk_device *ub)
642 {
643 	put_device(&ub->cdev_dev);
644 }
645 
ublk_get_queue(struct ublk_device * dev,int qid)646 static inline struct ublk_queue *ublk_get_queue(struct ublk_device *dev,
647 		int qid)
648 {
649        return (struct ublk_queue *)&(dev->__queues[qid * dev->queue_size]);
650 }
651 
ublk_rq_has_data(const struct request * rq)652 static inline bool ublk_rq_has_data(const struct request *rq)
653 {
654 	return bio_has_data(rq->bio);
655 }
656 
ublk_get_iod(struct ublk_queue * ubq,int tag)657 static inline struct ublksrv_io_desc *ublk_get_iod(struct ublk_queue *ubq,
658 		int tag)
659 {
660 	return (struct ublksrv_io_desc *)
661 		&(ubq->io_cmd_buf[tag * sizeof(struct ublksrv_io_desc)]);
662 }
663 
ublk_queue_cmd_buf(struct ublk_device * ub,int q_id)664 static inline char *ublk_queue_cmd_buf(struct ublk_device *ub, int q_id)
665 {
666 	return ublk_get_queue(ub, q_id)->io_cmd_buf;
667 }
668 
__ublk_queue_cmd_buf_size(int depth)669 static inline int __ublk_queue_cmd_buf_size(int depth)
670 {
671 	return round_up(depth * sizeof(struct ublksrv_io_desc), PAGE_SIZE);
672 }
673 
ublk_queue_cmd_buf_size(struct ublk_device * ub,int q_id)674 static inline int ublk_queue_cmd_buf_size(struct ublk_device *ub, int q_id)
675 {
676 	struct ublk_queue *ubq = ublk_get_queue(ub, q_id);
677 
678 	return __ublk_queue_cmd_buf_size(ubq->q_depth);
679 }
680 
ublk_max_cmd_buf_size(void)681 static int ublk_max_cmd_buf_size(void)
682 {
683 	return __ublk_queue_cmd_buf_size(UBLK_MAX_QUEUE_DEPTH);
684 }
685 
686 /*
687  * Should I/O outstanding to the ublk server when it exits be reissued?
688  * If not, outstanding I/O will get errors.
689  */
ublk_nosrv_should_reissue_outstanding(struct ublk_device * ub)690 static inline bool ublk_nosrv_should_reissue_outstanding(struct ublk_device *ub)
691 {
692 	return (ub->dev_info.flags & UBLK_F_USER_RECOVERY) &&
693 	       (ub->dev_info.flags & UBLK_F_USER_RECOVERY_REISSUE);
694 }
695 
696 /*
697  * Should I/O issued while there is no ublk server queue? If not, I/O
698  * issued while there is no ublk server will get errors.
699  */
ublk_nosrv_dev_should_queue_io(struct ublk_device * ub)700 static inline bool ublk_nosrv_dev_should_queue_io(struct ublk_device *ub)
701 {
702 	return ub->dev_info.flags & UBLK_F_USER_RECOVERY;
703 }
704 
705 /*
706  * Same as ublk_nosrv_dev_should_queue_io, but uses a queue-local copy
707  * of the device flags for smaller cache footprint - better for fast
708  * paths.
709  */
ublk_nosrv_should_queue_io(struct ublk_queue * ubq)710 static inline bool ublk_nosrv_should_queue_io(struct ublk_queue *ubq)
711 {
712 	return ubq->flags & UBLK_F_USER_RECOVERY;
713 }
714 
715 /*
716  * Should ublk devices be stopped (i.e. no recovery possible) when the
717  * ublk server exits? If not, devices can be used again by a future
718  * incarnation of a ublk server via the start_recovery/end_recovery
719  * commands.
720  */
ublk_nosrv_should_stop_dev(struct ublk_device * ub)721 static inline bool ublk_nosrv_should_stop_dev(struct ublk_device *ub)
722 {
723 	return !(ub->dev_info.flags & UBLK_F_USER_RECOVERY);
724 }
725 
ublk_free_disk(struct gendisk * disk)726 static void ublk_free_disk(struct gendisk *disk)
727 {
728 	struct ublk_device *ub = disk->private_data;
729 
730 	clear_bit(UB_STATE_USED, &ub->state);
731 	ublk_put_device(ub);
732 }
733 
ublk_store_owner_uid_gid(unsigned int * owner_uid,unsigned int * owner_gid)734 static void ublk_store_owner_uid_gid(unsigned int *owner_uid,
735 		unsigned int *owner_gid)
736 {
737 	kuid_t uid;
738 	kgid_t gid;
739 
740 	current_uid_gid(&uid, &gid);
741 
742 	*owner_uid = from_kuid(&init_user_ns, uid);
743 	*owner_gid = from_kgid(&init_user_ns, gid);
744 }
745 
ublk_open(struct gendisk * disk,blk_mode_t mode)746 static int ublk_open(struct gendisk *disk, blk_mode_t mode)
747 {
748 	struct ublk_device *ub = disk->private_data;
749 
750 	if (capable(CAP_SYS_ADMIN))
751 		return 0;
752 
753 	/*
754 	 * If it is one unprivileged device, only owner can open
755 	 * the disk. Otherwise it could be one trap made by one
756 	 * evil user who grants this disk's privileges to other
757 	 * users deliberately.
758 	 *
759 	 * This way is reasonable too given anyone can create
760 	 * unprivileged device, and no need other's grant.
761 	 */
762 	if (ub->dev_info.flags & UBLK_F_UNPRIVILEGED_DEV) {
763 		unsigned int curr_uid, curr_gid;
764 
765 		ublk_store_owner_uid_gid(&curr_uid, &curr_gid);
766 
767 		if (curr_uid != ub->dev_info.owner_uid || curr_gid !=
768 				ub->dev_info.owner_gid)
769 			return -EPERM;
770 	}
771 
772 	return 0;
773 }
774 
775 static const struct block_device_operations ub_fops = {
776 	.owner =	THIS_MODULE,
777 	.open =		ublk_open,
778 	.free_disk =	ublk_free_disk,
779 	.report_zones =	ublk_report_zones,
780 };
781 
782 #define UBLK_MAX_PIN_PAGES	32
783 
784 struct ublk_io_iter {
785 	struct page *pages[UBLK_MAX_PIN_PAGES];
786 	struct bio *bio;
787 	struct bvec_iter iter;
788 };
789 
790 /* return how many pages are copied */
ublk_copy_io_pages(struct ublk_io_iter * data,size_t total,size_t pg_off,int dir)791 static void ublk_copy_io_pages(struct ublk_io_iter *data,
792 		size_t total, size_t pg_off, int dir)
793 {
794 	unsigned done = 0;
795 	unsigned pg_idx = 0;
796 
797 	while (done < total) {
798 		struct bio_vec bv = bio_iter_iovec(data->bio, data->iter);
799 		unsigned int bytes = min3(bv.bv_len, (unsigned)total - done,
800 				(unsigned)(PAGE_SIZE - pg_off));
801 		void *bv_buf = bvec_kmap_local(&bv);
802 		void *pg_buf = kmap_local_page(data->pages[pg_idx]);
803 
804 		if (dir == ITER_DEST)
805 			memcpy(pg_buf + pg_off, bv_buf, bytes);
806 		else
807 			memcpy(bv_buf, pg_buf + pg_off, bytes);
808 
809 		kunmap_local(pg_buf);
810 		kunmap_local(bv_buf);
811 
812 		/* advance page array */
813 		pg_off += bytes;
814 		if (pg_off == PAGE_SIZE) {
815 			pg_idx += 1;
816 			pg_off = 0;
817 		}
818 
819 		done += bytes;
820 
821 		/* advance bio */
822 		bio_advance_iter_single(data->bio, &data->iter, bytes);
823 		if (!data->iter.bi_size) {
824 			data->bio = data->bio->bi_next;
825 			if (data->bio == NULL)
826 				break;
827 			data->iter = data->bio->bi_iter;
828 		}
829 	}
830 }
831 
ublk_advance_io_iter(const struct request * req,struct ublk_io_iter * iter,unsigned int offset)832 static bool ublk_advance_io_iter(const struct request *req,
833 		struct ublk_io_iter *iter, unsigned int offset)
834 {
835 	struct bio *bio = req->bio;
836 
837 	for_each_bio(bio) {
838 		if (bio->bi_iter.bi_size > offset) {
839 			iter->bio = bio;
840 			iter->iter = bio->bi_iter;
841 			bio_advance_iter(iter->bio, &iter->iter, offset);
842 			return true;
843 		}
844 		offset -= bio->bi_iter.bi_size;
845 	}
846 	return false;
847 }
848 
849 /*
850  * Copy data between request pages and io_iter, and 'offset'
851  * is the start point of linear offset of request.
852  */
ublk_copy_user_pages(const struct request * req,unsigned offset,struct iov_iter * uiter,int dir)853 static size_t ublk_copy_user_pages(const struct request *req,
854 		unsigned offset, struct iov_iter *uiter, int dir)
855 {
856 	struct ublk_io_iter iter;
857 	size_t done = 0;
858 
859 	if (!ublk_advance_io_iter(req, &iter, offset))
860 		return 0;
861 
862 	while (iov_iter_count(uiter) && iter.bio) {
863 		unsigned nr_pages;
864 		ssize_t len;
865 		size_t off;
866 		int i;
867 
868 		len = iov_iter_get_pages2(uiter, iter.pages,
869 				iov_iter_count(uiter),
870 				UBLK_MAX_PIN_PAGES, &off);
871 		if (len <= 0)
872 			return done;
873 
874 		ublk_copy_io_pages(&iter, len, off, dir);
875 		nr_pages = DIV_ROUND_UP(len + off, PAGE_SIZE);
876 		for (i = 0; i < nr_pages; i++) {
877 			if (dir == ITER_DEST)
878 				set_page_dirty(iter.pages[i]);
879 			put_page(iter.pages[i]);
880 		}
881 		done += len;
882 	}
883 
884 	return done;
885 }
886 
ublk_need_map_req(const struct request * req)887 static inline bool ublk_need_map_req(const struct request *req)
888 {
889 	return ublk_rq_has_data(req) && req_op(req) == REQ_OP_WRITE;
890 }
891 
ublk_need_unmap_req(const struct request * req)892 static inline bool ublk_need_unmap_req(const struct request *req)
893 {
894 	return ublk_rq_has_data(req) &&
895 	       (req_op(req) == REQ_OP_READ || req_op(req) == REQ_OP_DRV_IN);
896 }
897 
ublk_map_io(const struct ublk_queue * ubq,const struct request * req,struct ublk_io * io)898 static int ublk_map_io(const struct ublk_queue *ubq, const struct request *req,
899 		struct ublk_io *io)
900 {
901 	const unsigned int rq_bytes = blk_rq_bytes(req);
902 
903 	if (ublk_support_user_copy(ubq))
904 		return rq_bytes;
905 
906 	/*
907 	 * no zero copy, we delay copy WRITE request data into ublksrv
908 	 * context and the big benefit is that pinning pages in current
909 	 * context is pretty fast, see ublk_pin_user_pages
910 	 */
911 	if (ublk_need_map_req(req)) {
912 		struct iov_iter iter;
913 		const int dir = ITER_DEST;
914 
915 		import_ubuf(dir, u64_to_user_ptr(io->addr), rq_bytes, &iter);
916 		return ublk_copy_user_pages(req, 0, &iter, dir);
917 	}
918 	return rq_bytes;
919 }
920 
ublk_unmap_io(const struct ublk_queue * ubq,const struct request * req,struct ublk_io * io)921 static int ublk_unmap_io(const struct ublk_queue *ubq,
922 		const struct request *req,
923 		struct ublk_io *io)
924 {
925 	const unsigned int rq_bytes = blk_rq_bytes(req);
926 
927 	if (ublk_support_user_copy(ubq))
928 		return rq_bytes;
929 
930 	if (ublk_need_unmap_req(req)) {
931 		struct iov_iter iter;
932 		const int dir = ITER_SOURCE;
933 
934 		WARN_ON_ONCE(io->res > rq_bytes);
935 
936 		import_ubuf(dir, u64_to_user_ptr(io->addr), io->res, &iter);
937 		return ublk_copy_user_pages(req, 0, &iter, dir);
938 	}
939 	return rq_bytes;
940 }
941 
ublk_req_build_flags(struct request * req)942 static inline unsigned int ublk_req_build_flags(struct request *req)
943 {
944 	unsigned flags = 0;
945 
946 	if (req->cmd_flags & REQ_FAILFAST_DEV)
947 		flags |= UBLK_IO_F_FAILFAST_DEV;
948 
949 	if (req->cmd_flags & REQ_FAILFAST_TRANSPORT)
950 		flags |= UBLK_IO_F_FAILFAST_TRANSPORT;
951 
952 	if (req->cmd_flags & REQ_FAILFAST_DRIVER)
953 		flags |= UBLK_IO_F_FAILFAST_DRIVER;
954 
955 	if (req->cmd_flags & REQ_META)
956 		flags |= UBLK_IO_F_META;
957 
958 	if (req->cmd_flags & REQ_FUA)
959 		flags |= UBLK_IO_F_FUA;
960 
961 	if (req->cmd_flags & REQ_NOUNMAP)
962 		flags |= UBLK_IO_F_NOUNMAP;
963 
964 	if (req->cmd_flags & REQ_SWAP)
965 		flags |= UBLK_IO_F_SWAP;
966 
967 	return flags;
968 }
969 
ublk_setup_iod(struct ublk_queue * ubq,struct request * req)970 static blk_status_t ublk_setup_iod(struct ublk_queue *ubq, struct request *req)
971 {
972 	struct ublksrv_io_desc *iod = ublk_get_iod(ubq, req->tag);
973 	struct ublk_io *io = &ubq->ios[req->tag];
974 	enum req_op op = req_op(req);
975 	u32 ublk_op;
976 
977 	if (!ublk_queue_is_zoned(ubq) &&
978 	    (op_is_zone_mgmt(op) || op == REQ_OP_ZONE_APPEND))
979 		return BLK_STS_IOERR;
980 
981 	switch (req_op(req)) {
982 	case REQ_OP_READ:
983 		ublk_op = UBLK_IO_OP_READ;
984 		break;
985 	case REQ_OP_WRITE:
986 		ublk_op = UBLK_IO_OP_WRITE;
987 		break;
988 	case REQ_OP_FLUSH:
989 		ublk_op = UBLK_IO_OP_FLUSH;
990 		break;
991 	case REQ_OP_DISCARD:
992 		ublk_op = UBLK_IO_OP_DISCARD;
993 		break;
994 	case REQ_OP_WRITE_ZEROES:
995 		ublk_op = UBLK_IO_OP_WRITE_ZEROES;
996 		break;
997 	default:
998 		if (ublk_queue_is_zoned(ubq))
999 			return ublk_setup_iod_zoned(ubq, req);
1000 		return BLK_STS_IOERR;
1001 	}
1002 
1003 	/* need to translate since kernel may change */
1004 	iod->op_flags = ublk_op | ublk_req_build_flags(req);
1005 	iod->nr_sectors = blk_rq_sectors(req);
1006 	iod->start_sector = blk_rq_pos(req);
1007 	iod->addr = io->addr;
1008 
1009 	return BLK_STS_OK;
1010 }
1011 
ublk_get_uring_cmd_pdu(struct io_uring_cmd * ioucmd)1012 static inline struct ublk_uring_cmd_pdu *ublk_get_uring_cmd_pdu(
1013 		struct io_uring_cmd *ioucmd)
1014 {
1015 	return (struct ublk_uring_cmd_pdu *)&ioucmd->pdu;
1016 }
1017 
ubq_daemon_is_dying(struct ublk_queue * ubq)1018 static inline bool ubq_daemon_is_dying(struct ublk_queue *ubq)
1019 {
1020 	return ubq->ubq_daemon->flags & PF_EXITING;
1021 }
1022 
1023 /* todo: handle partial completion */
__ublk_complete_rq(struct request * req)1024 static inline void __ublk_complete_rq(struct request *req)
1025 {
1026 	struct ublk_queue *ubq = req->mq_hctx->driver_data;
1027 	struct ublk_io *io = &ubq->ios[req->tag];
1028 	unsigned int unmapped_bytes;
1029 	blk_status_t res = BLK_STS_OK;
1030 
1031 	/* called from ublk_abort_queue() code path */
1032 	if (io->flags & UBLK_IO_FLAG_ABORTED) {
1033 		res = BLK_STS_IOERR;
1034 		goto exit;
1035 	}
1036 
1037 	/* failed read IO if nothing is read */
1038 	if (!io->res && req_op(req) == REQ_OP_READ)
1039 		io->res = -EIO;
1040 
1041 	if (io->res < 0) {
1042 		res = errno_to_blk_status(io->res);
1043 		goto exit;
1044 	}
1045 
1046 	/*
1047 	 * FLUSH, DISCARD or WRITE_ZEROES usually won't return bytes returned, so end them
1048 	 * directly.
1049 	 *
1050 	 * Both the two needn't unmap.
1051 	 */
1052 	if (req_op(req) != REQ_OP_READ && req_op(req) != REQ_OP_WRITE &&
1053 	    req_op(req) != REQ_OP_DRV_IN)
1054 		goto exit;
1055 
1056 	/* for READ request, writing data in iod->addr to rq buffers */
1057 	unmapped_bytes = ublk_unmap_io(ubq, req, io);
1058 
1059 	/*
1060 	 * Extremely impossible since we got data filled in just before
1061 	 *
1062 	 * Re-read simply for this unlikely case.
1063 	 */
1064 	if (unlikely(unmapped_bytes < io->res))
1065 		io->res = unmapped_bytes;
1066 
1067 	if (blk_update_request(req, BLK_STS_OK, io->res))
1068 		blk_mq_requeue_request(req, true);
1069 	else
1070 		__blk_mq_end_request(req, BLK_STS_OK);
1071 
1072 	return;
1073 exit:
1074 	blk_mq_end_request(req, res);
1075 }
1076 
ublk_complete_rq(struct kref * ref)1077 static void ublk_complete_rq(struct kref *ref)
1078 {
1079 	struct ublk_rq_data *data = container_of(ref, struct ublk_rq_data,
1080 			ref);
1081 	struct request *req = blk_mq_rq_from_pdu(data);
1082 
1083 	__ublk_complete_rq(req);
1084 }
1085 
ublk_do_fail_rq(struct request * req)1086 static void ublk_do_fail_rq(struct request *req)
1087 {
1088 	struct ublk_queue *ubq = req->mq_hctx->driver_data;
1089 
1090 	if (ublk_nosrv_should_reissue_outstanding(ubq->dev))
1091 		blk_mq_requeue_request(req, false);
1092 	else
1093 		__ublk_complete_rq(req);
1094 }
1095 
ublk_fail_rq_fn(struct kref * ref)1096 static void ublk_fail_rq_fn(struct kref *ref)
1097 {
1098 	struct ublk_rq_data *data = container_of(ref, struct ublk_rq_data,
1099 			ref);
1100 	struct request *req = blk_mq_rq_from_pdu(data);
1101 
1102 	ublk_do_fail_rq(req);
1103 }
1104 
1105 /*
1106  * Since __ublk_rq_task_work always fails requests immediately during
1107  * exiting, __ublk_fail_req() is only called from abort context during
1108  * exiting. So lock is unnecessary.
1109  *
1110  * Also aborting may not be started yet, keep in mind that one failed
1111  * request may be issued by block layer again.
1112  */
__ublk_fail_req(struct ublk_queue * ubq,struct ublk_io * io,struct request * req)1113 static void __ublk_fail_req(struct ublk_queue *ubq, struct ublk_io *io,
1114 		struct request *req)
1115 {
1116 	WARN_ON_ONCE(io->flags & UBLK_IO_FLAG_ACTIVE);
1117 
1118 	if (ublk_need_req_ref(ubq)) {
1119 		struct ublk_rq_data *data = blk_mq_rq_to_pdu(req);
1120 
1121 		kref_put(&data->ref, ublk_fail_rq_fn);
1122 	} else {
1123 		ublk_do_fail_rq(req);
1124 	}
1125 }
1126 
ubq_complete_io_cmd(struct ublk_io * io,int res,unsigned issue_flags)1127 static void ubq_complete_io_cmd(struct ublk_io *io, int res,
1128 				unsigned issue_flags)
1129 {
1130 	/* mark this cmd owned by ublksrv */
1131 	io->flags |= UBLK_IO_FLAG_OWNED_BY_SRV;
1132 
1133 	/*
1134 	 * clear ACTIVE since we are done with this sqe/cmd slot
1135 	 * We can only accept io cmd in case of being not active.
1136 	 */
1137 	io->flags &= ~UBLK_IO_FLAG_ACTIVE;
1138 
1139 	/* tell ublksrv one io request is coming */
1140 	io_uring_cmd_done(io->cmd, res, 0, issue_flags);
1141 }
1142 
1143 #define UBLK_REQUEUE_DELAY_MS	3
1144 
__ublk_abort_rq(struct ublk_queue * ubq,struct request * rq)1145 static inline void __ublk_abort_rq(struct ublk_queue *ubq,
1146 		struct request *rq)
1147 {
1148 	/* We cannot process this rq so just requeue it. */
1149 	if (ublk_nosrv_dev_should_queue_io(ubq->dev))
1150 		blk_mq_requeue_request(rq, false);
1151 	else
1152 		blk_mq_end_request(rq, BLK_STS_IOERR);
1153 }
1154 
__ublk_rq_task_work(struct request * req,unsigned issue_flags)1155 static inline void __ublk_rq_task_work(struct request *req,
1156 				       unsigned issue_flags)
1157 {
1158 	struct ublk_queue *ubq = req->mq_hctx->driver_data;
1159 	int tag = req->tag;
1160 	struct ublk_io *io = &ubq->ios[tag];
1161 	unsigned int mapped_bytes;
1162 
1163 	pr_devel("%s: complete: op %d, qid %d tag %d io_flags %x addr %llx\n",
1164 			__func__, io->cmd->cmd_op, ubq->q_id, req->tag, io->flags,
1165 			ublk_get_iod(ubq, req->tag)->addr);
1166 
1167 	/*
1168 	 * Task is exiting if either:
1169 	 *
1170 	 * (1) current != ubq_daemon.
1171 	 * io_uring_cmd_complete_in_task() tries to run task_work
1172 	 * in a workqueue if ubq_daemon(cmd's task) is PF_EXITING.
1173 	 *
1174 	 * (2) current->flags & PF_EXITING.
1175 	 */
1176 	if (unlikely(current != ubq->ubq_daemon || current->flags & PF_EXITING)) {
1177 		__ublk_abort_rq(ubq, req);
1178 		return;
1179 	}
1180 
1181 	if (ublk_need_get_data(ubq) && ublk_need_map_req(req)) {
1182 		/*
1183 		 * We have not handled UBLK_IO_NEED_GET_DATA command yet,
1184 		 * so immepdately pass UBLK_IO_RES_NEED_GET_DATA to ublksrv
1185 		 * and notify it.
1186 		 */
1187 		if (!(io->flags & UBLK_IO_FLAG_NEED_GET_DATA)) {
1188 			io->flags |= UBLK_IO_FLAG_NEED_GET_DATA;
1189 			pr_devel("%s: need get data. op %d, qid %d tag %d io_flags %x\n",
1190 					__func__, io->cmd->cmd_op, ubq->q_id,
1191 					req->tag, io->flags);
1192 			ubq_complete_io_cmd(io, UBLK_IO_RES_NEED_GET_DATA, issue_flags);
1193 			return;
1194 		}
1195 		/*
1196 		 * We have handled UBLK_IO_NEED_GET_DATA command,
1197 		 * so clear UBLK_IO_FLAG_NEED_GET_DATA now and just
1198 		 * do the copy work.
1199 		 */
1200 		io->flags &= ~UBLK_IO_FLAG_NEED_GET_DATA;
1201 		/* update iod->addr because ublksrv may have passed a new io buffer */
1202 		ublk_get_iod(ubq, req->tag)->addr = io->addr;
1203 		pr_devel("%s: update iod->addr: op %d, qid %d tag %d io_flags %x addr %llx\n",
1204 				__func__, io->cmd->cmd_op, ubq->q_id, req->tag, io->flags,
1205 				ublk_get_iod(ubq, req->tag)->addr);
1206 	}
1207 
1208 	mapped_bytes = ublk_map_io(ubq, req, io);
1209 
1210 	/* partially mapped, update io descriptor */
1211 	if (unlikely(mapped_bytes != blk_rq_bytes(req))) {
1212 		/*
1213 		 * Nothing mapped, retry until we succeed.
1214 		 *
1215 		 * We may never succeed in mapping any bytes here because
1216 		 * of OOM. TODO: reserve one buffer with single page pinned
1217 		 * for providing forward progress guarantee.
1218 		 */
1219 		if (unlikely(!mapped_bytes)) {
1220 			blk_mq_requeue_request(req, false);
1221 			blk_mq_delay_kick_requeue_list(req->q,
1222 					UBLK_REQUEUE_DELAY_MS);
1223 			return;
1224 		}
1225 
1226 		ublk_get_iod(ubq, req->tag)->nr_sectors =
1227 			mapped_bytes >> 9;
1228 	}
1229 
1230 	ublk_init_req_ref(ubq, req);
1231 	ubq_complete_io_cmd(io, UBLK_IO_RES_OK, issue_flags);
1232 }
1233 
ublk_forward_io_cmds(struct ublk_queue * ubq,unsigned issue_flags)1234 static inline void ublk_forward_io_cmds(struct ublk_queue *ubq,
1235 					unsigned issue_flags)
1236 {
1237 	struct llist_node *io_cmds = llist_del_all(&ubq->io_cmds);
1238 	struct ublk_rq_data *data, *tmp;
1239 
1240 	io_cmds = llist_reverse_order(io_cmds);
1241 	llist_for_each_entry_safe(data, tmp, io_cmds, node)
1242 		__ublk_rq_task_work(blk_mq_rq_from_pdu(data), issue_flags);
1243 }
1244 
ublk_rq_task_work_cb(struct io_uring_cmd * cmd,unsigned issue_flags)1245 static void ublk_rq_task_work_cb(struct io_uring_cmd *cmd, unsigned issue_flags)
1246 {
1247 	struct ublk_uring_cmd_pdu *pdu = ublk_get_uring_cmd_pdu(cmd);
1248 	struct ublk_queue *ubq = pdu->ubq;
1249 
1250 	ublk_forward_io_cmds(ubq, issue_flags);
1251 }
1252 
ublk_queue_cmd(struct ublk_queue * ubq,struct request * rq)1253 static void ublk_queue_cmd(struct ublk_queue *ubq, struct request *rq)
1254 {
1255 	struct ublk_rq_data *data = blk_mq_rq_to_pdu(rq);
1256 
1257 	if (llist_add(&data->node, &ubq->io_cmds)) {
1258 		struct ublk_io *io = &ubq->ios[rq->tag];
1259 
1260 		io_uring_cmd_complete_in_task(io->cmd, ublk_rq_task_work_cb);
1261 	}
1262 }
1263 
ublk_timeout(struct request * rq)1264 static enum blk_eh_timer_return ublk_timeout(struct request *rq)
1265 {
1266 	struct ublk_queue *ubq = rq->mq_hctx->driver_data;
1267 	unsigned int nr_inflight = 0;
1268 	int i;
1269 
1270 	if (ubq->flags & UBLK_F_UNPRIVILEGED_DEV) {
1271 		if (!ubq->timeout) {
1272 			send_sig(SIGKILL, ubq->ubq_daemon, 0);
1273 			ubq->timeout = true;
1274 		}
1275 
1276 		return BLK_EH_DONE;
1277 	}
1278 
1279 	if (!ubq_daemon_is_dying(ubq))
1280 		return BLK_EH_RESET_TIMER;
1281 
1282 	for (i = 0; i < ubq->q_depth; i++) {
1283 		struct ublk_io *io = &ubq->ios[i];
1284 
1285 		if (!(io->flags & UBLK_IO_FLAG_ACTIVE))
1286 			nr_inflight++;
1287 	}
1288 
1289 	/* cancelable uring_cmd can't help us if all commands are in-flight */
1290 	if (nr_inflight == ubq->q_depth) {
1291 		struct ublk_device *ub = ubq->dev;
1292 
1293 		if (ublk_abort_requests(ub, ubq)) {
1294 			if (ublk_nosrv_should_stop_dev(ub))
1295 				schedule_work(&ub->stop_work);
1296 			else
1297 				schedule_work(&ub->quiesce_work);
1298 		}
1299 		return BLK_EH_DONE;
1300 	}
1301 
1302 	return BLK_EH_RESET_TIMER;
1303 }
1304 
ublk_queue_rq(struct blk_mq_hw_ctx * hctx,const struct blk_mq_queue_data * bd)1305 static blk_status_t ublk_queue_rq(struct blk_mq_hw_ctx *hctx,
1306 		const struct blk_mq_queue_data *bd)
1307 {
1308 	struct ublk_queue *ubq = hctx->driver_data;
1309 	struct request *rq = bd->rq;
1310 	blk_status_t res;
1311 
1312 	/* fill iod to slot in io cmd buffer */
1313 	res = ublk_setup_iod(ubq, rq);
1314 	if (unlikely(res != BLK_STS_OK))
1315 		return BLK_STS_IOERR;
1316 
1317 	/* With recovery feature enabled, force_abort is set in
1318 	 * ublk_stop_dev() before calling del_gendisk(). We have to
1319 	 * abort all requeued and new rqs here to let del_gendisk()
1320 	 * move on. Besides, we cannot not call io_uring_cmd_complete_in_task()
1321 	 * to avoid UAF on io_uring ctx.
1322 	 *
1323 	 * Note: force_abort is guaranteed to be seen because it is set
1324 	 * before request queue is unqiuesced.
1325 	 */
1326 	if (ublk_nosrv_should_queue_io(ubq) && unlikely(ubq->force_abort))
1327 		return BLK_STS_IOERR;
1328 
1329 	if (unlikely(ubq->canceling)) {
1330 		__ublk_abort_rq(ubq, rq);
1331 		return BLK_STS_OK;
1332 	}
1333 
1334 	blk_mq_start_request(bd->rq);
1335 	ublk_queue_cmd(ubq, rq);
1336 
1337 	return BLK_STS_OK;
1338 }
1339 
ublk_init_hctx(struct blk_mq_hw_ctx * hctx,void * driver_data,unsigned int hctx_idx)1340 static int ublk_init_hctx(struct blk_mq_hw_ctx *hctx, void *driver_data,
1341 		unsigned int hctx_idx)
1342 {
1343 	struct ublk_device *ub = driver_data;
1344 	struct ublk_queue *ubq = ublk_get_queue(ub, hctx->queue_num);
1345 
1346 	hctx->driver_data = ubq;
1347 	return 0;
1348 }
1349 
1350 static const struct blk_mq_ops ublk_mq_ops = {
1351 	.queue_rq       = ublk_queue_rq,
1352 	.init_hctx	= ublk_init_hctx,
1353 	.timeout	= ublk_timeout,
1354 };
1355 
ublk_ch_open(struct inode * inode,struct file * filp)1356 static int ublk_ch_open(struct inode *inode, struct file *filp)
1357 {
1358 	struct ublk_device *ub = container_of(inode->i_cdev,
1359 			struct ublk_device, cdev);
1360 
1361 	if (test_and_set_bit(UB_STATE_OPEN, &ub->state))
1362 		return -EBUSY;
1363 	filp->private_data = ub;
1364 	return 0;
1365 }
1366 
ublk_ch_release(struct inode * inode,struct file * filp)1367 static int ublk_ch_release(struct inode *inode, struct file *filp)
1368 {
1369 	struct ublk_device *ub = filp->private_data;
1370 
1371 	clear_bit(UB_STATE_OPEN, &ub->state);
1372 	return 0;
1373 }
1374 
1375 /* map pre-allocated per-queue cmd buffer to ublksrv daemon */
ublk_ch_mmap(struct file * filp,struct vm_area_struct * vma)1376 static int ublk_ch_mmap(struct file *filp, struct vm_area_struct *vma)
1377 {
1378 	struct ublk_device *ub = filp->private_data;
1379 	size_t sz = vma->vm_end - vma->vm_start;
1380 	unsigned max_sz = ublk_max_cmd_buf_size();
1381 	unsigned long pfn, end, phys_off = vma->vm_pgoff << PAGE_SHIFT;
1382 	int q_id, ret = 0;
1383 
1384 	spin_lock(&ub->lock);
1385 	if (!ub->mm)
1386 		ub->mm = current->mm;
1387 	if (current->mm != ub->mm)
1388 		ret = -EINVAL;
1389 	spin_unlock(&ub->lock);
1390 
1391 	if (ret)
1392 		return ret;
1393 
1394 	if (vma->vm_flags & VM_WRITE)
1395 		return -EPERM;
1396 
1397 	end = UBLKSRV_CMD_BUF_OFFSET + ub->dev_info.nr_hw_queues * max_sz;
1398 	if (phys_off < UBLKSRV_CMD_BUF_OFFSET || phys_off >= end)
1399 		return -EINVAL;
1400 
1401 	q_id = (phys_off - UBLKSRV_CMD_BUF_OFFSET) / max_sz;
1402 	pr_devel("%s: qid %d, pid %d, addr %lx pg_off %lx sz %lu\n",
1403 			__func__, q_id, current->pid, vma->vm_start,
1404 			phys_off, (unsigned long)sz);
1405 
1406 	if (sz != ublk_queue_cmd_buf_size(ub, q_id))
1407 		return -EINVAL;
1408 
1409 	pfn = virt_to_phys(ublk_queue_cmd_buf(ub, q_id)) >> PAGE_SHIFT;
1410 	return remap_pfn_range(vma, vma->vm_start, pfn, sz, vma->vm_page_prot);
1411 }
1412 
ublk_commit_completion(struct ublk_device * ub,const struct ublksrv_io_cmd * ub_cmd)1413 static void ublk_commit_completion(struct ublk_device *ub,
1414 		const struct ublksrv_io_cmd *ub_cmd)
1415 {
1416 	u32 qid = ub_cmd->q_id, tag = ub_cmd->tag;
1417 	struct ublk_queue *ubq = ublk_get_queue(ub, qid);
1418 	struct ublk_io *io = &ubq->ios[tag];
1419 	struct request *req;
1420 
1421 	/* now this cmd slot is owned by nbd driver */
1422 	io->flags &= ~UBLK_IO_FLAG_OWNED_BY_SRV;
1423 	io->res = ub_cmd->result;
1424 
1425 	/* find the io request and complete */
1426 	req = blk_mq_tag_to_rq(ub->tag_set.tags[qid], tag);
1427 	if (WARN_ON_ONCE(unlikely(!req)))
1428 		return;
1429 
1430 	if (req_op(req) == REQ_OP_ZONE_APPEND)
1431 		req->__sector = ub_cmd->zone_append_lba;
1432 
1433 	if (likely(!blk_should_fake_timeout(req->q)))
1434 		ublk_put_req_ref(ubq, req);
1435 }
1436 
1437 /*
1438  * Called from ubq_daemon context via cancel fn, meantime quiesce ublk
1439  * blk-mq queue, so we are called exclusively with blk-mq and ubq_daemon
1440  * context, so everything is serialized.
1441  */
ublk_abort_queue(struct ublk_device * ub,struct ublk_queue * ubq)1442 static void ublk_abort_queue(struct ublk_device *ub, struct ublk_queue *ubq)
1443 {
1444 	int i;
1445 
1446 	for (i = 0; i < ubq->q_depth; i++) {
1447 		struct ublk_io *io = &ubq->ios[i];
1448 
1449 		if (!(io->flags & UBLK_IO_FLAG_ACTIVE)) {
1450 			struct request *rq;
1451 
1452 			/*
1453 			 * Either we fail the request or ublk_rq_task_work_fn
1454 			 * will do it
1455 			 */
1456 			rq = blk_mq_tag_to_rq(ub->tag_set.tags[ubq->q_id], i);
1457 			if (rq && blk_mq_request_started(rq)) {
1458 				io->flags |= UBLK_IO_FLAG_ABORTED;
1459 				__ublk_fail_req(ubq, io, rq);
1460 			}
1461 		}
1462 	}
1463 }
1464 
1465 /* Must be called when queue is frozen */
ublk_mark_queue_canceling(struct ublk_queue * ubq)1466 static bool ublk_mark_queue_canceling(struct ublk_queue *ubq)
1467 {
1468 	bool canceled;
1469 
1470 	spin_lock(&ubq->cancel_lock);
1471 	canceled = ubq->canceling;
1472 	if (!canceled)
1473 		ubq->canceling = true;
1474 	spin_unlock(&ubq->cancel_lock);
1475 
1476 	return canceled;
1477 }
1478 
ublk_abort_requests(struct ublk_device * ub,struct ublk_queue * ubq)1479 static bool ublk_abort_requests(struct ublk_device *ub, struct ublk_queue *ubq)
1480 {
1481 	bool was_canceled = ubq->canceling;
1482 	struct gendisk *disk;
1483 
1484 	if (was_canceled)
1485 		return false;
1486 
1487 	spin_lock(&ub->lock);
1488 	disk = ub->ub_disk;
1489 	if (disk)
1490 		get_device(disk_to_dev(disk));
1491 	spin_unlock(&ub->lock);
1492 
1493 	/* Our disk has been dead */
1494 	if (!disk)
1495 		return false;
1496 
1497 	/*
1498 	 * Now we are serialized with ublk_queue_rq()
1499 	 *
1500 	 * Make sure that ubq->canceling is set when queue is frozen,
1501 	 * because ublk_queue_rq() has to rely on this flag for avoiding to
1502 	 * touch completed uring_cmd
1503 	 */
1504 	blk_mq_quiesce_queue(disk->queue);
1505 	was_canceled = ublk_mark_queue_canceling(ubq);
1506 	if (!was_canceled) {
1507 		/* abort queue is for making forward progress */
1508 		ublk_abort_queue(ub, ubq);
1509 	}
1510 	blk_mq_unquiesce_queue(disk->queue);
1511 	put_device(disk_to_dev(disk));
1512 
1513 	return !was_canceled;
1514 }
1515 
ublk_cancel_cmd(struct ublk_queue * ubq,struct ublk_io * io,unsigned int issue_flags)1516 static void ublk_cancel_cmd(struct ublk_queue *ubq, struct ublk_io *io,
1517 		unsigned int issue_flags)
1518 {
1519 	bool done;
1520 
1521 	if (!(io->flags & UBLK_IO_FLAG_ACTIVE))
1522 		return;
1523 
1524 	spin_lock(&ubq->cancel_lock);
1525 	done = !!(io->flags & UBLK_IO_FLAG_CANCELED);
1526 	if (!done)
1527 		io->flags |= UBLK_IO_FLAG_CANCELED;
1528 	spin_unlock(&ubq->cancel_lock);
1529 
1530 	if (!done)
1531 		io_uring_cmd_done(io->cmd, UBLK_IO_RES_ABORT, 0, issue_flags);
1532 }
1533 
1534 /*
1535  * The ublk char device won't be closed when calling cancel fn, so both
1536  * ublk device and queue are guaranteed to be live
1537  */
ublk_uring_cmd_cancel_fn(struct io_uring_cmd * cmd,unsigned int issue_flags)1538 static void ublk_uring_cmd_cancel_fn(struct io_uring_cmd *cmd,
1539 		unsigned int issue_flags)
1540 {
1541 	struct ublk_uring_cmd_pdu *pdu = ublk_get_uring_cmd_pdu(cmd);
1542 	struct ublk_queue *ubq = pdu->ubq;
1543 	struct task_struct *task;
1544 	struct ublk_device *ub;
1545 	bool need_schedule;
1546 	struct ublk_io *io;
1547 
1548 	if (WARN_ON_ONCE(!ubq))
1549 		return;
1550 
1551 	if (WARN_ON_ONCE(pdu->tag >= ubq->q_depth))
1552 		return;
1553 
1554 	task = io_uring_cmd_get_task(cmd);
1555 	if (WARN_ON_ONCE(task && task != ubq->ubq_daemon))
1556 		return;
1557 
1558 	ub = ubq->dev;
1559 	need_schedule = ublk_abort_requests(ub, ubq);
1560 
1561 	io = &ubq->ios[pdu->tag];
1562 	WARN_ON_ONCE(io->cmd != cmd);
1563 	ublk_cancel_cmd(ubq, io, issue_flags);
1564 
1565 	if (need_schedule) {
1566 		if (ublk_nosrv_should_stop_dev(ub))
1567 			schedule_work(&ub->stop_work);
1568 		else
1569 			schedule_work(&ub->quiesce_work);
1570 	}
1571 }
1572 
ublk_queue_ready(struct ublk_queue * ubq)1573 static inline bool ublk_queue_ready(struct ublk_queue *ubq)
1574 {
1575 	return ubq->nr_io_ready == ubq->q_depth;
1576 }
1577 
ublk_cancel_queue(struct ublk_queue * ubq)1578 static void ublk_cancel_queue(struct ublk_queue *ubq)
1579 {
1580 	int i;
1581 
1582 	for (i = 0; i < ubq->q_depth; i++)
1583 		ublk_cancel_cmd(ubq, &ubq->ios[i], IO_URING_F_UNLOCKED);
1584 }
1585 
1586 /* Cancel all pending commands, must be called after del_gendisk() returns */
ublk_cancel_dev(struct ublk_device * ub)1587 static void ublk_cancel_dev(struct ublk_device *ub)
1588 {
1589 	int i;
1590 
1591 	for (i = 0; i < ub->dev_info.nr_hw_queues; i++)
1592 		ublk_cancel_queue(ublk_get_queue(ub, i));
1593 }
1594 
ublk_check_inflight_rq(struct request * rq,void * data)1595 static bool ublk_check_inflight_rq(struct request *rq, void *data)
1596 {
1597 	bool *idle = data;
1598 
1599 	if (blk_mq_request_started(rq)) {
1600 		*idle = false;
1601 		return false;
1602 	}
1603 	return true;
1604 }
1605 
ublk_wait_tagset_rqs_idle(struct ublk_device * ub)1606 static void ublk_wait_tagset_rqs_idle(struct ublk_device *ub)
1607 {
1608 	bool idle;
1609 
1610 	WARN_ON_ONCE(!blk_queue_quiesced(ub->ub_disk->queue));
1611 	while (true) {
1612 		idle = true;
1613 		blk_mq_tagset_busy_iter(&ub->tag_set,
1614 				ublk_check_inflight_rq, &idle);
1615 		if (idle)
1616 			break;
1617 		msleep(UBLK_REQUEUE_DELAY_MS);
1618 	}
1619 }
1620 
__ublk_quiesce_dev(struct ublk_device * ub)1621 static void __ublk_quiesce_dev(struct ublk_device *ub)
1622 {
1623 	pr_devel("%s: quiesce ub: dev_id %d state %s\n",
1624 			__func__, ub->dev_info.dev_id,
1625 			ub->dev_info.state == UBLK_S_DEV_LIVE ?
1626 			"LIVE" : "QUIESCED");
1627 	blk_mq_quiesce_queue(ub->ub_disk->queue);
1628 	ublk_wait_tagset_rqs_idle(ub);
1629 	ub->dev_info.state = UBLK_S_DEV_QUIESCED;
1630 }
1631 
ublk_quiesce_work_fn(struct work_struct * work)1632 static void ublk_quiesce_work_fn(struct work_struct *work)
1633 {
1634 	struct ublk_device *ub =
1635 		container_of(work, struct ublk_device, quiesce_work);
1636 
1637 	mutex_lock(&ub->mutex);
1638 	if (ub->dev_info.state != UBLK_S_DEV_LIVE)
1639 		goto unlock;
1640 	__ublk_quiesce_dev(ub);
1641  unlock:
1642 	mutex_unlock(&ub->mutex);
1643 	ublk_cancel_dev(ub);
1644 }
1645 
ublk_unquiesce_dev(struct ublk_device * ub)1646 static void ublk_unquiesce_dev(struct ublk_device *ub)
1647 {
1648 	int i;
1649 
1650 	pr_devel("%s: unquiesce ub: dev_id %d state %s\n",
1651 			__func__, ub->dev_info.dev_id,
1652 			ub->dev_info.state == UBLK_S_DEV_LIVE ?
1653 			"LIVE" : "QUIESCED");
1654 	/* quiesce_work has run. We let requeued rqs be aborted
1655 	 * before running fallback_wq. "force_abort" must be seen
1656 	 * after request queue is unqiuesced. Then del_gendisk()
1657 	 * can move on.
1658 	 */
1659 	for (i = 0; i < ub->dev_info.nr_hw_queues; i++)
1660 		ublk_get_queue(ub, i)->force_abort = true;
1661 
1662 	blk_mq_unquiesce_queue(ub->ub_disk->queue);
1663 	/* We may have requeued some rqs in ublk_quiesce_queue() */
1664 	blk_mq_kick_requeue_list(ub->ub_disk->queue);
1665 }
1666 
ublk_detach_disk(struct ublk_device * ub)1667 static struct gendisk *ublk_detach_disk(struct ublk_device *ub)
1668 {
1669 	struct gendisk *disk;
1670 
1671 	/* Sync with ublk_abort_queue() by holding the lock */
1672 	spin_lock(&ub->lock);
1673 	disk = ub->ub_disk;
1674 	ub->dev_info.state = UBLK_S_DEV_DEAD;
1675 	ub->dev_info.ublksrv_pid = -1;
1676 	ub->ub_disk = NULL;
1677 	spin_unlock(&ub->lock);
1678 
1679 	return disk;
1680 }
1681 
ublk_stop_dev(struct ublk_device * ub)1682 static void ublk_stop_dev(struct ublk_device *ub)
1683 {
1684 	struct gendisk *disk;
1685 
1686 	mutex_lock(&ub->mutex);
1687 	if (ub->dev_info.state == UBLK_S_DEV_DEAD)
1688 		goto unlock;
1689 	if (ublk_nosrv_dev_should_queue_io(ub)) {
1690 		if (ub->dev_info.state == UBLK_S_DEV_LIVE)
1691 			__ublk_quiesce_dev(ub);
1692 		ublk_unquiesce_dev(ub);
1693 	}
1694 	del_gendisk(ub->ub_disk);
1695 	disk = ublk_detach_disk(ub);
1696 	put_disk(disk);
1697  unlock:
1698 	mutex_unlock(&ub->mutex);
1699 	ublk_cancel_dev(ub);
1700 }
1701 
1702 /* device can only be started after all IOs are ready */
ublk_mark_io_ready(struct ublk_device * ub,struct ublk_queue * ubq)1703 static void ublk_mark_io_ready(struct ublk_device *ub, struct ublk_queue *ubq)
1704 {
1705 	mutex_lock(&ub->mutex);
1706 	ubq->nr_io_ready++;
1707 	if (ublk_queue_ready(ubq)) {
1708 		ubq->ubq_daemon = current;
1709 		get_task_struct(ubq->ubq_daemon);
1710 		ub->nr_queues_ready++;
1711 
1712 		if (capable(CAP_SYS_ADMIN))
1713 			ub->nr_privileged_daemon++;
1714 	}
1715 	if (ub->nr_queues_ready == ub->dev_info.nr_hw_queues)
1716 		complete_all(&ub->completion);
1717 	mutex_unlock(&ub->mutex);
1718 }
1719 
ublk_handle_need_get_data(struct ublk_device * ub,int q_id,int tag)1720 static void ublk_handle_need_get_data(struct ublk_device *ub, int q_id,
1721 		int tag)
1722 {
1723 	struct ublk_queue *ubq = ublk_get_queue(ub, q_id);
1724 	struct request *req = blk_mq_tag_to_rq(ub->tag_set.tags[q_id], tag);
1725 
1726 	ublk_queue_cmd(ubq, req);
1727 }
1728 
ublk_check_cmd_op(u32 cmd_op)1729 static inline int ublk_check_cmd_op(u32 cmd_op)
1730 {
1731 	u32 ioc_type = _IOC_TYPE(cmd_op);
1732 
1733 	if (!IS_ENABLED(CONFIG_BLKDEV_UBLK_LEGACY_OPCODES) && ioc_type != 'u')
1734 		return -EOPNOTSUPP;
1735 
1736 	if (ioc_type != 'u' && ioc_type != 0)
1737 		return -EOPNOTSUPP;
1738 
1739 	return 0;
1740 }
1741 
ublk_fill_io_cmd(struct ublk_io * io,struct io_uring_cmd * cmd,unsigned long buf_addr)1742 static inline void ublk_fill_io_cmd(struct ublk_io *io,
1743 		struct io_uring_cmd *cmd, unsigned long buf_addr)
1744 {
1745 	io->cmd = cmd;
1746 	io->flags |= UBLK_IO_FLAG_ACTIVE;
1747 	io->addr = buf_addr;
1748 }
1749 
ublk_prep_cancel(struct io_uring_cmd * cmd,unsigned int issue_flags,struct ublk_queue * ubq,unsigned int tag)1750 static inline void ublk_prep_cancel(struct io_uring_cmd *cmd,
1751 				    unsigned int issue_flags,
1752 				    struct ublk_queue *ubq, unsigned int tag)
1753 {
1754 	struct ublk_uring_cmd_pdu *pdu = ublk_get_uring_cmd_pdu(cmd);
1755 
1756 	/*
1757 	 * Safe to refer to @ubq since ublk_queue won't be died until its
1758 	 * commands are completed
1759 	 */
1760 	pdu->ubq = ubq;
1761 	pdu->tag = tag;
1762 	io_uring_cmd_mark_cancelable(cmd, issue_flags);
1763 }
1764 
__ublk_ch_uring_cmd(struct io_uring_cmd * cmd,unsigned int issue_flags,const struct ublksrv_io_cmd * ub_cmd)1765 static int __ublk_ch_uring_cmd(struct io_uring_cmd *cmd,
1766 			       unsigned int issue_flags,
1767 			       const struct ublksrv_io_cmd *ub_cmd)
1768 {
1769 	struct ublk_device *ub = cmd->file->private_data;
1770 	struct ublk_queue *ubq;
1771 	struct ublk_io *io;
1772 	u32 cmd_op = cmd->cmd_op;
1773 	unsigned tag = ub_cmd->tag;
1774 	int ret = -EINVAL;
1775 	struct request *req;
1776 
1777 	pr_devel("%s: received: cmd op %d queue %d tag %d result %d\n",
1778 			__func__, cmd->cmd_op, ub_cmd->q_id, tag,
1779 			ub_cmd->result);
1780 
1781 	if (ub_cmd->q_id >= ub->dev_info.nr_hw_queues)
1782 		goto out;
1783 
1784 	ubq = ublk_get_queue(ub, ub_cmd->q_id);
1785 	if (!ubq || ub_cmd->q_id != ubq->q_id)
1786 		goto out;
1787 
1788 	if (ubq->ubq_daemon && ubq->ubq_daemon != current)
1789 		goto out;
1790 
1791 	if (tag >= ubq->q_depth)
1792 		goto out;
1793 
1794 	io = &ubq->ios[tag];
1795 
1796 	/* there is pending io cmd, something must be wrong */
1797 	if (io->flags & UBLK_IO_FLAG_ACTIVE) {
1798 		ret = -EBUSY;
1799 		goto out;
1800 	}
1801 
1802 	/*
1803 	 * ensure that the user issues UBLK_IO_NEED_GET_DATA
1804 	 * iff the driver have set the UBLK_IO_FLAG_NEED_GET_DATA.
1805 	 */
1806 	if ((!!(io->flags & UBLK_IO_FLAG_NEED_GET_DATA))
1807 			^ (_IOC_NR(cmd_op) == UBLK_IO_NEED_GET_DATA))
1808 		goto out;
1809 
1810 	ret = ublk_check_cmd_op(cmd_op);
1811 	if (ret)
1812 		goto out;
1813 
1814 	ret = -EINVAL;
1815 	switch (_IOC_NR(cmd_op)) {
1816 	case UBLK_IO_FETCH_REQ:
1817 		/* UBLK_IO_FETCH_REQ is only allowed before queue is setup */
1818 		if (ublk_queue_ready(ubq)) {
1819 			ret = -EBUSY;
1820 			goto out;
1821 		}
1822 		/*
1823 		 * The io is being handled by server, so COMMIT_RQ is expected
1824 		 * instead of FETCH_REQ
1825 		 */
1826 		if (io->flags & UBLK_IO_FLAG_OWNED_BY_SRV)
1827 			goto out;
1828 
1829 		if (!ublk_support_user_copy(ubq)) {
1830 			/*
1831 			 * FETCH_RQ has to provide IO buffer if NEED GET
1832 			 * DATA is not enabled
1833 			 */
1834 			if (!ub_cmd->addr && !ublk_need_get_data(ubq))
1835 				goto out;
1836 		} else if (ub_cmd->addr) {
1837 			/* User copy requires addr to be unset */
1838 			ret = -EINVAL;
1839 			goto out;
1840 		}
1841 
1842 		ublk_fill_io_cmd(io, cmd, ub_cmd->addr);
1843 		ublk_mark_io_ready(ub, ubq);
1844 		break;
1845 	case UBLK_IO_COMMIT_AND_FETCH_REQ:
1846 		req = blk_mq_tag_to_rq(ub->tag_set.tags[ub_cmd->q_id], tag);
1847 
1848 		if (!(io->flags & UBLK_IO_FLAG_OWNED_BY_SRV))
1849 			goto out;
1850 
1851 		if (!ublk_support_user_copy(ubq)) {
1852 			/*
1853 			 * COMMIT_AND_FETCH_REQ has to provide IO buffer if
1854 			 * NEED GET DATA is not enabled or it is Read IO.
1855 			 */
1856 			if (!ub_cmd->addr && (!ublk_need_get_data(ubq) ||
1857 						req_op(req) == REQ_OP_READ))
1858 				goto out;
1859 		} else if (req_op(req) != REQ_OP_ZONE_APPEND && ub_cmd->addr) {
1860 			/*
1861 			 * User copy requires addr to be unset when command is
1862 			 * not zone append
1863 			 */
1864 			ret = -EINVAL;
1865 			goto out;
1866 		}
1867 
1868 		ublk_fill_io_cmd(io, cmd, ub_cmd->addr);
1869 		ublk_commit_completion(ub, ub_cmd);
1870 		break;
1871 	case UBLK_IO_NEED_GET_DATA:
1872 		if (!(io->flags & UBLK_IO_FLAG_OWNED_BY_SRV))
1873 			goto out;
1874 		ublk_fill_io_cmd(io, cmd, ub_cmd->addr);
1875 		ublk_handle_need_get_data(ub, ub_cmd->q_id, ub_cmd->tag);
1876 		break;
1877 	default:
1878 		goto out;
1879 	}
1880 	ublk_prep_cancel(cmd, issue_flags, ubq, tag);
1881 	return -EIOCBQUEUED;
1882 
1883  out:
1884 	pr_devel("%s: complete: cmd op %d, tag %d ret %x io_flags %x\n",
1885 			__func__, cmd_op, tag, ret, io->flags);
1886 	return ret;
1887 }
1888 
__ublk_check_and_get_req(struct ublk_device * ub,struct ublk_queue * ubq,int tag,size_t offset)1889 static inline struct request *__ublk_check_and_get_req(struct ublk_device *ub,
1890 		struct ublk_queue *ubq, int tag, size_t offset)
1891 {
1892 	struct request *req;
1893 
1894 	if (!ublk_need_req_ref(ubq))
1895 		return NULL;
1896 
1897 	req = blk_mq_tag_to_rq(ub->tag_set.tags[ubq->q_id], tag);
1898 	if (!req)
1899 		return NULL;
1900 
1901 	if (!ublk_get_req_ref(ubq, req))
1902 		return NULL;
1903 
1904 	if (unlikely(!blk_mq_request_started(req) || req->tag != tag))
1905 		goto fail_put;
1906 
1907 	if (!ublk_rq_has_data(req))
1908 		goto fail_put;
1909 
1910 	if (offset > blk_rq_bytes(req))
1911 		goto fail_put;
1912 
1913 	return req;
1914 fail_put:
1915 	ublk_put_req_ref(ubq, req);
1916 	return NULL;
1917 }
1918 
ublk_ch_uring_cmd_local(struct io_uring_cmd * cmd,unsigned int issue_flags)1919 static inline int ublk_ch_uring_cmd_local(struct io_uring_cmd *cmd,
1920 		unsigned int issue_flags)
1921 {
1922 	/*
1923 	 * Not necessary for async retry, but let's keep it simple and always
1924 	 * copy the values to avoid any potential reuse.
1925 	 */
1926 	const struct ublksrv_io_cmd *ub_src = io_uring_sqe_cmd(cmd->sqe);
1927 	const struct ublksrv_io_cmd ub_cmd = {
1928 		.q_id = READ_ONCE(ub_src->q_id),
1929 		.tag = READ_ONCE(ub_src->tag),
1930 		.result = READ_ONCE(ub_src->result),
1931 		.addr = READ_ONCE(ub_src->addr)
1932 	};
1933 
1934 	WARN_ON_ONCE(issue_flags & IO_URING_F_UNLOCKED);
1935 
1936 	return __ublk_ch_uring_cmd(cmd, issue_flags, &ub_cmd);
1937 }
1938 
ublk_ch_uring_cmd_cb(struct io_uring_cmd * cmd,unsigned int issue_flags)1939 static void ublk_ch_uring_cmd_cb(struct io_uring_cmd *cmd,
1940 		unsigned int issue_flags)
1941 {
1942 	int ret = ublk_ch_uring_cmd_local(cmd, issue_flags);
1943 
1944 	if (ret != -EIOCBQUEUED)
1945 		io_uring_cmd_done(cmd, ret, 0, issue_flags);
1946 }
1947 
ublk_ch_uring_cmd(struct io_uring_cmd * cmd,unsigned int issue_flags)1948 static int ublk_ch_uring_cmd(struct io_uring_cmd *cmd, unsigned int issue_flags)
1949 {
1950 	if (unlikely(issue_flags & IO_URING_F_CANCEL)) {
1951 		ublk_uring_cmd_cancel_fn(cmd, issue_flags);
1952 		return 0;
1953 	}
1954 
1955 	/* well-implemented server won't run into unlocked */
1956 	if (unlikely(issue_flags & IO_URING_F_UNLOCKED)) {
1957 		io_uring_cmd_complete_in_task(cmd, ublk_ch_uring_cmd_cb);
1958 		return -EIOCBQUEUED;
1959 	}
1960 
1961 	return ublk_ch_uring_cmd_local(cmd, issue_flags);
1962 }
1963 
ublk_check_ubuf_dir(const struct request * req,int ubuf_dir)1964 static inline bool ublk_check_ubuf_dir(const struct request *req,
1965 		int ubuf_dir)
1966 {
1967 	/* copy ubuf to request pages */
1968 	if ((req_op(req) == REQ_OP_READ || req_op(req) == REQ_OP_DRV_IN) &&
1969 	    ubuf_dir == ITER_SOURCE)
1970 		return true;
1971 
1972 	/* copy request pages to ubuf */
1973 	if ((req_op(req) == REQ_OP_WRITE ||
1974 	     req_op(req) == REQ_OP_ZONE_APPEND) &&
1975 	    ubuf_dir == ITER_DEST)
1976 		return true;
1977 
1978 	return false;
1979 }
1980 
ublk_check_and_get_req(struct kiocb * iocb,struct iov_iter * iter,size_t * off,int dir)1981 static struct request *ublk_check_and_get_req(struct kiocb *iocb,
1982 		struct iov_iter *iter, size_t *off, int dir)
1983 {
1984 	struct ublk_device *ub = iocb->ki_filp->private_data;
1985 	struct ublk_queue *ubq;
1986 	struct request *req;
1987 	size_t buf_off;
1988 	u16 tag, q_id;
1989 
1990 	if (!ub)
1991 		return ERR_PTR(-EACCES);
1992 
1993 	if (!user_backed_iter(iter))
1994 		return ERR_PTR(-EACCES);
1995 
1996 	if (ub->dev_info.state == UBLK_S_DEV_DEAD)
1997 		return ERR_PTR(-EACCES);
1998 
1999 	tag = ublk_pos_to_tag(iocb->ki_pos);
2000 	q_id = ublk_pos_to_hwq(iocb->ki_pos);
2001 	buf_off = ublk_pos_to_buf_off(iocb->ki_pos);
2002 
2003 	if (q_id >= ub->dev_info.nr_hw_queues)
2004 		return ERR_PTR(-EINVAL);
2005 
2006 	ubq = ublk_get_queue(ub, q_id);
2007 	if (!ubq)
2008 		return ERR_PTR(-EINVAL);
2009 
2010 	if (tag >= ubq->q_depth)
2011 		return ERR_PTR(-EINVAL);
2012 
2013 	req = __ublk_check_and_get_req(ub, ubq, tag, buf_off);
2014 	if (!req)
2015 		return ERR_PTR(-EINVAL);
2016 
2017 	if (!req->mq_hctx || !req->mq_hctx->driver_data)
2018 		goto fail;
2019 
2020 	if (!ublk_check_ubuf_dir(req, dir))
2021 		goto fail;
2022 
2023 	*off = buf_off;
2024 	return req;
2025 fail:
2026 	ublk_put_req_ref(ubq, req);
2027 	return ERR_PTR(-EACCES);
2028 }
2029 
ublk_ch_read_iter(struct kiocb * iocb,struct iov_iter * to)2030 static ssize_t ublk_ch_read_iter(struct kiocb *iocb, struct iov_iter *to)
2031 {
2032 	struct ublk_queue *ubq;
2033 	struct request *req;
2034 	size_t buf_off;
2035 	size_t ret;
2036 
2037 	req = ublk_check_and_get_req(iocb, to, &buf_off, ITER_DEST);
2038 	if (IS_ERR(req))
2039 		return PTR_ERR(req);
2040 
2041 	ret = ublk_copy_user_pages(req, buf_off, to, ITER_DEST);
2042 	ubq = req->mq_hctx->driver_data;
2043 	ublk_put_req_ref(ubq, req);
2044 
2045 	return ret;
2046 }
2047 
ublk_ch_write_iter(struct kiocb * iocb,struct iov_iter * from)2048 static ssize_t ublk_ch_write_iter(struct kiocb *iocb, struct iov_iter *from)
2049 {
2050 	struct ublk_queue *ubq;
2051 	struct request *req;
2052 	size_t buf_off;
2053 	size_t ret;
2054 
2055 	req = ublk_check_and_get_req(iocb, from, &buf_off, ITER_SOURCE);
2056 	if (IS_ERR(req))
2057 		return PTR_ERR(req);
2058 
2059 	ret = ublk_copy_user_pages(req, buf_off, from, ITER_SOURCE);
2060 	ubq = req->mq_hctx->driver_data;
2061 	ublk_put_req_ref(ubq, req);
2062 
2063 	return ret;
2064 }
2065 
2066 static const struct file_operations ublk_ch_fops = {
2067 	.owner = THIS_MODULE,
2068 	.open = ublk_ch_open,
2069 	.release = ublk_ch_release,
2070 	.read_iter = ublk_ch_read_iter,
2071 	.write_iter = ublk_ch_write_iter,
2072 	.uring_cmd = ublk_ch_uring_cmd,
2073 	.mmap = ublk_ch_mmap,
2074 };
2075 
ublk_deinit_queue(struct ublk_device * ub,int q_id)2076 static void ublk_deinit_queue(struct ublk_device *ub, int q_id)
2077 {
2078 	int size = ublk_queue_cmd_buf_size(ub, q_id);
2079 	struct ublk_queue *ubq = ublk_get_queue(ub, q_id);
2080 
2081 	if (ubq->ubq_daemon)
2082 		put_task_struct(ubq->ubq_daemon);
2083 	if (ubq->io_cmd_buf)
2084 		free_pages((unsigned long)ubq->io_cmd_buf, get_order(size));
2085 }
2086 
ublk_init_queue(struct ublk_device * ub,int q_id)2087 static int ublk_init_queue(struct ublk_device *ub, int q_id)
2088 {
2089 	struct ublk_queue *ubq = ublk_get_queue(ub, q_id);
2090 	gfp_t gfp_flags = GFP_KERNEL | __GFP_ZERO;
2091 	void *ptr;
2092 	int size;
2093 
2094 	spin_lock_init(&ubq->cancel_lock);
2095 	ubq->flags = ub->dev_info.flags;
2096 	ubq->q_id = q_id;
2097 	ubq->q_depth = ub->dev_info.queue_depth;
2098 	size = ublk_queue_cmd_buf_size(ub, q_id);
2099 
2100 	ptr = (void *) __get_free_pages(gfp_flags, get_order(size));
2101 	if (!ptr)
2102 		return -ENOMEM;
2103 
2104 	ubq->io_cmd_buf = ptr;
2105 	ubq->dev = ub;
2106 	return 0;
2107 }
2108 
ublk_deinit_queues(struct ublk_device * ub)2109 static void ublk_deinit_queues(struct ublk_device *ub)
2110 {
2111 	int nr_queues = ub->dev_info.nr_hw_queues;
2112 	int i;
2113 
2114 	if (!ub->__queues)
2115 		return;
2116 
2117 	for (i = 0; i < nr_queues; i++)
2118 		ublk_deinit_queue(ub, i);
2119 	kvfree(ub->__queues);
2120 }
2121 
ublk_init_queues(struct ublk_device * ub)2122 static int ublk_init_queues(struct ublk_device *ub)
2123 {
2124 	int nr_queues = ub->dev_info.nr_hw_queues;
2125 	int depth = ub->dev_info.queue_depth;
2126 	int ubq_size = sizeof(struct ublk_queue) + depth * sizeof(struct ublk_io);
2127 	int i, ret = -ENOMEM;
2128 
2129 	ub->queue_size = ubq_size;
2130 	ub->__queues = kvcalloc(nr_queues, ubq_size, GFP_KERNEL);
2131 	if (!ub->__queues)
2132 		return ret;
2133 
2134 	for (i = 0; i < nr_queues; i++) {
2135 		if (ublk_init_queue(ub, i))
2136 			goto fail;
2137 	}
2138 
2139 	init_completion(&ub->completion);
2140 	return 0;
2141 
2142  fail:
2143 	ublk_deinit_queues(ub);
2144 	return ret;
2145 }
2146 
ublk_alloc_dev_number(struct ublk_device * ub,int idx)2147 static int ublk_alloc_dev_number(struct ublk_device *ub, int idx)
2148 {
2149 	int i = idx;
2150 	int err;
2151 
2152 	spin_lock(&ublk_idr_lock);
2153 	/* allocate id, if @id >= 0, we're requesting that specific id */
2154 	if (i >= 0) {
2155 		err = idr_alloc(&ublk_index_idr, ub, i, i + 1, GFP_NOWAIT);
2156 		if (err == -ENOSPC)
2157 			err = -EEXIST;
2158 	} else {
2159 		err = idr_alloc(&ublk_index_idr, ub, 0, UBLK_MAX_UBLKS,
2160 				GFP_NOWAIT);
2161 	}
2162 	spin_unlock(&ublk_idr_lock);
2163 
2164 	if (err >= 0)
2165 		ub->ub_number = err;
2166 
2167 	return err;
2168 }
2169 
ublk_free_dev_number(struct ublk_device * ub)2170 static void ublk_free_dev_number(struct ublk_device *ub)
2171 {
2172 	spin_lock(&ublk_idr_lock);
2173 	idr_remove(&ublk_index_idr, ub->ub_number);
2174 	wake_up_all(&ublk_idr_wq);
2175 	spin_unlock(&ublk_idr_lock);
2176 }
2177 
ublk_cdev_rel(struct device * dev)2178 static void ublk_cdev_rel(struct device *dev)
2179 {
2180 	struct ublk_device *ub = container_of(dev, struct ublk_device, cdev_dev);
2181 
2182 	blk_mq_free_tag_set(&ub->tag_set);
2183 	ublk_deinit_queues(ub);
2184 	ublk_free_dev_number(ub);
2185 	mutex_destroy(&ub->mutex);
2186 	kfree(ub);
2187 }
2188 
ublk_add_chdev(struct ublk_device * ub)2189 static int ublk_add_chdev(struct ublk_device *ub)
2190 {
2191 	struct device *dev = &ub->cdev_dev;
2192 	int minor = ub->ub_number;
2193 	int ret;
2194 
2195 	dev->parent = ublk_misc.this_device;
2196 	dev->devt = MKDEV(MAJOR(ublk_chr_devt), minor);
2197 	dev->class = &ublk_chr_class;
2198 	dev->release = ublk_cdev_rel;
2199 	device_initialize(dev);
2200 
2201 	ret = dev_set_name(dev, "ublkc%d", minor);
2202 	if (ret)
2203 		goto fail;
2204 
2205 	cdev_init(&ub->cdev, &ublk_ch_fops);
2206 	ret = cdev_device_add(&ub->cdev, dev);
2207 	if (ret)
2208 		goto fail;
2209 
2210 	if (ub->dev_info.flags & UBLK_F_UNPRIVILEGED_DEV)
2211 		unprivileged_ublks_added++;
2212 	return 0;
2213  fail:
2214 	put_device(dev);
2215 	return ret;
2216 }
2217 
ublk_stop_work_fn(struct work_struct * work)2218 static void ublk_stop_work_fn(struct work_struct *work)
2219 {
2220 	struct ublk_device *ub =
2221 		container_of(work, struct ublk_device, stop_work);
2222 
2223 	ublk_stop_dev(ub);
2224 }
2225 
2226 /* align max io buffer size with PAGE_SIZE */
ublk_align_max_io_size(struct ublk_device * ub)2227 static void ublk_align_max_io_size(struct ublk_device *ub)
2228 {
2229 	unsigned int max_io_bytes = ub->dev_info.max_io_buf_bytes;
2230 
2231 	ub->dev_info.max_io_buf_bytes =
2232 		round_down(max_io_bytes, PAGE_SIZE);
2233 }
2234 
ublk_add_tag_set(struct ublk_device * ub)2235 static int ublk_add_tag_set(struct ublk_device *ub)
2236 {
2237 	ub->tag_set.ops = &ublk_mq_ops;
2238 	ub->tag_set.nr_hw_queues = ub->dev_info.nr_hw_queues;
2239 	ub->tag_set.queue_depth = ub->dev_info.queue_depth;
2240 	ub->tag_set.numa_node = NUMA_NO_NODE;
2241 	ub->tag_set.cmd_size = sizeof(struct ublk_rq_data);
2242 	ub->tag_set.flags = BLK_MQ_F_SHOULD_MERGE;
2243 	ub->tag_set.driver_data = ub;
2244 	return blk_mq_alloc_tag_set(&ub->tag_set);
2245 }
2246 
ublk_remove(struct ublk_device * ub)2247 static void ublk_remove(struct ublk_device *ub)
2248 {
2249 	bool unprivileged;
2250 
2251 	ublk_stop_dev(ub);
2252 	cancel_work_sync(&ub->stop_work);
2253 	cancel_work_sync(&ub->quiesce_work);
2254 	cdev_device_del(&ub->cdev, &ub->cdev_dev);
2255 	unprivileged = ub->dev_info.flags & UBLK_F_UNPRIVILEGED_DEV;
2256 	ublk_put_device(ub);
2257 
2258 	if (unprivileged)
2259 		unprivileged_ublks_added--;
2260 }
2261 
ublk_get_device_from_id(int idx)2262 static struct ublk_device *ublk_get_device_from_id(int idx)
2263 {
2264 	struct ublk_device *ub = NULL;
2265 
2266 	if (idx < 0)
2267 		return NULL;
2268 
2269 	spin_lock(&ublk_idr_lock);
2270 	ub = idr_find(&ublk_index_idr, idx);
2271 	if (ub)
2272 		ub = ublk_get_device(ub);
2273 	spin_unlock(&ublk_idr_lock);
2274 
2275 	return ub;
2276 }
2277 
ublk_ctrl_start_dev(struct ublk_device * ub,struct io_uring_cmd * cmd)2278 static int ublk_ctrl_start_dev(struct ublk_device *ub, struct io_uring_cmd *cmd)
2279 {
2280 	const struct ublksrv_ctrl_cmd *header = io_uring_sqe_cmd(cmd->sqe);
2281 	const struct ublk_param_basic *p = &ub->params.basic;
2282 	int ublksrv_pid = (int)header->data[0];
2283 	struct queue_limits lim = {
2284 		.logical_block_size	= 1 << p->logical_bs_shift,
2285 		.physical_block_size	= 1 << p->physical_bs_shift,
2286 		.io_min			= 1 << p->io_min_shift,
2287 		.io_opt			= 1 << p->io_opt_shift,
2288 		.max_hw_sectors		= p->max_sectors,
2289 		.chunk_sectors		= p->chunk_sectors,
2290 		.virt_boundary_mask	= p->virt_boundary_mask,
2291 		.max_segments		= USHRT_MAX,
2292 		.max_segment_size	= UINT_MAX,
2293 		.dma_alignment		= 3,
2294 	};
2295 	struct gendisk *disk;
2296 	int ret = -EINVAL;
2297 
2298 	if (ublksrv_pid <= 0)
2299 		return -EINVAL;
2300 	if (!(ub->params.types & UBLK_PARAM_TYPE_BASIC))
2301 		return -EINVAL;
2302 
2303 	if (ub->params.types & UBLK_PARAM_TYPE_DISCARD) {
2304 		const struct ublk_param_discard *pd = &ub->params.discard;
2305 
2306 		lim.discard_alignment = pd->discard_alignment;
2307 		lim.discard_granularity = pd->discard_granularity;
2308 		lim.max_hw_discard_sectors = pd->max_discard_sectors;
2309 		lim.max_write_zeroes_sectors = pd->max_write_zeroes_sectors;
2310 		lim.max_discard_segments = pd->max_discard_segments;
2311 	}
2312 
2313 	if (ub->params.types & UBLK_PARAM_TYPE_ZONED) {
2314 		const struct ublk_param_zoned *p = &ub->params.zoned;
2315 
2316 		if (!IS_ENABLED(CONFIG_BLK_DEV_ZONED))
2317 			return -EOPNOTSUPP;
2318 
2319 		lim.features |= BLK_FEAT_ZONED;
2320 		lim.max_active_zones = p->max_active_zones;
2321 		lim.max_open_zones =  p->max_open_zones;
2322 		lim.max_zone_append_sectors = p->max_zone_append_sectors;
2323 	}
2324 
2325 	if (ub->params.basic.attrs & UBLK_ATTR_VOLATILE_CACHE) {
2326 		lim.features |= BLK_FEAT_WRITE_CACHE;
2327 		if (ub->params.basic.attrs & UBLK_ATTR_FUA)
2328 			lim.features |= BLK_FEAT_FUA;
2329 	}
2330 
2331 	if (ub->params.basic.attrs & UBLK_ATTR_ROTATIONAL)
2332 		lim.features |= BLK_FEAT_ROTATIONAL;
2333 
2334 	if (wait_for_completion_interruptible(&ub->completion) != 0)
2335 		return -EINTR;
2336 
2337 	mutex_lock(&ub->mutex);
2338 	if (ub->dev_info.state == UBLK_S_DEV_LIVE ||
2339 	    test_bit(UB_STATE_USED, &ub->state)) {
2340 		ret = -EEXIST;
2341 		goto out_unlock;
2342 	}
2343 
2344 	disk = blk_mq_alloc_disk(&ub->tag_set, &lim, NULL);
2345 	if (IS_ERR(disk)) {
2346 		ret = PTR_ERR(disk);
2347 		goto out_unlock;
2348 	}
2349 	sprintf(disk->disk_name, "ublkb%d", ub->ub_number);
2350 	disk->fops = &ub_fops;
2351 	disk->private_data = ub;
2352 
2353 	ub->dev_info.ublksrv_pid = ublksrv_pid;
2354 	ub->ub_disk = disk;
2355 
2356 	ublk_apply_params(ub);
2357 
2358 	/* don't probe partitions if any one ubq daemon is un-trusted */
2359 	if (ub->nr_privileged_daemon != ub->nr_queues_ready)
2360 		set_bit(GD_SUPPRESS_PART_SCAN, &disk->state);
2361 
2362 	ublk_get_device(ub);
2363 	ub->dev_info.state = UBLK_S_DEV_LIVE;
2364 
2365 	if (ublk_dev_is_zoned(ub)) {
2366 		ret = ublk_revalidate_disk_zones(ub);
2367 		if (ret)
2368 			goto out_put_cdev;
2369 	}
2370 
2371 	ret = add_disk(disk);
2372 	if (ret)
2373 		goto out_put_cdev;
2374 
2375 	set_bit(UB_STATE_USED, &ub->state);
2376 
2377 out_put_cdev:
2378 	if (ret) {
2379 		ublk_detach_disk(ub);
2380 		ublk_put_device(ub);
2381 	}
2382 	if (ret)
2383 		put_disk(disk);
2384 out_unlock:
2385 	mutex_unlock(&ub->mutex);
2386 	return ret;
2387 }
2388 
ublk_ctrl_get_queue_affinity(struct ublk_device * ub,struct io_uring_cmd * cmd)2389 static int ublk_ctrl_get_queue_affinity(struct ublk_device *ub,
2390 		struct io_uring_cmd *cmd)
2391 {
2392 	const struct ublksrv_ctrl_cmd *header = io_uring_sqe_cmd(cmd->sqe);
2393 	void __user *argp = (void __user *)(unsigned long)header->addr;
2394 	cpumask_var_t cpumask;
2395 	unsigned long queue;
2396 	unsigned int retlen;
2397 	unsigned int i;
2398 	int ret;
2399 
2400 	if (header->len * BITS_PER_BYTE < nr_cpu_ids)
2401 		return -EINVAL;
2402 	if (header->len & (sizeof(unsigned long)-1))
2403 		return -EINVAL;
2404 	if (!header->addr)
2405 		return -EINVAL;
2406 
2407 	queue = header->data[0];
2408 	if (queue >= ub->dev_info.nr_hw_queues)
2409 		return -EINVAL;
2410 
2411 	if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
2412 		return -ENOMEM;
2413 
2414 	for_each_possible_cpu(i) {
2415 		if (ub->tag_set.map[HCTX_TYPE_DEFAULT].mq_map[i] == queue)
2416 			cpumask_set_cpu(i, cpumask);
2417 	}
2418 
2419 	ret = -EFAULT;
2420 	retlen = min_t(unsigned short, header->len, cpumask_size());
2421 	if (copy_to_user(argp, cpumask, retlen))
2422 		goto out_free_cpumask;
2423 	if (retlen != header->len &&
2424 	    clear_user(argp + retlen, header->len - retlen))
2425 		goto out_free_cpumask;
2426 
2427 	ret = 0;
2428 out_free_cpumask:
2429 	free_cpumask_var(cpumask);
2430 	return ret;
2431 }
2432 
ublk_dump_dev_info(struct ublksrv_ctrl_dev_info * info)2433 static inline void ublk_dump_dev_info(struct ublksrv_ctrl_dev_info *info)
2434 {
2435 	pr_devel("%s: dev id %d flags %llx\n", __func__,
2436 			info->dev_id, info->flags);
2437 	pr_devel("\t nr_hw_queues %d queue_depth %d\n",
2438 			info->nr_hw_queues, info->queue_depth);
2439 }
2440 
ublk_ctrl_add_dev(struct io_uring_cmd * cmd)2441 static int ublk_ctrl_add_dev(struct io_uring_cmd *cmd)
2442 {
2443 	const struct ublksrv_ctrl_cmd *header = io_uring_sqe_cmd(cmd->sqe);
2444 	void __user *argp = (void __user *)(unsigned long)header->addr;
2445 	struct ublksrv_ctrl_dev_info info;
2446 	struct ublk_device *ub;
2447 	int ret = -EINVAL;
2448 
2449 	if (header->len < sizeof(info) || !header->addr)
2450 		return -EINVAL;
2451 	if (header->queue_id != (u16)-1) {
2452 		pr_warn("%s: queue_id is wrong %x\n",
2453 			__func__, header->queue_id);
2454 		return -EINVAL;
2455 	}
2456 
2457 	if (copy_from_user(&info, argp, sizeof(info)))
2458 		return -EFAULT;
2459 
2460 	if (info.queue_depth > UBLK_MAX_QUEUE_DEPTH || !info.queue_depth ||
2461 	    info.nr_hw_queues > UBLK_MAX_NR_QUEUES || !info.nr_hw_queues)
2462 		return -EINVAL;
2463 
2464 	if (capable(CAP_SYS_ADMIN))
2465 		info.flags &= ~UBLK_F_UNPRIVILEGED_DEV;
2466 	else if (!(info.flags & UBLK_F_UNPRIVILEGED_DEV))
2467 		return -EPERM;
2468 
2469 	/*
2470 	 * unprivileged device can't be trusted, but RECOVERY and
2471 	 * RECOVERY_REISSUE still may hang error handling, so can't
2472 	 * support recovery features for unprivileged ublk now
2473 	 *
2474 	 * TODO: provide forward progress for RECOVERY handler, so that
2475 	 * unprivileged device can benefit from it
2476 	 */
2477 	if (info.flags & UBLK_F_UNPRIVILEGED_DEV) {
2478 		info.flags &= ~(UBLK_F_USER_RECOVERY_REISSUE |
2479 				UBLK_F_USER_RECOVERY);
2480 
2481 		/*
2482 		 * For USER_COPY, we depends on userspace to fill request
2483 		 * buffer by pwrite() to ublk char device, which can't be
2484 		 * used for unprivileged device
2485 		 */
2486 		if (info.flags & UBLK_F_USER_COPY)
2487 			return -EINVAL;
2488 	}
2489 
2490 	/* the created device is always owned by current user */
2491 	ublk_store_owner_uid_gid(&info.owner_uid, &info.owner_gid);
2492 
2493 	if (header->dev_id != info.dev_id) {
2494 		pr_warn("%s: dev id not match %u %u\n",
2495 			__func__, header->dev_id, info.dev_id);
2496 		return -EINVAL;
2497 	}
2498 
2499 	if (header->dev_id != U32_MAX && header->dev_id >= UBLK_MAX_UBLKS) {
2500 		pr_warn("%s: dev id is too large. Max supported is %d\n",
2501 			__func__, UBLK_MAX_UBLKS - 1);
2502 		return -EINVAL;
2503 	}
2504 
2505 	ublk_dump_dev_info(&info);
2506 
2507 	ret = mutex_lock_killable(&ublk_ctl_mutex);
2508 	if (ret)
2509 		return ret;
2510 
2511 	ret = -EACCES;
2512 	if ((info.flags & UBLK_F_UNPRIVILEGED_DEV) &&
2513 	    unprivileged_ublks_added >= unprivileged_ublks_max)
2514 		goto out_unlock;
2515 
2516 	ret = -ENOMEM;
2517 	ub = kzalloc(sizeof(*ub), GFP_KERNEL);
2518 	if (!ub)
2519 		goto out_unlock;
2520 	mutex_init(&ub->mutex);
2521 	spin_lock_init(&ub->lock);
2522 	INIT_WORK(&ub->quiesce_work, ublk_quiesce_work_fn);
2523 	INIT_WORK(&ub->stop_work, ublk_stop_work_fn);
2524 
2525 	ret = ublk_alloc_dev_number(ub, header->dev_id);
2526 	if (ret < 0)
2527 		goto out_free_ub;
2528 
2529 	memcpy(&ub->dev_info, &info, sizeof(info));
2530 
2531 	/* update device id */
2532 	ub->dev_info.dev_id = ub->ub_number;
2533 
2534 	/*
2535 	 * 64bit flags will be copied back to userspace as feature
2536 	 * negotiation result, so have to clear flags which driver
2537 	 * doesn't support yet, then userspace can get correct flags
2538 	 * (features) to handle.
2539 	 */
2540 	ub->dev_info.flags &= UBLK_F_ALL;
2541 
2542 	ub->dev_info.flags |= UBLK_F_CMD_IOCTL_ENCODE |
2543 		UBLK_F_URING_CMD_COMP_IN_TASK;
2544 
2545 	/* GET_DATA isn't needed any more with USER_COPY */
2546 	if (ublk_dev_is_user_copy(ub))
2547 		ub->dev_info.flags &= ~UBLK_F_NEED_GET_DATA;
2548 
2549 	/* Zoned storage support requires user copy feature */
2550 	if (ublk_dev_is_zoned(ub) &&
2551 	    (!IS_ENABLED(CONFIG_BLK_DEV_ZONED) || !ublk_dev_is_user_copy(ub))) {
2552 		ret = -EINVAL;
2553 		goto out_free_dev_number;
2554 	}
2555 
2556 	/* We are not ready to support zero copy */
2557 	ub->dev_info.flags &= ~UBLK_F_SUPPORT_ZERO_COPY;
2558 
2559 	ub->dev_info.nr_hw_queues = min_t(unsigned int,
2560 			ub->dev_info.nr_hw_queues, nr_cpu_ids);
2561 	ublk_align_max_io_size(ub);
2562 
2563 	ret = ublk_init_queues(ub);
2564 	if (ret)
2565 		goto out_free_dev_number;
2566 
2567 	ret = ublk_add_tag_set(ub);
2568 	if (ret)
2569 		goto out_deinit_queues;
2570 
2571 	ret = -EFAULT;
2572 	if (copy_to_user(argp, &ub->dev_info, sizeof(info)))
2573 		goto out_free_tag_set;
2574 
2575 	/*
2576 	 * Add the char dev so that ublksrv daemon can be setup.
2577 	 * ublk_add_chdev() will cleanup everything if it fails.
2578 	 */
2579 	ret = ublk_add_chdev(ub);
2580 	goto out_unlock;
2581 
2582 out_free_tag_set:
2583 	blk_mq_free_tag_set(&ub->tag_set);
2584 out_deinit_queues:
2585 	ublk_deinit_queues(ub);
2586 out_free_dev_number:
2587 	ublk_free_dev_number(ub);
2588 out_free_ub:
2589 	mutex_destroy(&ub->mutex);
2590 	kfree(ub);
2591 out_unlock:
2592 	mutex_unlock(&ublk_ctl_mutex);
2593 	return ret;
2594 }
2595 
ublk_idr_freed(int id)2596 static inline bool ublk_idr_freed(int id)
2597 {
2598 	void *ptr;
2599 
2600 	spin_lock(&ublk_idr_lock);
2601 	ptr = idr_find(&ublk_index_idr, id);
2602 	spin_unlock(&ublk_idr_lock);
2603 
2604 	return ptr == NULL;
2605 }
2606 
ublk_ctrl_del_dev(struct ublk_device ** p_ub,bool wait)2607 static int ublk_ctrl_del_dev(struct ublk_device **p_ub, bool wait)
2608 {
2609 	struct ublk_device *ub = *p_ub;
2610 	int idx = ub->ub_number;
2611 	int ret;
2612 
2613 	ret = mutex_lock_killable(&ublk_ctl_mutex);
2614 	if (ret)
2615 		return ret;
2616 
2617 	if (!test_bit(UB_STATE_DELETED, &ub->state)) {
2618 		ublk_remove(ub);
2619 		set_bit(UB_STATE_DELETED, &ub->state);
2620 	}
2621 
2622 	/* Mark the reference as consumed */
2623 	*p_ub = NULL;
2624 	ublk_put_device(ub);
2625 	mutex_unlock(&ublk_ctl_mutex);
2626 
2627 	/*
2628 	 * Wait until the idr is removed, then it can be reused after
2629 	 * DEL_DEV command is returned.
2630 	 *
2631 	 * If we returns because of user interrupt, future delete command
2632 	 * may come:
2633 	 *
2634 	 * - the device number isn't freed, this device won't or needn't
2635 	 *   be deleted again, since UB_STATE_DELETED is set, and device
2636 	 *   will be released after the last reference is dropped
2637 	 *
2638 	 * - the device number is freed already, we will not find this
2639 	 *   device via ublk_get_device_from_id()
2640 	 */
2641 	if (wait && wait_event_interruptible(ublk_idr_wq, ublk_idr_freed(idx)))
2642 		return -EINTR;
2643 	return 0;
2644 }
2645 
ublk_ctrl_cmd_dump(struct io_uring_cmd * cmd)2646 static inline void ublk_ctrl_cmd_dump(struct io_uring_cmd *cmd)
2647 {
2648 	const struct ublksrv_ctrl_cmd *header = io_uring_sqe_cmd(cmd->sqe);
2649 
2650 	pr_devel("%s: cmd_op %x, dev id %d qid %d data %llx buf %llx len %u\n",
2651 			__func__, cmd->cmd_op, header->dev_id, header->queue_id,
2652 			header->data[0], header->addr, header->len);
2653 }
2654 
ublk_ctrl_stop_dev(struct ublk_device * ub)2655 static int ublk_ctrl_stop_dev(struct ublk_device *ub)
2656 {
2657 	ublk_stop_dev(ub);
2658 	cancel_work_sync(&ub->stop_work);
2659 	cancel_work_sync(&ub->quiesce_work);
2660 
2661 	return 0;
2662 }
2663 
ublk_ctrl_get_dev_info(struct ublk_device * ub,struct io_uring_cmd * cmd)2664 static int ublk_ctrl_get_dev_info(struct ublk_device *ub,
2665 		struct io_uring_cmd *cmd)
2666 {
2667 	const struct ublksrv_ctrl_cmd *header = io_uring_sqe_cmd(cmd->sqe);
2668 	void __user *argp = (void __user *)(unsigned long)header->addr;
2669 
2670 	if (header->len < sizeof(struct ublksrv_ctrl_dev_info) || !header->addr)
2671 		return -EINVAL;
2672 
2673 	if (copy_to_user(argp, &ub->dev_info, sizeof(ub->dev_info)))
2674 		return -EFAULT;
2675 
2676 	return 0;
2677 }
2678 
2679 /* TYPE_DEVT is readonly, so fill it up before returning to userspace */
ublk_ctrl_fill_params_devt(struct ublk_device * ub)2680 static void ublk_ctrl_fill_params_devt(struct ublk_device *ub)
2681 {
2682 	ub->params.devt.char_major = MAJOR(ub->cdev_dev.devt);
2683 	ub->params.devt.char_minor = MINOR(ub->cdev_dev.devt);
2684 
2685 	if (ub->ub_disk) {
2686 		ub->params.devt.disk_major = MAJOR(disk_devt(ub->ub_disk));
2687 		ub->params.devt.disk_minor = MINOR(disk_devt(ub->ub_disk));
2688 	} else {
2689 		ub->params.devt.disk_major = 0;
2690 		ub->params.devt.disk_minor = 0;
2691 	}
2692 	ub->params.types |= UBLK_PARAM_TYPE_DEVT;
2693 }
2694 
ublk_ctrl_get_params(struct ublk_device * ub,struct io_uring_cmd * cmd)2695 static int ublk_ctrl_get_params(struct ublk_device *ub,
2696 		struct io_uring_cmd *cmd)
2697 {
2698 	const struct ublksrv_ctrl_cmd *header = io_uring_sqe_cmd(cmd->sqe);
2699 	void __user *argp = (void __user *)(unsigned long)header->addr;
2700 	struct ublk_params_header ph;
2701 	int ret;
2702 
2703 	if (header->len <= sizeof(ph) || !header->addr)
2704 		return -EINVAL;
2705 
2706 	if (copy_from_user(&ph, argp, sizeof(ph)))
2707 		return -EFAULT;
2708 
2709 	if (ph.len > header->len || !ph.len)
2710 		return -EINVAL;
2711 
2712 	if (ph.len > sizeof(struct ublk_params))
2713 		ph.len = sizeof(struct ublk_params);
2714 
2715 	mutex_lock(&ub->mutex);
2716 	ublk_ctrl_fill_params_devt(ub);
2717 	if (copy_to_user(argp, &ub->params, ph.len))
2718 		ret = -EFAULT;
2719 	else
2720 		ret = 0;
2721 	mutex_unlock(&ub->mutex);
2722 
2723 	return ret;
2724 }
2725 
ublk_ctrl_set_params(struct ublk_device * ub,struct io_uring_cmd * cmd)2726 static int ublk_ctrl_set_params(struct ublk_device *ub,
2727 		struct io_uring_cmd *cmd)
2728 {
2729 	const struct ublksrv_ctrl_cmd *header = io_uring_sqe_cmd(cmd->sqe);
2730 	void __user *argp = (void __user *)(unsigned long)header->addr;
2731 	struct ublk_params_header ph;
2732 	int ret = -EFAULT;
2733 
2734 	if (header->len <= sizeof(ph) || !header->addr)
2735 		return -EINVAL;
2736 
2737 	if (copy_from_user(&ph, argp, sizeof(ph)))
2738 		return -EFAULT;
2739 
2740 	if (ph.len > header->len || !ph.len || !ph.types)
2741 		return -EINVAL;
2742 
2743 	if (ph.len > sizeof(struct ublk_params))
2744 		ph.len = sizeof(struct ublk_params);
2745 
2746 	mutex_lock(&ub->mutex);
2747 	if (test_bit(UB_STATE_USED, &ub->state)) {
2748 		/*
2749 		 * Parameters can only be changed when device hasn't
2750 		 * been started yet
2751 		 */
2752 		ret = -EACCES;
2753 	} else if (copy_from_user(&ub->params, argp, ph.len)) {
2754 		ret = -EFAULT;
2755 	} else {
2756 		/* clear all we don't support yet */
2757 		ub->params.types &= UBLK_PARAM_TYPE_ALL;
2758 		ret = ublk_validate_params(ub);
2759 		if (ret)
2760 			ub->params.types = 0;
2761 	}
2762 	mutex_unlock(&ub->mutex);
2763 
2764 	return ret;
2765 }
2766 
ublk_queue_reinit(struct ublk_device * ub,struct ublk_queue * ubq)2767 static void ublk_queue_reinit(struct ublk_device *ub, struct ublk_queue *ubq)
2768 {
2769 	int i;
2770 
2771 	WARN_ON_ONCE(!(ubq->ubq_daemon && ubq_daemon_is_dying(ubq)));
2772 
2773 	/* All old ioucmds have to be completed */
2774 	ubq->nr_io_ready = 0;
2775 	/* old daemon is PF_EXITING, put it now */
2776 	put_task_struct(ubq->ubq_daemon);
2777 	/* We have to reset it to NULL, otherwise ub won't accept new FETCH_REQ */
2778 	ubq->ubq_daemon = NULL;
2779 	ubq->timeout = false;
2780 	ubq->canceling = false;
2781 
2782 	for (i = 0; i < ubq->q_depth; i++) {
2783 		struct ublk_io *io = &ubq->ios[i];
2784 
2785 		/* forget everything now and be ready for new FETCH_REQ */
2786 		io->flags = 0;
2787 		io->cmd = NULL;
2788 		io->addr = 0;
2789 	}
2790 }
2791 
ublk_ctrl_start_recovery(struct ublk_device * ub,struct io_uring_cmd * cmd)2792 static int ublk_ctrl_start_recovery(struct ublk_device *ub,
2793 		struct io_uring_cmd *cmd)
2794 {
2795 	const struct ublksrv_ctrl_cmd *header = io_uring_sqe_cmd(cmd->sqe);
2796 	int ret = -EINVAL;
2797 	int i;
2798 
2799 	mutex_lock(&ub->mutex);
2800 	if (ublk_nosrv_should_stop_dev(ub))
2801 		goto out_unlock;
2802 	if (!ub->nr_queues_ready)
2803 		goto out_unlock;
2804 	/*
2805 	 * START_RECOVERY is only allowd after:
2806 	 *
2807 	 * (1) UB_STATE_OPEN is not set, which means the dying process is exited
2808 	 *     and related io_uring ctx is freed so file struct of /dev/ublkcX is
2809 	 *     released.
2810 	 *
2811 	 * (2) UBLK_S_DEV_QUIESCED is set, which means the quiesce_work:
2812 	 *     (a)has quiesced request queue
2813 	 *     (b)has requeued every inflight rqs whose io_flags is ACTIVE
2814 	 *     (c)has requeued/aborted every inflight rqs whose io_flags is NOT ACTIVE
2815 	 *     (d)has completed/camceled all ioucmds owned by ther dying process
2816 	 */
2817 	if (test_bit(UB_STATE_OPEN, &ub->state) ||
2818 			ub->dev_info.state != UBLK_S_DEV_QUIESCED) {
2819 		ret = -EBUSY;
2820 		goto out_unlock;
2821 	}
2822 	pr_devel("%s: start recovery for dev id %d.\n", __func__, header->dev_id);
2823 	for (i = 0; i < ub->dev_info.nr_hw_queues; i++)
2824 		ublk_queue_reinit(ub, ublk_get_queue(ub, i));
2825 	/* set to NULL, otherwise new ubq_daemon cannot mmap the io_cmd_buf */
2826 	ub->mm = NULL;
2827 	ub->nr_queues_ready = 0;
2828 	ub->nr_privileged_daemon = 0;
2829 	init_completion(&ub->completion);
2830 	ret = 0;
2831  out_unlock:
2832 	mutex_unlock(&ub->mutex);
2833 	return ret;
2834 }
2835 
ublk_ctrl_end_recovery(struct ublk_device * ub,struct io_uring_cmd * cmd)2836 static int ublk_ctrl_end_recovery(struct ublk_device *ub,
2837 		struct io_uring_cmd *cmd)
2838 {
2839 	const struct ublksrv_ctrl_cmd *header = io_uring_sqe_cmd(cmd->sqe);
2840 	int ublksrv_pid = (int)header->data[0];
2841 	int ret = -EINVAL;
2842 
2843 	pr_devel("%s: Waiting for new ubq_daemons(nr: %d) are ready, dev id %d...\n",
2844 			__func__, ub->dev_info.nr_hw_queues, header->dev_id);
2845 	/* wait until new ubq_daemon sending all FETCH_REQ */
2846 	if (wait_for_completion_interruptible(&ub->completion))
2847 		return -EINTR;
2848 
2849 	pr_devel("%s: All new ubq_daemons(nr: %d) are ready, dev id %d\n",
2850 			__func__, ub->dev_info.nr_hw_queues, header->dev_id);
2851 
2852 	mutex_lock(&ub->mutex);
2853 	if (ublk_nosrv_should_stop_dev(ub))
2854 		goto out_unlock;
2855 
2856 	if (ub->dev_info.state != UBLK_S_DEV_QUIESCED) {
2857 		ret = -EBUSY;
2858 		goto out_unlock;
2859 	}
2860 	ub->dev_info.ublksrv_pid = ublksrv_pid;
2861 	pr_devel("%s: new ublksrv_pid %d, dev id %d\n",
2862 			__func__, ublksrv_pid, header->dev_id);
2863 	blk_mq_unquiesce_queue(ub->ub_disk->queue);
2864 	pr_devel("%s: queue unquiesced, dev id %d.\n",
2865 			__func__, header->dev_id);
2866 	blk_mq_kick_requeue_list(ub->ub_disk->queue);
2867 	ub->dev_info.state = UBLK_S_DEV_LIVE;
2868 	ret = 0;
2869  out_unlock:
2870 	mutex_unlock(&ub->mutex);
2871 	return ret;
2872 }
2873 
ublk_ctrl_get_features(struct io_uring_cmd * cmd)2874 static int ublk_ctrl_get_features(struct io_uring_cmd *cmd)
2875 {
2876 	const struct ublksrv_ctrl_cmd *header = io_uring_sqe_cmd(cmd->sqe);
2877 	void __user *argp = (void __user *)(unsigned long)header->addr;
2878 	u64 features = UBLK_F_ALL & ~UBLK_F_SUPPORT_ZERO_COPY;
2879 
2880 	if (header->len != UBLK_FEATURES_LEN || !header->addr)
2881 		return -EINVAL;
2882 
2883 	if (copy_to_user(argp, &features, UBLK_FEATURES_LEN))
2884 		return -EFAULT;
2885 
2886 	return 0;
2887 }
2888 
2889 /*
2890  * All control commands are sent via /dev/ublk-control, so we have to check
2891  * the destination device's permission
2892  */
ublk_char_dev_permission(struct ublk_device * ub,const char * dev_path,int mask)2893 static int ublk_char_dev_permission(struct ublk_device *ub,
2894 		const char *dev_path, int mask)
2895 {
2896 	int err;
2897 	struct path path;
2898 	struct kstat stat;
2899 
2900 	err = kern_path(dev_path, LOOKUP_FOLLOW, &path);
2901 	if (err)
2902 		return err;
2903 
2904 	err = vfs_getattr(&path, &stat, STATX_TYPE, AT_STATX_SYNC_AS_STAT);
2905 	if (err)
2906 		goto exit;
2907 
2908 	err = -EPERM;
2909 	if (stat.rdev != ub->cdev_dev.devt || !S_ISCHR(stat.mode))
2910 		goto exit;
2911 
2912 	err = inode_permission(&nop_mnt_idmap,
2913 			d_backing_inode(path.dentry), mask);
2914 exit:
2915 	path_put(&path);
2916 	return err;
2917 }
2918 
ublk_ctrl_uring_cmd_permission(struct ublk_device * ub,struct io_uring_cmd * cmd)2919 static int ublk_ctrl_uring_cmd_permission(struct ublk_device *ub,
2920 		struct io_uring_cmd *cmd)
2921 {
2922 	struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)io_uring_sqe_cmd(cmd->sqe);
2923 	bool unprivileged = ub->dev_info.flags & UBLK_F_UNPRIVILEGED_DEV;
2924 	void __user *argp = (void __user *)(unsigned long)header->addr;
2925 	char *dev_path = NULL;
2926 	int ret = 0;
2927 	int mask;
2928 
2929 	if (!unprivileged) {
2930 		if (!capable(CAP_SYS_ADMIN))
2931 			return -EPERM;
2932 		/*
2933 		 * The new added command of UBLK_CMD_GET_DEV_INFO2 includes
2934 		 * char_dev_path in payload too, since userspace may not
2935 		 * know if the specified device is created as unprivileged
2936 		 * mode.
2937 		 */
2938 		if (_IOC_NR(cmd->cmd_op) != UBLK_CMD_GET_DEV_INFO2)
2939 			return 0;
2940 	}
2941 
2942 	/*
2943 	 * User has to provide the char device path for unprivileged ublk
2944 	 *
2945 	 * header->addr always points to the dev path buffer, and
2946 	 * header->dev_path_len records length of dev path buffer.
2947 	 */
2948 	if (!header->dev_path_len || header->dev_path_len > PATH_MAX)
2949 		return -EINVAL;
2950 
2951 	if (header->len < header->dev_path_len)
2952 		return -EINVAL;
2953 
2954 	dev_path = memdup_user_nul(argp, header->dev_path_len);
2955 	if (IS_ERR(dev_path))
2956 		return PTR_ERR(dev_path);
2957 
2958 	ret = -EINVAL;
2959 	switch (_IOC_NR(cmd->cmd_op)) {
2960 	case UBLK_CMD_GET_DEV_INFO:
2961 	case UBLK_CMD_GET_DEV_INFO2:
2962 	case UBLK_CMD_GET_QUEUE_AFFINITY:
2963 	case UBLK_CMD_GET_PARAMS:
2964 	case (_IOC_NR(UBLK_U_CMD_GET_FEATURES)):
2965 		mask = MAY_READ;
2966 		break;
2967 	case UBLK_CMD_START_DEV:
2968 	case UBLK_CMD_STOP_DEV:
2969 	case UBLK_CMD_ADD_DEV:
2970 	case UBLK_CMD_DEL_DEV:
2971 	case UBLK_CMD_SET_PARAMS:
2972 	case UBLK_CMD_START_USER_RECOVERY:
2973 	case UBLK_CMD_END_USER_RECOVERY:
2974 		mask = MAY_READ | MAY_WRITE;
2975 		break;
2976 	default:
2977 		goto exit;
2978 	}
2979 
2980 	ret = ublk_char_dev_permission(ub, dev_path, mask);
2981 	if (!ret) {
2982 		header->len -= header->dev_path_len;
2983 		header->addr += header->dev_path_len;
2984 	}
2985 	pr_devel("%s: dev id %d cmd_op %x uid %d gid %d path %s ret %d\n",
2986 			__func__, ub->ub_number, cmd->cmd_op,
2987 			ub->dev_info.owner_uid, ub->dev_info.owner_gid,
2988 			dev_path, ret);
2989 exit:
2990 	kfree(dev_path);
2991 	return ret;
2992 }
2993 
ublk_ctrl_uring_cmd(struct io_uring_cmd * cmd,unsigned int issue_flags)2994 static int ublk_ctrl_uring_cmd(struct io_uring_cmd *cmd,
2995 		unsigned int issue_flags)
2996 {
2997 	const struct ublksrv_ctrl_cmd *header = io_uring_sqe_cmd(cmd->sqe);
2998 	struct ublk_device *ub = NULL;
2999 	u32 cmd_op = cmd->cmd_op;
3000 	int ret = -EINVAL;
3001 
3002 	if (issue_flags & IO_URING_F_NONBLOCK)
3003 		return -EAGAIN;
3004 
3005 	ublk_ctrl_cmd_dump(cmd);
3006 
3007 	if (!(issue_flags & IO_URING_F_SQE128))
3008 		goto out;
3009 
3010 	ret = ublk_check_cmd_op(cmd_op);
3011 	if (ret)
3012 		goto out;
3013 
3014 	if (cmd_op == UBLK_U_CMD_GET_FEATURES) {
3015 		ret = ublk_ctrl_get_features(cmd);
3016 		goto out;
3017 	}
3018 
3019 	if (_IOC_NR(cmd_op) != UBLK_CMD_ADD_DEV) {
3020 		ret = -ENODEV;
3021 		ub = ublk_get_device_from_id(header->dev_id);
3022 		if (!ub)
3023 			goto out;
3024 
3025 		ret = ublk_ctrl_uring_cmd_permission(ub, cmd);
3026 		if (ret)
3027 			goto put_dev;
3028 	}
3029 
3030 	switch (_IOC_NR(cmd_op)) {
3031 	case UBLK_CMD_START_DEV:
3032 		ret = ublk_ctrl_start_dev(ub, cmd);
3033 		break;
3034 	case UBLK_CMD_STOP_DEV:
3035 		ret = ublk_ctrl_stop_dev(ub);
3036 		break;
3037 	case UBLK_CMD_GET_DEV_INFO:
3038 	case UBLK_CMD_GET_DEV_INFO2:
3039 		ret = ublk_ctrl_get_dev_info(ub, cmd);
3040 		break;
3041 	case UBLK_CMD_ADD_DEV:
3042 		ret = ublk_ctrl_add_dev(cmd);
3043 		break;
3044 	case UBLK_CMD_DEL_DEV:
3045 		ret = ublk_ctrl_del_dev(&ub, true);
3046 		break;
3047 	case UBLK_CMD_DEL_DEV_ASYNC:
3048 		ret = ublk_ctrl_del_dev(&ub, false);
3049 		break;
3050 	case UBLK_CMD_GET_QUEUE_AFFINITY:
3051 		ret = ublk_ctrl_get_queue_affinity(ub, cmd);
3052 		break;
3053 	case UBLK_CMD_GET_PARAMS:
3054 		ret = ublk_ctrl_get_params(ub, cmd);
3055 		break;
3056 	case UBLK_CMD_SET_PARAMS:
3057 		ret = ublk_ctrl_set_params(ub, cmd);
3058 		break;
3059 	case UBLK_CMD_START_USER_RECOVERY:
3060 		ret = ublk_ctrl_start_recovery(ub, cmd);
3061 		break;
3062 	case UBLK_CMD_END_USER_RECOVERY:
3063 		ret = ublk_ctrl_end_recovery(ub, cmd);
3064 		break;
3065 	default:
3066 		ret = -EOPNOTSUPP;
3067 		break;
3068 	}
3069 
3070  put_dev:
3071 	if (ub)
3072 		ublk_put_device(ub);
3073  out:
3074 	pr_devel("%s: cmd done ret %d cmd_op %x, dev id %d qid %d\n",
3075 			__func__, ret, cmd->cmd_op, header->dev_id, header->queue_id);
3076 	return ret;
3077 }
3078 
3079 static const struct file_operations ublk_ctl_fops = {
3080 	.open		= nonseekable_open,
3081 	.uring_cmd      = ublk_ctrl_uring_cmd,
3082 	.owner		= THIS_MODULE,
3083 	.llseek		= noop_llseek,
3084 };
3085 
3086 static struct miscdevice ublk_misc = {
3087 	.minor		= MISC_DYNAMIC_MINOR,
3088 	.name		= "ublk-control",
3089 	.fops		= &ublk_ctl_fops,
3090 };
3091 
ublk_init(void)3092 static int __init ublk_init(void)
3093 {
3094 	int ret;
3095 
3096 	BUILD_BUG_ON((u64)UBLKSRV_IO_BUF_OFFSET +
3097 			UBLKSRV_IO_BUF_TOTAL_SIZE < UBLKSRV_IO_BUF_OFFSET);
3098 
3099 	init_waitqueue_head(&ublk_idr_wq);
3100 
3101 	ret = misc_register(&ublk_misc);
3102 	if (ret)
3103 		return ret;
3104 
3105 	ret = alloc_chrdev_region(&ublk_chr_devt, 0, UBLK_MINORS, "ublk-char");
3106 	if (ret)
3107 		goto unregister_mis;
3108 
3109 	ret = class_register(&ublk_chr_class);
3110 	if (ret)
3111 		goto free_chrdev_region;
3112 
3113 	return 0;
3114 
3115 free_chrdev_region:
3116 	unregister_chrdev_region(ublk_chr_devt, UBLK_MINORS);
3117 unregister_mis:
3118 	misc_deregister(&ublk_misc);
3119 	return ret;
3120 }
3121 
ublk_exit(void)3122 static void __exit ublk_exit(void)
3123 {
3124 	struct ublk_device *ub;
3125 	int id;
3126 
3127 	idr_for_each_entry(&ublk_index_idr, ub, id)
3128 		ublk_remove(ub);
3129 
3130 	class_unregister(&ublk_chr_class);
3131 	misc_deregister(&ublk_misc);
3132 
3133 	idr_destroy(&ublk_index_idr);
3134 	unregister_chrdev_region(ublk_chr_devt, UBLK_MINORS);
3135 }
3136 
3137 module_init(ublk_init);
3138 module_exit(ublk_exit);
3139 
ublk_set_max_unprivileged_ublks(const char * buf,const struct kernel_param * kp)3140 static int ublk_set_max_unprivileged_ublks(const char *buf,
3141 					   const struct kernel_param *kp)
3142 {
3143 	return param_set_uint_minmax(buf, kp, 0, UBLK_MAX_UBLKS);
3144 }
3145 
ublk_get_max_unprivileged_ublks(char * buf,const struct kernel_param * kp)3146 static int ublk_get_max_unprivileged_ublks(char *buf,
3147 					   const struct kernel_param *kp)
3148 {
3149 	return sysfs_emit(buf, "%u\n", unprivileged_ublks_max);
3150 }
3151 
3152 static const struct kernel_param_ops ublk_max_unprivileged_ublks_ops = {
3153 	.set = ublk_set_max_unprivileged_ublks,
3154 	.get = ublk_get_max_unprivileged_ublks,
3155 };
3156 
3157 module_param_cb(ublks_max, &ublk_max_unprivileged_ublks_ops,
3158 		&unprivileged_ublks_max, 0644);
3159 MODULE_PARM_DESC(ublks_max, "max number of unprivileged ublk devices allowed to add(default: 64)");
3160 
3161 MODULE_AUTHOR("Ming Lei <ming.lei@redhat.com>");
3162 MODULE_DESCRIPTION("Userspace block device");
3163 MODULE_LICENSE("GPL");
3164