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