Merge branch 'master' into next
[GitHub/mt8127/android_kernel_alcatel_ttab.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>
17
062a644d
VG
18enum blkio_policy_id {
19 BLKIO_POLICY_PROP = 0, /* Proportional Bandwidth division */
4c9eefa1 20 BLKIO_POLICY_THROTL, /* Throttling */
062a644d
VG
21};
22
9355aede
VG
23/* Max limits for throttle policy */
24#define THROTL_IOPS_MAX UINT_MAX
25
67523c48
BB
26#if defined(CONFIG_BLK_CGROUP) || defined(CONFIG_BLK_CGROUP_MODULE)
27
28#ifndef CONFIG_BLK_CGROUP
29/* When blk-cgroup is a module, its subsys_id isn't a compile-time constant */
30extern struct cgroup_subsys blkio_subsys;
31#define blkio_subsys_id blkio_subsys.subsys_id
32#endif
2f5ea477 33
84c124da
DS
34enum stat_type {
35 /* Total time spent (in ns) between request dispatch to the driver and
36 * request completion for IOs doen by this cgroup. This may not be
37 * accurate when NCQ is turned on. */
38 BLKIO_STAT_SERVICE_TIME = 0,
39 /* Total bytes transferred */
40 BLKIO_STAT_SERVICE_BYTES,
41 /* Total IOs serviced, post merge */
42 BLKIO_STAT_SERVICED,
43 /* Total time spent waiting in scheduler queue in ns */
44 BLKIO_STAT_WAIT_TIME,
812d4026
DS
45 /* Number of IOs merged */
46 BLKIO_STAT_MERGED,
cdc1184c
DS
47 /* Number of IOs queued up */
48 BLKIO_STAT_QUEUED,
84c124da
DS
49 /* All the single valued stats go below this */
50 BLKIO_STAT_TIME,
51 BLKIO_STAT_SECTORS,
167400d3
JT
52 /* Time not charged to this cgroup */
53 BLKIO_STAT_UNACCOUNTED_TIME,
84c124da 54#ifdef CONFIG_DEBUG_BLK_CGROUP
cdc1184c 55 BLKIO_STAT_AVG_QUEUE_SIZE,
812df48d
DS
56 BLKIO_STAT_IDLE_TIME,
57 BLKIO_STAT_EMPTY_TIME,
58 BLKIO_STAT_GROUP_WAIT_TIME,
84c124da
DS
59 BLKIO_STAT_DEQUEUE
60#endif
61};
62
63enum stat_sub_type {
64 BLKIO_STAT_READ = 0,
65 BLKIO_STAT_WRITE,
66 BLKIO_STAT_SYNC,
67 BLKIO_STAT_ASYNC,
68 BLKIO_STAT_TOTAL
303a3acb
DS
69};
70
812df48d
DS
71/* blkg state flags */
72enum blkg_state_flags {
73 BLKG_waiting = 0,
74 BLKG_idling,
75 BLKG_empty,
76};
77
062a644d
VG
78/* cgroup files owned by proportional weight policy */
79enum blkcg_file_name_prop {
80 BLKIO_PROP_weight = 1,
81 BLKIO_PROP_weight_device,
82 BLKIO_PROP_io_service_bytes,
83 BLKIO_PROP_io_serviced,
84 BLKIO_PROP_time,
85 BLKIO_PROP_sectors,
167400d3 86 BLKIO_PROP_unaccounted_time,
062a644d
VG
87 BLKIO_PROP_io_service_time,
88 BLKIO_PROP_io_wait_time,
89 BLKIO_PROP_io_merged,
90 BLKIO_PROP_io_queued,
91 BLKIO_PROP_avg_queue_size,
92 BLKIO_PROP_group_wait_time,
93 BLKIO_PROP_idle_time,
94 BLKIO_PROP_empty_time,
95 BLKIO_PROP_dequeue,
96};
97
4c9eefa1
VG
98/* cgroup files owned by throttle policy */
99enum blkcg_file_name_throtl {
100 BLKIO_THROTL_read_bps_device,
101 BLKIO_THROTL_write_bps_device,
7702e8f4
VG
102 BLKIO_THROTL_read_iops_device,
103 BLKIO_THROTL_write_iops_device,
4c9eefa1
VG
104 BLKIO_THROTL_io_service_bytes,
105 BLKIO_THROTL_io_serviced,
106};
107
31e4c28d
VG
108struct blkio_cgroup {
109 struct cgroup_subsys_state css;
110 unsigned int weight;
111 spinlock_t lock;
112 struct hlist_head blkg_list;
34d0f179 113 struct list_head policy_list; /* list of blkio_policy_node */
31e4c28d
VG
114};
115
303a3acb
DS
116struct blkio_group_stats {
117 /* total disk time and nr sectors dispatched by this group */
118 uint64_t time;
119 uint64_t sectors;
167400d3
JT
120 /* Time not charged to this cgroup */
121 uint64_t unaccounted_time;
cdc1184c 122 uint64_t stat_arr[BLKIO_STAT_QUEUED + 1][BLKIO_STAT_TOTAL];
303a3acb 123#ifdef CONFIG_DEBUG_BLK_CGROUP
cdc1184c
DS
124 /* Sum of number of IOs queued across all samples */
125 uint64_t avg_queue_size_sum;
126 /* Count of samples taken for average */
127 uint64_t avg_queue_size_samples;
303a3acb
DS
128 /* How many times this group has been removed from service tree */
129 unsigned long dequeue;
812df48d
DS
130
131 /* Total time spent waiting for it to be assigned a timeslice. */
132 uint64_t group_wait_time;
133 uint64_t start_group_wait_time;
134
135 /* Time spent idling for this blkio_group */
136 uint64_t idle_time;
137 uint64_t start_idle_time;
138 /*
139 * Total time when we have requests queued and do not contain the
140 * current active queue.
141 */
142 uint64_t empty_time;
143 uint64_t start_empty_time;
144 uint16_t flags;
303a3acb
DS
145#endif
146};
147
31e4c28d
VG
148struct blkio_group {
149 /* An rcu protected unique identifier for the group */
150 void *key;
151 struct hlist_node blkcg_node;
b1c35769 152 unsigned short blkcg_id;
2868ef7b
VG
153 /* Store cgroup path */
154 char path[128];
22084190 155 /* The device MKDEV(major, minor), this group has been created for */
84c124da 156 dev_t dev;
062a644d
VG
157 /* policy which owns this blk group */
158 enum blkio_policy_id plid;
22084190 159
303a3acb
DS
160 /* Need to serialize the stats in the case of reset/update */
161 spinlock_t stats_lock;
162 struct blkio_group_stats stats;
31e4c28d
VG
163};
164
34d0f179
GJ
165struct blkio_policy_node {
166 struct list_head node;
167 dev_t dev;
062a644d
VG
168 /* This node belongs to max bw policy or porportional weight policy */
169 enum blkio_policy_id plid;
170 /* cgroup file to which this rule belongs to */
171 int fileid;
4c9eefa1
VG
172
173 union {
174 unsigned int weight;
175 /*
176 * Rate read/write in terms of byptes per second
177 * Whether this rate represents read or write is determined
178 * by file type "fileid".
179 */
180 u64 bps;
7702e8f4 181 unsigned int iops;
4c9eefa1 182 } val;
34d0f179
GJ
183};
184
185extern unsigned int blkcg_get_weight(struct blkio_cgroup *blkcg,
186 dev_t dev);
4c9eefa1
VG
187extern uint64_t blkcg_get_read_bps(struct blkio_cgroup *blkcg,
188 dev_t dev);
189extern uint64_t blkcg_get_write_bps(struct blkio_cgroup *blkcg,
190 dev_t dev);
7702e8f4
VG
191extern unsigned int blkcg_get_read_iops(struct blkio_cgroup *blkcg,
192 dev_t dev);
193extern unsigned int blkcg_get_write_iops(struct blkio_cgroup *blkcg,
194 dev_t dev);
34d0f179 195
3e252066 196typedef void (blkio_unlink_group_fn) (void *key, struct blkio_group *blkg);
fe071437
VG
197
198typedef void (blkio_update_group_weight_fn) (void *key,
199 struct blkio_group *blkg, unsigned int weight);
200typedef void (blkio_update_group_read_bps_fn) (void * key,
201 struct blkio_group *blkg, u64 read_bps);
202typedef void (blkio_update_group_write_bps_fn) (void *key,
203 struct blkio_group *blkg, u64 write_bps);
204typedef void (blkio_update_group_read_iops_fn) (void *key,
205 struct blkio_group *blkg, unsigned int read_iops);
206typedef void (blkio_update_group_write_iops_fn) (void *key,
207 struct blkio_group *blkg, unsigned int write_iops);
3e252066
VG
208
209struct blkio_policy_ops {
210 blkio_unlink_group_fn *blkio_unlink_group_fn;
211 blkio_update_group_weight_fn *blkio_update_group_weight_fn;
4c9eefa1
VG
212 blkio_update_group_read_bps_fn *blkio_update_group_read_bps_fn;
213 blkio_update_group_write_bps_fn *blkio_update_group_write_bps_fn;
7702e8f4
VG
214 blkio_update_group_read_iops_fn *blkio_update_group_read_iops_fn;
215 blkio_update_group_write_iops_fn *blkio_update_group_write_iops_fn;
3e252066
VG
216};
217
218struct blkio_policy_type {
219 struct list_head list;
220 struct blkio_policy_ops ops;
062a644d 221 enum blkio_policy_id plid;
3e252066
VG
222};
223
224/* Blkio controller policy registration */
225extern void blkio_policy_register(struct blkio_policy_type *);
226extern void blkio_policy_unregister(struct blkio_policy_type *);
227
afc24d49
VG
228static inline char *blkg_path(struct blkio_group *blkg)
229{
230 return blkg->path;
231}
232
2f5ea477
JA
233#else
234
235struct blkio_group {
236};
237
3e252066
VG
238struct blkio_policy_type {
239};
240
241static inline void blkio_policy_register(struct blkio_policy_type *blkiop) { }
242static inline void blkio_policy_unregister(struct blkio_policy_type *blkiop) { }
243
afc24d49
VG
244static inline char *blkg_path(struct blkio_group *blkg) { return NULL; }
245
2f5ea477
JA
246#endif
247
df457f84 248#define BLKIO_WEIGHT_MIN 10
31e4c28d
VG
249#define BLKIO_WEIGHT_MAX 1000
250#define BLKIO_WEIGHT_DEFAULT 500
251
2868ef7b 252#ifdef CONFIG_DEBUG_BLK_CGROUP
a11cdaa7 253void blkiocg_update_avg_queue_size_stats(struct blkio_group *blkg);
9195291e 254void blkiocg_update_dequeue_stats(struct blkio_group *blkg,
22084190 255 unsigned long dequeue);
812df48d
DS
256void blkiocg_update_set_idle_time_stats(struct blkio_group *blkg);
257void blkiocg_update_idle_time_stats(struct blkio_group *blkg);
e5ff082e 258void blkiocg_set_start_empty_time(struct blkio_group *blkg);
812df48d
DS
259
260#define BLKG_FLAG_FNS(name) \
261static inline void blkio_mark_blkg_##name( \
262 struct blkio_group_stats *stats) \
263{ \
264 stats->flags |= (1 << BLKG_##name); \
265} \
266static inline void blkio_clear_blkg_##name( \
267 struct blkio_group_stats *stats) \
268{ \
269 stats->flags &= ~(1 << BLKG_##name); \
270} \
271static inline int blkio_blkg_##name(struct blkio_group_stats *stats) \
272{ \
273 return (stats->flags & (1 << BLKG_##name)) != 0; \
274} \
275
276BLKG_FLAG_FNS(waiting)
277BLKG_FLAG_FNS(idling)
278BLKG_FLAG_FNS(empty)
279#undef BLKG_FLAG_FNS
2868ef7b 280#else
a11cdaa7 281static inline void blkiocg_update_avg_queue_size_stats(
cdc1184c 282 struct blkio_group *blkg) {}
9195291e
DS
283static inline void blkiocg_update_dequeue_stats(struct blkio_group *blkg,
284 unsigned long dequeue) {}
812df48d
DS
285static inline void blkiocg_update_set_idle_time_stats(struct blkio_group *blkg)
286{}
287static inline void blkiocg_update_idle_time_stats(struct blkio_group *blkg) {}
e5ff082e 288static inline void blkiocg_set_start_empty_time(struct blkio_group *blkg) {}
2868ef7b
VG
289#endif
290
67523c48 291#if defined(CONFIG_BLK_CGROUP) || defined(CONFIG_BLK_CGROUP_MODULE)
31e4c28d
VG
292extern struct blkio_cgroup blkio_root_cgroup;
293extern struct blkio_cgroup *cgroup_to_blkio_cgroup(struct cgroup *cgroup);
70087dc3 294extern struct blkio_cgroup *task_blkio_cgroup(struct task_struct *tsk);
31e4c28d 295extern void blkiocg_add_blkio_group(struct blkio_cgroup *blkcg,
062a644d
VG
296 struct blkio_group *blkg, void *key, dev_t dev,
297 enum blkio_policy_id plid);
31e4c28d
VG
298extern int blkiocg_del_blkio_group(struct blkio_group *blkg);
299extern struct blkio_group *blkiocg_lookup_group(struct blkio_cgroup *blkcg,
300 void *key);
303a3acb 301void blkiocg_update_timeslice_used(struct blkio_group *blkg,
167400d3
JT
302 unsigned long time,
303 unsigned long unaccounted_time);
84c124da
DS
304void blkiocg_update_dispatch_stats(struct blkio_group *blkg, uint64_t bytes,
305 bool direction, bool sync);
306void blkiocg_update_completion_stats(struct blkio_group *blkg,
307 uint64_t start_time, uint64_t io_start_time, bool direction, bool sync);
812d4026
DS
308void blkiocg_update_io_merged_stats(struct blkio_group *blkg, bool direction,
309 bool sync);
a11cdaa7 310void blkiocg_update_io_add_stats(struct blkio_group *blkg,
cdc1184c 311 struct blkio_group *curr_blkg, bool direction, bool sync);
a11cdaa7 312void blkiocg_update_io_remove_stats(struct blkio_group *blkg,
cdc1184c 313 bool direction, bool sync);
31e4c28d 314#else
2f5ea477 315struct cgroup;
31e4c28d
VG
316static inline struct blkio_cgroup *
317cgroup_to_blkio_cgroup(struct cgroup *cgroup) { return NULL; }
70087dc3
VG
318static inline struct blkio_cgroup *
319task_blkio_cgroup(struct task_struct *tsk) { return NULL; }
31e4c28d
VG
320
321static inline void blkiocg_add_blkio_group(struct blkio_cgroup *blkcg,
062a644d
VG
322 struct blkio_group *blkg, void *key, dev_t dev,
323 enum blkio_policy_id plid) {}
31e4c28d
VG
324
325static inline int
326blkiocg_del_blkio_group(struct blkio_group *blkg) { return 0; }
327
328static inline struct blkio_group *
329blkiocg_lookup_group(struct blkio_cgroup *blkcg, void *key) { return NULL; }
303a3acb 330static inline void blkiocg_update_timeslice_used(struct blkio_group *blkg,
167400d3
JT
331 unsigned long time,
332 unsigned long unaccounted_time)
333{}
84c124da
DS
334static inline void blkiocg_update_dispatch_stats(struct blkio_group *blkg,
335 uint64_t bytes, bool direction, bool sync) {}
336static inline void blkiocg_update_completion_stats(struct blkio_group *blkg,
337 uint64_t start_time, uint64_t io_start_time, bool direction,
338 bool sync) {}
812d4026
DS
339static inline void blkiocg_update_io_merged_stats(struct blkio_group *blkg,
340 bool direction, bool sync) {}
a11cdaa7 341static inline void blkiocg_update_io_add_stats(struct blkio_group *blkg,
cdc1184c 342 struct blkio_group *curr_blkg, bool direction, bool sync) {}
a11cdaa7 343static inline void blkiocg_update_io_remove_stats(struct blkio_group *blkg,
cdc1184c 344 bool direction, bool sync) {}
31e4c28d
VG
345#endif
346#endif /* _BLK_CGROUP_H */