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