470a29db6beca4b54ffa122040da6ffc2f413449
[safe/jmp/linux-2.6] / 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 #if defined(CONFIG_BLK_CGROUP) || defined(CONFIG_BLK_CGROUP_MODULE)
19
20 #ifndef CONFIG_BLK_CGROUP
21 /* When blk-cgroup is a module, its subsys_id isn't a compile-time constant */
22 extern struct cgroup_subsys blkio_subsys;
23 #define blkio_subsys_id blkio_subsys.subsys_id
24 #endif
25
26 enum stat_type {
27         /* Total time spent (in ns) between request dispatch to the driver and
28          * request completion for IOs doen by this cgroup. This may not be
29          * accurate when NCQ is turned on. */
30         BLKIO_STAT_SERVICE_TIME = 0,
31         /* Total bytes transferred */
32         BLKIO_STAT_SERVICE_BYTES,
33         /* Total IOs serviced, post merge */
34         BLKIO_STAT_SERVICED,
35         /* Total time spent waiting in scheduler queue in ns */
36         BLKIO_STAT_WAIT_TIME,
37         /* Number of IOs merged */
38         BLKIO_STAT_MERGED,
39         /* All the single valued stats go below this */
40         BLKIO_STAT_TIME,
41         BLKIO_STAT_SECTORS,
42 #ifdef CONFIG_DEBUG_BLK_CGROUP
43         BLKIO_STAT_DEQUEUE
44 #endif
45 };
46
47 enum stat_sub_type {
48         BLKIO_STAT_READ = 0,
49         BLKIO_STAT_WRITE,
50         BLKIO_STAT_SYNC,
51         BLKIO_STAT_ASYNC,
52         BLKIO_STAT_TOTAL
53 };
54
55 struct blkio_cgroup {
56         struct cgroup_subsys_state css;
57         unsigned int weight;
58         spinlock_t lock;
59         struct hlist_head blkg_list;
60 };
61
62 struct blkio_group_stats {
63         /* total disk time and nr sectors dispatched by this group */
64         uint64_t time;
65         uint64_t sectors;
66         uint64_t stat_arr[BLKIO_STAT_MERGED + 1][BLKIO_STAT_TOTAL];
67 #ifdef CONFIG_DEBUG_BLK_CGROUP
68         /* How many times this group has been removed from service tree */
69         unsigned long dequeue;
70 #endif
71 };
72
73 struct blkio_group {
74         /* An rcu protected unique identifier for the group */
75         void *key;
76         struct hlist_node blkcg_node;
77         unsigned short blkcg_id;
78 #ifdef CONFIG_DEBUG_BLK_CGROUP
79         /* Store cgroup path */
80         char path[128];
81 #endif
82         /* The device MKDEV(major, minor), this group has been created for */
83         dev_t dev;
84
85         /* Need to serialize the stats in the case of reset/update */
86         spinlock_t stats_lock;
87         struct blkio_group_stats stats;
88 };
89
90 typedef void (blkio_unlink_group_fn) (void *key, struct blkio_group *blkg);
91 typedef void (blkio_update_group_weight_fn) (struct blkio_group *blkg,
92                                                 unsigned int weight);
93
94 struct blkio_policy_ops {
95         blkio_unlink_group_fn *blkio_unlink_group_fn;
96         blkio_update_group_weight_fn *blkio_update_group_weight_fn;
97 };
98
99 struct blkio_policy_type {
100         struct list_head list;
101         struct blkio_policy_ops ops;
102 };
103
104 /* Blkio controller policy registration */
105 extern void blkio_policy_register(struct blkio_policy_type *);
106 extern void blkio_policy_unregister(struct blkio_policy_type *);
107
108 #else
109
110 struct blkio_group {
111 };
112
113 struct blkio_policy_type {
114 };
115
116 static inline void blkio_policy_register(struct blkio_policy_type *blkiop) { }
117 static inline void blkio_policy_unregister(struct blkio_policy_type *blkiop) { }
118
119 #endif
120
121 #define BLKIO_WEIGHT_MIN        100
122 #define BLKIO_WEIGHT_MAX        1000
123 #define BLKIO_WEIGHT_DEFAULT    500
124
125 #ifdef CONFIG_DEBUG_BLK_CGROUP
126 static inline char *blkg_path(struct blkio_group *blkg)
127 {
128         return blkg->path;
129 }
130 void blkiocg_update_dequeue_stats(struct blkio_group *blkg,
131                                 unsigned long dequeue);
132 #else
133 static inline char *blkg_path(struct blkio_group *blkg) { return NULL; }
134 static inline void blkiocg_update_dequeue_stats(struct blkio_group *blkg,
135                                                 unsigned long dequeue) {}
136 #endif
137
138 #if defined(CONFIG_BLK_CGROUP) || defined(CONFIG_BLK_CGROUP_MODULE)
139 extern struct blkio_cgroup blkio_root_cgroup;
140 extern struct blkio_cgroup *cgroup_to_blkio_cgroup(struct cgroup *cgroup);
141 extern void blkiocg_add_blkio_group(struct blkio_cgroup *blkcg,
142                         struct blkio_group *blkg, void *key, dev_t dev);
143 extern int blkiocg_del_blkio_group(struct blkio_group *blkg);
144 extern struct blkio_group *blkiocg_lookup_group(struct blkio_cgroup *blkcg,
145                                                 void *key);
146 void blkio_group_init(struct blkio_group *blkg);
147 void blkiocg_update_timeslice_used(struct blkio_group *blkg,
148                                         unsigned long time);
149 void blkiocg_update_dispatch_stats(struct blkio_group *blkg, uint64_t bytes,
150                                                 bool direction, bool sync);
151 void blkiocg_update_completion_stats(struct blkio_group *blkg,
152         uint64_t start_time, uint64_t io_start_time, bool direction, bool sync);
153 void blkiocg_update_io_merged_stats(struct blkio_group *blkg, bool direction,
154                                         bool sync);
155 #else
156 struct cgroup;
157 static inline struct blkio_cgroup *
158 cgroup_to_blkio_cgroup(struct cgroup *cgroup) { return NULL; }
159
160 static inline void blkio_group_init(struct blkio_group *blkg) {}
161 static inline void blkiocg_add_blkio_group(struct blkio_cgroup *blkcg,
162                         struct blkio_group *blkg, void *key, dev_t dev) {}
163
164 static inline int
165 blkiocg_del_blkio_group(struct blkio_group *blkg) { return 0; }
166
167 static inline struct blkio_group *
168 blkiocg_lookup_group(struct blkio_cgroup *blkcg, void *key) { return NULL; }
169 static inline void blkiocg_update_timeslice_used(struct blkio_group *blkg,
170                                                 unsigned long time) {}
171 static inline void blkiocg_update_dispatch_stats(struct blkio_group *blkg,
172                                 uint64_t bytes, bool direction, bool sync) {}
173 static inline void blkiocg_update_completion_stats(struct blkio_group *blkg,
174                 uint64_t start_time, uint64_t io_start_time, bool direction,
175                 bool sync) {}
176 static inline void blkiocg_update_io_merged_stats(struct blkio_group *blkg,
177                                                 bool direction, bool sync) {}
178 #endif
179 #endif /* _BLK_CGROUP_H */