1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _LINUX_SHRINKER_H
3#define _LINUX_SHRINKER_H
4
5/*
6 * This struct is used to pass information from page reclaim to the shrinkers.
7 * We consolidate the values for easier extension later.
8 *
9 * The 'gfpmask' refers to the allocation we are currently trying to
10 * fulfil.
11 */
12struct shrink_control {
13 gfp_t gfp_mask;
14
15 /* current node being shrunk (for NUMA aware shrinkers) */
16 int nid;
17
18 /*
19 * How many objects scan_objects should scan and try to reclaim.
20 * This is reset before every call, so it is safe for callees
21 * to modify.
22 */
23 unsigned long nr_to_scan;
24
25 /*
26 * How many objects did scan_objects process?
27 * This defaults to nr_to_scan before every call, but the callee
28 * should track its actual progress.
29 */
30 unsigned long nr_scanned;
31
32 /* current memcg being shrunk (for memcg aware shrinkers) */
33 struct mem_cgroup *memcg;
34};
35
36#define SHRINK_STOP (~0UL)
37#define SHRINK_EMPTY (~0UL - 1)
38/*
39 * A callback you can register to apply pressure to ageable caches.
40 *
41 * @count_objects should return the number of freeable items in the cache. If
42 * there are no objects to free, it should return SHRINK_EMPTY, while 0 is
43 * returned in cases of the number of freeable items cannot be determined
44 * or shrinker should skip this cache for this time (e.g., their number
45 * is below shrinkable limit). No deadlock checks should be done during the
46 * count callback - the shrinker relies on aggregating scan counts that couldn't
47 * be executed due to potential deadlocks to be run at a later call when the
48 * deadlock condition is no longer pending.
49 *
50 * @scan_objects will only be called if @count_objects returned a non-zero
51 * value for the number of freeable objects. The callout should scan the cache
52 * and attempt to free items from the cache. It should then return the number
53 * of objects freed during the scan, or SHRINK_STOP if progress cannot be made
54 * due to potential deadlocks. If SHRINK_STOP is returned, then no further
55 * attempts to call the @scan_objects will be made from the current reclaim
56 * context.
57 *
58 * @flags determine the shrinker abilities, like numa awareness
59 */
60struct shrinker {
61 unsigned long (*count_objects)(struct shrinker *,
62 struct shrink_control *sc);
63 unsigned long (*scan_objects)(struct shrinker *,
64 struct shrink_control *sc);
65
66 long batch; /* reclaim batch size, 0 = default */
67 int seeks; /* seeks to recreate an obj */
68 unsigned flags;
69
70 /* These are for internal use */
71 struct list_head list;
72#ifdef CONFIG_MEMCG
73 /* ID in shrinker_idr */
74 int id;
75#endif
76#ifdef CONFIG_SHRINKER_DEBUG
77 int debugfs_id;
78 const char *name;
79 struct dentry *debugfs_entry;
80#endif
81 /* objs pending delete, per node */
82 atomic_long_t *nr_deferred;
83};
84#define DEFAULT_SEEKS 2 /* A good number if you don't know better. */
85
86/* Flags */
87#define SHRINKER_REGISTERED (1 << 0)
88#define SHRINKER_NUMA_AWARE (1 << 1)
89#define SHRINKER_MEMCG_AWARE (1 << 2)
90/*
91 * It just makes sense when the shrinker is also MEMCG_AWARE for now,
92 * non-MEMCG_AWARE shrinker should not have this flag set.
93 */
94#define SHRINKER_NONSLAB (1 << 3)
95
96extern int __printf(2, 3) prealloc_shrinker(struct shrinker *shrinker,
97 const char *fmt, ...);
98extern void register_shrinker_prepared(struct shrinker *shrinker);
99extern int __printf(2, 3) register_shrinker(struct shrinker *shrinker,
100 const char *fmt, ...);
101extern void unregister_shrinker(struct shrinker *shrinker);
102extern void free_prealloced_shrinker(struct shrinker *shrinker);
103extern void synchronize_shrinkers(void);
104
105#ifdef CONFIG_SHRINKER_DEBUG
106extern int shrinker_debugfs_add(struct shrinker *shrinker);
107extern void shrinker_debugfs_remove(struct shrinker *shrinker);
108extern int __printf(2, 3) shrinker_debugfs_rename(struct shrinker *shrinker,
109 const char *fmt, ...);
110#else /* CONFIG_SHRINKER_DEBUG */
111static inline int shrinker_debugfs_add(struct shrinker *shrinker)
112{
113 return 0;
114}
115static inline void shrinker_debugfs_remove(struct shrinker *shrinker)
116{
117}
118static inline __printf(2, 3)
119int shrinker_debugfs_rename(struct shrinker *shrinker, const char *fmt, ...)
120{
121 return 0;
122}
123#endif /* CONFIG_SHRINKER_DEBUG */
124#endif /* _LINUX_SHRINKER_H */
125

source code of linux/include/linux/shrinker.h