blkcg: mass rename of blkcg API
[GitHub/LineageOS/android_kernel_motorola_exynos9610.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>
31e4c28d 19
9355aede
VG
20/* Max limits for throttle policy */
21#define THROTL_IOPS_MAX UINT_MAX
22
3381cb8d
TH
23/* CFQ specific, out here for blkcg->cfq_weight */
24#define CFQ_WEIGHT_MIN 10
25#define CFQ_WEIGHT_MAX 1000
26#define CFQ_WEIGHT_DEFAULT 500
27
f48ec1d7
TH
28#ifdef CONFIG_BLK_CGROUP
29
edcb0722
TH
30enum blkg_rwstat_type {
31 BLKG_RWSTAT_READ,
32 BLKG_RWSTAT_WRITE,
33 BLKG_RWSTAT_SYNC,
34 BLKG_RWSTAT_ASYNC,
35
36 BLKG_RWSTAT_NR,
37 BLKG_RWSTAT_TOTAL = BLKG_RWSTAT_NR,
303a3acb
DS
38};
39
3c798398 40struct blkcg {
36558c8a
TH
41 struct cgroup_subsys_state css;
42 spinlock_t lock;
43 struct hlist_head blkg_list;
9a9e8a26
TH
44
45 /* for policies to test whether associated blkcg has changed */
36558c8a 46 uint64_t id;
3381cb8d 47
3c798398 48 /* TODO: per-policy storage in blkcg */
36558c8a 49 unsigned int cfq_weight; /* belongs to cfq */
31e4c28d
VG
50};
51
edcb0722
TH
52struct blkg_stat {
53 struct u64_stats_sync syncp;
54 uint64_t cnt;
55};
56
57struct blkg_rwstat {
58 struct u64_stats_sync syncp;
59 uint64_t cnt[BLKG_RWSTAT_NR];
60};
61
0381411e
TH
62/* per-blkg per-policy data */
63struct blkg_policy_data {
64 /* the blkg this per-policy data belongs to */
3c798398 65 struct blkcg_gq *blkg;
0381411e 66
a2b1693b 67 /* used during policy activation */
36558c8a 68 struct list_head alloc_node;
a2b1693b 69
0381411e 70 /* pol->pdata_size bytes of private data used by policy impl */
36558c8a 71 char pdata[] __aligned(__alignof__(unsigned long long));
0381411e
TH
72};
73
3c798398
TH
74/* association between a blk cgroup and a request queue */
75struct blkcg_gq {
c875f4d0 76 /* Pointer to the associated request_queue */
36558c8a
TH
77 struct request_queue *q;
78 struct list_head q_node;
79 struct hlist_node blkcg_node;
3c798398 80 struct blkcg *blkcg;
1adaf3dd 81 /* reference count */
36558c8a 82 int refcnt;
22084190 83
36558c8a 84 struct blkg_policy_data *pd[BLKCG_MAX_POLS];
1adaf3dd 85
36558c8a 86 struct rcu_head rcu_head;
31e4c28d
VG
87};
88
3c798398
TH
89typedef void (blkcg_pol_init_pd_fn)(struct blkcg_gq *blkg);
90typedef void (blkcg_pol_exit_pd_fn)(struct blkcg_gq *blkg);
91typedef void (blkcg_pol_reset_pd_stats_fn)(struct blkcg_gq *blkg);
3e252066 92
3c798398
TH
93struct blkcg_policy_ops {
94 blkcg_pol_init_pd_fn *pd_init_fn;
95 blkcg_pol_exit_pd_fn *pd_exit_fn;
96 blkcg_pol_reset_pd_stats_fn *pd_reset_stats_fn;
3e252066
VG
97};
98
3c798398
TH
99struct blkcg_policy {
100 struct blkcg_policy_ops ops;
36558c8a
TH
101 int plid;
102 /* policy specific private data size */
103 size_t pdata_size;
104 /* cgroup files for the policy */
105 struct cftype *cftypes;
3e252066
VG
106};
107
3c798398 108extern struct blkcg blkcg_root;
36558c8a 109
3c798398
TH
110struct blkcg *cgroup_to_blkcg(struct cgroup *cgroup);
111struct blkcg *bio_blkcg(struct bio *bio);
112struct blkcg_gq *blkg_lookup(struct blkcg *blkcg, struct request_queue *q);
113struct blkcg_gq *blkg_lookup_create(struct blkcg *blkcg,
114 struct request_queue *q);
36558c8a
TH
115int blkcg_init_queue(struct request_queue *q);
116void blkcg_drain_queue(struct request_queue *q);
117void blkcg_exit_queue(struct request_queue *q);
5efd6113 118
3e252066 119/* Blkio controller policy registration */
3c798398
TH
120int blkcg_policy_register(struct blkcg_policy *pol);
121void blkcg_policy_unregister(struct blkcg_policy *pol);
36558c8a 122int blkcg_activate_policy(struct request_queue *q,
3c798398 123 const struct blkcg_policy *pol);
36558c8a 124void blkcg_deactivate_policy(struct request_queue *q,
3c798398 125 const struct blkcg_policy *pol);
3e252066 126
3c798398 127void blkcg_print_blkgs(struct seq_file *sf, struct blkcg *blkcg,
d366e7ec 128 u64 (*prfill)(struct seq_file *, void *, int),
3c798398 129 const struct blkcg_policy *pol, int data,
ec399347 130 bool show_total);
d366e7ec
TH
131u64 __blkg_prfill_u64(struct seq_file *sf, void *pdata, u64 v);
132u64 __blkg_prfill_rwstat(struct seq_file *sf, void *pdata,
829fdb50 133 const struct blkg_rwstat *rwstat);
5bc4afb1
TH
134u64 blkg_prfill_stat(struct seq_file *sf, void *pdata, int off);
135u64 blkg_prfill_rwstat(struct seq_file *sf, void *pdata, int off);
829fdb50
TH
136
137struct blkg_conf_ctx {
36558c8a 138 struct gendisk *disk;
3c798398 139 struct blkcg_gq *blkg;
36558c8a 140 u64 v;
829fdb50
TH
141};
142
3c798398
TH
143int blkg_conf_prep(struct blkcg *blkcg, const struct blkcg_policy *pol,
144 const char *input, struct blkg_conf_ctx *ctx);
829fdb50
TH
145void blkg_conf_finish(struct blkg_conf_ctx *ctx);
146
147
0381411e
TH
148/**
149 * blkg_to_pdata - get policy private data
150 * @blkg: blkg of interest
151 * @pol: policy of interest
152 *
153 * Return pointer to private data associated with the @blkg-@pol pair.
154 */
3c798398
TH
155static inline void *blkg_to_pdata(struct blkcg_gq *blkg,
156 struct blkcg_policy *pol)
0381411e 157{
549d3aa8 158 return blkg ? blkg->pd[pol->plid]->pdata : NULL;
0381411e
TH
159}
160
161/**
162 * pdata_to_blkg - get blkg associated with policy private data
163 * @pdata: policy private data of interest
0381411e 164 *
aaec55a0 165 * @pdata is policy private data. Determine the blkg it's associated with.
0381411e 166 */
3c798398 167static inline struct blkcg_gq *pdata_to_blkg(void *pdata)
0381411e
TH
168{
169 if (pdata) {
170 struct blkg_policy_data *pd =
171 container_of(pdata, struct blkg_policy_data, pdata);
172 return pd->blkg;
173 }
174 return NULL;
175}
176
54e7ed12
TH
177/**
178 * blkg_path - format cgroup path of blkg
179 * @blkg: blkg of interest
180 * @buf: target buffer
181 * @buflen: target buffer length
182 *
183 * Format the path of the cgroup of @blkg into @buf.
184 */
3c798398 185static inline int blkg_path(struct blkcg_gq *blkg, char *buf, int buflen)
afc24d49 186{
54e7ed12
TH
187 int ret;
188
189 rcu_read_lock();
190 ret = cgroup_path(blkg->blkcg->css.cgroup, buf, buflen);
191 rcu_read_unlock();
192 if (ret)
193 strncpy(buf, "<unavailable>", buflen);
194 return ret;
afc24d49
VG
195}
196
1adaf3dd
TH
197/**
198 * blkg_get - get a blkg reference
199 * @blkg: blkg to get
200 *
201 * The caller should be holding queue_lock and an existing reference.
202 */
3c798398 203static inline void blkg_get(struct blkcg_gq *blkg)
1adaf3dd
TH
204{
205 lockdep_assert_held(blkg->q->queue_lock);
206 WARN_ON_ONCE(!blkg->refcnt);
207 blkg->refcnt++;
208}
209
3c798398 210void __blkg_release(struct blkcg_gq *blkg);
1adaf3dd
TH
211
212/**
213 * blkg_put - put a blkg reference
214 * @blkg: blkg to put
215 *
216 * The caller should be holding queue_lock.
217 */
3c798398 218static inline void blkg_put(struct blkcg_gq *blkg)
1adaf3dd
TH
219{
220 lockdep_assert_held(blkg->q->queue_lock);
221 WARN_ON_ONCE(blkg->refcnt <= 0);
222 if (!--blkg->refcnt)
223 __blkg_release(blkg);
224}
225
edcb0722
TH
226/**
227 * blkg_stat_add - add a value to a blkg_stat
228 * @stat: target blkg_stat
229 * @val: value to add
230 *
231 * Add @val to @stat. The caller is responsible for synchronizing calls to
232 * this function.
233 */
234static inline void blkg_stat_add(struct blkg_stat *stat, uint64_t val)
235{
236 u64_stats_update_begin(&stat->syncp);
237 stat->cnt += val;
238 u64_stats_update_end(&stat->syncp);
239}
240
241/**
242 * blkg_stat_read - read the current value of a blkg_stat
243 * @stat: blkg_stat to read
244 *
245 * Read the current value of @stat. This function can be called without
246 * synchroniztion and takes care of u64 atomicity.
247 */
248static inline uint64_t blkg_stat_read(struct blkg_stat *stat)
249{
250 unsigned int start;
251 uint64_t v;
252
253 do {
254 start = u64_stats_fetch_begin(&stat->syncp);
255 v = stat->cnt;
256 } while (u64_stats_fetch_retry(&stat->syncp, start));
257
258 return v;
259}
260
261/**
262 * blkg_stat_reset - reset a blkg_stat
263 * @stat: blkg_stat to reset
264 */
265static inline void blkg_stat_reset(struct blkg_stat *stat)
266{
267 stat->cnt = 0;
268}
269
270/**
271 * blkg_rwstat_add - add a value to a blkg_rwstat
272 * @rwstat: target blkg_rwstat
273 * @rw: mask of REQ_{WRITE|SYNC}
274 * @val: value to add
275 *
276 * Add @val to @rwstat. The counters are chosen according to @rw. The
277 * caller is responsible for synchronizing calls to this function.
278 */
279static inline void blkg_rwstat_add(struct blkg_rwstat *rwstat,
280 int rw, uint64_t val)
281{
282 u64_stats_update_begin(&rwstat->syncp);
283
284 if (rw & REQ_WRITE)
285 rwstat->cnt[BLKG_RWSTAT_WRITE] += val;
286 else
287 rwstat->cnt[BLKG_RWSTAT_READ] += val;
288 if (rw & REQ_SYNC)
289 rwstat->cnt[BLKG_RWSTAT_SYNC] += val;
290 else
291 rwstat->cnt[BLKG_RWSTAT_ASYNC] += val;
292
293 u64_stats_update_end(&rwstat->syncp);
294}
295
296/**
297 * blkg_rwstat_read - read the current values of a blkg_rwstat
298 * @rwstat: blkg_rwstat to read
299 *
300 * Read the current snapshot of @rwstat and return it as the return value.
301 * This function can be called without synchronization and takes care of
302 * u64 atomicity.
303 */
c94bed89 304static inline struct blkg_rwstat blkg_rwstat_read(struct blkg_rwstat *rwstat)
edcb0722
TH
305{
306 unsigned int start;
307 struct blkg_rwstat tmp;
308
309 do {
310 start = u64_stats_fetch_begin(&rwstat->syncp);
311 tmp = *rwstat;
312 } while (u64_stats_fetch_retry(&rwstat->syncp, start));
313
314 return tmp;
315}
316
317/**
318 * blkg_rwstat_sum - read the total count of a blkg_rwstat
319 * @rwstat: blkg_rwstat to read
320 *
321 * Return the total count of @rwstat regardless of the IO direction. This
322 * function can be called without synchronization and takes care of u64
323 * atomicity.
324 */
325static inline uint64_t blkg_rwstat_sum(struct blkg_rwstat *rwstat)
326{
327 struct blkg_rwstat tmp = blkg_rwstat_read(rwstat);
328
329 return tmp.cnt[BLKG_RWSTAT_READ] + tmp.cnt[BLKG_RWSTAT_WRITE];
330}
331
332/**
333 * blkg_rwstat_reset - reset a blkg_rwstat
334 * @rwstat: blkg_rwstat to reset
335 */
336static inline void blkg_rwstat_reset(struct blkg_rwstat *rwstat)
337{
338 memset(rwstat->cnt, 0, sizeof(rwstat->cnt));
339}
340
36558c8a
TH
341#else /* CONFIG_BLK_CGROUP */
342
343struct cgroup;
2f5ea477 344
3c798398 345struct blkcg_gq {
2f5ea477
JA
346};
347
3c798398 348struct blkcg_policy {
3e252066
VG
349};
350
3c798398
TH
351static inline struct blkcg *cgroup_to_blkcg(struct cgroup *cgroup) { return NULL; }
352static inline struct blkcg *bio_blkcg(struct bio *bio) { return NULL; }
353static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg, void *key) { return NULL; }
5efd6113
TH
354static inline int blkcg_init_queue(struct request_queue *q) { return 0; }
355static inline void blkcg_drain_queue(struct request_queue *q) { }
356static inline void blkcg_exit_queue(struct request_queue *q) { }
3c798398
TH
357static inline int blkcg_policy_register(struct blkcg_policy *pol) { return 0; }
358static inline void blkcg_policy_unregister(struct blkcg_policy *pol) { }
a2b1693b 359static inline int blkcg_activate_policy(struct request_queue *q,
3c798398 360 const struct blkcg_policy *pol) { return 0; }
a2b1693b 361static inline void blkcg_deactivate_policy(struct request_queue *q,
3c798398
TH
362 const struct blkcg_policy *pol) { }
363
364static inline void *blkg_to_pdata(struct blkcg_gq *blkg,
365 struct blkcg_policy *pol) { return NULL; }
366static inline struct blkcg_gq *pdata_to_blkg(void *pdata,
367 struct blkcg_policy *pol) { return NULL; }
368static inline char *blkg_path(struct blkcg_gq *blkg) { return NULL; }
369static inline void blkg_get(struct blkcg_gq *blkg) { }
370static inline void blkg_put(struct blkcg_gq *blkg) { }
afc24d49 371
36558c8a
TH
372#endif /* CONFIG_BLK_CGROUP */
373#endif /* _BLK_CGROUP_H */