xref: /kernel/linux/linux-5.10/block/blk-sysfs.c (revision 8c2ecf20)
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Functions related to sysfs handling
4 */
5#include <linux/kernel.h>
6#include <linux/slab.h>
7#include <linux/module.h>
8#include <linux/bio.h>
9#include <linux/blkdev.h>
10#include <linux/backing-dev.h>
11#include <linux/blktrace_api.h>
12#include <linux/blk-mq.h>
13#include <linux/blk-cgroup.h>
14#include <linux/debugfs.h>
15
16#include "blk.h"
17#include "blk-mq.h"
18#include "blk-mq-debugfs.h"
19#include "blk-wbt.h"
20
21struct queue_sysfs_entry {
22	struct attribute attr;
23	ssize_t (*show)(struct request_queue *, char *);
24	ssize_t (*store)(struct request_queue *, const char *, size_t);
25};
26
27static ssize_t
28queue_var_show(unsigned long var, char *page)
29{
30	return sprintf(page, "%lu\n", var);
31}
32
33static ssize_t
34queue_var_store(unsigned long *var, const char *page, size_t count)
35{
36	int err;
37	unsigned long v;
38
39	err = kstrtoul(page, 10, &v);
40	if (err || v > UINT_MAX)
41		return -EINVAL;
42
43	*var = v;
44
45	return count;
46}
47
48static ssize_t queue_var_store64(s64 *var, const char *page)
49{
50	int err;
51	s64 v;
52
53	err = kstrtos64(page, 10, &v);
54	if (err < 0)
55		return err;
56
57	*var = v;
58	return 0;
59}
60
61static ssize_t queue_requests_show(struct request_queue *q, char *page)
62{
63	return queue_var_show(q->nr_requests, (page));
64}
65
66static ssize_t
67queue_requests_store(struct request_queue *q, const char *page, size_t count)
68{
69	unsigned long nr;
70	int ret, err;
71
72	if (!queue_is_mq(q))
73		return -EINVAL;
74
75	ret = queue_var_store(&nr, page, count);
76	if (ret < 0)
77		return ret;
78
79	if (nr < BLKDEV_MIN_RQ)
80		nr = BLKDEV_MIN_RQ;
81
82	err = blk_mq_update_nr_requests(q, nr);
83	if (err)
84		return err;
85
86	return ret;
87}
88
89static ssize_t queue_ra_show(struct request_queue *q, char *page)
90{
91	unsigned long ra_kb = q->backing_dev_info->ra_pages <<
92					(PAGE_SHIFT - 10);
93
94	return queue_var_show(ra_kb, (page));
95}
96
97static ssize_t
98queue_ra_store(struct request_queue *q, const char *page, size_t count)
99{
100	unsigned long ra_kb;
101	ssize_t ret = queue_var_store(&ra_kb, page, count);
102
103	if (ret < 0)
104		return ret;
105
106	q->backing_dev_info->ra_pages = ra_kb >> (PAGE_SHIFT - 10);
107
108	return ret;
109}
110
111static ssize_t queue_max_sectors_show(struct request_queue *q, char *page)
112{
113	int max_sectors_kb = queue_max_sectors(q) >> 1;
114
115	return queue_var_show(max_sectors_kb, (page));
116}
117
118static ssize_t queue_max_segments_show(struct request_queue *q, char *page)
119{
120	return queue_var_show(queue_max_segments(q), (page));
121}
122
123static ssize_t queue_max_discard_segments_show(struct request_queue *q,
124		char *page)
125{
126	return queue_var_show(queue_max_discard_segments(q), (page));
127}
128
129static ssize_t queue_max_integrity_segments_show(struct request_queue *q, char *page)
130{
131	return queue_var_show(q->limits.max_integrity_segments, (page));
132}
133
134static ssize_t queue_max_segment_size_show(struct request_queue *q, char *page)
135{
136	return queue_var_show(queue_max_segment_size(q), (page));
137}
138
139static ssize_t queue_logical_block_size_show(struct request_queue *q, char *page)
140{
141	return queue_var_show(queue_logical_block_size(q), page);
142}
143
144static ssize_t queue_physical_block_size_show(struct request_queue *q, char *page)
145{
146	return queue_var_show(queue_physical_block_size(q), page);
147}
148
149static ssize_t queue_chunk_sectors_show(struct request_queue *q, char *page)
150{
151	return queue_var_show(q->limits.chunk_sectors, page);
152}
153
154static ssize_t queue_io_min_show(struct request_queue *q, char *page)
155{
156	return queue_var_show(queue_io_min(q), page);
157}
158
159static ssize_t queue_io_opt_show(struct request_queue *q, char *page)
160{
161	return queue_var_show(queue_io_opt(q), page);
162}
163
164static ssize_t queue_discard_granularity_show(struct request_queue *q, char *page)
165{
166	return queue_var_show(q->limits.discard_granularity, page);
167}
168
169static ssize_t queue_discard_max_hw_show(struct request_queue *q, char *page)
170{
171
172	return sprintf(page, "%llu\n",
173		(unsigned long long)q->limits.max_hw_discard_sectors << 9);
174}
175
176static ssize_t queue_discard_max_show(struct request_queue *q, char *page)
177{
178	return sprintf(page, "%llu\n",
179		       (unsigned long long)q->limits.max_discard_sectors << 9);
180}
181
182static ssize_t queue_discard_max_store(struct request_queue *q,
183				       const char *page, size_t count)
184{
185	unsigned long max_discard;
186	ssize_t ret = queue_var_store(&max_discard, page, count);
187
188	if (ret < 0)
189		return ret;
190
191	if (max_discard & (q->limits.discard_granularity - 1))
192		return -EINVAL;
193
194	max_discard >>= 9;
195	if (max_discard > UINT_MAX)
196		return -EINVAL;
197
198	if (max_discard > q->limits.max_hw_discard_sectors)
199		max_discard = q->limits.max_hw_discard_sectors;
200
201	q->limits.max_discard_sectors = max_discard;
202	return ret;
203}
204
205static ssize_t queue_discard_zeroes_data_show(struct request_queue *q, char *page)
206{
207	return queue_var_show(0, page);
208}
209
210static ssize_t queue_write_same_max_show(struct request_queue *q, char *page)
211{
212	return sprintf(page, "%llu\n",
213		(unsigned long long)q->limits.max_write_same_sectors << 9);
214}
215
216static ssize_t queue_write_zeroes_max_show(struct request_queue *q, char *page)
217{
218	return sprintf(page, "%llu\n",
219		(unsigned long long)q->limits.max_write_zeroes_sectors << 9);
220}
221
222static ssize_t queue_zone_append_max_show(struct request_queue *q, char *page)
223{
224	unsigned long long max_sectors = q->limits.max_zone_append_sectors;
225
226	return sprintf(page, "%llu\n", max_sectors << SECTOR_SHIFT);
227}
228
229static ssize_t
230queue_max_sectors_store(struct request_queue *q, const char *page, size_t count)
231{
232	unsigned long max_sectors_kb,
233		max_hw_sectors_kb = queue_max_hw_sectors(q) >> 1,
234			page_kb = 1 << (PAGE_SHIFT - 10);
235	ssize_t ret = queue_var_store(&max_sectors_kb, page, count);
236
237	if (ret < 0)
238		return ret;
239
240	max_hw_sectors_kb = min_not_zero(max_hw_sectors_kb, (unsigned long)
241					 q->limits.max_dev_sectors >> 1);
242
243	if (max_sectors_kb > max_hw_sectors_kb || max_sectors_kb < page_kb)
244		return -EINVAL;
245
246	spin_lock_irq(&q->queue_lock);
247	q->limits.max_sectors = max_sectors_kb << 1;
248	q->backing_dev_info->io_pages = max_sectors_kb >> (PAGE_SHIFT - 10);
249	spin_unlock_irq(&q->queue_lock);
250
251	return ret;
252}
253
254static ssize_t queue_max_hw_sectors_show(struct request_queue *q, char *page)
255{
256	int max_hw_sectors_kb = queue_max_hw_sectors(q) >> 1;
257
258	return queue_var_show(max_hw_sectors_kb, (page));
259}
260
261#define QUEUE_SYSFS_BIT_FNS(name, flag, neg)				\
262static ssize_t								\
263queue_##name##_show(struct request_queue *q, char *page)		\
264{									\
265	int bit;							\
266	bit = test_bit(QUEUE_FLAG_##flag, &q->queue_flags);		\
267	return queue_var_show(neg ? !bit : bit, page);			\
268}									\
269static ssize_t								\
270queue_##name##_store(struct request_queue *q, const char *page, size_t count) \
271{									\
272	unsigned long val;						\
273	ssize_t ret;							\
274	ret = queue_var_store(&val, page, count);			\
275	if (ret < 0)							\
276		 return ret;						\
277	if (neg)							\
278		val = !val;						\
279									\
280	if (val)							\
281		blk_queue_flag_set(QUEUE_FLAG_##flag, q);		\
282	else								\
283		blk_queue_flag_clear(QUEUE_FLAG_##flag, q);		\
284	return ret;							\
285}
286
287QUEUE_SYSFS_BIT_FNS(nonrot, NONROT, 1);
288QUEUE_SYSFS_BIT_FNS(random, ADD_RANDOM, 0);
289QUEUE_SYSFS_BIT_FNS(iostats, IO_STAT, 0);
290QUEUE_SYSFS_BIT_FNS(stable_writes, STABLE_WRITES, 0);
291#undef QUEUE_SYSFS_BIT_FNS
292
293static ssize_t queue_zoned_show(struct request_queue *q, char *page)
294{
295	switch (blk_queue_zoned_model(q)) {
296	case BLK_ZONED_HA:
297		return sprintf(page, "host-aware\n");
298	case BLK_ZONED_HM:
299		return sprintf(page, "host-managed\n");
300	default:
301		return sprintf(page, "none\n");
302	}
303}
304
305static ssize_t queue_nr_zones_show(struct request_queue *q, char *page)
306{
307	return queue_var_show(blk_queue_nr_zones(q), page);
308}
309
310static ssize_t queue_max_open_zones_show(struct request_queue *q, char *page)
311{
312	return queue_var_show(queue_max_open_zones(q), page);
313}
314
315static ssize_t queue_max_active_zones_show(struct request_queue *q, char *page)
316{
317	return queue_var_show(queue_max_active_zones(q), page);
318}
319
320static ssize_t queue_nomerges_show(struct request_queue *q, char *page)
321{
322	return queue_var_show((blk_queue_nomerges(q) << 1) |
323			       blk_queue_noxmerges(q), page);
324}
325
326static ssize_t queue_nomerges_store(struct request_queue *q, const char *page,
327				    size_t count)
328{
329	unsigned long nm;
330	ssize_t ret = queue_var_store(&nm, page, count);
331
332	if (ret < 0)
333		return ret;
334
335	blk_queue_flag_clear(QUEUE_FLAG_NOMERGES, q);
336	blk_queue_flag_clear(QUEUE_FLAG_NOXMERGES, q);
337	if (nm == 2)
338		blk_queue_flag_set(QUEUE_FLAG_NOMERGES, q);
339	else if (nm)
340		blk_queue_flag_set(QUEUE_FLAG_NOXMERGES, q);
341
342	return ret;
343}
344
345static ssize_t queue_rq_affinity_show(struct request_queue *q, char *page)
346{
347	bool set = test_bit(QUEUE_FLAG_SAME_COMP, &q->queue_flags);
348	bool force = test_bit(QUEUE_FLAG_SAME_FORCE, &q->queue_flags);
349
350	return queue_var_show(set << force, page);
351}
352
353static ssize_t
354queue_rq_affinity_store(struct request_queue *q, const char *page, size_t count)
355{
356	ssize_t ret = -EINVAL;
357#ifdef CONFIG_SMP
358	unsigned long val;
359
360	ret = queue_var_store(&val, page, count);
361	if (ret < 0)
362		return ret;
363
364	if (val == 2) {
365		blk_queue_flag_set(QUEUE_FLAG_SAME_COMP, q);
366		blk_queue_flag_set(QUEUE_FLAG_SAME_FORCE, q);
367	} else if (val == 1) {
368		blk_queue_flag_set(QUEUE_FLAG_SAME_COMP, q);
369		blk_queue_flag_clear(QUEUE_FLAG_SAME_FORCE, q);
370	} else if (val == 0) {
371		blk_queue_flag_clear(QUEUE_FLAG_SAME_COMP, q);
372		blk_queue_flag_clear(QUEUE_FLAG_SAME_FORCE, q);
373	}
374#endif
375	return ret;
376}
377
378static ssize_t queue_poll_delay_show(struct request_queue *q, char *page)
379{
380	int val;
381
382	if (q->poll_nsec == BLK_MQ_POLL_CLASSIC)
383		val = BLK_MQ_POLL_CLASSIC;
384	else
385		val = q->poll_nsec / 1000;
386
387	return sprintf(page, "%d\n", val);
388}
389
390static ssize_t queue_poll_delay_store(struct request_queue *q, const char *page,
391				size_t count)
392{
393	int err, val;
394
395	if (!q->mq_ops || !q->mq_ops->poll)
396		return -EINVAL;
397
398	err = kstrtoint(page, 10, &val);
399	if (err < 0)
400		return err;
401
402	if (val == BLK_MQ_POLL_CLASSIC)
403		q->poll_nsec = BLK_MQ_POLL_CLASSIC;
404	else if (val >= 0)
405		q->poll_nsec = val * 1000;
406	else
407		return -EINVAL;
408
409	return count;
410}
411
412static ssize_t queue_poll_show(struct request_queue *q, char *page)
413{
414	return queue_var_show(test_bit(QUEUE_FLAG_POLL, &q->queue_flags), page);
415}
416
417static ssize_t queue_poll_store(struct request_queue *q, const char *page,
418				size_t count)
419{
420	unsigned long poll_on;
421	ssize_t ret;
422
423	if (!q->tag_set || q->tag_set->nr_maps <= HCTX_TYPE_POLL ||
424	    !q->tag_set->map[HCTX_TYPE_POLL].nr_queues)
425		return -EINVAL;
426
427	ret = queue_var_store(&poll_on, page, count);
428	if (ret < 0)
429		return ret;
430
431	if (poll_on)
432		blk_queue_flag_set(QUEUE_FLAG_POLL, q);
433	else
434		blk_queue_flag_clear(QUEUE_FLAG_POLL, q);
435
436	return ret;
437}
438
439static ssize_t queue_io_timeout_show(struct request_queue *q, char *page)
440{
441	return sprintf(page, "%u\n", jiffies_to_msecs(q->rq_timeout));
442}
443
444static ssize_t queue_io_timeout_store(struct request_queue *q, const char *page,
445				  size_t count)
446{
447	unsigned int val;
448	int err;
449
450	err = kstrtou32(page, 10, &val);
451	if (err || val == 0)
452		return -EINVAL;
453
454	blk_queue_rq_timeout(q, msecs_to_jiffies(val));
455
456	return count;
457}
458
459static ssize_t queue_wb_lat_show(struct request_queue *q, char *page)
460{
461	if (!wbt_rq_qos(q))
462		return -EINVAL;
463
464	return sprintf(page, "%llu\n", div_u64(wbt_get_min_lat(q), 1000));
465}
466
467static ssize_t queue_wb_lat_store(struct request_queue *q, const char *page,
468				  size_t count)
469{
470	struct rq_qos *rqos;
471	ssize_t ret;
472	s64 val;
473
474	ret = queue_var_store64(&val, page);
475	if (ret < 0)
476		return ret;
477	if (val < -1)
478		return -EINVAL;
479
480	rqos = wbt_rq_qos(q);
481	if (!rqos) {
482		ret = wbt_init(q);
483		if (ret)
484			return ret;
485	}
486
487	if (val == -1)
488		val = wbt_default_latency_nsec(q);
489	else if (val >= 0)
490		val *= 1000ULL;
491
492	if (wbt_get_min_lat(q) == val)
493		return count;
494
495	/*
496	 * Ensure that the queue is idled, in case the latency update
497	 * ends up either enabling or disabling wbt completely. We can't
498	 * have IO inflight if that happens.
499	 */
500	blk_mq_freeze_queue(q);
501	blk_mq_quiesce_queue(q);
502
503	wbt_set_min_lat(q, val);
504
505	blk_mq_unquiesce_queue(q);
506	blk_mq_unfreeze_queue(q);
507
508	return count;
509}
510
511static ssize_t queue_wc_show(struct request_queue *q, char *page)
512{
513	if (test_bit(QUEUE_FLAG_WC, &q->queue_flags))
514		return sprintf(page, "write back\n");
515
516	return sprintf(page, "write through\n");
517}
518
519static ssize_t queue_wc_store(struct request_queue *q, const char *page,
520			      size_t count)
521{
522	int set = -1;
523
524	if (!strncmp(page, "write back", 10))
525		set = 1;
526	else if (!strncmp(page, "write through", 13) ||
527		 !strncmp(page, "none", 4))
528		set = 0;
529
530	if (set == -1)
531		return -EINVAL;
532
533	if (set)
534		blk_queue_flag_set(QUEUE_FLAG_WC, q);
535	else
536		blk_queue_flag_clear(QUEUE_FLAG_WC, q);
537
538	return count;
539}
540
541static ssize_t queue_fua_show(struct request_queue *q, char *page)
542{
543	return sprintf(page, "%u\n", test_bit(QUEUE_FLAG_FUA, &q->queue_flags));
544}
545
546static ssize_t queue_dax_show(struct request_queue *q, char *page)
547{
548	return queue_var_show(blk_queue_dax(q), page);
549}
550
551#define QUEUE_RO_ENTRY(_prefix, _name)			\
552static struct queue_sysfs_entry _prefix##_entry = {	\
553	.attr	= { .name = _name, .mode = 0444 },	\
554	.show	= _prefix##_show,			\
555};
556
557#define QUEUE_RW_ENTRY(_prefix, _name)			\
558static struct queue_sysfs_entry _prefix##_entry = {	\
559	.attr	= { .name = _name, .mode = 0644 },	\
560	.show	= _prefix##_show,			\
561	.store	= _prefix##_store,			\
562};
563
564QUEUE_RW_ENTRY(queue_requests, "nr_requests");
565QUEUE_RW_ENTRY(queue_ra, "read_ahead_kb");
566QUEUE_RW_ENTRY(queue_max_sectors, "max_sectors_kb");
567QUEUE_RO_ENTRY(queue_max_hw_sectors, "max_hw_sectors_kb");
568QUEUE_RO_ENTRY(queue_max_segments, "max_segments");
569QUEUE_RO_ENTRY(queue_max_integrity_segments, "max_integrity_segments");
570QUEUE_RO_ENTRY(queue_max_segment_size, "max_segment_size");
571QUEUE_RW_ENTRY(elv_iosched, "scheduler");
572
573QUEUE_RO_ENTRY(queue_logical_block_size, "logical_block_size");
574QUEUE_RO_ENTRY(queue_physical_block_size, "physical_block_size");
575QUEUE_RO_ENTRY(queue_chunk_sectors, "chunk_sectors");
576QUEUE_RO_ENTRY(queue_io_min, "minimum_io_size");
577QUEUE_RO_ENTRY(queue_io_opt, "optimal_io_size");
578
579QUEUE_RO_ENTRY(queue_max_discard_segments, "max_discard_segments");
580QUEUE_RO_ENTRY(queue_discard_granularity, "discard_granularity");
581QUEUE_RO_ENTRY(queue_discard_max_hw, "discard_max_hw_bytes");
582QUEUE_RW_ENTRY(queue_discard_max, "discard_max_bytes");
583QUEUE_RO_ENTRY(queue_discard_zeroes_data, "discard_zeroes_data");
584
585QUEUE_RO_ENTRY(queue_write_same_max, "write_same_max_bytes");
586QUEUE_RO_ENTRY(queue_write_zeroes_max, "write_zeroes_max_bytes");
587QUEUE_RO_ENTRY(queue_zone_append_max, "zone_append_max_bytes");
588
589QUEUE_RO_ENTRY(queue_zoned, "zoned");
590QUEUE_RO_ENTRY(queue_nr_zones, "nr_zones");
591QUEUE_RO_ENTRY(queue_max_open_zones, "max_open_zones");
592QUEUE_RO_ENTRY(queue_max_active_zones, "max_active_zones");
593
594QUEUE_RW_ENTRY(queue_nomerges, "nomerges");
595QUEUE_RW_ENTRY(queue_rq_affinity, "rq_affinity");
596QUEUE_RW_ENTRY(queue_poll, "io_poll");
597QUEUE_RW_ENTRY(queue_poll_delay, "io_poll_delay");
598QUEUE_RW_ENTRY(queue_wc, "write_cache");
599QUEUE_RO_ENTRY(queue_fua, "fua");
600QUEUE_RO_ENTRY(queue_dax, "dax");
601QUEUE_RW_ENTRY(queue_io_timeout, "io_timeout");
602QUEUE_RW_ENTRY(queue_wb_lat, "wbt_lat_usec");
603
604#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
605QUEUE_RW_ENTRY(blk_throtl_sample_time, "throttle_sample_time");
606#endif
607
608/* legacy alias for logical_block_size: */
609static struct queue_sysfs_entry queue_hw_sector_size_entry = {
610	.attr = {.name = "hw_sector_size", .mode = 0444 },
611	.show = queue_logical_block_size_show,
612};
613
614QUEUE_RW_ENTRY(queue_nonrot, "rotational");
615QUEUE_RW_ENTRY(queue_iostats, "iostats");
616QUEUE_RW_ENTRY(queue_random, "add_random");
617QUEUE_RW_ENTRY(queue_stable_writes, "stable_writes");
618
619static struct attribute *queue_attrs[] = {
620	&queue_requests_entry.attr,
621	&queue_ra_entry.attr,
622	&queue_max_hw_sectors_entry.attr,
623	&queue_max_sectors_entry.attr,
624	&queue_max_segments_entry.attr,
625	&queue_max_discard_segments_entry.attr,
626	&queue_max_integrity_segments_entry.attr,
627	&queue_max_segment_size_entry.attr,
628	&elv_iosched_entry.attr,
629	&queue_hw_sector_size_entry.attr,
630	&queue_logical_block_size_entry.attr,
631	&queue_physical_block_size_entry.attr,
632	&queue_chunk_sectors_entry.attr,
633	&queue_io_min_entry.attr,
634	&queue_io_opt_entry.attr,
635	&queue_discard_granularity_entry.attr,
636	&queue_discard_max_entry.attr,
637	&queue_discard_max_hw_entry.attr,
638	&queue_discard_zeroes_data_entry.attr,
639	&queue_write_same_max_entry.attr,
640	&queue_write_zeroes_max_entry.attr,
641	&queue_zone_append_max_entry.attr,
642	&queue_nonrot_entry.attr,
643	&queue_zoned_entry.attr,
644	&queue_nr_zones_entry.attr,
645	&queue_max_open_zones_entry.attr,
646	&queue_max_active_zones_entry.attr,
647	&queue_nomerges_entry.attr,
648	&queue_rq_affinity_entry.attr,
649	&queue_iostats_entry.attr,
650	&queue_stable_writes_entry.attr,
651	&queue_random_entry.attr,
652	&queue_poll_entry.attr,
653	&queue_wc_entry.attr,
654	&queue_fua_entry.attr,
655	&queue_dax_entry.attr,
656	&queue_wb_lat_entry.attr,
657	&queue_poll_delay_entry.attr,
658	&queue_io_timeout_entry.attr,
659#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
660	&blk_throtl_sample_time_entry.attr,
661#endif
662	NULL,
663};
664
665static umode_t queue_attr_visible(struct kobject *kobj, struct attribute *attr,
666				int n)
667{
668	struct request_queue *q =
669		container_of(kobj, struct request_queue, kobj);
670
671	if (attr == &queue_io_timeout_entry.attr &&
672		(!q->mq_ops || !q->mq_ops->timeout))
673			return 0;
674
675	if ((attr == &queue_max_open_zones_entry.attr ||
676	     attr == &queue_max_active_zones_entry.attr) &&
677	    !blk_queue_is_zoned(q))
678		return 0;
679
680	return attr->mode;
681}
682
683static struct attribute_group queue_attr_group = {
684	.attrs = queue_attrs,
685	.is_visible = queue_attr_visible,
686};
687
688
689#define to_queue(atr) container_of((atr), struct queue_sysfs_entry, attr)
690
691static ssize_t
692queue_attr_show(struct kobject *kobj, struct attribute *attr, char *page)
693{
694	struct queue_sysfs_entry *entry = to_queue(attr);
695	struct request_queue *q =
696		container_of(kobj, struct request_queue, kobj);
697	ssize_t res;
698
699	if (!entry->show)
700		return -EIO;
701	mutex_lock(&q->sysfs_lock);
702	res = entry->show(q, page);
703	mutex_unlock(&q->sysfs_lock);
704	return res;
705}
706
707static ssize_t
708queue_attr_store(struct kobject *kobj, struct attribute *attr,
709		    const char *page, size_t length)
710{
711	struct queue_sysfs_entry *entry = to_queue(attr);
712	struct request_queue *q;
713	ssize_t res;
714
715	if (!entry->store)
716		return -EIO;
717
718	q = container_of(kobj, struct request_queue, kobj);
719	mutex_lock(&q->sysfs_lock);
720	res = entry->store(q, page, length);
721	mutex_unlock(&q->sysfs_lock);
722	return res;
723}
724
725static void blk_free_queue_rcu(struct rcu_head *rcu_head)
726{
727	struct request_queue *q = container_of(rcu_head, struct request_queue,
728					       rcu_head);
729
730	percpu_ref_exit(&q->q_usage_counter);
731	kmem_cache_free(blk_requestq_cachep, q);
732}
733
734/* Unconfigure the I/O scheduler and dissociate from the cgroup controller. */
735static void blk_exit_queue(struct request_queue *q)
736{
737	/*
738	 * Since the I/O scheduler exit code may access cgroup information,
739	 * perform I/O scheduler exit before disassociating from the block
740	 * cgroup controller.
741	 */
742	if (q->elevator) {
743		ioc_clear_queue(q);
744		__elevator_exit(q, q->elevator);
745	}
746
747	/*
748	 * Remove all references to @q from the block cgroup controller before
749	 * restoring @q->queue_lock to avoid that restoring this pointer causes
750	 * e.g. blkcg_print_blkgs() to crash.
751	 */
752	blkcg_exit_queue(q);
753
754	/*
755	 * Since the cgroup code may dereference the @q->backing_dev_info
756	 * pointer, only decrease its reference count after having removed the
757	 * association with the block cgroup controller.
758	 */
759	bdi_put(q->backing_dev_info);
760}
761
762/**
763 * blk_release_queue - releases all allocated resources of the request_queue
764 * @kobj: pointer to a kobject, whose container is a request_queue
765 *
766 * This function releases all allocated resources of the request queue.
767 *
768 * The struct request_queue refcount is incremented with blk_get_queue() and
769 * decremented with blk_put_queue(). Once the refcount reaches 0 this function
770 * is called.
771 *
772 * For drivers that have a request_queue on a gendisk and added with
773 * __device_add_disk() the refcount to request_queue will reach 0 with
774 * the last put_disk() called by the driver. For drivers which don't use
775 * __device_add_disk() this happens with blk_cleanup_queue().
776 *
777 * Drivers exist which depend on the release of the request_queue to be
778 * synchronous, it should not be deferred.
779 *
780 * Context: can sleep
781 */
782static void blk_release_queue(struct kobject *kobj)
783{
784	struct request_queue *q =
785		container_of(kobj, struct request_queue, kobj);
786
787	might_sleep();
788
789	if (test_bit(QUEUE_FLAG_POLL_STATS, &q->queue_flags))
790		blk_stat_remove_callback(q, q->poll_cb);
791	blk_stat_free_callback(q->poll_cb);
792
793	blk_free_queue_stats(q->stats);
794
795	blk_exit_queue(q);
796
797	blk_queue_free_zone_bitmaps(q);
798
799	if (queue_is_mq(q))
800		blk_mq_release(q);
801
802	blk_trace_shutdown(q);
803	mutex_lock(&q->debugfs_mutex);
804	debugfs_remove_recursive(q->debugfs_dir);
805	mutex_unlock(&q->debugfs_mutex);
806
807	if (queue_is_mq(q))
808		blk_mq_debugfs_unregister(q);
809
810	bioset_exit(&q->bio_split);
811
812	ida_simple_remove(&blk_queue_ida, q->id);
813	call_rcu(&q->rcu_head, blk_free_queue_rcu);
814}
815
816static const struct sysfs_ops queue_sysfs_ops = {
817	.show	= queue_attr_show,
818	.store	= queue_attr_store,
819};
820
821struct kobj_type blk_queue_ktype = {
822	.sysfs_ops	= &queue_sysfs_ops,
823	.release	= blk_release_queue,
824};
825
826/**
827 * blk_register_queue - register a block layer queue with sysfs
828 * @disk: Disk of which the request queue should be registered with sysfs.
829 */
830int blk_register_queue(struct gendisk *disk)
831{
832	int ret;
833	struct device *dev = disk_to_dev(disk);
834	struct request_queue *q = disk->queue;
835
836	if (WARN_ON(!q))
837		return -ENXIO;
838
839	WARN_ONCE(blk_queue_registered(q),
840		  "%s is registering an already registered queue\n",
841		  kobject_name(&dev->kobj));
842
843	/*
844	 * SCSI probing may synchronously create and destroy a lot of
845	 * request_queues for non-existent devices.  Shutting down a fully
846	 * functional queue takes measureable wallclock time as RCU grace
847	 * periods are involved.  To avoid excessive latency in these
848	 * cases, a request_queue starts out in a degraded mode which is
849	 * faster to shut down and is made fully functional here as
850	 * request_queues for non-existent devices never get registered.
851	 */
852	if (!blk_queue_init_done(q)) {
853		blk_queue_flag_set(QUEUE_FLAG_INIT_DONE, q);
854		percpu_ref_switch_to_percpu(&q->q_usage_counter);
855	}
856
857	blk_queue_update_readahead(q);
858
859	ret = blk_trace_init_sysfs(dev);
860	if (ret)
861		return ret;
862
863	mutex_lock(&q->sysfs_dir_lock);
864
865	ret = kobject_add(&q->kobj, kobject_get(&dev->kobj), "%s", "queue");
866	if (ret < 0) {
867		blk_trace_remove_sysfs(dev);
868		goto unlock;
869	}
870
871	ret = sysfs_create_group(&q->kobj, &queue_attr_group);
872	if (ret) {
873		blk_trace_remove_sysfs(dev);
874		kobject_del(&q->kobj);
875		kobject_put(&dev->kobj);
876		goto unlock;
877	}
878
879	mutex_lock(&q->debugfs_mutex);
880	q->debugfs_dir = debugfs_create_dir(kobject_name(q->kobj.parent),
881					    blk_debugfs_root);
882	mutex_unlock(&q->debugfs_mutex);
883
884	if (queue_is_mq(q)) {
885		__blk_mq_register_dev(dev, q);
886		blk_mq_debugfs_register(q);
887	}
888
889	mutex_lock(&q->sysfs_lock);
890	if (q->elevator) {
891		ret = elv_register_queue(q, false);
892		if (ret) {
893			mutex_unlock(&q->sysfs_lock);
894			mutex_unlock(&q->sysfs_dir_lock);
895			kobject_del(&q->kobj);
896			blk_trace_remove_sysfs(dev);
897			kobject_put(&dev->kobj);
898			return ret;
899		}
900	}
901
902	blk_queue_flag_set(QUEUE_FLAG_REGISTERED, q);
903	wbt_enable_default(q);
904	blk_throtl_register_queue(q);
905	spin_lock_irq(&q->queue_lock);
906	blk_queue_flag_set(QUEUE_FLAG_THROTL_INIT_DONE, q);
907	spin_unlock_irq(&q->queue_lock);
908
909	/* Now everything is ready and send out KOBJ_ADD uevent */
910	kobject_uevent(&q->kobj, KOBJ_ADD);
911	if (q->elevator)
912		kobject_uevent(&q->elevator->kobj, KOBJ_ADD);
913	mutex_unlock(&q->sysfs_lock);
914
915	ret = 0;
916unlock:
917	mutex_unlock(&q->sysfs_dir_lock);
918	return ret;
919}
920EXPORT_SYMBOL_GPL(blk_register_queue);
921
922/**
923 * blk_unregister_queue - counterpart of blk_register_queue()
924 * @disk: Disk of which the request queue should be unregistered from sysfs.
925 *
926 * Note: the caller is responsible for guaranteeing that this function is called
927 * after blk_register_queue() has finished.
928 */
929void blk_unregister_queue(struct gendisk *disk)
930{
931	struct request_queue *q = disk->queue;
932
933	if (WARN_ON(!q))
934		return;
935
936	/* Return early if disk->queue was never registered. */
937	if (!blk_queue_registered(q))
938		return;
939
940	spin_lock_irq(&q->queue_lock);
941	blk_queue_flag_clear(QUEUE_FLAG_THROTL_INIT_DONE, q);
942	spin_unlock_irq(&q->queue_lock);
943
944	/*
945	 * Since sysfs_remove_dir() prevents adding new directory entries
946	 * before removal of existing entries starts, protect against
947	 * concurrent elv_iosched_store() calls.
948	 */
949	mutex_lock(&q->sysfs_lock);
950	blk_queue_flag_clear(QUEUE_FLAG_REGISTERED, q);
951	mutex_unlock(&q->sysfs_lock);
952
953	mutex_lock(&q->sysfs_dir_lock);
954	/*
955	 * Remove the sysfs attributes before unregistering the queue data
956	 * structures that can be modified through sysfs.
957	 */
958	if (queue_is_mq(q))
959		blk_mq_unregister_dev(disk_to_dev(disk), q);
960	blk_trace_remove_sysfs(disk_to_dev(disk));
961
962	mutex_lock(&q->sysfs_lock);
963	if (q->elevator)
964		elv_unregister_queue(q);
965	mutex_unlock(&q->sysfs_lock);
966
967	/* Now that we've deleted all child objects, we can delete the queue. */
968	kobject_uevent(&q->kobj, KOBJ_REMOVE);
969	kobject_del(&q->kobj);
970
971	mutex_unlock(&q->sysfs_dir_lock);
972
973	kobject_put(&disk_to_dev(disk)->kobj);
974}
975