]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - block/blk-cgroup.h
blkcg: let blkcg core handle policy private data allocation
[mirror_ubuntu-artful-kernel.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
167 /* pol->pdata_size bytes of private data used by policy impl */
168 char pdata[] __aligned(__alignof__(unsigned long long));
169};
170
31e4c28d 171struct blkio_group {
ca32aefc
TH
172 /* Pointer to the associated request_queue, RCU protected */
173 struct request_queue __rcu *q;
31e4c28d 174 struct hlist_node blkcg_node;
7ee9c562 175 struct blkio_cgroup *blkcg;
2868ef7b
VG
176 /* Store cgroup path */
177 char path[128];
062a644d
VG
178 /* policy which owns this blk group */
179 enum blkio_policy_id plid;
22084190 180
e56da7e2
TH
181 /* Configuration */
182 struct blkio_group_conf conf;
183
303a3acb
DS
184 /* Need to serialize the stats in the case of reset/update */
185 spinlock_t stats_lock;
186 struct blkio_group_stats stats;
5624a4e4
VG
187 /* Per cpu stats pointer */
188 struct blkio_group_stats_cpu __percpu *stats_cpu;
0381411e
TH
189
190 struct blkg_policy_data *pd;
31e4c28d
VG
191};
192
0381411e 193typedef void (blkio_init_group_fn)(struct blkio_group *blkg);
cd1604fa
TH
194typedef void (blkio_link_group_fn)(struct request_queue *q,
195 struct blkio_group *blkg);
ca32aefc
TH
196typedef void (blkio_unlink_group_fn)(struct request_queue *q,
197 struct blkio_group *blkg);
72e06c25 198typedef bool (blkio_clear_queue_fn)(struct request_queue *q);
ca32aefc 199typedef void (blkio_update_group_weight_fn)(struct request_queue *q,
fe071437 200 struct blkio_group *blkg, unsigned int weight);
ca32aefc 201typedef void (blkio_update_group_read_bps_fn)(struct request_queue *q,
fe071437 202 struct blkio_group *blkg, u64 read_bps);
ca32aefc 203typedef void (blkio_update_group_write_bps_fn)(struct request_queue *q,
fe071437 204 struct blkio_group *blkg, u64 write_bps);
ca32aefc 205typedef void (blkio_update_group_read_iops_fn)(struct request_queue *q,
fe071437 206 struct blkio_group *blkg, unsigned int read_iops);
ca32aefc 207typedef void (blkio_update_group_write_iops_fn)(struct request_queue *q,
fe071437 208 struct blkio_group *blkg, unsigned int write_iops);
3e252066
VG
209
210struct blkio_policy_ops {
0381411e 211 blkio_init_group_fn *blkio_init_group_fn;
cd1604fa 212 blkio_link_group_fn *blkio_link_group_fn;
3e252066 213 blkio_unlink_group_fn *blkio_unlink_group_fn;
72e06c25 214 blkio_clear_queue_fn *blkio_clear_queue_fn;
3e252066 215 blkio_update_group_weight_fn *blkio_update_group_weight_fn;
4c9eefa1
VG
216 blkio_update_group_read_bps_fn *blkio_update_group_read_bps_fn;
217 blkio_update_group_write_bps_fn *blkio_update_group_write_bps_fn;
7702e8f4
VG
218 blkio_update_group_read_iops_fn *blkio_update_group_read_iops_fn;
219 blkio_update_group_write_iops_fn *blkio_update_group_write_iops_fn;
3e252066
VG
220};
221
222struct blkio_policy_type {
223 struct list_head list;
224 struct blkio_policy_ops ops;
062a644d 225 enum blkio_policy_id plid;
0381411e 226 size_t pdata_size; /* policy specific private data size */
3e252066
VG
227};
228
5efd6113
TH
229extern int blkcg_init_queue(struct request_queue *q);
230extern void blkcg_drain_queue(struct request_queue *q);
231extern void blkcg_exit_queue(struct request_queue *q);
232
3e252066
VG
233/* Blkio controller policy registration */
234extern void blkio_policy_register(struct blkio_policy_type *);
235extern void blkio_policy_unregister(struct blkio_policy_type *);
72e06c25 236extern void blkg_destroy_all(struct request_queue *q);
3e252066 237
0381411e
TH
238/**
239 * blkg_to_pdata - get policy private data
240 * @blkg: blkg of interest
241 * @pol: policy of interest
242 *
243 * Return pointer to private data associated with the @blkg-@pol pair.
244 */
245static inline void *blkg_to_pdata(struct blkio_group *blkg,
246 struct blkio_policy_type *pol)
247{
248 return blkg ? blkg->pd->pdata : NULL;
249}
250
251/**
252 * pdata_to_blkg - get blkg associated with policy private data
253 * @pdata: policy private data of interest
254 * @pol: policy @pdata is for
255 *
256 * @pdata is policy private data for @pol. Determine the blkg it's
257 * associated with.
258 */
259static inline struct blkio_group *pdata_to_blkg(void *pdata,
260 struct blkio_policy_type *pol)
261{
262 if (pdata) {
263 struct blkg_policy_data *pd =
264 container_of(pdata, struct blkg_policy_data, pdata);
265 return pd->blkg;
266 }
267 return NULL;
268}
269
afc24d49
VG
270static inline char *blkg_path(struct blkio_group *blkg)
271{
272 return blkg->path;
273}
274
2f5ea477
JA
275#else
276
277struct blkio_group {
278};
279
3e252066
VG
280struct blkio_policy_type {
281};
282
5efd6113
TH
283static inline int blkcg_init_queue(struct request_queue *q) { return 0; }
284static inline void blkcg_drain_queue(struct request_queue *q) { }
285static inline void blkcg_exit_queue(struct request_queue *q) { }
3e252066
VG
286static inline void blkio_policy_register(struct blkio_policy_type *blkiop) { }
287static inline void blkio_policy_unregister(struct blkio_policy_type *blkiop) { }
72e06c25 288static inline void blkg_destroy_all(struct request_queue *q) { }
3e252066 289
0381411e
TH
290static inline void *blkg_to_pdata(struct blkio_group *blkg,
291 struct blkio_policy_type *pol) { return NULL; }
292static inline struct blkio_group *pdata_to_blkg(void *pdata,
293 struct blkio_policy_type *pol) { return NULL; }
afc24d49
VG
294static inline char *blkg_path(struct blkio_group *blkg) { return NULL; }
295
2f5ea477
JA
296#endif
297
df457f84 298#define BLKIO_WEIGHT_MIN 10
31e4c28d
VG
299#define BLKIO_WEIGHT_MAX 1000
300#define BLKIO_WEIGHT_DEFAULT 500
301
2868ef7b 302#ifdef CONFIG_DEBUG_BLK_CGROUP
a11cdaa7 303void blkiocg_update_avg_queue_size_stats(struct blkio_group *blkg);
9195291e 304void blkiocg_update_dequeue_stats(struct blkio_group *blkg,
22084190 305 unsigned long dequeue);
812df48d
DS
306void blkiocg_update_set_idle_time_stats(struct blkio_group *blkg);
307void blkiocg_update_idle_time_stats(struct blkio_group *blkg);
e5ff082e 308void blkiocg_set_start_empty_time(struct blkio_group *blkg);
812df48d
DS
309
310#define BLKG_FLAG_FNS(name) \
311static inline void blkio_mark_blkg_##name( \
312 struct blkio_group_stats *stats) \
313{ \
314 stats->flags |= (1 << BLKG_##name); \
315} \
316static inline void blkio_clear_blkg_##name( \
317 struct blkio_group_stats *stats) \
318{ \
319 stats->flags &= ~(1 << BLKG_##name); \
320} \
321static inline int blkio_blkg_##name(struct blkio_group_stats *stats) \
322{ \
323 return (stats->flags & (1 << BLKG_##name)) != 0; \
324} \
325
326BLKG_FLAG_FNS(waiting)
327BLKG_FLAG_FNS(idling)
328BLKG_FLAG_FNS(empty)
329#undef BLKG_FLAG_FNS
2868ef7b 330#else
a11cdaa7 331static inline void blkiocg_update_avg_queue_size_stats(
cdc1184c 332 struct blkio_group *blkg) {}
9195291e
DS
333static inline void blkiocg_update_dequeue_stats(struct blkio_group *blkg,
334 unsigned long dequeue) {}
812df48d
DS
335static inline void blkiocg_update_set_idle_time_stats(struct blkio_group *blkg)
336{}
337static inline void blkiocg_update_idle_time_stats(struct blkio_group *blkg) {}
e5ff082e 338static inline void blkiocg_set_start_empty_time(struct blkio_group *blkg) {}
2868ef7b
VG
339#endif
340
32e380ae 341#ifdef CONFIG_BLK_CGROUP
31e4c28d
VG
342extern struct blkio_cgroup blkio_root_cgroup;
343extern struct blkio_cgroup *cgroup_to_blkio_cgroup(struct cgroup *cgroup);
70087dc3 344extern struct blkio_cgroup *task_blkio_cgroup(struct task_struct *tsk);
31e4c28d 345extern int blkiocg_del_blkio_group(struct blkio_group *blkg);
cd1604fa
TH
346extern struct blkio_group *blkg_lookup(struct blkio_cgroup *blkcg,
347 struct request_queue *q,
348 enum blkio_policy_id plid);
349struct blkio_group *blkg_lookup_create(struct blkio_cgroup *blkcg,
350 struct request_queue *q,
351 enum blkio_policy_id plid,
352 bool for_root);
303a3acb 353void blkiocg_update_timeslice_used(struct blkio_group *blkg,
167400d3
JT
354 unsigned long time,
355 unsigned long unaccounted_time);
84c124da
DS
356void blkiocg_update_dispatch_stats(struct blkio_group *blkg, uint64_t bytes,
357 bool direction, bool sync);
358void blkiocg_update_completion_stats(struct blkio_group *blkg,
359 uint64_t start_time, uint64_t io_start_time, bool direction, bool sync);
812d4026
DS
360void blkiocg_update_io_merged_stats(struct blkio_group *blkg, bool direction,
361 bool sync);
a11cdaa7 362void blkiocg_update_io_add_stats(struct blkio_group *blkg,
cdc1184c 363 struct blkio_group *curr_blkg, bool direction, bool sync);
a11cdaa7 364void blkiocg_update_io_remove_stats(struct blkio_group *blkg,
cdc1184c 365 bool direction, bool sync);
31e4c28d 366#else
2f5ea477 367struct cgroup;
31e4c28d
VG
368static inline struct blkio_cgroup *
369cgroup_to_blkio_cgroup(struct cgroup *cgroup) { return NULL; }
70087dc3
VG
370static inline struct blkio_cgroup *
371task_blkio_cgroup(struct task_struct *tsk) { return NULL; }
31e4c28d 372
31e4c28d
VG
373static inline int
374blkiocg_del_blkio_group(struct blkio_group *blkg) { return 0; }
375
cd1604fa
TH
376static inline struct blkio_group *blkg_lookup(struct blkio_cgroup *blkcg,
377 void *key) { return NULL; }
303a3acb 378static inline void blkiocg_update_timeslice_used(struct blkio_group *blkg,
167400d3
JT
379 unsigned long time,
380 unsigned long unaccounted_time)
381{}
84c124da
DS
382static inline void blkiocg_update_dispatch_stats(struct blkio_group *blkg,
383 uint64_t bytes, bool direction, bool sync) {}
384static inline void blkiocg_update_completion_stats(struct blkio_group *blkg,
385 uint64_t start_time, uint64_t io_start_time, bool direction,
386 bool sync) {}
812d4026
DS
387static inline void blkiocg_update_io_merged_stats(struct blkio_group *blkg,
388 bool direction, bool sync) {}
a11cdaa7 389static inline void blkiocg_update_io_add_stats(struct blkio_group *blkg,
cdc1184c 390 struct blkio_group *curr_blkg, bool direction, bool sync) {}
a11cdaa7 391static inline void blkiocg_update_io_remove_stats(struct blkio_group *blkg,
cdc1184c 392 bool direction, bool sync) {}
31e4c28d
VG
393#endif
394#endif /* _BLK_CGROUP_H */