xref: /linux/mm/shrinker.c (revision bba2c3615bd6cfee7456d1130f2e6b01b3f4e9ba)
1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/memcontrol.h>
3 #include <linux/rwsem.h>
4 #include <linux/shrinker.h>
5 #include <linux/rculist.h>
6 #include <trace/events/vmscan.h>
7 
8 #include "internal.h"
9 
10 LIST_HEAD(shrinker_list);
11 DEFINE_MUTEX(shrinker_mutex);
12 
13 #ifdef CONFIG_MEMCG
14 static int shrinker_nr_max;
15 
16 static inline int shrinker_unit_size(int nr_items)
17 {
18 	return (DIV_ROUND_UP(nr_items, SHRINKER_UNIT_BITS) * sizeof(struct shrinker_info_unit *));
19 }
20 
21 static inline void shrinker_unit_free(struct shrinker_info *info, int start)
22 {
23 	struct shrinker_info_unit **unit;
24 	int nr, i;
25 
26 	if (!info)
27 		return;
28 
29 	unit = info->unit;
30 	nr = DIV_ROUND_UP(info->map_nr_max, SHRINKER_UNIT_BITS);
31 
32 	for (i = start; i < nr; i++) {
33 		if (!unit[i])
34 			break;
35 
36 		kfree(unit[i]);
37 		unit[i] = NULL;
38 	}
39 }
40 
41 static inline int shrinker_unit_alloc(struct shrinker_info *new,
42 				       struct shrinker_info *old, int nid)
43 {
44 	struct shrinker_info_unit *unit;
45 	int nr = DIV_ROUND_UP(new->map_nr_max, SHRINKER_UNIT_BITS);
46 	int start = old ? DIV_ROUND_UP(old->map_nr_max, SHRINKER_UNIT_BITS) : 0;
47 	int i;
48 
49 	for (i = start; i < nr; i++) {
50 		unit = kzalloc_node(sizeof(*unit), GFP_KERNEL, nid);
51 		if (!unit) {
52 			shrinker_unit_free(new, start);
53 			return -ENOMEM;
54 		}
55 
56 		new->unit[i] = unit;
57 	}
58 
59 	return 0;
60 }
61 
62 void free_shrinker_info(struct mem_cgroup *memcg)
63 {
64 	struct mem_cgroup_per_node *pn;
65 	struct shrinker_info *info;
66 	int nid;
67 
68 	for_each_node(nid) {
69 		pn = memcg->nodeinfo[nid];
70 		info = rcu_dereference_protected(pn->shrinker_info, true);
71 		shrinker_unit_free(info, 0);
72 		kvfree(info);
73 		rcu_assign_pointer(pn->shrinker_info, NULL);
74 	}
75 }
76 
77 int alloc_shrinker_info(struct mem_cgroup *memcg)
78 {
79 	int nid, ret = 0;
80 	int array_size = 0;
81 
82 	mutex_lock(&shrinker_mutex);
83 	array_size = shrinker_unit_size(shrinker_nr_max);
84 	for_each_node(nid) {
85 		struct shrinker_info *info = kvzalloc_node(sizeof(*info) + array_size,
86 							   GFP_KERNEL, nid);
87 		if (!info)
88 			goto err;
89 		info->map_nr_max = shrinker_nr_max;
90 		if (shrinker_unit_alloc(info, NULL, nid)) {
91 			kvfree(info);
92 			goto err;
93 		}
94 		rcu_assign_pointer(memcg->nodeinfo[nid]->shrinker_info, info);
95 	}
96 	mutex_unlock(&shrinker_mutex);
97 
98 	return ret;
99 
100 err:
101 	mutex_unlock(&shrinker_mutex);
102 	free_shrinker_info(memcg);
103 	return -ENOMEM;
104 }
105 
106 static struct shrinker_info *shrinker_info_protected(struct mem_cgroup *memcg,
107 						     int nid)
108 {
109 	return rcu_dereference_protected(memcg->nodeinfo[nid]->shrinker_info,
110 					 lockdep_is_held(&shrinker_mutex));
111 }
112 
113 static int expand_one_shrinker_info(struct mem_cgroup *memcg, int new_size,
114 				    int old_size, int new_nr_max)
115 {
116 	struct shrinker_info *new, *old;
117 	struct mem_cgroup_per_node *pn;
118 	int nid;
119 
120 	for_each_node(nid) {
121 		pn = memcg->nodeinfo[nid];
122 		old = shrinker_info_protected(memcg, nid);
123 		/* Not yet online memcg */
124 		if (!old)
125 			return 0;
126 
127 		/* Already expanded this shrinker_info */
128 		if (new_nr_max <= old->map_nr_max)
129 			continue;
130 
131 		new = kvzalloc_node(sizeof(*new) + new_size, GFP_KERNEL, nid);
132 		if (!new)
133 			return -ENOMEM;
134 
135 		new->map_nr_max = new_nr_max;
136 
137 		memcpy(new->unit, old->unit, old_size);
138 		if (shrinker_unit_alloc(new, old, nid)) {
139 			kvfree(new);
140 			return -ENOMEM;
141 		}
142 
143 		rcu_assign_pointer(pn->shrinker_info, new);
144 		kvfree_rcu(old, rcu);
145 	}
146 
147 	return 0;
148 }
149 
150 static int expand_shrinker_info(int new_id)
151 {
152 	int ret = 0;
153 	int new_nr_max = round_up(new_id + 1, SHRINKER_UNIT_BITS);
154 	int new_size, old_size = 0;
155 	struct mem_cgroup *memcg;
156 
157 	if (!root_mem_cgroup)
158 		goto out;
159 
160 	lockdep_assert_held(&shrinker_mutex);
161 
162 	new_size = shrinker_unit_size(new_nr_max);
163 	old_size = shrinker_unit_size(shrinker_nr_max);
164 
165 	memcg = mem_cgroup_iter(NULL, NULL, NULL);
166 	do {
167 		ret = expand_one_shrinker_info(memcg, new_size, old_size,
168 					       new_nr_max);
169 		if (ret) {
170 			mem_cgroup_iter_break(NULL, memcg);
171 			goto out;
172 		}
173 	} while ((memcg = mem_cgroup_iter(NULL, memcg, NULL)) != NULL);
174 out:
175 	if (!ret)
176 		shrinker_nr_max = new_nr_max;
177 
178 	return ret;
179 }
180 
181 static inline int shrinker_id_to_index(int shrinker_id)
182 {
183 	return shrinker_id / SHRINKER_UNIT_BITS;
184 }
185 
186 static inline int shrinker_id_to_offset(int shrinker_id)
187 {
188 	return shrinker_id % SHRINKER_UNIT_BITS;
189 }
190 
191 static inline int calc_shrinker_id(int index, int offset)
192 {
193 	return index * SHRINKER_UNIT_BITS + offset;
194 }
195 
196 void set_shrinker_bit(struct mem_cgroup *memcg, int nid, int shrinker_id)
197 {
198 	if (shrinker_id >= 0 && memcg && !mem_cgroup_is_root(memcg)) {
199 		struct shrinker_info *info;
200 
201 		rcu_read_lock();
202 		info = rcu_dereference(memcg->nodeinfo[nid]->shrinker_info);
203 		if (!WARN_ON_ONCE(shrinker_id >= info->map_nr_max)) {
204 			struct shrinker_info_unit *unit;
205 
206 			unit = info->unit[shrinker_id_to_index(shrinker_id)];
207 			/* Pairs with smp mb in shrink_slab() */
208 			smp_mb__before_atomic();
209 			set_bit(shrinker_id_to_offset(shrinker_id), unit->map);
210 		}
211 		rcu_read_unlock();
212 	}
213 }
214 
215 static DEFINE_IDR(shrinker_idr);
216 
217 static int shrinker_memcg_alloc(struct shrinker *shrinker)
218 {
219 	int id;
220 
221 	if (mem_cgroup_disabled())
222 		return -ENOSYS;
223 	if (mem_cgroup_kmem_disabled() && !(shrinker->flags & SHRINKER_NONSLAB))
224 		return -ENOSYS;
225 
226 	guard(mutex)(&shrinker_mutex);
227 	id = idr_alloc(&shrinker_idr, shrinker, 0, 0, GFP_KERNEL);
228 	if (id < 0)
229 		return id;
230 
231 	if (id >= shrinker_nr_max) {
232 		if (expand_shrinker_info(id)) {
233 			idr_remove(&shrinker_idr, id);
234 			return -ENOMEM;
235 		}
236 	}
237 	shrinker->id = id;
238 	return 0;
239 }
240 
241 static void shrinker_memcg_remove(struct shrinker *shrinker)
242 {
243 	int id = shrinker->id;
244 
245 	BUG_ON(id < 0);
246 
247 	lockdep_assert_held(&shrinker_mutex);
248 
249 	idr_remove(&shrinker_idr, id);
250 }
251 
252 static long xchg_nr_deferred_memcg(int nid, struct shrinker *shrinker,
253 				   struct mem_cgroup *memcg)
254 {
255 	struct shrinker_info *info;
256 	struct shrinker_info_unit *unit;
257 	long nr_deferred;
258 
259 	rcu_read_lock();
260 	info = rcu_dereference(memcg->nodeinfo[nid]->shrinker_info);
261 	unit = info->unit[shrinker_id_to_index(shrinker->id)];
262 	nr_deferred = atomic_long_xchg(&unit->nr_deferred[shrinker_id_to_offset(shrinker->id)], 0);
263 	rcu_read_unlock();
264 
265 	return nr_deferred;
266 }
267 
268 static long add_nr_deferred_memcg(long nr, int nid, struct shrinker *shrinker,
269 				  struct mem_cgroup *memcg)
270 {
271 	struct shrinker_info *info;
272 	struct shrinker_info_unit *unit;
273 	long nr_deferred;
274 
275 	rcu_read_lock();
276 	info = rcu_dereference(memcg->nodeinfo[nid]->shrinker_info);
277 	unit = info->unit[shrinker_id_to_index(shrinker->id)];
278 	nr_deferred =
279 		atomic_long_add_return(nr, &unit->nr_deferred[shrinker_id_to_offset(shrinker->id)]);
280 	rcu_read_unlock();
281 
282 	return nr_deferred;
283 }
284 
285 void reparent_shrinker_deferred(struct mem_cgroup *memcg)
286 {
287 	int nid, index, offset;
288 	long nr;
289 	struct mem_cgroup *parent = parent_mem_cgroup(memcg);
290 	struct shrinker_info *child_info, *parent_info;
291 	struct shrinker_info_unit *child_unit, *parent_unit;
292 
293 	/* Prevent from concurrent shrinker_info expand */
294 	mutex_lock(&shrinker_mutex);
295 	for_each_node(nid) {
296 		child_info = shrinker_info_protected(memcg, nid);
297 		parent_info = shrinker_info_protected(parent, nid);
298 		for (index = 0; index < shrinker_id_to_index(child_info->map_nr_max); index++) {
299 			child_unit = child_info->unit[index];
300 			parent_unit = parent_info->unit[index];
301 			for (offset = 0; offset < SHRINKER_UNIT_BITS; offset++) {
302 				nr = atomic_long_read(&child_unit->nr_deferred[offset]);
303 				atomic_long_add(nr, &parent_unit->nr_deferred[offset]);
304 			}
305 		}
306 	}
307 	mutex_unlock(&shrinker_mutex);
308 }
309 #else
310 static int shrinker_memcg_alloc(struct shrinker *shrinker)
311 {
312 	return -ENOSYS;
313 }
314 
315 static void shrinker_memcg_remove(struct shrinker *shrinker)
316 {
317 }
318 
319 static long xchg_nr_deferred_memcg(int nid, struct shrinker *shrinker,
320 				   struct mem_cgroup *memcg)
321 {
322 	return 0;
323 }
324 
325 static long add_nr_deferred_memcg(long nr, int nid, struct shrinker *shrinker,
326 				  struct mem_cgroup *memcg)
327 {
328 	return 0;
329 }
330 #endif /* CONFIG_MEMCG */
331 
332 static long xchg_nr_deferred(struct shrinker *shrinker,
333 			     struct shrink_control *sc)
334 {
335 	int nid = sc->nid;
336 
337 	if (!(shrinker->flags & SHRINKER_NUMA_AWARE))
338 		nid = 0;
339 
340 	if (sc->memcg &&
341 	    (shrinker->flags & SHRINKER_MEMCG_AWARE))
342 		return xchg_nr_deferred_memcg(nid, shrinker,
343 					      sc->memcg);
344 
345 	return atomic_long_xchg(&shrinker->nr_deferred[nid], 0);
346 }
347 
348 
349 static long add_nr_deferred(long nr, struct shrinker *shrinker,
350 			    struct shrink_control *sc)
351 {
352 	int nid = sc->nid;
353 
354 	if (!(shrinker->flags & SHRINKER_NUMA_AWARE))
355 		nid = 0;
356 
357 	if (sc->memcg &&
358 	    (shrinker->flags & SHRINKER_MEMCG_AWARE))
359 		return add_nr_deferred_memcg(nr, nid, shrinker,
360 					     sc->memcg);
361 
362 	return atomic_long_add_return(nr, &shrinker->nr_deferred[nid]);
363 }
364 
365 #define SHRINK_BATCH 128
366 
367 static unsigned long do_shrink_slab(struct shrink_control *shrinkctl,
368 				    struct shrinker *shrinker, int priority)
369 {
370 	unsigned long freed = 0;
371 	unsigned long long delta;
372 	long total_scan;
373 	long freeable;
374 	long nr;
375 	long new_nr;
376 	long batch_size = shrinker->batch ? shrinker->batch
377 					  : SHRINK_BATCH;
378 	long scanned = 0, next_deferred;
379 
380 	freeable = shrinker->count_objects(shrinker, shrinkctl);
381 	if (freeable == 0 || freeable == SHRINK_EMPTY)
382 		return freeable;
383 
384 	/*
385 	 * copy the current shrinker scan count into a local variable
386 	 * and zero it so that other concurrent shrinker invocations
387 	 * don't also do this scanning work.
388 	 */
389 	nr = xchg_nr_deferred(shrinker, shrinkctl);
390 
391 	if (shrinker->seeks) {
392 		delta = freeable >> priority;
393 		delta *= 4;
394 		do_div(delta, shrinker->seeks);
395 	} else {
396 		/*
397 		 * These objects don't require any IO to create. Trim
398 		 * them aggressively under memory pressure to keep
399 		 * them from causing refetches in the IO caches.
400 		 */
401 		delta = freeable / 2;
402 	}
403 
404 	total_scan = nr >> priority;
405 	total_scan += delta;
406 	total_scan = min(total_scan, (2 * freeable));
407 
408 	trace_mm_shrink_slab_start(shrinker, shrinkctl, nr,
409 				   freeable, delta, total_scan, priority,
410 				   shrinkctl->memcg);
411 
412 	/*
413 	 * Normally, we should not scan less than batch_size objects in one
414 	 * pass to avoid too frequent shrinker calls, but if the slab has less
415 	 * than batch_size objects in total and we are really tight on memory,
416 	 * we will try to reclaim all available objects, otherwise we can end
417 	 * up failing allocations although there are plenty of reclaimable
418 	 * objects spread over several slabs with usage less than the
419 	 * batch_size.
420 	 *
421 	 * We detect the "tight on memory" situations by looking at the total
422 	 * number of objects we want to scan (total_scan). If it is greater
423 	 * than the total number of objects on slab (freeable), we must be
424 	 * scanning at high prio and therefore should try to reclaim as much as
425 	 * possible.
426 	 */
427 	while (total_scan >= batch_size ||
428 	       total_scan >= freeable) {
429 		unsigned long ret;
430 		unsigned long nr_to_scan = min(batch_size, total_scan);
431 
432 		shrinkctl->nr_to_scan = nr_to_scan;
433 		shrinkctl->nr_scanned = nr_to_scan;
434 		ret = shrinker->scan_objects(shrinker, shrinkctl);
435 		if (ret == SHRINK_STOP)
436 			break;
437 		freed += ret;
438 
439 		count_vm_events(SLABS_SCANNED, shrinkctl->nr_scanned);
440 		total_scan -= shrinkctl->nr_scanned;
441 		scanned += shrinkctl->nr_scanned;
442 
443 		cond_resched();
444 	}
445 
446 	/*
447 	 * The deferred work is increased by any new work (delta) that wasn't
448 	 * done, decreased by old deferred work that was done now.
449 	 *
450 	 * And it is capped to two times of the freeable items.
451 	 */
452 	next_deferred = max_t(long, (nr + delta - scanned), 0);
453 	next_deferred = min(next_deferred, (2 * freeable));
454 
455 	/*
456 	 * move the unused scan count back into the shrinker in a
457 	 * manner that handles concurrent updates.
458 	 */
459 	new_nr = add_nr_deferred(next_deferred, shrinker, shrinkctl);
460 
461 	trace_mm_shrink_slab_end(shrinker, shrinkctl->nid, freed, nr, new_nr, total_scan,
462 				 shrinkctl->memcg);
463 	return freed;
464 }
465 
466 #ifdef CONFIG_MEMCG
467 static unsigned long shrink_slab_memcg(gfp_t gfp_mask, int nid,
468 			struct mem_cgroup *memcg, int priority)
469 {
470 	struct shrinker_info *info;
471 	unsigned long ret, freed = 0;
472 	int offset, index = 0;
473 
474 	if (!mem_cgroup_online(memcg))
475 		return 0;
476 
477 	/*
478 	 * lockless algorithm of memcg shrink.
479 	 *
480 	 * The shrinker_info may be freed asynchronously via RCU in the
481 	 * expand_one_shrinker_info(), so the rcu_read_lock() needs to be used
482 	 * to ensure the existence of the shrinker_info.
483 	 *
484 	 * The shrinker_info_unit is never freed unless its corresponding memcg
485 	 * is destroyed. Here we already hold the refcount of memcg, so the
486 	 * memcg will not be destroyed, and of course shrinker_info_unit will
487 	 * not be freed.
488 	 *
489 	 * So in the memcg shrink:
490 	 *  step 1: use rcu_read_lock() to guarantee existence of the
491 	 *          shrinker_info.
492 	 *  step 2: after getting shrinker_info_unit we can safely release the
493 	 *          RCU lock.
494 	 *  step 3: traverse the bitmap and calculate shrinker_id
495 	 *  step 4: use rcu_read_lock() to guarantee existence of the shrinker.
496 	 *  step 5: use shrinker_id to find the shrinker, then use
497 	 *          shrinker_try_get() to guarantee existence of the shrinker,
498 	 *          then we can release the RCU lock to do do_shrink_slab() that
499 	 *          may sleep.
500 	 *  step 6: do shrinker_put() paired with step 5 to put the refcount,
501 	 *          if the refcount reaches 0, then wake up the waiter in
502 	 *          shrinker_free() by calling complete().
503 	 *          Note: here is different from the global shrink, we don't
504 	 *                need to acquire the RCU lock to guarantee existence of
505 	 *                the shrinker, because we don't need to use this
506 	 *                shrinker to traverse the next shrinker in the bitmap.
507 	 *  step 7: we have already exited the read-side of rcu critical section
508 	 *          before calling do_shrink_slab(), the shrinker_info may be
509 	 *          released in expand_one_shrinker_info(), so go back to step 1
510 	 *          to reacquire the shrinker_info.
511 	 */
512 again:
513 	rcu_read_lock();
514 	info = rcu_dereference(memcg->nodeinfo[nid]->shrinker_info);
515 	if (unlikely(!info))
516 		goto unlock;
517 
518 	if (index < shrinker_id_to_index(info->map_nr_max)) {
519 		struct shrinker_info_unit *unit;
520 
521 		unit = info->unit[index];
522 
523 		rcu_read_unlock();
524 
525 		for_each_set_bit(offset, unit->map, SHRINKER_UNIT_BITS) {
526 			struct shrink_control sc = {
527 				.gfp_mask = gfp_mask,
528 				.nid = nid,
529 				.memcg = memcg,
530 			};
531 			struct shrinker *shrinker;
532 			int shrinker_id = calc_shrinker_id(index, offset);
533 
534 			rcu_read_lock();
535 			shrinker = idr_find(&shrinker_idr, shrinker_id);
536 			if (unlikely(!shrinker || !shrinker_try_get(shrinker))) {
537 				clear_bit(offset, unit->map);
538 				rcu_read_unlock();
539 				continue;
540 			}
541 			rcu_read_unlock();
542 
543 			/* Call non-slab shrinkers even though kmem is disabled */
544 			if (!memcg_kmem_online() &&
545 			    !(shrinker->flags & SHRINKER_NONSLAB)) {
546 				clear_bit(offset, unit->map);
547 				shrinker_put(shrinker);
548 				continue;
549 			}
550 
551 			ret = do_shrink_slab(&sc, shrinker, priority);
552 			if (ret == SHRINK_EMPTY) {
553 				clear_bit(offset, unit->map);
554 				/*
555 				 * After the shrinker reported that it had no objects to
556 				 * free, but before we cleared the corresponding bit in
557 				 * the memcg shrinker map, a new object might have been
558 				 * added. To make sure, we have the bit set in this
559 				 * case, we invoke the shrinker one more time and reset
560 				 * the bit if it reports that it is not empty anymore.
561 				 * The memory barrier here pairs with the barrier in
562 				 * set_shrinker_bit():
563 				 *
564 				 * list_lru_add()     shrink_slab_memcg()
565 				 *   list_add_tail()    clear_bit()
566 				 *   <MB>               <MB>
567 				 *   set_bit()          do_shrink_slab()
568 				 */
569 				smp_mb__after_atomic();
570 				ret = do_shrink_slab(&sc, shrinker, priority);
571 				if (ret == SHRINK_EMPTY)
572 					ret = 0;
573 				else
574 					set_shrinker_bit(memcg, nid, shrinker_id);
575 			}
576 			freed += ret;
577 			shrinker_put(shrinker);
578 		}
579 
580 		index++;
581 		goto again;
582 	}
583 unlock:
584 	rcu_read_unlock();
585 	return freed;
586 }
587 #else /* !CONFIG_MEMCG */
588 static unsigned long shrink_slab_memcg(gfp_t gfp_mask, int nid,
589 			struct mem_cgroup *memcg, int priority)
590 {
591 	return 0;
592 }
593 #endif /* CONFIG_MEMCG */
594 
595 /**
596  * shrink_slab - shrink slab caches
597  * @gfp_mask: allocation context
598  * @nid: node whose slab caches to target
599  * @memcg: memory cgroup whose slab caches to target
600  * @priority: the reclaim priority
601  *
602  * Call the shrink functions to age shrinkable caches.
603  *
604  * @nid is passed along to shrinkers with SHRINKER_NUMA_AWARE set,
605  * unaware shrinkers will receive a node id of 0 instead.
606  *
607  * @memcg specifies the memory cgroup to target. Unaware shrinkers
608  * are called only if it is the root cgroup.
609  *
610  * @priority is sc->priority, we take the number of objects and >> by priority
611  * in order to get the scan target.
612  *
613  * Returns the number of reclaimed slab objects.
614  */
615 unsigned long shrink_slab(gfp_t gfp_mask, int nid, struct mem_cgroup *memcg,
616 			  int priority)
617 {
618 	unsigned long ret, freed = 0;
619 	struct shrinker *shrinker;
620 
621 	/*
622 	 * The root memcg might be allocated even though memcg is disabled
623 	 * via "cgroup_disable=memory" boot parameter.  This could make
624 	 * mem_cgroup_is_root() return false, then just run memcg slab
625 	 * shrink, but skip global shrink.  This may result in premature
626 	 * oom.
627 	 */
628 	if (!mem_cgroup_disabled() && !mem_cgroup_is_root(memcg))
629 		return shrink_slab_memcg(gfp_mask, nid, memcg, priority);
630 
631 	/*
632 	 * lockless algorithm of global shrink.
633 	 *
634 	 * In the unregistration setp, the shrinker will be freed asynchronously
635 	 * via RCU after its refcount reaches 0. So both rcu_read_lock() and
636 	 * shrinker_try_get() can be used to ensure the existence of the shrinker.
637 	 *
638 	 * So in the global shrink:
639 	 *  step 1: use rcu_read_lock() to guarantee existence of the shrinker
640 	 *          and the validity of the shrinker_list walk.
641 	 *  step 2: use shrinker_try_get() to try get the refcount, if successful,
642 	 *          then the existence of the shrinker can also be guaranteed,
643 	 *          so we can release the RCU lock to do do_shrink_slab() that
644 	 *          may sleep.
645 	 *  step 3: *MUST* to reacquire the RCU lock before calling shrinker_put(),
646 	 *          which ensures that neither this shrinker nor the next shrinker
647 	 *          will be freed in the next traversal operation.
648 	 *  step 4: do shrinker_put() paired with step 2 to put the refcount,
649 	 *          if the refcount reaches 0, then wake up the waiter in
650 	 *          shrinker_free() by calling complete().
651 	 */
652 	rcu_read_lock();
653 	list_for_each_entry_rcu(shrinker, &shrinker_list, list) {
654 		struct shrink_control sc = {
655 			.gfp_mask = gfp_mask,
656 			.nid = nid,
657 			.memcg = memcg,
658 		};
659 
660 		if (!shrinker_try_get(shrinker))
661 			continue;
662 
663 		rcu_read_unlock();
664 
665 		ret = do_shrink_slab(&sc, shrinker, priority);
666 		if (ret == SHRINK_EMPTY)
667 			ret = 0;
668 		freed += ret;
669 
670 		rcu_read_lock();
671 		shrinker_put(shrinker);
672 	}
673 
674 	rcu_read_unlock();
675 	cond_resched();
676 	return freed;
677 }
678 
679 struct shrinker *shrinker_alloc(unsigned int flags, const char *fmt, ...)
680 {
681 	struct shrinker *shrinker;
682 	unsigned int size;
683 	va_list ap;
684 	int err;
685 
686 	shrinker = kzalloc_obj(struct shrinker);
687 	if (!shrinker)
688 		return NULL;
689 
690 	va_start(ap, fmt);
691 	err = shrinker_debugfs_name_alloc(shrinker, fmt, ap);
692 	va_end(ap);
693 	if (err)
694 		goto err_name;
695 
696 	shrinker->flags = flags | SHRINKER_ALLOCATED;
697 	shrinker->seeks = DEFAULT_SEEKS;
698 
699 	if (flags & SHRINKER_MEMCG_AWARE) {
700 		err = shrinker_memcg_alloc(shrinker);
701 		if (err == -ENOSYS) {
702 			/* Memcg is not supported, fallback to non-memcg-aware shrinker. */
703 			shrinker->flags &= ~SHRINKER_MEMCG_AWARE;
704 			goto non_memcg;
705 		}
706 
707 		if (err)
708 			goto err_flags;
709 
710 		return shrinker;
711 	}
712 
713 non_memcg:
714 	/*
715 	 * The nr_deferred is available on per memcg level for memcg aware
716 	 * shrinkers, so only allocate nr_deferred in the following cases:
717 	 *  - non-memcg-aware shrinkers
718 	 *  - !CONFIG_MEMCG
719 	 *  - memcg is disabled by kernel command line
720 	 *  - non-slab shrinkers: when memcg kmem is disabled
721 	 */
722 	size = sizeof(*shrinker->nr_deferred);
723 	if (flags & SHRINKER_NUMA_AWARE)
724 		size *= nr_node_ids;
725 
726 	shrinker->nr_deferred = kzalloc(size, GFP_KERNEL);
727 	if (!shrinker->nr_deferred)
728 		goto err_flags;
729 
730 	return shrinker;
731 
732 err_flags:
733 	shrinker_debugfs_name_free(shrinker);
734 err_name:
735 	kfree(shrinker);
736 	return NULL;
737 }
738 EXPORT_SYMBOL_GPL(shrinker_alloc);
739 
740 void shrinker_register(struct shrinker *shrinker)
741 {
742 	if (unlikely(!(shrinker->flags & SHRINKER_ALLOCATED))) {
743 		pr_warn("Must use shrinker_alloc() to dynamically allocate the shrinker");
744 		return;
745 	}
746 
747 	mutex_lock(&shrinker_mutex);
748 	list_add_tail_rcu(&shrinker->list, &shrinker_list);
749 	shrinker->flags |= SHRINKER_REGISTERED;
750 	shrinker_debugfs_add(shrinker);
751 	mutex_unlock(&shrinker_mutex);
752 
753 	init_completion(&shrinker->done);
754 	/*
755 	 * Now the shrinker is fully set up, take the first reference to it to
756 	 * indicate that lookup operations are now allowed to use it via
757 	 * shrinker_try_get().
758 	 */
759 	refcount_set(&shrinker->refcount, 1);
760 }
761 EXPORT_SYMBOL_GPL(shrinker_register);
762 
763 static void shrinker_free_rcu_cb(struct rcu_head *head)
764 {
765 	struct shrinker *shrinker = container_of(head, struct shrinker, rcu);
766 
767 	kfree(shrinker->nr_deferred);
768 	kfree(shrinker);
769 }
770 
771 void shrinker_free(struct shrinker *shrinker)
772 {
773 	struct dentry *debugfs_entry = NULL;
774 	int debugfs_id;
775 
776 	if (!shrinker)
777 		return;
778 
779 	if (shrinker->flags & SHRINKER_REGISTERED) {
780 		/* drop the initial refcount */
781 		shrinker_put(shrinker);
782 		/*
783 		 * Wait for all lookups of the shrinker to complete, after that,
784 		 * no shrinker is running or will run again, then we can safely
785 		 * free it asynchronously via RCU and safely free the structure
786 		 * where the shrinker is located, such as super_block etc.
787 		 */
788 		wait_for_completion(&shrinker->done);
789 	}
790 
791 	mutex_lock(&shrinker_mutex);
792 	if (shrinker->flags & SHRINKER_REGISTERED) {
793 		/*
794 		 * Now we can safely remove it from the shrinker_list and then
795 		 * free it.
796 		 */
797 		list_del_rcu(&shrinker->list);
798 		debugfs_entry = shrinker_debugfs_detach(shrinker, &debugfs_id);
799 		shrinker->flags &= ~SHRINKER_REGISTERED;
800 	}
801 
802 	shrinker_debugfs_name_free(shrinker);
803 
804 	if (shrinker->flags & SHRINKER_MEMCG_AWARE)
805 		shrinker_memcg_remove(shrinker);
806 	mutex_unlock(&shrinker_mutex);
807 
808 	if (debugfs_entry)
809 		shrinker_debugfs_remove(debugfs_entry, debugfs_id);
810 
811 	call_rcu(&shrinker->rcu, shrinker_free_rcu_cb);
812 }
813 EXPORT_SYMBOL_GPL(shrinker_free);
814