Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * linux/mm/swapfile.c
4 *
5 * Copyright (C) 1991, 1992, 1993, 1994 Linus Torvalds
6 * Swap reorganised 29.12.95, Stephen Tweedie
7 */
8
9#include <linux/mm.h>
10#include <linux/sched/mm.h>
11#include <linux/sched/task.h>
12#include <linux/hugetlb.h>
13#include <linux/mman.h>
14#include <linux/slab.h>
15#include <linux/kernel_stat.h>
16#include <linux/swap.h>
17#include <linux/vmalloc.h>
18#include <linux/pagemap.h>
19#include <linux/namei.h>
20#include <linux/shmem_fs.h>
21#include <linux/blkdev.h>
22#include <linux/random.h>
23#include <linux/writeback.h>
24#include <linux/proc_fs.h>
25#include <linux/seq_file.h>
26#include <linux/init.h>
27#include <linux/ksm.h>
28#include <linux/rmap.h>
29#include <linux/security.h>
30#include <linux/backing-dev.h>
31#include <linux/mutex.h>
32#include <linux/capability.h>
33#include <linux/syscalls.h>
34#include <linux/memcontrol.h>
35#include <linux/poll.h>
36#include <linux/oom.h>
37#include <linux/frontswap.h>
38#include <linux/swapfile.h>
39#include <linux/export.h>
40#include <linux/swap_slots.h>
41#include <linux/sort.h>
42
43#include <asm/pgtable.h>
44#include <asm/tlbflush.h>
45#include <linux/swapops.h>
46#include <linux/swap_cgroup.h>
47
48static bool swap_count_continued(struct swap_info_struct *, pgoff_t,
49 unsigned char);
50static void free_swap_count_continuations(struct swap_info_struct *);
51static sector_t map_swap_entry(swp_entry_t, struct block_device**);
52
53DEFINE_SPINLOCK(swap_lock);
54static unsigned int nr_swapfiles;
55atomic_long_t nr_swap_pages;
56/*
57 * Some modules use swappable objects and may try to swap them out under
58 * memory pressure (via the shrinker). Before doing so, they may wish to
59 * check to see if any swap space is available.
60 */
61EXPORT_SYMBOL_GPL(nr_swap_pages);
62/* protected with swap_lock. reading in vm_swap_full() doesn't need lock */
63long total_swap_pages;
64static int least_priority = -1;
65
66static const char Bad_file[] = "Bad swap file entry ";
67static const char Unused_file[] = "Unused swap file entry ";
68static const char Bad_offset[] = "Bad swap offset entry ";
69static const char Unused_offset[] = "Unused swap offset entry ";
70
71/*
72 * all active swap_info_structs
73 * protected with swap_lock, and ordered by priority.
74 */
75PLIST_HEAD(swap_active_head);
76
77/*
78 * all available (active, not full) swap_info_structs
79 * protected with swap_avail_lock, ordered by priority.
80 * This is used by get_swap_page() instead of swap_active_head
81 * because swap_active_head includes all swap_info_structs,
82 * but get_swap_page() doesn't need to look at full ones.
83 * This uses its own lock instead of swap_lock because when a
84 * swap_info_struct changes between not-full/full, it needs to
85 * add/remove itself to/from this list, but the swap_info_struct->lock
86 * is held and the locking order requires swap_lock to be taken
87 * before any swap_info_struct->lock.
88 */
89static struct plist_head *swap_avail_heads;
90static DEFINE_SPINLOCK(swap_avail_lock);
91
92struct swap_info_struct *swap_info[MAX_SWAPFILES];
93
94static DEFINE_MUTEX(swapon_mutex);
95
96static DECLARE_WAIT_QUEUE_HEAD(proc_poll_wait);
97/* Activity counter to indicate that a swapon or swapoff has occurred */
98static atomic_t proc_poll_event = ATOMIC_INIT(0);
99
100atomic_t nr_rotate_swap = ATOMIC_INIT(0);
101
102static struct swap_info_struct *swap_type_to_swap_info(int type)
103{
104 if (type >= READ_ONCE(nr_swapfiles))
105 return NULL;
106
107 smp_rmb(); /* Pairs with smp_wmb in alloc_swap_info. */
108 return READ_ONCE(swap_info[type]);
109}
110
111static inline unsigned char swap_count(unsigned char ent)
112{
113 return ent & ~SWAP_HAS_CACHE; /* may include COUNT_CONTINUED flag */
114}
115
116/* Reclaim the swap entry anyway if possible */
117#define TTRS_ANYWAY 0x1
118/*
119 * Reclaim the swap entry if there are no more mappings of the
120 * corresponding page
121 */
122#define TTRS_UNMAPPED 0x2
123/* Reclaim the swap entry if swap is getting full*/
124#define TTRS_FULL 0x4
125
126/* returns 1 if swap entry is freed */
127static int __try_to_reclaim_swap(struct swap_info_struct *si,
128 unsigned long offset, unsigned long flags)
129{
130 swp_entry_t entry = swp_entry(si->type, offset);
131 struct page *page;
132 int ret = 0;
133
134 page = find_get_page(swap_address_space(entry), offset);
135 if (!page)
136 return 0;
137 /*
138 * When this function is called from scan_swap_map_slots() and it's
139 * called by vmscan.c at reclaiming pages. So, we hold a lock on a page,
140 * here. We have to use trylock for avoiding deadlock. This is a special
141 * case and you should use try_to_free_swap() with explicit lock_page()
142 * in usual operations.
143 */
144 if (trylock_page(page)) {
145 if ((flags & TTRS_ANYWAY) ||
146 ((flags & TTRS_UNMAPPED) && !page_mapped(page)) ||
147 ((flags & TTRS_FULL) && mem_cgroup_swap_full(page)))
148 ret = try_to_free_swap(page);
149 unlock_page(page);
150 }
151 put_page(page);
152 return ret;
153}
154
155static inline struct swap_extent *first_se(struct swap_info_struct *sis)
156{
157 struct rb_node *rb = rb_first(&sis->swap_extent_root);
158 return rb_entry(rb, struct swap_extent, rb_node);
159}
160
161static inline struct swap_extent *next_se(struct swap_extent *se)
162{
163 struct rb_node *rb = rb_next(&se->rb_node);
164 return rb ? rb_entry(rb, struct swap_extent, rb_node) : NULL;
165}
166
167/*
168 * swapon tell device that all the old swap contents can be discarded,
169 * to allow the swap device to optimize its wear-levelling.
170 */
171static int discard_swap(struct swap_info_struct *si)
172{
173 struct swap_extent *se;
174 sector_t start_block;
175 sector_t nr_blocks;
176 int err = 0;
177
178 /* Do not discard the swap header page! */
179 se = first_se(si);
180 start_block = (se->start_block + 1) << (PAGE_SHIFT - 9);
181 nr_blocks = ((sector_t)se->nr_pages - 1) << (PAGE_SHIFT - 9);
182 if (nr_blocks) {
183 err = blkdev_issue_discard(si->bdev, start_block,
184 nr_blocks, GFP_KERNEL, 0);
185 if (err)
186 return err;
187 cond_resched();
188 }
189
190 for (se = next_se(se); se; se = next_se(se)) {
191 start_block = se->start_block << (PAGE_SHIFT - 9);
192 nr_blocks = (sector_t)se->nr_pages << (PAGE_SHIFT - 9);
193
194 err = blkdev_issue_discard(si->bdev, start_block,
195 nr_blocks, GFP_KERNEL, 0);
196 if (err)
197 break;
198
199 cond_resched();
200 }
201 return err; /* That will often be -EOPNOTSUPP */
202}
203
204static struct swap_extent *
205offset_to_swap_extent(struct swap_info_struct *sis, unsigned long offset)
206{
207 struct swap_extent *se;
208 struct rb_node *rb;
209
210 rb = sis->swap_extent_root.rb_node;
211 while (rb) {
212 se = rb_entry(rb, struct swap_extent, rb_node);
213 if (offset < se->start_page)
214 rb = rb->rb_left;
215 else if (offset >= se->start_page + se->nr_pages)
216 rb = rb->rb_right;
217 else
218 return se;
219 }
220 /* It *must* be present */
221 BUG();
222}
223
224/*
225 * swap allocation tell device that a cluster of swap can now be discarded,
226 * to allow the swap device to optimize its wear-levelling.
227 */
228static void discard_swap_cluster(struct swap_info_struct *si,
229 pgoff_t start_page, pgoff_t nr_pages)
230{
231 struct swap_extent *se = offset_to_swap_extent(si, start_page);
232
233 while (nr_pages) {
234 pgoff_t offset = start_page - se->start_page;
235 sector_t start_block = se->start_block + offset;
236 sector_t nr_blocks = se->nr_pages - offset;
237
238 if (nr_blocks > nr_pages)
239 nr_blocks = nr_pages;
240 start_page += nr_blocks;
241 nr_pages -= nr_blocks;
242
243 start_block <<= PAGE_SHIFT - 9;
244 nr_blocks <<= PAGE_SHIFT - 9;
245 if (blkdev_issue_discard(si->bdev, start_block,
246 nr_blocks, GFP_NOIO, 0))
247 break;
248
249 se = next_se(se);
250 }
251}
252
253#ifdef CONFIG_THP_SWAP
254#define SWAPFILE_CLUSTER HPAGE_PMD_NR
255
256#define swap_entry_size(size) (size)
257#else
258#define SWAPFILE_CLUSTER 256
259
260/*
261 * Define swap_entry_size() as constant to let compiler to optimize
262 * out some code if !CONFIG_THP_SWAP
263 */
264#define swap_entry_size(size) 1
265#endif
266#define LATENCY_LIMIT 256
267
268static inline void cluster_set_flag(struct swap_cluster_info *info,
269 unsigned int flag)
270{
271 info->flags = flag;
272}
273
274static inline unsigned int cluster_count(struct swap_cluster_info *info)
275{
276 return info->data;
277}
278
279static inline void cluster_set_count(struct swap_cluster_info *info,
280 unsigned int c)
281{
282 info->data = c;
283}
284
285static inline void cluster_set_count_flag(struct swap_cluster_info *info,
286 unsigned int c, unsigned int f)
287{
288 info->flags = f;
289 info->data = c;
290}
291
292static inline unsigned int cluster_next(struct swap_cluster_info *info)
293{
294 return info->data;
295}
296
297static inline void cluster_set_next(struct swap_cluster_info *info,
298 unsigned int n)
299{
300 info->data = n;
301}
302
303static inline void cluster_set_next_flag(struct swap_cluster_info *info,
304 unsigned int n, unsigned int f)
305{
306 info->flags = f;
307 info->data = n;
308}
309
310static inline bool cluster_is_free(struct swap_cluster_info *info)
311{
312 return info->flags & CLUSTER_FLAG_FREE;
313}
314
315static inline bool cluster_is_null(struct swap_cluster_info *info)
316{
317 return info->flags & CLUSTER_FLAG_NEXT_NULL;
318}
319
320static inline void cluster_set_null(struct swap_cluster_info *info)
321{
322 info->flags = CLUSTER_FLAG_NEXT_NULL;
323 info->data = 0;
324}
325
326static inline bool cluster_is_huge(struct swap_cluster_info *info)
327{
328 if (IS_ENABLED(CONFIG_THP_SWAP))
329 return info->flags & CLUSTER_FLAG_HUGE;
330 return false;
331}
332
333static inline void cluster_clear_huge(struct swap_cluster_info *info)
334{
335 info->flags &= ~CLUSTER_FLAG_HUGE;
336}
337
338static inline struct swap_cluster_info *lock_cluster(struct swap_info_struct *si,
339 unsigned long offset)
340{
341 struct swap_cluster_info *ci;
342
343 ci = si->cluster_info;
344 if (ci) {
345 ci += offset / SWAPFILE_CLUSTER;
346 spin_lock(&ci->lock);
347 }
348 return ci;
349}
350
351static inline void unlock_cluster(struct swap_cluster_info *ci)
352{
353 if (ci)
354 spin_unlock(&ci->lock);
355}
356
357/*
358 * Determine the locking method in use for this device. Return
359 * swap_cluster_info if SSD-style cluster-based locking is in place.
360 */
361static inline struct swap_cluster_info *lock_cluster_or_swap_info(
362 struct swap_info_struct *si, unsigned long offset)
363{
364 struct swap_cluster_info *ci;
365
366 /* Try to use fine-grained SSD-style locking if available: */
367 ci = lock_cluster(si, offset);
368 /* Otherwise, fall back to traditional, coarse locking: */
369 if (!ci)
370 spin_lock(&si->lock);
371
372 return ci;
373}
374
375static inline void unlock_cluster_or_swap_info(struct swap_info_struct *si,
376 struct swap_cluster_info *ci)
377{
378 if (ci)
379 unlock_cluster(ci);
380 else
381 spin_unlock(&si->lock);
382}
383
384static inline bool cluster_list_empty(struct swap_cluster_list *list)
385{
386 return cluster_is_null(&list->head);
387}
388
389static inline unsigned int cluster_list_first(struct swap_cluster_list *list)
390{
391 return cluster_next(&list->head);
392}
393
394static void cluster_list_init(struct swap_cluster_list *list)
395{
396 cluster_set_null(&list->head);
397 cluster_set_null(&list->tail);
398}
399
400static void cluster_list_add_tail(struct swap_cluster_list *list,
401 struct swap_cluster_info *ci,
402 unsigned int idx)
403{
404 if (cluster_list_empty(list)) {
405 cluster_set_next_flag(&list->head, idx, 0);
406 cluster_set_next_flag(&list->tail, idx, 0);
407 } else {
408 struct swap_cluster_info *ci_tail;
409 unsigned int tail = cluster_next(&list->tail);
410
411 /*
412 * Nested cluster lock, but both cluster locks are
413 * only acquired when we held swap_info_struct->lock
414 */
415 ci_tail = ci + tail;
416 spin_lock_nested(&ci_tail->lock, SINGLE_DEPTH_NESTING);
417 cluster_set_next(ci_tail, idx);
418 spin_unlock(&ci_tail->lock);
419 cluster_set_next_flag(&list->tail, idx, 0);
420 }
421}
422
423static unsigned int cluster_list_del_first(struct swap_cluster_list *list,
424 struct swap_cluster_info *ci)
425{
426 unsigned int idx;
427
428 idx = cluster_next(&list->head);
429 if (cluster_next(&list->tail) == idx) {
430 cluster_set_null(&list->head);
431 cluster_set_null(&list->tail);
432 } else
433 cluster_set_next_flag(&list->head,
434 cluster_next(&ci[idx]), 0);
435
436 return idx;
437}
438
439/* Add a cluster to discard list and schedule it to do discard */
440static void swap_cluster_schedule_discard(struct swap_info_struct *si,
441 unsigned int idx)
442{
443 /*
444 * If scan_swap_map() can't find a free cluster, it will check
445 * si->swap_map directly. To make sure the discarding cluster isn't
446 * taken by scan_swap_map(), mark the swap entries bad (occupied). It
447 * will be cleared after discard
448 */
449 memset(si->swap_map + idx * SWAPFILE_CLUSTER,
450 SWAP_MAP_BAD, SWAPFILE_CLUSTER);
451
452 cluster_list_add_tail(&si->discard_clusters, si->cluster_info, idx);
453
454 schedule_work(&si->discard_work);
455}
456
457static void __free_cluster(struct swap_info_struct *si, unsigned long idx)
458{
459 struct swap_cluster_info *ci = si->cluster_info;
460
461 cluster_set_flag(ci + idx, CLUSTER_FLAG_FREE);
462 cluster_list_add_tail(&si->free_clusters, ci, idx);
463}
464
465/*
466 * Doing discard actually. After a cluster discard is finished, the cluster
467 * will be added to free cluster list. caller should hold si->lock.
468*/
469static void swap_do_scheduled_discard(struct swap_info_struct *si)
470{
471 struct swap_cluster_info *info, *ci;
472 unsigned int idx;
473
474 info = si->cluster_info;
475
476 while (!cluster_list_empty(&si->discard_clusters)) {
477 idx = cluster_list_del_first(&si->discard_clusters, info);
478 spin_unlock(&si->lock);
479
480 discard_swap_cluster(si, idx * SWAPFILE_CLUSTER,
481 SWAPFILE_CLUSTER);
482
483 spin_lock(&si->lock);
484 ci = lock_cluster(si, idx * SWAPFILE_CLUSTER);
485 __free_cluster(si, idx);
486 memset(si->swap_map + idx * SWAPFILE_CLUSTER,
487 0, SWAPFILE_CLUSTER);
488 unlock_cluster(ci);
489 }
490}
491
492static void swap_discard_work(struct work_struct *work)
493{
494 struct swap_info_struct *si;
495
496 si = container_of(work, struct swap_info_struct, discard_work);
497
498 spin_lock(&si->lock);
499 swap_do_scheduled_discard(si);
500 spin_unlock(&si->lock);
501}
502
503static void alloc_cluster(struct swap_info_struct *si, unsigned long idx)
504{
505 struct swap_cluster_info *ci = si->cluster_info;
506
507 VM_BUG_ON(cluster_list_first(&si->free_clusters) != idx);
508 cluster_list_del_first(&si->free_clusters, ci);
509 cluster_set_count_flag(ci + idx, 0, 0);
510}
511
512static void free_cluster(struct swap_info_struct *si, unsigned long idx)
513{
514 struct swap_cluster_info *ci = si->cluster_info + idx;
515
516 VM_BUG_ON(cluster_count(ci) != 0);
517 /*
518 * If the swap is discardable, prepare discard the cluster
519 * instead of free it immediately. The cluster will be freed
520 * after discard.
521 */
522 if ((si->flags & (SWP_WRITEOK | SWP_PAGE_DISCARD)) ==
523 (SWP_WRITEOK | SWP_PAGE_DISCARD)) {
524 swap_cluster_schedule_discard(si, idx);
525 return;
526 }
527
528 __free_cluster(si, idx);
529}
530
531/*
532 * The cluster corresponding to page_nr will be used. The cluster will be
533 * removed from free cluster list and its usage counter will be increased.
534 */
535static void inc_cluster_info_page(struct swap_info_struct *p,
536 struct swap_cluster_info *cluster_info, unsigned long page_nr)
537{
538 unsigned long idx = page_nr / SWAPFILE_CLUSTER;
539
540 if (!cluster_info)
541 return;
542 if (cluster_is_free(&cluster_info[idx]))
543 alloc_cluster(p, idx);
544
545 VM_BUG_ON(cluster_count(&cluster_info[idx]) >= SWAPFILE_CLUSTER);
546 cluster_set_count(&cluster_info[idx],
547 cluster_count(&cluster_info[idx]) + 1);
548}
549
550/*
551 * The cluster corresponding to page_nr decreases one usage. If the usage
552 * counter becomes 0, which means no page in the cluster is in using, we can
553 * optionally discard the cluster and add it to free cluster list.
554 */
555static void dec_cluster_info_page(struct swap_info_struct *p,
556 struct swap_cluster_info *cluster_info, unsigned long page_nr)
557{
558 unsigned long idx = page_nr / SWAPFILE_CLUSTER;
559
560 if (!cluster_info)
561 return;
562
563 VM_BUG_ON(cluster_count(&cluster_info[idx]) == 0);
564 cluster_set_count(&cluster_info[idx],
565 cluster_count(&cluster_info[idx]) - 1);
566
567 if (cluster_count(&cluster_info[idx]) == 0)
568 free_cluster(p, idx);
569}
570
571/*
572 * It's possible scan_swap_map() uses a free cluster in the middle of free
573 * cluster list. Avoiding such abuse to avoid list corruption.
574 */
575static bool
576scan_swap_map_ssd_cluster_conflict(struct swap_info_struct *si,
577 unsigned long offset)
578{
579 struct percpu_cluster *percpu_cluster;
580 bool conflict;
581
582 offset /= SWAPFILE_CLUSTER;
583 conflict = !cluster_list_empty(&si->free_clusters) &&
584 offset != cluster_list_first(&si->free_clusters) &&
585 cluster_is_free(&si->cluster_info[offset]);
586
587 if (!conflict)
588 return false;
589
590 percpu_cluster = this_cpu_ptr(si->percpu_cluster);
591 cluster_set_null(&percpu_cluster->index);
592 return true;
593}
594
595/*
596 * Try to get a swap entry from current cpu's swap entry pool (a cluster). This
597 * might involve allocating a new cluster for current CPU too.
598 */
599static bool scan_swap_map_try_ssd_cluster(struct swap_info_struct *si,
600 unsigned long *offset, unsigned long *scan_base)
601{
602 struct percpu_cluster *cluster;
603 struct swap_cluster_info *ci;
604 bool found_free;
605 unsigned long tmp, max;
606
607new_cluster:
608 cluster = this_cpu_ptr(si->percpu_cluster);
609 if (cluster_is_null(&cluster->index)) {
610 if (!cluster_list_empty(&si->free_clusters)) {
611 cluster->index = si->free_clusters.head;
612 cluster->next = cluster_next(&cluster->index) *
613 SWAPFILE_CLUSTER;
614 } else if (!cluster_list_empty(&si->discard_clusters)) {
615 /*
616 * we don't have free cluster but have some clusters in
617 * discarding, do discard now and reclaim them
618 */
619 swap_do_scheduled_discard(si);
620 *scan_base = *offset = si->cluster_next;
621 goto new_cluster;
622 } else
623 return false;
624 }
625
626 found_free = false;
627
628 /*
629 * Other CPUs can use our cluster if they can't find a free cluster,
630 * check if there is still free entry in the cluster
631 */
632 tmp = cluster->next;
633 max = min_t(unsigned long, si->max,
634 (cluster_next(&cluster->index) + 1) * SWAPFILE_CLUSTER);
635 if (tmp >= max) {
636 cluster_set_null(&cluster->index);
637 goto new_cluster;
638 }
639 ci = lock_cluster(si, tmp);
640 while (tmp < max) {
641 if (!si->swap_map[tmp]) {
642 found_free = true;
643 break;
644 }
645 tmp++;
646 }
647 unlock_cluster(ci);
648 if (!found_free) {
649 cluster_set_null(&cluster->index);
650 goto new_cluster;
651 }
652 cluster->next = tmp + 1;
653 *offset = tmp;
654 *scan_base = tmp;
655 return found_free;
656}
657
658static void __del_from_avail_list(struct swap_info_struct *p)
659{
660 int nid;
661
662 for_each_node(nid)
663 plist_del(&p->avail_lists[nid], &swap_avail_heads[nid]);
664}
665
666static void del_from_avail_list(struct swap_info_struct *p)
667{
668 spin_lock(&swap_avail_lock);
669 __del_from_avail_list(p);
670 spin_unlock(&swap_avail_lock);
671}
672
673static void swap_range_alloc(struct swap_info_struct *si, unsigned long offset,
674 unsigned int nr_entries)
675{
676 unsigned int end = offset + nr_entries - 1;
677
678 if (offset == si->lowest_bit)
679 si->lowest_bit += nr_entries;
680 if (end == si->highest_bit)
681 si->highest_bit -= nr_entries;
682 si->inuse_pages += nr_entries;
683 if (si->inuse_pages == si->pages) {
684 si->lowest_bit = si->max;
685 si->highest_bit = 0;
686 del_from_avail_list(si);
687 }
688}
689
690static void add_to_avail_list(struct swap_info_struct *p)
691{
692 int nid;
693
694 spin_lock(&swap_avail_lock);
695 for_each_node(nid) {
696 WARN_ON(!plist_node_empty(&p->avail_lists[nid]));
697 plist_add(&p->avail_lists[nid], &swap_avail_heads[nid]);
698 }
699 spin_unlock(&swap_avail_lock);
700}
701
702static void swap_range_free(struct swap_info_struct *si, unsigned long offset,
703 unsigned int nr_entries)
704{
705 unsigned long end = offset + nr_entries - 1;
706 void (*swap_slot_free_notify)(struct block_device *, unsigned long);
707
708 if (offset < si->lowest_bit)
709 si->lowest_bit = offset;
710 if (end > si->highest_bit) {
711 bool was_full = !si->highest_bit;
712
713 si->highest_bit = end;
714 if (was_full && (si->flags & SWP_WRITEOK))
715 add_to_avail_list(si);
716 }
717 atomic_long_add(nr_entries, &nr_swap_pages);
718 si->inuse_pages -= nr_entries;
719 if (si->flags & SWP_BLKDEV)
720 swap_slot_free_notify =
721 si->bdev->bd_disk->fops->swap_slot_free_notify;
722 else
723 swap_slot_free_notify = NULL;
724 while (offset <= end) {
725 frontswap_invalidate_page(si->type, offset);
726 if (swap_slot_free_notify)
727 swap_slot_free_notify(si->bdev, offset);
728 offset++;
729 }
730}
731
732static int scan_swap_map_slots(struct swap_info_struct *si,
733 unsigned char usage, int nr,
734 swp_entry_t slots[])
735{
736 struct swap_cluster_info *ci;
737 unsigned long offset;
738 unsigned long scan_base;
739 unsigned long last_in_cluster = 0;
740 int latency_ration = LATENCY_LIMIT;
741 int n_ret = 0;
742
743 if (nr > SWAP_BATCH)
744 nr = SWAP_BATCH;
745
746 /*
747 * We try to cluster swap pages by allocating them sequentially
748 * in swap. Once we've allocated SWAPFILE_CLUSTER pages this
749 * way, however, we resort to first-free allocation, starting
750 * a new cluster. This prevents us from scattering swap pages
751 * all over the entire swap partition, so that we reduce
752 * overall disk seek times between swap pages. -- sct
753 * But we do now try to find an empty cluster. -Andrea
754 * And we let swap pages go all over an SSD partition. Hugh
755 */
756
757 si->flags += SWP_SCANNING;
758 scan_base = offset = si->cluster_next;
759
760 /* SSD algorithm */
761 if (si->cluster_info) {
762 if (scan_swap_map_try_ssd_cluster(si, &offset, &scan_base))
763 goto checks;
764 else
765 goto scan;
766 }
767
768 if (unlikely(!si->cluster_nr--)) {
769 if (si->pages - si->inuse_pages < SWAPFILE_CLUSTER) {
770 si->cluster_nr = SWAPFILE_CLUSTER - 1;
771 goto checks;
772 }
773
774 spin_unlock(&si->lock);
775
776 /*
777 * If seek is expensive, start searching for new cluster from
778 * start of partition, to minimize the span of allocated swap.
779 * If seek is cheap, that is the SWP_SOLIDSTATE si->cluster_info
780 * case, just handled by scan_swap_map_try_ssd_cluster() above.
781 */
782 scan_base = offset = si->lowest_bit;
783 last_in_cluster = offset + SWAPFILE_CLUSTER - 1;
784
785 /* Locate the first empty (unaligned) cluster */
786 for (; last_in_cluster <= si->highest_bit; offset++) {
787 if (si->swap_map[offset])
788 last_in_cluster = offset + SWAPFILE_CLUSTER;
789 else if (offset == last_in_cluster) {
790 spin_lock(&si->lock);
791 offset -= SWAPFILE_CLUSTER - 1;
792 si->cluster_next = offset;
793 si->cluster_nr = SWAPFILE_CLUSTER - 1;
794 goto checks;
795 }
796 if (unlikely(--latency_ration < 0)) {
797 cond_resched();
798 latency_ration = LATENCY_LIMIT;
799 }
800 }
801
802 offset = scan_base;
803 spin_lock(&si->lock);
804 si->cluster_nr = SWAPFILE_CLUSTER - 1;
805 }
806
807checks:
808 if (si->cluster_info) {
809 while (scan_swap_map_ssd_cluster_conflict(si, offset)) {
810 /* take a break if we already got some slots */
811 if (n_ret)
812 goto done;
813 if (!scan_swap_map_try_ssd_cluster(si, &offset,
814 &scan_base))
815 goto scan;
816 }
817 }
818 if (!(si->flags & SWP_WRITEOK))
819 goto no_page;
820 if (!si->highest_bit)
821 goto no_page;
822 if (offset > si->highest_bit)
823 scan_base = offset = si->lowest_bit;
824
825 ci = lock_cluster(si, offset);
826 /* reuse swap entry of cache-only swap if not busy. */
827 if (vm_swap_full() && si->swap_map[offset] == SWAP_HAS_CACHE) {
828 int swap_was_freed;
829 unlock_cluster(ci);
830 spin_unlock(&si->lock);
831 swap_was_freed = __try_to_reclaim_swap(si, offset, TTRS_ANYWAY);
832 spin_lock(&si->lock);
833 /* entry was freed successfully, try to use this again */
834 if (swap_was_freed)
835 goto checks;
836 goto scan; /* check next one */
837 }
838
839 if (si->swap_map[offset]) {
840 unlock_cluster(ci);
841 if (!n_ret)
842 goto scan;
843 else
844 goto done;
845 }
846 si->swap_map[offset] = usage;
847 inc_cluster_info_page(si, si->cluster_info, offset);
848 unlock_cluster(ci);
849
850 swap_range_alloc(si, offset, 1);
851 si->cluster_next = offset + 1;
852 slots[n_ret++] = swp_entry(si->type, offset);
853
854 /* got enough slots or reach max slots? */
855 if ((n_ret == nr) || (offset >= si->highest_bit))
856 goto done;
857
858 /* search for next available slot */
859
860 /* time to take a break? */
861 if (unlikely(--latency_ration < 0)) {
862 if (n_ret)
863 goto done;
864 spin_unlock(&si->lock);
865 cond_resched();
866 spin_lock(&si->lock);
867 latency_ration = LATENCY_LIMIT;
868 }
869
870 /* try to get more slots in cluster */
871 if (si->cluster_info) {
872 if (scan_swap_map_try_ssd_cluster(si, &offset, &scan_base))
873 goto checks;
874 else
875 goto done;
876 }
877 /* non-ssd case */
878 ++offset;
879
880 /* non-ssd case, still more slots in cluster? */
881 if (si->cluster_nr && !si->swap_map[offset]) {
882 --si->cluster_nr;
883 goto checks;
884 }
885
886done:
887 si->flags -= SWP_SCANNING;
888 return n_ret;
889
890scan:
891 spin_unlock(&si->lock);
892 while (++offset <= si->highest_bit) {
893 if (!si->swap_map[offset]) {
894 spin_lock(&si->lock);
895 goto checks;
896 }
897 if (vm_swap_full() && si->swap_map[offset] == SWAP_HAS_CACHE) {
898 spin_lock(&si->lock);
899 goto checks;
900 }
901 if (unlikely(--latency_ration < 0)) {
902 cond_resched();
903 latency_ration = LATENCY_LIMIT;
904 }
905 }
906 offset = si->lowest_bit;
907 while (offset < scan_base) {
908 if (!si->swap_map[offset]) {
909 spin_lock(&si->lock);
910 goto checks;
911 }
912 if (vm_swap_full() && si->swap_map[offset] == SWAP_HAS_CACHE) {
913 spin_lock(&si->lock);
914 goto checks;
915 }
916 if (unlikely(--latency_ration < 0)) {
917 cond_resched();
918 latency_ration = LATENCY_LIMIT;
919 }
920 offset++;
921 }
922 spin_lock(&si->lock);
923
924no_page:
925 si->flags -= SWP_SCANNING;
926 return n_ret;
927}
928
929static int swap_alloc_cluster(struct swap_info_struct *si, swp_entry_t *slot)
930{
931 unsigned long idx;
932 struct swap_cluster_info *ci;
933 unsigned long offset, i;
934 unsigned char *map;
935
936 /*
937 * Should not even be attempting cluster allocations when huge
938 * page swap is disabled. Warn and fail the allocation.
939 */
940 if (!IS_ENABLED(CONFIG_THP_SWAP)) {
941 VM_WARN_ON_ONCE(1);
942 return 0;
943 }
944
945 if (cluster_list_empty(&si->free_clusters))
946 return 0;
947
948 idx = cluster_list_first(&si->free_clusters);
949 offset = idx * SWAPFILE_CLUSTER;
950 ci = lock_cluster(si, offset);
951 alloc_cluster(si, idx);
952 cluster_set_count_flag(ci, SWAPFILE_CLUSTER, CLUSTER_FLAG_HUGE);
953
954 map = si->swap_map + offset;
955 for (i = 0; i < SWAPFILE_CLUSTER; i++)
956 map[i] = SWAP_HAS_CACHE;
957 unlock_cluster(ci);
958 swap_range_alloc(si, offset, SWAPFILE_CLUSTER);
959 *slot = swp_entry(si->type, offset);
960
961 return 1;
962}
963
964static void swap_free_cluster(struct swap_info_struct *si, unsigned long idx)
965{
966 unsigned long offset = idx * SWAPFILE_CLUSTER;
967 struct swap_cluster_info *ci;
968
969 ci = lock_cluster(si, offset);
970 memset(si->swap_map + offset, 0, SWAPFILE_CLUSTER);
971 cluster_set_count_flag(ci, 0, 0);
972 free_cluster(si, idx);
973 unlock_cluster(ci);
974 swap_range_free(si, offset, SWAPFILE_CLUSTER);
975}
976
977static unsigned long scan_swap_map(struct swap_info_struct *si,
978 unsigned char usage)
979{
980 swp_entry_t entry;
981 int n_ret;
982
983 n_ret = scan_swap_map_slots(si, usage, 1, &entry);
984
985 if (n_ret)
986 return swp_offset(entry);
987 else
988 return 0;
989
990}
991
992int get_swap_pages(int n_goal, swp_entry_t swp_entries[], int entry_size)
993{
994 unsigned long size = swap_entry_size(entry_size);
995 struct swap_info_struct *si, *next;
996 long avail_pgs;
997 int n_ret = 0;
998 int node;
999
1000 /* Only single cluster request supported */
1001 WARN_ON_ONCE(n_goal > 1 && size == SWAPFILE_CLUSTER);
1002
1003 avail_pgs = atomic_long_read(&nr_swap_pages) / size;
1004 if (avail_pgs <= 0)
1005 goto noswap;
1006
1007 if (n_goal > SWAP_BATCH)
1008 n_goal = SWAP_BATCH;
1009
1010 if (n_goal > avail_pgs)
1011 n_goal = avail_pgs;
1012
1013 atomic_long_sub(n_goal * size, &nr_swap_pages);
1014
1015 spin_lock(&swap_avail_lock);
1016
1017start_over:
1018 node = numa_node_id();
1019 plist_for_each_entry_safe(si, next, &swap_avail_heads[node], avail_lists[node]) {
1020 /* requeue si to after same-priority siblings */
1021 plist_requeue(&si->avail_lists[node], &swap_avail_heads[node]);
1022 spin_unlock(&swap_avail_lock);
1023 spin_lock(&si->lock);
1024 if (!si->highest_bit || !(si->flags & SWP_WRITEOK)) {
1025 spin_lock(&swap_avail_lock);
1026 if (plist_node_empty(&si->avail_lists[node])) {
1027 spin_unlock(&si->lock);
1028 goto nextsi;
1029 }
1030 WARN(!si->highest_bit,
1031 "swap_info %d in list but !highest_bit\n",
1032 si->type);
1033 WARN(!(si->flags & SWP_WRITEOK),
1034 "swap_info %d in list but !SWP_WRITEOK\n",
1035 si->type);
1036 __del_from_avail_list(si);
1037 spin_unlock(&si->lock);
1038 goto nextsi;
1039 }
1040 if (size == SWAPFILE_CLUSTER) {
1041 if (!(si->flags & SWP_FS))
1042 n_ret = swap_alloc_cluster(si, swp_entries);
1043 } else
1044 n_ret = scan_swap_map_slots(si, SWAP_HAS_CACHE,
1045 n_goal, swp_entries);
1046 spin_unlock(&si->lock);
1047 if (n_ret || size == SWAPFILE_CLUSTER)
1048 goto check_out;
1049 pr_debug("scan_swap_map of si %d failed to find offset\n",
1050 si->type);
1051
1052 spin_lock(&swap_avail_lock);
1053nextsi:
1054 /*
1055 * if we got here, it's likely that si was almost full before,
1056 * and since scan_swap_map() can drop the si->lock, multiple
1057 * callers probably all tried to get a page from the same si
1058 * and it filled up before we could get one; or, the si filled
1059 * up between us dropping swap_avail_lock and taking si->lock.
1060 * Since we dropped the swap_avail_lock, the swap_avail_head
1061 * list may have been modified; so if next is still in the
1062 * swap_avail_head list then try it, otherwise start over
1063 * if we have not gotten any slots.
1064 */
1065 if (plist_node_empty(&next->avail_lists[node]))
1066 goto start_over;
1067 }
1068
1069 spin_unlock(&swap_avail_lock);
1070
1071check_out:
1072 if (n_ret < n_goal)
1073 atomic_long_add((long)(n_goal - n_ret) * size,
1074 &nr_swap_pages);
1075noswap:
1076 return n_ret;
1077}
1078
1079/* The only caller of this function is now suspend routine */
1080swp_entry_t get_swap_page_of_type(int type)
1081{
1082 struct swap_info_struct *si = swap_type_to_swap_info(type);
1083 pgoff_t offset;
1084
1085 if (!si)
1086 goto fail;
1087
1088 spin_lock(&si->lock);
1089 if (si->flags & SWP_WRITEOK) {
1090 atomic_long_dec(&nr_swap_pages);
1091 /* This is called for allocating swap entry, not cache */
1092 offset = scan_swap_map(si, 1);
1093 if (offset) {
1094 spin_unlock(&si->lock);
1095 return swp_entry(type, offset);
1096 }
1097 atomic_long_inc(&nr_swap_pages);
1098 }
1099 spin_unlock(&si->lock);
1100fail:
1101 return (swp_entry_t) {0};
1102}
1103
1104static struct swap_info_struct *__swap_info_get(swp_entry_t entry)
1105{
1106 struct swap_info_struct *p;
1107 unsigned long offset;
1108
1109 if (!entry.val)
1110 goto out;
1111 p = swp_swap_info(entry);
1112 if (!p)
1113 goto bad_nofile;
1114 if (!(p->flags & SWP_USED))
1115 goto bad_device;
1116 offset = swp_offset(entry);
1117 if (offset >= p->max)
1118 goto bad_offset;
1119 return p;
1120
1121bad_offset:
1122 pr_err("swap_info_get: %s%08lx\n", Bad_offset, entry.val);
1123 goto out;
1124bad_device:
1125 pr_err("swap_info_get: %s%08lx\n", Unused_file, entry.val);
1126 goto out;
1127bad_nofile:
1128 pr_err("swap_info_get: %s%08lx\n", Bad_file, entry.val);
1129out:
1130 return NULL;
1131}
1132
1133static struct swap_info_struct *_swap_info_get(swp_entry_t entry)
1134{
1135 struct swap_info_struct *p;
1136
1137 p = __swap_info_get(entry);
1138 if (!p)
1139 goto out;
1140 if (!p->swap_map[swp_offset(entry)])
1141 goto bad_free;
1142 return p;
1143
1144bad_free:
1145 pr_err("swap_info_get: %s%08lx\n", Unused_offset, entry.val);
1146 goto out;
1147out:
1148 return NULL;
1149}
1150
1151static struct swap_info_struct *swap_info_get(swp_entry_t entry)
1152{
1153 struct swap_info_struct *p;
1154
1155 p = _swap_info_get(entry);
1156 if (p)
1157 spin_lock(&p->lock);
1158 return p;
1159}
1160
1161static struct swap_info_struct *swap_info_get_cont(swp_entry_t entry,
1162 struct swap_info_struct *q)
1163{
1164 struct swap_info_struct *p;
1165
1166 p = _swap_info_get(entry);
1167
1168 if (p != q) {
1169 if (q != NULL)
1170 spin_unlock(&q->lock);
1171 if (p != NULL)
1172 spin_lock(&p->lock);
1173 }
1174 return p;
1175}
1176
1177static unsigned char __swap_entry_free_locked(struct swap_info_struct *p,
1178 unsigned long offset,
1179 unsigned char usage)
1180{
1181 unsigned char count;
1182 unsigned char has_cache;
1183
1184 count = p->swap_map[offset];
1185
1186 has_cache = count & SWAP_HAS_CACHE;
1187 count &= ~SWAP_HAS_CACHE;
1188
1189 if (usage == SWAP_HAS_CACHE) {
1190 VM_BUG_ON(!has_cache);
1191 has_cache = 0;
1192 } else if (count == SWAP_MAP_SHMEM) {
1193 /*
1194 * Or we could insist on shmem.c using a special
1195 * swap_shmem_free() and free_shmem_swap_and_cache()...
1196 */
1197 count = 0;
1198 } else if ((count & ~COUNT_CONTINUED) <= SWAP_MAP_MAX) {
1199 if (count == COUNT_CONTINUED) {
1200 if (swap_count_continued(p, offset, count))
1201 count = SWAP_MAP_MAX | COUNT_CONTINUED;
1202 else
1203 count = SWAP_MAP_MAX;
1204 } else
1205 count--;
1206 }
1207
1208 usage = count | has_cache;
1209 p->swap_map[offset] = usage ? : SWAP_HAS_CACHE;
1210
1211 return usage;
1212}
1213
1214/*
1215 * Check whether swap entry is valid in the swap device. If so,
1216 * return pointer to swap_info_struct, and keep the swap entry valid
1217 * via preventing the swap device from being swapoff, until
1218 * put_swap_device() is called. Otherwise return NULL.
1219 *
1220 * The entirety of the RCU read critical section must come before the
1221 * return from or after the call to synchronize_rcu() in
1222 * enable_swap_info() or swapoff(). So if "si->flags & SWP_VALID" is
1223 * true, the si->map, si->cluster_info, etc. must be valid in the
1224 * critical section.
1225 *
1226 * Notice that swapoff or swapoff+swapon can still happen before the
1227 * rcu_read_lock() in get_swap_device() or after the rcu_read_unlock()
1228 * in put_swap_device() if there isn't any other way to prevent
1229 * swapoff, such as page lock, page table lock, etc. The caller must
1230 * be prepared for that. For example, the following situation is
1231 * possible.
1232 *
1233 * CPU1 CPU2
1234 * do_swap_page()
1235 * ... swapoff+swapon
1236 * __read_swap_cache_async()
1237 * swapcache_prepare()
1238 * __swap_duplicate()
1239 * // check swap_map
1240 * // verify PTE not changed
1241 *
1242 * In __swap_duplicate(), the swap_map need to be checked before
1243 * changing partly because the specified swap entry may be for another
1244 * swap device which has been swapoff. And in do_swap_page(), after
1245 * the page is read from the swap device, the PTE is verified not
1246 * changed with the page table locked to check whether the swap device
1247 * has been swapoff or swapoff+swapon.
1248 */
1249struct swap_info_struct *get_swap_device(swp_entry_t entry)
1250{
1251 struct swap_info_struct *si;
1252 unsigned long offset;
1253
1254 if (!entry.val)
1255 goto out;
1256 si = swp_swap_info(entry);
1257 if (!si)
1258 goto bad_nofile;
1259
1260 rcu_read_lock();
1261 if (!(si->flags & SWP_VALID))
1262 goto unlock_out;
1263 offset = swp_offset(entry);
1264 if (offset >= si->max)
1265 goto unlock_out;
1266
1267 return si;
1268bad_nofile:
1269 pr_err("%s: %s%08lx\n", __func__, Bad_file, entry.val);
1270out:
1271 return NULL;
1272unlock_out:
1273 rcu_read_unlock();
1274 return NULL;
1275}
1276
1277static unsigned char __swap_entry_free(struct swap_info_struct *p,
1278 swp_entry_t entry, unsigned char usage)
1279{
1280 struct swap_cluster_info *ci;
1281 unsigned long offset = swp_offset(entry);
1282
1283 ci = lock_cluster_or_swap_info(p, offset);
1284 usage = __swap_entry_free_locked(p, offset, usage);
1285 unlock_cluster_or_swap_info(p, ci);
1286 if (!usage)
1287 free_swap_slot(entry);
1288
1289 return usage;
1290}
1291
1292static void swap_entry_free(struct swap_info_struct *p, swp_entry_t entry)
1293{
1294 struct swap_cluster_info *ci;
1295 unsigned long offset = swp_offset(entry);
1296 unsigned char count;
1297
1298 ci = lock_cluster(p, offset);
1299 count = p->swap_map[offset];
1300 VM_BUG_ON(count != SWAP_HAS_CACHE);
1301 p->swap_map[offset] = 0;
1302 dec_cluster_info_page(p, p->cluster_info, offset);
1303 unlock_cluster(ci);
1304
1305 mem_cgroup_uncharge_swap(entry, 1);
1306 swap_range_free(p, offset, 1);
1307}
1308
1309/*
1310 * Caller has made sure that the swap device corresponding to entry
1311 * is still around or has not been recycled.
1312 */
1313void swap_free(swp_entry_t entry)
1314{
1315 struct swap_info_struct *p;
1316
1317 p = _swap_info_get(entry);
1318 if (p)
1319 __swap_entry_free(p, entry, 1);
1320}
1321
1322/*
1323 * Called after dropping swapcache to decrease refcnt to swap entries.
1324 */
1325void put_swap_page(struct page *page, swp_entry_t entry)
1326{
1327 unsigned long offset = swp_offset(entry);
1328 unsigned long idx = offset / SWAPFILE_CLUSTER;
1329 struct swap_cluster_info *ci;
1330 struct swap_info_struct *si;
1331 unsigned char *map;
1332 unsigned int i, free_entries = 0;
1333 unsigned char val;
1334 int size = swap_entry_size(hpage_nr_pages(page));
1335
1336 si = _swap_info_get(entry);
1337 if (!si)
1338 return;
1339
1340 ci = lock_cluster_or_swap_info(si, offset);
1341 if (size == SWAPFILE_CLUSTER) {
1342 VM_BUG_ON(!cluster_is_huge(ci));
1343 map = si->swap_map + offset;
1344 for (i = 0; i < SWAPFILE_CLUSTER; i++) {
1345 val = map[i];
1346 VM_BUG_ON(!(val & SWAP_HAS_CACHE));
1347 if (val == SWAP_HAS_CACHE)
1348 free_entries++;
1349 }
1350 cluster_clear_huge(ci);
1351 if (free_entries == SWAPFILE_CLUSTER) {
1352 unlock_cluster_or_swap_info(si, ci);
1353 spin_lock(&si->lock);
1354 mem_cgroup_uncharge_swap(entry, SWAPFILE_CLUSTER);
1355 swap_free_cluster(si, idx);
1356 spin_unlock(&si->lock);
1357 return;
1358 }
1359 }
1360 for (i = 0; i < size; i++, entry.val++) {
1361 if (!__swap_entry_free_locked(si, offset + i, SWAP_HAS_CACHE)) {
1362 unlock_cluster_or_swap_info(si, ci);
1363 free_swap_slot(entry);
1364 if (i == size - 1)
1365 return;
1366 lock_cluster_or_swap_info(si, offset);
1367 }
1368 }
1369 unlock_cluster_or_swap_info(si, ci);
1370}
1371
1372#ifdef CONFIG_THP_SWAP
1373int split_swap_cluster(swp_entry_t entry)
1374{
1375 struct swap_info_struct *si;
1376 struct swap_cluster_info *ci;
1377 unsigned long offset = swp_offset(entry);
1378
1379 si = _swap_info_get(entry);
1380 if (!si)
1381 return -EBUSY;
1382 ci = lock_cluster(si, offset);
1383 cluster_clear_huge(ci);
1384 unlock_cluster(ci);
1385 return 0;
1386}
1387#endif
1388
1389static int swp_entry_cmp(const void *ent1, const void *ent2)
1390{
1391 const swp_entry_t *e1 = ent1, *e2 = ent2;
1392
1393 return (int)swp_type(*e1) - (int)swp_type(*e2);
1394}
1395
1396void swapcache_free_entries(swp_entry_t *entries, int n)
1397{
1398 struct swap_info_struct *p, *prev;
1399 int i;
1400
1401 if (n <= 0)
1402 return;
1403
1404 prev = NULL;
1405 p = NULL;
1406
1407 /*
1408 * Sort swap entries by swap device, so each lock is only taken once.
1409 * nr_swapfiles isn't absolutely correct, but the overhead of sort() is
1410 * so low that it isn't necessary to optimize further.
1411 */
1412 if (nr_swapfiles > 1)
1413 sort(entries, n, sizeof(entries[0]), swp_entry_cmp, NULL);
1414 for (i = 0; i < n; ++i) {
1415 p = swap_info_get_cont(entries[i], prev);
1416 if (p)
1417 swap_entry_free(p, entries[i]);
1418 prev = p;
1419 }
1420 if (p)
1421 spin_unlock(&p->lock);
1422}
1423
1424/*
1425 * How many references to page are currently swapped out?
1426 * This does not give an exact answer when swap count is continued,
1427 * but does include the high COUNT_CONTINUED flag to allow for that.
1428 */
1429int page_swapcount(struct page *page)
1430{
1431 int count = 0;
1432 struct swap_info_struct *p;
1433 struct swap_cluster_info *ci;
1434 swp_entry_t entry;
1435 unsigned long offset;
1436
1437 entry.val = page_private(page);
1438 p = _swap_info_get(entry);
1439 if (p) {
1440 offset = swp_offset(entry);
1441 ci = lock_cluster_or_swap_info(p, offset);
1442 count = swap_count(p->swap_map[offset]);
1443 unlock_cluster_or_swap_info(p, ci);
1444 }
1445 return count;
1446}
1447
1448int __swap_count(swp_entry_t entry)
1449{
1450 struct swap_info_struct *si;
1451 pgoff_t offset = swp_offset(entry);
1452 int count = 0;
1453
1454 si = get_swap_device(entry);
1455 if (si) {
1456 count = swap_count(si->swap_map[offset]);
1457 put_swap_device(si);
1458 }
1459 return count;
1460}
1461
1462static int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
1463{
1464 int count = 0;
1465 pgoff_t offset = swp_offset(entry);
1466 struct swap_cluster_info *ci;
1467
1468 ci = lock_cluster_or_swap_info(si, offset);
1469 count = swap_count(si->swap_map[offset]);
1470 unlock_cluster_or_swap_info(si, ci);
1471 return count;
1472}
1473
1474/*
1475 * How many references to @entry are currently swapped out?
1476 * This does not give an exact answer when swap count is continued,
1477 * but does include the high COUNT_CONTINUED flag to allow for that.
1478 */
1479int __swp_swapcount(swp_entry_t entry)
1480{
1481 int count = 0;
1482 struct swap_info_struct *si;
1483
1484 si = get_swap_device(entry);
1485 if (si) {
1486 count = swap_swapcount(si, entry);
1487 put_swap_device(si);
1488 }
1489 return count;
1490}
1491
1492/*
1493 * How many references to @entry are currently swapped out?
1494 * This considers COUNT_CONTINUED so it returns exact answer.
1495 */
1496int swp_swapcount(swp_entry_t entry)
1497{
1498 int count, tmp_count, n;
1499 struct swap_info_struct *p;
1500 struct swap_cluster_info *ci;
1501 struct page *page;
1502 pgoff_t offset;
1503 unsigned char *map;
1504
1505 p = _swap_info_get(entry);
1506 if (!p)
1507 return 0;
1508
1509 offset = swp_offset(entry);
1510
1511 ci = lock_cluster_or_swap_info(p, offset);
1512
1513 count = swap_count(p->swap_map[offset]);
1514 if (!(count & COUNT_CONTINUED))
1515 goto out;
1516
1517 count &= ~COUNT_CONTINUED;
1518 n = SWAP_MAP_MAX + 1;
1519
1520 page = vmalloc_to_page(p->swap_map + offset);
1521 offset &= ~PAGE_MASK;
1522 VM_BUG_ON(page_private(page) != SWP_CONTINUED);
1523
1524 do {
1525 page = list_next_entry(page, lru);
1526 map = kmap_atomic(page);
1527 tmp_count = map[offset];
1528 kunmap_atomic(map);
1529
1530 count += (tmp_count & ~COUNT_CONTINUED) * n;
1531 n *= (SWAP_CONT_MAX + 1);
1532 } while (tmp_count & COUNT_CONTINUED);
1533out:
1534 unlock_cluster_or_swap_info(p, ci);
1535 return count;
1536}
1537
1538static bool swap_page_trans_huge_swapped(struct swap_info_struct *si,
1539 swp_entry_t entry)
1540{
1541 struct swap_cluster_info *ci;
1542 unsigned char *map = si->swap_map;
1543 unsigned long roffset = swp_offset(entry);
1544 unsigned long offset = round_down(roffset, SWAPFILE_CLUSTER);
1545 int i;
1546 bool ret = false;
1547
1548 ci = lock_cluster_or_swap_info(si, offset);
1549 if (!ci || !cluster_is_huge(ci)) {
1550 if (swap_count(map[roffset]))
1551 ret = true;
1552 goto unlock_out;
1553 }
1554 for (i = 0; i < SWAPFILE_CLUSTER; i++) {
1555 if (swap_count(map[offset + i])) {
1556 ret = true;
1557 break;
1558 }
1559 }
1560unlock_out:
1561 unlock_cluster_or_swap_info(si, ci);
1562 return ret;
1563}
1564
1565static bool page_swapped(struct page *page)
1566{
1567 swp_entry_t entry;
1568 struct swap_info_struct *si;
1569
1570 if (!IS_ENABLED(CONFIG_THP_SWAP) || likely(!PageTransCompound(page)))
1571 return page_swapcount(page) != 0;
1572
1573 page = compound_head(page);
1574 entry.val = page_private(page);
1575 si = _swap_info_get(entry);
1576 if (si)
1577 return swap_page_trans_huge_swapped(si, entry);
1578 return false;
1579}
1580
1581static int page_trans_huge_map_swapcount(struct page *page, int *total_mapcount,
1582 int *total_swapcount)
1583{
1584 int i, map_swapcount, _total_mapcount, _total_swapcount;
1585 unsigned long offset = 0;
1586 struct swap_info_struct *si;
1587 struct swap_cluster_info *ci = NULL;
1588 unsigned char *map = NULL;
1589 int mapcount, swapcount = 0;
1590
1591 /* hugetlbfs shouldn't call it */
1592 VM_BUG_ON_PAGE(PageHuge(page), page);
1593
1594 if (!IS_ENABLED(CONFIG_THP_SWAP) || likely(!PageTransCompound(page))) {
1595 mapcount = page_trans_huge_mapcount(page, total_mapcount);
1596 if (PageSwapCache(page))
1597 swapcount = page_swapcount(page);
1598 if (total_swapcount)
1599 *total_swapcount = swapcount;
1600 return mapcount + swapcount;
1601 }
1602
1603 page = compound_head(page);
1604
1605 _total_mapcount = _total_swapcount = map_swapcount = 0;
1606 if (PageSwapCache(page)) {
1607 swp_entry_t entry;
1608
1609 entry.val = page_private(page);
1610 si = _swap_info_get(entry);
1611 if (si) {
1612 map = si->swap_map;
1613 offset = swp_offset(entry);
1614 }
1615 }
1616 if (map)
1617 ci = lock_cluster(si, offset);
1618 for (i = 0; i < HPAGE_PMD_NR; i++) {
1619 mapcount = atomic_read(&page[i]._mapcount) + 1;
1620 _total_mapcount += mapcount;
1621 if (map) {
1622 swapcount = swap_count(map[offset + i]);
1623 _total_swapcount += swapcount;
1624 }
1625 map_swapcount = max(map_swapcount, mapcount + swapcount);
1626 }
1627 unlock_cluster(ci);
1628 if (PageDoubleMap(page)) {
1629 map_swapcount -= 1;
1630 _total_mapcount -= HPAGE_PMD_NR;
1631 }
1632 mapcount = compound_mapcount(page);
1633 map_swapcount += mapcount;
1634 _total_mapcount += mapcount;
1635 if (total_mapcount)
1636 *total_mapcount = _total_mapcount;
1637 if (total_swapcount)
1638 *total_swapcount = _total_swapcount;
1639
1640 return map_swapcount;
1641}
1642
1643/*
1644 * We can write to an anon page without COW if there are no other references
1645 * to it. And as a side-effect, free up its swap: because the old content
1646 * on disk will never be read, and seeking back there to write new content
1647 * later would only waste time away from clustering.
1648 *
1649 * NOTE: total_map_swapcount should not be relied upon by the caller if
1650 * reuse_swap_page() returns false, but it may be always overwritten
1651 * (see the other implementation for CONFIG_SWAP=n).
1652 */
1653bool reuse_swap_page(struct page *page, int *total_map_swapcount)
1654{
1655 int count, total_mapcount, total_swapcount;
1656
1657 VM_BUG_ON_PAGE(!PageLocked(page), page);
1658 if (unlikely(PageKsm(page)))
1659 return false;
1660 count = page_trans_huge_map_swapcount(page, &total_mapcount,
1661 &total_swapcount);
1662 if (total_map_swapcount)
1663 *total_map_swapcount = total_mapcount + total_swapcount;
1664 if (count == 1 && PageSwapCache(page) &&
1665 (likely(!PageTransCompound(page)) ||
1666 /* The remaining swap count will be freed soon */
1667 total_swapcount == page_swapcount(page))) {
1668 if (!PageWriteback(page)) {
1669 page = compound_head(page);
1670 delete_from_swap_cache(page);
1671 SetPageDirty(page);
1672 } else {
1673 swp_entry_t entry;
1674 struct swap_info_struct *p;
1675
1676 entry.val = page_private(page);
1677 p = swap_info_get(entry);
1678 if (p->flags & SWP_STABLE_WRITES) {
1679 spin_unlock(&p->lock);
1680 return false;
1681 }
1682 spin_unlock(&p->lock);
1683 }
1684 }
1685
1686 return count <= 1;
1687}
1688
1689/*
1690 * If swap is getting full, or if there are no more mappings of this page,
1691 * then try_to_free_swap is called to free its swap space.
1692 */
1693int try_to_free_swap(struct page *page)
1694{
1695 VM_BUG_ON_PAGE(!PageLocked(page), page);
1696
1697 if (!PageSwapCache(page))
1698 return 0;
1699 if (PageWriteback(page))
1700 return 0;
1701 if (page_swapped(page))
1702 return 0;
1703
1704 /*
1705 * Once hibernation has begun to create its image of memory,
1706 * there's a danger that one of the calls to try_to_free_swap()
1707 * - most probably a call from __try_to_reclaim_swap() while
1708 * hibernation is allocating its own swap pages for the image,
1709 * but conceivably even a call from memory reclaim - will free
1710 * the swap from a page which has already been recorded in the
1711 * image as a clean swapcache page, and then reuse its swap for
1712 * another page of the image. On waking from hibernation, the
1713 * original page might be freed under memory pressure, then
1714 * later read back in from swap, now with the wrong data.
1715 *
1716 * Hibernation suspends storage while it is writing the image
1717 * to disk so check that here.
1718 */
1719 if (pm_suspended_storage())
1720 return 0;
1721
1722 page = compound_head(page);
1723 delete_from_swap_cache(page);
1724 SetPageDirty(page);
1725 return 1;
1726}
1727
1728/*
1729 * Free the swap entry like above, but also try to
1730 * free the page cache entry if it is the last user.
1731 */
1732int free_swap_and_cache(swp_entry_t entry)
1733{
1734 struct swap_info_struct *p;
1735 unsigned char count;
1736
1737 if (non_swap_entry(entry))
1738 return 1;
1739
1740 p = _swap_info_get(entry);
1741 if (p) {
1742 count = __swap_entry_free(p, entry, 1);
1743 if (count == SWAP_HAS_CACHE &&
1744 !swap_page_trans_huge_swapped(p, entry))
1745 __try_to_reclaim_swap(p, swp_offset(entry),
1746 TTRS_UNMAPPED | TTRS_FULL);
1747 }
1748 return p != NULL;
1749}
1750
1751#ifdef CONFIG_HIBERNATION
1752/*
1753 * Find the swap type that corresponds to given device (if any).
1754 *
1755 * @offset - number of the PAGE_SIZE-sized block of the device, starting
1756 * from 0, in which the swap header is expected to be located.
1757 *
1758 * This is needed for the suspend to disk (aka swsusp).
1759 */
1760int swap_type_of(dev_t device, sector_t offset, struct block_device **bdev_p)
1761{
1762 struct block_device *bdev = NULL;
1763 int type;
1764
1765 if (device)
1766 bdev = bdget(device);
1767
1768 spin_lock(&swap_lock);
1769 for (type = 0; type < nr_swapfiles; type++) {
1770 struct swap_info_struct *sis = swap_info[type];
1771
1772 if (!(sis->flags & SWP_WRITEOK))
1773 continue;
1774
1775 if (!bdev) {
1776 if (bdev_p)
1777 *bdev_p = bdgrab(sis->bdev);
1778
1779 spin_unlock(&swap_lock);
1780 return type;
1781 }
1782 if (bdev == sis->bdev) {
1783 struct swap_extent *se = first_se(sis);
1784
1785 if (se->start_block == offset) {
1786 if (bdev_p)
1787 *bdev_p = bdgrab(sis->bdev);
1788
1789 spin_unlock(&swap_lock);
1790 bdput(bdev);
1791 return type;
1792 }
1793 }
1794 }
1795 spin_unlock(&swap_lock);
1796 if (bdev)
1797 bdput(bdev);
1798
1799 return -ENODEV;
1800}
1801
1802/*
1803 * Get the (PAGE_SIZE) block corresponding to given offset on the swapdev
1804 * corresponding to given index in swap_info (swap type).
1805 */
1806sector_t swapdev_block(int type, pgoff_t offset)
1807{
1808 struct block_device *bdev;
1809 struct swap_info_struct *si = swap_type_to_swap_info(type);
1810
1811 if (!si || !(si->flags & SWP_WRITEOK))
1812 return 0;
1813 return map_swap_entry(swp_entry(type, offset), &bdev);
1814}
1815
1816/*
1817 * Return either the total number of swap pages of given type, or the number
1818 * of free pages of that type (depending on @free)
1819 *
1820 * This is needed for software suspend
1821 */
1822unsigned int count_swap_pages(int type, int free)
1823{
1824 unsigned int n = 0;
1825
1826 spin_lock(&swap_lock);
1827 if ((unsigned int)type < nr_swapfiles) {
1828 struct swap_info_struct *sis = swap_info[type];
1829
1830 spin_lock(&sis->lock);
1831 if (sis->flags & SWP_WRITEOK) {
1832 n = sis->pages;
1833 if (free)
1834 n -= sis->inuse_pages;
1835 }
1836 spin_unlock(&sis->lock);
1837 }
1838 spin_unlock(&swap_lock);
1839 return n;
1840}
1841#endif /* CONFIG_HIBERNATION */
1842
1843static inline int pte_same_as_swp(pte_t pte, pte_t swp_pte)
1844{
1845 return pte_same(pte_swp_clear_soft_dirty(pte), swp_pte);
1846}
1847
1848/*
1849 * No need to decide whether this PTE shares the swap entry with others,
1850 * just let do_wp_page work it out if a write is requested later - to
1851 * force COW, vm_page_prot omits write permission from any private vma.
1852 */
1853static int unuse_pte(struct vm_area_struct *vma, pmd_t *pmd,
1854 unsigned long addr, swp_entry_t entry, struct page *page)
1855{
1856 struct page *swapcache;
1857 struct mem_cgroup *memcg;
1858 spinlock_t *ptl;
1859 pte_t *pte;
1860 int ret = 1;
1861
1862 swapcache = page;
1863 page = ksm_might_need_to_copy(page, vma, addr);
1864 if (unlikely(!page))
1865 return -ENOMEM;
1866
1867 if (mem_cgroup_try_charge(page, vma->vm_mm, GFP_KERNEL,
1868 &memcg, false)) {
1869 ret = -ENOMEM;
1870 goto out_nolock;
1871 }
1872
1873 pte = pte_offset_map_lock(vma->vm_mm, pmd, addr, &ptl);
1874 if (unlikely(!pte_same_as_swp(*pte, swp_entry_to_pte(entry)))) {
1875 mem_cgroup_cancel_charge(page, memcg, false);
1876 ret = 0;
1877 goto out;
1878 }
1879
1880 dec_mm_counter(vma->vm_mm, MM_SWAPENTS);
1881 inc_mm_counter(vma->vm_mm, MM_ANONPAGES);
1882 get_page(page);
1883 set_pte_at(vma->vm_mm, addr, pte,
1884 pte_mkold(mk_pte(page, vma->vm_page_prot)));
1885 if (page == swapcache) {
1886 page_add_anon_rmap(page, vma, addr, false);
1887 mem_cgroup_commit_charge(page, memcg, true, false);
1888 } else { /* ksm created a completely new copy */
1889 page_add_new_anon_rmap(page, vma, addr, false);
1890 mem_cgroup_commit_charge(page, memcg, false, false);
1891 lru_cache_add_active_or_unevictable(page, vma);
1892 }
1893 swap_free(entry);
1894 /*
1895 * Move the page to the active list so it is not
1896 * immediately swapped out again after swapon.
1897 */
1898 activate_page(page);
1899out:
1900 pte_unmap_unlock(pte, ptl);
1901out_nolock:
1902 if (page != swapcache) {
1903 unlock_page(page);
1904 put_page(page);
1905 }
1906 return ret;
1907}
1908
1909static int unuse_pte_range(struct vm_area_struct *vma, pmd_t *pmd,
1910 unsigned long addr, unsigned long end,
1911 unsigned int type, bool frontswap,
1912 unsigned long *fs_pages_to_unuse)
1913{
1914 struct page *page;
1915 swp_entry_t entry;
1916 pte_t *pte;
1917 struct swap_info_struct *si;
1918 unsigned long offset;
1919 int ret = 0;
1920 volatile unsigned char *swap_map;
1921
1922 si = swap_info[type];
1923 pte = pte_offset_map(pmd, addr);
1924 do {
1925 struct vm_fault vmf;
1926
1927 if (!is_swap_pte(*pte))
1928 continue;
1929
1930 entry = pte_to_swp_entry(*pte);
1931 if (swp_type(entry) != type)
1932 continue;
1933
1934 offset = swp_offset(entry);
1935 if (frontswap && !frontswap_test(si, offset))
1936 continue;
1937
1938 pte_unmap(pte);
1939 swap_map = &si->swap_map[offset];
1940 vmf.vma = vma;
1941 vmf.address = addr;
1942 vmf.pmd = pmd;
1943 page = swapin_readahead(entry, GFP_HIGHUSER_MOVABLE, &vmf);
1944 if (!page) {
1945 if (*swap_map == 0 || *swap_map == SWAP_MAP_BAD)
1946 goto try_next;
1947 return -ENOMEM;
1948 }
1949
1950 lock_page(page);
1951 wait_on_page_writeback(page);
1952 ret = unuse_pte(vma, pmd, addr, entry, page);
1953 if (ret < 0) {
1954 unlock_page(page);
1955 put_page(page);
1956 goto out;
1957 }
1958
1959 try_to_free_swap(page);
1960 unlock_page(page);
1961 put_page(page);
1962
1963 if (*fs_pages_to_unuse && !--(*fs_pages_to_unuse)) {
1964 ret = FRONTSWAP_PAGES_UNUSED;
1965 goto out;
1966 }
1967try_next:
1968 pte = pte_offset_map(pmd, addr);
1969 } while (pte++, addr += PAGE_SIZE, addr != end);
1970 pte_unmap(pte - 1);
1971
1972 ret = 0;
1973out:
1974 return ret;
1975}
1976
1977static inline int unuse_pmd_range(struct vm_area_struct *vma, pud_t *pud,
1978 unsigned long addr, unsigned long end,
1979 unsigned int type, bool frontswap,
1980 unsigned long *fs_pages_to_unuse)
1981{
1982 pmd_t *pmd;
1983 unsigned long next;
1984 int ret;
1985
1986 pmd = pmd_offset(pud, addr);
1987 do {
1988 cond_resched();
1989 next = pmd_addr_end(addr, end);
1990 if (pmd_none_or_trans_huge_or_clear_bad(pmd))
1991 continue;
1992 ret = unuse_pte_range(vma, pmd, addr, next, type,
1993 frontswap, fs_pages_to_unuse);
1994 if (ret)
1995 return ret;
1996 } while (pmd++, addr = next, addr != end);
1997 return 0;
1998}
1999
2000static inline int unuse_pud_range(struct vm_area_struct *vma, p4d_t *p4d,
2001 unsigned long addr, unsigned long end,
2002 unsigned int type, bool frontswap,
2003 unsigned long *fs_pages_to_unuse)
2004{
2005 pud_t *pud;
2006 unsigned long next;
2007 int ret;
2008
2009 pud = pud_offset(p4d, addr);
2010 do {
2011 next = pud_addr_end(addr, end);
2012 if (pud_none_or_clear_bad(pud))
2013 continue;
2014 ret = unuse_pmd_range(vma, pud, addr, next, type,
2015 frontswap, fs_pages_to_unuse);
2016 if (ret)
2017 return ret;
2018 } while (pud++, addr = next, addr != end);
2019 return 0;
2020}
2021
2022static inline int unuse_p4d_range(struct vm_area_struct *vma, pgd_t *pgd,
2023 unsigned long addr, unsigned long end,
2024 unsigned int type, bool frontswap,
2025 unsigned long *fs_pages_to_unuse)
2026{
2027 p4d_t *p4d;
2028 unsigned long next;
2029 int ret;
2030
2031 p4d = p4d_offset(pgd, addr);
2032 do {
2033 next = p4d_addr_end(addr, end);
2034 if (p4d_none_or_clear_bad(p4d))
2035 continue;
2036 ret = unuse_pud_range(vma, p4d, addr, next, type,
2037 frontswap, fs_pages_to_unuse);
2038 if (ret)
2039 return ret;
2040 } while (p4d++, addr = next, addr != end);
2041 return 0;
2042}
2043
2044static int unuse_vma(struct vm_area_struct *vma, unsigned int type,
2045 bool frontswap, unsigned long *fs_pages_to_unuse)
2046{
2047 pgd_t *pgd;
2048 unsigned long addr, end, next;
2049 int ret;
2050
2051 addr = vma->vm_start;
2052 end = vma->vm_end;
2053
2054 pgd = pgd_offset(vma->vm_mm, addr);
2055 do {
2056 next = pgd_addr_end(addr, end);
2057 if (pgd_none_or_clear_bad(pgd))
2058 continue;
2059 ret = unuse_p4d_range(vma, pgd, addr, next, type,
2060 frontswap, fs_pages_to_unuse);
2061 if (ret)
2062 return ret;
2063 } while (pgd++, addr = next, addr != end);
2064 return 0;
2065}
2066
2067static int unuse_mm(struct mm_struct *mm, unsigned int type,
2068 bool frontswap, unsigned long *fs_pages_to_unuse)
2069{
2070 struct vm_area_struct *vma;
2071 int ret = 0;
2072
2073 down_read(&mm->mmap_sem);
2074 for (vma = mm->mmap; vma; vma = vma->vm_next) {
2075 if (vma->anon_vma) {
2076 ret = unuse_vma(vma, type, frontswap,
2077 fs_pages_to_unuse);
2078 if (ret)
2079 break;
2080 }
2081 cond_resched();
2082 }
2083 up_read(&mm->mmap_sem);
2084 return ret;
2085}
2086
2087/*
2088 * Scan swap_map (or frontswap_map if frontswap parameter is true)
2089 * from current position to next entry still in use. Return 0
2090 * if there are no inuse entries after prev till end of the map.
2091 */
2092static unsigned int find_next_to_unuse(struct swap_info_struct *si,
2093 unsigned int prev, bool frontswap)
2094{
2095 unsigned int i;
2096 unsigned char count;
2097
2098 /*
2099 * No need for swap_lock here: we're just looking
2100 * for whether an entry is in use, not modifying it; false
2101 * hits are okay, and sys_swapoff() has already prevented new
2102 * allocations from this area (while holding swap_lock).
2103 */
2104 for (i = prev + 1; i < si->max; i++) {
2105 count = READ_ONCE(si->swap_map[i]);
2106 if (count && swap_count(count) != SWAP_MAP_BAD)
2107 if (!frontswap || frontswap_test(si, i))
2108 break;
2109 if ((i % LATENCY_LIMIT) == 0)
2110 cond_resched();
2111 }
2112
2113 if (i == si->max)
2114 i = 0;
2115
2116 return i;
2117}
2118
2119/*
2120 * If the boolean frontswap is true, only unuse pages_to_unuse pages;
2121 * pages_to_unuse==0 means all pages; ignored if frontswap is false
2122 */
2123int try_to_unuse(unsigned int type, bool frontswap,
2124 unsigned long pages_to_unuse)
2125{
2126 struct mm_struct *prev_mm;
2127 struct mm_struct *mm;
2128 struct list_head *p;
2129 int retval = 0;
2130 struct swap_info_struct *si = swap_info[type];
2131 struct page *page;
2132 swp_entry_t entry;
2133 unsigned int i;
2134
2135 if (!si->inuse_pages)
2136 return 0;
2137
2138 if (!frontswap)
2139 pages_to_unuse = 0;
2140
2141retry:
2142 retval = shmem_unuse(type, frontswap, &pages_to_unuse);
2143 if (retval)
2144 goto out;
2145
2146 prev_mm = &init_mm;
2147 mmget(prev_mm);
2148
2149 spin_lock(&mmlist_lock);
2150 p = &init_mm.mmlist;
2151 while (si->inuse_pages &&
2152 !signal_pending(current) &&
2153 (p = p->next) != &init_mm.mmlist) {
2154
2155 mm = list_entry(p, struct mm_struct, mmlist);
2156 if (!mmget_not_zero(mm))
2157 continue;
2158 spin_unlock(&mmlist_lock);
2159 mmput(prev_mm);
2160 prev_mm = mm;
2161 retval = unuse_mm(mm, type, frontswap, &pages_to_unuse);
2162
2163 if (retval) {
2164 mmput(prev_mm);
2165 goto out;
2166 }
2167
2168 /*
2169 * Make sure that we aren't completely killing
2170 * interactive performance.
2171 */
2172 cond_resched();
2173 spin_lock(&mmlist_lock);
2174 }
2175 spin_unlock(&mmlist_lock);
2176
2177 mmput(prev_mm);
2178
2179 i = 0;
2180 while (si->inuse_pages &&
2181 !signal_pending(current) &&
2182 (i = find_next_to_unuse(si, i, frontswap)) != 0) {
2183
2184 entry = swp_entry(type, i);
2185 page = find_get_page(swap_address_space(entry), i);
2186 if (!page)
2187 continue;
2188
2189 /*
2190 * It is conceivable that a racing task removed this page from
2191 * swap cache just before we acquired the page lock. The page
2192 * might even be back in swap cache on another swap area. But
2193 * that is okay, try_to_free_swap() only removes stale pages.
2194 */
2195 lock_page(page);
2196 wait_on_page_writeback(page);
2197 try_to_free_swap(page);
2198 unlock_page(page);
2199 put_page(page);
2200
2201 /*
2202 * For frontswap, we just need to unuse pages_to_unuse, if
2203 * it was specified. Need not check frontswap again here as
2204 * we already zeroed out pages_to_unuse if not frontswap.
2205 */
2206 if (pages_to_unuse && --pages_to_unuse == 0)
2207 goto out;
2208 }
2209
2210 /*
2211 * Lets check again to see if there are still swap entries in the map.
2212 * If yes, we would need to do retry the unuse logic again.
2213 * Under global memory pressure, swap entries can be reinserted back
2214 * into process space after the mmlist loop above passes over them.
2215 *
2216 * Limit the number of retries? No: when mmget_not_zero() above fails,
2217 * that mm is likely to be freeing swap from exit_mmap(), which proceeds
2218 * at its own independent pace; and even shmem_writepage() could have
2219 * been preempted after get_swap_page(), temporarily hiding that swap.
2220 * It's easy and robust (though cpu-intensive) just to keep retrying.
2221 */
2222 if (si->inuse_pages) {
2223 if (!signal_pending(current))
2224 goto retry;
2225 retval = -EINTR;
2226 }
2227out:
2228 return (retval == FRONTSWAP_PAGES_UNUSED) ? 0 : retval;
2229}
2230
2231/*
2232 * After a successful try_to_unuse, if no swap is now in use, we know
2233 * we can empty the mmlist. swap_lock must be held on entry and exit.
2234 * Note that mmlist_lock nests inside swap_lock, and an mm must be
2235 * added to the mmlist just after page_duplicate - before would be racy.
2236 */
2237static void drain_mmlist(void)
2238{
2239 struct list_head *p, *next;
2240 unsigned int type;
2241
2242 for (type = 0; type < nr_swapfiles; type++)
2243 if (swap_info[type]->inuse_pages)
2244 return;
2245 spin_lock(&mmlist_lock);
2246 list_for_each_safe(p, next, &init_mm.mmlist)
2247 list_del_init(p);
2248 spin_unlock(&mmlist_lock);
2249}
2250
2251/*
2252 * Use this swapdev's extent info to locate the (PAGE_SIZE) block which
2253 * corresponds to page offset for the specified swap entry.
2254 * Note that the type of this function is sector_t, but it returns page offset
2255 * into the bdev, not sector offset.
2256 */
2257static sector_t map_swap_entry(swp_entry_t entry, struct block_device **bdev)
2258{
2259 struct swap_info_struct *sis;
2260 struct swap_extent *se;
2261 pgoff_t offset;
2262
2263 sis = swp_swap_info(entry);
2264 *bdev = sis->bdev;
2265
2266 offset = swp_offset(entry);
2267 se = offset_to_swap_extent(sis, offset);
2268 return se->start_block + (offset - se->start_page);
2269}
2270
2271/*
2272 * Returns the page offset into bdev for the specified page's swap entry.
2273 */
2274sector_t map_swap_page(struct page *page, struct block_device **bdev)
2275{
2276 swp_entry_t entry;
2277 entry.val = page_private(page);
2278 return map_swap_entry(entry, bdev);
2279}
2280
2281/*
2282 * Free all of a swapdev's extent information
2283 */
2284static void destroy_swap_extents(struct swap_info_struct *sis)
2285{
2286 while (!RB_EMPTY_ROOT(&sis->swap_extent_root)) {
2287 struct rb_node *rb = sis->swap_extent_root.rb_node;
2288 struct swap_extent *se = rb_entry(rb, struct swap_extent, rb_node);
2289
2290 rb_erase(rb, &sis->swap_extent_root);
2291 kfree(se);
2292 }
2293
2294 if (sis->flags & SWP_ACTIVATED) {
2295 struct file *swap_file = sis->swap_file;
2296 struct address_space *mapping = swap_file->f_mapping;
2297
2298 sis->flags &= ~SWP_ACTIVATED;
2299 if (mapping->a_ops->swap_deactivate)
2300 mapping->a_ops->swap_deactivate(swap_file);
2301 }
2302}
2303
2304/*
2305 * Add a block range (and the corresponding page range) into this swapdev's
2306 * extent tree.
2307 *
2308 * This function rather assumes that it is called in ascending page order.
2309 */
2310int
2311add_swap_extent(struct swap_info_struct *sis, unsigned long start_page,
2312 unsigned long nr_pages, sector_t start_block)
2313{
2314 struct rb_node **link = &sis->swap_extent_root.rb_node, *parent = NULL;
2315 struct swap_extent *se;
2316 struct swap_extent *new_se;
2317
2318 /*
2319 * place the new node at the right most since the
2320 * function is called in ascending page order.
2321 */
2322 while (*link) {
2323 parent = *link;
2324 link = &parent->rb_right;
2325 }
2326
2327 if (parent) {
2328 se = rb_entry(parent, struct swap_extent, rb_node);
2329 BUG_ON(se->start_page + se->nr_pages != start_page);
2330 if (se->start_block + se->nr_pages == start_block) {
2331 /* Merge it */
2332 se->nr_pages += nr_pages;
2333 return 0;
2334 }
2335 }
2336
2337 /* No merge, insert a new extent. */
2338 new_se = kmalloc(sizeof(*se), GFP_KERNEL);
2339 if (new_se == NULL)
2340 return -ENOMEM;
2341 new_se->start_page = start_page;
2342 new_se->nr_pages = nr_pages;
2343 new_se->start_block = start_block;
2344
2345 rb_link_node(&new_se->rb_node, parent, link);
2346 rb_insert_color(&new_se->rb_node, &sis->swap_extent_root);
2347 return 1;
2348}
2349EXPORT_SYMBOL_GPL(add_swap_extent);
2350
2351/*
2352 * A `swap extent' is a simple thing which maps a contiguous range of pages
2353 * onto a contiguous range of disk blocks. An ordered list of swap extents
2354 * is built at swapon time and is then used at swap_writepage/swap_readpage
2355 * time for locating where on disk a page belongs.
2356 *
2357 * If the swapfile is an S_ISBLK block device, a single extent is installed.
2358 * This is done so that the main operating code can treat S_ISBLK and S_ISREG
2359 * swap files identically.
2360 *
2361 * Whether the swapdev is an S_ISREG file or an S_ISBLK blockdev, the swap
2362 * extent list operates in PAGE_SIZE disk blocks. Both S_ISREG and S_ISBLK
2363 * swapfiles are handled *identically* after swapon time.
2364 *
2365 * For S_ISREG swapfiles, setup_swap_extents() will walk all the file's blocks
2366 * and will parse them into an ordered extent list, in PAGE_SIZE chunks. If
2367 * some stray blocks are found which do not fall within the PAGE_SIZE alignment
2368 * requirements, they are simply tossed out - we will never use those blocks
2369 * for swapping.
2370 *
2371 * For all swap devices we set S_SWAPFILE across the life of the swapon. This
2372 * prevents users from writing to the swap device, which will corrupt memory.
2373 *
2374 * The amount of disk space which a single swap extent represents varies.
2375 * Typically it is in the 1-4 megabyte range. So we can have hundreds of
2376 * extents in the list. To avoid much list walking, we cache the previous
2377 * search location in `curr_swap_extent', and start new searches from there.
2378 * This is extremely effective. The average number of iterations in
2379 * map_swap_page() has been measured at about 0.3 per page. - akpm.
2380 */
2381static int setup_swap_extents(struct swap_info_struct *sis, sector_t *span)
2382{
2383 struct file *swap_file = sis->swap_file;
2384 struct address_space *mapping = swap_file->f_mapping;
2385 struct inode *inode = mapping->host;
2386 int ret;
2387
2388 if (S_ISBLK(inode->i_mode)) {
2389 ret = add_swap_extent(sis, 0, sis->max, 0);
2390 *span = sis->pages;
2391 return ret;
2392 }
2393
2394 if (mapping->a_ops->swap_activate) {
2395 ret = mapping->a_ops->swap_activate(sis, swap_file, span);
2396 if (ret >= 0)
2397 sis->flags |= SWP_ACTIVATED;
2398 if (!ret) {
2399 sis->flags |= SWP_FS;
2400 ret = add_swap_extent(sis, 0, sis->max, 0);
2401 *span = sis->pages;
2402 }
2403 return ret;
2404 }
2405
2406 return generic_swapfile_activate(sis, swap_file, span);
2407}
2408
2409static int swap_node(struct swap_info_struct *p)
2410{
2411 struct block_device *bdev;
2412
2413 if (p->bdev)
2414 bdev = p->bdev;
2415 else
2416 bdev = p->swap_file->f_inode->i_sb->s_bdev;
2417
2418 return bdev ? bdev->bd_disk->node_id : NUMA_NO_NODE;
2419}
2420
2421static void setup_swap_info(struct swap_info_struct *p, int prio,
2422 unsigned char *swap_map,
2423 struct swap_cluster_info *cluster_info)
2424{
2425 int i;
2426
2427 if (prio >= 0)
2428 p->prio = prio;
2429 else
2430 p->prio = --least_priority;
2431 /*
2432 * the plist prio is negated because plist ordering is
2433 * low-to-high, while swap ordering is high-to-low
2434 */
2435 p->list.prio = -p->prio;
2436 for_each_node(i) {
2437 if (p->prio >= 0)
2438 p->avail_lists[i].prio = -p->prio;
2439 else {
2440 if (swap_node(p) == i)
2441 p->avail_lists[i].prio = 1;
2442 else
2443 p->avail_lists[i].prio = -p->prio;
2444 }
2445 }
2446 p->swap_map = swap_map;
2447 p->cluster_info = cluster_info;
2448}
2449
2450static void _enable_swap_info(struct swap_info_struct *p)
2451{
2452 p->flags |= SWP_WRITEOK | SWP_VALID;
2453 atomic_long_add(p->pages, &nr_swap_pages);
2454 total_swap_pages += p->pages;
2455
2456 assert_spin_locked(&swap_lock);
2457 /*
2458 * both lists are plists, and thus priority ordered.
2459 * swap_active_head needs to be priority ordered for swapoff(),
2460 * which on removal of any swap_info_struct with an auto-assigned
2461 * (i.e. negative) priority increments the auto-assigned priority
2462 * of any lower-priority swap_info_structs.
2463 * swap_avail_head needs to be priority ordered for get_swap_page(),
2464 * which allocates swap pages from the highest available priority
2465 * swap_info_struct.
2466 */
2467 plist_add(&p->list, &swap_active_head);
2468 add_to_avail_list(p);
2469}
2470
2471static void enable_swap_info(struct swap_info_struct *p, int prio,
2472 unsigned char *swap_map,
2473 struct swap_cluster_info *cluster_info,
2474 unsigned long *frontswap_map)
2475{
2476 frontswap_init(p->type, frontswap_map);
2477 spin_lock(&swap_lock);
2478 spin_lock(&p->lock);
2479 setup_swap_info(p, prio, swap_map, cluster_info);
2480 spin_unlock(&p->lock);
2481 spin_unlock(&swap_lock);
2482 /*
2483 * Guarantee swap_map, cluster_info, etc. fields are valid
2484 * between get/put_swap_device() if SWP_VALID bit is set
2485 */
2486 synchronize_rcu();
2487 spin_lock(&swap_lock);
2488 spin_lock(&p->lock);
2489 _enable_swap_info(p);
2490 spin_unlock(&p->lock);
2491 spin_unlock(&swap_lock);
2492}
2493
2494static void reinsert_swap_info(struct swap_info_struct *p)
2495{
2496 spin_lock(&swap_lock);
2497 spin_lock(&p->lock);
2498 setup_swap_info(p, p->prio, p->swap_map, p->cluster_info);
2499 _enable_swap_info(p);
2500 spin_unlock(&p->lock);
2501 spin_unlock(&swap_lock);
2502}
2503
2504bool has_usable_swap(void)
2505{
2506 bool ret = true;
2507
2508 spin_lock(&swap_lock);
2509 if (plist_head_empty(&swap_active_head))
2510 ret = false;
2511 spin_unlock(&swap_lock);
2512 return ret;
2513}
2514
2515SYSCALL_DEFINE1(swapoff, const char __user *, specialfile)
2516{
2517 struct swap_info_struct *p = NULL;
2518 unsigned char *swap_map;
2519 struct swap_cluster_info *cluster_info;
2520 unsigned long *frontswap_map;
2521 struct file *swap_file, *victim;
2522 struct address_space *mapping;
2523 struct inode *inode;
2524 struct filename *pathname;
2525 int err, found = 0;
2526 unsigned int old_block_size;
2527
2528 if (!capable(CAP_SYS_ADMIN))
2529 return -EPERM;
2530
2531 BUG_ON(!current->mm);
2532
2533 pathname = getname(specialfile);
2534 if (IS_ERR(pathname))
2535 return PTR_ERR(pathname);
2536
2537 victim = file_open_name(pathname, O_RDWR|O_LARGEFILE, 0);
2538 err = PTR_ERR(victim);
2539 if (IS_ERR(victim))
2540 goto out;
2541
2542 mapping = victim->f_mapping;
2543 spin_lock(&swap_lock);
2544 plist_for_each_entry(p, &swap_active_head, list) {
2545 if (p->flags & SWP_WRITEOK) {
2546 if (p->swap_file->f_mapping == mapping) {
2547 found = 1;
2548 break;
2549 }
2550 }
2551 }
2552 if (!found) {
2553 err = -EINVAL;
2554 spin_unlock(&swap_lock);
2555 goto out_dput;
2556 }
2557 if (!security_vm_enough_memory_mm(current->mm, p->pages))
2558 vm_unacct_memory(p->pages);
2559 else {
2560 err = -ENOMEM;
2561 spin_unlock(&swap_lock);
2562 goto out_dput;
2563 }
2564 del_from_avail_list(p);
2565 spin_lock(&p->lock);
2566 if (p->prio < 0) {
2567 struct swap_info_struct *si = p;
2568 int nid;
2569
2570 plist_for_each_entry_continue(si, &swap_active_head, list) {
2571 si->prio++;
2572 si->list.prio--;
2573 for_each_node(nid) {
2574 if (si->avail_lists[nid].prio != 1)
2575 si->avail_lists[nid].prio--;
2576 }
2577 }
2578 least_priority++;
2579 }
2580 plist_del(&p->list, &swap_active_head);
2581 atomic_long_sub(p->pages, &nr_swap_pages);
2582 total_swap_pages -= p->pages;
2583 p->flags &= ~SWP_WRITEOK;
2584 spin_unlock(&p->lock);
2585 spin_unlock(&swap_lock);
2586
2587 disable_swap_slots_cache_lock();
2588
2589 set_current_oom_origin();
2590 err = try_to_unuse(p->type, false, 0); /* force unuse all pages */
2591 clear_current_oom_origin();
2592
2593 if (err) {
2594 /* re-insert swap space back into swap_list */
2595 reinsert_swap_info(p);
2596 reenable_swap_slots_cache_unlock();
2597 goto out_dput;
2598 }
2599
2600 reenable_swap_slots_cache_unlock();
2601
2602 spin_lock(&swap_lock);
2603 spin_lock(&p->lock);
2604 p->flags &= ~SWP_VALID; /* mark swap device as invalid */
2605 spin_unlock(&p->lock);
2606 spin_unlock(&swap_lock);
2607 /*
2608 * wait for swap operations protected by get/put_swap_device()
2609 * to complete
2610 */
2611 synchronize_rcu();
2612
2613 flush_work(&p->discard_work);
2614
2615 destroy_swap_extents(p);
2616 if (p->flags & SWP_CONTINUED)
2617 free_swap_count_continuations(p);
2618
2619 if (!p->bdev || !blk_queue_nonrot(bdev_get_queue(p->bdev)))
2620 atomic_dec(&nr_rotate_swap);
2621
2622 mutex_lock(&swapon_mutex);
2623 spin_lock(&swap_lock);
2624 spin_lock(&p->lock);
2625 drain_mmlist();
2626
2627 /* wait for anyone still in scan_swap_map */
2628 p->highest_bit = 0; /* cuts scans short */
2629 while (p->flags >= SWP_SCANNING) {
2630 spin_unlock(&p->lock);
2631 spin_unlock(&swap_lock);
2632 schedule_timeout_uninterruptible(1);
2633 spin_lock(&swap_lock);
2634 spin_lock(&p->lock);
2635 }
2636
2637 swap_file = p->swap_file;
2638 old_block_size = p->old_block_size;
2639 p->swap_file = NULL;
2640 p->max = 0;
2641 swap_map = p->swap_map;
2642 p->swap_map = NULL;
2643 cluster_info = p->cluster_info;
2644 p->cluster_info = NULL;
2645 frontswap_map = frontswap_map_get(p);
2646 spin_unlock(&p->lock);
2647 spin_unlock(&swap_lock);
2648 frontswap_invalidate_area(p->type);
2649 frontswap_map_set(p, NULL);
2650 mutex_unlock(&swapon_mutex);
2651 free_percpu(p->percpu_cluster);
2652 p->percpu_cluster = NULL;
2653 vfree(swap_map);
2654 kvfree(cluster_info);
2655 kvfree(frontswap_map);
2656 /* Destroy swap account information */
2657 swap_cgroup_swapoff(p->type);
2658 exit_swap_address_space(p->type);
2659
2660 inode = mapping->host;
2661 if (S_ISBLK(inode->i_mode)) {
2662 struct block_device *bdev = I_BDEV(inode);
2663
2664 set_blocksize(bdev, old_block_size);
2665 blkdev_put(bdev, FMODE_READ | FMODE_WRITE | FMODE_EXCL);
2666 }
2667
2668 inode_lock(inode);
2669 inode->i_flags &= ~S_SWAPFILE;
2670 inode_unlock(inode);
2671 filp_close(swap_file, NULL);
2672
2673 /*
2674 * Clear the SWP_USED flag after all resources are freed so that swapon
2675 * can reuse this swap_info in alloc_swap_info() safely. It is ok to
2676 * not hold p->lock after we cleared its SWP_WRITEOK.
2677 */
2678 spin_lock(&swap_lock);
2679 p->flags = 0;
2680 spin_unlock(&swap_lock);
2681
2682 err = 0;
2683 atomic_inc(&proc_poll_event);
2684 wake_up_interruptible(&proc_poll_wait);
2685
2686out_dput:
2687 filp_close(victim, NULL);
2688out:
2689 putname(pathname);
2690 return err;
2691}
2692
2693#ifdef CONFIG_PROC_FS
2694static __poll_t swaps_poll(struct file *file, poll_table *wait)
2695{
2696 struct seq_file *seq = file->private_data;
2697
2698 poll_wait(file, &proc_poll_wait, wait);
2699
2700 if (seq->poll_event != atomic_read(&proc_poll_event)) {
2701 seq->poll_event = atomic_read(&proc_poll_event);
2702 return EPOLLIN | EPOLLRDNORM | EPOLLERR | EPOLLPRI;
2703 }
2704
2705 return EPOLLIN | EPOLLRDNORM;
2706}
2707
2708/* iterator */
2709static void *swap_start(struct seq_file *swap, loff_t *pos)
2710{
2711 struct swap_info_struct *si;
2712 int type;
2713 loff_t l = *pos;
2714
2715 mutex_lock(&swapon_mutex);
2716
2717 if (!l)
2718 return SEQ_START_TOKEN;
2719
2720 for (type = 0; (si = swap_type_to_swap_info(type)); type++) {
2721 if (!(si->flags & SWP_USED) || !si->swap_map)
2722 continue;
2723 if (!--l)
2724 return si;
2725 }
2726
2727 return NULL;
2728}
2729
2730static void *swap_next(struct seq_file *swap, void *v, loff_t *pos)
2731{
2732 struct swap_info_struct *si = v;
2733 int type;
2734
2735 if (v == SEQ_START_TOKEN)
2736 type = 0;
2737 else
2738 type = si->type + 1;
2739
2740 for (; (si = swap_type_to_swap_info(type)); type++) {
2741 if (!(si->flags & SWP_USED) || !si->swap_map)
2742 continue;
2743 ++*pos;
2744 return si;
2745 }
2746
2747 return NULL;
2748}
2749
2750static void swap_stop(struct seq_file *swap, void *v)
2751{
2752 mutex_unlock(&swapon_mutex);
2753}
2754
2755static int swap_show(struct seq_file *swap, void *v)
2756{
2757 struct swap_info_struct *si = v;
2758 struct file *file;
2759 int len;
2760
2761 if (si == SEQ_START_TOKEN) {
2762 seq_puts(swap,"Filename\t\t\t\tType\t\tSize\tUsed\tPriority\n");
2763 return 0;
2764 }
2765
2766 file = si->swap_file;
2767 len = seq_file_path(swap, file, " \t\n\\");
2768 seq_printf(swap, "%*s%s\t%u\t%u\t%d\n",
2769 len < 40 ? 40 - len : 1, " ",
2770 S_ISBLK(file_inode(file)->i_mode) ?
2771 "partition" : "file\t",
2772 si->pages << (PAGE_SHIFT - 10),
2773 si->inuse_pages << (PAGE_SHIFT - 10),
2774 si->prio);
2775 return 0;
2776}
2777
2778static const struct seq_operations swaps_op = {
2779 .start = swap_start,
2780 .next = swap_next,
2781 .stop = swap_stop,
2782 .show = swap_show
2783};
2784
2785static int swaps_open(struct inode *inode, struct file *file)
2786{
2787 struct seq_file *seq;
2788 int ret;
2789
2790 ret = seq_open(file, &swaps_op);
2791 if (ret)
2792 return ret;
2793
2794 seq = file->private_data;
2795 seq->poll_event = atomic_read(&proc_poll_event);
2796 return 0;
2797}
2798
2799static const struct file_operations proc_swaps_operations = {
2800 .open = swaps_open,
2801 .read = seq_read,
2802 .llseek = seq_lseek,
2803 .release = seq_release,
2804 .poll = swaps_poll,
2805};
2806
2807static int __init procswaps_init(void)
2808{
2809 proc_create("swaps", 0, NULL, &proc_swaps_operations);
2810 return 0;
2811}
2812__initcall(procswaps_init);
2813#endif /* CONFIG_PROC_FS */
2814
2815#ifdef MAX_SWAPFILES_CHECK
2816static int __init max_swapfiles_check(void)
2817{
2818 MAX_SWAPFILES_CHECK();
2819 return 0;
2820}
2821late_initcall(max_swapfiles_check);
2822#endif
2823
2824static struct swap_info_struct *alloc_swap_info(void)
2825{
2826 struct swap_info_struct *p;
2827 unsigned int type;
2828 int i;
2829
2830 p = kvzalloc(struct_size(p, avail_lists, nr_node_ids), GFP_KERNEL);
2831 if (!p)
2832 return ERR_PTR(-ENOMEM);
2833
2834 spin_lock(&swap_lock);
2835 for (type = 0; type < nr_swapfiles; type++) {
2836 if (!(swap_info[type]->flags & SWP_USED))
2837 break;
2838 }
2839 if (type >= MAX_SWAPFILES) {
2840 spin_unlock(&swap_lock);
2841 kvfree(p);
2842 return ERR_PTR(-EPERM);
2843 }
2844 if (type >= nr_swapfiles) {
2845 p->type = type;
2846 WRITE_ONCE(swap_info[type], p);
2847 /*
2848 * Write swap_info[type] before nr_swapfiles, in case a
2849 * racing procfs swap_start() or swap_next() is reading them.
2850 * (We never shrink nr_swapfiles, we never free this entry.)
2851 */
2852 smp_wmb();
2853 WRITE_ONCE(nr_swapfiles, nr_swapfiles + 1);
2854 } else {
2855 kvfree(p);
2856 p = swap_info[type];
2857 /*
2858 * Do not memset this entry: a racing procfs swap_next()
2859 * would be relying on p->type to remain valid.
2860 */
2861 }
2862 p->swap_extent_root = RB_ROOT;
2863 plist_node_init(&p->list, 0);
2864 for_each_node(i)
2865 plist_node_init(&p->avail_lists[i], 0);
2866 p->flags = SWP_USED;
2867 spin_unlock(&swap_lock);
2868 spin_lock_init(&p->lock);
2869 spin_lock_init(&p->cont_lock);
2870
2871 return p;
2872}
2873
2874static int claim_swapfile(struct swap_info_struct *p, struct inode *inode)
2875{
2876 int error;
2877
2878 if (S_ISBLK(inode->i_mode)) {
2879 p->bdev = bdgrab(I_BDEV(inode));
2880 error = blkdev_get(p->bdev,
2881 FMODE_READ | FMODE_WRITE | FMODE_EXCL, p);
2882 if (error < 0) {
2883 p->bdev = NULL;
2884 return error;
2885 }
2886 p->old_block_size = block_size(p->bdev);
2887 error = set_blocksize(p->bdev, PAGE_SIZE);
2888 if (error < 0)
2889 return error;
2890 p->flags |= SWP_BLKDEV;
2891 } else if (S_ISREG(inode->i_mode)) {
2892 p->bdev = inode->i_sb->s_bdev;
2893 }
2894
2895 inode_lock(inode);
2896 if (IS_SWAPFILE(inode))
2897 return -EBUSY;
2898
2899 return 0;
2900}
2901
2902
2903/*
2904 * Find out how many pages are allowed for a single swap device. There
2905 * are two limiting factors:
2906 * 1) the number of bits for the swap offset in the swp_entry_t type, and
2907 * 2) the number of bits in the swap pte, as defined by the different
2908 * architectures.
2909 *
2910 * In order to find the largest possible bit mask, a swap entry with
2911 * swap type 0 and swap offset ~0UL is created, encoded to a swap pte,
2912 * decoded to a swp_entry_t again, and finally the swap offset is
2913 * extracted.
2914 *
2915 * This will mask all the bits from the initial ~0UL mask that can't
2916 * be encoded in either the swp_entry_t or the architecture definition
2917 * of a swap pte.
2918 */
2919unsigned long generic_max_swapfile_size(void)
2920{
2921 return swp_offset(pte_to_swp_entry(
2922 swp_entry_to_pte(swp_entry(0, ~0UL)))) + 1;
2923}
2924
2925/* Can be overridden by an architecture for additional checks. */
2926__weak unsigned long max_swapfile_size(void)
2927{
2928 return generic_max_swapfile_size();
2929}
2930
2931static unsigned long read_swap_header(struct swap_info_struct *p,
2932 union swap_header *swap_header,
2933 struct inode *inode)
2934{
2935 int i;
2936 unsigned long maxpages;
2937 unsigned long swapfilepages;
2938 unsigned long last_page;
2939
2940 if (memcmp("SWAPSPACE2", swap_header->magic.magic, 10)) {
2941 pr_err("Unable to find swap-space signature\n");
2942 return 0;
2943 }
2944
2945 /* swap partition endianess hack... */
2946 if (swab32(swap_header->info.version) == 1) {
2947 swab32s(&swap_header->info.version);
2948 swab32s(&swap_header->info.last_page);
2949 swab32s(&swap_header->info.nr_badpages);
2950 if (swap_header->info.nr_badpages > MAX_SWAP_BADPAGES)
2951 return 0;
2952 for (i = 0; i < swap_header->info.nr_badpages; i++)
2953 swab32s(&swap_header->info.badpages[i]);
2954 }
2955 /* Check the swap header's sub-version */
2956 if (swap_header->info.version != 1) {
2957 pr_warn("Unable to handle swap header version %d\n",
2958 swap_header->info.version);
2959 return 0;
2960 }
2961
2962 p->lowest_bit = 1;
2963 p->cluster_next = 1;
2964 p->cluster_nr = 0;
2965
2966 maxpages = max_swapfile_size();
2967 last_page = swap_header->info.last_page;
2968 if (!last_page) {
2969 pr_warn("Empty swap-file\n");
2970 return 0;
2971 }
2972 if (last_page > maxpages) {
2973 pr_warn("Truncating oversized swap area, only using %luk out of %luk\n",
2974 maxpages << (PAGE_SHIFT - 10),
2975 last_page << (PAGE_SHIFT - 10));
2976 }
2977 if (maxpages > last_page) {
2978 maxpages = last_page + 1;
2979 /* p->max is an unsigned int: don't overflow it */
2980 if ((unsigned int)maxpages == 0)
2981 maxpages = UINT_MAX;
2982 }
2983 p->highest_bit = maxpages - 1;
2984
2985 if (!maxpages)
2986 return 0;
2987 swapfilepages = i_size_read(inode) >> PAGE_SHIFT;
2988 if (swapfilepages && maxpages > swapfilepages) {
2989 pr_warn("Swap area shorter than signature indicates\n");
2990 return 0;
2991 }
2992 if (swap_header->info.nr_badpages && S_ISREG(inode->i_mode))
2993 return 0;
2994 if (swap_header->info.nr_badpages > MAX_SWAP_BADPAGES)
2995 return 0;
2996
2997 return maxpages;
2998}
2999
3000#define SWAP_CLUSTER_INFO_COLS \
3001 DIV_ROUND_UP(L1_CACHE_BYTES, sizeof(struct swap_cluster_info))
3002#define SWAP_CLUSTER_SPACE_COLS \
3003 DIV_ROUND_UP(SWAP_ADDRESS_SPACE_PAGES, SWAPFILE_CLUSTER)
3004#define SWAP_CLUSTER_COLS \
3005 max_t(unsigned int, SWAP_CLUSTER_INFO_COLS, SWAP_CLUSTER_SPACE_COLS)
3006
3007static int setup_swap_map_and_extents(struct swap_info_struct *p,
3008 union swap_header *swap_header,
3009 unsigned char *swap_map,
3010 struct swap_cluster_info *cluster_info,
3011 unsigned long maxpages,
3012 sector_t *span)
3013{
3014 unsigned int j, k;
3015 unsigned int nr_good_pages;
3016 int nr_extents;
3017 unsigned long nr_clusters = DIV_ROUND_UP(maxpages, SWAPFILE_CLUSTER);
3018 unsigned long col = p->cluster_next / SWAPFILE_CLUSTER % SWAP_CLUSTER_COLS;
3019 unsigned long i, idx;
3020
3021 nr_good_pages = maxpages - 1; /* omit header page */
3022
3023 cluster_list_init(&p->free_clusters);
3024 cluster_list_init(&p->discard_clusters);
3025
3026 for (i = 0; i < swap_header->info.nr_badpages; i++) {
3027 unsigned int page_nr = swap_header->info.badpages[i];
3028 if (page_nr == 0 || page_nr > swap_header->info.last_page)
3029 return -EINVAL;
3030 if (page_nr < maxpages) {
3031 swap_map[page_nr] = SWAP_MAP_BAD;
3032 nr_good_pages--;
3033 /*
3034 * Haven't marked the cluster free yet, no list
3035 * operation involved
3036 */
3037 inc_cluster_info_page(p, cluster_info, page_nr);
3038 }
3039 }
3040
3041 /* Haven't marked the cluster free yet, no list operation involved */
3042 for (i = maxpages; i < round_up(maxpages, SWAPFILE_CLUSTER); i++)
3043 inc_cluster_info_page(p, cluster_info, i);
3044
3045 if (nr_good_pages) {
3046 swap_map[0] = SWAP_MAP_BAD;
3047 /*
3048 * Not mark the cluster free yet, no list
3049 * operation involved
3050 */
3051 inc_cluster_info_page(p, cluster_info, 0);
3052 p->max = maxpages;
3053 p->pages = nr_good_pages;
3054 nr_extents = setup_swap_extents(p, span);
3055 if (nr_extents < 0)
3056 return nr_extents;
3057 nr_good_pages = p->pages;
3058 }
3059 if (!nr_good_pages) {
3060 pr_warn("Empty swap-file\n");
3061 return -EINVAL;
3062 }
3063
3064 if (!cluster_info)
3065 return nr_extents;
3066
3067
3068 /*
3069 * Reduce false cache line sharing between cluster_info and
3070 * sharing same address space.
3071 */
3072 for (k = 0; k < SWAP_CLUSTER_COLS; k++) {
3073 j = (k + col) % SWAP_CLUSTER_COLS;
3074 for (i = 0; i < DIV_ROUND_UP(nr_clusters, SWAP_CLUSTER_COLS); i++) {
3075 idx = i * SWAP_CLUSTER_COLS + j;
3076 if (idx >= nr_clusters)
3077 continue;
3078 if (cluster_count(&cluster_info[idx]))
3079 continue;
3080 cluster_set_flag(&cluster_info[idx], CLUSTER_FLAG_FREE);
3081 cluster_list_add_tail(&p->free_clusters, cluster_info,
3082 idx);
3083 }
3084 }
3085 return nr_extents;
3086}
3087
3088/*
3089 * Helper to sys_swapon determining if a given swap
3090 * backing device queue supports DISCARD operations.
3091 */
3092static bool swap_discardable(struct swap_info_struct *si)
3093{
3094 struct request_queue *q = bdev_get_queue(si->bdev);
3095
3096 if (!q || !blk_queue_discard(q))
3097 return false;
3098
3099 return true;
3100}
3101
3102SYSCALL_DEFINE2(swapon, const char __user *, specialfile, int, swap_flags)
3103{
3104 struct swap_info_struct *p;
3105 struct filename *name;
3106 struct file *swap_file = NULL;
3107 struct address_space *mapping;
3108 int prio;
3109 int error;
3110 union swap_header *swap_header;
3111 int nr_extents;
3112 sector_t span;
3113 unsigned long maxpages;
3114 unsigned char *swap_map = NULL;
3115 struct swap_cluster_info *cluster_info = NULL;
3116 unsigned long *frontswap_map = NULL;
3117 struct page *page = NULL;
3118 struct inode *inode = NULL;
3119 bool inced_nr_rotate_swap = false;
3120
3121 if (swap_flags & ~SWAP_FLAGS_VALID)
3122 return -EINVAL;
3123
3124 if (!capable(CAP_SYS_ADMIN))
3125 return -EPERM;
3126
3127 if (!swap_avail_heads)
3128 return -ENOMEM;
3129
3130 p = alloc_swap_info();
3131 if (IS_ERR(p))
3132 return PTR_ERR(p);
3133
3134 INIT_WORK(&p->discard_work, swap_discard_work);
3135
3136 name = getname(specialfile);
3137 if (IS_ERR(name)) {
3138 error = PTR_ERR(name);
3139 name = NULL;
3140 goto bad_swap;
3141 }
3142 swap_file = file_open_name(name, O_RDWR|O_LARGEFILE, 0);
3143 if (IS_ERR(swap_file)) {
3144 error = PTR_ERR(swap_file);
3145 swap_file = NULL;
3146 goto bad_swap;
3147 }
3148
3149 p->swap_file = swap_file;
3150 mapping = swap_file->f_mapping;
3151 inode = mapping->host;
3152
3153 /* If S_ISREG(inode->i_mode) will do inode_lock(inode); */
3154 error = claim_swapfile(p, inode);
3155 if (unlikely(error))
3156 goto bad_swap;
3157
3158 /*
3159 * Read the swap header.
3160 */
3161 if (!mapping->a_ops->readpage) {
3162 error = -EINVAL;
3163 goto bad_swap;
3164 }
3165 page = read_mapping_page(mapping, 0, swap_file);
3166 if (IS_ERR(page)) {
3167 error = PTR_ERR(page);
3168 goto bad_swap;
3169 }
3170 swap_header = kmap(page);
3171
3172 maxpages = read_swap_header(p, swap_header, inode);
3173 if (unlikely(!maxpages)) {
3174 error = -EINVAL;
3175 goto bad_swap;
3176 }
3177
3178 /* OK, set up the swap map and apply the bad block list */
3179 swap_map = vzalloc(maxpages);
3180 if (!swap_map) {
3181 error = -ENOMEM;
3182 goto bad_swap;
3183 }
3184
3185 if (bdi_cap_stable_pages_required(inode_to_bdi(inode)))
3186 p->flags |= SWP_STABLE_WRITES;
3187
3188 if (bdi_cap_synchronous_io(inode_to_bdi(inode)))
3189 p->flags |= SWP_SYNCHRONOUS_IO;
3190
3191 if (p->bdev && blk_queue_nonrot(bdev_get_queue(p->bdev))) {
3192 int cpu;
3193 unsigned long ci, nr_cluster;
3194
3195 p->flags |= SWP_SOLIDSTATE;
3196 /*
3197 * select a random position to start with to help wear leveling
3198 * SSD
3199 */
3200 p->cluster_next = 1 + (prandom_u32() % p->highest_bit);
3201 nr_cluster = DIV_ROUND_UP(maxpages, SWAPFILE_CLUSTER);
3202
3203 cluster_info = kvcalloc(nr_cluster, sizeof(*cluster_info),
3204 GFP_KERNEL);
3205 if (!cluster_info) {
3206 error = -ENOMEM;
3207 goto bad_swap;
3208 }
3209
3210 for (ci = 0; ci < nr_cluster; ci++)
3211 spin_lock_init(&((cluster_info + ci)->lock));
3212
3213 p->percpu_cluster = alloc_percpu(struct percpu_cluster);
3214 if (!p->percpu_cluster) {
3215 error = -ENOMEM;
3216 goto bad_swap;
3217 }
3218 for_each_possible_cpu(cpu) {
3219 struct percpu_cluster *cluster;
3220 cluster = per_cpu_ptr(p->percpu_cluster, cpu);
3221 cluster_set_null(&cluster->index);
3222 }
3223 } else {
3224 atomic_inc(&nr_rotate_swap);
3225 inced_nr_rotate_swap = true;
3226 }
3227
3228 error = swap_cgroup_swapon(p->type, maxpages);
3229 if (error)
3230 goto bad_swap;
3231
3232 nr_extents = setup_swap_map_and_extents(p, swap_header, swap_map,
3233 cluster_info, maxpages, &span);
3234 if (unlikely(nr_extents < 0)) {
3235 error = nr_extents;
3236 goto bad_swap;
3237 }
3238 /* frontswap enabled? set up bit-per-page map for frontswap */
3239 if (IS_ENABLED(CONFIG_FRONTSWAP))
3240 frontswap_map = kvcalloc(BITS_TO_LONGS(maxpages),
3241 sizeof(long),
3242 GFP_KERNEL);
3243
3244 if (p->bdev &&(swap_flags & SWAP_FLAG_DISCARD) && swap_discardable(p)) {
3245 /*
3246 * When discard is enabled for swap with no particular
3247 * policy flagged, we set all swap discard flags here in
3248 * order to sustain backward compatibility with older
3249 * swapon(8) releases.
3250 */
3251 p->flags |= (SWP_DISCARDABLE | SWP_AREA_DISCARD |
3252 SWP_PAGE_DISCARD);
3253
3254 /*
3255 * By flagging sys_swapon, a sysadmin can tell us to
3256 * either do single-time area discards only, or to just
3257 * perform discards for released swap page-clusters.
3258 * Now it's time to adjust the p->flags accordingly.
3259 */
3260 if (swap_flags & SWAP_FLAG_DISCARD_ONCE)
3261 p->flags &= ~SWP_PAGE_DISCARD;
3262 else if (swap_flags & SWAP_FLAG_DISCARD_PAGES)
3263 p->flags &= ~SWP_AREA_DISCARD;
3264
3265 /* issue a swapon-time discard if it's still required */
3266 if (p->flags & SWP_AREA_DISCARD) {
3267 int err = discard_swap(p);
3268 if (unlikely(err))
3269 pr_err("swapon: discard_swap(%p): %d\n",
3270 p, err);
3271 }
3272 }
3273
3274 error = init_swap_address_space(p->type, maxpages);
3275 if (error)
3276 goto bad_swap;
3277
3278 /*
3279 * Flush any pending IO and dirty mappings before we start using this
3280 * swap device.
3281 */
3282 inode->i_flags |= S_SWAPFILE;
3283 error = inode_drain_writes(inode);
3284 if (error) {
3285 inode->i_flags &= ~S_SWAPFILE;
3286 goto bad_swap;
3287 }
3288
3289 mutex_lock(&swapon_mutex);
3290 prio = -1;
3291 if (swap_flags & SWAP_FLAG_PREFER)
3292 prio =
3293 (swap_flags & SWAP_FLAG_PRIO_MASK) >> SWAP_FLAG_PRIO_SHIFT;
3294 enable_swap_info(p, prio, swap_map, cluster_info, frontswap_map);
3295
3296 pr_info("Adding %uk swap on %s. Priority:%d extents:%d across:%lluk %s%s%s%s%s\n",
3297 p->pages<<(PAGE_SHIFT-10), name->name, p->prio,
3298 nr_extents, (unsigned long long)span<<(PAGE_SHIFT-10),
3299 (p->flags & SWP_SOLIDSTATE) ? "SS" : "",
3300 (p->flags & SWP_DISCARDABLE) ? "D" : "",
3301 (p->flags & SWP_AREA_DISCARD) ? "s" : "",
3302 (p->flags & SWP_PAGE_DISCARD) ? "c" : "",
3303 (frontswap_map) ? "FS" : "");
3304
3305 mutex_unlock(&swapon_mutex);
3306 atomic_inc(&proc_poll_event);
3307 wake_up_interruptible(&proc_poll_wait);
3308
3309 error = 0;
3310 goto out;
3311bad_swap:
3312 free_percpu(p->percpu_cluster);
3313 p->percpu_cluster = NULL;
3314 if (inode && S_ISBLK(inode->i_mode) && p->bdev) {
3315 set_blocksize(p->bdev, p->old_block_size);
3316 blkdev_put(p->bdev, FMODE_READ | FMODE_WRITE | FMODE_EXCL);
3317 }
3318 destroy_swap_extents(p);
3319 swap_cgroup_swapoff(p->type);
3320 spin_lock(&swap_lock);
3321 p->swap_file = NULL;
3322 p->flags = 0;
3323 spin_unlock(&swap_lock);
3324 vfree(swap_map);
3325 kvfree(cluster_info);
3326 kvfree(frontswap_map);
3327 if (inced_nr_rotate_swap)
3328 atomic_dec(&nr_rotate_swap);
3329 if (swap_file) {
3330 if (inode) {
3331 inode_unlock(inode);
3332 inode = NULL;
3333 }
3334 filp_close(swap_file, NULL);
3335 }
3336out:
3337 if (page && !IS_ERR(page)) {
3338 kunmap(page);
3339 put_page(page);
3340 }
3341 if (name)
3342 putname(name);
3343 if (inode)
3344 inode_unlock(inode);
3345 if (!error)
3346 enable_swap_slots_cache();
3347 return error;
3348}
3349
3350void si_swapinfo(struct sysinfo *val)
3351{
3352 unsigned int type;
3353 unsigned long nr_to_be_unused = 0;
3354
3355 spin_lock(&swap_lock);
3356 for (type = 0; type < nr_swapfiles; type++) {
3357 struct swap_info_struct *si = swap_info[type];
3358
3359 if ((si->flags & SWP_USED) && !(si->flags & SWP_WRITEOK))
3360 nr_to_be_unused += si->inuse_pages;
3361 }
3362 val->freeswap = atomic_long_read(&nr_swap_pages) + nr_to_be_unused;
3363 val->totalswap = total_swap_pages + nr_to_be_unused;
3364 spin_unlock(&swap_lock);
3365}
3366
3367/*
3368 * Verify that a swap entry is valid and increment its swap map count.
3369 *
3370 * Returns error code in following case.
3371 * - success -> 0
3372 * - swp_entry is invalid -> EINVAL
3373 * - swp_entry is migration entry -> EINVAL
3374 * - swap-cache reference is requested but there is already one. -> EEXIST
3375 * - swap-cache reference is requested but the entry is not used. -> ENOENT
3376 * - swap-mapped reference requested but needs continued swap count. -> ENOMEM
3377 */
3378static int __swap_duplicate(swp_entry_t entry, unsigned char usage)
3379{
3380 struct swap_info_struct *p;
3381 struct swap_cluster_info *ci;
3382 unsigned long offset;
3383 unsigned char count;
3384 unsigned char has_cache;
3385 int err = -EINVAL;
3386
3387 p = get_swap_device(entry);
3388 if (!p)
3389 goto out;
3390
3391 offset = swp_offset(entry);
3392 ci = lock_cluster_or_swap_info(p, offset);
3393
3394 count = p->swap_map[offset];
3395
3396 /*
3397 * swapin_readahead() doesn't check if a swap entry is valid, so the
3398 * swap entry could be SWAP_MAP_BAD. Check here with lock held.
3399 */
3400 if (unlikely(swap_count(count) == SWAP_MAP_BAD)) {
3401 err = -ENOENT;
3402 goto unlock_out;
3403 }
3404
3405 has_cache = count & SWAP_HAS_CACHE;
3406 count &= ~SWAP_HAS_CACHE;
3407 err = 0;
3408
3409 if (usage == SWAP_HAS_CACHE) {
3410
3411 /* set SWAP_HAS_CACHE if there is no cache and entry is used */
3412 if (!has_cache && count)
3413 has_cache = SWAP_HAS_CACHE;
3414 else if (has_cache) /* someone else added cache */
3415 err = -EEXIST;
3416 else /* no users remaining */
3417 err = -ENOENT;
3418
3419 } else if (count || has_cache) {
3420
3421 if ((count & ~COUNT_CONTINUED) < SWAP_MAP_MAX)
3422 count += usage;
3423 else if ((count & ~COUNT_CONTINUED) > SWAP_MAP_MAX)
3424 err = -EINVAL;
3425 else if (swap_count_continued(p, offset, count))
3426 count = COUNT_CONTINUED;
3427 else
3428 err = -ENOMEM;
3429 } else
3430 err = -ENOENT; /* unused swap entry */
3431
3432 p->swap_map[offset] = count | has_cache;
3433
3434unlock_out:
3435 unlock_cluster_or_swap_info(p, ci);
3436out:
3437 if (p)
3438 put_swap_device(p);
3439 return err;
3440}
3441
3442/*
3443 * Help swapoff by noting that swap entry belongs to shmem/tmpfs
3444 * (in which case its reference count is never incremented).
3445 */
3446void swap_shmem_alloc(swp_entry_t entry)
3447{
3448 __swap_duplicate(entry, SWAP_MAP_SHMEM);
3449}
3450
3451/*
3452 * Increase reference count of swap entry by 1.
3453 * Returns 0 for success, or -ENOMEM if a swap_count_continuation is required
3454 * but could not be atomically allocated. Returns 0, just as if it succeeded,
3455 * if __swap_duplicate() fails for another reason (-EINVAL or -ENOENT), which
3456 * might occur if a page table entry has got corrupted.
3457 */
3458int swap_duplicate(swp_entry_t entry)
3459{
3460 int err = 0;
3461
3462 while (!err && __swap_duplicate(entry, 1) == -ENOMEM)
3463 err = add_swap_count_continuation(entry, GFP_ATOMIC);
3464 return err;
3465}
3466
3467/*
3468 * @entry: swap entry for which we allocate swap cache.
3469 *
3470 * Called when allocating swap cache for existing swap entry,
3471 * This can return error codes. Returns 0 at success.
3472 * -EBUSY means there is a swap cache.
3473 * Note: return code is different from swap_duplicate().
3474 */
3475int swapcache_prepare(swp_entry_t entry)
3476{
3477 return __swap_duplicate(entry, SWAP_HAS_CACHE);
3478}
3479
3480struct swap_info_struct *swp_swap_info(swp_entry_t entry)
3481{
3482 return swap_type_to_swap_info(swp_type(entry));
3483}
3484
3485struct swap_info_struct *page_swap_info(struct page *page)
3486{
3487 swp_entry_t entry = { .val = page_private(page) };
3488 return swp_swap_info(entry);
3489}
3490
3491/*
3492 * out-of-line __page_file_ methods to avoid include hell.
3493 */
3494struct address_space *__page_file_mapping(struct page *page)
3495{
3496 return page_swap_info(page)->swap_file->f_mapping;
3497}
3498EXPORT_SYMBOL_GPL(__page_file_mapping);
3499
3500pgoff_t __page_file_index(struct page *page)
3501{
3502 swp_entry_t swap = { .val = page_private(page) };
3503 return swp_offset(swap);
3504}
3505EXPORT_SYMBOL_GPL(__page_file_index);
3506
3507/*
3508 * add_swap_count_continuation - called when a swap count is duplicated
3509 * beyond SWAP_MAP_MAX, it allocates a new page and links that to the entry's
3510 * page of the original vmalloc'ed swap_map, to hold the continuation count
3511 * (for that entry and for its neighbouring PAGE_SIZE swap entries). Called
3512 * again when count is duplicated beyond SWAP_MAP_MAX * SWAP_CONT_MAX, etc.
3513 *
3514 * These continuation pages are seldom referenced: the common paths all work
3515 * on the original swap_map, only referring to a continuation page when the
3516 * low "digit" of a count is incremented or decremented through SWAP_MAP_MAX.
3517 *
3518 * add_swap_count_continuation(, GFP_ATOMIC) can be called while holding
3519 * page table locks; if it fails, add_swap_count_continuation(, GFP_KERNEL)
3520 * can be called after dropping locks.
3521 */
3522int add_swap_count_continuation(swp_entry_t entry, gfp_t gfp_mask)
3523{
3524 struct swap_info_struct *si;
3525 struct swap_cluster_info *ci;
3526 struct page *head;
3527 struct page *page;
3528 struct page *list_page;
3529 pgoff_t offset;
3530 unsigned char count;
3531 int ret = 0;
3532
3533 /*
3534 * When debugging, it's easier to use __GFP_ZERO here; but it's better
3535 * for latency not to zero a page while GFP_ATOMIC and holding locks.
3536 */
3537 page = alloc_page(gfp_mask | __GFP_HIGHMEM);
3538
3539 si = get_swap_device(entry);
3540 if (!si) {
3541 /*
3542 * An acceptable race has occurred since the failing
3543 * __swap_duplicate(): the swap device may be swapoff
3544 */
3545 goto outer;
3546 }
3547 spin_lock(&si->lock);
3548
3549 offset = swp_offset(entry);
3550
3551 ci = lock_cluster(si, offset);
3552
3553 count = si->swap_map[offset] & ~SWAP_HAS_CACHE;
3554
3555 if ((count & ~COUNT_CONTINUED) != SWAP_MAP_MAX) {
3556 /*
3557 * The higher the swap count, the more likely it is that tasks
3558 * will race to add swap count continuation: we need to avoid
3559 * over-provisioning.
3560 */
3561 goto out;
3562 }
3563
3564 if (!page) {
3565 ret = -ENOMEM;
3566 goto out;
3567 }
3568
3569 /*
3570 * We are fortunate that although vmalloc_to_page uses pte_offset_map,
3571 * no architecture is using highmem pages for kernel page tables: so it
3572 * will not corrupt the GFP_ATOMIC caller's atomic page table kmaps.
3573 */
3574 head = vmalloc_to_page(si->swap_map + offset);
3575 offset &= ~PAGE_MASK;
3576
3577 spin_lock(&si->cont_lock);
3578 /*
3579 * Page allocation does not initialize the page's lru field,
3580 * but it does always reset its private field.
3581 */
3582 if (!page_private(head)) {
3583 BUG_ON(count & COUNT_CONTINUED);
3584 INIT_LIST_HEAD(&head->lru);
3585 set_page_private(head, SWP_CONTINUED);
3586 si->flags |= SWP_CONTINUED;
3587 }
3588
3589 list_for_each_entry(list_page, &head->lru, lru) {
3590 unsigned char *map;
3591
3592 /*
3593 * If the previous map said no continuation, but we've found
3594 * a continuation page, free our allocation and use this one.
3595 */
3596 if (!(count & COUNT_CONTINUED))
3597 goto out_unlock_cont;
3598
3599 map = kmap_atomic(list_page) + offset;
3600 count = *map;
3601 kunmap_atomic(map);
3602
3603 /*
3604 * If this continuation count now has some space in it,
3605 * free our allocation and use this one.
3606 */
3607 if ((count & ~COUNT_CONTINUED) != SWAP_CONT_MAX)
3608 goto out_unlock_cont;
3609 }
3610
3611 list_add_tail(&page->lru, &head->lru);
3612 page = NULL; /* now it's attached, don't free it */
3613out_unlock_cont:
3614 spin_unlock(&si->cont_lock);
3615out:
3616 unlock_cluster(ci);
3617 spin_unlock(&si->lock);
3618 put_swap_device(si);
3619outer:
3620 if (page)
3621 __free_page(page);
3622 return ret;
3623}
3624
3625/*
3626 * swap_count_continued - when the original swap_map count is incremented
3627 * from SWAP_MAP_MAX, check if there is already a continuation page to carry
3628 * into, carry if so, or else fail until a new continuation page is allocated;
3629 * when the original swap_map count is decremented from 0 with continuation,
3630 * borrow from the continuation and report whether it still holds more.
3631 * Called while __swap_duplicate() or swap_entry_free() holds swap or cluster
3632 * lock.
3633 */
3634static bool swap_count_continued(struct swap_info_struct *si,
3635 pgoff_t offset, unsigned char count)
3636{
3637 struct page *head;
3638 struct page *page;
3639 unsigned char *map;
3640 bool ret;
3641
3642 head = vmalloc_to_page(si->swap_map + offset);
3643 if (page_private(head) != SWP_CONTINUED) {
3644 BUG_ON(count & COUNT_CONTINUED);
3645 return false; /* need to add count continuation */
3646 }
3647
3648 spin_lock(&si->cont_lock);
3649 offset &= ~PAGE_MASK;
3650 page = list_entry(head->lru.next, struct page, lru);
3651 map = kmap_atomic(page) + offset;
3652
3653 if (count == SWAP_MAP_MAX) /* initial increment from swap_map */
3654 goto init_map; /* jump over SWAP_CONT_MAX checks */
3655
3656 if (count == (SWAP_MAP_MAX | COUNT_CONTINUED)) { /* incrementing */
3657 /*
3658 * Think of how you add 1 to 999
3659 */
3660 while (*map == (SWAP_CONT_MAX | COUNT_CONTINUED)) {
3661 kunmap_atomic(map);
3662 page = list_entry(page->lru.next, struct page, lru);
3663 BUG_ON(page == head);
3664 map = kmap_atomic(page) + offset;
3665 }
3666 if (*map == SWAP_CONT_MAX) {
3667 kunmap_atomic(map);
3668 page = list_entry(page->lru.next, struct page, lru);
3669 if (page == head) {
3670 ret = false; /* add count continuation */
3671 goto out;
3672 }
3673 map = kmap_atomic(page) + offset;
3674init_map: *map = 0; /* we didn't zero the page */
3675 }
3676 *map += 1;
3677 kunmap_atomic(map);
3678 page = list_entry(page->lru.prev, struct page, lru);
3679 while (page != head) {
3680 map = kmap_atomic(page) + offset;
3681 *map = COUNT_CONTINUED;
3682 kunmap_atomic(map);
3683 page = list_entry(page->lru.prev, struct page, lru);
3684 }
3685 ret = true; /* incremented */
3686
3687 } else { /* decrementing */
3688 /*
3689 * Think of how you subtract 1 from 1000
3690 */
3691 BUG_ON(count != COUNT_CONTINUED);
3692 while (*map == COUNT_CONTINUED) {
3693 kunmap_atomic(map);
3694 page = list_entry(page->lru.next, struct page, lru);
3695 BUG_ON(page == head);
3696 map = kmap_atomic(page) + offset;
3697 }
3698 BUG_ON(*map == 0);
3699 *map -= 1;
3700 if (*map == 0)
3701 count = 0;
3702 kunmap_atomic(map);
3703 page = list_entry(page->lru.prev, struct page, lru);
3704 while (page != head) {
3705 map = kmap_atomic(page) + offset;
3706 *map = SWAP_CONT_MAX | count;
3707 count = COUNT_CONTINUED;
3708 kunmap_atomic(map);
3709 page = list_entry(page->lru.prev, struct page, lru);
3710 }
3711 ret = count == COUNT_CONTINUED;
3712 }
3713out:
3714 spin_unlock(&si->cont_lock);
3715 return ret;
3716}
3717
3718/*
3719 * free_swap_count_continuations - swapoff free all the continuation pages
3720 * appended to the swap_map, after swap_map is quiesced, before vfree'ing it.
3721 */
3722static void free_swap_count_continuations(struct swap_info_struct *si)
3723{
3724 pgoff_t offset;
3725
3726 for (offset = 0; offset < si->max; offset += PAGE_SIZE) {
3727 struct page *head;
3728 head = vmalloc_to_page(si->swap_map + offset);
3729 if (page_private(head)) {
3730 struct page *page, *next;
3731
3732 list_for_each_entry_safe(page, next, &head->lru, lru) {
3733 list_del(&page->lru);
3734 __free_page(page);
3735 }
3736 }
3737 }
3738}
3739
3740#if defined(CONFIG_MEMCG) && defined(CONFIG_BLK_CGROUP)
3741void mem_cgroup_throttle_swaprate(struct mem_cgroup *memcg, int node,
3742 gfp_t gfp_mask)
3743{
3744 struct swap_info_struct *si, *next;
3745 if (!(gfp_mask & __GFP_IO) || !memcg)
3746 return;
3747
3748 if (!blk_cgroup_congested())
3749 return;
3750
3751 /*
3752 * We've already scheduled a throttle, avoid taking the global swap
3753 * lock.
3754 */
3755 if (current->throttle_queue)
3756 return;
3757
3758 spin_lock(&swap_avail_lock);
3759 plist_for_each_entry_safe(si, next, &swap_avail_heads[node],
3760 avail_lists[node]) {
3761 if (si->bdev) {
3762 blkcg_schedule_throttle(bdev_get_queue(si->bdev),
3763 true);
3764 break;
3765 }
3766 }
3767 spin_unlock(&swap_avail_lock);
3768}
3769#endif
3770
3771static int __init swapfile_init(void)
3772{
3773 int nid;
3774
3775 swap_avail_heads = kmalloc_array(nr_node_ids, sizeof(struct plist_head),
3776 GFP_KERNEL);
3777 if (!swap_avail_heads) {
3778 pr_emerg("Not enough memory for swap heads, swap is disabled\n");
3779 return -ENOMEM;
3780 }
3781
3782 for_each_node(nid)
3783 plist_head_init(&swap_avail_heads[nid]);
3784
3785 return 0;
3786}
3787subsys_initcall(swapfile_init);
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * linux/mm/swapfile.c
4 *
5 * Copyright (C) 1991, 1992, 1993, 1994 Linus Torvalds
6 * Swap reorganised 29.12.95, Stephen Tweedie
7 */
8
9#include <linux/mm.h>
10#include <linux/sched/mm.h>
11#include <linux/sched/task.h>
12#include <linux/hugetlb.h>
13#include <linux/mman.h>
14#include <linux/slab.h>
15#include <linux/kernel_stat.h>
16#include <linux/swap.h>
17#include <linux/vmalloc.h>
18#include <linux/pagemap.h>
19#include <linux/namei.h>
20#include <linux/shmem_fs.h>
21#include <linux/blkdev.h>
22#include <linux/random.h>
23#include <linux/writeback.h>
24#include <linux/proc_fs.h>
25#include <linux/seq_file.h>
26#include <linux/init.h>
27#include <linux/ksm.h>
28#include <linux/rmap.h>
29#include <linux/security.h>
30#include <linux/backing-dev.h>
31#include <linux/mutex.h>
32#include <linux/capability.h>
33#include <linux/syscalls.h>
34#include <linux/memcontrol.h>
35#include <linux/poll.h>
36#include <linux/oom.h>
37#include <linux/frontswap.h>
38#include <linux/swapfile.h>
39#include <linux/export.h>
40#include <linux/swap_slots.h>
41#include <linux/sort.h>
42#include <linux/completion.h>
43
44#include <asm/tlbflush.h>
45#include <linux/swapops.h>
46#include <linux/swap_cgroup.h>
47
48static bool swap_count_continued(struct swap_info_struct *, pgoff_t,
49 unsigned char);
50static void free_swap_count_continuations(struct swap_info_struct *);
51
52DEFINE_SPINLOCK(swap_lock);
53static unsigned int nr_swapfiles;
54atomic_long_t nr_swap_pages;
55/*
56 * Some modules use swappable objects and may try to swap them out under
57 * memory pressure (via the shrinker). Before doing so, they may wish to
58 * check to see if any swap space is available.
59 */
60EXPORT_SYMBOL_GPL(nr_swap_pages);
61/* protected with swap_lock. reading in vm_swap_full() doesn't need lock */
62long total_swap_pages;
63static int least_priority = -1;
64
65static const char Bad_file[] = "Bad swap file entry ";
66static const char Unused_file[] = "Unused swap file entry ";
67static const char Bad_offset[] = "Bad swap offset entry ";
68static const char Unused_offset[] = "Unused swap offset entry ";
69
70/*
71 * all active swap_info_structs
72 * protected with swap_lock, and ordered by priority.
73 */
74PLIST_HEAD(swap_active_head);
75
76/*
77 * all available (active, not full) swap_info_structs
78 * protected with swap_avail_lock, ordered by priority.
79 * This is used by get_swap_page() instead of swap_active_head
80 * because swap_active_head includes all swap_info_structs,
81 * but get_swap_page() doesn't need to look at full ones.
82 * This uses its own lock instead of swap_lock because when a
83 * swap_info_struct changes between not-full/full, it needs to
84 * add/remove itself to/from this list, but the swap_info_struct->lock
85 * is held and the locking order requires swap_lock to be taken
86 * before any swap_info_struct->lock.
87 */
88static struct plist_head *swap_avail_heads;
89static DEFINE_SPINLOCK(swap_avail_lock);
90
91struct swap_info_struct *swap_info[MAX_SWAPFILES];
92
93static DEFINE_MUTEX(swapon_mutex);
94
95static DECLARE_WAIT_QUEUE_HEAD(proc_poll_wait);
96/* Activity counter to indicate that a swapon or swapoff has occurred */
97static atomic_t proc_poll_event = ATOMIC_INIT(0);
98
99atomic_t nr_rotate_swap = ATOMIC_INIT(0);
100
101static struct swap_info_struct *swap_type_to_swap_info(int type)
102{
103 if (type >= MAX_SWAPFILES)
104 return NULL;
105
106 return READ_ONCE(swap_info[type]); /* rcu_dereference() */
107}
108
109static inline unsigned char swap_count(unsigned char ent)
110{
111 return ent & ~SWAP_HAS_CACHE; /* may include COUNT_CONTINUED flag */
112}
113
114/* Reclaim the swap entry anyway if possible */
115#define TTRS_ANYWAY 0x1
116/*
117 * Reclaim the swap entry if there are no more mappings of the
118 * corresponding page
119 */
120#define TTRS_UNMAPPED 0x2
121/* Reclaim the swap entry if swap is getting full*/
122#define TTRS_FULL 0x4
123
124/* returns 1 if swap entry is freed */
125static int __try_to_reclaim_swap(struct swap_info_struct *si,
126 unsigned long offset, unsigned long flags)
127{
128 swp_entry_t entry = swp_entry(si->type, offset);
129 struct page *page;
130 int ret = 0;
131
132 page = find_get_page(swap_address_space(entry), offset);
133 if (!page)
134 return 0;
135 /*
136 * When this function is called from scan_swap_map_slots() and it's
137 * called by vmscan.c at reclaiming pages. So, we hold a lock on a page,
138 * here. We have to use trylock for avoiding deadlock. This is a special
139 * case and you should use try_to_free_swap() with explicit lock_page()
140 * in usual operations.
141 */
142 if (trylock_page(page)) {
143 if ((flags & TTRS_ANYWAY) ||
144 ((flags & TTRS_UNMAPPED) && !page_mapped(page)) ||
145 ((flags & TTRS_FULL) && mem_cgroup_swap_full(page)))
146 ret = try_to_free_swap(page);
147 unlock_page(page);
148 }
149 put_page(page);
150 return ret;
151}
152
153static inline struct swap_extent *first_se(struct swap_info_struct *sis)
154{
155 struct rb_node *rb = rb_first(&sis->swap_extent_root);
156 return rb_entry(rb, struct swap_extent, rb_node);
157}
158
159static inline struct swap_extent *next_se(struct swap_extent *se)
160{
161 struct rb_node *rb = rb_next(&se->rb_node);
162 return rb ? rb_entry(rb, struct swap_extent, rb_node) : NULL;
163}
164
165/*
166 * swapon tell device that all the old swap contents can be discarded,
167 * to allow the swap device to optimize its wear-levelling.
168 */
169static int discard_swap(struct swap_info_struct *si)
170{
171 struct swap_extent *se;
172 sector_t start_block;
173 sector_t nr_blocks;
174 int err = 0;
175
176 /* Do not discard the swap header page! */
177 se = first_se(si);
178 start_block = (se->start_block + 1) << (PAGE_SHIFT - 9);
179 nr_blocks = ((sector_t)se->nr_pages - 1) << (PAGE_SHIFT - 9);
180 if (nr_blocks) {
181 err = blkdev_issue_discard(si->bdev, start_block,
182 nr_blocks, GFP_KERNEL, 0);
183 if (err)
184 return err;
185 cond_resched();
186 }
187
188 for (se = next_se(se); se; se = next_se(se)) {
189 start_block = se->start_block << (PAGE_SHIFT - 9);
190 nr_blocks = (sector_t)se->nr_pages << (PAGE_SHIFT - 9);
191
192 err = blkdev_issue_discard(si->bdev, start_block,
193 nr_blocks, GFP_KERNEL, 0);
194 if (err)
195 break;
196
197 cond_resched();
198 }
199 return err; /* That will often be -EOPNOTSUPP */
200}
201
202static struct swap_extent *
203offset_to_swap_extent(struct swap_info_struct *sis, unsigned long offset)
204{
205 struct swap_extent *se;
206 struct rb_node *rb;
207
208 rb = sis->swap_extent_root.rb_node;
209 while (rb) {
210 se = rb_entry(rb, struct swap_extent, rb_node);
211 if (offset < se->start_page)
212 rb = rb->rb_left;
213 else if (offset >= se->start_page + se->nr_pages)
214 rb = rb->rb_right;
215 else
216 return se;
217 }
218 /* It *must* be present */
219 BUG();
220}
221
222sector_t swap_page_sector(struct page *page)
223{
224 struct swap_info_struct *sis = page_swap_info(page);
225 struct swap_extent *se;
226 sector_t sector;
227 pgoff_t offset;
228
229 offset = __page_file_index(page);
230 se = offset_to_swap_extent(sis, offset);
231 sector = se->start_block + (offset - se->start_page);
232 return sector << (PAGE_SHIFT - 9);
233}
234
235/*
236 * swap allocation tell device that a cluster of swap can now be discarded,
237 * to allow the swap device to optimize its wear-levelling.
238 */
239static void discard_swap_cluster(struct swap_info_struct *si,
240 pgoff_t start_page, pgoff_t nr_pages)
241{
242 struct swap_extent *se = offset_to_swap_extent(si, start_page);
243
244 while (nr_pages) {
245 pgoff_t offset = start_page - se->start_page;
246 sector_t start_block = se->start_block + offset;
247 sector_t nr_blocks = se->nr_pages - offset;
248
249 if (nr_blocks > nr_pages)
250 nr_blocks = nr_pages;
251 start_page += nr_blocks;
252 nr_pages -= nr_blocks;
253
254 start_block <<= PAGE_SHIFT - 9;
255 nr_blocks <<= PAGE_SHIFT - 9;
256 if (blkdev_issue_discard(si->bdev, start_block,
257 nr_blocks, GFP_NOIO, 0))
258 break;
259
260 se = next_se(se);
261 }
262}
263
264#ifdef CONFIG_THP_SWAP
265#define SWAPFILE_CLUSTER HPAGE_PMD_NR
266
267#define swap_entry_size(size) (size)
268#else
269#define SWAPFILE_CLUSTER 256
270
271/*
272 * Define swap_entry_size() as constant to let compiler to optimize
273 * out some code if !CONFIG_THP_SWAP
274 */
275#define swap_entry_size(size) 1
276#endif
277#define LATENCY_LIMIT 256
278
279static inline void cluster_set_flag(struct swap_cluster_info *info,
280 unsigned int flag)
281{
282 info->flags = flag;
283}
284
285static inline unsigned int cluster_count(struct swap_cluster_info *info)
286{
287 return info->data;
288}
289
290static inline void cluster_set_count(struct swap_cluster_info *info,
291 unsigned int c)
292{
293 info->data = c;
294}
295
296static inline void cluster_set_count_flag(struct swap_cluster_info *info,
297 unsigned int c, unsigned int f)
298{
299 info->flags = f;
300 info->data = c;
301}
302
303static inline unsigned int cluster_next(struct swap_cluster_info *info)
304{
305 return info->data;
306}
307
308static inline void cluster_set_next(struct swap_cluster_info *info,
309 unsigned int n)
310{
311 info->data = n;
312}
313
314static inline void cluster_set_next_flag(struct swap_cluster_info *info,
315 unsigned int n, unsigned int f)
316{
317 info->flags = f;
318 info->data = n;
319}
320
321static inline bool cluster_is_free(struct swap_cluster_info *info)
322{
323 return info->flags & CLUSTER_FLAG_FREE;
324}
325
326static inline bool cluster_is_null(struct swap_cluster_info *info)
327{
328 return info->flags & CLUSTER_FLAG_NEXT_NULL;
329}
330
331static inline void cluster_set_null(struct swap_cluster_info *info)
332{
333 info->flags = CLUSTER_FLAG_NEXT_NULL;
334 info->data = 0;
335}
336
337static inline bool cluster_is_huge(struct swap_cluster_info *info)
338{
339 if (IS_ENABLED(CONFIG_THP_SWAP))
340 return info->flags & CLUSTER_FLAG_HUGE;
341 return false;
342}
343
344static inline void cluster_clear_huge(struct swap_cluster_info *info)
345{
346 info->flags &= ~CLUSTER_FLAG_HUGE;
347}
348
349static inline struct swap_cluster_info *lock_cluster(struct swap_info_struct *si,
350 unsigned long offset)
351{
352 struct swap_cluster_info *ci;
353
354 ci = si->cluster_info;
355 if (ci) {
356 ci += offset / SWAPFILE_CLUSTER;
357 spin_lock(&ci->lock);
358 }
359 return ci;
360}
361
362static inline void unlock_cluster(struct swap_cluster_info *ci)
363{
364 if (ci)
365 spin_unlock(&ci->lock);
366}
367
368/*
369 * Determine the locking method in use for this device. Return
370 * swap_cluster_info if SSD-style cluster-based locking is in place.
371 */
372static inline struct swap_cluster_info *lock_cluster_or_swap_info(
373 struct swap_info_struct *si, unsigned long offset)
374{
375 struct swap_cluster_info *ci;
376
377 /* Try to use fine-grained SSD-style locking if available: */
378 ci = lock_cluster(si, offset);
379 /* Otherwise, fall back to traditional, coarse locking: */
380 if (!ci)
381 spin_lock(&si->lock);
382
383 return ci;
384}
385
386static inline void unlock_cluster_or_swap_info(struct swap_info_struct *si,
387 struct swap_cluster_info *ci)
388{
389 if (ci)
390 unlock_cluster(ci);
391 else
392 spin_unlock(&si->lock);
393}
394
395static inline bool cluster_list_empty(struct swap_cluster_list *list)
396{
397 return cluster_is_null(&list->head);
398}
399
400static inline unsigned int cluster_list_first(struct swap_cluster_list *list)
401{
402 return cluster_next(&list->head);
403}
404
405static void cluster_list_init(struct swap_cluster_list *list)
406{
407 cluster_set_null(&list->head);
408 cluster_set_null(&list->tail);
409}
410
411static void cluster_list_add_tail(struct swap_cluster_list *list,
412 struct swap_cluster_info *ci,
413 unsigned int idx)
414{
415 if (cluster_list_empty(list)) {
416 cluster_set_next_flag(&list->head, idx, 0);
417 cluster_set_next_flag(&list->tail, idx, 0);
418 } else {
419 struct swap_cluster_info *ci_tail;
420 unsigned int tail = cluster_next(&list->tail);
421
422 /*
423 * Nested cluster lock, but both cluster locks are
424 * only acquired when we held swap_info_struct->lock
425 */
426 ci_tail = ci + tail;
427 spin_lock_nested(&ci_tail->lock, SINGLE_DEPTH_NESTING);
428 cluster_set_next(ci_tail, idx);
429 spin_unlock(&ci_tail->lock);
430 cluster_set_next_flag(&list->tail, idx, 0);
431 }
432}
433
434static unsigned int cluster_list_del_first(struct swap_cluster_list *list,
435 struct swap_cluster_info *ci)
436{
437 unsigned int idx;
438
439 idx = cluster_next(&list->head);
440 if (cluster_next(&list->tail) == idx) {
441 cluster_set_null(&list->head);
442 cluster_set_null(&list->tail);
443 } else
444 cluster_set_next_flag(&list->head,
445 cluster_next(&ci[idx]), 0);
446
447 return idx;
448}
449
450/* Add a cluster to discard list and schedule it to do discard */
451static void swap_cluster_schedule_discard(struct swap_info_struct *si,
452 unsigned int idx)
453{
454 /*
455 * If scan_swap_map_slots() can't find a free cluster, it will check
456 * si->swap_map directly. To make sure the discarding cluster isn't
457 * taken by scan_swap_map_slots(), mark the swap entries bad (occupied).
458 * It will be cleared after discard
459 */
460 memset(si->swap_map + idx * SWAPFILE_CLUSTER,
461 SWAP_MAP_BAD, SWAPFILE_CLUSTER);
462
463 cluster_list_add_tail(&si->discard_clusters, si->cluster_info, idx);
464
465 schedule_work(&si->discard_work);
466}
467
468static void __free_cluster(struct swap_info_struct *si, unsigned long idx)
469{
470 struct swap_cluster_info *ci = si->cluster_info;
471
472 cluster_set_flag(ci + idx, CLUSTER_FLAG_FREE);
473 cluster_list_add_tail(&si->free_clusters, ci, idx);
474}
475
476/*
477 * Doing discard actually. After a cluster discard is finished, the cluster
478 * will be added to free cluster list. caller should hold si->lock.
479*/
480static void swap_do_scheduled_discard(struct swap_info_struct *si)
481{
482 struct swap_cluster_info *info, *ci;
483 unsigned int idx;
484
485 info = si->cluster_info;
486
487 while (!cluster_list_empty(&si->discard_clusters)) {
488 idx = cluster_list_del_first(&si->discard_clusters, info);
489 spin_unlock(&si->lock);
490
491 discard_swap_cluster(si, idx * SWAPFILE_CLUSTER,
492 SWAPFILE_CLUSTER);
493
494 spin_lock(&si->lock);
495 ci = lock_cluster(si, idx * SWAPFILE_CLUSTER);
496 __free_cluster(si, idx);
497 memset(si->swap_map + idx * SWAPFILE_CLUSTER,
498 0, SWAPFILE_CLUSTER);
499 unlock_cluster(ci);
500 }
501}
502
503static void swap_discard_work(struct work_struct *work)
504{
505 struct swap_info_struct *si;
506
507 si = container_of(work, struct swap_info_struct, discard_work);
508
509 spin_lock(&si->lock);
510 swap_do_scheduled_discard(si);
511 spin_unlock(&si->lock);
512}
513
514static void swap_users_ref_free(struct percpu_ref *ref)
515{
516 struct swap_info_struct *si;
517
518 si = container_of(ref, struct swap_info_struct, users);
519 complete(&si->comp);
520}
521
522static void alloc_cluster(struct swap_info_struct *si, unsigned long idx)
523{
524 struct swap_cluster_info *ci = si->cluster_info;
525
526 VM_BUG_ON(cluster_list_first(&si->free_clusters) != idx);
527 cluster_list_del_first(&si->free_clusters, ci);
528 cluster_set_count_flag(ci + idx, 0, 0);
529}
530
531static void free_cluster(struct swap_info_struct *si, unsigned long idx)
532{
533 struct swap_cluster_info *ci = si->cluster_info + idx;
534
535 VM_BUG_ON(cluster_count(ci) != 0);
536 /*
537 * If the swap is discardable, prepare discard the cluster
538 * instead of free it immediately. The cluster will be freed
539 * after discard.
540 */
541 if ((si->flags & (SWP_WRITEOK | SWP_PAGE_DISCARD)) ==
542 (SWP_WRITEOK | SWP_PAGE_DISCARD)) {
543 swap_cluster_schedule_discard(si, idx);
544 return;
545 }
546
547 __free_cluster(si, idx);
548}
549
550/*
551 * The cluster corresponding to page_nr will be used. The cluster will be
552 * removed from free cluster list and its usage counter will be increased.
553 */
554static void inc_cluster_info_page(struct swap_info_struct *p,
555 struct swap_cluster_info *cluster_info, unsigned long page_nr)
556{
557 unsigned long idx = page_nr / SWAPFILE_CLUSTER;
558
559 if (!cluster_info)
560 return;
561 if (cluster_is_free(&cluster_info[idx]))
562 alloc_cluster(p, idx);
563
564 VM_BUG_ON(cluster_count(&cluster_info[idx]) >= SWAPFILE_CLUSTER);
565 cluster_set_count(&cluster_info[idx],
566 cluster_count(&cluster_info[idx]) + 1);
567}
568
569/*
570 * The cluster corresponding to page_nr decreases one usage. If the usage
571 * counter becomes 0, which means no page in the cluster is in using, we can
572 * optionally discard the cluster and add it to free cluster list.
573 */
574static void dec_cluster_info_page(struct swap_info_struct *p,
575 struct swap_cluster_info *cluster_info, unsigned long page_nr)
576{
577 unsigned long idx = page_nr / SWAPFILE_CLUSTER;
578
579 if (!cluster_info)
580 return;
581
582 VM_BUG_ON(cluster_count(&cluster_info[idx]) == 0);
583 cluster_set_count(&cluster_info[idx],
584 cluster_count(&cluster_info[idx]) - 1);
585
586 if (cluster_count(&cluster_info[idx]) == 0)
587 free_cluster(p, idx);
588}
589
590/*
591 * It's possible scan_swap_map_slots() uses a free cluster in the middle of free
592 * cluster list. Avoiding such abuse to avoid list corruption.
593 */
594static bool
595scan_swap_map_ssd_cluster_conflict(struct swap_info_struct *si,
596 unsigned long offset)
597{
598 struct percpu_cluster *percpu_cluster;
599 bool conflict;
600
601 offset /= SWAPFILE_CLUSTER;
602 conflict = !cluster_list_empty(&si->free_clusters) &&
603 offset != cluster_list_first(&si->free_clusters) &&
604 cluster_is_free(&si->cluster_info[offset]);
605
606 if (!conflict)
607 return false;
608
609 percpu_cluster = this_cpu_ptr(si->percpu_cluster);
610 cluster_set_null(&percpu_cluster->index);
611 return true;
612}
613
614/*
615 * Try to get a swap entry from current cpu's swap entry pool (a cluster). This
616 * might involve allocating a new cluster for current CPU too.
617 */
618static bool scan_swap_map_try_ssd_cluster(struct swap_info_struct *si,
619 unsigned long *offset, unsigned long *scan_base)
620{
621 struct percpu_cluster *cluster;
622 struct swap_cluster_info *ci;
623 unsigned long tmp, max;
624
625new_cluster:
626 cluster = this_cpu_ptr(si->percpu_cluster);
627 if (cluster_is_null(&cluster->index)) {
628 if (!cluster_list_empty(&si->free_clusters)) {
629 cluster->index = si->free_clusters.head;
630 cluster->next = cluster_next(&cluster->index) *
631 SWAPFILE_CLUSTER;
632 } else if (!cluster_list_empty(&si->discard_clusters)) {
633 /*
634 * we don't have free cluster but have some clusters in
635 * discarding, do discard now and reclaim them, then
636 * reread cluster_next_cpu since we dropped si->lock
637 */
638 swap_do_scheduled_discard(si);
639 *scan_base = this_cpu_read(*si->cluster_next_cpu);
640 *offset = *scan_base;
641 goto new_cluster;
642 } else
643 return false;
644 }
645
646 /*
647 * Other CPUs can use our cluster if they can't find a free cluster,
648 * check if there is still free entry in the cluster
649 */
650 tmp = cluster->next;
651 max = min_t(unsigned long, si->max,
652 (cluster_next(&cluster->index) + 1) * SWAPFILE_CLUSTER);
653 if (tmp < max) {
654 ci = lock_cluster(si, tmp);
655 while (tmp < max) {
656 if (!si->swap_map[tmp])
657 break;
658 tmp++;
659 }
660 unlock_cluster(ci);
661 }
662 if (tmp >= max) {
663 cluster_set_null(&cluster->index);
664 goto new_cluster;
665 }
666 cluster->next = tmp + 1;
667 *offset = tmp;
668 *scan_base = tmp;
669 return true;
670}
671
672static void __del_from_avail_list(struct swap_info_struct *p)
673{
674 int nid;
675
676 for_each_node(nid)
677 plist_del(&p->avail_lists[nid], &swap_avail_heads[nid]);
678}
679
680static void del_from_avail_list(struct swap_info_struct *p)
681{
682 spin_lock(&swap_avail_lock);
683 __del_from_avail_list(p);
684 spin_unlock(&swap_avail_lock);
685}
686
687static void swap_range_alloc(struct swap_info_struct *si, unsigned long offset,
688 unsigned int nr_entries)
689{
690 unsigned int end = offset + nr_entries - 1;
691
692 if (offset == si->lowest_bit)
693 si->lowest_bit += nr_entries;
694 if (end == si->highest_bit)
695 WRITE_ONCE(si->highest_bit, si->highest_bit - nr_entries);
696 si->inuse_pages += nr_entries;
697 if (si->inuse_pages == si->pages) {
698 si->lowest_bit = si->max;
699 si->highest_bit = 0;
700 del_from_avail_list(si);
701 }
702}
703
704static void add_to_avail_list(struct swap_info_struct *p)
705{
706 int nid;
707
708 spin_lock(&swap_avail_lock);
709 for_each_node(nid) {
710 WARN_ON(!plist_node_empty(&p->avail_lists[nid]));
711 plist_add(&p->avail_lists[nid], &swap_avail_heads[nid]);
712 }
713 spin_unlock(&swap_avail_lock);
714}
715
716static void swap_range_free(struct swap_info_struct *si, unsigned long offset,
717 unsigned int nr_entries)
718{
719 unsigned long begin = offset;
720 unsigned long end = offset + nr_entries - 1;
721 void (*swap_slot_free_notify)(struct block_device *, unsigned long);
722
723 if (offset < si->lowest_bit)
724 si->lowest_bit = offset;
725 if (end > si->highest_bit) {
726 bool was_full = !si->highest_bit;
727
728 WRITE_ONCE(si->highest_bit, end);
729 if (was_full && (si->flags & SWP_WRITEOK))
730 add_to_avail_list(si);
731 }
732 atomic_long_add(nr_entries, &nr_swap_pages);
733 si->inuse_pages -= nr_entries;
734 if (si->flags & SWP_BLKDEV)
735 swap_slot_free_notify =
736 si->bdev->bd_disk->fops->swap_slot_free_notify;
737 else
738 swap_slot_free_notify = NULL;
739 while (offset <= end) {
740 arch_swap_invalidate_page(si->type, offset);
741 frontswap_invalidate_page(si->type, offset);
742 if (swap_slot_free_notify)
743 swap_slot_free_notify(si->bdev, offset);
744 offset++;
745 }
746 clear_shadow_from_swap_cache(si->type, begin, end);
747}
748
749static void set_cluster_next(struct swap_info_struct *si, unsigned long next)
750{
751 unsigned long prev;
752
753 if (!(si->flags & SWP_SOLIDSTATE)) {
754 si->cluster_next = next;
755 return;
756 }
757
758 prev = this_cpu_read(*si->cluster_next_cpu);
759 /*
760 * Cross the swap address space size aligned trunk, choose
761 * another trunk randomly to avoid lock contention on swap
762 * address space if possible.
763 */
764 if ((prev >> SWAP_ADDRESS_SPACE_SHIFT) !=
765 (next >> SWAP_ADDRESS_SPACE_SHIFT)) {
766 /* No free swap slots available */
767 if (si->highest_bit <= si->lowest_bit)
768 return;
769 next = si->lowest_bit +
770 prandom_u32_max(si->highest_bit - si->lowest_bit + 1);
771 next = ALIGN_DOWN(next, SWAP_ADDRESS_SPACE_PAGES);
772 next = max_t(unsigned int, next, si->lowest_bit);
773 }
774 this_cpu_write(*si->cluster_next_cpu, next);
775}
776
777static int scan_swap_map_slots(struct swap_info_struct *si,
778 unsigned char usage, int nr,
779 swp_entry_t slots[])
780{
781 struct swap_cluster_info *ci;
782 unsigned long offset;
783 unsigned long scan_base;
784 unsigned long last_in_cluster = 0;
785 int latency_ration = LATENCY_LIMIT;
786 int n_ret = 0;
787 bool scanned_many = false;
788
789 /*
790 * We try to cluster swap pages by allocating them sequentially
791 * in swap. Once we've allocated SWAPFILE_CLUSTER pages this
792 * way, however, we resort to first-free allocation, starting
793 * a new cluster. This prevents us from scattering swap pages
794 * all over the entire swap partition, so that we reduce
795 * overall disk seek times between swap pages. -- sct
796 * But we do now try to find an empty cluster. -Andrea
797 * And we let swap pages go all over an SSD partition. Hugh
798 */
799
800 si->flags += SWP_SCANNING;
801 /*
802 * Use percpu scan base for SSD to reduce lock contention on
803 * cluster and swap cache. For HDD, sequential access is more
804 * important.
805 */
806 if (si->flags & SWP_SOLIDSTATE)
807 scan_base = this_cpu_read(*si->cluster_next_cpu);
808 else
809 scan_base = si->cluster_next;
810 offset = scan_base;
811
812 /* SSD algorithm */
813 if (si->cluster_info) {
814 if (!scan_swap_map_try_ssd_cluster(si, &offset, &scan_base))
815 goto scan;
816 } else if (unlikely(!si->cluster_nr--)) {
817 if (si->pages - si->inuse_pages < SWAPFILE_CLUSTER) {
818 si->cluster_nr = SWAPFILE_CLUSTER - 1;
819 goto checks;
820 }
821
822 spin_unlock(&si->lock);
823
824 /*
825 * If seek is expensive, start searching for new cluster from
826 * start of partition, to minimize the span of allocated swap.
827 * If seek is cheap, that is the SWP_SOLIDSTATE si->cluster_info
828 * case, just handled by scan_swap_map_try_ssd_cluster() above.
829 */
830 scan_base = offset = si->lowest_bit;
831 last_in_cluster = offset + SWAPFILE_CLUSTER - 1;
832
833 /* Locate the first empty (unaligned) cluster */
834 for (; last_in_cluster <= si->highest_bit; offset++) {
835 if (si->swap_map[offset])
836 last_in_cluster = offset + SWAPFILE_CLUSTER;
837 else if (offset == last_in_cluster) {
838 spin_lock(&si->lock);
839 offset -= SWAPFILE_CLUSTER - 1;
840 si->cluster_next = offset;
841 si->cluster_nr = SWAPFILE_CLUSTER - 1;
842 goto checks;
843 }
844 if (unlikely(--latency_ration < 0)) {
845 cond_resched();
846 latency_ration = LATENCY_LIMIT;
847 }
848 }
849
850 offset = scan_base;
851 spin_lock(&si->lock);
852 si->cluster_nr = SWAPFILE_CLUSTER - 1;
853 }
854
855checks:
856 if (si->cluster_info) {
857 while (scan_swap_map_ssd_cluster_conflict(si, offset)) {
858 /* take a break if we already got some slots */
859 if (n_ret)
860 goto done;
861 if (!scan_swap_map_try_ssd_cluster(si, &offset,
862 &scan_base))
863 goto scan;
864 }
865 }
866 if (!(si->flags & SWP_WRITEOK))
867 goto no_page;
868 if (!si->highest_bit)
869 goto no_page;
870 if (offset > si->highest_bit)
871 scan_base = offset = si->lowest_bit;
872
873 ci = lock_cluster(si, offset);
874 /* reuse swap entry of cache-only swap if not busy. */
875 if (vm_swap_full() && si->swap_map[offset] == SWAP_HAS_CACHE) {
876 int swap_was_freed;
877 unlock_cluster(ci);
878 spin_unlock(&si->lock);
879 swap_was_freed = __try_to_reclaim_swap(si, offset, TTRS_ANYWAY);
880 spin_lock(&si->lock);
881 /* entry was freed successfully, try to use this again */
882 if (swap_was_freed)
883 goto checks;
884 goto scan; /* check next one */
885 }
886
887 if (si->swap_map[offset]) {
888 unlock_cluster(ci);
889 if (!n_ret)
890 goto scan;
891 else
892 goto done;
893 }
894 WRITE_ONCE(si->swap_map[offset], usage);
895 inc_cluster_info_page(si, si->cluster_info, offset);
896 unlock_cluster(ci);
897
898 swap_range_alloc(si, offset, 1);
899 slots[n_ret++] = swp_entry(si->type, offset);
900
901 /* got enough slots or reach max slots? */
902 if ((n_ret == nr) || (offset >= si->highest_bit))
903 goto done;
904
905 /* search for next available slot */
906
907 /* time to take a break? */
908 if (unlikely(--latency_ration < 0)) {
909 if (n_ret)
910 goto done;
911 spin_unlock(&si->lock);
912 cond_resched();
913 spin_lock(&si->lock);
914 latency_ration = LATENCY_LIMIT;
915 }
916
917 /* try to get more slots in cluster */
918 if (si->cluster_info) {
919 if (scan_swap_map_try_ssd_cluster(si, &offset, &scan_base))
920 goto checks;
921 } else if (si->cluster_nr && !si->swap_map[++offset]) {
922 /* non-ssd case, still more slots in cluster? */
923 --si->cluster_nr;
924 goto checks;
925 }
926
927 /*
928 * Even if there's no free clusters available (fragmented),
929 * try to scan a little more quickly with lock held unless we
930 * have scanned too many slots already.
931 */
932 if (!scanned_many) {
933 unsigned long scan_limit;
934
935 if (offset < scan_base)
936 scan_limit = scan_base;
937 else
938 scan_limit = si->highest_bit;
939 for (; offset <= scan_limit && --latency_ration > 0;
940 offset++) {
941 if (!si->swap_map[offset])
942 goto checks;
943 }
944 }
945
946done:
947 set_cluster_next(si, offset + 1);
948 si->flags -= SWP_SCANNING;
949 return n_ret;
950
951scan:
952 spin_unlock(&si->lock);
953 while (++offset <= READ_ONCE(si->highest_bit)) {
954 if (data_race(!si->swap_map[offset])) {
955 spin_lock(&si->lock);
956 goto checks;
957 }
958 if (vm_swap_full() &&
959 READ_ONCE(si->swap_map[offset]) == SWAP_HAS_CACHE) {
960 spin_lock(&si->lock);
961 goto checks;
962 }
963 if (unlikely(--latency_ration < 0)) {
964 cond_resched();
965 latency_ration = LATENCY_LIMIT;
966 scanned_many = true;
967 }
968 }
969 offset = si->lowest_bit;
970 while (offset < scan_base) {
971 if (data_race(!si->swap_map[offset])) {
972 spin_lock(&si->lock);
973 goto checks;
974 }
975 if (vm_swap_full() &&
976 READ_ONCE(si->swap_map[offset]) == SWAP_HAS_CACHE) {
977 spin_lock(&si->lock);
978 goto checks;
979 }
980 if (unlikely(--latency_ration < 0)) {
981 cond_resched();
982 latency_ration = LATENCY_LIMIT;
983 scanned_many = true;
984 }
985 offset++;
986 }
987 spin_lock(&si->lock);
988
989no_page:
990 si->flags -= SWP_SCANNING;
991 return n_ret;
992}
993
994static int swap_alloc_cluster(struct swap_info_struct *si, swp_entry_t *slot)
995{
996 unsigned long idx;
997 struct swap_cluster_info *ci;
998 unsigned long offset;
999
1000 /*
1001 * Should not even be attempting cluster allocations when huge
1002 * page swap is disabled. Warn and fail the allocation.
1003 */
1004 if (!IS_ENABLED(CONFIG_THP_SWAP)) {
1005 VM_WARN_ON_ONCE(1);
1006 return 0;
1007 }
1008
1009 if (cluster_list_empty(&si->free_clusters))
1010 return 0;
1011
1012 idx = cluster_list_first(&si->free_clusters);
1013 offset = idx * SWAPFILE_CLUSTER;
1014 ci = lock_cluster(si, offset);
1015 alloc_cluster(si, idx);
1016 cluster_set_count_flag(ci, SWAPFILE_CLUSTER, CLUSTER_FLAG_HUGE);
1017
1018 memset(si->swap_map + offset, SWAP_HAS_CACHE, SWAPFILE_CLUSTER);
1019 unlock_cluster(ci);
1020 swap_range_alloc(si, offset, SWAPFILE_CLUSTER);
1021 *slot = swp_entry(si->type, offset);
1022
1023 return 1;
1024}
1025
1026static void swap_free_cluster(struct swap_info_struct *si, unsigned long idx)
1027{
1028 unsigned long offset = idx * SWAPFILE_CLUSTER;
1029 struct swap_cluster_info *ci;
1030
1031 ci = lock_cluster(si, offset);
1032 memset(si->swap_map + offset, 0, SWAPFILE_CLUSTER);
1033 cluster_set_count_flag(ci, 0, 0);
1034 free_cluster(si, idx);
1035 unlock_cluster(ci);
1036 swap_range_free(si, offset, SWAPFILE_CLUSTER);
1037}
1038
1039int get_swap_pages(int n_goal, swp_entry_t swp_entries[], int entry_size)
1040{
1041 unsigned long size = swap_entry_size(entry_size);
1042 struct swap_info_struct *si, *next;
1043 long avail_pgs;
1044 int n_ret = 0;
1045 int node;
1046
1047 /* Only single cluster request supported */
1048 WARN_ON_ONCE(n_goal > 1 && size == SWAPFILE_CLUSTER);
1049
1050 spin_lock(&swap_avail_lock);
1051
1052 avail_pgs = atomic_long_read(&nr_swap_pages) / size;
1053 if (avail_pgs <= 0) {
1054 spin_unlock(&swap_avail_lock);
1055 goto noswap;
1056 }
1057
1058 n_goal = min3((long)n_goal, (long)SWAP_BATCH, avail_pgs);
1059
1060 atomic_long_sub(n_goal * size, &nr_swap_pages);
1061
1062start_over:
1063 node = numa_node_id();
1064 plist_for_each_entry_safe(si, next, &swap_avail_heads[node], avail_lists[node]) {
1065 /* requeue si to after same-priority siblings */
1066 plist_requeue(&si->avail_lists[node], &swap_avail_heads[node]);
1067 spin_unlock(&swap_avail_lock);
1068 spin_lock(&si->lock);
1069 if (!si->highest_bit || !(si->flags & SWP_WRITEOK)) {
1070 spin_lock(&swap_avail_lock);
1071 if (plist_node_empty(&si->avail_lists[node])) {
1072 spin_unlock(&si->lock);
1073 goto nextsi;
1074 }
1075 WARN(!si->highest_bit,
1076 "swap_info %d in list but !highest_bit\n",
1077 si->type);
1078 WARN(!(si->flags & SWP_WRITEOK),
1079 "swap_info %d in list but !SWP_WRITEOK\n",
1080 si->type);
1081 __del_from_avail_list(si);
1082 spin_unlock(&si->lock);
1083 goto nextsi;
1084 }
1085 if (size == SWAPFILE_CLUSTER) {
1086 if (si->flags & SWP_BLKDEV)
1087 n_ret = swap_alloc_cluster(si, swp_entries);
1088 } else
1089 n_ret = scan_swap_map_slots(si, SWAP_HAS_CACHE,
1090 n_goal, swp_entries);
1091 spin_unlock(&si->lock);
1092 if (n_ret || size == SWAPFILE_CLUSTER)
1093 goto check_out;
1094 pr_debug("scan_swap_map of si %d failed to find offset\n",
1095 si->type);
1096
1097 spin_lock(&swap_avail_lock);
1098nextsi:
1099 /*
1100 * if we got here, it's likely that si was almost full before,
1101 * and since scan_swap_map_slots() can drop the si->lock,
1102 * multiple callers probably all tried to get a page from the
1103 * same si and it filled up before we could get one; or, the si
1104 * filled up between us dropping swap_avail_lock and taking
1105 * si->lock. Since we dropped the swap_avail_lock, the
1106 * swap_avail_head list may have been modified; so if next is
1107 * still in the swap_avail_head list then try it, otherwise
1108 * start over if we have not gotten any slots.
1109 */
1110 if (plist_node_empty(&next->avail_lists[node]))
1111 goto start_over;
1112 }
1113
1114 spin_unlock(&swap_avail_lock);
1115
1116check_out:
1117 if (n_ret < n_goal)
1118 atomic_long_add((long)(n_goal - n_ret) * size,
1119 &nr_swap_pages);
1120noswap:
1121 return n_ret;
1122}
1123
1124static struct swap_info_struct *__swap_info_get(swp_entry_t entry)
1125{
1126 struct swap_info_struct *p;
1127 unsigned long offset;
1128
1129 if (!entry.val)
1130 goto out;
1131 p = swp_swap_info(entry);
1132 if (!p)
1133 goto bad_nofile;
1134 if (data_race(!(p->flags & SWP_USED)))
1135 goto bad_device;
1136 offset = swp_offset(entry);
1137 if (offset >= p->max)
1138 goto bad_offset;
1139 return p;
1140
1141bad_offset:
1142 pr_err("%s: %s%08lx\n", __func__, Bad_offset, entry.val);
1143 goto out;
1144bad_device:
1145 pr_err("%s: %s%08lx\n", __func__, Unused_file, entry.val);
1146 goto out;
1147bad_nofile:
1148 pr_err("%s: %s%08lx\n", __func__, Bad_file, entry.val);
1149out:
1150 return NULL;
1151}
1152
1153static struct swap_info_struct *_swap_info_get(swp_entry_t entry)
1154{
1155 struct swap_info_struct *p;
1156
1157 p = __swap_info_get(entry);
1158 if (!p)
1159 goto out;
1160 if (data_race(!p->swap_map[swp_offset(entry)]))
1161 goto bad_free;
1162 return p;
1163
1164bad_free:
1165 pr_err("%s: %s%08lx\n", __func__, Unused_offset, entry.val);
1166out:
1167 return NULL;
1168}
1169
1170static struct swap_info_struct *swap_info_get(swp_entry_t entry)
1171{
1172 struct swap_info_struct *p;
1173
1174 p = _swap_info_get(entry);
1175 if (p)
1176 spin_lock(&p->lock);
1177 return p;
1178}
1179
1180static struct swap_info_struct *swap_info_get_cont(swp_entry_t entry,
1181 struct swap_info_struct *q)
1182{
1183 struct swap_info_struct *p;
1184
1185 p = _swap_info_get(entry);
1186
1187 if (p != q) {
1188 if (q != NULL)
1189 spin_unlock(&q->lock);
1190 if (p != NULL)
1191 spin_lock(&p->lock);
1192 }
1193 return p;
1194}
1195
1196static unsigned char __swap_entry_free_locked(struct swap_info_struct *p,
1197 unsigned long offset,
1198 unsigned char usage)
1199{
1200 unsigned char count;
1201 unsigned char has_cache;
1202
1203 count = p->swap_map[offset];
1204
1205 has_cache = count & SWAP_HAS_CACHE;
1206 count &= ~SWAP_HAS_CACHE;
1207
1208 if (usage == SWAP_HAS_CACHE) {
1209 VM_BUG_ON(!has_cache);
1210 has_cache = 0;
1211 } else if (count == SWAP_MAP_SHMEM) {
1212 /*
1213 * Or we could insist on shmem.c using a special
1214 * swap_shmem_free() and free_shmem_swap_and_cache()...
1215 */
1216 count = 0;
1217 } else if ((count & ~COUNT_CONTINUED) <= SWAP_MAP_MAX) {
1218 if (count == COUNT_CONTINUED) {
1219 if (swap_count_continued(p, offset, count))
1220 count = SWAP_MAP_MAX | COUNT_CONTINUED;
1221 else
1222 count = SWAP_MAP_MAX;
1223 } else
1224 count--;
1225 }
1226
1227 usage = count | has_cache;
1228 if (usage)
1229 WRITE_ONCE(p->swap_map[offset], usage);
1230 else
1231 WRITE_ONCE(p->swap_map[offset], SWAP_HAS_CACHE);
1232
1233 return usage;
1234}
1235
1236/*
1237 * Check whether swap entry is valid in the swap device. If so,
1238 * return pointer to swap_info_struct, and keep the swap entry valid
1239 * via preventing the swap device from being swapoff, until
1240 * put_swap_device() is called. Otherwise return NULL.
1241 *
1242 * Notice that swapoff or swapoff+swapon can still happen before the
1243 * percpu_ref_tryget_live() in get_swap_device() or after the
1244 * percpu_ref_put() in put_swap_device() if there isn't any other way
1245 * to prevent swapoff, such as page lock, page table lock, etc. The
1246 * caller must be prepared for that. For example, the following
1247 * situation is possible.
1248 *
1249 * CPU1 CPU2
1250 * do_swap_page()
1251 * ... swapoff+swapon
1252 * __read_swap_cache_async()
1253 * swapcache_prepare()
1254 * __swap_duplicate()
1255 * // check swap_map
1256 * // verify PTE not changed
1257 *
1258 * In __swap_duplicate(), the swap_map need to be checked before
1259 * changing partly because the specified swap entry may be for another
1260 * swap device which has been swapoff. And in do_swap_page(), after
1261 * the page is read from the swap device, the PTE is verified not
1262 * changed with the page table locked to check whether the swap device
1263 * has been swapoff or swapoff+swapon.
1264 */
1265struct swap_info_struct *get_swap_device(swp_entry_t entry)
1266{
1267 struct swap_info_struct *si;
1268 unsigned long offset;
1269
1270 if (!entry.val)
1271 goto out;
1272 si = swp_swap_info(entry);
1273 if (!si)
1274 goto bad_nofile;
1275 if (!percpu_ref_tryget_live(&si->users))
1276 goto out;
1277 /*
1278 * Guarantee the si->users are checked before accessing other
1279 * fields of swap_info_struct.
1280 *
1281 * Paired with the spin_unlock() after setup_swap_info() in
1282 * enable_swap_info().
1283 */
1284 smp_rmb();
1285 offset = swp_offset(entry);
1286 if (offset >= si->max)
1287 goto put_out;
1288
1289 return si;
1290bad_nofile:
1291 pr_err("%s: %s%08lx\n", __func__, Bad_file, entry.val);
1292out:
1293 return NULL;
1294put_out:
1295 percpu_ref_put(&si->users);
1296 return NULL;
1297}
1298
1299static unsigned char __swap_entry_free(struct swap_info_struct *p,
1300 swp_entry_t entry)
1301{
1302 struct swap_cluster_info *ci;
1303 unsigned long offset = swp_offset(entry);
1304 unsigned char usage;
1305
1306 ci = lock_cluster_or_swap_info(p, offset);
1307 usage = __swap_entry_free_locked(p, offset, 1);
1308 unlock_cluster_or_swap_info(p, ci);
1309 if (!usage)
1310 free_swap_slot(entry);
1311
1312 return usage;
1313}
1314
1315static void swap_entry_free(struct swap_info_struct *p, swp_entry_t entry)
1316{
1317 struct swap_cluster_info *ci;
1318 unsigned long offset = swp_offset(entry);
1319 unsigned char count;
1320
1321 ci = lock_cluster(p, offset);
1322 count = p->swap_map[offset];
1323 VM_BUG_ON(count != SWAP_HAS_CACHE);
1324 p->swap_map[offset] = 0;
1325 dec_cluster_info_page(p, p->cluster_info, offset);
1326 unlock_cluster(ci);
1327
1328 mem_cgroup_uncharge_swap(entry, 1);
1329 swap_range_free(p, offset, 1);
1330}
1331
1332/*
1333 * Caller has made sure that the swap device corresponding to entry
1334 * is still around or has not been recycled.
1335 */
1336void swap_free(swp_entry_t entry)
1337{
1338 struct swap_info_struct *p;
1339
1340 p = _swap_info_get(entry);
1341 if (p)
1342 __swap_entry_free(p, entry);
1343}
1344
1345/*
1346 * Called after dropping swapcache to decrease refcnt to swap entries.
1347 */
1348void put_swap_page(struct page *page, swp_entry_t entry)
1349{
1350 unsigned long offset = swp_offset(entry);
1351 unsigned long idx = offset / SWAPFILE_CLUSTER;
1352 struct swap_cluster_info *ci;
1353 struct swap_info_struct *si;
1354 unsigned char *map;
1355 unsigned int i, free_entries = 0;
1356 unsigned char val;
1357 int size = swap_entry_size(thp_nr_pages(page));
1358
1359 si = _swap_info_get(entry);
1360 if (!si)
1361 return;
1362
1363 ci = lock_cluster_or_swap_info(si, offset);
1364 if (size == SWAPFILE_CLUSTER) {
1365 VM_BUG_ON(!cluster_is_huge(ci));
1366 map = si->swap_map + offset;
1367 for (i = 0; i < SWAPFILE_CLUSTER; i++) {
1368 val = map[i];
1369 VM_BUG_ON(!(val & SWAP_HAS_CACHE));
1370 if (val == SWAP_HAS_CACHE)
1371 free_entries++;
1372 }
1373 cluster_clear_huge(ci);
1374 if (free_entries == SWAPFILE_CLUSTER) {
1375 unlock_cluster_or_swap_info(si, ci);
1376 spin_lock(&si->lock);
1377 mem_cgroup_uncharge_swap(entry, SWAPFILE_CLUSTER);
1378 swap_free_cluster(si, idx);
1379 spin_unlock(&si->lock);
1380 return;
1381 }
1382 }
1383 for (i = 0; i < size; i++, entry.val++) {
1384 if (!__swap_entry_free_locked(si, offset + i, SWAP_HAS_CACHE)) {
1385 unlock_cluster_or_swap_info(si, ci);
1386 free_swap_slot(entry);
1387 if (i == size - 1)
1388 return;
1389 lock_cluster_or_swap_info(si, offset);
1390 }
1391 }
1392 unlock_cluster_or_swap_info(si, ci);
1393}
1394
1395#ifdef CONFIG_THP_SWAP
1396int split_swap_cluster(swp_entry_t entry)
1397{
1398 struct swap_info_struct *si;
1399 struct swap_cluster_info *ci;
1400 unsigned long offset = swp_offset(entry);
1401
1402 si = _swap_info_get(entry);
1403 if (!si)
1404 return -EBUSY;
1405 ci = lock_cluster(si, offset);
1406 cluster_clear_huge(ci);
1407 unlock_cluster(ci);
1408 return 0;
1409}
1410#endif
1411
1412static int swp_entry_cmp(const void *ent1, const void *ent2)
1413{
1414 const swp_entry_t *e1 = ent1, *e2 = ent2;
1415
1416 return (int)swp_type(*e1) - (int)swp_type(*e2);
1417}
1418
1419void swapcache_free_entries(swp_entry_t *entries, int n)
1420{
1421 struct swap_info_struct *p, *prev;
1422 int i;
1423
1424 if (n <= 0)
1425 return;
1426
1427 prev = NULL;
1428 p = NULL;
1429
1430 /*
1431 * Sort swap entries by swap device, so each lock is only taken once.
1432 * nr_swapfiles isn't absolutely correct, but the overhead of sort() is
1433 * so low that it isn't necessary to optimize further.
1434 */
1435 if (nr_swapfiles > 1)
1436 sort(entries, n, sizeof(entries[0]), swp_entry_cmp, NULL);
1437 for (i = 0; i < n; ++i) {
1438 p = swap_info_get_cont(entries[i], prev);
1439 if (p)
1440 swap_entry_free(p, entries[i]);
1441 prev = p;
1442 }
1443 if (p)
1444 spin_unlock(&p->lock);
1445}
1446
1447/*
1448 * How many references to page are currently swapped out?
1449 * This does not give an exact answer when swap count is continued,
1450 * but does include the high COUNT_CONTINUED flag to allow for that.
1451 */
1452int page_swapcount(struct page *page)
1453{
1454 int count = 0;
1455 struct swap_info_struct *p;
1456 struct swap_cluster_info *ci;
1457 swp_entry_t entry;
1458 unsigned long offset;
1459
1460 entry.val = page_private(page);
1461 p = _swap_info_get(entry);
1462 if (p) {
1463 offset = swp_offset(entry);
1464 ci = lock_cluster_or_swap_info(p, offset);
1465 count = swap_count(p->swap_map[offset]);
1466 unlock_cluster_or_swap_info(p, ci);
1467 }
1468 return count;
1469}
1470
1471int __swap_count(swp_entry_t entry)
1472{
1473 struct swap_info_struct *si;
1474 pgoff_t offset = swp_offset(entry);
1475 int count = 0;
1476
1477 si = get_swap_device(entry);
1478 if (si) {
1479 count = swap_count(si->swap_map[offset]);
1480 put_swap_device(si);
1481 }
1482 return count;
1483}
1484
1485static int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
1486{
1487 int count = 0;
1488 pgoff_t offset = swp_offset(entry);
1489 struct swap_cluster_info *ci;
1490
1491 ci = lock_cluster_or_swap_info(si, offset);
1492 count = swap_count(si->swap_map[offset]);
1493 unlock_cluster_or_swap_info(si, ci);
1494 return count;
1495}
1496
1497/*
1498 * How many references to @entry are currently swapped out?
1499 * This does not give an exact answer when swap count is continued,
1500 * but does include the high COUNT_CONTINUED flag to allow for that.
1501 */
1502int __swp_swapcount(swp_entry_t entry)
1503{
1504 int count = 0;
1505 struct swap_info_struct *si;
1506
1507 si = get_swap_device(entry);
1508 if (si) {
1509 count = swap_swapcount(si, entry);
1510 put_swap_device(si);
1511 }
1512 return count;
1513}
1514
1515/*
1516 * How many references to @entry are currently swapped out?
1517 * This considers COUNT_CONTINUED so it returns exact answer.
1518 */
1519int swp_swapcount(swp_entry_t entry)
1520{
1521 int count, tmp_count, n;
1522 struct swap_info_struct *p;
1523 struct swap_cluster_info *ci;
1524 struct page *page;
1525 pgoff_t offset;
1526 unsigned char *map;
1527
1528 p = _swap_info_get(entry);
1529 if (!p)
1530 return 0;
1531
1532 offset = swp_offset(entry);
1533
1534 ci = lock_cluster_or_swap_info(p, offset);
1535
1536 count = swap_count(p->swap_map[offset]);
1537 if (!(count & COUNT_CONTINUED))
1538 goto out;
1539
1540 count &= ~COUNT_CONTINUED;
1541 n = SWAP_MAP_MAX + 1;
1542
1543 page = vmalloc_to_page(p->swap_map + offset);
1544 offset &= ~PAGE_MASK;
1545 VM_BUG_ON(page_private(page) != SWP_CONTINUED);
1546
1547 do {
1548 page = list_next_entry(page, lru);
1549 map = kmap_atomic(page);
1550 tmp_count = map[offset];
1551 kunmap_atomic(map);
1552
1553 count += (tmp_count & ~COUNT_CONTINUED) * n;
1554 n *= (SWAP_CONT_MAX + 1);
1555 } while (tmp_count & COUNT_CONTINUED);
1556out:
1557 unlock_cluster_or_swap_info(p, ci);
1558 return count;
1559}
1560
1561static bool swap_page_trans_huge_swapped(struct swap_info_struct *si,
1562 swp_entry_t entry)
1563{
1564 struct swap_cluster_info *ci;
1565 unsigned char *map = si->swap_map;
1566 unsigned long roffset = swp_offset(entry);
1567 unsigned long offset = round_down(roffset, SWAPFILE_CLUSTER);
1568 int i;
1569 bool ret = false;
1570
1571 ci = lock_cluster_or_swap_info(si, offset);
1572 if (!ci || !cluster_is_huge(ci)) {
1573 if (swap_count(map[roffset]))
1574 ret = true;
1575 goto unlock_out;
1576 }
1577 for (i = 0; i < SWAPFILE_CLUSTER; i++) {
1578 if (swap_count(map[offset + i])) {
1579 ret = true;
1580 break;
1581 }
1582 }
1583unlock_out:
1584 unlock_cluster_or_swap_info(si, ci);
1585 return ret;
1586}
1587
1588static bool page_swapped(struct page *page)
1589{
1590 swp_entry_t entry;
1591 struct swap_info_struct *si;
1592
1593 if (!IS_ENABLED(CONFIG_THP_SWAP) || likely(!PageTransCompound(page)))
1594 return page_swapcount(page) != 0;
1595
1596 page = compound_head(page);
1597 entry.val = page_private(page);
1598 si = _swap_info_get(entry);
1599 if (si)
1600 return swap_page_trans_huge_swapped(si, entry);
1601 return false;
1602}
1603
1604static int page_trans_huge_map_swapcount(struct page *page, int *total_mapcount,
1605 int *total_swapcount)
1606{
1607 int i, map_swapcount, _total_mapcount, _total_swapcount;
1608 unsigned long offset = 0;
1609 struct swap_info_struct *si;
1610 struct swap_cluster_info *ci = NULL;
1611 unsigned char *map = NULL;
1612 int mapcount, swapcount = 0;
1613
1614 /* hugetlbfs shouldn't call it */
1615 VM_BUG_ON_PAGE(PageHuge(page), page);
1616
1617 if (!IS_ENABLED(CONFIG_THP_SWAP) || likely(!PageTransCompound(page))) {
1618 mapcount = page_trans_huge_mapcount(page, total_mapcount);
1619 if (PageSwapCache(page))
1620 swapcount = page_swapcount(page);
1621 if (total_swapcount)
1622 *total_swapcount = swapcount;
1623 return mapcount + swapcount;
1624 }
1625
1626 page = compound_head(page);
1627
1628 _total_mapcount = _total_swapcount = map_swapcount = 0;
1629 if (PageSwapCache(page)) {
1630 swp_entry_t entry;
1631
1632 entry.val = page_private(page);
1633 si = _swap_info_get(entry);
1634 if (si) {
1635 map = si->swap_map;
1636 offset = swp_offset(entry);
1637 }
1638 }
1639 if (map)
1640 ci = lock_cluster(si, offset);
1641 for (i = 0; i < HPAGE_PMD_NR; i++) {
1642 mapcount = atomic_read(&page[i]._mapcount) + 1;
1643 _total_mapcount += mapcount;
1644 if (map) {
1645 swapcount = swap_count(map[offset + i]);
1646 _total_swapcount += swapcount;
1647 }
1648 map_swapcount = max(map_swapcount, mapcount + swapcount);
1649 }
1650 unlock_cluster(ci);
1651 if (PageDoubleMap(page)) {
1652 map_swapcount -= 1;
1653 _total_mapcount -= HPAGE_PMD_NR;
1654 }
1655 mapcount = compound_mapcount(page);
1656 map_swapcount += mapcount;
1657 _total_mapcount += mapcount;
1658 if (total_mapcount)
1659 *total_mapcount = _total_mapcount;
1660 if (total_swapcount)
1661 *total_swapcount = _total_swapcount;
1662
1663 return map_swapcount;
1664}
1665
1666/*
1667 * We can write to an anon page without COW if there are no other references
1668 * to it. And as a side-effect, free up its swap: because the old content
1669 * on disk will never be read, and seeking back there to write new content
1670 * later would only waste time away from clustering.
1671 *
1672 * NOTE: total_map_swapcount should not be relied upon by the caller if
1673 * reuse_swap_page() returns false, but it may be always overwritten
1674 * (see the other implementation for CONFIG_SWAP=n).
1675 */
1676bool reuse_swap_page(struct page *page, int *total_map_swapcount)
1677{
1678 int count, total_mapcount, total_swapcount;
1679
1680 VM_BUG_ON_PAGE(!PageLocked(page), page);
1681 if (unlikely(PageKsm(page)))
1682 return false;
1683 count = page_trans_huge_map_swapcount(page, &total_mapcount,
1684 &total_swapcount);
1685 if (total_map_swapcount)
1686 *total_map_swapcount = total_mapcount + total_swapcount;
1687 if (count == 1 && PageSwapCache(page) &&
1688 (likely(!PageTransCompound(page)) ||
1689 /* The remaining swap count will be freed soon */
1690 total_swapcount == page_swapcount(page))) {
1691 if (!PageWriteback(page)) {
1692 page = compound_head(page);
1693 delete_from_swap_cache(page);
1694 SetPageDirty(page);
1695 } else {
1696 swp_entry_t entry;
1697 struct swap_info_struct *p;
1698
1699 entry.val = page_private(page);
1700 p = swap_info_get(entry);
1701 if (p->flags & SWP_STABLE_WRITES) {
1702 spin_unlock(&p->lock);
1703 return false;
1704 }
1705 spin_unlock(&p->lock);
1706 }
1707 }
1708
1709 return count <= 1;
1710}
1711
1712/*
1713 * If swap is getting full, or if there are no more mappings of this page,
1714 * then try_to_free_swap is called to free its swap space.
1715 */
1716int try_to_free_swap(struct page *page)
1717{
1718 VM_BUG_ON_PAGE(!PageLocked(page), page);
1719
1720 if (!PageSwapCache(page))
1721 return 0;
1722 if (PageWriteback(page))
1723 return 0;
1724 if (page_swapped(page))
1725 return 0;
1726
1727 /*
1728 * Once hibernation has begun to create its image of memory,
1729 * there's a danger that one of the calls to try_to_free_swap()
1730 * - most probably a call from __try_to_reclaim_swap() while
1731 * hibernation is allocating its own swap pages for the image,
1732 * but conceivably even a call from memory reclaim - will free
1733 * the swap from a page which has already been recorded in the
1734 * image as a clean swapcache page, and then reuse its swap for
1735 * another page of the image. On waking from hibernation, the
1736 * original page might be freed under memory pressure, then
1737 * later read back in from swap, now with the wrong data.
1738 *
1739 * Hibernation suspends storage while it is writing the image
1740 * to disk so check that here.
1741 */
1742 if (pm_suspended_storage())
1743 return 0;
1744
1745 page = compound_head(page);
1746 delete_from_swap_cache(page);
1747 SetPageDirty(page);
1748 return 1;
1749}
1750
1751/*
1752 * Free the swap entry like above, but also try to
1753 * free the page cache entry if it is the last user.
1754 */
1755int free_swap_and_cache(swp_entry_t entry)
1756{
1757 struct swap_info_struct *p;
1758 unsigned char count;
1759
1760 if (non_swap_entry(entry))
1761 return 1;
1762
1763 p = _swap_info_get(entry);
1764 if (p) {
1765 count = __swap_entry_free(p, entry);
1766 if (count == SWAP_HAS_CACHE &&
1767 !swap_page_trans_huge_swapped(p, entry))
1768 __try_to_reclaim_swap(p, swp_offset(entry),
1769 TTRS_UNMAPPED | TTRS_FULL);
1770 }
1771 return p != NULL;
1772}
1773
1774#ifdef CONFIG_HIBERNATION
1775
1776swp_entry_t get_swap_page_of_type(int type)
1777{
1778 struct swap_info_struct *si = swap_type_to_swap_info(type);
1779 swp_entry_t entry = {0};
1780
1781 if (!si)
1782 goto fail;
1783
1784 /* This is called for allocating swap entry, not cache */
1785 spin_lock(&si->lock);
1786 if ((si->flags & SWP_WRITEOK) && scan_swap_map_slots(si, 1, 1, &entry))
1787 atomic_long_dec(&nr_swap_pages);
1788 spin_unlock(&si->lock);
1789fail:
1790 return entry;
1791}
1792
1793/*
1794 * Find the swap type that corresponds to given device (if any).
1795 *
1796 * @offset - number of the PAGE_SIZE-sized block of the device, starting
1797 * from 0, in which the swap header is expected to be located.
1798 *
1799 * This is needed for the suspend to disk (aka swsusp).
1800 */
1801int swap_type_of(dev_t device, sector_t offset)
1802{
1803 int type;
1804
1805 if (!device)
1806 return -1;
1807
1808 spin_lock(&swap_lock);
1809 for (type = 0; type < nr_swapfiles; type++) {
1810 struct swap_info_struct *sis = swap_info[type];
1811
1812 if (!(sis->flags & SWP_WRITEOK))
1813 continue;
1814
1815 if (device == sis->bdev->bd_dev) {
1816 struct swap_extent *se = first_se(sis);
1817
1818 if (se->start_block == offset) {
1819 spin_unlock(&swap_lock);
1820 return type;
1821 }
1822 }
1823 }
1824 spin_unlock(&swap_lock);
1825 return -ENODEV;
1826}
1827
1828int find_first_swap(dev_t *device)
1829{
1830 int type;
1831
1832 spin_lock(&swap_lock);
1833 for (type = 0; type < nr_swapfiles; type++) {
1834 struct swap_info_struct *sis = swap_info[type];
1835
1836 if (!(sis->flags & SWP_WRITEOK))
1837 continue;
1838 *device = sis->bdev->bd_dev;
1839 spin_unlock(&swap_lock);
1840 return type;
1841 }
1842 spin_unlock(&swap_lock);
1843 return -ENODEV;
1844}
1845
1846/*
1847 * Get the (PAGE_SIZE) block corresponding to given offset on the swapdev
1848 * corresponding to given index in swap_info (swap type).
1849 */
1850sector_t swapdev_block(int type, pgoff_t offset)
1851{
1852 struct swap_info_struct *si = swap_type_to_swap_info(type);
1853 struct swap_extent *se;
1854
1855 if (!si || !(si->flags & SWP_WRITEOK))
1856 return 0;
1857 se = offset_to_swap_extent(si, offset);
1858 return se->start_block + (offset - se->start_page);
1859}
1860
1861/*
1862 * Return either the total number of swap pages of given type, or the number
1863 * of free pages of that type (depending on @free)
1864 *
1865 * This is needed for software suspend
1866 */
1867unsigned int count_swap_pages(int type, int free)
1868{
1869 unsigned int n = 0;
1870
1871 spin_lock(&swap_lock);
1872 if ((unsigned int)type < nr_swapfiles) {
1873 struct swap_info_struct *sis = swap_info[type];
1874
1875 spin_lock(&sis->lock);
1876 if (sis->flags & SWP_WRITEOK) {
1877 n = sis->pages;
1878 if (free)
1879 n -= sis->inuse_pages;
1880 }
1881 spin_unlock(&sis->lock);
1882 }
1883 spin_unlock(&swap_lock);
1884 return n;
1885}
1886#endif /* CONFIG_HIBERNATION */
1887
1888static inline int pte_same_as_swp(pte_t pte, pte_t swp_pte)
1889{
1890 return pte_same(pte_swp_clear_flags(pte), swp_pte);
1891}
1892
1893/*
1894 * No need to decide whether this PTE shares the swap entry with others,
1895 * just let do_wp_page work it out if a write is requested later - to
1896 * force COW, vm_page_prot omits write permission from any private vma.
1897 */
1898static int unuse_pte(struct vm_area_struct *vma, pmd_t *pmd,
1899 unsigned long addr, swp_entry_t entry, struct page *page)
1900{
1901 struct page *swapcache;
1902 spinlock_t *ptl;
1903 pte_t *pte;
1904 int ret = 1;
1905
1906 swapcache = page;
1907 page = ksm_might_need_to_copy(page, vma, addr);
1908 if (unlikely(!page))
1909 return -ENOMEM;
1910
1911 pte = pte_offset_map_lock(vma->vm_mm, pmd, addr, &ptl);
1912 if (unlikely(!pte_same_as_swp(*pte, swp_entry_to_pte(entry)))) {
1913 ret = 0;
1914 goto out;
1915 }
1916
1917 dec_mm_counter(vma->vm_mm, MM_SWAPENTS);
1918 inc_mm_counter(vma->vm_mm, MM_ANONPAGES);
1919 get_page(page);
1920 set_pte_at(vma->vm_mm, addr, pte,
1921 pte_mkold(mk_pte(page, vma->vm_page_prot)));
1922 if (page == swapcache) {
1923 page_add_anon_rmap(page, vma, addr, false);
1924 } else { /* ksm created a completely new copy */
1925 page_add_new_anon_rmap(page, vma, addr, false);
1926 lru_cache_add_inactive_or_unevictable(page, vma);
1927 }
1928 swap_free(entry);
1929out:
1930 pte_unmap_unlock(pte, ptl);
1931 if (page != swapcache) {
1932 unlock_page(page);
1933 put_page(page);
1934 }
1935 return ret;
1936}
1937
1938static int unuse_pte_range(struct vm_area_struct *vma, pmd_t *pmd,
1939 unsigned long addr, unsigned long end,
1940 unsigned int type, bool frontswap,
1941 unsigned long *fs_pages_to_unuse)
1942{
1943 struct page *page;
1944 swp_entry_t entry;
1945 pte_t *pte;
1946 struct swap_info_struct *si;
1947 unsigned long offset;
1948 int ret = 0;
1949 volatile unsigned char *swap_map;
1950
1951 si = swap_info[type];
1952 pte = pte_offset_map(pmd, addr);
1953 do {
1954 if (!is_swap_pte(*pte))
1955 continue;
1956
1957 entry = pte_to_swp_entry(*pte);
1958 if (swp_type(entry) != type)
1959 continue;
1960
1961 offset = swp_offset(entry);
1962 if (frontswap && !frontswap_test(si, offset))
1963 continue;
1964
1965 pte_unmap(pte);
1966 swap_map = &si->swap_map[offset];
1967 page = lookup_swap_cache(entry, vma, addr);
1968 if (!page) {
1969 struct vm_fault vmf = {
1970 .vma = vma,
1971 .address = addr,
1972 .pmd = pmd,
1973 };
1974
1975 page = swapin_readahead(entry, GFP_HIGHUSER_MOVABLE,
1976 &vmf);
1977 }
1978 if (!page) {
1979 if (*swap_map == 0 || *swap_map == SWAP_MAP_BAD)
1980 goto try_next;
1981 return -ENOMEM;
1982 }
1983
1984 lock_page(page);
1985 wait_on_page_writeback(page);
1986 ret = unuse_pte(vma, pmd, addr, entry, page);
1987 if (ret < 0) {
1988 unlock_page(page);
1989 put_page(page);
1990 goto out;
1991 }
1992
1993 try_to_free_swap(page);
1994 unlock_page(page);
1995 put_page(page);
1996
1997 if (*fs_pages_to_unuse && !--(*fs_pages_to_unuse)) {
1998 ret = FRONTSWAP_PAGES_UNUSED;
1999 goto out;
2000 }
2001try_next:
2002 pte = pte_offset_map(pmd, addr);
2003 } while (pte++, addr += PAGE_SIZE, addr != end);
2004 pte_unmap(pte - 1);
2005
2006 ret = 0;
2007out:
2008 return ret;
2009}
2010
2011static inline int unuse_pmd_range(struct vm_area_struct *vma, pud_t *pud,
2012 unsigned long addr, unsigned long end,
2013 unsigned int type, bool frontswap,
2014 unsigned long *fs_pages_to_unuse)
2015{
2016 pmd_t *pmd;
2017 unsigned long next;
2018 int ret;
2019
2020 pmd = pmd_offset(pud, addr);
2021 do {
2022 cond_resched();
2023 next = pmd_addr_end(addr, end);
2024 if (pmd_none_or_trans_huge_or_clear_bad(pmd))
2025 continue;
2026 ret = unuse_pte_range(vma, pmd, addr, next, type,
2027 frontswap, fs_pages_to_unuse);
2028 if (ret)
2029 return ret;
2030 } while (pmd++, addr = next, addr != end);
2031 return 0;
2032}
2033
2034static inline int unuse_pud_range(struct vm_area_struct *vma, p4d_t *p4d,
2035 unsigned long addr, unsigned long end,
2036 unsigned int type, bool frontswap,
2037 unsigned long *fs_pages_to_unuse)
2038{
2039 pud_t *pud;
2040 unsigned long next;
2041 int ret;
2042
2043 pud = pud_offset(p4d, addr);
2044 do {
2045 next = pud_addr_end(addr, end);
2046 if (pud_none_or_clear_bad(pud))
2047 continue;
2048 ret = unuse_pmd_range(vma, pud, addr, next, type,
2049 frontswap, fs_pages_to_unuse);
2050 if (ret)
2051 return ret;
2052 } while (pud++, addr = next, addr != end);
2053 return 0;
2054}
2055
2056static inline int unuse_p4d_range(struct vm_area_struct *vma, pgd_t *pgd,
2057 unsigned long addr, unsigned long end,
2058 unsigned int type, bool frontswap,
2059 unsigned long *fs_pages_to_unuse)
2060{
2061 p4d_t *p4d;
2062 unsigned long next;
2063 int ret;
2064
2065 p4d = p4d_offset(pgd, addr);
2066 do {
2067 next = p4d_addr_end(addr, end);
2068 if (p4d_none_or_clear_bad(p4d))
2069 continue;
2070 ret = unuse_pud_range(vma, p4d, addr, next, type,
2071 frontswap, fs_pages_to_unuse);
2072 if (ret)
2073 return ret;
2074 } while (p4d++, addr = next, addr != end);
2075 return 0;
2076}
2077
2078static int unuse_vma(struct vm_area_struct *vma, unsigned int type,
2079 bool frontswap, unsigned long *fs_pages_to_unuse)
2080{
2081 pgd_t *pgd;
2082 unsigned long addr, end, next;
2083 int ret;
2084
2085 addr = vma->vm_start;
2086 end = vma->vm_end;
2087
2088 pgd = pgd_offset(vma->vm_mm, addr);
2089 do {
2090 next = pgd_addr_end(addr, end);
2091 if (pgd_none_or_clear_bad(pgd))
2092 continue;
2093 ret = unuse_p4d_range(vma, pgd, addr, next, type,
2094 frontswap, fs_pages_to_unuse);
2095 if (ret)
2096 return ret;
2097 } while (pgd++, addr = next, addr != end);
2098 return 0;
2099}
2100
2101static int unuse_mm(struct mm_struct *mm, unsigned int type,
2102 bool frontswap, unsigned long *fs_pages_to_unuse)
2103{
2104 struct vm_area_struct *vma;
2105 int ret = 0;
2106
2107 mmap_read_lock(mm);
2108 for (vma = mm->mmap; vma; vma = vma->vm_next) {
2109 if (vma->anon_vma) {
2110 ret = unuse_vma(vma, type, frontswap,
2111 fs_pages_to_unuse);
2112 if (ret)
2113 break;
2114 }
2115 cond_resched();
2116 }
2117 mmap_read_unlock(mm);
2118 return ret;
2119}
2120
2121/*
2122 * Scan swap_map (or frontswap_map if frontswap parameter is true)
2123 * from current position to next entry still in use. Return 0
2124 * if there are no inuse entries after prev till end of the map.
2125 */
2126static unsigned int find_next_to_unuse(struct swap_info_struct *si,
2127 unsigned int prev, bool frontswap)
2128{
2129 unsigned int i;
2130 unsigned char count;
2131
2132 /*
2133 * No need for swap_lock here: we're just looking
2134 * for whether an entry is in use, not modifying it; false
2135 * hits are okay, and sys_swapoff() has already prevented new
2136 * allocations from this area (while holding swap_lock).
2137 */
2138 for (i = prev + 1; i < si->max; i++) {
2139 count = READ_ONCE(si->swap_map[i]);
2140 if (count && swap_count(count) != SWAP_MAP_BAD)
2141 if (!frontswap || frontswap_test(si, i))
2142 break;
2143 if ((i % LATENCY_LIMIT) == 0)
2144 cond_resched();
2145 }
2146
2147 if (i == si->max)
2148 i = 0;
2149
2150 return i;
2151}
2152
2153/*
2154 * If the boolean frontswap is true, only unuse pages_to_unuse pages;
2155 * pages_to_unuse==0 means all pages; ignored if frontswap is false
2156 */
2157int try_to_unuse(unsigned int type, bool frontswap,
2158 unsigned long pages_to_unuse)
2159{
2160 struct mm_struct *prev_mm;
2161 struct mm_struct *mm;
2162 struct list_head *p;
2163 int retval = 0;
2164 struct swap_info_struct *si = swap_info[type];
2165 struct page *page;
2166 swp_entry_t entry;
2167 unsigned int i;
2168
2169 if (!READ_ONCE(si->inuse_pages))
2170 return 0;
2171
2172 if (!frontswap)
2173 pages_to_unuse = 0;
2174
2175retry:
2176 retval = shmem_unuse(type, frontswap, &pages_to_unuse);
2177 if (retval)
2178 goto out;
2179
2180 prev_mm = &init_mm;
2181 mmget(prev_mm);
2182
2183 spin_lock(&mmlist_lock);
2184 p = &init_mm.mmlist;
2185 while (READ_ONCE(si->inuse_pages) &&
2186 !signal_pending(current) &&
2187 (p = p->next) != &init_mm.mmlist) {
2188
2189 mm = list_entry(p, struct mm_struct, mmlist);
2190 if (!mmget_not_zero(mm))
2191 continue;
2192 spin_unlock(&mmlist_lock);
2193 mmput(prev_mm);
2194 prev_mm = mm;
2195 retval = unuse_mm(mm, type, frontswap, &pages_to_unuse);
2196
2197 if (retval) {
2198 mmput(prev_mm);
2199 goto out;
2200 }
2201
2202 /*
2203 * Make sure that we aren't completely killing
2204 * interactive performance.
2205 */
2206 cond_resched();
2207 spin_lock(&mmlist_lock);
2208 }
2209 spin_unlock(&mmlist_lock);
2210
2211 mmput(prev_mm);
2212
2213 i = 0;
2214 while (READ_ONCE(si->inuse_pages) &&
2215 !signal_pending(current) &&
2216 (i = find_next_to_unuse(si, i, frontswap)) != 0) {
2217
2218 entry = swp_entry(type, i);
2219 page = find_get_page(swap_address_space(entry), i);
2220 if (!page)
2221 continue;
2222
2223 /*
2224 * It is conceivable that a racing task removed this page from
2225 * swap cache just before we acquired the page lock. The page
2226 * might even be back in swap cache on another swap area. But
2227 * that is okay, try_to_free_swap() only removes stale pages.
2228 */
2229 lock_page(page);
2230 wait_on_page_writeback(page);
2231 try_to_free_swap(page);
2232 unlock_page(page);
2233 put_page(page);
2234
2235 /*
2236 * For frontswap, we just need to unuse pages_to_unuse, if
2237 * it was specified. Need not check frontswap again here as
2238 * we already zeroed out pages_to_unuse if not frontswap.
2239 */
2240 if (pages_to_unuse && --pages_to_unuse == 0)
2241 goto out;
2242 }
2243
2244 /*
2245 * Lets check again to see if there are still swap entries in the map.
2246 * If yes, we would need to do retry the unuse logic again.
2247 * Under global memory pressure, swap entries can be reinserted back
2248 * into process space after the mmlist loop above passes over them.
2249 *
2250 * Limit the number of retries? No: when mmget_not_zero() above fails,
2251 * that mm is likely to be freeing swap from exit_mmap(), which proceeds
2252 * at its own independent pace; and even shmem_writepage() could have
2253 * been preempted after get_swap_page(), temporarily hiding that swap.
2254 * It's easy and robust (though cpu-intensive) just to keep retrying.
2255 */
2256 if (READ_ONCE(si->inuse_pages)) {
2257 if (!signal_pending(current))
2258 goto retry;
2259 retval = -EINTR;
2260 }
2261out:
2262 return (retval == FRONTSWAP_PAGES_UNUSED) ? 0 : retval;
2263}
2264
2265/*
2266 * After a successful try_to_unuse, if no swap is now in use, we know
2267 * we can empty the mmlist. swap_lock must be held on entry and exit.
2268 * Note that mmlist_lock nests inside swap_lock, and an mm must be
2269 * added to the mmlist just after page_duplicate - before would be racy.
2270 */
2271static void drain_mmlist(void)
2272{
2273 struct list_head *p, *next;
2274 unsigned int type;
2275
2276 for (type = 0; type < nr_swapfiles; type++)
2277 if (swap_info[type]->inuse_pages)
2278 return;
2279 spin_lock(&mmlist_lock);
2280 list_for_each_safe(p, next, &init_mm.mmlist)
2281 list_del_init(p);
2282 spin_unlock(&mmlist_lock);
2283}
2284
2285/*
2286 * Free all of a swapdev's extent information
2287 */
2288static void destroy_swap_extents(struct swap_info_struct *sis)
2289{
2290 while (!RB_EMPTY_ROOT(&sis->swap_extent_root)) {
2291 struct rb_node *rb = sis->swap_extent_root.rb_node;
2292 struct swap_extent *se = rb_entry(rb, struct swap_extent, rb_node);
2293
2294 rb_erase(rb, &sis->swap_extent_root);
2295 kfree(se);
2296 }
2297
2298 if (sis->flags & SWP_ACTIVATED) {
2299 struct file *swap_file = sis->swap_file;
2300 struct address_space *mapping = swap_file->f_mapping;
2301
2302 sis->flags &= ~SWP_ACTIVATED;
2303 if (mapping->a_ops->swap_deactivate)
2304 mapping->a_ops->swap_deactivate(swap_file);
2305 }
2306}
2307
2308/*
2309 * Add a block range (and the corresponding page range) into this swapdev's
2310 * extent tree.
2311 *
2312 * This function rather assumes that it is called in ascending page order.
2313 */
2314int
2315add_swap_extent(struct swap_info_struct *sis, unsigned long start_page,
2316 unsigned long nr_pages, sector_t start_block)
2317{
2318 struct rb_node **link = &sis->swap_extent_root.rb_node, *parent = NULL;
2319 struct swap_extent *se;
2320 struct swap_extent *new_se;
2321
2322 /*
2323 * place the new node at the right most since the
2324 * function is called in ascending page order.
2325 */
2326 while (*link) {
2327 parent = *link;
2328 link = &parent->rb_right;
2329 }
2330
2331 if (parent) {
2332 se = rb_entry(parent, struct swap_extent, rb_node);
2333 BUG_ON(se->start_page + se->nr_pages != start_page);
2334 if (se->start_block + se->nr_pages == start_block) {
2335 /* Merge it */
2336 se->nr_pages += nr_pages;
2337 return 0;
2338 }
2339 }
2340
2341 /* No merge, insert a new extent. */
2342 new_se = kmalloc(sizeof(*se), GFP_KERNEL);
2343 if (new_se == NULL)
2344 return -ENOMEM;
2345 new_se->start_page = start_page;
2346 new_se->nr_pages = nr_pages;
2347 new_se->start_block = start_block;
2348
2349 rb_link_node(&new_se->rb_node, parent, link);
2350 rb_insert_color(&new_se->rb_node, &sis->swap_extent_root);
2351 return 1;
2352}
2353EXPORT_SYMBOL_GPL(add_swap_extent);
2354
2355/*
2356 * A `swap extent' is a simple thing which maps a contiguous range of pages
2357 * onto a contiguous range of disk blocks. An ordered list of swap extents
2358 * is built at swapon time and is then used at swap_writepage/swap_readpage
2359 * time for locating where on disk a page belongs.
2360 *
2361 * If the swapfile is an S_ISBLK block device, a single extent is installed.
2362 * This is done so that the main operating code can treat S_ISBLK and S_ISREG
2363 * swap files identically.
2364 *
2365 * Whether the swapdev is an S_ISREG file or an S_ISBLK blockdev, the swap
2366 * extent list operates in PAGE_SIZE disk blocks. Both S_ISREG and S_ISBLK
2367 * swapfiles are handled *identically* after swapon time.
2368 *
2369 * For S_ISREG swapfiles, setup_swap_extents() will walk all the file's blocks
2370 * and will parse them into an ordered extent list, in PAGE_SIZE chunks. If
2371 * some stray blocks are found which do not fall within the PAGE_SIZE alignment
2372 * requirements, they are simply tossed out - we will never use those blocks
2373 * for swapping.
2374 *
2375 * For all swap devices we set S_SWAPFILE across the life of the swapon. This
2376 * prevents users from writing to the swap device, which will corrupt memory.
2377 *
2378 * The amount of disk space which a single swap extent represents varies.
2379 * Typically it is in the 1-4 megabyte range. So we can have hundreds of
2380 * extents in the list. To avoid much list walking, we cache the previous
2381 * search location in `curr_swap_extent', and start new searches from there.
2382 * This is extremely effective. The average number of iterations in
2383 * map_swap_page() has been measured at about 0.3 per page. - akpm.
2384 */
2385static int setup_swap_extents(struct swap_info_struct *sis, sector_t *span)
2386{
2387 struct file *swap_file = sis->swap_file;
2388 struct address_space *mapping = swap_file->f_mapping;
2389 struct inode *inode = mapping->host;
2390 int ret;
2391
2392 if (S_ISBLK(inode->i_mode)) {
2393 ret = add_swap_extent(sis, 0, sis->max, 0);
2394 *span = sis->pages;
2395 return ret;
2396 }
2397
2398 if (mapping->a_ops->swap_activate) {
2399 ret = mapping->a_ops->swap_activate(sis, swap_file, span);
2400 if (ret >= 0)
2401 sis->flags |= SWP_ACTIVATED;
2402 if (!ret) {
2403 sis->flags |= SWP_FS_OPS;
2404 ret = add_swap_extent(sis, 0, sis->max, 0);
2405 *span = sis->pages;
2406 }
2407 return ret;
2408 }
2409
2410 return generic_swapfile_activate(sis, swap_file, span);
2411}
2412
2413static int swap_node(struct swap_info_struct *p)
2414{
2415 struct block_device *bdev;
2416
2417 if (p->bdev)
2418 bdev = p->bdev;
2419 else
2420 bdev = p->swap_file->f_inode->i_sb->s_bdev;
2421
2422 return bdev ? bdev->bd_disk->node_id : NUMA_NO_NODE;
2423}
2424
2425static void setup_swap_info(struct swap_info_struct *p, int prio,
2426 unsigned char *swap_map,
2427 struct swap_cluster_info *cluster_info)
2428{
2429 int i;
2430
2431 if (prio >= 0)
2432 p->prio = prio;
2433 else
2434 p->prio = --least_priority;
2435 /*
2436 * the plist prio is negated because plist ordering is
2437 * low-to-high, while swap ordering is high-to-low
2438 */
2439 p->list.prio = -p->prio;
2440 for_each_node(i) {
2441 if (p->prio >= 0)
2442 p->avail_lists[i].prio = -p->prio;
2443 else {
2444 if (swap_node(p) == i)
2445 p->avail_lists[i].prio = 1;
2446 else
2447 p->avail_lists[i].prio = -p->prio;
2448 }
2449 }
2450 p->swap_map = swap_map;
2451 p->cluster_info = cluster_info;
2452}
2453
2454static void _enable_swap_info(struct swap_info_struct *p)
2455{
2456 p->flags |= SWP_WRITEOK;
2457 atomic_long_add(p->pages, &nr_swap_pages);
2458 total_swap_pages += p->pages;
2459
2460 assert_spin_locked(&swap_lock);
2461 /*
2462 * both lists are plists, and thus priority ordered.
2463 * swap_active_head needs to be priority ordered for swapoff(),
2464 * which on removal of any swap_info_struct with an auto-assigned
2465 * (i.e. negative) priority increments the auto-assigned priority
2466 * of any lower-priority swap_info_structs.
2467 * swap_avail_head needs to be priority ordered for get_swap_page(),
2468 * which allocates swap pages from the highest available priority
2469 * swap_info_struct.
2470 */
2471 plist_add(&p->list, &swap_active_head);
2472 add_to_avail_list(p);
2473}
2474
2475static void enable_swap_info(struct swap_info_struct *p, int prio,
2476 unsigned char *swap_map,
2477 struct swap_cluster_info *cluster_info,
2478 unsigned long *frontswap_map)
2479{
2480 frontswap_init(p->type, frontswap_map);
2481 spin_lock(&swap_lock);
2482 spin_lock(&p->lock);
2483 setup_swap_info(p, prio, swap_map, cluster_info);
2484 spin_unlock(&p->lock);
2485 spin_unlock(&swap_lock);
2486 /*
2487 * Finished initializing swap device, now it's safe to reference it.
2488 */
2489 percpu_ref_resurrect(&p->users);
2490 spin_lock(&swap_lock);
2491 spin_lock(&p->lock);
2492 _enable_swap_info(p);
2493 spin_unlock(&p->lock);
2494 spin_unlock(&swap_lock);
2495}
2496
2497static void reinsert_swap_info(struct swap_info_struct *p)
2498{
2499 spin_lock(&swap_lock);
2500 spin_lock(&p->lock);
2501 setup_swap_info(p, p->prio, p->swap_map, p->cluster_info);
2502 _enable_swap_info(p);
2503 spin_unlock(&p->lock);
2504 spin_unlock(&swap_lock);
2505}
2506
2507bool has_usable_swap(void)
2508{
2509 bool ret = true;
2510
2511 spin_lock(&swap_lock);
2512 if (plist_head_empty(&swap_active_head))
2513 ret = false;
2514 spin_unlock(&swap_lock);
2515 return ret;
2516}
2517
2518SYSCALL_DEFINE1(swapoff, const char __user *, specialfile)
2519{
2520 struct swap_info_struct *p = NULL;
2521 unsigned char *swap_map;
2522 struct swap_cluster_info *cluster_info;
2523 unsigned long *frontswap_map;
2524 struct file *swap_file, *victim;
2525 struct address_space *mapping;
2526 struct inode *inode;
2527 struct filename *pathname;
2528 int err, found = 0;
2529 unsigned int old_block_size;
2530
2531 if (!capable(CAP_SYS_ADMIN))
2532 return -EPERM;
2533
2534 BUG_ON(!current->mm);
2535
2536 pathname = getname(specialfile);
2537 if (IS_ERR(pathname))
2538 return PTR_ERR(pathname);
2539
2540 victim = file_open_name(pathname, O_RDWR|O_LARGEFILE, 0);
2541 err = PTR_ERR(victim);
2542 if (IS_ERR(victim))
2543 goto out;
2544
2545 mapping = victim->f_mapping;
2546 spin_lock(&swap_lock);
2547 plist_for_each_entry(p, &swap_active_head, list) {
2548 if (p->flags & SWP_WRITEOK) {
2549 if (p->swap_file->f_mapping == mapping) {
2550 found = 1;
2551 break;
2552 }
2553 }
2554 }
2555 if (!found) {
2556 err = -EINVAL;
2557 spin_unlock(&swap_lock);
2558 goto out_dput;
2559 }
2560 if (!security_vm_enough_memory_mm(current->mm, p->pages))
2561 vm_unacct_memory(p->pages);
2562 else {
2563 err = -ENOMEM;
2564 spin_unlock(&swap_lock);
2565 goto out_dput;
2566 }
2567 del_from_avail_list(p);
2568 spin_lock(&p->lock);
2569 if (p->prio < 0) {
2570 struct swap_info_struct *si = p;
2571 int nid;
2572
2573 plist_for_each_entry_continue(si, &swap_active_head, list) {
2574 si->prio++;
2575 si->list.prio--;
2576 for_each_node(nid) {
2577 if (si->avail_lists[nid].prio != 1)
2578 si->avail_lists[nid].prio--;
2579 }
2580 }
2581 least_priority++;
2582 }
2583 plist_del(&p->list, &swap_active_head);
2584 atomic_long_sub(p->pages, &nr_swap_pages);
2585 total_swap_pages -= p->pages;
2586 p->flags &= ~SWP_WRITEOK;
2587 spin_unlock(&p->lock);
2588 spin_unlock(&swap_lock);
2589
2590 disable_swap_slots_cache_lock();
2591
2592 set_current_oom_origin();
2593 err = try_to_unuse(p->type, false, 0); /* force unuse all pages */
2594 clear_current_oom_origin();
2595
2596 if (err) {
2597 /* re-insert swap space back into swap_list */
2598 reinsert_swap_info(p);
2599 reenable_swap_slots_cache_unlock();
2600 goto out_dput;
2601 }
2602
2603 reenable_swap_slots_cache_unlock();
2604
2605 /*
2606 * Wait for swap operations protected by get/put_swap_device()
2607 * to complete.
2608 *
2609 * We need synchronize_rcu() here to protect the accessing to
2610 * the swap cache data structure.
2611 */
2612 percpu_ref_kill(&p->users);
2613 synchronize_rcu();
2614 wait_for_completion(&p->comp);
2615
2616 flush_work(&p->discard_work);
2617
2618 destroy_swap_extents(p);
2619 if (p->flags & SWP_CONTINUED)
2620 free_swap_count_continuations(p);
2621
2622 if (!p->bdev || !blk_queue_nonrot(bdev_get_queue(p->bdev)))
2623 atomic_dec(&nr_rotate_swap);
2624
2625 mutex_lock(&swapon_mutex);
2626 spin_lock(&swap_lock);
2627 spin_lock(&p->lock);
2628 drain_mmlist();
2629
2630 /* wait for anyone still in scan_swap_map_slots */
2631 p->highest_bit = 0; /* cuts scans short */
2632 while (p->flags >= SWP_SCANNING) {
2633 spin_unlock(&p->lock);
2634 spin_unlock(&swap_lock);
2635 schedule_timeout_uninterruptible(1);
2636 spin_lock(&swap_lock);
2637 spin_lock(&p->lock);
2638 }
2639
2640 swap_file = p->swap_file;
2641 old_block_size = p->old_block_size;
2642 p->swap_file = NULL;
2643 p->max = 0;
2644 swap_map = p->swap_map;
2645 p->swap_map = NULL;
2646 cluster_info = p->cluster_info;
2647 p->cluster_info = NULL;
2648 frontswap_map = frontswap_map_get(p);
2649 spin_unlock(&p->lock);
2650 spin_unlock(&swap_lock);
2651 arch_swap_invalidate_area(p->type);
2652 frontswap_invalidate_area(p->type);
2653 frontswap_map_set(p, NULL);
2654 mutex_unlock(&swapon_mutex);
2655 free_percpu(p->percpu_cluster);
2656 p->percpu_cluster = NULL;
2657 free_percpu(p->cluster_next_cpu);
2658 p->cluster_next_cpu = NULL;
2659 vfree(swap_map);
2660 kvfree(cluster_info);
2661 kvfree(frontswap_map);
2662 /* Destroy swap account information */
2663 swap_cgroup_swapoff(p->type);
2664 exit_swap_address_space(p->type);
2665
2666 inode = mapping->host;
2667 if (S_ISBLK(inode->i_mode)) {
2668 struct block_device *bdev = I_BDEV(inode);
2669
2670 set_blocksize(bdev, old_block_size);
2671 blkdev_put(bdev, FMODE_READ | FMODE_WRITE | FMODE_EXCL);
2672 }
2673
2674 inode_lock(inode);
2675 inode->i_flags &= ~S_SWAPFILE;
2676 inode_unlock(inode);
2677 filp_close(swap_file, NULL);
2678
2679 /*
2680 * Clear the SWP_USED flag after all resources are freed so that swapon
2681 * can reuse this swap_info in alloc_swap_info() safely. It is ok to
2682 * not hold p->lock after we cleared its SWP_WRITEOK.
2683 */
2684 spin_lock(&swap_lock);
2685 p->flags = 0;
2686 spin_unlock(&swap_lock);
2687
2688 err = 0;
2689 atomic_inc(&proc_poll_event);
2690 wake_up_interruptible(&proc_poll_wait);
2691
2692out_dput:
2693 filp_close(victim, NULL);
2694out:
2695 putname(pathname);
2696 return err;
2697}
2698
2699#ifdef CONFIG_PROC_FS
2700static __poll_t swaps_poll(struct file *file, poll_table *wait)
2701{
2702 struct seq_file *seq = file->private_data;
2703
2704 poll_wait(file, &proc_poll_wait, wait);
2705
2706 if (seq->poll_event != atomic_read(&proc_poll_event)) {
2707 seq->poll_event = atomic_read(&proc_poll_event);
2708 return EPOLLIN | EPOLLRDNORM | EPOLLERR | EPOLLPRI;
2709 }
2710
2711 return EPOLLIN | EPOLLRDNORM;
2712}
2713
2714/* iterator */
2715static void *swap_start(struct seq_file *swap, loff_t *pos)
2716{
2717 struct swap_info_struct *si;
2718 int type;
2719 loff_t l = *pos;
2720
2721 mutex_lock(&swapon_mutex);
2722
2723 if (!l)
2724 return SEQ_START_TOKEN;
2725
2726 for (type = 0; (si = swap_type_to_swap_info(type)); type++) {
2727 if (!(si->flags & SWP_USED) || !si->swap_map)
2728 continue;
2729 if (!--l)
2730 return si;
2731 }
2732
2733 return NULL;
2734}
2735
2736static void *swap_next(struct seq_file *swap, void *v, loff_t *pos)
2737{
2738 struct swap_info_struct *si = v;
2739 int type;
2740
2741 if (v == SEQ_START_TOKEN)
2742 type = 0;
2743 else
2744 type = si->type + 1;
2745
2746 ++(*pos);
2747 for (; (si = swap_type_to_swap_info(type)); type++) {
2748 if (!(si->flags & SWP_USED) || !si->swap_map)
2749 continue;
2750 return si;
2751 }
2752
2753 return NULL;
2754}
2755
2756static void swap_stop(struct seq_file *swap, void *v)
2757{
2758 mutex_unlock(&swapon_mutex);
2759}
2760
2761static int swap_show(struct seq_file *swap, void *v)
2762{
2763 struct swap_info_struct *si = v;
2764 struct file *file;
2765 int len;
2766 unsigned int bytes, inuse;
2767
2768 if (si == SEQ_START_TOKEN) {
2769 seq_puts(swap, "Filename\t\t\t\tType\t\tSize\t\tUsed\t\tPriority\n");
2770 return 0;
2771 }
2772
2773 bytes = si->pages << (PAGE_SHIFT - 10);
2774 inuse = si->inuse_pages << (PAGE_SHIFT - 10);
2775
2776 file = si->swap_file;
2777 len = seq_file_path(swap, file, " \t\n\\");
2778 seq_printf(swap, "%*s%s\t%u\t%s%u\t%s%d\n",
2779 len < 40 ? 40 - len : 1, " ",
2780 S_ISBLK(file_inode(file)->i_mode) ?
2781 "partition" : "file\t",
2782 bytes, bytes < 10000000 ? "\t" : "",
2783 inuse, inuse < 10000000 ? "\t" : "",
2784 si->prio);
2785 return 0;
2786}
2787
2788static const struct seq_operations swaps_op = {
2789 .start = swap_start,
2790 .next = swap_next,
2791 .stop = swap_stop,
2792 .show = swap_show
2793};
2794
2795static int swaps_open(struct inode *inode, struct file *file)
2796{
2797 struct seq_file *seq;
2798 int ret;
2799
2800 ret = seq_open(file, &swaps_op);
2801 if (ret)
2802 return ret;
2803
2804 seq = file->private_data;
2805 seq->poll_event = atomic_read(&proc_poll_event);
2806 return 0;
2807}
2808
2809static const struct proc_ops swaps_proc_ops = {
2810 .proc_flags = PROC_ENTRY_PERMANENT,
2811 .proc_open = swaps_open,
2812 .proc_read = seq_read,
2813 .proc_lseek = seq_lseek,
2814 .proc_release = seq_release,
2815 .proc_poll = swaps_poll,
2816};
2817
2818static int __init procswaps_init(void)
2819{
2820 proc_create("swaps", 0, NULL, &swaps_proc_ops);
2821 return 0;
2822}
2823__initcall(procswaps_init);
2824#endif /* CONFIG_PROC_FS */
2825
2826#ifdef MAX_SWAPFILES_CHECK
2827static int __init max_swapfiles_check(void)
2828{
2829 MAX_SWAPFILES_CHECK();
2830 return 0;
2831}
2832late_initcall(max_swapfiles_check);
2833#endif
2834
2835static struct swap_info_struct *alloc_swap_info(void)
2836{
2837 struct swap_info_struct *p;
2838 struct swap_info_struct *defer = NULL;
2839 unsigned int type;
2840 int i;
2841
2842 p = kvzalloc(struct_size(p, avail_lists, nr_node_ids), GFP_KERNEL);
2843 if (!p)
2844 return ERR_PTR(-ENOMEM);
2845
2846 if (percpu_ref_init(&p->users, swap_users_ref_free,
2847 PERCPU_REF_INIT_DEAD, GFP_KERNEL)) {
2848 kvfree(p);
2849 return ERR_PTR(-ENOMEM);
2850 }
2851
2852 spin_lock(&swap_lock);
2853 for (type = 0; type < nr_swapfiles; type++) {
2854 if (!(swap_info[type]->flags & SWP_USED))
2855 break;
2856 }
2857 if (type >= MAX_SWAPFILES) {
2858 spin_unlock(&swap_lock);
2859 percpu_ref_exit(&p->users);
2860 kvfree(p);
2861 return ERR_PTR(-EPERM);
2862 }
2863 if (type >= nr_swapfiles) {
2864 p->type = type;
2865 /*
2866 * Publish the swap_info_struct after initializing it.
2867 * Note that kvzalloc() above zeroes all its fields.
2868 */
2869 smp_store_release(&swap_info[type], p); /* rcu_assign_pointer() */
2870 nr_swapfiles++;
2871 } else {
2872 defer = p;
2873 p = swap_info[type];
2874 /*
2875 * Do not memset this entry: a racing procfs swap_next()
2876 * would be relying on p->type to remain valid.
2877 */
2878 }
2879 p->swap_extent_root = RB_ROOT;
2880 plist_node_init(&p->list, 0);
2881 for_each_node(i)
2882 plist_node_init(&p->avail_lists[i], 0);
2883 p->flags = SWP_USED;
2884 spin_unlock(&swap_lock);
2885 if (defer) {
2886 percpu_ref_exit(&defer->users);
2887 kvfree(defer);
2888 }
2889 spin_lock_init(&p->lock);
2890 spin_lock_init(&p->cont_lock);
2891 init_completion(&p->comp);
2892
2893 return p;
2894}
2895
2896static int claim_swapfile(struct swap_info_struct *p, struct inode *inode)
2897{
2898 int error;
2899
2900 if (S_ISBLK(inode->i_mode)) {
2901 p->bdev = blkdev_get_by_dev(inode->i_rdev,
2902 FMODE_READ | FMODE_WRITE | FMODE_EXCL, p);
2903 if (IS_ERR(p->bdev)) {
2904 error = PTR_ERR(p->bdev);
2905 p->bdev = NULL;
2906 return error;
2907 }
2908 p->old_block_size = block_size(p->bdev);
2909 error = set_blocksize(p->bdev, PAGE_SIZE);
2910 if (error < 0)
2911 return error;
2912 /*
2913 * Zoned block devices contain zones that have a sequential
2914 * write only restriction. Hence zoned block devices are not
2915 * suitable for swapping. Disallow them here.
2916 */
2917 if (blk_queue_is_zoned(p->bdev->bd_disk->queue))
2918 return -EINVAL;
2919 p->flags |= SWP_BLKDEV;
2920 } else if (S_ISREG(inode->i_mode)) {
2921 p->bdev = inode->i_sb->s_bdev;
2922 }
2923
2924 return 0;
2925}
2926
2927
2928/*
2929 * Find out how many pages are allowed for a single swap device. There
2930 * are two limiting factors:
2931 * 1) the number of bits for the swap offset in the swp_entry_t type, and
2932 * 2) the number of bits in the swap pte, as defined by the different
2933 * architectures.
2934 *
2935 * In order to find the largest possible bit mask, a swap entry with
2936 * swap type 0 and swap offset ~0UL is created, encoded to a swap pte,
2937 * decoded to a swp_entry_t again, and finally the swap offset is
2938 * extracted.
2939 *
2940 * This will mask all the bits from the initial ~0UL mask that can't
2941 * be encoded in either the swp_entry_t or the architecture definition
2942 * of a swap pte.
2943 */
2944unsigned long generic_max_swapfile_size(void)
2945{
2946 return swp_offset(pte_to_swp_entry(
2947 swp_entry_to_pte(swp_entry(0, ~0UL)))) + 1;
2948}
2949
2950/* Can be overridden by an architecture for additional checks. */
2951__weak unsigned long max_swapfile_size(void)
2952{
2953 return generic_max_swapfile_size();
2954}
2955
2956static unsigned long read_swap_header(struct swap_info_struct *p,
2957 union swap_header *swap_header,
2958 struct inode *inode)
2959{
2960 int i;
2961 unsigned long maxpages;
2962 unsigned long swapfilepages;
2963 unsigned long last_page;
2964
2965 if (memcmp("SWAPSPACE2", swap_header->magic.magic, 10)) {
2966 pr_err("Unable to find swap-space signature\n");
2967 return 0;
2968 }
2969
2970 /* swap partition endianness hack... */
2971 if (swab32(swap_header->info.version) == 1) {
2972 swab32s(&swap_header->info.version);
2973 swab32s(&swap_header->info.last_page);
2974 swab32s(&swap_header->info.nr_badpages);
2975 if (swap_header->info.nr_badpages > MAX_SWAP_BADPAGES)
2976 return 0;
2977 for (i = 0; i < swap_header->info.nr_badpages; i++)
2978 swab32s(&swap_header->info.badpages[i]);
2979 }
2980 /* Check the swap header's sub-version */
2981 if (swap_header->info.version != 1) {
2982 pr_warn("Unable to handle swap header version %d\n",
2983 swap_header->info.version);
2984 return 0;
2985 }
2986
2987 p->lowest_bit = 1;
2988 p->cluster_next = 1;
2989 p->cluster_nr = 0;
2990
2991 maxpages = max_swapfile_size();
2992 last_page = swap_header->info.last_page;
2993 if (!last_page) {
2994 pr_warn("Empty swap-file\n");
2995 return 0;
2996 }
2997 if (last_page > maxpages) {
2998 pr_warn("Truncating oversized swap area, only using %luk out of %luk\n",
2999 maxpages << (PAGE_SHIFT - 10),
3000 last_page << (PAGE_SHIFT - 10));
3001 }
3002 if (maxpages > last_page) {
3003 maxpages = last_page + 1;
3004 /* p->max is an unsigned int: don't overflow it */
3005 if ((unsigned int)maxpages == 0)
3006 maxpages = UINT_MAX;
3007 }
3008 p->highest_bit = maxpages - 1;
3009
3010 if (!maxpages)
3011 return 0;
3012 swapfilepages = i_size_read(inode) >> PAGE_SHIFT;
3013 if (swapfilepages && maxpages > swapfilepages) {
3014 pr_warn("Swap area shorter than signature indicates\n");
3015 return 0;
3016 }
3017 if (swap_header->info.nr_badpages && S_ISREG(inode->i_mode))
3018 return 0;
3019 if (swap_header->info.nr_badpages > MAX_SWAP_BADPAGES)
3020 return 0;
3021
3022 return maxpages;
3023}
3024
3025#define SWAP_CLUSTER_INFO_COLS \
3026 DIV_ROUND_UP(L1_CACHE_BYTES, sizeof(struct swap_cluster_info))
3027#define SWAP_CLUSTER_SPACE_COLS \
3028 DIV_ROUND_UP(SWAP_ADDRESS_SPACE_PAGES, SWAPFILE_CLUSTER)
3029#define SWAP_CLUSTER_COLS \
3030 max_t(unsigned int, SWAP_CLUSTER_INFO_COLS, SWAP_CLUSTER_SPACE_COLS)
3031
3032static int setup_swap_map_and_extents(struct swap_info_struct *p,
3033 union swap_header *swap_header,
3034 unsigned char *swap_map,
3035 struct swap_cluster_info *cluster_info,
3036 unsigned long maxpages,
3037 sector_t *span)
3038{
3039 unsigned int j, k;
3040 unsigned int nr_good_pages;
3041 int nr_extents;
3042 unsigned long nr_clusters = DIV_ROUND_UP(maxpages, SWAPFILE_CLUSTER);
3043 unsigned long col = p->cluster_next / SWAPFILE_CLUSTER % SWAP_CLUSTER_COLS;
3044 unsigned long i, idx;
3045
3046 nr_good_pages = maxpages - 1; /* omit header page */
3047
3048 cluster_list_init(&p->free_clusters);
3049 cluster_list_init(&p->discard_clusters);
3050
3051 for (i = 0; i < swap_header->info.nr_badpages; i++) {
3052 unsigned int page_nr = swap_header->info.badpages[i];
3053 if (page_nr == 0 || page_nr > swap_header->info.last_page)
3054 return -EINVAL;
3055 if (page_nr < maxpages) {
3056 swap_map[page_nr] = SWAP_MAP_BAD;
3057 nr_good_pages--;
3058 /*
3059 * Haven't marked the cluster free yet, no list
3060 * operation involved
3061 */
3062 inc_cluster_info_page(p, cluster_info, page_nr);
3063 }
3064 }
3065
3066 /* Haven't marked the cluster free yet, no list operation involved */
3067 for (i = maxpages; i < round_up(maxpages, SWAPFILE_CLUSTER); i++)
3068 inc_cluster_info_page(p, cluster_info, i);
3069
3070 if (nr_good_pages) {
3071 swap_map[0] = SWAP_MAP_BAD;
3072 /*
3073 * Not mark the cluster free yet, no list
3074 * operation involved
3075 */
3076 inc_cluster_info_page(p, cluster_info, 0);
3077 p->max = maxpages;
3078 p->pages = nr_good_pages;
3079 nr_extents = setup_swap_extents(p, span);
3080 if (nr_extents < 0)
3081 return nr_extents;
3082 nr_good_pages = p->pages;
3083 }
3084 if (!nr_good_pages) {
3085 pr_warn("Empty swap-file\n");
3086 return -EINVAL;
3087 }
3088
3089 if (!cluster_info)
3090 return nr_extents;
3091
3092
3093 /*
3094 * Reduce false cache line sharing between cluster_info and
3095 * sharing same address space.
3096 */
3097 for (k = 0; k < SWAP_CLUSTER_COLS; k++) {
3098 j = (k + col) % SWAP_CLUSTER_COLS;
3099 for (i = 0; i < DIV_ROUND_UP(nr_clusters, SWAP_CLUSTER_COLS); i++) {
3100 idx = i * SWAP_CLUSTER_COLS + j;
3101 if (idx >= nr_clusters)
3102 continue;
3103 if (cluster_count(&cluster_info[idx]))
3104 continue;
3105 cluster_set_flag(&cluster_info[idx], CLUSTER_FLAG_FREE);
3106 cluster_list_add_tail(&p->free_clusters, cluster_info,
3107 idx);
3108 }
3109 }
3110 return nr_extents;
3111}
3112
3113/*
3114 * Helper to sys_swapon determining if a given swap
3115 * backing device queue supports DISCARD operations.
3116 */
3117static bool swap_discardable(struct swap_info_struct *si)
3118{
3119 struct request_queue *q = bdev_get_queue(si->bdev);
3120
3121 if (!q || !blk_queue_discard(q))
3122 return false;
3123
3124 return true;
3125}
3126
3127SYSCALL_DEFINE2(swapon, const char __user *, specialfile, int, swap_flags)
3128{
3129 struct swap_info_struct *p;
3130 struct filename *name;
3131 struct file *swap_file = NULL;
3132 struct address_space *mapping;
3133 int prio;
3134 int error;
3135 union swap_header *swap_header;
3136 int nr_extents;
3137 sector_t span;
3138 unsigned long maxpages;
3139 unsigned char *swap_map = NULL;
3140 struct swap_cluster_info *cluster_info = NULL;
3141 unsigned long *frontswap_map = NULL;
3142 struct page *page = NULL;
3143 struct inode *inode = NULL;
3144 bool inced_nr_rotate_swap = false;
3145
3146 if (swap_flags & ~SWAP_FLAGS_VALID)
3147 return -EINVAL;
3148
3149 if (!capable(CAP_SYS_ADMIN))
3150 return -EPERM;
3151
3152 if (!swap_avail_heads)
3153 return -ENOMEM;
3154
3155 p = alloc_swap_info();
3156 if (IS_ERR(p))
3157 return PTR_ERR(p);
3158
3159 INIT_WORK(&p->discard_work, swap_discard_work);
3160
3161 name = getname(specialfile);
3162 if (IS_ERR(name)) {
3163 error = PTR_ERR(name);
3164 name = NULL;
3165 goto bad_swap;
3166 }
3167 swap_file = file_open_name(name, O_RDWR|O_LARGEFILE, 0);
3168 if (IS_ERR(swap_file)) {
3169 error = PTR_ERR(swap_file);
3170 swap_file = NULL;
3171 goto bad_swap;
3172 }
3173
3174 p->swap_file = swap_file;
3175 mapping = swap_file->f_mapping;
3176 inode = mapping->host;
3177
3178 error = claim_swapfile(p, inode);
3179 if (unlikely(error))
3180 goto bad_swap;
3181
3182 inode_lock(inode);
3183 if (IS_SWAPFILE(inode)) {
3184 error = -EBUSY;
3185 goto bad_swap_unlock_inode;
3186 }
3187
3188 /*
3189 * Read the swap header.
3190 */
3191 if (!mapping->a_ops->readpage) {
3192 error = -EINVAL;
3193 goto bad_swap_unlock_inode;
3194 }
3195 page = read_mapping_page(mapping, 0, swap_file);
3196 if (IS_ERR(page)) {
3197 error = PTR_ERR(page);
3198 goto bad_swap_unlock_inode;
3199 }
3200 swap_header = kmap(page);
3201
3202 maxpages = read_swap_header(p, swap_header, inode);
3203 if (unlikely(!maxpages)) {
3204 error = -EINVAL;
3205 goto bad_swap_unlock_inode;
3206 }
3207
3208 /* OK, set up the swap map and apply the bad block list */
3209 swap_map = vzalloc(maxpages);
3210 if (!swap_map) {
3211 error = -ENOMEM;
3212 goto bad_swap_unlock_inode;
3213 }
3214
3215 if (p->bdev && blk_queue_stable_writes(p->bdev->bd_disk->queue))
3216 p->flags |= SWP_STABLE_WRITES;
3217
3218 if (p->bdev && p->bdev->bd_disk->fops->rw_page)
3219 p->flags |= SWP_SYNCHRONOUS_IO;
3220
3221 if (p->bdev && blk_queue_nonrot(bdev_get_queue(p->bdev))) {
3222 int cpu;
3223 unsigned long ci, nr_cluster;
3224
3225 p->flags |= SWP_SOLIDSTATE;
3226 p->cluster_next_cpu = alloc_percpu(unsigned int);
3227 if (!p->cluster_next_cpu) {
3228 error = -ENOMEM;
3229 goto bad_swap_unlock_inode;
3230 }
3231 /*
3232 * select a random position to start with to help wear leveling
3233 * SSD
3234 */
3235 for_each_possible_cpu(cpu) {
3236 per_cpu(*p->cluster_next_cpu, cpu) =
3237 1 + prandom_u32_max(p->highest_bit);
3238 }
3239 nr_cluster = DIV_ROUND_UP(maxpages, SWAPFILE_CLUSTER);
3240
3241 cluster_info = kvcalloc(nr_cluster, sizeof(*cluster_info),
3242 GFP_KERNEL);
3243 if (!cluster_info) {
3244 error = -ENOMEM;
3245 goto bad_swap_unlock_inode;
3246 }
3247
3248 for (ci = 0; ci < nr_cluster; ci++)
3249 spin_lock_init(&((cluster_info + ci)->lock));
3250
3251 p->percpu_cluster = alloc_percpu(struct percpu_cluster);
3252 if (!p->percpu_cluster) {
3253 error = -ENOMEM;
3254 goto bad_swap_unlock_inode;
3255 }
3256 for_each_possible_cpu(cpu) {
3257 struct percpu_cluster *cluster;
3258 cluster = per_cpu_ptr(p->percpu_cluster, cpu);
3259 cluster_set_null(&cluster->index);
3260 }
3261 } else {
3262 atomic_inc(&nr_rotate_swap);
3263 inced_nr_rotate_swap = true;
3264 }
3265
3266 error = swap_cgroup_swapon(p->type, maxpages);
3267 if (error)
3268 goto bad_swap_unlock_inode;
3269
3270 nr_extents = setup_swap_map_and_extents(p, swap_header, swap_map,
3271 cluster_info, maxpages, &span);
3272 if (unlikely(nr_extents < 0)) {
3273 error = nr_extents;
3274 goto bad_swap_unlock_inode;
3275 }
3276 /* frontswap enabled? set up bit-per-page map for frontswap */
3277 if (IS_ENABLED(CONFIG_FRONTSWAP))
3278 frontswap_map = kvcalloc(BITS_TO_LONGS(maxpages),
3279 sizeof(long),
3280 GFP_KERNEL);
3281
3282 if (p->bdev && (swap_flags & SWAP_FLAG_DISCARD) && swap_discardable(p)) {
3283 /*
3284 * When discard is enabled for swap with no particular
3285 * policy flagged, we set all swap discard flags here in
3286 * order to sustain backward compatibility with older
3287 * swapon(8) releases.
3288 */
3289 p->flags |= (SWP_DISCARDABLE | SWP_AREA_DISCARD |
3290 SWP_PAGE_DISCARD);
3291
3292 /*
3293 * By flagging sys_swapon, a sysadmin can tell us to
3294 * either do single-time area discards only, or to just
3295 * perform discards for released swap page-clusters.
3296 * Now it's time to adjust the p->flags accordingly.
3297 */
3298 if (swap_flags & SWAP_FLAG_DISCARD_ONCE)
3299 p->flags &= ~SWP_PAGE_DISCARD;
3300 else if (swap_flags & SWAP_FLAG_DISCARD_PAGES)
3301 p->flags &= ~SWP_AREA_DISCARD;
3302
3303 /* issue a swapon-time discard if it's still required */
3304 if (p->flags & SWP_AREA_DISCARD) {
3305 int err = discard_swap(p);
3306 if (unlikely(err))
3307 pr_err("swapon: discard_swap(%p): %d\n",
3308 p, err);
3309 }
3310 }
3311
3312 error = init_swap_address_space(p->type, maxpages);
3313 if (error)
3314 goto bad_swap_unlock_inode;
3315
3316 /*
3317 * Flush any pending IO and dirty mappings before we start using this
3318 * swap device.
3319 */
3320 inode->i_flags |= S_SWAPFILE;
3321 error = inode_drain_writes(inode);
3322 if (error) {
3323 inode->i_flags &= ~S_SWAPFILE;
3324 goto free_swap_address_space;
3325 }
3326
3327 mutex_lock(&swapon_mutex);
3328 prio = -1;
3329 if (swap_flags & SWAP_FLAG_PREFER)
3330 prio =
3331 (swap_flags & SWAP_FLAG_PRIO_MASK) >> SWAP_FLAG_PRIO_SHIFT;
3332 enable_swap_info(p, prio, swap_map, cluster_info, frontswap_map);
3333
3334 pr_info("Adding %uk swap on %s. Priority:%d extents:%d across:%lluk %s%s%s%s%s\n",
3335 p->pages<<(PAGE_SHIFT-10), name->name, p->prio,
3336 nr_extents, (unsigned long long)span<<(PAGE_SHIFT-10),
3337 (p->flags & SWP_SOLIDSTATE) ? "SS" : "",
3338 (p->flags & SWP_DISCARDABLE) ? "D" : "",
3339 (p->flags & SWP_AREA_DISCARD) ? "s" : "",
3340 (p->flags & SWP_PAGE_DISCARD) ? "c" : "",
3341 (frontswap_map) ? "FS" : "");
3342
3343 mutex_unlock(&swapon_mutex);
3344 atomic_inc(&proc_poll_event);
3345 wake_up_interruptible(&proc_poll_wait);
3346
3347 error = 0;
3348 goto out;
3349free_swap_address_space:
3350 exit_swap_address_space(p->type);
3351bad_swap_unlock_inode:
3352 inode_unlock(inode);
3353bad_swap:
3354 free_percpu(p->percpu_cluster);
3355 p->percpu_cluster = NULL;
3356 free_percpu(p->cluster_next_cpu);
3357 p->cluster_next_cpu = NULL;
3358 if (inode && S_ISBLK(inode->i_mode) && p->bdev) {
3359 set_blocksize(p->bdev, p->old_block_size);
3360 blkdev_put(p->bdev, FMODE_READ | FMODE_WRITE | FMODE_EXCL);
3361 }
3362 inode = NULL;
3363 destroy_swap_extents(p);
3364 swap_cgroup_swapoff(p->type);
3365 spin_lock(&swap_lock);
3366 p->swap_file = NULL;
3367 p->flags = 0;
3368 spin_unlock(&swap_lock);
3369 vfree(swap_map);
3370 kvfree(cluster_info);
3371 kvfree(frontswap_map);
3372 if (inced_nr_rotate_swap)
3373 atomic_dec(&nr_rotate_swap);
3374 if (swap_file)
3375 filp_close(swap_file, NULL);
3376out:
3377 if (page && !IS_ERR(page)) {
3378 kunmap(page);
3379 put_page(page);
3380 }
3381 if (name)
3382 putname(name);
3383 if (inode)
3384 inode_unlock(inode);
3385 if (!error)
3386 enable_swap_slots_cache();
3387 return error;
3388}
3389
3390void si_swapinfo(struct sysinfo *val)
3391{
3392 unsigned int type;
3393 unsigned long nr_to_be_unused = 0;
3394
3395 spin_lock(&swap_lock);
3396 for (type = 0; type < nr_swapfiles; type++) {
3397 struct swap_info_struct *si = swap_info[type];
3398
3399 if ((si->flags & SWP_USED) && !(si->flags & SWP_WRITEOK))
3400 nr_to_be_unused += si->inuse_pages;
3401 }
3402 val->freeswap = atomic_long_read(&nr_swap_pages) + nr_to_be_unused;
3403 val->totalswap = total_swap_pages + nr_to_be_unused;
3404 spin_unlock(&swap_lock);
3405}
3406
3407/*
3408 * Verify that a swap entry is valid and increment its swap map count.
3409 *
3410 * Returns error code in following case.
3411 * - success -> 0
3412 * - swp_entry is invalid -> EINVAL
3413 * - swp_entry is migration entry -> EINVAL
3414 * - swap-cache reference is requested but there is already one. -> EEXIST
3415 * - swap-cache reference is requested but the entry is not used. -> ENOENT
3416 * - swap-mapped reference requested but needs continued swap count. -> ENOMEM
3417 */
3418static int __swap_duplicate(swp_entry_t entry, unsigned char usage)
3419{
3420 struct swap_info_struct *p;
3421 struct swap_cluster_info *ci;
3422 unsigned long offset;
3423 unsigned char count;
3424 unsigned char has_cache;
3425 int err;
3426
3427 p = get_swap_device(entry);
3428 if (!p)
3429 return -EINVAL;
3430
3431 offset = swp_offset(entry);
3432 ci = lock_cluster_or_swap_info(p, offset);
3433
3434 count = p->swap_map[offset];
3435
3436 /*
3437 * swapin_readahead() doesn't check if a swap entry is valid, so the
3438 * swap entry could be SWAP_MAP_BAD. Check here with lock held.
3439 */
3440 if (unlikely(swap_count(count) == SWAP_MAP_BAD)) {
3441 err = -ENOENT;
3442 goto unlock_out;
3443 }
3444
3445 has_cache = count & SWAP_HAS_CACHE;
3446 count &= ~SWAP_HAS_CACHE;
3447 err = 0;
3448
3449 if (usage == SWAP_HAS_CACHE) {
3450
3451 /* set SWAP_HAS_CACHE if there is no cache and entry is used */
3452 if (!has_cache && count)
3453 has_cache = SWAP_HAS_CACHE;
3454 else if (has_cache) /* someone else added cache */
3455 err = -EEXIST;
3456 else /* no users remaining */
3457 err = -ENOENT;
3458
3459 } else if (count || has_cache) {
3460
3461 if ((count & ~COUNT_CONTINUED) < SWAP_MAP_MAX)
3462 count += usage;
3463 else if ((count & ~COUNT_CONTINUED) > SWAP_MAP_MAX)
3464 err = -EINVAL;
3465 else if (swap_count_continued(p, offset, count))
3466 count = COUNT_CONTINUED;
3467 else
3468 err = -ENOMEM;
3469 } else
3470 err = -ENOENT; /* unused swap entry */
3471
3472 WRITE_ONCE(p->swap_map[offset], count | has_cache);
3473
3474unlock_out:
3475 unlock_cluster_or_swap_info(p, ci);
3476 if (p)
3477 put_swap_device(p);
3478 return err;
3479}
3480
3481/*
3482 * Help swapoff by noting that swap entry belongs to shmem/tmpfs
3483 * (in which case its reference count is never incremented).
3484 */
3485void swap_shmem_alloc(swp_entry_t entry)
3486{
3487 __swap_duplicate(entry, SWAP_MAP_SHMEM);
3488}
3489
3490/*
3491 * Increase reference count of swap entry by 1.
3492 * Returns 0 for success, or -ENOMEM if a swap_count_continuation is required
3493 * but could not be atomically allocated. Returns 0, just as if it succeeded,
3494 * if __swap_duplicate() fails for another reason (-EINVAL or -ENOENT), which
3495 * might occur if a page table entry has got corrupted.
3496 */
3497int swap_duplicate(swp_entry_t entry)
3498{
3499 int err = 0;
3500
3501 while (!err && __swap_duplicate(entry, 1) == -ENOMEM)
3502 err = add_swap_count_continuation(entry, GFP_ATOMIC);
3503 return err;
3504}
3505
3506/*
3507 * @entry: swap entry for which we allocate swap cache.
3508 *
3509 * Called when allocating swap cache for existing swap entry,
3510 * This can return error codes. Returns 0 at success.
3511 * -EEXIST means there is a swap cache.
3512 * Note: return code is different from swap_duplicate().
3513 */
3514int swapcache_prepare(swp_entry_t entry)
3515{
3516 return __swap_duplicate(entry, SWAP_HAS_CACHE);
3517}
3518
3519struct swap_info_struct *swp_swap_info(swp_entry_t entry)
3520{
3521 return swap_type_to_swap_info(swp_type(entry));
3522}
3523
3524struct swap_info_struct *page_swap_info(struct page *page)
3525{
3526 swp_entry_t entry = { .val = page_private(page) };
3527 return swp_swap_info(entry);
3528}
3529
3530/*
3531 * out-of-line __page_file_ methods to avoid include hell.
3532 */
3533struct address_space *__page_file_mapping(struct page *page)
3534{
3535 return page_swap_info(page)->swap_file->f_mapping;
3536}
3537EXPORT_SYMBOL_GPL(__page_file_mapping);
3538
3539pgoff_t __page_file_index(struct page *page)
3540{
3541 swp_entry_t swap = { .val = page_private(page) };
3542 return swp_offset(swap);
3543}
3544EXPORT_SYMBOL_GPL(__page_file_index);
3545
3546/*
3547 * add_swap_count_continuation - called when a swap count is duplicated
3548 * beyond SWAP_MAP_MAX, it allocates a new page and links that to the entry's
3549 * page of the original vmalloc'ed swap_map, to hold the continuation count
3550 * (for that entry and for its neighbouring PAGE_SIZE swap entries). Called
3551 * again when count is duplicated beyond SWAP_MAP_MAX * SWAP_CONT_MAX, etc.
3552 *
3553 * These continuation pages are seldom referenced: the common paths all work
3554 * on the original swap_map, only referring to a continuation page when the
3555 * low "digit" of a count is incremented or decremented through SWAP_MAP_MAX.
3556 *
3557 * add_swap_count_continuation(, GFP_ATOMIC) can be called while holding
3558 * page table locks; if it fails, add_swap_count_continuation(, GFP_KERNEL)
3559 * can be called after dropping locks.
3560 */
3561int add_swap_count_continuation(swp_entry_t entry, gfp_t gfp_mask)
3562{
3563 struct swap_info_struct *si;
3564 struct swap_cluster_info *ci;
3565 struct page *head;
3566 struct page *page;
3567 struct page *list_page;
3568 pgoff_t offset;
3569 unsigned char count;
3570 int ret = 0;
3571
3572 /*
3573 * When debugging, it's easier to use __GFP_ZERO here; but it's better
3574 * for latency not to zero a page while GFP_ATOMIC and holding locks.
3575 */
3576 page = alloc_page(gfp_mask | __GFP_HIGHMEM);
3577
3578 si = get_swap_device(entry);
3579 if (!si) {
3580 /*
3581 * An acceptable race has occurred since the failing
3582 * __swap_duplicate(): the swap device may be swapoff
3583 */
3584 goto outer;
3585 }
3586 spin_lock(&si->lock);
3587
3588 offset = swp_offset(entry);
3589
3590 ci = lock_cluster(si, offset);
3591
3592 count = swap_count(si->swap_map[offset]);
3593
3594 if ((count & ~COUNT_CONTINUED) != SWAP_MAP_MAX) {
3595 /*
3596 * The higher the swap count, the more likely it is that tasks
3597 * will race to add swap count continuation: we need to avoid
3598 * over-provisioning.
3599 */
3600 goto out;
3601 }
3602
3603 if (!page) {
3604 ret = -ENOMEM;
3605 goto out;
3606 }
3607
3608 /*
3609 * We are fortunate that although vmalloc_to_page uses pte_offset_map,
3610 * no architecture is using highmem pages for kernel page tables: so it
3611 * will not corrupt the GFP_ATOMIC caller's atomic page table kmaps.
3612 */
3613 head = vmalloc_to_page(si->swap_map + offset);
3614 offset &= ~PAGE_MASK;
3615
3616 spin_lock(&si->cont_lock);
3617 /*
3618 * Page allocation does not initialize the page's lru field,
3619 * but it does always reset its private field.
3620 */
3621 if (!page_private(head)) {
3622 BUG_ON(count & COUNT_CONTINUED);
3623 INIT_LIST_HEAD(&head->lru);
3624 set_page_private(head, SWP_CONTINUED);
3625 si->flags |= SWP_CONTINUED;
3626 }
3627
3628 list_for_each_entry(list_page, &head->lru, lru) {
3629 unsigned char *map;
3630
3631 /*
3632 * If the previous map said no continuation, but we've found
3633 * a continuation page, free our allocation and use this one.
3634 */
3635 if (!(count & COUNT_CONTINUED))
3636 goto out_unlock_cont;
3637
3638 map = kmap_atomic(list_page) + offset;
3639 count = *map;
3640 kunmap_atomic(map);
3641
3642 /*
3643 * If this continuation count now has some space in it,
3644 * free our allocation and use this one.
3645 */
3646 if ((count & ~COUNT_CONTINUED) != SWAP_CONT_MAX)
3647 goto out_unlock_cont;
3648 }
3649
3650 list_add_tail(&page->lru, &head->lru);
3651 page = NULL; /* now it's attached, don't free it */
3652out_unlock_cont:
3653 spin_unlock(&si->cont_lock);
3654out:
3655 unlock_cluster(ci);
3656 spin_unlock(&si->lock);
3657 put_swap_device(si);
3658outer:
3659 if (page)
3660 __free_page(page);
3661 return ret;
3662}
3663
3664/*
3665 * swap_count_continued - when the original swap_map count is incremented
3666 * from SWAP_MAP_MAX, check if there is already a continuation page to carry
3667 * into, carry if so, or else fail until a new continuation page is allocated;
3668 * when the original swap_map count is decremented from 0 with continuation,
3669 * borrow from the continuation and report whether it still holds more.
3670 * Called while __swap_duplicate() or swap_entry_free() holds swap or cluster
3671 * lock.
3672 */
3673static bool swap_count_continued(struct swap_info_struct *si,
3674 pgoff_t offset, unsigned char count)
3675{
3676 struct page *head;
3677 struct page *page;
3678 unsigned char *map;
3679 bool ret;
3680
3681 head = vmalloc_to_page(si->swap_map + offset);
3682 if (page_private(head) != SWP_CONTINUED) {
3683 BUG_ON(count & COUNT_CONTINUED);
3684 return false; /* need to add count continuation */
3685 }
3686
3687 spin_lock(&si->cont_lock);
3688 offset &= ~PAGE_MASK;
3689 page = list_next_entry(head, lru);
3690 map = kmap_atomic(page) + offset;
3691
3692 if (count == SWAP_MAP_MAX) /* initial increment from swap_map */
3693 goto init_map; /* jump over SWAP_CONT_MAX checks */
3694
3695 if (count == (SWAP_MAP_MAX | COUNT_CONTINUED)) { /* incrementing */
3696 /*
3697 * Think of how you add 1 to 999
3698 */
3699 while (*map == (SWAP_CONT_MAX | COUNT_CONTINUED)) {
3700 kunmap_atomic(map);
3701 page = list_next_entry(page, lru);
3702 BUG_ON(page == head);
3703 map = kmap_atomic(page) + offset;
3704 }
3705 if (*map == SWAP_CONT_MAX) {
3706 kunmap_atomic(map);
3707 page = list_next_entry(page, lru);
3708 if (page == head) {
3709 ret = false; /* add count continuation */
3710 goto out;
3711 }
3712 map = kmap_atomic(page) + offset;
3713init_map: *map = 0; /* we didn't zero the page */
3714 }
3715 *map += 1;
3716 kunmap_atomic(map);
3717 while ((page = list_prev_entry(page, lru)) != head) {
3718 map = kmap_atomic(page) + offset;
3719 *map = COUNT_CONTINUED;
3720 kunmap_atomic(map);
3721 }
3722 ret = true; /* incremented */
3723
3724 } else { /* decrementing */
3725 /*
3726 * Think of how you subtract 1 from 1000
3727 */
3728 BUG_ON(count != COUNT_CONTINUED);
3729 while (*map == COUNT_CONTINUED) {
3730 kunmap_atomic(map);
3731 page = list_next_entry(page, lru);
3732 BUG_ON(page == head);
3733 map = kmap_atomic(page) + offset;
3734 }
3735 BUG_ON(*map == 0);
3736 *map -= 1;
3737 if (*map == 0)
3738 count = 0;
3739 kunmap_atomic(map);
3740 while ((page = list_prev_entry(page, lru)) != head) {
3741 map = kmap_atomic(page) + offset;
3742 *map = SWAP_CONT_MAX | count;
3743 count = COUNT_CONTINUED;
3744 kunmap_atomic(map);
3745 }
3746 ret = count == COUNT_CONTINUED;
3747 }
3748out:
3749 spin_unlock(&si->cont_lock);
3750 return ret;
3751}
3752
3753/*
3754 * free_swap_count_continuations - swapoff free all the continuation pages
3755 * appended to the swap_map, after swap_map is quiesced, before vfree'ing it.
3756 */
3757static void free_swap_count_continuations(struct swap_info_struct *si)
3758{
3759 pgoff_t offset;
3760
3761 for (offset = 0; offset < si->max; offset += PAGE_SIZE) {
3762 struct page *head;
3763 head = vmalloc_to_page(si->swap_map + offset);
3764 if (page_private(head)) {
3765 struct page *page, *next;
3766
3767 list_for_each_entry_safe(page, next, &head->lru, lru) {
3768 list_del(&page->lru);
3769 __free_page(page);
3770 }
3771 }
3772 }
3773}
3774
3775#if defined(CONFIG_MEMCG) && defined(CONFIG_BLK_CGROUP)
3776void cgroup_throttle_swaprate(struct page *page, gfp_t gfp_mask)
3777{
3778 struct swap_info_struct *si, *next;
3779 int nid = page_to_nid(page);
3780
3781 if (!(gfp_mask & __GFP_IO))
3782 return;
3783
3784 if (!blk_cgroup_congested())
3785 return;
3786
3787 /*
3788 * We've already scheduled a throttle, avoid taking the global swap
3789 * lock.
3790 */
3791 if (current->throttle_queue)
3792 return;
3793
3794 spin_lock(&swap_avail_lock);
3795 plist_for_each_entry_safe(si, next, &swap_avail_heads[nid],
3796 avail_lists[nid]) {
3797 if (si->bdev) {
3798 blkcg_schedule_throttle(bdev_get_queue(si->bdev), true);
3799 break;
3800 }
3801 }
3802 spin_unlock(&swap_avail_lock);
3803}
3804#endif
3805
3806static int __init swapfile_init(void)
3807{
3808 int nid;
3809
3810 swap_avail_heads = kmalloc_array(nr_node_ids, sizeof(struct plist_head),
3811 GFP_KERNEL);
3812 if (!swap_avail_heads) {
3813 pr_emerg("Not enough memory for swap heads, swap is disabled\n");
3814 return -ENOMEM;
3815 }
3816
3817 for_each_node(nid)
3818 plist_head_init(&swap_avail_heads[nid]);
3819
3820 return 0;
3821}
3822subsys_initcall(swapfile_init);