blk-cgroup.h 10.9 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
#ifndef _BLK_CGROUP_H
#define _BLK_CGROUP_H
/*
 * Common Block IO controller cgroup interface
 *
 * Based on ideas and code from CFQ, CFS and BFQ:
 * Copyright (C) 2003 Jens Axboe <axboe@kernel.dk>
 *
 * Copyright (C) 2008 Fabio Checconi <fabio@gandalf.sssup.it>
 *		      Paolo Valente <paolo.valente@unimore.it>
 *
 * Copyright (C) 2009 Vivek Goyal <vgoyal@redhat.com>
 * 	              Nauman Rafique <nauman@google.com>
 */

#include <linux/cgroup.h>
17
#include <linux/u64_stats_sync.h>
18

19
20
enum blkio_policy_id {
	BLKIO_POLICY_PROP = 0,		/* Proportional Bandwidth division */
21
	BLKIO_POLICY_THROTL,		/* Throttling */
22
23

	BLKIO_NR_POLICIES,
24
25
};

26
27
28
/* Max limits for throttle policy */
#define THROTL_IOPS_MAX		UINT_MAX

Tejun Heo's avatar
Tejun Heo committed
29
#ifdef CONFIG_BLK_CGROUP
30

31
32
33
34
35
36
37
enum stat_type {
	/* Total time spent (in ns) between request dispatch to the driver and
	 * request completion for IOs doen by this cgroup. This may not be
	 * accurate when NCQ is turned on. */
	BLKIO_STAT_SERVICE_TIME = 0,
	/* Total time spent waiting in scheduler queue in ns */
	BLKIO_STAT_WAIT_TIME,
38
39
	/* Number of IOs queued up */
	BLKIO_STAT_QUEUED,
40
41
	/* All the single valued stats go below this */
	BLKIO_STAT_TIME,
42
#ifdef CONFIG_DEBUG_BLK_CGROUP
43
44
	/* Time not charged to this cgroup */
	BLKIO_STAT_UNACCOUNTED_TIME,
45
	BLKIO_STAT_AVG_QUEUE_SIZE,
46
47
48
	BLKIO_STAT_IDLE_TIME,
	BLKIO_STAT_EMPTY_TIME,
	BLKIO_STAT_GROUP_WAIT_TIME,
49
50
51
52
	BLKIO_STAT_DEQUEUE
#endif
};

53
54
55
56
57
58
59
/* Per cpu stats */
enum stat_type_cpu {
	BLKIO_STAT_CPU_SECTORS,
	/* Total bytes transferred */
	BLKIO_STAT_CPU_SERVICE_BYTES,
	/* Total IOs serviced, post merge */
	BLKIO_STAT_CPU_SERVICED,
60
61
	/* Number of IOs merged */
	BLKIO_STAT_CPU_MERGED,
62
63
64
	BLKIO_STAT_CPU_NR
};

65
66
67
68
69
70
enum stat_sub_type {
	BLKIO_STAT_READ = 0,
	BLKIO_STAT_WRITE,
	BLKIO_STAT_SYNC,
	BLKIO_STAT_ASYNC,
	BLKIO_STAT_TOTAL
71
72
};

73
74
75
76
77
78
79
/* blkg state flags */
enum blkg_state_flags {
	BLKG_waiting = 0,
	BLKG_idling,
	BLKG_empty,
};

80
81
82
83
84
85
86
87
/* cgroup files owned by proportional weight policy */
enum blkcg_file_name_prop {
	BLKIO_PROP_weight = 1,
	BLKIO_PROP_weight_device,
	BLKIO_PROP_io_service_bytes,
	BLKIO_PROP_io_serviced,
	BLKIO_PROP_time,
	BLKIO_PROP_sectors,
88
	BLKIO_PROP_unaccounted_time,
89
90
91
92
93
94
95
96
97
98
99
	BLKIO_PROP_io_service_time,
	BLKIO_PROP_io_wait_time,
	BLKIO_PROP_io_merged,
	BLKIO_PROP_io_queued,
	BLKIO_PROP_avg_queue_size,
	BLKIO_PROP_group_wait_time,
	BLKIO_PROP_idle_time,
	BLKIO_PROP_empty_time,
	BLKIO_PROP_dequeue,
};

