shrinker.h 2.4 KB
Newer Older
1 2 3 4 5 6
#ifndef _LINUX_SHRINKER_H
#define _LINUX_SHRINKER_H

/*
 * This struct is used to pass information from page reclaim to the shrinkers.
 * We consolidate the values for easier extention later.
Dave Chinner's avatar
Dave Chinner committed
7 8 9
 *
 * The 'gfpmask' refers to the allocation we are currently trying to
 * fulfil.
10 11 12 13
 */
struct shrink_control {
	gfp_t gfp_mask;

14 15 16 17 18
	/*
	 * How many objects scan_objects should scan and try to reclaim.
	 * This is reset before every call, so it is safe for callees
	 * to modify.
	 */
19
	unsigned long nr_to_scan;
20

21 22
	/* current node being shrunk (for NUMA aware shrinkers) */
	int nid;
23 24 25

	/* current memcg being shrunk (for memcg aware shrinkers) */
	struct mem_cgroup *memcg;
26 27
};

Dave Chinner's avatar
Dave Chinner committed
28
#define SHRINK_STOP (~0UL)
29 30 31
/*
 * A callback you can register to apply pressure to ageable caches.
 *
Dave Chinner's avatar
Dave Chinner committed
32 33 34 35 36 37
 * @count_objects should return the number of freeable items in the cache. If
 * there are no objects to free or the number of freeable items cannot be
 * determined, it should return 0. No deadlock checks should be done during the
 * count callback - the shrinker relies on aggregating scan counts that couldn't
 * be executed due to potential deadlocks to be run at a later call when the
 * deadlock condition is no longer pending.
38
 *
Dave Chinner's avatar
Dave Chinner committed
39 40 41 42 43 44 45
 * @scan_objects will only be called if @count_objects returned a non-zero
 * value for the number of freeable objects. The callout should scan the cache
 * and attempt to free items from the cache. It should then return the number
 * of objects freed during the scan, or SHRINK_STOP if progress cannot be made
 * due to potential deadlocks. If SHRINK_STOP is returned, then no further
 * attempts to call the @scan_objects will be made from the current reclaim
 * context.
46 47
 *
 * @flags determine the shrinker abilities, like numa awareness
48 49
 */
struct shrinker {
Dave Chinner's avatar
Dave Chinner committed
50 51 52 53 54
	unsigned long (*count_objects)(struct shrinker *,
				       struct shrink_control *sc);
	unsigned long (*scan_objects)(struct shrinker *,
				      struct shrink_control *sc);

55 56
	int seeks;	/* seeks to recreate an obj */
	long batch;	/* reclaim batch size, 0 = default */
57
	unsigned long flags;
58 59 60

	/* These are for internal use */
	struct list_head list;
61 62
	/* objs pending delete, per node */
	atomic_long_t *nr_deferred;
63 64
};
#define DEFAULT_SEEKS 2 /* A good number if you don't know better. */
65 66

/* Flags */
67 68
#define SHRINKER_NUMA_AWARE	(1 << 0)
#define SHRINKER_MEMCG_AWARE	(1 << 1)
69 70

extern int register_shrinker(struct shrinker *);
71 72
extern void unregister_shrinker(struct shrinker *);
#endif