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