100
101
102
103
/* cgroup files owned by throttle policy */
enum blkcg_file_name_throtl {
	BLKIO_THROTL_read_bps_device,
	BLKIO_THROTL_write_bps_device,
104
105
	BLKIO_THROTL_read_iops_device,
	BLKIO_THROTL_write_iops_device,
106
107
108
109
	BLKIO_THROTL_io_service_bytes,
	BLKIO_THROTL_io_serviced,
};

110
111
112
113
114
115
116
struct blkio_cgroup {
	struct cgroup_subsys_state css;
	unsigned int weight;
	spinlock_t lock;
	struct hlist_head blkg_list;
};

117
118
119
struct blkio_group_stats {
	/* total disk time and nr sectors dispatched by this group */
	uint64_t time;
120
	uint64_t stat_arr[BLKIO_STAT_QUEUED + 1][BLKIO_STAT_TOTAL];
121
#ifdef CONFIG_DEBUG_BLK_CGROUP
122
123
124
	/* Time not charged to this cgroup */
	uint64_t unaccounted_time;

125
126
127
128
	/* Sum of number of IOs queued across all samples */
	uint64_t avg_queue_size_sum;
	/* Count of samples taken for average */
	uint64_t avg_queue_size_samples;
129
130
	/* How many times this group has been removed from service tree */
	unsigned long dequeue;
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

	/* Total time spent waiting for it to be assigned a timeslice. */
	uint64_t group_wait_time;
	uint64_t start_group_wait_time;

	/* Time spent idling for this blkio_group */
	uint64_t idle_time;
	uint64_t start_idle_time;
	/*
	 * Total time when we have requests queued and do not contain the
	 * current active queue.
	 */
	uint64_t empty_time;
	uint64_t start_empty_time;
	uint16_t flags;
146
147
148
#endif
};

149
150
151
152
/* Per cpu blkio group stats */
struct blkio_group_stats_cpu {
	uint64_t sectors;
	uint64_t stat_arr_cpu[BLKIO_STAT_CPU_NR][BLKIO_STAT_TOTAL];
153
	struct u64_stats_sync syncp;
154
155
};

156
157
158
159
160
161
struct blkio_group_conf {
	unsigned int weight;
	unsigned int iops[2];
	u64 bps[2];
};

162
struct blkio_group {
163
164
	/* Pointer to the associated request_queue, RCU protected */
	struct request_queue __rcu *q;
165
	struct hlist_node blkcg_node;
166
	struct blkio_cgroup *blkcg;
167
168
	/* Store cgroup path */
	char path[128];
169
170
	/* policy which owns this blk group */
	enum blkio_policy_id plid;
171

172
173
174
	/* Configuration */
	struct blkio_group_conf conf;

175
176
177
	/* Need to serialize the stats in the case of reset/update */
	spinlock_t stats_lock;
	struct blkio_group_stats stats;
178
179
	/* Per cpu stats pointer */
	struct blkio_group_stats_cpu __percpu *stats_cpu;
180
181
};

182
183
184
185
typedef struct blkio_group *(blkio_alloc_group_fn)(struct request_queue *q,
						   struct blkio_cgroup *blkcg);
typedef void (blkio_link_group_fn)(struct request_queue *q,
			struct blkio_group *blkg);
186
187
typedef void (blkio_unlink_group_fn)(struct request_queue *q,
			struct blkio_group *blkg);
188
typedef bool (blkio_clear_queue_fn)(struct request_queue *q);
189
typedef void (blkio_update_group_weight_fn)(struct request_queue *q,
190
			struct blkio_group *blkg, unsigned int weight);
191
typedef void (blkio_update_group_read_bps_fn)(struct request_queue *q,
192
			struct blkio_group *blkg, u64 read_bps);
