2 * linux/kernel/power/swap.c
4 * This file provides functions for reading the suspend image from
5 * and writing it to a swap partition.
7 * Copyright (C) 1998,2001-2005 Pavel Machek <pavel@ucw.cz>
8 * Copyright (C) 2006 Rafael J. Wysocki <rjw@sisk.pl>
9 * Copyright (C) 2010-2012 Bojan Smojver <bojan@rexursive.com>
11 * This file is released under the GPLv2.
15 #include <linux/module.h>
16 #include <linux/file.h>
17 #include <linux/delay.h>
18 #include <linux/bitops.h>
19 #include <linux/genhd.h>
20 #include <linux/device.h>
21 #include <linux/bio.h>
22 #include <linux/blkdev.h>
23 #include <linux/swap.h>
24 #include <linux/swapops.h>
26 #include <linux/slab.h>
27 #include <linux/lzo.h>
28 #include <linux/vmalloc.h>
29 #include <linux/cpumask.h>
30 #include <linux/atomic.h>
31 #include <linux/kthread.h>
32 #include <linux/crc32.h>
33 #include <linux/ktime.h>
37 #define HIBERNATE_SIG "S1SUSPEND"
40 * The swap map is a data structure used for keeping track of each page
41 * written to a swap partition. It consists of many swap_map_page
42 * structures that contain each an array of MAP_PAGE_ENTRIES swap entries.
43 * These structures are stored on the swap and linked together with the
44 * help of the .next_swap member.
46 * The swap map is created during suspend. The swap map pages are
47 * allocated and populated one at a time, so we only need one memory
48 * page to set up the entire structure.
50 * During resume we pick up all swap_map_page structures into a list.
53 #define MAP_PAGE_ENTRIES (PAGE_SIZE / sizeof(sector_t) - 1)
56 * Number of free pages that are not high.
58 static inline unsigned long low_free_pages(void)
60 return nr_free_pages() - nr_free_highpages();
64 * Number of pages required to be kept free while writing the image. Always
65 * half of all available low pages before the writing starts.
67 static inline unsigned long reqd_free_pages(void)
69 return low_free_pages() / 2;
72 struct swap_map_page
{
73 sector_t entries
[MAP_PAGE_ENTRIES
];
77 struct swap_map_page_list
{
78 struct swap_map_page
*map
;
79 struct swap_map_page_list
*next
;
83 * The swap_map_handle structure is used for handling swap in
87 struct swap_map_handle
{
88 struct swap_map_page
*cur
;
89 struct swap_map_page_list
*maps
;
91 sector_t first_sector
;
93 unsigned long reqd_free_pages
;
97 struct swsusp_header
{
98 char reserved
[PAGE_SIZE
- 20 - sizeof(sector_t
) - sizeof(int) -
102 unsigned int flags
; /* Flags to pass to the "boot" kernel */
107 static struct swsusp_header
*swsusp_header
;
110 * The following functions are used for tracing the allocated
111 * swap pages, so that they can be freed in case of an error.
114 struct swsusp_extent
{
120 static struct rb_root swsusp_extents
= RB_ROOT
;
122 static int swsusp_extents_insert(unsigned long swap_offset
)
124 struct rb_node
**new = &(swsusp_extents
.rb_node
);
125 struct rb_node
*parent
= NULL
;
126 struct swsusp_extent
*ext
;
128 /* Figure out where to put the new node */
130 ext
= rb_entry(*new, struct swsusp_extent
, node
);
132 if (swap_offset
< ext
->start
) {
134 if (swap_offset
== ext
->start
- 1) {
138 new = &((*new)->rb_left
);
139 } else if (swap_offset
> ext
->end
) {
141 if (swap_offset
== ext
->end
+ 1) {
145 new = &((*new)->rb_right
);
147 /* It already is in the tree */
151 /* Add the new node and rebalance the tree. */
152 ext
= kzalloc(sizeof(struct swsusp_extent
), GFP_KERNEL
);
156 ext
->start
= swap_offset
;
157 ext
->end
= swap_offset
;
158 rb_link_node(&ext
->node
, parent
, new);
159 rb_insert_color(&ext
->node
, &swsusp_extents
);
164 * alloc_swapdev_block - allocate a swap page and register that it has
165 * been allocated, so that it can be freed in case of an error.
168 sector_t
alloc_swapdev_block(int swap
)
170 unsigned long offset
;
172 offset
= swp_offset(get_swap_page_of_type(swap
));
174 if (swsusp_extents_insert(offset
))
175 swap_free(swp_entry(swap
, offset
));
177 return swapdev_block(swap
, offset
);
183 * free_all_swap_pages - free swap pages allocated for saving image data.
184 * It also frees the extents used to register which swap entries had been
188 void free_all_swap_pages(int swap
)
190 struct rb_node
*node
;
192 while ((node
= swsusp_extents
.rb_node
)) {
193 struct swsusp_extent
*ext
;
194 unsigned long offset
;
196 ext
= container_of(node
, struct swsusp_extent
, node
);
197 rb_erase(node
, &swsusp_extents
);
198 for (offset
= ext
->start
; offset
<= ext
->end
; offset
++)
199 swap_free(swp_entry(swap
, offset
));
205 int swsusp_swap_in_use(void)
207 return (swsusp_extents
.rb_node
!= NULL
);
214 static unsigned short root_swap
= 0xffff;
215 static struct block_device
*hib_resume_bdev
;
217 struct hib_bio_batch
{
219 wait_queue_head_t wait
;
223 static void hib_init_batch(struct hib_bio_batch
*hb
)
225 atomic_set(&hb
->count
, 0);
226 init_waitqueue_head(&hb
->wait
);
230 static void hib_end_io(struct bio
*bio
)
232 struct hib_bio_batch
*hb
= bio
->bi_private
;
233 struct page
*page
= bio
->bi_io_vec
[0].bv_page
;
236 printk(KERN_ALERT
"Read-error on swap-device (%u:%u:%Lu)\n",
237 imajor(bio
->bi_bdev
->bd_inode
),
238 iminor(bio
->bi_bdev
->bd_inode
),
239 (unsigned long long)bio
->bi_iter
.bi_sector
);
242 if (bio_data_dir(bio
) == WRITE
)
245 if (bio
->bi_error
&& !hb
->error
)
246 hb
->error
= bio
->bi_error
;
247 if (atomic_dec_and_test(&hb
->count
))
253 static int hib_submit_io(int rw
, pgoff_t page_off
, void *addr
,
254 struct hib_bio_batch
*hb
)
256 struct page
*page
= virt_to_page(addr
);
260 bio
= bio_alloc(__GFP_WAIT
| __GFP_HIGH
, 1);
261 bio
->bi_iter
.bi_sector
= page_off
* (PAGE_SIZE
>> 9);
262 bio
->bi_bdev
= hib_resume_bdev
;
264 if (bio_add_page(bio
, page
, PAGE_SIZE
, 0) < PAGE_SIZE
) {
265 printk(KERN_ERR
"PM: Adding page to bio failed at %llu\n",
266 (unsigned long long)bio
->bi_iter
.bi_sector
);
272 bio
->bi_end_io
= hib_end_io
;
273 bio
->bi_private
= hb
;
274 atomic_inc(&hb
->count
);
277 error
= submit_bio_wait(rw
, bio
);
284 static int hib_wait_io(struct hib_bio_batch
*hb
)
286 wait_event(hb
->wait
, atomic_read(&hb
->count
) == 0);
294 static int mark_swapfiles(struct swap_map_handle
*handle
, unsigned int flags
)
298 hib_submit_io(READ_SYNC
, swsusp_resume_block
, swsusp_header
, NULL
);
299 if (!memcmp("SWAP-SPACE",swsusp_header
->sig
, 10) ||
300 !memcmp("SWAPSPACE2",swsusp_header
->sig
, 10)) {
301 memcpy(swsusp_header
->orig_sig
,swsusp_header
->sig
, 10);
302 memcpy(swsusp_header
->sig
, HIBERNATE_SIG
, 10);
303 swsusp_header
->image
= handle
->first_sector
;
304 swsusp_header
->flags
= flags
;
305 if (flags
& SF_CRC32_MODE
)
306 swsusp_header
->crc32
= handle
->crc32
;
307 error
= hib_submit_io(WRITE_SYNC
, swsusp_resume_block
,
308 swsusp_header
, NULL
);
310 printk(KERN_ERR
"PM: Swap header not found!\n");
317 * swsusp_swap_check - check if the resume device is a swap device
318 * and get its index (if so)
320 * This is called before saving image
322 static int swsusp_swap_check(void)
326 res
= swap_type_of(swsusp_resume_device
, swsusp_resume_block
,
332 res
= blkdev_get(hib_resume_bdev
, FMODE_WRITE
, NULL
);
336 res
= set_blocksize(hib_resume_bdev
, PAGE_SIZE
);
338 blkdev_put(hib_resume_bdev
, FMODE_WRITE
);
344 * write_page - Write one page to given swap location.
345 * @buf: Address we're writing.
346 * @offset: Offset of the swap page we're writing to.
347 * @hb: bio completion batch
350 static int write_page(void *buf
, sector_t offset
, struct hib_bio_batch
*hb
)
359 src
= (void *)__get_free_page(__GFP_WAIT
| __GFP_NOWARN
|
364 ret
= hib_wait_io(hb
); /* Free pages */
367 src
= (void *)__get_free_page(__GFP_WAIT
|
374 hb
= NULL
; /* Go synchronous */
381 return hib_submit_io(WRITE_SYNC
, offset
, src
, hb
);
384 static void release_swap_writer(struct swap_map_handle
*handle
)
387 free_page((unsigned long)handle
->cur
);
391 static int get_swap_writer(struct swap_map_handle
*handle
)
395 ret
= swsusp_swap_check();
398 printk(KERN_ERR
"PM: Cannot find swap device, try "
402 handle
->cur
= (struct swap_map_page
*)get_zeroed_page(GFP_KERNEL
);
407 handle
->cur_swap
= alloc_swapdev_block(root_swap
);
408 if (!handle
->cur_swap
) {
413 handle
->reqd_free_pages
= reqd_free_pages();
414 handle
->first_sector
= handle
->cur_swap
;
417 release_swap_writer(handle
);
419 swsusp_close(FMODE_WRITE
);
423 static int swap_write_page(struct swap_map_handle
*handle
, void *buf
,
424 struct hib_bio_batch
*hb
)
431 offset
= alloc_swapdev_block(root_swap
);
432 error
= write_page(buf
, offset
, hb
);
435 handle
->cur
->entries
[handle
->k
++] = offset
;
436 if (handle
->k
>= MAP_PAGE_ENTRIES
) {
437 offset
= alloc_swapdev_block(root_swap
);
440 handle
->cur
->next_swap
= offset
;
441 error
= write_page(handle
->cur
, handle
->cur_swap
, hb
);
444 clear_page(handle
->cur
);
445 handle
->cur_swap
= offset
;
448 if (hb
&& low_free_pages() <= handle
->reqd_free_pages
) {
449 error
= hib_wait_io(hb
);
453 * Recalculate the number of required free pages, to
454 * make sure we never take more than half.
456 handle
->reqd_free_pages
= reqd_free_pages();
463 static int flush_swap_writer(struct swap_map_handle
*handle
)
465 if (handle
->cur
&& handle
->cur_swap
)
466 return write_page(handle
->cur
, handle
->cur_swap
, NULL
);
471 static int swap_writer_finish(struct swap_map_handle
*handle
,
472 unsigned int flags
, int error
)
475 flush_swap_writer(handle
);
476 printk(KERN_INFO
"PM: S");
477 error
= mark_swapfiles(handle
, flags
);
482 free_all_swap_pages(root_swap
);
483 release_swap_writer(handle
);
484 swsusp_close(FMODE_WRITE
);
489 /* We need to remember how much compressed data we need to read. */
490 #define LZO_HEADER sizeof(size_t)
492 /* Number of pages/bytes we'll compress at one time. */
493 #define LZO_UNC_PAGES 32
494 #define LZO_UNC_SIZE (LZO_UNC_PAGES * PAGE_SIZE)
496 /* Number of pages/bytes we need for compressed data (worst case). */
497 #define LZO_CMP_PAGES DIV_ROUND_UP(lzo1x_worst_compress(LZO_UNC_SIZE) + \
498 LZO_HEADER, PAGE_SIZE)
499 #define LZO_CMP_SIZE (LZO_CMP_PAGES * PAGE_SIZE)
501 /* Maximum number of threads for compression/decompression. */
502 #define LZO_THREADS 3
504 /* Minimum/maximum number of pages for read buffering. */
505 #define LZO_MIN_RD_PAGES 1024
506 #define LZO_MAX_RD_PAGES 8192
510 * save_image - save the suspend image data
513 static int save_image(struct swap_map_handle
*handle
,
514 struct snapshot_handle
*snapshot
,
515 unsigned int nr_to_write
)
521 struct hib_bio_batch hb
;
527 printk(KERN_INFO
"PM: Saving image data pages (%u pages)...\n",
529 m
= nr_to_write
/ 10;
535 ret
= snapshot_read_next(snapshot
);
538 ret
= swap_write_page(handle
, data_of(*snapshot
), &hb
);
542 printk(KERN_INFO
"PM: Image saving progress: %3d%%\n",
546 err2
= hib_wait_io(&hb
);
551 printk(KERN_INFO
"PM: Image saving done.\n");
552 swsusp_show_speed(start
, stop
, nr_to_write
, "Wrote");
557 * Structure used for CRC32.
560 struct task_struct
*thr
; /* thread */
561 atomic_t ready
; /* ready to start flag */
562 atomic_t stop
; /* ready to stop flag */
563 unsigned run_threads
; /* nr current threads */
564 wait_queue_head_t go
; /* start crc update */
565 wait_queue_head_t done
; /* crc update done */
566 u32
*crc32
; /* points to handle's crc32 */
567 size_t *unc_len
[LZO_THREADS
]; /* uncompressed lengths */
568 unsigned char *unc
[LZO_THREADS
]; /* uncompressed data */
572 * CRC32 update function that runs in its own thread.
574 static int crc32_threadfn(void *data
)
576 struct crc_data
*d
= data
;
580 wait_event(d
->go
, atomic_read(&d
->ready
) ||
581 kthread_should_stop());
582 if (kthread_should_stop()) {
584 atomic_set(&d
->stop
, 1);
588 atomic_set(&d
->ready
, 0);
590 for (i
= 0; i
< d
->run_threads
; i
++)
591 *d
->crc32
= crc32_le(*d
->crc32
,
592 d
->unc
[i
], *d
->unc_len
[i
]);
593 atomic_set(&d
->stop
, 1);
599 * Structure used for LZO data compression.
602 struct task_struct
*thr
; /* thread */
603 atomic_t ready
; /* ready to start flag */
604 atomic_t stop
; /* ready to stop flag */
605 int ret
; /* return code */
606 wait_queue_head_t go
; /* start compression */
607 wait_queue_head_t done
; /* compression done */
608 size_t unc_len
; /* uncompressed length */
609 size_t cmp_len
; /* compressed length */
610 unsigned char unc
[LZO_UNC_SIZE
]; /* uncompressed buffer */
611 unsigned char cmp
[LZO_CMP_SIZE
]; /* compressed buffer */
612 unsigned char wrk
[LZO1X_1_MEM_COMPRESS
]; /* compression workspace */
616 * Compression function that runs in its own thread.
618 static int lzo_compress_threadfn(void *data
)
620 struct cmp_data
*d
= data
;
623 wait_event(d
->go
, atomic_read(&d
->ready
) ||
624 kthread_should_stop());
625 if (kthread_should_stop()) {
628 atomic_set(&d
->stop
, 1);
632 atomic_set(&d
->ready
, 0);
634 d
->ret
= lzo1x_1_compress(d
->unc
, d
->unc_len
,
635 d
->cmp
+ LZO_HEADER
, &d
->cmp_len
,
637 atomic_set(&d
->stop
, 1);
644 * save_image_lzo - Save the suspend image data compressed with LZO.
645 * @handle: Swap map handle to use for saving the image.
646 * @snapshot: Image to read data from.
647 * @nr_to_write: Number of pages to save.
649 static int save_image_lzo(struct swap_map_handle
*handle
,
650 struct snapshot_handle
*snapshot
,
651 unsigned int nr_to_write
)
657 struct hib_bio_batch hb
;
661 unsigned thr
, run_threads
, nr_threads
;
662 unsigned char *page
= NULL
;
663 struct cmp_data
*data
= NULL
;
664 struct crc_data
*crc
= NULL
;
669 * We'll limit the number of threads for compression to limit memory
672 nr_threads
= num_online_cpus() - 1;
673 nr_threads
= clamp_val(nr_threads
, 1, LZO_THREADS
);
675 page
= (void *)__get_free_page(__GFP_WAIT
| __GFP_HIGH
);
677 printk(KERN_ERR
"PM: Failed to allocate LZO page\n");
682 data
= vmalloc(sizeof(*data
) * nr_threads
);
684 printk(KERN_ERR
"PM: Failed to allocate LZO data\n");
688 for (thr
= 0; thr
< nr_threads
; thr
++)
689 memset(&data
[thr
], 0, offsetof(struct cmp_data
, go
));
691 crc
= kmalloc(sizeof(*crc
), GFP_KERNEL
);
693 printk(KERN_ERR
"PM: Failed to allocate crc\n");
697 memset(crc
, 0, offsetof(struct crc_data
, go
));
700 * Start the compression threads.
702 for (thr
= 0; thr
< nr_threads
; thr
++) {
703 init_waitqueue_head(&data
[thr
].go
);
704 init_waitqueue_head(&data
[thr
].done
);
706 data
[thr
].thr
= kthread_run(lzo_compress_threadfn
,
708 "image_compress/%u", thr
);
709 if (IS_ERR(data
[thr
].thr
)) {
710 data
[thr
].thr
= NULL
;
712 "PM: Cannot start compression threads\n");
719 * Start the CRC32 thread.
721 init_waitqueue_head(&crc
->go
);
722 init_waitqueue_head(&crc
->done
);
725 crc
->crc32
= &handle
->crc32
;
726 for (thr
= 0; thr
< nr_threads
; thr
++) {
727 crc
->unc
[thr
] = data
[thr
].unc
;
728 crc
->unc_len
[thr
] = &data
[thr
].unc_len
;
731 crc
->thr
= kthread_run(crc32_threadfn
, crc
, "image_crc32");
732 if (IS_ERR(crc
->thr
)) {
734 printk(KERN_ERR
"PM: Cannot start CRC32 thread\n");
740 * Adjust the number of required free pages after all allocations have
741 * been done. We don't want to run out of pages when writing.
743 handle
->reqd_free_pages
= reqd_free_pages();
746 "PM: Using %u thread(s) for compression.\n"
747 "PM: Compressing and saving image data (%u pages)...\n",
748 nr_threads
, nr_to_write
);
749 m
= nr_to_write
/ 10;
755 for (thr
= 0; thr
< nr_threads
; thr
++) {
756 for (off
= 0; off
< LZO_UNC_SIZE
; off
+= PAGE_SIZE
) {
757 ret
= snapshot_read_next(snapshot
);
764 memcpy(data
[thr
].unc
+ off
,
765 data_of(*snapshot
), PAGE_SIZE
);
769 "PM: Image saving progress: "
777 data
[thr
].unc_len
= off
;
779 atomic_set(&data
[thr
].ready
, 1);
780 wake_up(&data
[thr
].go
);
786 crc
->run_threads
= thr
;
787 atomic_set(&crc
->ready
, 1);
790 for (run_threads
= thr
, thr
= 0; thr
< run_threads
; thr
++) {
791 wait_event(data
[thr
].done
,
792 atomic_read(&data
[thr
].stop
));
793 atomic_set(&data
[thr
].stop
, 0);
798 printk(KERN_ERR
"PM: LZO compression failed\n");
802 if (unlikely(!data
[thr
].cmp_len
||
804 lzo1x_worst_compress(data
[thr
].unc_len
))) {
806 "PM: Invalid LZO compressed length\n");
811 *(size_t *)data
[thr
].cmp
= data
[thr
].cmp_len
;
814 * Given we are writing one page at a time to disk, we
815 * copy that much from the buffer, although the last
816 * bit will likely be smaller than full page. This is
817 * OK - we saved the length of the compressed data, so
818 * any garbage at the end will be discarded when we
822 off
< LZO_HEADER
+ data
[thr
].cmp_len
;
824 memcpy(page
, data
[thr
].cmp
+ off
, PAGE_SIZE
);
826 ret
= swap_write_page(handle
, page
, &hb
);
832 wait_event(crc
->done
, atomic_read(&crc
->stop
));
833 atomic_set(&crc
->stop
, 0);
837 err2
= hib_wait_io(&hb
);
842 printk(KERN_INFO
"PM: Image saving done.\n");
843 swsusp_show_speed(start
, stop
, nr_to_write
, "Wrote");
847 kthread_stop(crc
->thr
);
851 for (thr
= 0; thr
< nr_threads
; thr
++)
853 kthread_stop(data
[thr
].thr
);
856 if (page
) free_page((unsigned long)page
);
862 * enough_swap - Make sure we have enough swap to save the image.
864 * Returns TRUE or FALSE after checking the total amount of swap
865 * space avaiable from the resume partition.
868 static int enough_swap(unsigned int nr_pages
, unsigned int flags
)
870 unsigned int free_swap
= count_swap_pages(root_swap
, 1);
871 unsigned int required
;
873 pr_debug("PM: Free swap pages: %u\n", free_swap
);
875 required
= PAGES_FOR_IO
+ nr_pages
;
876 return free_swap
> required
;
880 * swsusp_write - Write entire image and metadata.
881 * @flags: flags to pass to the "boot" kernel in the image header
883 * It is important _NOT_ to umount filesystems at this point. We want
884 * them synced (in case something goes wrong) but we DO not want to mark
885 * filesystem clean: it is not. (And it does not matter, if we resume
886 * correctly, we'll mark system clean, anyway.)
889 int swsusp_write(unsigned int flags
)
891 struct swap_map_handle handle
;
892 struct snapshot_handle snapshot
;
893 struct swsusp_info
*header
;
897 pages
= snapshot_get_image_size();
898 error
= get_swap_writer(&handle
);
900 printk(KERN_ERR
"PM: Cannot get swap writer\n");
903 if (flags
& SF_NOCOMPRESS_MODE
) {
904 if (!enough_swap(pages
, flags
)) {
905 printk(KERN_ERR
"PM: Not enough free swap\n");
910 memset(&snapshot
, 0, sizeof(struct snapshot_handle
));
911 error
= snapshot_read_next(&snapshot
);
912 if (error
< PAGE_SIZE
) {
918 header
= (struct swsusp_info
*)data_of(snapshot
);
919 error
= swap_write_page(&handle
, header
, NULL
);
921 error
= (flags
& SF_NOCOMPRESS_MODE
) ?
922 save_image(&handle
, &snapshot
, pages
- 1) :
923 save_image_lzo(&handle
, &snapshot
, pages
- 1);
926 error
= swap_writer_finish(&handle
, flags
, error
);
931 * The following functions allow us to read data using a swap map
932 * in a file-alike way
935 static void release_swap_reader(struct swap_map_handle
*handle
)
937 struct swap_map_page_list
*tmp
;
939 while (handle
->maps
) {
940 if (handle
->maps
->map
)
941 free_page((unsigned long)handle
->maps
->map
);
943 handle
->maps
= handle
->maps
->next
;
949 static int get_swap_reader(struct swap_map_handle
*handle
,
950 unsigned int *flags_p
)
953 struct swap_map_page_list
*tmp
, *last
;
956 *flags_p
= swsusp_header
->flags
;
958 if (!swsusp_header
->image
) /* how can this happen? */
962 last
= handle
->maps
= NULL
;
963 offset
= swsusp_header
->image
;
965 tmp
= kmalloc(sizeof(*handle
->maps
), GFP_KERNEL
);
967 release_swap_reader(handle
);
970 memset(tmp
, 0, sizeof(*tmp
));
977 tmp
->map
= (struct swap_map_page
*)
978 __get_free_page(__GFP_WAIT
| __GFP_HIGH
);
980 release_swap_reader(handle
);
984 error
= hib_submit_io(READ_SYNC
, offset
, tmp
->map
, NULL
);
986 release_swap_reader(handle
);
989 offset
= tmp
->map
->next_swap
;
992 handle
->cur
= handle
->maps
->map
;
996 static int swap_read_page(struct swap_map_handle
*handle
, void *buf
,
997 struct hib_bio_batch
*hb
)
1001 struct swap_map_page_list
*tmp
;
1005 offset
= handle
->cur
->entries
[handle
->k
];
1008 error
= hib_submit_io(READ_SYNC
, offset
, buf
, hb
);
1011 if (++handle
->k
>= MAP_PAGE_ENTRIES
) {
1013 free_page((unsigned long)handle
->maps
->map
);
1015 handle
->maps
= handle
->maps
->next
;
1018 release_swap_reader(handle
);
1020 handle
->cur
= handle
->maps
->map
;
1025 static int swap_reader_finish(struct swap_map_handle
*handle
)
1027 release_swap_reader(handle
);
1033 * load_image - load the image using the swap map handle
1034 * @handle and the snapshot handle @snapshot
1035 * (assume there are @nr_pages pages to load)
1038 static int load_image(struct swap_map_handle
*handle
,
1039 struct snapshot_handle
*snapshot
,
1040 unsigned int nr_to_read
)
1046 struct hib_bio_batch hb
;
1050 hib_init_batch(&hb
);
1052 printk(KERN_INFO
"PM: Loading image data pages (%u pages)...\n",
1054 m
= nr_to_read
/ 10;
1058 start
= ktime_get();
1060 ret
= snapshot_write_next(snapshot
);
1063 ret
= swap_read_page(handle
, data_of(*snapshot
), &hb
);
1066 if (snapshot
->sync_read
)
1067 ret
= hib_wait_io(&hb
);
1070 if (!(nr_pages
% m
))
1071 printk(KERN_INFO
"PM: Image loading progress: %3d%%\n",
1075 err2
= hib_wait_io(&hb
);
1080 printk(KERN_INFO
"PM: Image loading done.\n");
1081 snapshot_write_finalize(snapshot
);
1082 if (!snapshot_image_loaded(snapshot
))
1085 swsusp_show_speed(start
, stop
, nr_to_read
, "Read");
1090 * Structure used for LZO data decompression.
1093 struct task_struct
*thr
; /* thread */
1094 atomic_t ready
; /* ready to start flag */
1095 atomic_t stop
; /* ready to stop flag */
1096 int ret
; /* return code */
1097 wait_queue_head_t go
; /* start decompression */
1098 wait_queue_head_t done
; /* decompression done */
1099 size_t unc_len
; /* uncompressed length */
1100 size_t cmp_len
; /* compressed length */
1101 unsigned char unc
[LZO_UNC_SIZE
]; /* uncompressed buffer */
1102 unsigned char cmp
[LZO_CMP_SIZE
]; /* compressed buffer */
1106 * Deompression function that runs in its own thread.
1108 static int lzo_decompress_threadfn(void *data
)
1110 struct dec_data
*d
= data
;
1113 wait_event(d
->go
, atomic_read(&d
->ready
) ||
1114 kthread_should_stop());
1115 if (kthread_should_stop()) {
1118 atomic_set(&d
->stop
, 1);
1122 atomic_set(&d
->ready
, 0);
1124 d
->unc_len
= LZO_UNC_SIZE
;
1125 d
->ret
= lzo1x_decompress_safe(d
->cmp
+ LZO_HEADER
, d
->cmp_len
,
1126 d
->unc
, &d
->unc_len
);
1127 atomic_set(&d
->stop
, 1);
1134 * load_image_lzo - Load compressed image data and decompress them with LZO.
1135 * @handle: Swap map handle to use for loading data.
1136 * @snapshot: Image to copy uncompressed data into.
1137 * @nr_to_read: Number of pages to load.
1139 static int load_image_lzo(struct swap_map_handle
*handle
,
1140 struct snapshot_handle
*snapshot
,
1141 unsigned int nr_to_read
)
1146 struct hib_bio_batch hb
;
1151 unsigned i
, thr
, run_threads
, nr_threads
;
1152 unsigned ring
= 0, pg
= 0, ring_size
= 0,
1153 have
= 0, want
, need
, asked
= 0;
1154 unsigned long read_pages
= 0;
1155 unsigned char **page
= NULL
;
1156 struct dec_data
*data
= NULL
;
1157 struct crc_data
*crc
= NULL
;
1159 hib_init_batch(&hb
);
1162 * We'll limit the number of threads for decompression to limit memory
1165 nr_threads
= num_online_cpus() - 1;
1166 nr_threads
= clamp_val(nr_threads
, 1, LZO_THREADS
);
1168 page
= vmalloc(sizeof(*page
) * LZO_MAX_RD_PAGES
);
1170 printk(KERN_ERR
"PM: Failed to allocate LZO page\n");
1175 data
= vmalloc(sizeof(*data
) * nr_threads
);
1177 printk(KERN_ERR
"PM: Failed to allocate LZO data\n");
1181 for (thr
= 0; thr
< nr_threads
; thr
++)
1182 memset(&data
[thr
], 0, offsetof(struct dec_data
, go
));
1184 crc
= kmalloc(sizeof(*crc
), GFP_KERNEL
);
1186 printk(KERN_ERR
"PM: Failed to allocate crc\n");
1190 memset(crc
, 0, offsetof(struct crc_data
, go
));
1193 * Start the decompression threads.
1195 for (thr
= 0; thr
< nr_threads
; thr
++) {
1196 init_waitqueue_head(&data
[thr
].go
);
1197 init_waitqueue_head(&data
[thr
].done
);
1199 data
[thr
].thr
= kthread_run(lzo_decompress_threadfn
,
1201 "image_decompress/%u", thr
);
1202 if (IS_ERR(data
[thr
].thr
)) {
1203 data
[thr
].thr
= NULL
;
1205 "PM: Cannot start decompression threads\n");
1212 * Start the CRC32 thread.
1214 init_waitqueue_head(&crc
->go
);
1215 init_waitqueue_head(&crc
->done
);
1218 crc
->crc32
= &handle
->crc32
;
1219 for (thr
= 0; thr
< nr_threads
; thr
++) {
1220 crc
->unc
[thr
] = data
[thr
].unc
;
1221 crc
->unc_len
[thr
] = &data
[thr
].unc_len
;
1224 crc
->thr
= kthread_run(crc32_threadfn
, crc
, "image_crc32");
1225 if (IS_ERR(crc
->thr
)) {
1227 printk(KERN_ERR
"PM: Cannot start CRC32 thread\n");
1233 * Set the number of pages for read buffering.
1234 * This is complete guesswork, because we'll only know the real
1235 * picture once prepare_image() is called, which is much later on
1236 * during the image load phase. We'll assume the worst case and
1237 * say that none of the image pages are from high memory.
1239 if (low_free_pages() > snapshot_get_image_size())
1240 read_pages
= (low_free_pages() - snapshot_get_image_size()) / 2;
1241 read_pages
= clamp_val(read_pages
, LZO_MIN_RD_PAGES
, LZO_MAX_RD_PAGES
);
1243 for (i
= 0; i
< read_pages
; i
++) {
1244 page
[i
] = (void *)__get_free_page(i
< LZO_CMP_PAGES
?
1245 __GFP_WAIT
| __GFP_HIGH
:
1246 __GFP_WAIT
| __GFP_NOWARN
|
1250 if (i
< LZO_CMP_PAGES
) {
1253 "PM: Failed to allocate LZO pages\n");
1261 want
= ring_size
= i
;
1264 "PM: Using %u thread(s) for decompression.\n"
1265 "PM: Loading and decompressing image data (%u pages)...\n",
1266 nr_threads
, nr_to_read
);
1267 m
= nr_to_read
/ 10;
1271 start
= ktime_get();
1273 ret
= snapshot_write_next(snapshot
);
1278 for (i
= 0; !eof
&& i
< want
; i
++) {
1279 ret
= swap_read_page(handle
, page
[ring
], &hb
);
1282 * On real read error, finish. On end of data,
1283 * set EOF flag and just exit the read loop.
1286 handle
->cur
->entries
[handle
->k
]) {
1293 if (++ring
>= ring_size
)
1300 * We are out of data, wait for some more.
1306 ret
= hib_wait_io(&hb
);
1315 if (crc
->run_threads
) {
1316 wait_event(crc
->done
, atomic_read(&crc
->stop
));
1317 atomic_set(&crc
->stop
, 0);
1318 crc
->run_threads
= 0;
1321 for (thr
= 0; have
&& thr
< nr_threads
; thr
++) {
1322 data
[thr
].cmp_len
= *(size_t *)page
[pg
];
1323 if (unlikely(!data
[thr
].cmp_len
||
1325 lzo1x_worst_compress(LZO_UNC_SIZE
))) {
1327 "PM: Invalid LZO compressed length\n");
1332 need
= DIV_ROUND_UP(data
[thr
].cmp_len
+ LZO_HEADER
,
1343 off
< LZO_HEADER
+ data
[thr
].cmp_len
;
1345 memcpy(data
[thr
].cmp
+ off
,
1346 page
[pg
], PAGE_SIZE
);
1349 if (++pg
>= ring_size
)
1353 atomic_set(&data
[thr
].ready
, 1);
1354 wake_up(&data
[thr
].go
);
1358 * Wait for more data while we are decompressing.
1360 if (have
< LZO_CMP_PAGES
&& asked
) {
1361 ret
= hib_wait_io(&hb
);
1370 for (run_threads
= thr
, thr
= 0; thr
< run_threads
; thr
++) {
1371 wait_event(data
[thr
].done
,
1372 atomic_read(&data
[thr
].stop
));
1373 atomic_set(&data
[thr
].stop
, 0);
1375 ret
= data
[thr
].ret
;
1379 "PM: LZO decompression failed\n");
1383 if (unlikely(!data
[thr
].unc_len
||
1384 data
[thr
].unc_len
> LZO_UNC_SIZE
||
1385 data
[thr
].unc_len
& (PAGE_SIZE
- 1))) {
1387 "PM: Invalid LZO uncompressed length\n");
1393 off
< data
[thr
].unc_len
; off
+= PAGE_SIZE
) {
1394 memcpy(data_of(*snapshot
),
1395 data
[thr
].unc
+ off
, PAGE_SIZE
);
1397 if (!(nr_pages
% m
))
1399 "PM: Image loading progress: "
1404 ret
= snapshot_write_next(snapshot
);
1406 crc
->run_threads
= thr
+ 1;
1407 atomic_set(&crc
->ready
, 1);
1414 crc
->run_threads
= thr
;
1415 atomic_set(&crc
->ready
, 1);
1420 if (crc
->run_threads
) {
1421 wait_event(crc
->done
, atomic_read(&crc
->stop
));
1422 atomic_set(&crc
->stop
, 0);
1426 printk(KERN_INFO
"PM: Image loading done.\n");
1427 snapshot_write_finalize(snapshot
);
1428 if (!snapshot_image_loaded(snapshot
))
1431 if (swsusp_header
->flags
& SF_CRC32_MODE
) {
1432 if(handle
->crc32
!= swsusp_header
->crc32
) {
1434 "PM: Invalid image CRC32!\n");
1440 swsusp_show_speed(start
, stop
, nr_to_read
, "Read");
1442 for (i
= 0; i
< ring_size
; i
++)
1443 free_page((unsigned long)page
[i
]);
1446 kthread_stop(crc
->thr
);
1450 for (thr
= 0; thr
< nr_threads
; thr
++)
1452 kthread_stop(data
[thr
].thr
);
1461 * swsusp_read - read the hibernation image.
1462 * @flags_p: flags passed by the "frozen" kernel in the image header should
1463 * be written into this memory location
1466 int swsusp_read(unsigned int *flags_p
)
1469 struct swap_map_handle handle
;
1470 struct snapshot_handle snapshot
;
1471 struct swsusp_info
*header
;
1473 memset(&snapshot
, 0, sizeof(struct snapshot_handle
));
1474 error
= snapshot_write_next(&snapshot
);
1475 if (error
< PAGE_SIZE
)
1476 return error
< 0 ? error
: -EFAULT
;
1477 header
= (struct swsusp_info
*)data_of(snapshot
);
1478 error
= get_swap_reader(&handle
, flags_p
);
1482 error
= swap_read_page(&handle
, header
, NULL
);
1484 error
= (*flags_p
& SF_NOCOMPRESS_MODE
) ?
1485 load_image(&handle
, &snapshot
, header
->pages
- 1) :
1486 load_image_lzo(&handle
, &snapshot
, header
->pages
- 1);
1488 swap_reader_finish(&handle
);
1491 pr_debug("PM: Image successfully loaded\n");
1493 pr_debug("PM: Error %d resuming\n", error
);
1498 * swsusp_check - Check for swsusp signature in the resume device
1501 int swsusp_check(void)
1505 hib_resume_bdev
= blkdev_get_by_dev(swsusp_resume_device
,
1507 if (!IS_ERR(hib_resume_bdev
)) {
1508 set_blocksize(hib_resume_bdev
, PAGE_SIZE
);
1509 clear_page(swsusp_header
);
1510 error
= hib_submit_io(READ_SYNC
, swsusp_resume_block
,
1511 swsusp_header
, NULL
);
1515 if (!memcmp(HIBERNATE_SIG
, swsusp_header
->sig
, 10)) {
1516 memcpy(swsusp_header
->sig
, swsusp_header
->orig_sig
, 10);
1517 /* Reset swap signature now */
1518 error
= hib_submit_io(WRITE_SYNC
, swsusp_resume_block
,
1519 swsusp_header
, NULL
);
1526 blkdev_put(hib_resume_bdev
, FMODE_READ
);
1528 pr_debug("PM: Image signature found, resuming\n");
1530 error
= PTR_ERR(hib_resume_bdev
);
1534 pr_debug("PM: Image not found (code %d)\n", error
);
1540 * swsusp_close - close swap device.
1543 void swsusp_close(fmode_t mode
)
1545 if (IS_ERR(hib_resume_bdev
)) {
1546 pr_debug("PM: Image device not initialised\n");
1550 blkdev_put(hib_resume_bdev
, mode
);
1554 * swsusp_unmark - Unmark swsusp signature in the resume device
1557 #ifdef CONFIG_SUSPEND
1558 int swsusp_unmark(void)
1562 hib_submit_io(READ_SYNC
, swsusp_resume_block
, swsusp_header
, NULL
);
1563 if (!memcmp(HIBERNATE_SIG
,swsusp_header
->sig
, 10)) {
1564 memcpy(swsusp_header
->sig
,swsusp_header
->orig_sig
, 10);
1565 error
= hib_submit_io(WRITE_SYNC
, swsusp_resume_block
,
1566 swsusp_header
, NULL
);
1568 printk(KERN_ERR
"PM: Cannot find swsusp signature!\n");
1573 * We just returned from suspend, we don't need the image any more.
1575 free_all_swap_pages(root_swap
);
1581 static int swsusp_header_init(void)
1583 swsusp_header
= (struct swsusp_header
*) __get_free_page(GFP_KERNEL
);
1585 panic("Could not allocate memory for swsusp_header\n");
1589 core_initcall(swsusp_header_init
);