blk-rq-qos.h 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef RQ_QOS_H
  3. #define RQ_QOS_H
  4. #include <linux/kernel.h>
  5. #include <linux/blkdev.h>
  6. #include <linux/blk_types.h>
  7. #include <linux/atomic.h>
  8. #include <linux/wait.h>
  9. #include <linux/blk-mq.h>
  10. #include "blk-mq-debugfs.h"
  11. struct blk_mq_debugfs_attr;
  12. enum rq_qos_id {
  13. RQ_QOS_WBT,
  14. RQ_QOS_LATENCY,
  15. RQ_QOS_COST,
  16. RQ_QOS_IOPRIO,
  17. };
  18. struct rq_wait {
  19. wait_queue_head_t wait;
  20. atomic_t inflight;
  21. };
  22. struct rq_qos {
  23. struct rq_qos_ops *ops;
  24. struct request_queue *q;
  25. enum rq_qos_id id;
  26. struct rq_qos *next;
  27. #ifdef CONFIG_BLK_DEBUG_FS
  28. struct dentry *debugfs_dir;
  29. #endif
  30. };
  31. struct rq_qos_ops {
  32. void (*throttle)(struct rq_qos *, struct bio *);
  33. void (*track)(struct rq_qos *, struct request *, struct bio *);
  34. void (*merge)(struct rq_qos *, struct request *, struct bio *);
  35. void (*issue)(struct rq_qos *, struct request *);
  36. void (*requeue)(struct rq_qos *, struct request *);
  37. void (*done)(struct rq_qos *, struct request *);
  38. void (*done_bio)(struct rq_qos *, struct bio *);
  39. void (*cleanup)(struct rq_qos *, struct bio *);
  40. void (*queue_depth_changed)(struct rq_qos *);
  41. void (*exit)(struct rq_qos *);
  42. const struct blk_mq_debugfs_attr *debugfs_attrs;
  43. };
  44. struct rq_depth {
  45. unsigned int max_depth;
  46. int scale_step;
  47. bool scaled_max;
  48. unsigned int queue_depth;
  49. unsigned int default_depth;
  50. };
  51. static inline struct rq_qos *rq_qos_id(struct request_queue *q,
  52. enum rq_qos_id id)
  53. {
  54. struct rq_qos *rqos;
  55. for (rqos = q->rq_qos; rqos; rqos = rqos->next) {
  56. if (rqos->id == id)
  57. break;
  58. }
  59. return rqos;
  60. }
  61. static inline struct rq_qos *wbt_rq_qos(struct request_queue *q)
  62. {
  63. return rq_qos_id(q, RQ_QOS_WBT);
  64. }
  65. static inline struct rq_qos *blkcg_rq_qos(struct request_queue *q)
  66. {
  67. return rq_qos_id(q, RQ_QOS_LATENCY);
  68. }
  69. static inline void rq_wait_init(struct rq_wait *rq_wait)
  70. {
  71. atomic_set(&rq_wait->inflight, 0);
  72. init_waitqueue_head(&rq_wait->wait);
  73. }
  74. static inline void rq_qos_add(struct request_queue *q, struct rq_qos *rqos)
  75. {
  76. /*
  77. * No IO can be in-flight when adding rqos, so freeze queue, which
  78. * is fine since we only support rq_qos for blk-mq queue.
  79. *
  80. * Reuse ->queue_lock for protecting against other concurrent
  81. * rq_qos adding/deleting
  82. */
  83. blk_mq_freeze_queue(q);
  84. spin_lock_irq(&q->queue_lock);
  85. rqos->next = q->rq_qos;
  86. q->rq_qos = rqos;
  87. spin_unlock_irq(&q->queue_lock);
  88. blk_mq_unfreeze_queue(q);
  89. if (rqos->ops->debugfs_attrs)
  90. blk_mq_debugfs_register_rqos(rqos);
  91. }
  92. static inline void rq_qos_del(struct request_queue *q, struct rq_qos *rqos)
  93. {
  94. struct rq_qos **cur;
  95. /*
  96. * See comment in rq_qos_add() about freezing queue & using
  97. * ->queue_lock.
  98. */
  99. blk_mq_freeze_queue(q);
  100. spin_lock_irq(&q->queue_lock);
  101. for (cur = &q->rq_qos; *cur; cur = &(*cur)->next) {
  102. if (*cur == rqos) {
  103. *cur = rqos->next;
  104. break;
  105. }
  106. }
  107. spin_unlock_irq(&q->queue_lock);
  108. blk_mq_unfreeze_queue(q);
  109. blk_mq_debugfs_unregister_rqos(rqos);
  110. }
  111. typedef bool (acquire_inflight_cb_t)(struct rq_wait *rqw, void *private_data);
  112. typedef void (cleanup_cb_t)(struct rq_wait *rqw, void *private_data);
  113. void rq_qos_wait(struct rq_wait *rqw, void *private_data,
  114. acquire_inflight_cb_t *acquire_inflight_cb,
  115. cleanup_cb_t *cleanup_cb);
  116. bool rq_wait_inc_below(struct rq_wait *rq_wait, unsigned int limit);
  117. bool rq_depth_scale_up(struct rq_depth *rqd);
  118. bool rq_depth_scale_down(struct rq_depth *rqd, bool hard_throttle);
  119. bool rq_depth_calc_max_depth(struct rq_depth *rqd);
  120. void __rq_qos_cleanup(struct rq_qos *rqos, struct bio *bio);
  121. void __rq_qos_done(struct rq_qos *rqos, struct request *rq);
  122. void __rq_qos_issue(struct rq_qos *rqos, struct request *rq);
  123. void __rq_qos_requeue(struct rq_qos *rqos, struct request *rq);
  124. void __rq_qos_throttle(struct rq_qos *rqos, struct bio *bio);
  125. void __rq_qos_track(struct rq_qos *rqos, struct request *rq, struct bio *bio);
  126. void __rq_qos_merge(struct rq_qos *rqos, struct request *rq, struct bio *bio);
  127. void __rq_qos_done_bio(struct rq_qos *rqos, struct bio *bio);
  128. void __rq_qos_queue_depth_changed(struct rq_qos *rqos);
  129. static inline void rq_qos_cleanup(struct request_queue *q, struct bio *bio)
  130. {
  131. if (q->rq_qos)
  132. __rq_qos_cleanup(q->rq_qos, bio);
  133. }
  134. static inline void rq_qos_done(struct request_queue *q, struct request *rq)
  135. {
  136. if (q->rq_qos)
  137. __rq_qos_done(q->rq_qos, rq);
  138. }
  139. static inline void rq_qos_issue(struct request_queue *q, struct request *rq)
  140. {
  141. if (q->rq_qos)
  142. __rq_qos_issue(q->rq_qos, rq);
  143. }
  144. static inline void rq_qos_requeue(struct request_queue *q, struct request *rq)
  145. {
  146. if (q->rq_qos)
  147. __rq_qos_requeue(q->rq_qos, rq);
  148. }
  149. static inline void rq_qos_done_bio(struct request_queue *q, struct bio *bio)
  150. {
  151. if (q->rq_qos)
  152. __rq_qos_done_bio(q->rq_qos, bio);
  153. }
  154. static inline void rq_qos_throttle(struct request_queue *q, struct bio *bio)
  155. {
  156. /*
  157. * BIO_TRACKED lets controllers know that a bio went through the
  158. * normal rq_qos path.
  159. */
  160. bio_set_flag(bio, BIO_TRACKED);
  161. if (q->rq_qos)
  162. __rq_qos_throttle(q->rq_qos, bio);
  163. }
  164. static inline void rq_qos_track(struct request_queue *q, struct request *rq,
  165. struct bio *bio)
  166. {
  167. if (q->rq_qos)
  168. __rq_qos_track(q->rq_qos, rq, bio);
  169. }
  170. static inline void rq_qos_merge(struct request_queue *q, struct request *rq,
  171. struct bio *bio)
  172. {
  173. if (q->rq_qos)
  174. __rq_qos_merge(q->rq_qos, rq, bio);
  175. }
  176. static inline void rq_qos_queue_depth_changed(struct request_queue *q)
  177. {
  178. if (q->rq_qos)
  179. __rq_qos_queue_depth_changed(q->rq_qos);
  180. }
  181. void rq_qos_exit(struct request_queue *);
  182. #endif