193
typedef void (blkio_update_group_write_bps_fn)(struct request_queue *q,
194
			struct blkio_group *blkg, u64 write_bps);
195
typedef void (blkio_update_group_read_iops_fn)(struct request_queue *q,
196
			struct blkio_group *blkg, unsigned int read_iops);
197
typedef void (blkio_update_group_write_iops_fn)(struct request_queue *q,
198
			struct blkio_group *blkg, unsigned int write_iops);
199
200

struct blkio_policy_ops {
201
202
	blkio_alloc_group_fn *blkio_alloc_group_fn;
	blkio_link_group_fn *blkio_link_group_fn;
203
	blkio_unlink_group_fn *blkio_unlink_group_fn;
204
	blkio_clear_queue_fn *blkio_clear_queue_fn;
205
	blkio_update_group_weight_fn *blkio_update_group_weight_fn;
206
207
	blkio_update_group_read_bps_fn *blkio_update_group_read_bps_fn;
	blkio_update_group_write_bps_fn *blkio_update_group_write_bps_fn;
208
209
	blkio_update_group_read_iops_fn *blkio_update_group_read_iops_fn;
	blkio_update_group_write_iops_fn *blkio_update_group_write_iops_fn;
210
211
212
213
214
};

struct blkio_policy_type {
	struct list_head list;
	struct blkio_policy_ops ops;
215
	enum blkio_policy_id plid;
216
217
};

218
219
220
221
extern int blkcg_init_queue(struct request_queue *q);
extern void blkcg_drain_queue(struct request_queue *q);
extern void blkcg_exit_queue(struct request_queue *q);

222
223
224
/* Blkio controller policy registration */
extern void blkio_policy_register(struct blkio_policy_type *);
extern void blkio_policy_unregister(struct blkio_policy_type *);
225
extern void blkg_destroy_all(struct request_queue *q);
226

227
228
229
230
231
static inline char *blkg_path(struct blkio_group *blkg)
{
	return blkg->path;
}

232
233
234
235
236
#else

struct blkio_group {
};

237
238
239
struct blkio_policy_type {
};

240
241
242
static inline int blkcg_init_queue(struct request_queue *q) { return 0; }
static inline void blkcg_drain_queue(struct request_queue *q) { }
static inline void blkcg_exit_queue(struct request_queue *q) { }
243
244
static inline void blkio_policy_register(struct blkio_policy_type *blkiop) { }
static inline void blkio_policy_unregister(struct blkio_policy_type *blkiop) { }
245
static inline void blkg_destroy_all(struct request_queue *q) { }
246

247
248
static inline char *blkg_path(struct blkio_group *blkg) { return NULL; }

249
250
#endif

251
#define BLKIO_WEIGHT_MIN	10
252
253
254
#define BLKIO_WEIGHT_MAX	1000
#define BLKIO_WEIGHT_DEFAULT	500

255
#ifdef CONFIG_DEBUG_BLK_CGROUP
256
void blkiocg_update_avg_queue_size_stats(struct blkio_group *blkg);
257
void blkiocg_update_dequeue_stats(struct blkio_group *blkg,
258
				unsigned long dequeue);
259
260
void blkiocg_update_set_idle_time_stats(struct blkio_group *blkg);
void blkiocg_update_idle_time_stats(struct blkio_group *blkg);
261
void blkiocg_set_start_empty_time(struct blkio_group *blkg);
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

