drivers: power: report battery voltage in AOSP compatible format
[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>
575969a0 17#include <linux/u64_stats_sync.h>
829fdb50 18#include <linux/seq_file.h>
a637120e 19#include <linux/radix-tree.h>
a051661c 20#include <linux/blkdev.h>
31e4c28d 21
9355aede
VG
22/* Max limits for throttle policy */
23#define THROTL_IOPS_MAX UINT_MAX
24
3381cb8d
TH
25/* CFQ specific, out here for blkcg->cfq_weight */
26#define CFQ_WEIGHT_MIN 10
27#define CFQ_WEIGHT_MAX 1000
28#define CFQ_WEIGHT_DEFAULT 500
29
f48ec1d7
TH
30#ifdef CONFIG_BLK_CGROUP
31
edcb0722
TH
32enum blkg_rwstat_type {
33 BLKG_RWSTAT_READ,
34 BLKG_RWSTAT_WRITE,
35 BLKG_RWSTAT_SYNC,
36 BLKG_RWSTAT_ASYNC,
37
38 BLKG_RWSTAT_NR,
39 BLKG_RWSTAT_TOTAL = BLKG_RWSTAT_NR,
303a3acb
DS
40};
41
a637120e
TH
42struct blkcg_gq;
43
3c798398 44struct blkcg {
36558c8a
TH
45 struct cgroup_subsys_state css;
46 spinlock_t lock;
a637120e
TH
47
48 struct radix_tree_root blkg_tree;
49 struct blkcg_gq *blkg_hint;
36558c8a 50 struct hlist_head blkg_list;
9a9e8a26
TH
51
52 /* for policies to test whether associated blkcg has changed */
36558c8a 53 uint64_t id;
3381cb8d 54
3c798398 55 /* TODO: per-policy storage in blkcg */
36558c8a 56 unsigned int cfq_weight; /* belongs to cfq */
e71357e1 57 unsigned int cfq_leaf_weight;
31e4c28d
VG
58};
59
edcb0722
TH
60struct blkg_stat {
61 struct u64_stats_sync syncp;
62 uint64_t cnt;
63};
64
65struct blkg_rwstat {
66 struct u64_stats_sync syncp;
67 uint64_t cnt[BLKG_RWSTAT_NR];
68};
69
f95a04af
TH
70/*
71 * A blkcg_gq (blkg) is association between a block cgroup (blkcg) and a
72 * request_queue (q). This is used by blkcg policies which need to track
73 * information per blkcg - q pair.
74 *
75 * There can be multiple active blkcg policies and each has its private
76 * data on each blkg, the size of which is determined by
77 * blkcg_policy->pd_size. blkcg core allocates and frees such areas
78 * together with blkg and invokes pd_init/exit_fn() methods.
79 *
80 * Such private data must embed struct blkg_policy_data (pd) at the
81 * beginning and pd_size can't be smaller than pd.
82 */
0381411e 83struct blkg_policy_data {
b276a876 84 /* the blkg and policy id this per-policy data belongs to */
3c798398 85 struct blkcg_gq *blkg;
b276a876 86 int plid;
0381411e 87
a2b1693b 88 /* used during policy activation */
36558c8a 89 struct list_head alloc_node;
0381411e
TH
90};
91
3c798398
TH
92/* association between a blk cgroup and a request queue */
93struct blkcg_gq {
c875f4d0 94 /* Pointer to the associated request_queue */
36558c8a
TH
95 struct request_queue *q;
96 struct list_head q_node;
97 struct hlist_node blkcg_node;
3c798398 98 struct blkcg *blkcg;
3c547865
TH
99
100 /* all non-root blkcg_gq's are guaranteed to have access to parent */
101 struct blkcg_gq *parent;
102
a051661c
TH
103 /* request allocation list for this blkcg-q pair */
104 struct request_list rl;
3c547865 105
1adaf3dd 106 /* reference count */
36558c8a 107 int refcnt;
22084190 108
f427d909
TH
109 /* is this blkg online? protected by both blkcg and q locks */
110 bool online;
111
36558c8a 112 struct blkg_policy_data *pd[BLKCG_MAX_POLS];
1adaf3dd 113
36558c8a 114 struct rcu_head rcu_head;
31e4c28d
VG
115};
116
3c798398 117typedef void (blkcg_pol_init_pd_fn)(struct blkcg_gq *blkg);
f427d909
TH
118typedef void (blkcg_pol_online_pd_fn)(struct blkcg_gq *blkg);
119typedef void (blkcg_pol_offline_pd_fn)(struct blkcg_gq *blkg);
3c798398
TH
120typedef void (blkcg_pol_exit_pd_fn)(struct blkcg_gq *blkg);
121typedef void (blkcg_pol_reset_pd_stats_fn)(struct blkcg_gq *blkg);
3e252066 122
3c798398 123struct blkcg_policy {
36558c8a
TH
124 int plid;
125 /* policy specific private data size */
f95a04af 126 size_t pd_size;
36558c8a
TH
127 /* cgroup files for the policy */
128 struct cftype *cftypes;
f9fcc2d3
TH
129
130 /* operations */
131 blkcg_pol_init_pd_fn *pd_init_fn;
f427d909
TH
132 blkcg_pol_online_pd_fn *pd_online_fn;
133 blkcg_pol_offline_pd_fn *pd_offline_fn;
f9fcc2d3
TH
134 blkcg_pol_exit_pd_fn *pd_exit_fn;
135 blkcg_pol_reset_pd_stats_fn *pd_reset_stats_fn;
3e252066
VG
136};
137
3c798398 138extern struct blkcg blkcg_root;
36558c8a 139
3c798398
TH
140struct blkcg_gq *blkg_lookup(struct blkcg *blkcg, struct request_queue *q);
141struct blkcg_gq *blkg_lookup_create(struct blkcg *blkcg,
142 struct request_queue *q);
36558c8a
TH
143int blkcg_init_queue(struct request_queue *q);
144void blkcg_drain_queue(struct request_queue *q);
145void blkcg_exit_queue(struct request_queue *q);
5efd6113 146
3e252066 147/* Blkio controller policy registration */
3c798398
TH
148int blkcg_policy_register(struct blkcg_policy *pol);
149void blkcg_policy_unregister(struct blkcg_policy *pol);
36558c8a 150int blkcg_activate_policy(struct request_queue *q,
3c798398 151 const struct blkcg_policy *pol);
36558c8a 152void blkcg_deactivate_policy(struct request_queue *q,
3c798398 153 const struct blkcg_policy *pol);
3e252066 154
3c798398 155void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
f95a04af
TH
156 u64 (*prfill)(struct seq_file *,
157 struct blkg_policy_data *, int),
3c798398 158 const struct blkcg_policy *pol, int data,
ec399347 159 bool show_total);
f95a04af
TH
160u64 __blkg_prfill_u64(struct seq_file *sf, struct blkg_policy_data *pd, u64 v);
161u64 __blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
829fdb50 162 const struct blkg_rwstat *rwstat);
f95a04af
TH
163u64 blkg_prfill_stat(struct seq_file *sf, struct blkg_policy_data *pd, int off);
164u64 blkg_prfill_rwstat(struct seq_file *sf, struct blkg_policy_data *pd,
165 int off);
829fdb50 166
16b3de66
TH
167u64 blkg_stat_recursive_sum(struct blkg_policy_data *pd, int off);
168struct blkg_rwstat blkg_rwstat_recursive_sum(struct blkg_policy_data *pd,
169 int off);
170
829fdb50 171struct blkg_conf_ctx {
36558c8a 172 struct gendisk *disk;
3c798398 173 struct blkcg_gq *blkg;
36558c8a 174 u64 v;
829fdb50
TH
175};
176
3c798398
TH
177int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
178 const char *input, struct blkg_conf_ctx *ctx);
829fdb50
TH
179void blkg_conf_finish(struct blkg_conf_ctx *ctx);
180
181
b1208b56
TH
182static inline struct blkcg *cgroup_to_blkcg(struct cgroup *cgroup)
183{
184 return container_of(cgroup_subsys_state(cgroup, blkio_subsys_id),
185 struct blkcg, css);
186}
187
188static inline struct blkcg *task_blkcg(struct task_struct *tsk)
189{
190 return container_of(task_subsys_state(tsk, blkio_subsys_id),
191 struct blkcg, css);
192}
193
194static inline struct blkcg *bio_blkcg(struct bio *bio)
195{
196 if (bio && bio->bi_css)
197 return container_of(bio->bi_css, struct blkcg, css);
198 return task_blkcg(current);
199}
200
3c547865
TH
201/**
202 * blkcg_parent - get the parent of a blkcg
203 * @blkcg: blkcg of interest
204 *
205 * Return the parent blkcg of @blkcg. Can be called anytime.
206 */
207static inline struct blkcg *blkcg_parent(struct blkcg *blkcg)
208{
209 struct cgroup *pcg = blkcg->css.cgroup->parent;
210
211 return pcg ? cgroup_to_blkcg(pcg) : NULL;
212}
213
0381411e
TH
214/**
215 * blkg_to_pdata - get policy private data
216 * @blkg: blkg of interest
217 * @pol: policy of interest
218 *
219 * Return pointer to private data associated with the @blkg-@pol pair.
220 */
f95a04af
TH
221static inline struct blkg_policy_data *blkg_to_pd(struct blkcg_gq *blkg,
222 struct blkcg_policy *pol)
0381411e 223{
f95a04af 224 return blkg ? blkg->pd[pol->plid] : NULL;
0381411e
TH
225}
226
227/**
228 * pdata_to_blkg - get blkg associated with policy private data
f95a04af 229 * @pd: policy private data of interest
0381411e 230 *
f95a04af 231 * @pd is policy private data. Determine the blkg it's associated with.
0381411e 232 */
f95a04af 233static inline struct blkcg_gq *pd_to_blkg(struct blkg_policy_data *pd)
0381411e 234{
f95a04af 235 return pd ? pd->blkg : NULL;
0381411e
TH
236}
237
54e7ed12
TH
238/**
239 * blkg_path - format cgroup path of blkg
240 * @blkg: blkg of interest
241 * @buf: target buffer
242 * @buflen: target buffer length
243 *
244 * Format the path of the cgroup of @blkg into @buf.
245 */
3c798398 246static inline int blkg_path(struct blkcg_gq *blkg, char *buf, int buflen)
afc24d49 247{
54e7ed12
TH
248 int ret;
249
54e7ed12 250 ret = cgroup_path(blkg->blkcg->css.cgroup, buf, buflen);
54e7ed12
TH
251 if (ret)
252 strncpy(buf, "<unavailable>", buflen);
253 return ret;
afc24d49
VG
254}
255
1adaf3dd
TH
256/**
257 * blkg_get - get a blkg reference
258 * @blkg: blkg to get
259 *
260 * The caller should be holding queue_lock and an existing reference.
261 */
3c798398 262static inline void blkg_get(struct blkcg_gq *blkg)
1adaf3dd
TH
263{
264 lockdep_assert_held(blkg->q->queue_lock);
265 WARN_ON_ONCE(!blkg->refcnt);
266 blkg->refcnt++;
267}
268
3c798398 269void __blkg_release(struct blkcg_gq *blkg);
1adaf3dd
TH
270
271/**
272 * blkg_put - put a blkg reference
273 * @blkg: blkg to put
274 *
275 * The caller should be holding queue_lock.
276 */
3c798398 277static inline void blkg_put(struct blkcg_gq *blkg)
1adaf3dd
TH
278{
279 lockdep_assert_held(blkg->q->queue_lock);
280 WARN_ON_ONCE(blkg->refcnt <= 0);
281 if (!--blkg->refcnt)
282 __blkg_release(blkg);
283}
284
a051661c
TH
285/**
286 * blk_get_rl - get request_list to use
287 * @q: request_queue of interest
288 * @bio: bio which will be attached to the allocated request (may be %NULL)
289 *
290 * The caller wants to allocate a request from @q to use for @bio. Find
291 * the request_list to use and obtain a reference on it. Should be called
292 * under queue_lock. This function is guaranteed to return non-%NULL
293 * request_list.
294 */
295static inline struct request_list *blk_get_rl(struct request_queue *q,
296 struct bio *bio)
297{
298 struct blkcg *blkcg;
299 struct blkcg_gq *blkg;
300
301 rcu_read_lock();
302
303 blkcg = bio_blkcg(bio);
304
305 /* bypass blkg lookup and use @q->root_rl directly for root */
306 if (blkcg == &blkcg_root)
307 goto root_rl;
308
309 /*
310 * Try to use blkg->rl. blkg lookup may fail under memory pressure
311 * or if either the blkcg or queue is going away. Fall back to
312 * root_rl in such cases.
313 */
314 blkg = blkg_lookup_create(blkcg, q);
315 if (unlikely(IS_ERR(blkg)))
316 goto root_rl;
317
318 blkg_get(blkg);
319 rcu_read_unlock();
320 return &blkg->rl;
321root_rl:
322 rcu_read_unlock();
323 return &q->root_rl;
324}
325
326/**
327 * blk_put_rl - put request_list
328 * @rl: request_list to put
329 *
330 * Put the reference acquired by blk_get_rl(). Should be called under
331 * queue_lock.
332 */
333static inline void blk_put_rl(struct request_list *rl)
334{
335 /* root_rl may not have blkg set */
336 if (rl->blkg && rl->blkg->blkcg != &blkcg_root)
337 blkg_put(rl->blkg);
338}
339
340/**
341 * blk_rq_set_rl - associate a request with a request_list
342 * @rq: request of interest
343 * @rl: target request_list
344 *
345 * Associate @rq with @rl so that accounting and freeing can know the
346 * request_list @rq came from.
347 */
348static inline void blk_rq_set_rl(struct request *rq, struct request_list *rl)
349{
350 rq->rl = rl;
351}
352
353/**
354 * blk_rq_rl - return the request_list a request came from
355 * @rq: request of interest
356 *
357 * Return the request_list @rq is allocated from.
358 */
359static inline struct request_list *blk_rq_rl(struct request *rq)
360{
361 return rq->rl;
362}
363
364struct request_list *__blk_queue_next_rl(struct request_list *rl,
365 struct request_queue *q);
366/**
367 * blk_queue_for_each_rl - iterate through all request_lists of a request_queue
368 *
369 * Should be used under queue_lock.
370 */
371#define blk_queue_for_each_rl(rl, q) \
372 for ((rl) = &(q)->root_rl; (rl); (rl) = __blk_queue_next_rl((rl), (q)))
373
edcb0722
TH
374/**
375 * blkg_stat_add - add a value to a blkg_stat
376 * @stat: target blkg_stat
377 * @val: value to add
378 *
379 * Add @val to @stat. The caller is responsible for synchronizing calls to
380 * this function.
381 */
382static inline void blkg_stat_add(struct blkg_stat *stat, uint64_t val)
383{
384 u64_stats_update_begin(&stat->syncp);
385 stat->cnt += val;
386 u64_stats_update_end(&stat->syncp);
387}
388
389/**
390 * blkg_stat_read - read the current value of a blkg_stat
391 * @stat: blkg_stat to read
392 *
393 * Read the current value of @stat. This function can be called without
394 * synchroniztion and takes care of u64 atomicity.
395 */
396static inline uint64_t blkg_stat_read(struct blkg_stat *stat)
397{
398 unsigned int start;
399 uint64_t v;
400
401 do {
950cda7f 402 start = u64_stats_fetch_begin_bh(&stat->syncp);
edcb0722 403 v = stat->cnt;
950cda7f 404 } while (u64_stats_fetch_retry_bh(&stat->syncp, start));
edcb0722
TH
405
406 return v;
407}
408
409/**
410 * blkg_stat_reset - reset a blkg_stat
411 * @stat: blkg_stat to reset
412 */
413static inline void blkg_stat_reset(struct blkg_stat *stat)
414{
415 stat->cnt = 0;
416}
417
16b3de66
TH
418/**
419 * blkg_stat_merge - merge a blkg_stat into another
420 * @to: the destination blkg_stat
421 * @from: the source
422 *
423 * Add @from's count to @to.
424 */
425static inline void blkg_stat_merge(struct blkg_stat *to, struct blkg_stat *from)
426{
427 blkg_stat_add(to, blkg_stat_read(from));
428}
429
edcb0722
TH
430/**
431 * blkg_rwstat_add - add a value to a blkg_rwstat
432 * @rwstat: target blkg_rwstat
433 * @rw: mask of REQ_{WRITE|SYNC}
434 * @val: value to add
435 *
436 * Add @val to @rwstat. The counters are chosen according to @rw. The
437 * caller is responsible for synchronizing calls to this function.
438 */
439static inline void blkg_rwstat_add(struct blkg_rwstat *rwstat,
440 int rw, uint64_t val)
441{
442 u64_stats_update_begin(&rwstat->syncp);
443
444 if (rw & REQ_WRITE)
445 rwstat->cnt[BLKG_RWSTAT_WRITE] += val;
446 else
447 rwstat->cnt[BLKG_RWSTAT_READ] += val;
448 if (rw & REQ_SYNC)
449 rwstat->cnt[BLKG_RWSTAT_SYNC] += val;
450 else
451 rwstat->cnt[BLKG_RWSTAT_ASYNC] += val;
452
453 u64_stats_update_end(&rwstat->syncp);
454}
455
456/**
457 * blkg_rwstat_read - read the current values of a blkg_rwstat
458 * @rwstat: blkg_rwstat to read
459 *
460 * Read the current snapshot of @rwstat and return it as the return value.
461 * This function can be called without synchronization and takes care of
462 * u64 atomicity.
463 */
c94bed89 464static inline struct blkg_rwstat blkg_rwstat_read(struct blkg_rwstat *rwstat)
edcb0722
TH
465{
466 unsigned int start;
467 struct blkg_rwstat tmp;
468
469 do {
950cda7f 470 start = u64_stats_fetch_begin_bh(&rwstat->syncp);
edcb0722 471 tmp = *rwstat;
950cda7f 472 } while (u64_stats_fetch_retry_bh(&rwstat->syncp, start));
edcb0722
TH
473
474 return tmp;
475}
476
477/**
4d5e80a7 478 * blkg_rwstat_total - read the total count of a blkg_rwstat
edcb0722
TH
479 * @rwstat: blkg_rwstat to read
480 *
481 * Return the total count of @rwstat regardless of the IO direction. This
482 * function can be called without synchronization and takes care of u64
483 * atomicity.
484 */
4d5e80a7 485static inline uint64_t blkg_rwstat_total(struct blkg_rwstat *rwstat)
edcb0722
TH
486{
487 struct blkg_rwstat tmp = blkg_rwstat_read(rwstat);
488
489 return tmp.cnt[BLKG_RWSTAT_READ] + tmp.cnt[BLKG_RWSTAT_WRITE];
490}
491
492/**
493 * blkg_rwstat_reset - reset a blkg_rwstat
494 * @rwstat: blkg_rwstat to reset
495 */
496static inline void blkg_rwstat_reset(struct blkg_rwstat *rwstat)
497{
498 memset(rwstat->cnt, 0, sizeof(rwstat->cnt));
499}
500
16b3de66
TH
501/**
502 * blkg_rwstat_merge - merge a blkg_rwstat into another
503 * @to: the destination blkg_rwstat
504 * @from: the source
505 *
506 * Add @from's counts to @to.
507 */
508static inline void blkg_rwstat_merge(struct blkg_rwstat *to,
509 struct blkg_rwstat *from)
510{
511 struct blkg_rwstat v = blkg_rwstat_read(from);
512 int i;
513
514 u64_stats_update_begin(&to->syncp);
515 for (i = 0; i < BLKG_RWSTAT_NR; i++)
516 to->cnt[i] += v.cnt[i];
517 u64_stats_update_end(&to->syncp);
518}
519
36558c8a
TH
520#else /* CONFIG_BLK_CGROUP */
521
522struct cgroup;
b1208b56 523struct blkcg;
2f5ea477 524
f95a04af
TH
525struct blkg_policy_data {
526};
527
3c798398 528struct blkcg_gq {
2f5ea477
JA
529};
530
3c798398 531struct blkcg_policy {
3e252066
VG
532};
533
3c798398 534static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg, void *key) { return NULL; }
5efd6113
TH
535static inline int blkcg_init_queue(struct request_queue *q) { return 0; }
536static inline void blkcg_drain_queue(struct request_queue *q) { }
537static inline void blkcg_exit_queue(struct request_queue *q) { }
3c798398
TH
538static inline int blkcg_policy_register(struct blkcg_policy *pol) { return 0; }
539static inline void blkcg_policy_unregister(struct blkcg_policy *pol) { }
a2b1693b 540static inline int blkcg_activate_policy(struct request_queue *q,
3c798398 541 const struct blkcg_policy *pol) { return 0; }
a2b1693b 542static inline void blkcg_deactivate_policy(struct request_queue *q,
3c798398
TH
543 const struct blkcg_policy *pol) { }
544
b1208b56
TH
545static inline struct blkcg *cgroup_to_blkcg(struct cgroup *cgroup) { return NULL; }
546static inline struct blkcg *bio_blkcg(struct bio *bio) { return NULL; }
a051661c 547
f95a04af
TH
548static inline struct blkg_policy_data *blkg_to_pd(struct blkcg_gq *blkg,
549 struct blkcg_policy *pol) { return NULL; }
550static inline struct blkcg_gq *pd_to_blkg(struct blkg_policy_data *pd) { return NULL; }
3c798398
TH
551static inline char *blkg_path(struct blkcg_gq *blkg) { return NULL; }
552static inline void blkg_get(struct blkcg_gq *blkg) { }
553static inline void blkg_put(struct blkcg_gq *blkg) { }
afc24d49 554
a051661c
TH
555static inline struct request_list *blk_get_rl(struct request_queue *q,
556 struct bio *bio) { return &q->root_rl; }
557static inline void blk_put_rl(struct request_list *rl) { }
558static inline void blk_rq_set_rl(struct request *rq, struct request_list *rl) { }
559static inline struct request_list *blk_rq_rl(struct request *rq) { return &rq->q->root_rl; }
560
561#define blk_queue_for_each_rl(rl, q) \
562 for ((rl) = &(q)->root_rl; (rl); (rl) = NULL)
563
36558c8a
TH
564#endif /* CONFIG_BLK_CGROUP */
565#endif /* _BLK_CGROUP_H */