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