#define BLKG_FLAG_FNS(name)						\
static inline void blkio_mark_blkg_##name(				\
		struct blkio_group_stats *stats)			\
{									\
	stats->flags |= (1 << BLKG_##name);				\
}									\
static inline void blkio_clear_blkg_##name(				\
		struct blkio_group_stats *stats)			\
{									\
	stats->flags &= ~(1 << BLKG_##name);				\
}									\
static inline int blkio_blkg_##name(struct blkio_group_stats *stats)	\
{									\
	return (stats->flags & (1 << BLKG_##name)) != 0;		\
}									\

BLKG_FLAG_FNS(waiting)
BLKG_FLAG_FNS(idling)
BLKG_FLAG_FNS(empty)
#undef BLKG_FLAG_FNS
283
#else
284
static inline void blkiocg_update_avg_queue_size_stats(
285
						struct blkio_group *blkg) {}
286
287
static inline void blkiocg_update_dequeue_stats(struct blkio_group *blkg,
						unsigned long dequeue) {}
288
289
290
static inline void blkiocg_update_set_idle_time_stats(struct blkio_group *blkg)
{}
static inline void blkiocg_update_idle_time_stats(struct blkio_group *blkg) {}
291
static inline void blkiocg_set_start_empty_time(struct blkio_group *blkg) {}
292
293
#endif

Tejun Heo's avatar
Tejun Heo committed
294
#ifdef CONFIG_BLK_CGROUP
295
296
extern struct blkio_cgroup blkio_root_cgroup;
extern struct blkio_cgroup *cgroup_to_blkio_cgroup(struct cgroup *cgroup);
297
extern struct blkio_cgroup *task_blkio_cgroup(struct task_struct *tsk);
298
extern int blkiocg_del_blkio_group(struct blkio_group *blkg);
299
300
301
302
303
304
305
extern struct blkio_group *blkg_lookup(struct blkio_cgroup *blkcg,
				       struct request_queue *q,
				       enum blkio_policy_id plid);
struct blkio_group *blkg_lookup_create(struct blkio_cgroup *blkcg,
				       struct request_queue *q,
				       enum blkio_policy_id plid,
				       bool for_root);
306
void blkiocg_update_timeslice_used(struct blkio_group *blkg,
307
308
					unsigned long time,
					unsigned long unaccounted_time);
309
310
311
312
void blkiocg_update_dispatch_stats(struct blkio_group *blkg, uint64_t bytes,
						bool direction, bool sync);
void blkiocg_update_completion_stats(struct blkio_group *blkg,
	uint64_t start_time, uint64_t io_start_time, bool direction, bool sync);
Divyesh Shah's avatar
Divyesh Shah committed
313
314
void blkiocg_update_io_merged_stats(struct blkio_group *blkg, bool direction,
					bool sync);
315
void blkiocg_update_io_add_stats(struct blkio_group *blkg,
316
		struct blkio_group *curr_blkg, bool direction, bool sync);
317
void blkiocg_update_io_remove_stats(struct blkio_group *blkg,
318
					bool direction, bool sync);
319
#else
320
struct cgroup;
321
322
static inline struct blkio_cgroup *
cgroup_to_blkio_cgroup(struct cgroup *cgroup) { return NULL; }
323
324
static inline struct blkio_cgroup *
task_blkio_cgroup(struct task_struct *tsk) { return NULL; }
325
326
327
328

static inline int
blkiocg_del_blkio_group(struct blkio_group *blkg) { return 0; }

329
330
static inline struct blkio_group *blkg_lookup(struct blkio_cgroup *blkcg,
					      void *key) { return NULL; }
331
static inline void blkiocg_update_timeslice_used(struct blkio_group *blkg,
332
333
334
						unsigned long time,
						unsigned long unaccounted_time)
{}
335
336
337
338
339
static inline void blkiocg_update_dispatch_stats(struct blkio_group *blkg,
				uint64_t bytes, bool direction, bool sync) {}
static inline void blkiocg_update_completion_stats(struct blkio_group *blkg,
		uint64_t start_time, uint64_t io_start_time, bool direction,
		bool sync) {}
Divyesh Shah's avatar
Divyesh Shah committed
340
341
static inline void blkiocg_update_io_merged_stats(struct blkio_group *blkg,
						bool direction, bool sync) {}
342
static inline void blkiocg_update_io_add_stats(struct blkio_group *blkg,
343
		struct blkio_group *curr_blkg, bool direction, bool sync) {}
344
static inline void blkiocg_update_io_remove_stats(struct blkio_group *blkg,
345
						bool direction, bool sync) {}
346
347
#endif
#endif /* _BLK_CGROUP_H */