blkcg: let blkio_group point to blkio_cgroup directly
[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
31e4c28d 162struct blkio_group {
ca32aefc
TH
163 /* Pointer to the associated request_queue, RCU protected */
164 struct request_queue __rcu *q;
31e4c28d 165 struct hlist_node blkcg_node;
7ee9c562 166 struct blkio_cgroup *blkcg;
2868ef7b
VG
167 /* Store cgroup path */
168 char path[128];
062a644d
VG
169 /* policy which owns this blk group */
170 enum blkio_policy_id plid;
22084190 171
e56da7e2
TH
172 /* Configuration */
173 struct blkio_group_conf conf;
174
303a3acb
DS
175 /* Need to serialize the stats in the case of reset/update */
176 spinlock_t stats_lock;
177 struct blkio_group_stats stats;
5624a4e4
VG
178 /* Per cpu stats pointer */
179 struct blkio_group_stats_cpu __percpu *stats_cpu;
31e4c28d
VG
180};
181
cd1604fa
TH
182typedef struct blkio_group *(blkio_alloc_group_fn)(struct request_queue *q,
183 struct blkio_cgroup *blkcg);
184typedef void (blkio_link_group_fn)(struct request_queue *q,
185 struct blkio_group *blkg);
ca32aefc
TH
186typedef void (blkio_unlink_group_fn)(struct request_queue *q,
187 struct blkio_group *blkg);
72e06c25 188typedef bool (blkio_clear_queue_fn)(struct request_queue *q);
ca32aefc 189typedef void (blkio_update_group_weight_fn)(struct request_queue *q,
fe071437 190 struct blkio_group *blkg, unsigned int weight);
ca32aefc 191typedef void (blkio_update_group_read_bps_fn)(struct request_queue *q,
fe071437 192 struct blkio_group *blkg, u64 read_bps);
ca32aefc 193typedef void (blkio_update_group_write_bps_fn)(struct request_queue *q,
fe071437 194 struct blkio_group *blkg, u64 write_bps);
ca32aefc 195typedef void (blkio_update_group_read_iops_fn)(struct request_queue *q,
fe071437 196 struct blkio_group *blkg, unsigned int read_iops);
ca32aefc 197typedef void (blkio_update_group_write_iops_fn)(struct request_queue *q,
fe071437 198 struct blkio_group *blkg, unsigned int write_iops);
3e252066
VG
199
200struct blkio_policy_ops {
cd1604fa
TH
201 blkio_alloc_group_fn *blkio_alloc_group_fn;
202 blkio_link_group_fn *blkio_link_group_fn;
3e252066 203 blkio_unlink_group_fn *blkio_unlink_group_fn;
72e06c25 204 blkio_clear_queue_fn *blkio_clear_queue_fn;
3e252066 205 blkio_update_group_weight_fn *blkio_update_group_weight_fn;
4c9eefa1
VG
206 blkio_update_group_read_bps_fn *blkio_update_group_read_bps_fn;
207 blkio_update_group_write_bps_fn *blkio_update_group_write_bps_fn;
7702e8f4
VG
208 blkio_update_group_read_iops_fn *blkio_update_group_read_iops_fn;
209 blkio_update_group_write_iops_fn *blkio_update_group_write_iops_fn;
3e252066
VG
210};
211
212struct blkio_policy_type {
213 struct list_head list;
214 struct blkio_policy_ops ops;
062a644d 215 enum blkio_policy_id plid;
3e252066
VG
216};
217
218/* Blkio controller policy registration */
219extern void blkio_policy_register(struct blkio_policy_type *);
220extern void blkio_policy_unregister(struct blkio_policy_type *);
72e06c25 221extern void blkg_destroy_all(struct request_queue *q);
3e252066 222
afc24d49
VG
223static inline char *blkg_path(struct blkio_group *blkg)
224{
225 return blkg->path;
226}
227
2f5ea477
JA
228#else
229
230struct blkio_group {
231};
232
3e252066
VG
233struct blkio_policy_type {
234};
235
236static inline void blkio_policy_register(struct blkio_policy_type *blkiop) { }
237static inline void blkio_policy_unregister(struct blkio_policy_type *blkiop) { }
72e06c25 238static inline void blkg_destroy_all(struct request_queue *q) { }
3e252066 239
afc24d49
VG
240static inline char *blkg_path(struct blkio_group *blkg) { return NULL; }
241
2f5ea477
JA
242#endif
243
df457f84 244#define BLKIO_WEIGHT_MIN 10
31e4c28d
VG
245#define BLKIO_WEIGHT_MAX 1000
246#define BLKIO_WEIGHT_DEFAULT 500
247
2868ef7b 248#ifdef CONFIG_DEBUG_BLK_CGROUP
a11cdaa7 249void blkiocg_update_avg_queue_size_stats(struct blkio_group *blkg);
9195291e 250void blkiocg_update_dequeue_stats(struct blkio_group *blkg,
22084190 251 unsigned long dequeue);
812df48d
DS
252void blkiocg_update_set_idle_time_stats(struct blkio_group *blkg);
253void blkiocg_update_idle_time_stats(struct blkio_group *blkg);
e5ff082e 254void blkiocg_set_start_empty_time(struct blkio_group *blkg);
812df48d
DS
255
256#define BLKG_FLAG_FNS(name) \
257static inline void blkio_mark_blkg_##name( \
258 struct blkio_group_stats *stats) \
259{ \
260 stats->flags |= (1 << BLKG_##name); \
261} \
262static inline void blkio_clear_blkg_##name( \
263 struct blkio_group_stats *stats) \
264{ \
265 stats->flags &= ~(1 << BLKG_##name); \
266} \
267static inline int blkio_blkg_##name(struct blkio_group_stats *stats) \
268{ \
269 return (stats->flags & (1 << BLKG_##name)) != 0; \
270} \
271
272BLKG_FLAG_FNS(waiting)
273BLKG_FLAG_FNS(idling)
274BLKG_FLAG_FNS(empty)
275#undef BLKG_FLAG_FNS
2868ef7b 276#else
a11cdaa7 277static inline void blkiocg_update_avg_queue_size_stats(
cdc1184c 278 struct blkio_group *blkg) {}
9195291e
DS
279static inline void blkiocg_update_dequeue_stats(struct blkio_group *blkg,
280 unsigned long dequeue) {}
812df48d
DS
281static inline void blkiocg_update_set_idle_time_stats(struct blkio_group *blkg)
282{}
283static inline void blkiocg_update_idle_time_stats(struct blkio_group *blkg) {}
e5ff082e 284static inline void blkiocg_set_start_empty_time(struct blkio_group *blkg) {}
2868ef7b
VG
285#endif
286
32e380ae 287#ifdef CONFIG_BLK_CGROUP
31e4c28d
VG
288extern struct blkio_cgroup blkio_root_cgroup;
289extern struct blkio_cgroup *cgroup_to_blkio_cgroup(struct cgroup *cgroup);
70087dc3 290extern struct blkio_cgroup *task_blkio_cgroup(struct task_struct *tsk);
31e4c28d 291extern int blkiocg_del_blkio_group(struct blkio_group *blkg);
cd1604fa
TH
292extern struct blkio_group *blkg_lookup(struct blkio_cgroup *blkcg,
293 struct request_queue *q,
294 enum blkio_policy_id plid);
295struct blkio_group *blkg_lookup_create(struct blkio_cgroup *blkcg,
296 struct request_queue *q,
297 enum blkio_policy_id plid,
298 bool for_root);
303a3acb 299void blkiocg_update_timeslice_used(struct blkio_group *blkg,
167400d3
JT
300 unsigned long time,
301 unsigned long unaccounted_time);
84c124da
DS
302void blkiocg_update_dispatch_stats(struct blkio_group *blkg, uint64_t bytes,
303 bool direction, bool sync);
304void blkiocg_update_completion_stats(struct blkio_group *blkg,
305 uint64_t start_time, uint64_t io_start_time, bool direction, bool sync);
812d4026
DS
306void blkiocg_update_io_merged_stats(struct blkio_group *blkg, bool direction,
307 bool sync);
a11cdaa7 308void blkiocg_update_io_add_stats(struct blkio_group *blkg,
cdc1184c 309 struct blkio_group *curr_blkg, bool direction, bool sync);
a11cdaa7 310void blkiocg_update_io_remove_stats(struct blkio_group *blkg,
cdc1184c 311 bool direction, bool sync);
31e4c28d 312#else
2f5ea477 313struct cgroup;
31e4c28d
VG
314static inline struct blkio_cgroup *
315cgroup_to_blkio_cgroup(struct cgroup *cgroup) { return NULL; }
70087dc3
VG
316static inline struct blkio_cgroup *
317task_blkio_cgroup(struct task_struct *tsk) { return NULL; }
31e4c28d 318
31e4c28d
VG
319static inline int
320blkiocg_del_blkio_group(struct blkio_group *blkg) { return 0; }
321
cd1604fa
TH
322static inline struct blkio_group *blkg_lookup(struct blkio_cgroup *blkcg,
323 void *key) { return NULL; }
303a3acb 324static inline void blkiocg_update_timeslice_used(struct blkio_group *blkg,
167400d3
JT
325 unsigned long time,
326 unsigned long unaccounted_time)
327{}
84c124da
DS
328static inline void blkiocg_update_dispatch_stats(struct blkio_group *blkg,
329 uint64_t bytes, bool direction, bool sync) {}
330static inline void blkiocg_update_completion_stats(struct blkio_group *blkg,
331 uint64_t start_time, uint64_t io_start_time, bool direction,
332 bool sync) {}
812d4026
DS
333static inline void blkiocg_update_io_merged_stats(struct blkio_group *blkg,
334 bool direction, bool sync) {}
a11cdaa7 335static inline void blkiocg_update_io_add_stats(struct blkio_group *blkg,
cdc1184c 336 struct blkio_group *curr_blkg, bool direction, bool sync) {}
a11cdaa7 337static inline void blkiocg_update_io_remove_stats(struct blkio_group *blkg,
cdc1184c 338 bool direction, bool sync) {}
31e4c28d
VG
339#endif
340#endif /* _BLK_CGROUP_H */