projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
blkcg: move per-queue blkg list heads and counters to queue and blkg
[linux-2.6-block.git] / block / blk-cgroup.h
CommitLineData
31e4c28d
VG		 1#ifndef _BLK_CGROUP_H
2#define _BLK_CGROUP_H
3/*
4 * Common Block IO controller cgroup interface
5 *
6 * Based on ideas and code from CFQ, CFS and BFQ:
7 * Copyright (C) 2003 Jens Axboe <axboe@kernel.dk>
8 *
9 * Copyright (C) 2008 Fabio Checconi <fabio@gandalf.sssup.it>
10 * Paolo Valente <paolo.valente@unimore.it>
11 *
12 * Copyright (C) 2009 Vivek Goyal <vgoyal@redhat.com>
13 * Nauman Rafique <nauman@google.com>
14 */
15
16#include <linux/cgroup.h>
575969a0 17#include <linux/u64_stats_sync.h>
31e4c28d 18
062a644d
VG		 19enum blkio_policy_id {
20 BLKIO_POLICY_PROP = 0, /* Proportional Bandwidth division */
4c9eefa1 21 BLKIO_POLICY_THROTL, /* Throttling */
035d10b2
TH		 22
23 BLKIO_NR_POLICIES,
062a644d
VG		 24};
25
9355aede
VG		 26/* Max limits for throttle policy */
27#define THROTL_IOPS_MAX UINT_MAX
28
32e380ae 29#ifdef CONFIG_BLK_CGROUP
2f5ea477 30
84c124da
DS		 31enum stat_type {
32 /* Total time spent (in ns) between request dispatch to the driver and
33 * request completion for IOs doen by this cgroup. This may not be
34 * accurate when NCQ is turned on. */
35 BLKIO_STAT_SERVICE_TIME = 0,
84c124da
DS		 36 /* Total time spent waiting in scheduler queue in ns */
37 BLKIO_STAT_WAIT_TIME,
cdc1184c
DS		 38 /* Number of IOs queued up */
39 BLKIO_STAT_QUEUED,
84c124da
DS		 40 /* All the single valued stats go below this */
41 BLKIO_STAT_TIME,
a23e6869 42#ifdef CONFIG_DEBUG_BLK_CGROUP
167400d3
JT		 43 /* Time not charged to this cgroup */
44 BLKIO_STAT_UNACCOUNTED_TIME,
cdc1184c 45 BLKIO_STAT_AVG_QUEUE_SIZE,
812df48d
DS		 46 BLKIO_STAT_IDLE_TIME,
47 BLKIO_STAT_EMPTY_TIME,
48 BLKIO_STAT_GROUP_WAIT_TIME,
84c124da
DS		 49 BLKIO_STAT_DEQUEUE
50#endif
51};
52
5624a4e4
VG		 53/* Per cpu stats */
54enum stat_type_cpu {
55 BLKIO_STAT_CPU_SECTORS,
56 /* Total bytes transferred */
57 BLKIO_STAT_CPU_SERVICE_BYTES,
58 /* Total IOs serviced, post merge */
59 BLKIO_STAT_CPU_SERVICED,
317389a7
VG		 60 /* Number of IOs merged */
61 BLKIO_STAT_CPU_MERGED,
5624a4e4
VG		 62 BLKIO_STAT_CPU_NR
63};
64
84c124da
DS		 65enum stat_sub_type {
66 BLKIO_STAT_READ = 0,
67 BLKIO_STAT_WRITE,
68 BLKIO_STAT_SYNC,
69 BLKIO_STAT_ASYNC,
70 BLKIO_STAT_TOTAL
303a3acb
DS		 71};
72
812df48d
DS		 73/* blkg state flags */
74enum blkg_state_flags {
75 BLKG_waiting = 0,
76 BLKG_idling,
77 BLKG_empty,
78};
79
062a644d
VG		 80/* cgroup files owned by proportional weight policy */
81enum blkcg_file_name_prop {
82 BLKIO_PROP_weight = 1,
83 BLKIO_PROP_weight_device,
84 BLKIO_PROP_io_service_bytes,
85 BLKIO_PROP_io_serviced,
86 BLKIO_PROP_time,
87 BLKIO_PROP_sectors,
167400d3 88 BLKIO_PROP_unaccounted_time,
062a644d
VG		 89 BLKIO_PROP_io_service_time,
90 BLKIO_PROP_io_wait_time,
91 BLKIO_PROP_io_merged,
92 BLKIO_PROP_io_queued,
93 BLKIO_PROP_avg_queue_size,
94 BLKIO_PROP_group_wait_time,
95 BLKIO_PROP_idle_time,
96 BLKIO_PROP_empty_time,
97 BLKIO_PROP_dequeue,
98};
99
4c9eefa1
VG		 100/* cgroup files owned by throttle policy */
101enum blkcg_file_name_throtl {
102 BLKIO_THROTL_read_bps_device,
103 BLKIO_THROTL_write_bps_device,
7702e8f4
VG		 104 BLKIO_THROTL_read_iops_device,
105 BLKIO_THROTL_write_iops_device,
4c9eefa1
VG		 106 BLKIO_THROTL_io_service_bytes,
107 BLKIO_THROTL_io_serviced,
108};
109
31e4c28d
VG		 110struct blkio_cgroup {
111 struct cgroup_subsys_state css;
112 unsigned int weight;
113 spinlock_t lock;
114 struct hlist_head blkg_list;
115};
116
303a3acb
DS		 117struct blkio_group_stats {
118 /* total disk time and nr sectors dispatched by this group */
119 uint64_t time;
cdc1184c 120 uint64_t stat_arr[BLKIO_STAT_QUEUED + 1][BLKIO_STAT_TOTAL];
303a3acb 121#ifdef CONFIG_DEBUG_BLK_CGROUP
a23e6869
VG		 122 /* Time not charged to this cgroup */
123 uint64_t unaccounted_time;
124
cdc1184c
DS		 125 /* Sum of number of IOs queued across all samples */
126 uint64_t avg_queue_size_sum;
127 /* Count of samples taken for average */
128 uint64_t avg_queue_size_samples;
303a3acb
DS		 129 /* How many times this group has been removed from service tree */
130 unsigned long dequeue;
812df48d
DS		 131
132 /* Total time spent waiting for it to be assigned a timeslice. */
133 uint64_t group_wait_time;
134 uint64_t start_group_wait_time;
135
136 /* Time spent idling for this blkio_group */
137 uint64_t idle_time;
138 uint64_t start_idle_time;
139 /*
140 * Total time when we have requests queued and do not contain the
141 * current active queue.
142 */
143 uint64_t empty_time;
144 uint64_t start_empty_time;
145 uint16_t flags;
303a3acb
DS		 146#endif
147};
148
5624a4e4
VG		 149/* Per cpu blkio group stats */
150struct blkio_group_stats_cpu {
151 uint64_t sectors;
152 uint64_t stat_arr_cpu[BLKIO_STAT_CPU_NR][BLKIO_STAT_TOTAL];
575969a0 153 struct u64_stats_sync syncp;
5624a4e4
VG		 154};
155
e56da7e2
TH		 156struct blkio_group_conf {
157 unsigned int weight;
158 unsigned int iops[2];
159 u64 bps[2];
160};
161
0381411e
TH		 162/* per-blkg per-policy data */
163struct blkg_policy_data {
164 /* the blkg this per-policy data belongs to */
165 struct blkio_group *blkg;
166
549d3aa8
TH		 167 /* Configuration */
168 struct blkio_group_conf conf;
169
170 struct blkio_group_stats stats;
171 /* Per cpu stats pointer */
172 struct blkio_group_stats_cpu __percpu *stats_cpu;
173
0381411e
TH		 174 /* pol->pdata_size bytes of private data used by policy impl */
175 char pdata[] __aligned(__alignof__(unsigned long long));
176};
177
31e4c28d 178struct blkio_group {
ca32aefc
TH		 179 /* Pointer to the associated request_queue, RCU protected */
180 struct request_queue __rcu *q;
4eef3049 181 struct list_head q_node[BLKIO_NR_POLICIES];
31e4c28d 182 struct hlist_node blkcg_node;
7ee9c562 183 struct blkio_cgroup *blkcg;
2868ef7b
VG		 184 /* Store cgroup path */
185 char path[128];
062a644d
VG		 186 /* policy which owns this blk group */
187 enum blkio_policy_id plid;
1adaf3dd
TH		 188 /* reference count */
189 int refcnt;
22084190 190
303a3acb
DS		 191 /* Need to serialize the stats in the case of reset/update */
192 spinlock_t stats_lock;
549d3aa8 193 struct blkg_policy_data *pd[BLKIO_NR_POLICIES];
1adaf3dd
TH		 194
195 struct rcu_head rcu_head;
31e4c28d
VG		 196};
197
0381411e 198typedef void (blkio_init_group_fn)(struct blkio_group *blkg);
cd1604fa
TH		 199typedef void (blkio_link_group_fn)(struct request_queue *q,
200 struct blkio_group *blkg);
ca32aefc
TH		 201typedef void (blkio_unlink_group_fn)(struct request_queue *q,
202 struct blkio_group *blkg);
72e06c25 203typedef bool (blkio_clear_queue_fn)(struct request_queue *q);
ca32aefc 204typedef void (blkio_update_group_weight_fn)(struct request_queue *q,
fe071437 205 struct blkio_group *blkg, unsigned int weight);
ca32aefc 206typedef void (blkio_update_group_read_bps_fn)(struct request_queue *q,
fe071437 207 struct blkio_group *blkg, u64 read_bps);
ca32aefc 208typedef void (blkio_update_group_write_bps_fn)(struct request_queue *q,
fe071437 209 struct blkio_group *blkg, u64 write_bps);
ca32aefc 210typedef void (blkio_update_group_read_iops_fn)(struct request_queue *q,
fe071437 211 struct blkio_group *blkg, unsigned int read_iops);
ca32aefc 212typedef void (blkio_update_group_write_iops_fn)(struct request_queue *q,
fe071437 213 struct blkio_group *blkg, unsigned int write_iops);
3e252066
VG		 214
215struct blkio_policy_ops {
0381411e 216 blkio_init_group_fn *blkio_init_group_fn;
cd1604fa 217 blkio_link_group_fn *blkio_link_group_fn;
3e252066 218 blkio_unlink_group_fn *blkio_unlink_group_fn;
72e06c25 219 blkio_clear_queue_fn *blkio_clear_queue_fn;
3e252066 220 blkio_update_group_weight_fn *blkio_update_group_weight_fn;
4c9eefa1
VG		 221 blkio_update_group_read_bps_fn *blkio_update_group_read_bps_fn;
222 blkio_update_group_write_bps_fn *blkio_update_group_write_bps_fn;
7702e8f4
VG		 223 blkio_update_group_read_iops_fn *blkio_update_group_read_iops_fn;
224 blkio_update_group_write_iops_fn *blkio_update_group_write_iops_fn;
3e252066
VG		 225};
226
227struct blkio_policy_type {
228 struct list_head list;
229 struct blkio_policy_ops ops;
062a644d 230 enum blkio_policy_id plid;
0381411e 231 size_t pdata_size; /* policy specific private data size */
3e252066
VG		 232};
233
5efd6113
TH		 234extern int blkcg_init_queue(struct request_queue *q);
235extern void blkcg_drain_queue(struct request_queue *q);
236extern void blkcg_exit_queue(struct request_queue *q);
237
3e252066
VG		 238/* Blkio controller policy registration */
239extern void blkio_policy_register(struct blkio_policy_type *);
240extern void blkio_policy_unregister(struct blkio_policy_type *);
72e06c25 241extern void blkg_destroy_all(struct request_queue *q);
3e252066 242
0381411e
TH		 243/**
244 * blkg_to_pdata - get policy private data
245 * @blkg: blkg of interest
246 * @pol: policy of interest
247 *
248 * Return pointer to private data associated with the @blkg-@pol pair.
249 */
250static inline void *blkg_to_pdata(struct blkio_group *blkg,
251 struct blkio_policy_type *pol)
252{
549d3aa8 253 return blkg ? blkg->pd[pol->plid]->pdata : NULL;
0381411e
TH		 254}
255
256/**
257 * pdata_to_blkg - get blkg associated with policy private data
258 * @pdata: policy private data of interest
259 * @pol: policy @pdata is for
260 *
261 * @pdata is policy private data for @pol. Determine the blkg it's
262 * associated with.
263 */
264static inline struct blkio_group *pdata_to_blkg(void *pdata,
265 struct blkio_policy_type *pol)
266{
267 if (pdata) {
268 struct blkg_policy_data *pd =
269 container_of(pdata, struct blkg_policy_data, pdata);
270 return pd->blkg;
271 }
272 return NULL;
273}
274
afc24d49
VG		 275static inline char *blkg_path(struct blkio_group *blkg)
276{
277 return blkg->path;
278}
279
1adaf3dd
TH		 280/**
281 * blkg_get - get a blkg reference
282 * @blkg: blkg to get
283 *
284 * The caller should be holding queue_lock and an existing reference.
285 */
286static inline void blkg_get(struct blkio_group *blkg)
287{
288 lockdep_assert_held(blkg->q->queue_lock);
289 WARN_ON_ONCE(!blkg->refcnt);
290 blkg->refcnt++;
291}
292
293void __blkg_release(struct blkio_group *blkg);
294
295/**
296 * blkg_put - put a blkg reference
297 * @blkg: blkg to put
298 *
299 * The caller should be holding queue_lock.
300 */
301static inline void blkg_put(struct blkio_group *blkg)
302{
303 lockdep_assert_held(blkg->q->queue_lock);
304 WARN_ON_ONCE(blkg->refcnt <= 0);
305 if (!--blkg->refcnt)
306 __blkg_release(blkg);
307}
308
2f5ea477
JA		 309#else
310
311struct blkio_group {
312};
313
3e252066
VG		 314struct blkio_policy_type {
315};
316
5efd6113
TH		 317static inline int blkcg_init_queue(struct request_queue *q) { return 0; }
318static inline void blkcg_drain_queue(struct request_queue *q) { }
319static inline void blkcg_exit_queue(struct request_queue *q) { }
3e252066
VG		 320static inline void blkio_policy_register(struct blkio_policy_type *blkiop) { }
321static inline void blkio_policy_unregister(struct blkio_policy_type *blkiop) { }
72e06c25 322static inline void blkg_destroy_all(struct request_queue *q) { }
3e252066 323
0381411e
TH		 324static inline void *blkg_to_pdata(struct blkio_group *blkg,
325 struct blkio_policy_type *pol) { return NULL; }
326static inline struct blkio_group *pdata_to_blkg(void *pdata,
327 struct blkio_policy_type *pol) { return NULL; }
afc24d49 328static inline char *blkg_path(struct blkio_group *blkg) { return NULL; }
1adaf3dd
TH		 329static inline void blkg_get(struct blkio_group *blkg) { }
330static inline void blkg_put(struct blkio_group *blkg) { }
afc24d49 331
2f5ea477
JA		 332#endif
333
df457f84 334#define BLKIO_WEIGHT_MIN 10
31e4c28d
VG		 335#define BLKIO_WEIGHT_MAX 1000
336#define BLKIO_WEIGHT_DEFAULT 500
337
2868ef7b 338#ifdef CONFIG_DEBUG_BLK_CGROUP
c1768268
TH		 339void blkiocg_update_avg_queue_size_stats(struct blkio_group *blkg,
340 struct blkio_policy_type *pol);
9195291e 341void blkiocg_update_dequeue_stats(struct blkio_group *blkg,
c1768268
TH		 342 struct blkio_policy_type *pol,
343 unsigned long dequeue);
344void blkiocg_update_set_idle_time_stats(struct blkio_group *blkg,
345 struct blkio_policy_type *pol);
346void blkiocg_update_idle_time_stats(struct blkio_group *blkg,
347 struct blkio_policy_type *pol);
348void blkiocg_set_start_empty_time(struct blkio_group *blkg,
349 struct blkio_policy_type *pol);
812df48d
DS		 350
351#define BLKG_FLAG_FNS(name) \
352static inline void blkio_mark_blkg_##name( \
353 struct blkio_group_stats *stats) \
354{ \
355 stats->flags |= (1 << BLKG_##name); \
356} \
357static inline void blkio_clear_blkg_##name( \
358 struct blkio_group_stats *stats) \
359{ \
360 stats->flags &= ~(1 << BLKG_##name); \
361} \
362static inline int blkio_blkg_##name(struct blkio_group_stats *stats) \
363{ \
364 return (stats->flags & (1 << BLKG_##name)) != 0; \
365} \
366
367BLKG_FLAG_FNS(waiting)
368BLKG_FLAG_FNS(idling)
369BLKG_FLAG_FNS(empty)
370#undef BLKG_FLAG_FNS
2868ef7b 371#else
c1768268
TH		 372static inline void blkiocg_update_avg_queue_size_stats(struct blkio_group *blkg,
373 struct blkio_policy_type *pol) { }
9195291e 374static inline void blkiocg_update_dequeue_stats(struct blkio_group *blkg,
c1768268
TH		 375 struct blkio_policy_type *pol, unsigned long dequeue) { }
376static inline void blkiocg_update_set_idle_time_stats(struct blkio_group *blkg,
377 struct blkio_policy_type *pol) { }
378static inline void blkiocg_update_idle_time_stats(struct blkio_group *blkg,
379 struct blkio_policy_type *pol) { }
380static inline void blkiocg_set_start_empty_time(struct blkio_group *blkg,
381 struct blkio_policy_type *pol) { }
2868ef7b
VG		 382#endif
383
32e380ae 384#ifdef CONFIG_BLK_CGROUP
31e4c28d
VG		 385extern struct blkio_cgroup blkio_root_cgroup;
386extern struct blkio_cgroup *cgroup_to_blkio_cgroup(struct cgroup *cgroup);
70087dc3 387extern struct blkio_cgroup *task_blkio_cgroup(struct task_struct *tsk);
31e4c28d 388extern int blkiocg_del_blkio_group(struct blkio_group *blkg);
cd1604fa
TH		 389extern struct blkio_group *blkg_lookup(struct blkio_cgroup *blkcg,
390 struct request_queue *q,
391 enum blkio_policy_id plid);
392struct blkio_group *blkg_lookup_create(struct blkio_cgroup *blkcg,
393 struct request_queue *q,
394 enum blkio_policy_id plid,
395 bool for_root);
303a3acb 396void blkiocg_update_timeslice_used(struct blkio_group *blkg,
c1768268
TH		 397 struct blkio_policy_type *pol,
398 unsigned long time,
399 unsigned long unaccounted_time);
400void blkiocg_update_dispatch_stats(struct blkio_group *blkg,
401 struct blkio_policy_type *pol,
402 uint64_t bytes, bool direction, bool sync);
84c124da 403void blkiocg_update_completion_stats(struct blkio_group *blkg,
c1768268
TH		 404 struct blkio_policy_type *pol,
405 uint64_t start_time,
406 uint64_t io_start_time, bool direction,
407 bool sync);
408void blkiocg_update_io_merged_stats(struct blkio_group *blkg,
409 struct blkio_policy_type *pol,
410 bool direction, bool sync);
a11cdaa7 411void blkiocg_update_io_add_stats(struct blkio_group *blkg,
c1768268
TH		 412 struct blkio_policy_type *pol,
413 struct blkio_group *curr_blkg, bool direction,
414 bool sync);
a11cdaa7 415void blkiocg_update_io_remove_stats(struct blkio_group *blkg,
c1768268
TH		 416 struct blkio_policy_type *pol,
417 bool direction, bool sync);
31e4c28d 418#else
2f5ea477 419struct cgroup;
31e4c28d
VG		 420static inline struct blkio_cgroup *
421cgroup_to_blkio_cgroup(struct cgroup *cgroup) { return NULL; }
70087dc3
VG		 422static inline struct blkio_cgroup *
423task_blkio_cgroup(struct task_struct *tsk) { return NULL; }
31e4c28d 424
31e4c28d
VG		 425static inline int
426blkiocg_del_blkio_group(struct blkio_group *blkg) { return 0; }
427
cd1604fa
TH		 428static inline struct blkio_group *blkg_lookup(struct blkio_cgroup *blkcg,
429 void *key) { return NULL; }
303a3acb 430static inline void blkiocg_update_timeslice_used(struct blkio_group *blkg,
c1768268
TH		 431 struct blkio_policy_type *pol, unsigned long time,
432 unsigned long unaccounted_time) { }
84c124da 433static inline void blkiocg_update_dispatch_stats(struct blkio_group *blkg,
c1768268
TH		 434 struct blkio_policy_type *pol, uint64_t bytes,
435 bool direction, bool sync) { }
84c124da 436static inline void blkiocg_update_completion_stats(struct blkio_group *blkg,
c1768268
TH		 437 struct blkio_policy_type *pol, uint64_t start_time,
438 uint64_t io_start_time, bool direction, bool sync) { }
812d4026 439static inline void blkiocg_update_io_merged_stats(struct blkio_group *blkg,
c1768268
TH		 440 struct blkio_policy_type *pol, bool direction,
441 bool sync) { }
a11cdaa7 442static inline void blkiocg_update_io_add_stats(struct blkio_group *blkg,
c1768268
TH		 443 struct blkio_policy_type *pol,
444 struct blkio_group *curr_blkg, bool direction,
445 bool sync) { }
a11cdaa7 446static inline void blkiocg_update_io_remove_stats(struct blkio_group *blkg,
c1768268
TH		 447 struct blkio_policy_type *pol, bool direction,
448 bool sync) { }
31e4c28d
VG		 449#endif
450#endif /* _BLK_CGROUP_H */
Linux 6.x block layer and io_uring tree(s)