s390/dasd: Fix potential memleak in dasd_eckd_init()
[linux-block.git] / drivers / block / ublk_drv.c
CommitLineData
71f28f31
ML
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.h>
40#include <linux/blk-mq.h>
41#include <linux/delay.h>
42#include <linux/mm.h>
43#include <asm/page.h>
0edb3696 44#include <linux/task_work.h>
4093cb5a 45#include <linux/namei.h>
71f28f31
ML
46#include <uapi/linux/ublk_cmd.h>
47
48#define UBLK_MINORS (1U << MINORBITS)
49
6d8c5afc 50/* All UBLK_F_* have to be included into UBLK_F_ALL */
c86019ff
Z
51#define UBLK_F_ALL (UBLK_F_SUPPORT_ZERO_COPY \
52 | UBLK_F_URING_CMD_COMP_IN_TASK \
77a440e2 53 | UBLK_F_NEED_GET_DATA \
a0d41dc1 54 | UBLK_F_USER_RECOVERY \
4093cb5a
ML
55 | UBLK_F_USER_RECOVERY_REISSUE \
56 | UBLK_F_UNPRIVILEGED_DEV)
6d8c5afc 57
0aa73170 58/* All UBLK_PARAM_TYPE_* should be included here */
abb864d3
ML
59#define UBLK_PARAM_TYPE_ALL (UBLK_PARAM_TYPE_BASIC | \
60 UBLK_PARAM_TYPE_DISCARD | UBLK_PARAM_TYPE_DEVT)
0aa73170 61
0edb3696 62struct ublk_rq_data {
7d4a9317
ML
63 struct llist_node node;
64 struct callback_head work;
0edb3696
ML
65};
66
71f28f31 67struct ublk_uring_cmd_pdu {
3ab6e94c 68 struct ublk_queue *ubq;
71f28f31
ML
69};
70
71/*
72 * io command is active: sqe cmd is received, and its cqe isn't done
73 *
74 * If the flag is set, the io command is owned by ublk driver, and waited
75 * for incoming blk-mq request from the ublk block device.
76 *
77 * If the flag is cleared, the io command will be completed, and owned by
78 * ublk server.
79 */
80#define UBLK_IO_FLAG_ACTIVE 0x01
81
82/*
83 * IO command is completed via cqe, and it is being handled by ublksrv, and
84 * not committed yet
85 *
86 * Basically exclusively with UBLK_IO_FLAG_ACTIVE, so can be served for
87 * cross verification
88 */
89#define UBLK_IO_FLAG_OWNED_BY_SRV 0x02
90
91/*
92 * IO command is aborted, so this flag is set in case of
93 * !UBLK_IO_FLAG_ACTIVE.
94 *
95 * After this flag is observed, any pending or new incoming request
96 * associated with this io command will be failed immediately
97 */
98#define UBLK_IO_FLAG_ABORTED 0x04
99
c86019ff
Z
100/*
101 * UBLK_IO_FLAG_NEED_GET_DATA is set because IO command requires
102 * get data buffer address from ublksrv.
103 *
104 * Then, bio data could be copied into this data buffer for a WRITE request
105 * after the IO command is issued again and UBLK_IO_FLAG_NEED_GET_DATA is unset.
106 */
107#define UBLK_IO_FLAG_NEED_GET_DATA 0x08
108
71f28f31
ML
109struct ublk_io {
110 /* userspace buffer address from io cmd */
111 __u64 addr;
112 unsigned int flags;
113 int res;
114
115 struct io_uring_cmd *cmd;
116};
117
118struct ublk_queue {
119 int q_id;
120 int q_depth;
121
0edb3696 122 unsigned long flags;
71f28f31
ML
123 struct task_struct *ubq_daemon;
124 char *io_cmd_buf;
125
3ab6e94c
ML
126 struct llist_head io_cmds;
127
71f28f31
ML
128 unsigned long io_addr; /* mapped vm address */
129 unsigned int max_io_sz;
bbae8d1f 130 bool force_abort;
71f28f31
ML
131 unsigned short nr_io_ready; /* how many ios setup */
132 struct ublk_device *dev;
72495b5a 133 struct ublk_io ios[];
71f28f31
ML
134};
135
136#define UBLK_DAEMON_MONITOR_PERIOD (5 * HZ)
137
138struct ublk_device {
139 struct gendisk *ub_disk;
71f28f31
ML
140
141 char *__queues;
142
143 unsigned short queue_size;
71f28f31
ML
144 struct ublksrv_ctrl_dev_info dev_info;
145
146 struct blk_mq_tag_set tag_set;
147
148 struct cdev cdev;
149 struct device cdev_dev;
150
8d9fdb60
DC
151#define UB_STATE_OPEN 0
152#define UB_STATE_USED 1
0abe39de 153#define UB_STATE_DELETED 2
fa362045 154 unsigned long state;
71f28f31
ML
155 int ub_number;
156
157 struct mutex mutex;
158
e94eb459 159 spinlock_t mm_lock;
71f28f31
ML
160 struct mm_struct *mm;
161
0aa73170
ML
162 struct ublk_params params;
163
71f28f31
ML
164 struct completion completion;
165 unsigned int nr_queues_ready;
73a166d9 166 unsigned int nr_privileged_daemon;
71f28f31
ML
167
168 /*
169 * Our ubq->daemon may be killed without any notification, so
170 * monitor each queue's daemon periodically
171 */
172 struct delayed_work monitor_work;
bbae8d1f 173 struct work_struct quiesce_work;
71f28f31
ML
174 struct work_struct stop_work;
175};
176
0aa73170
ML
177/* header of ublk_params */
178struct ublk_params_header {
179 __u32 len;
180 __u32 types;
181};
182
71f28f31
ML
183static dev_t ublk_chr_devt;
184static struct class *ublk_chr_class;
185
186static DEFINE_IDR(ublk_index_idr);
187static DEFINE_SPINLOCK(ublk_idr_lock);
188static wait_queue_head_t ublk_idr_wq; /* wait until one idr is freed */
189
190static DEFINE_MUTEX(ublk_ctl_mutex);
191
403ebc87
ML
192/*
193 * Max ublk devices allowed to add
194 *
195 * It can be extended to one per-user limit in future or even controlled
196 * by cgroup.
197 */
198static unsigned int ublks_max = 64;
199static unsigned int ublks_added; /* protected by ublk_ctl_mutex */
200
71f28f31
ML
201static struct miscdevice ublk_misc;
202
0aa73170
ML
203static void ublk_dev_param_basic_apply(struct ublk_device *ub)
204{
205 struct request_queue *q = ub->ub_disk->queue;
206 const struct ublk_param_basic *p = &ub->params.basic;
207
208 blk_queue_logical_block_size(q, 1 << p->logical_bs_shift);
209 blk_queue_physical_block_size(q, 1 << p->physical_bs_shift);
210 blk_queue_io_min(q, 1 << p->io_min_shift);
211 blk_queue_io_opt(q, 1 << p->io_opt_shift);
212
213 blk_queue_write_cache(q, p->attrs & UBLK_ATTR_VOLATILE_CACHE,
214 p->attrs & UBLK_ATTR_FUA);
215 if (p->attrs & UBLK_ATTR_ROTATIONAL)
216 blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
217 else
218 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
219
220 blk_queue_max_hw_sectors(q, p->max_sectors);
221 blk_queue_chunk_sectors(q, p->chunk_sectors);
222 blk_queue_virt_boundary(q, p->virt_boundary_mask);
223
224 if (p->attrs & UBLK_ATTR_READ_ONLY)
225 set_disk_ro(ub->ub_disk, true);
226
227 set_capacity(ub->ub_disk, p->dev_sectors);
228}
229
230static void ublk_dev_param_discard_apply(struct ublk_device *ub)
231{
232 struct request_queue *q = ub->ub_disk->queue;
233 const struct ublk_param_discard *p = &ub->params.discard;
234
235 q->limits.discard_alignment = p->discard_alignment;
236 q->limits.discard_granularity = p->discard_granularity;
237 blk_queue_max_discard_sectors(q, p->max_discard_sectors);
238 blk_queue_max_write_zeroes_sectors(q,
239 p->max_write_zeroes_sectors);
240 blk_queue_max_discard_segments(q, p->max_discard_segments);
241}
242
243static int ublk_validate_params(const struct ublk_device *ub)
244{
245 /* basic param is the only one which must be set */
246 if (ub->params.types & UBLK_PARAM_TYPE_BASIC) {
247 const struct ublk_param_basic *p = &ub->params.basic;
248
249 if (p->logical_bs_shift > PAGE_SHIFT)
250 return -EINVAL;
251
252 if (p->logical_bs_shift > p->physical_bs_shift)
253 return -EINVAL;
254
4bf9cbf3 255 if (p->max_sectors > (ub->dev_info.max_io_buf_bytes >> 9))
0aa73170
ML
256 return -EINVAL;
257 } else
258 return -EINVAL;
259
260 if (ub->params.types & UBLK_PARAM_TYPE_DISCARD) {
261 const struct ublk_param_discard *p = &ub->params.discard;
262
263 /* So far, only support single segment discard */
264 if (p->max_discard_sectors && p->max_discard_segments != 1)
265 return -EINVAL;
266
267 if (!p->discard_granularity)
268 return -EINVAL;
269 }
270
abb864d3
ML
271 /* dev_t is read-only */
272 if (ub->params.types & UBLK_PARAM_TYPE_DEVT)
273 return -EINVAL;
274
0aa73170
ML
275 return 0;
276}
277
278static int ublk_apply_params(struct ublk_device *ub)
279{
280 if (!(ub->params.types & UBLK_PARAM_TYPE_BASIC))
281 return -EINVAL;
282
283 ublk_dev_param_basic_apply(ub);
284
285 if (ub->params.types & UBLK_PARAM_TYPE_DISCARD)
286 ublk_dev_param_discard_apply(ub);
287
288 return 0;
289}
290
0edb3696
ML
291static inline bool ublk_can_use_task_work(const struct ublk_queue *ubq)
292{
293 if (IS_BUILTIN(CONFIG_BLK_DEV_UBLK) &&
294 !(ubq->flags & UBLK_F_URING_CMD_COMP_IN_TASK))
295 return true;
296 return false;
297}
298
c86019ff
Z
299static inline bool ublk_need_get_data(const struct ublk_queue *ubq)
300{
301 if (ubq->flags & UBLK_F_NEED_GET_DATA)
302 return true;
303 return false;
304}
305
71f28f31
ML
306static struct ublk_device *ublk_get_device(struct ublk_device *ub)
307{
308 if (kobject_get_unless_zero(&ub->cdev_dev.kobj))
309 return ub;
310 return NULL;
311}
312
313static void ublk_put_device(struct ublk_device *ub)
314{
315 put_device(&ub->cdev_dev);
316}
317
318static inline struct ublk_queue *ublk_get_queue(struct ublk_device *dev,
319 int qid)
320{
321 return (struct ublk_queue *)&(dev->__queues[qid * dev->queue_size]);
322}
323
324static inline bool ublk_rq_has_data(const struct request *rq)
325{
731e208d 326 return bio_has_data(rq->bio);
71f28f31
ML
327}
328
329static inline struct ublksrv_io_desc *ublk_get_iod(struct ublk_queue *ubq,
330 int tag)
331{
332 return (struct ublksrv_io_desc *)
333 &(ubq->io_cmd_buf[tag * sizeof(struct ublksrv_io_desc)]);
334}
335
336static inline char *ublk_queue_cmd_buf(struct ublk_device *ub, int q_id)
337{
338 return ublk_get_queue(ub, q_id)->io_cmd_buf;
339}
340
341static inline int ublk_queue_cmd_buf_size(struct ublk_device *ub, int q_id)
342{
343 struct ublk_queue *ubq = ublk_get_queue(ub, q_id);
344
345 return round_up(ubq->q_depth * sizeof(struct ublksrv_io_desc),
346 PAGE_SIZE);
347}
348
a0d41dc1
Z
349static inline bool ublk_queue_can_use_recovery_reissue(
350 struct ublk_queue *ubq)
351{
352 if ((ubq->flags & UBLK_F_USER_RECOVERY) &&
353 (ubq->flags & UBLK_F_USER_RECOVERY_REISSUE))
354 return true;
355 return false;
356}
357
77a440e2
Z
358static inline bool ublk_queue_can_use_recovery(
359 struct ublk_queue *ubq)
360{
361 if (ubq->flags & UBLK_F_USER_RECOVERY)
362 return true;
363 return false;
364}
365
366static inline bool ublk_can_use_recovery(struct ublk_device *ub)
367{
368 if (ub->dev_info.flags & UBLK_F_USER_RECOVERY)
369 return true;
370 return false;
371}
372
6d9e6dfd
CH
373static void ublk_free_disk(struct gendisk *disk)
374{
375 struct ublk_device *ub = disk->private_data;
376
377 clear_bit(UB_STATE_USED, &ub->state);
378 put_device(&ub->cdev_dev);
379}
380
48a90519
ML
381static void ublk_store_owner_uid_gid(unsigned int *owner_uid,
382 unsigned int *owner_gid)
383{
384 kuid_t uid;
385 kgid_t gid;
386
387 current_uid_gid(&uid, &gid);
388
389 *owner_uid = from_kuid(&init_user_ns, uid);
390 *owner_gid = from_kgid(&init_user_ns, gid);
391}
392
393static int ublk_open(struct block_device *bdev, fmode_t mode)
394{
395 struct ublk_device *ub = bdev->bd_disk->private_data;
396
397 if (capable(CAP_SYS_ADMIN))
398 return 0;
399
400 /*
401 * If it is one unprivileged device, only owner can open
402 * the disk. Otherwise it could be one trap made by one
403 * evil user who grants this disk's privileges to other
404 * users deliberately.
405 *
406 * This way is reasonable too given anyone can create
407 * unprivileged device, and no need other's grant.
408 */
409 if (ub->dev_info.flags & UBLK_F_UNPRIVILEGED_DEV) {
410 unsigned int curr_uid, curr_gid;
411
412 ublk_store_owner_uid_gid(&curr_uid, &curr_gid);
413
414 if (curr_uid != ub->dev_info.owner_uid || curr_gid !=
415 ub->dev_info.owner_gid)
416 return -EPERM;
417 }
418
419 return 0;
420}
421
71f28f31
ML
422static const struct block_device_operations ub_fops = {
423 .owner = THIS_MODULE,
48a90519 424 .open = ublk_open,
6d9e6dfd 425 .free_disk = ublk_free_disk,
71f28f31
ML
426};
427
428#define UBLK_MAX_PIN_PAGES 32
429
430struct ublk_map_data {
431 const struct ublk_queue *ubq;
432 const struct request *rq;
433 const struct ublk_io *io;
434 unsigned max_bytes;
435};
436
437struct ublk_io_iter {
438 struct page *pages[UBLK_MAX_PIN_PAGES];
439 unsigned pg_off; /* offset in the 1st page in pages */
440 int nr_pages; /* how many page pointers in pages */
441 struct bio *bio;
442 struct bvec_iter iter;
443};
444
445static inline unsigned ublk_copy_io_pages(struct ublk_io_iter *data,
446 unsigned max_bytes, bool to_vm)
447{
448 const unsigned total = min_t(unsigned, max_bytes,
449 PAGE_SIZE - data->pg_off +
450 ((data->nr_pages - 1) << PAGE_SHIFT));
451 unsigned done = 0;
452 unsigned pg_idx = 0;
453
454 while (done < total) {
455 struct bio_vec bv = bio_iter_iovec(data->bio, data->iter);
456 const unsigned int bytes = min3(bv.bv_len, total - done,
457 (unsigned)(PAGE_SIZE - data->pg_off));
458 void *bv_buf = bvec_kmap_local(&bv);
459 void *pg_buf = kmap_local_page(data->pages[pg_idx]);
460
461 if (to_vm)
462 memcpy(pg_buf + data->pg_off, bv_buf, bytes);
463 else
464 memcpy(bv_buf, pg_buf + data->pg_off, bytes);
465
466 kunmap_local(pg_buf);
467 kunmap_local(bv_buf);
468
469 /* advance page array */
470 data->pg_off += bytes;
471 if (data->pg_off == PAGE_SIZE) {
472 pg_idx += 1;
473 data->pg_off = 0;
474 }
475
476 done += bytes;
477
478 /* advance bio */
479 bio_advance_iter_single(data->bio, &data->iter, bytes);
480 if (!data->iter.bi_size) {
481 data->bio = data->bio->bi_next;
482 if (data->bio == NULL)
483 break;
484 data->iter = data->bio->bi_iter;
485 }
486 }
487
488 return done;
489}
490
491static inline int ublk_copy_user_pages(struct ublk_map_data *data,
492 bool to_vm)
493{
494 const unsigned int gup_flags = to_vm ? FOLL_WRITE : 0;
495 const unsigned long start_vm = data->io->addr;
496 unsigned int done = 0;
497 struct ublk_io_iter iter = {
498 .pg_off = start_vm & (PAGE_SIZE - 1),
499 .bio = data->rq->bio,
500 .iter = data->rq->bio->bi_iter,
501 };
502 const unsigned int nr_pages = round_up(data->max_bytes +
503 (start_vm & (PAGE_SIZE - 1)), PAGE_SIZE) >> PAGE_SHIFT;
504
505 while (done < nr_pages) {
506 const unsigned to_pin = min_t(unsigned, UBLK_MAX_PIN_PAGES,
507 nr_pages - done);
508 unsigned i, len;
509
510 iter.nr_pages = get_user_pages_fast(start_vm +
511 (done << PAGE_SHIFT), to_pin, gup_flags,
512 iter.pages);
513 if (iter.nr_pages <= 0)
514 return done == 0 ? iter.nr_pages : done;
515 len = ublk_copy_io_pages(&iter, data->max_bytes, to_vm);
516 for (i = 0; i < iter.nr_pages; i++) {
517 if (to_vm)
518 set_page_dirty(iter.pages[i]);
519 put_page(iter.pages[i]);
520 }
521 data->max_bytes -= len;
522 done += iter.nr_pages;
523 }
524
525 return done;
526}
527
528static int ublk_map_io(const struct ublk_queue *ubq, const struct request *req,
529 struct ublk_io *io)
530{
531 const unsigned int rq_bytes = blk_rq_bytes(req);
532 /*
533 * no zero copy, we delay copy WRITE request data into ublksrv
534 * context and the big benefit is that pinning pages in current
535 * context is pretty fast, see ublk_pin_user_pages
536 */
537 if (req_op(req) != REQ_OP_WRITE && req_op(req) != REQ_OP_FLUSH)
538 return rq_bytes;
539
540 if (ublk_rq_has_data(req)) {
541 struct ublk_map_data data = {
542 .ubq = ubq,
543 .rq = req,
544 .io = io,
545 .max_bytes = rq_bytes,
546 };
547
548 ublk_copy_user_pages(&data, true);
549
550 return rq_bytes - data.max_bytes;
551 }
552 return rq_bytes;
553}
554
555static int ublk_unmap_io(const struct ublk_queue *ubq,
556 const struct request *req,
557 struct ublk_io *io)
558{
559 const unsigned int rq_bytes = blk_rq_bytes(req);
560
561 if (req_op(req) == REQ_OP_READ && ublk_rq_has_data(req)) {
562 struct ublk_map_data data = {
563 .ubq = ubq,
564 .rq = req,
565 .io = io,
566 .max_bytes = io->res,
567 };
568
569 WARN_ON_ONCE(io->res > rq_bytes);
570
571 ublk_copy_user_pages(&data, false);
572
573 return io->res - data.max_bytes;
574 }
575 return rq_bytes;
576}
577
578static inline unsigned int ublk_req_build_flags(struct request *req)
579{
580 unsigned flags = 0;
581
582 if (req->cmd_flags & REQ_FAILFAST_DEV)
583 flags |= UBLK_IO_F_FAILFAST_DEV;
584
585 if (req->cmd_flags & REQ_FAILFAST_TRANSPORT)
586 flags |= UBLK_IO_F_FAILFAST_TRANSPORT;
587
588 if (req->cmd_flags & REQ_FAILFAST_DRIVER)
589 flags |= UBLK_IO_F_FAILFAST_DRIVER;
590
591 if (req->cmd_flags & REQ_META)
592 flags |= UBLK_IO_F_META;
593
71f28f31
ML
594 if (req->cmd_flags & REQ_FUA)
595 flags |= UBLK_IO_F_FUA;
596
71f28f31
ML
597 if (req->cmd_flags & REQ_NOUNMAP)
598 flags |= UBLK_IO_F_NOUNMAP;
599
600 if (req->cmd_flags & REQ_SWAP)
601 flags |= UBLK_IO_F_SWAP;
602
603 return flags;
604}
605
f2450f8a 606static blk_status_t ublk_setup_iod(struct ublk_queue *ubq, struct request *req)
71f28f31
ML
607{
608 struct ublksrv_io_desc *iod = ublk_get_iod(ubq, req->tag);
609 struct ublk_io *io = &ubq->ios[req->tag];
610 u32 ublk_op;
611
612 switch (req_op(req)) {
613 case REQ_OP_READ:
614 ublk_op = UBLK_IO_OP_READ;
615 break;
616 case REQ_OP_WRITE:
617 ublk_op = UBLK_IO_OP_WRITE;
618 break;
619 case REQ_OP_FLUSH:
620 ublk_op = UBLK_IO_OP_FLUSH;
621 break;
622 case REQ_OP_DISCARD:
623 ublk_op = UBLK_IO_OP_DISCARD;
624 break;
625 case REQ_OP_WRITE_ZEROES:
626 ublk_op = UBLK_IO_OP_WRITE_ZEROES;
627 break;
628 default:
629 return BLK_STS_IOERR;
630 }
631
632 /* need to translate since kernel may change */
633 iod->op_flags = ublk_op | ublk_req_build_flags(req);
634 iod->nr_sectors = blk_rq_sectors(req);
635 iod->start_sector = blk_rq_pos(req);
636 iod->addr = io->addr;
637
638 return BLK_STS_OK;
639}
640
641static inline struct ublk_uring_cmd_pdu *ublk_get_uring_cmd_pdu(
642 struct io_uring_cmd *ioucmd)
643{
644 return (struct ublk_uring_cmd_pdu *)&ioucmd->pdu;
645}
646
966120b5 647static inline bool ubq_daemon_is_dying(struct ublk_queue *ubq)
71f28f31
ML
648{
649 return ubq->ubq_daemon->flags & PF_EXITING;
650}
651
652/* todo: handle partial completion */
653static void ublk_complete_rq(struct request *req)
654{
655 struct ublk_queue *ubq = req->mq_hctx->driver_data;
656 struct ublk_io *io = &ubq->ios[req->tag];
657 unsigned int unmapped_bytes;
658
659 /* failed read IO if nothing is read */
660 if (!io->res && req_op(req) == REQ_OP_READ)
661 io->res = -EIO;
662
663 if (io->res < 0) {
664 blk_mq_end_request(req, errno_to_blk_status(io->res));
665 return;
666 }
667
668 /*
b352389e 669 * FLUSH, DISCARD or WRITE_ZEROES usually won't return bytes returned, so end them
71f28f31
ML
670 * directly.
671 *
672 * Both the two needn't unmap.
673 */
674 if (req_op(req) != REQ_OP_READ && req_op(req) != REQ_OP_WRITE) {
675 blk_mq_end_request(req, BLK_STS_OK);
676 return;
677 }
678
679 /* for READ request, writing data in iod->addr to rq buffers */
680 unmapped_bytes = ublk_unmap_io(ubq, req, io);
681
682 /*
683 * Extremely impossible since we got data filled in just before
684 *
685 * Re-read simply for this unlikely case.
686 */
687 if (unlikely(unmapped_bytes < io->res))
688 io->res = unmapped_bytes;
689
690 if (blk_update_request(req, BLK_STS_OK, io->res))
691 blk_mq_requeue_request(req, true);
692 else
693 __blk_mq_end_request(req, BLK_STS_OK);
694}
695
696/*
bb241747
Z
697 * Since __ublk_rq_task_work always fails requests immediately during
698 * exiting, __ublk_fail_req() is only called from abort context during
699 * exiting. So lock is unnecessary.
71f28f31
ML
700 *
701 * Also aborting may not be started yet, keep in mind that one failed
702 * request may be issued by block layer again.
703 */
a0d41dc1
Z
704static void __ublk_fail_req(struct ublk_queue *ubq, struct ublk_io *io,
705 struct request *req)
71f28f31
ML
706{
707 WARN_ON_ONCE(io->flags & UBLK_IO_FLAG_ACTIVE);
708
709 if (!(io->flags & UBLK_IO_FLAG_ABORTED)) {
710 io->flags |= UBLK_IO_FLAG_ABORTED;
a0d41dc1
Z
711 if (ublk_queue_can_use_recovery_reissue(ubq))
712 blk_mq_requeue_request(req, false);
713 else
714 blk_mq_end_request(req, BLK_STS_IOERR);
71f28f31
ML
715 }
716}
717
c86019ff
Z
718static void ubq_complete_io_cmd(struct ublk_io *io, int res)
719{
720 /* mark this cmd owned by ublksrv */
721 io->flags |= UBLK_IO_FLAG_OWNED_BY_SRV;
722
723 /*
724 * clear ACTIVE since we are done with this sqe/cmd slot
725 * We can only accept io cmd in case of being not active.
726 */
727 io->flags &= ~UBLK_IO_FLAG_ACTIVE;
728
729 /* tell ublksrv one io request is coming */
730 io_uring_cmd_done(io->cmd, res, 0);
731}
732
71f28f31
ML
733#define UBLK_REQUEUE_DELAY_MS 3
734
42cf5fc5
Z
735static inline void __ublk_abort_rq(struct ublk_queue *ubq,
736 struct request *rq)
737{
738 /* We cannot process this rq so just requeue it. */
739 if (ublk_queue_can_use_recovery(ubq))
740 blk_mq_requeue_request(rq, false);
741 else
742 blk_mq_end_request(rq, BLK_STS_IOERR);
743
744 mod_delayed_work(system_wq, &ubq->dev->monitor_work, 0);
745}
746
0edb3696 747static inline void __ublk_rq_task_work(struct request *req)
71f28f31 748{
71f28f31
ML
749 struct ublk_queue *ubq = req->mq_hctx->driver_data;
750 int tag = req->tag;
751 struct ublk_io *io = &ubq->ios[tag];
71f28f31
ML
752 unsigned int mapped_bytes;
753
754 pr_devel("%s: complete: op %d, qid %d tag %d io_flags %x addr %llx\n",
755 __func__, io->cmd->cmd_op, ubq->q_id, req->tag, io->flags,
756 ublk_get_iod(ubq, req->tag)->addr);
757
ae3f7193
Z
758 /*
759 * Task is exiting if either:
760 *
761 * (1) current != ubq_daemon.
762 * io_uring_cmd_complete_in_task() tries to run task_work
763 * in a workqueue if ubq_daemon(cmd's task) is PF_EXITING.
764 *
765 * (2) current->flags & PF_EXITING.
766 */
767 if (unlikely(current != ubq->ubq_daemon || current->flags & PF_EXITING)) {
42cf5fc5 768 __ublk_abort_rq(ubq, req);
71f28f31
ML
769 return;
770 }
771
c86019ff
Z
772 if (ublk_need_get_data(ubq) &&
773 (req_op(req) == REQ_OP_WRITE ||
774 req_op(req) == REQ_OP_FLUSH)) {
775 /*
776 * We have not handled UBLK_IO_NEED_GET_DATA command yet,
777 * so immepdately pass UBLK_IO_RES_NEED_GET_DATA to ublksrv
778 * and notify it.
779 */
780 if (!(io->flags & UBLK_IO_FLAG_NEED_GET_DATA)) {
781 io->flags |= UBLK_IO_FLAG_NEED_GET_DATA;
782 pr_devel("%s: need get data. op %d, qid %d tag %d io_flags %x\n",
783 __func__, io->cmd->cmd_op, ubq->q_id,
784 req->tag, io->flags);
785 ubq_complete_io_cmd(io, UBLK_IO_RES_NEED_GET_DATA);
786 return;
787 }
788 /*
789 * We have handled UBLK_IO_NEED_GET_DATA command,
790 * so clear UBLK_IO_FLAG_NEED_GET_DATA now and just
791 * do the copy work.
792 */
793 io->flags &= ~UBLK_IO_FLAG_NEED_GET_DATA;
92cb6e2e
Z
794 /* update iod->addr because ublksrv may have passed a new io buffer */
795 ublk_get_iod(ubq, req->tag)->addr = io->addr;
796 pr_devel("%s: update iod->addr: op %d, qid %d tag %d io_flags %x addr %llx\n",
797 __func__, io->cmd->cmd_op, ubq->q_id, req->tag, io->flags,
798 ublk_get_iod(ubq, req->tag)->addr);
c86019ff
Z
799 }
800
71f28f31
ML
801 mapped_bytes = ublk_map_io(ubq, req, io);
802
803 /* partially mapped, update io descriptor */
804 if (unlikely(mapped_bytes != blk_rq_bytes(req))) {
805 /*
806 * Nothing mapped, retry until we succeed.
807 *
808 * We may never succeed in mapping any bytes here because
809 * of OOM. TODO: reserve one buffer with single page pinned
810 * for providing forward progress guarantee.
811 */
812 if (unlikely(!mapped_bytes)) {
813 blk_mq_requeue_request(req, false);
814 blk_mq_delay_kick_requeue_list(req->q,
815 UBLK_REQUEUE_DELAY_MS);
816 return;
817 }
818
819 ublk_get_iod(ubq, req->tag)->nr_sectors =
820 mapped_bytes >> 9;
821 }
822
c86019ff 823 ubq_complete_io_cmd(io, UBLK_IO_RES_OK);
71f28f31
ML
824}
825
7d4a9317
ML
826static inline void ublk_forward_io_cmds(struct ublk_queue *ubq)
827{
828 struct llist_node *io_cmds = llist_del_all(&ubq->io_cmds);
829 struct ublk_rq_data *data, *tmp;
830
831 io_cmds = llist_reverse_order(io_cmds);
832 llist_for_each_entry_safe(data, tmp, io_cmds, node)
833 __ublk_rq_task_work(blk_mq_rq_from_pdu(data));
834}
835
836static inline void ublk_abort_io_cmds(struct ublk_queue *ubq)
837{
838 struct llist_node *io_cmds = llist_del_all(&ubq->io_cmds);
839 struct ublk_rq_data *data, *tmp;
840
841 llist_for_each_entry_safe(data, tmp, io_cmds, node)
842 __ublk_abort_rq(ubq, blk_mq_rq_from_pdu(data));
843}
844
0edb3696
ML
845static void ublk_rq_task_work_cb(struct io_uring_cmd *cmd)
846{
847 struct ublk_uring_cmd_pdu *pdu = ublk_get_uring_cmd_pdu(cmd);
3ab6e94c 848 struct ublk_queue *ubq = pdu->ubq;
0edb3696 849
7d4a9317 850 ublk_forward_io_cmds(ubq);
0edb3696
ML
851}
852
853static void ublk_rq_task_work_fn(struct callback_head *work)
854{
855 struct ublk_rq_data *data = container_of(work,
856 struct ublk_rq_data, work);
857 struct request *req = blk_mq_rq_from_pdu(data);
7d4a9317 858 struct ublk_queue *ubq = req->mq_hctx->driver_data;
0edb3696 859
7d4a9317 860 ublk_forward_io_cmds(ubq);
0edb3696
ML
861}
862
7d4a9317 863static void ublk_queue_cmd(struct ublk_queue *ubq, struct request *rq)
3ab6e94c 864{
7d4a9317
ML
865 struct ublk_rq_data *data = blk_mq_rq_to_pdu(rq);
866 struct ublk_io *io;
3ab6e94c 867
7d4a9317
ML
868 if (!llist_add(&data->node, &ubq->io_cmds))
869 return;
870
871 io = &ubq->ios[rq->tag];
3ab6e94c
ML
872 /*
873 * If the check pass, we know that this is a re-issued request aborted
874 * previously in monitor_work because the ubq_daemon(cmd's task) is
875 * PF_EXITING. We cannot call io_uring_cmd_complete_in_task() anymore
876 * because this ioucmd's io_uring context may be freed now if no inflight
877 * ioucmd exists. Otherwise we may cause null-deref in ctx->fallback_work.
878 *
879 * Note: monitor_work sets UBLK_IO_FLAG_ABORTED and ends this request(releasing
880 * the tag). Then the request is re-started(allocating the tag) and we are here.
881 * Since releasing/allocating a tag implies smp_mb(), finding UBLK_IO_FLAG_ABORTED
882 * guarantees that here is a re-issued request aborted previously.
883 */
884 if (unlikely(io->flags & UBLK_IO_FLAG_ABORTED)) {
7d4a9317
ML
885 ublk_abort_io_cmds(ubq);
886 } else if (ublk_can_use_task_work(ubq)) {
887 if (task_work_add(ubq->ubq_daemon, &data->work,
888 TWA_SIGNAL_NO_IPI))
889 ublk_abort_io_cmds(ubq);
3ab6e94c
ML
890 } else {
891 struct io_uring_cmd *cmd = io->cmd;
892 struct ublk_uring_cmd_pdu *pdu = ublk_get_uring_cmd_pdu(cmd);
893
894 pdu->ubq = ubq;
895 io_uring_cmd_complete_in_task(cmd, ublk_rq_task_work_cb);
896 }
897}
898
71f28f31
ML
899static blk_status_t ublk_queue_rq(struct blk_mq_hw_ctx *hctx,
900 const struct blk_mq_queue_data *bd)
901{
902 struct ublk_queue *ubq = hctx->driver_data;
903 struct request *rq = bd->rq;
71f28f31
ML
904 blk_status_t res;
905
906 /* fill iod to slot in io cmd buffer */
907 res = ublk_setup_iod(ubq, rq);
908 if (unlikely(res != BLK_STS_OK))
909 return BLK_STS_IOERR;
3ab6e94c 910
bbae8d1f
Z
911 /* With recovery feature enabled, force_abort is set in
912 * ublk_stop_dev() before calling del_gendisk(). We have to
913 * abort all requeued and new rqs here to let del_gendisk()
914 * move on. Besides, we cannot not call io_uring_cmd_complete_in_task()
915 * to avoid UAF on io_uring ctx.
916 *
917 * Note: force_abort is guaranteed to be seen because it is set
918 * before request queue is unqiuesced.
919 */
920 if (ublk_queue_can_use_recovery(ubq) && unlikely(ubq->force_abort))
921 return BLK_STS_IOERR;
71f28f31
ML
922
923 blk_mq_start_request(bd->rq);
924
925 if (unlikely(ubq_daemon_is_dying(ubq))) {
42cf5fc5
Z
926 __ublk_abort_rq(ubq, rq);
927 return BLK_STS_OK;
71f28f31
ML
928 }
929
7d4a9317 930 ublk_queue_cmd(ubq, rq);
0edb3696 931
71f28f31
ML
932 return BLK_STS_OK;
933}
934
71f28f31
ML
935static int ublk_init_hctx(struct blk_mq_hw_ctx *hctx, void *driver_data,
936 unsigned int hctx_idx)
937{
cebbe577 938 struct ublk_device *ub = driver_data;
71f28f31
ML
939 struct ublk_queue *ubq = ublk_get_queue(ub, hctx->queue_num);
940
941 hctx->driver_data = ubq;
942 return 0;
943}
944
0edb3696
ML
945static int ublk_init_rq(struct blk_mq_tag_set *set, struct request *req,
946 unsigned int hctx_idx, unsigned int numa_node)
947{
948 struct ublk_rq_data *data = blk_mq_rq_to_pdu(req);
949
950 init_task_work(&data->work, ublk_rq_task_work_fn);
951 return 0;
952}
953
71f28f31
ML
954static const struct blk_mq_ops ublk_mq_ops = {
955 .queue_rq = ublk_queue_rq,
956 .init_hctx = ublk_init_hctx,
0edb3696 957 .init_request = ublk_init_rq,
71f28f31
ML
958};
959
960static int ublk_ch_open(struct inode *inode, struct file *filp)
961{
962 struct ublk_device *ub = container_of(inode->i_cdev,
963 struct ublk_device, cdev);
964
fa362045
CH
965 if (test_and_set_bit(UB_STATE_OPEN, &ub->state))
966 return -EBUSY;
967 filp->private_data = ub;
968 return 0;
71f28f31
ML
969}
970
971static int ublk_ch_release(struct inode *inode, struct file *filp)
972{
973 struct ublk_device *ub = filp->private_data;
974
fa362045 975 clear_bit(UB_STATE_OPEN, &ub->state);
71f28f31
ML
976 return 0;
977}
978
979/* map pre-allocated per-queue cmd buffer to ublksrv daemon */
980static int ublk_ch_mmap(struct file *filp, struct vm_area_struct *vma)
981{
982 struct ublk_device *ub = filp->private_data;
983 size_t sz = vma->vm_end - vma->vm_start;
984 unsigned max_sz = UBLK_MAX_QUEUE_DEPTH * sizeof(struct ublksrv_io_desc);
985 unsigned long pfn, end, phys_off = vma->vm_pgoff << PAGE_SHIFT;
986 int q_id, ret = 0;
987
e94eb459 988 spin_lock(&ub->mm_lock);
71f28f31
ML
989 if (!ub->mm)
990 ub->mm = current->mm;
991 if (current->mm != ub->mm)
992 ret = -EINVAL;
e94eb459 993 spin_unlock(&ub->mm_lock);
71f28f31
ML
994
995 if (ret)
996 return ret;
997
998 if (vma->vm_flags & VM_WRITE)
999 return -EPERM;
1000
1001 end = UBLKSRV_CMD_BUF_OFFSET + ub->dev_info.nr_hw_queues * max_sz;
1002 if (phys_off < UBLKSRV_CMD_BUF_OFFSET || phys_off >= end)
1003 return -EINVAL;
1004
1005 q_id = (phys_off - UBLKSRV_CMD_BUF_OFFSET) / max_sz;
1006 pr_devel("%s: qid %d, pid %d, addr %lx pg_off %lx sz %lu\n",
1007 __func__, q_id, current->pid, vma->vm_start,
1008 phys_off, (unsigned long)sz);
1009
1010 if (sz != ublk_queue_cmd_buf_size(ub, q_id))
1011 return -EINVAL;
1012
1013 pfn = virt_to_phys(ublk_queue_cmd_buf(ub, q_id)) >> PAGE_SHIFT;
1014 return remap_pfn_range(vma, vma->vm_start, pfn, sz, vma->vm_page_prot);
1015}
1016
1017static void ublk_commit_completion(struct ublk_device *ub,
1018 struct ublksrv_io_cmd *ub_cmd)
1019{
1020 u32 qid = ub_cmd->q_id, tag = ub_cmd->tag;
1021 struct ublk_queue *ubq = ublk_get_queue(ub, qid);
1022 struct ublk_io *io = &ubq->ios[tag];
1023 struct request *req;
1024
1025 /* now this cmd slot is owned by nbd driver */
1026 io->flags &= ~UBLK_IO_FLAG_OWNED_BY_SRV;
1027 io->res = ub_cmd->result;
1028
1029 /* find the io request and complete */
1030 req = blk_mq_tag_to_rq(ub->tag_set.tags[qid], tag);
1031
1032 if (req && likely(!blk_should_fake_timeout(req->q)))
1033 ublk_complete_rq(req);
1034}
1035
1036/*
1037 * When ->ubq_daemon is exiting, either new request is ended immediately,
1038 * or any queued io command is drained, so it is safe to abort queue
1039 * lockless
1040 */
1041static void ublk_abort_queue(struct ublk_device *ub, struct ublk_queue *ubq)
1042{
1043 int i;
1044
1045 if (!ublk_get_device(ub))
1046 return;
1047
1048 for (i = 0; i < ubq->q_depth; i++) {
1049 struct ublk_io *io = &ubq->ios[i];
1050
1051 if (!(io->flags & UBLK_IO_FLAG_ACTIVE)) {
1052 struct request *rq;
1053
1054 /*
1055 * Either we fail the request or ublk_rq_task_work_fn
1056 * will do it
1057 */
1058 rq = blk_mq_tag_to_rq(ub->tag_set.tags[ubq->q_id], i);
1059 if (rq)
a0d41dc1 1060 __ublk_fail_req(ubq, io, rq);
71f28f31
ML
1061 }
1062 }
1063 ublk_put_device(ub);
1064}
1065
1066static void ublk_daemon_monitor_work(struct work_struct *work)
1067{
1068 struct ublk_device *ub =
1069 container_of(work, struct ublk_device, monitor_work.work);
1070 int i;
1071
1072 for (i = 0; i < ub->dev_info.nr_hw_queues; i++) {
1073 struct ublk_queue *ubq = ublk_get_queue(ub, i);
1074
1075 if (ubq_daemon_is_dying(ubq)) {
bbae8d1f
Z
1076 if (ublk_queue_can_use_recovery(ubq))
1077 schedule_work(&ub->quiesce_work);
1078 else
1079 schedule_work(&ub->stop_work);
71f28f31
ML
1080
1081 /* abort queue is for making forward progress */
1082 ublk_abort_queue(ub, ubq);
1083 }
1084 }
1085
1086 /*
bbae8d1f
Z
1087 * We can't schedule monitor work after ub's state is not UBLK_S_DEV_LIVE.
1088 * after ublk_remove() or __ublk_quiesce_dev() is started.
71f28f31
ML
1089 *
1090 * No need ub->mutex, monitor work are canceled after state is marked
bbae8d1f 1091 * as not LIVE, so new state is observed reliably.
71f28f31 1092 */
bbae8d1f 1093 if (ub->dev_info.state == UBLK_S_DEV_LIVE)
71f28f31
ML
1094 schedule_delayed_work(&ub->monitor_work,
1095 UBLK_DAEMON_MONITOR_PERIOD);
1096}
1097
a8ce5f52
ML
1098static inline bool ublk_queue_ready(struct ublk_queue *ubq)
1099{
1100 return ubq->nr_io_ready == ubq->q_depth;
1101}
1102
71f28f31
ML
1103static void ublk_cancel_queue(struct ublk_queue *ubq)
1104{
1105 int i;
1106
a8ce5f52
ML
1107 if (!ublk_queue_ready(ubq))
1108 return;
1109
71f28f31
ML
1110 for (i = 0; i < ubq->q_depth; i++) {
1111 struct ublk_io *io = &ubq->ios[i];
1112
1113 if (io->flags & UBLK_IO_FLAG_ACTIVE)
1114 io_uring_cmd_done(io->cmd, UBLK_IO_RES_ABORT, 0);
1115 }
a8ce5f52
ML
1116
1117 /* all io commands are canceled */
1118 ubq->nr_io_ready = 0;
71f28f31
ML
1119}
1120
1121/* Cancel all pending commands, must be called after del_gendisk() returns */
1122static void ublk_cancel_dev(struct ublk_device *ub)
1123{
1124 int i;
1125
1126 for (i = 0; i < ub->dev_info.nr_hw_queues; i++)
1127 ublk_cancel_queue(ublk_get_queue(ub, i));
1128}
1129
bbae8d1f
Z
1130static bool ublk_check_inflight_rq(struct request *rq, void *data)
1131{
1132 bool *idle = data;
1133
1134 if (blk_mq_request_started(rq)) {
1135 *idle = false;
1136 return false;
1137 }
1138 return true;
1139}
1140
1141static void ublk_wait_tagset_rqs_idle(struct ublk_device *ub)
1142{
1143 bool idle;
1144
1145 WARN_ON_ONCE(!blk_queue_quiesced(ub->ub_disk->queue));
1146 while (true) {
1147 idle = true;
1148 blk_mq_tagset_busy_iter(&ub->tag_set,
1149 ublk_check_inflight_rq, &idle);
1150 if (idle)
1151 break;
1152 msleep(UBLK_REQUEUE_DELAY_MS);
1153 }
1154}
1155
1156static void __ublk_quiesce_dev(struct ublk_device *ub)
71f28f31 1157{
bbae8d1f
Z
1158 pr_devel("%s: quiesce ub: dev_id %d state %s\n",
1159 __func__, ub->dev_info.dev_id,
1160 ub->dev_info.state == UBLK_S_DEV_LIVE ?
1161 "LIVE" : "QUIESCED");
1162 blk_mq_quiesce_queue(ub->ub_disk->queue);
1163 ublk_wait_tagset_rqs_idle(ub);
1164 ub->dev_info.state = UBLK_S_DEV_QUIESCED;
1165 ublk_cancel_dev(ub);
1166 /* we are going to release task_struct of ubq_daemon and resets
1167 * ->ubq_daemon to NULL. So in monitor_work, check on ubq_daemon causes UAF.
1168 * Besides, monitor_work is not necessary in QUIESCED state since we have
1169 * already scheduled quiesce_work and quiesced all ubqs.
1170 *
1171 * Do not let monitor_work schedule itself if state it QUIESCED. And we cancel
1172 * it here and re-schedule it in END_USER_RECOVERY to avoid UAF.
1173 */
1174 cancel_delayed_work_sync(&ub->monitor_work);
1175}
1176
1177static void ublk_quiesce_work_fn(struct work_struct *work)
1178{
1179 struct ublk_device *ub =
1180 container_of(work, struct ublk_device, quiesce_work);
1181
71f28f31 1182 mutex_lock(&ub->mutex);
6d9e6dfd 1183 if (ub->dev_info.state != UBLK_S_DEV_LIVE)
71f28f31 1184 goto unlock;
bbae8d1f
Z
1185 __ublk_quiesce_dev(ub);
1186 unlock:
1187 mutex_unlock(&ub->mutex);
1188}
71f28f31 1189
bbae8d1f
Z
1190static void ublk_unquiesce_dev(struct ublk_device *ub)
1191{
1192 int i;
1193
1194 pr_devel("%s: unquiesce ub: dev_id %d state %s\n",
1195 __func__, ub->dev_info.dev_id,
1196 ub->dev_info.state == UBLK_S_DEV_LIVE ?
1197 "LIVE" : "QUIESCED");
1198 /* quiesce_work has run. We let requeued rqs be aborted
1199 * before running fallback_wq. "force_abort" must be seen
1200 * after request queue is unqiuesced. Then del_gendisk()
1201 * can move on.
1202 */
1203 for (i = 0; i < ub->dev_info.nr_hw_queues; i++)
1204 ublk_get_queue(ub, i)->force_abort = true;
1205
1206 blk_mq_unquiesce_queue(ub->ub_disk->queue);
1207 /* We may have requeued some rqs in ublk_quiesce_queue() */
1208 blk_mq_kick_requeue_list(ub->ub_disk->queue);
1209}
1210
1211static void ublk_stop_dev(struct ublk_device *ub)
1212{
1213 mutex_lock(&ub->mutex);
1214 if (ub->dev_info.state == UBLK_S_DEV_DEAD)
1215 goto unlock;
1216 if (ublk_can_use_recovery(ub)) {
1217 if (ub->dev_info.state == UBLK_S_DEV_LIVE)
1218 __ublk_quiesce_dev(ub);
1219 ublk_unquiesce_dev(ub);
1220 }
71f28f31
ML
1221 del_gendisk(ub->ub_disk);
1222 ub->dev_info.state = UBLK_S_DEV_DEAD;
1223 ub->dev_info.ublksrv_pid = -1;
6d9e6dfd
CH
1224 put_disk(ub->ub_disk);
1225 ub->ub_disk = NULL;
71f28f31 1226 unlock:
a8ce5f52 1227 ublk_cancel_dev(ub);
71f28f31
ML
1228 mutex_unlock(&ub->mutex);
1229 cancel_delayed_work_sync(&ub->monitor_work);
1230}
1231
71f28f31
ML
1232/* device can only be started after all IOs are ready */
1233static void ublk_mark_io_ready(struct ublk_device *ub, struct ublk_queue *ubq)
1234{
1235 mutex_lock(&ub->mutex);
1236 ubq->nr_io_ready++;
1237 if (ublk_queue_ready(ubq)) {
1238 ubq->ubq_daemon = current;
1239 get_task_struct(ubq->ubq_daemon);
1240 ub->nr_queues_ready++;
73a166d9
ML
1241
1242 if (capable(CAP_SYS_ADMIN))
1243 ub->nr_privileged_daemon++;
71f28f31
ML
1244 }
1245 if (ub->nr_queues_ready == ub->dev_info.nr_hw_queues)
1246 complete_all(&ub->completion);
1247 mutex_unlock(&ub->mutex);
1248}
1249
c86019ff 1250static void ublk_handle_need_get_data(struct ublk_device *ub, int q_id,
fee32f31 1251 int tag)
c86019ff
Z
1252{
1253 struct ublk_queue *ubq = ublk_get_queue(ub, q_id);
1254 struct request *req = blk_mq_tag_to_rq(ub->tag_set.tags[q_id], tag);
1255
7d4a9317 1256 ublk_queue_cmd(ubq, req);
c86019ff
Z
1257}
1258
71f28f31
ML
1259static int ublk_ch_uring_cmd(struct io_uring_cmd *cmd, unsigned int issue_flags)
1260{
1261 struct ublksrv_io_cmd *ub_cmd = (struct ublksrv_io_cmd *)cmd->cmd;
1262 struct ublk_device *ub = cmd->file->private_data;
1263 struct ublk_queue *ubq;
1264 struct ublk_io *io;
1265 u32 cmd_op = cmd->cmd_op;
1266 unsigned tag = ub_cmd->tag;
1267 int ret = -EINVAL;
1268
1269 pr_devel("%s: received: cmd op %d queue %d tag %d result %d\n",
1270 __func__, cmd->cmd_op, ub_cmd->q_id, tag,
1271 ub_cmd->result);
1272
1273 if (!(issue_flags & IO_URING_F_SQE128))
1274 goto out;
1275
1276 if (ub_cmd->q_id >= ub->dev_info.nr_hw_queues)
1277 goto out;
1278
1279 ubq = ublk_get_queue(ub, ub_cmd->q_id);
1280 if (!ubq || ub_cmd->q_id != ubq->q_id)
1281 goto out;
1282
1283 if (ubq->ubq_daemon && ubq->ubq_daemon != current)
1284 goto out;
1285
1286 if (tag >= ubq->q_depth)
1287 goto out;
1288
1289 io = &ubq->ios[tag];
1290
1291 /* there is pending io cmd, something must be wrong */
1292 if (io->flags & UBLK_IO_FLAG_ACTIVE) {
1293 ret = -EBUSY;
1294 goto out;
1295 }
1296
c86019ff
Z
1297 /*
1298 * ensure that the user issues UBLK_IO_NEED_GET_DATA
1299 * iff the driver have set the UBLK_IO_FLAG_NEED_GET_DATA.
1300 */
1301 if ((!!(io->flags & UBLK_IO_FLAG_NEED_GET_DATA))
1302 ^ (cmd_op == UBLK_IO_NEED_GET_DATA))
1303 goto out;
1304
71f28f31
ML
1305 switch (cmd_op) {
1306 case UBLK_IO_FETCH_REQ:
1307 /* UBLK_IO_FETCH_REQ is only allowed before queue is setup */
1308 if (ublk_queue_ready(ubq)) {
1309 ret = -EBUSY;
1310 goto out;
1311 }
1312 /*
1313 * The io is being handled by server, so COMMIT_RQ is expected
1314 * instead of FETCH_REQ
1315 */
1316 if (io->flags & UBLK_IO_FLAG_OWNED_BY_SRV)
1317 goto out;
1318 /* FETCH_RQ has to provide IO buffer */
1319 if (!ub_cmd->addr)
1320 goto out;
1321 io->cmd = cmd;
1322 io->flags |= UBLK_IO_FLAG_ACTIVE;
1323 io->addr = ub_cmd->addr;
1324
1325 ublk_mark_io_ready(ub, ubq);
1326 break;
1327 case UBLK_IO_COMMIT_AND_FETCH_REQ:
1328 /* FETCH_RQ has to provide IO buffer */
1329 if (!ub_cmd->addr)
1330 goto out;
1331 if (!(io->flags & UBLK_IO_FLAG_OWNED_BY_SRV))
1332 goto out;
1333 io->addr = ub_cmd->addr;
1334 io->flags |= UBLK_IO_FLAG_ACTIVE;
1335 io->cmd = cmd;
1336 ublk_commit_completion(ub, ub_cmd);
1337 break;
c86019ff
Z
1338 case UBLK_IO_NEED_GET_DATA:
1339 if (!(io->flags & UBLK_IO_FLAG_OWNED_BY_SRV))
1340 goto out;
1341 io->addr = ub_cmd->addr;
1342 io->cmd = cmd;
1343 io->flags |= UBLK_IO_FLAG_ACTIVE;
fee32f31 1344 ublk_handle_need_get_data(ub, ub_cmd->q_id, ub_cmd->tag);
c86019ff 1345 break;
71f28f31
ML
1346 default:
1347 goto out;
1348 }
1349 return -EIOCBQUEUED;
1350
1351 out:
71f28f31
ML
1352 io_uring_cmd_done(cmd, ret, 0);
1353 pr_devel("%s: complete: cmd op %d, tag %d ret %x io_flags %x\n",
1354 __func__, cmd_op, tag, ret, io->flags);
1355 return -EIOCBQUEUED;
1356}
1357
1358static const struct file_operations ublk_ch_fops = {
1359 .owner = THIS_MODULE,
1360 .open = ublk_ch_open,
1361 .release = ublk_ch_release,
1362 .llseek = no_llseek,
1363 .uring_cmd = ublk_ch_uring_cmd,
1364 .mmap = ublk_ch_mmap,
1365};
1366
1367static void ublk_deinit_queue(struct ublk_device *ub, int q_id)
1368{
1369 int size = ublk_queue_cmd_buf_size(ub, q_id);
1370 struct ublk_queue *ubq = ublk_get_queue(ub, q_id);
1371
1372 if (ubq->ubq_daemon)
1373 put_task_struct(ubq->ubq_daemon);
1374 if (ubq->io_cmd_buf)
1375 free_pages((unsigned long)ubq->io_cmd_buf, get_order(size));
1376}
1377
1378static int ublk_init_queue(struct ublk_device *ub, int q_id)
1379{
1380 struct ublk_queue *ubq = ublk_get_queue(ub, q_id);
1381 gfp_t gfp_flags = GFP_KERNEL | __GFP_ZERO;
1382 void *ptr;
1383 int size;
1384
6d8c5afc 1385 ubq->flags = ub->dev_info.flags;
71f28f31
ML
1386 ubq->q_id = q_id;
1387 ubq->q_depth = ub->dev_info.queue_depth;
1388 size = ublk_queue_cmd_buf_size(ub, q_id);
1389
1390 ptr = (void *) __get_free_pages(gfp_flags, get_order(size));
1391 if (!ptr)
1392 return -ENOMEM;
1393
1394 ubq->io_cmd_buf = ptr;
1395 ubq->dev = ub;
1396 return 0;
1397}
1398
1399static void ublk_deinit_queues(struct ublk_device *ub)
1400{
1401 int nr_queues = ub->dev_info.nr_hw_queues;
1402 int i;
1403
1404 if (!ub->__queues)
1405 return;
1406
1407 for (i = 0; i < nr_queues; i++)
1408 ublk_deinit_queue(ub, i);
1409 kfree(ub->__queues);
1410}
1411
1412static int ublk_init_queues(struct ublk_device *ub)
1413{
1414 int nr_queues = ub->dev_info.nr_hw_queues;
1415 int depth = ub->dev_info.queue_depth;
1416 int ubq_size = sizeof(struct ublk_queue) + depth * sizeof(struct ublk_io);
1417 int i, ret = -ENOMEM;
1418
1419 ub->queue_size = ubq_size;
1420 ub->__queues = kcalloc(nr_queues, ubq_size, GFP_KERNEL);
1421 if (!ub->__queues)
1422 return ret;
1423
1424 for (i = 0; i < nr_queues; i++) {
1425 if (ublk_init_queue(ub, i))
1426 goto fail;
1427 }
1428
1429 init_completion(&ub->completion);
1430 return 0;
1431
1432 fail:
1433 ublk_deinit_queues(ub);
1434 return ret;
1435}
1436
fa9482e0 1437static int ublk_alloc_dev_number(struct ublk_device *ub, int idx)
71f28f31
ML
1438{
1439 int i = idx;
1440 int err;
1441
1442 spin_lock(&ublk_idr_lock);
1443 /* allocate id, if @id >= 0, we're requesting that specific id */
1444 if (i >= 0) {
1445 err = idr_alloc(&ublk_index_idr, ub, i, i + 1, GFP_NOWAIT);
1446 if (err == -ENOSPC)
1447 err = -EEXIST;
1448 } else {
1449 err = idr_alloc(&ublk_index_idr, ub, 0, 0, GFP_NOWAIT);
1450 }
1451 spin_unlock(&ublk_idr_lock);
1452
1453 if (err >= 0)
1454 ub->ub_number = err;
1455
1456 return err;
1457}
1458
fa9482e0 1459static void ublk_free_dev_number(struct ublk_device *ub)
71f28f31
ML
1460{
1461 spin_lock(&ublk_idr_lock);
1462 idr_remove(&ublk_index_idr, ub->ub_number);
1463 wake_up_all(&ublk_idr_wq);
1464 spin_unlock(&ublk_idr_lock);
71f28f31
ML
1465}
1466
1467static void ublk_cdev_rel(struct device *dev)
1468{
1469 struct ublk_device *ub = container_of(dev, struct ublk_device, cdev_dev);
1470
71f28f31 1471 blk_mq_free_tag_set(&ub->tag_set);
71f28f31 1472 ublk_deinit_queues(ub);
fa9482e0
CH
1473 ublk_free_dev_number(ub);
1474 mutex_destroy(&ub->mutex);
1475 kfree(ub);
71f28f31
ML
1476}
1477
1478static int ublk_add_chdev(struct ublk_device *ub)
1479{
1480 struct device *dev = &ub->cdev_dev;
1481 int minor = ub->ub_number;
1482 int ret;
1483
1484 dev->parent = ublk_misc.this_device;
1485 dev->devt = MKDEV(MAJOR(ublk_chr_devt), minor);
1486 dev->class = ublk_chr_class;
1487 dev->release = ublk_cdev_rel;
1488 device_initialize(dev);
1489
1490 ret = dev_set_name(dev, "ublkc%d", minor);
1491 if (ret)
1492 goto fail;
1493
1494 cdev_init(&ub->cdev, &ublk_ch_fops);
1495 ret = cdev_device_add(&ub->cdev, dev);
1496 if (ret)
1497 goto fail;
403ebc87
ML
1498
1499 ublks_added++;
71f28f31
ML
1500 return 0;
1501 fail:
1502 put_device(dev);
1503 return ret;
1504}
1505
1506static void ublk_stop_work_fn(struct work_struct *work)
1507{
1508 struct ublk_device *ub =
1509 container_of(work, struct ublk_device, stop_work);
1510
1511 ublk_stop_dev(ub);
1512}
1513
4bf9cbf3 1514/* align max io buffer size with PAGE_SIZE */
6d9e6dfd 1515static void ublk_align_max_io_size(struct ublk_device *ub)
71f28f31 1516{
4bf9cbf3 1517 unsigned int max_io_bytes = ub->dev_info.max_io_buf_bytes;
71f28f31 1518
4bf9cbf3
ML
1519 ub->dev_info.max_io_buf_bytes =
1520 round_down(max_io_bytes, PAGE_SIZE);
71f28f31
ML
1521}
1522
fa9482e0 1523static int ublk_add_tag_set(struct ublk_device *ub)
71f28f31 1524{
71f28f31
ML
1525 ub->tag_set.ops = &ublk_mq_ops;
1526 ub->tag_set.nr_hw_queues = ub->dev_info.nr_hw_queues;
1527 ub->tag_set.queue_depth = ub->dev_info.queue_depth;
1528 ub->tag_set.numa_node = NUMA_NO_NODE;
0edb3696 1529 ub->tag_set.cmd_size = sizeof(struct ublk_rq_data);
71f28f31
ML
1530 ub->tag_set.flags = BLK_MQ_F_SHOULD_MERGE;
1531 ub->tag_set.driver_data = ub;
fa9482e0 1532 return blk_mq_alloc_tag_set(&ub->tag_set);
71f28f31
ML
1533}
1534
1535static void ublk_remove(struct ublk_device *ub)
1536{
34d8f2be
CH
1537 ublk_stop_dev(ub);
1538 cancel_work_sync(&ub->stop_work);
bbae8d1f 1539 cancel_work_sync(&ub->quiesce_work);
71f28f31
ML
1540 cdev_device_del(&ub->cdev, &ub->cdev_dev);
1541 put_device(&ub->cdev_dev);
403ebc87 1542 ublks_added--;
71f28f31
ML
1543}
1544
1545static struct ublk_device *ublk_get_device_from_id(int idx)
1546{
1547 struct ublk_device *ub = NULL;
1548
1549 if (idx < 0)
1550 return NULL;
1551
1552 spin_lock(&ublk_idr_lock);
1553 ub = idr_find(&ublk_index_idr, idx);
1554 if (ub)
1555 ub = ublk_get_device(ub);
1556 spin_unlock(&ublk_idr_lock);
1557
1558 return ub;
1559}
1560
bfbcef03 1561static int ublk_ctrl_start_dev(struct ublk_device *ub, struct io_uring_cmd *cmd)
71f28f31
ML
1562{
1563 struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)cmd->cmd;
71f28f31 1564 int ublksrv_pid = (int)header->data[0];
6d9e6dfd 1565 struct gendisk *disk;
34d8f2be 1566 int ret = -EINVAL;
71f28f31
ML
1567
1568 if (ublksrv_pid <= 0)
34d8f2be
CH
1569 return -EINVAL;
1570
71f28f31
ML
1571 wait_for_completion_interruptible(&ub->completion);
1572
1573 schedule_delayed_work(&ub->monitor_work, UBLK_DAEMON_MONITOR_PERIOD);
1574
1575 mutex_lock(&ub->mutex);
6d9e6dfd
CH
1576 if (ub->dev_info.state == UBLK_S_DEV_LIVE ||
1577 test_bit(UB_STATE_USED, &ub->state)) {
71f28f31 1578 ret = -EEXIST;
34d8f2be 1579 goto out_unlock;
71f28f31 1580 }
71f28f31 1581
1972d038 1582 disk = blk_mq_alloc_disk(&ub->tag_set, NULL);
6d9e6dfd
CH
1583 if (IS_ERR(disk)) {
1584 ret = PTR_ERR(disk);
1585 goto out_unlock;
34d8f2be 1586 }
6d9e6dfd
CH
1587 sprintf(disk->disk_name, "ublkb%d", ub->ub_number);
1588 disk->fops = &ub_fops;
1589 disk->private_data = ub;
1590
34d8f2be 1591 ub->dev_info.ublksrv_pid = ublksrv_pid;
6d9e6dfd 1592 ub->ub_disk = disk;
0aa73170
ML
1593
1594 ret = ublk_apply_params(ub);
1595 if (ret)
1596 goto out_put_disk;
1597
73a166d9
ML
1598 /* don't probe partitions if any one ubq daemon is un-trusted */
1599 if (ub->nr_privileged_daemon != ub->nr_queues_ready)
1600 set_bit(GD_SUPPRESS_PART_SCAN, &disk->state);
1601
6d9e6dfd
CH
1602 get_device(&ub->cdev_dev);
1603 ret = add_disk(disk);
1604 if (ret) {
93d71ec8
ML
1605 /*
1606 * Has to drop the reference since ->free_disk won't be
1607 * called in case of add_disk failure.
1608 */
1609 ublk_put_device(ub);
0aa73170 1610 goto out_put_disk;
6d9e6dfd
CH
1611 }
1612 set_bit(UB_STATE_USED, &ub->state);
34d8f2be 1613 ub->dev_info.state = UBLK_S_DEV_LIVE;
0aa73170
ML
1614out_put_disk:
1615 if (ret)
1616 put_disk(disk);
34d8f2be
CH
1617out_unlock:
1618 mutex_unlock(&ub->mutex);
71f28f31
ML
1619 return ret;
1620}
1621
bfbcef03
ML
1622static int ublk_ctrl_get_queue_affinity(struct ublk_device *ub,
1623 struct io_uring_cmd *cmd)
71f28f31
ML
1624{
1625 struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)cmd->cmd;
1626 void __user *argp = (void __user *)(unsigned long)header->addr;
c50061f0 1627 cpumask_var_t cpumask;
71f28f31
ML
1628 unsigned long queue;
1629 unsigned int retlen;
c50061f0 1630 unsigned int i;
bfbcef03
ML
1631 int ret;
1632
34d8f2be
CH
1633 if (header->len * BITS_PER_BYTE < nr_cpu_ids)
1634 return -EINVAL;
1635 if (header->len & (sizeof(unsigned long)-1))
1636 return -EINVAL;
1637 if (!header->addr)
1638 return -EINVAL;
71f28f31 1639
71f28f31
ML
1640 queue = header->data[0];
1641 if (queue >= ub->dev_info.nr_hw_queues)
bfbcef03 1642 return -EINVAL;
71f28f31 1643
c50061f0 1644 if (!zalloc_cpumask_var(&cpumask, GFP_KERNEL))
bfbcef03 1645 return -ENOMEM;
c50061f0
CH
1646
1647 for_each_possible_cpu(i) {
1648 if (ub->tag_set.map[HCTX_TYPE_DEFAULT].mq_map[i] == queue)
1649 cpumask_set_cpu(i, cpumask);
71f28f31 1650 }
c50061f0
CH
1651
1652 ret = -EFAULT;
1653 retlen = min_t(unsigned short, header->len, cpumask_size());
1654 if (copy_to_user(argp, cpumask, retlen))
1655 goto out_free_cpumask;
1656 if (retlen != header->len &&
1657 clear_user(argp + retlen, header->len - retlen))
1658 goto out_free_cpumask;
1659
71f28f31 1660 ret = 0;
c50061f0
CH
1661out_free_cpumask:
1662 free_cpumask_var(cpumask);
71f28f31
ML
1663 return ret;
1664}
1665
34d8f2be 1666static inline void ublk_dump_dev_info(struct ublksrv_ctrl_dev_info *info)
71f28f31 1667{
34d8f2be 1668 pr_devel("%s: dev id %d flags %llx\n", __func__,
6d8c5afc 1669 info->dev_id, info->flags);
4bf9cbf3
ML
1670 pr_devel("\t nr_hw_queues %d queue_depth %d\n",
1671 info->nr_hw_queues, info->queue_depth);
34d8f2be
CH
1672}
1673
1674static int ublk_ctrl_add_dev(struct io_uring_cmd *cmd)
1675{
1676 struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)cmd->cmd;
1677 void __user *argp = (void __user *)(unsigned long)header->addr;
1678 struct ublksrv_ctrl_dev_info info;
71f28f31 1679 struct ublk_device *ub;
34d8f2be
CH
1680 int ret = -EINVAL;
1681
1682 if (header->len < sizeof(info) || !header->addr)
1683 return -EINVAL;
1684 if (header->queue_id != (u16)-1) {
1685 pr_warn("%s: queue_id is wrong %x\n",
1686 __func__, header->queue_id);
1687 return -EINVAL;
1688 }
4093cb5a 1689
34d8f2be
CH
1690 if (copy_from_user(&info, argp, sizeof(info)))
1691 return -EFAULT;
4093cb5a
ML
1692
1693 if (capable(CAP_SYS_ADMIN))
1694 info.flags &= ~UBLK_F_UNPRIVILEGED_DEV;
1695 else if (!(info.flags & UBLK_F_UNPRIVILEGED_DEV))
1696 return -EPERM;
1697
1698 /* the created device is always owned by current user */
48a90519 1699 ublk_store_owner_uid_gid(&info.owner_uid, &info.owner_gid);
4093cb5a 1700
34d8f2be
CH
1701 if (header->dev_id != info.dev_id) {
1702 pr_warn("%s: dev id not match %u %u\n",
1703 __func__, header->dev_id, info.dev_id);
1704 return -EINVAL;
1705 }
71f28f31 1706
4093cb5a
ML
1707 ublk_dump_dev_info(&info);
1708
71f28f31
ML
1709 ret = mutex_lock_killable(&ublk_ctl_mutex);
1710 if (ret)
1711 return ret;
1712
403ebc87
ML
1713 ret = -EACCES;
1714 if (ublks_added >= ublks_max)
1715 goto out_unlock;
1716
cfee7e4d
CH
1717 ret = -ENOMEM;
1718 ub = kzalloc(sizeof(*ub), GFP_KERNEL);
1719 if (!ub)
1720 goto out_unlock;
fa9482e0
CH
1721 mutex_init(&ub->mutex);
1722 spin_lock_init(&ub->mm_lock);
bbae8d1f 1723 INIT_WORK(&ub->quiesce_work, ublk_quiesce_work_fn);
fa9482e0
CH
1724 INIT_WORK(&ub->stop_work, ublk_stop_work_fn);
1725 INIT_DELAYED_WORK(&ub->monitor_work, ublk_daemon_monitor_work);
cfee7e4d 1726
fa9482e0
CH
1727 ret = ublk_alloc_dev_number(ub, header->dev_id);
1728 if (ret < 0)
1729 goto out_free_ub;
71f28f31 1730
34d8f2be 1731 memcpy(&ub->dev_info, &info, sizeof(info));
71f28f31 1732
34d8f2be
CH
1733 /* update device id */
1734 ub->dev_info.dev_id = ub->ub_number;
1735
6d8c5afc
ML
1736 /*
1737 * 64bit flags will be copied back to userspace as feature
1738 * negotiation result, so have to clear flags which driver
1739 * doesn't support yet, then userspace can get correct flags
1740 * (features) to handle.
1741 */
1742 ub->dev_info.flags &= UBLK_F_ALL;
1743
224e858f
ML
1744 if (!IS_BUILTIN(CONFIG_BLK_DEV_UBLK))
1745 ub->dev_info.flags |= UBLK_F_URING_CMD_COMP_IN_TASK;
1746
fa9482e0 1747 /* We are not ready to support zero copy */
6d8c5afc 1748 ub->dev_info.flags &= ~UBLK_F_SUPPORT_ZERO_COPY;
fa9482e0 1749
fa9482e0
CH
1750 ub->dev_info.nr_hw_queues = min_t(unsigned int,
1751 ub->dev_info.nr_hw_queues, nr_cpu_ids);
1752 ublk_align_max_io_size(ub);
1753
1754 ret = ublk_init_queues(ub);
34d8f2be 1755 if (ret)
fa9482e0 1756 goto out_free_dev_number;
34d8f2be 1757
fa9482e0
CH
1758 ret = ublk_add_tag_set(ub);
1759 if (ret)
1760 goto out_deinit_queues;
1761
1762 ret = -EFAULT;
1763 if (copy_to_user(argp, &ub->dev_info, sizeof(info)))
1764 goto out_free_tag_set;
1765
1766 /*
1767 * Add the char dev so that ublksrv daemon can be setup.
1768 * ublk_add_chdev() will cleanup everything if it fails.
1769 */
1770 ret = ublk_add_chdev(ub);
1771 goto out_unlock;
1772
1773out_free_tag_set:
1774 blk_mq_free_tag_set(&ub->tag_set);
1775out_deinit_queues:
1776 ublk_deinit_queues(ub);
1777out_free_dev_number:
1778 ublk_free_dev_number(ub);
1779out_free_ub:
1780 mutex_destroy(&ub->mutex);
1781 kfree(ub);
34d8f2be 1782out_unlock:
71f28f31 1783 mutex_unlock(&ublk_ctl_mutex);
71f28f31
ML
1784 return ret;
1785}
1786
1787static inline bool ublk_idr_freed(int id)
1788{
1789 void *ptr;
1790
1791 spin_lock(&ublk_idr_lock);
1792 ptr = idr_find(&ublk_index_idr, id);
1793 spin_unlock(&ublk_idr_lock);
1794
1795 return ptr == NULL;
1796}
1797
bfbcef03 1798static int ublk_ctrl_del_dev(struct ublk_device **p_ub)
71f28f31 1799{
bfbcef03
ML
1800 struct ublk_device *ub = *p_ub;
1801 int idx = ub->ub_number;
71f28f31
ML
1802 int ret;
1803
1804 ret = mutex_lock_killable(&ublk_ctl_mutex);
1805 if (ret)
1806 return ret;
1807
0abe39de
ML
1808 if (!test_bit(UB_STATE_DELETED, &ub->state)) {
1809 ublk_remove(ub);
1810 set_bit(UB_STATE_DELETED, &ub->state);
1811 }
bfbcef03
ML
1812
1813 /* Mark the reference as consumed */
1814 *p_ub = NULL;
1815 ublk_put_device(ub);
0abe39de 1816 mutex_unlock(&ublk_ctl_mutex);
71f28f31
ML
1817
1818 /*
1819 * Wait until the idr is removed, then it can be reused after
1820 * DEL_DEV command is returned.
0abe39de
ML
1821 *
1822 * If we returns because of user interrupt, future delete command
1823 * may come:
1824 *
1825 * - the device number isn't freed, this device won't or needn't
1826 * be deleted again, since UB_STATE_DELETED is set, and device
1827 * will be released after the last reference is dropped
1828 *
1829 * - the device number is freed already, we will not find this
1830 * device via ublk_get_device_from_id()
71f28f31 1831 */
0abe39de 1832 wait_event_interruptible(ublk_idr_wq, ublk_idr_freed(idx));
71f28f31 1833
0abe39de 1834 return 0;
71f28f31
ML
1835}
1836
71f28f31
ML
1837static inline void ublk_ctrl_cmd_dump(struct io_uring_cmd *cmd)
1838{
1839 struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)cmd->cmd;
1840
1841 pr_devel("%s: cmd_op %x, dev id %d qid %d data %llx buf %llx len %u\n",
1842 __func__, cmd->cmd_op, header->dev_id, header->queue_id,
1843 header->data[0], header->addr, header->len);
1844}
1845
bfbcef03 1846static int ublk_ctrl_stop_dev(struct ublk_device *ub)
71f28f31 1847{
34d8f2be
CH
1848 ublk_stop_dev(ub);
1849 cancel_work_sync(&ub->stop_work);
bbae8d1f 1850 cancel_work_sync(&ub->quiesce_work);
71f28f31
ML
1851
1852 return 0;
1853}
1854
bfbcef03
ML
1855static int ublk_ctrl_get_dev_info(struct ublk_device *ub,
1856 struct io_uring_cmd *cmd)
71f28f31
ML
1857{
1858 struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)cmd->cmd;
1859 void __user *argp = (void __user *)(unsigned long)header->addr;
34d8f2be
CH
1860
1861 if (header->len < sizeof(struct ublksrv_ctrl_dev_info) || !header->addr)
1862 return -EINVAL;
1863
34d8f2be 1864 if (copy_to_user(argp, &ub->dev_info, sizeof(ub->dev_info)))
bfbcef03 1865 return -EFAULT;
34d8f2be 1866
bfbcef03 1867 return 0;
34d8f2be
CH
1868}
1869
abb864d3
ML
1870/* TYPE_DEVT is readonly, so fill it up before returning to userspace */
1871static void ublk_ctrl_fill_params_devt(struct ublk_device *ub)
1872{
1873 ub->params.devt.char_major = MAJOR(ub->cdev_dev.devt);
1874 ub->params.devt.char_minor = MINOR(ub->cdev_dev.devt);
1875
1876 if (ub->ub_disk) {
1877 ub->params.devt.disk_major = MAJOR(disk_devt(ub->ub_disk));
1878 ub->params.devt.disk_minor = MINOR(disk_devt(ub->ub_disk));
1879 } else {
1880 ub->params.devt.disk_major = 0;
1881 ub->params.devt.disk_minor = 0;
1882 }
1883 ub->params.types |= UBLK_PARAM_TYPE_DEVT;
1884}
1885
bfbcef03
ML
1886static int ublk_ctrl_get_params(struct ublk_device *ub,
1887 struct io_uring_cmd *cmd)
0aa73170
ML
1888{
1889 struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)cmd->cmd;
1890 void __user *argp = (void __user *)(unsigned long)header->addr;
1891 struct ublk_params_header ph;
0aa73170
ML
1892 int ret;
1893
1894 if (header->len <= sizeof(ph) || !header->addr)
1895 return -EINVAL;
1896
1897 if (copy_from_user(&ph, argp, sizeof(ph)))
1898 return -EFAULT;
1899
1900 if (ph.len > header->len || !ph.len)
1901 return -EINVAL;
1902
1903 if (ph.len > sizeof(struct ublk_params))
1904 ph.len = sizeof(struct ublk_params);
1905
0aa73170 1906 mutex_lock(&ub->mutex);
abb864d3 1907 ublk_ctrl_fill_params_devt(ub);
0aa73170
ML
1908 if (copy_to_user(argp, &ub->params, ph.len))
1909 ret = -EFAULT;
1910 else
1911 ret = 0;
1912 mutex_unlock(&ub->mutex);
1913
0aa73170
ML
1914 return ret;
1915}
1916
bfbcef03
ML
1917static int ublk_ctrl_set_params(struct ublk_device *ub,
1918 struct io_uring_cmd *cmd)
0aa73170
ML
1919{
1920 struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)cmd->cmd;
1921 void __user *argp = (void __user *)(unsigned long)header->addr;
1922 struct ublk_params_header ph;
0aa73170
ML
1923 int ret = -EFAULT;
1924
1925 if (header->len <= sizeof(ph) || !header->addr)
1926 return -EINVAL;
1927
1928 if (copy_from_user(&ph, argp, sizeof(ph)))
1929 return -EFAULT;
1930
1931 if (ph.len > header->len || !ph.len || !ph.types)
1932 return -EINVAL;
1933
1934 if (ph.len > sizeof(struct ublk_params))
1935 ph.len = sizeof(struct ublk_params);
1936
0aa73170
ML
1937 /* parameters can only be changed when device isn't live */
1938 mutex_lock(&ub->mutex);
1939 if (ub->dev_info.state == UBLK_S_DEV_LIVE) {
1940 ret = -EACCES;
1941 } else if (copy_from_user(&ub->params, argp, ph.len)) {
1942 ret = -EFAULT;
1943 } else {
1944 /* clear all we don't support yet */
1945 ub->params.types &= UBLK_PARAM_TYPE_ALL;
1946 ret = ublk_validate_params(ub);
1947 }
1948 mutex_unlock(&ub->mutex);
0aa73170
ML
1949
1950 return ret;
1951}
1952
c732a852
Z
1953static void ublk_queue_reinit(struct ublk_device *ub, struct ublk_queue *ubq)
1954{
1955 int i;
1956
1957 WARN_ON_ONCE(!(ubq->ubq_daemon && ubq_daemon_is_dying(ubq)));
1958 /* All old ioucmds have to be completed */
1959 WARN_ON_ONCE(ubq->nr_io_ready);
1960 /* old daemon is PF_EXITING, put it now */
1961 put_task_struct(ubq->ubq_daemon);
1962 /* We have to reset it to NULL, otherwise ub won't accept new FETCH_REQ */
1963 ubq->ubq_daemon = NULL;
1964
1965 for (i = 0; i < ubq->q_depth; i++) {
1966 struct ublk_io *io = &ubq->ios[i];
1967
1968 /* forget everything now and be ready for new FETCH_REQ */
1969 io->flags = 0;
1970 io->cmd = NULL;
1971 io->addr = 0;
1972 }
1973}
1974
bfbcef03
ML
1975static int ublk_ctrl_start_recovery(struct ublk_device *ub,
1976 struct io_uring_cmd *cmd)
c732a852
Z
1977{
1978 struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)cmd->cmd;
c732a852
Z
1979 int ret = -EINVAL;
1980 int i;
1981
c732a852
Z
1982 mutex_lock(&ub->mutex);
1983 if (!ublk_can_use_recovery(ub))
1984 goto out_unlock;
1985 /*
1986 * START_RECOVERY is only allowd after:
1987 *
1988 * (1) UB_STATE_OPEN is not set, which means the dying process is exited
1989 * and related io_uring ctx is freed so file struct of /dev/ublkcX is
1990 * released.
1991 *
1992 * (2) UBLK_S_DEV_QUIESCED is set, which means the quiesce_work:
1993 * (a)has quiesced request queue
1994 * (b)has requeued every inflight rqs whose io_flags is ACTIVE
1995 * (c)has requeued/aborted every inflight rqs whose io_flags is NOT ACTIVE
1996 * (d)has completed/camceled all ioucmds owned by ther dying process
1997 */
1998 if (test_bit(UB_STATE_OPEN, &ub->state) ||
1999 ub->dev_info.state != UBLK_S_DEV_QUIESCED) {
2000 ret = -EBUSY;
2001 goto out_unlock;
2002 }
2003 pr_devel("%s: start recovery for dev id %d.\n", __func__, header->dev_id);
2004 for (i = 0; i < ub->dev_info.nr_hw_queues; i++)
2005 ublk_queue_reinit(ub, ublk_get_queue(ub, i));
2006 /* set to NULL, otherwise new ubq_daemon cannot mmap the io_cmd_buf */
2007 ub->mm = NULL;
2008 ub->nr_queues_ready = 0;
73a166d9 2009 ub->nr_privileged_daemon = 0;
c732a852
Z
2010 init_completion(&ub->completion);
2011 ret = 0;
2012 out_unlock:
2013 mutex_unlock(&ub->mutex);
c732a852
Z
2014 return ret;
2015}
2016
bfbcef03
ML
2017static int ublk_ctrl_end_recovery(struct ublk_device *ub,
2018 struct io_uring_cmd *cmd)
c732a852
Z
2019{
2020 struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)cmd->cmd;
2021 int ublksrv_pid = (int)header->data[0];
c732a852
Z
2022 int ret = -EINVAL;
2023
c732a852
Z
2024 pr_devel("%s: Waiting for new ubq_daemons(nr: %d) are ready, dev id %d...\n",
2025 __func__, ub->dev_info.nr_hw_queues, header->dev_id);
2026 /* wait until new ubq_daemon sending all FETCH_REQ */
2027 wait_for_completion_interruptible(&ub->completion);
2028 pr_devel("%s: All new ubq_daemons(nr: %d) are ready, dev id %d\n",
2029 __func__, ub->dev_info.nr_hw_queues, header->dev_id);
2030
2031 mutex_lock(&ub->mutex);
2032 if (!ublk_can_use_recovery(ub))
2033 goto out_unlock;
2034
2035 if (ub->dev_info.state != UBLK_S_DEV_QUIESCED) {
2036 ret = -EBUSY;
2037 goto out_unlock;
2038 }
2039 ub->dev_info.ublksrv_pid = ublksrv_pid;
2040 pr_devel("%s: new ublksrv_pid %d, dev id %d\n",
2041 __func__, ublksrv_pid, header->dev_id);
2042 blk_mq_unquiesce_queue(ub->ub_disk->queue);
2043 pr_devel("%s: queue unquiesced, dev id %d.\n",
2044 __func__, header->dev_id);
2045 blk_mq_kick_requeue_list(ub->ub_disk->queue);
2046 ub->dev_info.state = UBLK_S_DEV_LIVE;
2047 schedule_delayed_work(&ub->monitor_work, UBLK_DAEMON_MONITOR_PERIOD);
2048 ret = 0;
2049 out_unlock:
2050 mutex_unlock(&ub->mutex);
c732a852
Z
2051 return ret;
2052}
2053
4093cb5a
ML
2054/*
2055 * All control commands are sent via /dev/ublk-control, so we have to check
2056 * the destination device's permission
2057 */
2058static int ublk_char_dev_permission(struct ublk_device *ub,
2059 const char *dev_path, int mask)
2060{
2061 int err;
2062 struct path path;
2063 struct kstat stat;
2064
2065 err = kern_path(dev_path, LOOKUP_FOLLOW, &path);
2066 if (err)
2067 return err;
2068
2069 err = vfs_getattr(&path, &stat, STATX_TYPE, AT_STATX_SYNC_AS_STAT);
2070 if (err)
2071 goto exit;
2072
2073 err = -EPERM;
2074 if (stat.rdev != ub->cdev_dev.devt || !S_ISCHR(stat.mode))
2075 goto exit;
2076
2077 err = inode_permission(&init_user_ns,
2078 d_backing_inode(path.dentry), mask);
2079exit:
2080 path_put(&path);
2081 return err;
2082}
2083
2084static int ublk_ctrl_uring_cmd_permission(struct ublk_device *ub,
2085 struct io_uring_cmd *cmd)
2086{
2087 struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)cmd->cmd;
2088 bool unprivileged = ub->dev_info.flags & UBLK_F_UNPRIVILEGED_DEV;
2089 void __user *argp = (void __user *)(unsigned long)header->addr;
2090 char *dev_path = NULL;
2091 int ret = 0;
2092 int mask;
2093
2094 if (!unprivileged) {
2095 if (!capable(CAP_SYS_ADMIN))
2096 return -EPERM;
2097 /*
2098 * The new added command of UBLK_CMD_GET_DEV_INFO2 includes
2099 * char_dev_path in payload too, since userspace may not
2100 * know if the specified device is created as unprivileged
2101 * mode.
2102 */
2103 if (cmd->cmd_op != UBLK_CMD_GET_DEV_INFO2)
2104 return 0;
2105 }
2106
2107 /*
2108 * User has to provide the char device path for unprivileged ublk
2109 *
2110 * header->addr always points to the dev path buffer, and
2111 * header->dev_path_len records length of dev path buffer.
2112 */
2113 if (!header->dev_path_len || header->dev_path_len > PATH_MAX)
2114 return -EINVAL;
2115
2116 if (header->len < header->dev_path_len)
2117 return -EINVAL;
2118
2119 dev_path = kmalloc(header->dev_path_len + 1, GFP_KERNEL);
2120 if (!dev_path)
2121 return -ENOMEM;
2122
2123 ret = -EFAULT;
2124 if (copy_from_user(dev_path, argp, header->dev_path_len))
2125 goto exit;
2126 dev_path[header->dev_path_len] = 0;
2127
2128 ret = -EINVAL;
2129 switch (cmd->cmd_op) {
2130 case UBLK_CMD_GET_DEV_INFO:
2131 case UBLK_CMD_GET_DEV_INFO2:
2132 case UBLK_CMD_GET_QUEUE_AFFINITY:
2133 case UBLK_CMD_GET_PARAMS:
2134 mask = MAY_READ;
2135 break;
2136 case UBLK_CMD_START_DEV:
2137 case UBLK_CMD_STOP_DEV:
2138 case UBLK_CMD_ADD_DEV:
2139 case UBLK_CMD_DEL_DEV:
2140 case UBLK_CMD_SET_PARAMS:
2141 case UBLK_CMD_START_USER_RECOVERY:
2142 case UBLK_CMD_END_USER_RECOVERY:
2143 mask = MAY_READ | MAY_WRITE;
2144 break;
2145 default:
2146 goto exit;
2147 }
2148
2149 ret = ublk_char_dev_permission(ub, dev_path, mask);
2150 if (!ret) {
2151 header->len -= header->dev_path_len;
2152 header->addr += header->dev_path_len;
2153 }
2154 pr_devel("%s: dev id %d cmd_op %x uid %d gid %d path %s ret %d\n",
2155 __func__, ub->ub_number, cmd->cmd_op,
2156 ub->dev_info.owner_uid, ub->dev_info.owner_gid,
2157 dev_path, ret);
2158exit:
2159 kfree(dev_path);
2160 return ret;
2161}
2162
34d8f2be
CH
2163static int ublk_ctrl_uring_cmd(struct io_uring_cmd *cmd,
2164 unsigned int issue_flags)
2165{
2166 struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)cmd->cmd;
bfbcef03 2167 struct ublk_device *ub = NULL;
71f28f31
ML
2168 int ret = -EINVAL;
2169
fa8e442e
ML
2170 if (issue_flags & IO_URING_F_NONBLOCK)
2171 return -EAGAIN;
2172
71f28f31
ML
2173 ublk_ctrl_cmd_dump(cmd);
2174
2175 if (!(issue_flags & IO_URING_F_SQE128))
2176 goto out;
2177
bfbcef03
ML
2178 if (cmd->cmd_op != UBLK_CMD_ADD_DEV) {
2179 ret = -ENODEV;
2180 ub = ublk_get_device_from_id(header->dev_id);
2181 if (!ub)
2182 goto out;
4093cb5a
ML
2183
2184 ret = ublk_ctrl_uring_cmd_permission(ub, cmd);
2185 } else {
2186 /* ADD_DEV permission check is done in command handler */
2187 ret = 0;
bfbcef03
ML
2188 }
2189
4093cb5a
ML
2190 if (ret)
2191 goto put_dev;
2192
34d8f2be 2193 switch (cmd->cmd_op) {
71f28f31 2194 case UBLK_CMD_START_DEV:
bfbcef03 2195 ret = ublk_ctrl_start_dev(ub, cmd);
71f28f31
ML
2196 break;
2197 case UBLK_CMD_STOP_DEV:
bfbcef03 2198 ret = ublk_ctrl_stop_dev(ub);
71f28f31
ML
2199 break;
2200 case UBLK_CMD_GET_DEV_INFO:
4093cb5a 2201 case UBLK_CMD_GET_DEV_INFO2:
bfbcef03 2202 ret = ublk_ctrl_get_dev_info(ub, cmd);
71f28f31
ML
2203 break;
2204 case UBLK_CMD_ADD_DEV:
34d8f2be 2205 ret = ublk_ctrl_add_dev(cmd);
71f28f31
ML
2206 break;
2207 case UBLK_CMD_DEL_DEV:
bfbcef03 2208 ret = ublk_ctrl_del_dev(&ub);
71f28f31
ML
2209 break;
2210 case UBLK_CMD_GET_QUEUE_AFFINITY:
bfbcef03 2211 ret = ublk_ctrl_get_queue_affinity(ub, cmd);
71f28f31 2212 break;
0aa73170 2213 case UBLK_CMD_GET_PARAMS:
bfbcef03 2214 ret = ublk_ctrl_get_params(ub, cmd);
0aa73170
ML
2215 break;
2216 case UBLK_CMD_SET_PARAMS:
bfbcef03 2217 ret = ublk_ctrl_set_params(ub, cmd);
0aa73170 2218 break;
c732a852 2219 case UBLK_CMD_START_USER_RECOVERY:
bfbcef03 2220 ret = ublk_ctrl_start_recovery(ub, cmd);
c732a852
Z
2221 break;
2222 case UBLK_CMD_END_USER_RECOVERY:
bfbcef03 2223 ret = ublk_ctrl_end_recovery(ub, cmd);
c732a852 2224 break;
71f28f31 2225 default:
bfbcef03 2226 ret = -ENOTSUPP;
71f28f31 2227 break;
6b1439d2 2228 }
4093cb5a
ML
2229
2230 put_dev:
bfbcef03
ML
2231 if (ub)
2232 ublk_put_device(ub);
71f28f31
ML
2233 out:
2234 io_uring_cmd_done(cmd, ret, 0);
2235 pr_devel("%s: cmd done ret %d cmd_op %x, dev id %d qid %d\n",
2236 __func__, ret, cmd->cmd_op, header->dev_id, header->queue_id);
2237 return -EIOCBQUEUED;
2238}
2239
2240static const struct file_operations ublk_ctl_fops = {
2241 .open = nonseekable_open,
2242 .uring_cmd = ublk_ctrl_uring_cmd,
2243 .owner = THIS_MODULE,
2244 .llseek = noop_llseek,
2245};
2246
2247static struct miscdevice ublk_misc = {
2248 .minor = MISC_DYNAMIC_MINOR,
2249 .name = "ublk-control",
2250 .fops = &ublk_ctl_fops,
2251};
2252
2253static int __init ublk_init(void)
2254{
2255 int ret;
2256
2257 init_waitqueue_head(&ublk_idr_wq);
2258
2259 ret = misc_register(&ublk_misc);
2260 if (ret)
2261 return ret;
2262
2263 ret = alloc_chrdev_region(&ublk_chr_devt, 0, UBLK_MINORS, "ublk-char");
2264 if (ret)
2265 goto unregister_mis;
2266
2267 ublk_chr_class = class_create(THIS_MODULE, "ublk-char");
2268 if (IS_ERR(ublk_chr_class)) {
2269 ret = PTR_ERR(ublk_chr_class);
2270 goto free_chrdev_region;
2271 }
2272 return 0;
2273
2274free_chrdev_region:
2275 unregister_chrdev_region(ublk_chr_devt, UBLK_MINORS);
2276unregister_mis:
2277 misc_deregister(&ublk_misc);
2278 return ret;
2279}
2280
2281static void __exit ublk_exit(void)
2282{
2283 struct ublk_device *ub;
2284 int id;
2285
71f28f31
ML
2286 idr_for_each_entry(&ublk_index_idr, ub, id)
2287 ublk_remove(ub);
2288
8e4ff684
ML
2289 class_destroy(ublk_chr_class);
2290 misc_deregister(&ublk_misc);
2291
71f28f31
ML
2292 idr_destroy(&ublk_index_idr);
2293 unregister_chrdev_region(ublk_chr_devt, UBLK_MINORS);
2294}
2295
2296module_init(ublk_init);
2297module_exit(ublk_exit);
2298
403ebc87
ML
2299module_param(ublks_max, int, 0444);
2300MODULE_PARM_DESC(ublks_max, "max number of ublk devices allowed to add(default: 64)");
2301
71f28f31
ML
2302MODULE_AUTHOR("Ming Lei <ming.lei@redhat.com>");
2303MODULE_LICENSE("GPL");