4 * Copyright (C) 1991, 1992, 1993, 1994 Linus Torvalds
5 * Swap reorganised 29.12.95, Stephen Tweedie
9 #include <linux/hugetlb.h>
10 #include <linux/mman.h>
11 #include <linux/slab.h>
12 #include <linux/kernel_stat.h>
13 #include <linux/swap.h>
14 #include <linux/vmalloc.h>
15 #include <linux/pagemap.h>
16 #include <linux/namei.h>
17 #include <linux/shm.h>
18 #include <linux/blkdev.h>
19 #include <linux/writeback.h>
20 #include <linux/proc_fs.h>
21 #include <linux/seq_file.h>
22 #include <linux/init.h>
23 #include <linux/module.h>
24 #include <linux/rmap.h>
25 #include <linux/security.h>
26 #include <linux/backing-dev.h>
27 #include <linux/mutex.h>
28 #include <linux/capability.h>
29 #include <linux/syscalls.h>
31 #include <asm/pgtable.h>
32 #include <asm/tlbflush.h>
33 #include <linux/swapops.h>
35 DEFINE_SPINLOCK(swap_lock
);
36 unsigned int nr_swapfiles
;
37 long total_swap_pages
;
38 static int swap_overflow
;
40 static const char Bad_file
[] = "Bad swap file entry ";
41 static const char Unused_file
[] = "Unused swap file entry ";
42 static const char Bad_offset
[] = "Bad swap offset entry ";
43 static const char Unused_offset
[] = "Unused swap offset entry ";
45 struct swap_list_t swap_list
= {-1, -1};
47 static struct swap_info_struct swap_info
[MAX_SWAPFILES
];
49 static DEFINE_MUTEX(swapon_mutex
);
52 * We need this because the bdev->unplug_fn can sleep and we cannot
53 * hold swap_lock while calling the unplug_fn. And swap_lock
54 * cannot be turned into a mutex.
56 static DECLARE_RWSEM(swap_unplug_sem
);
58 void swap_unplug_io_fn(struct backing_dev_info
*unused_bdi
, struct page
*page
)
62 down_read(&swap_unplug_sem
);
63 entry
.val
= page_private(page
);
64 if (PageSwapCache(page
)) {
65 struct block_device
*bdev
= swap_info
[swp_type(entry
)].bdev
;
66 struct backing_dev_info
*bdi
;
69 * If the page is removed from swapcache from under us (with a
70 * racy try_to_unuse/swapoff) we need an additional reference
71 * count to avoid reading garbage from page_private(page) above.
72 * If the WARN_ON triggers during a swapoff it maybe the race
73 * condition and it's harmless. However if it triggers without
74 * swapoff it signals a problem.
76 WARN_ON(page_count(page
) <= 1);
78 bdi
= bdev
->bd_inode
->i_mapping
->backing_dev_info
;
79 blk_run_backing_dev(bdi
, page
);
81 up_read(&swap_unplug_sem
);
84 #define SWAPFILE_CLUSTER 256
85 #define LATENCY_LIMIT 256
87 static inline unsigned long scan_swap_map(struct swap_info_struct
*si
)
89 unsigned long offset
, last_in_cluster
;
90 int latency_ration
= LATENCY_LIMIT
;
93 * We try to cluster swap pages by allocating them sequentially
94 * in swap. Once we've allocated SWAPFILE_CLUSTER pages this
95 * way, however, we resort to first-free allocation, starting
96 * a new cluster. This prevents us from scattering swap pages
97 * all over the entire swap partition, so that we reduce
98 * overall disk seek times between swap pages. -- sct
99 * But we do now try to find an empty cluster. -Andrea
102 si
->flags
+= SWP_SCANNING
;
103 if (unlikely(!si
->cluster_nr
)) {
104 si
->cluster_nr
= SWAPFILE_CLUSTER
- 1;
105 if (si
->pages
- si
->inuse_pages
< SWAPFILE_CLUSTER
)
107 spin_unlock(&swap_lock
);
109 offset
= si
->lowest_bit
;
110 last_in_cluster
= offset
+ SWAPFILE_CLUSTER
- 1;
112 /* Locate the first empty (unaligned) cluster */
113 for (; last_in_cluster
<= si
->highest_bit
; offset
++) {
114 if (si
->swap_map
[offset
])
115 last_in_cluster
= offset
+ SWAPFILE_CLUSTER
;
116 else if (offset
== last_in_cluster
) {
117 spin_lock(&swap_lock
);
118 si
->cluster_next
= offset
-SWAPFILE_CLUSTER
+1;
121 if (unlikely(--latency_ration
< 0)) {
123 latency_ration
= LATENCY_LIMIT
;
126 spin_lock(&swap_lock
);
132 offset
= si
->cluster_next
;
133 if (offset
> si
->highest_bit
)
134 lowest
: offset
= si
->lowest_bit
;
135 checks
: if (!(si
->flags
& SWP_WRITEOK
))
137 if (!si
->highest_bit
)
139 if (!si
->swap_map
[offset
]) {
140 if (offset
== si
->lowest_bit
)
142 if (offset
== si
->highest_bit
)
145 if (si
->inuse_pages
== si
->pages
) {
146 si
->lowest_bit
= si
->max
;
149 si
->swap_map
[offset
] = 1;
150 si
->cluster_next
= offset
+ 1;
151 si
->flags
-= SWP_SCANNING
;
155 spin_unlock(&swap_lock
);
156 while (++offset
<= si
->highest_bit
) {
157 if (!si
->swap_map
[offset
]) {
158 spin_lock(&swap_lock
);
161 if (unlikely(--latency_ration
< 0)) {
163 latency_ration
= LATENCY_LIMIT
;
166 spin_lock(&swap_lock
);
170 si
->flags
-= SWP_SCANNING
;
174 swp_entry_t
get_swap_page(void)
176 struct swap_info_struct
*si
;
181 spin_lock(&swap_lock
);
182 if (nr_swap_pages
<= 0)
186 for (type
= swap_list
.next
; type
>= 0 && wrapped
< 2; type
= next
) {
187 si
= swap_info
+ type
;
190 (!wrapped
&& si
->prio
!= swap_info
[next
].prio
)) {
191 next
= swap_list
.head
;
195 if (!si
->highest_bit
)
197 if (!(si
->flags
& SWP_WRITEOK
))
200 swap_list
.next
= next
;
201 offset
= scan_swap_map(si
);
203 spin_unlock(&swap_lock
);
204 return swp_entry(type
, offset
);
206 next
= swap_list
.next
;
211 spin_unlock(&swap_lock
);
212 return (swp_entry_t
) {0};
215 swp_entry_t
get_swap_page_of_type(int type
)
217 struct swap_info_struct
*si
;
220 spin_lock(&swap_lock
);
221 si
= swap_info
+ type
;
222 if (si
->flags
& SWP_WRITEOK
) {
224 offset
= scan_swap_map(si
);
226 spin_unlock(&swap_lock
);
227 return swp_entry(type
, offset
);
231 spin_unlock(&swap_lock
);
232 return (swp_entry_t
) {0};
235 static struct swap_info_struct
* swap_info_get(swp_entry_t entry
)
237 struct swap_info_struct
* p
;
238 unsigned long offset
, type
;
242 type
= swp_type(entry
);
243 if (type
>= nr_swapfiles
)
245 p
= & swap_info
[type
];
246 if (!(p
->flags
& SWP_USED
))
248 offset
= swp_offset(entry
);
249 if (offset
>= p
->max
)
251 if (!p
->swap_map
[offset
])
253 spin_lock(&swap_lock
);
257 printk(KERN_ERR
"swap_free: %s%08lx\n", Unused_offset
, entry
.val
);
260 printk(KERN_ERR
"swap_free: %s%08lx\n", Bad_offset
, entry
.val
);
263 printk(KERN_ERR
"swap_free: %s%08lx\n", Unused_file
, entry
.val
);
266 printk(KERN_ERR
"swap_free: %s%08lx\n", Bad_file
, entry
.val
);
271 static int swap_entry_free(struct swap_info_struct
*p
, unsigned long offset
)
273 int count
= p
->swap_map
[offset
];
275 if (count
< SWAP_MAP_MAX
) {
277 p
->swap_map
[offset
] = count
;
279 if (offset
< p
->lowest_bit
)
280 p
->lowest_bit
= offset
;
281 if (offset
> p
->highest_bit
)
282 p
->highest_bit
= offset
;
283 if (p
->prio
> swap_info
[swap_list
.next
].prio
)
284 swap_list
.next
= p
- swap_info
;
293 * Caller has made sure that the swapdevice corresponding to entry
294 * is still around or has not been recycled.
296 void swap_free(swp_entry_t entry
)
298 struct swap_info_struct
* p
;
300 p
= swap_info_get(entry
);
302 swap_entry_free(p
, swp_offset(entry
));
303 spin_unlock(&swap_lock
);
308 * How many references to page are currently swapped out?
310 static inline int page_swapcount(struct page
*page
)
313 struct swap_info_struct
*p
;
316 entry
.val
= page_private(page
);
317 p
= swap_info_get(entry
);
319 /* Subtract the 1 for the swap cache itself */
320 count
= p
->swap_map
[swp_offset(entry
)] - 1;
321 spin_unlock(&swap_lock
);
327 * We can use this swap cache entry directly
328 * if there are no other references to it.
330 int can_share_swap_page(struct page
*page
)
334 BUG_ON(!PageLocked(page
));
335 count
= page_mapcount(page
);
336 if (count
<= 1 && PageSwapCache(page
))
337 count
+= page_swapcount(page
);
342 * Work out if there are any other processes sharing this
343 * swap cache page. Free it if you can. Return success.
345 int remove_exclusive_swap_page(struct page
*page
)
348 struct swap_info_struct
* p
;
351 BUG_ON(PagePrivate(page
));
352 BUG_ON(!PageLocked(page
));
354 if (!PageSwapCache(page
))
356 if (PageWriteback(page
))
358 if (page_count(page
) != 2) /* 2: us + cache */
361 entry
.val
= page_private(page
);
362 p
= swap_info_get(entry
);
366 /* Is the only swap cache user the cache itself? */
368 if (p
->swap_map
[swp_offset(entry
)] == 1) {
369 /* Recheck the page count with the swapcache lock held.. */
370 write_lock_irq(&swapper_space
.tree_lock
);
371 if ((page_count(page
) == 2) && !PageWriteback(page
)) {
372 __delete_from_swap_cache(page
);
376 write_unlock_irq(&swapper_space
.tree_lock
);
378 spin_unlock(&swap_lock
);
382 page_cache_release(page
);
389 * Free the swap entry like above, but also try to
390 * free the page cache entry if it is the last user.
392 void free_swap_and_cache(swp_entry_t entry
)
394 struct swap_info_struct
* p
;
395 struct page
*page
= NULL
;
397 if (is_migration_entry(entry
))
400 p
= swap_info_get(entry
);
402 if (swap_entry_free(p
, swp_offset(entry
)) == 1) {
403 page
= find_get_page(&swapper_space
, entry
.val
);
404 if (page
&& unlikely(TestSetPageLocked(page
))) {
405 page_cache_release(page
);
409 spin_unlock(&swap_lock
);
414 BUG_ON(PagePrivate(page
));
415 one_user
= (page_count(page
) == 2);
416 /* Only cache user (+us), or swap space full? Free it! */
417 /* Also recheck PageSwapCache after page is locked (above) */
418 if (PageSwapCache(page
) && !PageWriteback(page
) &&
419 (one_user
|| vm_swap_full())) {
420 delete_from_swap_cache(page
);
424 page_cache_release(page
);
428 #ifdef CONFIG_SOFTWARE_SUSPEND
430 * Find the swap type that corresponds to given device (if any).
432 * @offset - number of the PAGE_SIZE-sized block of the device, starting
433 * from 0, in which the swap header is expected to be located.
435 * This is needed for the suspend to disk (aka swsusp).
437 int swap_type_of(dev_t device
, sector_t offset
, struct block_device
**bdev_p
)
439 struct block_device
*bdev
= NULL
;
443 bdev
= bdget(device
);
445 spin_lock(&swap_lock
);
446 for (i
= 0; i
< nr_swapfiles
; i
++) {
447 struct swap_info_struct
*sis
= swap_info
+ i
;
449 if (!(sis
->flags
& SWP_WRITEOK
))
456 spin_unlock(&swap_lock
);
459 if (bdev
== sis
->bdev
) {
460 struct swap_extent
*se
;
462 se
= list_entry(sis
->extent_list
.next
,
463 struct swap_extent
, list
);
464 if (se
->start_block
== offset
) {
468 spin_unlock(&swap_lock
);
474 spin_unlock(&swap_lock
);
482 * Return either the total number of swap pages of given type, or the number
483 * of free pages of that type (depending on @free)
485 * This is needed for software suspend
487 unsigned int count_swap_pages(int type
, int free
)
491 if (type
< nr_swapfiles
) {
492 spin_lock(&swap_lock
);
493 if (swap_info
[type
].flags
& SWP_WRITEOK
) {
494 n
= swap_info
[type
].pages
;
496 n
-= swap_info
[type
].inuse_pages
;
498 spin_unlock(&swap_lock
);
505 * No need to decide whether this PTE shares the swap entry with others,
506 * just let do_wp_page work it out if a write is requested later - to
507 * force COW, vm_page_prot omits write permission from any private vma.
509 static void unuse_pte(struct vm_area_struct
*vma
, pte_t
*pte
,
510 unsigned long addr
, swp_entry_t entry
, struct page
*page
)
512 inc_mm_counter(vma
->vm_mm
, anon_rss
);
514 set_pte_at(vma
->vm_mm
, addr
, pte
,
515 pte_mkold(mk_pte(page
, vma
->vm_page_prot
)));
516 page_add_anon_rmap(page
, vma
, addr
);
519 * Move the page to the active list so it is not
520 * immediately swapped out again after swapon.
525 static int unuse_pte_range(struct vm_area_struct
*vma
, pmd_t
*pmd
,
526 unsigned long addr
, unsigned long end
,
527 swp_entry_t entry
, struct page
*page
)
529 pte_t swp_pte
= swp_entry_to_pte(entry
);
534 pte
= pte_offset_map_lock(vma
->vm_mm
, pmd
, addr
, &ptl
);
537 * swapoff spends a _lot_ of time in this loop!
538 * Test inline before going to call unuse_pte.
540 if (unlikely(pte_same(*pte
, swp_pte
))) {
541 unuse_pte(vma
, pte
++, addr
, entry
, page
);
545 } while (pte
++, addr
+= PAGE_SIZE
, addr
!= end
);
546 pte_unmap_unlock(pte
- 1, ptl
);
550 static inline int unuse_pmd_range(struct vm_area_struct
*vma
, pud_t
*pud
,
551 unsigned long addr
, unsigned long end
,
552 swp_entry_t entry
, struct page
*page
)
557 pmd
= pmd_offset(pud
, addr
);
559 next
= pmd_addr_end(addr
, end
);
560 if (pmd_none_or_clear_bad(pmd
))
562 if (unuse_pte_range(vma
, pmd
, addr
, next
, entry
, page
))
564 } while (pmd
++, addr
= next
, addr
!= end
);
568 static inline int unuse_pud_range(struct vm_area_struct
*vma
, pgd_t
*pgd
,
569 unsigned long addr
, unsigned long end
,
570 swp_entry_t entry
, struct page
*page
)
575 pud
= pud_offset(pgd
, addr
);
577 next
= pud_addr_end(addr
, end
);
578 if (pud_none_or_clear_bad(pud
))
580 if (unuse_pmd_range(vma
, pud
, addr
, next
, entry
, page
))
582 } while (pud
++, addr
= next
, addr
!= end
);
586 static int unuse_vma(struct vm_area_struct
*vma
,
587 swp_entry_t entry
, struct page
*page
)
590 unsigned long addr
, end
, next
;
593 addr
= page_address_in_vma(page
, vma
);
597 end
= addr
+ PAGE_SIZE
;
599 addr
= vma
->vm_start
;
603 pgd
= pgd_offset(vma
->vm_mm
, addr
);
605 next
= pgd_addr_end(addr
, end
);
606 if (pgd_none_or_clear_bad(pgd
))
608 if (unuse_pud_range(vma
, pgd
, addr
, next
, entry
, page
))
610 } while (pgd
++, addr
= next
, addr
!= end
);
614 static int unuse_mm(struct mm_struct
*mm
,
615 swp_entry_t entry
, struct page
*page
)
617 struct vm_area_struct
*vma
;
619 if (!down_read_trylock(&mm
->mmap_sem
)) {
621 * Activate page so shrink_cache is unlikely to unmap its
622 * ptes while lock is dropped, so swapoff can make progress.
626 down_read(&mm
->mmap_sem
);
629 for (vma
= mm
->mmap
; vma
; vma
= vma
->vm_next
) {
630 if (vma
->anon_vma
&& unuse_vma(vma
, entry
, page
))
633 up_read(&mm
->mmap_sem
);
635 * Currently unuse_mm cannot fail, but leave error handling
636 * at call sites for now, since we change it from time to time.
642 * Scan swap_map from current position to next entry still in use.
643 * Recycle to start on reaching the end, returning 0 when empty.
645 static unsigned int find_next_to_unuse(struct swap_info_struct
*si
,
648 unsigned int max
= si
->max
;
649 unsigned int i
= prev
;
653 * No need for swap_lock here: we're just looking
654 * for whether an entry is in use, not modifying it; false
655 * hits are okay, and sys_swapoff() has already prevented new
656 * allocations from this area (while holding swap_lock).
665 * No entries in use at top of swap_map,
666 * loop back to start and recheck there.
672 count
= si
->swap_map
[i
];
673 if (count
&& count
!= SWAP_MAP_BAD
)
680 * We completely avoid races by reading each swap page in advance,
681 * and then search for the process using it. All the necessary
682 * page table adjustments can then be made atomically.
684 static int try_to_unuse(unsigned int type
)
686 struct swap_info_struct
* si
= &swap_info
[type
];
687 struct mm_struct
*start_mm
;
688 unsigned short *swap_map
;
689 unsigned short swcount
;
694 int reset_overflow
= 0;
698 * When searching mms for an entry, a good strategy is to
699 * start at the first mm we freed the previous entry from
700 * (though actually we don't notice whether we or coincidence
701 * freed the entry). Initialize this start_mm with a hold.
703 * A simpler strategy would be to start at the last mm we
704 * freed the previous entry from; but that would take less
705 * advantage of mmlist ordering, which clusters forked mms
706 * together, child after parent. If we race with dup_mmap(), we
707 * prefer to resolve parent before child, lest we miss entries
708 * duplicated after we scanned child: using last mm would invert
709 * that. Though it's only a serious concern when an overflowed
710 * swap count is reset from SWAP_MAP_MAX, preventing a rescan.
713 atomic_inc(&init_mm
.mm_users
);
716 * Keep on scanning until all entries have gone. Usually,
717 * one pass through swap_map is enough, but not necessarily:
718 * there are races when an instance of an entry might be missed.
720 while ((i
= find_next_to_unuse(si
, i
)) != 0) {
721 if (signal_pending(current
)) {
727 * Get a page for the entry, using the existing swap
728 * cache page if there is one. Otherwise, get a clean
729 * page and read the swap into it.
731 swap_map
= &si
->swap_map
[i
];
732 entry
= swp_entry(type
, i
);
733 page
= read_swap_cache_async(entry
, NULL
, 0);
736 * Either swap_duplicate() failed because entry
737 * has been freed independently, and will not be
738 * reused since sys_swapoff() already disabled
739 * allocation from here, or alloc_page() failed.
748 * Don't hold on to start_mm if it looks like exiting.
750 if (atomic_read(&start_mm
->mm_users
) == 1) {
753 atomic_inc(&init_mm
.mm_users
);
757 * Wait for and lock page. When do_swap_page races with
758 * try_to_unuse, do_swap_page can handle the fault much
759 * faster than try_to_unuse can locate the entry. This
760 * apparently redundant "wait_on_page_locked" lets try_to_unuse
761 * defer to do_swap_page in such a case - in some tests,
762 * do_swap_page and try_to_unuse repeatedly compete.
764 wait_on_page_locked(page
);
765 wait_on_page_writeback(page
);
767 wait_on_page_writeback(page
);
770 * Remove all references to entry.
771 * Whenever we reach init_mm, there's no address space
772 * to search, but use it as a reminder to search shmem.
777 if (start_mm
== &init_mm
)
778 shmem
= shmem_unuse(entry
, page
);
780 retval
= unuse_mm(start_mm
, entry
, page
);
783 int set_start_mm
= (*swap_map
>= swcount
);
784 struct list_head
*p
= &start_mm
->mmlist
;
785 struct mm_struct
*new_start_mm
= start_mm
;
786 struct mm_struct
*prev_mm
= start_mm
;
787 struct mm_struct
*mm
;
789 atomic_inc(&new_start_mm
->mm_users
);
790 atomic_inc(&prev_mm
->mm_users
);
791 spin_lock(&mmlist_lock
);
792 while (*swap_map
> 1 && !retval
&&
793 (p
= p
->next
) != &start_mm
->mmlist
) {
794 mm
= list_entry(p
, struct mm_struct
, mmlist
);
795 if (!atomic_inc_not_zero(&mm
->mm_users
))
797 spin_unlock(&mmlist_lock
);
806 else if (mm
== &init_mm
) {
808 shmem
= shmem_unuse(entry
, page
);
810 retval
= unuse_mm(mm
, entry
, page
);
811 if (set_start_mm
&& *swap_map
< swcount
) {
813 atomic_inc(&mm
->mm_users
);
817 spin_lock(&mmlist_lock
);
819 spin_unlock(&mmlist_lock
);
822 start_mm
= new_start_mm
;
826 page_cache_release(page
);
831 * How could swap count reach 0x7fff when the maximum
832 * pid is 0x7fff, and there's no way to repeat a swap
833 * page within an mm (except in shmem, where it's the
834 * shared object which takes the reference count)?
835 * We believe SWAP_MAP_MAX cannot occur in Linux 2.4.
837 * If that's wrong, then we should worry more about
838 * exit_mmap() and do_munmap() cases described above:
839 * we might be resetting SWAP_MAP_MAX too early here.
840 * We know "Undead"s can happen, they're okay, so don't
841 * report them; but do report if we reset SWAP_MAP_MAX.
843 if (*swap_map
== SWAP_MAP_MAX
) {
844 spin_lock(&swap_lock
);
846 spin_unlock(&swap_lock
);
851 * If a reference remains (rare), we would like to leave
852 * the page in the swap cache; but try_to_unmap could
853 * then re-duplicate the entry once we drop page lock,
854 * so we might loop indefinitely; also, that page could
855 * not be swapped out to other storage meanwhile. So:
856 * delete from cache even if there's another reference,
857 * after ensuring that the data has been saved to disk -
858 * since if the reference remains (rarer), it will be
859 * read from disk into another page. Splitting into two
860 * pages would be incorrect if swap supported "shared
861 * private" pages, but they are handled by tmpfs files.
863 * Note shmem_unuse already deleted a swappage from
864 * the swap cache, unless the move to filepage failed:
865 * in which case it left swappage in cache, lowered its
866 * swap count to pass quickly through the loops above,
867 * and now we must reincrement count to try again later.
869 if ((*swap_map
> 1) && PageDirty(page
) && PageSwapCache(page
)) {
870 struct writeback_control wbc
= {
871 .sync_mode
= WB_SYNC_NONE
,
874 swap_writepage(page
, &wbc
);
876 wait_on_page_writeback(page
);
878 if (PageSwapCache(page
)) {
880 swap_duplicate(entry
);
882 delete_from_swap_cache(page
);
886 * So we could skip searching mms once swap count went
887 * to 1, we did not mark any present ptes as dirty: must
888 * mark page dirty so shrink_list will preserve it.
892 page_cache_release(page
);
895 * Make sure that we aren't completely killing
896 * interactive performance.
902 if (reset_overflow
) {
903 printk(KERN_WARNING
"swapoff: cleared swap entry overflow\n");
910 * After a successful try_to_unuse, if no swap is now in use, we know
911 * we can empty the mmlist. swap_lock must be held on entry and exit.
912 * Note that mmlist_lock nests inside swap_lock, and an mm must be
913 * added to the mmlist just after page_duplicate - before would be racy.
915 static void drain_mmlist(void)
917 struct list_head
*p
, *next
;
920 for (i
= 0; i
< nr_swapfiles
; i
++)
921 if (swap_info
[i
].inuse_pages
)
923 spin_lock(&mmlist_lock
);
924 list_for_each_safe(p
, next
, &init_mm
.mmlist
)
926 spin_unlock(&mmlist_lock
);
930 * Use this swapdev's extent info to locate the (PAGE_SIZE) block which
931 * corresponds to page offset `offset'.
933 sector_t
map_swap_page(struct swap_info_struct
*sis
, pgoff_t offset
)
935 struct swap_extent
*se
= sis
->curr_swap_extent
;
936 struct swap_extent
*start_se
= se
;
939 struct list_head
*lh
;
941 if (se
->start_page
<= offset
&&
942 offset
< (se
->start_page
+ se
->nr_pages
)) {
943 return se
->start_block
+ (offset
- se
->start_page
);
946 if (lh
== &sis
->extent_list
)
948 se
= list_entry(lh
, struct swap_extent
, list
);
949 sis
->curr_swap_extent
= se
;
950 BUG_ON(se
== start_se
); /* It *must* be present */
954 #ifdef CONFIG_SOFTWARE_SUSPEND
956 * Get the (PAGE_SIZE) block corresponding to given offset on the swapdev
957 * corresponding to given index in swap_info (swap type).
959 sector_t
swapdev_block(int swap_type
, pgoff_t offset
)
961 struct swap_info_struct
*sis
;
963 if (swap_type
>= nr_swapfiles
)
966 sis
= swap_info
+ swap_type
;
967 return (sis
->flags
& SWP_WRITEOK
) ? map_swap_page(sis
, offset
) : 0;
969 #endif /* CONFIG_SOFTWARE_SUSPEND */
972 * Free all of a swapdev's extent information
974 static void destroy_swap_extents(struct swap_info_struct
*sis
)
976 while (!list_empty(&sis
->extent_list
)) {
977 struct swap_extent
*se
;
979 se
= list_entry(sis
->extent_list
.next
,
980 struct swap_extent
, list
);
987 * Add a block range (and the corresponding page range) into this swapdev's
988 * extent list. The extent list is kept sorted in page order.
990 * This function rather assumes that it is called in ascending page order.
993 add_swap_extent(struct swap_info_struct
*sis
, unsigned long start_page
,
994 unsigned long nr_pages
, sector_t start_block
)
996 struct swap_extent
*se
;
997 struct swap_extent
*new_se
;
998 struct list_head
*lh
;
1000 lh
= sis
->extent_list
.prev
; /* The highest page extent */
1001 if (lh
!= &sis
->extent_list
) {
1002 se
= list_entry(lh
, struct swap_extent
, list
);
1003 BUG_ON(se
->start_page
+ se
->nr_pages
!= start_page
);
1004 if (se
->start_block
+ se
->nr_pages
== start_block
) {
1006 se
->nr_pages
+= nr_pages
;
1012 * No merge. Insert a new extent, preserving ordering.
1014 new_se
= kmalloc(sizeof(*se
), GFP_KERNEL
);
1017 new_se
->start_page
= start_page
;
1018 new_se
->nr_pages
= nr_pages
;
1019 new_se
->start_block
= start_block
;
1021 list_add_tail(&new_se
->list
, &sis
->extent_list
);
1026 * A `swap extent' is a simple thing which maps a contiguous range of pages
1027 * onto a contiguous range of disk blocks. An ordered list of swap extents
1028 * is built at swapon time and is then used at swap_writepage/swap_readpage
1029 * time for locating where on disk a page belongs.
1031 * If the swapfile is an S_ISBLK block device, a single extent is installed.
1032 * This is done so that the main operating code can treat S_ISBLK and S_ISREG
1033 * swap files identically.
1035 * Whether the swapdev is an S_ISREG file or an S_ISBLK blockdev, the swap
1036 * extent list operates in PAGE_SIZE disk blocks. Both S_ISREG and S_ISBLK
1037 * swapfiles are handled *identically* after swapon time.
1039 * For S_ISREG swapfiles, setup_swap_extents() will walk all the file's blocks
1040 * and will parse them into an ordered extent list, in PAGE_SIZE chunks. If
1041 * some stray blocks are found which do not fall within the PAGE_SIZE alignment
1042 * requirements, they are simply tossed out - we will never use those blocks
1045 * For S_ISREG swapfiles we set S_SWAPFILE across the life of the swapon. This
1046 * prevents root from shooting her foot off by ftruncating an in-use swapfile,
1047 * which will scribble on the fs.
1049 * The amount of disk space which a single swap extent represents varies.
1050 * Typically it is in the 1-4 megabyte range. So we can have hundreds of
1051 * extents in the list. To avoid much list walking, we cache the previous
1052 * search location in `curr_swap_extent', and start new searches from there.
1053 * This is extremely effective. The average number of iterations in
1054 * map_swap_page() has been measured at about 0.3 per page. - akpm.
1056 static int setup_swap_extents(struct swap_info_struct
*sis
, sector_t
*span
)
1058 struct inode
*inode
;
1059 unsigned blocks_per_page
;
1060 unsigned long page_no
;
1062 sector_t probe_block
;
1063 sector_t last_block
;
1064 sector_t lowest_block
= -1;
1065 sector_t highest_block
= 0;
1069 inode
= sis
->swap_file
->f_mapping
->host
;
1070 if (S_ISBLK(inode
->i_mode
)) {
1071 ret
= add_swap_extent(sis
, 0, sis
->max
, 0);
1076 blkbits
= inode
->i_blkbits
;
1077 blocks_per_page
= PAGE_SIZE
>> blkbits
;
1080 * Map all the blocks into the extent list. This code doesn't try
1085 last_block
= i_size_read(inode
) >> blkbits
;
1086 while ((probe_block
+ blocks_per_page
) <= last_block
&&
1087 page_no
< sis
->max
) {
1088 unsigned block_in_page
;
1089 sector_t first_block
;
1091 first_block
= bmap(inode
, probe_block
);
1092 if (first_block
== 0)
1096 * It must be PAGE_SIZE aligned on-disk
1098 if (first_block
& (blocks_per_page
- 1)) {
1103 for (block_in_page
= 1; block_in_page
< blocks_per_page
;
1107 block
= bmap(inode
, probe_block
+ block_in_page
);
1110 if (block
!= first_block
+ block_in_page
) {
1117 first_block
>>= (PAGE_SHIFT
- blkbits
);
1118 if (page_no
) { /* exclude the header page */
1119 if (first_block
< lowest_block
)
1120 lowest_block
= first_block
;
1121 if (first_block
> highest_block
)
1122 highest_block
= first_block
;
1126 * We found a PAGE_SIZE-length, PAGE_SIZE-aligned run of blocks
1128 ret
= add_swap_extent(sis
, page_no
, 1, first_block
);
1133 probe_block
+= blocks_per_page
;
1138 *span
= 1 + highest_block
- lowest_block
;
1140 page_no
= 1; /* force Empty message */
1142 sis
->pages
= page_no
- 1;
1143 sis
->highest_bit
= page_no
- 1;
1145 sis
->curr_swap_extent
= list_entry(sis
->extent_list
.prev
,
1146 struct swap_extent
, list
);
1149 printk(KERN_ERR
"swapon: swapfile has holes\n");
1155 #if 0 /* We don't need this yet */
1156 #include <linux/backing-dev.h>
1157 int page_queue_congested(struct page
*page
)
1159 struct backing_dev_info
*bdi
;
1161 BUG_ON(!PageLocked(page
)); /* It pins the swap_info_struct */
1163 if (PageSwapCache(page
)) {
1164 swp_entry_t entry
= { .val
= page_private(page
) };
1165 struct swap_info_struct
*sis
;
1167 sis
= get_swap_info_struct(swp_type(entry
));
1168 bdi
= sis
->bdev
->bd_inode
->i_mapping
->backing_dev_info
;
1170 bdi
= page
->mapping
->backing_dev_info
;
1171 return bdi_write_congested(bdi
);
1175 asmlinkage
long sys_swapoff(const char __user
* specialfile
)
1177 struct swap_info_struct
* p
= NULL
;
1178 unsigned short *swap_map
;
1179 struct file
*swap_file
, *victim
;
1180 struct address_space
*mapping
;
1181 struct inode
*inode
;
1186 if (!capable(CAP_SYS_ADMIN
))
1189 pathname
= getname(specialfile
);
1190 err
= PTR_ERR(pathname
);
1191 if (IS_ERR(pathname
))
1194 victim
= filp_open(pathname
, O_RDWR
|O_LARGEFILE
, 0);
1196 err
= PTR_ERR(victim
);
1200 mapping
= victim
->f_mapping
;
1202 spin_lock(&swap_lock
);
1203 for (type
= swap_list
.head
; type
>= 0; type
= swap_info
[type
].next
) {
1204 p
= swap_info
+ type
;
1205 if ((p
->flags
& SWP_ACTIVE
) == SWP_ACTIVE
) {
1206 if (p
->swap_file
->f_mapping
== mapping
)
1213 spin_unlock(&swap_lock
);
1216 if (!security_vm_enough_memory(p
->pages
))
1217 vm_unacct_memory(p
->pages
);
1220 spin_unlock(&swap_lock
);
1224 swap_list
.head
= p
->next
;
1226 swap_info
[prev
].next
= p
->next
;
1228 if (type
== swap_list
.next
) {
1229 /* just pick something that's safe... */
1230 swap_list
.next
= swap_list
.head
;
1232 nr_swap_pages
-= p
->pages
;
1233 total_swap_pages
-= p
->pages
;
1234 p
->flags
&= ~SWP_WRITEOK
;
1235 spin_unlock(&swap_lock
);
1237 current
->flags
|= PF_SWAPOFF
;
1238 err
= try_to_unuse(type
);
1239 current
->flags
&= ~PF_SWAPOFF
;
1242 /* re-insert swap space back into swap_list */
1243 spin_lock(&swap_lock
);
1244 for (prev
= -1, i
= swap_list
.head
; i
>= 0; prev
= i
, i
= swap_info
[i
].next
)
1245 if (p
->prio
>= swap_info
[i
].prio
)
1249 swap_list
.head
= swap_list
.next
= p
- swap_info
;
1251 swap_info
[prev
].next
= p
- swap_info
;
1252 nr_swap_pages
+= p
->pages
;
1253 total_swap_pages
+= p
->pages
;
1254 p
->flags
|= SWP_WRITEOK
;
1255 spin_unlock(&swap_lock
);
1259 /* wait for any unplug function to finish */
1260 down_write(&swap_unplug_sem
);
1261 up_write(&swap_unplug_sem
);
1263 destroy_swap_extents(p
);
1264 mutex_lock(&swapon_mutex
);
1265 spin_lock(&swap_lock
);
1268 /* wait for anyone still in scan_swap_map */
1269 p
->highest_bit
= 0; /* cuts scans short */
1270 while (p
->flags
>= SWP_SCANNING
) {
1271 spin_unlock(&swap_lock
);
1272 schedule_timeout_uninterruptible(1);
1273 spin_lock(&swap_lock
);
1276 swap_file
= p
->swap_file
;
1277 p
->swap_file
= NULL
;
1279 swap_map
= p
->swap_map
;
1282 spin_unlock(&swap_lock
);
1283 mutex_unlock(&swapon_mutex
);
1285 inode
= mapping
->host
;
1286 if (S_ISBLK(inode
->i_mode
)) {
1287 struct block_device
*bdev
= I_BDEV(inode
);
1288 set_blocksize(bdev
, p
->old_block_size
);
1291 mutex_lock(&inode
->i_mutex
);
1292 inode
->i_flags
&= ~S_SWAPFILE
;
1293 mutex_unlock(&inode
->i_mutex
);
1295 filp_close(swap_file
, NULL
);
1299 filp_close(victim
, NULL
);
1304 #ifdef CONFIG_PROC_FS
1306 static void *swap_start(struct seq_file
*swap
, loff_t
*pos
)
1308 struct swap_info_struct
*ptr
= swap_info
;
1312 mutex_lock(&swapon_mutex
);
1315 return SEQ_START_TOKEN
;
1317 for (i
= 0; i
< nr_swapfiles
; i
++, ptr
++) {
1318 if (!(ptr
->flags
& SWP_USED
) || !ptr
->swap_map
)
1327 static void *swap_next(struct seq_file
*swap
, void *v
, loff_t
*pos
)
1329 struct swap_info_struct
*ptr
;
1330 struct swap_info_struct
*endptr
= swap_info
+ nr_swapfiles
;
1332 if (v
== SEQ_START_TOKEN
)
1339 for (; ptr
< endptr
; ptr
++) {
1340 if (!(ptr
->flags
& SWP_USED
) || !ptr
->swap_map
)
1349 static void swap_stop(struct seq_file
*swap
, void *v
)
1351 mutex_unlock(&swapon_mutex
);
1354 static int swap_show(struct seq_file
*swap
, void *v
)
1356 struct swap_info_struct
*ptr
= v
;
1360 if (ptr
== SEQ_START_TOKEN
) {
1361 seq_puts(swap
,"Filename\t\t\t\tType\t\tSize\tUsed\tPriority\n");
1365 file
= ptr
->swap_file
;
1366 len
= seq_path(swap
, file
->f_path
.mnt
, file
->f_path
.dentry
, " \t\n\\");
1367 seq_printf(swap
, "%*s%s\t%u\t%u\t%d\n",
1368 len
< 40 ? 40 - len
: 1, " ",
1369 S_ISBLK(file
->f_path
.dentry
->d_inode
->i_mode
) ?
1370 "partition" : "file\t",
1371 ptr
->pages
<< (PAGE_SHIFT
- 10),
1372 ptr
->inuse_pages
<< (PAGE_SHIFT
- 10),
1377 static const struct seq_operations swaps_op
= {
1378 .start
= swap_start
,
1384 static int swaps_open(struct inode
*inode
, struct file
*file
)
1386 return seq_open(file
, &swaps_op
);
1389 static const struct file_operations proc_swaps_operations
= {
1392 .llseek
= seq_lseek
,
1393 .release
= seq_release
,
1396 static int __init
procswaps_init(void)
1398 struct proc_dir_entry
*entry
;
1400 entry
= create_proc_entry("swaps", 0, NULL
);
1402 entry
->proc_fops
= &proc_swaps_operations
;
1405 __initcall(procswaps_init
);
1406 #endif /* CONFIG_PROC_FS */
1409 * Written 01/25/92 by Simmule Turner, heavily changed by Linus.
1411 * The swapon system call
1413 asmlinkage
long sys_swapon(const char __user
* specialfile
, int swap_flags
)
1415 struct swap_info_struct
* p
;
1417 struct block_device
*bdev
= NULL
;
1418 struct file
*swap_file
= NULL
;
1419 struct address_space
*mapping
;
1423 static int least_priority
;
1424 union swap_header
*swap_header
= NULL
;
1425 int swap_header_version
;
1426 unsigned int nr_good_pages
= 0;
1429 unsigned long maxpages
= 1;
1431 unsigned short *swap_map
;
1432 struct page
*page
= NULL
;
1433 struct inode
*inode
= NULL
;
1436 if (!capable(CAP_SYS_ADMIN
))
1438 spin_lock(&swap_lock
);
1440 for (type
= 0 ; type
< nr_swapfiles
; type
++,p
++)
1441 if (!(p
->flags
& SWP_USED
))
1444 if (type
>= MAX_SWAPFILES
) {
1445 spin_unlock(&swap_lock
);
1448 if (type
>= nr_swapfiles
)
1449 nr_swapfiles
= type
+1;
1450 INIT_LIST_HEAD(&p
->extent_list
);
1451 p
->flags
= SWP_USED
;
1452 p
->swap_file
= NULL
;
1453 p
->old_block_size
= 0;
1460 if (swap_flags
& SWAP_FLAG_PREFER
) {
1462 (swap_flags
& SWAP_FLAG_PRIO_MASK
)>>SWAP_FLAG_PRIO_SHIFT
;
1464 p
->prio
= --least_priority
;
1466 spin_unlock(&swap_lock
);
1467 name
= getname(specialfile
);
1468 error
= PTR_ERR(name
);
1473 swap_file
= filp_open(name
, O_RDWR
|O_LARGEFILE
, 0);
1474 error
= PTR_ERR(swap_file
);
1475 if (IS_ERR(swap_file
)) {
1480 p
->swap_file
= swap_file
;
1481 mapping
= swap_file
->f_mapping
;
1482 inode
= mapping
->host
;
1485 for (i
= 0; i
< nr_swapfiles
; i
++) {
1486 struct swap_info_struct
*q
= &swap_info
[i
];
1488 if (i
== type
|| !q
->swap_file
)
1490 if (mapping
== q
->swap_file
->f_mapping
)
1495 if (S_ISBLK(inode
->i_mode
)) {
1496 bdev
= I_BDEV(inode
);
1497 error
= bd_claim(bdev
, sys_swapon
);
1503 p
->old_block_size
= block_size(bdev
);
1504 error
= set_blocksize(bdev
, PAGE_SIZE
);
1508 } else if (S_ISREG(inode
->i_mode
)) {
1509 p
->bdev
= inode
->i_sb
->s_bdev
;
1510 mutex_lock(&inode
->i_mutex
);
1512 if (IS_SWAPFILE(inode
)) {
1520 swapfilesize
= i_size_read(inode
) >> PAGE_SHIFT
;
1523 * Read the swap header.
1525 if (!mapping
->a_ops
->readpage
) {
1529 page
= read_mapping_page(mapping
, 0, swap_file
);
1531 error
= PTR_ERR(page
);
1534 wait_on_page_locked(page
);
1535 if (!PageUptodate(page
))
1538 swap_header
= page_address(page
);
1540 if (!memcmp("SWAP-SPACE",swap_header
->magic
.magic
,10))
1541 swap_header_version
= 1;
1542 else if (!memcmp("SWAPSPACE2",swap_header
->magic
.magic
,10))
1543 swap_header_version
= 2;
1545 printk(KERN_ERR
"Unable to find swap-space signature\n");
1550 switch (swap_header_version
) {
1552 printk(KERN_ERR
"version 0 swap is no longer supported. "
1553 "Use mkswap -v1 %s\n", name
);
1557 /* Check the swap header's sub-version and the size of
1558 the swap file and bad block lists */
1559 if (swap_header
->info
.version
!= 1) {
1561 "Unable to handle swap header version %d\n",
1562 swap_header
->info
.version
);
1568 p
->cluster_next
= 1;
1571 * Find out how many pages are allowed for a single swap
1572 * device. There are two limiting factors: 1) the number of
1573 * bits for the swap offset in the swp_entry_t type and
1574 * 2) the number of bits in the a swap pte as defined by
1575 * the different architectures. In order to find the
1576 * largest possible bit mask a swap entry with swap type 0
1577 * and swap offset ~0UL is created, encoded to a swap pte,
1578 * decoded to a swp_entry_t again and finally the swap
1579 * offset is extracted. This will mask all the bits from
1580 * the initial ~0UL mask that can't be encoded in either
1581 * the swp_entry_t or the architecture definition of a
1584 maxpages
= swp_offset(pte_to_swp_entry(swp_entry_to_pte(swp_entry(0,~0UL)))) - 1;
1585 if (maxpages
> swap_header
->info
.last_page
)
1586 maxpages
= swap_header
->info
.last_page
;
1587 p
->highest_bit
= maxpages
- 1;
1592 if (swapfilesize
&& maxpages
> swapfilesize
) {
1594 "Swap area shorter than signature indicates\n");
1597 if (swap_header
->info
.nr_badpages
&& S_ISREG(inode
->i_mode
))
1599 if (swap_header
->info
.nr_badpages
> MAX_SWAP_BADPAGES
)
1602 /* OK, set up the swap map and apply the bad block list */
1603 if (!(p
->swap_map
= vmalloc(maxpages
* sizeof(short)))) {
1609 memset(p
->swap_map
, 0, maxpages
* sizeof(short));
1610 for (i
= 0; i
< swap_header
->info
.nr_badpages
; i
++) {
1611 int page_nr
= swap_header
->info
.badpages
[i
];
1612 if (page_nr
<= 0 || page_nr
>= swap_header
->info
.last_page
)
1615 p
->swap_map
[page_nr
] = SWAP_MAP_BAD
;
1617 nr_good_pages
= swap_header
->info
.last_page
-
1618 swap_header
->info
.nr_badpages
-
1619 1 /* header page */;
1624 if (nr_good_pages
) {
1625 p
->swap_map
[0] = SWAP_MAP_BAD
;
1627 p
->pages
= nr_good_pages
;
1628 nr_extents
= setup_swap_extents(p
, &span
);
1629 if (nr_extents
< 0) {
1633 nr_good_pages
= p
->pages
;
1635 if (!nr_good_pages
) {
1636 printk(KERN_WARNING
"Empty swap-file\n");
1641 mutex_lock(&swapon_mutex
);
1642 spin_lock(&swap_lock
);
1643 p
->flags
= SWP_ACTIVE
;
1644 nr_swap_pages
+= nr_good_pages
;
1645 total_swap_pages
+= nr_good_pages
;
1647 printk(KERN_INFO
"Adding %uk swap on %s. "
1648 "Priority:%d extents:%d across:%lluk\n",
1649 nr_good_pages
<<(PAGE_SHIFT
-10), name
, p
->prio
,
1650 nr_extents
, (unsigned long long)span
<<(PAGE_SHIFT
-10));
1652 /* insert swap space into swap_list: */
1654 for (i
= swap_list
.head
; i
>= 0; i
= swap_info
[i
].next
) {
1655 if (p
->prio
>= swap_info
[i
].prio
) {
1662 swap_list
.head
= swap_list
.next
= p
- swap_info
;
1664 swap_info
[prev
].next
= p
- swap_info
;
1666 spin_unlock(&swap_lock
);
1667 mutex_unlock(&swapon_mutex
);
1672 set_blocksize(bdev
, p
->old_block_size
);
1675 destroy_swap_extents(p
);
1677 spin_lock(&swap_lock
);
1678 swap_map
= p
->swap_map
;
1679 p
->swap_file
= NULL
;
1682 if (!(swap_flags
& SWAP_FLAG_PREFER
))
1684 spin_unlock(&swap_lock
);
1687 filp_close(swap_file
, NULL
);
1689 if (page
&& !IS_ERR(page
)) {
1691 page_cache_release(page
);
1697 inode
->i_flags
|= S_SWAPFILE
;
1698 mutex_unlock(&inode
->i_mutex
);
1703 void si_swapinfo(struct sysinfo
*val
)
1706 unsigned long nr_to_be_unused
= 0;
1708 spin_lock(&swap_lock
);
1709 for (i
= 0; i
< nr_swapfiles
; i
++) {
1710 if (!(swap_info
[i
].flags
& SWP_USED
) ||
1711 (swap_info
[i
].flags
& SWP_WRITEOK
))
1713 nr_to_be_unused
+= swap_info
[i
].inuse_pages
;
1715 val
->freeswap
= nr_swap_pages
+ nr_to_be_unused
;
1716 val
->totalswap
= total_swap_pages
+ nr_to_be_unused
;
1717 spin_unlock(&swap_lock
);
1721 * Verify that a swap entry is valid and increment its swap map count.
1723 * Note: if swap_map[] reaches SWAP_MAP_MAX the entries are treated as
1724 * "permanent", but will be reclaimed by the next swapoff.
1726 int swap_duplicate(swp_entry_t entry
)
1728 struct swap_info_struct
* p
;
1729 unsigned long offset
, type
;
1732 if (is_migration_entry(entry
))
1735 type
= swp_type(entry
);
1736 if (type
>= nr_swapfiles
)
1738 p
= type
+ swap_info
;
1739 offset
= swp_offset(entry
);
1741 spin_lock(&swap_lock
);
1742 if (offset
< p
->max
&& p
->swap_map
[offset
]) {
1743 if (p
->swap_map
[offset
] < SWAP_MAP_MAX
- 1) {
1744 p
->swap_map
[offset
]++;
1746 } else if (p
->swap_map
[offset
] <= SWAP_MAP_MAX
) {
1747 if (swap_overflow
++ < 5)
1748 printk(KERN_WARNING
"swap_dup: swap entry overflow\n");
1749 p
->swap_map
[offset
] = SWAP_MAP_MAX
;
1753 spin_unlock(&swap_lock
);
1758 printk(KERN_ERR
"swap_dup: %s%08lx\n", Bad_file
, entry
.val
);
1762 struct swap_info_struct
*
1763 get_swap_info_struct(unsigned type
)
1765 return &swap_info
[type
];
1769 * swap_lock prevents swap_map being freed. Don't grab an extra
1770 * reference on the swaphandle, it doesn't matter if it becomes unused.
1772 int valid_swaphandles(swp_entry_t entry
, unsigned long *offset
)
1774 int our_page_cluster
= page_cluster
;
1775 int ret
= 0, i
= 1 << our_page_cluster
;
1777 struct swap_info_struct
*swapdev
= swp_type(entry
) + swap_info
;
1779 if (!our_page_cluster
) /* no readahead */
1781 toff
= (swp_offset(entry
) >> our_page_cluster
) << our_page_cluster
;
1782 if (!toff
) /* first page is swap header */
1786 spin_lock(&swap_lock
);
1788 /* Don't read-ahead past the end of the swap area */
1789 if (toff
>= swapdev
->max
)
1791 /* Don't read in free or bad pages */
1792 if (!swapdev
->swap_map
[toff
])
1794 if (swapdev
->swap_map
[toff
] == SWAP_MAP_BAD
)
1799 spin_unlock(&swap_lock
);