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